public abstract class BaseFormNavigatorEntry<T> extends Object implements FormNavigatorEntry<T>
| Constructor and Description |
|---|
BaseFormNavigatorEntry() |
| Modifier and Type | Method and Description |
|---|---|
abstract String |
getCategoryKey()
Returns the category key where the form navigator entry will be included.
|
abstract String |
getFormNavigatorId()
Returns the form navigator ID where the form navigator entry will be
included.
|
abstract String |
getKey()
Returns the key for the form navigator entry.
|
abstract 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.
|
abstract void |
include(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
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. |
public abstract String getCategoryKey()
FormNavigatorEntrygetCategoryKey in interface FormNavigatorEntry<T>public abstract String getFormNavigatorId()
FormNavigatorEntryliferay-ui:form-navigator tag, where this form navigator
entry is to be included.getFormNavigatorId in interface FormNavigatorEntry<T>public abstract String getKey()
FormNavigatorEntrygetKey in interface FormNavigatorEntry<T>public abstract String getLabel(Locale locale)
FormNavigatorEntrygetLabel in interface FormNavigatorEntry<T>locale - the locale that the label should be retrieved forpublic abstract void include(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
throws IOException
FormNavigatorEntryinclude in interface FormNavigatorEntry<T>request - the request with which the form navigator entry is
renderedresponse - the response with which the form navigator entry is
renderedIOException - if an IO exception occurspublic boolean isVisible(User user, T formModelBean)
FormNavigatorEntrytrue if the form navigator entry should be
displayed.isVisible in interface FormNavigatorEntry<T>user - the user viewing the form navigator entryformModelBean - the bean edited by the form navigator, or
nulltrue if the form navigator entry should be
displayed; false otherwise