Module io.github.mmm.ui.api.window

Package io.github.mmm.ui.api.window.notiy

Interface UiPopupNotifier

All Superinterfaces:

UiNotifier

All Known Implementing Classes:

AbstractUiNotifier

public interface UiPopupNotifier
extends UiNotifier

Interface to notify via popup or growl.

Since:

1.0.0

Method Summary

Modifier and Type	Method	Description
UiPopup	createPopup(UiNotification notification, UiAction... actions)	This method creates a popup window with the given message.
default UiPopup	createPopupOk(UiNotification notification)	This method creates a popup window with the given message.
default UiPopup	createPopupOk(UiNotification notification, UiActionOk action)	This method creates a popup window with the given message.
default UiPopup	createPopupYesNo(UiNotification notification, Consumer<Boolean> callback)	This method creates a popup window with the given UiNotification and two buttons for the options yes and no.
static UiPopupNotifier	get()
Iterable<UiNotification>	getHistory()
default void	showPopup(UiNotification notification, UiAction... actions)
default void	showPopupOk(UiNotification notification)
default void	showPopupOk(UiNotification notification, UiActionOk action)
default void	showPopupYesNo(UiNotification notification, Consumer<Boolean> callback)

Methods inherited from interface io.github.mmm.ui.api.notify.UiNotifier

event, show, show, showInfo

Method Detail

createPopup

UiPopup createPopup(UiNotification notification,
                    UiAction... actions)

This method creates a popup window with the given message. It is the most generic and flexible but also the most inconvenient showPopup method variant.

Parameters:

notification - the UiNotification to show.

actions - are the UiActions for the buttons to close (answer, confirm, or cancel) the popup. Has to be at least one UiAction.

Returns:

the UiPopup.

createPopupOk

default UiPopup createPopupOk(UiNotification notification)

This method creates a popup window with the given message. It is the most generic and flexible but also the most inconvenient showPopup method variant.

Parameters:

notification - the UiNotification to show.

actions - are the UiActions for the buttons to close (answer, confirm, or cancel) the popup. Has to be at least one UiAction.

Returns:

the UiPopup.

createPopupOk

default UiPopup createPopupOk(UiNotification notification,
                              UiActionOk action)

This method creates a popup window with the given message. It is the most generic and flexible but also the most inconvenient showPopup method variant.

Parameters:

notification - the UiNotification to show.

action - the optional UiActionOk to invoke when OK is pressed and the popup is closed.

Returns:

the UiPopup.

createPopupYesNo

default UiPopup createPopupYesNo(UiNotification notification,
                                 Consumer<Boolean> callback)

This method creates a popup window with the given UiNotification and two buttons for the options yes and no.
ATTENTION:
This is a very convenient but 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 createPopup(UiNotification, UiAction...). A famous example for a misuse of this method would be the question "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 button labels.

Parameters:

notification - the UiNotification to show. Should have UiSeverity.QUESTION.

callback - is the Consumer invoked after the popup has been confirmed. Consumer.accept(Object) will receive Boolean.TRUE if the user clicked "Yes" and Boolean.FALSE for "No".

Returns:

the UiPopup.

showPopup

default void showPopup(UiNotification notification,
                       UiAction... actions)

Specified by:

showPopup in interface UiNotifier

showPopupOk

default void showPopupOk(UiNotification notification)

Specified by:

showPopupOk in interface UiNotifier

showPopupOk

default void showPopupOk(UiNotification notification,
                         UiActionOk action)

Specified by:

showPopupOk in interface UiNotifier

showPopupYesNo

default void showPopupYesNo(UiNotification notification,
                            Consumer<Boolean> callback)

Specified by:

showPopupYesNo in interface UiNotifier

getHistory

Iterable<UiNotification> getHistory()

Specified by:

getHistory in interface UiNotifier

Returns:

the history of the notifications collected by this UiNotifier. It may be only a queue with the last N number of UiNotifications to avoid memory leaks.

get

static UiPopupNotifier get()

Returns:

the singleton instance of this UiNotifier.