com.esri.arcgis.display
Class TextSymbol

java.lang.Object
  com.esri.arcgis.display.TextSymbol

All Implemented Interfaces:

ICharacterOrientation, IClone, IDisplayName, IFormattedTextSymbol, IMapLevel, IMarginProperties, IMask, IPersist, IPersistStream, IPropertySupport, IQueryGeometry, ISimpleTextSymbol, ISymbol, ISymbolRotation, ITextDrawSupport, ITextParserSupport, ITextSymbol, IWordBoundaries, IXMLSerialize, java.io.Serializable

public class TextSymbol

extends java.lang.Object

implements IFormattedTextSymbol, ISimpleTextSymbol, IMapLevel, ISymbol, ISymbolRotation, IMask, IPersistStream, IPersist, IClone, IDisplayName, IPropertySupport, ITextParserSupport, IQueryGeometry, IMarginProperties, ITextDrawSupport, IWordBoundaries, IXMLSerialize, ICharacterOrientation

A symbol that controls how text is displayed.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Description

Use TextSymbol to create text of either IFormattedTextSymbol or ISimpleTextSymbol.

Remarks

TextSymbol is the primary object for defining the display properties of a TextElement. Commonly edited properties can be set using ITextSymbol while additional interfaces such as ISimpleTextSymbol and IFormattedTextSymbol provide access to other display properties. Text properties such as highway shields and callouts are implemented as Text Backgrounds and can controlled using IFormattedTextSymbol:Background. The Text property of TextSymbol is only used for low level drawing of text. The text string should be set on the TextElement.

If you are editing Geodatabase Annotation, DO NOT control the display of annotation features by obtaining a reference to the TextSymbol through ITextElement::Symbol and change the properties. This will undermine the storage mechanism that Geodatabase Annotation utilizes for efficient storage. For more information on TextSymbols and Geodatabase Annotation, see the interface ISymbolCollectionElement.

See Also:

Serialized Form

Constructor Summary

TextSymbol()
Constructs a TextSymbol using ArcGIS Engine.

TextSymbol(java.lang.Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.

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.
void	deserialize(IXMLSerializeData data) Deserializes an object from XML.
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() Text baseline angle.
ICharacterOrientation	getAsICharacterOrientation() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IClone	getAsIClone() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IDisplayName	getAsIDisplayName() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IFormattedTextSymbol	getAsIFormattedTextSymbol() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IMapLevel	getAsIMapLevel() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IMarginProperties	getAsIMarginProperties() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IMask	getAsIMask() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IPersist	getAsIPersist() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IPersistStream	getAsIPersistStream() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IPropertySupport	getAsIPropertySupport() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IQueryGeometry	getAsIQueryGeometry() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
ISimpleTextSymbol	getAsISimpleTextSymbol() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
ISymbol	getAsISymbol() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
ISymbolRotation	getAsISymbolRotation() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
ITextDrawSupport	getAsITextDrawSupport() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
ITextParserSupport	getAsITextParserSupport() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IWordBoundaries	getAsIWordBoundaries() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IXMLSerialize	getAsIXMLSerialize() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
ITextBackground	getBackground() 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) Supported Platforms
static java.lang.String	getClsid()
IColor	getColor() Text 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.
double	getLeading() The character leading.
int	getMapLevel() Current map level for drawing multi-level symbols.
double	getMargin() Value for the margin.
double	getMaskSize() The mask size.
int	getMaskStyle() The mask style.
IFillSymbol	getMaskSymbol() The mask 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() Text size.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) Supported Platforms
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() Text offset along X-axis.
double	getYOffset() Text offset along Y-axis.
int	hashCode() the hashcode for this object
boolean	isCJKCharactersRotation() Indicates if CJK charcters are rotated.
boolean	isClip() Indicates if the text will be clipped per geometry.
void	isDirty() Supported Platforms
boolean	isEqual(IClone other) Returns TRUE when the receiver and other have the same properties.
boolean	isIdentical(IClone other) Returns TRUE when 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	isRotateWithTransform() Indicates if the symbol rotates with the display.
boolean	isTypeSetting() Indicates if typesetting is used.
void	load(IStream pstm) Supported Platforms
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	resetDC() Restores DC to original state.
void	save(IStream pstm, int fClearDirty) Supported Platforms
void	serialize(IXMLSerializeData data) Serializes an object to XML.
void	setAngle(double angle) Text baseline 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	setCJKCharactersRotation(boolean rotation) Indicates if CJK charcters are rotated.
void	setClip(boolean clip) Indicates if the text will be clipped per geometry.
void	setColor(IColor color) Text 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	setMargin(double margin) Value for the margin.
void	setMaskSize(double size) The mask size.
void	setMaskStyle(int style) The mask style.
void	setMaskSymbolByRef(IFillSymbol fillSym) The mask 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	setRotateWithTransform(boolean flag) Indicates if the symbol rotates with the display.
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) Text 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) Text offset along X-axis.
void	setYOffset(double yOffset) Text offset along Y-axis.

Methods inherited from class java.lang.Object

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

Constructor Detail

TextSymbol

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

Constructs a TextSymbol using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

TextSymbol

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

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.

Construct a TextSymbol using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to TextSymbol.
TextSymbol theTextSymbol = (TextSymbol) obj;

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

java.io.IOException - if there are interop problems

Method Detail

getClsid

public static java.lang.String getClsid()

getAsIFormattedTextSymbol

public IFormattedTextSymbol getAsIFormattedTextSymbol()

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

getAsISimpleTextSymbol

public ISimpleTextSymbol getAsISimpleTextSymbol()

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

getAsIMapLevel

public IMapLevel getAsIMapLevel()

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

getAsISymbol

public ISymbol getAsISymbol()

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

getAsISymbolRotation

public ISymbolRotation getAsISymbolRotation()

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

getAsIMask

public IMask getAsIMask()

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

getAsIPersistStream

public IPersistStream getAsIPersistStream()

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

getAsIPersist

public IPersist getAsIPersist()

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

getAsIClone

public IClone getAsIClone()

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

getAsIDisplayName

public IDisplayName getAsIDisplayName()

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

getAsIPropertySupport

public IPropertySupport getAsIPropertySupport()

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

getAsITextParserSupport

public ITextParserSupport getAsITextParserSupport()

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

getAsIQueryGeometry

public IQueryGeometry getAsIQueryGeometry()

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

getAsIMarginProperties

public IMarginProperties getAsIMarginProperties()

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

getAsITextDrawSupport

public ITextDrawSupport getAsITextDrawSupport()

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

getAsIWordBoundaries

public IWordBoundaries getAsIWordBoundaries()

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

getAsIXMLSerialize

public IXMLSerialize getAsIXMLSerialize()

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

getAsICharacterOrientation

public ICharacterOrientation getAsICharacterOrientation()

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

equals

public boolean equals(java.lang.Object o)

Compare this object with another

hashCode

public int hashCode()

the hashcode for this object

getShadowColor

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

Description copied from interface: IFormattedTextSymbol

The shadow color.

Supported Platforms

Windows, Solaris, Linux

Description

ShadowColor is the color of the dropshadow. This can be any of the IColor interfaces.

Specified by:

getShadowColor in interface IFormattedTextSymbol

Returns:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setShadowColor

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

Description copied from interface: IFormattedTextSymbol

The shadow color.

Supported Platforms

Windows, Solaris, Linux

Description

ShadowColor is the color of the dropshadow. This can be any of the IColor interfaces.

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

Description copied from interface: IFormattedTextSymbol

The shadow X offset.

Supported Platforms

Windows, Solaris, Linux

Description

ShadowXOffset is the offset in points (approx. 1/72 inch) in the X or horizontal direction that the dropshadow will be displayed. Positive values offset to the right and negative values offset to the left. The default value is 0 (zero).

Specified by:

getShadowXOffset in interface IFormattedTextSymbol

Returns:

The xOffset

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setShadowXOffset

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

Description copied from interface: IFormattedTextSymbol

The shadow X offset.

Supported Platforms

Windows, Solaris, Linux

Description

ShadowXOffset is the offset in points (approx. 1/72 inch) in the X or horizontal direction that the dropshadow will be displayed. Positive values offset to the right and negative values offset to the left. The default value is 0 (zero).

Specified by:

setShadowXOffset in interface IFormattedTextSymbol

Parameters:

xOffset - The xOffset (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getShadowYOffset

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

Description copied from interface: IFormattedTextSymbol

The shadow Y offset.

Supported Platforms

Windows, Solaris, Linux

Description

ShadowYOffset is the offset in points (approx. 1/72 inch) in the Y or vertical direction that the dropshadow will be displayed. Positive values offset upwards and negative values offset downwards. The default value is 0 (zero).

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

Description copied from interface: IFormattedTextSymbol

The shadow Y offset.

Supported Platforms

Windows, Solaris, Linux

Description

ShadowYOffset is the offset in points (approx. 1/72 inch) in the Y or vertical direction that the dropshadow will be displayed. Positive values offset upwards and negative values offset downwards. The default value is 0 (zero).

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

Description copied from interface: IFormattedTextSymbol

The text position.

Supported Platforms

Windows, Solaris, Linux

Description

Position is whether the ITextSymbol will be normal, subscript, or superscript. Use enumerations: esriTPNormal, esriTPSubscript or esriTPSuperscript.

Specified by:

getPosition in interface IFormattedTextSymbol

Returns:

A com.esri.arcgis.display.esriTextPosition constant

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setPosition

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

Description copied from interface: IFormattedTextSymbol

The text position.

Supported Platforms

Windows, Solaris, Linux

Description

Position is whether the IFormattedTextSymbol will be normal, subscript, or superscript.

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

Description copied from interface: IFormattedTextSymbol

The text case.

Supported Platforms

Windows, Solaris, Linux

Description

Case is whether the letters of an IFormattedTextSymbol are upper, lower, or mixed case. Use enumerations: esriTCNormal, esriTCAllcaps, esriTCsmallcaps.

Specified by:

getCase in interface IFormattedTextSymbol

Returns:

A com.esri.arcgis.display.esriTextCase constant

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setCase

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

Description copied from interface: IFormattedTextSymbol

The text case.

Supported Platforms

Windows, Solaris, Linux

Description

Case is whether the letters of an IFormattedTextSymbol are upper, lower, or mixed case. Use enumerations: esriTCNormal, esriTCAllcaps, esriTCsmallcaps.

Specified by:

setCase in interface IFormattedTextSymbol

Parameters:

textCase - A com.esri.arcgis.display.esriTextCase constant (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getCharacterSpacing

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

Description copied from interface: IFormattedTextSymbol

The character spacing.

Supported Platforms

Windows, Solaris, Linux

Description

CharacterSpacing is the additional space that is added to each character beyond what is defined by its character box in its font. Character spacing is a percentage of the original character's length.

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

Description copied from interface: IFormattedTextSymbol

The character spacing.

Supported Platforms

Windows, Solaris, Linux

Description

CharacterSpacing is the additional space that is added to each character beyond what is defined by its character box in its font. Character spacing is a percentage of the original character's length.

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

Description copied from interface: IFormattedTextSymbol

The character width.

Supported Platforms

Windows, Solaris, Linux

Description

CharacterWidth is the width that is added to each character beyond what is defined by its character box in its font. Character width is a percentage of the original character.

Specified by:

getCharacterWidth in interface IFormattedTextSymbol

Returns:

The characterWidth

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setCharacterWidth

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

Description copied from interface: IFormattedTextSymbol

The character width.

Supported Platforms

Windows, Solaris, Linux

Description

CharacterWidth is the width that is added to each character beyond what is defined by its character box in its font. Character width is a percentage of the original character.

Specified by:

setCharacterWidth in interface IFormattedTextSymbol

Parameters:

characterWidth - The characterWidth (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getWordSpacing

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

Description copied from interface: IFormattedTextSymbol

The word spacing.

Supported Platforms

Windows, Solaris, Linux

Description

WordSpacing is the additional space that is added between words of the text string. Word spacing is a percentage of the original.

Specified by:

getWordSpacing in interface IFormattedTextSymbol

Returns:

The wordSpacing

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setWordSpacing

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

Description copied from interface: IFormattedTextSymbol

The word spacing.

Supported Platforms

Windows, Solaris, Linux

Description

WordSpacing is the additional space that is added between words of the text string. Word spacing is a percentage of the original.

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

Description copied from interface: IFormattedTextSymbol

Indicates if kerning is on.

Supported Platforms

Windows, Solaris, Linux

Description

Kerning indicates whether the specific relationship of two adjacent characters within their character cells is examined and adjusted according to the predefined font metrics specific to each typeface.

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

Description copied from interface: IFormattedTextSymbol

Indicates if kerning is on.

Supported Platforms

Windows, Solaris, Linux

Description

Kerning indicates whether the specific relationship of two adjacent characters within their character cells is examined and adjusted according to the predefined font metrics specific to each typeface.

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

Description copied from interface: IFormattedTextSymbol

The character leading.

Supported Platforms

Windows, Solaris, Linux

Description

Leading specifies the adjustment to regular spacing between lines. 0 units means no adjustment to regular line spacing. Leading is generally equal to or greater than the text size.

Specified by:

getLeading in interface IFormattedTextSymbol

Returns:

The leading

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setLeading

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

Description copied from interface: IFormattedTextSymbol

The character leading.

Supported Platforms

Windows, Solaris, Linux

Description

Leading specifies the adjustment to regular spacing between lines. 0 units means no adjustment to regular line spacing. Leading is generally equal to or greater than the text size.

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

Description copied from interface: IFormattedTextSymbol

The text direction.

Supported Platforms

Windows, Solaris, Linux

Description

Direction is the enumeration that defines the flow direction of the text. There are three options: esriTDAngle, esriTDHorizontal, and esriTDVertical. esriTDHorizontal is the default Direction.

Remarks

Direction is not yet implemented.

Specified by:

getDirection in interface IFormattedTextSymbol

Returns:

A com.esri.arcgis.display.esriTextDirection constant

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setDirection

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

Description copied from interface: IFormattedTextSymbol

The text direction.

Supported Platforms

Windows, Solaris, Linux

Description

Direction is the enumeration that defines the flow direction of the text. There are three options: esriTDAngle, esriTDHorizontal, and esriTDVertical. esriTDHorizontal is the default Direction.

Remarks

Direction is not yet implemented.

Specified by:

setDirection in interface IFormattedTextSymbol

Parameters:

textDirection - A com.esri.arcgis.display.esriTextDirection constant (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getFlipAngle

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

Description copied from interface: IFormattedTextSymbol

The flip angle.

Supported Platforms

Windows, Solaris, Linux

Description

Flipangle specifies the angle (in degrees from the vertical) at which point rotated text is flipped (mirrored) in place. The valid range is -360 to 360.

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

Description copied from interface: IFormattedTextSymbol

The flip angle.

Supported Platforms

Windows, Solaris, Linux

Description

Flipangle specifies the angle (in degrees from the vertical) at which point rotated text is flipped (mirrored) in place. The valid range is -360 to 360.

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

Description copied from interface: IFormattedTextSymbol

The text background object.

Supported Platforms

Windows, Solaris, Linux

Description

Background is the object displayed behind the text. IBalloonCallout, ILineCallout, ISimpleLineCallout or IMarkerTextBackground can be used as backgrounds for text.

Specified by:

getBackground in interface IFormattedTextSymbol

Returns:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setBackgroundByRef

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

Description copied from interface: IFormattedTextSymbol

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

Description copied from interface: IFormattedTextSymbol

Indicates if typesetting is used.

Supported Platforms

Windows, Solaris, Linux

Description

TypeSetting is a Boolean indicator that determines whether text formatting tags will be either executed or displayed as characters within the string. True - formatting tags will be executed. False - formatting tags will be displayed as characters.

Specified by:

isTypeSetting in interface IFormattedTextSymbol

Returns:

The typeSetting

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setTypeSetting

public void setTypeSetting(boolean typeSetting)
                    throws java.io.IOException,
                           AutomationException

Description copied from interface: IFormattedTextSymbol

Indicates if typesetting is used.

Supported Platforms

Windows, Solaris, Linux

Description

TypeSetting is a Boolean indicator that determines whether text formatting tags will be either executed or displayed as characters within the string. True - formatting tags will be executed. False - formatting tags will be displayed as characters.

Specified by:

setTypeSetting in interface IFormattedTextSymbol

Parameters:

typeSetting - The typeSetting (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getFillSymbol

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

Description copied from interface: IFormattedTextSymbol

The fill symbol.

Supported Platforms

Windows, Solaris, Linux

Description

FillSymbol is the fill symbol used to render the text. This can be any of the IFillSymbol interfaces.

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

Description copied from interface: IFormattedTextSymbol

The fill symbol.

Specified by:

setFillSymbolByRef in interface IFormattedTextSymbol

Parameters:

fillSymbol - A reference to a com.esri.arcgis.display.IFillSymbol (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getFont

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

Description copied from interface: ITextSymbol

Text font.

Supported Platforms

Windows, Solaris, Linux

Description

Font is the font that an ITextSymbol uses. Use the IFontDisp interface to set the 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:

AutomationException - If the ArcObject component throws an exception.

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

setFont

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

Description copied from interface: ITextSymbol

Text font.

Supported Platforms

Windows, Solaris, Linux

Description

Font is the font that an ITextSymbol uses. Use the IFontDisp interface to set the 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.

getSize

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

Description copied from interface: ITextSymbol

Text size.

Supported Platforms

Windows, Solaris, Linux

Description

Size is the size in points (approx. 1/72 inch) for an ITextSymbol .

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

Description copied from interface: ITextSymbol

Text size.

Supported Platforms

Windows, Solaris, Linux

Description

Size is the size in points (approx. 1/72 inch) for an ITextSymbol .

Specified by:

setSize in interface ITextSymbol

Parameters:

size - The size (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getColor

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

Description copied from interface: ITextSymbol

Text color.

Supported Platforms

Windows, Solaris, Linux

Description

Color is the color for a TextSymbol object. Any IColor object can be used.

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

Description copied from interface: ITextSymbol

Text color.

Supported Platforms

Windows, Solaris, Linux

Description

Color is the color for a TextSymbol object. Any IColor object can be used.

Specified by:

setColor in interface ITextSymbol

Parameters:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getVerticalAlignment

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

Description copied from interface: ITextSymbol

Vertical alignment style.

Supported Platforms

Windows, Solaris, Linux

Description

VerticalAlignment is the enumeration that defines how text is vertically aligned. There are four options: esriTVABaseline, esriTVABottom, esriTVACenter, and esriTVATop. esriTVABaseline is the default VerticalAlignment.

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

Description copied from interface: ITextSymbol

Vertical alignment style.

Supported Platforms

Windows, Solaris, Linux

Description

VerticalAlignment is the enumeration that defines how text is vertically aligned. There are four options: esriTVABaseline , esriTVABottom , esriTVACenter , and esriTVATop . esriTVABaseline is the default VerticalAlignment .

Specified by:

setVerticalAlignment in interface ITextSymbol

Parameters:

vertAlignment - A com.esri.arcgis.display.esriTextVerticalAlignment constant (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getHorizontalAlignment

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

Description copied from interface: ITextSymbol

Horizontal alignment style.

Supported Platforms

Windows, Solaris, Linux

Description

HorizontalAlignment is the horizontal alignment that will be applied to text that contains multiple lines. There are four options: esriTHACenter , esriTHAFull , esriTHALeft , and esriTHARight . The default option is esriTHALeft .

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

Description copied from interface: ITextSymbol

Horizontal alignment style.

Supported Platforms

Windows, Solaris, Linux

Description

HorizontalAlignment is the horizontal alignment that will be applied to text that contains multiple lines. There are four options: esriTHACenter , esriTHAFull , esriTHALeft , and esriTHARight . The default option is esriTHALeft .

Specified by:

setHorizontalAlignment in interface ITextSymbol

Parameters:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getAngle

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

Description copied from interface: ITextSymbol

Text baseline angle.

Supported Platforms

Windows, Solaris, Linux

Description

Angle is the Angle in degrees that the entire line of text is displayed.

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

Description copied from interface: ITextSymbol

Text baseline angle.

Supported Platforms

Windows, Solaris, Linux

Description

Angle is the Angle in degrees that the entire line of text is displayed.

Specified by:

setAngle in interface ITextSymbol

Parameters:

angle - The angle (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

isRightToLeft

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

Description copied from interface: ITextSymbol

Indicates if the text is drawn from right to left.

Supported Platforms

Windows, Solaris, Linux

Description

RightToLeft is whether the text is to be displayed in a right to left manner. The default value is False.

Specified by:

isRightToLeft in interface ITextSymbol

Returns:

The rightToLeft

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setRightToLeft

public void setRightToLeft(boolean rightToLeft)
                    throws java.io.IOException,
                           AutomationException

Description copied from interface: ITextSymbol

Indicates if the text is drawn from right to left.

Supported Platforms

Windows, Solaris, Linux

Description

RightToLeft is whether the text is to be displayed in a right to left manner. The default value is False.

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

Description copied from interface: ITextSymbol

Text to draw.

Supported Platforms

Windows, Solaris, Linux

Description

Text is the text string that will be drawn using the other properties of the ITextSymbol. This property is only used for low level drawing of a TextSymbol on a display and is not typically used when TextSymbols are used for TextElements. In the case of TextElements, the element stores the text that is used during drawtime.

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

Description copied from interface: ITextSymbol

Text to draw.

Supported Platforms

Windows, Solaris, Linux

Description

Text is the text string that will be drawn using the other properties of the ITextSymbol. This property is only used for low level drawing of a TextSymbol on a display and is not typically used when TextSymbols are used for TextElements. In the case of TextElements, the element stores the text that is used during drawtime.

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

Description copied from interface: ITextSymbol

Gets the x and y dimensions of 'text' in points (1/72 inch).

Supported Platforms

Windows, Solaris, Linux

Description

GetTextSize assigns by reference the x and y dimensions of a ITextSymbol given the device context, Transformation, and Text that will be used. This is helpful in planning where to place graphic elements on the map sheet.

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

Description copied from interface: ISimpleTextSymbol

Character to be interpreted as text line end.

Supported Platforms

Windows, Solaris, Linux

Description

BreakCharacter is the character code value determining line breaks.

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

Description copied from interface: ISimpleTextSymbol

Character to be interpreted as text line end.

Supported Platforms

Windows, Solaris, Linux

Description

BreakCharacter is the character code value determining line breaks.

Specified by:

setBreakCharacter in interface ISimpleTextSymbol

Parameters:

charIndex - The charIndex (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

isClip

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

Description copied from interface: ISimpleTextSymbol

Indicates if the text will be clipped per geometry.

Supported Platforms

Windows, Solaris, Linux

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

Description copied from interface: ISimpleTextSymbol

Indicates if the text will be clipped per geometry.

Supported Platforms

Windows, Solaris, Linux

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

Description copied from interface: ISimpleTextSymbol

Path of text baseline.

Supported Platforms

Windows, Solaris, Linux

Description

TextPath sets or returns a TextPath object.

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

Description copied from interface: ISimpleTextSymbol

Path of text baseline.

Specified by:

setTextPathByRef in interface ISimpleTextSymbol

Parameters:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getXOffset

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

Description copied from interface: ISimpleTextSymbol

Text offset along X-axis.

Supported Platforms

Windows, Solaris, Linux

Description

XOffset sets or returns the horizontal offset.

Specified by:

getXOffset in interface ISimpleTextSymbol

Returns:

The xOffset

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setXOffset

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

Description copied from interface: ISimpleTextSymbol

Text offset along X-axis.

Supported Platforms

Windows, Solaris, Linux

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

Description copied from interface: ISimpleTextSymbol

Text offset along Y-axis.

Supported Platforms

Windows, Solaris, Linux

Description

YOffset sets or returns the vertical offset.

Specified by:

getYOffset in interface ISimpleTextSymbol

Returns:

The yOffset

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setYOffset

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

Description copied from interface: ISimpleTextSymbol

Text offset along Y-axis.

Supported Platforms

Windows, Solaris, Linux

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.

getMapLevel

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

Description copied from interface: IMapLevel

Current map level for drawing multi-level symbols.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getMapLevel in interface IMapLevel

Returns:

The mapLevel

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setMapLevel

public void setMapLevel(int mapLevel)
                 throws java.io.IOException,
                        AutomationException

Description copied from interface: IMapLevel

Current map level for drawing multi-level symbols.

Supported Platforms

Windows, Solaris, Linux

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.

setupDC

public void setupDC(int hDC,
                    ITransformation transformation)
             throws java.io.IOException,
                    AutomationException

Description copied from interface: ISymbol

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

Description copied from interface: ISymbol

Restores DC to original state.

Supported Platforms

Windows, Solaris, Linux

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

Description copied from interface: ISymbol

Draws the specified shape.

Supported Platforms

Windows, Solaris, Linux

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

Description copied from interface: ISymbol

Fills an existing polygon with the boundary of the specified symbol.

Supported Platforms

Windows, Solaris, Linux

Remarks

Valid input Geometries are as follows:

For MarkerSymbols, the Geometry must be an IPoint.

For Fill Symbols, the Geometry can be either an IPolygon or an IEnvelope.

For Line Symbols, the Geometry must be an IPolyline.

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:

AutomationException - If the ArcObject component throws an exception.

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

getROP2

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

Description copied from interface: ISymbol

Raster operation code for pixel drawing.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getROP2 in interface ISymbol

Returns:

A com.esri.arcgis.display.esriRasterOpCode constant

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setROP2

public void setROP2(int drawMode)
             throws java.io.IOException,
                    AutomationException

Description copied from interface: ISymbol

Raster operation code for pixel drawing.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setROP2 in interface ISymbol

Parameters:

drawMode - A com.esri.arcgis.display.esriRasterOpCode constant (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

isRotateWithTransform

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

Description copied from interface: ISymbolRotation

Indicates if the symbol rotates with the display.

Supported Platforms

Windows, Solaris, Linux

Specified by:

isRotateWithTransform in interface ISymbolRotation

Returns:

The flag

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setRotateWithTransform

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

Description copied from interface: ISymbolRotation

Indicates if the symbol rotates with the display.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setRotateWithTransform in interface ISymbolRotation

Parameters:

flag - The flag (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getMaskStyle

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

Description copied from interface: IMask

The mask style.

Supported Platforms

Windows, Solaris, Linux

Description

MaskStyle is the enumeration that defines the shape of the mask. There are two options: esriMSHalo and esriMSNone. esriMSNone is the default MaskStyle.

Specified by:

getMaskStyle in interface IMask

Returns:

A com.esri.arcgis.display.esriMaskStyle constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMaskStyle

public void setMaskStyle(int style)
                  throws java.io.IOException,
                         AutomationException

Description copied from interface: IMask

The mask style.

Supported Platforms

Windows, Solaris, Linux

Description

MaskStyle is the enumeration that defines the shape of the mask. There are two options: esriMSHalo and esriMSNone. esriMSNone is the default MaskStyle.

Specified by:

setMaskStyle in interface IMask

Parameters:

style - A com.esri.arcgis.display.esriMaskStyle constant (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getMaskSize

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

Description copied from interface: IMask

The mask size.

Supported Platforms

Windows, Solaris, Linux

Description

MaskSize returns or Sets the Double (ASCII) number for the size of the mask in points (approx. 1/72 inch).

Specified by:

getMaskSize in interface IMask

Returns:

The size

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMaskSize

public void setMaskSize(double size)
                 throws java.io.IOException,
                        AutomationException

Description copied from interface: IMask

The mask size.

Supported Platforms

Windows, Solaris, Linux

Description

MaskSize returns or Sets the Double (ASCII) number for the size of the mask in points (approx. 1/72 inch).

Specified by:

setMaskSize in interface IMask

Parameters:

size - The size (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getMaskSymbol

public IFillSymbol getMaskSymbol()
                          throws java.io.IOException,
                                 AutomationException

Description copied from interface: IMask

The mask symbol.

Supported Platforms

Windows, Solaris, Linux

Description

MaskSymbol is the fill symbol used as the mask. Any IFillSymbol interface can be used.

Specified by:

getMaskSymbol in interface IMask

Returns:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setMaskSymbolByRef

public void setMaskSymbolByRef(IFillSymbol fillSym)
                        throws java.io.IOException,
                               AutomationException

Description copied from interface: IMask

The mask symbol.

Specified by:

setMaskSymbolByRef in interface IMask

Parameters:

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

isDirty

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

Description copied from interface: IPersistStream

Supported Platforms

Windows, Solaris, Linux

Description

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

Specified by:

isDirty in interface IPersistStream

Throws:

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

AutomationException - If the ArcObject component throws an exception.

load

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

Description copied from interface: IPersistStream

Supported Platforms

Windows, Solaris, Linux

Description

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

Specified by:

load in interface IPersistStream

Parameters:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

save

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

Description copied from interface: IPersistStream

Supported Platforms

Windows, Solaris, Linux

Description

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

Specified by:

save in interface IPersistStream

Parameters:

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

fClearDirty - The fClearDirty (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSizeMax

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

Description copied from interface: IPersistStream

Supported Platforms

Windows, Solaris, Linux

Description

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

Specified by:

getSizeMax in interface IPersistStream

Parameters:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getClassID

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

Description copied from interface: IPersist

Supported Platforms

Windows, Solaris, Linux

Description

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

Specified by:

getClassID in interface IPersist

Parameters:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

esri_clone

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

Description copied from interface: IClone

Clones the receiver and assigns the result to *clone.

Specified by:

esri_clone in interface IClone

Returns:

A reference to a com.esri.arcgis.system.IClone

Throws:

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

AutomationException - If the ArcObject component throws an exception.

assign

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

Description copied from interface: IClone

Assigns the properties of src to the receiver.

Supported Platforms

Windows, Solaris, Linux

Description

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

Specified by:

assign in interface IClone

Parameters:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

isEqual

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

Description copied from interface: IClone

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

Specified by:

isEqual in interface IClone

Parameters:

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

Returns:

The equal

Throws:

AutomationException - If the ArcObject component throws an exception.

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

isIdentical

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

Description copied from interface: IClone

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

Specified by:

isIdentical in interface IClone

Parameters:

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

Returns:

The identical

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getNameString

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

Description copied from interface: IDisplayName

The display name of an object.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getNameString in interface IDisplayName

Returns:

The displayName

Throws:

AutomationException - If the ArcObject component throws an exception.

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

applies

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

Description copied from interface: IPropertySupport

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

Supported Platforms

Windows, Solaris, Linux

Remarks

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

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

Specified by:

applies in interface IPropertySupport

Parameters:

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

Returns:

The applies

Throws:

AutomationException - If the ArcObject component throws an exception.

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

canApply

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

Description copied from interface: IPropertySupport

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

Supported Platforms

Windows, Solaris, Linux

Remarks

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

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

Specified by:

canApply in interface IPropertySupport

Parameters:

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

Returns:

The canApply

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getCurrent

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

Description copied from interface: IPropertySupport

The object currently being used.

Supported Platforms

Windows, Solaris, Linux

Remarks

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

Specified by:

getCurrent in interface IPropertySupport

Parameters:

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

Returns:

A reference to another Object (IUnknown)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

apply

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

Description copied from interface: IPropertySupport

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

Supported Platforms

Windows, Solaris, Linux

Remarks

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

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

Specified by:

apply in interface IPropertySupport

Parameters:

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

Returns:

A reference to another Object (IUnknown)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getTextParser

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

Description copied from interface: ITextParserSupport

The text parser.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getTextParser in interface ITextParserSupport

Returns:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setTextParserByRef

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

Description copied from interface: ITextParserSupport

The text parser.

Specified by:

setTextParserByRef in interface ITextParserSupport

Parameters:

parser - A reference to a com.esri.arcgis.display.ITextParser (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getGeometry

public IGeometry getGeometry(int hDC,
                             ITransformation displayTransform,
                             IGeometry drawGeometry)
                      throws java.io.IOException,
                             AutomationException

Description copied from interface: IQueryGeometry

Gets the actual geometry of the boundary of the object (which may or may not be a polygon).

Supported Platforms

Windows, Solaris, Linux

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

Description copied from interface: IQueryGeometry

Queries the envelope of the boundary of the object.

Supported Platforms

Windows, Solaris, Linux

Description

You must instantiate the Envelope before calling QueryEnvelope. For example,

Dim pEnv as IEnvelope
Set pEnv = New Envelope

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:

AutomationException - If the ArcObject component throws an exception.

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

getMargin

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

Description copied from interface: IMarginProperties

Value for the margin.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getMargin in interface IMarginProperties

Returns:

The margin

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setMargin

public void setMargin(double margin)
               throws java.io.IOException,
                      AutomationException

Description copied from interface: IMarginProperties

Value for the margin.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setMargin in interface IMarginProperties

Parameters:

margin - The margin (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

Description copied from interface: ITextDrawSupport

Get text the way it will be drawn. Optionally gives the positions of drawn characters in the original string of characters.

Supported Platforms

Windows, Solaris, Linux

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

Description copied from interface: ITextDrawSupport

Gets an array of WKSPoints which represent the position at which each line of text is drawn; pGeometry must be a point.

Supported Platforms

Windows, Solaris, Linux

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

Description copied from interface: IWordBoundaries

Fills an existing geometry bag with the boundaries of the words in the text symbol.

Supported Platforms

Windows, Solaris, Linux

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:

AutomationException - If the ArcObject component throws an exception.

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

serialize

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

Description copied from interface: IXMLSerialize

Serializes an object to XML.

Supported Platforms

Windows, Solaris, Linux

Specified by:

serialize in interface IXMLSerialize

Parameters:

data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

deserialize

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

Description copied from interface: IXMLSerialize

Deserializes an object from XML.

Supported Platforms

Windows, Solaris, Linux

Specified by:

deserialize in interface IXMLSerialize

Parameters:

data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setCJKCharactersRotation

public void setCJKCharactersRotation(boolean rotation)
                              throws java.io.IOException,
                                     AutomationException

Description copied from interface: ICharacterOrientation

Indicates if CJK charcters are rotated.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setCJKCharactersRotation in interface ICharacterOrientation

Parameters:

rotation - The rotation (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

isCJKCharactersRotation

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

Description copied from interface: ICharacterOrientation

Indicates if CJK charcters are rotated.

Supported Platforms

Windows, Solaris, Linux

Specified by:

isCJKCharactersRotation in interface ICharacterOrientation

Returns:

The rotation

Throws:

AutomationException - If the ArcObject component throws an exception.

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