com.esri.arcgis.framework
Interface IArcToolboxTool

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

IArcToolboxToolProxy

public interface IArcToolboxTool
extends java.io.Serializable

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 =

Field Summary

static java.lang.String	IID Deprecated. Internal use only
static int	IID0acdfe44_f5e2_11d3_a623_0008c711c8c1
static int	xxDummy Deprecated. Internal use only

Method Summary

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	setModality(int dialogModality) The modality for the tool.

Field Detail

IID0acdfe44_f5e2_11d3_a623_0008c711c8c1

static final int IID0acdfe44_f5e2_11d3_a623_0008c711c8c1

See Also:

Constant Field Values

xxDummy

static final int xxDummy

Deprecated. Internal use only

See Also:

Constant Field Values

IID

static final java.lang.String IID

Deprecated. Internal use only

See Also:

Constant Field Values

Method Detail

setModality

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

The modality for the tool.

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

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

The modality for the tool.

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

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

The name of this tool.

Returns:

The name

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMessage

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

The description for this tool.

Returns:

The message

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getHelpFile

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

The name of the help file associated with this tool.

Returns:

The helpFile

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getHelpContextID

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

The help context ID associated with this tool.

Returns:

The helpID

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getBitmap

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

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

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

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

The location of the tool in the treeview.

Returns:

The treeviewLocation

Throws:

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

AutomationException - If the ArcObject component throws an exception.

onCreate

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

Occurs when this tool is created.

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

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

Run the tool.

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.