com.esri.arcgis.analyst3d
Class MessageDispatcher

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

All Implemented Interfaces:

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

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

A mechanism for manipulating message queue.

Remarks

MessageDispatcher coclass is used for interrupting an animated scene.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:

Serialized Form

Constructor Summary

MessageDispatcher()
Constructs a MessageDispatcher using ArcGIS Engine.

MessageDispatcher(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, Object[] pbCancelled) Dispatchs messages associated with the window.
boolean	equals(Object o) Compare this object with another
static String	getClsid() getClsid.
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	remove(int hWnd, boolean bSingle, 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

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef

getJintegraDispatch, release

Constructor Detail

MessageDispatcher

public MessageDispatcher()
                  throws IOException,
                         UnknownHostException

Constructs a MessageDispatcher using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

MessageDispatcher

public MessageDispatcher(Object obj)
                  throws 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:

IOException - if there are interop problems

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

isCancelOnEscPress

public boolean isCancelOnEscPress()
                           throws IOException,
                                  AutomationException

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isCancelOnEscPress in interface IMessageDispatcher

Returns:

The pbCancelOnEscPress

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCancelOnEscPress

public void setCancelOnEscPress(boolean pbCancelOnEscPress)
                         throws IOException,
                                AutomationException

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setCancelOnEscPress in interface IMessageDispatcher

Parameters:

pbCancelOnEscPress - The pbCancelOnEscPress (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isCancelOnClick

public boolean isCancelOnClick()
                        throws IOException,
                               AutomationException

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isCancelOnClick in interface IMessageDispatcher

Returns:

The pbCancelOnClick

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCancelOnClick

public void setCancelOnClick(boolean pbCancelOnClick)
                      throws IOException,
                             AutomationException

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setCancelOnClick in interface IMessageDispatcher

Parameters:

pbCancelOnClick - The pbCancelOnClick (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isCancelled

public boolean isCancelled(int hWnd)
                    throws IOException,
                           AutomationException

Indicates if a cancel action has been conducted.

Product Availability

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

Specified by:

isCancelled in interface IMessageDispatcher

Parameters:

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

Returns:

The pbCancelled

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

dispatch

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

Dispatchs messages associated with the window.

Product Availability

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

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:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

remove

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

Removes messages associated with the window.

Product Availability

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

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:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.