com.esri.arcgis.analyst3d
Class MessageDispatcher

java.lang.Object
  com.esri.arcgis.analyst3d.MessageDispatcher

All Implemented Interfaces:

IMessageDispatcher, com.esri.arcgis.interop.RemoteObjRef, java.io.Serializable

public class MessageDispatcher
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IMessageDispatcher

COM Class 'MessageDispatcher'. Generated 3/19/2015 1:20:41 PM from 'C:\ArcGIS\COM\esri3DAnalyst.olb'

Description 'A mechanism for manipulating message queue.' 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 =

See Also:

Serialized Form

Field Summary

Fields inherited from interface com.esri.arcgis.analyst3d.IMessageDispatcher

IID, IIDbd62a8fa_8833_11d4_ab87_0008c73fd50c, xxDummy

Constructor Summary

MessageDispatcher()
Constructs a MessageDispatcher using ArcGIS Engine.

MessageDispatcher(java.lang.Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
MessageDispatcher theMessageDispatcher = (MessageDispatcher) obj;

Method Summary

void	dispatch(int hWnd, boolean bSingle, java.lang.Object[] pbCancelled) Dispatchs messages associated with the window.
boolean	equals(java.lang.Object o) Compare this object with another
static java.lang.String	getClsid() getClsid.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
int	hashCode() the hashcode for this object
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	release() Release a MessageDispatcher.
void	remove(int hWnd, boolean bSingle, java.lang.Object[] pbCancelled) Removes messages associated with the window.
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 java.lang.Object

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

Constructor Detail

MessageDispatcher

public MessageDispatcher()
                  throws java.io.IOException,
                         java.net.UnknownHostException

Constructs a MessageDispatcher using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

MessageDispatcher

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

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

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

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

java.io.IOException - if there are interop problems

Method Detail

getClsid

public static java.lang.String getClsid()

getClsid.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()

Deprecated. Internal use only.

Specified by:

getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

release

public void release()

Release a MessageDispatcher.

Specified by:

release in interface com.esri.arcgis.interop.RemoteObjRef

isCancelOnEscPress

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

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

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

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

Specified by:

setCancelOnEscPress in interface IMessageDispatcher

Parameters:

pbCancelOnEscPress - The pbCancelOnEscPress (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isCancelOnClick

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

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

Specified by:

isCancelOnClick in interface IMessageDispatcher

Returns:

The pbCancelOnClick

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setCancelOnClick

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

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

Specified by:

setCancelOnClick in interface IMessageDispatcher

Parameters:

pbCancelOnClick - The pbCancelOnClick (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isCancelled

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

Indicates if a cancel action has been conducted.

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

Dispatchs messages associated with the window.

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

Removes messages associated with the window.

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:

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

AutomationException - If the ArcObject component throws an exception.