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, java.io.Serializable

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

COM Class 'SimpleTextPath'. Generated 3/19/2015 1:20:43 PM from 'C:\ArcGIS\COM\esriDisplay.olb'

Description 'Helper object used to align a text string to a geometry.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

See Also:

Serialized Form

Field Summary

Fields inherited from interface com.esri.arcgis.display.ITextPath

IID, IIDb65a3e75_2993_11d1_9a43_0080c7ec5c96, xxDummy

Fields inherited from interface com.esri.arcgis.display.ITextPath2

IID, IID6ea0e1e0_13e5_46d0_82ad_69f8993a67e3, xxDummy

Fields inherited from interface com.esri.arcgis.system.IPersist

IID, IID0000010c_0000_0000_c000_000000000046, xxDummy

Constructor Summary

SimpleTextPath()
Constructs a SimpleTextPath using ArcGIS Engine.

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

Method Summary

boolean	equals(java.lang.Object o) Compare this object with another
void	getClassID(GUID[] pClassID) getClassID
static java.lang.String	getClsid() getClsid.
IGeometry	getGeometry() The geometry used for the path.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
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	release() Release a SimpleTextPath.
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, java.lang.String text, java.lang.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

Constructor Detail

SimpleTextPath

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

Constructs a SimpleTextPath using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

SimpleTextPath

public SimpleTextPath(java.lang.Object obj)
               throws java.io.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:

java.io.IOException - if there are interop problems

Method Detail

getClsid

public static java.lang.String getClsid()

getClsid.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()

Deprecated. Internal use only.

Specified by:

getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

release

public void release()

Release a SimpleTextPath.

Specified by:

release in interface com.esri.arcgis.interop.RemoteObjRef

setup

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

Set up items needed by text path.

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:

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

AutomationException - If the ArcObject component throws an exception.

getGeometry

public IGeometry getGeometry()
                      throws java.io.IOException,
                             AutomationException

The geometry used for the path.

Specified by:

getGeometry in interface ITextPath

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.

setGeometryByRef

public void setGeometryByRef(IGeometry geometry)
                      throws java.io.IOException,
                             AutomationException

The geometry used for the path.

Specified by:

setGeometryByRef in interface ITextPath

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.

getXOffset

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

The X offset value.

Specified by:

getXOffset in interface ITextPath

Returns:

The xOffset

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setXOffset

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

The X offset value.

Specified by:

setXOffset in interface ITextPath

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

The Y offset value.

Specified by:

getYOffset in interface ITextPath

Returns:

The yOffset

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setYOffset

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

The Y offset value.

Specified by:

setYOffset in interface ITextPath

Parameters:

yOffset - The yOffset (in)

Throws:

java.io.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 java.io.IOException,
                 AutomationException

Returns the next coordinate.

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:

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

AutomationException - If the ArcObject component throws an exception.

reset

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

Resets the coordinate enumerator.

Specified by:

reset in interface ITextPath

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setupEx

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

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

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:

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

AutomationException - If the ArcObject component throws an exception.

getClassID

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

getClassID

Specified by:

getClassID in interface IPersist

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.