org.vaadin.spring.sidebar.components

Class AccordionSideBar

java.lang.Object

com.vaadin.server.AbstractClientConnector

com.vaadin.ui.AbstractComponent

com.vaadin.ui.CustomComponent

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

org.vaadin.spring.sidebar.components.AccordionSideBar

All Implemented Interfaces:

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

@StyleSheet(value="vaadin://addons/sidebar/sidebar.css")
public class AccordionSideBar
extends AbstractSideBar<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.

Author:

Petter Holmström (petter@vaadin.com)

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	AccordionSideBar.DefaultItemComponentFactory Default implementation of AbstractSideBar.ItemComponentFactory that creates NativeButtons.
class	AccordionSideBar.DefaultSectionComponentFactory Default implementation of AbstractSideBar.SectionComponentFactory that creates a Panel with a VerticalLayout that contains the items.

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

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

Method Summary

Modifier and Type	Method and Description
protected Accordion	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<Accordion>	createDefaultSectionComponentFactory() Creates the default AbstractSideBar.SectionComponentFactory to use.

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

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

AccordionSideBar

public AccordionSideBar(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 Accordion 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<Accordion>

createDefaultSectionComponentFactory

protected AbstractSideBar.SectionComponentFactory<Accordion> 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<Accordion>

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<Accordion>