com.liferay.portal.kernel.servlet.taglib.ui
Interface FormNavigatorEntry<T>
- All Known Implementing Classes:
- BaseCompanySettingsFormNavigatorEntry, BaseFormNavigatorEntry, BaseJSPFormNavigatorEntry, BaseOrganizationFormNavigatorEntry, BaseUserFormNavigatorEntry, CompanySettingsAdditionalEmailAddressesFormNavigatorEntry, CompanySettingsAddressesFormNavigatorEntry, CompanySettingsAnalyticsFormNavigatorEntry, CompanySettingsAuthenticationFormNavigatorEntry, CompanySettingsContentSharingFormNavigatorEntry, CompanySettingsDisplaySettingsFormNavigatorEntry, CompanySettingsEmailNotificationsFormNavigatorEntry, CompanySettingsGeneralFormNavigatorEntry, CompanySettingsInteractionsFormNavigatorEntry, CompanySettingsMailHostNamesFormNavigatorEntry, CompanySettingsMapsFormNavigatorEntry, CompanySettingsPhoneNumbersFormNavigatorEntry, CompanySettingsRatingsFormNavigatorEntry, CompanySettingsRecycleBinFormNavigatorEntry, CompanySettingsTermsOfUseFormNavigatorEntry, CompanySettingsUsersFormNavigatorEntry, CompanySettingsWebsitesFormNavigatorEntry, DeprecatedFormNavigatorEntry, OrganizationAdditionalEmailAddressesFormNavigatorEntry, OrganizationAddressesFormNavigatorEntry, OrganizationCategorizationFormNavigatorEntry, OrganizationCommentsFormNavigatorEntry, OrganizationCustomFieldsFormNavigatorEntry, OrganizationDetailsFormNavigatorEntry, OrganizationOrganizationSiteFormNavigatorEntry, OrganizationPhoneNumbersFormNavigatorEntry, OrganizationReminderQueriesFormNavigatorEntry, OrganizationServicesFormNavigatorEntry, OrganizationWebsitesFormNavigatorEntry, UserAdditionalEmailAddressesFormNavigatorEntry, UserAddressesFormNavigatorEntry, UserAnnouncementsFormNavigatorEntry, UserCategorizationFormNavigatorEntry, UserCommentsFormNavigatorEntry, UserCustomFieldsFormNavigatorEntry, UserDetailsFormNavigatorEntry, UserDisplaySettingsFormNavigatorEntry, UserInstantMessengerFormNavigatorEntry, UserOpenIdFormNavigatorEntry, UserOrganizationsFormNavigatorEntry, UserPasswordFormNavigatorEntry, UserPersonalSiteFormNavigatorEntry, UserPhoneNumbersFormNavigatorEntry, UserRolesFormNavigatorEntry, UserSitesFormNavigatorEntry, UserSmsFormNavigatorEntry, UserSocialNetworkFormNavigatorEntry, UserUserGroupsFormNavigatorEntry, UserWebsitesFormNavigatorEntry
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. |
getCategoryKey
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
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
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
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.
- 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 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
renderedresponse - the response with which the form navigator entry is
rendered
- Throws:
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 entryformModelBean - the bean edited by the form navigator, or
null
- Returns:
true if the form navigator entry should be
displayed; false otherwise