info.magnolia.ui.api.shell

Interface Shell

All Superinterfaces:

OverlayLayer, UiContext

All Known Implementing Classes:

ResurfaceShell, 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

Modifier and Type	Method and Description
default info.magnolia.event.HandlerRegistration	addFragmentChangedHandler(FragmentChangedHandler handler) Deprecated. since 6.0, no need to register fragment handling through the Shell anymore; use Vaadin's Page#addPopStateListener instead.
void	askForConfirmation(String message, ConfirmationHandler listener)
default void	enterFullScreenMode() Deprecated. since 6.0 legacy full-screen mode is no longer supported.
default void	exitFullScreenMode() Deprecated. since 6.0 legacy full-screen mode is no longer supported.
String	getFragment()
default OverlayCloser	openOverlayOnView(View view, View parent, OverlayLayer.ModalityDomain modalityLocation, OverlayLayer.ModalityLevel modalityLevel) Deprecated. since 6.1, overlays are no longer bound to specific views.
default void	pushToClient() Deprecated. since 6.0; was never used.
default void	registerApps(List<String> appNames) Deprecated. since 6.0 app registration is no longer performed through the Shell interface.
void	setFragment(String fragment)
default void	setStickerView(View view) Deprecated. since 6.0 environment info sticker is no longer provided through the Shell interface.
default void	setUserMenu(View view) Deprecated. since 6.0 user menu is no longer provided through the Shell interface.
void	showError(String message, Exception e)
void	showNotification(String message)

Methods inherited from interface info.magnolia.ui.api.context.UiContext

getOverlayDelegate, 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

@Deprecated
default info.magnolia.event.HandlerRegistration addFragmentChangedHandler(FragmentChangedHandler handler)

Deprecated. since 6.0, no need to register fragment handling through the Shell anymore; use Vaadin's Page#addPopStateListener instead.

registerApps

@Deprecated
default void registerApps(List<String> appNames)

Deprecated. since 6.0 app registration is no longer performed through the Shell interface.

pushToClient

@Deprecated
default void pushToClient()

Deprecated. since 6.0; was never used.

enterFullScreenMode

@Deprecated
default void enterFullScreenMode()

Deprecated. since 6.0 legacy full-screen mode is no longer supported.

exitFullScreenMode

@Deprecated
default void exitFullScreenMode()

Deprecated. since 6.0 legacy full-screen mode is no longer supported.

openOverlayOnView

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

Deprecated. since 6.1, overlays are no longer bound to specific views.

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

@Deprecated
default void setUserMenu(View view)

Deprecated. since 6.0 user menu is no longer provided through the Shell interface.

setStickerView

@Deprecated
default void setStickerView(View view)

Deprecated. since 6.0 environment info sticker is no longer provided through the Shell interface.