com.esri.arcgis.catalogUI
Class IGxApplicationProxy

java.lang.Object
  com.esri.arcgis.interop.Dispatch
      com.esri.arcgis.catalogUI.IGxApplicationProxy

All Implemented Interfaces:

IGxApplication, Externalizable, Serializable

public class IGxApplicationProxy
extends com.esri.arcgis.interop.Dispatch
implements IGxApplication, Serializable

Provides access to members that control the Gx Application object.

Description

The IGxApplication interface is unique to ArcCatalog and is used to control certain aspects of its behavior. For example, through the IGxApplication interface, you can delete or expand the current selection (through DeleteSelection and ExpandSelection) or force a refresh of a certain part of the Catalog tree (through Refresh). You can also get hold of the currently selected object(s) through the Selection and SelectedObject properties.

The Catalog property returns the GxCatalog object, which represents the root of the Catalog data tree. From there, you can use IGxObjectContainer::Children to enumerate through the Catalog’s descendants.

The TreeView property gives you access to ArcCatalog’s tree view. From this GxTreeView, you can ensure that a certain descendant is visible or initiate a renaming operation.

The View property gives you access to the active GxView, whatever it happens to be. It might be one of the built-in views—for example, GxContentsView, GxPreview, or GxMetadataView—or it might be a developer- added one. From here, you can manipulate the active view in whatever fashion is native to it.

Product Availability

Available with ArcGIS Desktop.

See Also:

com.esri.arcgis.gx.Application, Serialized Form

Field Summary

boolean

noncastable

Fields inherited from class com.esri.arcgis.interop.Dispatch

DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, objRef

Constructor Summary

	IGxApplicationProxy()
	IGxApplicationProxy(Object obj)
protected	IGxApplicationProxy(Object obj, String iid)

Method Summary

void	addListener(String iidStr, Object theListener, Object theSource)
void	deleteSelection() Deletes the current selection.
void	expandSelection() Expands the current selection.
IEnvelope	getAreaOfInterest() The default area of interest for the application.
IGxCatalog	getCatalog() The current catalog.
IGxObject	getSelectedObject() The first selected object, or the location if no objects are selected.
IGxSelection	getSelection() The selection of application.
IGxTreeView	getTreeView() The tree view.
IGxView	getView() The current view.
IUID	getViewClassID() The current view's class ID.
boolean	isCanDeleteSelection() Indicates if the current selection can be deleted.
boolean	isCanRenameSelection() Indicates if the current selection can be renamed.
void	refresh(String startingPath) Refreshes the catalog tree starting at the specified path.
void	removeListener(String iidStr, Object theListener)
void	renameSelection() Renames the current selection.
void	setAreaOfInterest(IEnvelope aoi) The default area of interest for the application.
void	setLocation(String rhs1) The location to the specified path.
void	setViewClassID(IUID viewClassID) The current view's class ID.
void	showContextMenu(int x, int y) Displays a context menu for the current selection.

Methods inherited from class com.esri.arcgis.interop.Dispatch

bindUsingMoniker, constructVtblPosTable, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, getVtblPos, hashCode, initDispatch, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, optimizedVtblInvoke, queryInterface, readExternal, release, setNativeMode, setPropertyByName, toString, vtblInvoke, writeExternal

Methods inherited from class java.lang.Object

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

Field Detail

noncastable

public boolean noncastable

Constructor Detail

IGxApplicationProxy

public IGxApplicationProxy()

IGxApplicationProxy

public IGxApplicationProxy(Object obj)
                    throws IOException

Throws:

IOException

IGxApplicationProxy

protected IGxApplicationProxy(Object obj,
                              String iid)
                       throws IOException

Throws:

IOException

Method Detail

addListener

public void addListener(String iidStr,
                        Object theListener,
                        Object theSource)
                 throws IOException

Overrides:

addListener in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

removeListener

public void removeListener(String iidStr,
                           Object theListener)
                    throws IOException

Overrides:

removeListener in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

getCatalog

public IGxCatalog getCatalog()
                      throws IOException,
                             AutomationException

The current catalog.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getCatalog in interface IGxApplication

Returns:

A reference to a com.esri.arcgis.catalog.IGxCatalog

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 IGxApplication

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 current view's class ID.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getViewClassID in interface IGxApplication

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 current view's class ID.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setViewClassID in interface IGxApplication

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.

getTreeView

public IGxTreeView getTreeView()
                        throws IOException,
                               AutomationException

The tree view.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getTreeView in interface IGxApplication

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSelection

public IGxSelection getSelection()
                          throws IOException,
                                 AutomationException

The selection of application.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getSelection in interface IGxApplication

Returns:

A reference to a com.esri.arcgis.catalog.IGxSelection

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSelectedObject

public IGxObject getSelectedObject()
                            throws IOException,
                                   AutomationException

The first selected object, or the location if no objects are selected.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getSelectedObject in interface IGxApplication

Returns:

A reference to a com.esri.arcgis.catalog.IGxObject

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLocation

public void setLocation(String rhs1)
                 throws IOException,
                        AutomationException

The location to the specified path. If the path isn't yet part of the catalog, it is added as a folder connection.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setLocation in interface IGxApplication

Parameters:

rhs1 - The rhs1 (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

refresh

public void refresh(String startingPath)
             throws IOException,
                    AutomationException

Refreshes the catalog tree starting at the specified path. If startingPath is 0 or the empty string, the entire catalog is refreshed.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

refresh in interface IGxApplication

Parameters:

startingPath - The startingPath (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

showContextMenu

public void showContextMenu(int x,
                            int y)
                     throws IOException,
                            AutomationException

Displays a context menu for the current selection.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

showContextMenu in interface IGxApplication

Parameters:

x - The x (in)

y - The y (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

expandSelection

public void expandSelection()
                     throws IOException,
                            AutomationException

Expands the current selection.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

expandSelection in interface IGxApplication

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isCanDeleteSelection

public boolean isCanDeleteSelection()
                             throws IOException,
                                    AutomationException

Indicates if the current selection can be deleted.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

isCanDeleteSelection in interface IGxApplication

Returns:

The pEnabled

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

deleteSelection

public void deleteSelection()
                     throws IOException,
                            AutomationException

Deletes the current selection.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

deleteSelection in interface IGxApplication

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isCanRenameSelection

public boolean isCanRenameSelection()
                             throws IOException,
                                    AutomationException

Indicates if the current selection can be renamed.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

isCanRenameSelection in interface IGxApplication

Returns:

The pEnabled

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

renameSelection

public void renameSelection()
                     throws IOException,
                            AutomationException

Renames the current selection.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

renameSelection in interface IGxApplication

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAreaOfInterest

public IEnvelope getAreaOfInterest()
                            throws IOException,
                                   AutomationException

The default area of interest for the application.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getAreaOfInterest in interface IGxApplication

Returns:

A reference to a com.esri.arcgis.geometry.IEnvelope

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAreaOfInterest

public void setAreaOfInterest(IEnvelope aoi)
                       throws IOException,
                              AutomationException

The default area of interest for the application.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setAreaOfInterest in interface IGxApplication

Parameters:

aoi - A reference to a com.esri.arcgis.geometry.IEnvelope (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.