info.magnolia.ui.vaadin.magnoliashell
Class MagnoliaShell

java.lang.Object
  com.vaadin.server.AbstractClientConnector
      com.vaadin.ui.AbstractComponent
          info.magnolia.ui.vaadin.magnoliashell.MagnoliaShell

All Implemented Interfaces:

com.vaadin.event.MethodEventSource, com.vaadin.server.ClientConnector, com.vaadin.server.Sizeable, com.vaadin.shared.Connector, com.vaadin.ui.Component, com.vaadin.ui.HasComponents, info.magnolia.ui.api.view.View, Serializable, Iterable<com.vaadin.ui.Component>

public class MagnoliaShell
extends com.vaadin.ui.AbstractComponent
implements com.vaadin.ui.HasComponents, info.magnolia.ui.api.view.View

Server side implementation of the MagnoliaShell container.

See Also:

Serialized Form

Nested Class Summary

static interface

MagnoliaShell.Listener Listener for events.

Nested classes/interfaces inherited from interface com.vaadin.ui.HasComponents

com.vaadin.ui.HasComponents.ComponentAttachDetachNotifier, com.vaadin.ui.HasComponents.ComponentAttachEvent, com.vaadin.ui.HasComponents.ComponentAttachListener, com.vaadin.ui.HasComponents.ComponentDetachEvent, com.vaadin.ui.HasComponents.ComponentDetachListener

Nested classes/interfaces inherited from interface com.vaadin.ui.Component

com.vaadin.ui.Component.ErrorEvent, com.vaadin.ui.Component.Event, com.vaadin.ui.Component.Focusable

Nested classes/interfaces inherited from interface com.vaadin.server.ClientConnector

com.vaadin.server.ClientConnector.AttachEvent, com.vaadin.server.ClientConnector.AttachListener, com.vaadin.server.ClientConnector.ConnectorErrorEvent, com.vaadin.server.ClientConnector.DetachEvent, com.vaadin.server.ClientConnector.DetachListener

Nested classes/interfaces inherited from interface com.vaadin.server.Sizeable

com.vaadin.server.Sizeable.Unit

Field Summary

Fields inherited from interface com.vaadin.server.Sizeable

SIZE_UNDEFINED, UNITS_CM, UNITS_EM, UNITS_EX, UNITS_INCH, UNITS_MM, UNITS_PERCENTAGE, UNITS_PICAS, UNITS_PIXELS, UNITS_POINTS

Constructor Summary

MagnoliaShell()

Method Summary

com.vaadin.ui.Component	asVaadinComponent()
protected MagnoliaShellState	createState()
void	doRegisterApps(List<String> appNames)
ShellViewport	getAppViewport()
ShellAppsViewport	getShellAppViewport()
protected MagnoliaShellState	getState()
protected MagnoliaShellState	getState(boolean markDirty)
String	getUriFragment()
void	goToApp(Fragment fragment)
void	goToShellApp(Fragment fragment)
void	hideAllMessages()
Iterator<com.vaadin.ui.Component>	iterator() Must also include any overlays that have been attached to the shell.
void	notifyOnFragmentChanged(String fragment)
void	onAppStarted(String appName)
void	onAppStopped(String appName)
info.magnolia.ui.api.overlay.OverlayCloser	openOverlay(info.magnolia.ui.api.view.View child, info.magnolia.ui.api.view.View parent, info.magnolia.ui.api.overlay.OverlayLayer.ModalityDomain modalityDomain, info.magnolia.ui.api.overlay.OverlayLayer.ModalityLevel modalityLevel) Open an Overlay on top of a specific View.
void	registerShellApp(ShellAppType type, com.vaadin.ui.Component component)
void	removeMessage(String messageId)
void	removeOverlay(Overlay overlay)
void	setFullScreen(boolean isFullScreen)
void	setIndication(ShellAppType type, int indication)
void	setListener(MagnoliaShell.Listener listener)
void	setUriFragment(Fragment fragment)
void	setUserMenu(info.magnolia.ui.api.view.View view)
void	showError(String id, String subject, String message)
void	showInfo(String id, String subject, String message)
void	showWarning(String id, String subject, String message)
void	stopCurrentApp()
void	stopCurrentShellApp()
void	updateShellAppIndication(ShellAppType type, int incrementOrDecrement)

Methods inherited from class com.vaadin.ui.AbstractComponent

addListener, addShortcutListener, addStyleName, attach, beforeClientResponse, detach, findAncestor, fireComponentErrorEvent, fireComponentEvent, focus, getActionManager, getCaption, getComponentError, getData, getDebugId, getDescription, getErrorMessage, getHeight, getHeightUnits, getIcon, getId, getLocale, getParent, getPrimaryStyleName, getStyleName, getWidth, getWidthUnits, isConnectorEnabled, isEnabled, isImmediate, isReadOnly, isVisible, removeListener, removeShortcutListener, removeStyleName, setCaption, setComponentError, setData, setDebugId, setDescription, setEnabled, setHeight, setHeight, setIcon, setId, setImmediate, setLocale, setParent, setPrimaryStyleName, setReadOnly, setSizeFull, setSizeUndefined, setStyleName, setVisible, setWidth, setWidth

Methods inherited from class com.vaadin.server.AbstractClientConnector

addAttachListener, addDetachListener, addExtension, addListener, addListener, addListener, addMethodInvocationToQueue, encodeState, fireEvent, getAllChildrenIterable, getConnectorId, getErrorHandler, getExtensions, getListeners, getResource, getRpcManager, getRpcProxy, getSession, getStateType, getUI, handleConnectorRequest, hasListeners, isAttached, markAsDirty, markAsDirtyRecursive, registerRpc, registerRpc, removeAttachListener, removeDetachListener, removeExtension, removeListener, removeListener, removeListener, removeListener, requestRepaint, requestRepaintAll, retrievePendingRpcCalls, setErrorHandler, setResource

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.vaadin.ui.Component

addListener, addStyleName, attach, getCaption, getDescription, getIcon, getId, getLocale, getParent, getPrimaryStyleName, getStyleName, getUI, isEnabled, isReadOnly, isVisible, removeListener, removeStyleName, setCaption, setEnabled, setIcon, setId, setParent, setPrimaryStyleName, setReadOnly, setStyleName, setVisible

Methods inherited from interface com.vaadin.server.ClientConnector

addAttachListener, addDetachListener, beforeClientResponse, detach, encodeState, getErrorHandler, getExtensions, getRpcManager, getStateType, handleConnectorRequest, isAttached, isConnectorEnabled, markAsDirty, markAsDirtyRecursive, removeAttachListener, removeDetachListener, removeExtension, requestRepaint, requestRepaintAll, retrievePendingRpcCalls, setErrorHandler

Methods inherited from interface com.vaadin.shared.Connector

getConnectorId

Methods inherited from interface com.vaadin.server.Sizeable

getHeight, getHeightUnits, getWidth, getWidthUnits, setHeight, setHeight, setSizeFull, setSizeUndefined, setWidth, setWidth

Constructor Detail

MagnoliaShell

public MagnoliaShell()

Method Detail

setUserMenu

public void setUserMenu(info.magnolia.ui.api.view.View view)

stopCurrentShellApp

public void stopCurrentShellApp()

stopCurrentApp

public void stopCurrentApp()

removeMessage

public void removeMessage(String messageId)

goToApp

public void goToApp(Fragment fragment)

goToShellApp

public void goToShellApp(Fragment fragment)

showInfo

public void showInfo(String id,
                     String subject,
                     String message)

showError

public void showError(String id,
                      String subject,
                      String message)

showWarning

public void showWarning(String id,
                        String subject,
                        String message)

hideAllMessages

public void hideAllMessages()

setFullScreen

public void setFullScreen(boolean isFullScreen)

updateShellAppIndication

public void updateShellAppIndication(ShellAppType type,
                                     int incrementOrDecrement)

setIndication

public void setIndication(ShellAppType type,
                          int indication)

setUriFragment

public void setUriFragment(Fragment fragment)

getUriFragment

public String getUriFragment()

openOverlay

public info.magnolia.ui.api.overlay.OverlayCloser openOverlay(info.magnolia.ui.api.view.View child,
                                                              info.magnolia.ui.api.view.View parent,
                                                              info.magnolia.ui.api.overlay.OverlayLayer.ModalityDomain modalityDomain,
                                                              info.magnolia.ui.api.overlay.OverlayLayer.ModalityLevel modalityLevel)

Open an Overlay on top of a specific View.

Parameters:

child - View to be displayed over another view.

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

removeOverlay

public void removeOverlay(Overlay overlay)

createState

protected MagnoliaShellState createState()

Overrides:

createState in class com.vaadin.server.AbstractClientConnector

getState

protected MagnoliaShellState getState()

Overrides:

getState in class com.vaadin.ui.AbstractComponent

getState

protected MagnoliaShellState getState(boolean markDirty)

Overrides:

getState in class com.vaadin.ui.AbstractComponent

notifyOnFragmentChanged

public void notifyOnFragmentChanged(String fragment)

setListener

public void setListener(MagnoliaShell.Listener listener)

doRegisterApps

public void doRegisterApps(List<String> appNames)

onAppStarted

public void onAppStarted(String appName)

onAppStopped

public void onAppStopped(String appName)

registerShellApp

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

iterator

public Iterator<com.vaadin.ui.Component> iterator()

Must also include any overlays that have been attached to the shell.

Specified by:

iterator in interface com.vaadin.ui.HasComponents

Specified by:

iterator in interface Iterable<com.vaadin.ui.Component>

getAppViewport

public ShellViewport getAppViewport()

getShellAppViewport

public ShellAppsViewport getShellAppViewport()

asVaadinComponent

public com.vaadin.ui.Component asVaadinComponent()

Specified by:

asVaadinComponent in interface info.magnolia.ui.api.view.View