com.esri.arcgis.trackinganalyst
Class TrackingLabel

java.lang.Object
  extended by com.esri.arcgis.trackinganalyst.TrackingLabel
All Implemented Interfaces:
com.esri.arcgis.interop.RemoteObjRef, ITrackingLabel, ITrackingTextLabel, Serializable

public class TrackingLabel
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, ITrackingLabel, ITrackingTextLabel

Controls settings for tracking labels.

Product Availability

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

See Also:
Serialized Form

Constructor Summary
TrackingLabel()
          Constructs a TrackingLabel using ArcGIS Engine.
TrackingLabel(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
TrackingLabel theTrackingLabel = (TrackingLabel) obj;
 
Method Summary
 void draw(IDisplay piDisplay)
          Draws the label to the map display.
 boolean equals(Object o)
          Compare this object with another
static String getClsid()
          getClsid.
 IEnvelope getEnvelope()
          Property Envelope.
 String getID()
          Indicates ID value for the label.
 String getLabelText()
          Defines label text.
 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.
 ITextSymbol getTextSymbol()
          Defines symbol(s) used in text label.
 int hashCode()
          the hashcode for this object
 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(String pbstrID)
          Indicates ID value for the label.
 void setLabelText(String pbstrLabelText)
          Defines label text.
 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 setTextSymbolByRef(ITextSymbol ppiTextSymbol)
          Defines symbol(s) used in text label.
 void setVisible(boolean pbvarVisible)
          Indicates whether the tracking label is visible on the map display.
 
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

TrackingLabel

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

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

TrackingLabel

public TrackingLabel(Object obj)
              throws IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
TrackingLabel theTrackingLabel = (TrackingLabel) obj;

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

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

isDirty

public boolean isDirty()
                throws IOException,
                       AutomationException
Indicates if the label properties have changed since last drawn.

Product Availability

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

Specified by:
isDirty in interface ITrackingLabel
Specified by:
isDirty in interface ITrackingTextLabel
Returns:
The pbvarDirty
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getID

public String getID()
             throws IOException,
                    AutomationException
Indicates ID value for the label.

Product Availability

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

Specified by:
getID in interface ITrackingLabel
Specified by:
getID in interface ITrackingTextLabel
Returns:
The pbstrID
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setID

public void setID(String pbstrID)
           throws IOException,
                  AutomationException
Indicates ID value for the label.

Product Availability

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

Specified by:
setID in interface ITrackingLabel
Specified by:
setID in interface ITrackingTextLabel
Parameters:
pbstrID - The pbstrID (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getEnvelope

public IEnvelope getEnvelope()
                      throws IOException,
                             AutomationException
Property Envelope.

Product Availability

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

Specified by:
getEnvelope in interface ITrackingLabel
Specified by:
getEnvelope in interface ITrackingTextLabel
Returns:
A reference to a com.esri.arcgis.geometry.IEnvelope
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setLocationByRef

public void setLocationByRef(IGeometry ppiLocation)
                      throws IOException,
                             AutomationException
Labels geometric location.

Product Availability

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

Specified by:
setLocationByRef in interface ITrackingLabel
Specified by:
setLocationByRef in interface ITrackingTextLabel
Parameters:
ppiLocation - A reference to a com.esri.arcgis.geometry.IGeometry (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLocation

public IGeometry getLocation()
                      throws IOException,
                             AutomationException
Labels geometric location.

Product Availability

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

Specified by:
getLocation in interface ITrackingLabel
Specified by:
getLocation in interface ITrackingTextLabel
Returns:
A reference to a com.esri.arcgis.geometry.IGeometry
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

draw

public void draw(IDisplay piDisplay)
          throws IOException,
                 AutomationException
Draws the label to the map display.

Product Availability

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

Specified by:
draw in interface ITrackingLabel
Specified by:
draw in interface ITrackingTextLabel
Parameters:
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.

isVisible

public boolean isVisible()
                  throws IOException,
                         AutomationException
Indicates whether the tracking label is visible on the map display.

Product Availability

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

Specified by:
isVisible in interface ITrackingLabel
Specified by:
isVisible in interface ITrackingTextLabel
Returns:
The pbvarVisible
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setVisible

public void setVisible(boolean pbvarVisible)
                throws IOException,
                       AutomationException
Indicates whether the tracking label is visible on the map display.

Product Availability

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

Specified by:
setVisible in interface ITrackingLabel
Specified by:
setVisible in interface ITrackingTextLabel
Parameters:
pbvarVisible - The pbvarVisible (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPixelOffset

public short getPixelOffset()
                     throws IOException,
                            AutomationException
Indicates the pixel offset from centroid of the location.

Product Availability

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

Specified by:
getPixelOffset in interface ITrackingLabel
Specified by:
getPixelOffset in interface ITrackingTextLabel
Returns:
The pnPixelOffset
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setPixelOffset

public void setPixelOffset(short pnPixelOffset)
                    throws IOException,
                           AutomationException
Indicates the pixel offset from centroid of the location.

Product Availability

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

Specified by:
setPixelOffset in interface ITrackingLabel
Specified by:
setPixelOffset in interface ITrackingTextLabel
Parameters:
pnPixelOffset - The pnPixelOffset (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getOffsetAngle

public double getOffsetAngle()
                      throws IOException,
                             AutomationException
Indicates the pixel offset bearing from the centroid of the location.

Product Availability

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

Specified by:
getOffsetAngle in interface ITrackingLabel
Specified by:
getOffsetAngle in interface ITrackingTextLabel
Returns:
The pdOffsetAngle
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setOffsetAngle

public void setOffsetAngle(double pdOffsetAngle)
                    throws IOException,
                           AutomationException
Indicates the pixel offset bearing from the centroid of the location.

Product Availability

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

Specified by:
setOffsetAngle in interface ITrackingLabel
Specified by:
setOffsetAngle in interface ITrackingTextLabel
Parameters:
pdOffsetAngle - The pdOffsetAngle (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLabelText

public String getLabelText()
                    throws IOException,
                           AutomationException
Defines label text.

Product Availability

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

Specified by:
getLabelText in interface ITrackingTextLabel
Returns:
The pbstrLabelText
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setLabelText

public void setLabelText(String pbstrLabelText)
                  throws IOException,
                         AutomationException
Defines label text.

Product Availability

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

Specified by:
setLabelText in interface ITrackingTextLabel
Parameters:
pbstrLabelText - The pbstrLabelText (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTextSymbol

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

Product Availability

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

Specified by:
getTextSymbol in interface ITrackingTextLabel
Returns:
A reference to a com.esri.arcgis.display.ITextSymbol
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTextSymbolByRef

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

Product Availability

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

Specified by:
setTextSymbolByRef in interface ITrackingTextLabel
Parameters:
ppiTextSymbol - A reference to a com.esri.arcgis.display.ITextSymbol (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.