com.communote.common.menu

Interface MenuEntry

All Known Subinterfaces:

MenuItem<T>

All Known Implementing Classes:

AdministrationPageMenuEntry, BasicMenuEntry, CategoryEntry

public interface MenuEntry

A generic entry of a menu.

Author:

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

Method Summary

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

Method Detail

getId

String getId()

Returns:

a unique ID of the item within the menu

getLabel

String getLabel()

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

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

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

Parameters:

locale - the locale to use

arguments - any arguments to pass to the i18n function

Returns:

the localized label