Class Alfresco.widget.DashletTitleBarActions
Extends Alfresco.component.Base
Dashlet title bar action controller
When creating a new title bar action controller it is necessary to call setOptions with the following
attributes in a hash:
- actions: an array of the actions to display (see below)
Actions:
Each action can have the following attributes:
- cssClass (required) : this should be a CSS class that defines a 16x16 image to render as the action icon
- tooltip (options) : this should be a message to use for the hover help tooltip
- eventOnClick (optional) : this is the custom event event that will be fired when the action is clicked
- linkOnClick (optional) : this is URL that the browser will redirect to when the action is clicked
- targetOnClick (optional) : this is the URL that the browser display in a new window/tab
- bubbleOnClick (optional) : this should be an object containing "message" (String) and "messageArgs" (String array) attributes
When creating a new title bar action controller it is necessary to call setOptions with the following
attributes in a hash:
- actions: an array of the actions to display (see below)
Actions:
Each action can have the following attributes:
- cssClass (required) : this should be a CSS class that defines a 16x16 image to render as the action icon
- tooltip (options) : this should be a message to use for the hover help tooltip
- eventOnClick (optional) : this is the custom event event that will be fired when the action is clicked
- linkOnClick (optional) : this is URL that the browser will redirect to when the action is clicked
- targetOnClick (optional) : this is the URL that the browser display in a new window/tab
- bubbleOnClick (optional) : this should be an object containing "message" (String) and "messageArgs" (String array) attributes
Defined in: share.js
| Constructor Attributes | Constructor Name and Description |
|---|---|
|
Dashlet Title Bar Action controller constructor.
|
| Field Attributes | Field Name and Description |
|---|---|
|
The that node containing all the actions nodes. The actions are
|
|
|
DOM node of dashlet
|
|
|
DOM node of dashlet body
|
|
|
DOM node of dashlet title
|
- Fields borrowed from class Alfresco.component.Base:
- modules, options, services, widgets
| Method Attributes | Method Name and Description |
|---|---|
|
onReady()
Fired by YUI when parent element is available for scripting.
|
- Methods borrowed from class Alfresco.component.Base:
- attachLinkClickListeners, bind, createYUIButtons, destroy, fire, invokeAction, msg, onComponentLoaded, onComponentsLoaded, onReadyWrapper, refresh, setMessages, setOptions
Constructor Detail
Alfresco.widget.DashletTitleBarActions(htmlId)
Dashlet Title Bar Action controller constructor.
- Parameters:
- htmlId
- Returns:
- {Alfresco.widget.DashletTitleBarActions} The new Alfresco.widget.DashletTitleBarActions instance
Field Detail
{object}
actionsNode
The that node containing all the actions nodes. The actions are
grouped under a single parent so that only one animation effect needs
to be applied.
grouped under a single parent so that only one animation effect needs
to be applied.
- Default Value:
- null
{object}
dashlet
DOM node of dashlet
Looks for first child DIV of dashlet with class="dashlet" and attach to this
Looks for first child DIV of dashlet with class="dashlet" and attach to this
- Default Value:
- null
{object}
dashletBody
DOM node of dashlet body
Resizer will look for first child DIV of dashlet with class="body" and resize this element
Resizer will look for first child DIV of dashlet with class="body" and resize this element
- Default Value:
- null
{object}
dashletTitle
DOM node of dashlet title
The first child DIV of dashlet with class="title"
The first child DIV of dashlet with class="title"
- Default Value:
- null
Method Detail
onReady()
Fired by YUI when parent element is available for scripting.
Template initialisation, including instantiation of YUI widgets and event listener binding.
Template initialisation, including instantiation of YUI widgets and event listener binding.