org.vaadin.spring.sidebar.components

Interface AbstractSideBar.SectionComponentFactory<CR extends ComponentContainer>

All Known Implementing Classes:

AccordionSideBar.DefaultSectionComponentFactory, ValoSideBar.DefaultSectionComponentFactory

Enclosing class:

AbstractSideBar<CR extends ComponentContainer>

public static interface AbstractSideBar.SectionComponentFactory<CR extends ComponentContainer>

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

Method Summary

Modifier and Type	Method and Description
void	createSection(CR compositionRoot, SideBarSectionDescriptor descriptor, Collection<SideBarItemDescriptor> itemDescriptors) Creates and adds the specified section and items to the composition root.
void	setItemComponentFactory(AbstractSideBar.ItemComponentFactory itemComponentFactory) Sets the ItemComponentFactory to use when creating the items of the section.

Method Detail

setItemComponentFactory

void setItemComponentFactory(AbstractSideBar.ItemComponentFactory itemComponentFactory)

Sets the ItemComponentFactory to use when creating the items of the section. This method is always called before the first invocation of createSection(com.vaadin.ui.ComponentContainer, org.vaadin.spring.sidebar.SideBarSectionDescriptor, java.util.Collection).

Parameters:

itemComponentFactory - the item component factory, must not be null.

createSection

void createSection(CR compositionRoot,
                   SideBarSectionDescriptor descriptor,
                   Collection<SideBarItemDescriptor> itemDescriptors)

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

Parameters:

compositionRoot - the component to which the section and items are to be added, must not be null.

descriptor - the descriptor of the side bar section, must not be null.

itemDescriptors - the descriptors of the items to be added to the section, must not be null nor empty.