org.vaadin.spring.sidebar

Class SideBarItemDescriptor.ViewItemDescriptor

java.lang.Object

org.vaadin.spring.sidebar.SideBarItemDescriptor

org.vaadin.spring.sidebar.SideBarItemDescriptor.ViewItemDescriptor

All Implemented Interfaces:

Comparable<SideBarItemDescriptor>

Enclosing class:

SideBarItemDescriptor

public static class SideBarItemDescriptor.ViewItemDescriptor
extends SideBarItemDescriptor

Side bar item descriptor for view items. When invoked, the descriptor will navigate to the view.

Nested Class Summary

Nested classes/interfaces inherited from class org.vaadin.spring.sidebar.SideBarItemDescriptor

SideBarItemDescriptor.ActionItemDescriptor, SideBarItemDescriptor.ViewItemDescriptor

Field Summary

Fields inherited from class org.vaadin.spring.sidebar.SideBarItemDescriptor

ITEM_ID_PREFIX

Constructor Summary

Constructors

Constructor and Description
ViewItemDescriptor(String beanName, ApplicationContext applicationContext) You should never need to create instances of this class directly.

Method Summary

Modifier and Type	Method and Description
String	getViewName() Gets the name of the view to navigate to.
void	itemInvoked(UI ui) This method must be called when the user clicks the item in the UI.

Methods inherited from class org.vaadin.spring.sidebar.SideBarItemDescriptor

compareTo, findAnnotationOnBean, getApplicationContext, getBeanName, getCaption, getIcon, getItemId, getOrder, isMemberOfSection

Methods inherited from class java.lang.Object

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

Constructor Detail

ViewItemDescriptor

public ViewItemDescriptor(String beanName,
                          ApplicationContext applicationContext)

You should never need to create instances of this class directly.

Parameters:

beanName - the name of the bean that implements the view to go to, must not be null.

applicationContext - the application context to use when looking up beans, must not be null.

Method Detail

getViewName

public String getViewName()

Gets the name of the view to navigate to.

Returns:

a string, never null.

itemInvoked

public void itemInvoked(UI ui)

Description copied from class: SideBarItemDescriptor

This method must be called when the user clicks the item in the UI.

Specified by:

itemInvoked in class SideBarItemDescriptor

Parameters:

ui - the UI in which the item was invoked, must not be null.