org.vaadin.spring.sidebar

Class SideBarItemDescriptor

java.lang.Object

org.vaadin.spring.sidebar.SideBarItemDescriptor

All Implemented Interfaces:

Comparable<SideBarItemDescriptor>

Direct Known Subclasses:

SideBarItemDescriptor.ActionItemDescriptor, SideBarItemDescriptor.ViewItemDescriptor

public abstract class SideBarItemDescriptor
extends Object
implements Comparable<SideBarItemDescriptor>

This is a class that describes a side bar item that has been declared using a SideBarItem annotation.

Author:

Petter Holmström (petter@vaadin.com)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SideBarItemDescriptor.ActionItemDescriptor Side bar item descriptor for action items.
static class	SideBarItemDescriptor.ViewItemDescriptor Side bar item descriptor for view items.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ITEM_ID_PREFIX

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SideBarItemDescriptor(String beanName, ApplicationContext applicationContext)

Method Summary

Modifier and Type	Method and Description
int	compareTo(SideBarItemDescriptor o)
<A extends Annotation> A	findAnnotationOnBean(Class<A> annotationType) Attempts to find and return an annotation of the specified type declared on this side bar item.
protected ApplicationContext	getApplicationContext() TODO Document me
protected String	getBeanName() TODO Document me
String	getCaption() Returns the caption of this side bar item.
Resource	getIcon() Returns the icon of the side bar item.
String	getItemId() Returns the generated item id.
int	getOrder() Returns the order of this side bar item within the section.
boolean	isMemberOfSection(SideBarSectionDescriptor section) Checks if this item is a member of the specified side bar section.
abstract void	itemInvoked(UI ui) This method must be called when the user clicks the item in the UI.

Methods inherited from class java.lang.Object

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

Field Detail

ITEM_ID_PREFIX

public static final String ITEM_ID_PREFIX

See Also:

Constant Field Values

Constructor Detail

SideBarItemDescriptor

protected SideBarItemDescriptor(String beanName,
                                ApplicationContext applicationContext)

Method Detail

findAnnotationOnBean

public <A extends Annotation> A findAnnotationOnBean(Class<A> annotationType)

Attempts to find and return an annotation of the specified type declared on this side bar item.

Parameters:

annotationType - the type of the annotation to look for.

Returns:

the annotation, or null if not found.

getApplicationContext

protected ApplicationContext getApplicationContext()

TODO Document me

Returns:

getBeanName

protected String getBeanName()

TODO Document me

Returns:

getCaption

public String getCaption()

Returns the caption of this side bar item. If the caption was specified using SideBarItem.captionCode(), this method will fetch the string from I18N.

Returns:

a string, never null.

getIcon

public Resource getIcon()

Returns the icon of the side bar item.

Returns:

an icon resource, or null if the item has no icon.

getItemId

public String getItemId()

Returns the generated item id. Can f.e. be used to reference the ItemButton in selenium tests.

Returns:

getOrder

public int getOrder()

Returns the order of this side bar item within the section.

isMemberOfSection

public boolean isMemberOfSection(SideBarSectionDescriptor section)

Checks if this item is a member of the specified side bar section.

Parameters:

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

Returns:

true if the item is a member, false otherwise.

compareTo

public int compareTo(SideBarItemDescriptor o)

Specified by:

compareTo in interface Comparable<SideBarItemDescriptor>

itemInvoked

public abstract void itemInvoked(UI ui)

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

Parameters:

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