com.esri.arcgis.arcmapui
Class IBasicDocumentProxy

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

All Implemented Interfaces:

IBasicDocument, Externalizable, Serializable

public class IBasicDocumentProxy
extends com.esri.arcgis.interop.Dispatch
implements IBasicDocument, Serializable

Provides 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

	IBasicDocumentProxy()
	IBasicDocumentProxy(Object obj)
protected	IBasicDocumentProxy(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)
Object	getContextItem() The last item that was right-clicked.
Object	getSelectedItem() The selected item in the layer control.
ILayer	getSelectedLayer() The selected layer in the layer control.
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	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

IBasicDocumentProxy

public IBasicDocumentProxy()

IBasicDocumentProxy

public IBasicDocumentProxy(Object obj)
                    throws IOException

Throws:

IOException

IBasicDocumentProxy

protected IBasicDocumentProxy(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.

Supported Platforms

Windows

Specified by:

getSelectedLayer in interface IBasicDocument

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.

Supported Platforms

Windows

Specified by:

getSelectedItem in interface IBasicDocument

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.

Supported Platforms

Windows

Specified by:

getContextItem in interface IBasicDocument

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.

Supported Platforms

Windows

Specified by:

setContextItem in interface IBasicDocument

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.

Supported Platforms

Windows

Specified by:

addLayer in interface IBasicDocument

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.

Supported Platforms

Windows

Specified by:

updateContents in interface IBasicDocument

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.

Supported Platforms

Windows

Specified by:

getTableProperties in interface IBasicDocument

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.