com.esri.arcgis.trackinganalyst
Interface ITrackingLabelEngine

All Superinterfaces:
java.io.Serializable
All Known Subinterfaces:
ITrackingLabelEngine2
All Known Implementing Classes:
ITrackingLabelEngine2Proxy, ITrackingLabelEngineProxy, LabelEngine

public interface ITrackingLabelEngine
extends java.io.Serializable

COM Interface 'ITrackingLabelEngine'. Generated 3/19/2015 1:20:59 PM from 'C:\ArcGIS\COM\esriTrackingAnalyst.olb'

Description: 'Provides access to properties and methods for controlling the tracking label engine used for dynamically changing labels.' 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 =


Field Summary
static java.lang.String IID
          Deprecated. Internal use only
static int IIDff5d5f00_ec63_11d5_b81a_00010265adc5
           
static int xxDummy
          Deprecated. Internal use only
 
Method Summary
 void addLabel(java.lang.String bstrID, ILayer piLayer, ITrackingLabel piLabel)
          Adds a tracking label to the map display.
 void attach(IMap piMap)
          Attaches a label to a given feature on the map.
 void draw(IDisplay piDisplay)
          Draws the labels to the map display.
 ITrackingLabel findLabel(java.lang.String bstrID, ILayer piLayer)
          Finds a given label for the map display.
 void hideLabels(ILayer piLayer, IGeometry piGeometry)
          Hides labels from the map display.
 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.
 

Field Detail

IIDff5d5f00_ec63_11d5_b81a_00010265adc5

static final int IIDff5d5f00_ec63_11d5_b81a_00010265adc5
See Also:
Constant Field Values

xxDummy

static final int xxDummy
Deprecated. Internal use only
See Also:
Constant Field Values

IID

static final java.lang.String IID
Deprecated. Internal use only
See Also:
Constant Field Values
Method Detail

addLabel

void addLabel(java.lang.String bstrID,
              ILayer piLayer,
              ITrackingLabel piLabel)
              throws java.io.IOException,
                     AutomationException
Adds a tracking label to the map display.

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

ITrackingLabel findLabel(java.lang.String bstrID,
                         ILayer piLayer)
                         throws java.io.IOException,
                                AutomationException
Finds a given label for the map display.

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

void draw(IDisplay piDisplay)
          throws java.io.IOException,
                 AutomationException
Draws the labels to the map display.

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

void removeLabel(java.lang.String bstrID,
                 ILayer piLayer)
                 throws java.io.IOException,
                        AutomationException
Removes a tracking label from the map display.

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

void removeAllLabels()
                     throws java.io.IOException,
                            AutomationException
Removes all labels from the map display.

Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

attach

void attach(IMap piMap)
            throws java.io.IOException,
                   AutomationException
Attaches a label to a given feature on the map.

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

void hideLabels(ILayer piLayer,
                IGeometry piGeometry)
                throws java.io.IOException,
                       AutomationException
Hides labels from the map display.

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

void removeLayerLabels(ILayer piLayer)
                       throws java.io.IOException,
                              AutomationException
Remove labels from a given layer.

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.