com.liferay.portal.kernel.servlet.taglib.ui

Interface FormNavigatorEntry<T>

All Known Implementing Classes:

BaseFormNavigatorEntry, BaseJSPFormNavigatorEntry

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.

Author:

Sergio González

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCategoryKey() Returns the category key where the form navigator entry will be included.
java.lang.String	getFormNavigatorId() Returns the form navigator ID where the form navigator entry will be included.
java.lang.String	getKey() Returns the key for the form navigator entry.
java.lang.String	getLabel(java.util.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

getCategoryKey

java.lang.String getCategoryKey()

Returns the category key where the form navigator entry will be included.

Returns:

the category key where the form navigator entry will be included

getFormNavigatorId

java.lang.String getFormNavigatorId()

Returns the form navigator ID where the form navigator entry will be included. This ID must match the ID attribute of the liferay-ui:form-navigator tag, where this form navigator entry is to be included.

Returns:

the form navigator ID where the form navigator entry will be included

getKey

java.lang.String getKey()

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

java.lang.String getLabel(java.util.Locale locale)

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 request,
             javax.servlet.http.HttpServletResponse response)
      throws java.io.IOException

Renders the HTML that needs to be displayed when the form navigator entry is displayed.

Parameters:

request - the request with which the form navigator entry is rendered

response - the response with which the form navigator entry is rendered

Throws:

java.io.IOException - if an IO exception occurs

isVisible

boolean isVisible(User user,
                  T formModelBean)

Returns true if the form navigator entry should be displayed.

Parameters:

user - the user viewing the form navigator entry

formModelBean - the bean edited by the form navigator, or null

Returns:

true if the form navigator entry should be displayed; false otherwise