A C D E F G I L O P S T V

A

AbstractSideBar<CR extends ComponentContainer> - Class in org.vaadin.spring.sidebar.components

Base class for visual side bar components.

AbstractSideBar(SideBarUtils) - Constructor for class org.vaadin.spring.sidebar.components.AbstractSideBar

Protected constructor.

AbstractSideBar.ItemComponentFactory - Interface in org.vaadin.spring.sidebar.components

Interface defining a factory for creating components that correspond to items in a side bar section.

AbstractSideBar.ItemFilter - Interface in org.vaadin.spring.sidebar.components

Interface defining a filter that can limit which items show up in the side bar.

AbstractSideBar.SectionComponentFactory<CR extends ComponentContainer> - Interface in org.vaadin.spring.sidebar.components

Interface defining a factory for creating components that correspond to sections in a side bar.

AccordionSideBar - Class in org.vaadin.spring.sidebar.components

This is a side bar component that can be used as a main menu in applications.

AccordionSideBar(SideBarUtils) - Constructor for class org.vaadin.spring.sidebar.components.AccordionSideBar

You should not need to create instances of this component directly.

AccordionSideBar.DefaultItemComponentFactory - Class in org.vaadin.spring.sidebar.components

Default implementation of AbstractSideBar.ItemComponentFactory that creates NativeButtons.

AccordionSideBar.DefaultSectionComponentFactory - Class in org.vaadin.spring.sidebar.components

Default implementation of AbstractSideBar.SectionComponentFactory that creates a Panel with a VerticalLayout that contains the items.

ActionItemDescriptor(String, ApplicationContext) - Constructor for class org.vaadin.spring.sidebar.SideBarItemDescriptor.ActionItemDescriptor

You should never need to create instances of this class directly.

attach() - Method in class org.vaadin.spring.sidebar.components.AbstractSideBar

C

compareTo(SideBarItemDescriptor) - Method in class org.vaadin.spring.sidebar.SideBarItemDescriptor

compareTo(SideBarSectionDescriptor) - Method in class org.vaadin.spring.sidebar.SideBarSectionDescriptor

createCompositionRoot() - Method in class org.vaadin.spring.sidebar.components.AbstractSideBar

Creates the component that actually contain the side bar sections and items.

createCompositionRoot() - Method in class org.vaadin.spring.sidebar.components.AccordionSideBar

createCompositionRoot() - Method in class org.vaadin.spring.sidebar.components.ValoSideBar

createDefaultItemComponentFactory() - Method in class org.vaadin.spring.sidebar.components.AbstractSideBar

Creates the default AbstractSideBar.ItemComponentFactory to use.

createDefaultItemComponentFactory() - Method in class org.vaadin.spring.sidebar.components.AccordionSideBar

createDefaultItemComponentFactory() - Method in class org.vaadin.spring.sidebar.components.ValoSideBar

createDefaultSectionComponentFactory() - Method in class org.vaadin.spring.sidebar.components.AbstractSideBar

Creates the default AbstractSideBar.SectionComponentFactory to use.

createDefaultSectionComponentFactory() - Method in class org.vaadin.spring.sidebar.components.AccordionSideBar

createDefaultSectionComponentFactory() - Method in class org.vaadin.spring.sidebar.components.ValoSideBar

createItemComponent(SideBarItemDescriptor) - Method in interface org.vaadin.spring.sidebar.components.AbstractSideBar.ItemComponentFactory

Creates a component to be added to a side bar section by a AccordionSideBar.SectionComponentFactory.

createItemComponent(SideBarItemDescriptor) - Method in class org.vaadin.spring.sidebar.components.AccordionSideBar.DefaultItemComponentFactory

createItemComponent(SideBarItemDescriptor) - Method in class org.vaadin.spring.sidebar.components.ValoSideBar.DefaultItemComponentFactory

createSection(CR, SideBarSectionDescriptor, Collection<SideBarItemDescriptor>) - Method in interface org.vaadin.spring.sidebar.components.AbstractSideBar.SectionComponentFactory

Creates and adds the specified section and items to the composition root.

createSection(Accordion, SideBarSectionDescriptor, Collection<SideBarItemDescriptor>) - Method in class org.vaadin.spring.sidebar.components.AccordionSideBar.DefaultSectionComponentFactory

createSection(CssLayout, SideBarSectionDescriptor, Collection<SideBarItemDescriptor>) - Method in class org.vaadin.spring.sidebar.components.ValoSideBar.DefaultSectionComponentFactory

D

DefaultItemComponentFactory() - Constructor for class org.vaadin.spring.sidebar.components.AccordionSideBar.DefaultItemComponentFactory

DefaultItemComponentFactory() - Constructor for class org.vaadin.spring.sidebar.components.ValoSideBar.DefaultItemComponentFactory

DefaultSectionComponentFactory() - Constructor for class org.vaadin.spring.sidebar.components.AccordionSideBar.DefaultSectionComponentFactory

DefaultSectionComponentFactory() - Constructor for class org.vaadin.spring.sidebar.components.ValoSideBar.DefaultSectionComponentFactory

detach() - Method in class org.vaadin.spring.sidebar.components.AbstractSideBar

E

EnableSideBar - Annotation Type in org.vaadin.spring.sidebar.annotation

Add this annotation to your application configuration to enable the AccordionSideBar component.

F

findAnnotationOnBean(Class<A>) - Method in class org.vaadin.spring.sidebar.SideBarItemDescriptor

Attempts to find and return an annotation of the specified type declared on this side bar item.

FontAwesomeIcon - Annotation Type in org.vaadin.spring.sidebar.annotation

This annotation is placed next to SideBarItem, instructing the side bar to use a FontAwesome icon for the item.

FontAwesomeIconProvider - Class in org.vaadin.spring.sidebar

Icon provider for FontAwesomeIcon.

FontAwesomeIconProvider() - Constructor for class org.vaadin.spring.sidebar.FontAwesomeIconProvider

G

getApplicationContext() - Method in class org.vaadin.spring.sidebar.SideBarItemDescriptor

TODO Document me

getBeanName() - Method in class org.vaadin.spring.sidebar.SideBarItemDescriptor

TODO Document me

getCaption() - Method in class org.vaadin.spring.sidebar.SideBarItemDescriptor

Returns the caption of this side bar item.

getCaption() - Method in class org.vaadin.spring.sidebar.SideBarSectionDescriptor

Returns the caption of this side bar section.

getCompositionRoot() - Method in class org.vaadin.spring.sidebar.components.AbstractSideBar

getHeader() - Method in class org.vaadin.spring.sidebar.components.ValoSideBar

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

getIcon(FontAwesomeIcon) - Method in class org.vaadin.spring.sidebar.FontAwesomeIconProvider

getIcon(LocalizedThemeIcon) - Method in class org.vaadin.spring.sidebar.LocalizedThemeIconProvider

getIcon() - Method in class org.vaadin.spring.sidebar.SideBarItemDescriptor

Returns the icon of the side bar item.

getIcon(A) - Method in interface org.vaadin.spring.sidebar.SideBarItemIconProvider

Returns the icon resource that the specified annotation refers to, or null if not found.

getIcon(ThemeIcon) - Method in class org.vaadin.spring.sidebar.ThemeIconProvider

getIcon(VaadinFontIcon) - Method in class org.vaadin.spring.sidebar.VaadinFontIconProvider

getId() - Method in class org.vaadin.spring.sidebar.SideBarSectionDescriptor

Returns the ID of this side bar section.

getItemComponentFactory() - Method in class org.vaadin.spring.sidebar.components.AbstractSideBar

Returns the current AbstractSideBar.ItemComponentFactory.

getItemFilter() - Method in class org.vaadin.spring.sidebar.components.AbstractSideBar

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

getItemId() - Method in class org.vaadin.spring.sidebar.SideBarItemDescriptor

Returns the generated item id.

getLogo() - Method in class org.vaadin.spring.sidebar.components.ValoSideBar

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

getOrder() - Method in class org.vaadin.spring.sidebar.SideBarItemDescriptor

Returns the order of this side bar item within the section.

getOrder() - Method in class org.vaadin.spring.sidebar.SideBarSectionDescriptor

Returns the order of the side bar section within the side bar.

getSectionComponentFactory() - Method in class org.vaadin.spring.sidebar.components.AbstractSideBar

Returns the current AbstractSideBar.SectionComponentFactory.

getSideBarItems(SideBarSectionDescriptor) - Method in class org.vaadin.spring.sidebar.SideBarUtils

Gets all side bar items for the specified side bar section.

getSideBarSections(Class<? extends UI>) - Method in class org.vaadin.spring.sidebar.SideBarUtils

Gets all side bar sections for the specified UI class.

getViewName() - Method in class org.vaadin.spring.sidebar.SideBarItemDescriptor.ViewItemDescriptor

Gets the name of the view to navigate to.

I

isAvailableFor(Class<? extends UI>) - Method in class org.vaadin.spring.sidebar.SideBarSectionDescriptor

Checks if this section is available for the specified UI subclass.

isLargeIcons() - Method in class org.vaadin.spring.sidebar.components.ValoSideBar

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

isMemberOfSection(SideBarSectionDescriptor) - Method in class org.vaadin.spring.sidebar.SideBarItemDescriptor

Checks if this item is a member of the specified side bar section.

ITEM_ID_PREFIX - Static variable in class org.vaadin.spring.sidebar.SideBarItemDescriptor

itemInvoked(UI) - Method in class org.vaadin.spring.sidebar.SideBarItemDescriptor.ActionItemDescriptor

itemInvoked(UI) - Method in class org.vaadin.spring.sidebar.SideBarItemDescriptor

This method must be called when the user clicks the item in the UI.

itemInvoked(UI) - Method in class org.vaadin.spring.sidebar.SideBarItemDescriptor.ViewItemDescriptor

L

LocalizedThemeIcon - Annotation Type in org.vaadin.spring.sidebar.annotation

This annotation is placed next to SideBarItem, instructing the side bar to use a ThemeResource icon for the item, but to look up the actual resource ID from an I18N.

LocalizedThemeIconProvider - Class in org.vaadin.spring.sidebar

Icon provider for LocalizedThemeIcon.

LocalizedThemeIconProvider(I18N) - Constructor for class org.vaadin.spring.sidebar.LocalizedThemeIconProvider

O

org.vaadin.spring.sidebar - package org.vaadin.spring.sidebar

org.vaadin.spring.sidebar.annotation - package org.vaadin.spring.sidebar.annotation

org.vaadin.spring.sidebar.components - package org.vaadin.spring.sidebar.components

org.vaadin.spring.sidebar.config - package org.vaadin.spring.sidebar.config

org.vaadin.spring.sidebar.security - package org.vaadin.spring.sidebar.security

P

passesFilter(SideBarItemDescriptor) - Method in interface org.vaadin.spring.sidebar.components.AbstractSideBar.ItemFilter

Checks if the specified side bar item passes the filter or not.

passesFilter(SideBarItemDescriptor) - Method in class org.vaadin.spring.sidebar.security.VaadinSecurityItemFilter

S

SELECTED_STYLE - Static variable in class org.vaadin.spring.sidebar.components.AccordionSideBar

setHeader(Layout) - Method in class org.vaadin.spring.sidebar.components.ValoSideBar

Adds a header to the top of the side bar, below the logo.

setItemComponentFactory(AbstractSideBar.ItemComponentFactory) - Method in interface org.vaadin.spring.sidebar.components.AbstractSideBar.SectionComponentFactory

Sets the ItemComponentFactory to use when creating the items of the section.

setItemComponentFactory(AbstractSideBar.ItemComponentFactory) - Method in class org.vaadin.spring.sidebar.components.AbstractSideBar

Sets the AbstractSideBar.ItemComponentFactory to use.

setItemComponentFactory(AbstractSideBar.ItemComponentFactory) - Method in class org.vaadin.spring.sidebar.components.AccordionSideBar.DefaultSectionComponentFactory

setItemComponentFactory(AbstractSideBar.ItemComponentFactory) - Method in class org.vaadin.spring.sidebar.components.ValoSideBar.DefaultSectionComponentFactory

setItemFilter(AbstractSideBar.ItemFilter) - Method in class org.vaadin.spring.sidebar.components.AbstractSideBar

Sets an optional filter that is consulted before an item is added to the side bar.

setLargeIcons(boolean) - Method in class org.vaadin.spring.sidebar.components.ValoSideBar

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

setLogo(Component) - Method in class org.vaadin.spring.sidebar.components.ValoSideBar

Adds a logo to the very top of the side bar, above the header.

setSectionComponentFactory(AbstractSideBar.SectionComponentFactory<CR>) - Method in class org.vaadin.spring.sidebar.components.AbstractSideBar

Sets the AbstractSideBar.SectionComponentFactory to use.

SIDE_BAR_SECTION_ITEM_STYLE - Static variable in class org.vaadin.spring.sidebar.components.AccordionSideBar

SIDE_BAR_SECTION_STYLE - Static variable in class org.vaadin.spring.sidebar.components.AccordionSideBar

SIDE_BAR_STYLE - Static variable in class org.vaadin.spring.sidebar.components.AccordionSideBar

SideBarConfiguration - Class in org.vaadin.spring.sidebar.config

Spring configuration for the AccordionSideBar and its dependencies.

SideBarConfiguration() - Constructor for class org.vaadin.spring.sidebar.config.SideBarConfiguration

SideBarItem - Annotation Type in org.vaadin.spring.sidebar.annotation

This annotation is used to declare a AccordionSideBar item that a user can click on.

SideBarItemDescriptor - Class in org.vaadin.spring.sidebar

This is a class that describes a side bar item that has been declared using a SideBarItem annotation.

SideBarItemDescriptor(String, ApplicationContext) - Constructor for class org.vaadin.spring.sidebar.SideBarItemDescriptor

SideBarItemDescriptor.ActionItemDescriptor - Class in org.vaadin.spring.sidebar

Side bar item descriptor for action items.

SideBarItemDescriptor.ViewItemDescriptor - Class in org.vaadin.spring.sidebar

Side bar item descriptor for view items.

SideBarItemIcon - Annotation Type in org.vaadin.spring.sidebar.annotation

Meta annotation designed to be placed on icon annotations that are used to specify an icon of a SideBarItem.

SideBarItemIconProvider<A extends Annotation> - Interface in org.vaadin.spring.sidebar

Interface defining a provider that maps a side bar item icon annotation to an actual Resource.

SideBarSection - Annotation Type in org.vaadin.spring.sidebar.annotation

This annotation is used to declare a AccordionSideBar section that can contain items.

SideBarSectionDescriptor - Class in org.vaadin.spring.sidebar

This is a class that describes a side bar section that has been declared using a SideBarSection annotation.

SideBarSectionDescriptor(SideBarSection, I18N) - Constructor for class org.vaadin.spring.sidebar.SideBarSectionDescriptor

You should never need to create instances of this class directly.

SideBarSections - Annotation Type in org.vaadin.spring.sidebar.annotation

This annotation is used to declare multiple SideBarSections on the same bean.

SideBarUtils - Class in org.vaadin.spring.sidebar

Utility methods for working with side bars.

SideBarUtils(ApplicationContext, I18N) - Constructor for class org.vaadin.spring.sidebar.SideBarUtils

T

ThemeIcon - Annotation Type in org.vaadin.spring.sidebar.annotation

This annotation is placed next to SideBarItem, instructing the side bar to use a ThemeResource icon for the item.

ThemeIconProvider - Class in org.vaadin.spring.sidebar

Icon provider for ThemeIcon.

ThemeIconProvider() - Constructor for class org.vaadin.spring.sidebar.ThemeIconProvider

V

VaadinFontIcon - Annotation Type in org.vaadin.spring.sidebar.annotation

This annotation is placed next to SideBarItem, instructing the side bar to use a Vaadin Font Icon for the item.

VaadinFontIconProvider - Class in org.vaadin.spring.sidebar

Icon provider for VaadinFontIcon.

VaadinFontIconProvider() - Constructor for class org.vaadin.spring.sidebar.VaadinFontIconProvider

VaadinSecurityItemFilter - Class in org.vaadin.spring.sidebar.security

This is an ItemFilter that uses VaadinSecurity to filter out items with the Secured annotation based on the current user's authorities.

VaadinSecurityItemFilter(VaadinSecurity) - Constructor for class org.vaadin.spring.sidebar.security.VaadinSecurityItemFilter

Creates a new instance of VaadinSecurityItemFilter.

ValoSideBar - Class in org.vaadin.spring.sidebar.components

This is a side bar component that has been especially designed to be used with the Valo theme.

ValoSideBar(SideBarUtils) - Constructor for class org.vaadin.spring.sidebar.components.ValoSideBar

You should not need to create instances of this component directly.

ValoSideBar.DefaultItemComponentFactory - Class in org.vaadin.spring.sidebar.components

Default implementation of ValoSideBar.ItemComponentFactory that creates Buttons.

ValoSideBar.DefaultSectionComponentFactory - Class in org.vaadin.spring.sidebar.components

Default implementation of ValoSideBar.SectionComponentFactory that adds the section header and items directly to the composition root.

ViewItemDescriptor(String, ApplicationContext) - Constructor for class org.vaadin.spring.sidebar.SideBarItemDescriptor.ViewItemDescriptor

You should never need to create instances of this class directly.

A C D E F G I L O P S T V