Class BaseFormNavigatorEntry<T>
java.lang.Object
com.liferay.frontend.taglib.form.navigator.BaseFormNavigatorEntry<T>
- All Implemented Interfaces:
FormNavigatorEntry<T>
- Direct Known Subclasses:
BaseJSPFormNavigatorEntry
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionabstract StringReturns the category key where the form navigator entry will be included.abstract StringReturns the form navigator ID where the form navigator entry will be included.abstract StringgetKey()Returns the key for the form navigator entry.abstract StringReturns the label that will be displayed in the user interface when the form navigator entry is included in the form navigator.abstract jakarta.servlet.ServletContextabstract voidinclude(jakarta.servlet.http.HttpServletRequest httpServletRequest, jakarta.servlet.http.HttpServletResponse httpServletResponse) Renders the HTML that needs to be displayed when the form navigator entry is displayed.booleanReturnstrueif the form navigator entry should be displayed.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface com.liferay.frontend.taglib.form.navigator.FormNavigatorEntry
isDeprecated
-
Constructor Details
-
BaseFormNavigatorEntry
public BaseFormNavigatorEntry()
-
-
Method Details
-
getCategoryKey
Description copied from interface:FormNavigatorEntryReturns the category key where the form navigator entry will be included.- Specified by:
getCategoryKeyin interfaceFormNavigatorEntry<T>- Returns:
- the category key where the form navigator entry will be included
-
getKey
Description copied from interface:FormNavigatorEntryReturns 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:
getKeyin interfaceFormNavigatorEntry<T>- Returns:
- the key of the form navigator entry
-
getLabel
Description copied from interface:FormNavigatorEntryReturns the label that will be displayed in the user interface when the form navigator entry is included in the form navigator.- Specified by:
getLabelin interfaceFormNavigatorEntry<T>- Parameters:
locale- the locale that the label should be retrieved for- Returns:
- the label of the form navigator entry
-
getServletContext
public abstract jakarta.servlet.ServletContext getServletContext() -
include
public abstract void include(jakarta.servlet.http.HttpServletRequest httpServletRequest, jakarta.servlet.http.HttpServletResponse httpServletResponse) throws IOException Description copied from interface:FormNavigatorEntryRenders the HTML that needs to be displayed when the form navigator entry is displayed.- Specified by:
includein interfaceFormNavigatorEntry<T>- Parameters:
httpServletRequest- the request with which the form navigator entry is renderedhttpServletResponse- the response with which the form navigator entry is rendered- Throws:
IOException- if an IO exception occurs
-
isVisible
Description copied from interface:FormNavigatorEntryReturnstrueif the form navigator entry should be displayed.- Specified by:
isVisiblein interfaceFormNavigatorEntry<T>- Parameters:
user- the user viewing the form navigator entryformModelBean- the bean edited by the form navigator, ornull- Returns:
trueif the form navigator entry should be displayed;falseotherwise
-