A summary card shown on the manage-profile (or manage-org) admin page, giving an at-a-glance view of something the owning app tracks for that profile or organisation, such as a points balance or an enrolment count. Either rendered via a named portlet, or as a simple icon plus main/sub text pair, and optionally linked to a ProfileTab so the user can click through for more detail.
Implements: Serializable
Properties
| Property | Returns | Description |
|---|---|---|
| icon | String | The icon shown for this panel, when it uses the icon/text rendering rather than a portlet. |
| mainText | String | The main text (typically a value, such as a count or balance) shown for this panel, when it uses the icon/text rendering rather than a portlet. |
| portletId | String | The name of the portlet used to render this panel's body, when this panel renders via a portlet rather than an icon/text pair. |
| profileTab | ProfileTab | The profile tab this panel links to, so a user can click through to more detail. May be null if the panel is not linked to a tab. |
| subText | String | The secondary text (typically a label describing the main text) shown for this panel, when it uses the icon/text rendering rather than a portlet. |
| title | String | The title displayed at the top of this panel. |
Methods
getPortletId()
Returns: String
The name of the portlet used to render this panel's body, when this panel renders via a portlet rather than an icon/text pair.
getTitle()
Returns: String
The title displayed at the top of this panel.
getProfileTab()
Returns: ProfileTab
The profile tab this panel links to, so a user can click through to more detail. May be null if the panel is not linked to a tab.
getIcon()
Returns: String
The icon shown for this panel, when it uses the icon/text rendering rather than a portlet.
getMainText()
Returns: String
The main text (typically a value, such as a count or balance) shown for this panel, when it uses the icon/text rendering rather than a portlet.
getSubText()
Returns: String
The secondary text (typically a label describing the main text) shown for this panel, when it uses the icon/text rendering rather than a portlet.