org.vaadin.spring.sidebar.components

Class ValoSideBar

java.lang.Object

com.vaadin.server.AbstractClientConnector

com.vaadin.ui.AbstractComponent

com.vaadin.ui.CustomComponent

org.vaadin.spring.sidebar.components.AbstractSideBar<CssLayout>

org.vaadin.spring.sidebar.components.ValoSideBar

All Implemented Interfaces:

ContextClickEvent.ContextClickNotifier, MethodEventSource, ClientConnector, Sizeable, Connector, Component, HasComponents, Serializable, Iterable<Component>

public class ValoSideBar
extends AbstractSideBar<CssLayout>

This is a side bar component that has been especially designed to be used with the Valo theme. It is based on CssLayouts and the MENU_ -styles.

The sections and items are declared using the SideBarSection and SideBarItem annotations, respectively. To use this side bar, simply enable it in your application configuration using the EnableSideBar annotation, and inject it into your UI. Also remember to use the Valo theme.

Author:

Petter Holmström (petter@vaadin.com)

See Also:

setHeader(com.vaadin.ui.Layout), setLogo(com.vaadin.ui.Component), setLargeIcons(boolean), Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	ValoSideBar.DefaultItemComponentFactory Default implementation of ValoSideBar.ItemComponentFactory that creates Buttons.
class	ValoSideBar.DefaultSectionComponentFactory Default implementation of ValoSideBar.SectionComponentFactory that adds the section header and items directly to the composition root.

Nested classes/interfaces inherited from class org.vaadin.spring.sidebar.components.AbstractSideBar

AbstractSideBar.ItemComponentFactory, AbstractSideBar.ItemFilter, AbstractSideBar.SectionComponentFactory<CR extends ComponentContainer>

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

HasComponents.ComponentAttachDetachNotifier, HasComponents.ComponentAttachEvent, HasComponents.ComponentAttachListener, HasComponents.ComponentDetachEvent, HasComponents.ComponentDetachListener

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

Component.ErrorEvent, Component.Event, Component.Focusable, Component.Listener

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

ClientConnector.AttachEvent, ClientConnector.AttachListener, ClientConnector.ConnectorErrorEvent, ClientConnector.DetachEvent, ClientConnector.DetachListener

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

Sizeable.Unit

Field Summary

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
ValoSideBar(SideBarUtils sideBarUtils) You should not need to create instances of this component directly.

Method Summary

Modifier and Type	Method and Description
protected CssLayout	createCompositionRoot() Creates the component that actually contain the side bar sections and items.
protected AbstractSideBar.ItemComponentFactory	createDefaultItemComponentFactory() Creates the default AbstractSideBar.ItemComponentFactory to use.
protected AbstractSideBar.SectionComponentFactory<CssLayout>	createDefaultSectionComponentFactory() Creates the default AbstractSideBar.SectionComponentFactory to use.
Layout	getHeader() Returns the header layout, or null if none has been set.
Component	getLogo() Returns the logo, or null if none has been set.
boolean	isLargeIcons() Returns whether the side bar is using large icons or not.
void	setHeader(Layout headerLayout) Adds a header to the top of the side bar, below the logo.
void	setLargeIcons(boolean largeIcons) Specifies whether the side bar should use large icons or not.
void	setLogo(Component logo) Adds a logo to the very top of the side bar, above the header.

Methods inherited from class org.vaadin.spring.sidebar.components.AbstractSideBar

attach, detach, getCompositionRoot, getItemComponentFactory, getItemFilter, getSectionComponentFactory, setItemComponentFactory, setItemFilter, setSectionComponentFactory

Methods inherited from class com.vaadin.ui.CustomComponent

getComponentCount, getState, getState, iterator, setCompositionRoot

Methods inherited from class com.vaadin.ui.AbstractComponent

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

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.vaadin.ui.Component

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

Methods inherited from interface com.vaadin.server.ClientConnector

addAttachListener, addDetachListener, beforeClientResponse, 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

Constructor Detail

ValoSideBar

public ValoSideBar(SideBarUtils sideBarUtils)

You should not need to create instances of this component directly. Instead, just inject the side bar into your UI.

Method Detail

createCompositionRoot

protected CssLayout createCompositionRoot()

Description copied from class: AbstractSideBar

Creates the component that actually contain the side bar sections and items. This method is called every time the side bar is attached to a UI. Every time the side bar is detached, its composition root will be set back to null.

Specified by:

createCompositionRoot in class AbstractSideBar<CssLayout>

isLargeIcons

public boolean isLargeIcons()

Returns whether the side bar is using large icons or not. Default is false.

See Also:

ValoTheme.MENU_PART_LARGE_ICONS

setLargeIcons

public void setLargeIcons(boolean largeIcons)

Specifies whether the side bar should use large icons or not.

See Also:

ValoTheme.MENU_PART_LARGE_ICONS

setHeader

public void setHeader(Layout headerLayout)

Adds a header to the top of the side bar, below the logo. The ValoTheme.MENU_TITLE style will automatically be added to the layout.

Parameters:

headerLayout - the layout containing the header, or null to remove.

getHeader

public Layout getHeader()

Returns the header layout, or null if none has been set.

See Also:

setHeader(com.vaadin.ui.Layout)

setLogo

public void setLogo(Component logo)

Adds a logo to the very top of the side bar, above the header. The logo's primary style is automatically set to ValoTheme.MENU_LOGO ands its size to undefined.

Parameters:

logo - a Label or Button to use as the logo, or null to remove the logo completely.

getLogo

public Component getLogo()

Returns the logo, or null if none has been set.

See Also:

setLogo(com.vaadin.ui.Component)

createDefaultSectionComponentFactory

protected AbstractSideBar.SectionComponentFactory<CssLayout> createDefaultSectionComponentFactory()

Description copied from class: AbstractSideBar

Creates the default AbstractSideBar.SectionComponentFactory to use. This method must never return null.

Specified by:

createDefaultSectionComponentFactory in class AbstractSideBar<CssLayout>

createDefaultItemComponentFactory

protected AbstractSideBar.ItemComponentFactory createDefaultItemComponentFactory()

Description copied from class: AbstractSideBar

Creates the default AbstractSideBar.ItemComponentFactory to use. This method must never return null.

Specified by:

createDefaultItemComponentFactory in class AbstractSideBar<CssLayout>