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

Class DialogController<VIEW extends UiWidget>

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<VIEW>

Type Parameters:

VIEW - is the generic type of the view.

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractMainDialogController, AbstractNavigationDialogController, AbstractPageDialogController, RootDialogController

public abstract class DialogController<VIEW extends UiWidget>
extends AbstractDialogController<VIEW>
implements Dialog

This is the abstract base class for the controller of a Dialog. For each ApplicationWindow a single instance of DialogController exists for each Dialog holding its state.

 public class PageDialogController extends DialogController<MyPageView> {

   ...

   public String AbstractDialog.getId() {
     return DialogConstants.DIALOG_ID_PAGE;
   }

   protected DialogSlot doShow(DialogPlace place) {
     return DialogConstants.SLOT_ROOT_PAGE;
   }

   protected void embed(DialogController subDialog, DialogSlot slot) {
     if (slot == SLOT_MAIN) {
       this.widgetMainSlot.setChild(subDialog.getView());
     } else if (slot == SLOT_...) {
       ...
     } else {
       super.embed(subDialog, slot);
     }
   }

 }
 

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Field Summary

Fields

Modifier and Type	Field and Description
private AbstractDialogManager	dialogManager
private DialogController<?>	parent The parent DialogController or null for no parent (if this is the root DialogController or not opened).
private DialogPlace	place
private Map<DialogSlot,DialogController<?>>	slot2subDialogMap
private UiContext	uiContext

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

PATTERN_DIALOG_ID

Constructor Summary

Constructors

Constructor and Description
DialogController() The constructor.

Method Summary

Modifier and Type	Method and Description
protected abstract 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.
protected DialogManager	getDialogManager()
(package private) DialogController<?>	getParent()
UiContext	getUiContext()
protected void	onRemoveChild(DialogController<?> subDialog) This method notifies that the given DialogController has been removed as a sub-dialog.
(package private) void	setDialogManager(AbstractDialogManager dialogManager)
(package private) void	setParent(DialogController<?> parent) This method sets the parent DialogController when embedding.
(package private) void	setSubDialog(DialogController<?> subDialog, DialogSlot slot, DialogPlace dialogPlace) This method embeds the given subDialog inside the given slot of this dialog.
void	setUiContext(UiContext uiContext)
(package private) void	setVisible(boolean visible) This method sets the visible flag and on change it triggers AbstractDialogController.onShow() or AbstractDialogController.onHide() accordingly.
void	show(DialogPlace dialogPlace) This method opens this dialog as triggered by the given DialogPlace.
private DialogSlot	showInternal(DialogPlace dialogPlace)

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

createView, 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.Dialog

getType

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

getId, getTitle, isVisible

Field Detail

slot2subDialogMap

private final Map<DialogSlot,DialogController<?>> slot2subDialogMap

See Also:

setSubDialog(DialogController, DialogSlot, DialogPlace)

dialogManager

private AbstractDialogManager dialogManager

See Also:

getDialogManager()

uiContext

private UiContext uiContext

See Also:

setUiContext(UiContext)

parent

private DialogController<?> parent

The parent DialogController or null for no parent (if this is the root DialogController or not opened).

place

private DialogPlace place

See Also:

show(DialogPlace)

Constructor Detail

DialogController

public DialogController()

The constructor.

Method Detail

getParent

DialogController<?> getParent()

Returns:

the parent DialogController or null if NOT visible or root.

setParent

void setParent(DialogController<?> parent)

This method sets the parent DialogController when embedding.

Parameters:

parent - is the parent DialogController or null to reset.

onRemoveChild

protected void onRemoveChild(DialogController<?> subDialog)

This method notifies that the given DialogController has been removed as a sub-dialog.

Parameters:

subDialog - is the child DialogController that has been removed.

setVisible

void setVisible(boolean visible)

This method sets the visible flag and on change it triggers AbstractDialogController.onShow() or AbstractDialogController.onHide() accordingly.

Overrides:

setVisible in class AbstractDialogController<VIEW extends UiWidget>

Parameters:

visible - - true if this controller is about to show its view, false if it will hide it.

getDialogManager

protected DialogManager getDialogManager()

Returns:

the DialogManager instance.

setDialogManager

void setDialogManager(AbstractDialogManager dialogManager)

Parameters:

dialogManager - is the instance of AbstractDialogManager to use.

show

public final void show(DialogPlace dialogPlace)

This method opens this dialog as triggered by the given DialogPlace.

Parameters:

dialogPlace - is the DialogPlace identifying this DialogController and providing potential parameters.

showInternal

private DialogSlot showInternal(DialogPlace dialogPlace)

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.

doShow

protected abstract 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.

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.

setSubDialog

final void setSubDialog(DialogController<?> subDialog,
                        DialogSlot slot,
                        DialogPlace dialogPlace)

This method embeds the given subDialog inside the given slot of this dialog. The subDialog previously set in that slot is replaced with the new one.

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.

dialogPlace - is the DialogPlace pointing to the child (or descendant) dialog to embed.

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.

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.

getUiContext

public UiContext getUiContext()

Returns:

the uiContext

setUiContext

@Inject
public void setUiContext(UiContext uiContext)

Parameters:

uiContext - is the uiContext to set