Interface FormNavigatorCategory


@Deprecated public interface FormNavigatorCategory
Deprecated.
As of Cavanaugh (7.4.x), replaced by com.liferay.frontend.taglib.form.navigator.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.

Author:
Sergio González
  • Method Summary

    Modifier and Type
    Method
    Description
    Deprecated.
    Returns the form navigator ID where the form navigator category will be included.
    Deprecated.
    Returns the key for the form navigator category.
    getLabel(Locale locale)
    Deprecated.
    Defines the label that will be displayed in the user interface when the form navigator category is included in the form navigator.
  • Method Details

    • getFormNavigatorId

      String getFormNavigatorId()
      Deprecated.
      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

      String getKey()
      Deprecated.
      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

      String getLabel(Locale locale)
      Deprecated.
      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