Class Alfresco.CustomiseLayout
CustomiseLayout component.
Defined in: customise-layout.js
| Constructor Attributes | Constructor Name and Description |
|---|---|
|
Alfresco.CustomiseLayout(htmlId)
Alfresco.CustomiseLayout constructor.
|
| Field Attributes | Field Name and Description |
|---|---|
|
Object container for initialization options
|
|
|
Object container for storing YUI widget instances.
|
| Method Attributes | Method Name and Description |
|---|---|
|
onCancelButtonClick(event)
Fired when the user clicks cancel layout button.
|
|
|
onChangeButtonClick(event)
Fired when the user clicks change layout button.
|
|
|
Fired by YUILoaderHelper when required component script files have
|
|
|
onSelectLayoutClick(selectedLayoutId)
Fired when the user clicks one of the select buttons or icons for a layout.
|
|
|
setMessages(obj)
Set messages for this module.
|
|
|
setOptions(obj)
Set multiple initialization options at once.
|
Constructor Detail
Alfresco.CustomiseLayout(htmlId)
Alfresco.CustomiseLayout constructor.
- Parameters:
- {string} htmlId
- The HTML id of the parent element
- Returns:
- {Alfresco.CustomiseLayout} The new CustomiseLayout instance
Field Detail
{object}
options
Object container for initialization options
{object}
widgets
Object container for storing YUI widget instances.
Method Detail
onCancelButtonClick(event)
Fired when the user clicks cancel layout button.
Hides the layout list.
Hides the layout list.
- Parameters:
- {object} event
- an "click" event
onChangeButtonClick(event)
Fired when the user clicks change layout button.
Shows the layout list.
Shows the layout list.
- Parameters:
- {object} event
- an "click" event
onComponentsLoaded()
Fired by YUILoaderHelper when required component script files have
been loaded into the browser.
been loaded into the browser.
onSelectLayoutClick(selectedLayoutId)
Fired when the user clicks one of the select buttons or icons for a layout.
Changes the current layout to the selected layout and throws an global
event, that can be captured by other components, such as
Alfresco.CustomiseDashlets.
Changes the current layout to the selected layout and throws an global
event, that can be captured by other components, such as
Alfresco.CustomiseDashlets.
- Parameters:
- {string} selectedLayoutId
- The id of the selected layout
{Alfresco.CustomiseLayout}
setMessages(obj)
Set messages for this module.
- Parameters:
- {object} obj
- Object literal specifying a set of messages
- Returns:
- {Alfresco.CustomiseLayout} returns 'this' for method chaining
{Alfresco.CustomiseLayout}
setOptions(obj)
Set multiple initialization options at once.
- Parameters:
- {object} obj
- Object literal specifying a set of options
- Returns:
- {Alfresco.CustomiseLayout} returns 'this' for method chaining