com.esri.arcgis.display
Class IFormattedTextSymbolProxy

java.lang.Object
  com.esri.arcgis.interop.Dispatch
      com.esri.arcgis.display.ITextSymbolProxy
          com.esri.arcgis.display.IFormattedTextSymbolProxy

All Implemented Interfaces:

IFormattedTextSymbol, ITextSymbol, Externalizable, Serializable

public class IFormattedTextSymbolProxy
extends ITextSymbolProxy
implements IFormattedTextSymbol, Serializable

Provides access to members that control the formatted text symbol.

Description

IFormattedTextSymbol is the interface for creating text symbols that have robust character placement and background display properties.

Remarks

Change the spread of characters in the text string by setting the CharacterSpacing property, which indicates the spacing between each character as a percentage. The default is 0, which indicates the standard character spacing, but values of -200 to 200 are valid. Lines of text can be spaced by setting the Leading property, whose units are Points.

You can change the case of every alphabetic character in the text string by setting the Case property to one of the esriTextCase constants.

You can also create subscript and superscript text by setting the Position property.

Product Availability

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

See Also:

IFormattedTextSymbol, ITextSymbol, ISimpleTextSymbol, Serialized Form

Field Summary

boolean

noncastable

Fields inherited from class com.esri.arcgis.interop.Dispatch

DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, objRef

Constructor Summary

	IFormattedTextSymbolProxy()
	IFormattedTextSymbolProxy(Object obj)
protected	IFormattedTextSymbolProxy(Object obj, String iid)

Method Summary

void	addListener(String iidStr, Object theListener, Object theSource)
ITextBackground	getBackground() The text background object.
int	getCase() The text case.
double	getCharacterSpacing() The character spacing.
double	getCharacterWidth() The character width.
int	getDirection() The text direction.
IFillSymbol	getFillSymbol() The fill symbol.
double	getFlipAngle() The flip angle.
double	getLeading() The character leading.
int	getPosition() The text position.
IColor	getShadowColor() The shadow color.
double	getShadowXOffset() The shadow X offset.
double	getShadowYOffset() The shadow Y offset.
double	getWordSpacing() The word spacing.
boolean	isKerning() Indicates if kerning is on.
boolean	isTypeSetting() Indicates if typesetting is used.
void	removeListener(String iidStr, Object theListener)
void	setBackgroundByRef(ITextBackground background) The text background object.
void	setCase(int textCase) The text case.
void	setCharacterSpacing(double characterSpacing) The character spacing.
void	setCharacterWidth(double characterWidth) The character width.
void	setDirection(int textDirection) The text direction.
void	setFillSymbolByRef(IFillSymbol fillSymbol) The fill symbol.
void	setFlipAngle(double flipAngle) The flip angle.
void	setKerning(boolean kerning) Indicates if kerning is on.
void	setLeading(double leading) The character leading.
void	setPosition(int textPosition) The text position.
void	setShadowColor(IColor shadowColor) The shadow color.
void	setShadowXOffset(double xOffset) The shadow X offset.
void	setShadowYOffset(double yOffset) The shadow Y offset.
void	setTypeSetting(boolean typeSetting) Indicates if typesetting is used.
void	setWordSpacing(double wordSpacing) The word spacing.

Methods inherited from class com.esri.arcgis.display.ITextSymbolProxy

getAngle, getColor, getFont, getHorizontalAlignment, getSize, getText, getTextSize, getVerticalAlignment, isRightToLeft, setAngle, setColor, setFont, setHorizontalAlignment, setRightToLeft, setSize, setText, setVerticalAlignment

Methods inherited from class com.esri.arcgis.interop.Dispatch

bindUsingMoniker, constructVtblPosTable, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, getVtblPos, hashCode, initDispatch, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, optimizedVtblInvoke, queryInterface, readExternal, release, setNativeMode, setPropertyByName, toString, vtblInvoke, writeExternal

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.esri.arcgis.display.ITextSymbol

getAngle, getColor, getFont, getHorizontalAlignment, getSize, getText, getTextSize, getVerticalAlignment, isRightToLeft, setAngle, setColor, setFont, setHorizontalAlignment, setRightToLeft, setSize, setText, setVerticalAlignment

Field Detail

noncastable

public boolean noncastable

Constructor Detail

IFormattedTextSymbolProxy

public IFormattedTextSymbolProxy()

IFormattedTextSymbolProxy

public IFormattedTextSymbolProxy(Object obj)
                          throws IOException

Throws:

IOException

IFormattedTextSymbolProxy

protected IFormattedTextSymbolProxy(Object obj,
                                    String iid)
                             throws IOException

Throws:

IOException

Method Detail

addListener

public void addListener(String iidStr,
                        Object theListener,
                        Object theSource)
                 throws IOException

Overrides:

addListener in class ITextSymbolProxy

Throws:

IOException

removeListener

public void removeListener(String iidStr,
                           Object theListener)
                    throws IOException

Overrides:

removeListener in class ITextSymbolProxy

Throws:

IOException

getShadowColor

public IColor getShadowColor()
                      throws IOException,
                             AutomationException

The shadow color.

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getShadowColor in interface IFormattedTextSymbol

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

IHsvColor, IHlsColor

setShadowColor

public void setShadowColor(IColor shadowColor)
                    throws IOException,
                           AutomationException

The shadow color.

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setShadowColor in interface IFormattedTextSymbol

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

IHsvColor, IHlsColor

getShadowXOffset

public double getShadowXOffset()
                        throws IOException,
                               AutomationException

The shadow X offset.

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getShadowXOffset in interface IFormattedTextSymbol

Returns:

The xOffset

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setShadowXOffset

public void setShadowXOffset(double xOffset)
                      throws IOException,
                             AutomationException

The shadow X offset.

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setShadowXOffset in interface IFormattedTextSymbol

Parameters:

xOffset - The xOffset (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getShadowYOffset

public double getShadowYOffset()
                        throws IOException,
                               AutomationException

The shadow Y offset.

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getShadowYOffset in interface IFormattedTextSymbol

Returns:

The yOffset

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setShadowYOffset

public void setShadowYOffset(double yOffset)
                      throws IOException,
                             AutomationException

The shadow Y offset.

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setShadowYOffset in interface IFormattedTextSymbol

Parameters:

yOffset - The yOffset (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPosition

public int getPosition()
                throws IOException,
                       AutomationException

The text position.

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getPosition in interface IFormattedTextSymbol

Returns:

A com.esri.arcgis.display.esriTextPosition constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

esriTextPosition

setPosition

public void setPosition(int textPosition)
                 throws IOException,
                        AutomationException

The text position.

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setPosition in interface IFormattedTextSymbol

Parameters:

textPosition - A com.esri.arcgis.display.esriTextPosition constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

esriTextPosition

getCase

public int getCase()
            throws IOException,
                   AutomationException

The text case.

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getCase in interface IFormattedTextSymbol

Returns:

A com.esri.arcgis.display.esriTextCase constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

esriTextCase

setCase

public void setCase(int textCase)
             throws IOException,
                    AutomationException

The text case.

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setCase in interface IFormattedTextSymbol

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

esriTextCase

getCharacterSpacing

public double getCharacterSpacing()
                           throws IOException,
                                  AutomationException

The character spacing.

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getCharacterSpacing in interface IFormattedTextSymbol

Returns:

The characterSpacing

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCharacterSpacing

public void setCharacterSpacing(double characterSpacing)
                         throws IOException,
                                AutomationException

The character spacing.

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setCharacterSpacing in interface IFormattedTextSymbol

Parameters:

characterSpacing - The characterSpacing (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCharacterWidth

public double getCharacterWidth()
                         throws IOException,
                                AutomationException

The character width.

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getCharacterWidth in interface IFormattedTextSymbol

Returns:

The characterWidth

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCharacterWidth

public void setCharacterWidth(double characterWidth)
                       throws IOException,
                              AutomationException

The character width.

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setCharacterWidth in interface IFormattedTextSymbol

Parameters:

characterWidth - The characterWidth (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getWordSpacing

public double getWordSpacing()
                      throws IOException,
                             AutomationException

The word spacing.

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getWordSpacing in interface IFormattedTextSymbol

Returns:

The wordSpacing

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setWordSpacing

public void setWordSpacing(double wordSpacing)
                    throws IOException,
                           AutomationException

The word spacing.

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setWordSpacing in interface IFormattedTextSymbol

Parameters:

wordSpacing - The wordSpacing (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isKerning

public boolean isKerning()
                  throws IOException,
                         AutomationException

Indicates if kerning is on.

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isKerning in interface IFormattedTextSymbol

Returns:

The kerning

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setKerning

public void setKerning(boolean kerning)
                throws IOException,
                       AutomationException

Indicates if kerning is on.

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setKerning in interface IFormattedTextSymbol

Parameters:

kerning - The kerning (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLeading

public double getLeading()
                  throws IOException,
                         AutomationException

The character leading.

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getLeading in interface IFormattedTextSymbol

Returns:

The leading

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLeading

public void setLeading(double leading)
                throws IOException,
                       AutomationException

The character leading.

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setLeading in interface IFormattedTextSymbol

Parameters:

leading - The leading (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDirection

public int getDirection()
                 throws IOException,
                        AutomationException

The text direction.

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getDirection in interface IFormattedTextSymbol

Returns:

A com.esri.arcgis.display.esriTextDirection constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDirection

public void setDirection(int textDirection)
                  throws IOException,
                         AutomationException

The text direction.

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setDirection in interface IFormattedTextSymbol

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFlipAngle

public double getFlipAngle()
                    throws IOException,
                           AutomationException

The flip angle.

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getFlipAngle in interface IFormattedTextSymbol

Returns:

The flipAngle

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFlipAngle

public void setFlipAngle(double flipAngle)
                  throws IOException,
                         AutomationException

The flip angle.

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setFlipAngle in interface IFormattedTextSymbol

Parameters:

flipAngle - The flipAngle (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBackground

public ITextBackground getBackground()
                              throws IOException,
                                     AutomationException

The text background object.

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getBackground in interface IFormattedTextSymbol

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBackgroundByRef

public void setBackgroundByRef(ITextBackground background)
                        throws IOException,
                               AutomationException

The text background object.

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setBackgroundByRef in interface IFormattedTextSymbol

Parameters:

background - A reference to a com.esri.arcgis.display.ITextBackground (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isTypeSetting

public boolean isTypeSetting()
                      throws IOException,
                             AutomationException

Indicates if typesetting is used.

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isTypeSetting in interface IFormattedTextSymbol

Returns:

The typeSetting

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTypeSetting

public void setTypeSetting(boolean typeSetting)
                    throws IOException,
                           AutomationException

Indicates if typesetting is used.

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setTypeSetting in interface IFormattedTextSymbol

Parameters:

typeSetting - The typeSetting (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFillSymbol

public IFillSymbol getFillSymbol()
                          throws IOException,
                                 AutomationException

The fill symbol.

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getFillSymbol in interface IFormattedTextSymbol

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFillSymbolByRef

public void setFillSymbolByRef(IFillSymbol fillSymbol)
                        throws IOException,
                               AutomationException

The fill symbol.

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setFillSymbolByRef in interface IFormattedTextSymbol

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.