com.esri.arcgis.trackinganalyst
Class TextMarkerSymbol

java.lang.Object
  extended by com.esri.arcgis.trackinganalyst.TextMarkerSymbol
All Implemented Interfaces:
IDisplayName, IFormattedTextSymbol, IMapLevel, IMarkerSymbol, IQueryGeometry, ISimpleTextSymbol, ISymbol, ITextDrawSupport, ITextParserSupport, ITextSymbol, IWordBoundaries, com.esri.arcgis.interop.RemoteObjRef, IClone, IDocumentVersionSupportGEN, IPersist, IPersistStream, IPropertySupport, ITextMarkerSymbol, java.io.Externalizable, java.io.Serializable

public class TextMarkerSymbol
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, ISymbol, IClone, IDisplayName, IMarkerSymbol, ITextMarkerSymbol, IDocumentVersionSupportGEN, IFormattedTextSymbol, ISimpleTextSymbol, IMapLevel, IPersistStream, IPersist, IPropertySupport, ITextParserSupport, IQueryGeometry, ITextDrawSupport, IWordBoundaries, java.io.Externalizable

COM Class 'TextMarkerSymbol'. Generated 3/19/2015 1:20:45 PM from 'C:\ArcGIS\COM\esriTrackingAnalyst.olb'

Description 'Class used to create a text marker symbol used to symbolize point geometries.' 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.display.ISymbol
IID, IIDf3435802_5779_11d0_98bf_00805f7ced21, xxDummy
 
Fields inherited from interface com.esri.arcgis.system.IClone
IID, IID9bff8aeb_e415_11d0_943c_080009eebecb, xxDummy
 
Fields inherited from interface com.esri.arcgis.display.IDisplayName
IID, IIDf47b9b56_7efe_4ee4_b7d4_445f93ff390e, xxDummy
 
Fields inherited from interface com.esri.arcgis.display.IMarkerSymbol
IID, IIDe6bdaa7c_4d35_11d0_98be_00805f7ced21, xxDummy
 
Fields inherited from interface com.esri.arcgis.trackinganalyst.ITextMarkerSymbol
IID, IID5a5ac70b_ef80_4be2_8f6e_9ecb744b0cd9, xxDummy
 
Fields inherited from interface com.esri.arcgis.display.IFormattedTextSymbol
IID, IIDb65a3e72_2993_11d1_9a43_0080c7ec5c96, xxDummy
 
Fields inherited from interface com.esri.arcgis.display.ISimpleTextSymbol
IID, IIDa80b5e8c_7f9c_11d0_9410_080009eebecb, xxDummy
 
Fields inherited from interface com.esri.arcgis.display.ITextSymbol
IIDa80b5e91_7f9c_11d0_9410_080009eebecb
 
Fields inherited from interface com.esri.arcgis.display.IMapLevel
IID, IIDcef72580_c1d9_11d2_9888_0080c7e04196, 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.display.ITextParserSupport
IID, IID5dea57cf_a8ef_4944_b731_87df1b6f136d, xxDummy
 
Fields inherited from interface com.esri.arcgis.display.IQueryGeometry
IID, IID8e1b88f1_0a46_11d4_8276_0080c79f0371, xxDummy
 
Fields inherited from interface com.esri.arcgis.display.ITextDrawSupport
IID, IIDbf5bd367_5223_49c0_8db0_fbc9d7cf36bb, xxDummy
 
Fields inherited from interface com.esri.arcgis.display.IWordBoundaries
IID, IIDdf0f7ba7_1c31_44cb_975f_87ff272793aa, xxDummy
 
Constructor Summary
TextMarkerSymbol()
          Constructs a TextMarkerSymbol using ArcGIS Engine.
TextMarkerSymbol(java.lang.Object obj)
          Construct a TextMarkerSymbol using a reference to such an object returned from ArcGIS Engine or Server.
 
Method Summary
 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.
 java.lang.Object convertToSupportedObject(int docVersion)
          Convert the object to another object that is supported.
 void draw(IGeometry geometry)
          Draws the specified shape.
 boolean equals(java.lang.Object o)
          Compare this object with another
 IClone esri_clone()
          Clones the receiver and assigns the result to *clone.
 double getAngle()
          Marker symbol angle.
 ITextBackground getBackground()
          The text background object.
 int getBreakCharacter()
          Character to be interpreted as text line end.
 int getCase()
          The text case.
 double getCharacterSpacing()
          The character spacing.
 double getCharacterWidth()
          The character width.
 void getClassID(GUID[] pClassID)
          getClassID
static java.lang.String getClsid()
          getClsid.
 IColor getColor()
          Marker symbol color.
 java.lang.Object getCurrent(java.lang.Object pUnk)
          The object currently being used.
 int getDirection()
          The text direction.
 java.lang.Object getDrawPoints(int hDC, ITransformation pTransform, IGeometry pGeometry)
          Gets an array of WKSPoints which represent the position at which each line of text is drawn; pGeometry must be a point.
 void getDrawText(java.lang.String origText, java.lang.String[] pParsedText, java.lang.Object[] pPositions)
          Get text the way it will be drawn.
 IFillSymbol getFillSymbol()
          The fill symbol.
 double getFlipAngle()
          The flip angle.
 Font getFont()
          Text font.
 IGeometry getGeometry(int hDC, ITransformation displayTransform, IGeometry drawGeometry)
          Gets the actual geometry of the boundary of the object (which may or may not be a polygon).
 int getHorizontalAlignment()
          Horizontal alignment style.
 com.esri.arcgis.interop.Dispatch getJintegraDispatch()
          Deprecated. Internal use only.
 double getLeading()
          The character leading.
 int getMapLevel()
          Current map level for drawing multi-level symbols.
 java.lang.String getMarkerText()
          String to be displayed as the text marker symbol.
 java.lang.String getNameString()
          The display name of an object.
 int getPosition()
          The text position.
 int getROP2()
          Raster operation code for pixel drawing.
 IColor getShadowColor()
          The shadow color.
 double getShadowXOffset()
          The shadow X offset.
 double getShadowYOffset()
          The shadow Y offset.
 double getSize()
          Marker symbol size.
 void getSizeMax(_ULARGE_INTEGER[] pcbSize)
          getSizeMax
 java.lang.String getText()
          Text to draw.
 ITextParser getTextParser()
          The text parser.
 ITextPath getTextPath()
          Path of text baseline.
 void getTextSize(int hDC, ITransformation transformation, java.lang.String text, double[] xSize, double[] ySize)
          Gets the x and y dimensions of 'text' in points (1/72 inch).
 int getVerticalAlignment()
          Vertical alignment style.
 double getWordSpacing()
          The word spacing.
 double getXOffset()
          Symbol X-axis offset from point location.
 double getYOffset()
          Symbol Y-axis offset from point location.
 int hashCode()
          the hashcode for this object
 boolean isClip()
          Indicates if the text will be clipped per geometry.
 void isDirty()
          isDirty
 boolean isEqual(IClone other)
          Indicates if the receiver and other have the same properties.
 boolean isIdentical(IClone other)
          Indicates if the receiver and other are the same object.
 boolean isKerning()
          Indicates if kerning is on.
 boolean isRightToLeft()
          Indicates if the text is drawn from right to left.
 boolean isSupportedAtVersion(int docVersion)
          Is this object valid at the given document version.
 boolean isTypeSetting()
          Indicates if typesetting is used.
 void load(IStream pstm)
          load
 void queryBoundary(int hDC, ITransformation displayTransform, IGeometry geometry, IPolygon boundary)
          Fills an existing polygon with the boundary of the specified symbol.
 void queryEnvelope(int hDC, ITransformation displayTransform, IGeometry drawGeometry, IEnvelope envelope)
          Queries the envelope of the boundary of the object.
 void queryWordBoundaries(int hDC, ITransformation displayTransform, IGeometry geometry, IGeometryBag boundaries)
          Fills an existing geometry bag with the boundaries of the words in the text symbol.
 void readExternal(java.io.ObjectInput in)
           
 void release()
          Release a TextMarkerSymbol.
 void resetDC()
          Restores DC to original state.
 void save(IStream pstm, int fClearDirty)
          save
 void setAngle(double angle)
          Marker symbol angle.
 void setBackgroundByRef(ITextBackground background)
          The text background object.
 void setBreakCharacter(int charIndex)
          Character to be interpreted as text line end.
 void setCase(int textCase)
          The text case.
 void setCharacterSpacing(double characterSpacing)
          The character spacing.
 void setCharacterWidth(double characterWidth)
          The character width.
 void setClip(boolean clip)
          Indicates if the text will be clipped per geometry.
 void setColor(IColor color)
          Marker symbol color.
 void setDirection(int textDirection)
          The text direction.
 void setFillSymbolByRef(IFillSymbol fillSymbol)
          The fill symbol.
 void setFlipAngle(double flipAngle)
          The flip angle.
 void setFont(Font fontDisp)
          Text font.
 void setHorizontalAlignment(int horizAlignment)
          Horizontal alignment style.
 void setKerning(boolean kerning)
          Indicates if kerning is on.
 void setLeading(double leading)
          The character leading.
 void setMapLevel(int mapLevel)
          Current map level for drawing multi-level symbols.
 void setMarkerText(java.lang.String pVal)
          String to be displayed as the text marker symbol.
 void setPosition(int textPosition)
          The text position.
 void setRightToLeft(boolean rightToLeft)
          Indicates if the text is drawn from right to left.
 void setROP2(int drawMode)
          Raster operation code for pixel drawing.
 void setShadowColor(IColor shadowColor)
          The shadow color.
 void setShadowXOffset(double xOffset)
          The shadow X offset.
 void setShadowYOffset(double yOffset)
          The shadow Y offset.
 void setSize(double size)
          Marker symbol size.
 void setText(java.lang.String text)
          Text to draw.
 void setTextParserByRef(ITextParser parser)
          The text parser.
 void setTextPathByRef(ITextPath textPath)
          Path of text baseline.
 void setTypeSetting(boolean typeSetting)
          Indicates if typesetting is used.
 void setupDC(int hDC, ITransformation transformation)
          Prepares the DC for drawing the symbol.
 void setVerticalAlignment(int vertAlignment)
          Vertical alignment style.
 void setWordSpacing(double wordSpacing)
          The word spacing.
 void setXOffset(double xOffset)
          Symbol X-axis offset from point location.
 void setYOffset(double yOffset)
          Symbol Y-axis offset from point location.
 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

TextMarkerSymbol

public TextMarkerSymbol()
                 throws java.io.IOException,
                        java.net.UnknownHostException
Constructs a TextMarkerSymbol using ArcGIS Engine.

Throws:
java.io.IOException - if there are interop problems
java.net.UnknownHostException - if there are interop problems

TextMarkerSymbol

public TextMarkerSymbol(java.lang.Object obj)
                 throws java.io.IOException
Construct a TextMarkerSymbol using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to TextMarkerSymbol.

Parameters:
obj - an object returned from ArcGIS Engine or Server
Throws:
java.io.IOException - if there are interop problems TextMarkerSymbol theTextMarkerSymbol = (TextMarkerSymbol) obj;
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 TextMarkerSymbol.

Specified by:
release in interface com.esri.arcgis.interop.RemoteObjRef

setupDC

public void setupDC(int hDC,
                    ITransformation transformation)
             throws java.io.IOException,
                    AutomationException
Prepares the DC for drawing the symbol.

Specified by:
setupDC in interface ISymbol
Parameters:
hDC - The hDC (A COM typedef) (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.

resetDC

public void resetDC()
             throws java.io.IOException,
                    AutomationException
Restores DC to original state.

Specified by:
resetDC in interface ISymbol
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

draw

public void draw(IGeometry geometry)
          throws java.io.IOException,
                 AutomationException
Draws the specified shape.

Specified by:
draw in interface ISymbol
Parameters:
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.

queryBoundary

public void queryBoundary(int hDC,
                          ITransformation displayTransform,
                          IGeometry geometry,
                          IPolygon boundary)
                   throws java.io.IOException,
                          AutomationException
Fills an existing polygon with the boundary of the specified symbol.

Specified by:
queryBoundary in interface ISymbol
Parameters:
hDC - The hDC (A COM typedef) (in)
displayTransform - A reference to a com.esri.arcgis.geometry.ITransformation (in)
geometry - A reference to a com.esri.arcgis.geometry.IGeometry (in)
boundary - 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.

getROP2

public int getROP2()
            throws java.io.IOException,
                   AutomationException
Raster operation code for pixel drawing.

Specified by:
getROP2 in interface ISymbol
Returns:
A com.esri.arcgis.display.esriRasterOpCode constant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setROP2

public void setROP2(int drawMode)
             throws java.io.IOException,
                    AutomationException
Raster operation code for pixel drawing.

Specified by:
setROP2 in interface ISymbol
Parameters:
drawMode - A com.esri.arcgis.display.esriRasterOpCode constant (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.

getNameString

public java.lang.String getNameString()
                               throws java.io.IOException,
                                      AutomationException
The display name of an object.

Specified by:
getNameString in interface IDisplayName
Returns:
The displayName
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
Marker symbol size.

Specified by:
getSize in interface IMarkerSymbol
Specified by:
getSize in interface ITextSymbol
Returns:
The size
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSize

public void setSize(double size)
             throws java.io.IOException,
                    AutomationException
Marker symbol size.

Specified by:
setSize in interface IMarkerSymbol
Specified by:
setSize in interface ITextSymbol
Parameters:
size - The size (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
Marker symbol color.

Specified by:
getColor in interface IMarkerSymbol
Specified by:
getColor in interface ITextSymbol
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
Marker symbol color.

Specified by:
setColor in interface IMarkerSymbol
Specified by:
setColor in interface ITextSymbol
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.

getAngle

public double getAngle()
                throws java.io.IOException,
                       AutomationException
Marker symbol angle.

Specified by:
getAngle in interface IMarkerSymbol
Specified by:
getAngle in interface ITextSymbol
Returns:
The angle
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAngle

public void setAngle(double angle)
              throws java.io.IOException,
                     AutomationException
Marker symbol angle.

Specified by:
setAngle in interface IMarkerSymbol
Specified by:
setAngle in interface ITextSymbol
Parameters:
angle - The angle (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
Symbol X-axis offset from point location.

Specified by:
getXOffset in interface IMarkerSymbol
Specified by:
getXOffset in interface ISimpleTextSymbol
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
Symbol X-axis offset from point location.

Specified by:
setXOffset in interface IMarkerSymbol
Specified by:
setXOffset in interface ISimpleTextSymbol
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
Symbol Y-axis offset from point location.

Specified by:
getYOffset in interface IMarkerSymbol
Specified by:
getYOffset in interface ISimpleTextSymbol
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
Symbol Y-axis offset from point location.

Specified by:
setYOffset in interface IMarkerSymbol
Specified by:
setYOffset in interface ISimpleTextSymbol
Parameters:
yOffset - The yOffset (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMarkerText

public java.lang.String getMarkerText()
                               throws java.io.IOException,
                                      AutomationException
String to be displayed as the text marker symbol.

Specified by:
getMarkerText in interface ITextMarkerSymbol
Returns:
The pVal
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMarkerText

public void setMarkerText(java.lang.String pVal)
                   throws java.io.IOException,
                          AutomationException
String to be displayed as the text marker symbol.

Specified by:
setMarkerText in interface ITextMarkerSymbol
Parameters:
pVal - The pVal (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isSupportedAtVersion

public boolean isSupportedAtVersion(int docVersion)
                             throws java.io.IOException,
                                    AutomationException
Is this object valid at the given document version.

Remarks

Use IsSupportedAtVersion to identify if a particular object should be saved to the ObjectStream. This result is based on the esriArcGISVersion enumeration. In some instances, if the object is not supported at a particular ArcGIS version, the object may support conversion to another similar object; use IDocumentVersionSupportGEN::ConvertToSupportedObject to accomplish this.

Product Availability

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

Specified by:
isSupportedAtVersion in interface IDocumentVersionSupportGEN
Parameters:
docVersion - A com.esri.arcgis.system.esriArcGISVersion constant (in)
Returns:
The supported
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

convertToSupportedObject

public java.lang.Object convertToSupportedObject(int docVersion)
                                          throws java.io.IOException,
                                                 AutomationException
Convert the object to another object that is supported.

Remarks

This method should be used when IDocumentVersionSupportGEN::IsSupportedAtVersion returns FALSE. Calling ConvertToSupportedObject will return an IUnknown pointer to a relevant object supported at the particular ArcGIS version. Not all objects will return a supported object; in these cases a null pointer will be returned.

Product Availability

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

Specified by:
convertToSupportedObject in interface IDocumentVersionSupportGEN
Parameters:
docVersion - A com.esri.arcgis.system.esriArcGISVersion constant (in)
Returns:
A Variant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getShadowColor

public IColor getShadowColor()
                      throws java.io.IOException,
                             AutomationException
The shadow color.

Specified by:
getShadowColor in interface IFormattedTextSymbol
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.

setShadowColor

public void setShadowColor(IColor shadowColor)
                    throws java.io.IOException,
                           AutomationException
The shadow color.

Specified by:
setShadowColor in interface IFormattedTextSymbol
Parameters:
shadowColor - 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.

getShadowXOffset

public double getShadowXOffset()
                        throws java.io.IOException,
                               AutomationException
The shadow X offset.

Specified by:
getShadowXOffset in interface IFormattedTextSymbol
Returns:
The xOffset
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setShadowXOffset

public void setShadowXOffset(double xOffset)
                      throws java.io.IOException,
                             AutomationException
The shadow X offset.

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

getShadowYOffset

public double getShadowYOffset()
                        throws java.io.IOException,
                               AutomationException
The shadow Y offset.

Specified by:
getShadowYOffset in interface IFormattedTextSymbol
Returns:
The yOffset
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setShadowYOffset

public void setShadowYOffset(double yOffset)
                      throws java.io.IOException,
                             AutomationException
The shadow Y offset.

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

getPosition

public int getPosition()
                throws java.io.IOException,
                       AutomationException
The text position.

Specified by:
getPosition in interface IFormattedTextSymbol
Returns:
A com.esri.arcgis.display.esriTextPosition constant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setPosition

public void setPosition(int textPosition)
                 throws java.io.IOException,
                        AutomationException
The text position.

Specified by:
setPosition in interface IFormattedTextSymbol
Parameters:
textPosition - A com.esri.arcgis.display.esriTextPosition constant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCase

public int getCase()
            throws java.io.IOException,
                   AutomationException
The text case.

Specified by:
getCase in interface IFormattedTextSymbol
Returns:
A com.esri.arcgis.display.esriTextCase constant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCase

public void setCase(int textCase)
             throws java.io.IOException,
                    AutomationException
The text case.

Specified by:
setCase in interface IFormattedTextSymbol
Parameters:
textCase - A com.esri.arcgis.display.esriTextCase constant (in)
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 IFormattedTextSymbol
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 IFormattedTextSymbol
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 IFormattedTextSymbol
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 IFormattedTextSymbol
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 IFormattedTextSymbol
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 IFormattedTextSymbol
Parameters:
wordSpacing - The wordSpacing (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isKerning

public boolean isKerning()
                  throws java.io.IOException,
                         AutomationException
Indicates if kerning is on.

Specified by:
isKerning in interface IFormattedTextSymbol
Returns:
The kerning
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setKerning

public void setKerning(boolean kerning)
                throws java.io.IOException,
                       AutomationException
Indicates if kerning is on.

Specified by:
setKerning in interface IFormattedTextSymbol
Parameters:
kerning - The kerning (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 IFormattedTextSymbol
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 IFormattedTextSymbol
Parameters:
leading - The leading (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDirection

public int getDirection()
                 throws java.io.IOException,
                        AutomationException
The text direction.

Specified by:
getDirection in interface IFormattedTextSymbol
Returns:
A com.esri.arcgis.display.esriTextDirection constant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDirection

public void setDirection(int textDirection)
                  throws java.io.IOException,
                         AutomationException
The text direction.

Specified by:
setDirection in interface IFormattedTextSymbol
Parameters:
textDirection - A com.esri.arcgis.display.esriTextDirection 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
The flip angle.

Specified by:
getFlipAngle in interface IFormattedTextSymbol
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
The flip angle.

Specified by:
setFlipAngle in interface IFormattedTextSymbol
Parameters:
flipAngle - The flipAngle (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
The text background object.

Specified by:
getBackground in interface IFormattedTextSymbol
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 background)
                        throws java.io.IOException,
                               AutomationException
The text background object.

Specified by:
setBackgroundByRef in interface IFormattedTextSymbol
Parameters:
background - 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.

isTypeSetting

public boolean isTypeSetting()
                      throws java.io.IOException,
                             AutomationException
Indicates if typesetting is used.

Specified by:
isTypeSetting in interface IFormattedTextSymbol
Returns:
The typeSetting
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTypeSetting

public void setTypeSetting(boolean typeSetting)
                    throws java.io.IOException,
                           AutomationException
Indicates if typesetting is used.

Specified by:
setTypeSetting in interface IFormattedTextSymbol
Parameters:
typeSetting - The typeSetting (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFillSymbol

public IFillSymbol getFillSymbol()
                          throws java.io.IOException,
                                 AutomationException
The fill symbol.

Specified by:
getFillSymbol in interface IFormattedTextSymbol
Returns:
A reference to a com.esri.arcgis.display.IFillSymbol
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setFillSymbolByRef

public void setFillSymbolByRef(IFillSymbol fillSymbol)
                        throws java.io.IOException,
                               AutomationException
The fill symbol.

Specified by:
setFillSymbolByRef in interface IFormattedTextSymbol
Parameters:
fillSymbol - A reference to a com.esri.arcgis.display.IFillSymbol (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFont

public Font getFont()
             throws java.io.IOException,
                    AutomationException
Text font.

Specified by:
getFont in interface ITextSymbol
Returns:
A reference to a com.esri.arcgis.support.ms.stdole.Font (A com.esri.arcgis.support.ms.stdole.Font COM typedef)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setFont

public void setFont(Font fontDisp)
             throws java.io.IOException,
                    AutomationException
Text font.

Specified by:
setFont in interface ITextSymbol
Parameters:
fontDisp - A reference to a com.esri.arcgis.support.ms.stdole.Font (A com.esri.arcgis.support.ms.stdole.Font COM typedef) (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 ITextSymbol
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 ITextSymbol
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 ITextSymbol
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 ITextSymbol
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.

isRightToLeft

public boolean isRightToLeft()
                      throws java.io.IOException,
                             AutomationException
Indicates if the text is drawn from right to left.

Specified by:
isRightToLeft in interface ITextSymbol
Returns:
The rightToLeft
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setRightToLeft

public void setRightToLeft(boolean rightToLeft)
                    throws java.io.IOException,
                           AutomationException
Indicates if the text is drawn from right to left.

Specified by:
setRightToLeft in interface ITextSymbol
Parameters:
rightToLeft - The rightToLeft (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 to draw.

Specified by:
getText in interface ITextSymbol
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 to draw.

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

getTextSize

public void getTextSize(int hDC,
                        ITransformation transformation,
                        java.lang.String text,
                        double[] xSize,
                        double[] ySize)
                 throws java.io.IOException,
                        AutomationException
Gets the x and y dimensions of 'text' in points (1/72 inch).

Specified by:
getTextSize in interface ITextSymbol
Parameters:
hDC - The hDC (A COM typedef) (in)
transformation - A reference to a com.esri.arcgis.geometry.ITransformation (in)
text - The text (in)
xSize - The xSize (out: use single element array)
ySize - The ySize (out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getBreakCharacter

public int getBreakCharacter()
                      throws java.io.IOException,
                             AutomationException
Character to be interpreted as text line end.

Specified by:
getBreakCharacter in interface ISimpleTextSymbol
Returns:
The charIndex
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setBreakCharacter

public void setBreakCharacter(int charIndex)
                       throws java.io.IOException,
                              AutomationException
Character to be interpreted as text line end.

Specified by:
setBreakCharacter in interface ISimpleTextSymbol
Parameters:
charIndex - The charIndex (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isClip

public boolean isClip()
               throws java.io.IOException,
                      AutomationException
Indicates if the text will be clipped per geometry.

Specified by:
isClip in interface ISimpleTextSymbol
Returns:
The clip
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setClip

public void setClip(boolean clip)
             throws java.io.IOException,
                    AutomationException
Indicates if the text will be clipped per geometry.

Specified by:
setClip in interface ISimpleTextSymbol
Parameters:
clip - The clip (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
Path of text baseline.

Specified by:
getTextPath in interface ISimpleTextSymbol
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
Path of text baseline.

Specified by:
setTextPathByRef in interface ISimpleTextSymbol
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.

getMapLevel

public int getMapLevel()
                throws java.io.IOException,
                       AutomationException
Current map level for drawing multi-level symbols.

Specified by:
getMapLevel in interface IMapLevel
Returns:
The mapLevel
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMapLevel

public void setMapLevel(int mapLevel)
                 throws java.io.IOException,
                        AutomationException
Current map level for drawing multi-level symbols.

Specified by:
setMapLevel in interface IMapLevel
Parameters:
mapLevel - The mapLevel (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.

getTextParser

public ITextParser getTextParser()
                          throws java.io.IOException,
                                 AutomationException
The text parser.

Specified by:
getTextParser in interface ITextParserSupport
Returns:
A reference to a com.esri.arcgis.display.ITextParser
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTextParserByRef

public void setTextParserByRef(ITextParser parser)
                        throws java.io.IOException,
                               AutomationException
The text parser.

Specified by:
setTextParserByRef in interface ITextParserSupport
Parameters:
parser - A reference to a com.esri.arcgis.display.ITextParser (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getGeometry

public IGeometry getGeometry(int hDC,
                             ITransformation displayTransform,
                             IGeometry drawGeometry)
                      throws java.io.IOException,
                             AutomationException
Gets the actual geometry of the boundary of the object (which may or may not be a polygon).

Specified by:
getGeometry in interface IQueryGeometry
Parameters:
hDC - The hDC (A COM typedef) (in)
displayTransform - A reference to a com.esri.arcgis.geometry.ITransformation (in)
drawGeometry - A reference to a com.esri.arcgis.geometry.IGeometry (in)
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.

queryEnvelope

public void queryEnvelope(int hDC,
                          ITransformation displayTransform,
                          IGeometry drawGeometry,
                          IEnvelope envelope)
                   throws java.io.IOException,
                          AutomationException
Queries the envelope of the boundary of the object.

Specified by:
queryEnvelope in interface IQueryGeometry
Parameters:
hDC - The hDC (A COM typedef) (in)
displayTransform - A reference to a com.esri.arcgis.geometry.ITransformation (in)
drawGeometry - A reference to a com.esri.arcgis.geometry.IGeometry (in)
envelope - 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.

getDrawText

public void getDrawText(java.lang.String origText,
                        java.lang.String[] pParsedText,
                        java.lang.Object[] pPositions)
                 throws java.io.IOException,
                        AutomationException
Get text the way it will be drawn. Optionally gives the positions of drawn characters in the original string of characters.

Specified by:
getDrawText in interface ITextDrawSupport
Parameters:
origText - The origText (in)
pParsedText - The pParsedText (out: use single element array)
pPositions - A Variant (out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDrawPoints

public java.lang.Object getDrawPoints(int hDC,
                                      ITransformation pTransform,
                                      IGeometry pGeometry)
                               throws java.io.IOException,
                                      AutomationException
Gets an array of WKSPoints which represent the position at which each line of text is drawn; pGeometry must be a point.

Specified by:
getDrawPoints in interface ITextDrawSupport
Parameters:
hDC - The hDC (A COM typedef) (in)
pTransform - A reference to a com.esri.arcgis.geometry.ITransformation (in)
pGeometry - A reference to a com.esri.arcgis.geometry.IGeometry (in)
Returns:
A Variant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

queryWordBoundaries

public void queryWordBoundaries(int hDC,
                                ITransformation displayTransform,
                                IGeometry geometry,
                                IGeometryBag boundaries)
                         throws java.io.IOException,
                                AutomationException
Fills an existing geometry bag with the boundaries of the words in the text symbol.

Specified by:
queryWordBoundaries in interface IWordBoundaries
Parameters:
hDC - The hDC (A COM typedef) (in)
displayTransform - A reference to a com.esri.arcgis.geometry.ITransformation (in)
geometry - A reference to a com.esri.arcgis.geometry.IGeometry (in)
boundaries - A reference to a com.esri.arcgis.geometry.IGeometryBag (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