org.vaadin.spring.sidebar

Class SideBarUtils

java.lang.Object

org.vaadin.spring.sidebar.SideBarUtils

public class SideBarUtils
extends Object

Utility methods for working with side bars. This class is a Spring managed bean and is mainly intended for internal use.

Author:

Petter Holmström (petter@vaadin.com)

Constructor Summary

Constructors

Constructor and Description
SideBarUtils(ApplicationContext applicationContext, I18N i18n)

Method Summary

Modifier and Type	Method and Description
Collection<SideBarItemDescriptor>	getSideBarItems(SideBarSectionDescriptor descriptor) Gets all side bar items for the specified side bar section.
Collection<SideBarSectionDescriptor>	getSideBarSections(Class<? extends UI> uiClass) Gets all side bar sections for the specified UI class.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SideBarUtils

public SideBarUtils(ApplicationContext applicationContext,
                    I18N i18n)

Method Detail

getSideBarSections

public Collection<SideBarSectionDescriptor> getSideBarSections(Class<? extends UI> uiClass)

Gets all side bar sections for the specified UI class.

Parameters:

uiClass - the UI class, must not be null.

Returns:

a collection of side bar section descriptors, never null.

See Also:

SideBarSection.ui()

getSideBarItems

public Collection<SideBarItemDescriptor> getSideBarItems(SideBarSectionDescriptor descriptor)

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

Parameters:

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

Returns:

a collection of side bar item descriptors, never null.