public interface FormNavigatorEntry<T>
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.
Modifier and Type | Method and Description |
---|---|
String |
getCategoryKey()
Returns the category key where the form navigator entry will be included.
|
String |
getFormNavigatorId()
Returns the form navigator ID where the form navigator entry will be
included.
|
String |
getKey()
Returns the key for the form navigator entry.
|
String |
getLabel(Locale locale)
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)
Renders the HTML that needs to be displayed when the form navigator entry
is displayed.
|
boolean |
isVisible(User user,
T formModelBean)
Returns
true if the form navigator entry should be
displayed. |
String getCategoryKey()
String getFormNavigatorId()
liferay-ui:form-navigator
tag, where this form navigator
entry is to be included.String getKey()
String getLabel(Locale locale)
locale
- the locale that the label should be retrieved forvoid include(javax.servlet.http.HttpServletRequest httpServletRequest, javax.servlet.http.HttpServletResponse httpServletResponse) throws IOException
httpServletRequest
- the request with which the form navigator
entry is renderedhttpServletResponse
- the response with which the form navigator
entry is renderedIOException
- if an IO exception occursboolean isVisible(User user, T formModelBean)
true
if the form navigator entry should be
displayed.user
- the user viewing the form navigator entryformModelBean
- the bean edited by the form navigator, or
null
true
if the form navigator entry should be
displayed; false
otherwise