Class Alfresco.RuleConfig
Extends Alfresco.component.Base
RuleConfig template.
Defined in: rule-config.js
| Constructor Attributes | Constructor Name and Description |
|---|---|
|
Alfresco.RuleConfig(htmlId)
RuleConfig constructor.
|
| Field Attributes | Field Name and Description |
|---|---|
|
CUSTOMISATIONS
|
|
|
Object container for initialization options
|
|
|
PARAMETER RENDERERS
|
- Fields borrowed from class Alfresco.component.Base:
- modules, services, widgets
| Method Attributes | Method Name and Description |
|---|---|
|
displayRuleConfigs(ruleConfigs)
Displays ruleConfig rows as described in ruleConfigs.
|
|
|
Returns a list of all the current ruleConfigs as an array of ruleConfig objects.
|
|
|
onAddConfigButtonClick(p_oEvent, p_eConfig)
Called when the user clicks on an "+"/add rule config button
|
|
|
onAddExtraParameterIconClick(p_oEvent, p_oParameterCtx)
Called from the "+" link to create another value for multi valued parameter
|
|
|
onConfigNameSelectChange(p_oEvent, configEl)
Called when the user selects an option int the ruleConfig select menu
|
|
|
onDatePickerMandatoryControlValueUpdated(layer, args)
Called when a date has been selected from a date picker.
|
|
|
onDeleteExtraParameterIconClick(p_oEvent, p_oExtraparamEl)
Called from the "-" link to remove a value for multi valued parameter
|
|
|
onReady()
Fired by YUI when parent element is available for scripting.
|
|
|
onRemoveConfigButtonClick(p_oEvent, p_eConfig)
Called when the user clicks on an "-"/remove rule config button
|
- Methods borrowed from class Alfresco.component.Base:
- attachLinkClickListeners, bind, createYUIButtons, destroy, fire, invokeAction, msg, onComponentLoaded, onComponentsLoaded, onReadyWrapper, refresh, setMessages, setOptions
Constructor Detail
Alfresco.RuleConfig(htmlId)
RuleConfig constructor.
- Parameters:
- {String} htmlId
- The HTML id of the parent element
- Returns:
- {Alfresco.RuleConfig} The new RuleConfig instance
Field Detail
customisations
CUSTOMISATIONS
{object}
options
Object container for initialization options
renderers
PARAMETER RENDERERS
Method Detail
displayRuleConfigs(ruleConfigs)
Displays ruleConfig rows as described in ruleConfigs.
Expects the following format of the ruleConfig array:
[
{
"<match the value of this.options.ruleConfigDefinitionKey>": "<the ruleConfig name to select in the select menu>",
"parameterValues":
{
"paramName1": "paramValue1",
"paramName2": "paramValue2"
}
}
]
Note! This method shall be called after the "ruleConfigReady" event has been fired.
Note! Before this method is called the config body will be empty.
Note! Even if ruleConfigs contains no elements 1 row will always be created.
Expects the following format of the ruleConfig array:
[
{
"<match the value of this.options.ruleConfigDefinitionKey>": "<the ruleConfig name to select in the select menu>",
"parameterValues":
{
"paramName1": "paramValue1",
"paramName2": "paramValue2"
}
}
]
Note! This method shall be called after the "ruleConfigReady" event has been fired.
Note! Before this method is called the config body will be empty.
Note! Even if ruleConfigs contains no elements 1 row will always be created.
- Parameters:
- {array} ruleConfigs
- An array of rule configurations
{array}
getRuleConfigs()
Returns a list of all the current ruleConfigs as an array of ruleConfig objects.
I.e
[
{
"<the value of this.options.ruleConfigDefinitionKey>": "<the selected option value in the select menu>",
"parameterValues":
{
"paramName1": "paramValue1",
"paramName2": "paramValue2"
}
}
]
I.e
[
{
"<the value of this.options.ruleConfigDefinitionKey>": "<the selected option value in the select menu>",
"parameterValues":
{
"paramName1": "paramValue1",
"paramName2": "paramValue2"
}
}
]
- Returns:
- {array} An array of ruleConfig objects
onAddConfigButtonClick(p_oEvent, p_eConfig)
Called when the user clicks on an "+"/add rule config button
- Parameters:
- {object} p_oEvent
- The click event
- {HTMLDivElement} p_eConfig
- the config element the button belongs to
onAddExtraParameterIconClick(p_oEvent, p_oParameterCtx)
Called from the "+" link to create another value for multi valued parameter
- Parameters:
- {object} p_oEvent
- The click event
- {object} p_oParameterCtx
- References to paramDef, configDef, ruleConfig
onConfigNameSelectChange(p_oEvent, configEl)
Called when the user selects an option int the ruleConfig select menu
- Parameters:
- {object} p_oEvent
- The change event
- {HTMLElement} configEl
- Contains the ruleConfig and configEl objects
onDatePickerMandatoryControlValueUpdated(layer, args)
Called when a date has been selected from a date picker.
Will cause the forms validation to run.
Will cause the forms validation to run.
- Parameters:
- layer
- args
onDeleteExtraParameterIconClick(p_oEvent, p_oExtraparamEl)
Called from the "-" link to remove a value for multi valued parameter
- Parameters:
- {object} p_oEvent
- The click event
- {HTMLElement} p_oExtraparamEl
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.
onRemoveConfigButtonClick(p_oEvent, p_eConfig)
Called when the user clicks on an "-"/remove rule config button
- Parameters:
- {object} p_oEvent
- The click event
- {HTMLDivElement} p_eConfig
- the config element the button belongs to