com.esri.arcgis.analyst3d
Interface IMessageDispatcher

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

IMessageDispatcherProxy, MessageDispatcher

public interface IMessageDispatcher
extends java.io.Serializable

COM Interface 'IMessageDispatcher'. Generated 3/19/2015 1:20:51 PM from 'C:\ArcGIS\COM\esri3DAnalyst.olb'

Description: 'Provides access to members for manipulating message queue and keeping track of cancellation.' 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 =

Field Summary

static java.lang.String	IID Deprecated. Internal use only
static int	IIDbd62a8fa_8833_11d4_ab87_0008c73fd50c
static int	xxDummy Deprecated. Internal use only

Method Summary

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	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.

Field Detail

IIDbd62a8fa_8833_11d4_ab87_0008c73fd50c

static final int IIDbd62a8fa_8833_11d4_ab87_0008c73fd50c

See Also:

Constant Field Values

xxDummy

static final int xxDummy

Deprecated. Internal use only

See Also:

Constant Field Values

IID

static final java.lang.String IID

Deprecated. Internal use only

See Also:

Constant Field Values

Method Detail

isCancelOnEscPress

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

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

Returns:

The pbCancelOnEscPress

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setCancelOnEscPress

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

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

Parameters:

pbCancelOnEscPress - The pbCancelOnEscPress (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isCancelOnClick

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

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

Returns:

The pbCancelOnClick

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setCancelOnClick

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

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

Parameters:

pbCancelOnClick - The pbCancelOnClick (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isCancelled

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

Indicates if a cancel action has been conducted.

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

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

Dispatchs messages associated with the window.

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

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

Removes messages associated with the window.

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.