net.sf.mmm.client.ui.base

Class AbstractUiPopupHelper

java.lang.Object

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

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

net.sf.mmm.client.ui.base.AbstractUiPopupHelper

All Implemented Interfaces:

UiPopupHelper

Direct Known Subclasses:

UiPopupHelperDummy, UiPopupHelperTestImpl

public abstract class AbstractUiPopupHelper
extends AbstractLoggableComponent
implements UiPopupHelper

This is the abstract base implementation of UiPopupHelper.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Field Summary

Fields

Modifier and Type	Field and Description
private NlsBundleUtilCoreRoot	nlsBundle The instance of NlsBundleUtilCoreRoot.

Fields inherited from interface net.sf.mmm.client.ui.api.UiPopupHelper

BUTTON_ID_CANCEL, BUTTON_ID_OK

Constructor Summary

Constructors

Constructor and Description
AbstractUiPopupHelper() The constructor.
AbstractUiPopupHelper(NlsBundleUtilCoreRoot nlsBundle) The constructor.

Method Summary

Modifier and Type	Method and Description
protected String	getTitle(MessageSeverity severity) This method gets the title for the given MessageSeverity.
void	showPopup(String message, MessageSeverity severity) This method opens a popup dialog with the given message.
void	showPopup(String message, MessageSeverity severity, Consumer<String> callback) This method opens a confirmation popup dialog with the given message and an "OK" button.
void	showPopup(String message, MessageSeverity severity, String title) This method opens a popup dialog with the given message.
void	showPopup(String message, MessageSeverity severity, String title, Consumer<String> callback) This method opens a confirmation popup dialog with the given message and an "OK" button.
void	showPopup(String message, MessageSeverity severity, String title, Consumer<String> callback, String labelOk, String labelCancel) This method opens a confirmation popup dialog with the given message and two buttons for the options "Yes" and "No".
void	showPopupYesNo(String message, String title, Consumer<String> callback) This method opens a confirmation popup dialog with the given message and two buttons for the options "Yes" and "No".

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.UiPopupHelper

showPopup, showPopup

Field Detail

nlsBundle

private final NlsBundleUtilCoreRoot nlsBundle

The instance of NlsBundleUtilCoreRoot.

Constructor Detail

AbstractUiPopupHelper

public AbstractUiPopupHelper()

The constructor.

AbstractUiPopupHelper

public AbstractUiPopupHelper(NlsBundleUtilCoreRoot nlsBundle)

The constructor.

Parameters:

nlsBundle - is the instance of NlsBundleUtilCoreRoot.

Method Detail

getTitle

protected String getTitle(MessageSeverity severity)

This method gets the title for the given MessageSeverity.

Parameters:

severity - is the MessageSeverity.

Returns:

the according title.

showPopup

public void showPopup(String message,
                      MessageSeverity severity,
                      String title)

This method opens a popup dialog with the given message.

Specified by:

showPopup in interface UiPopupHelper

Parameters:

message - is the message to display.

severity - is the MessageSeverity. Should NOT be MessageSeverity.QUESTION.

title - is the title that will be displayed in the title-bar of the popup.

showPopup

public void showPopup(String message,
                      MessageSeverity severity)

This method opens a popup dialog with the given message. The title of the popup is automatically derived from the given MessageSeverity.

Specified by:

showPopup in interface UiPopupHelper

Parameters:

message - is the message to display.

severity - is the MessageSeverity. Should NOT be MessageSeverity.QUESTION.

See Also:

UiPopupHelper.showPopup(String, MessageSeverity, String)

showPopup

public void showPopup(String message,
                      MessageSeverity severity,
                      Consumer<String> callback)

This method opens a confirmation popup dialog with the given message and an "OK" button.

Specified by:

showPopup in interface UiPopupHelper

Parameters:

message - is the message to display.

severity - is the MessageSeverity. Should NOT be MessageSeverity.QUESTION.

callback - is the Consumer invoked after the popup has been confirmed (the user has clicked the "OK" button). The given String value will always be UiPopupHelper.BUTTON_ID_OK.

showPopupYesNo

public void showPopupYesNo(String message,
                           String title,
                           Consumer<String> callback)

This method opens a confirmation popup dialog with the given message and two buttons for the options "Yes" and "No". It will use MessageSeverity.QUESTION.
ATTENTION:
This is a very common also also very often misused feature of UI toolkits or frameworks. A suitable example is e.g. to use this with the message "Do you really want to delete this object?". However, it would still be more explicit to have the buttons labeled with "Delete" and "Cancel" using UiPopupHelper.showPopup(String, MessageSeverity, String, Consumer, String, String). An example for a misuse of this method would be the message "Do you want to delete this occurrence or the series of the appointment? Press " Yes" to delete the series and "No" for this occurrence.". From this bad example that confuses the user, you should learn that it is always better to use more explicit labels.

Specified by:

showPopupYesNo in interface UiPopupHelper

Parameters:

message - is the message to display.

title - is the title that will be displayed in the title-bar of the popup.

callback - is the Consumer invoked after the popup has been confirmed (the user has clicked on one of the buttons). The given String value will be the ID of the button that has been clicked. Here, either UiPopupHelper.BUTTON_ID_OK for "Yes" or UiPopupHelper.BUTTON_ID_CANCEL for "No".

showPopup

public void showPopup(String message,
                      MessageSeverity severity,
                      String title,
                      Consumer<String> callback)

This method opens a confirmation popup dialog with the given message and an "OK" button.

Specified by:

showPopup in interface UiPopupHelper

Parameters:

message - is the message to display.

severity - is the MessageSeverity. Should NOT be MessageSeverity.QUESTION.

title - is the title that will be displayed in the title-bar of the popup.

callback - is the Consumer invoked after the popup has been confirmed (the user has clicked the "OK" button). The given String value will always be UiPopupHelper.BUTTON_ID_OK.

showPopup

public void showPopup(String message,
                      MessageSeverity severity,
                      String title,
                      Consumer<String> callback,
                      String labelOk,
                      String labelCancel)

This method opens a confirmation popup dialog with the given message and two buttons for the options "Yes" and "No". It will use MessageSeverity.QUESTION.

Specified by:

showPopup in interface UiPopupHelper

Parameters:

message - is the message to display.

severity - is the MessageSeverity - typically MessageSeverity.QUESTION.

title - is the title that will be displayed in the title-bar of the popup.

callback - is the Consumer invoked after the popup has been confirmed (the user has clicked on one of the buttons). The given String value will be the ID of the button that has been clicked. Here, either UiPopupHelper.BUTTON_ID_OK or UiPopupHelper.BUTTON_ID_CANCEL.

labelOk - is the label for the OK-button (may also be something like "Save", "Approve", etc.).

labelCancel - is the label for the cancel button.