com.esri.arcgis.arcmapui
Interface IFinder

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

FindFeatures, IFinderProxy

public interface IFinder
extends java.io.Serializable

COM Interface 'IFinder'. Generated 3/19/2015 1:21:02 PM from 'C:\ArcGIS\COM\esriArcMapUI.olb'

Description: 'Provides access to IFinder interface for the MxFind routine. Implement this interface to create a custom find dialog page.' 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 =

Field Summary

static java.lang.String	IID Deprecated. Internal use only
static int	IIDd7410cc7_5239_11d2_a079_0000f8775bf9
static int	xxDummy Deprecated. Internal use only

Method Summary

void	find(IFindCallBack pFindCallBack) Perform find functionality.
int	getColumnCount() Number of columns to display in list box.
java.lang.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.
java.lang.String	getName() The control name.
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.

Field Detail

IIDd7410cc7_5239_11d2_a079_0000f8775bf9

static final int IIDd7410cc7_5239_11d2_a079_0000f8775bf9

See Also:

Constant Field Values

xxDummy

static final int xxDummy

Deprecated. Internal use only

See Also:

Constant Field Values

IID

static final java.lang.String IID

Deprecated. Internal use only

See Also:

Constant Field Values

Method Detail

initializeControl

void initializeControl(IApplication pApplication,
                       IFindPanelEvents pFindEventsCallBack)
                       throws java.io.IOException,
                              AutomationException

Called to initialize control.

Parameters:

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

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

updateControl

void updateControl()
                   throws java.io.IOException,
                          AutomationException

Called whenever ArcMap status changes.

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getName

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

The control name. Used for the FindUI tab.

Returns:

The name

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getColumnCount

int getColumnCount()
                   throws java.io.IOException,
                          AutomationException

Number of columns to display in list box.

Returns:

The columnCount

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getColumnName

java.lang.String getColumnName(int column)
                               throws java.io.IOException,
                                      AutomationException

The column name.

Parameters:

column - The column (in)

Returns:

The columnName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getColumnWidth

int getColumnWidth(int column)
                   throws java.io.IOException,
                          AutomationException

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

Parameters:

column - The column (in)

Returns:

The width

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMenuUID

IUID getMenuUID()
                throws java.io.IOException,
                       AutomationException

UID of menu to popup in list box.

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

find

void find(IFindCallBack pFindCallBack)
          throws java.io.IOException,
                 AutomationException

Perform find functionality.

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

stop

void stop()
          throws java.io.IOException,
                 AutomationException

User requested find to stop.

Throws:

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

AutomationException - If the ArcObject component throws an exception.

newSearch

void newSearch()
               throws java.io.IOException,
                      AutomationException

New search. Clear control input boxes.

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getHWnd

int getHWnd()
            throws java.io.IOException,
                   AutomationException

The window handle for the finder.

Returns:

The hWnd (A COM typedef)

Throws:

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

AutomationException - If the ArcObject component throws an exception.