org.vaadin.spring.sidebar

Class SideBarSectionDescriptor

java.lang.Object

org.vaadin.spring.sidebar.SideBarSectionDescriptor

All Implemented Interfaces:

Comparable<SideBarSectionDescriptor>

public class SideBarSectionDescriptor
extends Object
implements Comparable<SideBarSectionDescriptor>

This is a class that describes a side bar section that has been declared using a SideBarSection annotation.

Author:

Petter Holmström (petter@vaadin.com)

Constructor Summary

Constructors

Constructor and Description
SideBarSectionDescriptor(SideBarSection section, I18N i18n) You should never need to create instances of this class directly.

Method Summary

Modifier and Type	Method and Description
int	compareTo(SideBarSectionDescriptor o)
String	getCaption() Returns the caption of this side bar section.
String	getId() Returns the ID of this side bar section.
int	getOrder() Returns the order of the side bar section within the side bar.
boolean	isAvailableFor(Class<? extends UI> uiClass) Checks if this section is available for the specified UI subclass.

Methods inherited from class java.lang.Object

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

Constructor Detail

SideBarSectionDescriptor

public SideBarSectionDescriptor(SideBarSection section,
                                I18N i18n)

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

Parameters:

section - the annotation, must not be null.

i18n - the I18N instance to use when looking up localized captions, must not be null.

Method Detail

getCaption

public String getCaption()

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

Returns:

a string, never null.

getOrder

public int getOrder()

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

getId

public String getId()

Returns the ID of this side bar section.

Returns:

a string, never null.

isAvailableFor

public boolean isAvailableFor(Class<? extends UI> uiClass)

Checks if this section is available for the specified UI subclass.

Parameters:

uiClass - the UI subclass, must not be null.

Returns:

true if the section is available, false otherwise.

compareTo

public int compareTo(SideBarSectionDescriptor o)

Specified by:

compareTo in interface Comparable<SideBarSectionDescriptor>