com.esri.arcgis.trackinganalyst
Interface ITrackingLabel

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

ITrackingLabelProxy, TrackingLabel

public interface ITrackingLabel
extends java.io.Serializable

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

Description: 'Provides access to properties and methods for controlling tracking 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	IIDe91113d0_eb5b_11d5_b81a_00010265adc5
static int	xxDummy Deprecated. Internal use only

Method Summary

void	draw(IDisplay piDisplay) Draws the label to the map display.
IEnvelope	getEnvelope() Property Envelope.
java.lang.String	getID() Indicates ID value for the label.
IGeometry	getLocation() Labels geometric location.
double	getOffsetAngle() Indicates the pixel offset bearing from the centroid of the location.
short	getPixelOffset() Indicates the pixel offset from centroid of the location.
boolean	isDirty() Indicates if the label properties have changed since last drawn.
boolean	isVisible() Indicates whether the tracking label is visible on the map display.
void	setID(java.lang.String pbstrID) Indicates ID value for the label.
void	setLocationByRef(IGeometry ppiLocation) Labels geometric location.
void	setOffsetAngle(double pdOffsetAngle) Indicates the pixel offset bearing from the centroid of the location.
void	setPixelOffset(short pnPixelOffset) Indicates the pixel offset from centroid of the location.
void	setVisible(boolean pbvarVisible) Indicates whether the tracking label is visible on the map display.

Field Detail

IIDe91113d0_eb5b_11d5_b81a_00010265adc5

static final int IIDe91113d0_eb5b_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

isDirty

boolean isDirty()
                throws java.io.IOException,
                       AutomationException

Indicates if the label properties have changed since last drawn.

Returns:

The pbvarDirty

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getID

java.lang.String getID()
                       throws java.io.IOException,
                              AutomationException

Indicates ID value for the label.

Returns:

The pbstrID

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setID

void setID(java.lang.String pbstrID)
           throws java.io.IOException,
                  AutomationException

Indicates ID value for the label.

Parameters:

pbstrID - The pbstrID (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getEnvelope

IEnvelope getEnvelope()
                      throws java.io.IOException,
                             AutomationException

Property Envelope.

Returns:

A reference to a com.esri.arcgis.geometry.IEnvelope

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setLocationByRef

void setLocationByRef(IGeometry ppiLocation)
                      throws java.io.IOException,
                             AutomationException

Labels geometric location.

Parameters:

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

getLocation

IGeometry getLocation()
                      throws java.io.IOException,
                             AutomationException

Labels geometric location.

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.

draw

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

Draws the label 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.

isVisible

boolean isVisible()
                  throws java.io.IOException,
                         AutomationException

Indicates whether the tracking label is visible on the map display.

Returns:

The pbvarVisible

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setVisible

void setVisible(boolean pbvarVisible)
                throws java.io.IOException,
                       AutomationException

Indicates whether the tracking label is visible on the map display.

Parameters:

pbvarVisible - The pbvarVisible (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getPixelOffset

short getPixelOffset()
                     throws java.io.IOException,
                            AutomationException

Indicates the pixel offset from centroid of the location.

Returns:

The pnPixelOffset

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setPixelOffset

void setPixelOffset(short pnPixelOffset)
                    throws java.io.IOException,
                           AutomationException

Indicates the pixel offset from centroid of the location.

Parameters:

pnPixelOffset - The pnPixelOffset (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getOffsetAngle

double getOffsetAngle()
                      throws java.io.IOException,
                             AutomationException

Indicates the pixel offset bearing from the centroid of the location.

Returns:

The pdOffsetAngle

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setOffsetAngle

void setOffsetAngle(double pdOffsetAngle)
                    throws java.io.IOException,
                           AutomationException

Indicates the pixel offset bearing from the centroid of the location.

Parameters:

pdOffsetAngle - The pdOffsetAngle (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.