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, java.io.Externalizable, java.io.Serializable, java.util.EventListener

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

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

Description 'GxView that represents the contents view.' 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

static long

serialVersionUID

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

IID, IIDbdbbb3f8_d0b2_11d1_aed9_080009ec734b, xxDummy

Fields inherited from interface com.esri.arcgis.catalogUI.IGxContentsView

IID, IIDda1862ea_95f8_11d2_af67_080009ec734b, xxDummy

Fields inherited from interface com.esri.arcgis.catalogUI.IGxContentsViewColumns

IID, IID26212055_ef93_11d3_a685_0008c7d3ae8d, xxDummy

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

IID, IIDbdbbb3f9_d0b2_11d1_aed9_080009ec734b, xxDummy

Fields inherited from interface com.esri.arcgis.catalogUI.IGxView

IID, IIDb1de27ab_d892_11d1_aa81_064342000000, xxDummy

Fields inherited from interface com.esri.arcgis.system.IPersistStream

IID, IID00000109_0000_0000_c000_000000000046, xxDummy

Fields inherited from interface com.esri.arcgis.system.IPersist

IID0000010c_0000_0000_c000_000000000046

Constructor Summary

GxContentsView()
Constructs a GxContentsView using ArcGIS Engine.

GxContentsView(java.lang.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(java.lang.Object o) Compare this object with another
IUID	getClassID() The class ID of the view.
void	getClassID(GUID[] pClassID) getClassID
static java.lang.String	getClsid() getClsid.
IGxContentsViewColumn	getColumnByIndex(int index) A column by its index.
IGxContentsViewColumn	getColumnByProperty(java.lang.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.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
java.lang.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(java.io.ObjectInput in)
void	refresh() Refreshes the view.
void	release() Release a GxContentsView.
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, java.lang.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(java.io.ObjectOutput out)

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

GxContentsView

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

Constructs a GxContentsView using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

GxContentsView

public GxContentsView(java.lang.Object obj)
               throws java.io.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:

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

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 GxContentsView.

Specified by:

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

onRefreshAll

public void onRefreshAll(IGxCatalogEventsOnRefreshAllEvent theEvent)
                  throws java.io.IOException,
                         AutomationException

Called when the whole catalog has changed.

Specified by:

onRefreshAll in interface IGxCatalogEvents

Parameters:

theEvent - The event

Throws:

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

AutomationException - If the ArcObject component throws an exception.

onObjectAdded

public void onObjectAdded(IGxCatalogEventsOnObjectAddedEvent theEvent)
                   throws java.io.IOException,
                          AutomationException

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

Specified by:

onObjectAdded in interface IGxCatalogEvents

Parameters:

theEvent - The event

Throws:

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

AutomationException - If the ArcObject component throws an exception.

onObjectDeleted

public void onObjectDeleted(IGxCatalogEventsOnObjectDeletedEvent theEvent)
                     throws java.io.IOException,
                            AutomationException

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

Specified by:

onObjectDeleted in interface IGxCatalogEvents

Parameters:

theEvent - The event

Throws:

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

AutomationException - If the ArcObject component throws an exception.

onObjectChanged

public void onObjectChanged(IGxCatalogEventsOnObjectChangedEvent theEvent)
                     throws java.io.IOException,
                            AutomationException

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

Specified by:

onObjectChanged in interface IGxCatalogEvents

Parameters:

theEvent - The event

Throws:

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

AutomationException - If the ArcObject component throws an exception.

onObjectRefreshed

public void onObjectRefreshed(IGxCatalogEventsOnObjectRefreshedEvent theEvent)
                       throws java.io.IOException,
                              AutomationException

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

Specified by:

onObjectRefreshed in interface IGxCatalogEvents

Parameters:

theEvent - The event

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDisplayStyle

public int getDisplayStyle()
                    throws java.io.IOException,
                           AutomationException

The current display style.

Specified by:

getDisplayStyle in interface IGxContentsView

Returns:

A com.esri.arcgis.catalogUI.esriContentsViewStyle constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDisplayStyle

public void setDisplayStyle(int contentsStyle)
                     throws java.io.IOException,
                            AutomationException

The current display style.

Specified by:

setDisplayStyle in interface IGxContentsView

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isAllowMultiSelect

public boolean isAllowMultiSelect()
                           throws java.io.IOException,
                                  AutomationException

Indicates if multiple objects can be selected.

Specified by:

isAllowMultiSelect in interface IGxContentsView

Returns:

The multiSelect

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setAllowMultiSelect

public void setAllowMultiSelect(boolean multiSelect)
                         throws java.io.IOException,
                                AutomationException

Indicates if multiple objects can be selected.

Specified by:

setAllowMultiSelect in interface IGxContentsView

Parameters:

multiSelect - The multiSelect (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setObjectFilterByRef

public void setObjectFilterByRef(IGxObjectFilter rhs1)
                          throws java.io.IOException,
                                 AutomationException

The object filter used for controlling what objects are displayed.

Specified by:

setObjectFilterByRef in interface IGxContentsView

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

beginRename

public void beginRename()
                 throws java.io.IOException,
                        AutomationException

Starts a rename operation on the current selection.

Specified by:

beginRename in interface IGxContentsView

Throws:

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

AutomationException - If the ArcObject component throws an exception.

insertColumn

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

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

Specified by:

insertColumn in interface IGxContentsViewColumns

Parameters:

index - The index (in)

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

removeColumn

public void removeColumn(IGxContentsViewColumn pColumn)
                  throws java.io.IOException,
                         AutomationException

Removes a GxContentsViewColumn.

Specified by:

removeColumn in interface IGxContentsViewColumns

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

removeAllColumns

public void removeAllColumns()
                      throws java.io.IOException,
                             AutomationException

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

Specified by:

removeAllColumns in interface IGxContentsViewColumns

Throws:

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

AutomationException - If the ArcObject component throws an exception.

updateColumns

public void updateColumns()
                   throws java.io.IOException,
                          AutomationException

Refresh columns in contents view after insert or remove columns.

Specified by:

updateColumns in interface IGxContentsViewColumns

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getColumnCount

public int getColumnCount()
                   throws java.io.IOException,
                          AutomationException

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

Specified by:

getColumnCount in interface IGxContentsViewColumns

Returns:

The count

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getColumnByIndex

public IGxContentsViewColumn getColumnByIndex(int index)
                                       throws java.io.IOException,
                                              AutomationException

A column by its index.

Specified by:

getColumnByIndex in interface IGxContentsViewColumns

Parameters:

index - The index (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getColumnByProperty

public IGxContentsViewColumn getColumnByProperty(java.lang.String property)
                                          throws java.io.IOException,
                                                 AutomationException

A column by its property.

Specified by:

getColumnByProperty in interface IGxContentsViewColumns

Parameters:

property - The property (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

onSelectionChanged

public void onSelectionChanged(IGxSelectionEventsOnSelectionChangedEvent theEvent)
                        throws java.io.IOException,
                               AutomationException

Called when the selection contents have changed.

Specified by:

onSelectionChanged in interface IGxSelectionEvents

Parameters:

theEvent - The event

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getName

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

The name of the view.

Specified by:

getName in interface IGxView

Returns:

The name

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getClassID

public IUID getClassID()
                throws java.io.IOException,
                       AutomationException

The class ID of the view.

Specified by:

getClassID in interface IGxView

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getHWnd

public int getHWnd()
            throws java.io.IOException,
                   AutomationException

The view's window handle.

Specified by:

getHWnd in interface IGxView

Returns:

The window (A COM typedef)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDefaultToolbarCLSID

public IUID getDefaultToolbarCLSID()
                            throws java.io.IOException,
                                   AutomationException

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

Specified by:

getDefaultToolbarCLSID in interface IGxView

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isSupportsTools

public boolean isSupportsTools()
                        throws java.io.IOException,
                               AutomationException

Indicates if the view supports tools.

Specified by:

isSupportsTools in interface IGxView

Returns:

The supportsTools

Throws:

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

AutomationException - If the ArcObject component throws an exception.

applies

public boolean applies(IGxObject selection)
                throws java.io.IOException,
                       AutomationException

Indicates if the view can display the given object.

Specified by:

applies in interface IGxView

Parameters:

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

Returns:

The applies

Throws:

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

AutomationException - If the ArcObject component throws an exception.

activate

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

Activates the view.

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:

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

AutomationException - If the ArcObject component throws an exception.

deactivate

public void deactivate()
                throws java.io.IOException,
                       AutomationException

Deactivates the view.

Specified by:

deactivate in interface IGxView

Throws:

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

AutomationException - If the ArcObject component throws an exception.

refresh

public void refresh()
             throws java.io.IOException,
                    AutomationException

Refreshes the view.

Specified by:

refresh in interface IGxView

Throws:

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

AutomationException - If the ArcObject component throws an exception.

systemSettingChanged

public void systemSettingChanged(int flag,
                                 java.lang.String section)
                          throws java.io.IOException,
                                 AutomationException

Informs the view that a system setting has changed.

Specified by:

systemSettingChanged in interface IGxView

Parameters:

flag - The flag (in)

section - The section (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws java.io.IOException,
                    AutomationException

isDirty

Specified by:

isDirty in interface IPersistStream

Throws:

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

AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws java.io.IOException,
                 AutomationException

load

Specified by:

load in interface IPersistStream

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

save

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

save

Specified by:

save in interface IPersistStream

Parameters:

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

fClearDirty - The fClearDirty (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSizeMax

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

getSizeMax

Specified by:

getSizeMax in interface IPersistStream

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getClassID

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

getClassID

Specified by:

getClassID in interface IPersist

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException

Specified by:

writeExternal in interface java.io.Externalizable

Throws:

java.io.IOException

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException

Specified by:

readExternal in interface java.io.Externalizable

Throws:

java.io.IOException

java.lang.ClassNotFoundException