Class Alfresco.RulesHeader
Extends Alfresco.component.Base
RulesHeader template.
Defined in: rules-header.js
| Constructor Attributes | Constructor Name and Description |
|---|---|
|
Alfresco.RulesHeader(htmlId)
RulesHeader constructor.
|
| Field Attributes | Field Name and Description |
|---|---|
|
The folders name
|
|
|
Flag set after component is instantiated.
|
|
|
Keeps track if this component is running rules or not
|
|
|
Object container for initialization options
|
|
|
The inherit and folder rules for the folder
|
- Fields borrowed from class Alfresco.component.Base:
- modules, services, widgets
| Method Attributes | Method Name and Description |
|---|---|
|
onCopyRuleFromButtonClick(type, args)
Called when user clicks on the copy rule from button.
|
|
|
onFolderDetailsAvailable(layer, args)
Event handler called when the "folderDetailsAvailable" event is received
|
|
|
onFolderRulesetDetailsAvailable(layer, args)
Event handler called when the "folderRulesDetailsAvailable" event is received
|
|
|
onNewRuleButtonClick(type, args)
Called when user clicks on the create rule button.
|
|
|
onReady()
Fired by YUI when parent element is available for scripting.
|
|
|
onRunRulesMenuSelect(sType, aArgs, p_obj)
Called when an option in the Run Rules menu has been called.
|
- Methods borrowed from class Alfresco.component.Base:
- attachLinkClickListeners, bind, createYUIButtons, destroy, fire, invokeAction, msg, onComponentLoaded, onComponentsLoaded, onReadyWrapper, refresh, setMessages, setOptions
Constructor Detail
Alfresco.RulesHeader(htmlId)
RulesHeader constructor.
- Parameters:
- {String} htmlId
- The HTML id of the parent element
- Returns:
- {Alfresco.RulesHeader} The new RulesHeader instance
Field Detail
folderDetails
The folders name
isReady
Flag set after component is instantiated.
{Boolean}
isRunning
Keeps track if this component is running rules or not
{object}
options
Object container for initialization options
ruleset
The inherit and folder rules for the folder
Method Detail
onCopyRuleFromButtonClick(type, args)
Called when user clicks on the copy rule from button.
Displays a rule folder dialog.
Displays a rule folder dialog.
- Parameters:
- type
- args
onFolderDetailsAvailable(layer, args)
Event handler called when the "folderDetailsAvailable" event is received
- Parameters:
- layer
- args
onFolderRulesetDetailsAvailable(layer, args)
Event handler called when the "folderRulesDetailsAvailable" event is received
- Parameters:
- layer
- args
onNewRuleButtonClick(type, args)
Called when user clicks on the create rule button.
Takes the user to the new rule page.
Takes the user to the new rule page.
- Parameters:
- type
- args
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.
onRunRulesMenuSelect(sType, aArgs, p_obj)
Called when an option in the Run Rules menu has been called.
- Parameters:
- {string} sType
- Event type, e.g. "click"
- {array} aArgs
- Arguments array, [0] = DomEvent, [1] = EventTarget
- {object} p_obj
- Object passed back from subscribe method