com.esri.arcgis.geoprocessing
Class IGPToolExtensionFactoryGenProxy

java.lang.Object
  extended by com.esri.arcgis.interop.Dispatch
      extended by com.esri.arcgis.geoprocessing.IGPToolExtensionFactoryGenProxy
All Implemented Interfaces:
IGPToolExtensionFactoryGen, Externalizable, Serializable

public class IGPToolExtensionFactoryGenProxy
extends com.esri.arcgis.interop.Dispatch
implements IGPToolExtensionFactoryGen, Serializable

Provides access to methods on a geoprocessing tool extension factory object.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

See Also:
Serialized Form

Field Summary
 
Fields inherited from class com.esri.arcgis.interop.Dispatch
DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, E
 
Constructor Summary
  IGPToolExtensionFactoryGenProxy()
           
  IGPToolExtensionFactoryGenProxy(Object obj)
           
protected IGPToolExtensionFactoryGenProxy(Object obj, String iid)
           
 
Method Summary
 void addListener(String iidStr, Object theListener, Object theSource)
           
 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.
 String getDefaultDescription()
          The default tool extension description.
 String getDefaultDisplayName()
          The default tool extension display name.
 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.
 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.
 void readExternal(ObjectInput in)
           
 void removeListener(String iidStr, Object theListener)
           
 void writeExternal(ObjectOutput out)
           
 
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, queryInterface, release, setNativeMode, setPropertyByName, toString, vtblInvoke
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

IGPToolExtensionFactoryGenProxy

public IGPToolExtensionFactoryGenProxy()

IGPToolExtensionFactoryGenProxy

public IGPToolExtensionFactoryGenProxy(Object obj)
                                throws IOException
Throws:
IOException

IGPToolExtensionFactoryGenProxy

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

getCLSID

public IUID getCLSID()
              throws IOException,
                     AutomationException
The CLSID of the tool extension factory class.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
getCLSID in interface IGPToolExtensionFactoryGen
Returns:
A reference to a com.esri.arcgis.system.IUID
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getToolExtensionName

public String getToolExtensionName()
                            throws IOException,
                                   AutomationException
Name of the tool extension factory class.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
getToolExtensionName in interface IGPToolExtensionFactoryGen
Returns:
The name
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSmallImage

public int getSmallImage()
                  throws IOException,
                         AutomationException
A 16x16 bitmap to associate with the tool extension.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
getSmallImage in interface IGPToolExtensionFactoryGen
Returns:
The image (A COM typedef)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLargeImage

public int getLargeImage()
                  throws IOException,
                         AutomationException
A 32x32 bitmap to associate with the tool extension.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
getLargeImage in interface IGPToolExtensionFactoryGen
Returns:
The image (A COM typedef)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSmallInvalidImage

public int getSmallInvalidImage()
                         throws IOException,
                                AutomationException
A 16x16 bitmap to associate with invalid instances of the tool extension.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
getSmallInvalidImage in interface IGPToolExtensionFactoryGen
Returns:
The image (A COM typedef)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLargeInvalidImage

public int getLargeInvalidImage()
                         throws IOException,
                                AutomationException
A 32x32 bitmap to associate with invalid instances of the tool extension.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
getLargeInvalidImage in interface IGPToolExtensionFactoryGen
Returns:
The image (A COM typedef)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSmallUnlicensedImage

public int getSmallUnlicensedImage()
                            throws IOException,
                                   AutomationException
A 16x16 bitmap to associate with unlicensed instances of the tool extension.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
getSmallUnlicensedImage in interface IGPToolExtensionFactoryGen
Returns:
The image (A COM typedef)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLargeUnlicensedImage

public int getLargeUnlicensedImage()
                            throws IOException,
                                   AutomationException
A 32x32 bitmap to associate with unlicensed instances of the tool extension.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
getLargeUnlicensedImage in interface IGPToolExtensionFactoryGen
Returns:
The image (A COM typedef)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDefaultName

public String getDefaultName()
                      throws IOException,
                             AutomationException
The default tool extension name.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
getDefaultName in interface IGPToolExtensionFactoryGen
Returns:
The name
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDefaultDisplayName

public String getDefaultDisplayName()
                             throws IOException,
                                    AutomationException
The default tool extension display name.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
getDefaultDisplayName in interface IGPToolExtensionFactoryGen
Returns:
The displayName
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDefaultDescription

public String getDefaultDescription()
                             throws IOException,
                                    AutomationException
The default tool extension description.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
getDefaultDescription in interface IGPToolExtensionFactoryGen
Returns:
The description
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

create

public IGPToolExtensionGen create(int parent,
                                  IGPToolbox destination)
                           throws IOException,
                                  AutomationException
Creates a new instance of a tool extension in the given toolbox.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
create in interface IGPToolExtensionFactoryGen
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:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

postCreateTool

public void postCreateTool(int parent,
                           IGPToolExtensionGen toolExtension)
                    throws IOException,
                           AutomationException
Called immediately following the creation of a new tool extension.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
postCreateTool in interface IGPToolExtensionFactoryGen
Parameters:
parent - The parent (A COM typedef) (in)
toolExtension - A reference to a com.esri.arcgis.geoprocessing.IGPToolExtensionGen (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

canEdit

public boolean canEdit()
                throws IOException,
                       AutomationException
Returns whether or not the factory supports editing instances of the tool extension.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
canEdit in interface IGPToolExtensionFactoryGen
Returns:
The canEdit
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

edit

public void edit(int parent,
                 IGPToolExtensionGen toolExtension)
          throws IOException,
                 AutomationException
Invokes a window to edit a tool extension.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
edit in interface IGPToolExtensionFactoryGen
Parameters:
parent - The parent (A COM typedef) (in)
toolExtension - A reference to a com.esri.arcgis.geoprocessing.IGPToolExtensionGen (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException
Specified by:
writeExternal in interface Externalizable
Overrides:
writeExternal in class com.esri.arcgis.interop.Dispatch
Throws:
IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException
Specified by:
readExternal in interface Externalizable
Overrides:
readExternal in class com.esri.arcgis.interop.Dispatch
Throws:
IOException
ClassNotFoundException