net.sf.mmm.client.ui.base.busy

Class AbstractBusyManager

java.lang.Object

net.sf.mmm.util.component.base.AbstractComponent

net.sf.mmm.util.component.base.AbstractLoggableComponent

net.sf.mmm.client.ui.base.busy.AbstractBusyManager

All Implemented Interfaces:

BusyManager

Direct Known Subclasses:

BusyManagerImplGwt

public abstract class AbstractBusyManager
extends AbstractLoggableComponent
implements BusyManager

This is the abstract base implementation of BusyManager.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private class	AbstractBusyManager.BusySessionImpl This inner class is the implementation of BusySession.

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	busy
private AbstractBusyManager.BusySessionImpl	currentSession The current AbstractBusyManager.BusySessionImpl or null for no open session.
private AbstractBusyManager.BusySessionImpl	toplevelSession The top-level AbstractBusyManager.BusySessionImpl or null for no open session.

Constructor Summary

Constructors

Constructor and Description
AbstractBusyManager() The constructor.

Method Summary

Modifier and Type	Method and Description
boolean	isBusy() This method determines if the application client is currently busy.
protected AbstractBusyManager.BusySessionImpl	newBusySession(String id) This method creates a new AbstractBusyManager.BusySessionImpl.
protected abstract void	setBusy() This method is called whenever the client changes from idle to busy.
protected abstract void	setIdle() This method is called whenever the client changes from busy to idle.
BusySession	start(String id) This method starts a BusySession that has to be terminated by BusySession.stop().
private void	stopSession(AbstractBusyManager.BusySessionImpl session)

Methods inherited from class net.sf.mmm.util.component.base.AbstractLoggableComponent

createLogger, doInitialize, getLogger

Methods inherited from class net.sf.mmm.util.component.base.AbstractComponent

doInitialized, getInitializationState, initialize

Methods inherited from class java.lang.Object

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

Field Detail

busy

private volatile boolean busy

See Also:

isBusy()

currentSession

private AbstractBusyManager.BusySessionImpl currentSession

The current AbstractBusyManager.BusySessionImpl or null for no open session.

toplevelSession

private AbstractBusyManager.BusySessionImpl toplevelSession

The top-level AbstractBusyManager.BusySessionImpl or null for no open session.

Constructor Detail

AbstractBusyManager

public AbstractBusyManager()

The constructor.

Method Detail

isBusy

public boolean isBusy()

This method determines if the application client is currently busy. Busy means the client is waiting for a remote invocation service result or performing client-side longer lasting logic (sorting long lists, complex rendering, etc.). The logic what happens is abstracted by the interface. Typically the user gets visual feedback (e.g. an animated wait image or progress-bar) and can not interact with the client (e.g. press additional buttons).
If the client is NOT busy, it is considered as idle and the user can interact normally with the client.

Specified by:

isBusy in interface BusyManager

Returns:

true if busy, false otherwise.

setBusy

protected abstract void setBusy()

This method is called whenever the client changes from idle to busy. It has to implement the client specific behavior.

setIdle

protected abstract void setIdle()

This method is called whenever the client changes from busy to idle. It has to implement the client specific behavior.

start

public BusySession start(String id)

This method starts a BusySession that has to be terminated by BusySession.stop(). If the application client is idle (NOT busy), it will switch to busy. Otherwise this is considered as a nested BusySession. Only after the initial BusySession have been stopped, the application will switch from busy back to idle mode.

Specified by:

start in interface BusyManager

Parameters:

id - is an identifier for the source or the reason for the client being busy.

Returns:

the BusySession used to stop the session.

stopSession

private void stopSession(AbstractBusyManager.BusySessionImpl session)

Parameters:

session - is the AbstractBusyManager.BusySessionImpl that has been stopped.

newBusySession

protected AbstractBusyManager.BusySessionImpl newBusySession(String id)

This method creates a new AbstractBusyManager.BusySessionImpl.

Parameters:

id - the ID.

Returns:

the new AbstractBusyManager.BusySessionImpl.