com.esri.arcgis.arcglobe
Class GxFilterGlobes

java.lang.Object
  extended by com.esri.arcgis.arcglobe.GxFilterGlobes
All Implemented Interfaces:
IGxObjectFilter, com.esri.arcgis.interop.RemoteObjRef, Serializable

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

A filter for displaying/choosing ArcGlobe documents.

Remarks

The GxFilterGlobes object implements the IGxObjectFilter interface. The methods and properties on this interface help in determining whether or not a particular ArcGlobe document (*.3dd) file will be displayed in ArcGlobe.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Supported Platforms

Windows

See Also:
Serialized Form

Constructor Summary
GxFilterGlobes()
          Constructs a GxFilterGlobes using ArcGIS Engine.
GxFilterGlobes(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
GxFilterGlobes theGxFilterGlobes = (GxFilterGlobes) 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.
 String getName()
          A user-friendly name identifying this filter.
 int hashCode()
          the hashcode for this object
 
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

GxFilterGlobes

public GxFilterGlobes()
               throws IOException,
                      UnknownHostException
Constructs a GxFilterGlobes using ArcGIS Engine.

Throws:
IOException - if there are interop problems
UnknownHostException - if there are interop problems

GxFilterGlobes

public GxFilterGlobes(Object obj)
               throws IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
GxFilterGlobes theGxFilterGlobes = (GxFilterGlobes) obj;

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

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.