com.esri.arcgis.trackinganalyst
Class LabelEngineManager

java.lang.Object
  extended by com.esri.arcgis.trackinganalyst.LabelEngineManager
All Implemented Interfaces:
com.esri.arcgis.interop.RemoteObjRef, ILabelEngineManager2, ITrackingLabelDraw, Serializable

public class LabelEngineManager
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, ILabelEngineManager2, ITrackingLabelDraw

Controls functionality of the label engine manager.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

See Also:
Serialized Form

Constructor Summary
LabelEngineManager()
          Constructs a LabelEngineManager using ArcGIS Engine.
LabelEngineManager(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(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(Object o)
          Compare this object with another
static String getClsid()
          getClsid.
 short getEngineCount()
          Number of labels in the label engine manager.
 ITrackingLabelEngine getLabelEngine(IMap piMap)
          Indicates the label engine being used by the label engine manager.
 int hashCode()
          the hashcode for this object
 void removeITxDocumentEventsListener(ITxDocumentEvents theListener)
          removeITxDocumentEventsListener.
 
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

LabelEngineManager

public LabelEngineManager()
                   throws IOException,
                          UnknownHostException
Constructs a LabelEngineManager using ArcGIS Engine.

Throws:
IOException - if there are interop problems
UnknownHostException - if there are interop problems

LabelEngineManager

public LabelEngineManager(Object obj)
                   throws 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:
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

addITxDocumentEventsListener

public void addITxDocumentEventsListener(ITxDocumentEvents theListener)
                                  throws IOException
addITxDocumentEventsListener. Listen to events generated by this class.

Parameters:
theListener - An object that implements the com.esri.arcgis.trackinganalyst.ITxDocumentEvents interface.
Throws:
IOException - If there are communications problems.

removeITxDocumentEventsListener

public void removeITxDocumentEventsListener(ITxDocumentEvents theListener)
                                     throws IOException
removeITxDocumentEventsListener. Stop listening to events generated by this class.

Parameters:
theListener - An object that implements the com.esri.arcgis.trackinganalyst.ITxDocumentEvents interface.
Throws:
IOException - If there are communications problems.

attach

public void attach(Object piDocument)
            throws IOException,
                   AutomationException
Attaches a label to a feature in the label engine manager.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
attach in interface ILabelEngineManager2
Parameters:
piDocument - A reference to another Object (IUnknown) (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getEngineCount

public short getEngineCount()
                     throws IOException,
                            AutomationException
Number of labels in the label engine manager.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:
getEngineCount in interface ILabelEngineManager2
Returns:
The nEngineCount
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLabelEngine

public ITrackingLabelEngine getLabelEngine(IMap piMap)
                                    throws IOException,
                                           AutomationException
Indicates the label engine being used by the label engine manager.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

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:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

drawLayerLabels

public void drawLayerLabels(ILayer piLayerToDraw,
                            IDisplay piDisplay)
                     throws IOException,
                            AutomationException
Draws the labels for a particular layer to the display object.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

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:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.