com.esri.arcgis.framework
Class IApplicationProxy

java.lang.Object
  extended by com.esri.arcgis.interop.Dispatch
      extended by com.esri.arcgis.framework.IApplicationProxy
All Implemented Interfaces:
IApplication, java.io.Externalizable, java.io.Serializable

public class IApplicationProxy
extends com.esri.arcgis.interop.Dispatch
implements IApplication, java.io.Serializable

Internal use class Proxy for 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 =

See Also:
Serialized Form

Field Summary
 boolean noncastable
           
static java.lang.Class targetClass
           
 
Fields inherited from class com.esri.arcgis.interop.Dispatch
DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, objRef
 
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
 
Constructor Summary
  IApplicationProxy()
          For internal use only
  IApplicationProxy(java.lang.Object obj)
           
protected IApplicationProxy(java.lang.Object obj, java.lang.String iid)
           
  IApplicationProxy(java.lang.String CLSID, java.lang.String host, com.esri.arcgis.interop.AuthInfo authInfo)
           
protected IApplicationProxy(java.lang.String CLSID, java.lang.String iid, java.lang.String host, com.esri.arcgis.interop.AuthInfo authInfo)
           
 
Method Summary
 void addListener(java.lang.String iidStr, java.lang.Object theListener, java.lang.Object theSource)
           
 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 removeListener(java.lang.String iidStr, java.lang.Object theListener)
           
 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.
 
Methods inherited from class com.esri.arcgis.interop.Dispatch
bindUsingMoniker, constructVtblPosTable, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, getVtblPos, hashCode, initDispatch, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, optimizedVtblInvoke, queryInterface, readExternal, release, setNativeMode, setPropertyByName, toString, vtblInvoke, writeExternal
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

targetClass

public static final java.lang.Class targetClass

noncastable

public boolean noncastable
Constructor Detail

IApplicationProxy

public IApplicationProxy(java.lang.String CLSID,
                         java.lang.String host,
                         com.esri.arcgis.interop.AuthInfo authInfo)
                  throws java.net.UnknownHostException,
                         java.io.IOException
Throws:
java.net.UnknownHostException
java.io.IOException

IApplicationProxy

public IApplicationProxy()
For internal use only


IApplicationProxy

public IApplicationProxy(java.lang.Object obj)
                  throws java.io.IOException
Throws:
java.io.IOException

IApplicationProxy

protected IApplicationProxy(java.lang.Object obj,
                            java.lang.String iid)
                     throws java.io.IOException
Throws:
java.io.IOException

IApplicationProxy

protected IApplicationProxy(java.lang.String CLSID,
                            java.lang.String iid,
                            java.lang.String host,
                            com.esri.arcgis.interop.AuthInfo authInfo)
                     throws java.io.IOException
Throws:
java.io.IOException
Method Detail

addListener

public void addListener(java.lang.String iidStr,
                        java.lang.Object theListener,
                        java.lang.Object theSource)
                 throws java.io.IOException
Overrides:
addListener in class com.esri.arcgis.interop.Dispatch
Throws:
java.io.IOException

removeListener

public void removeListener(java.lang.String iidStr,
                           java.lang.Object theListener)
                    throws java.io.IOException
Overrides:
removeListener in class com.esri.arcgis.interop.Dispatch
Throws:
java.io.IOException

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.