com.esri.arcgis.framework
Class IArcToolboxToolProxy

java.lang.Object
  com.esri.arcgis.interop.Dispatch
      com.esri.arcgis.framework.IArcToolboxToolProxy

All Implemented Interfaces:

IArcToolboxTool, Externalizable, Serializable

public class IArcToolboxToolProxy
extends com.esri.arcgis.interop.Dispatch
implements IArcToolboxTool, Serializable

Provides access to members that control the Toolbox tools.

Product Availability

Available with ArcGIS Desktop.

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

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

Method Summary

void	addListener(String iidStr, Object theListener, Object theSource)
void	execute(Object inputData) Run the tool.
Picture	getBitmap() The bitmap that is used as the icon for this tool.
int	getHelpContextID() The help context ID associated with this tool.
String	getHelpFile() The name of the help file associated with this tool.
String	getMessage() The description for this tool.
int	getModality() The modality for the tool.
String	getName() The name of this tool.
String	getTreeviewLocation() The location of the tool in the treeview.
void	onCreate(Object hook) Occurs when this tool is created.
void	removeListener(String iidStr, Object theListener)
void	setModality(int dialogModality) The modality for the tool.

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

IArcToolboxToolProxy

public IArcToolboxToolProxy()

IArcToolboxToolProxy

public IArcToolboxToolProxy(Object obj)
                     throws IOException

Throws:

IOException

IArcToolboxToolProxy

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

setModality

public void setModality(int dialogModality)
                 throws IOException,
                        AutomationException

The modality for the tool.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setModality in interface IArcToolboxTool

Parameters:

dialogModality - A com.esri.arcgis.framework.esriATModality constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getModality

public int getModality()
                throws IOException,
                       AutomationException

The modality for the tool.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getModality in interface IArcToolboxTool

Returns:

A com.esri.arcgis.framework.esriATModality constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getName

public String getName()
               throws IOException,
                      AutomationException

The name of this tool.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getName in interface IArcToolboxTool

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMessage

public String getMessage()
                  throws IOException,
                         AutomationException

The description for this tool.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getMessage in interface IArcToolboxTool

Returns:

The message

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getHelpFile

public String getHelpFile()
                   throws IOException,
                          AutomationException

The name of the help file associated with this tool.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getHelpFile in interface IArcToolboxTool

Returns:

The helpFile

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getHelpContextID

public int getHelpContextID()
                     throws IOException,
                            AutomationException

The help context ID associated with this tool.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getHelpContextID in interface IArcToolboxTool

Returns:

The helpID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBitmap

public Picture getBitmap()
                  throws IOException,
                         AutomationException

The bitmap that is used as the icon for this tool.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getBitmap in interface IArcToolboxTool

Returns:

A reference to a com.esri.arcgis.support.ms.stdole.Picture (A com.esri.arcgis.support.ms.stdole.Picture COM typedef)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTreeviewLocation

public String getTreeviewLocation()
                           throws IOException,
                                  AutomationException

The location of the tool in the treeview.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getTreeviewLocation in interface IArcToolboxTool

Returns:

The treeviewLocation

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onCreate

public void onCreate(Object hook)
              throws IOException,
                     AutomationException

Occurs when this tool is created.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

onCreate in interface IArcToolboxTool

Parameters:

hook - A reference to another Automation Object (IDispatch) (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

execute

public void execute(Object inputData)
             throws IOException,
                    AutomationException

Run the tool.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

execute in interface IArcToolboxTool

Parameters:

inputData - A Variant (in, optional, pass null if not required)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.