com.esri.arcgis.catalogUI
Class FindDialog

java.lang.Object
  com.esri.arcgis.catalogUI.FindDialog

All Implemented Interfaces:

IGxSelectionEvents, IFindDialog, ISearchEngineEvents, IDllThreadManager, com.esri.arcgis.interop.RemoteObjRef, Serializable, EventListener

public class FindDialog
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IFindDialog, ISearchEngineEvents, IGxSelectionEvents, IDllThreadManager

The Search dialog box.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Singleton:

This type is a singleton.

See Also:

Serialized Form

Constructor Summary

FindDialog()
Constructs a FindDialog using ArcGIS Engine.

FindDialog(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
FindDialog theFindDialog = (FindDialog) obj;

Method Summary

void	doSearch(IQuery pQuery) Starts executing the search defined by the query.
boolean	equals(Object o) Compare this object with another
static String	getClsid() getClsid.
int	getNumSearchEngines() Number of available search engines.
ISearchEngine	getSearchEngine(int index) The nth search engine.
int	hashCode() the hashcode for this object
void	initialize(IQuery pQuery) Initializes the dialog box based on a query's parameters and then opens it.
boolean	isVisible() Indicates if the dialog box is visible.
void	objectFound(ISearchEngineEventsObjectFoundEvent theEvent) Fired when an object is found that satisfies the search criteria.
void	onSelectionChanged(IGxSelectionEventsOnSelectionChangedEvent theEvent) Called when the selection contents have changed.
void	onShutdown() Occurs when the application is shutting down.
void	searchCanceled(ISearchEngineEventsSearchCanceledEvent theEvent) Fired when the search is explicitly canceled.
void	searchFailed(ISearchEngineEventsSearchFailedEvent theEvent) Fired when the search terminates prematurely.
void	searchFinished(ISearchEngineEventsSearchFinishedEvent theEvent) Fired when the search is complete.
void	searchLocationChanged(ISearchEngineEventsSearchLocationChangedEvent theEvent) Fired when the search begins looking inside a new folder or other container.
void	show(boolean bShow) Initializes the dialog box and opens it if indicated.
void	stopSearch() Cancels an ongoing search.

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

FindDialog

public FindDialog()
           throws IOException,
                  UnknownHostException

Constructs a FindDialog using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

FindDialog

public FindDialog(Object obj)
           throws IOException

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

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

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems

Method Detail

getClsid

public static String getClsid()

getClsid.

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

show

public void show(boolean bShow)
          throws IOException,
                 AutomationException

Initializes the dialog box and opens it if indicated.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

show in interface IFindDialog

Parameters:

bShow - The bShow (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 dialog box is visible.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

isVisible in interface IFindDialog

Returns:

The pVisible

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

doSearch

public void doSearch(IQuery pQuery)
              throws IOException,
                     AutomationException

Starts executing the search defined by the query.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

doSearch in interface IFindDialog

Parameters:

pQuery - A reference to a com.esri.arcgis.catalog.IQuery (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

stopSearch

public void stopSearch()
                throws IOException,
                       AutomationException

Cancels an ongoing search.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

stopSearch in interface IFindDialog

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

initialize

public void initialize(IQuery pQuery)
                throws IOException,
                       AutomationException

Initializes the dialog box based on a query's parameters and then opens it.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

initialize in interface IFindDialog

Parameters:

pQuery - A reference to a com.esri.arcgis.catalog.IQuery (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getNumSearchEngines

public int getNumSearchEngines()
                        throws IOException,
                               AutomationException

Number of available search engines.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getNumSearchEngines in interface IFindDialog

Returns:

The num

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSearchEngine

public ISearchEngine getSearchEngine(int index)
                              throws IOException,
                                     AutomationException

The nth search engine.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getSearchEngine in interface IFindDialog

Parameters:

index - The index (in)

Returns:

A reference to a com.esri.arcgis.catalogUI.ISearchEngine

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

objectFound

public void objectFound(ISearchEngineEventsObjectFoundEvent theEvent)
                 throws IOException,
                        AutomationException

Fired when an object is found that satisfies the search criteria.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

objectFound in interface ISearchEngineEvents

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

searchFinished

public void searchFinished(ISearchEngineEventsSearchFinishedEvent theEvent)
                    throws IOException,
                           AutomationException

Fired when the search is complete.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

searchFinished in interface ISearchEngineEvents

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

searchFailed

public void searchFailed(ISearchEngineEventsSearchFailedEvent theEvent)
                  throws IOException,
                         AutomationException

Fired when the search terminates prematurely.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

searchFailed in interface ISearchEngineEvents

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

searchCanceled

public void searchCanceled(ISearchEngineEventsSearchCanceledEvent theEvent)
                    throws IOException,
                           AutomationException

Fired when the search is explicitly canceled.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

searchCanceled in interface ISearchEngineEvents

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

searchLocationChanged

public void searchLocationChanged(ISearchEngineEventsSearchLocationChangedEvent theEvent)
                           throws IOException,
                                  AutomationException

Fired when the search begins looking inside a new folder or other container.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

searchLocationChanged in interface ISearchEngineEvents

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onSelectionChanged

public void onSelectionChanged(IGxSelectionEventsOnSelectionChangedEvent theEvent)
                        throws IOException,
                               AutomationException

Called when the selection contents have changed.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

onSelectionChanged in interface IGxSelectionEvents

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onShutdown

public void onShutdown()
                throws IOException,
                       AutomationException

Occurs when the application is shutting down. DLL threads should be terminated upon receiving this message.

Remarks

This method notifies the dll thread manager object that the application is shutting down so that the dll thread manager can terminate any threads that were created by the components in that dll.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

onShutdown in interface IDllThreadManager

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.