com.esri.arcgis.arcmapui
Class FindFeatures

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

All Implemented Interfaces:

IFinder, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class FindFeatures
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IFinder

Provides access to FindFeatures. Create a class with this interface (and add to category) for custom find dialog page.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

See Also:

Serialized Form

Constructor Summary

FindFeatures()
Constructs a FindFeatures using ArcGIS Engine.

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

Method Summary

boolean	equals(Object o) Compare this object with another
void	find(IFindCallBack pFindCallBack) Perform find functionality.
static String	getClsid() getClsid.
int	getColumnCount() Number of columns to display in list box.
String	getColumnName(int column) The column name.
int	getColumnWidth(int column) The column width in Dialog Units (1/4 of avg.
int	getHWnd() The window handle for the finder.
IUID	getMenuUID() UID of menu to popup in list box.
String	getName() The control name.
int	hashCode() the hashcode for this object
void	initializeControl(IApplication pApplication, IFindPanelEvents pFindEventsCallBack) Called to initialize control.
void	newSearch() New search.
void	stop() User requested find to stop.
void	updateControl() Called whenever ArcMap status changes.

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

FindFeatures

public FindFeatures()
             throws IOException,
                    UnknownHostException

Constructs a FindFeatures using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

FindFeatures

public FindFeatures(Object obj)
             throws IOException

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

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

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

initializeControl

public void initializeControl(IApplication pApplication,
                              IFindPanelEvents pFindEventsCallBack)
                       throws IOException,
                              AutomationException

Called to initialize control.

Description

Called on when the Find dialog is loaded the first time.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

initializeControl in interface IFinder

Parameters:

pApplication - A reference to a com.esri.arcgis.framework.IApplication (in)

pFindEventsCallBack - A reference to a com.esri.arcgis.arcmapui.IFindPanelEvents (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

updateControl

public void updateControl()
                   throws IOException,
                          AutomationException

Called whenever ArcMap status changes.

Description

Called by ArcMap when control needs to be redrawn.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

updateControl in interface IFinder

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getName

public String getName()
               throws IOException,
                      AutomationException

The control name. Used for the FindUI tab.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getName in interface IFinder

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getColumnCount

public int getColumnCount()
                   throws IOException,
                          AutomationException

Number of columns to display in list box.

Description

Return the number of columns the result list should contain.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getColumnCount in interface IFinder

Returns:

The columnCount

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getColumnName

public String getColumnName(int column)
                     throws IOException,
                            AutomationException

The column name.

Product Availability

Available with ArcGIS Desktop.

Specified by:

getColumnName in interface IFinder

Parameters:

column - The column (in)

Returns:

The columnName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getColumnWidth

public int getColumnWidth(int column)
                   throws IOException,
                          AutomationException

The column width in Dialog Units (1/4 of avg. char width).

Product Availability

Available with ArcGIS Desktop.

Specified by:

getColumnWidth in interface IFinder

Parameters:

column - The column (in)

Returns:

The width

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMenuUID

public IUID getMenuUID()
                throws IOException,
                       AutomationException

UID of menu to popup in list box.

Description

UID of the context menu that will be shown when the user right-clicks a value in the result list. The standard menu esriArcMapUI.FeatureFindContextMenu can be used.

You should set the value of IMXDocument::ContextItem to an ISet containing the features returned by the search to correctly support the use of a context menu.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getMenuUID in interface IFinder

Returns:

A reference to a com.esri.arcgis.system.IUID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

find

public void find(IFindCallBack pFindCallBack)
          throws IOException,
                 AutomationException

Perform find functionality.

Description

Perform the search.

Parameters such as the layer on which to perform the search and the value to search for are typically read from the controls in your tab.

You may search the layer using the IFind interface or any other selection function.

Each feature in the array corresponding to the result of the search is managed using the IFeatureFindData interface. For each feature, do set the IFeatureFindData::Layer and IFeatureFindData::ActiveView properties.

Use IFindCallBack to add these features to the result list. For each of them set the Object property and the Column values then call the AddNewRow method.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

find in interface IFinder

Parameters:

pFindCallBack - A reference to a com.esri.arcgis.arcmapui.IFindCallBack (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

stop

public void stop()
          throws IOException,
                 AutomationException

User requested find to stop.

Description

Called when the user clicks on the Stop button.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

stop in interface IFinder

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

newSearch

public void newSearch()
               throws IOException,
                      AutomationException

New search. Clear control input boxes.

Description

Called when the user clicks on the New Search button.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

newSearch in interface IFinder

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getHWnd

public int getHWnd()
            throws IOException,
                   AutomationException

The window handle for the finder.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getHWnd in interface IFinder

Returns:

The hWnd (A COM typedef)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.