Interface FormNavigatorEntry<T>
- All Known Implementing Classes:
BaseFormNavigatorEntry
,BaseJSPFormNavigatorEntry
Deprecated.
Provides an interface defining entries that will be used by a specific
liferay-ui:form-navigator
tag instance to render a new section.
Form navigator entries are included within form navigator categories, defined
by FormNavigatorCategory
implementations.
Implementations must be registered in the OSGi Registry. The order of the form navigator entries inside a category is determined by the service ranking.
- Author:
- Sergio González
-
Method Summary
Modifier and TypeMethodDescriptionDeprecated.Returns the category key where the form navigator entry will be included.Deprecated.Returns the form navigator ID where the form navigator entry will be included.getKey()
Deprecated.Returns the key for the form navigator entry.Deprecated.Returns the label that will be displayed in the user interface when the form navigator entry is included in the form navigator.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
Deprecated.Returnstrue
if the form navigator entry should be displayed.
-
Method Details
-
getCategoryKey
String getCategoryKey()Deprecated.Returns the category key where the form navigator entry will be included.- Returns:
- the category key where the form navigator entry will be included
-
getKey
String getKey()Deprecated.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.- Returns:
- the key of the form navigator entry
-
getLabel
Deprecated.Returns the label that will be displayed in the user interface when the form navigator entry is included in the form navigator.- Parameters:
locale
- the locale that the label should be retrieved for- Returns:
- the label of the form navigator entry
-
include
void include(javax.servlet.http.HttpServletRequest httpServletRequest, javax.servlet.http.HttpServletResponse httpServletResponse) throws IOException Deprecated.Renders the HTML that needs to be displayed when the form navigator entry is displayed.- 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
Deprecated.Returnstrue
if the form navigator entry should be displayed.- Parameters:
user
- the user viewing the form navigator entryformModelBean
- the bean edited by the form navigator, ornull
- Returns:
true
if the form navigator entry should be displayed;false
otherwise
-
com.liferay.frontend.taglib.form.navigator.FormNavigatorEntry