com.communote.common.menu

Class CategoryEntry<C extends MenuEntry,S extends MenuEntry>

java.lang.Object

com.communote.common.menu.CategoryEntry<C,S>

Type Parameters:

C - the type of the category details

S - the type of the sub-items

All Implemented Interfaces:

MenuEntry, MenuItem<S>

public class CategoryEntry<C extends MenuEntry,S extends MenuEntry>
extends Object
implements MenuItem<S>

Generic category menu entry which can have sub-items and arbitrary details describing the category.

Author:

Communote GmbH - http://www.communote.com/

Constructor Summary

Constructors

Constructor and Description
CategoryEntry(C categoryDetails) Create a new category entry with an empty collection of children

Method Summary

Modifier and Type	Method and Description
C	getCategoryDetails()
List<S>	getChildren()
String	getId()
String	getLabel()
String	getLocalizedLabel(Locale locale, Object... arguments) Return the localized label of the menu item.
boolean	hasChildren()
void	setChildren(List<S> children) set the children of this menu item

Methods inherited from class java.lang.Object

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

Constructor Detail

CategoryEntry

public CategoryEntry(C categoryDetails)

Create a new category entry with an empty collection of children

Parameters:

categoryDetails - the details describing the category

Method Detail

getCategoryDetails

public C getCategoryDetails()

Returns:

the details describing this category

getChildren

public List<S> getChildren()

Specified by:

getChildren in interface MenuItem<S extends MenuEntry>

Returns:

the sub-items of the menu item or null if MenuItem.hasChildren() returns false

getId

public String getId()

Specified by:

getId in interface MenuEntry

Returns:

a unique ID of the item within the menu

getLabel

public String getLabel()

Specified by:

getLabel in interface MenuEntry

Returns:

the label of a menu item. Implementors can decide what to return here, this could for instance be a static string, a localized string in a default language or maybe null if unlocalized strings are not supported.

getLocalizedLabel

public String getLocalizedLabel(Locale locale,
                                Object... arguments)

Description copied from interface: MenuEntry

Return the localized label of the menu item. The return value should be the same as that of MenuEntry.getLabel() if localization is not supported.

Specified by:

getLocalizedLabel in interface MenuEntry

Parameters:

locale - the locale to use

arguments - any arguments to pass to the i18n function

Returns:

the localized label

hasChildren

public boolean hasChildren()

Specified by:

hasChildren in interface MenuItem<S extends MenuEntry>

Returns:

whether the menu item contains other (sub-) menu items

setChildren

public void setChildren(List<S> children)

Description copied from interface: MenuItem

set the children of this menu item

Specified by:

setChildren in interface MenuItem<S extends MenuEntry>

Parameters:

children - the sub-items to set