TextElement (ArcObjects Java API)

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.esri.arcgis.carto
Class TextElement

java.lang.Object
  com.esri.arcgis.carto.TextElement

All Implemented Interfaces:: IBoundsProperties, IClone, IElement, IElementEditCallout, IElementEditVertices, IElementProperties, IElementProperties2, IElementProperties3, IGraphicElement, IGroupSymbolElement, IMultiPartTextElement, IPersist, IPersistStream, IPropertySupport, ISymbolCollectionElement, ITextElement, ITransform2D, IXMLSerialize, java.io.Serializable

public class TextElement
extends java.lang.Object
implements IElement, IElementProperties, IElementProperties2, IElementProperties3, ITextElement, IGraphicElement, IBoundsProperties, IGroupSymbolElement, ISymbolCollectionElement, ITransform2D, IPersistStream, IPropertySupport, IElementEditVertices, IElementEditCallout, IClone, IMultiPartTextElement, IXMLSerialize

The Graphic Element to display text.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Remarks

The TextElement object has many roles from the title of a map layout to a piece of feature-linked annotation and everything in between. Every piece of text or annotation on a map or layout is a TextElement, with the exception of paragraph text which is a ParagraphTextElement . The primary interface for the TextElement object is ITextElement, but like most elements, the object is usually passed using an IElement interface pointer.

Use this object when you want to place text on a map, layout, or in an annotation feature class.

Geometry: TextElement accepts geometry of type esriGeometryPoint, esriGeometryPolyline, or esriGeometryBag. For drawing text in a polygon or envelope, use a ParagraphTextElement. TextElement's with a Polyline or GeometryBag geometry type will have an associated text path type. Specifically, GeometryBag geomtries are used with a WordTextPath to draw multipart text. The GeometryBag may consist of points, lines, or multipoints. Multipoint geometries in this cases correspond to the multipart equivalent of an OverposterTextPath where each glyph in the text string has a defined position.

See Also:: IElement, IGraphicElement, Serialized Form

Constructor Summary
`TextElement()` Constructs a TextElement using ArcGIS Engine.
`TextElement(java.lang.Object obj)` Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.

Method Summary
`void`	`activate(IDisplay display)` Prepare to display graphic on screen.
`boolean`	`applies(java.lang.Object pUnk)` Indicates if the receiver can apply the given object at any given time.
`java.lang.Object`	`apply(java.lang.Object newObject)` Applies the given property to the receiver and returns the old object.
`void`	`assign(IClone src)` Assigns the properties of src to the receiver.
`boolean`	`canApply(java.lang.Object pUnk)` Indicates if the receiver can apply the given object at that particular moment.
`boolean`	`canRotate()` Indicates if the element can be rotated.
`void`	`convertToMultiPart(IDisplay pDisplay)` Converts the current element into a multipart element.
`void`	`convertToSinglePart()` Converts the current element into a single part element.
`void`	`deactivate()` ActiveView that graphics are displayed on is no longer visible.
`void`	`deletePart(int index)` Delete a part in the multipart element at the specified index.
`void`	`deserialize(IXMLSerializeData data)` Deserializes an object from XML.
`void`	`draw(IDisplay display, ITrackCancel trackCancel)` Draws the element into the given display object.
`void`	`drawESRIAnno(IStream stream, ISymbolCollection symbolCollection, ISpatialReference spatialRef, IDisplay display)` Draws the anno in a compressed format.
`boolean`	`equals(java.lang.Object o)` Compare this object with another
`IClone`	`esri_clone()` Clones the receiver and assigns the result to *clone.
`void`	`exportToESRIAnno(IStream stream)` Saves the anno in a compressed format.
`IBoundsProperties`	`getAsIBoundsProperties()` Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
`IClone`	`getAsIClone()` Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
`IElement`	`getAsIElement()` Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
`IElementEditCallout`	`getAsIElementEditCallout()` Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
`IElementEditVertices`	`getAsIElementEditVertices()` Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
`IElementProperties`	`getAsIElementProperties()` Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
`IElementProperties2`	`getAsIElementProperties2()` Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
`IElementProperties3`	`getAsIElementProperties3()` Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
`IGraphicElement`	`getAsIGraphicElement()` Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
`IGroupSymbolElement`	`getAsIGroupSymbolElement()` Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
`IMultiPartTextElement`	`getAsIMultiPartTextElement()` Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
`IPersistStream`	`getAsIPersistStream()` Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
`IPropertySupport`	`getAsIPropertySupport()` Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
`ISymbolCollectionElement`	`getAsISymbolCollectionElement()` Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
`ITextElement`	`getAsITextElement()` Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
`ITransform2D`	`getAsITransform2D()` Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
`IXMLSerialize`	`getAsIXMLSerialize()` Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
`ITextBackground`	`getBackground()` Background symbol.
`double`	`getCharacterSpacing()` The character spacing.
`double`	`getCharacterWidth()` The character width.
`void`	`getClassID(GUID[] pClassID)` Supported Platforms
`static java.lang.String`	`getClsid()`
`IColor`	`getColor()` Font color.
`java.lang.Object`	`getCurrent(java.lang.Object pUnk)` The object currently being used.
`java.lang.Object`	`getCustomProperty()` Custom property.
`double`	`getFlipAngle()` Flip angle.
`java.lang.String`	`getFontName()` Font name.
`IGeometry`	`getGeometry()` Shape of the element as a geometry.
`int`	`getHorizontalAlignment()` Horizontal alignment style.
`double`	`getLeading()` The character leading.
`ISelectionTracker`	`getMoveTextSelectionTracker()` Returns the selection tracker to move the text used by this element.
`ISelectionTracker`	`getMoveVerticesSelectionTracker()` Selection tracker to move points used by this element.
`java.lang.String`	`getName()` Name of the element.
`int`	`getOverriddenProperties()` Overridden properties.
`int`	`getOverriddenPropertiesExclusionMask()` Mask used to exclude overrides when drawing.
`int`	`getPartCount()` The number of parts in the multipart element.
`double`	`getReferenceScale()` Reference scale of the element.
`ISelectionTracker`	`getSelectionTracker()` Selection tracker used by this element.
`ISymbol`	`getSharedSymbol()` Collection symbol.
`double`	`getSize()` Font size.
`void`	`getSizeMax(_ULARGE_INTEGER[] pcbSize)` Supported Platforms
`ISpatialReference`	`getSpatialReference()` Spatial reference of the container.
`ITextSymbol`	`getSymbol()` Text symbol this element uses to draw itself.
`int`	`getSymbolID()` Symbol ID associated with this element.
`java.lang.String`	`getText()` Text being displayed by this element.
`ITextPath`	`getTextPath()` Text path.
`java.lang.String`	`getType()` Type of the element.
`int`	`getVerticalAlignment()` Vertical alignment style.
`double`	`getWordSpacing()` The word spacing.
`double`	`getXOffset()` Text offset along X-axis.
`double`	`getYOffset()` Text offset along Y-axis.
`int`	`hashCode()` the hashcode for this object
`boolean`	`hitTest(double x, double y, double tolerance)` Indicates if the given x and y coordinates are contained by the element.
`int`	`IElementProperties3_getAnchorPoint()` Anchor point of the element.
`IPoint`	`IGroupSymbolElement_getAnchorPoint()` Callout anchor point.
`void`	`importFromESRIAnno(IStream stream, ISpatialReference spatialReference)` Loads the anno in a compressed format.
`void`	`importFromESRIAnno(IStream stream, ISpatialReference spatialReference, ISymbolCollection symbolCollection)` Loads the anno in a compressed format.
`void`	`insertPart(int index, java.lang.String text, IGeometry geometry)` Insert a part in the multipart element at the specified index.
`boolean`	`isAutoTransform()` Indicates if transform is applied to symbols and other parts of element.
`boolean`	`isBold()` Indicates whether bold fonts style.
`void`	`isDirty()` Supported Platforms
`boolean`	`isEditingCallout()` Indicates if this element is editing it's callout.
`boolean`	`isEqual(IClone other)` Returns TRUE when the receiver and other have the same properties.
`boolean`	`isFixedAspectRatio()` Indicates if the bounds has a fixed aspect ratio.
`boolean`	`isFixedSize()` Indicates if size is determined by some other property like the symbol.
`boolean`	`isIdentical(IClone other)` Returns TRUE when the receiver and other are the same object.
`boolean`	`isItalic()` Indicates whether italic font style.
`boolean`	`isLocked()` Indicates if the element is in a read-only state.
`boolean`	`isMovingVertices()` Indicates if this element is moving its vertices.
`boolean`	`isMultipart()` Indicates if the element is multi part.
`boolean`	`isScaleText()` Indicates if the text scales with the map.
`boolean`	`isUnderline()` Indicates whether underline font style.
`IPoint`	`ISymbolCollectionElement_getAnchorPoint()` Callout anchor point.
`void`	`load(IStream pstm)` Supported Platforms
`void`	`move(double dx, double dy)` Moves dx units horizontally and dy units vertically.
`void`	`moveVector(ILine v)` Moves a direction and distance v.
`void`	`queryBounds(IDisplay display, IEnvelope bounds)` Bounds of the element taking symbology into consideration.
`void`	`queryOutline(IDisplay display, IPolygon outline)` Bounds of the element taking symbology into consideration.
`IElement`	`queryPart(int index)` Returns the part in the multipart element at the specified index.
`void`	`replacePart(int index, java.lang.String text, IGeometry geometry)` Replace a part in the multipart element at the specified index.
`void`	`rotate(IPoint origin, double rotationAngle)` Rotates about the specified origin point.
`void`	`save(IStream pstm, int fClearDirty)` Supported Platforms
`void`	`scale(IPoint origin, double sx, double sy)` Scales about the specified origin using seperate horizonal and vertical scales.
`void`	`serialize(IXMLSerializeData data)` Serializes an object to XML.
`void`	`setAnchorPoint(int anchorPoint)` Anchor point of the element.
`void`	`setAnchorPoint(IPoint anchorPoint)` Callout anchor point.
`void`	`setAutoTransform(boolean autoTransform)` Indicates if transform is applied to symbols and other parts of element.
`void`	`setBackgroundByRef(ITextBackground symbol)` Background symbol.
`void`	`setBold(boolean bold)` Indicates whether bold fonts style.
`void`	`setCharacterSpacing(double characterSpacing)` The character spacing.
`void`	`setCharacterWidth(double characterWidth)` The character width.
`void`	`setColor(IColor color)` Font color.
`void`	`setCustomProperty(java.lang.Object customProperty)` Custom property.
`void`	`setEditingCallout(boolean flag)` Indicates if this element is editing it's callout.
`void`	`setFixedAspectRatio(boolean flag)` Indicates if the bounds has a fixed aspect ratio.
`void`	`setFlipAngle(double flipAngle)` Flip angle.
`void`	`setFontName(java.lang.String fontName)` Font name.
`void`	`setGeometry(IGeometry pGeometry)` Shape of the element as a geometry.
`void`	`setGroupSymbol(int symbolID, ISymbol rhs2)` The symbol ID associated with this element.
`void`	`setHorizontalAlignment(int horizAlignment)` Horizontal alignment style.
`void`	`setItalic(boolean italic)` Indicates whether italic font style.
`void`	`setLeading(double leading)` The character leading.
`void`	`setLocked(boolean pLocked)` Indicates if the element is in a read-only state.
`void`	`setMovingVertices(boolean flag)` Indicates if this element is moving its vertices.
`void`	`setName(java.lang.String name)` Name of the element.
`void`	`setOverriddenProperties(int props)` Overridden properties.
`void`	`setOverriddenPropertiesExclusionMask(int mask)` Mask used to exclude overrides when drawing.
`void`	`setReferenceScale(double referenceScale)` Reference scale of the element.
`void`	`setScaleText(boolean scale)` Indicates if the text scales with the map.
`void`	`setSharedSymbol(int symbolID, ISymbol rhs2)` The symbol ID associated with this element.
`void`	`setSize(double pointSize)` Font size.
`void`	`setSpatialReferenceByRef(ISpatialReference spatialRef)` Spatial reference of the container.
`void`	`setSymbol(ITextSymbol symbol)` Text symbol this element uses to draw itself.
`void`	`setSymbolID(int symbolID)` Symbol ID associated with this element.
`void`	`setText(java.lang.String text)` Text being displayed by this element.
`void`	`setTextPathByRef(ITextPath textPath)` Text path.
`void`	`setType(java.lang.String name)` Type of the element.
`void`	`setUnderline(boolean underline)` Indicates whether underline font style.
`void`	`setVerticalAlignment(int vertAlignment)` Vertical alignment style.
`void`	`setWordSpacing(double wordSpacing)` The word spacing.
`void`	`setXOffset(double xOffset)` Text offset along X-axis.
`void`	`setYOffset(double yOffset)` Text offset along Y-axis.
`void`	`synchronizeParts(IDisplay pDisplay)` Synchronize the geometry with the text of the element.
`void`	`transform(int direction, ITransformation transformation)` Applies an arbitrary transformation.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TextElement

public TextElement()
            throws java.io.IOException,
                   java.net.UnknownHostException

Constructs a TextElement using ArcGIS Engine.
Throws:: java.io.IOException - if there are interop problems; java.net.UnknownHostException - if there are interop problems

TextElement

public TextElement(java.lang.Object obj)
            throws java.io.IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.; Construct a TextElement using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to TextElement.
TextElement theTextElement = (TextElement) obj;
Parameters:: obj - an object returned from ArcGIS Engine or Server
Throws:: java.io.IOException - if there are interop problems

Method Detail

getClsid

public static java.lang.String getClsid()

getAsIElement

public IElement getAsIElement()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIElementProperties

public IElementProperties getAsIElementProperties()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIElementProperties2

public IElementProperties2 getAsIElementProperties2()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIElementProperties3

public IElementProperties3 getAsIElementProperties3()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsITextElement

public ITextElement getAsITextElement()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIGraphicElement

public IGraphicElement getAsIGraphicElement()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIBoundsProperties

public IBoundsProperties getAsIBoundsProperties()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIGroupSymbolElement

public IGroupSymbolElement getAsIGroupSymbolElement()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsISymbolCollectionElement

public ISymbolCollectionElement getAsISymbolCollectionElement()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsITransform2D

public ITransform2D getAsITransform2D()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIPersistStream

public IPersistStream getAsIPersistStream()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIPropertySupport

public IPropertySupport getAsIPropertySupport()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIElementEditVertices

public IElementEditVertices getAsIElementEditVertices()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIElementEditCallout

public IElementEditCallout getAsIElementEditCallout()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIClone

public IClone getAsIClone()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIMultiPartTextElement

public IMultiPartTextElement getAsIMultiPartTextElement()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIXMLSerialize

public IXMLSerialize getAsIXMLSerialize()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

hashCode

public int hashCode()

the hashcode for this object

getGeometry

public IGeometry getGeometry()
                      throws java.io.IOException,
                             AutomationException

Description copied from interface: IElement

Shape of the element as a geometry.

Supported Platforms

Windows, Solaris, Linux

Description

Geometry is the shape assigned to this element.

Remarks

The Geometry property will return the shape associated with the element as an IGeometry. The geometry type of objects implementing IElement varies widely depending on what the element does. The remarks of each object implementing IElement will list the geometry types that are valid for that specific element.

Specified by:: getGeometry in interface IElement

Returns:: A reference to a com.esri.arcgis.geometry.IGeometry
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setGeometry

public void setGeometry(IGeometry pGeometry)
                 throws java.io.IOException,
                        AutomationException

Description copied from interface: IElement

Shape of the element as a geometry.

Supported Platforms

Windows, Solaris, Linux

Specified by:: setGeometry in interface IElement

Parameters:: pGeometry - A reference to a com.esri.arcgis.geometry.IGeometry (in)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

queryBounds

public void queryBounds(IDisplay display,
                        IEnvelope bounds)
                 throws java.io.IOException,
                        AutomationException

Description copied from interface: IElement

Bounds of the element taking symbology into consideration.

Supported Platforms

Windows, Solaris, Linux

Remarks

QueryBounds returns an envelope representing the boundary of the element. A valid envelope object must be passed in to the method along with the current display. The method then updates the envelope object based on the minimum bounding rectangle of the element.

Specified by:: queryBounds in interface IElement

Parameters:: display - A reference to a com.esri.arcgis.display.IDisplay (in); bounds - A reference to a com.esri.arcgis.geometry.IEnvelope (in)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

queryOutline

public void queryOutline(IDisplay display,
                         IPolygon outline)
                  throws java.io.IOException,
                         AutomationException

Description copied from interface: IElement

Bounds of the element taking symbology into consideration.

Supported Platforms

Windows, Solaris, Linux

Remarks

QueryOutline returns a polygon representing the outline of the element. A valid polygon object must be passed in to the method along with the current display. The method then updates the polygon object. The results for point and line elements will be similar to the minimum bounding envelope returned by QueryBounds, while the results for polygon elements while be the actual outline of the element (not the bounding envelope).

Specified by:: queryOutline in interface IElement

Parameters:: display - A reference to a com.esri.arcgis.display.IDisplay (in); outline - A reference to a com.esri.arcgis.geometry.IPolygon (in)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getSelectionTracker

public ISelectionTracker getSelectionTracker()
                                      throws java.io.IOException,
                                             AutomationException

Description copied from interface: IElement

Selection tracker used by this element.

Supported Platforms

Windows, Solaris, Linux

Remarks

SelectionTracker returns the ISelectionTracker used by the element. Elements have associated selection tracker objects which provide reshaping functionality. For example, in ArcMap after adding an element, the element is drawn with a selection tracker around it and users can then drag one of the selection handles on the selection tracker to modify the element's shape.

Specified by:: getSelectionTracker in interface IElement

Returns:: A reference to a com.esri.arcgis.display.ISelectionTracker
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.
See Also:: IElementEditVertices

hitTest

public boolean hitTest(double x,
                       double y,
                       double tolerance)
                throws java.io.IOException,
                       AutomationException

Description copied from interface: IElement

Indicates if the given x and y coordinates are contained by the element.

Supported Platforms

Windows, Solaris, Linux

Remarks

HitTest returns a boolean value indicating whether or not the current element is intersected by the specified coordinate pair and tolerance distance. For instance, if we have a line element selected, the HitTest is determining whether that line element is within the specified tolerance from the given X and Y. A value of TRUE is returned if the element is within the tolerance, while FALSE is returned if it is not.

The X,Y, and tolerance values should be specified in map units.

Specified by:: hitTest in interface IElement

Parameters:: x - The x (in); y - The y (in); tolerance - The tolerance (in)
Returns:: The hit
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

draw

public void draw(IDisplay display,
                 ITrackCancel trackCancel)
          throws java.io.IOException,
                 AutomationException

Description copied from interface: IElement

Draws the element into the given display object.

Supported Platforms

Windows, Solaris, Linux

Remarks

Draw draws the element to the screen display specified. An ITrackerCancel object can be passed in to enable cancelation of the draw wit the ESC key.

Symbolization of the element during the draw is based on the symbol that is stored with it. For instance, Marker Elements are displayed based on the Symbol property on the IMarkerElement interface.

Specified by:: draw in interface IElement

Parameters:: display - A reference to a com.esri.arcgis.display.IDisplay (in); trackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

activate

public void activate(IDisplay display)
              throws java.io.IOException,
                     AutomationException

Description copied from interface: IElement

Prepare to display graphic on screen.

Supported Platforms

Windows, Solaris, Linux

Remarks

Activate prepares the screen display for output and orients the scale of the element to the specified display. Activate should be executed with the current display before execute the IElement::Draw method.

Specified by:: activate in interface IElement

Parameters:: display - A reference to a com.esri.arcgis.display.IDisplay (in)
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

deactivate

public void deactivate()
                throws java.io.IOException,
                       AutomationException

Description copied from interface: IElement

ActiveView that graphics are displayed on is no longer visible.

Supported Platforms

Windows, Solaris, Linux

Remarks

Deactivate means the screen display associated with element output is no longer visible.

Specified by:: deactivate in interface IElement

Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isLocked

public boolean isLocked()
                 throws java.io.IOException,
                        AutomationException

Description copied from interface: IElement

Indicates if the element is in a read-only state.

Supported Platforms

Windows, Solaris, Linux

Remarks

The Locked property indicates whether the specified element can be updated. This property can be set to FALSE to stop users from modifying a particular element.

Specified by:: isLocked in interface IElement

Returns:: The pLocked
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

setLocked

public void setLocked(boolean pLocked)
               throws java.io.IOException,
                      AutomationException

Description copied from interface: IElement

Indicates if the element is in a read-only state.

Supported Platforms

Windows, Solaris, Linux

Specified by:: setLocked in interface IElement

Parameters:: pLocked - The pLocked (in)
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

getName

public java.lang.String getName()
                         throws java.io.IOException,
                                AutomationException

Description copied from interface: IElementProperties

Name of the element.

Supported Platforms

Windows, Solaris, Linux

Remarks

The Name property is used to store a name associated with the custom property assigned to the element.

Specified by:: getName in interface IElementProperties

Returns:: The name
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

setName

public void setName(java.lang.String name)
             throws java.io.IOException,
                    AutomationException

Description copied from interface: IElementProperties

Name of the element.

Supported Platforms

Windows, Solaris, Linux

Specified by:: setName in interface IElementProperties

Parameters:: name - The name (in)
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

getType

public java.lang.String getType()
                         throws java.io.IOException,
                                AutomationException

Description copied from interface: IElementProperties

Type of the element.

Supported Platforms

Windows, Solaris, Linux

Remarks

Type is a string used to specify the type of property that has been assigned to the element.

Specified by:: getType in interface IElementProperties

Returns:: The name
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

setType

public void setType(java.lang.String name)
             throws java.io.IOException,
                    AutomationException

Description copied from interface: IElementProperties

Type of the element.

Supported Platforms

Windows, Solaris, Linux

Specified by:: setType in interface IElementProperties

Parameters:: name - The name (in)
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

isAutoTransform

public boolean isAutoTransform()
                        throws java.io.IOException,
                               AutomationException

Description copied from interface: IElementProperties

Indicates if transform is applied to symbols and other parts of element. False = only apply transform to geometry.

Supported Platforms

Windows, Solaris, Linux

Remarks

AutoTransform is a boolean values that indicates whether internal setings should be transformed along with the elements's geometry, when a transform is applied via ITransform2D. For instance, if I have a point element and I rotate it around a central location (the anchor point of the rotation being different from the point element iself), then the AutoTransform property is used to determine whether the orientation of the symbol associated to the element should also be rotated by the same amount.

Specified by:: isAutoTransform in interface IElementProperties

Returns:: The autoTransform
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setAutoTransform

public void setAutoTransform(boolean autoTransform)
                      throws java.io.IOException,
                             AutomationException

Description copied from interface: IElementProperties

Indicates if transform is applied to symbols and other parts of element. False = only apply transform to geometry.

Supported Platforms

Windows, Solaris, Linux

Specified by:: setAutoTransform in interface IElementProperties

Parameters:: autoTransform - The autoTransform (in)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getCustomProperty

public java.lang.Object getCustomProperty()
                                   throws java.io.IOException,
                                          AutomationException

Description copied from interface: IElementProperties

Custom property.

Supported Platforms

Windows, Solaris, Linux

Remarks

CustomProperty is a place for developers to attach custom objects to an element. Previous versions of the software required that the specified variant be of type VT_UNKNOWN, i.e. a reference to an object, but that requirement has since been removed. Now, the CustomProperty can also be a simple type like an integer, double, boolean (VARIANT_BOOL) or a string (BSTR).

When this property is an object reference, the object must implement a persistence interface, so if you write a custom object it must implement IPersistStream or IPersistVariant. As an alternative to writing a custom object, you can use a PropertySet or XMLPropertySet, since they both already implement IPersistStream.

CustomProperty is never used by the core ArcObjects for its own elements, but the core software will expect to find an IPersistStream or IPersistVariant interface when the this property is an object reference, and it is part of an element being retrieved from or stored in an .mxd file.

Specified by:: getCustomProperty in interface IElementProperties

Returns:: A Variant
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

setCustomProperty

public void setCustomProperty(java.lang.Object customProperty)
                       throws java.io.IOException,
                              AutomationException

Description copied from interface: IElementProperties

Custom property.

Supported Platforms

Windows, Solaris, Linux

Remarks

Specified by:: setCustomProperty in interface IElementProperties

Parameters:: customProperty - A Variant (in)
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

canRotate

public boolean canRotate()
                  throws java.io.IOException,
                         AutomationException

Description copied from interface: IElementProperties2

Indicates if the element can be rotated.

Supported Platforms

Windows, Solaris, Linux

Specified by:: canRotate in interface IElementProperties2

Returns:: The canRotate
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

getReferenceScale

public double getReferenceScale()
                         throws java.io.IOException,
                                AutomationException

Description copied from interface: IElementProperties2

Reference scale of the element.

Supported Platforms

Windows, Solaris, Linux

Specified by:: getReferenceScale in interface IElementProperties2

Returns:: The referenceScale
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setReferenceScale

public void setReferenceScale(double referenceScale)
                       throws java.io.IOException,
                              AutomationException

Description copied from interface: IElementProperties2

Reference scale of the element.

Supported Platforms

Windows, Solaris, Linux

Specified by:: setReferenceScale in interface IElementProperties2

Parameters:: referenceScale - The referenceScale (in)
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

IElementProperties3_getAnchorPoint

public int IElementProperties3_getAnchorPoint()
                                       throws java.io.IOException,
                                              AutomationException

Description copied from interface: IElementProperties3

Anchor point of the element.

Specified by:: IElementProperties3_getAnchorPoint in interface IElementProperties3

Returns:: A com.esri.arcgis.carto.esriAnchorPointEnum constant
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setAnchorPoint

public void setAnchorPoint(int anchorPoint)
                    throws java.io.IOException,
                           AutomationException

Description copied from interface: IElementProperties3

Anchor point of the element.

Specified by:: setAnchorPoint in interface IElementProperties3

Parameters:: anchorPoint - A com.esri.arcgis.carto.esriAnchorPointEnum constant (in)
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

getSpatialReference

public ISpatialReference getSpatialReference()
                                      throws java.io.IOException,
                                             AutomationException

Description copied from interface: IElementProperties3

Spatial reference of the container.

Specified by:: getSpatialReference in interface IElementProperties3

Returns:: A reference to a com.esri.arcgis.geometry.ISpatialReference
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

setSpatialReferenceByRef

public void setSpatialReferenceByRef(ISpatialReference spatialRef)
                              throws java.io.IOException,
                                     AutomationException

Description copied from interface: IElementProperties3

Spatial reference of the container.

Specified by:: setSpatialReferenceByRef in interface IElementProperties3

Parameters:: spatialRef - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getSymbol

public ITextSymbol getSymbol()
                      throws java.io.IOException,
                             AutomationException

Description copied from interface: ITextElement

Text symbol this element uses to draw itself.

Supported Platforms

Windows, Solaris, Linux

Remarks

The Symbol property returns or sets the ITextSymbol associated with the TextElement. The Symbol property represents the symbology being used to display the text on the map.

The size characteristic of the Symbol property is also affected by the ScaleText property. If this property is set to True, the size will scale along with the current scale of the map. If the ScaleText property is False, then the size will remain constant.

Specified by:: getSymbol in interface ITextElement

Returns:: A reference to a com.esri.arcgis.display.ITextSymbol
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setSymbol

public void setSymbol(ITextSymbol symbol)
               throws java.io.IOException,
                      AutomationException

Description copied from interface: ITextElement

Text symbol this element uses to draw itself.

Supported Platforms

Windows, Solaris, Linux

Specified by:: setSymbol in interface ITextElement

Parameters:: symbol - A reference to a com.esri.arcgis.display.ITextSymbol (in)
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

getText

public java.lang.String getText()
                         throws java.io.IOException,
                                AutomationException

Description copied from interface: ITextElement

Text being displayed by this element.

Supported Platforms

Windows, Solaris, Linux

Remarks

The Text property returns or sets the text string used displayed on the map. Use this property to manipulate the string associated with the TextElement.

Specified by:: getText in interface ITextElement

Returns:: The text
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

setText

public void setText(java.lang.String text)
             throws java.io.IOException,
                    AutomationException

Description copied from interface: ITextElement

Text being displayed by this element.

Supported Platforms

Windows, Solaris, Linux

Specified by:: setText in interface ITextElement

Parameters:: text - The text (in)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isScaleText

public boolean isScaleText()
                    throws java.io.IOException,
                           AutomationException

Description copied from interface: ITextElement

Indicates if the text scales with the map.

Supported Platforms

Windows, Solaris, Linux

Remarks

The ScaleText property specifies whether or not the size of the TextElement should change when the scale of the map changes. If the ScaleText property is set to True, then the size of the text will increase or decrease along with the scale of the map. If the property is False, then the size will remain constant.

The actual size of the text on the screen is based on the Symbol property of the TextElement and the setting of the ScaleText property. When the ScaleText property is True, the size of the TextElement will be a combination of the Symbol property, the reference scale for the layer, and the current scale of the map.

Specified by:: isScaleText in interface ITextElement

Returns:: The scale
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setScaleText

public void setScaleText(boolean scale)
                  throws java.io.IOException,
                         AutomationException

Description copied from interface: ITextElement

Indicates if the text scales with the map.

Supported Platforms

Windows, Solaris, Linux

Specified by:: setScaleText in interface ITextElement

Parameters:: scale - The scale (in)
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

isFixedAspectRatio

public boolean isFixedAspectRatio()
                           throws java.io.IOException,
                                  AutomationException

Description copied from interface: IBoundsProperties

Indicates if the bounds has a fixed aspect ratio.

Supported Platforms

Windows, Solaris, Linux

Specified by:: isFixedAspectRatio in interface IBoundsProperties

Returns:: The flag
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

setFixedAspectRatio

public void setFixedAspectRatio(boolean flag)
                         throws java.io.IOException,
                                AutomationException

Description copied from interface: IBoundsProperties

Indicates if the bounds has a fixed aspect ratio.

Supported Platforms

Windows, Solaris, Linux

Specified by:: setFixedAspectRatio in interface IBoundsProperties

Parameters:: flag - The flag (in)
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

isFixedSize

public boolean isFixedSize()
                    throws java.io.IOException,
                           AutomationException

Description copied from interface: IBoundsProperties

Indicates if size is determined by some other property like the symbol.

Supported Platforms

Windows, Solaris, Linux

Specified by:: isFixedSize in interface IBoundsProperties

Returns:: The flag
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getSymbolID

public int getSymbolID()
                throws java.io.IOException,
                       AutomationException

Description copied from interface: IGroupSymbolElement

Symbol ID associated with this element.

Supported Platforms

Windows, Solaris, Linux

Specified by:: getSymbolID in interface IGroupSymbolElement

Returns:: The symbolID
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setSymbolID

public void setSymbolID(int symbolID)
                 throws java.io.IOException,
                        AutomationException

Description copied from interface: IGroupSymbolElement

Symbol ID associated with this element.

Supported Platforms

Windows, Solaris, Linux

Specified by:: setSymbolID in interface IGroupSymbolElement

Parameters:: symbolID - The symbolID (in)
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

setGroupSymbol

public void setGroupSymbol(int symbolID,
                           ISymbol rhs2)
                    throws java.io.IOException,
                           AutomationException

Description copied from interface: IGroupSymbolElement

The symbol ID associated with this element.

Supported Platforms

Windows, Solaris, Linux

Specified by:: setGroupSymbol in interface IGroupSymbolElement

Parameters:: symbolID - The symbolID (in); rhs2 - A reference to a com.esri.arcgis.display.ISymbol (in)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

exportToESRIAnno

public void exportToESRIAnno(IStream stream)
                      throws java.io.IOException,
                             AutomationException

Description copied from interface: IGroupSymbolElement

Saves the anno in a compressed format.

Supported Platforms

Windows, Solaris, Linux

Specified by:: exportToESRIAnno in interface IGroupSymbolElement

Parameters:: stream - A reference to a com.esri.arcgis.system.IStream (in)
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

importFromESRIAnno

public void importFromESRIAnno(IStream stream,
                               ISpatialReference spatialReference)
                        throws java.io.IOException,
                               AutomationException

Description copied from interface: IGroupSymbolElement

Loads the anno in a compressed format.

Supported Platforms

Windows, Solaris, Linux

Specified by:: importFromESRIAnno in interface IGroupSymbolElement

Parameters:: stream - A reference to a com.esri.arcgis.system.IStream (in); spatialReference - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

drawESRIAnno

public void drawESRIAnno(IStream stream,
                         ISymbolCollection symbolCollection,
                         ISpatialReference spatialRef,
                         IDisplay display)
                  throws java.io.IOException,
                         AutomationException

Description copied from interface: IGroupSymbolElement

Draws the anno in a compressed format.

Supported Platforms

Windows, Solaris, Linux

Specified by:: drawESRIAnno in interface IGroupSymbolElement

Parameters:: stream - A reference to a com.esri.arcgis.system.IStream (in); symbolCollection - A reference to a com.esri.arcgis.display.ISymbolCollection (in); spatialRef - A reference to a com.esri.arcgis.geometry.ISpatialReference (in); display - A reference to a com.esri.arcgis.display.IDisplay (in)
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

getXOffset

public double getXOffset()
                  throws java.io.IOException,
                         AutomationException

Description copied from interface: IGroupSymbolElement

Text offset along X-axis.

Supported Platforms

Windows, Solaris, Linux

Specified by:: getXOffset in interface IGroupSymbolElement

Returns:: The xOffset
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setXOffset

public void setXOffset(double xOffset)
                throws java.io.IOException,
                       AutomationException

Description copied from interface: IGroupSymbolElement

Text offset along X-axis.

Supported Platforms

Windows, Solaris, Linux

Specified by:: setXOffset in interface IGroupSymbolElement

Parameters:: xOffset - The xOffset (in)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getYOffset

public double getYOffset()
                  throws java.io.IOException,
                         AutomationException

Description copied from interface: IGroupSymbolElement

Text offset along Y-axis.

Supported Platforms

Windows, Solaris, Linux

Specified by:: getYOffset in interface IGroupSymbolElement

Returns:: The yOffset
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setYOffset

public void setYOffset(double yOffset)
                throws java.io.IOException,
                       AutomationException

Description copied from interface: IGroupSymbolElement

Text offset along Y-axis.

Supported Platforms

Windows, Solaris, Linux

Specified by:: setYOffset in interface IGroupSymbolElement

Parameters:: yOffset - The yOffset (in)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getVerticalAlignment

public int getVerticalAlignment()
                         throws java.io.IOException,
                                AutomationException

Description copied from interface: IGroupSymbolElement

Vertical alignment style.

Supported Platforms

Windows, Solaris, Linux

Specified by:: getVerticalAlignment in interface IGroupSymbolElement

Returns:: A com.esri.arcgis.display.esriTextVerticalAlignment constant
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

setVerticalAlignment

public void setVerticalAlignment(int vertAlignment)
                          throws java.io.IOException,
                                 AutomationException

Description copied from interface: IGroupSymbolElement

Vertical alignment style.

Supported Platforms

Windows, Solaris, Linux

Specified by:: setVerticalAlignment in interface IGroupSymbolElement

Parameters:: vertAlignment - A com.esri.arcgis.display.esriTextVerticalAlignment constant (in)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getHorizontalAlignment

public int getHorizontalAlignment()
                           throws java.io.IOException,
                                  AutomationException

Description copied from interface: IGroupSymbolElement

Horizontal alignment style.

Supported Platforms

Windows, Solaris, Linux

Specified by:: getHorizontalAlignment in interface IGroupSymbolElement

Returns:: A com.esri.arcgis.display.esriTextHorizontalAlignment constant
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setHorizontalAlignment

public void setHorizontalAlignment(int horizAlignment)
                            throws java.io.IOException,
                                   AutomationException

Description copied from interface: IGroupSymbolElement

Horizontal alignment style.

Supported Platforms

Windows, Solaris, Linux

Specified by:: setHorizontalAlignment in interface IGroupSymbolElement

Parameters:: horizAlignment - A com.esri.arcgis.display.esriTextHorizontalAlignment constant (in)
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

getFlipAngle

public double getFlipAngle()
                    throws java.io.IOException,
                           AutomationException

Description copied from interface: IGroupSymbolElement

Flip angle.

Supported Platforms

Windows, Solaris, Linux

Specified by:: getFlipAngle in interface IGroupSymbolElement

Returns:: The flipAngle
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

setFlipAngle

public void setFlipAngle(double flipAngle)
                  throws java.io.IOException,
                         AutomationException

Description copied from interface: IGroupSymbolElement

Flip angle.

Supported Platforms

Windows, Solaris, Linux

Specified by:: setFlipAngle in interface IGroupSymbolElement

Parameters:: flipAngle - The flipAngle (in)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

IGroupSymbolElement_getAnchorPoint

public IPoint IGroupSymbolElement_getAnchorPoint()
                                          throws java.io.IOException,
                                                 AutomationException

Description copied from interface: IGroupSymbolElement

Callout anchor point.

Specified by:: IGroupSymbolElement_getAnchorPoint in interface IGroupSymbolElement

Returns:: A reference to a com.esri.arcgis.geometry.IPoint
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

setAnchorPoint

public void setAnchorPoint(IPoint anchorPoint)
                    throws java.io.IOException,
                           AutomationException

Description copied from interface: IGroupSymbolElement

Callout anchor point.

Supported Platforms

Windows, Solaris, Linux

Specified by:: setAnchorPoint in interface IGroupSymbolElement

Parameters:: anchorPoint - A reference to a com.esri.arcgis.geometry.IPoint (in)
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

getSize

public double getSize()
               throws java.io.IOException,
                      AutomationException

Description copied from interface: IGroupSymbolElement

Font size.

Supported Platforms

Windows, Solaris, Linux

Specified by:: getSize in interface IGroupSymbolElement

Returns:: The pointSize
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setSize

public void setSize(double pointSize)
             throws java.io.IOException,
                    AutomationException

Description copied from interface: IGroupSymbolElement

Font size.

Supported Platforms

Windows, Solaris, Linux

Specified by:: setSize in interface IGroupSymbolElement

Parameters:: pointSize - The pointSize (in)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getColor

public IColor getColor()
                throws java.io.IOException,
                       AutomationException

Description copied from interface: IGroupSymbolElement

Font color.

Supported Platforms

Windows, Solaris, Linux

Specified by:: getColor in interface IGroupSymbolElement

Returns:: A reference to a com.esri.arcgis.display.IColor
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

setColor

public void setColor(IColor color)
              throws java.io.IOException,
                     AutomationException

Description copied from interface: IGroupSymbolElement

Font color.

Supported Platforms

Windows, Solaris, Linux

Specified by:: setColor in interface IGroupSymbolElement

Parameters:: color - A reference to a com.esri.arcgis.display.IColor (in)
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

getTextPath

public ITextPath getTextPath()
                      throws java.io.IOException,
                             AutomationException

Description copied from interface: IGroupSymbolElement

Text path.

Supported Platforms

Windows, Solaris, Linux

Specified by:: getTextPath in interface IGroupSymbolElement

Returns:: A reference to a com.esri.arcgis.display.ITextPath
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setTextPathByRef

public void setTextPathByRef(ITextPath textPath)
                      throws java.io.IOException,
                             AutomationException

Description copied from interface: IGroupSymbolElement

Text path.

Specified by:: setTextPathByRef in interface IGroupSymbolElement

Parameters:: textPath - A reference to a com.esri.arcgis.display.ITextPath (in)
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

setSharedSymbol

public void setSharedSymbol(int symbolID,
                            ISymbol rhs2)
                     throws java.io.IOException,
                            AutomationException

Description copied from interface: ISymbolCollectionElement

The symbol ID associated with this element.

Supported Platforms

Windows, Solaris, Linux

Specified by:: setSharedSymbol in interface ISymbolCollectionElement

Parameters:: symbolID - The symbolID (in); rhs2 - A reference to a com.esri.arcgis.display.ISymbol (in)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getSharedSymbol

public ISymbol getSharedSymbol()
                        throws java.io.IOException,
                               AutomationException

Description copied from interface: ISymbolCollectionElement

Collection symbol.

Supported Platforms

Windows, Solaris, Linux

Specified by:: getSharedSymbol in interface ISymbolCollectionElement

Returns:: A reference to a com.esri.arcgis.display.ISymbol
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

importFromESRIAnno

public void importFromESRIAnno(IStream stream,
                               ISpatialReference spatialReference,
                               ISymbolCollection symbolCollection)
                        throws java.io.IOException,
                               AutomationException

Description copied from interface: ISymbolCollectionElement

Loads the anno in a compressed format.

Supported Platforms

Windows, Solaris, Linux

Specified by:: importFromESRIAnno in interface ISymbolCollectionElement

Parameters:: stream - A reference to a com.esri.arcgis.system.IStream (in); spatialReference - A reference to a com.esri.arcgis.geometry.ISpatialReference (in); symbolCollection - A reference to a com.esri.arcgis.display.ISymbolCollection (in)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

ISymbolCollectionElement_getAnchorPoint

public IPoint ISymbolCollectionElement_getAnchorPoint()
                                               throws java.io.IOException,
                                                      AutomationException

Description copied from interface: ISymbolCollectionElement

Callout anchor point.

Specified by:: ISymbolCollectionElement_getAnchorPoint in interface ISymbolCollectionElement

Returns:: A reference to a com.esri.arcgis.geometry.IPoint
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

getCharacterSpacing

public double getCharacterSpacing()
                           throws java.io.IOException,
                                  AutomationException

Description copied from interface: ISymbolCollectionElement

The character spacing.

Supported Platforms

Windows, Solaris, Linux

Specified by:: getCharacterSpacing in interface ISymbolCollectionElement

Returns:: The characterSpacing
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

setCharacterSpacing

public void setCharacterSpacing(double characterSpacing)
                         throws java.io.IOException,
                                AutomationException

Description copied from interface: ISymbolCollectionElement

The character spacing.

Supported Platforms

Windows, Solaris, Linux

Specified by:: setCharacterSpacing in interface ISymbolCollectionElement

Parameters:: characterSpacing - The characterSpacing (in)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getCharacterWidth

public double getCharacterWidth()
                         throws java.io.IOException,
                                AutomationException

Description copied from interface: ISymbolCollectionElement

The character width.

Supported Platforms

Windows, Solaris, Linux

Specified by:: getCharacterWidth in interface ISymbolCollectionElement

Returns:: The characterWidth
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

setCharacterWidth

public void setCharacterWidth(double characterWidth)
                       throws java.io.IOException,
                              AutomationException

Description copied from interface: ISymbolCollectionElement

The character width.

Supported Platforms

Windows, Solaris, Linux

Specified by:: setCharacterWidth in interface ISymbolCollectionElement

Parameters:: characterWidth - The characterWidth (in)
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

getWordSpacing

public double getWordSpacing()
                      throws java.io.IOException,
                             AutomationException

Description copied from interface: ISymbolCollectionElement

The word spacing.

Supported Platforms

Windows, Solaris, Linux

Specified by:: getWordSpacing in interface ISymbolCollectionElement

Returns:: The wordSpacing
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setWordSpacing

public void setWordSpacing(double wordSpacing)
                    throws java.io.IOException,
                           AutomationException

Description copied from interface: ISymbolCollectionElement

The word spacing.

Supported Platforms

Windows, Solaris, Linux

Specified by:: setWordSpacing in interface ISymbolCollectionElement

Parameters:: wordSpacing - The wordSpacing (in)
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

getLeading

public double getLeading()
                  throws java.io.IOException,
                         AutomationException

Description copied from interface: ISymbolCollectionElement

The character leading.

Supported Platforms

Windows, Solaris, Linux

Specified by:: getLeading in interface ISymbolCollectionElement

Returns:: The leading
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

setLeading

public void setLeading(double leading)
                throws java.io.IOException,
                       AutomationException

Description copied from interface: ISymbolCollectionElement

The character leading.

Supported Platforms

Windows, Solaris, Linux

Specified by:: setLeading in interface ISymbolCollectionElement

Parameters:: leading - The leading (in)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isBold

public boolean isBold()
               throws java.io.IOException,
                      AutomationException

Description copied from interface: ISymbolCollectionElement

Indicates whether bold fonts style.

Supported Platforms

Windows, Solaris, Linux

Specified by:: isBold in interface ISymbolCollectionElement

Returns:: The bold
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setBold

public void setBold(boolean bold)
             throws java.io.IOException,
                    AutomationException

Description copied from interface: ISymbolCollectionElement

Indicates whether bold fonts style.

Supported Platforms

Windows, Solaris, Linux

Specified by:: setBold in interface ISymbolCollectionElement

Parameters:: bold - The bold (in)
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

getFontName

public java.lang.String getFontName()
                             throws java.io.IOException,
                                    AutomationException

Description copied from interface: ISymbolCollectionElement

Font name.

Supported Platforms

Windows, Solaris, Linux

Specified by:: getFontName in interface ISymbolCollectionElement

Returns:: The fontName
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

setFontName

public void setFontName(java.lang.String fontName)
                 throws java.io.IOException,
                        AutomationException

Description copied from interface: ISymbolCollectionElement

Font name.

Supported Platforms

Windows, Solaris, Linux

Specified by:: setFontName in interface ISymbolCollectionElement

Parameters:: fontName - The fontName (in)
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

isItalic

public boolean isItalic()
                 throws java.io.IOException,
                        AutomationException

Description copied from interface: ISymbolCollectionElement

Indicates whether italic font style.

Supported Platforms

Windows, Solaris, Linux

Specified by:: isItalic in interface ISymbolCollectionElement

Returns:: The italic
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

setItalic

public void setItalic(boolean italic)
               throws java.io.IOException,
                      AutomationException

Description copied from interface: ISymbolCollectionElement

Indicates whether italic font style.

Supported Platforms

Windows, Solaris, Linux

Specified by:: setItalic in interface ISymbolCollectionElement

Parameters:: italic - The italic (in)
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

isUnderline

public boolean isUnderline()
                    throws java.io.IOException,
                           AutomationException

Description copied from interface: ISymbolCollectionElement

Indicates whether underline font style.

Supported Platforms

Windows, Solaris, Linux

Specified by:: isUnderline in interface ISymbolCollectionElement

Returns:: The underline
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

setUnderline

public void setUnderline(boolean underline)
                  throws java.io.IOException,
                         AutomationException

Description copied from interface: ISymbolCollectionElement

Indicates whether underline font style.

Supported Platforms

Windows, Solaris, Linux

Specified by:: setUnderline in interface ISymbolCollectionElement

Parameters:: underline - The underline (in)
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

getBackground

public ITextBackground getBackground()
                              throws java.io.IOException,
                                     AutomationException

Description copied from interface: ISymbolCollectionElement

Background symbol.

Supported Platforms

Windows, Solaris, Linux

Specified by:: getBackground in interface ISymbolCollectionElement

Returns:: A reference to a com.esri.arcgis.display.ITextBackground
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

setBackgroundByRef

public void setBackgroundByRef(ITextBackground symbol)
                        throws java.io.IOException,
                               AutomationException

Description copied from interface: ISymbolCollectionElement

Background symbol.

Specified by:: setBackgroundByRef in interface ISymbolCollectionElement

Parameters:: symbol - A reference to a com.esri.arcgis.display.ITextBackground (in)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setOverriddenProperties

public void setOverriddenProperties(int props)
                             throws java.io.IOException,
                                    AutomationException

Description copied from interface: ISymbolCollectionElement

Overridden properties.

Supported Platforms

Windows, Solaris, Linux

Specified by:: setOverriddenProperties in interface ISymbolCollectionElement

Parameters:: props - The props (in)
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

getOverriddenProperties

public int getOverriddenProperties()
                            throws java.io.IOException,
                                   AutomationException

Description copied from interface: ISymbolCollectionElement

Overridden properties.

Supported Platforms

Windows, Solaris, Linux

Remarks

This property returns the sum of values which represent the overriden properties of this element. This property can be evaluated by performing an Xor comparison of the value and the individual override values availible from esriSymbolOverrideEnum. If the element is not referencing a symbol in the symbol collection, this value will be 0.

To reset the element to have no overrides, set the value of the property to 0. Putting values into this property can be used to clear overrides. For instance, if the overrride value is 3 meaning that both X and Y Offset are overriden, you can set the override value to 1 and remove the Y Offset.

Specified by:: getOverriddenProperties in interface ISymbolCollectionElement

Returns:: The props
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setOverriddenPropertiesExclusionMask

public void setOverriddenPropertiesExclusionMask(int mask)
                                          throws java.io.IOException,
                                                 AutomationException

Description copied from interface: ISymbolCollectionElement

Mask used to exclude overrides when drawing.

Supported Platforms

Windows, Solaris, Linux

Specified by:: setOverriddenPropertiesExclusionMask in interface ISymbolCollectionElement

Parameters:: mask - The mask (in)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getOverriddenPropertiesExclusionMask

public int getOverriddenPropertiesExclusionMask()
                                         throws java.io.IOException,
                                                AutomationException

Description copied from interface: ISymbolCollectionElement

Mask used to exclude overrides when drawing.

Supported Platforms

Windows, Solaris, Linux

Specified by:: getOverriddenPropertiesExclusionMask in interface ISymbolCollectionElement

Returns:: The mask
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

move

public void move(double dx,
                 double dy)
          throws java.io.IOException,
                 AutomationException

Description copied from interface: ITransform2D

Moves dx units horizontally and dy units vertically.

Supported Platforms

Windows, Solaris, Linux

Description

Moves the Geometry dX units along the X-Axis and dY units along the Y-Axis. Only changes the position of the Geometry without altering any of the other characteristics. Move is a spatial offset.

Remarks

Transform2D Move Example

Specified by:: move in interface ITransform2D

Parameters:: dx - The dx (in); dy - The dy (in)
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

moveVector

public void moveVector(ILine v)
                throws java.io.IOException,
                       AutomationException

Description copied from interface: ITransform2D

Moves a direction and distance v. v can be in a different spatial reference than the geometry being moved.

Supported Platforms

Windows, Solaris, Linux

Description

Moves the Geometry dX units along the X-Axis and dY units along the Y-Axis, where dX and dY are calculated from the input vector Line. Only the Length and Angle of the vector affect the transformation. The location of the vector does not change the transformation. Only changes the position of the Geometry without altering any of the other characteristics. Move is a spatial offset.

Remarks

Transform2D MoveVector Example

Specified by:: moveVector in interface ITransform2D

Parameters:: v - A reference to a com.esri.arcgis.geometry.ILine (in)
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

scale

public void scale(IPoint origin,
                  double sx,
                  double sy)
           throws java.io.IOException,
                  AutomationException

Description copied from interface: ITransform2D

Scales about the specified origin using seperate horizonal and vertical scales. The origin point can be in a different spatial reference than the geometry being scaled.

Supported Platforms

Windows, Solaris, Linux

Description

Stretches the Geometry a factor of sX along the X-Axis and a factor of sY along the Y-Axis (where sX is the ratio of Old Width to New Width, and sY is the ratio of Old Height to New Height). The Origin point is the reference Point from which the transformation is performed (Regardless of the location of the Origin point, the Geometry resulting from the transformation is the same, except for a positional offset). The Origin is the only point in the transformation guaranted to remain in the same location after the transformation is complete.

Remarks

Note: Caution must be taken when scaling a CircularArc or a geometry containing CircularArc segments. Unless Abs(ScaleX) = Abs(ScaleY), the resulting CircularArcs will not retain the characteristics of the original geometry (since they remain CircularArcs).

Scale Example

Specified by:: scale in interface ITransform2D

Parameters:: origin - A reference to a com.esri.arcgis.geometry.IPoint (in); sx - The sx (in); sy - The sy (in)
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

rotate

public void rotate(IPoint origin,
                   double rotationAngle)
            throws java.io.IOException,
                   AutomationException

Description copied from interface: ITransform2D

Rotates about the specified origin point. The angle is in radians. The origin can be in a different spatial reference than the geometry being rotated.

Supported Platforms

Windows, Solaris, Linux

Description

Rotate performs an angular transform (rotation) on the Geometry. The Origin is the only point in the transformation guaranteed to remain in the same location after the transformation is performed. Regardless of the Origin, the transformed Geometry is the same, except for a positional offset. The RotationAngle is measured in radians.

Remarks

An Envelope cannot be Rotated.

Transform2D Rotate Example

Specified by:: rotate in interface ITransform2D

Parameters:: origin - A reference to a com.esri.arcgis.geometry.IPoint (in); rotationAngle - The rotationAngle (in)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

transform

public void transform(int direction,
                      ITransformation transformation)
               throws java.io.IOException,
                      AutomationException

Description copied from interface: ITransform2D

Applies an arbitrary transformation. In particular, the transformation parameter can be either an affine transformation or a geographic transformation (datum shift).

Supported Platforms

Windows, Solaris, Linux

Specified by:: transform in interface ITransform2D

Parameters:: direction - A com.esri.arcgis.geometry.esriTransformDirection constant (in); transformation - A reference to a com.esri.arcgis.geometry.ITransformation (in)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws java.io.IOException,
                    AutomationException

Description copied from interface: IPersistStream

Supported Platforms

Windows, Solaris, Linux

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Specified by:: isDirty in interface IPersistStream

Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws java.io.IOException,
                 AutomationException

Description copied from interface: IPersistStream

Supported Platforms

Windows, Solaris, Linux

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Specified by:: load in interface IPersistStream

Parameters:: pstm - A reference to a com.esri.arcgis.system.IStream (in)
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

save

public void save(IStream pstm,
                 int fClearDirty)
          throws java.io.IOException,
                 AutomationException

Description copied from interface: IPersistStream

Supported Platforms

Windows, Solaris, Linux

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Specified by:: save in interface IPersistStream

Parameters:: pstm - A reference to a com.esri.arcgis.system.IStream (in); fClearDirty - The fClearDirty (in)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getSizeMax

public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
                throws java.io.IOException,
                       AutomationException

Description copied from interface: IPersistStream

Supported Platforms

Windows, Solaris, Linux

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Specified by:: getSizeMax in interface IPersistStream

Parameters:: pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

getClassID

public void getClassID(GUID[] pClassID)
                throws java.io.IOException,
                       AutomationException

Description copied from interface: IPersist

Supported Platforms

Windows, Solaris, Linux

Description

IPersist is a Microsoft interface. Please refer to MSDN for information about this interface.

Specified by:: getClassID in interface IPersist

Parameters:: pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

applies

public boolean applies(java.lang.Object pUnk)
                throws java.io.IOException,
                       AutomationException

Description copied from interface: IPropertySupport

Indicates if the receiver can apply the given object at any given time.

Supported Platforms

Windows, Solaris, Linux

Remarks

Applies indicates whether the specified object can be applied to the current object. For instance, we might want to ask our CircleElement whether a Color object applies to it. If it does, then we can use the Apply method to update our CircleElement with the new Color object.

CanApply differs from Applies in that it is a check for the editability of the object at any given time. Applies indicates whether an object can be applied at all, while CanApply indicates whether an object can be applied at that particular moment.

Specified by:: applies in interface IPropertySupport

Parameters:: pUnk - A reference to another Object (IUnknown) (in)
Returns:: The applies
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

canApply

public boolean canApply(java.lang.Object pUnk)
                 throws java.io.IOException,
                        AutomationException

Description copied from interface: IPropertySupport

Indicates if the receiver can apply the given object at that particular moment.

Supported Platforms

Windows, Solaris, Linux

Remarks

CanApply indicates whether the specified object can be applied to the current object. For instance, we might want to ask our CircleElement whether a Color object applies to it. If it does, then we can use the Apply method to update our CircleElement with the new Color object.

CanApply differs from Applies in that it is a check for the editability of the object at any given time. Applies indicates whether an object can be applied at all, while CanApply indicates whether an object can be applied at that particular moment.

Specified by:: canApply in interface IPropertySupport

Parameters:: pUnk - A reference to another Object (IUnknown) (in)
Returns:: The canApply
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

getCurrent

public java.lang.Object getCurrent(java.lang.Object pUnk)
                            throws java.io.IOException,
                                   AutomationException

Description copied from interface: IPropertySupport

The object currently being used.

Supported Platforms

Windows, Solaris, Linux

Remarks

Current will return you the current object of the specified type. For instance, I may ask a CircleElement if it supports a Color object. If it does, then I can use Current to get the Color object currently applied to my CircleElement.

Specified by:: getCurrent in interface IPropertySupport

Parameters:: pUnk - A reference to another Object (IUnknown) (in)
Returns:: A reference to another Object (IUnknown)
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

apply

public java.lang.Object apply(java.lang.Object newObject)
                       throws java.io.IOException,
                              AutomationException

Description copied from interface: IPropertySupport

Applies the given property to the receiver and returns the old object.

Supported Platforms

Windows, Solaris, Linux

Remarks

Apply will apply the specified object to the current object. For instance, I might apply a Color object to my RectangleElement. When I execute Apply, the object I replace (the old object) is returned.

Use the Applies and CanApply methods to determine if an Apply can be used on an object.

Specified by:: apply in interface IPropertySupport

Parameters:: newObject - A reference to another Object (IUnknown) (in)
Returns:: A reference to another Object (IUnknown)
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

getMoveVerticesSelectionTracker

public ISelectionTracker getMoveVerticesSelectionTracker()
                                                  throws java.io.IOException,
                                                         AutomationException

Description copied from interface: IElementEditVertices

Selection tracker to move points used by this element.

Supported Platforms

Windows, Solaris, Linux

Remarks

GetMoveVerticesSelection returns the ISelectionTracker being used to edit the vertices of the graphic element. This method is unaffected by the MovingVertices flag. The selection tracker returned will always be the appropriate one to use for moving the vertex points of this object. The MovingVertices property is independent and just tells get_SelectionTracker to either hand out the normal selection tracker or forward the call on to GetMoveVerticesSelectionTracker.

Specified by:: getMoveVerticesSelectionTracker in interface IElementEditVertices

Returns:: A reference to a com.esri.arcgis.display.ISelectionTracker
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

isMovingVertices

public boolean isMovingVertices()
                         throws java.io.IOException,
                                AutomationException

Description copied from interface: IElementEditVertices

Indicates if this element is moving its vertices.

Supported Platforms

Windows, Solaris, Linux

Remarks

This flag controls what type of selection tracker is used when one is requested from this object. If True , it will be a vertex point type. If False , it will be an object envelope type.

Specified by:: isMovingVertices in interface IElementEditVertices

Returns:: The flag
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setMovingVertices

public void setMovingVertices(boolean flag)
                       throws java.io.IOException,
                              AutomationException

Description copied from interface: IElementEditVertices

Indicates if this element is moving its vertices.

Supported Platforms

Windows, Solaris, Linux

Remarks

This flag controls what type of selection tracker is used when one is requested from this object. If True , it will be a vertex point type. If False , it will be an object envelope type.

Specified by:: setMovingVertices in interface IElementEditVertices

Parameters:: flag - The flag (in)
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

getMoveTextSelectionTracker

public ISelectionTracker getMoveTextSelectionTracker()
                                              throws java.io.IOException,
                                                     AutomationException

Description copied from interface: IElementEditCallout

Returns the selection tracker to move the text used by this element.

Supported Platforms

Windows, Solaris, Linux

Specified by:: getMoveTextSelectionTracker in interface IElementEditCallout

Returns:: A reference to a com.esri.arcgis.display.ISelectionTracker
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

isEditingCallout

public boolean isEditingCallout()
                         throws java.io.IOException,
                                AutomationException

Description copied from interface: IElementEditCallout

Indicates if this element is editing it's callout.

Supported Platforms

Windows, Solaris, Linux

Specified by:: isEditingCallout in interface IElementEditCallout

Returns:: The flag
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setEditingCallout

public void setEditingCallout(boolean flag)
                       throws java.io.IOException,
                              AutomationException

Description copied from interface: IElementEditCallout

Indicates if this element is editing it's callout.

Supported Platforms

Windows, Solaris, Linux

Specified by:: setEditingCallout in interface IElementEditCallout

Parameters:: flag - The flag (in)
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

esri_clone

public IClone esri_clone()
                  throws java.io.IOException,
                         AutomationException

Description copied from interface: IClone

Clones the receiver and assigns the result to *clone.

Specified by:: esri_clone in interface IClone

Returns:: A reference to a com.esri.arcgis.system.IClone
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

assign

public void assign(IClone src)
            throws java.io.IOException,
                   AutomationException

Description copied from interface: IClone

Assigns the properties of src to the receiver.

Supported Platforms

Windows, Solaris, Linux

Description

Use Assign method to assign the properties of source object to receiver object. Both objects need to have the same CLSIDs. Both source and receiver objects need to be instantiated.

Specified by:: assign in interface IClone

Parameters:: src - A reference to a com.esri.arcgis.system.IClone (in)
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

isEqual

public boolean isEqual(IClone other)
                throws java.io.IOException,
                       AutomationException

Description copied from interface: IClone

Returns TRUE when the receiver and other have the same properties.

Specified by:: isEqual in interface IClone

Parameters:: other - A reference to a com.esri.arcgis.system.IClone (in)
Returns:: The equal
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

isIdentical

public boolean isIdentical(IClone other)
                    throws java.io.IOException,
                           AutomationException

Description copied from interface: IClone

Returns TRUE when the receiver and other are the same object.

Specified by:: isIdentical in interface IClone

Parameters:: other - A reference to a com.esri.arcgis.system.IClone (in)
Returns:: The identical
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

convertToMultiPart

public void convertToMultiPart(IDisplay pDisplay)
                        throws java.io.IOException,
                               AutomationException

Description copied from interface: IMultiPartTextElement

Converts the current element into a multipart element.

Supported Platforms

Windows, Solaris, Linux

Specified by:: convertToMultiPart in interface IMultiPartTextElement

Parameters:: pDisplay - A reference to a com.esri.arcgis.display.IDisplay (in)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

convertToSinglePart

public void convertToSinglePart()
                         throws java.io.IOException,
                                AutomationException

Description copied from interface: IMultiPartTextElement

Converts the current element into a single part element.

Supported Platforms

Windows, Solaris, Linux

Specified by:: convertToSinglePart in interface IMultiPartTextElement

Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

isMultipart

public boolean isMultipart()
                    throws java.io.IOException,
                           AutomationException

Description copied from interface: IMultiPartTextElement

Indicates if the element is multi part.

Specified by:: isMultipart in interface IMultiPartTextElement

Returns:: The isMultiPartElement
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getPartCount

public int getPartCount()
                 throws java.io.IOException,
                        AutomationException

Description copied from interface: IMultiPartTextElement

The number of parts in the multipart element.

Supported Platforms

Windows, Solaris, Linux

Specified by:: getPartCount in interface IMultiPartTextElement

Returns:: The count
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

queryPart

public IElement queryPart(int index)
                   throws java.io.IOException,
                          AutomationException

Description copied from interface: IMultiPartTextElement

Returns the part in the multipart element at the specified index.

Supported Platforms

Windows, Solaris, Linux

Specified by:: queryPart in interface IMultiPartTextElement

Parameters:: index - The index (in)
Returns:: A reference to a com.esri.arcgis.carto.IElement
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

replacePart

public void replacePart(int index,
                        java.lang.String text,
                        IGeometry geometry)
                 throws java.io.IOException,
                        AutomationException

Description copied from interface: IMultiPartTextElement

Replace a part in the multipart element at the specified index.

Supported Platforms

Windows, Solaris, Linux

Specified by:: replacePart in interface IMultiPartTextElement

Parameters:: index - The index (in); text - The text (in); geometry - A reference to a com.esri.arcgis.geometry.IGeometry (in)
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

insertPart

public void insertPart(int index,
                       java.lang.String text,
                       IGeometry geometry)
                throws java.io.IOException,
                       AutomationException

Description copied from interface: IMultiPartTextElement

Insert a part in the multipart element at the specified index.

Supported Platforms

Windows, Solaris, Linux

Specified by:: insertPart in interface IMultiPartTextElement

Parameters:: index - The index (in); text - The text (in); geometry - A reference to a com.esri.arcgis.geometry.IGeometry (in)
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

deletePart

public void deletePart(int index)
                throws java.io.IOException,
                       AutomationException

Description copied from interface: IMultiPartTextElement

Delete a part in the multipart element at the specified index.

Supported Platforms

Windows, Solaris, Linux

Specified by:: deletePart in interface IMultiPartTextElement

Parameters:: index - The index (in)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

synchronizeParts

public void synchronizeParts(IDisplay pDisplay)
                      throws java.io.IOException,
                             AutomationException

Description copied from interface: IMultiPartTextElement

Synchronize the geometry with the text of the element.

Supported Platforms

Windows, Solaris, Linux

Specified by:: synchronizeParts in interface IMultiPartTextElement

Parameters:: pDisplay - A reference to a com.esri.arcgis.display.IDisplay (in)
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

serialize

public void serialize(IXMLSerializeData data)
               throws java.io.IOException,
                      AutomationException

Description copied from interface: IXMLSerialize

Serializes an object to XML.

Supported Platforms

Windows, Solaris, Linux

Specified by:: serialize in interface IXMLSerialize

Parameters:: data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

deserialize

public void deserialize(IXMLSerializeData data)
                 throws java.io.IOException,
                        AutomationException

Description copied from interface: IXMLSerialize

Deserializes an object from XML.

Supported Platforms

Windows, Solaris, Linux

Specified by:: deserialize in interface IXMLSerialize

Parameters:: data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.esri.arcgis.carto Class TextElement

Product Availability

Supported Platforms

Remarks

TextElement

TextElement

getClsid

getAsIElement

getAsIElementProperties

getAsIElementProperties2

getAsIElementProperties3

getAsITextElement

getAsIGraphicElement

getAsIBoundsProperties

getAsIGroupSymbolElement

getAsISymbolCollectionElement

getAsITransform2D

getAsIPersistStream

getAsIPropertySupport

getAsIElementEditVertices

getAsIElementEditCallout

getAsIClone

getAsIMultiPartTextElement

getAsIXMLSerialize

equals

hashCode

getGeometry

Supported Platforms

Description

Remarks

setGeometry

Supported Platforms

queryBounds

Supported Platforms

Remarks

queryOutline

Supported Platforms

Remarks

getSelectionTracker

Supported Platforms

Remarks

hitTest

Supported Platforms

Remarks

draw

Supported Platforms

Remarks

activate

Supported Platforms

Remarks

deactivate

Supported Platforms

Remarks

isLocked

Supported Platforms

Remarks

setLocked

Supported Platforms

getName

Supported Platforms

Remarks

setName

Supported Platforms

getType

Supported Platforms

Remarks

setType

Supported Platforms

isAutoTransform

Supported Platforms

Remarks

setAutoTransform

Supported Platforms

getCustomProperty

Supported Platforms

Remarks

setCustomProperty

Supported Platforms

Remarks

canRotate

com.esri.arcgis.carto
Class TextElement