com.esri.arcgis.catalogUI
Class GxRasterCatalogContentView

java.lang.Object
  com.esri.arcgis.catalogUI.GxRasterCatalogContentView

All Implemented Interfaces:

IGxCatalogEvents, IGxSelectionEvents, IGxContentsView, IGxPreview, IGxView, IObjectClassEvents, IObjectClassSchemaEvents, com.esri.arcgis.interop.RemoteObjRef, Serializable, EventListener

public class GxRasterCatalogContentView
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IGxView, IGxPreview, IGxSelectionEvents, IGxCatalogEvents, IGxContentsView, IObjectClassEvents, IObjectClassSchemaEvents

The RasterCatalog content view.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

See Also:

Serialized Form

Constructor Summary

GxRasterCatalogContentView()
Constructs a GxRasterCatalogContentView using ArcGIS Engine.

GxRasterCatalogContentView(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
GxRasterCatalogContentView theGxRasterCatalogContentView = (GxRasterCatalogContentView) obj;

Method Summary

void	activate(IGxApplication application, IGxCatalog catalog) Activates the view.
boolean	applies(IGxObject selection) Indicates if the view can display the given object.
void	beginRename() Starts a rename operation on the current selection.
void	deactivate() Deactivates the view.
boolean	equals(Object o) Compare this object with another
IUID	getClassID() The class ID of the view.
static String	getClsid() getClsid.
IUID	getDefaultToolbarCLSID() The class ID of the view's default toolbar.
int	getDisplayStyle() The current display style.
int	getHWnd() The view's window handle.
String	getName() The name of the view.
ISet	getSupportedViewClassIDs() A list of the class IDs for the views that are supported given the current selection.
IGxView	getView() The current view.
IUID	getViewClassID() The class ID of the current view.
int	hashCode() the hashcode for this object
boolean	isAllowMultiSelect() Indicates if multiple objects can be selected.
boolean	isSupportsTools() Indicates if the view supports tools.
void	onAddField(IObjectClassSchemaEventsOnAddFieldEvent theEvent) This event is fired when a new field is added to the object class.
void	onBehaviorChanged(IObjectClassSchemaEventsOnBehaviorChangedEvent theEvent) This event is fired when the behavior class for the object class changes.
void	onChange(IObjectClassEventsOnChangeEvent theEvent) This event is fired when an object's attributes or geometry is updated.
void	onCreate(IObjectClassEventsOnCreateEvent theEvent) This event is fired when a new object is created in the object class.
void	onDelete(IObjectClassEventsOnDeleteEvent theEvent) This event is fired when an object is deleted from the object class.
void	onDeleteField(IObjectClassSchemaEventsOnDeleteFieldEvent theEvent) This event is fired when a field is deleted from the object class.
void	onObjectAdded(IGxCatalogEventsOnObjectAddedEvent theEvent) Called when an object has been added to some part of the catalog.
void	onObjectChanged(IGxCatalogEventsOnObjectChangedEvent theEvent) Called when an object in some part of the catalog has been changed.
void	onObjectDeleted(IGxCatalogEventsOnObjectDeletedEvent theEvent) Called when an object has been deleted from some part of the catalog.
void	onObjectRefreshed(IGxCatalogEventsOnObjectRefreshedEvent theEvent) Called when an object in some part of the catalog has been refreshed.
void	onRefreshAll(IGxCatalogEventsOnRefreshAllEvent theEvent) Called when the whole catalog has changed.
void	onSelectionChanged(IGxSelectionEventsOnSelectionChangedEvent theEvent) Called when the selection contents have changed.
void	refresh() Refreshes the view.
void	setAllowMultiSelect(boolean multiSelect) Indicates if multiple objects can be selected.
void	setDisplayStyle(int contentsStyle) The current display style.
void	setObjectFilterByRef(IGxObjectFilter rhs1) The object filter used for controlling what objects are displayed.
void	setViewClassID(IUID viewClassID) The class ID of the current view.
void	systemSettingChanged(int flag, String section) Informs the view that a system setting has changed.

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

GxRasterCatalogContentView

public GxRasterCatalogContentView()
                           throws IOException,
                                  UnknownHostException

Constructs a GxRasterCatalogContentView using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

GxRasterCatalogContentView

public GxRasterCatalogContentView(Object obj)
                           throws IOException

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

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

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

The name of the view.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getName in interface IGxView

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getClassID

public IUID getClassID()
                throws IOException,
                       AutomationException

The class ID of the view.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getClassID in interface IGxView

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.

getHWnd

public int getHWnd()
            throws IOException,
                   AutomationException

The view's window handle.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getHWnd in interface IGxView

Returns:

The window (A COM typedef)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDefaultToolbarCLSID

public IUID getDefaultToolbarCLSID()
                            throws IOException,
                                   AutomationException

The class ID of the view's default toolbar. Not currently used.

Remarks

DefaultToolbarCLSID provides a reference to the default toolbar for the particular view. The default toolbar for a view would contain tools that were appropriate for the current type of GxView.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getDefaultToolbarCLSID in interface IGxView

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.

isSupportsTools

public boolean isSupportsTools()
                        throws IOException,
                               AutomationException

Indicates if the view supports tools.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

isSupportsTools in interface IGxView

Returns:

The supportsTools

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

applies

public boolean applies(IGxObject selection)
                throws IOException,
                       AutomationException

Indicates if the view can display the given object.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

applies in interface IGxView

Parameters:

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

Returns:

The applies

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

activate

public void activate(IGxApplication application,
                     IGxCatalog catalog)
              throws IOException,
                     AutomationException

Activates the view.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

activate in interface IGxView

Parameters:

application - A reference to a com.esri.arcgis.catalogUI.IGxApplication (in)

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

deactivate

public void deactivate()
                throws IOException,
                       AutomationException

Deactivates the view.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

deactivate in interface IGxView

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

refresh

public void refresh()
             throws IOException,
                    AutomationException

Refreshes the view.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

refresh in interface IGxView

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

systemSettingChanged

public void systemSettingChanged(int flag,
                                 String section)
                          throws IOException,
                                 AutomationException

Informs the view that a system setting has changed.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

systemSettingChanged in interface IGxView

Parameters:

flag - The flag (in)

section - The section (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getView

public IGxView getView()
                throws IOException,
                       AutomationException

The current view.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getView in interface IGxPreview

Returns:

A reference to a com.esri.arcgis.catalogUI.IGxView

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getViewClassID

public IUID getViewClassID()
                    throws IOException,
                           AutomationException

The class ID of the current view.

Remarks

TheViewClassID property is used to set and retrieve the current view through its UID. Setting the UID is the only method for changing the current view within the GxPreview object.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getViewClassID in interface IGxPreview

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.

setViewClassID

public void setViewClassID(IUID viewClassID)
                    throws IOException,
                           AutomationException

The class ID of the current view.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setViewClassID in interface IGxPreview

Parameters:

viewClassID - A reference to a com.esri.arcgis.system.IUID (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSupportedViewClassIDs

public ISet getSupportedViewClassIDs()
                              throws IOException,
                                     AutomationException

A list of the class IDs for the views that are supported given the current selection.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getSupportedViewClassIDs in interface IGxPreview

Returns:

A reference to a com.esri.arcgis.system.ISet

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onSelectionChanged

public void onSelectionChanged(IGxSelectionEventsOnSelectionChangedEvent theEvent)
                        throws IOException,
                               AutomationException

Called when the selection contents have changed.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

onSelectionChanged in interface IGxSelectionEvents

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onRefreshAll

public void onRefreshAll(IGxCatalogEventsOnRefreshAllEvent theEvent)
                  throws IOException,
                         AutomationException

Called when the whole catalog has changed.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

onRefreshAll in interface IGxCatalogEvents

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onObjectAdded

public void onObjectAdded(IGxCatalogEventsOnObjectAddedEvent theEvent)
                   throws IOException,
                          AutomationException

Called when an object has been added to some part of the catalog.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

onObjectAdded in interface IGxCatalogEvents

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onObjectDeleted

public void onObjectDeleted(IGxCatalogEventsOnObjectDeletedEvent theEvent)
                     throws IOException,
                            AutomationException

Called when an object has been deleted from some part of the catalog.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

onObjectDeleted in interface IGxCatalogEvents

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onObjectChanged

public void onObjectChanged(IGxCatalogEventsOnObjectChangedEvent theEvent)
                     throws IOException,
                            AutomationException

Called when an object in some part of the catalog has been changed.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

onObjectChanged in interface IGxCatalogEvents

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onObjectRefreshed

public void onObjectRefreshed(IGxCatalogEventsOnObjectRefreshedEvent theEvent)
                       throws IOException,
                              AutomationException

Called when an object in some part of the catalog has been refreshed.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

onObjectRefreshed in interface IGxCatalogEvents

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDisplayStyle

public int getDisplayStyle()
                    throws IOException,
                           AutomationException

The current display style.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getDisplayStyle in interface IGxContentsView

Returns:

A com.esri.arcgis.catalogUI.esriContentsViewStyle constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDisplayStyle

public void setDisplayStyle(int contentsStyle)
                     throws IOException,
                            AutomationException

The current display style.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setDisplayStyle in interface IGxContentsView

Parameters:

contentsStyle - A com.esri.arcgis.catalogUI.esriContentsViewStyle constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isAllowMultiSelect

public boolean isAllowMultiSelect()
                           throws IOException,
                                  AutomationException

Indicates if multiple objects can be selected.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

isAllowMultiSelect in interface IGxContentsView

Returns:

The multiSelect

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAllowMultiSelect

public void setAllowMultiSelect(boolean multiSelect)
                         throws IOException,
                                AutomationException

Indicates if multiple objects can be selected.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setAllowMultiSelect in interface IGxContentsView

Parameters:

multiSelect - The multiSelect (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setObjectFilterByRef

public void setObjectFilterByRef(IGxObjectFilter rhs1)
                          throws IOException,
                                 AutomationException

The object filter used for controlling what objects are displayed.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setObjectFilterByRef in interface IGxContentsView

Parameters:

rhs1 - A reference to a com.esri.arcgis.catalog.IGxObjectFilter (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

beginRename

public void beginRename()
                 throws IOException,
                        AutomationException

Starts a rename operation on the current selection.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

beginRename in interface IGxContentsView

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onCreate

public void onCreate(IObjectClassEventsOnCreateEvent theEvent)
              throws IOException,
                     AutomationException

This event is fired when a new object is created in the object class.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

onCreate in interface IObjectClassEvents

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onDelete

public void onDelete(IObjectClassEventsOnDeleteEvent theEvent)
              throws IOException,
                     AutomationException

This event is fired when an object is deleted from the object class.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

onDelete in interface IObjectClassEvents

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onChange

public void onChange(IObjectClassEventsOnChangeEvent theEvent)
              throws IOException,
                     AutomationException

This event is fired when an object's attributes or geometry is updated.

Remarks

In the event that a feature should be deleted due to an OnChange event, it is not recommended that the event handler delete the feature itself. Instead, an exception should be thrown to the application, where it can be made responsible for deleting the feature.

The OnChange event is not fired during a Topology Validation for performance reasons as a large number of features may be changed during a Validate. In addition, features may be changed many times.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

onChange in interface IObjectClassEvents

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onAddField

public void onAddField(IObjectClassSchemaEventsOnAddFieldEvent theEvent)
                throws IOException,
                       AutomationException

This event is fired when a new field is added to the object class.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

onAddField in interface IObjectClassSchemaEvents

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onDeleteField

public void onDeleteField(IObjectClassSchemaEventsOnDeleteFieldEvent theEvent)
                   throws IOException,
                          AutomationException

This event is fired when a field is deleted from the object class.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

onDeleteField in interface IObjectClassSchemaEvents

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onBehaviorChanged

public void onBehaviorChanged(IObjectClassSchemaEventsOnBehaviorChangedEvent theEvent)
                       throws IOException,
                              AutomationException

This event is fired when the behavior class for the object class changes.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

onBehaviorChanged in interface IObjectClassSchemaEvents

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.