com.esri.arcgis.display
Class ISimpleTextSymbolProxy

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

All Implemented Interfaces:

ISimpleTextSymbol, ITextSymbol, Externalizable, Serializable

public class ISimpleTextSymbolProxy
extends ITextSymbolProxy
implements ISimpleTextSymbol, Serializable

Provides access to members that control the simple text symbol.

Description

ISimpleTextSymbol is the interface for text symbols that have basic text display capabilties. Use IFormattedTextSymbol to create text symbols with a high degree of display control.

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

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

Method Summary

void	addListener(String iidStr, Object theListener, Object theSource)
int	getBreakCharacter() Character to be interpreted as text line end.
ITextPath	getTextPath() Path of text baseline.
double	getXOffset() Text offset along X-axis.
double	getYOffset() Text offset along Y-axis.
boolean	isClip() Indicates if the text will be clipped per geometry.
void	removeListener(String iidStr, Object theListener)
void	setBreakCharacter(int charIndex) Character to be interpreted as text line end.
void	setClip(boolean clip) Indicates if the text will be clipped per geometry.
void	setTextPathByRef(ITextPath textPath) Path of text baseline.
void	setXOffset(double xOffset) Text offset along X-axis.
void	setYOffset(double yOffset) Text offset along Y-axis.

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

ISimpleTextSymbolProxy

public ISimpleTextSymbolProxy()

ISimpleTextSymbolProxy

public ISimpleTextSymbolProxy(Object obj)
                       throws IOException

Throws:

IOException

ISimpleTextSymbolProxy

protected ISimpleTextSymbolProxy(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

getBreakCharacter

public int getBreakCharacter()
                      throws IOException,
                             AutomationException

Character to be interpreted as text line end.

Description

BreakCharacter is the character code value determining line breaks.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getBreakCharacter in interface ISimpleTextSymbol

Returns:

The charIndex

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBreakCharacter

public void setBreakCharacter(int charIndex)
                       throws IOException,
                              AutomationException

Character to be interpreted as text line end.

Description

BreakCharacter is the character code value determining line breaks.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setBreakCharacter in interface ISimpleTextSymbol

Parameters:

charIndex - The charIndex (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isClip

public boolean isClip()
               throws IOException,
                      AutomationException

Indicates if the text will be clipped per geometry.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isClip in interface ISimpleTextSymbol

Returns:

The clip

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setClip

public void setClip(boolean clip)
             throws IOException,
                    AutomationException

Indicates if the text will be clipped per geometry.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setClip in interface ISimpleTextSymbol

Parameters:

clip - The clip (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTextPath

public ITextPath getTextPath()
                      throws IOException,
                             AutomationException

Path of text baseline.

Description

TextPath sets or returns a TextPath object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getTextPath in interface ISimpleTextSymbol

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTextPathByRef

public void setTextPathByRef(ITextPath textPath)
                      throws IOException,
                             AutomationException

Path of text baseline.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setTextPathByRef in interface ISimpleTextSymbol

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getXOffset

public double getXOffset()
                  throws IOException,
                         AutomationException

Text offset along X-axis.

Description

XOffset sets or returns the horizontal offset.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getXOffset in interface ISimpleTextSymbol

Returns:

The xOffset

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setXOffset

public void setXOffset(double xOffset)
                throws IOException,
                       AutomationException

Text offset along X-axis.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setXOffset in interface ISimpleTextSymbol

Parameters:

xOffset - The xOffset (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getYOffset

public double getYOffset()
                  throws IOException,
                         AutomationException

Text offset along Y-axis.

Description

YOffset sets or returns the vertical offset.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getYOffset in interface ISimpleTextSymbol

Returns:

The yOffset

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setYOffset

public void setYOffset(double yOffset)
                throws IOException,
                       AutomationException

Text offset along Y-axis.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setYOffset in interface ISimpleTextSymbol

Parameters:

yOffset - The yOffset (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.