com.esri.arcgis.catalog
Class GxFilterToolboxes

java.lang.Object
  com.esri.arcgis.catalog.GxFilterToolboxes

All Implemented Interfaces:

IGxObjectFilter, com.esri.arcgis.interop.RemoteObjRef, java.io.Serializable

public class GxFilterToolboxes
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IGxObjectFilter

COM Class 'GxFilterToolboxes'. Generated 3/19/2015 1:20:49 PM from 'C:\ArcGIS\COM\esriCatalog.olb'

Description 'Object used to filter for Toolboxes.' 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 =

See Also:

Serialized Form

Field Summary

Fields inherited from interface com.esri.arcgis.catalog.IGxObjectFilter

IID, IID9e14bc46_19f4_11d3_9f55_00c04f6bc69e, xxDummy

Constructor Summary

GxFilterToolboxes()
Constructs a GxFilterToolboxes using ArcGIS Engine.

GxFilterToolboxes(java.lang.Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
GxFilterToolboxes theGxFilterToolboxes = (GxFilterToolboxes) obj;

Method Summary

boolean	canChooseObject(IGxObject object, int[] result) Indicates if the given object can be chosen.
boolean	canDisplayObject(IGxObject object) Indicates if the given object can be displayed.
boolean	canSaveObject(IGxObject location, java.lang.String newObjectName, boolean[] objectAlreadyExists) Indicates if a new object named newObjectName could be saved in the specified location.
boolean	equals(java.lang.Object o) Compare this object with another
static java.lang.String	getClsid() getClsid.
java.lang.String	getDescription() A string that describes what this filter does.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
java.lang.String	getName() A user-friendly name identifying this filter.
int	hashCode() the hashcode for this object
void	release() Release a GxFilterToolboxes.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GxFilterToolboxes

public GxFilterToolboxes()
                  throws java.io.IOException,
                         java.net.UnknownHostException

Constructs a GxFilterToolboxes using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

GxFilterToolboxes

public GxFilterToolboxes(java.lang.Object obj)
                  throws java.io.IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
GxFilterToolboxes theGxFilterToolboxes = (GxFilterToolboxes) obj;

Construct a GxFilterToolboxes using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to GxFilterToolboxes.

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

java.io.IOException - if there are interop problems

Method Detail

getClsid

public static java.lang.String getClsid()

getClsid.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()

Deprecated. Internal use only.

Specified by:

getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

release

public void release()

Release a GxFilterToolboxes.

Specified by:

release in interface com.esri.arcgis.interop.RemoteObjRef

getName

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

A user-friendly name identifying this filter.

Specified by:

getName in interface IGxObjectFilter

Returns:

The name

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDescription

public java.lang.String getDescription()
                                throws java.io.IOException,
                                       AutomationException

A string that describes what this filter does.

Specified by:

getDescription in interface IGxObjectFilter

Returns:

The description

Throws:

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

AutomationException - If the ArcObject component throws an exception.

canDisplayObject

public boolean canDisplayObject(IGxObject object)
                         throws java.io.IOException,
                                AutomationException

Indicates if the given object can be displayed.

Specified by:

canDisplayObject in interface IGxObjectFilter

Parameters:

object - A reference to a com.esri.arcgis.catalog.IGxObject (in)

Returns:

The canDisplay

Throws:

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

AutomationException - If the ArcObject component throws an exception.

canChooseObject

public boolean canChooseObject(IGxObject object,
                               int[] result)
                        throws java.io.IOException,
                               AutomationException

Indicates if the given object can be chosen.

Specified by:

canChooseObject in interface IGxObjectFilter

Parameters:

object - A reference to a com.esri.arcgis.catalog.IGxObject (in)

result - A com.esri.arcgis.catalog.esriDoubleClickResult constant (in/out: use single element array)

Returns:

The canChoose

Throws:

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

AutomationException - If the ArcObject component throws an exception.

canSaveObject

public boolean canSaveObject(IGxObject location,
                             java.lang.String newObjectName,
                             boolean[] objectAlreadyExists)
                      throws java.io.IOException,
                             AutomationException

Indicates if a new object named newObjectName could be saved in the specified location. If objectAlreadyExists is set to True, a confirmation dialog will appear asking if the existing object should be replaced.

Specified by:

canSaveObject in interface IGxObjectFilter

Parameters:

location - A reference to a com.esri.arcgis.catalog.IGxObject (in)

newObjectName - The newObjectName (in)

objectAlreadyExists - The objectAlreadyExists (in/out: use single element array)

Returns:

The canSave

Throws:

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

AutomationException - If the ArcObject component throws an exception.