Class Index | File Index

Classes


Class Alfresco.RuleConfigUtil

Rule config util
Field Summary
Field Attributes Field Name and Description
 
Flag to help us add listener for "ruleConfigReady" only once
 
This is where the rule configs will be stored: type (event), condition (if & unless) & action (action).
Method Summary
Method Attributes Method Name and Description
 
displayRuleConfigs(rule, mode, form)
Takes a rule and displays the info inside the rule config components in editable mode
 
onRuleConfigReady(layer, args)
Called when a rule config component has sent event telling its ready.
 
Called then the rule config components have been loaded and inserted.
 
Called then the rule config components have been loaded, inserted has loaded all of their
Field Detail
{boolean} listeningForReadyRuleConfigs
Flag to help us add listener for "ruleConfigReady" only once
Default Value:
false

{object} ruleConfigs
This is where the rule configs will be stored: type (event), condition (if & unless) & action (action).
Will first contain the componentId as key and a false boolean value to indicate that a component is being
loaded but hasn't fired its "ruleConfigReady" event. When the config component has fired the event
onRuleConfigReady method will replace the boolean value with the component instance to
indicate the config component is ready to be used.
Method Detail
{array} displayRuleConfigs(rule, mode, form)
Takes a rule and displays the info inside the rule config components in editable mode
if editMode is true.
Parameters:
{object} rule
The object describing the rule with the info to display as rule configs
{string} mode
form
Returns:
{array} the number of configs for each of the for config types.

onRuleConfigReady(layer, args)
Called when a rule config component has sent event telling its ready.
This method will display the configs when all 4 of them are ready.
Parameters:
{object} layer
Event fired (unused)
{array} args
Event parameters

onRuleConfigsLoaded()
Called then the rule config components have been loaded and inserted.

onRuleConfigsReady()
Called then the rule config components have been loaded, inserted has loaded all of their
dependecies, and thereofre is ready to use.
In other words ready for getting their displayRuleConfigs() invoked.

Documentation generated by JsDoc Toolkit 2.4.0 on Thu Feb 16 2012 12:24:27 GMT-0000 (GMT)