Fluent builder for an extra tab, and optionally a summary panel, added to an admin profile or organisation page, reached from controllerMappings.adminProfileTab or controllerMappings.adminOrgTab. Set the tab with tab and tabTemplate, optionally add a summary panel with panel and panelTemplate, then call build to create the mapping and add it to the target page's tab list.
Group: Builders
Methods
tab(String title, String portletId, Object func)
Returns: ProfileTabsBuilder
Sets the tab's title, portlet id and the JS function called to render its content.
| Parameter | Description |
|---|---|
title | the tab's display title |
portletId | id of the portlet section this tab renders into |
func | the JS function that renders the tab's content |
tabTemplate(String templatePath)
Returns: ProfileTabsBuilder
Sets the repository path of the template that renders the tab's content.
| Parameter | Description |
|---|---|
templatePath | the tab template path |
panel(String title, String portletId, Object func)
Returns: ProfileTabsBuilder
Sets the summary panel's title, portlet id and the JS function called to render its content. Adding a panel is optional; if not called, the built mapping has no summary panel.
| Parameter | Description |
|---|---|
title | the summary panel's display title |
portletId | id of the portlet section the summary panel renders into |
func | the JS function that renders the summary panel's content |
panelTemplate(String summaryTemplate)
Returns: ProfileTabsBuilder
Sets the repository path of the template that renders the summary panel's content.
| Parameter | Description |
|---|---|
summaryTemplate | the summary panel template path |
build()
Returns: ProfileTabMapping
Builds the tab mapping from the values set on this builder and adds it to the target page's tab list unless an equal mapping is already present.