org.vaadin.spring.sidebar.components

Class AbstractSideBar<CR extends ComponentContainer>

java.lang.Object

com.vaadin.server.AbstractClientConnector

com.vaadin.ui.AbstractComponent

com.vaadin.ui.CustomComponent

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

All Implemented Interfaces:

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

Direct Known Subclasses:

AccordionSideBar, ValoSideBar

public abstract class AbstractSideBar<CR extends ComponentContainer>
extends CustomComponent

Base class for visual side bar components. The side bar has access to an instance of SideBarUtils that will provide information about the sections and items to show.

Author:

Petter Holmström (petter@vaadin.com)

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AbstractSideBar.ItemComponentFactory Interface defining a factory for creating components that correspond to items in a side bar section.
static interface	AbstractSideBar.ItemFilter Interface defining a filter that can limit which items show up in the side bar.
static interface	AbstractSideBar.SectionComponentFactory<CR extends ComponentContainer> Interface defining a factory for creating components that correspond to sections in a side bar.

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

Modifier	Constructor and Description
protected	AbstractSideBar(SideBarUtils sideBarUtils) Protected constructor.

Method Summary

Modifier and Type	Method and Description
void	attach()
protected abstract CR	createCompositionRoot() Creates the component that actually contain the side bar sections and items.
protected abstract AbstractSideBar.ItemComponentFactory	createDefaultItemComponentFactory() Creates the default AbstractSideBar.ItemComponentFactory to use.
protected abstract AbstractSideBar.SectionComponentFactory<CR>	createDefaultSectionComponentFactory() Creates the default AbstractSideBar.SectionComponentFactory to use.
void	detach()
protected CR	getCompositionRoot()
protected AbstractSideBar.ItemComponentFactory	getItemComponentFactory() Returns the current AbstractSideBar.ItemComponentFactory.
AbstractSideBar.ItemFilter	getItemFilter() Returns the item filter to use or null if not set.
protected AbstractSideBar.SectionComponentFactory<CR>	getSectionComponentFactory() Returns the current AbstractSideBar.SectionComponentFactory.
protected void	setItemComponentFactory(AbstractSideBar.ItemComponentFactory itemComponentFactory) Sets the AbstractSideBar.ItemComponentFactory to use.
void	setItemFilter(AbstractSideBar.ItemFilter itemFilter) Sets an optional filter that is consulted before an item is added to the side bar.
protected void	setSectionComponentFactory(AbstractSideBar.SectionComponentFactory<CR> sectionComponentFactory) Sets the AbstractSideBar.SectionComponentFactory to use.

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

AbstractSideBar

protected AbstractSideBar(SideBarUtils sideBarUtils)

Protected constructor. The instance of SideBarUtils should come from the Spring application context.

Method Detail

createCompositionRoot

protected abstract CR createCompositionRoot()

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.

getCompositionRoot

protected CR getCompositionRoot()

When the side bar is not attached to a UI, this method will always return null.

Overrides:

getCompositionRoot in class CustomComponent

See Also:

createCompositionRoot()

attach

public void attach()

Specified by:

attach in interface ClientConnector

Specified by:

attach in interface Component

Overrides:

attach in class AbstractComponent

createDefaultSectionComponentFactory

protected abstract AbstractSideBar.SectionComponentFactory<CR> createDefaultSectionComponentFactory()

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

getSectionComponentFactory

protected AbstractSideBar.SectionComponentFactory<CR> getSectionComponentFactory()

Returns the current AbstractSideBar.SectionComponentFactory. If no factory has been set, a default factory is created.

See Also:

setSectionComponentFactory(org.vaadin.spring.sidebar.components.AbstractSideBar.SectionComponentFactory), createDefaultSectionComponentFactory()

setSectionComponentFactory

protected void setSectionComponentFactory(AbstractSideBar.SectionComponentFactory<CR> sectionComponentFactory)

Sets the AbstractSideBar.SectionComponentFactory to use.

createDefaultItemComponentFactory

protected abstract AbstractSideBar.ItemComponentFactory createDefaultItemComponentFactory()

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

getItemComponentFactory

protected AbstractSideBar.ItemComponentFactory getItemComponentFactory()

Returns the current AbstractSideBar.ItemComponentFactory. If no factory has been set, a default factory is created.

See Also:

setItemComponentFactory(org.vaadin.spring.sidebar.components.AbstractSideBar.ItemComponentFactory), createDefaultItemComponentFactory()

setItemComponentFactory

protected void setItemComponentFactory(AbstractSideBar.ItemComponentFactory itemComponentFactory)

Sets the AbstractSideBar.ItemComponentFactory to use.

setItemFilter

public void setItemFilter(AbstractSideBar.ItemFilter itemFilter)

Sets an optional filter that is consulted before an item is added to the side bar. If set, only items that pass the filter are added.

getItemFilter

public AbstractSideBar.ItemFilter getItemFilter()

Returns the item filter to use or null if not set.

detach

public void detach()

Specified by:

detach in interface ClientConnector

Overrides:

detach in class AbstractComponent