org.vaadin.spring.sidebar

Interface SideBar.ItemComponentFactory

All Known Implementing Classes:

SideBar.DefaultItemComponentFactory

Enclosing class:

SideBar

public static interface SideBar.ItemComponentFactory

Interface defining a factory for creating components that correspond to items in a side bar section. When the item is clicked by the user, SideBarItemDescriptor.itemInvoked(com.vaadin.ui.UI) must be called.

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.

Method Summary

Modifier and Type	Method and Description
Component	createItemComponent(SideBarItemDescriptor descriptor) Creates a component to be added to a side bar section by a SideBar.SectionComponentFactory.

Method Detail

createItemComponent

Component createItemComponent(SideBarItemDescriptor descriptor)

Creates a component to be added to a side bar section by a SideBar.SectionComponentFactory. Remember to call SideBarItemDescriptor.itemInvoked(com.vaadin.ui.UI) when the item is clicked by the user.

Parameters:

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

Returns:

a component, never null.