com.esri.arcgis.display
Class SimpleTextPath

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

All Implemented Interfaces:

ITextPath, ITextPath2, com.esri.arcgis.interop.RemoteObjRef, IPersist, Serializable

public class SimpleTextPath
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, ITextPath, ITextPath2, IPersist

Helper object used to align a text string to a geometry.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:

Serialized Form

Constructor Summary

SimpleTextPath()
Constructs a SimpleTextPath using ArcGIS Engine.

SimpleTextPath(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
SimpleTextPath theSimpleTextPath = (SimpleTextPath) obj;

Method Summary

boolean	equals(Object o) Compare this object with another
void	getClassID(GUID[] pClassID) getClassID
static String	getClsid() getClsid.
IGeometry	getGeometry() The geometry used for the path.
double	getXOffset() The X offset value.
double	getYOffset() The Y offset value.
int	hashCode() the hashcode for this object
void	next(double[] x, double[] y, double[] angle) Returns the next coordinate.
void	reset() Resets the coordinate enumerator.
void	setGeometryByRef(IGeometry geometry) The geometry used for the path.
void	setup(int hDC, ITransformation transformation, ITextSymbol textSym) Set up items needed by text path.
void	setupEx(int hDC, ITransformation transformation, ITextSymbol textSym, String text, Object charMetrics) Set up items needed by text path, including character metrics information.
void	setXOffset(double xOffset) The X offset value.
void	setYOffset(double yOffset) The Y offset value.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef

getJintegraDispatch, release

Constructor Detail

SimpleTextPath

public SimpleTextPath()
               throws IOException,
                      UnknownHostException

Constructs a SimpleTextPath using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

SimpleTextPath

public SimpleTextPath(Object obj)
               throws IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
SimpleTextPath theSimpleTextPath = (SimpleTextPath) obj;

Construct a SimpleTextPath using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to SimpleTextPath.

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

setup

public void setup(int hDC,
                  ITransformation transformation,
                  ITextSymbol textSym)
           throws IOException,
                  AutomationException

Set up items needed by text path.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setup in interface ITextPath

Parameters:

hDC - The hDC (A COM typedef) (in)

transformation - A reference to a com.esri.arcgis.geometry.ITransformation (in)

textSym - A reference to a com.esri.arcgis.display.ITextSymbol (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getGeometry

public IGeometry getGeometry()
                      throws IOException,
                             AutomationException

The geometry used for the path.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getGeometry in interface ITextPath

Returns:

A reference to a com.esri.arcgis.geometry.IGeometry

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setGeometryByRef

public void setGeometryByRef(IGeometry geometry)
                      throws IOException,
                             AutomationException

The geometry used for the path.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setGeometryByRef in interface ITextPath

Parameters:

geometry - A reference to a com.esri.arcgis.geometry.IGeometry (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getXOffset

public double getXOffset()
                  throws IOException,
                         AutomationException

The X offset value.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getXOffset in interface ITextPath

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

The X offset value.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setXOffset in interface ITextPath

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

The Y offset value.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getYOffset in interface ITextPath

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

The Y offset value.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setYOffset in interface ITextPath

Parameters:

yOffset - The yOffset (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

next

public void next(double[] x,
                 double[] y,
                 double[] angle)
          throws IOException,
                 AutomationException

Returns the next coordinate.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

next in interface ITextPath

Parameters:

x - The x (out: use single element array)

y - The y (out: use single element array)

angle - The angle (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

reset

public void reset()
           throws IOException,
                  AutomationException

Resets the coordinate enumerator.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

reset in interface ITextPath

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setupEx

public void setupEx(int hDC,
                    ITransformation transformation,
                    ITextSymbol textSym,
                    String text,
                    Object charMetrics)
             throws IOException,
                    AutomationException

Set up items needed by text path, including character metrics information.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setupEx in interface ITextPath2

Parameters:

hDC - The hDC (A COM typedef) (in)

transformation - A reference to a com.esri.arcgis.geometry.ITransformation (in)

textSym - A reference to a com.esri.arcgis.display.ITextSymbol (in)

text - The text (in)

charMetrics - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getClassID

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

getClassID

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getClassID in interface IPersist

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.