net.sf.cuf.fw2

Class BlockEvent

java.lang.Object

java.util.EventObject

net.sf.cuf.appevent.AppEvent

net.sf.cuf.fw2.BlockEvent

All Implemented Interfaces:

Serializable

public class BlockEvent
extends AppEvent

A BlockEvent is used to by a Dc/Pc to signal "the user should not make any further input".

See Also:

Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor and Description
BlockEvent(Object pSource, boolean pBlock) Create a non-consumed event to block or unblock the GUI.
BlockEvent(Object pSource, boolean pBlock, long pEstimatedBlockDuration, boolean pReFocus) Common constructor code
BlockEvent(Object pSource, long pEstimatedBlockDuration) Create a non-consumed event to block the GUI.

Method Summary

Modifier and Type	Method and Description
static BlockEvent	createBlockEvent(Object pSource)
static BlockEvent	createNoRefocusUnBlockEvent(Object pSource)
static BlockEvent	createUnBlockEvent(Object pSource)
long	getEstimatedBlockDuration() Returns the estimated time the block will take, -1 if we don't know.
boolean	isBlock() Returns true if the event is sent to block the GUI, false if the GUI should be unblocked.
boolean	isReFocus()

Methods inherited from class net.sf.cuf.appevent.AppEvent

consume, forward, isConsumed, toString

Methods inherited from class java.util.EventObject

getSource

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

BlockEvent

public BlockEvent(Object pSource,
                  boolean pBlock)

Create a non-consumed event to block or unblock the GUI.

Parameters:

pSource - null or event source

pBlock - flag if we should block (true) or unblock (false)

BlockEvent

public BlockEvent(Object pSource,
                  long pEstimatedBlockDuration)

Create a non-consumed event to block the GUI.

Parameters:

pSource - null or event source

pEstimatedBlockDuration - -1 or the estimated duration of the block

BlockEvent

public BlockEvent(Object pSource,
                  boolean pBlock,
                  long pEstimatedBlockDuration,
                  boolean pReFocus)

Common constructor code

Parameters:

pSource - null or event source

pBlock - flag if we should block (true) or unblock (false)

pEstimatedBlockDuration - -1 or the estimated duration of the block

pReFocus - flag if we should re-focus on unblock or not, ignored if pBlock is true

Method Detail

createBlockEvent

public static BlockEvent createBlockEvent(Object pSource)

createUnBlockEvent

public static BlockEvent createUnBlockEvent(Object pSource)

createNoRefocusUnBlockEvent

public static BlockEvent createNoRefocusUnBlockEvent(Object pSource)

isBlock

public boolean isBlock()

Returns true if the event is sent to block the GUI, false if the GUI should be unblocked.

Returns:

true if GUI should be blocked

getEstimatedBlockDuration

public long getEstimatedBlockDuration()

Returns the estimated time the block will take, -1 if we don't know.

Returns:

estimated block time

isReFocus

public boolean isReFocus()

Returns:

true if we should refocus on unblocking