net.sf.cuf.fw2

Class DialogManager

java.lang.Object

net.sf.cuf.fw2.DialogManager

All Implemented Interfaces:

Disposable

public class DialogManager
extends Object
implements Disposable

This helper class manages the opening and closing of dialogs. If a dialog is opened by id, it is also initialized. If the dialog implements the SimpleLifeCycle, the doActivate() and doPassivate() methods are called. The helper also supports modal dialogs and holds a list of all open dialogs. The DialogManager closes only dialogs that where opened by him. To allow further customizing of the open/close process, the DialogManger provices callbacks after opening/closing a dialog.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DialogManager.DialogCallback Callback interface for the opening/closing of a dialog.

Constructor Summary

Constructors

Constructor and Description
DialogManager(Application pApp) Creates a new dialog manager.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canPassivate() Helper method that checks if all active dialogs can be passivated.
void	closeDialog(CloseDialogEvent pEvent) Closes an open dialog.
void	dispose(Map<String,? super Object> pArgs) Called from the peer that coordinates our life cycle to tell us to cleanup all resources.
Dc	getActiveDialog() Returns the last dialog that was opened by this DialogManager or null if there is currently no active dialog.
List<Dc>	getActiveDialogs() Returns a list of active dialog objects.
void	openDialog(OpenDialogEvent pEvent) Open a new dialog.
void	openDialog(OpenDialogEvent pEvent, Dc pParent) Open a new dialog.
void	postAppEvent(Dc pDc, AppEventSupport pAppEventSupport, AppEvent pAppEvent) Filter for an AppEvent hierarchy: if a OpenDialogEvent or an CloseDialogEvent is posted, we try to handle it.
void	setCallback(DialogManager.DialogCallback pCallback) Set the callback target for dialog callbacks.
void	setKnownDialogs(Map<String,DialogDescription> pKnownDialogs) Sets the known dialogs of this DialogManager.

Methods inherited from class java.lang.Object

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

Constructor Detail

DialogManager

public DialogManager(Application pApp)

Creates a new dialog manager.

Parameters:

pApp - the application for the init() call if a dialog is created

Method Detail

setKnownDialogs

public void setKnownDialogs(Map<String,DialogDescription> pKnownDialogs)

Sets the known dialogs of this DialogManager.

Parameters:

pKnownDialogs - a map of all known dialogs, must not be null; key= dialog id as string, value= dialog description object

setCallback

public void setCallback(DialogManager.DialogCallback pCallback)

Set the callback target for dialog callbacks.

Parameters:

pCallback - the callback object, may be null

getActiveDialog

public Dc getActiveDialog()

Returns the last dialog that was opened by this DialogManager or null if there is currently no active dialog.

Returns:

null or a dialog object

getActiveDialogs

public List<Dc> getActiveDialogs()

Returns a list of active dialog objects.

Returns:

a copy of the active dialog list, never null

openDialog

public void openDialog(OpenDialogEvent pEvent)

Open a new dialog. This method doesn't return immediately if the opend dialog is modal, in this case the method returns after the modal dialog was closed.

Parameters:

pEvent - the event describing the to be opened dialog

openDialog

public void openDialog(OpenDialogEvent pEvent,
              Dc pParent)

Open a new dialog. This method doesn't return immediately if the opend dialog is modal, in this case the method returns after the modal dialog was closed.

Parameters:

pEvent - the event describing the to be opened dialog

pParent - null or the parent for the init() call if a dialog is created by dialog id

closeDialog

public void closeDialog(CloseDialogEvent pEvent)

Closes an open dialog. If the dialog implements SimpleLifeCycle, it will be checked first if the dialog can be passivated. We consume the event only if we know the dialog (=handled the OpenDialogEvent for it).

Parameters:

pEvent - the event describing the to be closed dialog

canPassivate

public boolean canPassivate()

Helper method that checks if all active dialogs can be passivated.

Returns:

true if all dialogs can be passivated

dispose

public void dispose(Map<String,? super Object> pArgs)

Called from the peer that coordinates our life cycle to tell us to cleanup all resources. We forward this to all known (sub-)dialogs and clear the known dialogs map.

Specified by:

dispose in interface Disposable

Parameters:

pArgs - arguments, key is a String, value is any suitable objekt for the key

postAppEvent

public void postAppEvent(Dc pDc,
                AppEventSupport pAppEventSupport,
                AppEvent pAppEvent)

Filter for an AppEvent hierarchy: if a OpenDialogEvent or an CloseDialogEvent is posted, we try to handle it. If we can't open or close a dialog, the event is not consumed and routed further up in the hierarchy.

Parameters:

pDc - the parent of the new dialog, may be null

pAppEventSupport - the (logical) parent in the AppEvent chain of responsability

pAppEvent - event that should be routed/processes, must not be null

Throws:

IllegalArgumentException - if pAppEvent is null