com.esri.arcgis.framework
Interface IApplication

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

Application, Application, Application, Application, AppRef, IApplicationProxy

public interface IApplication
extends java.io.Serializable

COM Interface 'IApplication'. Generated 3/19/2015 1:20:51 PM from 'C:\ArcGIS\COM\esriFramework.olb'

Description: 'Provides access to members that query or modify the 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 =

Field Summary

static java.lang.String	DISPID_1610743808_GET_NAME
static java.lang.String	DISPID_1610743809_GET_NAME
static java.lang.String	DISPID_1610743810_GET_NAME
static java.lang.String	DISPID_1610743811_NAME
static java.lang.String	DISPID_1610743812_NAME
static java.lang.String	DISPID_1610743813_GET_NAME
static java.lang.String	DISPID_1610743813_PUTREF_NAME
static java.lang.String	DISPID_1610743815_GET_NAME
static java.lang.String	DISPID_1610743816_NAME
static java.lang.String	DISPID_1610743817_NAME
static java.lang.String	DISPID_1610743818_NAME
static java.lang.String	DISPID_1610743819_NAME
static java.lang.String	DISPID_1610743820_NAME
static java.lang.String	DISPID_1610743821_NAME
static java.lang.String	DISPID_1610743822_NAME
static java.lang.String	DISPID_1610743823_NAME
static java.lang.String	DISPID_1610743824_NAME
static java.lang.String	DISPID_1610743825_GET_NAME
static java.lang.String	DISPID_1610743826_GET_NAME
static java.lang.String	DISPID_1610743827_NAME
static java.lang.String	DISPID_1610743828_NAME
static java.lang.String	DISPID_1610743829_NAME
static java.lang.String	DISPID_1610743830_GET_NAME
static java.lang.String	DISPID_1610743830_PUT_NAME
static java.lang.String	DISPID_1610743832_GET_NAME
static java.lang.String	DISPID_1610743832_PUT_NAME
static java.lang.String	IID Deprecated. Internal use only
static int	IID8e52b9a5_307b_11d2_94c9_080009eebecb
static int	xxDummy Deprecated. Internal use only

Method Summary

IExtension	findExtensionByCLSID(IUID extensionCLSID) Finds an extension by its CLSID.
IExtension	findExtensionByName(java.lang.String extensionName) Finds an extension by its name.
java.lang.String	getCaption() The caption of this application.
ICommandItem	getCurrentTool() The currently selected tool.
IDocument	getDocument() The document that is currently loaded in the application.
int	getHWnd() The handle of the application's window.
java.lang.String	getName() The name of this application.
IStatusBar	getStatusBar() The statusbar of this application.
ITemplates	getTemplates() The templates collection.
java.lang.Object	getVBE() The Visual Basic Environment.
boolean	isDialogVisible(int dialogID) Indicates if the specified dialog is visible in the application.
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	newDocument(boolean selectTemplate, java.lang.String templatePath) Creates a new document in this application.
void	openDocument(java.lang.String path) Opens a document in this application.
void	printDocument() Displays the Print dialog.
void	printPreview() Displays how the document will look like when it is printed.
void	refreshWindow() Redraws the application window.
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	setCaption(java.lang.String caption) The caption of this application.
void	setCurrentToolByRef(ICommandItem tool) The currently selected tool.
void	setVisible(boolean visible) Indicates if the application window is visible.
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.

Field Detail

IID8e52b9a5_307b_11d2_94c9_080009eebecb

static final int IID8e52b9a5_307b_11d2_94c9_080009eebecb

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

DISPID_1610743808_GET_NAME

static final java.lang.String DISPID_1610743808_GET_NAME

See Also:

Constant Field Values

DISPID_1610743809_GET_NAME

static final java.lang.String DISPID_1610743809_GET_NAME

See Also:

Constant Field Values

DISPID_1610743810_GET_NAME

static final java.lang.String DISPID_1610743810_GET_NAME

See Also:

Constant Field Values

DISPID_1610743811_NAME

static final java.lang.String DISPID_1610743811_NAME

See Also:

Constant Field Values

DISPID_1610743812_NAME

static final java.lang.String DISPID_1610743812_NAME

See Also:

Constant Field Values

DISPID_1610743813_GET_NAME

static final java.lang.String DISPID_1610743813_GET_NAME

See Also:

Constant Field Values

DISPID_1610743813_PUTREF_NAME

static final java.lang.String DISPID_1610743813_PUTREF_NAME

See Also:

Constant Field Values

DISPID_1610743815_GET_NAME

static final java.lang.String DISPID_1610743815_GET_NAME

See Also:

Constant Field Values

DISPID_1610743816_NAME

static final java.lang.String DISPID_1610743816_NAME

See Also:

Constant Field Values

DISPID_1610743817_NAME

static final java.lang.String DISPID_1610743817_NAME

See Also:

Constant Field Values

DISPID_1610743818_NAME

static final java.lang.String DISPID_1610743818_NAME

See Also:

Constant Field Values

DISPID_1610743819_NAME

static final java.lang.String DISPID_1610743819_NAME

See Also:

Constant Field Values

DISPID_1610743820_NAME

static final java.lang.String DISPID_1610743820_NAME

See Also:

Constant Field Values

DISPID_1610743821_NAME

static final java.lang.String DISPID_1610743821_NAME

See Also:

Constant Field Values

DISPID_1610743822_NAME

static final java.lang.String DISPID_1610743822_NAME

See Also:

Constant Field Values

DISPID_1610743823_NAME

static final java.lang.String DISPID_1610743823_NAME

See Also:

Constant Field Values

DISPID_1610743824_NAME

static final java.lang.String DISPID_1610743824_NAME

See Also:

Constant Field Values

DISPID_1610743825_GET_NAME

static final java.lang.String DISPID_1610743825_GET_NAME

See Also:

Constant Field Values

DISPID_1610743826_GET_NAME

static final java.lang.String DISPID_1610743826_GET_NAME

See Also:

Constant Field Values

DISPID_1610743827_NAME

static final java.lang.String DISPID_1610743827_NAME

See Also:

Constant Field Values

DISPID_1610743828_NAME

static final java.lang.String DISPID_1610743828_NAME

See Also:

Constant Field Values

DISPID_1610743829_NAME

static final java.lang.String DISPID_1610743829_NAME

See Also:

Constant Field Values

DISPID_1610743830_GET_NAME

static final java.lang.String DISPID_1610743830_GET_NAME

See Also:

Constant Field Values

DISPID_1610743830_PUT_NAME

static final java.lang.String DISPID_1610743830_PUT_NAME

See Also:

Constant Field Values

DISPID_1610743832_PUT_NAME

static final java.lang.String DISPID_1610743832_PUT_NAME

See Also:

Constant Field Values

DISPID_1610743832_GET_NAME

static final java.lang.String DISPID_1610743832_GET_NAME

See Also:

Constant Field Values

Method Detail

getName

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

The name of this application.

Returns:

The name

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDocument

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

The document that is currently loaded in the application.

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

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

The statusbar of this application.

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

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

Displays the specified dialog in the application.

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

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

Indicates if the specified dialog is visible in the application.

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

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

The currently selected tool.

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

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

The currently selected tool.

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

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

The Visual Basic Environment.

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

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

Creates a new document in this application.

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

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

Opens a document in this application.

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

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

Saves the document that is currently open in this application.

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

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.

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

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

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

printDocument

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

Displays the Print dialog.

Throws:

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

AutomationException - If the ArcObject component throws an exception.

lockCustomization

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

Locks the application's user interface against any customizations.

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

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

Unlocks previous user interface customization lock.

Parameters:

password - The password (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

refreshWindow

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

Redraws the application window.

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTemplates

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

The templates collection.

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

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

The handle of the application's window.

Returns:

The hWnd (A COM typedef)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

findExtensionByName

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

Finds an extension by its name.

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

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

Finds an extension by its CLSID.

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

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

Terminates the application.

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isVisible

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

Indicates if the application window is visible.

Returns:

The visible

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setVisible

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

Indicates if the application window is visible.

Parameters:

visible - The visible (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setCaption

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

The caption of this application.

Parameters:

caption - The caption (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCaption

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

The caption of this application.

Returns:

The caption

Throws:

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

AutomationException - If the ArcObject component throws an exception.