com.liferay.frontend.taglib.form.navigator

Interface FormNavigatorCategory

public interface FormNavigatorCategory

Provides an interface defining categories that will be used by a specific liferay-ui:form-navigator tag instance to render a new category. Form navigator categories includes form navigator entries, defined by FormNavigatorEntry implementations.

Implementations must be registered in the OSGi Registry. The order of the form navigator categories is determined by the service ranking.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getFormNavigatorId() Returns the form navigator ID where the form navigator category will be included.
java.lang.String	getKey() Returns the key for the form navigator category.
java.lang.String	getLabel(java.util.Locale locale) Defines the label that will be displayed in the user interface when the form navigator category is included in the form navigator.

Method Detail

getFormNavigatorId

java.lang.String getFormNavigatorId()

Returns the form navigator ID where the form navigator category will be included. This ID must match the ID attribute of the liferay-ui:form-navigator tag where this form navigator category is to be included.

Returns:

the form navigator ID where the form navigator category will be included

getKey

java.lang.String getKey()

Returns the key for the form navigator category. This key needs to be unique in the scope of a form navigator ID.

This key will be referred by the form navigator entries to be added to this form navigator category.

Returns:

the key of the form navigator category

getLabel

java.lang.String getLabel(java.util.Locale locale)

Defines the label that will be displayed in the user interface when the form navigator category is included in the form navigator.

Parameters:

locale - the locale that the label should be retrieved for

Returns:

the label of the form navigator category