info.magnolia.ui.api.overlay

Interface OverlayLayer

All Known Subinterfaces:

AppContext, AppInstanceController, Shell, SubAppContext, UiContext

All Known Implementing Classes:

AbstractUIContext, AppInstanceControllerImpl, M5AppInstanceController, M5SubAppContext, OverlayPresenter, ResurfaceShell, ShellImpl, SubAppContextImpl

Deprecated.

since 6.0, use either AlertBuilder to open alerts and confirm-dialogs, or default Vaadin Notifications and Windows.

@Deprecated
public interface OverlayLayer

Implementers can open overlay views (with a degree of modality) over their display area.

See Also:

Notification, AlertBuilder, info.magnolia.ui.DialogBuilder, info.magnolia.ui.LightBoxBuilder

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	OverlayLayer.ModalityDomain Deprecated. since 6.1, overlays are no longer bound to specific views.
static class	OverlayLayer.ModalityLevel Deprecated. since 6.1, use info.magnolia.ui.DialogBuilder#light()

Method Summary

Modifier and Type	Method and Description
void	openAlert(MessageStyleType type, String title, String body, String okButton, AlertCallback callback) Deprecated. since 6.1, use the AlertBuilder.
void	openAlert(MessageStyleType type, String title, View body, String okButton, AlertCallback callback) Deprecated. since 6.1, use the AlertBuilder.
void	openConfirmation(MessageStyleType type, String title, String body, String confirmButton, String cancelButton, boolean cancelIsDefault, ConfirmationCallback callback) Deprecated. since 6.1, use the AlertBuilder.
void	openConfirmation(MessageStyleType type, String title, View body, String confirmButton, String cancelButton, boolean cancelIsDefault, ConfirmationCallback callback) Deprecated. since 6.1, use the AlertBuilder.
void	openNotification(MessageStyleType type, boolean doesTimeout, String title) Deprecated. since 6.1, use default Vaadin Notifications. Mind the following mappings from MessageStyleType to Notification.Type: INFO => HUMANIZED_MESSAGE, WARNING => WARNING_MESSAGE, ERROR => ERROR_MESSAGE.
void	openNotification(MessageStyleType type, boolean doesTimeout, String title, String linkText, NotificationCallback cb) Deprecated. since 6.1, use default Vaadin Notifications. Mind the following mappings from MessageStyleType to Notification.Type: INFO => HUMANIZED_MESSAGE, WARNING => WARNING_MESSAGE, ERROR => ERROR_MESSAGE.
void	openNotification(MessageStyleType type, boolean doesTimeout, View viewToShow) Deprecated. since 6.1, use default Vaadin Notifications. Mind the following mappings from MessageStyleType to Notification.Type: INFO => HUMANIZED_MESSAGE, WARNING => WARNING_MESSAGE, ERROR => ERROR_MESSAGE.
OverlayCloser	openOverlay(View view) Deprecated. since 6.1, use either Magnolia's AlertBuilder, DialogBuilder or LightBoxBuilder, or default Vaadin Notifications, Windows or PopupViews.
OverlayCloser	openOverlay(View view, OverlayLayer.ModalityLevel modalityLevel) Deprecated. since 6.1, use either Magnolia's AlertBuilder, DialogBuilder or LightBoxBuilder, or default Vaadin Notifications, Windows or PopupViews.

Method Detail

openOverlay

@Deprecated
OverlayCloser openOverlay(View view)

Deprecated. since 6.1, use either Magnolia's AlertBuilder, DialogBuilder or LightBoxBuilder, or default Vaadin Notifications, Windows or PopupViews.

Open an Overlay on top of the OverlayLayer implementer.

Parameters:

view - View of the component to be displayed modally.

openOverlay

@Deprecated
OverlayCloser openOverlay(View view,
                                      OverlayLayer.ModalityLevel modalityLevel)

Deprecated. since 6.1, use either Magnolia's AlertBuilder, DialogBuilder or LightBoxBuilder, or default Vaadin Notifications, Windows or PopupViews.

Open an Overlay on top of the OverlayLayer implementer.

Parameters:

modalityLevel - Modality level

openAlert

@Deprecated
void openAlert(MessageStyleType type,
                           String title,
                           String body,
                           String okButton,
                           AlertCallback callback)

Deprecated. since 6.1, use the AlertBuilder.

Opens an alert dialog of given type, with given title and body.

Parameters:

type - the message level, i.e. INFO, WARNING or ERROR

title - the alert dialog's title

body - the alert dialog's text body

okButton - the OK button text

callback - the callback to execute when the OK button is pressed, or when the dialog is closed

openAlert

@Deprecated
void openAlert(MessageStyleType type,
                           String title,
                           View body,
                           String okButton,
                           AlertCallback callback)

Deprecated. since 6.1, use the AlertBuilder.

Opens an alert dialog of given type, with given title and body.

Parameters:

type - the message level, i.e. INFO, WARNING or ERROR

title - the alert dialog's title

body - the alert dialog's body as a magnolia View; alternatively one may wrap any Vaadin component as a View using ViewAdapter

okButton - the OK button text

callback - the callback to execute when the OK button is pressed, or when the dialog is closed

openConfirmation

@Deprecated
void openConfirmation(MessageStyleType type,
                                  String title,
                                  String body,
                                  String confirmButton,
                                  String cancelButton,
                                  boolean cancelIsDefault,
                                  ConfirmationCallback callback)

Deprecated. since 6.1, use the AlertBuilder.

Opens a confirmation dialog of given type, with given title and body.

Parameters:

type - the message level, i.e. INFO, WARNING or ERROR

title - the confirmation dialog's title

body - the confirmation dialog's body text

confirmButton - the confirm button text

cancelButton - the cancel button text

cancelIsDefault - whether the cancel button should be focused by default

callback - the callback to execute when any button is pressed, or when the dialog is closed

openConfirmation

@Deprecated
void openConfirmation(MessageStyleType type,
                                  String title,
                                  View body,
                                  String confirmButton,
                                  String cancelButton,
                                  boolean cancelIsDefault,
                                  ConfirmationCallback callback)

Deprecated. since 6.1, use the AlertBuilder.

Opens a confirmation dialog of given type, with given title and body.

Parameters:

type - the message level, i.e. INFO, WARNING or ERROR

title - the confirmation dialog's title

body - the confirmation dialog's body as a magnolia View; alternatively one may wrap any Vaadin component as a View using ViewAdapter

confirmButton - the confirm button text

cancelButton - the cancel button text

cancelIsDefault - whether the cancel button should be focused by default

callback - the callback to execute when any button is pressed, or when the dialog is closed

openNotification

@Deprecated
void openNotification(MessageStyleType type,
                                  boolean doesTimeout,
                                  View viewToShow)

Deprecated. since 6.1, use default Vaadin Notifications. Mind the following mappings from MessageStyleType to Notification.Type:
INFO => HUMANIZED_MESSAGE,
WARNING => WARNING_MESSAGE,
ERROR => ERROR_MESSAGE.

Notification indicator is a message banner that only shows a message to user. Message is shown until user clicks close button or timeout expires.

Parameters:

viewToShow - Content to show as View.

openNotification

@Deprecated
void openNotification(MessageStyleType type,
                                  boolean doesTimeout,
                                  String title)

Deprecated. since 6.1, use default Vaadin Notifications. Mind the following mappings from MessageStyleType to Notification.Type:
INFO => HUMANIZED_MESSAGE,
WARNING => WARNING_MESSAGE,
ERROR => ERROR_MESSAGE.

Notification indicator is a message banner that only shows a message to user. Message is shown until user clicks close button or timeout expires.

Parameters:

title - Content to show as string.

openNotification

@Deprecated
void openNotification(MessageStyleType type,
                                  boolean doesTimeout,
                                  String title,
                                  String linkText,
                                  NotificationCallback cb)

Deprecated. since 6.1, use default Vaadin Notifications. Mind the following mappings from MessageStyleType to Notification.Type:
INFO => HUMANIZED_MESSAGE,
WARNING => WARNING_MESSAGE,
ERROR => ERROR_MESSAGE.

Notification indicator is a message banner that only shows a message to user. Message is shown until user clicks close button or timeout expires.

Parameters:

title - Content to show as string.

linkText - Text to show in a link button.

cb - Callback for when user clicks on link.