com.communote.server.web.fe.admin

Class BasicMenuEntry

java.lang.Object

com.communote.server.web.fe.admin.BasicMenuEntry

All Implemented Interfaces:

MenuEntry

Direct Known Subclasses:

AdministrationPageMenuEntry

public class BasicMenuEntry
extends Object
implements MenuEntry

Menu entry with ID and a label based on a message key

Author:

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

Constructor Summary

Constructors

Constructor and Description
BasicMenuEntry(String id, String labelMessageKey) Create a menu entry with ID and a label based on a message key

Method Summary

Modifier and Type	Method and Description
String	getId()
String	getLabel()
String	getLabelMessageKey()
String	getLocalizedLabel(Locale locale, Object... arguments) Return the localized label of the menu item.

Methods inherited from class java.lang.Object

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

Constructor Detail

BasicMenuEntry

public BasicMenuEntry(String id,
                      String labelMessageKey)

Create a menu entry with ID and a label based on a message key

Parameters:

id - the ID of the entry

labelMessageKey - the message key of the localizable label

Method Detail

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.

getLabelMessageKey

public String getLabelMessageKey()

Returns:

the message key of the localizable label

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