com.esri.arcgis.geoprocessing
Class IGPToolExtensionFactoryProxy

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

public class IGPToolExtensionFactoryProxy
extends com.esri.arcgis.interop.Dispatch
implements IGPToolExtensionFactory, 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
  IGPToolExtensionFactoryProxy()
           
  IGPToolExtensionFactoryProxy(Object obj)
           
protected IGPToolExtensionFactoryProxy(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.
 IGPToolExtension create(int parent, IGPToolbox destination, String[] defaultName, String[] defaultDisplayName, 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.
 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.
 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

IGPToolExtensionFactoryProxy

public IGPToolExtensionFactoryProxy()

IGPToolExtensionFactoryProxy

public IGPToolExtensionFactoryProxy(Object obj)
                             throws IOException
Throws:
IOException

IGPToolExtensionFactoryProxy

protected IGPToolExtensionFactoryProxy(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 IGPToolExtensionFactory
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 IGPToolExtensionFactory
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 IGPToolExtensionFactory
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 IGPToolExtensionFactory
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 IGPToolExtensionFactory
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 IGPToolExtensionFactory
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 IGPToolExtensionFactory
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 IGPToolExtensionFactory
Returns:
The image (A COM typedef)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

create

public IGPToolExtension create(int parent,
                               IGPToolbox destination,
                               String[] defaultName,
                               String[] defaultDisplayName,
                               String[] defaultDescription)
                        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 IGPToolExtensionFactory
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:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

postCreateTool

public void postCreateTool(int parent,
                           IGPToolExtension 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 IGPToolExtensionFactory
Parameters:
parent - The parent (A COM typedef) (in)
toolExtension - A reference to a com.esri.arcgis.geoprocessing.IGPToolExtension (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 IGPToolExtensionFactory
Returns:
The canEdit
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

edit

public void edit(int parent,
                 IGPToolExtension 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 IGPToolExtensionFactory
Parameters:
parent - The parent (A COM typedef) (in)
toolExtension - A reference to a com.esri.arcgis.geoprocessing.IGPToolExtension (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