Plugin.Menu Class

Uses

Plugin.Base

Extends Menu

Defined in: src/sm-menu/js/plugins/menu-plugin.js:8

Module: gallery-sm-menu-plugin
Parent Module: gallery-sm-menu

Node plugin that toggles a dropdown menu when the host node is clicked.

Example

YUI().use('menu-plugin', function (Y) {
    var button = Y.one('#button');

    // Plug a dropdown menu into the button.
    button.plug(Y.Plugin.Menu, {
        items: [
            {label: 'Item One'},
            {label: 'Item Two'},
            {label: 'Item Three'}
        ]
    });

    // The menu will automatically be displayed whenever the button is
    // clicked, but you can also toggle it manually.
    button.menu.toggleVisible();
});

Constructor

Index
Methods
Properties
Attributes
Events

Item Index

Methods

`_addAttrs`

(

cfgs
values
lazy

)

private

Inherited from AttributeCore: attribute/js/AttributeCore.js:854

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:

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.

`_addLazyAttr`

(

name
[lazyCfg]

)

private

Inherited from AttributeCore: attribute/js/AttributeCore.js:360

Finishes initializing an attribute which has been lazily added.

Parameters:

name Object

The name of the attribute
[lazyCfg] Object optional

Optional config hash for the attribute. This is added for performance along the critical path, where the calling method has already obtained lazy config from state.

`_addOutOfOrder`

(

name
cfg

)

private

Inherited from AttributeCore: attribute/js/AttributeCore.js:527

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: ...
     }
});

Parameters:

name String

attribute name
cfg Object

attribute configuration

`_adoptNode`

(

node
[options]

)

protected

Inherited from Tree: tree/js/tree.js:675

Moves the specified node and all its children from another tree to this tree.

Parameters:

node Tree.Node

Node to adopt.
[options] Object optional

Options to pass along to removeNode().

`_afterAdd`

(

)

protected

Inherited from Menu: src/sm-menu/js/menu.js:744

Handles add events for this menu.

Parameters:

e EventFacade

`_afterClear`

() protected

Inherited from Menu: src/sm-menu/js/menu.js:785

Handles clear events for this menu.

`_afterClose`

(

)

protected

Inherited from Menu: src/sm-menu/js/menu.js:827

Handles close events for this menu.

Parameters:

e EventFacade

`_afterContainerChange`

() protected

Inherited from View: app/js/view.js:357

Available since 3.5.0

Handles containerChange events. Detaches event handlers from the old container (if any) and attaches them to the new container.

Right now the container attr is initOnly so this event should only ever fire the first time the container is created, but in the future (once Y.App can handle it) we may allow runtime container changes.

`_afterDisable`

(

)

protected

Inherited from Menu: src/sm-menu/js/menu.js:852

Handles disable events for this menu.

Parameters:

e EventFacade

`_afterDocMouseDown`

(

)

protected

Inherited from Menu: src/sm-menu/js/menu.js:806

Handles mousedown events on the document.

Parameters:

e EventFacade

`_afterEnable`

(

)

protected

Inherited from Menu: src/sm-menu/js/menu.js:867

Handles enable events for this menu.

Parameters:

e EventFacade

`_afterHide`

(

)

protected

Inherited from Menu: src/sm-menu/js/menu.js:882

Handles hide events for this menu.

Parameters:

e EventFacade

`_afterOpen`

(

)

protected

Inherited from Menu: src/sm-menu/js/menu.js:898

Handles open events for this menu.

Parameters:

e EventFacade

`_afterOrientationChange`

(

)

protected

Inherited from Menu: src/sm-menu/js/menu.js:937

Handles orientationChange events for this menu.

Parameters:

e EventFacade

`_afterRemove`

(

)

protected

Inherited from Menu: src/sm-menu/js/menu.js:953

Handles remove events for this menu.

Parameters:

e EventFacade

`_afterShow`

(

)

protected

Inherited from Menu: src/sm-menu/js/menu.js:975

Handles show events for this menu.

Parameters:

e EventFacade

`_afterVisibleChange`

(

)

protected

Inherited from Menu: src/sm-menu/js/menu.js:991

Handles visibleChange events for this menu.

Parameters:

e EventFacade

`_aggregateAttrs`

(

allAttrs

)

Object private

Inherited from BaseCore: base/js/BaseCore.js:618

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:

allAttrs Array

An array of ATTRS definitions across classes in the hierarchy (subclass first, Base last)

Returns:

Object:

The aggregate set of ATTRS definitions for the instance

`_attachMenuEvents`

() protected

Inherited from Menu: src/sm-menu/js/menu.js:487

Attaches menu events.

`_attrCfgHash`

() private

Inherited from BaseCore: base/js/BaseCore.js:581

Utility method to define the attribute hash used to filter/whitelist property mixes for this class for iteration performance reasons.

`_baseDestroy`

() private

Inherited from BaseCore: base/js/BaseCore.js:364

Internal destroy implementation for BaseCore

`_baseInit`

() private

Inherited from BaseCore: base/js/BaseCore.js:336

Internal initialization implementation for BaseCore

`_cloneDefaultValue`

(

cfg

)

private

Inherited from BaseCore: base/js/BaseCore.js:592

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:

cfg Object

`_composeNodeClass`

() protected

Inherited from Tree: tree/js/tree.js:711

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

)

private

Inherited from AttributeObservable: attribute/js/AttributeObservable.js:185

Default function for attribute change events.

Parameters:

e EventFacade

The event object for attribute change events.
eventFastPath Boolean

Whether or not we're using this as a fast path in the case of no listeners or not

`_defDestroyFn`

(

)

protected

Inherited from BaseObservable: base/js/BaseObservable.js:202

Default destroy event handler

Parameters:

e EventFacade

Event object

`_defDisableFn`

(

)

protected

Inherited from Menu.Base: src/sm-menu/js/menu-base.js:170

Default handler for the disable event.

Parameters:

e EventFacade

`_defEnableFn`

(

)

protected

Inherited from Menu.Base: src/sm-menu/js/menu-base.js:181

Default handler for the enable event.

Parameters:

e EventFacade

`_defHideFn`

(

)

protected

Inherited from Menu.Base: src/sm-menu/js/menu-base.js:192

Default handler for the hide event.

Parameters:

e EventFacade

`_defInitFn`

(

)

protected

Inherited from BaseObservable: base/js/BaseObservable.js:190

Default init event handler

Parameters:

e EventFacade

Event object, with a cfg property which refers to the configuration object passed to the constructor.

`_defItemClickFn`

(

)

protected

Inherited from Menu: src/sm-menu/js/menu.js:1127

Default handler for the generic itemClick event.

Parameters:

e EventFacade

`_defShowFn`

(

)

protected

Inherited from Menu.Base: src/sm-menu/js/menu-base.js:203

Default handler for the show event.

Parameters:

e EventFacade

`_defSpecificItemClickFn`

(

)

protected

Inherited from Menu: src/sm-menu/js/menu.js:1148

Default handler for item-specific itemClick#<id> events.

Parameters:

e EventFacade

`_destroyContainer`

() protected

Inherited from View: app/js/view.js:312

Removes the container from the DOM and purges all its event listeners.

`_destroyHierarchy`

() private

Inherited from BaseCore: base/js/BaseCore.js:782

Destroys the class hierarchy for this instance by invoking the destructor method on the prototype of each class in the hierarchy.

`_detachMenuEvents`

() protected

Inherited from Menu: src/sm-menu/js/menu.js:523

Detaches menu events.

`_filterAdHocAttrs`

(

allAttrs
userVals

)

Object private

Inherited from BaseCore: base/js/BaseCore.js:470

Parameters:

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.

Returns:

Object:

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]

)

private

Inherited from AttributeObservable: attribute/js/AttributeObservable.js:120

Utility method to help setup the event payload and fire the attribute change event.

Parameters:

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.
[cfg] Object optional

The attribute config stored in State, if already available.

`_fireTreeEvent`

(

name
facade
[options]

)

protected chainable

Inherited from Tree: tree/js/tree.js:766

Utility method for lazily publishing and firing events.

Parameters:

name String

Event name to fire.
facade Object

Event facade.
[options] Object optional

Options.
- [defaultFn] Function optional
  
  Default handler for this event.
- [silent=false] Boolean optional
  
  Whether the default handler should be executed directly without actually firing the event.

`_getAncestorTestFn`

() Function protected

Inherited from Menu but overwritten in src/sm-menu/js/plugins/menu-plugin.js:100

Returns an efficient test function that can be passed to Y.Node#ancestor() to test whether a node is this menu's container or its plugin host.

This is broken out to make overriding easier in subclasses.

Returns:

Function:

Test function.

`_getAnchorRegion`

(

anchor
nodeRegion
parentRegion

)

Object protected

Inherited from Menu: src/sm-menu/js/menu.js:551

Given an anchor point and the regions currently occupied by a child node (the node being anchored) and a parent node (the node being anchored to), returns a region object representing the coordinates the anchored node will occupy when anchored to the given point on the parent.

An anchor point is a string like "tl-bl", which means "anchor the top left point of nodeRegion to the bottom left point of parentRegion".

Any combination of top/bottom/left/right anchor points may be used as long as they follow this format. Here are a few examples:

'bl-br': Anchor the bottom left of nodeRegion to the bottom right of parentRegion.
'br-bl': Anchor the bottom right of nodeRegion to the bottom left of parentRegion.
'tl-tr': Anchor the top left of nodeRegion to the top right of parentRegion.
'tr-tl': Anchor the top right of nodeRegion to the top left of parentRegion.

Parameters:

anchor String

Anchor point. See above for details.
nodeRegion Object

Region object for the node to be anchored (that is, the node that will be repositioned).
parentRegion Object

Region object for the node that will be anchored to (that is, the node that will not move).

Returns:

Object:

Region that will be occupied by the anchored node.

`_getAttr`

(

name

)

Any protected chainable

Inherited from AttributeCore: attribute/js/AttributeCore.js:564

Provides the common implementation for the public get method, allowing Attribute hosts to over-ride either method.

See get for argument details.

Parameters:

name String

The name of the attribute.

Returns:

Any:

The value of the attribute.

`_getAttrCfg`

(

name

)

Object protected

Inherited from AttributeExtras: attribute/js/AttributeExtras.js:114

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:

name String

Optional. The attribute name. If not provided, the method will return the configuration for all attributes.

Returns:

Object:

The configuration properties for the given attribute, or all attributes.

`_getAttrCfgs`

() Object protected

Inherited from BaseCore: base/js/BaseCore.js:394

Returns an aggregated set of attribute configurations, by traversing the class hierarchy.

Returns:

Object:

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

)

Any private

Inherited from AttributeCore: attribute/js/AttributeCore.js:963

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:

attr String

The name of the attribute
cfg Object

The attribute configuration object
initValues Object

The object with simple and complex attribute name/value pairs returned from _normAttrVals

Returns:

Any:

The initial value of the attribute.

`_getAttrs`

(

attrs

)

Object protected

Inherited from AttributeCore: attribute/js/AttributeCore.js:792

Implementation behind the public getAttrs method, to get multiple attribute values.

Parameters:

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.

Returns:

Object:

An object with attribute name/value pairs.

`_getClasses`

() Function[] protected

Inherited from BaseCore: base/js/BaseCore.js:378

Returns the class hierarchy for this object, with BaseCore being the last class in the array.

Returns:

Function[]:

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.

`_getContainer`

(

value

)

Node protected

Inherited from View: app/js/view.js:323

Available since 3.5.0

Getter for the container attribute.

Parameters:

value Node | Null

Current attribute value.

Returns:

Node:

Container node.

`_getDefaultNodeIndex`

(

parent
node
[options]

)

Number protected

Inherited from Tree: tree/js/tree.js:798

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:

parent Tree.Node

Parent node.
node Tree.Node

Node being inserted.
[options] Object optional

Options passed to insertNode().

Returns:

Number:

Index at which node should be inserted into parent's children array.

`_getFullType`

(

type

)

String private

Inherited from EventTarget: event-custom/js/event-target.js:586

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:

type String

The short type to prefix

Returns:

String:

The prefixed type, if a prefix is set, otherwise the type passed in

`_getInstanceAttrCfgs`

(

allCfgs

)

Object private

Inherited from BaseCore: base/js/BaseCore.js:411

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:

allCfgs 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.

Returns:

Object:

The set of attributes to be added for this instance, suitable for passing through to addAttrs.

`_getStateVal`

(

name
[cfg]

)

Any private

Inherited from AttributeCore: attribute/js/AttributeCore.js:618

Gets the stored value for the attribute, from either the internal state object, or the state proxy if it exits

Parameters:

name String

The name of the attribute
[cfg] Object optional

Optional 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:

Any:

The stored value of the attribute

`_getType`

() private

Inherited from EventTarget: event-custom/js/event-target.js:36

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

)

Boolean private

Inherited from EventTarget: event-custom/js/event-facade.js:643

Parameters:

fullType String

The fully prefixed type name

Returns:

Boolean:

Whether the event has potential subscribers or not

`_hideMenu`

(

item
[htmlNode]

)

protected

Inherited from Menu: src/sm-menu/js/menu.js:648

Hides the specified menu container by moving its htmlNode offscreen.

Parameters:

item Menu.Item

Menu item.
[htmlNode] Node optional

HTML node for the menu item.

`_initAttrHost`

(

attrs
values
lazy

)

private

Inherited from AttributeCore: attribute/js/AttributeCore.js:140

Constructor logic for attributes. Initializes the host state, and sets up the inital attributes passed to the constructor.

Parameters:

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).

`_initAttribute`

() private

Inherited from BaseObservable but overwritten in base/js/BaseCore.js:309

Initializes AttributeCore

`_initAttrs`

(

attrs
values
lazy

)

protected

Inherited from AttributeCore: attribute/js/AttributeCore.js:1029

Utility method to set up initial attributes defined during construction, either through the constructor.ATTRS property, or explicitly passed in.

Parameters:

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).

`_initBase`

(

config

)

private

Inherited from BaseCore: base/js/BaseCore.js:274

Internal construction logic for BaseCore.

Parameters:

config Object

The constructor configuration object

`_initHierarchy`

(

userVals

)

private

Inherited from BaseCore: base/js/BaseCore.js:702

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:

userVals Object

Object with configuration property name/value pairs

`_initHierarchyData`

() private

Inherited from BaseCore: base/js/BaseCore.js:500

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.

`_inRegion`

(

inner
outer

)

Boolean | Number protected

Inherited from Menu: src/sm-menu/js/menu.js:665

Returns true if the given inner region is contained entirely within the given outer region. If it's not a perfect fit, returns a numerical score indicating how much of the inner region fits within the outer region. A higher score indicates a better fit.

Parameters:

inner Object

Inner region.
outer Object

Outer region.

Returns:

Boolean | Number:

true if the inner region fits entirely within the outer region or, if not, a numerical score indicating how much of the inner region fits.

`_isLazyAttr`

(

name

)

Boolean private

Inherited from AttributeCore: attribute/js/AttributeCore.js:347

Checks whether or not the attribute is one which has been added lazily and still requires initialization.

Parameters:

name String

The name of the attribute

Returns:

Boolean:

true if it's a lazily added attribute, false otherwise.

`_monitor`

(

what
eventType
o

)

private

Inherited from EventTarget: event-custom/js/event-target.js:658

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:

what String

'attach', 'detach', 'fire', or 'publish'
eventType String | CustomEvent

The prefixed name of the event being monitored, or the CustomEvent object.
o Object

Information about the event interaction, such as fire() args, subscription category, publish config

`_normAttrVals`

(

valueHash

)

Object private

Inherited from AttributeCore: attribute/js/AttributeCore.js:915

Utility method to normalize attribute values. The base implementation simply merges the hash to protect the original.

Parameters:

valueHash Object

An object with attribute name/value pairs

Returns:

Object:

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.

`_onItemClick`

(

)

protected

Inherited from Menu: src/sm-menu/js/menu.js:1011

Handles click events on menu items.

Parameters:

e EventFacade

`_onItemMouseEnter`

(

)

protected

Inherited from Menu: src/sm-menu/js/menu.js:1051

Handles delegated mouseenter events on menu items.

Parameters:

e EventFacade

`_onItemMouseLeave`

(

)

protected

Inherited from Menu: src/sm-menu/js/menu.js:1072

Handles delegated mouseleave events on menu items.

Parameters:

e EventFacade

`_onMenuMouseEnter`

(

)

protected

Inherited from Menu: src/sm-menu/js/menu.js:1093

Handles mouseenter events on this menu.

Parameters:

e EventFacade

`_onMenuMouseLeave`

(

)

protected

Inherited from Menu: src/sm-menu/js/menu.js:1104

Handles mouseleave events on this menu.

Parameters:

e EventFacade

`_parseType`

() private

Inherited from EventTarget: event-custom/js/event-target.js:52

Returns an array with the detach key (if provided), and the prefixed event name from _getType Y.on('detachcategory| menu:click', fn)

`_positionMenu`

(

item
[htmlNode]

)

protected

Inherited from Menu: src/sm-menu/js/menu.js:700

Intelligently positions the htmlNode of the given submenu item relative to its parent so that as much as possible of the submenu will be visible within the viewport.

Parameters:

item Menu.Item

Menu item to position.
[htmlNode] Node optional

HTML node for the menu item.

`_preInitEventCfg`

(

config

)

private

Inherited from BaseObservable: base/js/BaseObservable.js:110

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:

config Object

The user configuration object

`_protectAttrs`

(

attrs

)

Object deprecated protected

Inherited from AttributeCore: attribute/js/AttributeCore.js:901

Deprecated: Use `AttributeCore.protectAttrs()` or `Attribute.protectAttrs()` which are the same static utility method.

Utility method to protect an attribute configuration hash, by merging the entire object and the individual attr config objects.

Parameters:

attrs Object

A hash of attribute to configuration object pairs.

Returns:

Object:

A protected version of the attrs argument.

`_publish`

(

fullType
etOpts
ceOpts

)

CustomEvent private

Inherited from EventTarget: event-custom/js/event-target.js:610

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:

fullType String

The prefixed type of the event to publish.
etOpts Object

The EventTarget specific configuration to mix into the published event.
ceOpts Object

The publish specific configuration to mix into the published event.

Returns:

CustomEvent:

The published event. If called without etOpts or ceOpts, this will be the default CustomEvent instance, and can be configured independently.

`_removeNodeFromParent`

(

node

)

protected

Inherited from Tree: tree/js/tree.js:817

Removes the specified node from its parent node if it has one.

Parameters:

node Tree.Node

Node to remove.

`_set`

(

name
val
[opts]

)

Object protected chainable

Inherited from AttributeObservable but overwritten in attribute/js/AttributeCore.js:405

Allows setting of readOnly/writeOnce attributes. See set for argument details.

Parameters:

name String

The name of the attribute.
val Any

The value to set the attribute to.
[opts] Object optional

Optional data providing the circumstances for the change.

Returns:

Object:

A reference to the host object.

`_setAttr`

(

name
value
[opts]
force

)

Object protected chainable

Inherited from AttributeCore: attribute/js/AttributeCore.js:421

Provides the common implementation for the public set and protected _set methods.

See set for argument details.

Parameters:

name String

The name of the attribute.
value Any

The value to set the attribute to.
[opts] Object optional

Optional data providing the circumstances for the change.
force Boolean

If true, allows the caller to set values for readOnly or writeOnce attributes which have already been set.

Returns:

Object:

A reference to the host object.

`_setAttrs`

(

attrs
[opts]

)

Object protected chainable

Inherited from AttributeObservable but overwritten in attribute/js/AttributeCore.js:760

Implementation behind the public setAttrs method, to set multiple attribute values.

Parameters:

attrs Object

An object with attributes name/value pairs.
[opts] Object optional

Optional data providing the circumstances for the change

Returns:

Object:

A reference to the host object.

`_setAttrVal`

(

attrName
subAttrName
prevVal
newVal
[opts]
[attrCfg]

)

Booolean private

Inherited from AttributeCore: attribute/js/AttributeCore.js:658

Updates the stored value of the attribute in the privately held State object, if validation and setter passes.

Parameters:

attrName String

The attribute name.
subAttrName String

The sub-attribute name, if setting a sub-attribute property ("x.y.z").
prevVal Any

The currently stored value of the attribute.
newVal Any

The value which is going to be stored.
[opts] Object optional

Optional data providing the circumstances for the change.
[attrCfg] Object optional

Optional 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:

Booolean:

true if the new attribute value was stored, false if not.

`_setStateVal`

(

name
value

)

private

Inherited from AttributeCore: attribute/js/AttributeCore.js:640

Sets the stored value for the attribute, in either the internal state object, or the state proxy if it exits

Parameters:

name String

The name of the attribute
value Any

The value of the attribute

`addAttr`

(

name
config
lazy

)

Object chainable

Inherited from AttributeCore: attribute/js/AttributeCore.js:157

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:

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).

Returns:

Object:

A reference to the host object.

`addAttrs`

(

cfgs
values
lazy

)

Object chainable

Inherited from AttributeCore: attribute/js/AttributeCore.js:823

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:

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.

Returns:

Object:

A reference to the host object.

`addTarget`

(

)

chainable

Inherited from EventTarget: event-custom/js/event-facade.js:496

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:

o EventTarget

the target to add

`after`

(

type
fn
[context]
[arg*]

)

EventHandle

Inherited from EventTarget: event-custom/js/event-target.js:834

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:

type String

The name of the event
fn Function

The callback to execute in response to the event
[context] Object optional

Override this object in callback
[arg*] Any optional

0..n additional arguments to supply to the subscriber

Returns:

EventHandle:

A subscription handle capable of detaching the subscription

`afterHostEvent`

(

type
fn
context

)

EventHandle

Inherited from Plugin.Base: plugin/js/plugin.js:186

Listens for the "after" moment of events fired by the host object.

Listeners attached through this method will be detached when the plugin is unplugged.

Parameters:

type String | Object

The event type.
fn Function

The listener.
context Object

The execution context. Defaults to the plugin instance.

Returns:

EventHandle:

handle The detach handle for the listener.

`afterHostMethod`

(

method
fn
context

)

EventHandle

Inherited from Plugin.Base: plugin/js/plugin.js:238

Injects a function to be executed after a given method on host object.

The function will be detached when the plugin is unplugged.

Parameters:

method String

The name of the method to inject the function after.
fn Function

The function to inject.
context Object

The execution context. Defaults to the plugin instance.

Returns:

EventHandle:

handle The detach handle for the injected function.

`appendNode`

(

parent
node
[options]

)

Tree.Node | Tree.Node[]

Inherited from Tree: tree/js/tree.js:205

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:

parent Tree.Node

Parent node.
node Object | 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 optional

Options.
- [silent=false] Boolean optional
  
  If true, the add event will be suppressed.

Returns:

Tree.Node | Tree.Node[]:

Node or array of nodes that were appended.

`attachEvents`

(

[events]

)

chainable

Inherited from View: app/js/view.js:181

Attaches delegated event handlers to this view's container element. This method is called internally to subscribe to events configured in the events attribute when the view is initialized.

You may override this method to customize the event attaching logic.

Parameters:

[events] Object optional

Hash of events to attach. See the docs for the events attribute for details on the format. If not specified, this view's events property will be used.

`attrAdded`

(

name

)

Boolean

Inherited from AttributeCore: attribute/js/AttributeCore.js:319

Checks if the given attribute has been added to the host

Parameters:

name String

The name of the attribute to check.

Returns:

Boolean:

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`

()

Inherited from EventTarget: event-custom/js/event-target.js:871

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

`beforeHostMethod`

(

method
fn
context

)

EventHandle

Inherited from Plugin.Base: plugin/js/plugin.js:221

Injects a function to be executed before a given method on host object.

The function will be detached when the plugin is unplugged.

Parameters:

method String

The name of the method to inject the function before.
fn Function

The function to inject.
context Object

The execution context. Defaults to the plugin instance.

Returns:

EventHandle:

handle The detach handle for the injected function.

`bubble`

(

evt

)

Boolean

Inherited from EventTarget: event-custom/js/event-facade.js:554

Propagate an event. Requires the event-custom-complex module.

Parameters:

evt CustomEvent

the custom event to propagate

Returns:

Boolean:

the aggregated return value from Event.Custom.fire

`clear`

(

[rootNode]
[options]

)

chainable

Inherited from Tree: tree/js/tree.js:231

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 optional

If specified, this node will be used as the new root node.
[options] Object optional

Options.
- [silent=false] Boolean optional
  
  If true, the clear event will be suppressed.
- [src] String optional
  
  Source 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

Inherited from Menu.Base: src/sm-menu/js/menu-base.js:69

Closes all open submenus of this menu.

`create`

(

[container]

)

Node

Inherited from View: app/js/view.js:233

Creates and returns a container node for this view.

By default, the container is created from the HTML template specified in the containerTemplate property, and is not added to the DOM automatically.

You may override this method to customize how the container node is created (such as by rendering it from a custom template format). Your method must return a Y.Node instance.

Parameters:

[container] HTMLElement | Node | String optional

Selector string, Y.Node instance, or DOM element to use at the container node.

Returns:

Node:

Node instance of the created container node.

`createNode`

(

[config]

)

Tree.Node | Null

Inherited from Tree: tree/js/tree.js:258

Creates and returns a new Tree.Node instance associated with (but not yet appended to) this tree.

Parameters:

[config] Object | Tree.Node optional

Node configuration. If a Tree.Node instance is specified instead of a config object, that node will be adopted into this tree (if it doesn't already belong to this tree) and removed from any other tree to which it belongs.

Returns:

Tree.Node | Null:

New node, or null if a node could not be created from the given config.

`destroy`

(

[options]

)

chainable

Inherited from BaseObservable but overwritten in app/js/view.js:146

Destroys this View, detaching any DOM events and optionally also destroying its container node.

By default, the container node will not be destroyed. Pass an options object with a truthy remove property to destroy the container as well.

Parameters:

[options] Object optional

Options.
- [remove=false] Boolean optional
  
  If true, this View's container will be removed from the DOM and destroyed as well.

`destroyNode`

(

node
[options]

)

chainable

Inherited from Tree: tree/js/tree.js:301

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:

node Tree.Node

Node to destroy.
[options] Object optional

Options.
- [silent=false] Boolean optional
  
  If true, remove events will be suppressed.
- [src] String optional
  
  Source 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.

`destructor`

()

Inherited from Plugin.Base: plugin/js/plugin.js:89

Destructor lifecycle implementation.

Removes any event listeners or injected methods applied by the Plugin

`detach`

(

type
fn
context

)

EventTarget

Inherited from EventTarget: event-custom/js/event-target.js:346

Detach one or more listeners the from the specified event

Parameters:

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)

Returns:

EventTarget:

the host

`detachAll`

(

type

)

Inherited from EventTarget: event-custom/js/event-target.js:469

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:

type String

The type, or name of the event

`detachEvents`

() chainable

Inherited from View: app/js/view.js:253

Detaches DOM events that have previously been attached to the container by attachEvents().

`disableItem`

(

item
[options]

)

chainable

Inherited from Menu.Base: src/sm-menu/js/menu-base.js:84

Disables the specified menu item.

Parameters:

item Menu.Item

Menu item to disable.
[options] Object optional

Options.
- [silent=false] Boolean optional
  
  If true, the disable event will be suppressed.

`doAfter`

(

strMethod
fn
context

)

EventHandle

Inherited from Plugin.Base: plugin/js/plugin.js:128

Listens for the "after" moment of events fired by the host, or injects code "after" a given method on the host.

Parameters:

strMethod String

The event to listen for, or method to inject logic after.
fn Function

The handler function. For events, the "after" moment listener. For methods, the function to execute after the given method is executed.
context Object

An optional context to call the handler with. The default context is the plugin instance.

Returns:

EventHandle:

handle The detach handle for the listener.

`doBefore`

(

strMethod
fn
context

)

EventHandle

Inherited from Plugin.Base: plugin/js/plugin.js:105

Listens for the "on" moment of events fired by the host, or injects code "before" a given method on the host.

Parameters:

strMethod String

The event to listen for, or method to inject logic before.
fn Function

The handler function. For events, the "on" moment listener. For methods, the function to execute before the given method is executed.
context Object

An optional context to call the handler with. The default context is the plugin instance.

Returns:

EventHandle:

handle The detach handle for the handler.

`emptyNode`

(

node
[options]

)

Tree.Node[]

Inherited from Tree: tree/js/tree.js:349

Removes all children from the specified node. The removed children will still be reusable unless the destroy option is truthy.

Parameters:

node Tree.Node

Node to empty.
[options] Object optional

Options.
- [destroy=false] Boolean optional
  
  If true, the children will also be destroyed, which makes them available for garbage collection and means they can't be reused.
- [silent=false] Boolean optional
  
  If true, remove events will be suppressed.
- [src] String optional
  
  Source 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:

Tree.Node[]:

Array of removed child nodes.

`enableItem`

(

item
[options]

)

chainable

Inherited from Menu.Base: src/sm-menu/js/menu-base.js:105

Enables the specified menu item.

Parameters:

item Menu.Item

Menu item to enable.
[options] Object optional

Options.
- [silent=false] Boolean optional
  
  If true, the enable event will be suppressed.

`findNode`

(

node
[options]
callback
[thisObj]

)

Tree.Node | Null

Inherited from Tree: tree/js/tree.js:378

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:

node Tree.Node

Node to traverse.
[options] Object optional

Options.
- [depth] Number optional
  
  Depth limit. If specified, descendants will only be traversed to this depth before backtracking and moving on.
callback Function

Callback 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.
- node Tree.Node
  
  Node being traversed.
[thisObj] Object optional

this object to use when executing callback.

Returns:

Tree.Node | Null:

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

)

Boolean

Inherited from EventTarget: event-custom/js/event-target.js:695

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:

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.

Returns:

Boolean:

True if the whole lifecycle of the event went through, false if at any point the event propagation was halted.

`get`

(

name

)

Any

Inherited from AttributeCore: attribute/js/AttributeCore.js:331

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:

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"))

Returns:

Any:

The value of the attribute

`getAttrs`

(

attrs

)

Object

Inherited from AttributeCore: attribute/js/AttributeCore.js:780

Gets multiple attribute values.

Parameters:

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.

Returns:

Object:

An object with attribute name/value pairs.

`getEvent`

(

type
prefixed

)

CustomEvent

Inherited from EventTarget: event-custom/js/event-target.js:815

Returns the custom event of the provided type has been created, a falsy value otherwise

Parameters:

type String

the type, or name of the event
prefixed String

if true, the type is prefixed already

Returns:

CustomEvent:

the custom event or null

`getHTMLNode`

(

item

)

Node

Inherited from Menu: src/sm-menu/js/menu.js:118

Returns the HTML node (as a Y.Node instance) associated with the specified menu item, if any.

Parameters:

item Menu.Item

Menu item.

Returns:

Node:

Y.Node instance associated with the given tree node, or undefined if one was not found.

`getNodeById`

(

id

)

Tree.Node

Inherited from Tree: tree/js/tree.js:424

Returns the tree node with the specified id, or undefined if the node doesn't exist in this tree.

Parameters:

id String

Node id.

Returns:

Tree.Node:

Node, or undefined if not found.

`getTargets`

()

Inherited from EventTarget: event-custom/js/event-facade.js:523

Returns an array of bubble targets for this object.

Returns:

EventTarget[]

`hide`

() chainable

Inherited from Menu: src/sm-menu/js/menu.js:135

Hides this menu.

`hideItem`

(

item
[options]

)

chainable

Inherited from Menu.Base: src/sm-menu/js/menu-base.js:126

Hides the specified menu item.

Parameters:

item Menu.Item

Menu item to hide.
[options] Object optional

Options.
- [silent=false] Boolean optional
  
  If true, the hide event will be suppressed.

`init`

(

cfg

)

BaseCore chainable

Inherited from BaseObservable but overwritten in base/js/BaseCore.js:319

Init lifecycle method, invoked during construction. Sets up attributes and invokes initializers for the class hierarchy.

Parameters:

cfg Object

Object with configuration property name/value pairs

Returns:

BaseCore:

A reference to this object

`initializer`

(

config

)

Inherited from Plugin.Base: plugin/js/plugin.js:77

Initializer lifecycle implementation.

Parameters:

config Object

Configuration object with property name/value pairs.

`insertNode`

(

parent
node
[options]

)

Tree.Node | Tree.Node[]

Inherited from Tree: tree/js/tree.js:436

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:

parent Tree.Node

Parent node.
node Object | 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 optional

Options.
- [index] Number optional
  
  Index 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 optional
  
  If true, the add event will be suppressed.
- [src='insert'] String optional
  
  Source 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:

Tree.Node | Tree.Node[]:

Node or array of nodes that were inserted.

`modifyAttr`

(

name
config

)

Inherited from AttributeExtras: attribute/js/AttributeExtras.js:40

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.

Parameters:

name String

The name of the attribute whose configuration is to be updated.
config Object

An object with configuration property/value pairs, specifying the configuration properties to modify.

`on`

(

type
fn
[context]
[arg*]

)

EventHandle

Inherited from EventTarget: event-custom/js/event-target.js:188

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:

type String

The name of the event
fn Function

The callback to execute in response to the event
[context] Object optional

Override this object in callback
[arg*] Any optional

0..n additional arguments to supply to the subscriber

Returns:

EventHandle:

A subscription handle capable of detaching that subscription

`once`

(

type
fn
[context]
[arg*]

)

EventHandle

Inherited from EventTarget: event-custom/js/event-target.js:124

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:

type String

The name of the event
fn Function

The callback to execute in response to the event
[context] Object optional

Override this object in callback
[arg*] Any optional

0..n additional arguments to supply to the subscriber

Returns:

EventHandle:

A subscription handle capable of detaching the subscription

`onceAfter`

(

type
fn
[context]
[arg*]

)

EventHandle

Inherited from EventTarget: event-custom/js/event-target.js:146

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:

type String

The name of the event
fn Function

The callback to execute in response to the event
[context] Object optional

Override this object in callback
[arg*] Any optional

0..n additional arguments to supply to the subscriber

Returns:

EventHandle:

A subscription handle capable of detaching that subscription

`onceAfterHostEvent`

(

type
fn
context

)

EventHandle

Inherited from Plugin.Base: plugin/js/plugin.js:203

Listens for the "after" moment of events fired by the host object one time only. The listener is immediately detached when it is executed.

Listeners attached through this method will be detached when the plugin is unplugged.

Parameters:

type String | Object

The event type.
fn Function

The listener.
context Object

The execution context. Defaults to the plugin instance.

Returns:

EventHandle:

handle The detach handle for the listener.

`onceHostEvent`

(

type
fn
context

)

EventHandle

Inherited from Plugin.Base: plugin/js/plugin.js:168

Listens for the "on" moment of events fired by the host object one time only. The listener is immediately detached when it is executed.

Listeners attached through this method will be detached when the plugin is unplugged.

Parameters:

type String | Object

The event type.
fn Function

The listener.
context Object

The execution context. Defaults to the plugin instance.

Returns:

EventHandle:

handle The detach handle for the listener.

`onHostEvent`

(

type
fn
context

)

EventHandle

Inherited from Plugin.Base: plugin/js/plugin.js:151

Listens for the "on" moment of events fired by the host object.

Listeners attached through this method will be detached when the plugin is unplugged.

Parameters:

type String | Object

The event type.
fn Function

The listener.
context Object

The execution context. Defaults to the plugin instance.

Returns:

EventHandle:

handle The detach handle for the listener.

`parseHTML`

(

sourceNode

)

Object[]

Inherited from Menu: src/sm-menu/js/menu.js:146

Parses the specified HTML sourceNode as a menu structure and returns an array of menu item objects that can be used to generate a menu with that structure.

By default, sourceNode is expected to contain one <li> element per menu item, and submenus are expected to be represented by <ul> or <ol> elements.

The selector queries used to parse the menu structure are contained in the sourceSelectors property, and may be customized. Class names specified in the classNames property are used to determine whether a menu item should be disabled, hidden, or treated as a heading or separator.

Parameters:

sourceNode HTMLElement | Node | String
Node instance, HTML element, or selector string for the node (usually a <ul> or

Returns:

Object[]:

Array of menu item objects.

`parseType`

(

type
[pre=this._yuievt.config.prefix]

)

Array

Inherited from EventTarget: event-custom/js/event-target.js:168

Available since 3.3.0

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.

Parameters:

type String

the type
[pre=this._yuievt.config.prefix] String optional

the prefix

Returns:

Array:

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]

)

Tree.Node | Tree.Node[]

Inherited from Tree: tree/js/tree.js:522

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:

parent Tree.Node

Parent node.
node Object | 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 optional

Options.
- [silent=false] Boolean optional
  
  If true, the add event will be suppressed.

Returns:

Tree.Node | Tree.Node[]:

Node or array of nodes that were prepended.

`publish`

(

type
opts

)

CustomEvent

Inherited from EventTarget: event-custom/js/event-target.js:493

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:

type String

the type, or name of the event
opts Object
optional 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:

CustomEvent:

the custom event

`remove`

() chainable

Inherited from View: app/js/view.js:272

Removes this view's container element from the DOM (if it's in the DOM), but doesn't destroy it or any event listeners attached to it.

`removeAttr`

(

name

)

Inherited from AttributeExtras: attribute/js/AttributeExtras.js:79

Removes an attribute from the host object

Parameters:

name String

The name of the attribute to be removed.

`removeNode`

(

node
[options]

)

Tree.Node

Inherited from Tree: tree/js/tree.js:548

Removes the specified node from its parent node. The removed node will still be reusable unless the destroy option is truthy.

Parameters:

node Tree.Node

Node to remove.
[options] Object optional

Options.
- [destroy=false] Boolean optional
  
  If 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 optional
  
  If true, the remove event will be suppressed.
- [src] String optional
  
  Source 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:

Tree.Node:

Node that was removed.

`removeTarget`

(

)

chainable

Inherited from EventTarget: event-custom/js/event-facade.js:533

Removes a bubble target

Parameters:

o EventTarget

the target to remove

`render`

() chainable

Inherited from View but overwritten in src/sm-menu/js/menu.js:229

Renders this menu into its container.

If the container hasn't already been added to the current document, it will be appended to the <body> element.

`renderChildren`

(

menuItem
[options]

)

Node

Inherited from Menu: src/sm-menu/js/menu.js:265

Renders the children of the specified menu item.

If a container is specified, it will be assumed to be an existing rendered menu item, and the children will be rendered (or re-rendered) inside it.

Parameters:

menuItem Menu.Item

Menu item whose children should be rendered.
[options] Object optional

Options.
- [container] Node optional
  
  Y.Node instance of a container into which the children should be rendered. If the container already contains rendered children, they will be re-rendered in place.

Returns:

Node:

Y.Node instance containing the rendered children.

`renderNode`

(

menuItem
[options]

)

Node

Inherited from Menu: src/sm-menu/js/menu.js:316

Renders the specified menu item and its children (if any).

If a container is specified, the rendered node will be appended to it.

Parameters:

menuItem Menu.Item

Tree node to render.
[options] Object optional

Options.
- [container] Node optional
  
  Y.Node instance of a container to which the rendered tree node should be appended.
- [renderChildren=false] Boolean optional
  
  Whether or not to render this node's children.

Returns:

Node:

Y.Node instance of the rendered menu item.

`reposition`

(

[anchorPoint]

)

chainable

Inherited from Menu but overwritten in src/sm-menu/js/plugins/menu-plugin.js:51

Repositions this menu so that it is anchored to a specified node, region, or set of pixel coordinates.

The menu will be displayed at the most advantageous position relative to the anchor point to ensure that as much of the menu as possible is visible within the viewport.

If no anchor point is specified, the menu will be positioned relative to its host node.

Parameters:

[anchorPoint] Node | Number[] | Object optional

Anchor point at which this menu should be positioned. The point may be specified as a Y.Node reference, a region object, or an array of X and Y pixel coordinates.

`reset`

(

name

)

Object chainable

Inherited from AttributeExtras: attribute/js/AttributeExtras.js:89

Resets the attribute (or all attributes) to its initial value, as long as the attribute is not readOnly, or writeOnce.

Parameters:

name String

Optional. The name of the attribute to reset. If omitted, all attributes are reset.

Returns:

Object:

A reference to the host object.

`set`

(

name
value
[opts]

)

Object chainable

Inherited from AttributeObservable but overwritten in attribute/js/AttributeCore.js:388

Sets the value of an attribute.

Parameters:

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.
[opts] Object optional

Optional data providing the circumstances for the change.

Returns:

Object:

A reference to the host object.

`setAttrs`

(

attrs
[opts]

)

Object chainable

Inherited from AttributeObservable but overwritten in attribute/js/AttributeCore.js:747

Sets multiple attribute values.

Parameters:

attrs Object

An object with attributes name/value pairs.
[opts] Object optional

Optional data providing the circumstances for the change.

Returns:

Object:

A reference to the host object.

`show`

(

[options]

)

chainable

Inherited from Menu: src/sm-menu/js/menu.js:443

Shows this menu.

The menu will be rendered if it hasn't been rendered already.

Parameters:

[options] Object optional

Options.
- [anchorPoint] Node | Number[] | Object optional
  
  Anchor point at which this menu should be positioned when shown. The point may be specified as a Y.Node reference, a region object, or an array of X and Y pixel coordinates.

`showItem`

(

item
[options]

)

chainable

Inherited from Menu.Base: src/sm-menu/js/menu-base.js:147

Shows the specified menu item.

Parameters:

item Menu.Item

Menu item to show.
[options] Object optional

Options.
- [silent=false] Boolean optional
  
  If true, the show event will be suppressed.

`size`

() Number

Inherited from Tree: tree/js/tree.js:582

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:

Number:

Total number of nodes in this tree.

`subscribe`

() deprecated

Inherited from EventTarget: event-custom/js/event-target.js:336

Deprecated: use on

subscribe to an event

`toggleVisible`

(

[options]

)

chainable

Inherited from Menu: src/sm-menu/js/menu.js:469

Toggles the visibility of this menu, showing it if it's currently hidden or hiding it if it's currently visible.

Parameters:

[options] Object optional

Options.
- [anchorPoint] Node | Number[] | Object optional
  
  Anchor point at which this menu should be positioned when shown. The point may be specified as a Y.Node reference, a region object, or an array of X and Y pixel coordinates.

`toJSON`

() Object

Inherited from Tree: tree/js/tree.js:594

Serializes this tree to an object suitable for use in JSON.

Returns:

Object:

Serialized tree object.

`toString`

() String

Inherited from BaseCore: base/js/BaseCore.js:815

Default toString implementation. Provides the constructor NAME and the instance guid, if set.

Returns:

String:

String representation for this object

`traverseNode`

(

node
[options]
callback
[thisObj]

)

Mixed

Inherited from Tree: tree/js/tree.js:604

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 12

Parameters:

node Tree.Node

Node to traverse.
[options] Object optional

Options.
- [depth] Number optional
  
  Depth limit. If specified, descendants will only be traversed to this depth before backtracking and moving on.
callback Function

Callback function to call with the traversed node and each of its descendants.
- node Tree.Node
  
  Node being traversed.
[thisObj] Object optional

this object to use when executing callback.

Returns:

Mixed:

Returns Tree.STOP_TRAVERSAL if traversal was stopped; otherwise returns undefined.

`unsubscribe`

() deprecated

Inherited from EventTarget: event-custom/js/event-target.js:459

Deprecated: use detach

detach a listener

`unsubscribeAll`

(

type

)

deprecated

Inherited from EventTarget: event-custom/js/event-target.js:480

Deprecated: use detachAll

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:

type String

The type, or name of the event

Properties

`_allowAdHocAttrs`

Boolean protected

Inherited from BaseCore but overwritten in app/js/view.js:111

Available since 3.5.0

This tells Y.Base that it should create ad-hoc attributes for config properties passed to View's constructor. This makes it possible to instantiate a view and set a bunch of attributes without having to subclass Y.View and declare all those attributes first.

Default: true

`_handles`

Array private

Inherited from Plugin.Base: plugin/js/plugin.js:66

The list of event handles for event listeners or AOP injected methods applied by the plugin to the host object.

`_isYUITree`

Boolean protected

Inherited from Tree: tree/js/tree.js:126

Simple way to type-check that this is a Tree instance.

Default: true

`_nodeClass`

Tree.Node protected

Inherited from Tree: tree/js/tree.js:135

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.

`_nodeMap`

Object protected

Inherited from Tree: tree/js/tree.js:144

Mapping of node ids to node instances for nodes in this tree.

`_published`

Object protected

Inherited from Tree: tree/js/tree.js:171

Hash of published custom events.

Default: {}

`_rootNodeConfig`

Object protected

Inherited from Tree: tree/js/tree.js:151

Default config object for the root node.

`children`

Tree.Node[]

Inherited from Tree: tree/js/tree.js:80

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.

`classNames`

Object

Inherited from Menu: src/sm-menu/js/menu.js:42

CSS class names used by this menu.

`containerTemplate`

String

Inherited from View: app/js/view.js:40

Available since 3.5.0

Template for this view's container.

Default: "<div/>"

`events`

Object

Inherited from View: app/js/view.js:50

Hash of CSS selectors mapped to events to delegate to elements matching those selectors.

CSS selectors are relative to the container element. Events are attached to the container, and delegation is used so that subscribers are only notified of events that occur on elements inside the container that match the specified selectors. This allows the container's contents to be re- rendered as needed without losing event subscriptions.

Event handlers can be specified either as functions or as strings that map to function names on this view instance or its prototype.

The this object in event handlers will refer to this view instance. If you'd prefer this to be something else, use Y.bind() to bind a custom this object.

Default: {}

Example:

var view = new Y.View({
    events: {
        // Call this.toggle() whenever the element with the id
        // "toggle-button" is clicked.
        '#toggle-button': {click: 'toggle'},

        // Call this.hoverOn() when the mouse moves over any element
        // with the "hoverable" class, and this.hoverOff() when the
        // mouse moves out of any element with the "hoverable" class.
        '.hoverable': {
            mouseover: 'hoverOn',
            mouseout : 'hoverOff'
        }
    }
});

`name`

String deprecated

Inherited from BaseCore: base/js/BaseCore.js:297

Deprecated: Use this.constructor.NAME

The string used to identify the class of this object.

`nodeClass`

String | Tree.Node

Inherited from Tree: tree/js/tree.js:90

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

Inherited from Tree: tree/js/tree.js:102

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: []

`rendered`

Boolean

Inherited from Menu: src/sm-menu/js/menu.js:66

Whether or not this menu has been rendered.

Default: false

`rootNode`

Tree.Node

Inherited from Tree: tree/js/tree.js:117

Root node of this Tree.

`sourceSelectors`

Object

Inherited from Menu: src/sm-menu/js/menu.js:74

Selectors to use when parsing a menu structure from a DOM structure via parseHTML().

`template`

Mixed

Inherited from View: app/js/view.js:91

Template for this view's contents.

This is a convenience property that has no default behavior of its own. It's only provided as a convention to allow you to store whatever you consider to be a template, whether that's an HTML string, a Y.Node instance, a Mustache template, or anything else your little heart desires.

How this template gets used is entirely up to you and your custom render() method.

Default: ''

Attributes

`alignments`

String[]

Inherited from Menu: src/sm-menu/js/menu.js:1163

Preferred alignment positions at which this menu should be displayed relative to the anchor point when one is provided to the show(), toggle(), or reposition() methods.

The most optimal alignment position will be chosen automatically based on which one allows the most of this menu to be visible within the browser's viewport. If multiple positions are equally visible, then the optimal position will be chosen based on its order in this array.

An alignment position is a string like "tl-bl", which means "align the top left of this menu to the bottom left of its anchor point".

Any combination of top/bottom/left/right alignment positions may be used as long as they follow this format. Here are a few examples:

'bl-br': Align the bottom left of this menu with the bottom right of the anchor point.
'br-bl': Align the bottom right of this menu with the bottom left of the anchor point.
'tl-tr': Align the top left of this menu with the top right of the anchor point.
'tr-tl': Align the top right of this menu to the top left of this anchor point.

Default: ['tl-bl', 'tr-br', 'bl-tl', 'br-tr']

Fires event `alignmentsChange`

Fires when the value for the configuration attribute alignments 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:

e EventFacade
An Event Facade object with the following attribute-specific properties added:
- prevVal Any
  The value of the attribute, prior to it being set.
- newVal Any
  The value the attribute is to be set to.
- attrName String
  The name of the attribute being set.
- subAttrName String
  If setting a property within the attribute's value, the name of the sub-attribute property being set.

`container`

HTMLElement | Node | String

Inherited from View: app/js/view.js:376

Container node into which this view's content will be rendered.

The container node serves as the host for all DOM events attached by the view. Delegation is used to handle events on children of the container, allowing the container's contents to be re-rendered at any time without losing event subscriptions.

The default container is a <div> Node, but you can override this in a subclass, or by passing in a custom container config value at instantiation time. If you override the default container in a subclass using ATTRS, you must use the valueFn property. The view's constructor will ignore any assignments using value.

When container is overridden by a subclass or passed as a config option at instantiation time, you can provide it as a selector string, a DOM element, a Y.Node instance, or (if you are subclassing and modifying the attribute), a valueFn function that returns a Y.Node instance. The value will be converted into a Y.Node instance if it isn't one already.

The container is not added to the page automatically. This allows you to have full control over how and when your view is actually rendered to the page.

Default: Y.Node.create(this.containerTemplate)

Fires event `containerChange`

Fires when the value for the configuration attribute container 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:

e EventFacade
An Event Facade object with the following attribute-specific properties added:
- prevVal Any
  The value of the attribute, prior to it being set.
- newVal Any
  The value the attribute is to be set to.
- attrName String
  The name of the attribute being set.
- subAttrName String
  If setting a property within the attribute's value, the name of the sub-attribute property being set.

`destroyed`

Boolean readonly

Inherited from BaseCore: base/js/BaseCore.js:212

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:

e EventFacade
An Event Facade object with the following attribute-specific properties added:
- prevVal Any
  The value of the attribute, prior to it being set.
- newVal Any
  The value the attribute is to be set to.
- attrName String
  The name of the attribute being set.
- subAttrName String
  If setting a property within the attribute's value, the name of the sub-attribute property being set.

`hideOnClick`

Boolean

Inherited from Menu: src/sm-menu/js/menu.js:1197

If true, this menu will be hidden when the user clicks on a menu item that doesn't contain a submenu.

Default: true

Fires event `hideOnClickChange`

Fires when the value for the configuration attribute hideOnClick 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:

e EventFacade
An Event Facade object with the following attribute-specific properties added:
- prevVal Any
  The value of the attribute, prior to it being set.
- newVal Any
  The value the attribute is to be set to.
- attrName String
  The name of the attribute being set.
- subAttrName String
  If setting a property within the attribute's value, the name of the sub-attribute property being set.

`hideOnMouseLeave`

Boolean

Inherited from Menu: src/sm-menu/js/menu.js:1208

If true, this menu will be hidden when the user moves the mouse outside the menu.

Default: false

Fires event `hideOnMouseLeaveChange`

Fires when the value for the configuration attribute hideOnMouseLeave 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:

e EventFacade
An Event Facade object with the following attribute-specific properties added:
- prevVal Any
  The value of the attribute, prior to it being set.
- newVal Any
  The value the attribute is to be set to.
- attrName String
  The name of the attribute being set.
- subAttrName String
  If setting a property within the attribute's value, the name of the sub-attribute property being set.

`hideOnOutsideClick`

Boolean

Inherited from Menu: src/sm-menu/js/menu.js:1219

If true, this menu will be hidden when the user clicks somewhere outside the menu.

Default: true

Fires event `hideOnOutsideClickChange`

Fires when the value for the configuration attribute hideOnOutsideClick 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:

e EventFacade
An Event Facade object with the following attribute-specific properties added:
- prevVal Any
  The value of the attribute, prior to it being set.
- newVal Any
  The value the attribute is to be set to.
- attrName String
  The name of the attribute being set.
- subAttrName String
  If setting a property within the attribute's value, the name of the sub-attribute property being set.

`host`

Plugin.Host

Inherited from Plugin.Base: plugin/js/plugin.js:31

The plugin's host object.

Fires event `hostChange`

Fires when the value for the configuration attribute host 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:

e EventFacade
An Event Facade object with the following attribute-specific properties added:
- prevVal Any
  The value of the attribute, prior to it being set.
- newVal Any
  The value the attribute is to be set to.
- attrName String
  The name of the attribute being set.
- subAttrName String
  If setting a property within the attribute's value, the name of the sub-attribute property being set.

`initialized`

Boolean readonly

Inherited from BaseCore: base/js/BaseCore.js:198

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:

e EventFacade
An Event Facade object with the following attribute-specific properties added:
- prevVal Any
  The value of the attribute, prior to it being set.
- newVal Any
  The value the attribute is to be set to.
- attrName String
  The name of the attribute being set.
- subAttrName String
  If setting a property within the attribute's value, the name of the sub-attribute property being set.

`orientation`

String

Inherited from Menu: src/sm-menu/js/menu.js:1230

Orientation of this menu. May be either 'vertical' or 'horizontal'.

Default: 'vertical'

Fires event `orientationChange`

Fires when the value for the configuration attribute orientation 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:

e EventFacade
An Event Facade object with the following attribute-specific properties added:
- prevVal Any
  The value of the attribute, prior to it being set.
- newVal Any
  The value the attribute is to be set to.
- attrName String
  The name of the attribute being set.
- subAttrName String
  If setting a property within the attribute's value, the name of the sub-attribute property being set.

`showOnClick`

Boolean

Defined in src/sm-menu/js/plugins/menu-plugin.js:173

If true, this menu will be shown when the host node is clicked with the left mouse button or (in the case of <button>, <input>, and <a> elements) activated with the Return key.

Default: true

Fires event `showOnClickChange`

Fires when the value for the configuration attribute showOnClick 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:

e EventFacade
An Event Facade object with the following attribute-specific properties added:
- prevVal Any
  The value of the attribute, prior to it being set.
- newVal Any
  The value the attribute is to be set to.
- attrName String
  The name of the attribute being set.
- subAttrName String
  If setting a property within the attribute's value, the name of the sub-attribute property being set.

`showOnContext`

Boolean

Defined in src/sm-menu/js/plugins/menu-plugin.js:187

If true, this menu will be shown when the host node's contextmenu event occurs, which happens when the user takes an action that would normally display the browser's context menu (such as right-clicking).

When true, the browser's default context menu will be prevented from appearing.

Default: false

Fires event `showOnContextChange`

Fires when the value for the configuration attribute showOnContext 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:

e EventFacade
An Event Facade object with the following attribute-specific properties added:
- prevVal Any
  The value of the attribute, prior to it being set.
- newVal Any
  The value the attribute is to be set to.
- attrName String
  The name of the attribute being set.
- subAttrName String
  If setting a property within the attribute's value, the name of the sub-attribute property being set.

`showOnHover`

Boolean

Defined in src/sm-menu/js/plugins/menu-plugin.js:204

If true, this menu will be shown when the host node is hovered or receives focus instead of only being shown when it's clicked.

Default: false

Fires event `showOnHoverChange`

Fires when the value for the configuration attribute showOnHover 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:

e EventFacade
An Event Facade object with the following attribute-specific properties added:
- prevVal Any
  The value of the attribute, prior to it being set.
- newVal Any
  The value the attribute is to be set to.
- attrName String
  The name of the attribute being set.
- subAttrName String
  If setting a property within the attribute's value, the name of the sub-attribute property being set.

`subMenuAlignments`

String[]

Inherited from Menu: src/sm-menu/js/menu.js:1240

Just like alignments, but for submenus of this menu. See the alignments attribute for details on how alignment positions work.

Default: ['tl-tr', 'bl-br', 'tr-tl', 'br-bl']

Fires event `subMenuAlignmentsChange`

Fires when the value for the configuration attribute subMenuAlignments 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:

e EventFacade
An Event Facade object with the following attribute-specific properties added:
- prevVal Any
  The value of the attribute, prior to it being set.
- newVal Any
  The value the attribute is to be set to.
- attrName String
  The name of the attribute being set.
- subAttrName String
  If setting a property within the attribute's value, the name of the sub-attribute property being set.

`visible`

Boolean

Inherited from Menu: src/sm-menu/js/menu.js:1253

Whether or not this menu is visible. Changing this attribute's value will also change the visibility of this menu.

Default: false

Fires event `visibleChange`

Fires when the value for the configuration attribute visible 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:

e EventFacade
An Event Facade object with the following attribute-specific properties added:
- prevVal Any
  The value of the attribute, prior to it being set.
- newVal Any
  The value the attribute is to be set to.
- attrName String
  The name of the attribute being set.
- subAttrName String
  If setting a property within the attribute's value, the name of the sub-attribute property being set.

Events

`add`

Inherited from Tree: tree/js/tree.js:39

Fired when a node is added to this Tree. The src property will indicate how the node was added ("append", "insert", "prepend", etc.).

Event Payload:

index Number

Index at which the node will be added.
node Tree.Node

Node being added.
parent Tree.Node

Parent node to which the node will be added.
src String

Source of the event ("append", "insert", "prepend", etc.).

`clear`

Inherited from Tree: tree/js/tree.js:53

Fired when this Tree is cleared.

Event Payload:

rootNode Tree.Node

New root node of this tree (the old root node is always destroyed when a tree is cleared).
src String

Source of the event.

`destroy`

Inherited from BaseObservable: base/js/BaseObservable.js:163

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:

e EventFacade

Event object

`disable`

Inherited from Menu.Base: src/sm-menu/js/menu-base.js:21

Fired when a menu item is disabled.

Event Payload:

item Menu.Item

Menu item that was disabled.

`enable`

Inherited from Menu.Base: src/sm-menu/js/menu-base.js:30

Fired when a menu item is enabled.

Event Payload:

item Menu.Item

Menu item that was enabled.

`hide`

Inherited from Menu.Base: src/sm-menu/js/menu-base.js:39

Fired when a menu item is hidden.

Event Payload:

item Menu.Item

Menu item that was hidden.

`init`

Inherited from BaseObservable: base/js/BaseObservable.js:62

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:

e EventFacade

Event object, with a cfg property which refers to the configuration object passed to the constructor.

`itemClick`

Inherited from Menu: src/sm-menu/js/menu.js:27

Fired when any clickable menu item is clicked.

You can subscribe to clicks on a specific menu item by subscribing to "itemClick#id", where "id" is the item id of the item you want to subscribe to.

Event Payload:

item Menu.Item

Menu item that was clicked.
originEvent EventFacade

Original click event.

`remove`

Inherited from Tree: tree/js/tree.js:64

Fired when a node is removed from this Tree.

Event Payload:

destroy Boolean

Whether or not the node will be destroyed after being removed from this tree.
node Tree.Node

Node being removed.
parent Tree.Node

Parent node from which the node will be removed.
src String

Source of the event.

`show`

Inherited from Menu.Base: src/sm-menu/js/menu-base.js:48

Fired when a menu item is shown.

Event Payload:

item Menu.Item

Menu item that was shown.

APIs

Plugin.Menu Class

Example

Constructor

Plugin.Menu

Item Index

Methods

Properties

Attributes

Events

Methods

_addAttrs

Parameters:

_addLazyAttr

Parameters:

_addOutOfOrder

Parameters:

_adoptNode

Parameters:

_afterAdd

Parameters:

_afterClear

_afterClose

Parameters:

_afterContainerChange

_afterDisable

Parameters:

_afterDocMouseDown

Parameters:

_afterEnable

Parameters:

_afterHide

Parameters:

_afterOpen

Parameters:

_afterOrientationChange

Parameters:

_afterRemove

Parameters:

_afterShow

Parameters:

_afterVisibleChange

Parameters:

_aggregateAttrs

Parameters:

Returns:

_attachMenuEvents

_attrCfgHash

_baseDestroy

_baseInit

_cloneDefaultValue

Parameters:

_composeNodeClass

_defAttrChangeFn

Parameters:

_defDestroyFn

Parameters:

_defDisableFn

Parameters:

_defEnableFn

Parameters:

_defHideFn

Parameters:

_defInitFn

Parameters:

_defItemClickFn

Parameters:

_defShowFn

Parameters:

_defSpecificItemClickFn

Parameters:

_destroyContainer

_destroyHierarchy

_detachMenuEvents

_filterAdHocAttrs

Parameters:

Returns:

_fireAttrChange

Parameters:

_fireTreeEvent

`Plugin.Menu`

`_addAttrs`

`_addLazyAttr`

`_addOutOfOrder`

`_adoptNode`

`_afterAdd`

`_afterClear`

`_afterClose`

`_afterContainerChange`

`_afterDisable`

`_afterDocMouseDown`

`_afterEnable`

`_afterHide`

`_afterOpen`

`_afterOrientationChange`

`_afterRemove`

`_afterShow`

`_afterVisibleChange`

`_aggregateAttrs`

`_attachMenuEvents`

`_attrCfgHash`

`_baseDestroy`

`_baseInit`

`_cloneDefaultValue`

`_composeNodeClass`

`_defAttrChangeFn`

`_defDestroyFn`

`_defDisableFn`

`_defEnableFn`

`_defHideFn`

`_defInitFn`

`_defItemClickFn`

`_defShowFn`

`_defSpecificItemClickFn`

`_destroyContainer`

`_destroyHierarchy`

`_detachMenuEvents`

`_filterAdHocAttrs`

`_fireAttrChange`

`_fireTreeEvent`

`_getAncestorTestFn`

`_getAnchorRegion`

`_getAttr`

`_getAttrCfg`

`_getAttrCfgs`

`_getAttrInitVal`

`_getAttrs`

`_getClasses`

`_getContainer`

`_getDefaultNodeIndex`

`_getFullType`

`_getInstanceAttrCfgs`

`_getStateVal`

`_getType`

`_hasPotentialSubscribers`

`_hideMenu`

`_initAttrHost`

`_initAttribute`

`_initAttrs`

`_initBase`

`_initHierarchy`

`_initHierarchyData`

`_inRegion`

`_isLazyAttr`

`_monitor`

`_normAttrVals`

`_onItemClick`

`_onItemMouseEnter`

`_onItemMouseLeave`