com.esri.arcgis.arcmapui
Class IBasicDocument2Proxy

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

All Implemented Interfaces:

IBasicDocument2, java.io.Externalizable, java.io.Serializable

public class IBasicDocument2Proxy
extends com.esri.arcgis.interop.Dispatch
implements IBasicDocument2, java.io.Serializable

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

Description: 'Provides additional access to members that control the Basic 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.IBasicDocument2

IID, IIDef2ec034_c197_48a0_90ee_c6b7db797eb8

Constructor Summary

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

Method Summary

void	addLayer(ILayer pLayer) Adds a layer to the current focus map or scene.
void	addListener(java.lang.String iidStr, java.lang.Object theListener, java.lang.Object theSource)
IActiveView	getActivatedView() The activated view.
java.lang.Object	getContextItem() The last item that was right-clicked.
IPoint	getCurrentLocation() The current mouse location in map units.
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.
void	removeListener(java.lang.String iidStr, java.lang.Object theListener)
void	setContextItem(java.lang.Object ppItem) The last item that was right-clicked.
void	setCurrentLocation(IPoint mouseLoc) The current mouse location in map units.
void	setPageLayoutByRef(IPageLayout pageLayout) The page layout.
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

IBasicDocument2Proxy

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

IBasicDocument2Proxy

public IBasicDocument2Proxy()

For internal use only

IBasicDocument2Proxy

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

Throws:

java.io.IOException

IBasicDocument2Proxy

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

Throws:

java.io.IOException

IBasicDocument2Proxy

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

getSelectedLayer

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

The selected layer in the layer control.

Specified by:

getSelectedLayer in interface IBasicDocument2

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 IBasicDocument2

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 IBasicDocument2

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 ppItem)
                    throws java.io.IOException,
                           AutomationException

The last item that was right-clicked.

Specified by:

setContextItem in interface IBasicDocument2

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addLayer

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

Adds a layer to the current focus map or scene.

Specified by:

addLayer in interface IBasicDocument2

Parameters:

pLayer - 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 IBasicDocument2

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.

Specified by:

getTableProperties in interface IBasicDocument2

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.

setPageLayoutByRef

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

The page layout.

Specified by:

setPageLayoutByRef in interface IBasicDocument2

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 IBasicDocument2

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.

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 IBasicDocument2

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.

getFocusMap

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

The current focus map.

Specified by:

getFocusMap in interface IBasicDocument2

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.

getStyleGallery

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

Reference to the document's Style Gallery.

Specified by:

getStyleGallery in interface IBasicDocument2

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.

getSearchTolerance

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

The global search tolerance in geographic units for selection.

Specified by:

getSearchTolerance in interface IBasicDocument2

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 IBasicDocument2

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 IBasicDocument2

Parameters:

tol - The tol (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 IBasicDocument2

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 IBasicDocument2

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.

getCurrentLocation

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

The current mouse location in map units.

Specified by:

getCurrentLocation in interface IBasicDocument2

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 IBasicDocument2

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.