Show:

A base class for Audio.

Check the live demo.

Constructor

A.Audio

(
  • config
)

Parameters:

  • config Object

    Object literal specifying widget configuration properties.

Example:

<div id="myAudio"></div>
                                    
YUI().use(
                                     'aui-audio',
                                     function(Y) {
                                       new Y.Audio(
                                         {
                                           boundingBox: '#myAudio',
                                           url: 'https://alloyui.com/audio/zelda.mp3',
                                           oggUrl: 'https://alloyui.com/audio/zelda.ogg'
                                         }
                                       ).render();
                                     }
                                    );
                                    

Index

Methods

Methods

_addAttrs

(
  • cfgs
  • values
  • lazy
)
private

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

    <p><p><p><p><p><p><p><p>An object with attribute name/configuration pairs.</p></p></p></p></p></p></p></p>

  • values Object

    <p><p><p><p><p><p><p><p>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.</p></p></p></p></p></p></p></p>

  • lazy Boolean

    <p><p><p><p><p><p><p><p>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 <a href="#method_addAttr">addAttr</a>.</p></p></p></p></p></p></p></p>

_addLazyAttr

(
  • name
  • [lazyCfg]
)
private

Finishes initializing an attribute which has been lazily added.

Parameters:

  • name Object

    <p><p><p><p><p><p><p><p>The name of the attribute</p></p></p></p></p></p></p></p>

  • [lazyCfg] Object optional

    <p><p><p><p><p><p><p><p>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.</p></p></p></p></p></p></p></p>

_addOutOfOrder

(
  • name
  • cfg
)
private

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

    <p><p><p><p><p><p><p><p>attribute name</p></p></p></p></p></p></p></p>

  • cfg Object

    <p><p><p><p><p><p><p><p>attribute configuration</p></p></p></p></p></p></p></p>

_afterChildSelectedChange

(
  • event
)
protected

Default attribute change listener for the <code>selected</code> attribute, responsible for updating the UI, in response to attribute changes.

Parameters:

  • event EventFacade

    <p><p><p>The event facade for the attribute change.</p></p></p>

_afterCssClassChange

(
  • event
)
protected

Fires after the value of the cssClass attribute change.

Parameters:

_afterCurrentIndexChange

(
  • event
)
protected

Fired after the widget's index attribute is changed. Will update the scrollview to show the right item, if it isn't showing it yet.

Parameters:

_afterIndexChange

(
  • event
)
protected

Fired after the scrollview's index attribute is changed. Will update the widget's index accordingly.

Parameters:

_afterResponsiveSwipe

() protected

Fired after the widget's responsive event. This adds back the swipe css class that was removed by _onResponsiveSwipe and then syncs the scroll UI.

_afterWidgetUISetVisible

() protected

Fired after the widget's _uiSetVisible function is called. It prepares the swipe funcionality for use.

_aggregateAttrs

(
  • allAttrs
)
Object private

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

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

Returns:

Object:

<p><p><p><p><p><p><p><p>The aggregate set of ATTRS definitions for the instance</p></p></p></p></p></p></p></p>

_applyCssPrefix

(
  • component
)
protected

Applies a CSS prefix on a component.

Parameters:

  • component Object

_applyParsedConfig

() Object protected

Returns:

Object:

<p><p><p>The merged configuration literal</p></p></p>

_applyParser

(
  • config
)
protected

Utility method used to apply the <code>HTML_PARSER</code> configuration for the instance, to retrieve config data values.

Parameters:

  • config Object

    <p><p><p>User configuration object (will be populated with values from Node)</p></p></p>

_attachSwipeEvents

() protected

Listens to the necessary events for the swipe funcionality to work correctly.

_attrCfgHash

() private

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

_baseDestroy

() private

Internal destroy implementation for BaseCore

_baseInit

() private

Internal initialization implementation for BaseCore

_bindAttrUI

(
  • attrs
)
private

Binds after listeners for the list of attributes provided

Parameters:

  • attrs Array

_bindDOM

() protected

Sets up DOM listeners, on elements rendered by the widget.

_bindUI

() protected

Sets up DOM and CustomEvent listeners for the widget.

_bindUIChild

() protected

Binds event listeners responsible for updating the UI state in response to WidgetChild related state changes. <p> This method is invoked after bindUI is invoked for the Widget class using YUI's aop infrastructure. </p>

_cloneDefaultValue

(
  • cfg
)
private

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

_createSource

(
  • type
)
protected

Create source element using passed type attribute.

Parameters:

  • type Object

_createUIEvent

(
  • type
)
private

Binds a delegated DOM event listener of the specified type to the Widget's outtermost DOM element to facilitate the firing of a Custom Event of the same type for the Widget instance.

Parameters:

  • type String

    <p><p><p>String representing the name of the event</p></p></p>

_defAttrChangeFn

(
  • e
  • eventFastPath
)
private

Default function for attribute change events.

Parameters:

  • e EventFacade

    <p><p><p><p><p><p><p><p>The event object for attribute change events.</p></p></p></p></p></p></p></p>

  • eventFastPath Boolean

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

_defaultBB

() protected

Returns the default value for the boundingBox attribute.

For the Widget class, this will most commonly be null (resulting in a new boundingBox node instance being created), unless a srcNode was provided and CONTENT_TEMPLATE is null, in which case it will be srcNode. This behavior was introduced in @VERSION@ to accomodate single-box widgets whose BB & CB both point to srcNode (e.g. Y.Button).

_defaultCB

() protected

Returns the default value for the contentBox attribute.

For the Widget class, this will be the srcNode if provided, otherwise null (resulting in a new contentBox node instance being created)

_defDestroyFn

(
  • e
)
protected

Default destroy event handler

Parameters:

  • e EventFacade

    <p><p><p><p><p><p><p><p>Event object</p></p></p></p></p></p></p></p>

_defInitFn

(
  • e
)
protected

Default init event handler

Parameters:

  • e EventFacade

    <p><p><p><p><p><p><p><p>Event object, with a cfg property which refers to the configuration object passed to the constructor.</p></p></p></p></p></p></p></p>

_defRenderFn

(
  • e
  • parentNode
)
protected

Default render handler

Parameters:

  • e EventFacade

    <p><p><p>The Event object</p></p></p>

  • parentNode Node

    <p><p><p>The parent node to render to, if passed in to the <code>render</code> method</p></p></p>

_destroyBox

() protected

Removes and destroys the widgets rendered boundingBox, contentBox, and detaches bound UI events.

_destroyHierarchy

() private

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

_destroyUIEvents

() private

Destructor logic for UI event infrastructure, invoked during Widget destruction.

_detachSwipeEvents

() protected

Detaches all events related to the swipe funcionality.

_disableScrollView

() protected

Disables the scroll view, removing the swipe funcionality.

_enableScrollView

() protected

Enables the scroll view, adding the swipe funcionality.

_filterAdHocAttrs

(
  • allAttrs
  • userVals
)
Object private

Parameters:

  • allAttrs Object

    <p><p><p><p><p><p><p><p>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.</p></p></p></p></p></p></p></p>

  • userVals Object

    <p><p><p><p><p><p><p><p>The config object passed in by the user, from which adhoc attrs are to be filtered.</p></p></p></p></p></p></p></p>

Returns:

Object:

<p><p><p><p><p><p><p><p>The set of adhoc attributes passed in, in the form of an object with attribute name/configuration pairs.</p></p></p></p></p></p></p></p>

_filterUIEvent

(
  • evt
)
Boolean private

This method is used to determine if we should fire the UI Event or not. The default implementation makes sure that for nested delegates (nested unrelated widgets), we don't fire the UI event listener more than once at each level.

<p>For example, without the additional filter, if you have nested widgets, each widget will have a delegate listener. If you click on the inner widget, the inner delegate listener's filter will match once, but the outer will match twice (based on delegate's design) - once for the inner widget, and once for the outer.</p>

Parameters:

Returns:

Boolean:

<p><p><p>true if it's OK to fire the custom UI event, false if not.</p></p></p>

_fireAttrChange

(
  • attrName
  • subAttrName
  • currVal
  • newVal
  • opts
  • [cfg]
)
private

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

Parameters:

  • attrName String

    <p><p><p><p><p><p><p><p>The name of the attribute</p></p></p></p></p></p></p></p>

  • subAttrName String

    <p><p><p><p><p><p><p><p>The full path of the property being changed, if this is a sub-attribute value being change. Otherwise null.</p></p></p></p></p></p></p></p>

  • currVal Any

    <p><p><p><p><p><p><p><p>The current value of the attribute</p></p></p></p></p></p></p></p>

  • newVal Any

    <p><p><p><p><p><p><p><p>The new value of the attribute</p></p></p></p></p></p></p></p>

  • opts Object

    <p><p><p><p><p><p><p><p>Any additional event data to mix into the attribute change event's event facade.</p></p></p></p></p></p></p></p>

  • [cfg] Object optional

    <p><p><p><p><p><p><p><p>The attribute config stored in State, if already available.</p></p></p></p></p></p></p></p>

_getAttr

(
  • name
)
Any protected chainable

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

See <a href="#method_get">get</a> for argument details.

Parameters:

  • name String

    <p><p><p><p><p><p><p><p>The name of the attribute.</p></p></p></p></p></p></p></p>

Returns:

Any:

<p><p><p><p><p><p><p><p>The value of the attribute.</p></p></p></p></p></p></p></p>

_getAttrCfg

(
  • name
)
Object protected

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

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

Returns:

Object:

<p><p><p><p><p><p><p><p>The configuration properties for the given attribute, or all attributes.</p></p></p></p></p></p></p></p>

_getAttrCfgs

() Object protected

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

Returns:

Object:

<p><p><p><p><p><p><p><p>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.</p></p></p></p></p></p></p></p>

_getAttrInitVal

(
  • attr
  • cfg
  • initValues
)
Any private

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

    <p><p><p><p><p><p><p><p>The name of the attribute</p></p></p></p></p></p></p></p>

  • cfg Object

    <p><p><p><p><p><p><p><p>The attribute configuration object</p></p></p></p></p></p></p></p>

  • initValues Object

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

Returns:

Any:

<p><p><p><p><p><p><p><p>The initial value of the attribute.</p></p></p></p></p></p></p></p>

_getAttrs

(
  • attrs
)
Object protected

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

Parameters:

  • attrs String | Boolean

    <p><p><p><p><p><p><p><p>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.</p></p></p></p></p></p></p></p>

Returns:

Object:

<p><p><p><p><p><p><p><p>An object with attribute name/value pairs.</p></p></p></p></p></p></p></p>

_getClasses

() Function protected

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

Returns:

Function:

<p><p><p><p><p><p><p><p>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.</p></p></p></p></p></p></p></p>

_getFullType

(
  • type
)
String private

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

    <p><p><p><p><p><p><p><p>The short type to prefix</p></p></p></p></p></p></p></p>

Returns:

String:

<p><p><p><p><p><p><p><p>The prefixed type, if a prefix is set, otherwise the type passed in</p></p></p></p></p></p></p></p>

_getHtmlParser

() Object private

Gets the HTML_PARSER definition for this instance, by merging HTML_PARSER definitions across the class hierarchy.

Returns:

Object:

<p><p><p>HTML_PARSER definition for this instance</p></p></p>

_getInstanceAttrCfgs

(
  • allCfgs
)
Object private

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

    <p><p><p><p><p><p><p><p>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.</p></p></p></p></p></p></p></p>

Returns:

Object:

<p><p><p><p><p><p><p><p>The set of attributes to be added for this instance, suitable for passing through to <code>addAttrs</code>.</p></p></p></p></p></p></p></p>

_getNodeToParse

() Node private

Determines whether we have a node reference which we should try and parse.

The current implementation does not parse nodes generated from CONTENT_TEMPLATE, only explicitly set srcNode, or contentBox attributes.

Returns:

Node:

<p><p><p>The node reference to apply HTML_PARSER to.</p></p></p>

_getSrcNode

() Node protected

Returns:

Node:

<p><p><p>The Node to apply HTML_PARSER to</p></p></p>

_getStateVal

(
  • name
  • [cfg]
)
Any private

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

Parameters:

  • name String

    <p><p><p><p><p><p><p><p>The name of the attribute</p></p></p></p></p></p></p></p>

  • [cfg] Object optional

    <p><p><p><p><p><p><p><p>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.</p></p></p></p></p></p></p></p>

Returns:

Any:

<p><p><p><p><p><p><p><p>The stored value of the attribute</p></p></p></p></p></p></p></p>

_getType

() private

If the instance has a prefix attribute and the event type is not prefixed, the instance prefix is applied to the supplied type.

_getUIEventNode

() protected

Inherited from Widget but overwritten in yui3/src/widget/js/WidgetUIEvents.js:62

Returns the node on which to bind delegate listeners.

_guid

() protected

_hasPotentialSubscribers

(
  • fullType
)
Boolean private

Parameters:

  • fullType String

    <p><p><p><p><p><p><p><p>The fully prefixed type name</p></p></p></p></p></p></p></p>

Returns:

Boolean:

<p><p><p><p><p><p><p><p>Whether the event has potential subscribers or not</p></p></p></p></p></p></p></p>

_initAttrHost

(
  • attrs
  • values
  • lazy
)
private

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

Parameters:

  • attrs Object

    <p><p><p><p><p><p><p><p>The attributes to add during construction (passed through to <a href="#method_addAttrs">addAttrs</a>). These can also be defined on the constructor being augmented with Attribute by defining the ATTRS property on the constructor.</p></p></p></p></p></p></p></p>

  • values Object

    <p><p><p><p><p><p><p><p>The initial attribute values to apply (passed through to <a href="#method_addAttrs">addAttrs</a>). These are not merged/cloned. The caller is responsible for isolating user provided values if required.</p></p></p></p></p></p></p></p>

  • lazy Boolean

    <p><p><p><p><p><p><p><p>Whether or not to add attributes lazily (passed through to <a href="#method_addAttrs">addAttrs</a>).</p></p></p></p></p></p></p></p>

_initAttribute

() private

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

Initializes AttributeCore

_initAttrs

(
  • attrs
  • values
  • lazy
)
protected

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

Parameters:

  • attrs Object

    <p><p><p><p><p><p><p><p>The attributes to add during construction (passed through to <a href="#method_addAttrs">addAttrs</a>). These can also be defined on the constructor being augmented with Attribute by defining the ATTRS property on the constructor.</p></p></p></p></p></p></p></p>

  • values Object

    <p><p><p><p><p><p><p><p>The initial attribute values to apply (passed through to <a href="#method_addAttrs">addAttrs</a>). These are not merged/cloned. The caller is responsible for isolating user provided values if required.</p></p></p></p></p></p></p></p>

  • lazy Boolean

    <p><p><p><p><p><p><p><p>Whether or not to add attributes lazily (passed through to <a href="#method_addAttrs">addAttrs</a>).</p></p></p></p></p></p></p></p>

_initBase

(
  • config
)
private

Internal construction logic for BaseCore.

Parameters:

  • config Object

    <p><p><p><p><p><p><p><p>The constructor configuration object</p></p></p></p></p></p></p></p>

_initHierarchy

(
  • userVals
)
private

Initializes the class hierarchy for the instance, which includes initializing attributes for each class defined in the class's static <a href="#property_BaseCore.ATTRS">ATTRS</a> property and invoking the initializer method on the prototype of each class in the hierarchy.

Parameters:

  • userVals Object

    <p><p><p><p><p><p><p><p>Object with configuration property name/value pairs</p></p></p></p></p></p></p></p>

_initHierarchyData

() private

A helper method used by _getClasses and _getAttrCfgs, which determines both the array of classes and aggregate set of attribute configurations across the class hierarchy for the instance.

_initUIEvent

(
  • type
)
String private

Sets up infrastructure required to fire a UI event.

Parameters:

  • type String

    <p><p><p>String representing the name of the event</p></p></p>

Returns:

String:

_isLazyAttr

(
  • name
)
Boolean private

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

Parameters:

  • name String

    <p><p><p><p><p><p><p><p>The name of the attribute</p></p></p></p></p></p></p></p>

Returns:

Boolean:

<p><p><p><p><p><p><p><p>true if it's a lazily added attribute, false otherwise.</p></p></p></p></p></p></p></p>

_isUIEvent

(
  • type
)
String private

Determines if the specified event is a UI event.

Parameters:

  • type String

    <p><p><p>String representing the name of the event</p></p></p>

Returns:

String:

<p><p><p>Event Returns the name of the UI Event, otherwise undefined.</p></p></p>

_mapInstance

(
  • The
)
protected

Utility method used to add an entry to the boundingBox id to instance map.

This method can be used to populate the instance with lazily created boundingBox Node references.

Parameters:

  • The String

    <p><p><p>boundingBox id</p></p></p>

_monitor

(
  • what
  • eventType
  • o
)
private

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

    <p><p><p><p><p><p><p><p>'attach', 'detach', 'fire', or 'publish'</p></p></p></p></p></p></p></p>

  • eventType String | CustomEvent

    <p><p><p><p><p><p><p><p>The prefixed name of the event being monitored, or the CustomEvent object.</p></p></p></p></p></p></p></p>

  • o Object

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

_normAttrVals

(
  • valueHash
)
Object private

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

Parameters:

  • valueHash Object

    <p><p><p><p><p><p><p><p>An object with attribute name/value pairs</p></p></p></p></p></p></p></p>

Returns:

Object:

<p><p><p><p><p><p><p><p>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.</p></p></p></p></p></p></p></p>

_onDocFocus

(
  • evt
)
protected

DOM focus event handler, used to sync the state of the Widget with the DOM

Parameters:

  • evt EventFacade

    <p><p><p>The event facade for the DOM focus event</p></p></p>

_onDocMouseDown

(
  • evt
)
protected

"mousedown" event handler for the owner document of the widget's bounding box.

Parameters:

  • evt EventFacade

    <p><p><p>The event facade for the DOM focus event</p></p></p>

_onPause

(
  • event
)
protected

Fires on video pause event fires.

Parameters:

_onPlay

(
  • event
)
protected

Fires on video play event fires.

Parameters:

_onResponsiveSwipe

() protected

Fired on the widget's responsive event. This removes the swipe css class, so the responsive code can correctly calculate the widget's size. The css class will be added back by _afterResponsiveSwipe.

_parseType

() private

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

_plugPaginator

() protected

Plugs ScrollViewPaginator if the useScrollViewPaginator is true.

_preAddAttrs

(
  • attrs
  • userVals
  • lazy
)
protected

Implement the BaseCore _preAddAttrs method hook, to add the srcNode and related attributes, so that HTML_PARSER (which relies on this.get("srcNode")) can merge in it's results before the rest of the attributes are added.

Parameters:

  • attrs Object

    <p><p><p>The full hash of statically defined ATTRS attributes being added for this instance</p></p></p>

  • userVals Object

    <p><p><p>The hash of user values passed to the constructor</p></p></p>

  • lazy Boolean

    <p><p><p>Whether or not to add the attributes lazily</p></p></p>

_preInitEventCfg

(
  • config
)
private

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

    <p><p><p><p><p><p><p><p>The user configuration object</p></p></p></p></p></p></p></p>

_protectAttrs

(
  • attrs
)
Object deprecated protected

Inherited from AttributeCore: yui3/src/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

    <p><p><p><p><p><p><p><p>A hash of attribute to configuration object pairs.</p></p></p></p></p></p></p></p>

Returns:

Object:

<p><p><p><p><p><p><p><p>A protected version of the attrs argument.</p></p></p></p></p></p></p></p>

_publish

(
  • fullType
  • etOpts
  • ceOpts
)
CustomEvent private

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

    <p><p><p><p><p><p><p><p>The prefixed type of the event to publish.</p></p></p></p></p></p></p></p>

  • etOpts Object

    <p><p><p><p><p><p><p><p>The EventTarget specific configuration to mix into the published event.</p></p></p></p></p></p></p></p>

  • ceOpts Object

    <p><p><p><p><p><p><p><p>The publish specific configuration to mix into the published event.</p></p></p></p></p></p></p></p>

Returns:

CustomEvent:

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

_removeLoadingClassNames

() protected

Removes class names representative of the widget's loading state from the boundingBox.

_renderAudio

(
  • fallback
)
protected

Render Audio in DOM.

Parameters:

  • fallback Object

_renderBox

(
  • parentNode
)
private

Helper method to collect the boundingBox and contentBox and append to the provided parentNode, if not already a child. The owner document of the boundingBox, or the owner document of the contentBox will be used as the document into which the Widget is rendered if a parentNode is node is not provided. If both the boundingBox and the contentBox are not currently in the document, and no parentNode is provided, the widget will be rendered to the current document's body.

Parameters:

  • parentNode Node

    <p><p><p>The parentNode to render the widget to. If not provided, and both the boundingBox and the contentBox are not currently in the document, the widget will be rendered to the current document's body.</p></p></p>

_renderBoxClassNames

() protected

Applies standard class names to the boundingBox and contentBox.

_renderInteraction

(
  • event
  • parentNode
)
protected

Renders the A.Component based upon a passed in interaction.

Parameters:

  • event Object
  • parentNode Object

_renderSwf

() protected

Render SWF in DOM.

_renderUI

() protected

Initializes the UI state for the Widget's bounding/content boxes.

_scrollToCurrentIndex

() protected

Scrolls to the widget's current index.

_set

(
  • name
  • val
  • [opts]
)
Object protected chainable

Allows setting of readOnly/writeOnce attributes. See <a href="#method_set">set</a> for argument details.

Parameters:

  • name String

    <p><p><p><p><p><p><p><p>The name of the attribute.</p></p></p></p></p></p></p></p>

  • val Any

    <p><p><p><p><p><p><p><p>The value to set the attribute to.</p></p></p></p></p></p></p></p>

  • [opts] Object optional

    <p><p><p><p><p><p><p><p>Optional data providing the circumstances for the change.</p></p></p></p></p></p></p></p>

Returns:

Object:

<p><p><p><p><p><p><p><p>A reference to the host object.</p></p></p></p></p></p></p></p>

_setAttr

(
  • name
  • value
  • [opts]
  • force
)
Object protected chainable

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

See <a href="#method_set">set</a> for argument details.

Parameters:

  • name String

    <p><p><p><p><p><p><p><p>The name of the attribute.</p></p></p></p></p></p></p></p>

  • value Any

    <p><p><p><p><p><p><p><p>The value to set the attribute to.</p></p></p></p></p></p></p></p>

  • [opts] Object optional

    <p><p><p><p><p><p><p><p>Optional data providing the circumstances for the change.</p></p></p></p></p></p></p></p>

  • force Boolean

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

Returns:

Object:

<p><p><p><p><p><p><p><p>A reference to the host object.</p></p></p></p></p></p></p></p>

_setAttrs

(
  • attrs
  • [opts]
)
Object protected chainable

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

Parameters:

  • attrs Object

    <p><p><p><p><p><p><p><p>An object with attributes name/value pairs.</p></p></p></p></p></p></p></p>

  • [opts] Object optional

    <p><p><p><p><p><p><p><p>Optional data providing the circumstances for the change</p></p></p></p></p></p></p></p>

Returns:

Object:

<p><p><p><p><p><p><p><p>A reference to the host object.</p></p></p></p></p></p></p></p>

_setAttrUI

(
  • e
)
private

Parameters:

_setAttrVal

(
  • attrName
  • subAttrName
  • prevVal
  • newVal
  • [opts]
  • [attrCfg]
)
Boolean private

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

Parameters:

  • attrName String

    <p><p><p><p><p><p><p><p>The attribute name.</p></p></p></p></p></p></p></p>

  • subAttrName String

    <p><p><p><p><p><p><p><p>The sub-attribute name, if setting a sub-attribute property ("x.y.z").</p></p></p></p></p></p></p></p>

  • prevVal Any

    <p><p><p><p><p><p><p><p>The currently stored value of the attribute.</p></p></p></p></p></p></p></p>

  • newVal Any

    <p><p><p><p><p><p><p><p>The value which is going to be stored.</p></p></p></p></p></p></p></p>

  • [opts] Object optional

    <p><p><p><p><p><p><p><p>Optional data providing the circumstances for the change.</p></p></p></p></p></p></p></p>

  • [attrCfg] Object optional

    <p><p><p><p><p><p><p><p>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.</p></p></p></p></p></p></p></p>

Returns:

Boolean:

<p><p><p><p><p><p><p><p>true if the new attribute value was stored, false if not.</p></p></p></p></p></p></p></p>

_setBB

(
  • node
)
private

Setter for the boundingBox attribute

Parameters:

  • node Node | String

Returns:

<p><p><p>Node</p></p></p>

_setBox

(
  • id
  • node
  • template
  • isBounding
)
Node private

Helper method to set the bounding/content box, or create it from the provided template if not found.

Parameters:

  • id String

    <p><p><p>The node's id attribute</p></p></p>

  • node Node | String

    <p><p><p>The node reference</p></p></p>

  • template String

    <p><p><p>HTML string template for the node</p></p></p>

  • isBounding Boolean

    <p><p><p>true if this is the boundingBox, false if it's the contentBox</p></p></p>

Returns:

Node:

<p><p><p>The node</p></p></p>

_setCB

(
  • node
)
private

Setter for the contentBox attribute

Parameters:

  • node Node | String

Returns:

<p><p><p>Node</p></p></p>

_setMedia

(
  • flashVars
)
protected

Set media on flashVars.

Parameters:

  • flashVars Object

_setRender

(
  • config
)
protected

Sets the interaction and render behavior based upon an object (intercepts the default rendering behavior).

Parameters:

  • config Object

_setStateVal

(
  • name
  • value
)
private

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

Parameters:

  • name String

    <p><p><p><p><p><p><p><p>The name of the attribute</p></p></p></p></p></p></p></p>

  • value Any

    <p><p><p><p><p><p><p><p>The value of the attribute</p></p></p></p></p></p></p></p>

_setSwipe

() protected

Sets swipe attribute.

_strSetter

(
  • strings
)
String protected

The default setter for the strings attribute. Merges partial sets into the full string set, to allow users to partial sets of strings

Parameters:

  • strings Object

Returns:

String:

<p><p><p>The full set of strings to set</p></p></p>

_syncAttrUI

(
  • attrs
)
private

Invokes the _uiSet=ATTR NAME> method for the list of attributes provided

Parameters:

  • attrs Array

_syncScrollUI

() protected

This method updates the scroll view with new dimensions and makes sure it's at the correct position.

_syncUI

() protected

Updates the widget UI to reflect the attribute state.

_syncUIChild

() protected

Synchronizes the UI to match the WidgetChild state. <p> This method is invoked after bindUI is invoked for the Widget class using YUI's aop infrastructure. </p>

_uiSetChildSelected

(
  • selected
)
protected

Updates the UI to reflect the <code>selected</code> attribute value.

Parameters:

  • selected Number

    <p><p><p>The selected value to be reflected in the UI.</p></p></p>

_uiSetCssClass

(
  • newVal
  • prevVal
)
protected

Applies the CSS classes to the boundingBox and contentBox.

Parameters:

  • newVal String
  • prevVal String

_uiSetDim

(
  • dim
  • val
)
private

Parameters:

  • dim String

    <p><p><p>The dimension - "width" or "height"</p></p></p>

  • val Number | String

    <p><p><p>The value to set</p></p></p>

_uiSetDisabled

(
  • val
)
protected

Sets the disabled state for the UI

Parameters:

  • val Boolean

_uiSetFixedAttributes

(
  • val
)
protected

Set the fixedAttributes on the UI.

Parameters:

  • val Object

_uiSetFlashVars

(
  • val
)
protected

Set the flashVars on the UI.

Parameters:

  • val Object

_uiSetFocused

(
  • val
  • src
)
protected

Sets the focused state for the UI

Parameters:

  • val Boolean
  • src String

    <p><p><p>String representing the source that triggered an update to the UI.</p></p></p>

_uiSetHeight

(
  • val
)
protected

Sets the height on the widget's bounding box element

Parameters:

_uiSetOggUrl

(
  • val
)
protected

Set the oggUrl on the UI.

Parameters:

  • val Object

_uiSetSwfUrl

(
  • val
)
protected

Set the swfUrl on the UI.

Parameters:

  • val Object

_uiSetSwipe

() protected

Updates the UI according to the current value of swipe.

_uiSetTabIndex

(
  • Number
)
protected

Set the tabIndex on the widget's rendered UI

Parameters:

  • Number Object

_uiSetUrl

(
  • val
)
protected

Set the url on the UI.

Parameters:

  • val Object

_uiSetVisible

(
  • value
)
protected

Set the visibility on the UI.

Parameters:

  • value Object

_uiSetWidth

(
  • val
)
protected

Sets the width on the widget's bounding box element

Parameters:

_uiSizeCB

(
  • expand
)
protected

Parameters:

  • expand Boolean

_unbindDOM

() protected

_unbindUI

() protected

_usingVideo

() protected

Check if it's a video node.

_validTabIndex

(
  • tabIndex
)
protected

Parameters:

addAttr

(
  • name
  • config
  • lazy
)
Object chainable

<p> Adds an attribute with the provided configuration to the host object. </p> <p> The config argument object supports the following properties: </p>

<dl> <dt>value <Any></dt> <dd>The initial value to set on the attribute</dd>

<dt>valueFn <Function | String></dt> <dd> <p>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.</p>

<p>valueFn can also be set to a string, representing the name of the instance method to be used to retrieve the value.</p> </dd>

<dt>readOnly <boolean></dt> <dd>Whether or not the attribute is read only. Attributes having readOnly set to true cannot be modified by invoking the set method.</dd>

<dt>writeOnce <boolean> or <string></dt> <dd> 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. <p>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)</p> </dd>

<dt>setter <Function | String></dt> <dd> <p>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 <a href="#property_Attribute.INVALID_VALUE">Attribute.INVALID_VALUE</a>, from the setter will prevent the value from being stored. </p>

<p>setter can also be set to a string, representing the name of the instance method to be used as the setter function.</p> </dd>

<dt>getter <Function | String></dt> <dd> <p> 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. </p>

<p>getter can also be set to a string, representing the name of the instance method to be used as the getter function.</p> </dd>

<dt>validator <Function | String></dt> <dd> <p> The validator function invoked prior to setting the stored value. Returning false from the validator function will prevent the value from being stored. </p>

<p>validator can also be set to a string, representing the name of the instance method to be used as the validator function.</p> </dd>

<dt>lazyAdd <boolean></dt> <dd>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 <a href="#method_addAttrs">addAttrs</a> method.</dd>

</dl>

<p>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.</p>

<p>Configuration properties outside of the list mentioned above are considered private properties used internally by attribute, and are not intended for public use.</p>

Parameters:

  • name String

    <p><p><p><p><p><p><p><p>The name of the attribute.</p></p></p></p></p></p></p></p>

  • config Object

    <p><p><p><p><p><p><p><p>An object with attribute configuration property/value pairs, specifying the configuration for the attribute.</p> <p><p> <strong>NOTE:</strong> 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. </p></p></p></p></p></p></p></p></p>

  • lazy Boolean

    <p><p><p><p><p><p><p><p>(optional) Whether or not to add this attribute lazily (on the first call to get/set).</p></p></p></p></p></p></p></p>

Returns:

Object:

<p><p><p><p><p><p><p><p>A reference to the host object.</p></p></p></p></p></p></p></p>

addAttrs

(
  • cfgs
  • values
  • lazy
)
Object chainable

Configures a group of attributes, and sets initial values.

<p> <strong>NOTE:</strong> This method does not isolate the configuration object by merging/cloning. The caller is responsible for merging/cloning the configuration object if required. </p>

Parameters:

  • cfgs Object

    <p><p><p><p><p><p><p><p>An object with attribute name/configuration pairs.</p></p></p></p></p></p></p></p>

  • values Object

    <p><p><p><p><p><p><p><p>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.</p></p></p></p></p></p></p></p>

  • lazy Boolean

    <p><p><p><p><p><p><p><p>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 <a href="#method_addAttr">addAttr</a>.</p></p></p></p></p></p></p></p>

Returns:

Object:

<p><p><p><p><p><p><p><p>A reference to the host object.</p></p></p></p></p></p></p></p>

addTarget

(
  • o
)
chainable

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

    <p><p><p><p><p><p><p><p>the target to add</p></p></p></p></p></p></p></p>

after

(
  • type
  • fn
  • [context]
  • [arg*]
)
EventHandle

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

    <p><p><p><p><p><p><p><p>The name of the event</p></p></p></p></p></p></p></p>

  • fn Function

    <p><p><p><p><p><p><p><p>The callback to execute in response to the event</p></p></p></p></p></p></p></p>

  • [context] Object optional

    <p><p><p><p><p><p><p><p>Override <code>this</code> object in callback</p></p></p></p></p></p></p></p>

  • [arg*] Any optional

    <p><p><p><p><p><p><p><p>0..n additional arguments to supply to the subscriber</p></p></p></p></p></p></p></p>

Returns:

EventHandle:

<p><p><p><p><p><p><p><p>A subscription handle capable of detaching the subscription</p></p></p></p></p></p></p></p>

ancestor

(
  • depth
)
Widget

Returns the Widget instance at the specified depth.

Parameters:

  • depth Number

    <p><p><p>Number representing the depth of the ancestor.</p></p></p>

Returns:

Widget:

<p><p><p>Widget instance.</p></p></p>

attrAdded

(
  • name
)
Boolean

Checks if the given attribute has been added to the host

Parameters:

  • name String

    <p><p><p><p><p><p><p><p>The name of the attribute to check.</p></p></p></p></p></p></p></p>

Returns:

Boolean:

<p><p><p><p><p><p><p><p>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.</p></p></p></p></p></p></p></p>

before

()

Executes the callback before a DOM event, custom event or method. If the first argument is a function, it is assumed the target is a method. For DOM and custom events, this is an alias for Y.on.

For DOM and custom events: type, callback, context, 0-n arguments

For methods: callback, object (method host), methodName, context, 0-n arguments

Returns:

<p><p><p><p><p><p><p><p>detach handle</p></p></p></p></p></p></p></p>

bindUI

() protected

Inherited from Widget but overwritten in alloy-ui/src/aui-audio/js/aui-audio.js:244

Bind the events on the Audio UI. Lifecycle.

blur

() chainable

Causes the Widget to lose focus by setting the "focused" attribute to "false"

bubble

(
  • evt
)
Boolean

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

Parameters:

  • evt CustomEvent

    <p><p><p><p><p><p><p><p>the custom event to propagate</p></p></p></p></p></p></p></p>

Returns:

Boolean:

<p><p><p><p><p><p><p><p>the aggregated return value from Event.Custom.fire</p></p></p></p></p></p></p></p>

build

()

Applies extensions to a class using the static Base.build method.

clone

(
  • config
)
Widget

Clone the current A.Component.

Parameters:

  • config Object

Returns:

Widget:

Cloned instance.

create

(
  • config
)

Applies standard extensions from a given config to create a new class using the static Base.build method.

Parameters:

  • config Object

destroy

(
  • destroyAllNodes
)
Widget chainable

Inherited from BaseObservable but overwritten in yui3/src/widget/js/Widget.js:448

<p> Destroy lifecycle method. Fires the destroy event, prior to invoking destructors for the class hierarchy.

Overrides Base's implementation, to support arguments to destroy </p> <p> Subscribers to the destroy event can invoke preventDefault on the event object, to prevent destruction from proceeding. </p>

Parameters:

  • destroyAllNodes Boolean

    <p><p><p>If true, all nodes contained within the Widget are removed and destroyed. Defaults to false due to potentially high run-time cost.</p></p></p>

Returns:

Widget:

<p><p><p>A reference to this object</p></p></p>

destructor

() protected

Destructor lifecycle implementation.

detach

(
  • type
  • fn
  • context
)
EventTarget

Detach one or more listeners the from the specified event

Parameters:

  • type String | Object

    <p><p><p><p><p><p><p><p>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.</p></p></p></p></p></p></p></p>

  • fn Function

    <p><p><p><p><p><p><p><p>The subscribed function to unsubscribe, if not supplied, all subscribers will be removed.</p></p></p></p></p></p></p></p>

  • context Object

    <p><p><p><p><p><p><p><p>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)</p></p></p></p></p></p></p></p>

Returns:

EventTarget:

<p><p><p><p><p><p><p><p>the host</p></p></p></p></p></p></p></p>

detachAll

(
  • type
)

Removes all listeners from the specified event. If the event type is not specified, all listeners from all hosted custom events will be removed.

Parameters:

  • type String

    <p><p><p><p><p><p><p><p>The type, or name of the event</p></p></p></p></p></p></p></p>

disable

() chainable

Set the Widget's "disabled" attribute to "true".

enable

() chainable

Set the Widget's "disabled" attribute to "false".

fire

(
  • type
  • arguments
)
Boolean

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

    <p><p><p><p><p><p><p><p>The type of the event, or an object that contains a 'type' property.</p></p></p></p></p></p></p></p>

  • arguments Object

    <p><p><p><p><p><p><p><p>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.</p></p></p></p></p></p></p></p>

Returns:

Boolean:

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

focus

() chainable

Causes the Widget to receive the focus by setting the "focused" attribute to "true".

get

(
  • name
)
Any

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

    <p><p><p><p><p><p><p><p>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. <code>get("x.y.z")</code>)</p></p></p></p></p></p></p></p>

Returns:

Any:

<p><p><p><p><p><p><p><p>The value of the attribute</p></p></p></p></p></p></p></p>

getAttrs

(
  • attrs
)
Object

Gets multiple attribute values.

Parameters:

  • attrs String | Boolean

    <p><p><p><p><p><p><p><p>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.</p></p></p></p></p></p></p></p>

Returns:

Object:

<p><p><p><p><p><p><p><p>An object with attribute name/value pairs.</p></p></p></p></p></p></p></p>

getById

(
  • id
)

Gets component's instance by id.

Parameters:

  • id Object

getClassName

(
  • args
)

Inherited from Widget but overwritten in yui3/src/widget/js/Widget.js:309

Generate a standard prefixed classname for the Widget, prefixed by the default prefix defined by the <code>Y.config.classNamePrefix</code> attribute used by <code>ClassNameManager</code> and <code>Widget.NAME.toLowerCase()</code> (e.g. "yui-widget-xxxxx-yyyyy", based on default values for the prefix and widget class name). <p> The instance based version of this method can be used to generate standard prefixed classnames, based on the instances NAME, as opposed to Widget.NAME. This method should be used when you need to use a constant class name across different types instances. </p>

Parameters:

  • args String multiple

    <p><p><p>0..n strings which should be concatenated, using the default separator defined by ClassNameManager, to create the class name</p></p></p>

getEvent

(
  • type
  • prefixed
)
CustomEvent

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

Parameters:

  • type String

    <p><p><p><p><p><p><p><p>the type, or name of the event</p></p></p></p></p></p></p></p>

  • prefixed String

    <p><p><p><p><p><p><p><p>if true, the type is prefixed already</p></p></p></p></p></p></p></p>

Returns:

CustomEvent:

<p><p><p><p><p><p><p><p>the custom event or null</p></p></p></p></p></p></p></p>

getSkinName

(
  • [skinPrefix]
)
String

Returns the name of the skin that's currently applied to the widget.

Searches up the Widget's ancestor axis for, by default, a class yui3-skin-(name), and returns the (name) portion. Otherwise, returns null.

This is only really useful after the widget's DOM structure is in the document, either by render or by progressive enhancement.

Parameters:

  • [skinPrefix] String optional

    <p><p><p>The prefix which the implementation uses for the skin ("yui3-skin-" is the default).</p> <p>NOTE: skinPrefix will be used as part of a regular expression:</p> <pre><code>new RegExp('\b' + skinPrefix + '(\S+)') </code></pre> <p>Although an unlikely use case, literal characters which may result in an invalid regular expression should be escaped.</p></p></p>

Returns:

String:

<p><p><p>The name of the skin, or null, if a matching skin class is not found.</p></p></p>

getString

(
  • key
)
String deprecated

Inherited from Widget: yui3/src/widget/js/Widget.js:1240

Deprecated: Used by deprecated WidgetLocale implementations.

Helper method to get a specific string value

Parameters:

  • key String

Returns:

String:

<p><p><p>The string</p></p></p>

getStrings

(
  • key
)
String deprecated

Inherited from Widget: yui3/src/widget/js/Widget.js:1252

Deprecated: Used by deprecated WidgetLocale implementations.

Helper method to get the complete set of strings for the widget

Parameters:

  • key String

Returns:

String:

<p><p><p>The strings</p></p></p>

getTargets

()

Returns an array of bubble targets for this object.

Returns:

<p><p><p><p><p><p><p><p>EventTarget[]</p></p></p></p></p></p></p></p>

hide

() chainable

Hides the Widget by setting the "visible" attribute to "false".

init

(
  • cfg
)
BaseCore chainable

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

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

Parameters:

  • cfg Object

    <p><p><p><p><p><p><p><p>Object with configuration property name/value pairs</p></p></p></p></p></p></p></p>

Returns:

BaseCore:

<p><p><p><p><p><p><p><p>A reference to this object</p></p></p></p></p></p></p></p>

initializer

(
  • config
)
protected

Construction logic executed during Component instantiation. Lifecycle.

Parameters:

  • config Object

isRoot

() Boolean

Determines if the Widget is the root Widget in the object hierarchy.

Returns:

Boolean:

<p><p><p>Boolean indicating if Widget is the root Widget in the object hierarchy.</p></p></p>

load

()

Load audio track.

modifyAttr

(
  • name
  • config
)

Updates the configuration of an attribute which has already been added. <p> 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: </p> <dl> <dt>readOnly;</dt> <dt>writeOnce;</dt> <dt>broadcast; and</dt> <dt>getter.</dt> </dl> <p> Note: New attributes cannot be added using this interface. New attributes must be added using addAttr, or an appropriate manner for a class which utilises Attributes (e.g. the ATTRS property in Base). </p>

Parameters:

  • name String

    <p><p><p><p><p><p><p><p>The name of the attribute whose configuration is to be updated.</p></p></p></p></p></p></p></p>

  • config Object

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

next

(
  • circular
)
Widget

Returns the Widget's next sibling.

Parameters:

  • circular Boolean

    <p><p><p>Boolean indicating if the parent's first child should be returned if the child has no next sibling.</p></p></p>

Returns:

Widget:

<p><p><p>Widget instance.</p></p></p>

on

(
  • type
  • fn
  • [context]
  • [arg*]
)
EventHandle

Subscribe a callback function to a custom event fired by this object or from an object that bubbles its events to this object.

 this.on("change", this._onChange, this);
                                                

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.

 this.on({
                                                     "attrChange" : this._onAttrChange,
                                                     "change"     : this._onChange
                                                 });
                                                

You can also pass an array of event names as the first argument to subscribe to all listed events with the same callback.

 this.on([ "change", "attrChange" ], this._onChange);
                                                

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

    <p><p><p><p><p><p><p><p>The name of the event</p></p></p></p></p></p></p></p>

  • fn Function

    <p><p><p><p><p><p><p><p>The callback to execute in response to the event</p></p></p></p></p></p></p></p>

  • [context] Object optional

    <p><p><p><p><p><p><p><p>Override <code>this</code> object in callback</p></p></p></p></p></p></p></p>

  • [arg*] Any optional

    <p><p><p><p><p><p><p><p>0..n additional arguments to supply to the subscriber</p></p></p></p></p></p></p></p>

Returns:

EventHandle:

<p><p><p><p><p><p><p><p>A subscription handle capable of detaching that subscription</p></p></p></p></p></p></p></p>

once

(
  • type
  • fn
  • [context]
  • [arg*]
)
EventHandle

Listen to a custom event hosted by this object one time. This is the equivalent to <code>on</code> except the listener is immediatelly detached when it is executed.

Parameters:

  • type String

    <p><p><p><p><p><p><p><p>The name of the event</p></p></p></p></p></p></p></p>

  • fn Function

    <p><p><p><p><p><p><p><p>The callback to execute in response to the event</p></p></p></p></p></p></p></p>

  • [context] Object optional

    <p><p><p><p><p><p><p><p>Override <code>this</code> object in callback</p></p></p></p></p></p></p></p>

  • [arg*] Any optional

    <p><p><p><p><p><p><p><p>0..n additional arguments to supply to the subscriber</p></p></p></p></p></p></p></p>

Returns:

EventHandle:

<p><p><p><p><p><p><p><p>A subscription handle capable of detaching the subscription</p></p></p></p></p></p></p></p>

onceAfter

(
  • type
  • fn
  • [context]
  • [arg*]
)
EventHandle

Listen to a custom event hosted by this object one time. This is the equivalent to <code>after</code> except the listener is immediatelly detached when it is executed.

Parameters:

  • type String

    <p><p><p><p><p><p><p><p>The name of the event</p></p></p></p></p></p></p></p>

  • fn Function

    <p><p><p><p><p><p><p><p>The callback to execute in response to the event</p></p></p></p></p></p></p></p>

  • [context] Object optional

    <p><p><p><p><p><p><p><p>Override <code>this</code> object in callback</p></p></p></p></p></p></p></p>

  • [arg*] Any optional

    <p><p><p><p><p><p><p><p>0..n additional arguments to supply to the subscriber</p></p></p></p></p></p></p></p>

Returns:

EventHandle:

<p><p><p><p><p><p><p><p>A subscription handle capable of detaching that subscription</p></p></p></p></p></p></p></p>

parseType

(
  • type
  • [pre]
)
Array

Inherited from EventTarget: yui3/src/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

    <p><p><p><p><p><p><p><p>the type</p></p></p></p></p></p></p></p>

  • [pre] String optional

    <p><p><p><p><p><p><p><p>The prefix. Defaults to this._yuievt.config.prefix</p></p></p></p></p></p></p></p>

Returns:

Array:

<p><p><p><p><p><p><p><p>an array containing:</p> <ul> <li>the detach category, if supplied,</li> <li>the prefixed event type,</li> <li>whether or not this is an after listener,</li> <li>the supplied event type</li> </ul></p></p></p></p></p></p></p>

pause

()

Pause audio track.

play

()

Play audio track.

previous

(
  • circular
)
Widget

Returns the Widget's previous sibling.

Parameters:

  • circular Boolean

    <p><p><p>Boolean indicating if the parent's last child should be returned if the child has no previous sibling.</p></p></p>

Returns:

Widget:

<p><p><p>Widget instance.</p></p></p>

publish

(
  • type
  • opts
)
CustomEvent

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

    <p><p><p><p><p><p><p><p>the type, or name of the event</p></p></p></p></p></p></p></p>

  • opts Object

    <p><p><p><p><p><p><p><p>optional config params. Valid properties are:</p></p></p></p></p></p></p></p>

    • [broadcast=false] Boolean optional

      <p><p><p><p><p><p><p><p>whether or not the YUI instance and YUI global are notified when the event is fired.</p></p></p></p></p></p></p></p>

    • [bubbles=true] Boolean optional

      <p><p><p><p><p><p><p><p>Whether or not this event bubbles. Events can only bubble if <code>emitFacade</code> is true.</p></p></p></p></p></p></p></p>

    • [context=this] Object optional

      <p><p><p><p><p><p><p><p>the default execution context for the listeners.</p></p></p></p></p></p></p></p>

    • [defaultFn] Function optional

      <p><p><p><p><p><p><p><p>the default function to execute when this event fires if preventDefault was not called.</p></p></p></p></p></p></p></p>

    • [emitFacade=false] Boolean optional

      <p><p><p><p><p><p><p><p>whether or not this event emits a facade.</p></p></p></p></p></p></p></p>

    • [prefix] String optional

      <p><p><p><p><p><p><p><p>the prefix for this targets events, e.g., 'menu' in 'menu:click'.</p></p></p></p></p></p></p></p>

    • [fireOnce=false] Boolean optional

      <p><p><p><p><p><p><p><p>if an event is configured to fire once, new subscribers after the fire will be notified immediately.</p></p></p></p></p></p></p></p>

    • [async=false] Boolean optional

      <p><p><p><p><p><p><p><p>fireOnce event listeners will fire synchronously if the event has already fired unless <code>async</code> is <code>true</code>.</p></p></p></p></p></p></p></p>

    • [preventable=true] Boolean optional

      <p><p><p><p><p><p><p><p>whether or not <code>preventDefault()</code> has an effect.</p></p></p></p></p></p></p></p>

    • [preventedFn] Function optional

      <p><p><p><p><p><p><p><p>a function that is executed when <code>preventDefault()</code> is called.</p></p></p></p></p></p></p></p>

    • [queuable=false] Boolean optional

      <p><p><p><p><p><p><p><p>whether or not this event can be queued during bubbling.</p></p></p></p></p></p></p></p>

    • [silent] Boolean optional

      <p><p><p><p><p><p><p><p>if silent is true, debug messages are not provided for this event.</p></p></p></p></p></p></p></p>

    • [stoppedFn] Function optional

      <p><p><p><p><p><p><p><p>a function that is executed when stopPropagation is called.</p></p></p></p></p></p></p></p>

    • [monitored] Boolean optional

      <p><p><p><p><p><p><p><p>specifies whether or not this event should send notifications about when the event has been attached, detached, or published.</p></p></p></p></p></p></p></p>

    • [type] String optional

      <p><p><p><p><p><p><p><p>the event type (valid option if not provided as the first parameter to publish).</p></p></p></p></p></p></p></p>

Returns:

CustomEvent:

<p><p><p><p><p><p><p><p>the custom event</p></p></p></p></p></p></p></p>

removeAttr

(
  • name
)

Removes an attribute from the host object

Parameters:

  • name String

    <p><p><p><p><p><p><p><p>The name of the attribute to be removed.</p></p></p></p></p></p></p></p>

removeTarget

(
  • o
)
chainable

Removes a bubble target

Parameters:

  • o EventTarget

    <p><p><p><p><p><p><p><p>the target to remove</p></p></p></p></p></p></p></p>

render

(
  • parentNode
)
final chainable

Establishes the initial DOM for the widget. Invoking this method will lead to the creating of all DOM elements for the widget (or the manipulation of existing DOM elements for the progressive enhancement use case). <p> This method should only be invoked once for an initialized widget. </p> <p> It delegates to the widget specific renderer method to do the actual work. </p>

Parameters:

  • parentNode Object | String

    <p><p><p>Optional. The Node under which the Widget is to be rendered. This can be a Node instance or a CSS selector string. <p> If the selector string returns more than one Node, the first node will be used as the parentNode. NOTE: This argument is required if both the boundingBox and contentBox are not currently in the document. If it's not provided, the Widget will be rendered to the body of the current document in this case. </p></p></p></p>

renderer

() protected

Creates DOM (or manipulates DOM for progressive enhancement) This method is invoked by render() and is not chained automatically for the class hierarchy (unlike initializer, destructor) so it should be chained manually for subclasses if required.

renderUI

() protected

Inherited from Widget but overwritten in alloy-ui/src/aui-audio/js/aui-audio.js:229

Render the Audio component instance. Lifecycle.

reset

(
  • name
)
Object chainable

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

Parameters:

  • name String

    <p><p><p><p><p><p><p><p>Optional. The name of the attribute to reset. If omitted, all attributes are reset.</p></p></p></p></p></p></p></p>

Returns:

Object:

<p><p><p><p><p><p><p><p>A reference to the host object.</p></p></p></p></p></p></p></p>

set

(
  • name
  • value
  • [opts]
)
Object chainable

Sets the value of an attribute.

Parameters:

  • name String

    <p><p><p><p><p><p><p><p>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. <code>set("x.y.z", 5)</code>).</p></p></p></p></p></p></p></p>

  • value Any

    <p><p><p><p><p><p><p><p>The value to set the attribute to.</p></p></p></p></p></p></p></p>

  • [opts] Object optional

    <p><p><p><p><p><p><p><p>Optional data providing the circumstances for the change.</p></p></p></p></p></p></p></p>

Returns:

Object:

<p><p><p><p><p><p><p><p>A reference to the host object.</p></p></p></p></p></p></p></p>

setAttrs

(
  • attrs
  • [opts]
)
Object chainable

Sets multiple attribute values.

Parameters:

  • attrs Object

    <p><p><p><p><p><p><p><p>An object with attributes name/value pairs.</p></p></p></p></p></p></p></p>

  • [opts] Object optional

    <p><p><p><p><p><p><p><p>Optional data providing the circumstances for the change.</p></p></p></p></p></p></p></p>

Returns:

Object:

<p><p><p><p><p><p><p><p>A reference to the host object.</p></p></p></p></p></p></p></p>

show

() chainable

Shows the Widget by setting the "visible" attribute to "true".

subscribe

() deprecated

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

Deprecated: use on

subscribe to an event

syncUI

() protected

Inherited from Widget but overwritten in alloy-ui/src/aui-audio/js/aui-audio.js:267

Sync the Audio UI. Lifecycle.

toggle

(
  • visible
)

Toggles widget visibility.

Parameters:

  • visible Boolean

    Force the widget to be visible.

toString

() String

Inherited from BaseCore but overwritten in yui3/src/widget/js/Widget.js:1122

Generic toString implementation for all widgets.

Returns:

String:

<p><p><p>The default string value for the widget [ displays the NAME of the instance, and the unique id ]</p></p></p>

unsubscribe

() deprecated

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

Deprecated: use detach

detach a listener

unsubscribeAll

(
  • type
)
deprecated

Inherited from EventTarget: yui3/src/event-custom/js/event-target.js:490

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

    <p><p><p><p><p><p><p><p>The type, or name of the event</p></p></p></p></p></p></p></p>

Properties

_allowAdHocAttrs

Boolean protected

This property controls whether or not instances of this class should allow users to add ad-hoc attributes through the constructor configuration hash.

AdHoc attributes are attributes which are not defined by the class, and are not handled by the MyClass._NON_ATTRS_CFG

Default: undefined (false)

_UI_ATTRS

Object private

The lists of UI attributes to bind and sync for widget's _bindUI and _syncUI implementations

ATTRS

Object static

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

BIND_UI_ATTRS

Array static

Static property used to define the attributes for the bindUI lifecycle phase.

BOUNDING_TEMPLATE

String

Property defining the markup template for bounding box.

CONTENT_TEMPLATE

String

Property defining the markup template for content box. If your Widget doesn't need the dual boundingBox/contentBox structure, set CONTENT_TEMPLATE to null, and contentBox and boundingBox will both point to the same Node.

DEF_PARENT_NODE

String | Node

Default node to render the bounding box to. If not set, will default to the current document body.

DEF_UNIT

String

Default unit to use for dimension values

NAME

String static

Static property provides a string to identify the class.

name

String deprecated

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

Deprecated: Use this.constructor.NAME

The string used to identify the class of this object.

SYNC_UI_ATTRS

Array static

Static property used to define the attributes for the syncUI lifecycle phase.

UI_EVENTS

Object

Map of DOM events that should be fired as Custom Events by the Widget instance.

Attributes

boundingBox

String | Node

Inherited from Widget: