com.esri.arcgis.trackinganalyst
Class IActionEditProxy

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

All Implemented Interfaces:

IActionEdit, Externalizable, Serializable

public class IActionEditProxy
extends com.esri.arcgis.interop.Dispatch
implements IActionEdit, Serializable

Provides access to the methods and properties needed to edit the properties of an action.

Description

This interface provides a common set of methods for the Action Processor Editor framework to edit actions, edit the action processor, and create new actions.

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

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

Method Summary

void	addListener(String iidStr, Object theListener, Object theSource)
void	defaultAction() Sets the action to its default state and resets existing edits.
void	edit(int hParentWindowHandle, ISet piObjectSet) Invokes Edit dialog.
int	getHelpContextID(int lControlID) The help context ID for the specified control on the page.
String	getHelpFile() The help file name for the page.
int	getPreviewImage() Preview bitmap for the renderer that appears on the page.
void	removeListener(String iidStr, Object theListener)
void	setReadOnly(boolean rhs1) Indicates whether the action is specified as read-only.

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

IActionEditProxy

public IActionEditProxy()

IActionEditProxy

public IActionEditProxy(Object obj)
                 throws IOException

Throws:

IOException

IActionEditProxy

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

defaultAction

public void defaultAction()
                   throws IOException,
                          AutomationException

Sets the action to its default state and resets existing edits.

Description

This method sets the action to its default state and clears or resets any existing edits.

Product Availability

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

Specified by:

defaultAction in interface IActionEdit

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

edit

public void edit(int hParentWindowHandle,
                 ISet piObjectSet)
          throws IOException,
                 AutomationException

Invokes Edit dialog.

Description

This method invokes the editing dialog. The developer must ensure that the dialog is a modal dialog. The parent window handle is provided in order for the proper modal association to be set up. piObjectSet is the object set that needs to be edited.

Product Availability

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

Specified by:

edit in interface IActionEdit

Parameters:

hParentWindowHandle - The hParentWindowHandle (in)

piObjectSet - A reference to a com.esri.arcgis.system.ISet (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPreviewImage

public int getPreviewImage()
                    throws IOException,
                           AutomationException

Preview bitmap for the renderer that appears on the page.

Description

This property allows you to preview a bitmap for the renderer that appears on the page.

Product Availability

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

Specified by:

getPreviewImage in interface IActionEdit

Returns:

The phBitmap

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getHelpFile

public String getHelpFile()
                   throws IOException,
                          AutomationException

The help file name for the page.

Description

This property controls the help file name for the page.

Product Availability

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

Specified by:

getHelpFile in interface IActionEdit

Returns:

The pbstrHelpFile

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getHelpContextID

public int getHelpContextID(int lControlID)
                     throws IOException,
                            AutomationException

The help context ID for the specified control on the page.

Product Availability

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

Specified by:

getHelpContextID in interface IActionEdit

Parameters:

lControlID - The lControlID (in)

Returns:

The plHelpID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setReadOnly

public void setReadOnly(boolean rhs1)
                 throws IOException,
                        AutomationException

Indicates whether the action is specified as read-only.

Product Availability

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

Specified by:

setReadOnly in interface IActionEdit

Parameters:

rhs1 - The rhs1 (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.