com.esri.arcgis.trackinganalyst
Class ITrackingLayerLabelsProxy

java.lang.Object
  com.esri.arcgis.interop.Dispatch
      com.esri.arcgis.trackinganalyst.ITrackingLayerLabelsProxy

All Implemented Interfaces:

ITrackingLayerLabels, Externalizable, Serializable

public class ITrackingLayerLabelsProxy
extends com.esri.arcgis.interop.Dispatch
implements ITrackingLayerLabels, Serializable

Provides access to properties and methods needed to manage the tracking layer labels in the map display.

Description

This interface provides access to properties that manage tracking layer labels in the map display. Users can control whether labels will be drawn, the offset angle to events and the offset pixel between a feature and its label.

Product Availability

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

See Also:

Serialized Form

Field Summary

boolean

noncastable

Fields inherited from class com.esri.arcgis.interop.Dispatch

DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, objRef

Constructor Summary

	ITrackingLayerLabelsProxy()
	ITrackingLayerLabelsProxy(Object obj)
protected	ITrackingLayerLabelsProxy(Object obj, String iid)

Method Summary

void	addListener(String iidStr, Object theListener, Object theSource)
String	getLabelFieldName() Name of the field whose contents will be used as the tracking label for the layer.
double	getOffsetAngle() Indicates angle of offset for labels as they draw next to events on the map display.
short	getPixelOffset() Indicates amount of offset between feature and label as they draw to the map display.
ITextSymbol	getTextSymbol() Indicates settings for text symbol appearance as it appears as a label on the map display.
boolean	isLabelFeatures() Indicates whether or not feature labels will appear as events draw to the map display.
void	removeListener(String iidStr, Object theListener)
void	setLabelFeatures(boolean pbvarLabelFeatures) Indicates whether or not feature labels will appear as events draw to the map display.
void	setLabelFieldName(String pbstrFieldName) Name of the field whose contents will be used as the tracking label for the layer.
void	setOffsetAngle(double pdOffsetAngle) Indicates angle of offset for labels as they draw next to events on the map display.
void	setPixelOffset(short pnPixelOffset) Indicates amount of offset between feature and label as they draw to the map display.
void	setTextSymbolByRef(ITextSymbol ppiTextSymbol) Indicates settings for text symbol appearance as it appears as a label on the map display.

Methods inherited from class com.esri.arcgis.interop.Dispatch

bindUsingMoniker, constructVtblPosTable, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, getVtblPos, hashCode, initDispatch, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, optimizedVtblInvoke, queryInterface, readExternal, release, setNativeMode, setPropertyByName, toString, vtblInvoke, writeExternal

Methods inherited from class java.lang.Object

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

Field Detail

noncastable

public boolean noncastable

Constructor Detail

ITrackingLayerLabelsProxy

public ITrackingLayerLabelsProxy()

ITrackingLayerLabelsProxy

public ITrackingLayerLabelsProxy(Object obj)
                          throws IOException

Throws:

IOException

ITrackingLayerLabelsProxy

protected ITrackingLayerLabelsProxy(Object obj,
                                    String iid)
                             throws IOException

Throws:

IOException

Method Detail

addListener

public void addListener(String iidStr,
                        Object theListener,
                        Object theSource)
                 throws IOException

Overrides:

addListener in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

removeListener

public void removeListener(String iidStr,
                           Object theListener)
                    throws IOException

Overrides:

removeListener in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

setLabelFieldName

public void setLabelFieldName(String pbstrFieldName)
                       throws IOException,
                              AutomationException

Name of the field whose contents will be used as the tracking label for the layer.

Product Availability

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

Specified by:

setLabelFieldName in interface ITrackingLayerLabels

Parameters:

pbstrFieldName - The pbstrFieldName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLabelFieldName

public String getLabelFieldName()
                         throws IOException,
                                AutomationException

Name of the field whose contents will be used as the tracking label for the layer.

Product Availability

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

Specified by:

getLabelFieldName in interface ITrackingLayerLabels

Returns:

The pbstrFieldName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLabelFeatures

public void setLabelFeatures(boolean pbvarLabelFeatures)
                      throws IOException,
                             AutomationException

Indicates whether or not feature labels will appear as events draw to the map display.

Product Availability

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

Specified by:

setLabelFeatures in interface ITrackingLayerLabels

Parameters:

pbvarLabelFeatures - The pbvarLabelFeatures (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isLabelFeatures

public boolean isLabelFeatures()
                        throws IOException,
                               AutomationException

Indicates whether or not feature labels will appear as events draw to the map display.

Product Availability

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

Specified by:

isLabelFeatures in interface ITrackingLayerLabels

Returns:

The pbvarLabelFeatures

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPixelOffset

public short getPixelOffset()
                     throws IOException,
                            AutomationException

Indicates amount of offset between feature and label as they draw to the map display.

Product Availability

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

Specified by:

getPixelOffset in interface ITrackingLayerLabels

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 amount of offset between feature and label as they draw to the map display.

Product Availability

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

Specified by:

setPixelOffset in interface ITrackingLayerLabels

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 angle of offset for labels as they draw next to events on the map display.

Product Availability

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

Specified by:

getOffsetAngle in interface ITrackingLayerLabels

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 angle of offset for labels as they draw next to events on the map display.

Product Availability

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

Specified by:

setOffsetAngle in interface ITrackingLayerLabels

Parameters:

pdOffsetAngle - The pdOffsetAngle (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTextSymbol

public ITextSymbol getTextSymbol()
                          throws IOException,
                                 AutomationException

Indicates settings for text symbol appearance as it appears as a label on the map display.

Description

This property indicates the settings for text symbol appearance as it appears as a label on the map display.

Product Availability

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

Specified by:

getTextSymbol in interface ITrackingLayerLabels

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

Indicates settings for text symbol appearance as it appears as a label on the map display.

Product Availability

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

Specified by:

setTextSymbolByRef in interface ITrackingLayerLabels

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.