com.esri.arcgis.arcmapui
Class IMxDocumentProxy

java.lang.Object
  com.esri.arcgis.interop.Dispatch
      com.esri.arcgis.arcmapui.IMxDocumentProxy

All Implemented Interfaces:

IMxDocument, java.io.Externalizable, java.io.Serializable

public class IMxDocumentProxy
extends com.esri.arcgis.interop.Dispatch
implements IMxDocument, java.io.Serializable

Internal use class Proxy for COM Interface 'IMxDocument'. Generated 3/19/2015 1:21:02 PM from 'C:\ArcGIS\COM\esriArcMapUI.olb'

Description: 'Provides access to members that control the Mx Document.' 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.arcmapui.IMxDocument

IID, IID0522a5f1_487c_11d0_98bd_00805f7ced21

Constructor Summary

	IMxDocumentProxy() For internal use only
	IMxDocumentProxy(java.lang.Object obj)
protected	IMxDocumentProxy(java.lang.Object obj, java.lang.String iid)
	IMxDocumentProxy(java.lang.String CLSID, java.lang.String host, com.esri.arcgis.interop.AuthInfo authInfo)
protected	IMxDocumentProxy(java.lang.String CLSID, java.lang.String iid, java.lang.String host, com.esri.arcgis.interop.AuthInfo authInfo)

Method Summary

void	addLayer(ILayer layer) Adds a layer to the current focus map.
void	addListener(java.lang.String iidStr, java.lang.Object theListener, java.lang.Object theSource)
void	canInsertObject(boolean[] pEnabled) Indicates if the document allows objects to be inserted.
IActiveView	getActivatedView() The activated view.
IActiveView	getActiveView() The active view.
ICommand	getActiveViewCommand() The command associated with the active view.
IContentsView	getContentsView(int index) The contents view at the specified index.
int	getContentsViewCount() The number of contents views in the document.
java.lang.Object	getContextItem() The last item that was right-clicked.
IContentsView	getCurrentContentsView() The current contents view of the document.
IPoint	getCurrentLocation() The current mouse location in map units.
IColor	getDefaultColor(int type) The default color for the given type.
Font	getDefaultTextFont() The default font for text.
IFontSize	getDefaultTextFontSize() The default font size for text.
IMap	getFocusMap() The current focus map.
IMaps	getMaps() The collection of maps in the document.
IOperationStack	getOperationStack() The operation stack.
IPageLayout	getPageLayout() The page layout.
double	getSearchTolerance() The global search tolerance in geographic units for selection.
int	getSearchTolerancePixels() The global search tolerance in pixels for selection.
java.lang.Object	getSelectedItem() The selected item in the layer control.
ILayer	getSelectedLayer() The selected layer in the layer control.
IStyleGallery	getStyleGallery() Reference to the document's Style Gallery.
ITableProperties	getTableProperties() Table properties, for Layers and Tables in ArcMap.
void	insertObject() Inserts an object into the document.
boolean	isRelativePaths() Indicates if path names are stored relative to the document.
void	removeListener(java.lang.String iidStr, java.lang.Object theListener)
void	setActiveViewByRef(IActiveView activeView) The active view.
void	setContextItem(java.lang.Object item) The last item that was right-clicked.
void	setCurrentContentsViewByRef(IContentsView view) The current contents view of the document.
void	setCurrentLocation(IPoint mouseLoc) The current mouse location in map units.
void	setDefaultColor(int type, IColor color) The default color for the given type.
void	setDefaultTextFont(Font fontDisp) The default font for text.
void	setDefaultTextFontSize(IFontSize fontSize) The default font size for text.
void	setDelayUpdateContents(boolean rhs1) Indicates document update notifications should be ignored.
void	setPageLayoutByRef(IPageLayout pageLayout) The page layout.
void	setRelativePaths(boolean relPaths) Indicates if path names are stored relative to the document.
void	setSearchTolerancePixels(int tol) The global search tolerance in pixels for selection.
void	updateContents() Notifies the document that the contents have been updated.

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

IMxDocumentProxy

public IMxDocumentProxy(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

IMxDocumentProxy

public IMxDocumentProxy()

For internal use only

IMxDocumentProxy

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

Throws:

java.io.IOException

IMxDocumentProxy

protected IMxDocumentProxy(java.lang.Object obj,
                           java.lang.String iid)
                    throws java.io.IOException

Throws:

java.io.IOException

IMxDocumentProxy

protected IMxDocumentProxy(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

setPageLayoutByRef

public void setPageLayoutByRef(IPageLayout pageLayout)
                        throws java.io.IOException,
                               AutomationException

The page layout.

Specified by:

setPageLayoutByRef in interface IMxDocument

Parameters:

pageLayout - A reference to a com.esri.arcgis.carto.IPageLayout (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getPageLayout

public IPageLayout getPageLayout()
                          throws java.io.IOException,
                                 AutomationException

The page layout.

Specified by:

getPageLayout in interface IMxDocument

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getActiveView

public IActiveView getActiveView()
                          throws java.io.IOException,
                                 AutomationException

The active view.

Specified by:

getActiveView in interface IMxDocument

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setActiveViewByRef

public void setActiveViewByRef(IActiveView activeView)
                        throws java.io.IOException,
                               AutomationException

The active view.

Specified by:

setActiveViewByRef in interface IMxDocument

Parameters:

activeView - A reference to a com.esri.arcgis.carto.IActiveView (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getActivatedView

public IActiveView getActivatedView()
                             throws java.io.IOException,
                                    AutomationException

The activated view. This is the same as the active view unless a data frame is activated within a layout.

Specified by:

getActivatedView in interface IMxDocument

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getActiveViewCommand

public ICommand getActiveViewCommand()
                              throws java.io.IOException,
                                     AutomationException

The command associated with the active view.

Specified by:

getActiveViewCommand in interface IMxDocument

Returns:

A reference to a com.esri.arcgis.systemUI.ICommand

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFocusMap

public IMap getFocusMap()
                 throws java.io.IOException,
                        AutomationException

The current focus map.

Specified by:

getFocusMap in interface IMxDocument

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSelectedLayer

public ILayer getSelectedLayer()
                        throws java.io.IOException,
                               AutomationException

The selected layer in the layer control.

Specified by:

getSelectedLayer in interface IMxDocument

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSelectedItem

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

The selected item in the layer control.

Specified by:

getSelectedItem in interface IMxDocument

Returns:

A reference to another Object (IUnknown)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getContextItem

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

The last item that was right-clicked.

Specified by:

getContextItem in interface IMxDocument

Returns:

A reference to another Object (IUnknown)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setContextItem

public void setContextItem(java.lang.Object item)
                    throws java.io.IOException,
                           AutomationException

The last item that was right-clicked.

Specified by:

setContextItem in interface IMxDocument

Parameters:

item - A reference to another Object (IUnknown) (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getStyleGallery

public IStyleGallery getStyleGallery()
                              throws java.io.IOException,
                                     AutomationException

Reference to the document's Style Gallery.

Specified by:

getStyleGallery in interface IMxDocument

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addLayer

public void addLayer(ILayer layer)
              throws java.io.IOException,
                     AutomationException

Adds a layer to the current focus map.

Specified by:

addLayer in interface IMxDocument

Parameters:

layer - A reference to a com.esri.arcgis.carto.ILayer (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

updateContents

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

Notifies the document that the contents have been updated.

Specified by:

updateContents in interface IMxDocument

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSearchTolerance

public double getSearchTolerance()
                          throws java.io.IOException,
                                 AutomationException

The global search tolerance in geographic units for selection.

Specified by:

getSearchTolerance in interface IMxDocument

Returns:

The tol

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSearchTolerancePixels

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

The global search tolerance in pixels for selection.

Specified by:

getSearchTolerancePixels in interface IMxDocument

Returns:

The tol

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSearchTolerancePixels

public void setSearchTolerancePixels(int tol)
                              throws java.io.IOException,
                                     AutomationException

The global search tolerance in pixels for selection.

Specified by:

setSearchTolerancePixels in interface IMxDocument

Parameters:

tol - The tol (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

insertObject

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

Inserts an object into the document. Displays the insert object dialog.

Specified by:

insertObject in interface IMxDocument

Throws:

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

AutomationException - If the ArcObject component throws an exception.

canInsertObject

public void canInsertObject(boolean[] pEnabled)
                     throws java.io.IOException,
                            AutomationException

Indicates if the document allows objects to be inserted.

Specified by:

canInsertObject in interface IMxDocument

Parameters:

pEnabled - The pEnabled (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMaps

public IMaps getMaps()
              throws java.io.IOException,
                     AutomationException

The collection of maps in the document.

Specified by:

getMaps in interface IMxDocument

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getOperationStack

public IOperationStack getOperationStack()
                                  throws java.io.IOException,
                                         AutomationException

The operation stack.

Specified by:

getOperationStack in interface IMxDocument

Returns:

A reference to a com.esri.arcgis.systemUI.IOperationStack

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDefaultTextFont

public Font getDefaultTextFont()
                        throws java.io.IOException,
                               AutomationException

The default font for text.

Specified by:

getDefaultTextFont in interface IMxDocument

Returns:

A reference to a com.esri.arcgis.support.ms.stdole.Font (A com.esri.arcgis.support.ms.stdole.Font COM typedef)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDefaultTextFontSize

public void setDefaultTextFontSize(IFontSize fontSize)
                            throws java.io.IOException,
                                   AutomationException

The default font size for text.

Specified by:

setDefaultTextFontSize in interface IMxDocument

Parameters:

fontSize - A reference to a com.esri.arcgis.display.IFontSize (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDefaultTextFontSize

public IFontSize getDefaultTextFontSize()
                                 throws java.io.IOException,
                                        AutomationException

The default font size for text.

Specified by:

getDefaultTextFontSize in interface IMxDocument

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDefaultTextFont

public void setDefaultTextFont(Font fontDisp)
                        throws java.io.IOException,
                               AutomationException

The default font for text.

Specified by:

setDefaultTextFont in interface IMxDocument

Parameters:

fontDisp - A reference to a com.esri.arcgis.support.ms.stdole.Font (A com.esri.arcgis.support.ms.stdole.Font COM typedef) (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDefaultColor

public IColor getDefaultColor(int type)
                       throws java.io.IOException,
                              AutomationException

The default color for the given type.

Specified by:

getDefaultColor in interface IMxDocument

Parameters:

type - A com.esri.arcgis.arcmapui.esriMxDefaultColorTypes constant (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDefaultColor

public void setDefaultColor(int type,
                            IColor color)
                     throws java.io.IOException,
                            AutomationException

The default color for the given type.

Specified by:

setDefaultColor in interface IMxDocument

Parameters:

type - A com.esri.arcgis.arcmapui.esriMxDefaultColorTypes constant (in)

color - A reference to a com.esri.arcgis.display.IColor (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCurrentLocation

public IPoint getCurrentLocation()
                          throws java.io.IOException,
                                 AutomationException

The current mouse location in map units.

Specified by:

getCurrentLocation in interface IMxDocument

Returns:

A reference to a com.esri.arcgis.geometry.IPoint

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setCurrentLocation

public void setCurrentLocation(IPoint mouseLoc)
                        throws java.io.IOException,
                               AutomationException

The current mouse location in map units.

Specified by:

setCurrentLocation in interface IMxDocument

Parameters:

mouseLoc - A reference to a com.esri.arcgis.geometry.IPoint (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDelayUpdateContents

public void setDelayUpdateContents(boolean rhs1)
                            throws java.io.IOException,
                                   AutomationException

Indicates document update notifications should be ignored.

Specified by:

setDelayUpdateContents in interface IMxDocument

Parameters:

rhs1 - The rhs1 (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isRelativePaths

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

Indicates if path names are stored relative to the document.

Specified by:

isRelativePaths in interface IMxDocument

Returns:

The relPaths

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setRelativePaths

public void setRelativePaths(boolean relPaths)
                      throws java.io.IOException,
                             AutomationException

Indicates if path names are stored relative to the document.

Specified by:

setRelativePaths in interface IMxDocument

Parameters:

relPaths - The relPaths (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCurrentContentsView

public IContentsView getCurrentContentsView()
                                     throws java.io.IOException,
                                            AutomationException

The current contents view of the document.

Specified by:

getCurrentContentsView in interface IMxDocument

Returns:

A reference to a com.esri.arcgis.arcmapui.IContentsView

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setCurrentContentsViewByRef

public void setCurrentContentsViewByRef(IContentsView view)
                                 throws java.io.IOException,
                                        AutomationException

The current contents view of the document.

Specified by:

setCurrentContentsViewByRef in interface IMxDocument

Parameters:

view - A reference to a com.esri.arcgis.arcmapui.IContentsView (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getContentsViewCount

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

The number of contents views in the document.

Specified by:

getContentsViewCount in interface IMxDocument

Returns:

The count

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getContentsView

public IContentsView getContentsView(int index)
                              throws java.io.IOException,
                                     AutomationException

The contents view at the specified index.

Specified by:

getContentsView in interface IMxDocument

Parameters:

index - The index (in)

Returns:

A reference to a com.esri.arcgis.arcmapui.IContentsView

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTableProperties

public ITableProperties getTableProperties()
                                    throws java.io.IOException,
                                           AutomationException

Table properties, for Layers and Tables in ArcMap.

Specified by:

getTableProperties in interface IMxDocument

Returns:

A reference to a com.esri.arcgis.arcmapui.ITableProperties

Throws:

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

AutomationException - If the ArcObject component throws an exception.