com.esri.arcgis.trackinganalyst
Class LabelEngine

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

All Implemented Interfaces:

IActiveViewEvents, com.esri.arcgis.interop.RemoteObjRef, ISupportErrorInfo, ITrackingLabelDraw, ITrackingLabelEngine, ITrackingLabelEngine2, java.io.Serializable, java.util.EventListener

public class LabelEngine
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, ITrackingLabelEngine, ITrackingLabelEngine2, ITrackingLabelDraw, ISupportErrorInfo, IActiveViewEvents

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

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

IID, IID3b3d8769_16e3_41bc_85c0_2df43a4f2bd9, xxDummy

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

IIDff5d5f00_ec63_11d5_b81a_00010265adc5

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

Fields inherited from interface com.esri.arcgis.carto.IActiveViewEvents

IID, IIDe79c5940_52dd_11d0_98be_00805f7ced21, xxDummy

Constructor Summary

LabelEngine()
Constructs a LabelEngine using ArcGIS Engine.

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

Method Summary

void	addLabel(java.lang.String bstrID, ILayer piLayer, ITrackingLabel piLabel) Adds a tracking label to the map display.
void	afterDraw(IActiveViewEventsAfterDrawEvent theEvent) Fired after the specified phase is drawn.
void	afterItemDraw(IActiveViewEventsAfterItemDrawEvent theEvent) Fired after an individual view item is drawn.
void	attach(IMap piMap) Attaches a label to a given feature on the map.
void	attachMap(java.lang.Object piMap) Attaches a label to a given feature on the map.
void	contentsChanged(IActiveViewEventsContentsChangedEvent theEvent) Fired when the contents of the view changes.
void	contentsCleared(IActiveViewEventsContentsClearedEvent theEvent) Fired when the contents of the view is cleared.
void	draw(IDisplay piDisplay) Draws the labels to the map display.
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
ITrackingLabel	findLabel(java.lang.String bstrID, ILayer piLayer) Finds a given label for the map display.
void	focusMapChanged(IActiveViewEventsFocusMapChangedEvent theEvent) Fired when a new map is made active.
static java.lang.String	getClsid() getClsid.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
int	hashCode() the hashcode for this object
void	hideLabels(ILayer piLayer, IGeometry piGeometry) Hides labels from the map display.
void	interfaceSupportsErrorInfo(GUID riid) interfaceSupportsErrorInfo
void	itemAdded(IActiveViewEventsItemAddedEvent theEvent) Fired when an item is added to the view.
void	itemDeleted(IActiveViewEventsItemDeletedEvent theEvent) Fired when an item is deleted from the view.
void	itemReordered(IActiveViewEventsItemReorderedEvent theEvent) Fired when a view item is reordered.
void	release() Release a LabelEngine.
void	removeAllLabels() Removes all labels from the map display.
void	removeLabel(java.lang.String bstrID, ILayer piLayer) Removes a tracking label from the map display.
void	removeLayerLabels(ILayer piLayer) Remove labels from a given layer.
void	selectionChanged(IActiveViewEventsSelectionChangedEvent theEvent) Call this function to fire the selection changed event.
void	spatialReferenceChanged(IActiveViewEventsSpatialReferenceChangedEvent theEvent) Fired when the spatial reference is changed.
void	viewRefreshed(IActiveViewEventsViewRefreshedEvent theEvent) Fired when view is refreshed before draw happens.

Methods inherited from class java.lang.Object

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

Constructor Detail

LabelEngine

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

Constructs a LabelEngine using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

LabelEngine

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

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

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

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 LabelEngine.

Specified by:

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

addLabel

public void addLabel(java.lang.String bstrID,
                     ILayer piLayer,
                     ITrackingLabel piLabel)
              throws java.io.IOException,
                     AutomationException

Adds a tracking label to the map display.

Specified by:

addLabel in interface ITrackingLabelEngine

Parameters:

bstrID - The bstrID (in)

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

piLabel - A reference to a com.esri.arcgis.trackinganalyst.ITrackingLabel (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

findLabel

public ITrackingLabel findLabel(java.lang.String bstrID,
                                ILayer piLayer)
                         throws java.io.IOException,
                                AutomationException

Finds a given label for the map display.

Specified by:

findLabel in interface ITrackingLabelEngine

Parameters:

bstrID - The bstrID (in)

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

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

draw

public void draw(IDisplay piDisplay)
          throws java.io.IOException,
                 AutomationException

Draws the labels to the map display.

Specified by:

draw in interface ITrackingLabelEngine

Parameters:

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.

removeLabel

public void removeLabel(java.lang.String bstrID,
                        ILayer piLayer)
                 throws java.io.IOException,
                        AutomationException

Removes a tracking label from the map display.

Specified by:

removeLabel in interface ITrackingLabelEngine

Parameters:

bstrID - The bstrID (in)

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

removeAllLabels

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

Removes all labels from the map display.

Specified by:

removeAllLabels in interface ITrackingLabelEngine

Throws:

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

AutomationException - If the ArcObject component throws an exception.

attach

public void attach(IMap piMap)
            throws java.io.IOException,
                   AutomationException

Attaches a label to a given feature on the map.

Specified by:

attach in interface ITrackingLabelEngine

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

hideLabels

public void hideLabels(ILayer piLayer,
                       IGeometry piGeometry)
                throws java.io.IOException,
                       AutomationException

Hides labels from the map display.

Specified by:

hideLabels in interface ITrackingLabelEngine

Parameters:

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

piGeometry - 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.

removeLayerLabels

public void removeLayerLabels(ILayer piLayer)
                       throws java.io.IOException,
                              AutomationException

Remove labels from a given layer.

Specified by:

removeLayerLabels in interface ITrackingLabelEngine

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

attachMap

public void attachMap(java.lang.Object piMap)
               throws java.io.IOException,
                      AutomationException

Attaches a label to a given feature on the map.

Specified by:

attachMap in interface ITrackingLabelEngine2

Parameters:

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

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.

contentsChanged

public void contentsChanged(IActiveViewEventsContentsChangedEvent theEvent)
                     throws java.io.IOException,
                            AutomationException

Fired when the contents of the view changes.

Specified by:

contentsChanged in interface IActiveViewEvents

Parameters:

theEvent - The event

Throws:

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

AutomationException - If the ArcObject component throws an exception.

contentsCleared

public void contentsCleared(IActiveViewEventsContentsClearedEvent theEvent)
                     throws java.io.IOException,
                            AutomationException

Fired when the contents of the view is cleared.

Specified by:

contentsCleared in interface IActiveViewEvents

Parameters:

theEvent - The event

Throws:

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

AutomationException - If the ArcObject component throws an exception.

itemAdded

public void itemAdded(IActiveViewEventsItemAddedEvent theEvent)
               throws java.io.IOException,
                      AutomationException

Fired when an item is added to the view.

Specified by:

itemAdded in interface IActiveViewEvents

Parameters:

theEvent - The event

Throws:

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

AutomationException - If the ArcObject component throws an exception.

itemDeleted

public void itemDeleted(IActiveViewEventsItemDeletedEvent theEvent)
                 throws java.io.IOException,
                        AutomationException

Fired when an item is deleted from the view.

Specified by:

itemDeleted in interface IActiveViewEvents

Parameters:

theEvent - The event

Throws:

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

AutomationException - If the ArcObject component throws an exception.

itemReordered

public void itemReordered(IActiveViewEventsItemReorderedEvent theEvent)
                   throws java.io.IOException,
                          AutomationException

Fired when a view item is reordered.

Specified by:

itemReordered in interface IActiveViewEvents

Parameters:

theEvent - The event

Throws:

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

AutomationException - If the ArcObject component throws an exception.

selectionChanged

public void selectionChanged(IActiveViewEventsSelectionChangedEvent theEvent)
                      throws java.io.IOException,
                             AutomationException

Call this function to fire the selection changed event.

Specified by:

selectionChanged in interface IActiveViewEvents

Parameters:

theEvent - The event

Throws:

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

AutomationException - If the ArcObject component throws an exception.

viewRefreshed

public void viewRefreshed(IActiveViewEventsViewRefreshedEvent theEvent)
                   throws java.io.IOException,
                          AutomationException

Fired when view is refreshed before draw happens.

Specified by:

viewRefreshed in interface IActiveViewEvents

Parameters:

theEvent - The event

Throws:

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

AutomationException - If the ArcObject component throws an exception.

afterDraw

public void afterDraw(IActiveViewEventsAfterDrawEvent theEvent)
               throws java.io.IOException,
                      AutomationException

Fired after the specified phase is drawn.

Specified by:

afterDraw in interface IActiveViewEvents

Parameters:

theEvent - The event

Throws:

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

AutomationException - If the ArcObject component throws an exception.

afterItemDraw

public void afterItemDraw(IActiveViewEventsAfterItemDrawEvent theEvent)
                   throws java.io.IOException,
                          AutomationException

Fired after an individual view item is drawn. Example: view items include layers in a map or elements in a page layout.

Specified by:

afterItemDraw in interface IActiveViewEvents

Parameters:

theEvent - The event

Throws:

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

AutomationException - If the ArcObject component throws an exception.

focusMapChanged

public void focusMapChanged(IActiveViewEventsFocusMapChangedEvent theEvent)
                     throws java.io.IOException,
                            AutomationException

Fired when a new map is made active.

Specified by:

focusMapChanged in interface IActiveViewEvents

Parameters:

theEvent - The event

Throws:

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

AutomationException - If the ArcObject component throws an exception.

spatialReferenceChanged

public void spatialReferenceChanged(IActiveViewEventsSpatialReferenceChangedEvent theEvent)
                             throws java.io.IOException,
                                    AutomationException

Fired when the spatial reference is changed.

Specified by:

spatialReferenceChanged in interface IActiveViewEvents

Parameters:

theEvent - The event

Throws:

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

AutomationException - If the ArcObject component throws an exception.