com.esri.arcgis.arcmapui
Class IBasicDocument2Proxy

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

All Implemented Interfaces:

IBasicDocument2, Externalizable, Serializable

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

Provides additional access to members that control the Basic Document.

Product Availability

Available with ArcGIS Desktop.

See Also:

Serialized Form

Field Summary

boolean

noncastable

Fields inherited from class com.esri.arcgis.interop.Dispatch

DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, objRef

Constructor Summary

	IBasicDocument2Proxy()
	IBasicDocument2Proxy(Object obj)
protected	IBasicDocument2Proxy(Object obj, String iid)

Method Summary

void	addLayer(ILayer pLayer) Adds a layer to the current focus map or scene.
void	addListener(String iidStr, Object theListener, Object theSource)
IActiveView	getActivatedView() The activated view.
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.
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(String iidStr, Object theListener)
void	setContextItem(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

noncastable

public boolean noncastable

Constructor Detail

IBasicDocument2Proxy

public IBasicDocument2Proxy()

IBasicDocument2Proxy

public IBasicDocument2Proxy(Object obj)
                     throws IOException

Throws:

IOException

IBasicDocument2Proxy

protected IBasicDocument2Proxy(Object obj,
                               String iid)
                        throws IOException

Throws:

IOException

Method Detail

addListener

public void addListener(String iidStr,
                        Object theListener,
                        Object theSource)
                 throws IOException

Overrides:

addListener in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

removeListener

public void removeListener(String iidStr,
                           Object theListener)
                    throws IOException

Overrides:

removeListener in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

getSelectedLayer

public ILayer getSelectedLayer()
                        throws IOException,
                               AutomationException

The selected layer in the layer control.

Product Availability

Available with ArcGIS Desktop.

Specified by:

getSelectedLayer in interface IBasicDocument2

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSelectedItem

public Object getSelectedItem()
                       throws IOException,
                              AutomationException

The selected item in the layer control.

Product Availability

Available with ArcGIS Desktop.

Specified by:

getSelectedItem in interface IBasicDocument2

Returns:

A reference to another Object (IUnknown)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getContextItem

public Object getContextItem()
                      throws IOException,
                             AutomationException

The last item that was right-clicked.

Product Availability

Available with ArcGIS Desktop.

Specified by:

getContextItem in interface IBasicDocument2

Returns:

A reference to another Object (IUnknown)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setContextItem

public void setContextItem(Object ppItem)
                    throws IOException,
                           AutomationException

The last item that was right-clicked.

Product Availability

Available with ArcGIS Desktop.

Specified by:

setContextItem in interface IBasicDocument2

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addLayer

public void addLayer(ILayer pLayer)
              throws IOException,
                     AutomationException

Adds a layer to the current focus map or scene.

Product Availability

Available with ArcGIS Desktop.

Specified by:

addLayer in interface IBasicDocument2

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

updateContents

public void updateContents()
                    throws IOException,
                           AutomationException

Notifies the document that the contents have been updated.

Product Availability

Available with ArcGIS Desktop.

Specified by:

updateContents in interface IBasicDocument2

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTableProperties

public ITableProperties getTableProperties()
                                    throws IOException,
                                           AutomationException

Table properties, for Layers and Tables.

Product Availability

Available with ArcGIS Desktop.

Specified by:

getTableProperties in interface IBasicDocument2

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPageLayoutByRef

public void setPageLayoutByRef(IPageLayout pageLayout)
                        throws IOException,
                               AutomationException

The page layout.

Product Availability

Available with ArcGIS Desktop.

Specified by:

setPageLayoutByRef in interface IBasicDocument2

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPageLayout

public IPageLayout getPageLayout()
                          throws IOException,
                                 AutomationException

The page layout.

Product Availability

Available with ArcGIS Desktop.

Specified by:

getPageLayout in interface IBasicDocument2

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getActivatedView

public IActiveView getActivatedView()
                             throws IOException,
                                    AutomationException

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

Product Availability

Available with ArcGIS Desktop.

Specified by:

getActivatedView in interface IBasicDocument2

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFocusMap

public IMap getFocusMap()
                 throws IOException,
                        AutomationException

The current focus map.

Product Availability

Available with ArcGIS Desktop.

Specified by:

getFocusMap in interface IBasicDocument2

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getStyleGallery

public IStyleGallery getStyleGallery()
                              throws IOException,
                                     AutomationException

Reference to the document's Style Gallery.

Product Availability

Available with ArcGIS Desktop.

Specified by:

getStyleGallery in interface IBasicDocument2

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSearchTolerance

public double getSearchTolerance()
                          throws IOException,
                                 AutomationException

The global search tolerance in geographic units for selection.

Product Availability

Available with ArcGIS Desktop.

Specified by:

getSearchTolerance in interface IBasicDocument2

Returns:

The tol

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSearchTolerancePixels

public int getSearchTolerancePixels()
                             throws IOException,
                                    AutomationException

The global search tolerance in pixels for selection.

Product Availability

Available with ArcGIS Desktop.

Specified by:

getSearchTolerancePixels in interface IBasicDocument2

Returns:

The tol

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSearchTolerancePixels

public void setSearchTolerancePixels(int tol)
                              throws IOException,
                                     AutomationException

The global search tolerance in pixels for selection.

Product Availability

Available with ArcGIS Desktop.

Specified by:

setSearchTolerancePixels in interface IBasicDocument2

Parameters:

tol - The tol (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMaps

public IMaps getMaps()
              throws IOException,
                     AutomationException

The collection of maps in the document.

Product Availability

Available with ArcGIS Desktop.

Specified by:

getMaps in interface IBasicDocument2

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getOperationStack

public IOperationStack getOperationStack()
                                  throws IOException,
                                         AutomationException

The operation stack.

Product Availability

Available with ArcGIS Desktop.

Specified by:

getOperationStack in interface IBasicDocument2

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCurrentLocation

public IPoint getCurrentLocation()
                          throws IOException,
                                 AutomationException

The current mouse location in map units.

Product Availability

Available with ArcGIS Desktop.

Specified by:

getCurrentLocation in interface IBasicDocument2

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCurrentLocation

public void setCurrentLocation(IPoint mouseLoc)
                        throws IOException,
                               AutomationException

The current mouse location in map units.

Product Availability

Available with ArcGIS Desktop.

Specified by:

setCurrentLocation in interface IBasicDocument2

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.