com.esri.arcgis.arcmapui
Class FindWindowUI

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

All Implemented Interfaces:

IDocumentEvents, IFindPanelEvents, IFindWindow, IFindWindow2, IActiveViewEvents, com.esri.arcgis.interop.RemoteObjRef, java.io.Serializable, java.util.EventListener

public class FindWindowUI
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IFindWindow, IFindWindow2, IActiveViewEvents, IDocumentEvents, IFindPanelEvents

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

Description 'Window to display Find dialog in. Deprecated. Please consider using the IFind interface in the Carto library instead.' 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.arcmapui.IFindWindow2

IID, IIDf609e798_026d_435a_8627_039275ecf606, xxDummy

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

IID212a710b_4c00_11d2_a079_0000f8775bf9

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

IID, IIDe79c5940_52dd_11d0_98be_00805f7ced21, xxDummy

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

IID, IID6db7c4bd_0a7c_11d1_86aa_0000f8751720, xxDummy

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

IID, IID8f8de9d8_3a48_11d3_9f58_00c04f8ed1c4, xxDummy

Constructor Summary

FindWindowUI()
Constructs a FindWindowUI using ArcGIS Engine.

FindWindowUI(java.lang.Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
FindWindowUI theFindWindowUI = (FindWindowUI) 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	executeFind(boolean refreshResultsOnly) Tells Find Dialog to execute a find.
void	focusMapChanged(IActiveViewEventsFocusMapChangedEvent theEvent) Fired when a new map is made active.
IApplication	getApplication() The application to which the window belongs.
static java.lang.String	getClsid() getClsid.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
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	openDocument(IDocumentEventsOpenDocumentEvent theEvent) Fired when a document is opened.
void	outputsChanged() Notifies Find Dialog that the outputs of the find panel have changed.
void	release() Release a FindWindowUI.
void	selectionChanged(IActiveViewEventsSelectionChangedEvent theEvent) Call this function to fire the selection changed event.
void	setApplicationByRef(java.lang.Object pApplication) The application to which the window belongs.
void	setCategoryID(IUID rhs1) The component category to use in the Find Window.
void	show(boolean show) Shows or hides the window.
void	spatialReferenceChanged(IActiveViewEventsSpatialReferenceChangedEvent theEvent) Fired when the spatial reference is changed.
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

FindWindowUI

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

Constructs a FindWindowUI using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

FindWindowUI

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

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

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

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 FindWindowUI.

Specified by:

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

setApplicationByRef

public void setApplicationByRef(java.lang.Object pApplication)
                         throws java.io.IOException,
                                AutomationException

The application to which the window belongs.

Specified by:

setApplicationByRef in interface IFindWindow

Parameters:

pApplication - 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.

getApplication

public IApplication getApplication()
                            throws java.io.IOException,
                                   AutomationException

The application to which the window belongs.

Specified by:

getApplication in interface IFindWindow

Returns:

A reference to a com.esri.arcgis.framework.IApplication

Throws:

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

AutomationException - If the ArcObject component throws an exception.

show

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

Shows or hides the window.

Specified by:

show in interface IFindWindow

Parameters:

show - The show (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setCategoryID

public void setCategoryID(IUID rhs1)
                   throws java.io.IOException,
                          AutomationException

The component category to use in the Find Window.

Specified by:

setCategoryID in interface IFindWindow2

Parameters:

rhs1 - A reference to a com.esri.arcgis.system.IUID (in)

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.

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.

outputsChanged

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

Notifies Find Dialog that the outputs of the find panel have changed.

Specified by:

outputsChanged in interface IFindPanelEvents

Throws:

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

AutomationException - If the ArcObject component throws an exception.

executeFind

public void executeFind(boolean refreshResultsOnly)
                 throws java.io.IOException,
                        AutomationException

Tells Find Dialog to execute a find. If the parameter passed is true, the dialog will only find if there are already results showing.

Specified by:

executeFind in interface IFindPanelEvents

Parameters:

refreshResultsOnly - The refreshResultsOnly (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.