com.esri.arcgis.trackinganalyst
Class LabelEngineManager

java.lang.Object
  com.esri.arcgis.trackinganalyst.LabelEngineManager

All Implemented Interfaces:

com.esri.arcgis.interop.RemoteObjRef, ISupportErrorInfo, ILabelEngineManager2, ILabelEngineManager3, ITrackingLabelDraw, java.io.Serializable

public class LabelEngineManager
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, ILabelEngineManager2, ILabelEngineManager3, ITrackingLabelDraw, ISupportErrorInfo

COM Class 'LabelEngineManager'. Generated 3/19/2015 1:20:45 PM from 'C:\ArcGIS\COM\esriTrackingAnalyst.olb'

Description 'Controls functionality of the label engine manager.' 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.trackinganalyst.ILabelEngineManager2

IID, IID9e671260_7dd6_11d7_b877_00010265adc5, xxDummy

Fields inherited from interface com.esri.arcgis.trackinganalyst.ILabelEngineManager3

IID, IIDfe31bf3d_9496_4c1e_b3c7_30dc2b226109, xxDummy

Fields inherited from interface com.esri.arcgis.trackinganalyst.ITrackingLabelDraw

IID, IID2b790601_3533_4911_9f11_aa9e5d8e31e8, xxDummy

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

IID, IIDdf0b3d60_548f_101b_8e65_08002b2bd119, xxDummy

Constructor Summary

LabelEngineManager()
Constructs a LabelEngineManager using ArcGIS Engine.

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

Method Summary

void	addITxDocumentEventsListener(ITxDocumentEvents theListener) addITxDocumentEventsListener.
void	attach(java.lang.Object piDocument) Attaches a label to a feature in the label engine manager.
void	drawLayerLabels(ILayer piLayerToDraw, IDisplay piDisplay) Draws the labels for a particular layer to the display object.
boolean	equals(java.lang.Object o) Compare this object with another
static java.lang.String	getClsid() getClsid.
short	getEngineCount() Number of labels in the label engine manager.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
ITrackingLabelEngine	getLabelEngine(IMap piMap) Indicates the label engine being used by the label engine manager.
ITrackingLabelEngine	getLabelEngine3(IBasicMap piMap) Indicates the label engine being used by the label engine manager.
int	hashCode() the hashcode for this object
void	interfaceSupportsErrorInfo(GUID riid) interfaceSupportsErrorInfo
void	release() Release a LabelEngineManager.
void	removeITxDocumentEventsListener(ITxDocumentEvents theListener) removeITxDocumentEventsListener.

Methods inherited from class java.lang.Object

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

Constructor Detail

LabelEngineManager

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

Constructs a LabelEngineManager using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

LabelEngineManager

public LabelEngineManager(java.lang.Object obj)
                   throws java.io.IOException

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

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

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

addITxDocumentEventsListener

public void addITxDocumentEventsListener(ITxDocumentEvents theListener)
                                  throws java.io.IOException

addITxDocumentEventsListener. Listen to events generated by this class.

Parameters:

theListener - An object that implements the com.esri.arcgis.trackinganalyst.ITxDocumentEvents interface.

Throws:

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

removeITxDocumentEventsListener

public void removeITxDocumentEventsListener(ITxDocumentEvents theListener)
                                     throws java.io.IOException

removeITxDocumentEventsListener. Stop listening to events generated by this class.

Parameters:

theListener - An object that implements the com.esri.arcgis.trackinganalyst.ITxDocumentEvents interface.

Throws:

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

release

public void release()

Release a LabelEngineManager.

Specified by:

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

attach

public void attach(java.lang.Object piDocument)
            throws java.io.IOException,
                   AutomationException

Attaches a label to a feature in the label engine manager.

Specified by:

attach in interface ILabelEngineManager2

Parameters:

piDocument - A reference to another Object (IUnknown) (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getEngineCount

public short getEngineCount()
                     throws java.io.IOException,
                            AutomationException

Number of labels in the label engine manager.

Specified by:

getEngineCount in interface ILabelEngineManager2

Returns:

The nEngineCount

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLabelEngine

public ITrackingLabelEngine getLabelEngine(IMap piMap)
                                    throws java.io.IOException,
                                           AutomationException

Indicates the label engine being used by the label engine manager.

Specified by:

getLabelEngine in interface ILabelEngineManager2

Parameters:

piMap - A reference to a com.esri.arcgis.carto.IMap (in)

Returns:

A reference to a com.esri.arcgis.trackinganalyst.ITrackingLabelEngine

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLabelEngine3

public ITrackingLabelEngine getLabelEngine3(IBasicMap piMap)
                                     throws java.io.IOException,
                                            AutomationException

Indicates the label engine being used by the label engine manager.

Specified by:

getLabelEngine3 in interface ILabelEngineManager3

Parameters:

piMap - A reference to a com.esri.arcgis.carto.IBasicMap (in)

Returns:

A reference to a com.esri.arcgis.trackinganalyst.ITrackingLabelEngine

Throws:

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

AutomationException - If the ArcObject component throws an exception.

drawLayerLabels

public void drawLayerLabels(ILayer piLayerToDraw,
                            IDisplay piDisplay)
                     throws java.io.IOException,
                            AutomationException

Draws the labels for a particular layer to the display object.

Specified by:

drawLayerLabels in interface ITrackingLabelDraw

Parameters:

piLayerToDraw - A reference to a com.esri.arcgis.carto.ILayer (in)

piDisplay - A reference to a com.esri.arcgis.display.IDisplay (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                throws java.io.IOException,
                                       AutomationException

interfaceSupportsErrorInfo

Specified by:

interfaceSupportsErrorInfo in interface ISupportErrorInfo

Parameters:

riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.