com.esri.arcgis.display
Class ITextSymbolProxy

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

All Implemented Interfaces:

ITextSymbol, Externalizable, Serializable

Direct Known Subclasses:

IFormattedTextSymbolProxy, ISimpleTextSymbolProxy

public class ITextSymbolProxy
extends com.esri.arcgis.interop.Dispatch
implements ITextSymbol, Serializable

Provides access to members that control text symbols.

Description

ITextSymbol is the generic interface for properties of IFormattedTextSymbol and ISimpleTextSymbol.

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

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

Method Summary

void	addListener(String iidStr, Object theListener, Object theSource)
double	getAngle() Text baseline angle.
IColor	getColor() Text color.
Font	getFont() Text font.
int	getHorizontalAlignment() Horizontal alignment style.
double	getSize() Text size.
String	getText() Text to draw.
void	getTextSize(int hDC, ITransformation transformation, String text, double[] xSize, double[] ySize) Gets the x and y dimensions of 'text' in points (1/72 inch).
int	getVerticalAlignment() Vertical alignment style.
boolean	isRightToLeft() Indicates if the text is drawn from right to left.
void	removeListener(String iidStr, Object theListener)
void	setAngle(double angle) Text baseline angle.
void	setColor(IColor color) Text color.
void	setFont(Font fontDisp) Text font.
void	setHorizontalAlignment(int horizAlignment) Horizontal alignment style.
void	setRightToLeft(boolean rightToLeft) Indicates if the text is drawn from right to left.
void	setSize(double size) Text size.
void	setText(String text) Text to draw.
void	setVerticalAlignment(int vertAlignment) Vertical alignment style.

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

Field Detail

noncastable

public boolean noncastable

Constructor Detail

ITextSymbolProxy

public ITextSymbolProxy()

ITextSymbolProxy

public ITextSymbolProxy(Object obj)
                 throws IOException

Throws:

IOException

ITextSymbolProxy

protected ITextSymbolProxy(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 com.esri.arcgis.interop.Dispatch

Throws:

IOException

removeListener

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

Overrides:

removeListener in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

getFont

public Font getFont()
             throws IOException,
                    AutomationException

Text font.

Description

Font is the font that an ITextSymbol uses. Use the IFontDisp interface to set the font.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFont

public void setFont(Font fontDisp)
             throws IOException,
                    AutomationException

Text font.

Description

Font is the font that an ITextSymbol uses. Use the IFontDisp interface to set the font.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSize

public double getSize()
               throws IOException,
                      AutomationException

Text size.

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getSize in interface ITextSymbol

Returns:

The size

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSize

public void setSize(double size)
             throws IOException,
                    AutomationException

Text size.

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setSize in interface ITextSymbol

Parameters:

size - The size (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getColor

public IColor getColor()
                throws IOException,
                       AutomationException

Text color.

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getColor in interface ITextSymbol

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

setColor

public void setColor(IColor color)
              throws IOException,
                     AutomationException

Text color.

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setColor in interface ITextSymbol

Parameters:

color - 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

getVerticalAlignment

public int getVerticalAlignment()
                         throws IOException,
                                AutomationException

Vertical alignment style.

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getVerticalAlignment in interface ITextSymbol

Returns:

A com.esri.arcgis.display.esriTextVerticalAlignment constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setVerticalAlignment

public void setVerticalAlignment(int vertAlignment)
                          throws IOException,
                                 AutomationException

Vertical alignment style.

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 .

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setVerticalAlignment in interface ITextSymbol

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getHorizontalAlignment

public int getHorizontalAlignment()
                           throws IOException,
                                  AutomationException

Horizontal alignment style.

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 .

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getHorizontalAlignment in interface ITextSymbol

Returns:

A com.esri.arcgis.display.esriTextHorizontalAlignment constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setHorizontalAlignment

public void setHorizontalAlignment(int horizAlignment)
                            throws IOException,
                                   AutomationException

Horizontal alignment style.

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 .

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setHorizontalAlignment in interface ITextSymbol

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAngle

public double getAngle()
                throws IOException,
                       AutomationException

Text baseline angle.

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getAngle in interface ITextSymbol

Returns:

The angle

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAngle

public void setAngle(double angle)
              throws IOException,
                     AutomationException

Text baseline angle.

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setAngle in interface ITextSymbol

Parameters:

angle - The angle (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isRightToLeft

public boolean isRightToLeft()
                      throws IOException,
                             AutomationException

Indicates if the text is drawn from right to left.

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isRightToLeft in interface ITextSymbol

Returns:

The rightToLeft

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRightToLeft

public void setRightToLeft(boolean rightToLeft)
                    throws IOException,
                           AutomationException

Indicates if the text is drawn from right to left.

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setRightToLeft in interface ITextSymbol

Parameters:

rightToLeft - The rightToLeft (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getText

public String getText()
               throws IOException,
                      AutomationException

Text to draw.

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getText in interface ITextSymbol

Returns:

The text

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setText

public void setText(String text)
             throws IOException,
                    AutomationException

Text to draw.

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setText in interface ITextSymbol

Parameters:

text - The text (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTextSize

public void getTextSize(int hDC,
                        ITransformation transformation,
                        String text,
                        double[] xSize,
                        double[] ySize)
                 throws IOException,
                        AutomationException

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

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.