com.esri.arcgis.catalogUI
Class GxContentsView

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

All Implemented Interfaces:

IGxCatalogEvents, IGxSelectionEvents, IGxContentsView, IGxContentsViewColumns, IGxView, com.esri.arcgis.interop.RemoteObjRef, IPersist, IPersistStream, Externalizable, Serializable, EventListener

public class GxContentsView
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IGxCatalogEvents, IGxContentsView, IGxContentsViewColumns, IGxSelectionEvents, IGxView, IPersistStream, Externalizable

GxView that represents the contents view.

Remarks

The Explorer-style iconic view available in ArcCatalog is the GxContentsView. It shows the children of the current selection location in a variety of styles: large icons, list, report, and thumbnails. You can set the style it uses by changing the DisplayStyle property on IGxContentsView.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

See Also:

Serialized Form

Constructor Summary

GxContentsView()
Constructs a GxContentsView using ArcGIS Engine.

GxContentsView(Object obj)
Construct a GxContentsView using a reference to such an object returned from ArcGIS Engine or Server.

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.
void	getClassID(GUID[] pClassID) getClassID
static String	getClsid() getClsid.
IGxContentsViewColumn	getColumnByIndex(int index) A column by its index.
IGxContentsViewColumn	getColumnByProperty(String property) A column by its property.
int	getColumnCount() The total number of columns (include both visible and invisible columns).
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.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
int	hashCode() the hashcode for this object
void	insertColumn(int index, IGxContentsViewColumn pColumn) Inserts a GxContentsViewColumn before the specified index.
boolean	isAllowMultiSelect() Indicates if multiple objects can be selected.
void	isDirty() isDirty
boolean	isSupportsTools() Indicates if the view supports tools.
void	load(IStream pstm) load
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	readExternal(ObjectInput in)
void	refresh() Refreshes the view.
void	removeAllColumns() Removes all columns except Name and Type column (they are always shown).
void	removeColumn(IGxContentsViewColumn pColumn) Removes a GxContentsViewColumn.
void	save(IStream pstm, int fClearDirty) save
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	systemSettingChanged(int flag, String section) Informs the view that a system setting has changed.
void	updateColumns() Refresh columns in contents view after insert or remove columns.
void	writeExternal(ObjectOutput out)

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

GxContentsView

public GxContentsView()
               throws IOException,
                      UnknownHostException

Constructs a GxContentsView using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

GxContentsView

public GxContentsView(Object obj)
               throws IOException

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

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems GxContentsView theGxContentsView = (GxContentsView) obj;

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

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.

insertColumn

public void insertColumn(int index,
                         IGxContentsViewColumn pColumn)
                  throws IOException,
                         AutomationException

Inserts a GxContentsViewColumn before the specified index. If index is -1, the column is inserted at the end.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

insertColumn in interface IGxContentsViewColumns

Parameters:

index - The index (in)

pColumn - A reference to a com.esri.arcgis.catalogUI.IGxContentsViewColumn (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

removeColumn

public void removeColumn(IGxContentsViewColumn pColumn)
                  throws IOException,
                         AutomationException

Removes a GxContentsViewColumn.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

removeColumn in interface IGxContentsViewColumns

Parameters:

pColumn - A reference to a com.esri.arcgis.catalogUI.IGxContentsViewColumn (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

removeAllColumns

public void removeAllColumns()
                      throws IOException,
                             AutomationException

Removes all columns except Name and Type column (they are always shown).

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

removeAllColumns in interface IGxContentsViewColumns

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

updateColumns

public void updateColumns()
                   throws IOException,
                          AutomationException

Refresh columns in contents view after insert or remove columns.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

updateColumns in interface IGxContentsViewColumns

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getColumnCount

public int getColumnCount()
                   throws IOException,
                          AutomationException

The total number of columns (include both visible and invisible columns).

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getColumnCount in interface IGxContentsViewColumns

Returns:

The count

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getColumnByIndex

public IGxContentsViewColumn getColumnByIndex(int index)
                                       throws IOException,
                                              AutomationException

A column by its index.

Product Availability

Available with ArcGIS Desktop.

Specified by:

getColumnByIndex in interface IGxContentsViewColumns

Parameters:

index - The index (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getColumnByProperty

public IGxContentsViewColumn getColumnByProperty(String property)
                                          throws IOException,
                                                 AutomationException

A column by its property.

Product Availability

Available with ArcGIS Desktop.

Specified by:

getColumnByProperty in interface IGxContentsViewColumns

Parameters:

property - The property (in)

Returns:

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

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.

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.

isDirty

public void isDirty()
             throws IOException,
                    AutomationException

isDirty

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isDirty in interface IPersistStream

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws IOException,
                 AutomationException

load

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

load in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

save

public void save(IStream pstm,
                 int fClearDirty)
          throws IOException,
                 AutomationException

save

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

save in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

fClearDirty - The fClearDirty (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSizeMax

public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
                throws IOException,
                       AutomationException

getSizeMax

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getSizeMax in interface IPersistStream

Parameters:

pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getClassID

public void getClassID(GUID[] pClassID)
                throws IOException,
                       AutomationException

getClassID

Description

IPersist is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getClassID in interface IPersist

Parameters:

pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)

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

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException