info.magnolia.ui.framework.context

Class AbstractUIContext

java.lang.Object

info.magnolia.ui.framework.context.AbstractUIContext

All Implemented Interfaces:

UiContext, OverlayLayer

Direct Known Subclasses:

AppInstanceControllerImpl, ShellImpl, SubAppContextImpl

public abstract class AbstractUIContext
extends Object
implements UiContext

Abstract basic implementation of UiContext. Delegates method calls to OverlayPresenter.

Nested Class Summary

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

OverlayLayer.ModalityDomain, OverlayLayer.ModalityLevel

Constructor Summary

Constructors

Constructor and Description
AbstractUIContext()

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract OverlayPresenter	initializeOverlayPresenter()
void	openAlert(MessageStyleType type, String title, String body, String okButton, AlertCallback callback) Opens an alert dialog of given type, with given title and body.
void	openAlert(MessageStyleType type, String title, View body, String okButton, AlertCallback callback) Opens an alert dialog of given type, with given title and body.
void	openAlert(MessageStyleType type, View body, String okButton, AlertCallback callback) Opens an alert dialog of given type, with given body but with empty title.
void	openConfirmation(MessageStyleType type, String title, String body, String confirmButton, String cancelButton, boolean cancelIsDefault, ConfirmationCallback callback) Opens a confirmation dialog of given type, with given title and body.
void	openConfirmation(MessageStyleType type, String title, View body, String confirmButton, String cancelButton, boolean cancelIsDefault, ConfirmationCallback callback) Opens a confirmation dialog of given type, with given title and body.
void	openConfirmation(MessageStyleType type, View body, String confirmButton, String cancelButton, boolean cancelIsDefault, ConfirmationCallback callback) Opens a confirmation dialog of given type, with given body but with empty title.
void	openNotification(MessageStyleType type, boolean doesTimeout, String title) Notification indicator is a message banner that only shows a message to user.
void	openNotification(MessageStyleType type, boolean doesTimeout, String title, String linkText, NotificationCallback cb) Notification indicator is a message banner that only shows a message to user.
void	openNotification(MessageStyleType type, boolean doesTimeout, View viewToShow) Notification indicator is a message banner that only shows a message to user.
OverlayCloser	openOverlay(View view) Open an Overlay on top of the OverlayLayer implementer.
OverlayCloser	openOverlay(View view, OverlayLayer.ModalityLevel modalityLevel) Open an Overlay on top of the OverlayLayer implementer.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractUIContext

public AbstractUIContext()

Method Detail

initializeOverlayPresenter

protected abstract OverlayPresenter initializeOverlayPresenter()

openOverlay

public OverlayCloser openOverlay(View view)

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

public OverlayCloser openOverlay(View view,
                        OverlayLayer.ModalityLevel modalityLevel)

Description copied from interface: OverlayLayer

Open an Overlay on top of the OverlayLayer implementer.

Specified by:

openOverlay in interface OverlayLayer

modalityLevel - Modality level

openAlert

public void openAlert(MessageStyleType type,
             View body,
             String okButton,
             AlertCallback callback)

Description copied from interface: OverlayLayer

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

Specified by:

openAlert in interface OverlayLayer

Parameters:

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

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

openAlert

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

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

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

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

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

Description copied from interface: OverlayLayer

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

Specified by:

openConfirmation in interface OverlayLayer

Parameters:

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

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

openConfirmation

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

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

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

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

public void openNotification(MessageStyleType type,
                    boolean doesTimeout,
                    View viewToShow)

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

public void openNotification(MessageStyleType type,
                    boolean doesTimeout,
                    String title)

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

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

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.