com.esri.arcgis.carto
Class TextElement

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

All Implemented Interfaces:

IBoundsProperties, IElement, IElementEditCallout, IElementEditVertices, IElementProperties, IElementProperties2, IElementProperties3, IGraphicElement, IGroupSymbolElement, IMultiPartTextElement, ISymbolCollectionElement, ITextElement, ITransform2D, com.esri.arcgis.interop.RemoteObjRef, IClone, IPersist, IPersistStream, IPropertySupport, IXMLSerialize, java.io.Externalizable, java.io.Serializable

public class TextElement
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IElement, IElementProperties, IElementProperties2, IElementProperties3, ITextElement, IGraphicElement, IBoundsProperties, IGroupSymbolElement, ISymbolCollectionElement, ITransform2D, IPersistStream, IPropertySupport, IElementEditVertices, IElementEditCallout, IClone, IMultiPartTextElement, IXMLSerialize, java.io.Externalizable

COM Class 'TextElement'. Generated 3/19/2015 1:20:41 PM from 'C:\ArcGIS\COM\esriCarto.olb'

Description 'The Graphic Element to display text.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

See Also:

Serialized Form

Field Summary

static long

serialVersionUID

Fields inherited from interface com.esri.arcgis.carto.IElement

IID, IID9b001319_9ed7_11d0_859e_0800091a2a72, xxDummy

Fields inherited from interface com.esri.arcgis.carto.IElementProperties

IID, IID86f32b61_7667_11d2_a2d3_080009b6f22b, xxDummy

Fields inherited from interface com.esri.arcgis.carto.IElementProperties2

IID, IID7d019a0d_f450_48fe_8a78_a2f0cb8ef3a4, xxDummy

Fields inherited from interface com.esri.arcgis.carto.IElementProperties3

IID, IID7d019a0e_f450_48fe_8a78_a2f0cb8ef3a4, xxDummy

Fields inherited from interface com.esri.arcgis.carto.ITextElement

IID, IID204034d2_f6ea_11d0_83ad_080009b996cc, xxDummy

Fields inherited from interface com.esri.arcgis.carto.IGraphicElement

IID, IIDc5c980f9_145e_11d3_9f88_00c04f6bc6a5, xxDummy

Fields inherited from interface com.esri.arcgis.carto.IBoundsProperties

IID, IID7ad72c5d_eb8a_11d3_9314_00600802e603, xxDummy

Fields inherited from interface com.esri.arcgis.carto.IGroupSymbolElement

IID, IID9e65c825_858c_11d3_9fc6_00c04f6bc6a5, xxDummy

Fields inherited from interface com.esri.arcgis.carto.ISymbolCollectionElement

IID, IID9aec8465_b8c8_4099_95a8_49815539a8a7, xxDummy

Fields inherited from interface com.esri.arcgis.geometry.ITransform2D

IID, IID3be78ad0_886e_11d1_bc78_0000f875bcce, xxDummy

Fields inherited from interface com.esri.arcgis.system.IPersistStream

IID, IID00000109_0000_0000_c000_000000000046, xxDummy

Fields inherited from interface com.esri.arcgis.system.IPersist

IID0000010c_0000_0000_c000_000000000046

Fields inherited from interface com.esri.arcgis.system.IPropertySupport

IID, IID8a11ad55_2f4f_11d3_9fa0_00c04f6bc6a5, xxDummy

Fields inherited from interface com.esri.arcgis.carto.IElementEditVertices

IID, IID86f32b62_7667_11d2_a2d3_080009b6f22b, xxDummy

Fields inherited from interface com.esri.arcgis.carto.IElementEditCallout

IID, IIDb6c88d50_e8b6_11d4_8408_0080c79f0371, xxDummy

Fields inherited from interface com.esri.arcgis.system.IClone

IID, IID9bff8aeb_e415_11d0_943c_080009eebecb, xxDummy

Fields inherited from interface com.esri.arcgis.carto.IMultiPartTextElement

IID, IIDb0db3a18_85c0_4c1b_97d2_a9501552ecaf, xxDummy

Fields inherited from interface com.esri.arcgis.system.IXMLSerialize

IID, IIDc8545045_6615_48e3_af27_52a0e5fc35e2, xxDummy

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.
TextElement theTextElement = (TextElement) obj;

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.
ITextBackground	getBackground() Background symbol.
double	getCharacterSpacing() The character spacing.
double	getCharacterWidth() The character width.
void	getClassID(GUID[] pClassID) getClassID
static java.lang.String	getClsid() 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.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
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) getSizeMax
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() isDirty
boolean	isEditingCallout() Indicates if this element is editing it's callout.
boolean	isEqual(IClone other) Indicates if 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) Indicates if 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) load
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	readExternal(java.io.ObjectInput in)
void	release() Release a TextElement.
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) save
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.
void	writeExternal(java.io.ObjectOutput out)

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

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.
TextElement theTextElement = (TextElement) obj;

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.

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()

getClsid.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()

Deprecated. Internal use only.

Specified by:

getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

release

public void release()

Release a TextElement.

Specified by:

release in interface com.esri.arcgis.interop.RemoteObjRef

getGeometry

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

Shape of the element as a geometry.

Specified by:

getGeometry in interface IElement

Specified by:

getGeometry in interface ISymbolCollectionElement

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

Shape of the element as a geometry.

Specified by:

setGeometry in interface IElement

Specified by:

setGeometry in interface ISymbolCollectionElement

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

Bounds of the element taking symbology into consideration.

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

Bounds of the element taking symbology into consideration.

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

Selection tracker used by this element.

Specified by:

getSelectionTracker in interface IElement

Returns:

A reference to a com.esri.arcgis.display.ISelectionTracker

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

hitTest

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

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

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

Draws the element into the given display object.

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

Prepare to display graphic on screen.

Specified by:

activate in interface IElement

Parameters:

display - 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.

deactivate

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

ActiveView that graphics are displayed on 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

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

Specified by:

isLocked in interface IElement

Returns:

The pLocked

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLocked

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

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

Specified by:

setLocked in interface IElement

Parameters:

pLocked - The pLocked (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getName

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

Name of the element.

Specified by:

getName in interface IElementProperties

Specified by:

getName in interface IElementProperties2

Specified by:

getName in interface IElementProperties3

Returns:

The name

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setName

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

Name of the element.

Specified by:

setName in interface IElementProperties

Specified by:

setName in interface IElementProperties2

Specified by:

setName in interface IElementProperties3

Parameters:

name - The name (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getType

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

Type of the element.

Specified by:

getType in interface IElementProperties

Specified by:

getType in interface IElementProperties2

Specified by:

getType in interface IElementProperties3

Returns:

The name

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setType

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

Type of the element.

Specified by:

setType in interface IElementProperties

Specified by:

setType in interface IElementProperties2

Specified by:

setType in interface IElementProperties3

Parameters:

name - The name (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isAutoTransform

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

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

Specified by:

isAutoTransform in interface IElementProperties

Specified by:

isAutoTransform in interface IElementProperties2

Specified by:

isAutoTransform in interface IElementProperties3

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

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

Specified by:

setAutoTransform in interface IElementProperties

Specified by:

setAutoTransform in interface IElementProperties2

Specified by:

setAutoTransform in interface IElementProperties3

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

Custom property.

Specified by:

getCustomProperty in interface IElementProperties

Specified by:

getCustomProperty in interface IElementProperties2

Specified by:

getCustomProperty in interface IElementProperties3

Returns:

A Variant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCustomProperty

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

Custom property.

Specified by:

setCustomProperty in interface IElementProperties

Specified by:

setCustomProperty in interface IElementProperties2

Specified by:

setCustomProperty in interface IElementProperties3

Parameters:

customProperty - A Variant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

canRotate

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

Indicates if the element can be rotated.

Specified by:

canRotate in interface IElementProperties2

Specified by:

canRotate in interface IElementProperties3

Returns:

The canRotate

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getReferenceScale

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

Reference scale of the element.

Specified by:

getReferenceScale in interface IElementProperties2

Specified by:

getReferenceScale in interface IElementProperties3

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

Reference scale of the element.

Specified by:

setReferenceScale in interface IElementProperties2

Specified by:

setReferenceScale in interface IElementProperties3

Parameters:

referenceScale - The referenceScale (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

IElementProperties3_getAnchorPoint

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

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

Anchor point of the element.

Specified by:

setAnchorPoint in interface IElementProperties3

Parameters:

anchorPoint - A com.esri.arcgis.carto.esriAnchorPointEnum constant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSpatialReference

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

Spatial reference of the container.

Specified by:

getSpatialReference in interface IElementProperties3

Specified by:

getSpatialReference in interface IGraphicElement

Returns:

A reference to a com.esri.arcgis.geometry.ISpatialReference

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSpatialReferenceByRef

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

Spatial reference of the container.

Specified by:

setSpatialReferenceByRef in interface IElementProperties3

Specified by:

setSpatialReferenceByRef in interface IGraphicElement

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

Text symbol this element uses to draw itself.

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

Text symbol this element uses to draw itself.

Specified by:

setSymbol in interface ITextElement

Parameters:

symbol - A reference to a com.esri.arcgis.display.ITextSymbol (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getText

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

Text being displayed by this element.

Specified by:

getText in interface ISymbolCollectionElement

Specified by:

getText in interface ITextElement

Returns:

The text

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setText

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

Text being displayed by this element.

Specified by:

setText in interface ISymbolCollectionElement

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

Indicates if the text scales with 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

Indicates if the text scales with the map.

Specified by:

setScaleText in interface ITextElement

Parameters:

scale - The scale (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isFixedAspectRatio

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

Indicates if the bounds has a fixed aspect ratio.

Specified by:

isFixedAspectRatio in interface IBoundsProperties

Returns:

The flag

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFixedAspectRatio

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

Indicates if the bounds has a fixed aspect ratio.

Specified by:

setFixedAspectRatio in interface IBoundsProperties

Parameters:

flag - The flag (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isFixedSize

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

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

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

Symbol ID associated with this element.

Specified by:

getSymbolID in interface IGroupSymbolElement

Specified by:

getSymbolID in interface ISymbolCollectionElement

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

Symbol ID associated with this element.

Specified by:

setSymbolID in interface IGroupSymbolElement

Parameters:

symbolID - The symbolID (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setGroupSymbol

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

The symbol ID associated with this element.

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

Saves the anno in a compressed format.

Specified by:

exportToESRIAnno in interface IGroupSymbolElement

Specified by:

exportToESRIAnno in interface ISymbolCollectionElement

Parameters:

stream - A reference to a com.esri.arcgis.system.IStream (in)

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)
                        throws java.io.IOException,
                               AutomationException

Loads the anno in a compressed format.

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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

drawESRIAnno

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

Draws the anno in a compressed format.

Specified by:

drawESRIAnno in interface IGroupSymbolElement

Specified by:

drawESRIAnno in interface ISymbolCollectionElement

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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getXOffset

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

Text offset along X-axis.

Specified by:

getXOffset in interface IGroupSymbolElement

Specified by:

getXOffset in interface ISymbolCollectionElement

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

Text offset along X-axis.

Specified by:

setXOffset in interface IGroupSymbolElement

Specified by:

setXOffset in interface ISymbolCollectionElement

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

Text offset along Y-axis.

Specified by:

getYOffset in interface IGroupSymbolElement

Specified by:

getYOffset in interface ISymbolCollectionElement

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

Text offset along Y-axis.

Specified by:

setYOffset in interface IGroupSymbolElement

Specified by:

setYOffset in interface ISymbolCollectionElement

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

Vertical alignment style.

Specified by:

getVerticalAlignment in interface IGroupSymbolElement

Specified by:

getVerticalAlignment in interface ISymbolCollectionElement

Returns:

A com.esri.arcgis.display.esriTextVerticalAlignment constant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setVerticalAlignment

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

Vertical alignment style.

Specified by:

setVerticalAlignment in interface IGroupSymbolElement

Specified by:

setVerticalAlignment in interface ISymbolCollectionElement

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

Horizontal alignment style.

Specified by:

getHorizontalAlignment in interface IGroupSymbolElement

Specified by:

getHorizontalAlignment in interface ISymbolCollectionElement

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

Horizontal alignment style.

Specified by:

setHorizontalAlignment in interface IGroupSymbolElement

Specified by:

setHorizontalAlignment in interface ISymbolCollectionElement

Parameters:

horizAlignment - A com.esri.arcgis.display.esriTextHorizontalAlignment constant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFlipAngle

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

Flip angle.

Specified by:

getFlipAngle in interface IGroupSymbolElement

Specified by:

getFlipAngle in interface ISymbolCollectionElement

Returns:

The flipAngle

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFlipAngle

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

Flip angle.

Specified by:

setFlipAngle in interface IGroupSymbolElement

Specified by:

setFlipAngle in interface ISymbolCollectionElement

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

Callout anchor point.

Specified by:

IGroupSymbolElement_getAnchorPoint in interface IGroupSymbolElement

Returns:

A reference to a com.esri.arcgis.geometry.IPoint

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAnchorPoint

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

Callout anchor point.

Specified by:

setAnchorPoint in interface IGroupSymbolElement

Specified by:

setAnchorPoint in interface ISymbolCollectionElement

Parameters:

anchorPoint - A reference to a com.esri.arcgis.geometry.IPoint (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSize

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

Font size.

Specified by:

getSize in interface IGroupSymbolElement

Specified by:

getSize in interface ISymbolCollectionElement

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

Font size.

Specified by:

setSize in interface IGroupSymbolElement

Specified by:

setSize in interface ISymbolCollectionElement

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

Font color.

Specified by:

getColor in interface IGroupSymbolElement

Specified by:

getColor in interface ISymbolCollectionElement

Returns:

A reference to a com.esri.arcgis.display.IColor

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setColor

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

Font color.

Specified by:

setColor in interface IGroupSymbolElement

Specified by:

setColor in interface ISymbolCollectionElement

Parameters:

color - A reference to a com.esri.arcgis.display.IColor (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTextPath

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

Text path.

Specified by:

getTextPath in interface IGroupSymbolElement

Specified by:

getTextPath in interface ISymbolCollectionElement

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

Text path.

Specified by:

setTextPathByRef in interface IGroupSymbolElement

Specified by:

setTextPathByRef in interface ISymbolCollectionElement

Parameters:

textPath - A reference to a com.esri.arcgis.display.ITextPath (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSharedSymbol

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

The symbol ID associated with this element.

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

Collection symbol.

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

Loads the anno in a compressed format.

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

Callout anchor point.

Specified by:

ISymbolCollectionElement_getAnchorPoint in interface ISymbolCollectionElement

Returns:

A reference to a com.esri.arcgis.geometry.IPoint

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCharacterSpacing

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

The character spacing.

Specified by:

getCharacterSpacing in interface ISymbolCollectionElement

Returns:

The characterSpacing

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCharacterSpacing

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

The character spacing.

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

The character width.

Specified by:

getCharacterWidth in interface ISymbolCollectionElement

Returns:

The characterWidth

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCharacterWidth

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

The character width.

Specified by:

setCharacterWidth in interface ISymbolCollectionElement

Parameters:

characterWidth - The characterWidth (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getWordSpacing

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

The word spacing.

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

The word spacing.

Specified by:

setWordSpacing in interface ISymbolCollectionElement

Parameters:

wordSpacing - The wordSpacing (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLeading

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

The character leading.

Specified by:

getLeading in interface ISymbolCollectionElement

Returns:

The leading

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLeading

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

The character leading.

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

Indicates whether bold fonts style.

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

Indicates whether bold fonts style.

Specified by:

setBold in interface ISymbolCollectionElement

Parameters:

bold - The bold (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFontName

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

Font name.

Specified by:

getFontName in interface ISymbolCollectionElement

Returns:

The fontName

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFontName

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

Font name.

Specified by:

setFontName in interface ISymbolCollectionElement

Parameters:

fontName - The fontName (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isItalic

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

Indicates whether italic font style.

Specified by:

isItalic in interface ISymbolCollectionElement

Returns:

The italic

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setItalic

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

Indicates whether italic font style.

Specified by:

setItalic in interface ISymbolCollectionElement

Parameters:

italic - The italic (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isUnderline

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

Indicates whether underline font style.

Specified by:

isUnderline in interface ISymbolCollectionElement

Returns:

The underline

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUnderline

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

Indicates whether underline font style.

Specified by:

setUnderline in interface ISymbolCollectionElement

Parameters:

underline - The underline (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBackground

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

Background symbol.

Specified by:

getBackground in interface ISymbolCollectionElement

Returns:

A reference to a com.esri.arcgis.display.ITextBackground

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBackgroundByRef

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

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

Overridden properties.

Specified by:

setOverriddenProperties in interface ISymbolCollectionElement

Parameters:

props - The props (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getOverriddenProperties

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

Overridden properties.

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

Mask used to exclude overrides when drawing.

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

Mask used to exclude overrides when drawing.

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

Moves dx units horizontally and dy units vertically.

Specified by:

move in interface ITransform2D

Parameters:

dx - The dx (in)

dy - The dy (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

moveVector

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

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

Specified by:

moveVector in interface ITransform2D

Parameters:

v - A reference to a com.esri.arcgis.geometry.ILine (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

scale

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

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.

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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

rotate

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

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.

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

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

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

isDirty

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

load

Specified by:

load in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

save

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

save

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

getSizeMax

Specified by:

getSizeMax in interface IPersistStream

Parameters:

pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getClassID

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

getClassID

Specified by:

getClassID in interface IPersist

Parameters:

pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

applies

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

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

Specified by:

applies in interface IPropertySupport

Parameters:

pUnk - A reference to another Object (IUnknown) (in)

Returns:

The applies

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

canApply

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

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

Specified by:

canApply in interface IPropertySupport

Parameters:

pUnk - A reference to another Object (IUnknown) (in)

Returns:

The canApply

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCurrent

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

The object currently being used.

Specified by:

getCurrent in interface IPropertySupport

Parameters:

pUnk - A reference to another Object (IUnknown) (in)

Returns:

A reference to another Object (IUnknown)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

apply

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

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

Specified by:

apply in interface IPropertySupport

Parameters:

newObject - A reference to another Object (IUnknown) (in)

Returns:

A reference to another Object (IUnknown)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMoveVerticesSelectionTracker

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

Selection tracker to move points used by this element.

Specified by:

getMoveVerticesSelectionTracker in interface IElementEditVertices

Returns:

A reference to a com.esri.arcgis.display.ISelectionTracker

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isMovingVertices

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

Indicates if this element is moving its vertices.

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

Indicates if this element is moving its vertices.

Specified by:

setMovingVertices in interface IElementEditVertices

Parameters:

flag - The flag (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMoveTextSelectionTracker

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

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

Specified by:

getMoveTextSelectionTracker in interface IElementEditCallout

Returns:

A reference to a com.esri.arcgis.display.ISelectionTracker

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isEditingCallout

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

Indicates if this element is editing it's callout.

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

Indicates if this element is editing it's callout.

Specified by:

setEditingCallout in interface IElementEditCallout

Parameters:

flag - The flag (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

esri_clone

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

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

Assigns the properties of src to the receiver.

Specified by:

assign in interface IClone

Parameters:

src - A reference to a com.esri.arcgis.system.IClone (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isEqual

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

Indicates if 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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isIdentical

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

Indicates if 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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

convertToMultiPart

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

Converts the current element into a multipart element.

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

Converts the current element into a single part element.

Specified by:

convertToSinglePart in interface IMultiPartTextElement

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isMultipart

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

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

The number of parts in the multipart element.

Specified by:

getPartCount in interface IMultiPartTextElement

Returns:

The count

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

queryPart

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

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

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

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

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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

insertPart

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

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

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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

deletePart

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

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

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

Synchronize the geometry with the text of the element.

Specified by:

synchronizeParts 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.

serialize

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

Serializes an object to XML.

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

Deserializes an object from XML.

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.

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException

Specified by:

writeExternal in interface java.io.Externalizable

Throws:

java.io.IOException

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException

Specified by:

readExternal in interface java.io.Externalizable

Throws:

java.io.IOException

java.lang.ClassNotFoundException