info.magnolia.ui.api.context

Interface UiContext

All Superinterfaces:

OverlayLayer

All Known Subinterfaces:

AppContext, AppInstanceController, Shell, SubAppContext

All Known Implementing Classes:

AbstractUIContext, AppInstanceControllerImpl, M5AppInstanceController, M5SubAppContext, 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 UiContext
extends OverlayLayer

Represents a UI context and allows components, views and presenters to interact with the context that contains them.

See Also:

Notification, AlertBuilder, DialogBuilder, LightBoxBuilder

Nested Class Summary

Nested classes/interfaces inherited from interface info.magnolia.ui.api.overlay.OverlayLayer

OverlayLayer.ModalityDomain, OverlayLayer.ModalityLevel

Method Summary

Modifier and Type	Method and Description
OverlayLayer	getOverlayDelegate() Deprecated.
default void	openAlert(MessageStyleType type, String title, String body, String okButton, AlertCallback callback) Deprecated. since 6.1, use the AlertBuilder.
default void	openAlert(MessageStyleType type, String title, View body, String okButton, AlertCallback callback) Deprecated. since 6.1, use the AlertBuilder.
default void	openConfirmation(MessageStyleType type, String title, String body, String confirmButton, String cancelButton, boolean cancelIsDefault, ConfirmationCallback callback) Deprecated. since 6.1, use the AlertBuilder.
default void	openConfirmation(MessageStyleType type, String title, View body, String confirmButton, String cancelButton, boolean cancelIsDefault, ConfirmationCallback callback) Deprecated. since 6.1, use the AlertBuilder.
default 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.
default 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.
default 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.
default OverlayCloser	openOverlay(View view) Deprecated. since 6.1, use either Magnolia's AlertBuilder, DialogBuilder or LightBoxBuilder, or default Vaadin Notifications, Windows or PopupViews.
default 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
default OverlayCloser openOverlay(View view)

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

Description copied from interface: OverlayLayer

Open an Overlay on top of the OverlayLayer implementer.

Specified by:

openOverlay in interface OverlayLayer

Parameters:

view - View of the component to be displayed modally.

openOverlay

@Deprecated
default 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.

Description copied from interface: OverlayLayer

Open an Overlay on top of the OverlayLayer implementer.

Specified by:

openOverlay in interface OverlayLayer

modalityLevel - Modality level

openAlert

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

Deprecated. since 6.1, use the AlertBuilder.

Description copied from interface: OverlayLayer

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

Specified by:

openAlert in interface OverlayLayer

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
default void openAlert(MessageStyleType type,
                                   String title,
                                   View body,
                                   String okButton,
                                   AlertCallback callback)

Deprecated. since 6.1, use the AlertBuilder.

Description copied from interface: OverlayLayer

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

Specified by:

openAlert in interface OverlayLayer

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
default void openConfirmation(MessageStyleType type,
                                          String title,
                                          String body,
                                          String confirmButton,
                                          String cancelButton,
                                          boolean cancelIsDefault,
                                          ConfirmationCallback callback)

Deprecated. since 6.1, use the AlertBuilder.

Description copied from interface: OverlayLayer

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

Specified by:

openConfirmation in interface OverlayLayer

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
default void openConfirmation(MessageStyleType type,
                                          String title,
                                          View body,
                                          String confirmButton,
                                          String cancelButton,
                                          boolean cancelIsDefault,
                                          ConfirmationCallback callback)

Deprecated. since 6.1, use the AlertBuilder.

Description copied from interface: OverlayLayer

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

Specified by:

openConfirmation in interface OverlayLayer

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

Description copied from interface: OverlayLayer

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

Specified by:

openNotification in interface OverlayLayer

viewToShow - Content to show as View.

openNotification

@Deprecated
default 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.

Description copied from interface: OverlayLayer

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

Specified by:

openNotification in interface OverlayLayer

title - Content to show as string.

openNotification

@Deprecated
default 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.

Description copied from interface: OverlayLayer

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

Specified by:

openNotification in interface OverlayLayer

title - Content to show as string.

linkText - Text to show in a link button.

cb - Callback for when user clicks on link.

getOverlayDelegate

OverlayLayer getOverlayDelegate()

Deprecated.