Liferay 7.0-ce-b4

com.liferay.portal.kernel.servlet.taglib.ui
Class BaseFormNavigatorEntry<T>

java.lang.Object
  extended by com.liferay.portal.kernel.servlet.taglib.ui.BaseFormNavigatorEntry<T>
All Implemented Interfaces:
FormNavigatorEntry<T>
Direct Known Subclasses:
BaseJSPFormNavigatorEntry

public abstract class BaseFormNavigatorEntry<T>
extends Object
implements FormNavigatorEntry<T>


Constructor Summary
BaseFormNavigatorEntry()
           
 
Method Summary
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.
 
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 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 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 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 String getLabel(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 request,
                             javax.servlet.http.HttpServletResponse response)
                      throws 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:
request - the request with which the form navigator entry is rendered
response - the response with which the form navigator entry is rendered
Throws:
IOException - if an IO exception occurs

isVisible

public boolean isVisible(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

Liferay 7.0-ce-b4