Class BaseFormNavigatorEntry<T>

Object
com.liferay.portal.kernel.servlet.taglib.ui.BaseFormNavigatorEntry<T>
All Implemented Interfaces:
FormNavigatorEntry<T>
Direct Known Subclasses:
BaseJSPFormNavigatorEntry

@Deprecated public abstract class BaseFormNavigatorEntry<T> extends Object implements FormNavigatorEntry<T>
Deprecated.
As of Cavanaugh (7.4.x), replaced by com.liferay.frontend.taglib.form.navigator.BaseFormNavigatorEntry
Author:
Sergio González
  • Constructor Summary

    Constructors
    Constructor
    Description
    Deprecated.
     
  • Method Summary

    Modifier and Type
    Method
    Description
    abstract String
    Deprecated.
    Returns the category key where the form navigator entry will be included.
    abstract String
    Deprecated.
    Returns the form navigator ID where the form navigator entry will be included.
    abstract String
    Deprecated.
    Returns the key for the form navigator entry.
    abstract String
    getLabel(Locale locale)
    Deprecated.
    Returns the label that will be displayed in the user interface when the form navigator entry is included in the form navigator.
    abstract void
    include(javax.servlet.http.HttpServletRequest httpServletRequest, javax.servlet.http.HttpServletResponse httpServletResponse)
    Deprecated.
    Renders the HTML that needs to be displayed when the form navigator entry is displayed.
    boolean
    isVisible(User user, T formModelBean)
    Deprecated.
    Returns true if the form navigator entry should be displayed.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  • Constructor Details

    • BaseFormNavigatorEntry

      public BaseFormNavigatorEntry()
      Deprecated.
  • Method Details

    • getCategoryKey

      public abstract String getCategoryKey()
      Deprecated.
      Description copied from interface: FormNavigatorEntry
      Returns the category key where the form navigator entry will be included.
      Specified by:
      getCategoryKey in interface FormNavigatorEntry<T>
      Returns:
      the category key where the form navigator entry will be included
    • getFormNavigatorId

      public abstract String getFormNavigatorId()
      Deprecated.
      Description copied from interface: FormNavigatorEntry
      Returns the form navigator ID where the form navigator entry will be included. This ID must match the ID attribute of the liferay-ui:form-navigator tag, where this form navigator entry is to be included.
      Specified by:
      getFormNavigatorId in interface FormNavigatorEntry<T>
      Returns:
      the form navigator ID where the form navigator entry will be included
    • getKey

      public abstract String getKey()
      Deprecated.
      Description copied from interface: FormNavigatorEntry
      Returns the key for the form navigator entry. This key needs to be unique in the scope of a category key and form navigator ID.
      Specified by:
      getKey in interface FormNavigatorEntry<T>
      Returns:
      the key of the form navigator entry
    • getLabel

      public abstract String getLabel(Locale locale)
      Deprecated.
      Description copied from interface: FormNavigatorEntry
      Returns the label that will be displayed in the user interface when the form navigator entry is included in the form navigator.
      Specified by:
      getLabel in interface FormNavigatorEntry<T>
      Parameters:
      locale - the locale that the label should be retrieved for
      Returns:
      the label of the form navigator entry
    • include

      public abstract void include(javax.servlet.http.HttpServletRequest httpServletRequest, javax.servlet.http.HttpServletResponse httpServletResponse) throws IOException
      Deprecated.
      Description copied from interface: FormNavigatorEntry
      Renders the HTML that needs to be displayed when the form navigator entry is displayed.
      Specified by:
      include in interface FormNavigatorEntry<T>
      Parameters:
      httpServletRequest - the request with which the form navigator entry is rendered
      httpServletResponse - the response with which the form navigator entry is rendered
      Throws:
      IOException - if an IO exception occurs
    • isVisible

      public boolean isVisible(User user, T formModelBean)
      Deprecated.
      Description copied from interface: FormNavigatorEntry
      Returns true if the form navigator entry should be displayed.
      Specified by:
      isVisible in interface FormNavigatorEntry<T>
      Parameters:
      user - the user viewing the form navigator entry
      formModelBean - the bean edited by the form navigator, or null
      Returns:
      true if the form navigator entry should be displayed; false otherwise