com.esri.arcgis.geoprocessing
Interface IGPToolExtensionFactoryGen

All Superinterfaces:
java.io.Serializable
All Known Implementing Classes:
IGPToolExtensionFactoryGenProxy

public interface IGPToolExtensionFactoryGen
extends java.io.Serializable

COM Interface 'IGPToolExtensionFactoryGen'. Generated 3/19/2015 1:20:59 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 IID50544432_54a5_4317_96ef_a8d51ad09a80
           
static int xxDummy
          Deprecated. Internal use only
 
Method Summary
 boolean canEdit()
          Returns whether or not the factory supports editing instances of the tool extension.
 IGPToolExtensionGen create(int parent, IGPToolbox destination)
          Creates a new instance of a tool extension in the given toolbox.
 void edit(int parent, IGPToolExtensionGen toolExtension)
          Invokes a window to edit a tool extension.
 IUID getCLSID()
          The CLSID of the tool extension factory class.
 java.lang.String getDefaultDescription()
          The default tool extension description.
 java.lang.String getDefaultDisplayName()
          The default tool extension display name.
 java.lang.String getDefaultName()
          The default tool extension name.
 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, IGPToolExtensionGen toolExtension)
          Called immediately following the creation of a new tool extension.
 

Field Detail

IID50544432_54a5_4317_96ef_a8d51ad09a80

static final int IID50544432_54a5_4317_96ef_a8d51ad09a80
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.

getDefaultName

java.lang.String getDefaultName()
                                throws java.io.IOException,
                                       AutomationException
The default tool extension name.

Returns:
The name
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDefaultDisplayName

java.lang.String getDefaultDisplayName()
                                       throws java.io.IOException,
                                              AutomationException
The default tool extension display name.

Returns:
The displayName
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDefaultDescription

java.lang.String getDefaultDescription()
                                       throws java.io.IOException,
                                              AutomationException
The default tool extension description.

Returns:
The description
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

create

IGPToolExtensionGen create(int parent,
                           IGPToolbox destination)
                           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)
Returns:
A reference to a com.esri.arcgis.geoprocessing.IGPToolExtensionGen
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

postCreateTool

void postCreateTool(int parent,
                    IGPToolExtensionGen 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.IGPToolExtensionGen (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,
          IGPToolExtensionGen 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.IGPToolExtensionGen (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.