com.esri.arcgis.catalogUI
Interface IGxApplication

All Superinterfaces:

Serializable

All Known Implementing Classes:

Application, Application, Application, Application, IGxApplicationProxy

public interface IGxApplication
extends 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

Method Summary

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

Method Detail

getCatalog

IGxCatalog getCatalog()
                      throws IOException,
                             AutomationException

The current catalog.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

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

IGxView getView()
                throws IOException,
                       AutomationException

The current view.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

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

IUID getViewClassID()
                    throws IOException,
                           AutomationException

The current view's class ID.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

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

void setViewClassID(IUID viewClassID)
                    throws IOException,
                           AutomationException

The current view's class ID.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

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

IGxTreeView getTreeView()
                        throws IOException,
                               AutomationException

The tree view.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

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

IGxSelection getSelection()
                          throws IOException,
                                 AutomationException

The selection of application.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

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

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

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

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

Parameters:

rhs1 - The rhs1 (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

refresh

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

Parameters:

startingPath - The startingPath (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

showContextMenu

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

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

void expandSelection()
                     throws IOException,
                            AutomationException

Expands the current selection.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isCanDeleteSelection

boolean isCanDeleteSelection()
                             throws IOException,
                                    AutomationException

Indicates if the current selection can be deleted.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

The pEnabled

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

deleteSelection

void deleteSelection()
                     throws IOException,
                            AutomationException

Deletes the current selection.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isCanRenameSelection

boolean isCanRenameSelection()
                             throws IOException,
                                    AutomationException

Indicates if the current selection can be renamed.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

The pEnabled

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

renameSelection

void renameSelection()
                     throws IOException,
                            AutomationException

Renames the current selection.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAreaOfInterest

IEnvelope getAreaOfInterest()
                            throws IOException,
                                   AutomationException

The default area of interest for the application.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

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

void setAreaOfInterest(IEnvelope aoi)
                       throws IOException,
                              AutomationException

The default area of interest for the application.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

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.