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

Class AbstractDialogController<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>

Type Parameters:

VIEW - is the generic type of the view.

All Implemented Interfaces:

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

Direct Known Subclasses:

DialogController

public abstract class AbstractDialogController<VIEW extends UiWidget>
extends AbstractLoggableComponent
implements AbstractDialog

This is the abstract base class for the controller of a Dialog or PopupDialog. It implements AbstractDialog as it represents the actual Dialog or PopupDialog and is its main entry point. A AbstractDialogController is supposed to be a lightweight component and construction shall be cheap and fast. It contains a view that is lazily created for performance reasons. The view can also be reseted to free resources or for testing hot-code changes during development. Therefore implementations have to properly reset their state in onReset().

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Field Summary

Fields

Modifier and Type	Field and Description
private VIEW	view
private boolean	visible

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

PATTERN_DIALOG_ID

Constructor Summary

Constructors

Constructor and Description
AbstractDialogController() The constructor.

Method Summary

Modifier and Type	Method and Description
protected abstract VIEW	createView() This method creates the view and has to be implemented for each individual dialog.
VIEW	getView() This method gets the view of this AbstractDialogController.
boolean	isVisible() This method determines if this dialog is currently visible (opened).
protected void	onHide() This method gets called whenever the view is hidden from the screen.
protected void	onReset() This method gets called whenever this controller is reseted.
protected void	onShow() This method gets called whenever the view is shown on the screen.
protected void	reset() This method resets this AbstractDialogController.
(package private) void	setVisible(boolean visible) This method sets the visible flag and on change it triggers onShow() or onHide() accordingly.

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

getId, getTitle

Field Detail

view

private VIEW extends UiWidget view

See Also:

getView()

visible

private boolean visible

See Also:

isVisible()

Constructor Detail

AbstractDialogController

public AbstractDialogController()

The constructor.

Method Detail

isVisible

public final boolean isVisible()

This method determines if this dialog is currently visible (opened).

Specified by:

isVisible in interface AttributeReadVisible

Specified by:

isVisible in interface AbstractDialog

Returns:

true if visible, false otherwise.

See Also:

AttributeReadVisibleRecursive.isVisibleRecursive()

setVisible

void setVisible(boolean visible)

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

Parameters:

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

reset

protected final void reset()

This method resets this AbstractDialogController.

onReset

protected void onReset()

This method gets called whenever this controller is reseted. If you keep custom state information you need to override and reset your state.

onShow

protected void onShow()

This method gets called whenever the view is shown on the screen. It can be overridden to trigger custom logic - e.g. to update data.

onHide

protected void onHide()

This method gets called whenever the view is hidden from the screen. It can be overridden to trigger custom logics or to clean up resources.

createView

protected abstract VIEW createView()

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

Returns:

the new view.

getView

public VIEW getView()

This method gets the view of this AbstractDialogController. The view is the actual UI represented by a UiWidget.
In most cases this will be a UiWidgetRegular. However, for specific controllers such as DialogConstants.TYPE_ROOT it may not be a regular widget.

Returns:

the view.