Menu.Base Class
Base menu functionality.
Constructor
Menu.Base
-
[config]
Parameters:
-
[config]Object optionalConfig options.
-
[items]Menu.Item[] | Object[] optionalArray of
Menu.Iteminstances or menu item config objects to add to this menu.
-
Item Index
Methods
- _addAttrs
- _addLazyAttr
- _addOutOfOrder
- _adoptNode
- _aggregateAttrs
- _attrCfgHash
- _baseDestroy
- _baseInit
- _cloneDefaultValue
- _composeNodeClass
- _defAttrChangeFn
- _defDestroyFn
- _defDisableFn
- _defEnableFn
- _defHideFn
- _defInitFn
- _defShowFn
- _destroyHierarchy
- _filterAdHocAttrs
- _fireAttrChange
- _fireTreeEvent
- _getAttr
- _getAttrCfg
- _getAttrCfgs
- _getAttrInitVal
- _getAttrs
- _getClasses
- _getDefaultNodeIndex
- _getFullType
- _getInstanceAttrCfgs
- _getStateVal
- _getType
- _hasPotentialSubscribers
- _initAttrHost
- _initAttribute
- _initAttrs
- _initBase
- _initHierarchy
- _initHierarchyData
- _isLazyAttr
- _monitor
- _normAttrVals
- _parseType
- _preInitEventCfg
- _protectAttrs deprecated
- _publish
- _removeNodeFromParent
- _set
- _setAttr
- _setAttrs
- _setAttrVal
- _setStateVal
- addAttr
- addAttrs
- addTarget
- after
- appendNode
- attrAdded
- before
- bubble
- clear
- closeSubMenus
- createNode
- destroy
- destroyNode
- detach
- detachAll
- disableItem
- emptyNode
- enableItem
- findNode
- fire
- get
- getAttrs
- getEvent
- getNodeById
- getTargets
- hideItem
- init
- insertNode
- modifyAttr
- on
- once
- onceAfter
- parseType
- prependNode
- publish
- removeAttr
- removeNode
- removeTarget
- reset
- set
- setAttrs
- showItem
- size
- subscribe deprecated
- toJSON
- toString
- traverseNode
- unsubscribe deprecated
- unsubscribeAll deprecated
Properties
Attributes
Methods
_addAttrs
-
cfgs -
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).
Parameters:
-
cfgsObjectAn object with attribute name/configuration pairs.
-
valuesObjectAn 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.
-
lazyBooleanWhether 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.
_addLazyAttr
-
name -
[lazyCfg]
Finishes initializing an attribute which has been lazily added.
_addOutOfOrder
-
name -
cfg
Utility method used by get/set to add attributes encountered out of order when calling addAttrs().
For example, if:
this.addAttrs({
foo: {
setter: function() {
// make sure this bar is available when foo is added
this.get("bar");
}
},
bar: {
value: ...
}
});_adoptNode
-
node -
[options]
Moves the specified node and all its children from another tree to this tree.
_aggregateAttrs
-
allAttrs
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).
Parameters:
-
allAttrsArrayAn array of ATTRS definitions across classes in the hierarchy (subclass first, Base last)
Returns:
The aggregate set of ATTRS definitions for the instance
_attrCfgHash
()
private
Utility method to define the attribute hash used to filter/whitelist property mixes for this class for iteration performance reasons.
_baseDestroy
()
private
Internal destroy implementation for BaseCore
_baseInit
()
private
Internal initialization implementation for BaseCore
_cloneDefaultValue
-
cfg
This method assumes that the value has already been checked to be an object. Since it's on a critical path, we don't want to re-do the check.
Parameters:
-
cfgObject
_composeNodeClass
()
protected
Composes a custom late-bound tree node class (if necessary) based on the
classes specified in this Tree's nodeClass and nodeExtensions
properties.
The composed class is stored in this Tree's _nodeClass property. If
composition wasn't necessary, then _nodeClass will just be a reference to
nodeClass.
_defAttrChangeFn
-
e -
eventFastPath
Default function for attribute change events.
Parameters:
-
eEventFacadeThe event object for attribute change events.
-
eventFastPathBooleanWhether or not we're using this as a fast path in the case of no listeners or not
_defInitFn
-
e
Default init event handler
Parameters:
-
eEventFacadeEvent object, with a cfg property which refers to the configuration object passed to the constructor.
_destroyHierarchy
()
private
Destroys the class hierarchy for this instance by invoking the destructor method on the prototype of each class in the hierarchy.
_filterAdHocAttrs
-
allAttrs -
userVals
Parameters:
-
allAttrsObjectThe 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.
-
userValsObjectThe config object passed in by the user, from which adhoc attrs are to be filtered.
Returns:
The set of adhoc attributes passed in, in the form of an object with attribute name/configuration pairs.
_fireAttrChange
-
attrName -
subAttrName -
currVal -
newVal -
opts -
[cfg]
Utility method to help setup the event payload and fire the attribute change event.
Parameters:
-
attrNameStringThe name of the attribute
-
subAttrNameStringThe full path of the property being changed, if this is a sub-attribute value being change. Otherwise null.
-
currValAnyThe current value of the attribute
-
newValAnyThe new value of the attribute
-
optsObjectAny additional event data to mix into the attribute change event's event facade.
-
[cfg]Object optionalThe attribute config stored in State, if already available.
_fireTreeEvent
-
name -
facade -
[options]
Utility method for lazily publishing and firing events.
_getAttr
-
name
Provides the common implementation for the public get method, allowing Attribute hosts to over-ride either method.
See get for argument details.
Parameters:
-
nameStringThe name of the attribute.
Returns:
The value of the attribute.
_getAttrCfg
-
name
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.
Parameters:
-
nameStringOptional. The attribute name. If not provided, the method will return the configuration for all attributes.
Returns:
The configuration properties for the given attribute, or all attributes.
_getAttrCfgs
()
Object
protected
Returns an aggregated set of attribute configurations, by traversing the class hierarchy.
Returns:
The hash of attribute configurations, aggregated across classes in the hierarchy This value is cached the first time the method, or _getClasses, is invoked. Subsequent invocations return the cached value.
_getAttrInitVal
-
attr -
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.
Parameters:
Returns:
The initial value of the attribute.
_getAttrs
-
attrs
Implementation behind the public getAttrs method, to get multiple attribute values.
Parameters:
-
attrsArray | booleanOptional. 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.
Returns:
An object with attribute name/value pairs.
_getClasses
()
Function[]
protected
Returns the class hierarchy for this object, with BaseCore being the last class in the array.
Returns:
An array of classes (constructor functions), making up the class hierarchy for this object. This value is cached the first time the method, or _getAttrCfgs, is invoked. Subsequent invocations return the cached value.
_getDefaultNodeIndex
-
parent -
node -
[options]
Returns the default insertion index that should be used when node is inserted as a child of parent without an explicit index.
The primary purpose of this method is to serve as a hook point for extensions and plugins that need to customize insertion order.
Parameters:
Returns:
Index at which node should be inserted into parent's
children array.
_getFullType
-
type
Returns the fully qualified type, given a short type string. That is, returns "foo:bar" when given "bar" if "foo" is the configured prefix.
NOTE: This method, unlike _getType, does no checking of the value passed in, and is designed to be used with the low level _publish() method, for critical path implementations which need to fast-track publish for performance reasons.
Parameters:
-
typeStringThe short type to prefix
Returns:
The prefixed type, if a prefix is set, otherwise the type passed in
_getInstanceAttrCfgs
-
allCfgs
A helper method used to isolate the attrs config for this instance to pass to addAttrs,
from the static cached ATTRS for the class.
Parameters:
-
allCfgsObjectThe 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.
Returns:
The set of attributes to be added for this instance, suitable
for passing through to addAttrs.
_getStateVal
-
name -
[cfg]
Gets the stored value for the attribute, from either the internal state object, or the state proxy if it exits
Parameters:
Returns:
The stored value of the attribute
_getType
()
private
If the instance has a prefix attribute and the event type is not prefixed, the instance prefix is applied to the supplied type.
_hasPotentialSubscribers
-
fullType
Parameters:
-
fullTypeStringThe fully prefixed type name
Returns:
Whether the event has potential subscribers or not
_initAttrHost
-
attrs -
values -
lazy
Constructor logic for attributes. Initializes the host state, and sets up the inital attributes passed to the constructor.
Parameters:
-
attrsObjectThe 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.
-
valuesObjectThe 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.
-
lazyBooleanWhether or not to add attributes lazily (passed through to addAttrs).
_initAttribute
()
private
Initializes AttributeCore
_initAttrs
-
attrs -
values -
lazy
Utility method to set up initial attributes defined during construction, either through the constructor.ATTRS property, or explicitly passed in.
Parameters:
-
attrsObjectThe 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.
-
valuesObjectThe 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.
-
lazyBooleanWhether or not to add attributes lazily (passed through to addAttrs).
_initBase
-
config
Internal construction logic for BaseCore.
Parameters:
-
configObjectThe constructor configuration object
_initHierarchy
-
userVals
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.
Parameters:
-
userValsObjectObject with configuration property name/value pairs
_initHierarchyData
()
private
A 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.
_isLazyAttr
-
name
Checks whether or not the attribute is one which has been added lazily and still requires initialization.
Parameters:
-
nameStringThe name of the attribute
Returns:
true if it's a lazily added attribute, false otherwise.
_monitor
-
what -
eventType -
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 -> click_attach, click_detach, 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.
Parameters:
-
whatString'attach', 'detach', 'fire', or 'publish'
-
eventTypeString | CustomEventThe prefixed name of the event being monitored, or the CustomEvent object.
-
oObjectInformation about the event interaction, such as fire() args, subscription category, publish config
_normAttrVals
-
valueHash
Utility method to normalize attribute values. The base implementation simply merges the hash to protect the original.
Parameters:
-
valueHashObjectAn object with attribute name/value pairs
Returns:
An object literal with 2 properties - "simple" and "complex", containing simple and complex attribute values respectively keyed by the top level attribute name, or null, if valueHash is falsey.
_parseType
()
private
Returns an array with the detach key (if provided), and the prefixed event name from _getType Y.on('detachcategory| menu:click', fn)
_preInitEventCfg
-
config
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.
Parameters:
-
configObjectThe user configuration object
_protectAttrs
-
attrs
Utility method to protect an attribute configuration hash, by merging the entire object and the individual attr config objects.
Parameters:
-
attrsObjectA hash of attribute to configuration object pairs.
Returns:
A protected version of the attrs argument.
_publish
-
fullType -
etOpts -
ceOpts
The low level event publish implementation. It expects all the massaging to have been done
outside of this method. e.g. the type to fullType conversion. It's designed to be a fast
path publish, which can be used by critical code paths to improve performance.
Parameters:
Returns:
The published event. If called without etOpts or ceOpts, this will
be the default CustomEvent instance, and can be configured independently.
_removeNodeFromParent
-
node
Removes the specified node from its parent node if it has one.
Parameters:
-
nodeTree.NodeNode to remove.
_set
-
name -
val -
[opts]
Allows setting of readOnly/writeOnce attributes. See set for argument details.
Parameters:
Returns:
A reference to the host object.
_setAttr
-
name -
value -
[opts] -
force
Provides the common implementation for the public set and protected _set methods.
See set for argument details.
Parameters:
Returns:
A reference to the host object.
_setAttrs
-
attrs -
[opts]
Implementation behind the public setAttrs method, to set multiple attribute values.
Parameters:
Returns:
A reference to the host object.
_setAttrVal
-
attrName -
subAttrName -
prevVal -
newVal -
[opts] -
[attrCfg]
Updates the stored value of the attribute in the privately held State object, if validation and setter passes.
Parameters:
-
attrNameStringThe attribute name.
-
subAttrNameStringThe sub-attribute name, if setting a sub-attribute property ("x.y.z").
-
prevValAnyThe currently stored value of the attribute.
-
newValAnyThe value which is going to be stored.
-
[opts]Object optionalOptional data providing the circumstances for the change.
-
[attrCfg]Object optionalOptional config hash for the attribute. This is added for performance along the critical path, where the calling method has already obtained the config from state.
Returns:
true if the new attribute value was stored, false if not.
_setStateVal
-
name -
value
Sets the stored value for the attribute, in either the internal state object, or the state proxy if it exits
Parameters:
-
nameStringThe name of the attribute
-
valueAnyThe value of the attribute
addAttr
-
name -
config -
lazy
Adds an attribute with the provided configuration to the host object.
The config argument object supports the following properties:
- value <Any>
- The initial value to set on the attribute
- valueFn <Function | String>
-
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.
- readOnly <boolean>
- Whether or not the attribute is read only. Attributes having readOnly set to true cannot be modified by invoking the set method.
- writeOnce <boolean> or <string>
-
Whether or not the attribute is "write once". Attributes having writeOnce set to true,
can only have their values set once, be it through the default configuration,
constructor configuration arguments, or by invoking set.
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)
- setter <Function | String>
-
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.
- getter <Function | String>
-
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.
- validator <Function | String>
-
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.
- lazyAdd <boolean>
- Whether or not to delay initialization of the attribute until the first call to get/set it. This flag can be used to over-ride lazy initialization on a per attribute basis, when adding multiple attributes through the addAttrs method.
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.
Parameters:
-
nameStringThe name of the attribute.
-
configObjectAn 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.
-
lazyBoolean(optional) Whether or not to add this attribute lazily (on the first call to get/set).
Returns:
A reference to the host object.
addAttrs
-
cfgs -
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.
Parameters:
-
cfgsObjectAn object with attribute name/configuration pairs.
-
valuesObjectAn 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.
-
lazyBooleanWhether 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.
Returns:
A reference to the host object.
addTarget
-
o
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.
Parameters:
-
oEventTargetthe target to add
after
-
type -
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.
Parameters:
Returns:
A subscription handle capable of detaching the subscription
appendNode
-
parent -
node -
[options]
Appends a node or array of nodes as the last child of the specified parent node.
If a node being appended is from another tree, it and all its children will be removed from that tree and moved to this one.
Parameters:
-
parentTree.NodeParent node.
-
nodeObject | Object[] | Tree.Node | Tree.Node[]Child node, node config object, array of child nodes, or array of node config objects to append to the given parent. Node config objects will automatically be converted into node instances.
-
[options]Object optionalOptions.
-
[silent=false]Boolean optionalIf
true, theaddevent will be suppressed.
-
Returns:
Node or array of nodes that were appended.
attrAdded
-
name
Checks if the given attribute has been added to the host
Parameters:
-
nameStringThe name of the attribute to check.
Returns:
true if an attribute with the given name has been added, false if it hasn't. This method will return true for lazily added attributes.
before
()
Executes 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
Returns:
detach handle
bubble
-
evt
Propagate an event. Requires the event-custom-complex module.
Parameters:
-
evtCustomEventthe custom event to propagate
Returns:
the aggregated return value from Event.Custom.fire
clear
-
[rootNode] -
[options]
Clears this tree by destroying the root node and all its children. If a
rootNode argument is provided, that node will become the root node of this
tree; otherwise, a new root node will be created.
Parameters:
-
[rootNode]Object | Tree.Node optionalIf specified, this node will be used as the new root node.
-
[options]Object optionalOptions.
-
[silent=false]Boolean optionalIf
true, theclearevent will be suppressed. -
[src]String optionalSource of the change, to be passed along to the event facade of the resulting event. This can be used to distinguish between changes triggered by a user and changes triggered programmatically, for example.
-
closeSubMenus
()
chainable
Closes all open submenus of this menu.
createNode
-
[config]
Creates and returns a new Tree.Node instance associated with (but not
yet appended to) this tree.
Parameters:
Returns:
New node, or null if a node could not be created
from the given config.
destroy
()
BaseCore
chainable
Destroy lifecycle method. Invokes destructors for the class hierarchy.
Returns:
A reference to this object
destroyNode
-
node -
[options]
Removes and destroys a node and all its child nodes. Once destroyed, a node is eligible for garbage collection and cannot be reused or re-added to the tree.
Parameters:
-
nodeTree.NodeNode to destroy.
-
[options]Object optionalOptions.
-
[silent=false]Boolean optionalIf
true,removeevents will be suppressed. -
[src]String optionalSource of the change, to be passed along to the event facade of the resulting events. This can be used to distinguish between changes triggered by a user and changes triggered programmatically, for example.
-
detach
-
type -
fn -
context
Detach one or more listeners the from the specified event
Parameters:
-
typeString | ObjectEither 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.
-
fnFunctionThe subscribed function to unsubscribe, if not supplied, all subscribers will be removed.
-
contextObjectThe 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)
Returns:
the host
detachAll
-
type
Removes all listeners from the specified event. If the event type is not specified, all listeners from all hosted custom events will be removed.
Parameters:
-
typeStringThe type, or name of the event
disableItem
-
item -
[options]
Disables the specified menu item.
emptyNode
-
node -
[options]
Removes all children from the specified node. The removed children will
still be reusable unless the destroy option is truthy.
Parameters:
-
nodeTree.NodeNode to empty.
-
[options]Object optionalOptions.
-
[destroy=false]Boolean optionalIf
true, the children will also be destroyed, which makes them available for garbage collection and means they can't be reused. -
[silent=false]Boolean optionalIf
true,removeevents will be suppressed. -
[src]String optionalSource of the change, to be passed along to the event facade of the resulting events. This can be used to distinguish between changes triggered by a user and changes triggered programmatically, for example.
-
Returns:
Array of removed child nodes.
enableItem
-
item -
[options]
Enables the specified menu item.
findNode
-
node -
[options] -
callback -
[thisObj]
Performs a depth-first traversal of node, passing it and each of its descendants to the specified callback, and returning the first node for which the callback returns a truthy value.
Traversal will stop as soon as a truthy value is returned from the callback.
See traverseNode() for more details on how depth-first traversal works.
Parameters:
-
nodeTree.NodeNode to traverse.
-
[options]Object optionalOptions.
-
[depth]Number optionalDepth limit. If specified, descendants will only be traversed to this depth before backtracking and moving on.
-
-
callbackFunctionCallback function to call with the traversed node and each of its descendants. If this function returns a truthy value, traversal will be stopped and the current node will be returned.
-
nodeTree.NodeNode being traversed.
-
-
[thisObj]Object optionalthisobject to use when executing callback.
Returns:
Returns the first node for which the callback
returns a truthy value, or null if the callback never returns a truthy
value.
fire
-
type -
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.
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.
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.
Parameters:
-
typeString | ObjectThe type of the event, or an object that contains a 'type' property.
-
argumentsObject*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.
Returns:
True if the whole lifecycle of the event went through, false if at any point the event propagation was halted.
get
-
name
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.
Parameters:
-
nameStringThe 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"))
Returns:
The value of the attribute
getAttrs
-
attrs
Gets multiple attribute values.
Parameters:
-
attrsArray | booleanOptional. 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.
Returns:
An object with attribute name/value pairs.
getEvent
-
type -
prefixed
Returns the custom event of the provided type has been created, a falsy value otherwise
Parameters:
Returns:
the custom event or null
getNodeById
-
id
Returns the tree node with the specified id, or undefined if the node
doesn't exist in this tree.
Parameters:
-
idStringNode id.
Returns:
Node, or undefined if not found.
getTargets
()
Returns an array of bubble targets for this object.
Returns:
EventTarget[]
hideItem
-
item -
[options]
Hides the specified menu item.
init
-
cfg
Init lifecycle method, invoked during construction. Sets up attributes and invokes initializers for the class hierarchy.
Parameters:
-
cfgObjectObject with configuration property name/value pairs
Returns:
A reference to this object
insertNode
-
parent -
node -
[options]
Inserts a node or array of nodes at the specified index under the given parent node, or appends them to the parent if no index is specified.
If a node being inserted is from another tree, it and all its children will be removed from that tree and moved to this one.
Parameters:
-
parentTree.NodeParent node.
-
nodeObject | Object[] | Tree.Node | Tree.Node[]Child node, node config object, array of child nodes, or array of node config objects to insert under the given parent. Node config objects will automatically be converted into node instances.
-
[options]Object optionalOptions.
-
[index]Number optionalIndex at which to insert the child node. If not specified, the node will be appended as the last child of the parent.
-
[silent=false]Boolean optionalIf
true, theaddevent will be suppressed. -
[src='insert']String optionalSource of the change, to be passed along to the event facade of the resulting event. This can be used to distinguish between changes triggered by a user and changes triggered programmatically, for example.
-
Returns:
Node or array of nodes that were inserted.
modifyAttr
-
name -
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.
on
-
type -
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.
Parameters:
Returns:
A subscription handle capable of detaching that subscription
once
-
type -
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.
Parameters:
Returns:
A subscription handle capable of detaching the subscription
onceAfter
-
type -
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.
Parameters:
Returns:
A subscription handle capable of detaching that subscription
parseType
-
type -
[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.
Returns:
an array containing: the detach category, if supplied, the prefixed event type, whether or not this is an after listener, the supplied event type
prependNode
-
parent -
node -
[options]
Prepends a node or array of nodes at the beginning of the specified parent node.
If a node being prepended is from another tree, it and all its children will be removed from that tree and moved to this one.
Parameters:
-
parentTree.NodeParent node.
-
nodeObject | Object[] | Tree.Node | Tree.Node[]Child node, node config object, array of child nodes, or array of node config objects to prepend to the given parent. Node config objects will automatically be converted into node instances.
-
[options]Object optionalOptions.
-
[silent=false]Boolean optionalIf
true, theaddevent will be suppressed.
-
Returns:
Node or array of nodes that were prepended.
publish
-
type -
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.
Parameters:
-
typeStringthe type, or name of the event
-
optsObjectoptional config params. Valid properties are:
- 'broadcast': whether or not the YUI instance and YUI global are notified when the event is fired (false)
- 'bubbles': whether or not this event bubbles (true) Events can only bubble if emitFacade is true.
- 'context': the default execution context for the listeners (this)
- 'defaultFn': the default function to execute when this event fires if preventDefault was not called
- 'emitFacade': whether or not this event emits a facade (false)
- 'prefix': the prefix for this targets events, e.g., 'menu' in 'menu:click'
- 'fireOnce': if an event is configured to fire once, new subscribers after the fire will be notified immediately.
- 'async': fireOnce event listeners will fire synchronously if the event has already fired unless async is true.
- 'preventable': whether or not preventDefault() has an effect (true)
- 'preventedFn': a function that is executed when preventDefault is called
- 'queuable': whether or not this event can be queued during bubbling (false)
- 'silent': if silent is true, debug messages are not provided for this event.
- 'stoppedFn': a function that is executed when stopPropagation is called
- 'monitored': specifies whether or not this event should send notifications about when the event has been attached, detached, or published.
- 'type': the event type (valid option if not provided as the first parameter to publish)
Returns:
the custom event
removeAttr
-
name
Removes an attribute from the host object
Parameters:
-
nameStringThe name of the attribute to be removed.
removeNode
-
node -
[options]
Removes the specified node from its parent node. The removed node will still
be reusable unless the destroy option is truthy.
Parameters:
-
nodeTree.NodeNode to remove.
-
[options]Object optionalOptions.
-
[destroy=false]Boolean optionalIf
true, the node and all its children will also be destroyed, which makes them available for garbage collection and means they can't be reused. -
[silent=false]Boolean optionalIf
true, theremoveevent will be suppressed. -
[src]String optionalSource of the change, to be passed along to the event facade of the resulting event. This can be used to distinguish between changes triggered by a user and changes triggered programmatically, for example.
-
Returns:
Node that was removed.
reset
-
name
Resets the attribute (or all attributes) to its initial value, as long as the attribute is not readOnly, or writeOnce.
Parameters:
-
nameStringOptional. The name of the attribute to reset. If omitted, all attributes are reset.
Returns:
A reference to the host object.
set
-
name -
value -
[opts]
Sets the value of an attribute.
Parameters:
-
nameStringThe 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)). -
valueAnyThe value to set the attribute to.
-
[opts]Object optionalOptional data providing the circumstances for the change.
Returns:
A reference to the host object.
setAttrs
-
attrs -
[opts]
Sets multiple attribute values.
Parameters:
Returns:
A reference to the host object.
showItem
-
item -
[options]
Shows the specified menu item.
size
()
Number
Returns the total number of nodes in this tree, at all levels.
Use rootNode.children.length to get only the number of top-level nodes.
Returns:
Total number of nodes in this tree.
subscribe
()
deprecated
subscribe to an event
toJSON
()
Object
Serializes this tree to an object suitable for use in JSON.
Returns:
Serialized tree object.
toString
()
String
Default toString implementation. Provides the constructor NAME and the instance guid, if set.
Returns:
String representation for this object
traverseNode
-
node -
[options] -
callback -
[thisObj]
Performs a depth-first traversal of node, passing it and each of its descendants to the specified callback.
If the callback function returns Tree.STOP_TRAVERSAL, traversal will be
stopped immediately. Otherwise, it will continue until the deepest
descendant of node has been traversed, or until each branch has been
traversed to the optional maximum depth limit.
Since traversal is depth-first, that means nodes are traversed like this:
1
/ | \
2 8 9
/ \ \
3 7 10
/ | \ / \
4 5 6 11 12Parameters:
-
nodeTree.NodeNode to traverse.
-
[options]Object optionalOptions.
-
[depth]Number optionalDepth limit. If specified, descendants will only be traversed to this depth before backtracking and moving on.
-
-
callbackFunctionCallback function to call with the traversed node and each of its descendants.
-
nodeTree.NodeNode being traversed.
-
-
[thisObj]Object optionalthisobject to use when executing callback.
Returns:
Returns Tree.STOP_TRAVERSAL if traversal was stopped;
otherwise returns undefined.
unsubscribe
()
deprecated
detach a listener
unsubscribeAll
-
type
Removes all listeners from the specified event. If the event type is not specified, all listeners from all hosted custom events will be removed.
Parameters:
-
typeStringThe type, or name of the event
Properties
_allowAdHocAttrs
Boolean
protected
This 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._NON_ATTRS_CFG
Default: undefined (false)
_nodeClass
Tree.Node
protected
Composed node class based on nodeClass that mixes in any extensions
specified in nodeExtensions. If there are no extensions, this will just be
a reference to nodeClass.
children
Tree.Node[]
Reference to the children array of this Tree's rootNode.
This is a convenience property to allow you to type tree.children instead
of tree.rootNode.children.
nodeClass
String | Tree.Node
The Tree.Node class or subclass that should be used for nodes created by
this tree.
You may specify an actual class reference or a string that resolves to a class reference at runtime.
Default: Y.Tree.Node
nodeExtensions
Array
Optional array containing one or more extension classes that should be mixed
into the nodeClass when this Tree is instantiated. The resulting composed
node class will be unique to this Tree instance and will not affect any
other instances, nor will it modify the defined nodeClass itself.
This provides a late-binding extension mechanism for nodes that doesn't
require them to extend Y.Base, which would incur a significant performance
hit.
Default: []
Attributes
destroyed
Boolean
readonly
Flag indicating whether or not this object has been through the destroy lifecycle phase.
Default: false
Fires event destroyedChange
Fires when the value for the configuration attribute destroyed 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:
-
eEventFacadeAn Event Facade object with the following attribute-specific properties added:
initialized
Boolean
readonly
Flag indicating whether or not this object has been through the init lifecycle phase.
Default: false
Fires event initializedChange
Fires when the value for the configuration attribute initialized 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:
-
eEventFacadeAn Event Facade object with the following attribute-specific properties added:
Events
add
Fired when a node is added to this Tree. The src property will indicate
how the node was added ("append", "insert", "prepend", etc.).
clear
Fired when this Tree is cleared.
destroy
Lifecycle 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).
Event Payload:
-
eEventFacadeEvent object
disable
Fired when a menu item is disabled.
Event Payload:
-
itemMenu.ItemMenu item that was disabled.
init
Lifecycle 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).
Event Payload:
-
eEventFacadeEvent object, with a cfg property which refers to the configuration object passed to the constructor.
remove
Fired when a node is removed from this Tree.