com.esri.arcgis.trackinganalyst
Class IHighlightSuppressionActionProxy

java.lang.Object
  extended by com.esri.arcgis.interop.Dispatch
      extended by com.esri.arcgis.trackinganalyst.IHighlightSuppressionActionProxy
All Implemented Interfaces:
IHighlightSuppressionAction, Externalizable, Serializable

public class IHighlightSuppressionActionProxy
extends com.esri.arcgis.interop.Dispatch
implements IHighlightSuppressionAction, Serializable

Provides access to properties and methods needed to manage the highlight/suppression action.

Product Availability

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

See Also:
Serialized Form

Field Summary
 
Fields inherited from class com.esri.arcgis.interop.Dispatch
DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, E
 
Constructor Summary
  IHighlightSuppressionActionProxy()
           
  IHighlightSuppressionActionProxy(Object obj)
           
protected IHighlightSuppressionActionProxy(Object obj, String iid)
           
 
Method Summary
 void addListener(String iidStr, Object theListener, Object theSource)
           
 void clearObjectArray()
          Clears object array of all previous entries.
 boolean containsFeature(int oID)
          Indicates whether or not feature is contained in the action.
 int getActionType()
          Indicates what type of action will be performed.
 ISymbol getHighlightSymbol()
          Symbol used to highlight the feature meeting highlight action criteria.
 boolean isSuppression()
          Indicates whether or not the highlight-suppression action is set to suppress features.
 void readExternal(ObjectInput in)
           
 void removeListener(String iidStr, Object theListener)
           
 void setActionType(int pVal)
          Indicates what type of action will be performed.
 void setHighlightSymbolByRef(ISymbol pVal)
          Symbol used to highlight the feature meeting highlight action criteria.
 void writeExternal(ObjectOutput out)
           
 
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, queryInterface, release, setNativeMode, setPropertyByName, toString, vtblInvoke
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

IHighlightSuppressionActionProxy

public IHighlightSuppressionActionProxy()

IHighlightSuppressionActionProxy

public IHighlightSuppressionActionProxy(Object obj)
                                 throws IOException
Throws:
IOException

IHighlightSuppressionActionProxy

protected IHighlightSuppressionActionProxy(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

getActionType

public int getActionType()
                  throws IOException,
                         AutomationException
Indicates what type of action will be performed.

Product Availability

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

Specified by:
getActionType in interface IHighlightSuppressionAction
Returns:
A com.esri.arcgis.trackinganalyst.enumHighlightSuppression constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setActionType

public void setActionType(int pVal)
                   throws IOException,
                          AutomationException
Indicates what type of action will be performed.

Product Availability

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

Specified by:
setActionType in interface IHighlightSuppressionAction
Parameters:
pVal - A com.esri.arcgis.trackinganalyst.enumHighlightSuppression constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getHighlightSymbol

public ISymbol getHighlightSymbol()
                           throws IOException,
                                  AutomationException
Symbol used to highlight the feature meeting highlight action criteria.

Product Availability

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

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

setHighlightSymbolByRef

public void setHighlightSymbolByRef(ISymbol pVal)
                             throws IOException,
                                    AutomationException
Symbol used to highlight the feature meeting highlight action criteria.

Product Availability

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

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

isSuppression

public boolean isSuppression()
                      throws IOException,
                             AutomationException
Indicates whether or not the highlight-suppression action is set to suppress features.

Product Availability

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

Specified by:
isSuppression in interface IHighlightSuppressionAction
Returns:
The bResult
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

containsFeature

public boolean containsFeature(int oID)
                        throws IOException,
                               AutomationException
Indicates whether or not feature is contained in the action.

Product Availability

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

Specified by:
containsFeature in interface IHighlightSuppressionAction
Parameters:
oID - The oID (in)
Returns:
The bResult
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

clearObjectArray

public void clearObjectArray()
                      throws IOException,
                             AutomationException
Clears object array of all previous entries.

Product Availability

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

Specified by:
clearObjectArray in interface IHighlightSuppressionAction
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException
Specified by:
writeExternal in interface Externalizable
Overrides:
writeExternal in class com.esri.arcgis.interop.Dispatch
Throws:
IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException
Specified by:
readExternal in interface Externalizable
Overrides:
readExternal in class com.esri.arcgis.interop.Dispatch
Throws:
IOException
ClassNotFoundException