info.magnolia.admincentral

Class ResurfaceShell

java.lang.Object

info.magnolia.admincentral.ResurfaceShell

All Implemented Interfaces:

UiContext, OverlayLayer, Shell

public class ResurfaceShell
extends Object
implements Shell, UiContext

The shell implementation for the Resurface Admincentral.

In comparison with the M5 shell, this implementation favors stock Vaadin usage over GWT customizations.

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
ResurfaceShell(MessagesManager messagesManager, info.magnolia.i18nsystem.SimpleTranslator i18n)

Method Summary

Modifier and Type	Method and Description
void	askForConfirmation(String message, ConfirmationHandler listener)
String	getFragment()
OverlayLayer	getOverlayDelegate()
void	openAlert(MessageStyleType messageType, String title, String body, String okButton, AlertCallback callback) Opens an alert dialog of given type, with given title and body.
void	openAlert(MessageStyleType messageType, String title, View content, String okButton, AlertCallback callback) Opens an alert dialog of given type, with given title and body.
void	openConfirmation(MessageStyleType messageType, 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 messageType, String title, View content, String confirmButton, String cancelButton, boolean cancelIsDefault, ConfirmationCallback callback) Opens a confirmation dialog of given type, with given title and body.
void	openNotification(MessageStyleType messageType, boolean doesTimeout, String title) Notification indicator is a message banner that only shows a message to user.
void	openNotification(MessageStyleType messageType, boolean doesTimeout, String title, String linkText, NotificationCallback cb) Notification indicator is a message banner that only shows a message to user.
void	openNotification(MessageStyleType messageType, boolean doesTimeout, View viewToShow) Notification indicator is a message banner that only shows a message to user.
OverlayCloser	openOverlay(View view) Deprecated.
OverlayCloser	openOverlay(View view, OverlayLayer.ModalityLevel modalityLevel) Deprecated.
OverlayCloser	openOverlayOnView(View view, View parent, OverlayLayer.ModalityDomain modalityLocation, OverlayLayer.ModalityLevel modalityLevel) Deprecated.
void	setFragment(String fragment)
void	showError(String message, Exception e)
void	showNotification(String message)

Methods inherited from class java.lang.Object

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

Methods inherited from interface info.magnolia.ui.api.shell.Shell

addFragmentChangedHandler, enterFullScreenMode, exitFullScreenMode, pushToClient, registerApps, setStickerView, setUserMenu

Constructor Detail

ResurfaceShell

@Inject
public ResurfaceShell(MessagesManager messagesManager,
                              info.magnolia.i18nsystem.SimpleTranslator i18n)

Method Detail

askForConfirmation

public void askForConfirmation(String message,
                               ConfirmationHandler listener)

Specified by:

askForConfirmation in interface Shell

showNotification

public void showNotification(String message)

Specified by:

showNotification in interface Shell

showError

public void showError(String message,
                      Exception e)

Specified by:

showError in interface Shell

getFragment

public String getFragment()

Specified by:

getFragment in interface Shell

setFragment

public void setFragment(String fragment)

Specified by:

setFragment in interface Shell

openOverlayOnView

@Deprecated
public OverlayCloser openOverlayOnView(View view,
                                                   View parent,
                                                   OverlayLayer.ModalityDomain modalityLocation,
                                                   OverlayLayer.ModalityLevel modalityLevel)

Deprecated.

Description copied from interface: Shell

Open an Overlay on top of a specific View.

Specified by:

openOverlayOnView in interface Shell

Parameters:

view - View to be displayed over the view.

parent - The View to open the Overlay on top of.

openOverlay

@Deprecated
public OverlayCloser openOverlay(View view)

Deprecated.

Description copied from interface: OverlayLayer

Open an Overlay on top of the OverlayLayer implementer.

Specified by:

openOverlay in interface UiContext

Specified by:

openOverlay in interface OverlayLayer

Parameters:

view - View of the component to be displayed modally.

openOverlay

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

Deprecated.

Description copied from interface: OverlayLayer

Open an Overlay on top of the OverlayLayer implementer.

Specified by:

openOverlay in interface UiContext

Specified by:

openOverlay in interface OverlayLayer

modalityLevel - Modality level

openNotification

public void openNotification(MessageStyleType messageType,
                             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 UiContext

Specified by:

openNotification in interface OverlayLayer

title - Content to show as string.

openNotification

public void openNotification(MessageStyleType messageType,
                             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 UiContext

Specified by:

openNotification in interface OverlayLayer

viewToShow - Content to show as View.

openNotification

public void openNotification(MessageStyleType messageType,
                             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 UiContext

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.

openAlert

public void openAlert(MessageStyleType messageType,
                      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 UiContext

Specified by:

openAlert in interface OverlayLayer

Parameters:

messageType - 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 messageType,
                      String title,
                      View content,
                      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 UiContext

Specified by:

openAlert in interface OverlayLayer

Parameters:

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

title - the alert dialog's title

content - 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 messageType,
                             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 UiContext

Specified by:

openConfirmation in interface OverlayLayer

Parameters:

messageType - 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 messageType,
                             String title,
                             View content,
                             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 UiContext

Specified by:

openConfirmation in interface OverlayLayer

Parameters:

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

title - the confirmation dialog's title

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

getOverlayDelegate

public OverlayLayer getOverlayDelegate()

Specified by:

getOverlayDelegate in interface UiContext