Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.esri.arcgis.trackinganalyst
Interface ITrackingTextLabel

All Superinterfaces:
java.io.Serializable
All Known Implementing Classes:
ITrackingTextLabelProxy, TrackingLabel
public interface ITrackingTextLabel
extends java.io.Serializable

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

Description: 'Provides access to properties and methods for controlling tracking text 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 IID80629b50_ec63_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()
          Provide the envelope of the label (currently, does nothing).
 java.lang.String getID()
          Label Identifier.
 java.lang.String getLabelText()
          Defines label text.
 IGeometry getLocation()
          Labels Geometric Location.
 double getOffsetAngle()
          Indicates pixel offset bearing from centroid of location.
 short getPixelOffset()
          Indicates pixel offset from centroid of location.
 ITextSymbol getTextSymbol()
          Defines symbol(s) used in text label.
 boolean isDirty()
          Indicates if the label properties have changed since last drawn.
 boolean isVisible()
          Indicates whether or not the text label is visible when drawing events on the map.
 void setID(java.lang.String pbstrID)
          Label Identifier.
 void setLabelText(java.lang.String pbstrLabelText)
          Defines label text.
 void setLocationByRef(IGeometry ppiLocation)
          Labels Geometric Location.
 void setOffsetAngle(double pdOffsetAngle)
          Indicates pixel offset bearing from centroid of location.
 void setPixelOffset(short pnPixelOffset)
          Indicates pixel offset from centroid of location.
 void setTextSymbolByRef(ITextSymbol ppiTextSymbol)
          Defines symbol(s) used in text label.
 void setVisible(boolean pbvarVisible)
          Indicates whether or not the text label is visible when drawing events on the map.
 

Field Detail

IID80629b50_ec63_11d5_b81a_00010265adc5

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

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
Label Identifier.

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
Label Identifier.

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
Provide the envelope of the label (currently, does nothing).

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 or not the text label is visible when drawing events on the map.

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 or not the text label is visible when drawing events on the map.

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 pixel offset from centroid of 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 pixel offset from centroid of 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 pixel offset bearing from centroid of 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 pixel offset bearing from centroid of location.

Parameters:
pdOffsetAngle - The pdOffsetAngle (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLabelText

java.lang.String getLabelText()
                              throws java.io.IOException,
                                     AutomationException
Defines label text.

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

setLabelText

void setLabelText(java.lang.String pbstrLabelText)
                  throws java.io.IOException,
                         AutomationException
Defines label text.

Parameters:
pbstrLabelText - The pbstrLabelText (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTextSymbol

ITextSymbol getTextSymbol()
                          throws java.io.IOException,
                                 AutomationException
Defines symbol(s) used in text label.

Returns:
A reference to a com.esri.arcgis.display.ITextSymbol
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTextSymbolByRef

void setTextSymbolByRef(ITextSymbol ppiTextSymbol)
                        throws java.io.IOException,
                               AutomationException
Defines symbol(s) used in text label.

Parameters:
ppiTextSymbol - A reference to a com.esri.arcgis.display.ITextSymbol (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD