net.sf.mmm.client.ui.api

Interface UiPopupHelper

All Known Implementing Classes:

AbstractUiPopupHelper, UiPopupHelperDummy, UiPopupHelperTestImpl

@ComponentSpecification
public interface UiPopupHelper

This is the interface for a component that allows to open very simple popup dialogs.
ATTENTION:
Be aware of internationalization whenever you supply messages, labels or titles of a popup. Please also note that this component is designed for a client that only needs to deal with a single Locale.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Field Summary

Fields

Modifier and Type	Field and Description
static String	BUTTON_ID_CANCEL The ID for the "Cancel" button.
static String	BUTTON_ID_OK The ID for the "OK" button.

Method Summary

Modifier and Type	Method and Description
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, Map<String,String> id2buttonLabelMap) This method opens a confirmation popup dialog with the given message.
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	showPopup(Throwable error) This method opens a popup dialog showing the given error.
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".

Field Detail

BUTTON_ID_OK

static final String BUTTON_ID_OK

The ID for the "OK" button.

See Also:

Constant Field Values

BUTTON_ID_CANCEL

static final String BUTTON_ID_CANCEL

The ID for the "Cancel" button.

See Also:

Constant Field Values

Method Detail

showPopup

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

This method opens a popup dialog with the given message.

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

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.

Parameters:

message - is the message to display.

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

See Also:

showPopup(String, MessageSeverity, String)

showPopup

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

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

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

showPopup

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.

Parameters:

message - is the message to display.

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

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

showPopupYesNo

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

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 BUTTON_ID_OK for "Yes" or BUTTON_ID_CANCEL for "No".

showPopup

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.

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 BUTTON_ID_OK or 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.

showPopup

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

This method opens a confirmation popup dialog with the given message. It is the most generic and flexible but also the most inconvenient method variant.

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 on one of the buttons). The given String value will be the ID of the button that has been clicked. The ID is the key of the given id2buttonLabelMap.

id2buttonLabelMap - is a Map defining the buttons for the popup. The values are the labels of the buttons while the keys are their IDs. The ID of the button that has been clicked is passed to the given callback.

showPopup

void showPopup(Throwable error)

This method opens a popup dialog showing the given error. It will use MessageSeverity.ERROR.

Parameters:

error - is the Throwable that has occurred.