org.vaadin.spring.sidebar

Class SideBar

java.lang.Object

com.vaadin.server.AbstractClientConnector

com.vaadin.ui.AbstractComponent

com.vaadin.ui.AbstractComponentContainer

com.vaadin.ui.TabSheet

com.vaadin.ui.Accordion

org.vaadin.spring.sidebar.SideBar

All Implemented Interfaces:

FieldEvents.BlurNotifier, FieldEvents.FocusNotifier, MethodEventSource, ClientConnector, Sizeable, Connector, Component, Component.Focusable, ComponentContainer, HasComponents, HasComponents.ComponentAttachDetachNotifier, SelectiveRenderer, Serializable, Iterable<Component>

public class SideBar
extends Accordion

This is a side bar component that can be used as a main menu in applications. The side bar is an Accordion that looks like this:

 |-------------|
 |   Section   |
 |-------------|
 |    Item     |
 |    Item     |
 |    Item     |
 |             |
 |-------------|
 |   Section   |
 |-------------|
 |   Section   |
 |-------------|
 

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.

The side bar comes with a simple theme. In most cases, you probably want to change the styles to make the look and feel of the side bar more compatible with your application. Please see the VAADIN/addons/sidebar/sidebar.css file in the resources directory.

If you want to customize the components that are added to the accordion, implement SideBar.SectionComponentFactory and/or SideBar.ItemComponentFactory.

Author:

Petter Holmström (petter@vaadin.com)

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	SideBar.DefaultItemComponentFactory Default implementation of SideBar.ItemComponentFactory that creates NativeButtons.
class	SideBar.DefaultSectionComponentFactory Default implementation of SideBar.SectionComponentFactory that creates a Panel with a VerticalLayout that contains the items.
static interface	SideBar.ItemComponentFactory Interface defining a factory for creating components that correspond to items in a side bar section.
static interface	SideBar.SectionComponentFactory Interface defining a factory for creating components that correspond to sections in a side bar.

Nested classes/interfaces inherited from class com.vaadin.ui.TabSheet

TabSheet.CloseHandler, TabSheet.SelectedTabChangeEvent, TabSheet.SelectedTabChangeListener, TabSheet.Tab, TabSheet.TabsheetServerRpcImpl, TabSheet.TabSheetTabImpl

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

Modifier and Type	Field and Description
static String	SELECTED_STYLE
static String	SIDE_BAR_SECTION_ITEM_STYLE
static String	SIDE_BAR_SECTION_STYLE
static String	SIDE_BAR_STYLE

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
SideBar(SideBarUtils sideBarUtils, SideBar.SectionComponentFactory sectionComponentFactory, SideBar.ItemComponentFactory itemComponentFactory) You should not need to create instances of this component directly.

Method Summary

Modifier and Type	Method and Description
void	attach()
void	detach()

Methods inherited from class com.vaadin.ui.Accordion

getState

Methods inherited from class com.vaadin.ui.TabSheet

addBlurListener, addComponent, addFocusListener, addListener, addListener, addListener, addSelectedTabChangeListener, addTab, addTab, addTab, addTab, addTab, areTabsHidden, fireSelectedTabChange, focus, getComponentCount, getCustomAttributes, getSelectedTab, getState, getTab, getTab, getTabIndex, getTabPosition, hideTabs, isRendered, isTabCaptionsAsHtml, iterator, moveComponentsFrom, readDesign, removeBlurListener, removeComponent, removeFocusListener, removeListener, removeListener, removeListener, removeSelectedTabChangeListener, removeTab, replaceComponent, selectedTabIndexAfterTabRemove, setCloseHandler, setSelectedTab, setSelectedTab, setSelectedTab, setTabCaptionsAsHtml, setTabIndex, setTabPosition, writeDesign

Methods inherited from class com.vaadin.ui.AbstractComponentContainer

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

Methods inherited from class com.vaadin.ui.AbstractComponent

addListener, addShortcutListener, addStyleName, beforeClientResponse, findAncestor, fireComponentErrorEvent, fireComponentEvent, getActionManager, getCaption, getComponentError, getData, getDebugId, getDescription, getErrorMessage, getHeight, getHeightUnits, getIcon, getId, getLocale, getParent, getPrimaryStyleName, getStyleName, getWidth, getWidthUnits, isCaptionAsHtml, isConnectorEnabled, isEnabled, isImmediate, isOrHasAncestor, isReadOnly, isVisible, removeListener, removeShortcutListener, removeStyleName, setCaption, setCaptionAsHtml, setComponentError, setData, setDebugId, setDescription, setEnabled, setHeight, setHeightUndefined, setIcon, setId, setImmediate, setLocale, setParent, setPrimaryStyleName, setReadOnly, setSizeFull, setSizeUndefined, 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.Component

addListener, addStyleName, 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, 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

Field Detail

SIDE_BAR_STYLE

public static final String SIDE_BAR_STYLE

See Also:

Constant Field Values

SIDE_BAR_SECTION_ITEM_STYLE

public static final String SIDE_BAR_SECTION_ITEM_STYLE

See Also:

Constant Field Values

SIDE_BAR_SECTION_STYLE

public static final String SIDE_BAR_SECTION_STYLE

See Also:

Constant Field Values

SELECTED_STYLE

public static final String SELECTED_STYLE

See Also:

Constant Field Values

Constructor Detail

SideBar

public SideBar(SideBarUtils sideBarUtils,
               SideBar.SectionComponentFactory sectionComponentFactory,
               SideBar.ItemComponentFactory itemComponentFactory)

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

Method Detail

attach

public void attach()

Specified by:

attach in interface ClientConnector

Specified by:

attach in interface Component

Overrides:

attach in class AbstractComponent

detach

public void detach()

Specified by:

detach in interface ClientConnector

Overrides:

detach in class AbstractComponent