org.lyra.Block
Class InfiniteProgressImpl

java.lang.Object
  org.lyra.AbstractBlock
      org.lyra.Block.InfiniteProgressImpl

public class InfiniteProgressImpl
extends AbstractBlock

The org.lyra.Widgets.InfiniteProgressPanel class is the preferred method for blocking the user interface. However it can lead to slow downs due to the graphics intensive method.

Version:

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

Author:

Martin Foster

See Also:

InfiniteProgressPanel

Field Summary

private InfiniteProgressPanel	Block
private static java.lang.String	CLASS
static java.lang.String	IDENT Identifier for this class allowing us to set it apart from other implementations which currently exist.
private Ledger	Logger
private java.lang.String	Message

Constructor Summary

InfiniteProgressImpl(Ledger logger, java.lang.String msg)
Constructor for the class.

Method Summary

java.lang.String	getMessage() Returns the message currently being displayed.
InfiniteProgressPanel	getPane() Provides an instance of the InfiniteProgressPanel that can be implemented into another instance.
void	setMessage(java.lang.String msg) Permits an update of the notice message displayed.
void	startBlock() Starts the blocking capability.
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

Field Detail

IDENT

public static final java.lang.String IDENT

Identifier for this class allowing us to set it apart from other implementations which currently exist.

See Also:

Constant Field Values

CLASS

private static final java.lang.String CLASS

See Also:

Constant Field Values

Block

private InfiniteProgressPanel Block

Message

private java.lang.String Message

Logger

private Ledger Logger

Constructor Detail

InfiniteProgressImpl

public InfiniteProgressImpl(Ledger logger,
                            java.lang.String msg)

Constructor for the class. Creates an instance of the InfiniteProgressPanel will interface an application class with a proper interface.

Parameters:

logger - Instance of ledger for logging errors and warnings.

msg - Sting message containing initial statement to display.

Method Detail

getPane

public InfiniteProgressPanel getPane()

Provides an instance of the InfiniteProgressPanel that can be implemented into another instance.

Returns:

Component capable of being dropped into a JGlassPane.

startBlock

public void startBlock()

Description copied from class: AbstractBlock

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

Specified by:

startBlock in class AbstractBlock

stopBlock

public void stopBlock()

Description copied from class: AbstractBlock

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

Specified by:

stopBlock in class AbstractBlock

setMessage

public void setMessage(java.lang.String msg)

Description copied from class: AbstractBlock

Permits an update of the notice message displayed.

Specified by:

setMessage in class AbstractBlock

Parameters:

msg - String containing new message.

getMessage

public java.lang.String getMessage()

Description copied from class: AbstractBlock

Returns the message currently being displayed.

Specified by:

getMessage in class AbstractBlock

Returns:

String containing current message.