com.esri.arcgis.arcmapui
Class IFindCallBackProxy

java.lang.Object
  com.esri.arcgis.interop.Dispatch
      com.esri.arcgis.arcmapui.IFindCallBackProxy

All Implemented Interfaces:

IFindCallBack, Externalizable, Serializable

public class IFindCallBackProxy
extends com.esri.arcgis.interop.Dispatch
implements IFindCallBack, Serializable

Provides access to members that control the results in a custom find dialog page.

Remarks

See the IFinder interface for documentation and an example (VB6) of use.

Performing a search with a Find tab will typically return an array of features used to populate the result list that automatically appears at the bottom of the dialog. Populating this list is done with the IFindCallBack and IFeatureFindData interfaces.

Product Availability

Available with ArcGIS Desktop.

See Also:

Serialized Form

Field Summary

boolean

noncastable

Fields inherited from class com.esri.arcgis.interop.Dispatch

DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, objRef

Constructor Summary

	IFindCallBackProxy()
	IFindCallBackProxy(Object obj)
protected	IFindCallBackProxy(Object obj, String iid)

Method Summary

void	addListener(String iidStr, Object theListener, Object theSource)
void	addNewRow() Adds a new row to the listbox, using values set with ColumnValue.
void	flashGeometry(IGeometry pGeometry, int nTimes, boolean bCoolFlash) Generic method to flash a point on the display n times.
IApplication	getApplication() The application that this dialog belongs to.
int	getColumnCount() Number of columns to display in list box.
void	processMessages(boolean[] quitProcessing) Processes messages.
void	removeListener(String iidStr, Object theListener)
void	setColumnValue(int column, String rhs2) Rows column value in listbox.
void	setObjectByRef(Object rhs1) The object value of the new row.

Methods inherited from class com.esri.arcgis.interop.Dispatch

bindUsingMoniker, constructVtblPosTable, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, getVtblPos, hashCode, initDispatch, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, optimizedVtblInvoke, queryInterface, readExternal, release, setNativeMode, setPropertyByName, toString, vtblInvoke, writeExternal

Methods inherited from class java.lang.Object

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

Field Detail

noncastable

public boolean noncastable

Constructor Detail

IFindCallBackProxy

public IFindCallBackProxy()

IFindCallBackProxy

public IFindCallBackProxy(Object obj)
                   throws IOException

Throws:

IOException

IFindCallBackProxy

protected IFindCallBackProxy(Object obj,
                             String iid)
                      throws IOException

Throws:

IOException

Method Detail

addListener

public void addListener(String iidStr,
                        Object theListener,
                        Object theSource)
                 throws IOException

Overrides:

addListener in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

removeListener

public void removeListener(String iidStr,
                           Object theListener)
                    throws IOException

Overrides:

removeListener in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

getApplication

public IApplication getApplication()
                            throws IOException,
                                   AutomationException

The application that this dialog belongs to.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getApplication in interface IFindCallBack

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setObjectByRef

public void setObjectByRef(Object rhs1)
                    throws IOException,
                           AutomationException

The object value of the new row. This object is passed to the popup menu in an ISet.

Description

The object to show as a new row in the value list. Typically an IFeatureFindData.

Remarks

A reference to a feature

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setObjectByRef in interface IFindCallBack

Parameters:

rhs1 - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setColumnValue

public void setColumnValue(int column,
                           String rhs2)
                    throws IOException,
                           AutomationException

Rows column value in listbox.

Product Availability

Available with ArcGIS Desktop.

Specified by:

setColumnValue in interface IFindCallBack

Parameters:

column - The column (in)

rhs2 - The rhs2 (in)

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

The number of columns in the value list.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getColumnCount in interface IFindCallBack

Returns:

The columnCount

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addNewRow

public void addNewRow()
               throws IOException,
                      AutomationException

Adds a new row to the listbox, using values set with ColumnValue.

Description

Adds a new row to the value list. Should be called once the properties of this interface and IFeatureFindData have been properly initialized.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

addNewRow in interface IFindCallBack

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

processMessages

public void processMessages(boolean[] quitProcessing)
                     throws IOException,
                            AutomationException

Processes messages. Run this method often.

Description

Optionally call this method in the loop adding features to the value list of the Find dialog and stop populating the list when it returns false to give the user a chance to interrupt the process.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

processMessages in interface IFindCallBack

Parameters:

quitProcessing - The quitProcessing (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

flashGeometry

public void flashGeometry(IGeometry pGeometry,
                          int nTimes,
                          boolean bCoolFlash)
                   throws IOException,
                          AutomationException

Generic method to flash a point on the display n times.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

flashGeometry in interface IFindCallBack

Parameters:

pGeometry - A reference to a com.esri.arcgis.geometry.IGeometry (in)

nTimes - The nTimes (in)

bCoolFlash - The bCoolFlash (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.