org.lyra
Class AbstractBlock

java.lang.Object
  org.lyra.AbstractBlock

Direct Known Subclasses:

InfiniteDialogImpl, InfiniteProgressImpl, NullBlock

public abstract class AbstractBlock
extends java.lang.Object

An abstract class which provides a consistent interface for other classes to access when wanting to block a user interface. This permits us to change or provide choice in the blocking method without major code changes.

Version:

1.0.5, %Revision, 174%, %LastChangedDate, 27/10/12 3:33PM%

Author:

Martin Foster

Constructor Summary

AbstractBlock()

Method Summary

abstract java.lang.String	getMessage() Returns the message currently being displayed.
abstract void	setMessage(java.lang.String msg) Permits an update of the notice message displayed.
abstract void	startBlock() Starts the blocking capability.
abstract void	stopBlock() Notice of blocked interface is removed and control returned to the user.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractBlock

public AbstractBlock()

Method Detail

startBlock

public abstract void startBlock()

Starts the blocking capability. Should prevent the user from accessing the main interface and notify that a blocking event is taking place.

stopBlock

public abstract void stopBlock()

Notice of blocked interface is removed and control returned to the user.

setMessage

public abstract void setMessage(java.lang.String msg)

Permits an update of the notice message displayed.

Parameters:

msg - String containing new message.

getMessage

public abstract java.lang.String getMessage()

Returns the message currently being displayed.

Returns:

String containing current message.