RuleEditor

The RuleEditor control enables users to input text using an “input group template”. You can either enter text manually or by using the intellisense menu. You can also customize the view for individual groups or within a group for specific group types.

The Constructor supports one composite parameter. The following table describes its properties.

Name	Type	Description
connectId	String	Mandatory parameter. It is the ID of the DOM element container for VariantsTree control. This element should exist in the DOM document. The VariantsTree DOM is placed as a child into the container. The default is ‘variantsTreeContainer’.
contextMenuEnabled	Boolean	Optional parameter. Turns context menu support on/off (widget creation, events tracking). The default is False.
isEditable	Boolean	Optional parameter. Turns text editing for the control on/off. The default is False.
template	Object	Optional composite parameter. It must include a ‘template’ array property containing the group names sequence and the parameters for each group from ‘template’ keyed with group names. Example: { template: [‘RuleConditionGroup’], templateGroups: { ‘RuleConditionGroup': { type: ‘grammar’, grammarFile: ‘RuleEditor/RuleGrammar.txt’, title: ‘Rule condition expression’, }, } }

Name	Type	Description
containerNode	DOM Node	A reference to the DOM Node used as a container for the control DOM.
domNode	DOM Node	A reference to the DOM Node that corresponds to the control.
contextMenu	Object, MenuWidget	A reference to the menu widget used for the context menu.
intelliSenseMenu	Object, MenuWidget	A reference to the menu widget used for the intellisense menu.

This section describes the public methods.

Use this method to create a new editor input template. The startNewInput method needs to be called before you can start working with the editor using this template method.

Input parameters

Name	Type	Description
inputTemplate	Object	A template that contains a list of groups used as the ‘template’ array property as well as settings for each group.

Use this method to get the current editor input template.

Return value

Object. Template descriptor or null.

Switch edit state for the control.

Input parameters

Name	Type	Description
isEditable	Boolean	The applied value defines how the editor content can be modified.

Get edit state of the control. It determines whether content is editable.

Return value Boolean

This method enables toggling between DOM Node CSS classes. Input parameters

Name	Type	Description
cssClassNames	String | Array of Strings	Class names that can be added or removed from the Node. You can pass several class names as a string parameter by separating them using the ‘space’ character.
turnStyleOn	Boolean	If true, classes are added to the Node. If false, classes are removed.
targetNode	DOM Node, Nullable	Node that can be modified.

Determines if the values from all the input groups passed validation. Return value Boolean

Determines if the template was set and all input groups were created. Return value Boolean

Places focus into the active or first input group.

Places focus into a specific input group. Input parameters

Name	Type	Description
groupName	String	Group name from template.

Places focus on the first input group, which supports user input.

Undoes the previous editor value change.

Re-does the change that was undone.

Gets information about the current editor state. Return value Object with editor state information.

Resets all changes. The Editor returns to its initial values.

Sets up the editor according to state settings. The current changes queue is dropped. Input parameters

Name	Type	Description
startState	Object	State information for editor settings restoration.

Gets the current editor value. Return value Object with values from all input groups. The key is the group name from the template.

Gets the editor value as string. Return value String. Concatenation of all input group values.

Sets the editor value. Input parameters

Name	Type	Description
inputData	Object	Value collection for editor input groups. Key = group name from template.

Gets value validation error as a string. Return value String. Concatenation of validation errors from all input groups.

Determines which editor control has focus. Return value Boolean

Determines which target menu control has focus. Input parameters

Name	Type	Description
targetMenu	Object, MenuWidget	Menu widget used in the editor.

Return value Boolean

Identifies whether the initial editor value was modified. Return value Boolean

Registers the shortcut for the editor. Input parameters

Name	Type	Description
keyCode	Number	Button key code.
isCtrl	Boolean	Specifies whether the Ctrl key is pressed.
isShift	Boolean	Specifies whether the Shift key is pressed.
callbackHandler	Function	Method that is called when the shortcut is activated.

Gets the index for a particular input group. Input parameters

Name	Type	Description
targetGroup	Object, InputGroup	Registered editor input group.

Gets a particular input group by index. Input parameters

Name	Type	Description
groupIndex	Number	Group index from template.

Return value InputGroup

Gets input group using the related DOM Node. Input parameters

Name	Type	Description
targetDomNode	DOM Node	DOM Node belonging to the registered editor input group.

Return value InputGroup

Gets the name of a specific input group. Input parameters

Name	Type	Description
targetGroup	Object, InputGroup	Registered editor input group.

Return value String. Group name from template.

Gets registered editor input group by name from the template. Input parameters

Name	Type	Description
groupName	String	Group name from active editor template.

Return value InputGroup

Counts the editor input groups. Return value Number

Gets the next input group relative to the target group. If the target group is last, then the first group is returned. Input parameters

Name	Type	Description
targetGroup	Object, InputGroup	Group relative to which next group is searched.

Return value InputGroup

Gets the previous input group relative to the target group. If the target group is last, then the first group is returned. Input parameters

Name	Type	Description
targetGroup	Object, InputGroup	Group relatively to which previous group is searched.

Return value InputGroup

Gets the previous input group relative to the target group. If target group is last, then the first group is returned. Input parameters

Name	Type	Description
targetGroup	Object,InputGroup | String	Existing editor input group or it id.

Return value InputGroup

Creates editor input groups based on the current template. All previous input groups are removed.

Shows the intellisense menu for a particular input group. Input parameters

Name	Type	Description
targetGroup	Object, InputGroup	Existing editor input group.
allOptions	Boolean	If true, all available group values appear. If false, proposed values are limited based on the current group value.

Hides active intellisense menu.

Events described in this section are based on the Eventable core module. You can assign Handlers for these events using the addEventListener method.

Event fires when the editor control has focus.

Event fires when the focus moves away from the editor control.

Event fires after group values are changed or the group loses focus.

Event fires after the editor creates DOM for input groups.

Event fires after editor creates DOM for input groups.

Event fires if the group value changed and passed validation. Input parameters

Name	Type	Description
targetGroup	Object, InputGroup	Affected editor input group.
approvedValue	String	Applied value, which passed validation.

The events described in this section belong to the dojo context menu widget. Use the dojo.connect and dojo.on modules to attach handlers for them.

onMenuInit

Event raised before context menu creation. Use it to create a list of required menu items. Input parameters

Name	Type	Description
menuEvent	Event	Corresponding native context menu event.
targetGroup	Object, InputGroup	Target editor input group that the context menu is created for.
targetGroupName	String	Input group name from template.

Return value Array of menu items descriptors.

onMenuItemClick

Event raised when the user clicks on the editor context menu item. Input parameters

Name	Type	Description
commandId	String	ID of selected menu item.
contextData	Any	Context information for menu.

Return value
Array of menu items descriptors.