com.esri.arcgis.catalogUI
Interface IGxApplication

All Superinterfaces:
java.io.Serializable
All Known Implementing Classes:
Application, Application, Application, Application, IGxApplicationProxy

public interface IGxApplication
extends java.io.Serializable

COM Interface 'IGxApplication'. Generated 3/19/2015 1:21:01 PM from 'C:\ArcGIS\COM\esriCatalogUI.olb'

Description: 'Provides access to members that control the Gx Application object.' 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 =


Field Summary
static java.lang.String IID
          Deprecated. Internal use only
static int IIDd1bf6a01_7a1c_11d0_b77d_00805f7ced21
           
static int xxDummy
          Deprecated. Internal use only
 
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(java.lang.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(java.lang.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.
 

Field Detail

IIDd1bf6a01_7a1c_11d0_b77d_00805f7ced21

static final int IIDd1bf6a01_7a1c_11d0_b77d_00805f7ced21
See Also:
Constant Field Values

xxDummy

static final int xxDummy
Deprecated. Internal use only
See Also:
Constant Field Values

IID

static final java.lang.String IID
Deprecated. Internal use only
See Also:
Constant Field Values
Method Detail

getCatalog

IGxCatalog getCatalog()
                      throws java.io.IOException,
                             AutomationException
The current catalog.

Returns:
A reference to a com.esri.arcgis.catalog.IGxCatalog
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getView

IGxView getView()
                throws java.io.IOException,
                       AutomationException
The current view.

Returns:
A reference to a com.esri.arcgis.catalogUI.IGxView
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getViewClassID

IUID getViewClassID()
                    throws java.io.IOException,
                           AutomationException
The current view's class ID.

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.

setViewClassID

void setViewClassID(IUID viewClassID)
                    throws java.io.IOException,
                           AutomationException
The current view's class ID.

Parameters:
viewClassID - A reference to a com.esri.arcgis.system.IUID (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTreeView

IGxTreeView getTreeView()
                        throws java.io.IOException,
                               AutomationException
The tree view.

Returns:
A reference to a com.esri.arcgis.catalogUI.IGxTreeView
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSelection

IGxSelection getSelection()
                          throws java.io.IOException,
                                 AutomationException
The selection of application.

Returns:
A reference to a com.esri.arcgis.catalog.IGxSelection
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSelectedObject

IGxObject getSelectedObject()
                            throws java.io.IOException,
                                   AutomationException
The first selected object, or the location if no objects are selected.

Returns:
A reference to a com.esri.arcgis.catalog.IGxObject
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setLocation

void setLocation(java.lang.String rhs1)
                 throws java.io.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.

Parameters:
rhs1 - The rhs1 (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

refresh

void refresh(java.lang.String startingPath)
             throws java.io.IOException,
                    AutomationException
Refreshes the catalog tree starting at the specified path. If startingPath is 0 or the empty string, the entire catalog is refreshed.

Parameters:
startingPath - The startingPath (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

showContextMenu

void showContextMenu(int x,
                     int y)
                     throws java.io.IOException,
                            AutomationException
Displays a context menu for the current selection.

Parameters:
x - The x (in)
y - The y (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

expandSelection

void expandSelection()
                     throws java.io.IOException,
                            AutomationException
Expands the current selection.

Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isCanDeleteSelection

boolean isCanDeleteSelection()
                             throws java.io.IOException,
                                    AutomationException
Indicates if the current selection can be deleted.

Returns:
The pEnabled
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

deleteSelection

void deleteSelection()
                     throws java.io.IOException,
                            AutomationException
Deletes the current selection.

Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isCanRenameSelection

boolean isCanRenameSelection()
                             throws java.io.IOException,
                                    AutomationException
Indicates if the current selection can be renamed.

Returns:
The pEnabled
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

renameSelection

void renameSelection()
                     throws java.io.IOException,
                            AutomationException
Renames the current selection.

Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAreaOfInterest

IEnvelope getAreaOfInterest()
                            throws java.io.IOException,
                                   AutomationException
The default area of interest for the application.

Returns:
A reference to a com.esri.arcgis.geometry.IEnvelope
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAreaOfInterest

void setAreaOfInterest(IEnvelope aoi)
                       throws java.io.IOException,
                              AutomationException
The default area of interest for the application.

Parameters:
aoi - A reference to a com.esri.arcgis.geometry.IEnvelope (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.