com.esri.arcgis.framework
Class IArcToolboxToolProxy

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

All Implemented Interfaces:

IArcToolboxTool, java.io.Externalizable, java.io.Serializable

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

Internal use class Proxy for COM Interface 'IArcToolboxTool'. Generated 3/19/2015 1:21:02 PM from 'C:\ArcGIS\COM\esriFramework.olb'

Description: 'Provides access to members that control the Toolbox tools.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

See Also:

Serialized Form

Field Summary

boolean	noncastable
static java.lang.Class	targetClass

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

DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, objRef

Fields inherited from interface com.esri.arcgis.framework.IArcToolboxTool

IID, IID0acdfe44_f5e2_11d3_a623_0008c711c8c1

Constructor Summary

	IArcToolboxToolProxy() For internal use only
	IArcToolboxToolProxy(java.lang.Object obj)
protected	IArcToolboxToolProxy(java.lang.Object obj, java.lang.String iid)
	IArcToolboxToolProxy(java.lang.String CLSID, java.lang.String host, com.esri.arcgis.interop.AuthInfo authInfo)
protected	IArcToolboxToolProxy(java.lang.String CLSID, java.lang.String iid, java.lang.String host, com.esri.arcgis.interop.AuthInfo authInfo)

Method Summary

void	addListener(java.lang.String iidStr, java.lang.Object theListener, java.lang.Object theSource)
void	execute(java.lang.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.
java.lang.String	getHelpFile() The name of the help file associated with this tool.
java.lang.String	getMessage() The description for this tool.
int	getModality() The modality for the tool.
java.lang.String	getName() The name of this tool.
java.lang.String	getTreeviewLocation() The location of the tool in the treeview.
void	onCreate(java.lang.Object hook) Occurs when this tool is created.
void	removeListener(java.lang.String iidStr, java.lang.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

targetClass

public static final java.lang.Class targetClass

noncastable

public boolean noncastable

Constructor Detail

IArcToolboxToolProxy

public IArcToolboxToolProxy(java.lang.String CLSID,
                            java.lang.String host,
                            com.esri.arcgis.interop.AuthInfo authInfo)
                     throws java.net.UnknownHostException,
                            java.io.IOException

Throws:

java.net.UnknownHostException

java.io.IOException

IArcToolboxToolProxy

public IArcToolboxToolProxy()

For internal use only

IArcToolboxToolProxy

public IArcToolboxToolProxy(java.lang.Object obj)
                     throws java.io.IOException

Throws:

java.io.IOException

IArcToolboxToolProxy

protected IArcToolboxToolProxy(java.lang.Object obj,
                               java.lang.String iid)
                        throws java.io.IOException

Throws:

java.io.IOException

IArcToolboxToolProxy

protected IArcToolboxToolProxy(java.lang.String CLSID,
                               java.lang.String iid,
                               java.lang.String host,
                               com.esri.arcgis.interop.AuthInfo authInfo)
                        throws java.io.IOException

Throws:

java.io.IOException

Method Detail

addListener

public void addListener(java.lang.String iidStr,
                        java.lang.Object theListener,
                        java.lang.Object theSource)
                 throws java.io.IOException

Overrides:

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

Throws:

java.io.IOException

removeListener

public void removeListener(java.lang.String iidStr,
                           java.lang.Object theListener)
                    throws java.io.IOException

Overrides:

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

Throws:

java.io.IOException

setModality

public void setModality(int dialogModality)
                 throws java.io.IOException,
                        AutomationException

The modality for the tool.

Specified by:

setModality in interface IArcToolboxTool

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getModality

public int getModality()
                throws java.io.IOException,
                       AutomationException

The modality for the tool.

Specified by:

getModality in interface IArcToolboxTool

Returns:

A com.esri.arcgis.framework.esriATModality constant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getName

public java.lang.String getName()
                         throws java.io.IOException,
                                AutomationException

The name of this tool.

Specified by:

getName in interface IArcToolboxTool

Returns:

The name

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMessage

public java.lang.String getMessage()
                            throws java.io.IOException,
                                   AutomationException

The description for this tool.

Specified by:

getMessage in interface IArcToolboxTool

Returns:

The message

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getHelpFile

public java.lang.String getHelpFile()
                             throws java.io.IOException,
                                    AutomationException

The name of the help file associated with this tool.

Specified by:

getHelpFile in interface IArcToolboxTool

Returns:

The helpFile

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getHelpContextID

public int getHelpContextID()
                     throws java.io.IOException,
                            AutomationException

The help context ID associated with this tool.

Specified by:

getHelpContextID in interface IArcToolboxTool

Returns:

The helpID

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBitmap

public Picture getBitmap()
                  throws java.io.IOException,
                         AutomationException

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

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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTreeviewLocation

public java.lang.String getTreeviewLocation()
                                     throws java.io.IOException,
                                            AutomationException

The location of the tool in the treeview.

Specified by:

getTreeviewLocation in interface IArcToolboxTool

Returns:

The treeviewLocation

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onCreate

public void onCreate(java.lang.Object hook)
              throws java.io.IOException,
                     AutomationException

Occurs when this tool is created.

Specified by:

onCreate in interface IArcToolboxTool

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

execute

public void execute(java.lang.Object inputData)
             throws java.io.IOException,
                    AutomationException

Run the tool.

Specified by:

execute in interface IArcToolboxTool

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.