info.magnolia.ui.workbench

Class WorkbenchViewImpl

java.lang.Object

com.vaadin.server.AbstractClientConnector

com.vaadin.ui.AbstractComponent

com.vaadin.ui.AbstractComponentContainer

com.vaadin.ui.AbstractLayout

com.vaadin.ui.AbstractOrderedLayout

com.vaadin.ui.VerticalLayout

info.magnolia.ui.workbench.WorkbenchViewImpl

All Implemented Interfaces:

com.vaadin.event.ContextClickEvent.ContextClickNotifier, com.vaadin.event.LayoutEvents.LayoutClickNotifier, com.vaadin.event.MethodEventSource, com.vaadin.server.ClientConnector, com.vaadin.server.Sizeable, com.vaadin.shared.Connector, com.vaadin.ui.Component, com.vaadin.ui.ComponentContainer, com.vaadin.ui.HasComponents, com.vaadin.ui.HasComponents.ComponentAttachDetachNotifier, com.vaadin.ui.Layout, com.vaadin.ui.Layout.AlignmentHandler, com.vaadin.ui.Layout.MarginHandler, com.vaadin.ui.Layout.SpacingHandler, View, WorkbenchView, Serializable, Iterable<com.vaadin.ui.Component>

public class WorkbenchViewImpl
extends com.vaadin.ui.VerticalLayout
implements WorkbenchView, Serializable

Implementation of the workbench view.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface info.magnolia.ui.workbench.WorkbenchView

WorkbenchView.Listener

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

com.vaadin.ui.Layout.AlignmentHandler, com.vaadin.ui.Layout.MarginHandler, com.vaadin.ui.Layout.SpacingHandler

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, com.vaadin.ui.Component.Listener

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

Modifier and Type	Field and Description
protected com.vaadin.ui.Panel	keyboardEventPanel

Fields inherited from class com.vaadin.ui.AbstractOrderedLayout

ALIGNMENT_DEFAULT, components

Fields inherited from class com.vaadin.ui.AbstractComponent

DESIGN_ATTR_PLAIN_TEXT

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

Constructors

Constructor and Description
WorkbenchViewImpl()
WorkbenchViewImpl(info.magnolia.i18nsystem.SimpleTranslator i18n) Deprecated. since 5.4.3. Use default constructor instead.

Method Summary

Modifier and Type	Method and Description
void	addContentTool(View view) Use this method to add content tools.
void	addContentTool(View view, ContentToolDefinition.Alignment alignment, float expandRatio)
void	addContentView(String viewType, ContentView view, ContentPresenterDefinition contentViewDefintion) Deprecated. since 5.4.3. Use addContentView( viewType, view, viewTypeIcon) instead. Interface method will become deprecated on magnolia-ui 5.5.
void	addContentView(String viewType, ContentView view, String viewTypeIcon) Adds a content view by given view type, content view and view type icon.
com.vaadin.ui.Component	asVaadinComponent() Returns the Vaadin component managed by this view.
void	bindKeyboardHandlers()
ContentView	getSelectedView()
void	setListener(WorkbenchView.Listener listener)
void	setMultiselect(boolean multiselect) Whether the user can select more items.
void	setSearchQuery(String query) Updates the search box with given search query.
void	setStatusBarView(StatusBarView statusBar) Use this method to add a status bar to this sub app view.
void	setViewType(String type)

Methods inherited from class com.vaadin.ui.VerticalLayout

getState

Methods inherited from class com.vaadin.ui.AbstractOrderedLayout

addComponent, addComponent, addComponentAsFirst, addLayoutClickListener, addListener, getComponent, getComponentAlignment, getComponentCount, getComponentIndex, getCustomAttributes, getDefaultComponentAlignment, getExpandRatio, getMargin, getState, isSpacing, iterator, readDesign, removeComponent, removeLayoutClickListener, removeListener, replaceComponent, setComponentAlignment, setDefaultComponentAlignment, setExpandRatio, setMargin, setMargin, setSpacing, writeDesign

Methods inherited from class com.vaadin.ui.AbstractLayout

readMargin, writeMargin

Methods inherited from class com.vaadin.ui.AbstractComponentContainer

addComponentAttachListener, addComponentDetachListener, addComponents, addListener, addListener, fireComponentAttachEvent, fireComponentDetachEvent, getComponentIterator, moveComponentsFrom, removeAllComponents, removeComponentAttachListener, removeComponentDetachListener, removeListener, removeListener, setHeight, setWidth

Methods inherited from class com.vaadin.ui.AbstractComponent

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

Methods inherited from class com.vaadin.server.AbstractClientConnector

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.vaadin.ui.ComponentContainer

addComponents, addListener, addListener, getComponentIterator, moveComponentsFrom, removeAllComponents, removeListener, removeListener

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, setHeightUndefined, setSizeFull, setSizeUndefined, setWidth, setWidth, setWidthUndefined

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface com.vaadin.ui.HasComponents.ComponentAttachDetachNotifier

addComponentAttachListener, addComponentDetachListener, removeComponentAttachListener, removeComponentDetachListener

Field Detail

keyboardEventPanel

protected final com.vaadin.ui.Panel keyboardEventPanel

Constructor Detail

WorkbenchViewImpl

public WorkbenchViewImpl()

WorkbenchViewImpl

@Deprecated
public WorkbenchViewImpl(info.magnolia.i18nsystem.SimpleTranslator i18n)

Deprecated. since 5.4.3. Use default constructor instead.

Method Detail

bindKeyboardHandlers

public void bindKeyboardHandlers()

setSearchQuery

public void setSearchQuery(String query)

Description copied from interface: WorkbenchView

Updates the search box with given search query.

Specified by:

setSearchQuery in interface WorkbenchView

addContentView

@Deprecated
public void addContentView(String viewType,
                                       ContentView view,
                                       ContentPresenterDefinition contentViewDefintion)

Deprecated. since 5.4.3. Use addContentView( viewType, view, viewTypeIcon) instead. Interface method will become deprecated on magnolia-ui 5.5.

Adds a content view by given view type, content view and content view definition.

Specified by:

addContentView in interface WorkbenchView

addContentView

public void addContentView(String viewType,
                           ContentView view,
                           String viewTypeIcon)

Adds a content view by given view type, content view and view type icon.

setViewType

public void setViewType(String type)

Specified by:

setViewType in interface WorkbenchView

setStatusBarView

public void setStatusBarView(StatusBarView statusBar)

Description copied from interface: WorkbenchView

Use this method to add a status bar to this sub app view.

Specified by:

setStatusBarView in interface WorkbenchView

getSelectedView

public ContentView getSelectedView()

Specified by:

getSelectedView in interface WorkbenchView

asVaadinComponent

public com.vaadin.ui.Component asVaadinComponent()

Description copied from interface: View

Returns the Vaadin component managed by this view.

Specified by:

asVaadinComponent in interface View

setListener

public void setListener(WorkbenchView.Listener listener)

Specified by:

setListener in interface WorkbenchView

setMultiselect

public void setMultiselect(boolean multiselect)

Description copied from interface: WorkbenchView

Whether the user can select more items.

Specified by:

setMultiselect in interface WorkbenchView

addContentTool

public void addContentTool(View view)

Description copied from interface: WorkbenchView

Use this method to add content tools.

Specified by:

addContentTool in interface WorkbenchView

addContentTool

public void addContentTool(View view,
                           ContentToolDefinition.Alignment alignment,
                           float expandRatio)