org.vaadin.spring.sidebar

Interface SideBar.SectionComponentFactory

All Known Implementing Classes:

SideBar.DefaultSectionComponentFactory

Enclosing class:

SideBar

public static interface SideBar.SectionComponentFactory

Interface defining a factory for creating components that correspond to sections in a side bar. In practice, a section is a tab of a SideBar.

If you want to use your own factory, make a Spring managed bean that implements this interface. It will automatically be used by the SideBar.

See Also:

TabSheet.addTab(com.vaadin.ui.Component)

Method Summary

Modifier and Type	Method and Description
Component	createSectionComponent(SideBarSectionDescriptor descriptor, Collection<SideBarItemDescriptor> itemDescriptors) Creates a component to be added as a tab to the SideBar.
void	setItemComponentFactory(SideBar.ItemComponentFactory itemComponentFactory) Sets the ItemComponentFactory to use when creating the items of the section.

Method Detail

setItemComponentFactory

void setItemComponentFactory(SideBar.ItemComponentFactory itemComponentFactory)

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

Parameters:

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

createSectionComponent

Component createSectionComponent(SideBarSectionDescriptor descriptor,
                                 Collection<SideBarItemDescriptor> itemDescriptors)

Creates a component to be added as a tab to the SideBar.

Parameters:

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.

Returns:

a component, never null.

See Also:

TabSheet.addTab(com.vaadin.ui.Component)