com.esri.arcgis.analyst3d
Interface IMessageDispatcher

All Superinterfaces:

Serializable

All Known Implementing Classes:

MessageDispatcher

public interface IMessageDispatcher
extends 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.

Method Summary

void	dispatch(int hWnd, boolean bSingle, 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, 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.

Method Detail

isCancelOnEscPress

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

Returns:

The pbCancelOnEscPress

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCancelOnEscPress

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

Parameters:

pbCancelOnEscPress - The pbCancelOnEscPress (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isCancelOnClick

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

Returns:

The pbCancelOnClick

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCancelOnClick

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

Parameters:

pbCancelOnClick - The pbCancelOnClick (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isCancelled

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.

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

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

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

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

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.