net.sf.mmm.client.ui.base.dialog

Class AbstractDialogManager

java.lang.Object

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

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

net.sf.mmm.client.ui.base.dialog.AbstractDialogManager

All Implemented Interfaces:

DialogManager

Direct Known Subclasses:

DialogManagerImplGwt

public abstract class AbstractDialogManager
extends AbstractLoggableComponent
implements DialogManager

This is the abstract base implementation of DialogManager.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Field Summary

Fields

Modifier and Type	Field and Description
private UiContext	context
private DialogPlace	currentPlace
private DialogPlace	defaultPlace
private DialogControllerFactory	dialogControllerFactory
private Map<String,DialogController<?>>	id2DialogMap
private LinkedList<PopupDialog>	popupStack
private Map<String,Dialog>	type2currentDialogMap

Constructor Summary

Constructors

Constructor and Description
AbstractDialogManager() The constructor.

Method Summary

Modifier and Type	Method and Description
protected void	doInitialize() This method performs the actual initialization.
protected UiContext	getContext()
Dialog	getCurrentDialog(String type) This method gets the current Dialog of the given type.
Dialog	getCurrentMainDialog() This method gets the current Dialog of the type main.
DialogPlace	getCurrentPlace() This method gets the current DialogPlace.
PopupDialog	getCurrentPopupDialog() This method gets the current PopupDialog.
DialogController<?>	getDialog(String dialogId) This method gets the Dialog with the given ID.
protected abstract DialogPlace	getStartPlace() This method determines the start DialogPlace.
protected String	getTitle(DialogController<?> dialogController) This method determines the title for the given DialogController.
void	initialize(DialogPlace defaultDialogPlace) This method initializes this DialogManager.
void	navigateTo(String dialogId) This is a convenience method for navigateTo(new DialogPlace(dialogId)).
(package private) void	onHideDialog(Dialog dialog) This method should be called whenever a Dialog is hidden.
(package private) void	onShowDialog(Dialog dialog) This method has to be called whenever a Dialog is opened or brought to the front.
void	setContext(UiContext uiContext)
void	setDialogControllerFactory(DialogControllerFactory dialogControllerFactory)
protected void	show(DialogPlace dialogPlace)
private boolean	verifyUniqueAccessKeys()

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

createLogger, 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

Methods inherited from interface net.sf.mmm.client.ui.api.dialog.DialogManager

navigateBack, navigateForward, navigateTo, openInNewWindow

Field Detail

id2DialogMap

private final Map<String,DialogController<?>> id2DialogMap

See Also:

getDialog(String)

type2currentDialogMap

private final Map<String,Dialog> type2currentDialogMap

See Also:

getCurrentDialog(String)

popupStack

private final LinkedList<PopupDialog> popupStack

See Also:

getCurrentPopupDialog()

dialogControllerFactory

private DialogControllerFactory dialogControllerFactory

See Also:

setDialogControllerFactory(DialogControllerFactory)

context

private UiContext context

See Also:

setContext(UiContext)

defaultPlace

private DialogPlace defaultPlace

See Also:

initialize(DialogPlace)

currentPlace

private DialogPlace currentPlace

See Also:

getCurrentPlace()

Constructor Detail

AbstractDialogManager

public AbstractDialogManager()

The constructor.

Method Detail

setDialogControllerFactory

@Inject
public void setDialogControllerFactory(DialogControllerFactory dialogControllerFactory)

Parameters:

dialogControllerFactory - is the DialogControllerFactory to set manually or via Inject.

getContext

protected UiContext getContext()

Returns:

the UiContext instance.

setContext

@Inject
public void setContext(UiContext uiContext)

Parameters:

uiContext - is the UiContext to Inject.

doInitialize

protected void doInitialize()

This method performs the actual initialization. It is called when AbstractComponent.initialize() is invoked for the first time.
ATTENTION:
When you override this method from a sub-class you need to do a super.AbstractComponent.doInitialize().

Overrides:

doInitialize in class AbstractLoggableComponent

initialize

public void initialize(DialogPlace defaultDialogPlace)

This method initializes this DialogManager. It opens the first dialog according to the initial DialogPlace that may be provided by the user e.g. from a bookmark. If no DialogPlace is given by the user, the defaultPlace is opened.

Specified by:

initialize in interface DialogManager

Parameters:

defaultDialogPlace - is the DialogPlace of the start Dialog to open as default.

getCurrentPlace

public DialogPlace getCurrentPlace()

This method gets the current DialogPlace.

Specified by:

getCurrentPlace in interface DialogManager

Returns:

the current DialogPlace. Will be null until DialogManager.initialize(DialogPlace) has been called.

getStartPlace

protected abstract DialogPlace getStartPlace()

This method determines the start DialogPlace. If the application is started from a bookmark, this method will create the DialogPlace from this bookmark (in case of a web-application from the hash of the URL).

Returns:

the start DialogPlace or null if not present (and default shall be used.

See Also:

initialize(DialogPlace)

getDialog

public DialogController<?> getDialog(String dialogId)
                              throws ObjectNotFoundException

This method gets the Dialog with the given ID.

Specified by:

getDialog in interface DialogManager

Parameters:

dialogId - the ID of the requested Dialog.

Returns:

the requested Dialog.

Throws:

ObjectNotFoundException - if no Dialog with the given dialogId.

getCurrentDialog

public Dialog getCurrentDialog(String type)

This method gets the current Dialog of the given type. If multiple Dialogs of the same type are open at a time, this method will return the one in the front.

Specified by:

getCurrentDialog in interface DialogManager

Parameters:

type - is the type of the requested Dialog.

Returns:

the current Dialog with the given type or null if no such Dialog is visible.

getCurrentMainDialog

public Dialog getCurrentMainDialog()

This method gets the current Dialog of the type main.

Specified by:

getCurrentMainDialog in interface DialogManager

Returns:

the current Dialog.

getCurrentPopupDialog

public PopupDialog getCurrentPopupDialog()

This method gets the current PopupDialog. If multiple PopupDialogs are open, it will return the top-level one.
ATTENTION:
Beside a PopupDialog there can also be simple popups that are NOT considered by this method.

Specified by:

getCurrentPopupDialog in interface DialogManager

Returns:

the current PopupDialog or null if no PopupDialog is currently open.

onShowDialog

void onShowDialog(Dialog dialog)

This method has to be called whenever a Dialog is opened or brought to the front.

Parameters:

dialog - the current Dialog.

onHideDialog

void onHideDialog(Dialog dialog)

This method should be called whenever a Dialog is hidden.

Parameters:

dialog - the Dialog to hide.

navigateTo

public final void navigateTo(String dialogId)

This is a convenience method for navigateTo(new DialogPlace(dialogId)).
ATTENTION:
It is best practice NOT to use this method. See DialogPlace for further details.

Specified by:

navigateTo in interface DialogManager

Parameters:

dialogId - is the ID of the dialog to open.

show

protected void show(DialogPlace dialogPlace)

Parameters:

dialogPlace - is the DialogPlace to show.

See Also:

DialogManager.navigateTo(DialogPlace)

verifyUniqueAccessKeys

private boolean verifyUniqueAccessKeys()

Returns:

always true.

See Also:

UiAccessKeyBinding.verifyUniqueAccessKeys()

getTitle

protected String getTitle(DialogController<?> dialogController)

This method determines the title for the given DialogController.

Parameters:

dialogController - is the DialogController.

Returns:

the calculated title.