info.magnolia.ui.framework.shell

Class ShellImpl

java.lang.Object

info.magnolia.ui.framework.context.AbstractUIContext

info.magnolia.ui.framework.shell.ShellImpl

All Implemented Interfaces:

info.magnolia.event.EventHandler, UiContext, OverlayLayer, Shell, MessageEventHandler

@Singleton
public class ShellImpl
extends AbstractUIContext
implements Shell, MessageEventHandler

Admin shell.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ShellImpl.ShellAppLocationProvider Provides the current location of shell apps.

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

OverlayLayer.ModalityDomain, OverlayLayer.ModalityLevel

Constructor Summary

Constructors

Constructor and Description
ShellImpl(info.magnolia.event.EventBus admincentralEventBus, AppController appController, MessagesManager messagesManager)

Method Summary

Modifier and Type	Method and Description
info.magnolia.event.HandlerRegistration	addFragmentChangedHandler(FragmentChangedHandler handler)
void	askForConfirmation(String message, ConfirmationHandler listener)
void	enterFullScreenMode()
void	exitFullScreenMode()
Viewport	getAppViewport()
String	getFragment()
MagnoliaShell	getMagnoliaShell()
Viewport	getShellAppViewport()
void	hideAllMessages()
protected OverlayPresenter	initializeOverlayPresenter()
void	messageCleared(MessageEvent event)
void	messageRemoved(MessageEvent messageEvent)
void	messageSent(MessageEvent event)
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	registerShellApp(ShellAppType type, com.vaadin.ui.Component component)
void	setFragment(String fragment)
void	setFullScreen(boolean isFullScreen)
void	setIndication(ShellAppType type, int indication)
void	setShellAppLocationProvider(ShellImpl.ShellAppLocationProvider shellAppLocationProvider)
void	setUserMenu(View view)
void	showError(String messageText, Exception e)
void	showNotification(String messageText)
void	updateShellAppIndication(ShellAppType type, int incrementOrDecrement)

Methods inherited from class info.magnolia.ui.framework.context.AbstractUIContext

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

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.overlay.OverlayLayer

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

Constructor Detail

ShellImpl

@Inject
public ShellImpl(@Named(value="admincentral")
                         info.magnolia.event.EventBus admincentralEventBus,
                         AppController appController,
                         MessagesManager messagesManager)

Method Detail

initializeOverlayPresenter

protected OverlayPresenter initializeOverlayPresenter()

Specified by:

initializeOverlayPresenter in class AbstractUIContext

setShellAppLocationProvider

public void setShellAppLocationProvider(ShellImpl.ShellAppLocationProvider shellAppLocationProvider)

askForConfirmation

public void askForConfirmation(String message,
                               ConfirmationHandler listener)

Specified by:

askForConfirmation in interface Shell

showNotification

public void showNotification(String messageText)

Specified by:

showNotification in interface Shell

showError

public void showError(String messageText,
                      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

addFragmentChangedHandler

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

Specified by:

addFragmentChangedHandler in interface Shell

openOverlayOnView

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

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.

setUserMenu

public void setUserMenu(View view)

Specified by:

setUserMenu in interface Shell

messageSent

public void messageSent(MessageEvent event)

Specified by:

messageSent in interface MessageEventHandler

messageCleared

public void messageCleared(MessageEvent event)

Specified by:

messageCleared in interface MessageEventHandler

messageRemoved

public void messageRemoved(MessageEvent messageEvent)

Specified by:

messageRemoved in interface MessageEventHandler

registerApps

public void registerApps(List<String> appNames)

Specified by:

registerApps in interface Shell

pushToClient

public void pushToClient()

Specified by:

pushToClient in interface Shell

getShellAppViewport

public Viewport getShellAppViewport()

getAppViewport

public Viewport getAppViewport()

setIndication

public void setIndication(ShellAppType type,
                          int indication)

updateShellAppIndication

public void updateShellAppIndication(ShellAppType type,
                                     int incrementOrDecrement)

registerShellApp

public void registerShellApp(ShellAppType type,
                             com.vaadin.ui.Component component)

hideAllMessages

public void hideAllMessages()

setFullScreen

public void setFullScreen(boolean isFullScreen)

getMagnoliaShell

public MagnoliaShell getMagnoliaShell()

enterFullScreenMode

public void enterFullScreenMode()

Specified by:

enterFullScreenMode in interface Shell

exitFullScreenMode

public void exitFullScreenMode()

Specified by:

exitFullScreenMode in interface Shell