com.esri.arcgis.catalog
Class GxFilterLayers

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

All Implemented Interfaces:

IGxObjectFilter, com.esri.arcgis.interop.RemoteObjRef, IDocumentVersion, Serializable

public class GxFilterLayers
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IGxObjectFilter, IDocumentVersion

A filter for displaying/choosing layers.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

See Also:

Serialized Form

Constructor Summary

GxFilterLayers()
Constructs a GxFilterLayers using ArcGIS Engine.

GxFilterLayers(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
GxFilterLayers theGxFilterLayers = (GxFilterLayers) 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, String newObjectName, boolean[] objectAlreadyExists) Indicates if a new object named newObjectName could be saved in the specified location.
boolean	equals(Object o) Compare this object with another
static String	getClsid() getClsid.
String	getDescription() A string that describes what this filter does.
int	getDocumentVersion() The version of the document to save.
String	getName() A user-friendly name identifying this filter.
int	hashCode() the hashcode for this object
void	setDocumentVersion(int docVersion) The version of the document to save.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef

getJintegraDispatch, release

Constructor Detail

GxFilterLayers

public GxFilterLayers()
               throws IOException,
                      UnknownHostException

Constructs a GxFilterLayers using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

GxFilterLayers

public GxFilterLayers(Object obj)
               throws IOException

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

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

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

getName

public String getName()
               throws IOException,
                      AutomationException

A user-friendly name identifying this filter.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getName in interface IGxObjectFilter

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDescription

public String getDescription()
                      throws IOException,
                             AutomationException

A string that describes what this filter does.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getDescription in interface IGxObjectFilter

Returns:

The description

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

canDisplayObject

public boolean canDisplayObject(IGxObject object)
                         throws IOException,
                                AutomationException

Indicates if the given object can be displayed.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

canDisplayObject in interface IGxObjectFilter

Parameters:

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

Returns:

The canDisplay

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

canChooseObject

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

Indicates if the given object can be chosen.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

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:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

canSaveObject

public boolean canSaveObject(IGxObject location,
                             String newObjectName,
                             boolean[] objectAlreadyExists)
                      throws 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.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

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:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDocumentVersion

public void setDocumentVersion(int docVersion)
                        throws IOException,
                               AutomationException

The version of the document to save.

Product Availability

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

Specified by:

setDocumentVersion in interface IDocumentVersion

Parameters:

docVersion - A com.esri.arcgis.system.esriArcGISVersion constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDocumentVersion

public int getDocumentVersion()
                       throws IOException,
                              AutomationException

The version of the document to save.

Remarks

Determines which version an object is persisted. This can be useful when saving an object ObjectStream or MemoryBlobStream and you want the version of that object to be compatible with previous releases of ArcGIS. Not all persistable objects implement IDocumentVersion; you should ensure the object supports this interface before accessing this property.

Product Availability

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

Specified by:

getDocumentVersion in interface IDocumentVersion

Returns:

A com.esri.arcgis.system.esriArcGISVersion constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.