com.esri.arcgis.arcmapui
Class IDocumentEventsProxy

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

All Implemented Interfaces:

IDocumentEvents, Externalizable, Serializable, EventListener

public class IDocumentEventsProxy
extends com.esri.arcgis.interop.Dispatch
implements IDocumentEvents, Serializable

Provides access to events that occur in ArcMap.

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

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

Method Summary

void	activeViewChanged(IDocumentEventsActiveViewChangedEvent theEvent) Fired when the active view changes.
void	addListener(String iidStr, Object theListener, Object theSource)
boolean	beforeCloseDocument(IDocumentEventsBeforeCloseDocumentEvent theEvent) Fired before a document is closed.
void	closeDocument(IDocumentEventsCloseDocumentEvent theEvent) Fired when a document is closed.
void	mapsChanged(IDocumentEventsMapsChangedEvent theEvent) Fired when a change is made to the map collection.
void	newDocument(IDocumentEventsNewDocumentEvent theEvent) Fired when a new document is created.
void	onContextMenu(IDocumentEventsOnContextMenuEvent theEvent) Indicates if a context menu should be displayed at the given xy location.
void	openDocument(IDocumentEventsOpenDocumentEvent theEvent) Fired when a document is opened.
void	removeListener(String iidStr, Object theListener)

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

IDocumentEventsProxy

public IDocumentEventsProxy()

IDocumentEventsProxy

public IDocumentEventsProxy(Object obj)
                     throws IOException

Throws:

IOException

IDocumentEventsProxy

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

activeViewChanged

public void activeViewChanged(IDocumentEventsActiveViewChangedEvent theEvent)
                       throws IOException,
                              AutomationException

Fired when the active view changes.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

activeViewChanged in interface IDocumentEvents

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

mapsChanged

public void mapsChanged(IDocumentEventsMapsChangedEvent theEvent)
                 throws IOException,
                        AutomationException

Fired when a change is made to the map collection.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

mapsChanged in interface IDocumentEvents

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onContextMenu

public void onContextMenu(IDocumentEventsOnContextMenuEvent theEvent)
                   throws IOException,
                          AutomationException

Indicates if a context menu should be displayed at the given xy location. Return true if handled.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

onContextMenu in interface IDocumentEvents

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

newDocument

public void newDocument(IDocumentEventsNewDocumentEvent theEvent)
                 throws IOException,
                        AutomationException

Fired when a new document is created.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

newDocument in interface IDocumentEvents

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

openDocument

public void openDocument(IDocumentEventsOpenDocumentEvent theEvent)
                  throws IOException,
                         AutomationException

Fired when a document is opened.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

openDocument in interface IDocumentEvents

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

beforeCloseDocument

public boolean beforeCloseDocument(IDocumentEventsBeforeCloseDocumentEvent theEvent)
                            throws IOException,
                                   AutomationException

Fired before a document is closed. Return True to abort the close process.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

beforeCloseDocument in interface IDocumentEvents

Parameters:

theEvent - The event

Returns:

The abortClose

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

closeDocument

public void closeDocument(IDocumentEventsCloseDocumentEvent theEvent)
                   throws IOException,
                          AutomationException

Fired when a document is closed.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

closeDocument in interface IDocumentEvents

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.