com.esri.arcgis.systemUI
Class ICompletionNotifyProxy

java.lang.Object
  com.esri.arcgis.interop.Dispatch
      com.esri.arcgis.systemUI.ICompletionNotifyProxy

All Implemented Interfaces:

ICompletionNotify, Externalizable, Serializable

public class ICompletionNotifyProxy
extends com.esri.arcgis.interop.Dispatch
implements ICompletionNotify, Serializable

Provides access to a method that advises the framework that the control user has indicated completion.

Remarks

When a ToolControl object gains focus, an ICompletionNotify object is passed to the ToolControl in the IToolControl::OnFocus method.

When To Use

The ICompletionNotify interface provides the IToolControl interface a mechanism to report to the application that the ToolControl no longer needs focus.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

See Also:

IToolControl.onFocus(com.esri.arcgis.systemUI.ICompletionNotify), 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

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

Method Summary

void	addListener(String iidStr, Object theListener, Object theSource)
void	removeListener(String iidStr, Object theListener)
void	setComplete() Advises the framework that the control user has indicated completion.

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

ICompletionNotifyProxy

public ICompletionNotifyProxy()

ICompletionNotifyProxy

public ICompletionNotifyProxy(Object obj)
                       throws IOException

Throws:

IOException

ICompletionNotifyProxy

protected ICompletionNotifyProxy(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

setComplete

public void setComplete()
                 throws IOException,
                        AutomationException

Advises the framework that the control user has indicated completion.

Remarks

When a ToolControl object gains focus, an ICompletionNotify object is passed to the ToolControl in the IToolControl::OnFocus method. The ToolControl needs to call the SetComplete method when it's finished to let the application know that the control should lose focus.

For example, a combobox control should lose focus after a user selects an item in the combobox. In this case in you would call SetComplete in the Click event of the combobox control.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setComplete in interface ICompletionNotify

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.