org.vaadin.spring.sidebar.annotation

Annotation Type SideBarSection

@Target(value=TYPE)
 @Retention(value=RUNTIME)
public @interface SideBarSection

This annotation is used to declare a SideBar section that can contain items. It has to be placed on a Spring-managed bean in order to get detected, but the bean can be an empty singleton without methods.

Author:

Petter Holmström (petter@vaadin.com)

See Also:

SideBar, SideBarItem, SideBarSections

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	id The ID of the side bar section.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	caption The caption of this section.
String	captionCode The code to pass to the I18N instance to get the section caption.
int	order The order of this section within the side bar.
Class<? extends UI>[]	ui The UI subclasses that this section is available for.

Element Detail

id

public abstract String id

The ID of the side bar section. Must be unique within the application.

caption

public abstract String caption

The caption of this section.

Default:

""

captionCode

public abstract String captionCode

The code to pass to the I18N instance to get the section caption. If this is an empty string, caption() is used instead.

See Also:

I18N.get(String, Object...)

Default:

""

ui

public abstract Class<? extends UI>[] ui

The UI subclasses that this section is available for. If no classes are specified, the section will be available for all UI subclasses within the application.

Default:

{}

order

public abstract int order

The order of this section within the side bar. Sections with a lower order are placed higher up in the list.

Default:

2147483647