Alloy UI

aui-tree  1.0.1

 
Filters

Class TreeNodeIO - extends TreeNode

Known Subclasses:
TreeNodeCheck
A base class for TreeNodeIO, providing:
  • Widget Lifecycle (initializer, renderUI, bindUI, syncUI, destructor)
  • Ajax support to load the children of the current TreeNode
Quick Example:
var treeNodeIO = new A.TreeNodeIO({
label: 'TreeNodeIO',
cache: false,
io: {
url: 'assets/content.html'
}
});
Check the list of Configuration Attributes available for TreeNodeIO.

Constructor

TreeNodeIO ( 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 Base:

Configuration Attributes

cache - boolean

Whether the current TreeNode should cache the loaded content or not.
Default Value: true

io - Object

IO options for the current TreeNode load the children.
Default Value: Default IO Configuration.

loaded - boolean

Whether the current TreeNode has loaded the content.
Default Value: false

loading - boolean

Whether the current TreeNode IO transaction is loading.
Default Value: false

Configuration attributes inherited from TreeData:

Configuration attributes inherited from Base:

Methods

_bindPaginatorUI

protected void _bindPaginatorUI ( )
Bind events to the paginator "show more" link.

_defPaginatorClickFn

protected void _defPaginatorClickFn ( event )
Default paginatorClick event handler. Increment the paginator.start to the next paginator.limit.
Parameters:
event <EventFacade> The Event object

_handlePaginatorClickEvent

protected void _handlePaginatorClickEvent ( event )
Fires the paginatorClick event.
Parameters:
event <EventFacade> paginatorClick event facade

_inheritOwnerTreeAttrs

protected void _inheritOwnerTreeAttrs ( )
If not specified on the TreeNode some attributes are inherited from the ownerTree by this method.

_setIO

protected Object _setIO ( v )
Setter for io.
Parameters:
v <Object>

_syncPaginatorIOData

protected void _syncPaginatorIOData ( )
Adds two extra IO data parameter to the request to handle the paginator. By default these parameters are limit and start.

_syncPaginatorUI

protected void _syncPaginatorUI ( )
Sync the paginator link UI.

bindUI

protected void bindUI ( )
Bind the events on the TreeNodeIO UI. Lifecycle.

initIO

void initIO ( )
Initialize the IO transaction setup on the io attribute.

ioCompleteHandler

void ioCompleteHandler ( )
IO Complete handler.

ioFailureHandler

void ioFailureHandler ( )
IO Failure handler.

ioStartHandler

void ioStartHandler ( )
IO Start handler.

ioSuccessHandler

void ioSuccessHandler ( )
IO Success handler.

renderUI

protected void renderUI ( )
Create the DOM structure for the TreeNodeIO. Lifecycle.

Methods inherited from Plugin.Host:

Events

cacheChange

cacheChange ( event )
Fires when the value for the configuration attribute 'cache' 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

ioChange

ioChange ( event )
Fires when the value for the configuration attribute 'io' 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

loadedChange

loadedChange ( event )
Fires when the value for the configuration attribute 'loaded' 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

loadingChange

loadingChange ( event )
Fires when the value for the configuration attribute 'loading' 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