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

Class RootDialogController

java.lang.Object

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

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

net.sf.mmm.client.ui.base.dialog.AbstractDialogController<VIEW>

net.sf.mmm.client.ui.base.dialog.DialogController<UiWidgetMainWindow>

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

All Implemented Interfaces:

AttributeReadVisible, AbstractDialog, Dialog, AttributeReadId<String>, AttributeReadTitle<String>

public class RootDialogController
extends DialogController<UiWidgetMainWindow>

This is the DialogController for the root dialog. It simply represents the empty main window of the application and provides a slot to embed the actual page dialog.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Field Summary

Fields inherited from interface net.sf.mmm.client.ui.api.dialog.AbstractDialog

PATTERN_DIALOG_ID

Constructor Summary

Constructors

Constructor and Description
RootDialogController() The constructor.

Method Summary

Modifier and Type	Method and Description
protected UiWidgetMainWindow	createView() This method creates the view and has to be implemented for each individual dialog.
protected DialogSlot	doShow(DialogPlace dialogPlace) This method gets called whenever this DialogController is to be shown.
protected void	embed(DialogController<?> subDialog, DialogSlot slot) This method has to be overridden with the custom logic to embed a given DialogController as sub-dialog in a predefined slot.
String	getId() This method gets the ID used to identify this object.
String	getTitle() This method gets the title of this object.
String	getType() This method determines the type of this Dialog.

Methods inherited from class net.sf.mmm.client.ui.base.dialog.DialogController

getDialogManager, getUiContext, onRemoveChild, setUiContext, show

Methods inherited from class net.sf.mmm.client.ui.base.dialog.AbstractDialogController

getView, isVisible, onHide, onReset, onShow, reset

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

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

isVisible

Constructor Detail

RootDialogController

public RootDialogController()

The constructor.

Method Detail

getType

public String getType()

This method determines the type of this Dialog. There are predefined TYPE_* constants for common types in DialogConstants. However, you can simply create additional custom types for your needs.

Returns:

the type of this Dialog.

See Also:

DialogConstants.TYPE_MAIN, DialogConstants.TYPE_HEADER, DialogConstants.TYPE_FOOTER, DialogConstants.TYPE_NAVIGATION, DialogConstants.TYPE_SIDE, DialogConstants.TYPE_ROOT

getTitle

public String getTitle()

This method gets the title of this object.
NOTE:
For generic usage you need to use Object.toString() of the result if NOT null

Returns:

the title or null if not set. The string-representation of the result (if NOT null) needs to be suitable for end-users.

getId

public String getId()

This method gets the ID used to identify this object. An ID should be unique. The ID of a dialog should only contain ASCII letters, Latin digits, hyphens or underscores. It must NOT contain ':', ';', '&', '?', '=', '/', '\\' or ' '.

Returns:

the object's ID.

See Also:

DialogConstants.DIALOG_ID_ROOT, DialogConstants.DIALOG_ID_PAGE, DialogConstants.DIALOG_ID_HOME

doShow

protected DialogSlot doShow(DialogPlace dialogPlace)

This method gets called whenever this DialogController is to be shown. There are two cases to distinguish:

• direct
  This DialogController is identified by the given DialogPlace. It is the leaf of the DialogController-hierarchy that is to be displayed.
• indirect
  Because of a direct request to show a dialog, its parent (and ancestors) will be shown that will embed their child dialog in the DialogSlot returned by this method.

If this is the root DialogController this method will never be called.

Specified by:

doShow in class DialogController<UiWidgetMainWindow>

Parameters:

dialogPlace - is the DialogPlace pointing to the direct dialog to open and containing potential parameters.

Returns:

the DialogSlot identifying the parent DialogController and its slot where to embed this DialogController.

createView

protected UiWidgetMainWindow createView()

This method creates the view and has to be implemented for each individual dialog.
ATTENTION:
This method can be called more than once.

Specified by:

createView in class AbstractDialogController<UiWidgetMainWindow>

Returns:

the new view.

embed

protected void embed(DialogController<?> subDialog,
                     DialogSlot slot)

This method has to be overridden with the custom logic to embed a given DialogController as sub-dialog in a predefined slot. If this DialogController represents a leaf-dialog than can not have sub-dialogs this method will be never called.
Here is a typical example:

 protected void embed(DialogController subDialog, DialogSlot slot) {
   if (slot == SLOT_MAIN) {
     AbstractDialogController.getView().getMainSlot().setChild((UiWidgetRegular) subDialog.AbstractDialogController.getView());
   } else if (slot == SLOT_NAVIGATION) {
     ...
   } else {
     super.embed(subDialog, slot);
   }
 }
 

The cast to UiWidgetRegular is legal here if you are not doing odd things. See AbstractDialogController.getView() for details.

Overrides:

embed in class DialogController<UiWidgetMainWindow>

Parameters:

subDialog - is the DialogController of the sub-dialog to embed.

slot - is the DialogSlot identifying the location in the view where the subDialog shall be embedded.