com.esri.arcgis.arcmap
Class Application

java.lang.Object
  com.esri.arcgis.arcmap.Application

All Implemented Interfaces:

IApplicationWindows, IEnumPrinterNames, IMxApplication, IMxApplication2, IGxCatalogDefaultDatabase, IGxCatalogWorkspace, IGxApplication, IApplication, IApplicationStatus, IDockableWindowManager, IMultiThreadedApplication, IObjectFactory, IVbaApplication, IWindowPosition, com.esri.arcgis.interop.RemoteObjRef, IExtensionManager, java.io.Serializable

public class Application
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IApplication, IMxApplication, IMxApplication2, IVbaApplication, IExtensionManager, IEnumPrinterNames, IApplicationWindows, IMultiThreadedApplication, IDockableWindowManager, IWindowPosition, IObjectFactory, IApplicationStatus, IGxApplication, IGxCatalogWorkspace, IGxCatalogDefaultDatabase

COM Class 'Application'. Generated 3/19/2015 1:20:50 PM from 'C:\ArcGIS\COM\esriArcMap.olb'

Description 'Esri ArcMap Application' 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

Fields inherited from interface com.esri.arcgis.framework.IApplication

DISPID_1610743808_GET_NAME, DISPID_1610743809_GET_NAME, DISPID_1610743810_GET_NAME, DISPID_1610743811_NAME, DISPID_1610743812_NAME, DISPID_1610743813_GET_NAME, DISPID_1610743813_PUTREF_NAME, DISPID_1610743815_GET_NAME, DISPID_1610743816_NAME, DISPID_1610743817_NAME, DISPID_1610743818_NAME, DISPID_1610743819_NAME, DISPID_1610743820_NAME, DISPID_1610743821_NAME, DISPID_1610743822_NAME, DISPID_1610743823_NAME, DISPID_1610743824_NAME, DISPID_1610743825_GET_NAME, DISPID_1610743826_GET_NAME, DISPID_1610743827_NAME, DISPID_1610743828_NAME, DISPID_1610743829_NAME, DISPID_1610743830_GET_NAME, DISPID_1610743830_PUT_NAME, DISPID_1610743832_GET_NAME, DISPID_1610743832_PUT_NAME, IID, IID8e52b9a5_307b_11d2_94c9_080009eebecb, xxDummy

Fields inherited from interface com.esri.arcgis.arcmapui.IMxApplication

IID, IID0522a5f2_487c_11d0_98bd_00805f7ced21, xxDummy

Fields inherited from interface com.esri.arcgis.arcmapui.IMxApplication2

IID, IID0522a5f3_487c_11d0_98bd_00805f7ced21, xxDummy

Fields inherited from interface com.esri.arcgis.framework.IVbaApplication

IID, IIDd7ee3483_004d_11d4_9fe7_00c04f6bc78e, xxDummy

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

IID, IID05c71634_d9d5_4d6f_b68e_d7661142fa06, xxDummy

Fields inherited from interface com.esri.arcgis.arcmapui.IEnumPrinterNames

IID, IID1c79daed_c3da_4954_a7d2_330cef0bd4b1, xxDummy

Fields inherited from interface com.esri.arcgis.arcmapui.IApplicationWindows

IID, IID01030199_17ac_11d4_9fed_00c04f6bc78e, xxDummy

Fields inherited from interface com.esri.arcgis.framework.IMultiThreadedApplication

IID, IID34709a45_8e39_4397_a0cf_63963e5f52e4, xxDummy

Fields inherited from interface com.esri.arcgis.framework.IDockableWindowManager

IID, IID3ee6d0c2_e3f2_11d3_a679_0008c7df97b9, xxDummy

Fields inherited from interface com.esri.arcgis.framework.IWindowPosition

IID, IID88c995ae_64a7_43f5_bf12_88ac179b25a6, xxDummy

Fields inherited from interface com.esri.arcgis.framework.IObjectFactory

IID, IID60a1409b_9b67_431b_b428_e2c17be36e9a, xxDummy

Fields inherited from interface com.esri.arcgis.framework.IApplicationStatus

IID, IID0573d2f5_a2a0_4ef6_bdf7_416097472c8d, xxDummy

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

IID, IIDd1bf6a01_7a1c_11d0_b77d_00805f7ced21, xxDummy

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

IID, IID9585bc1b_3477_48f7_9f28_c1ed484ad498, xxDummy

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

IID, IIDf154fd7b_c485_47d2_810a_2792e41f225d, xxDummy

Constructor Summary

Application()
Constructs a Application using ArcGIS Engine.

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

Method Summary

void	addIApplicationStatusEventsListener(IApplicationStatusEvents theListener) addIApplicationStatusEventsListener.
void	copyToClipboard() Copies the current view to the clipboard.
java.lang.Object	create(java.lang.Object objectID) Creates an instance of an object identified by objectID.
void	createCodeModule(java.lang.String docName, java.lang.String moduleName) Creates a code module in the specified VBA project.
void	deleteSelection() Deletes the current selection.
boolean	equals(java.lang.Object o) Compare this object with another
void	expandSelection() Expands the current selection.
void	export() Exports the current document.
IExtension	findExtension(java.lang.Object nameOrID) Finds the extension by CLSID (IUID) or name (String).
IExtension	findExtensionByCLSID(IUID extensionCLSID) Finds an extension by its CLSID.
IExtension	findExtensionByName(java.lang.String extensionName) Finds an extension by its name.
IEnvelope	getAreaOfInterest() The default area of interest for the application.
java.lang.String	getCaption() The caption of this application.
IGxCatalog	getCatalog() The current catalog.
static java.lang.String	getClsid() getClsid.
ICommandItem	getCurrentTool() The currently selected tool.
ISet	getDataWindows() The data windows in the application.
IWorkspaceName	getDefaultDatabaseName() The default geodatabase.
IWorkspaceName	getDefaultDatabaseNameNoValidate() The default geodatabase.
IAppDisplay	getDisplay() The application display.
IDockableWindow	getDockableWindow(IUID dockWnd) Finds a dockable window looking first in the collection and then in the category.
IDocument	getDocument() The document that is currently loaded in the application.
IExtension	getExtension(int index) The extension at the specified index.
IUID	getExtensionCLSID(int index) The CLSID of the extension at the specified index.
int	getExtensionCount() The number of extensions loaded in the application.
int	getHeight() The height of the window.
int	getHWnd() The handle of the application's window.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
int	getLeft() The distance between the internal left edge of the window and screen.
java.lang.String	getName() The name of this application.
IPaper	getPaper() The current paper settings.
IPrinter	getPrinter() The current printer settings.
int	getProcessID() The process ID for the application.
IGxObject	getSelectedObject() The first selected object, or the location if no objects are selected.
IGxSelection	getSelection() The selection of application.
ISelectionEnvironment	getSelectionEnvironment() The selection environment.
int	getState() The state of the window.
IStatusBar	getStatusBar() The statusbar of this application.
ITemplates	getTemplates() The templates collection.
int	getTop() The distance between the internal top edge of the window and screen.
IGxTreeView	getTreeView() The tree view.
java.lang.Object	getVBE() The Visual Basic Environment.
IGxView	getView() The current view.
IUID	getViewClassID() The current view's class ID.
int	getWidth() The width of the window.
java.lang.String	getWorkspaceFolderPath() The workspace path.
int	hashCode() the hashcode for this object
void	insertCode(java.lang.String docName, java.lang.String moduleName, java.lang.String codeText) Inserts code into the specified module.
boolean	isCanDeleteSelection() Indicates if the current selection can be deleted.
boolean	isCanRenameSelection() Indicates if the current selection can be renamed.
boolean	isDialogVisible(int dialogID) Indicates if the specified dialog is visible in the application.
boolean	isInitialized() Is the application initialized.
boolean	isPauseDrawing() Pause display updates.
boolean	isUseWorkspaceFolder() Indicates if the catalog uses a workspace folder as a home folder.
boolean	isVisible() Indicates if the application window is visible.
void	lockCustomization(java.lang.String password, ICustomizationFilter custFilter) Locks the application's user interface against any customizations.
void	move(int left, int top, int width, int height) Moves and optionally resizes the windows in a single function.
void	newDocument(boolean selectTemplate, java.lang.String templatePath) Creates a new document in this application.
java.lang.String	next() The next Printer Name.
void	openDocument(java.lang.String path) Opens a document in this application.
void	openWorkspaceFolder(java.lang.String workspaceFolderPath) Opens the document catalog.
void	printDocument() Displays the Print dialog.
void	printPreview() Displays how the document will look like when it is printed.
void	refresh(java.lang.String startingPath) Refreshes the catalog tree starting at the specified path.
void	refreshWindow() Redraws the application window.
int	registerThreadManager(IDllThreadManager pThreadMgr) Registers a DLL thread manager with the application.
void	release() Release a Application.
void	removeCodeModule(java.lang.String docName, java.lang.String moduleName) Removes a code module from the specified VBA project.
void	removeIApplicationStatusEventsListener(IApplicationStatusEvents theListener) removeIApplicationStatusEventsListener.
void	renameSelection() Renames the current selection.
void	reset() Reset the Enumeration to the beginning.
java.lang.Object	runVBAMacro(java.lang.String docName, java.lang.String moduleName, java.lang.String macroName, java.lang.Object arguments) Runs the specified VBA macro.
void	saveAsDocument(java.lang.String saveAsPath, boolean saveAsCopy) Saves the document that is currently open in this application to a different file.
void	saveDocument(java.lang.String saveAsPath) Saves the document that is currently open in this application.
void	setAreaOfInterest(IEnvelope aoi) The default area of interest for the application.
void	setCaption(java.lang.String caption) The caption of this application.
void	setCurrentToolByRef(ICommandItem tool) The currently selected tool.
void	setDefaultDatabaseName(IWorkspaceName ppWorkspaceName) The default geodatabase.
void	setDefaultDatabaseNameNoValidate(IWorkspaceName ppWorkspaceName) The default geodatabase.
void	setHeight(int height) The height of the window.
void	setLeft(int left) The distance between the internal left edge of the window and screen.
void	setLocation(java.lang.String rhs1) The location to the specified path.
void	setPauseDrawing(boolean flag) Pause display updates.
void	setPrinterByRef(IPrinter printer) The current printer settings.
void	setState(int windowState) The state of the window.
void	setTop(int top) The distance between the internal top edge of the window and screen.
void	setUseWorkspaceFolder(boolean bUseWorkspaceFolder) Indicates if the catalog uses a workspace folder as a home folder.
void	setViewClassID(IUID viewClassID) The current view's class ID.
void	setVisible(boolean visible) Indicates if the application window is visible.
void	setWidth(int width) The width of the window.
void	showContextMenu(int x, int y) Displays a context menu for the current selection.
java.lang.Object	showDialog(int dialogID, java.lang.Object bShow) Displays the specified dialog in the application.
void	shutdown() Terminates the application.
void	unlockCustomization(java.lang.String password) Unlocks previous user interface customization lock.
void	unregisterThreadManager(int mgrCookie) Unregisters a DLL thread manager with the application.

Methods inherited from class java.lang.Object

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

Constructor Detail

Application

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

Constructs a Application using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

Application

public Application(java.lang.Object obj)
            throws java.io.IOException

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

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

java.io.IOException - if there are interop problems Application theApplication = (Application) 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

addIApplicationStatusEventsListener

public void addIApplicationStatusEventsListener(IApplicationStatusEvents theListener)
                                         throws java.io.IOException

addIApplicationStatusEventsListener. Listen to events generated by this class.

Parameters:

theListener - An object that implements the com.esri.arcgis.framework.IApplicationStatusEvents interface.

Throws:

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

removeIApplicationStatusEventsListener

public void removeIApplicationStatusEventsListener(IApplicationStatusEvents theListener)
                                            throws java.io.IOException

removeIApplicationStatusEventsListener. Stop listening to events generated by this class.

Parameters:

theListener - An object that implements the com.esri.arcgis.framework.IApplicationStatusEvents interface.

Throws:

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

release

public void release()

Release a Application.

Specified by:

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

getName

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

The name of this application.

Specified by:

getName in interface IApplication

Returns:

The name

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDocument

public IDocument getDocument()
                      throws java.io.IOException,
                             AutomationException

The document that is currently loaded in the application.

Specified by:

getDocument in interface IApplication

Returns:

A reference to a com.esri.arcgis.framework.IDocument

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getStatusBar

public IStatusBar getStatusBar()
                        throws java.io.IOException,
                               AutomationException

The statusbar of this application.

Specified by:

getStatusBar in interface IApplication

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

showDialog

public java.lang.Object showDialog(int dialogID,
                                   java.lang.Object bShow)
                            throws java.io.IOException,
                                   AutomationException

Displays the specified dialog in the application.

Specified by:

showDialog in interface IApplication

Parameters:

dialogID - The dialogID (in)

bShow - A Variant (in, optional, pass null if not required)

Returns:

A Variant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isDialogVisible

public boolean isDialogVisible(int dialogID)
                        throws java.io.IOException,
                               AutomationException

Indicates if the specified dialog is visible in the application.

Specified by:

isDialogVisible in interface IApplication

Parameters:

dialogID - The dialogID (in)

Returns:

The bVisible

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCurrentTool

public ICommandItem getCurrentTool()
                            throws java.io.IOException,
                                   AutomationException

The currently selected tool.

Specified by:

getCurrentTool in interface IApplication

Returns:

A reference to a com.esri.arcgis.framework.ICommandItem

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setCurrentToolByRef

public void setCurrentToolByRef(ICommandItem tool)
                         throws java.io.IOException,
                                AutomationException

The currently selected tool.

Specified by:

setCurrentToolByRef in interface IApplication

Parameters:

tool - A reference to a com.esri.arcgis.framework.ICommandItem (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getVBE

public java.lang.Object getVBE()
                        throws java.io.IOException,
                               AutomationException

The Visual Basic Environment.

Specified by:

getVBE in interface IApplication

Returns:

A reference to another Automation Object (IDispatch)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

newDocument

public void newDocument(boolean selectTemplate,
                        java.lang.String templatePath)
                 throws java.io.IOException,
                        AutomationException

Creates a new document in this application.

Specified by:

newDocument in interface IApplication

Parameters:

selectTemplate - The selectTemplate (in, optional, pass false if not required)

templatePath - The templatePath (in, optional, pass null if not required)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

openDocument

public void openDocument(java.lang.String path)
                  throws java.io.IOException,
                         AutomationException

Opens a document in this application.

Specified by:

openDocument in interface IApplication

Parameters:

path - The path (in, optional, pass null if not required)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

saveDocument

public void saveDocument(java.lang.String saveAsPath)
                  throws java.io.IOException,
                         AutomationException

Saves the document that is currently open in this application.

Specified by:

saveDocument in interface IApplication

Parameters:

saveAsPath - The saveAsPath (in, optional, pass null if not required)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

saveAsDocument

public void saveAsDocument(java.lang.String saveAsPath,
                           boolean saveAsCopy)
                    throws java.io.IOException,
                           AutomationException

Saves the document that is currently open in this application to a different file.

Specified by:

saveAsDocument in interface IApplication

Parameters:

saveAsPath - The saveAsPath (in, optional, pass null if not required)

saveAsCopy - The saveAsCopy (in, optional, pass false if not required)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

printPreview

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

Displays how the document will look like when it is printed.

Specified by:

printPreview in interface IApplication

Throws:

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

AutomationException - If the ArcObject component throws an exception.

printDocument

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

Displays the Print dialog.

Specified by:

printDocument in interface IApplication

Throws:

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

AutomationException - If the ArcObject component throws an exception.

lockCustomization

public void lockCustomization(java.lang.String password,
                              ICustomizationFilter custFilter)
                       throws java.io.IOException,
                              AutomationException

Locks the application's user interface against any customizations.

Specified by:

lockCustomization in interface IApplication

Parameters:

password - The password (in)

custFilter - A reference to a com.esri.arcgis.framework.ICustomizationFilter (in, optional, pass null if not required)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

unlockCustomization

public void unlockCustomization(java.lang.String password)
                         throws java.io.IOException,
                                AutomationException

Unlocks previous user interface customization lock.

Specified by:

unlockCustomization in interface IApplication

Parameters:

password - The password (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

refreshWindow

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

Redraws the application window.

Specified by:

refreshWindow in interface IApplication

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTemplates

public ITemplates getTemplates()
                        throws java.io.IOException,
                               AutomationException

The templates collection.

Specified by:

getTemplates in interface IApplication

Returns:

A reference to a com.esri.arcgis.framework.ITemplates

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 handle of the application's window.

Specified by:

getHWnd in interface IApplication

Returns:

The hWnd (A COM typedef)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

findExtensionByName

public IExtension findExtensionByName(java.lang.String extensionName)
                               throws java.io.IOException,
                                      AutomationException

Finds an extension by its name.

Specified by:

findExtensionByName in interface IApplication

Parameters:

extensionName - The extensionName (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

findExtensionByCLSID

public IExtension findExtensionByCLSID(IUID extensionCLSID)
                                throws java.io.IOException,
                                       AutomationException

Finds an extension by its CLSID.

Specified by:

findExtensionByCLSID in interface IApplication

Parameters:

extensionCLSID - A reference to a com.esri.arcgis.system.IUID (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

shutdown

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

Terminates the application.

Specified by:

shutdown in interface IApplication

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isVisible

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

Indicates if the application window is visible.

Specified by:

isVisible in interface IApplication

Returns:

The visible

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setVisible

public void setVisible(boolean visible)
                throws java.io.IOException,
                       AutomationException

Indicates if the application window is visible.

Specified by:

setVisible in interface IApplication

Parameters:

visible - The visible (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setCaption

public void setCaption(java.lang.String caption)
                throws java.io.IOException,
                       AutomationException

The caption of this application.

Specified by:

setCaption in interface IApplication

Parameters:

caption - The caption (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCaption

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

The caption of this application.

Specified by:

getCaption in interface IApplication

Returns:

The caption

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setPrinterByRef

public void setPrinterByRef(IPrinter printer)
                     throws java.io.IOException,
                            AutomationException

The current printer settings.

Specified by:

setPrinterByRef in interface IMxApplication

Specified by:

setPrinterByRef in interface IMxApplication2

Parameters:

printer - A reference to a com.esri.arcgis.output.IPrinter (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getPrinter

public IPrinter getPrinter()
                    throws java.io.IOException,
                           AutomationException

The current printer settings.

Specified by:

getPrinter in interface IMxApplication

Specified by:

getPrinter in interface IMxApplication2

Returns:

A reference to a com.esri.arcgis.output.IPrinter

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getPaper

public IPaper getPaper()
                throws java.io.IOException,
                       AutomationException

The current paper settings.

Specified by:

getPaper in interface IMxApplication

Specified by:

getPaper in interface IMxApplication2

Returns:

A reference to a com.esri.arcgis.output.IPaper

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDisplay

public IAppDisplay getDisplay()
                       throws java.io.IOException,
                              AutomationException

The application display.

Specified by:

getDisplay in interface IMxApplication

Specified by:

getDisplay in interface IMxApplication2

Returns:

A reference to a com.esri.arcgis.display.IAppDisplay

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSelectionEnvironment

public ISelectionEnvironment getSelectionEnvironment()
                                              throws java.io.IOException,
                                                     AutomationException

The selection environment.

Specified by:

getSelectionEnvironment in interface IMxApplication

Specified by:

getSelectionEnvironment in interface IMxApplication2

Returns:

A reference to a com.esri.arcgis.carto.ISelectionEnvironment

Throws:

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

AutomationException - If the ArcObject component throws an exception.

export

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

Exports the current document.

Specified by:

export in interface IMxApplication

Specified by:

export in interface IMxApplication2

Throws:

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

AutomationException - If the ArcObject component throws an exception.

copyToClipboard

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

Copies the current view to the clipboard.

Specified by:

copyToClipboard in interface IMxApplication

Specified by:

copyToClipboard in interface IMxApplication2

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setPauseDrawing

public void setPauseDrawing(boolean flag)
                     throws java.io.IOException,
                            AutomationException

Pause display updates.

Specified by:

setPauseDrawing in interface IMxApplication2

Parameters:

flag - The flag (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isPauseDrawing

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

Pause display updates.

Specified by:

isPauseDrawing in interface IMxApplication2

Returns:

The flag

Throws:

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

AutomationException - If the ArcObject component throws an exception.

runVBAMacro

public java.lang.Object runVBAMacro(java.lang.String docName,
                                    java.lang.String moduleName,
                                    java.lang.String macroName,
                                    java.lang.Object arguments)
                             throws java.io.IOException,
                                    AutomationException

Runs the specified VBA macro.

Specified by:

runVBAMacro in interface IVbaApplication

Parameters:

docName - The docName (in)

moduleName - The moduleName (in)

macroName - The macroName (in)

arguments - A Variant (in)

Returns:

A Variant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

createCodeModule

public void createCodeModule(java.lang.String docName,
                             java.lang.String moduleName)
                      throws java.io.IOException,
                             AutomationException

Creates a code module in the specified VBA project.

Specified by:

createCodeModule in interface IVbaApplication

Parameters:

docName - The docName (in)

moduleName - The moduleName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

removeCodeModule

public void removeCodeModule(java.lang.String docName,
                             java.lang.String moduleName)
                      throws java.io.IOException,
                             AutomationException

Removes a code module from the specified VBA project.

Specified by:

removeCodeModule in interface IVbaApplication

Parameters:

docName - The docName (in)

moduleName - The moduleName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

insertCode

public void insertCode(java.lang.String docName,
                       java.lang.String moduleName,
                       java.lang.String codeText)
                throws java.io.IOException,
                       AutomationException

Inserts code into the specified module.

Specified by:

insertCode in interface IVbaApplication

Parameters:

docName - The docName (in)

moduleName - The moduleName (in)

codeText - The codeText (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getExtensionCount

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

The number of extensions loaded in the application.

Specified by:

getExtensionCount in interface IExtensionManager

Returns:

The count

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getExtension

public IExtension getExtension(int index)
                        throws java.io.IOException,
                               AutomationException

The extension at the specified index.

Specified by:

getExtension in interface IExtensionManager

Parameters:

index - The index (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getExtensionCLSID

public IUID getExtensionCLSID(int index)
                       throws java.io.IOException,
                              AutomationException

The CLSID of the extension at the specified index.

Specified by:

getExtensionCLSID in interface IExtensionManager

Parameters:

index - The index (in)

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.

findExtension

public IExtension findExtension(java.lang.Object nameOrID)
                         throws java.io.IOException,
                                AutomationException

Finds the extension by CLSID (IUID) or name (String).

Specified by:

findExtension in interface IExtensionManager

Parameters:

nameOrID - A Variant (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

reset

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

Reset the Enumeration to the beginning.

Specified by:

reset in interface IEnumPrinterNames

Throws:

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

AutomationException - If the ArcObject component throws an exception.

next

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

The next Printer Name.

Specified by:

next in interface IEnumPrinterNames

Returns:

The printerName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDataWindows

public ISet getDataWindows()
                    throws java.io.IOException,
                           AutomationException

The data windows in the application.

Specified by:

getDataWindows in interface IApplicationWindows

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getProcessID

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

The process ID for the application.

Specified by:

getProcessID in interface IMultiThreadedApplication

Returns:

The pid

Throws:

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

AutomationException - If the ArcObject component throws an exception.

registerThreadManager

public int registerThreadManager(IDllThreadManager pThreadMgr)
                          throws java.io.IOException,
                                 AutomationException

Registers a DLL thread manager with the application.

Specified by:

registerThreadManager in interface IMultiThreadedApplication

Parameters:

pThreadMgr - A reference to a com.esri.arcgis.framework.IDllThreadManager (in)

Returns:

The mgrCookie

Throws:

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

AutomationException - If the ArcObject component throws an exception.

unregisterThreadManager

public void unregisterThreadManager(int mgrCookie)
                             throws java.io.IOException,
                                    AutomationException

Unregisters a DLL thread manager with the application.

Specified by:

unregisterThreadManager in interface IMultiThreadedApplication

Parameters:

mgrCookie - The mgrCookie (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDockableWindow

public IDockableWindow getDockableWindow(IUID dockWnd)
                                  throws java.io.IOException,
                                         AutomationException

Finds a dockable window looking first in the collection and then in the category.

Specified by:

getDockableWindow in interface IDockableWindowManager

Parameters:

dockWnd - A reference to a com.esri.arcgis.system.IUID (in)

Returns:

A reference to a com.esri.arcgis.framework.IDockableWindow

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setLeft

public void setLeft(int left)
             throws java.io.IOException,
                    AutomationException

The distance between the internal left edge of the window and screen.

Specified by:

setLeft in interface IWindowPosition

Parameters:

left - The left (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLeft

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

The distance between the internal left edge of the window and screen.

Specified by:

getLeft in interface IWindowPosition

Returns:

The left

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setTop

public void setTop(int top)
            throws java.io.IOException,
                   AutomationException

The distance between the internal top edge of the window and screen.

Specified by:

setTop in interface IWindowPosition

Parameters:

top - The top (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTop

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

The distance between the internal top edge of the window and screen.

Specified by:

getTop in interface IWindowPosition

Returns:

The top

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setWidth

public void setWidth(int width)
              throws java.io.IOException,
                     AutomationException

The width of the window.

Specified by:

setWidth in interface IWindowPosition

Parameters:

width - The width (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getWidth

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

The width of the window.

Specified by:

getWidth in interface IWindowPosition

Returns:

The width

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setHeight

public void setHeight(int height)
               throws java.io.IOException,
                      AutomationException

The height of the window.

Specified by:

setHeight in interface IWindowPosition

Parameters:

height - The height (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getHeight

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

The height of the window.

Specified by:

getHeight in interface IWindowPosition

Returns:

The height

Throws:

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

AutomationException - If the ArcObject component throws an exception.

move

public void move(int left,
                 int top,
                 int width,
                 int height)
          throws java.io.IOException,
                 AutomationException

Moves and optionally resizes the windows in a single function.

Specified by:

move in interface IWindowPosition

Parameters:

left - The left (in)

top - The top (in)

width - The width (in, optional, pass 0 if not required)

height - The height (in, optional, pass 0 if not required)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setState

public void setState(int windowState)
              throws java.io.IOException,
                     AutomationException

The state of the window.

Specified by:

setState in interface IWindowPosition

Parameters:

windowState - A com.esri.arcgis.framework.esriWindowState constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getState

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

The state of the window.

Specified by:

getState in interface IWindowPosition

Returns:

A com.esri.arcgis.framework.esriWindowState constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

create

public java.lang.Object create(java.lang.Object objectID)
                        throws java.io.IOException,
                               AutomationException

Creates an instance of an object identified by objectID.

Specified by:

create in interface IObjectFactory

Parameters:

objectID - A Variant (in)

Returns:

A reference to another Object (IUnknown)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isInitialized

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

Is the application initialized.

Specified by:

isInitialized in interface IApplicationStatus

Returns:

The pOut

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCatalog

public IGxCatalog getCatalog()
                      throws java.io.IOException,
                             AutomationException

The current catalog.

Specified by:

getCatalog in interface IGxApplication

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

public IGxView getView()
                throws java.io.IOException,
                       AutomationException

The current view.

Specified by:

getView in interface IGxApplication

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

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

The current view's class ID.

Specified by:

getViewClassID in interface IGxApplication

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

public void setViewClassID(IUID viewClassID)
                    throws java.io.IOException,
                           AutomationException

The current view's class ID.

Specified by:

setViewClassID in interface IGxApplication

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

public IGxTreeView getTreeView()
                        throws java.io.IOException,
                               AutomationException

The tree view.

Specified by:

getTreeView in interface IGxApplication

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

public IGxSelection getSelection()
                          throws java.io.IOException,
                                 AutomationException

The selection of application.

Specified by:

getSelection in interface IGxApplication

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

public IGxObject getSelectedObject()
                            throws java.io.IOException,
                                   AutomationException

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

Specified by:

getSelectedObject in interface IGxApplication

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

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

Specified by:

setLocation in interface IGxApplication

Parameters:

rhs1 - The rhs1 (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

refresh

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

Specified by:

refresh in interface IGxApplication

Parameters:

startingPath - The startingPath (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

showContextMenu

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

Displays a context menu for the current selection.

Specified by:

showContextMenu in interface IGxApplication

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

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

Expands the current selection.

Specified by:

expandSelection in interface IGxApplication

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isCanDeleteSelection

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

Indicates if the current selection can be deleted.

Specified by:

isCanDeleteSelection in interface IGxApplication

Returns:

The pEnabled

Throws:

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

AutomationException - If the ArcObject component throws an exception.

deleteSelection

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

Deletes the current selection.

Specified by:

deleteSelection in interface IGxApplication

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isCanRenameSelection

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

Indicates if the current selection can be renamed.

Specified by:

isCanRenameSelection in interface IGxApplication

Returns:

The pEnabled

Throws:

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

AutomationException - If the ArcObject component throws an exception.

renameSelection

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

Renames the current selection.

Specified by:

renameSelection in interface IGxApplication

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getAreaOfInterest

public IEnvelope getAreaOfInterest()
                            throws java.io.IOException,
                                   AutomationException

The default area of interest for the application.

Specified by:

getAreaOfInterest in interface IGxApplication

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

public void setAreaOfInterest(IEnvelope aoi)
                       throws java.io.IOException,
                              AutomationException

The default area of interest for the application.

Specified by:

setAreaOfInterest in interface IGxApplication

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.

isUseWorkspaceFolder

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

Indicates if the catalog uses a workspace folder as a home folder.

Specified by:

isUseWorkspaceFolder in interface IGxCatalogWorkspace

Returns:

The bUseWorkspaceFolder

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setUseWorkspaceFolder

public void setUseWorkspaceFolder(boolean bUseWorkspaceFolder)
                           throws java.io.IOException,
                                  AutomationException

Indicates if the catalog uses a workspace folder as a home folder.

Specified by:

setUseWorkspaceFolder in interface IGxCatalogWorkspace

Parameters:

bUseWorkspaceFolder - The bUseWorkspaceFolder (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getWorkspaceFolderPath

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

The workspace path.

Specified by:

getWorkspaceFolderPath in interface IGxCatalogWorkspace

Returns:

The workspaceFolderPath

Throws:

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

AutomationException - If the ArcObject component throws an exception.

openWorkspaceFolder

public void openWorkspaceFolder(java.lang.String workspaceFolderPath)
                         throws java.io.IOException,
                                AutomationException

Opens the document catalog.

Specified by:

openWorkspaceFolder in interface IGxCatalogWorkspace

Parameters:

workspaceFolderPath - The workspaceFolderPath (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDefaultDatabaseName

public IWorkspaceName getDefaultDatabaseName()
                                      throws java.io.IOException,
                                             AutomationException

The default geodatabase.

Specified by:

getDefaultDatabaseName in interface IGxCatalogDefaultDatabase

Returns:

A reference to a com.esri.arcgis.geodatabase.IWorkspaceName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDefaultDatabaseName

public void setDefaultDatabaseName(IWorkspaceName ppWorkspaceName)
                            throws java.io.IOException,
                                   AutomationException

The default geodatabase.

Specified by:

setDefaultDatabaseName in interface IGxCatalogDefaultDatabase

Parameters:

ppWorkspaceName - A reference to a com.esri.arcgis.geodatabase.IWorkspaceName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDefaultDatabaseNameNoValidate

public IWorkspaceName getDefaultDatabaseNameNoValidate()
                                                throws java.io.IOException,
                                                       AutomationException

The default geodatabase. Does not perform validation on the geodatabase.

Specified by:

getDefaultDatabaseNameNoValidate in interface IGxCatalogDefaultDatabase

Returns:

A reference to a com.esri.arcgis.geodatabase.IWorkspaceName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDefaultDatabaseNameNoValidate

public void setDefaultDatabaseNameNoValidate(IWorkspaceName ppWorkspaceName)
                                      throws java.io.IOException,
                                             AutomationException

The default geodatabase. Does not perform validation on the geodatabase.

Specified by:

setDefaultDatabaseNameNoValidate in interface IGxCatalogDefaultDatabase

Parameters:

ppWorkspaceName - A reference to a com.esri.arcgis.geodatabase.IWorkspaceName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.