net.sf.mmm.client.ui.api.dialog

Interface DialogManager

All Known Implementing Classes:

AbstractDialogManager, DialogManagerImplGwt

@ComponentSpecification
public interface DialogManager

This is the interface for the component used to manage Dialogs.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Method Summary

Modifier and Type	Method and Description
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.
Dialog	getDialog(String dialogId) This method gets the Dialog with the given ID.
void	initialize(DialogPlace defaultPlace) This method initializes this DialogManager.
void	navigateBack() This method navigates back in the history to the DialogPlace that has been visited before.
void	navigateForward() This method navigates forward in the history.
void	navigateTo(DialogPlace place) This method opens the given DialogPlace and its according Dialog in the current ApplicationWindow.
void	navigateTo(String dialogId) This is a convenience method for navigateTo(new DialogPlace(dialogId)).
ApplicationWindow	openInNewWindow(DialogPlace place) This method opens the given DialogPlace and its according Dialog in a new ApplicationWindow.

Method Detail

getDialog

Dialog getDialog(String dialogId)
          throws ObjectNotFoundException

This method gets the Dialog with the given ID.

Parameters:

dialogId - the ID of the requested Dialog.

Returns:

the requested Dialog.

Throws:

ObjectNotFoundException - if no Dialog with the given dialogId.

getCurrentDialog

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.

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.

getCurrentPopupDialog

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.

Returns:

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

getCurrentMainDialog

Dialog getCurrentMainDialog()

This method gets the current Dialog of the type main.

Returns:

the current Dialog.

initialize

void initialize(DialogPlace defaultPlace)

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.

Parameters:

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

getCurrentPlace

DialogPlace getCurrentPlace()

This method gets the current DialogPlace.

Returns:

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

navigateBack

void navigateBack()

This method navigates back in the history to the DialogPlace that has been visited before. In a web-application this can also be triggered by pressing the back button.

navigateForward

void navigateForward()

This method navigates forward in the history. After navigateBack() was invoked, this method will go to the DialogPlace that has been visited before the invocation of navigateBack(). In a web-application this can also be triggered by pressing the forward button.

navigateTo

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.

Parameters:

dialogId - is the ID of the dialog to open.

navigateTo

void navigateTo(DialogPlace place)

This method opens the given DialogPlace and its according Dialog in the current ApplicationWindow. The current place is added to the navigation history.

Parameters:

place - is the DialogPlace identifying the Dialog to open.

openInNewWindow

ApplicationWindow openInNewWindow(DialogPlace place)

This method opens the given DialogPlace and its according Dialog in a new ApplicationWindow. The operation does not affect the current navigation history. In case of a web-application a new browser window (or tab) is opened that starts another instance of the client at the given place. In a native client a new window is opened with its own DialogManager instance and new instances of all Dialogs.

Parameters:

place - is the DialogPlace to open in the new window.

Returns:

the handle for the new window.