info.magnolia.ui.api.shell
Interface Shell

All Superinterfaces:

OverlayLayer, UiContext

All Known Implementing Classes:

ShellImpl

public interface Shell
extends UiContext

Decouples the presenters and the Vaadin application. Provides methods to show messages and configuration dialogs.

Nested Class Summary

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

OverlayLayer.ModalityDomain, OverlayLayer.ModalityLevel

Method Summary

info.magnolia.event.HandlerRegistration	addFragmentChangedHandler(FragmentChangedHandler handler)
void	askForConfirmation(String message, ConfirmationHandler listener)
void	enterFullScreenMode()
void	exitFullScreenMode()
String	getFragment()
OverlayCloser	openOverlayOnView(View view, View parent, OverlayLayer.ModalityDomain modalityLocation, OverlayLayer.ModalityLevel modalityLevel) Open an Overlay on top of a specific View.
void	pushToClient()
void	registerApps(List<String> appNames)
void	setFragment(String fragment)
void	setUserMenu(View view)
void	showError(String message, Exception e)
void	showNotification(String message)

Methods inherited from interface info.magnolia.ui.api.overlay.OverlayLayer

openAlert, openAlert, openConfirmation, openConfirmation, openNotification, openNotification, openNotification, openOverlay, openOverlay

Method Detail

askForConfirmation

void askForConfirmation(String message,
                        ConfirmationHandler listener)

showNotification

void showNotification(String message)

showError

void showError(String message,
               Exception e)

getFragment

String getFragment()

setFragment

void setFragment(String fragment)

addFragmentChangedHandler

info.magnolia.event.HandlerRegistration addFragmentChangedHandler(FragmentChangedHandler handler)

registerApps

void registerApps(List<String> appNames)

pushToClient

void pushToClient()

enterFullScreenMode

void enterFullScreenMode()

exitFullScreenMode

void exitFullScreenMode()

openOverlayOnView

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

Open an Overlay on top of a specific View.

Parameters:

view - View to be displayed over the view.

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

setUserMenu

void setUserMenu(View view)