com.esri.arcgis.geoprocessing
Interface IGPToolExtensionFactory

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

FMEToolFactory, IGPToolExtensionFactoryProxy

public interface IGPToolExtensionFactory
extends java.io.Serializable

COM Interface 'IGPToolExtensionFactory'. Generated 3/19/2015 1:20:58 PM from 'C:\ArcGIS\COM\esriGeoprocessing.olb'

Description: 'Provides access to methods on a geoprocessing tool extension factory object.' 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	IIDf0a6e875_ec4e_4b83_8599_77b04766d717
static int	xxDummy Deprecated. Internal use only

Method Summary

boolean	canEdit() Returns whether or not the factory supports editing instances of the tool extension.
IGPToolExtension	create(int parent, IGPToolbox destination, java.lang.String[] defaultName, java.lang.String[] defaultDisplayName, java.lang.String[] defaultDescription) Creates a new instance of a tool extension in the given toolbox.
void	edit(int parent, IGPToolExtension toolExtension) Invokes a window to edit a tool extension.
IUID	getCLSID() The CLSID of the tool extension factory class.
int	getLargeImage() A 32x32 bitmap to associate with the tool extension.
int	getLargeInvalidImage() A 32x32 bitmap to associate with invalid instances of the tool extension.
int	getLargeUnlicensedImage() A 32x32 bitmap to associate with unlicensed instances of the tool extension.
int	getSmallImage() A 16x16 bitmap to associate with the tool extension.
int	getSmallInvalidImage() A 16x16 bitmap to associate with invalid instances of the tool extension.
int	getSmallUnlicensedImage() A 16x16 bitmap to associate with unlicensed instances of the tool extension.
java.lang.String	getToolExtensionName() Name of the tool extension factory class.
void	postCreateTool(int parent, IGPToolExtension toolExtension) Called immediately following the creation of a new tool extension.

Field Detail

IIDf0a6e875_ec4e_4b83_8599_77b04766d717

static final int IIDf0a6e875_ec4e_4b83_8599_77b04766d717

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

getCLSID

IUID getCLSID()
              throws java.io.IOException,
                     AutomationException

The CLSID of the tool extension factory class.

Returns:

A reference to a com.esri.arcgis.system.IUID

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getToolExtensionName

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

Name of the tool extension factory class.

Returns:

The name

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSmallImage

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

A 16x16 bitmap to associate with the tool extension.

Returns:

The image (A COM typedef)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLargeImage

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

A 32x32 bitmap to associate with the tool extension.

Returns:

The image (A COM typedef)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSmallInvalidImage

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

A 16x16 bitmap to associate with invalid instances of the tool extension.

Returns:

The image (A COM typedef)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLargeInvalidImage

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

A 32x32 bitmap to associate with invalid instances of the tool extension.

Returns:

The image (A COM typedef)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSmallUnlicensedImage

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

A 16x16 bitmap to associate with unlicensed instances of the tool extension.

Returns:

The image (A COM typedef)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLargeUnlicensedImage

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

A 32x32 bitmap to associate with unlicensed instances of the tool extension.

Returns:

The image (A COM typedef)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

create

IGPToolExtension create(int parent,
                        IGPToolbox destination,
                        java.lang.String[] defaultName,
                        java.lang.String[] defaultDisplayName,
                        java.lang.String[] defaultDescription)
                        throws java.io.IOException,
                               AutomationException

Creates a new instance of a tool extension in the given toolbox.

Parameters:

parent - The parent (A COM typedef) (in)

destination - A reference to a com.esri.arcgis.geoprocessing.IGPToolbox (in)

defaultName - The defaultName (out: use single element array)

defaultDisplayName - The defaultDisplayName (out: use single element array)

defaultDescription - The defaultDescription (out: use single element array)

Returns:

A reference to a com.esri.arcgis.geoprocessing.IGPToolExtension

Throws:

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

AutomationException - If the ArcObject component throws an exception.

postCreateTool

void postCreateTool(int parent,
                    IGPToolExtension toolExtension)
                    throws java.io.IOException,
                           AutomationException

Called immediately following the creation of a new tool extension.

Parameters:

parent - The parent (A COM typedef) (in)

toolExtension - A reference to a com.esri.arcgis.geoprocessing.IGPToolExtension (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

canEdit

boolean canEdit()
                throws java.io.IOException,
                       AutomationException

Returns whether or not the factory supports editing instances of the tool extension.

Returns:

The canEdit

Throws:

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

AutomationException - If the ArcObject component throws an exception.

edit

void edit(int parent,
          IGPToolExtension toolExtension)
          throws java.io.IOException,
                 AutomationException

Invokes a window to edit a tool extension.

Parameters:

parent - The parent (A COM typedef) (in)

toolExtension - A reference to a com.esri.arcgis.geoprocessing.IGPToolExtension (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.