CheckBoxTreeView widget. Extrends TreeView widget to support relevant events and methods od checkbox tree. This widget represents the root cotainer for CheckBoxTreeNode objects that build the actual tree structure. Therefore this widget will not usually have any visual representation. Its also responsible for handling node events.
_addchild
child
index
Adds a Widget as a child. If the specified Widget already has a parent it will be removed from its current parent before being added as a child.
child
Widget | Object
The Widget instance, or configuration object for the Widget to be added as a child.
child
Array
Array of Widget instances, or configuration objects for the Widgets to be added as a children.
index
Number
(Optional.) Number representing the position at which the child should be inserted.
_addAttrscfgs
values
lazy
Implementation behind the public addAttrs method.
This method is invoked directly by get if it encounters a scenario in which an attribute's valueFn attempts to obtain the value an attribute in the same group of attributes, which has not yet been added (on demand initialization).
cfgs
Object
An object with attribute name/configuration pairs.
values
Object
An object with attribute name/value pairs, defining the initial values to apply. Values defined in the cfgs argument will be over-written by values in this argument unless defined as read only.
lazy
Boolean
Whether or not to delay the intialization of these attributes until the first call to get/set. Individual attributes can over-ride this behavior by defining a lazyAdd configuration property in their configuration. See addAttr.
_addLazyAttrname
Finishes initializing an attribute which has been lazily added.
name
Object
The name of the attribute
_afterActiveDescendantChangeevent
Attribute change listener for the activeDescendant
attribute, responsible for setting the value of the
parent's activeDescendant attribute.
event
EventFacade
The event facade for the attribute change.
_afterChildSelectedChangeevent
Default attribute change listener for the selected
attribute, responsible for updating the UI, in response to
attribute changes.
event
EventFacade
The event facade for the attribute change.
_afterDestroyChildevent
Destroy event listener for each child Widget, responsible for removing the destroyed child Widget from the parent's internal array of children (_items property).
event
EventFacade
The event facade for the attribute change.
_afterParentSelectedChangeevent
Attribute change listener for the selected
attribute, responsible for syncing the selected state of all children to
match that of their parent Widget.
event
EventFacade
The event facade for the attribute change.
_afterSelectionChangeevent
Attribute change listener for the selection
attribute, responsible for setting the value of the
parent's selected attribute.
event
EventFacade
The event facade for the attribute change.
_aggregateAttrsallAttrs
A helper method, used by _initHierarchyData to aggregate attribute configuration across the instances class hierarchy.
The method will protect the attribute configuration value to protect the statically defined default value in ATTRS if required (if the value is an object literal, array or the attribute configuration has cloneDefaultValue set to shallow or deep).
allAttrs
Array
An array of ATTRS definitions across classes in the hierarchy (subclass first, Base last)
_applyParserconfig
Utility method used to apply the HTML_PARSER configuration for the
instance, to retrieve config data values.
config
Object
User configuration object (will be populated with values from Node)
_attrCfgHashUtility method to define the attribute hash used to filter/whitelist property mixes for this class.
_baseDestroyInternal destroy implementation for BaseCore
_baseInitInternal initialization implementation for BaseCore
_bindAttrUIattrs
Binds after listeners for the list of attributes provided
attrs
Array
_bindDOMSets up DOM listeners, on elements rendered by the widget.
_bindUISets up DOM and CustomEvent listeners for the widget.
_bindUIChildBinds event listeners responsible for updating the UI state in response to WidgetChild related state changes.
This method is invoked after bindUI is invoked for the Widget class using YUI's aop infrastructure.
_bindUIParentSets up DOM and CustomEvent listeners for the parent widget.
This method in invoked after bindUI is invoked for the Widget class using YUI's aop infrastructure.
_createChildconfig
Creates an instance of a child Widget using the specified configuration.
By default Widget instances will be created of the type specified
by the defaultChildType attribute. Types can be explicitly
defined via the childType property of the configuration object
literal. The use of the type property has been deprecated, but
will still be used as a fallback, if childType is not defined,
for backwards compatibility.
config
Object
Object literal representing the configuration used to create an instance of a Widget.
_createUIEventtype
Binds a delegated DOM event listener of the specified type to the Widget's outtermost DOM element to facilitate the firing of a Custom Event of the same type for the Widget instance.
type
String
String representing the name of the event
_defAddChildFnevent
child
index
Default addChild handler
event
EventFacade
The Event object
child
Widget
The Widget instance, or configuration object for the Widget to be added as a child.
index
Number
Number representing the position at which the child will be inserted.
_defAttrChangeFne
Default function for attribute change events.
e
EventFacade
The event object for attribute change events.
_defaultCBReturns the default value for the contentBox attribute.
For the Widget class, this will be the srcNode if provided, otherwise null (resulting in a new contentBox node instance being created)
_defInitFne
Default init event handler
e
EventFacade
Event object, with a cfg property which refers to the configuration object passed to the constructor.
_defRemoveChildFnevent
child
index
Default removeChild handler
event
EventFacade
The Event object
child
Widget
The Widget instance to be removed.
index
Number
Number representing the index of the Widget to be removed.
_defRenderFne
parentNode
Default render handler
e
EventFacade
The Event object
parentNode
Node
The parent node to render to, if passed in to the render method
_destroyBoxRemoves and destroys the widgets rendered boundingBox, contentBox, and detaches bound UI events.
_destroyChildrenDestroys all child Widgets for the parent.
This method is invoked before the destructor is invoked for the Widget class using YUI's aop infrastructure.
_destroyHierarchyDestroys the class hierarchy for this instance by invoking the destructor method on the prototype of each class in the hierarchy.
_destroyUIEventsDestructor logic for UI event infrastructure, invoked during Widget destruction.
_expandStateDefaultFnDefault event handler for "expand" event
_filterAdHocAttrsallAttrs
userVals
allAttrs
Object
The set of all attribute configurations for this instance. Attributes will be removed from this set, if they belong to the filtered class, so that by the time all classes are processed, allCfgs will be empty.
userVals
Object
The config object passed in by the user, from which adhoc attrs are to be filtered.
_filterAttrCfsclazz
allCfgs
A helper method used when processing ATTRS across the class hierarchy during initialization. Returns a disposable object with the attributes defined for the provided class, extracted from the set of all attributes passed in.
_filterUIEventevt
This method is used to determine if we should fire the UI Event or not. The default implementation makes sure that for nested delegates (nested unrelated widgets), we don't fire the UI event listener more than once at each level.
For example, without the additional filter, if you have nested widgets, each widget will have a delegate listener. If you click on the inner widget, the inner delegate listener's filter will match once, but the outer will match twice (based on delegate's design) - once for the inner widget, and once for the outer.
evt
DOMEventFacade
_fireAttrChangeattrName
subAttrName
currVal
newVal
opts
Utility method to help setup the event payload and fire the attribute change event.
attrName
String
The name of the attribute
subAttrName
String
The full path of the property being changed, if this is a sub-attribute value being change. Otherwise null.
currVal
Any
The current value of the attribute
newVal
Any
The new value of the attribute
opts
Object
Any additional event data to mix into the attribute change event's event facade.
_getAttrname
Provides the common implementation for the public get method, allowing Attribute hosts to over-ride either method.
See get for argument details.
name
String
The name of the attribute.
_getAttrCfgname
Returns an object with the configuration properties (and value) for the given attribute. If attrName is not provided, returns the configuration properties for all attributes.
name
String
Optional. The attribute name. If not provided, the method will return the configuration for all attributes.
_getAttrCfgsReturns an aggregated set of attribute configurations, by traversing the class hierarchy.
_getAttrInitValattr
cfg
initValues
Returns the initial value of the given attribute from either the default configuration provided, or the over-ridden value if it exists in the set of initValues provided and the attribute is not read-only.
_getAttrsattrs
Implementation behind the public getAttrs method, to get multiple attribute values.
attrs
Array | boolean
Optional. An array of attribute names. If omitted, all attribute values are returned. If set to true, all attributes modified from their initial values are returned.
_getClassesReturns the class hierarchy for this object, with BaseCore being the last class in the array.
_getHtmlParserGets the HTMLPARSER definition for this instance, by merging HTMLPARSER definitions across the class hierarchy.
_getNodeToParseDetermines whether we have a node reference which we should try and parse.
The current implementation does not parse nodes generated from CONTENT_TEMPLATE, only explicitly set srcNode, or contentBox attributes.
_getStateValname
Gets the stored value for the attribute, from either the internal state object, or the state proxy if it exits
name
String
The name of the attribute
_getStringslocale
Returns the strings key/value hash for a paricular locale, without locale lookup applied.
locale
Object
_getTypeIf the instance has a prefix attribute and the event type is not prefixed, the instance prefix is applied to the supplied type.
_getUIEventNodeReturns the node on which to bind delegate listeners.
Override of Widget's implementation of _getUIEventNode() to ensure that all event listeners are bound to the Widget's topmost DOM element. This ensures that the firing of each type of Widget UI event (click, mousedown, etc.) is facilitated by a single, top-level, delegated DOM event listener.
_guid_initAttrHostattrs
values
lazy
Constructor logic for attributes. Initializes the host state, and sets up the inital attributes passed to the constructor.
attrs
Object
The attributes to add during construction (passed through to addAttrs). These can also be defined on the constructor being augmented with Attribute by defining the ATTRS property on the constructor.
values
Object
The initial attribute values to apply (passed through to addAttrs). These are not merged/cloned. The caller is responsible for isolating user provided values if required.
lazy
Boolean
Whether or not to add attributes lazily (passed through to addAttrs).
_initAttributeInitializes Attribute
_initAttrsattrs
values
lazy
Utility method to set up initial attributes defined during construction, either through the constructor.ATTRS property, or explicitly passed in.
attrs
Object
The attributes to add during construction (passed through to addAttrs). These can also be defined on the constructor being augmented with Attribute by defining the ATTRS property on the constructor.
values
Object
The initial attribute values to apply (passed through to addAttrs). These are not merged/cloned. The caller is responsible for isolating user provided values if required.
lazy
Boolean
Whether or not to add attributes lazily (passed through to addAttrs).
_initBaseconfig
Internal construction logic for Base.
config
Object
The constructor configuration object
_initHierarchyuserVals
Initializes the class hierarchy for the instance, which includes initializing attributes for each class defined in the class's static ATTRS property and invoking the initializer method on the prototype of each class in the hierarchy.
userVals
Object
Object with configuration property name/value pairs
_initHierarchyDataA helper method used by _getClasses and _getAttrCfgs, which determines both the array of classes and aggregate set of attribute configurations across the class hierarchy for the instance.
_initUIEventtype
Sets up infrastructure required to fire a UI event.
type
String
String representing the name of the event
_isLazyAttrname
Checks whether or not the attribute is one which has been added lazily and still requires initialization.
name
String
The name of the attribute
_isUIEventtype
Determines if the specified event is a UI event.
type
String
String representing the name of the event
_mapInstanceThe
Utility method used to add an entry to the boundingBox id to instance map.
This method can be used to populate the instance with lazily created boundingBox Node references.
The
String
boundingBox id
_monitorwhat
type
o
This is the entry point for the event monitoring system. You can monitor 'attach', 'detach', 'fire', and 'publish'. When configured, these events generate an event. click -> clickattach, clickdetach, click_publish -- these can be subscribed to like other events to monitor the event system. Inividual published events can have monitoring turned on or off (publish can't be turned off before it it published) by setting the events 'monitor' config.
_nodeClickDefaultFnDefault event handler for "check" event
_nodeCollapseDefaultFnDefault event handler for "collapse" event
_nodeToggleDefaultFnDefault event handler for "toggleTreeState" event
_normAttrValsvalueHash
Utility method to normalize attribute values. The base implementation simply merges the hash to protect the original.
valueHash
Object
An object with attribute name/value pairs
_onClickEventsHandles internal tree click events
_onDocFocusevt
DOM focus event handler, used to sync the state of the Widget with the DOM
evt
EventFacade
The event facade for the DOM focus event
_onDocMouseDownevt
"mousedown" event handler for the owner document of the widget's bounding box.
evt
EventFacade
The event facade for the DOM focus event
_onKeyEventsHandles internal tree keyboard interaction
_parseTypeReturns an array with the detach key (if provided), and the prefixed event name from _getType Y.on('detachcategory| menu:click', fn)
_preInitEventCfgconfig
Handles the special on, after and target properties which allow the user to easily configure on and after listeners as well as bubble targets during construction, prior to init.
config
Object
The user configuration object
_protectAttrsattrs
Utility method to protect an attribute configuration hash, by merging the entire object and the individual attr config objects.
attrs
Object
A hash of attribute to configuration object pairs.
_removeLoadingClassNamesRemoves class names representative of the widget's loading state from the boundingBox.
_renderBoxparentNode
Helper method to collect the boundingBox and contentBox and append to the provided parentNode, if not already a child. The owner document of the boundingBox, or the owner document of the contentBox will be used as the document into which the Widget is rendered if a parentNode is node is not provided. If both the boundingBox and the contentBox are not currently in the document, and no parentNode is provided, the widget will be rendered to the current document's body.
parentNode
Node
The parentNode to render the widget to. If not provided, and both the boundingBox and the contentBox are not currently in the document, the widget will be rendered to the current document's body.
_renderBoxClassNamesApplies standard class names to the boundingBox and contentBox
_renderChildrenRenders all child Widgets for the parent.
This method in invoked after renderUI is invoked for the Widget class using YUI's aop infrastructure.
_renderUIInitializes the UI state for the Widget's bounding/content boxes.
_setname
val
Allows setting of readOnly/writeOnce attributes. See set for argument details.
name
String
The name of the attribute.
val
Any
The value to set the attribute to.
_setAttrname
value
opts
force
Provides the common implementation for the public set and protected _set methods.
See set for argument details.
name
String
The name of the attribute.
value
Any
The value to set the attribute to.
opts
Object
(Optional) Optional event data to be mixed into the event facade passed to subscribers of the attribute's change event. This is currently a hack. There's no real need for the AttributeCore implementation to support this parameter, but breaking it out into AttributeEvents, results in additional function hops for the critical path.
force
Boolean
If true, allows the caller to set values for readOnly or writeOnce attributes which have already been set.
_setAttrsattrs
Implementation behind the public setAttrs method, to set multiple attribute values.
attrs
Object
An object with attributes name/value pairs.
_setAttrValattrName
subAttrName
prevVal
newVal
Updates the stored value of the attribute in the privately held State object, if validation and setter passes.
_setBBNode/String
Setter for the boundingBox attribute
Node/String
Object
_setBoxid
node
template
true
Helper method to set the bounding/content box, or create it from the provided template if not found.
_setCBnode
Setter for the contentBox attribute
_setChildEventHandlersSets child event handlers
_setStateValname
value
Sets the stored value for the attribute, in either the internal state object, or the state proxy if it exits
name
String
The name of the attribute
value
Any
The value of the attribute
_setStringsstrings
locale
Sets strings for a particular locale, merging with any existing strings which may already be defined for the locale.
_strSetterstrings
The default setter for the strings attribute. Merges partial sets into the full string set, to allow users to partial sets of strings
strings
Object
_syncAttrUIattrs
Invokes the _uiSet=ATTR NAME> method for the list of attributes provided
attrs
Array
_syncUIUpdates the widget UI to reflect the attribute state.
_syncUIChildSynchronizes the UI to match the WidgetChild state.
This method is invoked after bindUI is invoked for the Widget class using YUI's aop infrastructure.
_uiAddChildchild
parentNode
Updates the UI in response to a child being added.
_uiRemoveChildchild
Updates the UI in response to a child being removed.
child
Widget
The child Widget instance to render.
_uiSetChildSelectedselected
Updates the UI to reflect the selected attribute value.
selected
Number
The selected value to be reflected in the UI.
_uiSetDimdim
val
_uiSetFocusedval
src
Sets the focused state for the UI
_uiSetHeightval
Sets the height on the widget's bounding box element
_uiSetTabIndexNumber
Set the tabIndex on the widget's rendered UI
Number
Object
_uiSetWidthval
Sets the width on the widget's bounding box element
_unbindDOM_unbindUI_updateActiveDescendantevent
Attribute change listener for the focused
attribute of child Widgets, responsible for setting the value of the
parent's activeDescendant attribute.
event
EventFacade
The event facade for the attribute change.
_updateSelectionevent
Attribute change listener for the selected
attribute of child Widgets, responsible for setting the value of the
parent's selection attribute.
event
EventFacade
The event facade for the attribute change.
addchild
child
index
Adds a Widget as a child. If the specified Widget already has a parent it will be removed from its current parent before being added as a child.
child
Widget | Object
The Widget instance, or configuration
object for the Widget to be added as a child. The configuration object
for the child can include a childType property, which is either
a constructor function or a string which names a constructor function on the
Y instance (e.g. "Tab" would refer to Y.Tab) (childType used to be
named type, support for which has been deprecated, but is still
maintained for backward compatibility. childType takes precedence
over type if both are defined.
child
Array
Array of Widget instances, or configuration objects for the Widgets to be added as a children.
index
Number
(Optional.) Number representing the position at which the child should be inserted.
addAttrname
config
lazy
Adds an attribute with the provided configuration to the host object.
The config argument object supports the following properties:
A function, which will return the initial value to set on the attribute. This is useful for cases where the attribute configuration is defined statically, but needs to reference the host instance ("this") to obtain an initial value. If both the value and valueFn properties are defined, the value returned by the valueFn has precedence over the value property, unless it returns undefined, in which case the value property is used.
valueFn can also be set to a string, representing the name of the instance method to be used to retrieve the value.
The writeOnce attribute can also be set to the string "initOnly", in which case the attribute can only be set during initialization (when used with Base, this means it can only be set during construction)
The setter function used to massage or normalize the value passed to the set method for the attribute. The value returned by the setter will be the final stored value. Returning Attribute.INVALID_VALUE, from the setter will prevent the value from being stored.
setter can also be set to a string, representing the name of the instance method to be used as the setter function.
The getter function used to massage or normalize the value returned by the get method for the attribute. The value returned by the getter function is the value which will be returned to the user when they invoke get.
getter can also be set to a string, representing the name of the instance method to be used as the getter function.
The validator function invoked prior to setting the stored value. Returning false from the validator function will prevent the value from being stored.
validator can also be set to a string, representing the name of the instance method to be used as the validator function.
The setter, getter and validator are invoked with the value and name passed in as the first and second arguments, and with the context ("this") set to the host object.
Configuration properties outside of the list mentioned above are considered private properties used internally by attribute, and are not intended for public use.
name
String
The name of the attribute.
config
Object
An object with attribute configuration property/value pairs, specifying the configuration for the attribute.
NOTE: The configuration object is modified when adding an attribute, so if you need to protect the original values, you will need to merge the object.
lazy
Boolean
(optional) Whether or not to add this attribute lazily (on the first call to get/set).
addAttrscfgs
values
lazy
Configures a group of attributes, and sets initial values.
NOTE: This method does not isolate the configuration object by merging/cloning. The caller is responsible for merging/cloning the configuration object if required.
cfgs
Object
An object with attribute name/configuration pairs.
values
Object
An object with attribute name/value pairs, defining the initial values to apply. Values defined in the cfgs argument will be over-written by values in this argument unless defined as read only.
lazy
Boolean
Whether or not to delay the intialization of these attributes until the first call to get/set. Individual attributes can over-ride this behavior by defining a lazyAdd configuration property in their configuration. See addAttr.
addTargeto
Registers another EventTarget as a bubble target. Bubble order is determined by the order registered. Multiple targets can be specified.
Events can only bubble if emitFacade is true.
Included in the event-custom-complex submodule.
o
EventTarget
the target to add
aftertype
fn
[context]
[arg*]
Subscribe to a custom event hosted by this object. The supplied callback will execute after any listeners add via the subscribe method, and after the default function, if configured for the event, has executed.
ancestordepth
Returns the Widget instance at the specified depth.
depth
Number
Number representing the depth of the ancestor.
attrAddedname
Checks if the given attribute has been added to the host
name
String
The name of the attribute to check.
beforeExecutes the callback before a DOM event, custom event or method. If the first argument is a function, it is assumed the target is a method. For DOM and custom events, this is an alias for Y.on.
For DOM and custom events: type, callback, context, 0-n arguments
For methods: callback, object (method host), methodName, context, 0-n arguments
bindUIConfigures/Sets up listeners to bind Widget State to UI/DOM
This method is not called by framework and is not chained automatically for the class hierarchy.
blurCauses the Widget to lose focus by setting the "focused" attribute to "false"
bubbleevt
Propagate an event. Requires the event-custom-complex module.
evt
CustomEvent
the custom event to propagate
deselectAllDeselects all children.
destroydestroyAllNodes
Destroy lifecycle method. Fires the destroy event, prior to invoking destructors for the class hierarchy. Overrides Base's implementation, to support arguments to destroy
Subscribers to the destroy event can invoke preventDefault on the event object, to prevent destruction from proceeding.
destroyAllNodes
Boolean
If true, all nodes contained within the Widget are removed and destroyed. Defaults to false due to potentially high run-time cost.
destructorThe destructor implementation for Parent widgets. Destroys all children.
detachtype
fn
context
Detach one or more listeners the from the specified event
type
String | Object
Either the handle to the subscriber or the type of event. If the type is not specified, it will attempt to remove the listener from all hosted events.
fn
Function
The subscribed function to unsubscribe, if not supplied, all subscribers will be removed.
context
Object
The custom object passed to subscribe. This is optional, but if supplied will be used to disambiguate multiple listeners that are the same (e.g., you subscribe many object using a function that lives on the prototype)
detachAlltype
Removes all listeners from the specified event. If the event type is not specified, all listeners from all hosted custom events will be removed.
type
String
The type, or name of the event
disableSet the Widget's "disabled" attribute to "true".
enableSet the Widget's "disabled" attribute to "false".
firetype
arguments
Fire a custom event by name. The callback functions will be executed from the context specified when the event was created, and with the following parameters.
If the custom event object hasn't been created, then the event hasn't been published and it has no subscribers. For performance sake, we immediate exit in this case. This means the event won't bubble, so if the intention is that a bubble target be notified, the event must be published on this object first.
The first argument is the event type, and any additional arguments are passed to the listeners as parameters. If the first of these is an object literal, and the event is configured to emit an event facade, that object is mixed into the event facade and the facade is provided in place of the original object.
type
String | Object
The type of the event, or an object that contains a 'type' property.
arguments
Object*
an arbitrary set of parameters to pass to the handler. If the first of these is an object literal and the event is configured to emit an event facade, the event facade will replace that parameter after the properties the object literal contains are copied to the event facade.
focusCauses the Widget to receive the focus by setting the "focused" attribute to "true".
getname
Returns the current value of the attribute. If the attribute has been configured with a 'getter' function, this method will delegate to the 'getter' to obtain the value of the attribute.
name
String
The name of the attribute. If the value of the attribute is an Object,
dot notation can be used to obtain the value of a property of the object (e.g. get("x.y.z"))
getAttrsattrs
Gets multiple attribute values.
attrs
Array | boolean
Optional. An array of attribute names. If omitted, all attribute values are returned. If set to true, all attributes modified from their initial values are returned.
getCheckedReturns the list of nodes that are roots of checked subtrees
getCheckedPathscfg
Returns list of pathes (breadcrumbs) of nodes that are roots of checked subtrees
cfg
Object
An object literal with the following properties:
labelAttrreversegetClassNameargs
Generate a standard prefixed classname for the Widget, prefixed by the default prefix defined
by the Y.config.classNamePrefix attribute used by ClassNameManager and
Widget.NAME.toLowerCase() (e.g. "yui-widget-xxxxx-yyyyy", based on default values for
the prefix and widget class name).
The instance based version of this method can be used to generate standard prefixed classnames, based on the instances NAME, as opposed to Widget.NAME. This method should be used when you need to use a constant class name across different types instances.
args
String*
multiple
0..n strings which should be concatenated, using the default separator defined by ClassNameManager, to create the class name
getDefaultLocaleReturns the default locale for the widget (the locale value defined by the widget class, or provided by the user during construction).
getEventtype
prefixed
Returns the custom event of the provided type has been created, a falsy value otherwise
getSkinNameReturns the name of the skin that's currently applied to the widget. This is only really useful after the widget's DOM structure is in the document, either by render or by progressive enhancement. Searches up the Widget's ancestor axis for a class yui3-skin-(name), and returns the (name) portion. Otherwise, returns null.
getStringkey
Helper method to get a specific string value
key
String
getStringskey
Helper method to get the complete set of strings for the widget
key
String
getTargetsReturns an array of bubble targets for this object.
hideHides the Widget by setting the "visible" attribute to "false".
initconfig
Init lifecycle method, invoked during construction. Fires the init event prior to setting up attributes and invoking initializers for the class hierarchy.
config
Object
Object with configuration property name/value pairs
initializerconfig
Initializer lifecycle implementation for the Widget class. Registers the widget instance, and runs through the Widget's HTML_PARSER definition.
config
Object
Configuration object literal for the widget
isRootDetermines if the Widget is the root Widget in the object hierarchy.
modifyAttrname
config
Updates the configuration of an attribute which has already been added.
The properties which can be modified through this interface are limited to the following subset of attributes, which can be safely modified after a value has already been set on the attribute: readOnly, writeOnce, broadcast and getter.
nextcircular
Returns the Widget's next sibling.
circular
Boolean
Boolean indicating if the parent's first child should be returned if the child has no next sibling.
ontype
fn
[context]
[arg*]
Subscribe a callback function to a custom event fired by this object or from an object that bubbles its events to this object.
Callback functions for events published with emitFacade = true will
receive an EventFacade as the first argument (typically named "e").
These callbacks can then call e.preventDefault() to disable the
behavior published to that event's defaultFn. See the EventFacade
API for all available properties and methods. Subscribers to
non-emitFacade events will receive the arguments passed to fire()
after the event name.
To subscribe to multiple events at once, pass an object as the first argument, where the key:value pairs correspond to the eventName:callback, or pass an array of event names as the first argument to subscribe to all listed events with the same callback.
Returning false from a callback is supported as an alternative to
calling e.preventDefault(); e.stopPropagation();. However, it is
recommended to use the event methods whenever possible.
oncetype
fn
[context]
[arg*]
Listen to a custom event hosted by this object one time.
This is the equivalent to on except the
listener is immediatelly detached when it is executed.
onceAftertype
fn
[context]
[arg*]
Listen to a custom event hosted by this object one time.
This is the equivalent to after except the
listener is immediatelly detached when it is executed.
parseTypetype
[pre=this._yuievt.config.prefix]
Takes the type parameter passed to 'on' and parses out the various pieces that could be included in the type. If the event type is passed without a prefix, it will be expanded to include the prefix one is supplied or the event target is configured with a default prefix.
previouscircular
Returns the Widget's previous sibling.
circular
Boolean
Boolean indicating if the parent's last child should be returned if the child has no previous sibling.
publishtype
opts
Creates a new custom event of the specified type. If a custom event by that name already exists, it will not be re-created. In either case the custom event is returned.
type
String
the type, or name of the event
opts
Object
optional config params. Valid properties are:
removeindex
Removes the Widget from its parent. Optionally, can remove a child by specifying its index.
index
Number
(Optional.) Number representing the index of the child to be removed.
removeAllRemoves all of the children from the Widget.
removeAttrname
Removes an attribute from the host object
name
String
The name of the attribute to be removed.
renderparentNode
Establishes the initial DOM for the widget. Invoking this method will lead to the creating of all DOM elements for the widget (or the manipulation of existing DOM elements for the progressive enhancement use case).
This method should only be invoked once for an initialized widget.
It delegates to the widget specific renderer method to do the actual work.
parentNode
Object | String
Optional. The Node under which the Widget is to be rendered. This can be a Node instance or a CSS selector string.
If the selector string returns more than one Node, the first node will be used as the parentNode. NOTE: This argument is required if both the boundingBox and contentBox are not currently in the document. If it's not provided, the Widget will be rendered to the body of the current document in this case.
rendererCreates DOM (or manipulates DOM for progressive enhancement) This method is invoked by render() and is not chained automatically for the class hierarchy (unlike initializer, destructor) so it should be chained manually for subclasses if required.
renderUIAdds nodes to the DOM
This method is not called by framework and is not chained automatically for the class hierarchy.
resetname
Resets the attribute (or all attributes) to its initial value, as long as the attribute is not readOnly, or writeOnce.
name
String
Optional. The name of the attribute to reset. If omitted, all attributes are reset.
selectAllSelects all children.
selectChildi
Selects the child at the given index (zero-based).
i
Number
the index of the child to be selected
setname
value
Sets the value of an attribute.
name
String
The name of the attribute. If the
current value of the attribute is an Object, dot notation can be used
to set the value of a property within the object (e.g. set("x.y.z", 5)).
value
Any
The value to set the attribute to.
setAttrsattrs
Sets multiple attribute values.
attrs
Object
An object with attributes name/value pairs.
showShows the Widget by setting the "visible" attribute to "true".
subscribesubscribe to an event
syncUIRefreshes the rendered UI, based on Widget State
This method is not called by framework and is not chained automatically for the class hierarchy.
toStringGeneric toString implementation for all widgets.
unsubscribedetach a listener
unsubscribeAlltype
Removes all listeners from the specified event. If the event type is not specified, all listeners from all hosted custom events will be removed.
type
String
The type, or name of the event
_allowAdHocAttrsThis property controls whether or not instances of this class should allow users to add ad-hoc attributes through the constructor configuration hash.
AdHoc attributes are attributes which are not defined by the class, and are not handled by the MyClass.NONATTRS_CFG
Default: undefined (false)
_childrenContainerBy default WidgetParent will render it's children to the parent's content box.
If the children need to be rendered somewhere else, the _childrenContainer property can be set to the Node which the children should be rendered to. This property should be set before the _renderChildren method is invoked, ideally in your renderUI method, as soon as you create the element to be rendered to.
_UI_ATTRSThe lists of UI attributes to bind and sync for widget's _bindUI and _syncUI implementations
CONTENT_TEMPLATEProperty defining the markup template for content box. If your Widget doesn't need the dual boundingBox/contentBox structure, set CONTENT_TEMPLATE to null, and contentBox and boundingBox will both point to the same Node.
boundingBoxThe outermost DOM node for the Widget, used for sizing and positioning of a Widget as well as a containing element for any decorator elements used for skinning.
checkOnLabelClickWhether to change node checked state on label clicks with addition to checkbox control clicks
contentBoxA DOM node that is a direct descendant of a Widget's bounding box that houses its content.
destroyedFlag indicating whether or not this object has been through the destroy lifecycle phase.
Default: false
disabledBoolean indicating if the Widget should be disabled. The disabled implementation is left to the specific classes extending widget.
Default: false
focusedBoolean indicating if the Widget, or one of its descendants, has focus.
Default: false
heightString with units, or number, representing the height of the Widget. If a number is provided, the default unit, defined by the Widgets DEF_UNIT, property is used.
Default: EMPTY_STR
initializedFlag indicating whether or not this object has been through the init lifecycle phase.
Default: false
loadOnDemandWhether children of this node can be loaded on demand (when this tree node is expanded, for example). Use with gallery-yui3treeview-ng-datasource.
localeThe default locale for the widget. NOTE: Using get/set on the "strings" attribute will return/set strings for this locale.
Default: "en"
multipleBoolean indicating if multiple children can be selected at
once. Whether or not multiple selection is enabled is always delegated
to the value of the multiple attribute of the root widget
in the object hierarchy.
Default: false
renderWhether or not to render the widget automatically after init, and optionally, to which parent node.
renderedFlag indicating whether or not this Widget has been through the render lifecycle phase.
Default: false
selectionReturns the currently selected child Widget. If the
mulitple attribte is set to true will
return an Y.ArrayList instance containing the currently selected
children. If no children are selected, will return null.
srcNodeThe DOM node to parse for configuration values, passed to the Widget's HTML_PARSER definition
tabIndexNumber (between -32767 to 32767) indicating the widget's position in the default tab flow. The value is used to set the "tabIndex" attribute on the widget's bounding box. Negative values allow the widget to receive DOM focus programmatically (by calling the focus method), while being removed from the default tab flow. A value of null removes the "tabIndex" attribute from the widget's bounding box.
Default: null
toggleOnLabelClickwhether to toogle tree state on label clicks with addition to toggle control clicks
addChildFires when a Widget is add as a child. The event object will have a 'child' property that returns a reference to the child Widget, as well as an 'index' property that returns a reference to the index specified when the add() method was called.
Subscribers to the "on" moment of this event, will be notified before a child is added.
Subscribers to the "after" moment of this event, will be notified after a child is added.
e
EventFacade
The Event Facade
checkFires when node checkbox state is changed
treenode
TreeNode
tree node that is checked
destroyLifecycle event for the destroy phase, fired prior to destruction. Invoking the preventDefault method on the event object provided to subscribers will prevent destruction from proceeding.
Subscribers to the "after" moment of this event, will be notified after destruction is complete (and as a result cannot prevent destruction).
e
EventFacade
Event object
initLifecycle event for the init phase, fired prior to initialization. Invoking the preventDefault() method on the event object provided to subscribers will prevent initialization from occuring.
Subscribers to the "after" momemt of this event, will be notified after initialization of the object is complete (and therefore cannot prevent initialization).
e
EventFacade
Event object, with a cfg property which refers to the configuration object passed to the constructor.
nodeClickFires when node is clicked
treenode
TreeNode
tree node that is being clicked
nodeCollapseFires when node is collapsed
treenode
TreeNode
tree node that is collapsing
nodeToggleFires when node is expanded / collapsed
treenode
TreeNode
tree node that is expanding / collapsing. Use this event to listed for nodes being clicked.
removeChildFires when a child Widget is removed. The event object will have a 'child' property that returns a reference to the child Widget, as well as an 'index' property that returns a reference child's ordinal position.
Subscribers to the "on" moment of this event, will be notified before a child is removed.
Subscribers to the "after" moment of this event, will be notified after a child is removed.
e
EventFacade
The Event Facade
widget:contentUpdateNotification event, which widget implementations can fire, when they change the content of the widget. This event has no default behavior and cannot be prevented, so the "on" or "after" moments are effectively equivalent (with on listeners being invoked before after listeners).
e
EventFacade
The Event Facade
widget:renderLifecycle event for the render phase, fired prior to rendering the UI for the widget (prior to invoking the widget's renderer method).
Subscribers to the "on" moment of this event, will be notified before the widget is rendered.
Subscribers to the "after" moment of this event, will be notified after rendering is complete.
e
EventFacade
The Event Facade