com.esri.arcgis.arcmapui
Class MapInsetWindow

java.lang.Object
  com.esri.arcgis.arcmapui.MapInsetWindow

All Implemented Interfaces:

IDataWindow, IDataWindow2, IDocumentEvents, ILensWindow, IMapInsetWindow, IActiveViewEvents, IMapSurroundEvents, com.esri.arcgis.interop.RemoteObjRef, IPersist, IPersistStream, Externalizable, Serializable, EventListener

public class MapInsetWindow
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IMapInsetWindow, ILensWindow, IDataWindow, IDataWindow2, IDocumentEvents, IActiveViewEvents, IMapSurroundEvents, IPersistStream, Externalizable

Window to display MapInsets.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

See Also:

Serialized Form

Constructor Summary

MapInsetWindow(Object obj)
Construct a MapInsetWindow using a reference to such an object returned from ArcGIS Engine or Server.

Method Summary

void	activeViewChanged(IDocumentEventsActiveViewChangedEvent theEvent) Fired when the active view changes.
void	addIDataWindowEventsListener(IDataWindowEvents theListener) addIDataWindowEventsListener.
void	afterDraw(IActiveViewEventsAfterDrawEvent theEvent) Fired after the specified phase is drawn.
void	afterDraw(IMapSurroundEventsAfterDrawEvent theEvent) Fired after drawing completes.
void	afterItemDraw(IActiveViewEventsAfterItemDrawEvent theEvent) Fired after an individual view item is drawn.
boolean	beforeCloseDocument(IDocumentEventsBeforeCloseDocumentEvent theEvent) Fired before a document is closed.
void	beforeDraw(IMapSurroundEventsBeforeDrawEvent theEvent) Fired before drawing starts.
void	closeDocument(IDocumentEventsCloseDocumentEvent theEvent) Fired when a document is closed.
void	contentsChanged(IActiveViewEventsContentsChangedEvent theEvent) Fired when the contents of the view changes.
void	contentsChanged(IMapSurroundEventsContentsChangedEvent theEvent) Fired when the contents of the map surround changes.
void	contentsCleared(IActiveViewEventsContentsClearedEvent theEvent) Fired when the contents of the view is cleared.
void	destroy() Close and destroy the window.
boolean	equals(Object o) Compare this object with another
void	flashLocation() Draw leader lines from the inset to the location on the map shown by the inset.
void	focusMapChanged(IActiveViewEventsFocusMapChangedEvent theEvent) Fired when a new map is made active.
void	getClassID(GUID[] pClassID) getClassID
int	getHWnd() The window's handle.
IMapInset	getMapInset() The MapInset used by this window.
IScreenDisplay	getScreenDisplay() The screen display used by this window.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
String	getTag() For developer use.
int	hashCode() the hashcode for this object
void	isDirty() isDirty
boolean	isDockable() Indicates if the window is dockable.
boolean	isEnableContextMenu() Indicates if the context menu should be enabled.
boolean	isLive() Indicates if the window shows a live view of what's under it or a snapshot.
boolean	isUpdateWhileDragging() Indicates if the window is redrawn as it's moved or not.
boolean	isVisible() Indicates if the window is visible.
void	itemAdded(IActiveViewEventsItemAddedEvent theEvent) Fired when an item is added to the view.
void	itemDeleted(IActiveViewEventsItemDeletedEvent theEvent) Fired when an item is deleted from the view.
void	itemReordered(IActiveViewEventsItemReorderedEvent theEvent) Fired when a view item is reordered.
void	load(IStream pstm) load
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	putPosition(int left, int top, int right, int bottom) The window's position in screen pixels.
void	queryPosition(int[] left, int[] top, int[] right, int[] bottom) The window's position in screen pixels.
void	readExternal(ObjectInput in)
void	refresh() Cause the window to redraw.
void	removeIDataWindowEventsListener(IDataWindowEvents theListener) removeIDataWindowEventsListener.
void	save(IStream pstm, int fClearDirty) save
void	selectionChanged(IActiveViewEventsSelectionChangedEvent theEvent) Call this function to fire the selection changed event.
void	setApplicationByRef(Object rhs1) Provides the window with a reference to the application.
void	setEnableContextMenu(boolean enable) Indicates if the context menu should be enabled.
void	setIsLive(boolean isLive) Indicates if the window shows a live view of what's under it or a snapshot.
void	setMapInsetByRef(IMapInset mapInset) The MapInset used by this window.
void	setTag(String tag) For developer use.
void	setUpdateWhileDragging(boolean updateWhileDragging) Indicates if the window is redrawn as it's moved or not.
void	show(boolean show) Indicates if the window is shown.
void	spatialReferenceChanged(IActiveViewEventsSpatialReferenceChangedEvent theEvent) Fired when the spatial reference is changed.
void	viewRefreshed(IActiveViewEventsViewRefreshedEvent theEvent) Fired when view is refreshed before draw happens.
void	writeExternal(ObjectOutput out)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef

getJintegraDispatch, release

Constructor Detail

MapInsetWindow

public MapInsetWindow(Object obj)
               throws IOException

Construct a MapInsetWindow using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to MapInsetWindow.
Casting to this class from the return value of a method will not work, as this class represents an abstract class in ArcObjects.
*
MapInsetWindow o = (MapInsetWindow)obj; // will not work

MapInsetWindow o = new MapInsetWindow(obj); // Use this constructor instead
* @param obj an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems MapInsetWindow theMapInsetWindow = (MapInsetWindow) obj;

Method Detail

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

addIDataWindowEventsListener

public void addIDataWindowEventsListener(IDataWindowEvents theListener)
                                  throws IOException

addIDataWindowEventsListener. Listen to events generated by this class.

Parameters:

theListener - An object that implements the com.esri.arcgis.arcmapui.IDataWindowEvents interface.

Throws:

IOException - If there are communications problems.

removeIDataWindowEventsListener

public void removeIDataWindowEventsListener(IDataWindowEvents theListener)
                                     throws IOException

removeIDataWindowEventsListener. Stop listening to events generated by this class.

Parameters:

theListener - An object that implements the com.esri.arcgis.arcmapui.IDataWindowEvents interface.

Throws:

IOException - If there are communications problems.

getMapInset

public IMapInset getMapInset()
                      throws IOException,
                             AutomationException

The MapInset used by this window.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getMapInset in interface IMapInsetWindow

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMapInsetByRef

public void setMapInsetByRef(IMapInset mapInset)
                      throws IOException,
                             AutomationException

The MapInset used by this window.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setMapInsetByRef in interface IMapInsetWindow

Parameters:

mapInset - A reference to a com.esri.arcgis.carto.IMapInset (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

flashLocation

public void flashLocation()
                   throws IOException,
                          AutomationException

Draw leader lines from the inset to the location on the map shown by the inset.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

flashLocation in interface IMapInsetWindow

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getScreenDisplay

public IScreenDisplay getScreenDisplay()
                                throws IOException,
                                       AutomationException

The screen display used by this window.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getScreenDisplay in interface ILensWindow

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isUpdateWhileDragging

public boolean isUpdateWhileDragging()
                              throws IOException,
                                     AutomationException

Indicates if the window is redrawn as it's moved or not.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

isUpdateWhileDragging in interface ILensWindow

Returns:

The updateWhileDragging

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUpdateWhileDragging

public void setUpdateWhileDragging(boolean updateWhileDragging)
                            throws IOException,
                                   AutomationException

Indicates if the window is redrawn as it's moved or not.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setUpdateWhileDragging in interface ILensWindow

Parameters:

updateWhileDragging - The updateWhileDragging (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isLive

public boolean isLive()
               throws IOException,
                      AutomationException

Indicates if the window shows a live view of what's under it or a snapshot.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

isLive in interface ILensWindow

Returns:

The isLive

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setIsLive

public void setIsLive(boolean isLive)
               throws IOException,
                      AutomationException

Indicates if the window shows a live view of what's under it or a snapshot.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setIsLive in interface ILensWindow

Parameters:

isLive - The isLive (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setApplicationByRef

public void setApplicationByRef(Object rhs1)
                         throws IOException,
                                AutomationException

Provides the window with a reference to the application.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setApplicationByRef in interface IDataWindow

Specified by:

setApplicationByRef in interface IDataWindow2

Parameters:

rhs1 - A reference to another Automation Object (IDispatch) (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getHWnd

public int getHWnd()
            throws IOException,
                   AutomationException

The window's handle.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getHWnd in interface IDataWindow

Specified by:

getHWnd in interface IDataWindow2

Returns:

The hWnd (A COM typedef)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

queryPosition

public void queryPosition(int[] left,
                          int[] top,
                          int[] right,
                          int[] bottom)
                   throws IOException,
                          AutomationException

The window's position in screen pixels.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

queryPosition in interface IDataWindow

Specified by:

queryPosition in interface IDataWindow2

Parameters:

left - The left (out: use single element array)

top - The top (out: use single element array)

right - The right (out: use single element array)

bottom - The bottom (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

putPosition

public void putPosition(int left,
                        int top,
                        int right,
                        int bottom)
                 throws IOException,
                        AutomationException

The window's position in screen pixels.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

putPosition in interface IDataWindow

Specified by:

putPosition in interface IDataWindow2

Parameters:

left - The left (in)

top - The top (in)

right - The right (in)

bottom - The bottom (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isVisible

public boolean isVisible()
                  throws IOException,
                         AutomationException

Indicates if the window is visible.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

isVisible in interface IDataWindow

Specified by:

isVisible in interface IDataWindow2

Returns:

The isVisible

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDockable

public boolean isDockable()
                   throws IOException,
                          AutomationException

Indicates if the window is dockable.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

isDockable in interface IDataWindow

Specified by:

isDockable in interface IDataWindow2

Returns:

The isVisible

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

show

public void show(boolean show)
          throws IOException,
                 AutomationException

Indicates if the window is shown.

Description

Show specifies whether the data window should be shown or hidden. Use True to show the window and False to hide the window.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

show in interface IDataWindow

Specified by:

show in interface IDataWindow2

Parameters:

show - The show (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

refresh

public void refresh()
             throws IOException,
                    AutomationException

Cause the window to redraw.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

refresh in interface IDataWindow

Specified by:

refresh in interface IDataWindow2

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTag

public String getTag()
              throws IOException,
                     AutomationException

For developer use.

Product Availability

Available with ArcGIS Desktop.

Specified by:

getTag in interface IDataWindow2

Returns:

The tag

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTag

public void setTag(String tag)
            throws IOException,
                   AutomationException

For developer use.

Product Availability

Available with ArcGIS Desktop.

Specified by:

setTag in interface IDataWindow2

Parameters:

tag - The tag (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isEnableContextMenu

public boolean isEnableContextMenu()
                            throws IOException,
                                   AutomationException

Indicates if the context menu should be enabled.

Product Availability

Available with ArcGIS Desktop.

Specified by:

isEnableContextMenu in interface IDataWindow2

Returns:

The enable

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setEnableContextMenu

public void setEnableContextMenu(boolean enable)
                          throws IOException,
                                 AutomationException

Indicates if the context menu should be enabled.

Product Availability

Available with ArcGIS Desktop.

Specified by:

setEnableContextMenu in interface IDataWindow2

Parameters:

enable - The enable (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

destroy

public void destroy()
             throws IOException,
                    AutomationException

Close and destroy the window.

Product Availability

Available with ArcGIS Desktop.

Specified by:

destroy in interface IDataWindow2

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

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.

contentsChanged

public void contentsChanged(IActiveViewEventsContentsChangedEvent theEvent)
                     throws IOException,
                            AutomationException

Fired when the contents of the view changes.

Remarks

The Map object fires this event when a new document is loaded. Adding a new layer to a Map does not trigger this event.

The PageLayout object fires the event when IGraphicsContainer::DeleteAllElements in called and when a new document is loaded.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

contentsChanged in interface IActiveViewEvents

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

IActiveView.contentsChanged()

contentsCleared

public void contentsCleared(IActiveViewEventsContentsClearedEvent theEvent)
                     throws IOException,
                            AutomationException

Fired when the contents of the view is cleared.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

contentsCleared in interface IActiveViewEvents

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

itemAdded

public void itemAdded(IActiveViewEventsItemAddedEvent theEvent)
               throws IOException,
                      AutomationException

Fired when an item is added to the view.

Remarks

The Map fires the event every time a new layer is added.

The PageLayout fires this event whenever a new element is added to the layout. Elements include not only graphics but data frames as well.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

itemAdded in interface IActiveViewEvents

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

itemDeleted

public void itemDeleted(IActiveViewEventsItemDeletedEvent theEvent)
                 throws IOException,
                        AutomationException

Fired when an item is deleted from the view.

Remarks

The PageLayout object fires this event whenever elements are deleted from the layout.

The Map object fires this event when a layer is removed.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

itemDeleted in interface IActiveViewEvents

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

itemReordered

public void itemReordered(IActiveViewEventsItemReorderedEvent theEvent)
                   throws IOException,
                          AutomationException

Fired when a view item is reordered.

Remarks

The Map objects only fire this event whenever IMap::MoveLayer is called. In the ArcMap application, this occurs when you reorder layers in the table of contents. The Map will also fire this event when new layers are added.

The PageLayout object fires this event when changing the order of graphics. For example, IGraphicsContainer::BringToFront, PutElementOrder, SendToBack, SendBackward, and BringForward all fire this event. These functions are on ArcMap's Drawing menu under the Order pull right menu. Although the Map object is also a graphics container, it does not fire this event when its graphics are reordered.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

itemReordered in interface IActiveViewEvents

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

selectionChanged

public void selectionChanged(IActiveViewEventsSelectionChangedEvent theEvent)
                      throws IOException,
                             AutomationException

Call this function to fire the selection changed event.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

selectionChanged in interface IActiveViewEvents

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

viewRefreshed

public void viewRefreshed(IActiveViewEventsViewRefreshedEvent theEvent)
                   throws IOException,
                          AutomationException

Fired when view is refreshed before draw happens.

Description

Method that gets fired in response to IActiveView::Refresh and IActiveView::PartialRefresh.

Remarks

This event is useful in the case where you're watching for something to change in the view and there aren't any specific events for that change (e.g. ContentsChanged, ItemAdded). You can always listen for this method as a last resort. Care must be taken however to be very efficient in your implementation of this event because it will be called quite often.

The event parameters directly coincide with the arguments to IActiveView::PartialRefresh. For additional information about the arguments, see the help for that method.

If the event object connects to both the layout and a map, then the view parameter tells you which object initiated the event.

In an implementation of this method you typically want to check the phase and respond to only one. Otherwise, your code will execute multiple times per drawing sequence.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

viewRefreshed in interface IActiveViewEvents

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

afterDraw

public void afterDraw(IActiveViewEventsAfterDrawEvent theEvent)
               throws IOException,
                      AutomationException

Fired after the specified phase is drawn.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

afterDraw in interface IActiveViewEvents

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

afterItemDraw

public void afterItemDraw(IActiveViewEventsAfterItemDrawEvent theEvent)
                   throws IOException,
                          AutomationException

Fired after an individual view item is drawn. Example: view items include layers in a map or elements in a page layout.

Remarks

AfterItemDraw can be used to execute after each individual item has drawn. Event firing can be an expensive operation (time consuming) when there are many layers in a map, however. As a result, the AfterItemDraw event is only fired when the IViewManger::VerboseEvents property is set to True. By default this property is False.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

afterItemDraw in interface IActiveViewEvents

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

focusMapChanged

public void focusMapChanged(IActiveViewEventsFocusMapChangedEvent theEvent)
                     throws IOException,
                            AutomationException

Fired when a new map is made active.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

focusMapChanged in interface IActiveViewEvents

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

spatialReferenceChanged

public void spatialReferenceChanged(IActiveViewEventsSpatialReferenceChangedEvent theEvent)
                             throws IOException,
                                    AutomationException

Fired when the spatial reference is changed.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

spatialReferenceChanged in interface IActiveViewEvents

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

contentsChanged

public void contentsChanged(IMapSurroundEventsContentsChangedEvent theEvent)
                     throws IOException,
                            AutomationException

Fired when the contents of the map surround changes.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

contentsChanged in interface IMapSurroundEvents

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

beforeDraw

public void beforeDraw(IMapSurroundEventsBeforeDrawEvent theEvent)
                throws IOException,
                       AutomationException

Fired before drawing starts.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

beforeDraw in interface IMapSurroundEvents

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

afterDraw

public void afterDraw(IMapSurroundEventsAfterDrawEvent theEvent)
               throws IOException,
                      AutomationException

Fired after drawing completes.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

afterDraw in interface IMapSurroundEvents

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws IOException,
                    AutomationException

isDirty

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

isDirty in interface IPersistStream

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws IOException,
                 AutomationException

load

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

load in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

save

public void save(IStream pstm,
                 int fClearDirty)
          throws IOException,
                 AutomationException

save

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

save in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

fClearDirty - The fClearDirty (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSizeMax

public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
                throws IOException,
                       AutomationException

getSizeMax

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getSizeMax in interface IPersistStream

Parameters:

pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getClassID

public void getClassID(GUID[] pClassID)
                throws IOException,
                       AutomationException

getClassID

Description

IPersist is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getClassID in interface IPersist

Parameters:

pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException