org.vaadin.spring.sidebar.annotation

Annotation Type SideBarItem

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

This annotation is used to declare a SideBar item that a user can click on. It can be placed on two types of beans:

1. Runnables - when the item is clicked, the runnable is executed
2. Viewss that are also annotated with VaadinView - when the item is clicked, the navigator navigates to the view.

Please note that the annotated class must be a Spring-managed bean - only adding this annotation is not enough.

Author:

Petter Holmström (petter@vaadin.com)

See Also:

SideBar, SideBarSection, FontAwesomeIcon, ThemeIcon, LocalizedThemeIcon

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	sectionId The ID of the side bar section that this item belongs to.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	caption The caption of this item.
String	captionCode The code to pass to the I18N instance to get the item caption.
int	order The order of this item within its section.

Element Detail

sectionId

public abstract String sectionId

The ID of the side bar section that this item belongs to.

See Also:

SideBarSection.id()

caption

public abstract String caption

The caption of this item.

See Also:

captionCode()

Default:

""

captionCode

public abstract String captionCode

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

See Also:

I18N.get(String, Object...)

Default:

""

order

public abstract int order

The order of this item within its section. Items with a lower order are placed higher up in the list.

Default:

2147483647