|
Liferay 7.0-ce-b4 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
public interface FormNavigatorEntry<T>
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.
| Method Summary | |
|---|---|
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 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. |
| Method Detail |
|---|
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 for
void include(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
throws IOException
request - the request with which the form navigator entry is
renderedresponse - the response with which the form navigator entry is
rendered
IOException - if an IO exception occurs
boolean 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
|
Liferay 7.0-ce-b4 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||