com.liferay.frontend.taglib.form.navigator

Class BaseFormNavigatorEntry<T>

java.lang.Object

com.liferay.frontend.taglib.form.navigator.BaseFormNavigatorEntry<T>

All Implemented Interfaces:

FormNavigatorEntry<T>

Direct Known Subclasses:

BaseJSPFormNavigatorEntry

public abstract class BaseFormNavigatorEntry<T>
extends java.lang.Object
implements FormNavigatorEntry<T>

Constructor Summary

Constructors

Constructor and Description
BaseFormNavigatorEntry()

Method Summary

Modifier and Type	Method and Description
abstract java.lang.String	getCategoryKey() Returns the category key where the form navigator entry will be included.
abstract java.lang.String	getFormNavigatorId() Returns the form navigator ID where the form navigator entry will be included.
abstract java.lang.String	getKey() Returns the key for the form navigator entry.
abstract 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.
abstract 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(com.liferay.portal.kernel.model.User user, T formModelBean) Returns true if the form navigator entry should be displayed.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BaseFormNavigatorEntry

public BaseFormNavigatorEntry()

Method Detail

getCategoryKey

public abstract java.lang.String getCategoryKey()

Description copied from interface: FormNavigatorEntry

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

Specified by:

getCategoryKey in interface FormNavigatorEntry<T>

Returns:

the category key where the form navigator entry will be included

getFormNavigatorId

public abstract java.lang.String getFormNavigatorId()

Description copied from interface: FormNavigatorEntry

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.

Specified by:

getFormNavigatorId in interface FormNavigatorEntry<T>

Returns:

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

getKey

public abstract java.lang.String getKey()

Description copied from interface: FormNavigatorEntry

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.

Specified by:

getKey in interface FormNavigatorEntry<T>

Returns:

the key of the form navigator entry

getLabel

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

Description copied from interface: FormNavigatorEntry

Returns the label that will be displayed in the user interface when the form navigator entry is included in the form navigator.

Specified by:

getLabel in interface FormNavigatorEntry<T>

Parameters:

locale - the locale that the label should be retrieved for

Returns:

the label of the form navigator entry

include

public abstract void include(javax.servlet.http.HttpServletRequest httpServletRequest,
                             javax.servlet.http.HttpServletResponse httpServletResponse)
                      throws java.io.IOException

Description copied from interface: FormNavigatorEntry

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

Specified by:

include in interface FormNavigatorEntry<T>

Parameters:

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

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

Throws:

java.io.IOException - if an IO exception occurs

isVisible

public boolean isVisible(com.liferay.portal.kernel.model.User user,
                         T formModelBean)

Description copied from interface: FormNavigatorEntry

Returns true if the form navigator entry should be displayed.

Specified by:

isVisible in interface FormNavigatorEntry<T>

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