com.esri.arcgis.controls
Class IEngineSnapAgentCategoryProxy

java.lang.Object
  com.esri.arcgis.interop.Dispatch
      com.esri.arcgis.controls.IEngineSnapAgentCategoryProxy

All Implemented Interfaces:

IEngineSnapAgentCategory, Externalizable, Serializable

public class IEngineSnapAgentCategoryProxy
extends com.esri.arcgis.interop.Dispatch
implements IEngineSnapAgentCategory, Serializable

Provides access to the category of an engine snap agent.

Remarks

EngineFeatureSnap agents do not implement this interface. You should check the type of SnapAgent before attempting to access this interface.

When To Use

IEngineSnapAgentCategory provides a mechanism to organize and group custom SnapAgents. Custom EngineSnapAgents are listed in the lower half of the Snapping dialog. Implement this interface if you want to place your snap agent into a particular category.

Product Availability

Available with ArcGIS Engine.

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

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

Method Summary

void	addListener(String iidStr, Object theListener, Object theSource)
String	getCategory() The engine snap agent category.
void	removeListener(String iidStr, Object theListener)

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

IEngineSnapAgentCategoryProxy

public IEngineSnapAgentCategoryProxy()

IEngineSnapAgentCategoryProxy

public IEngineSnapAgentCategoryProxy(Object obj)
                              throws IOException

Throws:

IOException

IEngineSnapAgentCategoryProxy

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

getCategory

public String getCategory()
                   throws IOException,
                          AutomationException

The engine snap agent category.

Description

Category returns the name of each top-level node in the lower-half of the Snapping Environment dialog.

Product Availability

Available with ArcGIS Engine.

Specified by:

getCategory in interface IEngineSnapAgentCategory

Returns:

The text

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.