com.esri.arcgis.analyst3d
Class IMessageDispatcherProxy

java.lang.Object
  com.esri.arcgis.interop.Dispatch
      com.esri.arcgis.analyst3d.IMessageDispatcherProxy

All Implemented Interfaces:

java.io.Externalizable, IMessageDispatcher, java.io.Serializable

public class IMessageDispatcherProxy

extends Dispatch

implements IMessageDispatcher, java.io.Serializable

Provides access to members for manipulating message queue and keeping track of cancellation.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

See Also:

Serialized Form

Field Summary

static java.lang.Class

targetClass

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

DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF

Constructor Summary

	IMessageDispatcherProxy() For internal use only
	IMessageDispatcherProxy(java.lang.Object obj)
protected	IMessageDispatcherProxy(java.lang.Object obj, java.lang.String iid)
	IMessageDispatcherProxy(java.lang.String CLSID, java.lang.String host, AuthInfo authInfo)
protected	IMessageDispatcherProxy(java.lang.String CLSID, java.lang.String iid, java.lang.String host, AuthInfo authInfo)

Method Summary

void	addListener(java.lang.String iidStr, java.lang.Object theListener, java.lang.Object theSource) Adds a Java object to be a listener for a specific kind of event generated by the COM object.
void	dispatch(int hWnd, boolean bSingle, java.lang.Object[] pbCancelled) Dispatchs messages associated with the window.
boolean	isCancelled(int hWnd) Indicates if a cancel action has been conducted.
boolean	isCancelOnClick() Indicates if a mouse click is seen as a cancel action.
boolean	isCancelOnEscPress() Indicates if pressing the escape key is seen as a cancel action.
void	remove(int hWnd, boolean bSingle, java.lang.Object[] pbCancelled) Removes messages associated with the window.
void	removeListener(java.lang.String iidStr, java.lang.Object theListener) Removes a Java object as a listener to events generated by a COM object.
void	setCancelOnClick(boolean pbCancelOnClick) Indicates if a mouse click is seen as a cancel action.
void	setCancelOnEscPress(boolean pbCancelOnEscPress) Indicates if pressing the escape key is seen as a cancel action.

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

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

Methods inherited from class java.lang.Object

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

Field Detail

targetClass

public static final java.lang.Class targetClass

Constructor Detail

IMessageDispatcherProxy

public IMessageDispatcherProxy(java.lang.String CLSID,
                               java.lang.String host,
                               AuthInfo authInfo)
                        throws java.net.UnknownHostException,
                               java.io.IOException

IMessageDispatcherProxy

public IMessageDispatcherProxy()

For internal use only

IMessageDispatcherProxy

public IMessageDispatcherProxy(java.lang.Object obj)
                        throws java.io.IOException

IMessageDispatcherProxy

protected IMessageDispatcherProxy(java.lang.Object obj,
                                  java.lang.String iid)
                           throws java.io.IOException

IMessageDispatcherProxy

protected IMessageDispatcherProxy(java.lang.String CLSID,
                                  java.lang.String iid,
                                  java.lang.String host,
                                  AuthInfo authInfo)
                           throws java.io.IOException

Method Detail

addListener

public void addListener(java.lang.String iidStr,
                        java.lang.Object theListener,
                        java.lang.Object theSource)
                 throws java.io.IOException

Description copied from class: Dispatch

Adds a Java object to be a listener for a specific kind of event generated by the COM object. when you wish to invoke method on the COM object using IDispatch (not using custom marshalling).

Overrides:

addListener in class Dispatch

Parameters:

iidStr - the ID of the outgoing interface, implemented by the listener

theListener - the object to be informed of the events

theSource - the proxy class that represents the COM class that is the source of the events

Throws:

java.io.IOException

removeListener

public void removeListener(java.lang.String iidStr,
                           java.lang.Object theListener)
                    throws java.io.IOException

Description copied from class: Dispatch

Removes a Java object as a listener to events generated by a COM object. when you wish to invoke method on the COM object using IDispatch (not using custom marshalling).

Overrides:

removeListener in class Dispatch

Parameters:

iidStr - the ID of the outgoing interface, implemented by the listener

theListener - the object that no longer wishes to be informed of the events

Throws:

java.io.IOException

isCancelOnEscPress

public boolean isCancelOnEscPress()
                           throws java.io.IOException,
                                  AutomationException

Description copied from interface: IMessageDispatcher

Indicates if pressing the escape key is seen as a cancel action.

Supported Platforms

Windows, Solaris, Linux

Specified by:

isCancelOnEscPress in interface IMessageDispatcher

Returns:

The pbCancelOnEscPress

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setCancelOnEscPress

public void setCancelOnEscPress(boolean pbCancelOnEscPress)
                         throws java.io.IOException,
                                AutomationException

Description copied from interface: IMessageDispatcher

Indicates if pressing the escape key is seen as a cancel action.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setCancelOnEscPress in interface IMessageDispatcher

Parameters:

pbCancelOnEscPress - The pbCancelOnEscPress (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

isCancelOnClick

public boolean isCancelOnClick()
                        throws java.io.IOException,
                               AutomationException

Description copied from interface: IMessageDispatcher

Indicates if a mouse click is seen as a cancel action.

Supported Platforms

Windows, Solaris, Linux

Specified by:

isCancelOnClick in interface IMessageDispatcher

Returns:

The pbCancelOnClick

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setCancelOnClick

public void setCancelOnClick(boolean pbCancelOnClick)
                      throws java.io.IOException,
                             AutomationException

Description copied from interface: IMessageDispatcher

Indicates if a mouse click is seen as a cancel action.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setCancelOnClick in interface IMessageDispatcher

Parameters:

pbCancelOnClick - The pbCancelOnClick (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

isCancelled

public boolean isCancelled(int hWnd)
                    throws java.io.IOException,
                           AutomationException

Description copied from interface: IMessageDispatcher

Indicates if a cancel action has been conducted.

Supported Platforms

Windows, Solaris, Linux

Specified by:

isCancelled in interface IMessageDispatcher

Parameters:

hWnd - The hWnd (A COM typedef) (in)

Returns:

The pbCancelled

Throws:

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

AutomationException - If the ArcObject component throws an exception.

dispatch

public void dispatch(int hWnd,
                     boolean bSingle,
                     java.lang.Object[] pbCancelled)
              throws java.io.IOException,
                     AutomationException

Description copied from interface: IMessageDispatcher

Dispatchs messages associated with the window.

Supported Platforms

Windows, Solaris, Linux

Specified by:

dispatch in interface IMessageDispatcher

Parameters:

hWnd - The hWnd (A COM typedef) (in)

bSingle - The bSingle (in)

pbCancelled - A Variant (out: use single element array, optional, pass single element of null if not required)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

remove

public void remove(int hWnd,
                   boolean bSingle,
                   java.lang.Object[] pbCancelled)
            throws java.io.IOException,
                   AutomationException

Description copied from interface: IMessageDispatcher

Removes messages associated with the window.

Supported Platforms

Windows, Solaris, Linux

Specified by:

remove in interface IMessageDispatcher

Parameters:

hWnd - The hWnd (A COM typedef) (in)

bSingle - The bSingle (in)

pbCancelled - A Variant (out: use single element array, optional, pass single element of null if not required)

Throws:

AutomationException - If the ArcObject component throws an exception.

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