Liferay 7.0-ce-b4

com.liferay.portal.servlet.taglib.ui
Class DeprecatedFormNavigatorEntry

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

public class DeprecatedFormNavigatorEntry
extends BaseJSPFormNavigatorEntry<Object>


Constructor Summary
DeprecatedFormNavigatorEntry(String key, String label, String categoryKey, String formNavigatorId, String jspPath)
           
 
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.
protected  String getJspPath()
           
 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.
 
Methods inherited from class com.liferay.portal.kernel.servlet.taglib.ui.BaseJSPFormNavigatorEntry
getServletContext, include, setServletContext
 
Methods inherited from class com.liferay.portal.kernel.servlet.taglib.ui.BaseFormNavigatorEntry
isVisible
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.liferay.portal.kernel.servlet.taglib.ui.FormNavigatorEntry
isVisible
 

Constructor Detail

DeprecatedFormNavigatorEntry

public DeprecatedFormNavigatorEntry(String key,
                                    String label,
                                    String categoryKey,
                                    String formNavigatorId,
                                    String jspPath)
Method Detail

getCategoryKey

public 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<Object>
Specified by:
getCategoryKey in class BaseFormNavigatorEntry<Object>
Returns:
the category key where the form navigator entry will be included

getFormNavigatorId

public 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<Object>
Specified by:
getFormNavigatorId in class BaseFormNavigatorEntry<Object>
Returns:
the form navigator ID where the form navigator entry will be included

getKey

public 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<Object>
Specified by:
getKey in class BaseFormNavigatorEntry<Object>
Returns:
the key of the form navigator entry

getLabel

public 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<Object>
Specified by:
getLabel in class BaseFormNavigatorEntry<Object>
Parameters:
locale - the locale that the label should be retrieved for
Returns:
the label of the form navigator entry

getJspPath

protected String getJspPath()
Specified by:
getJspPath in class BaseJSPFormNavigatorEntry<Object>

Liferay 7.0-ce-b4