com.esri.arcgis.arcmapui
Class HistoryViewerWindow

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

All Implemented Interfaces:

IDocumentEvents, IHistoryViewerWindow, IActiveViewEvents, IMapEvents, IDockableWindowDef, com.esri.arcgis.interop.RemoteObjRef, java.io.Serializable, java.util.EventListener

public class HistoryViewerWindow
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IDockableWindowDef, IHistoryViewerWindow, IDocumentEvents, IActiveViewEvents, IMapEvents

COM Class 'HistoryViewerWindow'. Generated 3/19/2015 1:20:50 PM from 'C:\ArcGIS\COM\esriArcMapUI.olb'

Description 'History Viewer Window' 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

Fields inherited from interface com.esri.arcgis.framework.IDockableWindowDef

IID, IID3d1fa10a_f154_11d3_a67e_0008c7df97b9, xxDummy

Fields inherited from interface com.esri.arcgis.arcmapui.IHistoryViewerWindow

IID, IID462e59c1_2fa3_4d36_98f0_22e134d9bce3, xxDummy

Fields inherited from interface com.esri.arcgis.arcmapui.IDocumentEvents

IID, IID6db7c4bd_0a7c_11d1_86aa_0000f8751720, xxDummy

Fields inherited from interface com.esri.arcgis.carto.IActiveViewEvents

IID, IIDe79c5940_52dd_11d0_98be_00805f7ced21, xxDummy

Fields inherited from interface com.esri.arcgis.carto.IMapEvents

IID, IIDd1b15b2c_0723_11d3_9f33_00c04f6bc979, xxDummy

Constructor Summary

HistoryViewerWindow()
Constructs a HistoryViewerWindow using ArcGIS Engine.

HistoryViewerWindow(java.lang.Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
HistoryViewerWindow theHistoryViewerWindow = (HistoryViewerWindow) obj;

Method Summary

void	activeViewChanged(IDocumentEventsActiveViewChangedEvent theEvent) Fired when the active view changes.
void	afterDraw(IActiveViewEventsAfterDrawEvent theEvent) Fired after the specified phase is drawn.
void	afterItemDraw(IActiveViewEventsAfterItemDrawEvent theEvent) Fired after an individual view item is drawn.
boolean	beforeCloseDocument(IDocumentEventsBeforeCloseDocumentEvent theEvent) Fired before a document is closed.
void	closeDocument(IDocumentEventsCloseDocumentEvent theEvent) Fired when a document is closed.
void	contentsChanged(IActiveViewEventsContentsChangedEvent theEvent) Fired when the contents of the view changes.
void	contentsCleared(IActiveViewEventsContentsClearedEvent theEvent) Fired when the contents of the view is cleared.
boolean	equals(java.lang.Object o) Compare this object with another
void	featureClassChanged(IMapEventsFeatureClassChangedEvent theEvent) Fired when the feature class changes.
void	focusMapChanged(IActiveViewEventsFocusMapChangedEvent theEvent) Fired when a new map is made active.
java.lang.String	getCaption() The caption of the dockable window.
int	getChildHWND() The hWnd of the window to be embedded in a dockable window.
static java.lang.String	getClsid() getClsid.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
java.lang.String	getName() The name of the dockable window.
java.lang.Object	getUserData() User defined data.
int	hashCode() the hashcode for this object
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	mapsChanged(IDocumentEventsMapsChangedEvent theEvent) Fired when a change is made to the map collection.
void	newDocument(IDocumentEventsNewDocumentEvent theEvent) Fired when a new document is created.
boolean	onContextMenu(IDocumentEventsOnContextMenuEvent theEvent) Indicates if a context menu should be displayed at the given xy location.
void	onCreate(java.lang.Object hook) Occurs when this dockable window is created and provides access to the application.
void	onDestroy() Occurs when the docking window is about to be destroyed.
void	openDocument(IDocumentEventsOpenDocumentEvent theEvent) Fired when a document is opened.
void	release() Release a HistoryViewerWindow.
void	selectionChanged(IActiveViewEventsSelectionChangedEvent theEvent) Call this function to fire the selection changed event.
void	show(int parentWindow) Show the HistoryViewerWindow.
void	spatialReferenceChanged(IActiveViewEventsSpatialReferenceChangedEvent theEvent) Fired when the spatial reference is changed.
void	versionChanged(IMapEventsVersionChangedEvent theEvent) Fired when the version changes.
void	viewRefreshed(IActiveViewEventsViewRefreshedEvent theEvent) Fired when view is refreshed before draw happens.

Methods inherited from class java.lang.Object

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

Constructor Detail

HistoryViewerWindow

public HistoryViewerWindow()
                    throws java.io.IOException,
                           java.net.UnknownHostException

Constructs a HistoryViewerWindow using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

HistoryViewerWindow

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

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
HistoryViewerWindow theHistoryViewerWindow = (HistoryViewerWindow) obj;

Construct a HistoryViewerWindow using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to HistoryViewerWindow.

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

java.io.IOException - if there are interop problems

Method Detail

getClsid

public static java.lang.String getClsid()

getClsid.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()

Deprecated. Internal use only.

Specified by:

getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

release

public void release()

Release a HistoryViewerWindow.

Specified by:

release in interface com.esri.arcgis.interop.RemoteObjRef

onCreate

public void onCreate(java.lang.Object hook)
              throws java.io.IOException,
                     AutomationException

Occurs when this dockable window is created and provides access to the application.

Specified by:

onCreate in interface IDockableWindowDef

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getChildHWND

public int getChildHWND()
                 throws java.io.IOException,
                        AutomationException

The hWnd of the window to be embedded in a dockable window.

Specified by:

getChildHWND in interface IDockableWindowDef

Returns:

The hWnd (A COM typedef)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getName

public java.lang.String getName()
                         throws java.io.IOException,
                                AutomationException

The name of the dockable window.

Specified by:

getName in interface IDockableWindowDef

Returns:

The name

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCaption

public java.lang.String getCaption()
                            throws java.io.IOException,
                                   AutomationException

The caption of the dockable window.

Specified by:

getCaption in interface IDockableWindowDef

Returns:

The caption

Throws:

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

AutomationException - If the ArcObject component throws an exception.

onDestroy

public void onDestroy()
               throws java.io.IOException,
                      AutomationException

Occurs when the docking window is about to be destroyed.

Specified by:

onDestroy in interface IDockableWindowDef

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getUserData

public java.lang.Object getUserData()
                             throws java.io.IOException,
                                    AutomationException

User defined data.

Specified by:

getUserData in interface IDockableWindowDef

Returns:

A Variant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

show

public void show(int parentWindow)
          throws java.io.IOException,
                 AutomationException

Show the HistoryViewerWindow.

Specified by:

show in interface IHistoryViewerWindow

Parameters:

parentWindow - The parentWindow (A COM typedef) (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

activeViewChanged

public void activeViewChanged(IDocumentEventsActiveViewChangedEvent theEvent)
                       throws java.io.IOException,
                              AutomationException

Fired when the active view changes.

Specified by:

activeViewChanged in interface IDocumentEvents

Parameters:

theEvent - The event

Throws:

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

AutomationException - If the ArcObject component throws an exception.

mapsChanged

public void mapsChanged(IDocumentEventsMapsChangedEvent theEvent)
                 throws java.io.IOException,
                        AutomationException

Fired when a change is made to the map collection.

Specified by:

mapsChanged in interface IDocumentEvents

Parameters:

theEvent - The event

Throws:

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

AutomationException - If the ArcObject component throws an exception.

onContextMenu

public boolean onContextMenu(IDocumentEventsOnContextMenuEvent theEvent)
                      throws java.io.IOException,
                             AutomationException

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

Specified by:

onContextMenu in interface IDocumentEvents

Parameters:

theEvent - The event

Returns:

The handled

Throws:

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

AutomationException - If the ArcObject component throws an exception.

newDocument

public void newDocument(IDocumentEventsNewDocumentEvent theEvent)
                 throws java.io.IOException,
                        AutomationException

Fired when a new document is created.

Specified by:

newDocument in interface IDocumentEvents

Parameters:

theEvent - The event

Throws:

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

AutomationException - If the ArcObject component throws an exception.

openDocument

public void openDocument(IDocumentEventsOpenDocumentEvent theEvent)
                  throws java.io.IOException,
                         AutomationException

Fired when a document is opened.

Specified by:

openDocument in interface IDocumentEvents

Parameters:

theEvent - The event

Throws:

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

AutomationException - If the ArcObject component throws an exception.

beforeCloseDocument

public boolean beforeCloseDocument(IDocumentEventsBeforeCloseDocumentEvent theEvent)
                            throws java.io.IOException,
                                   AutomationException

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

Specified by:

beforeCloseDocument in interface IDocumentEvents

Parameters:

theEvent - The event

Returns:

The abortClose

Throws:

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

AutomationException - If the ArcObject component throws an exception.

closeDocument

public void closeDocument(IDocumentEventsCloseDocumentEvent theEvent)
                   throws java.io.IOException,
                          AutomationException

Fired when a document is closed.

Specified by:

closeDocument in interface IDocumentEvents

Parameters:

theEvent - The event

Throws:

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

AutomationException - If the ArcObject component throws an exception.

contentsChanged

public void contentsChanged(IActiveViewEventsContentsChangedEvent theEvent)
                     throws java.io.IOException,
                            AutomationException

Fired when the contents of the view changes.

Specified by:

contentsChanged in interface IActiveViewEvents

Parameters:

theEvent - The event

Throws:

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

AutomationException - If the ArcObject component throws an exception.

contentsCleared

public void contentsCleared(IActiveViewEventsContentsClearedEvent theEvent)
                     throws java.io.IOException,
                            AutomationException

Fired when the contents of the view is cleared.

Specified by:

contentsCleared in interface IActiveViewEvents

Parameters:

theEvent - The event

Throws:

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

AutomationException - If the ArcObject component throws an exception.

itemAdded

public void itemAdded(IActiveViewEventsItemAddedEvent theEvent)
               throws java.io.IOException,
                      AutomationException

Fired when an item is added to the view.

Specified by:

itemAdded in interface IActiveViewEvents

Parameters:

theEvent - The event

Throws:

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

AutomationException - If the ArcObject component throws an exception.

itemDeleted

public void itemDeleted(IActiveViewEventsItemDeletedEvent theEvent)
                 throws java.io.IOException,
                        AutomationException

Fired when an item is deleted from the view.

Specified by:

itemDeleted in interface IActiveViewEvents

Parameters:

theEvent - The event

Throws:

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

AutomationException - If the ArcObject component throws an exception.

itemReordered

public void itemReordered(IActiveViewEventsItemReorderedEvent theEvent)
                   throws java.io.IOException,
                          AutomationException

Fired when a view item is reordered.

Specified by:

itemReordered in interface IActiveViewEvents

Parameters:

theEvent - The event

Throws:

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

AutomationException - If the ArcObject component throws an exception.

selectionChanged

public void selectionChanged(IActiveViewEventsSelectionChangedEvent theEvent)
                      throws java.io.IOException,
                             AutomationException

Call this function to fire the selection changed event.

Specified by:

selectionChanged in interface IActiveViewEvents

Parameters:

theEvent - The event

Throws:

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

AutomationException - If the ArcObject component throws an exception.

viewRefreshed

public void viewRefreshed(IActiveViewEventsViewRefreshedEvent theEvent)
                   throws java.io.IOException,
                          AutomationException

Fired when view is refreshed before draw happens.

Specified by:

viewRefreshed in interface IActiveViewEvents

Parameters:

theEvent - The event

Throws:

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

AutomationException - If the ArcObject component throws an exception.

afterDraw

public void afterDraw(IActiveViewEventsAfterDrawEvent theEvent)
               throws java.io.IOException,
                      AutomationException

Fired after the specified phase is drawn.

Specified by:

afterDraw in interface IActiveViewEvents

Parameters:

theEvent - The event

Throws:

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

AutomationException - If the ArcObject component throws an exception.

afterItemDraw

public void afterItemDraw(IActiveViewEventsAfterItemDrawEvent theEvent)
                   throws java.io.IOException,
                          AutomationException

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

Specified by:

afterItemDraw in interface IActiveViewEvents

Parameters:

theEvent - The event

Throws:

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

AutomationException - If the ArcObject component throws an exception.

focusMapChanged

public void focusMapChanged(IActiveViewEventsFocusMapChangedEvent theEvent)
                     throws java.io.IOException,
                            AutomationException

Fired when a new map is made active.

Specified by:

focusMapChanged in interface IActiveViewEvents

Parameters:

theEvent - The event

Throws:

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

AutomationException - If the ArcObject component throws an exception.

spatialReferenceChanged

public void spatialReferenceChanged(IActiveViewEventsSpatialReferenceChangedEvent theEvent)
                             throws java.io.IOException,
                                    AutomationException

Fired when the spatial reference is changed.

Specified by:

spatialReferenceChanged in interface IActiveViewEvents

Parameters:

theEvent - The event

Throws:

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

AutomationException - If the ArcObject component throws an exception.

versionChanged

public void versionChanged(IMapEventsVersionChangedEvent theEvent)
                    throws java.io.IOException,
                           AutomationException

Fired when the version changes.

Specified by:

versionChanged in interface IMapEvents

Parameters:

theEvent - The event

Throws:

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

AutomationException - If the ArcObject component throws an exception.

featureClassChanged

public void featureClassChanged(IMapEventsFeatureClassChangedEvent theEvent)
                         throws java.io.IOException,
                                AutomationException

Fired when the feature class changes.

Specified by:

featureClassChanged in interface IMapEvents

Parameters:

theEvent - The event

Throws:

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

AutomationException - If the ArcObject component throws an exception.