Alloy UI

aui-tree  1.0.1

 
Filters

Class TreeNodeCheck - extends TreeNodeIO

Known Subclasses:
TreeNodeTask

A base class for TreeNodeCheck, providing:
  • Widget Lifecycle (initializer, renderUI, bindUI, syncUI, destructor)
  • Checkbox support for the TreeNode
Check the list of Configuration Attributes available for TreeNodeCheck.

Constructor

TreeNodeCheck ( config )
Parameters:
config <Object> Object literal specifying widget configuration properties.

Properties

TreeNode.ATTRS - static Object

Static property used to define the default attribute configuration for the TreeNode.

TreeNode.NAME - static String

Static property provides a string to identify the class.

Properties inherited from TreeData:

Properties inherited from Attribute:

Properties inherited from TreeNodeIO:

Properties inherited from Base:

Configuration Attributes

checkContainerEl - Node | String

Container element for the checkbox.
Default Value: Generated DOM element.

checked - boolean

Whether the TreeNode is checked or not.
Default Value: false

checkEl - Node | String

Checkbox element.
Default Value: Generated DOM element.

checkName - String

Name of the checkbox element used on the current TreeNode.
Default Value: 'tree-node-check'

Configuration attributes inherited from TreeData:

Configuration attributes inherited from TreeNodeIO:

Configuration attributes inherited from Base:

Methods

check

void check ( )
Check the current TreeNode.

toggleCheck

void toggleCheck ( )
Toggle the check status of the current TreeNode.

uncheck

void uncheck ( )
Uncheck the current TreeNode.

Methods inherited from Plugin.Host:

Events

checkContainerElChange

checkContainerElChange ( event )
Fires when the value for the configuration attribute 'checkContainerEl' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.
Parameters:
event<Event.Facade> An Event Facade object with the following attribute specific properties added:
prevVal
The value of the attribute, prior to it being set
newVal
The value the attribute is to be set to
attrName
The name of the attribute being set
subAttrName
If setting a property within the attribute's value, the name of the sub-attribute property being set

checkedChange

checkedChange ( event )
Fires when the value for the configuration attribute 'checked' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.
Parameters:
event<Event.Facade> An Event Facade object with the following attribute specific properties added:
prevVal
The value of the attribute, prior to it being set
newVal
The value the attribute is to be set to
attrName
The name of the attribute being set
subAttrName
If setting a property within the attribute's value, the name of the sub-attribute property being set

checkElChange

checkElChange ( event )
Fires when the value for the configuration attribute 'checkEl' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.
Parameters:
event<Event.Facade> An Event Facade object with the following attribute specific properties added:
prevVal
The value of the attribute, prior to it being set
newVal
The value the attribute is to be set to
attrName
The name of the attribute being set
subAttrName
If setting a property within the attribute's value, the name of the sub-attribute property being set

checkNameChange

checkNameChange ( event )
Fires when the value for the configuration attribute 'checkName' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.
Parameters:
event<Event.Facade> An Event Facade object with the following attribute specific properties added:
prevVal
The value of the attribute, prior to it being set
newVal
The value the attribute is to be set to
attrName
The name of the attribute being set
subAttrName
If setting a property within the attribute's value, the name of the sub-attribute property being set