A.Tab

Extends: Tab

Defined in: alloy-ui/src/aui-tabview/js/aui-tabview.js:38

Module: aui-tabview

A base class for Tab.

Check the live demo.

Constructor

`A.Tab`

(

config

)

Defined in alloy-ui/src/aui-tabview/js/aui-tabview.js:38

Parameters:

config Object

Object literal specifying widget configuration properties.

Example:

<div id="myTab">
                                    
                                     <ul class="nav nav-tabs">
                                       <li><a href="#tab-1">Tab #1</a></li>
                                       <li class="active"><a href="#tab-2">Tab #2</a></li>
                                       <li><a href="#tab-3">Tab #3</a></li>
                                     </ul>
                                    
                                     <div class="tab-content">
                                       <div id="tab-1" class="tab-pane">
                                         <p>Lorem ipsum dolor sit amet, consectetur adipisicing elit. Accusamus dicta aspernatur beatae fuga neque cupiditate laudantium itaque pariatur deleniti tenetur modi voluptatem animi sunt eligendi nisi corporis expedita quaerat facilis.</p>
                                       </div>
                                       <div id="tab-2">
                                         <p>Doloremque beatae rem voluptate nulla perspiciatis atque laudantium nihil impedit molestiae fuga veritatis quibusdam nam maiores aliquid. Deserunt dolorum quas temporibus enim ex nihil nemo perspiciatis. Nisi deserunt rem id pariatur in nostrum?</p>
                                       </div>
                                       <div id="tab-3" class="tab-pane">
                                         <p>Aliquid ipsum asperiores alias temporibus autem impedit soluta ut id iure explicabo veritatis consectetur debitis eaque recusandae odit quas nobis maxime saepe. Incidunt amet obcaecati. Ducimus soluta unde repellat laboriosam fuga modi rem itaque!</p>
                                       </div>
                                     </div>
                                    
                                    </div>

YUI().use(
                                     'aui-tabview',
                                     function(Y) {
                                       new Y.TabView(
                                         {
                                           srcNode: '#myTab'
                                         }
                                       ).render();
                                     }
                                    );

Index

Methods

`_addAttrs`

(

cfgs
values
lazy

)

private

Inherited from AttributeCore: yui3/src/attribute/js/AttributeCore.js:877

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

`_addLazyAttr`

(

name
[lazyCfg]

)

private

Inherited from AttributeCore: yui3/src/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: yui3/src/attribute/js/AttributeCore.js:550

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

`_afterChildSelectedChange`

(

event

)

protected

Inherited from Widget: yui3/src/widget-child/js/Widget-Child.js:327

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

Parameters:

event EventFacade

The event facade for the attribute change.

`_afterUiSetDisabled`

(

val

)

protected

Defined in alloy-ui/src/aui-tabview/js/aui-tabview.js:153

Fire after disabled attribute been set on the UI.

Parameters:

val Object

`_aggregateAttrs`

(

allAttrs

)

Object private

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

`_applyParsedConfig`

() Object protected

Inherited from Widget: yui3/src/widget/js/WidgetHTMLParser.js:121

Returns:

Object:

The merged configuration literal

`_applyParser`

(

config

)

protected

Inherited from Widget: yui3/src/widget/js/WidgetHTMLParser.js:130

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

Parameters:

config Object

User configuration object (will be populated with values from Node)

`_attrCfgHash`

() private

Inherited from BaseCore: yui3/src/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: yui3/src/base/js/BaseCore.js:364

Internal destroy implementation for BaseCore

`_baseInit`

() private

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

Internal initialization implementation for BaseCore

`_bindAttrUI`

(

attrs

)

private

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

Binds after listeners for the list of attributes provided

Parameters:

attrs Array

`_bindDOM`

() protected

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

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

`_bindUI`

() protected

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

Sets up DOM and CustomEvent listeners for the widget.

`_bindUIChild`

() protected

Inherited from Widget: yui3/src/widget-child/js/Widget-Child.js:356

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

`_cloneDefaultValue`

(

cfg

)

private

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

`_createUIEvent`

(

type

)

private

Inherited from Widget: yui3/src/widget/js/WidgetUIEvents.js:73

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

String representing the name of the event

`_defAttrChangeFn`

(

e
eventFastPath

)

private

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

`_defaultBB`

() protected

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

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

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

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`

(

)

protected

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

Default destroy event handler

Parameters:

e EventFacade

Event object

`_defInitFn`

(

)

protected

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

`_defRenderFn`

(

e
parentNode

)

protected

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

Default render handler

Parameters:

e EventFacade

The Event object
parentNode Node

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

`_defStartNavigateFn`

(

event

)

Provided by the aui-sortable-list module.

Defined in alloy-ui/src/aui-surface/js/aui-surface-app.js:286

Starts navigation to a path.

Parameters:

event EventFacade

Event facade containing path and replaceHistory.

`_destroyBox`

() protected

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

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

`_destroyHierarchy`

() private

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

`_destroyUIEvents`

() private

Inherited from Widget: yui3/src/widget/js/WidgetUIEvents.js:20

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

`_doNavigate`

(

path
opt_replaceHistory

)

Promise

Provided by the aui-sortable-list module.

Defined in alloy-ui/src/aui-surface/js/aui-surface-app.js:316

Starts navigation to a path.

Parameters:

path String

Path containing the querystring part.
opt_replaceHistory Boolean

Replaces browser history.

Returns:

Promise:

Returns a pending request cancellable promise.

`_filterAdHocAttrs`

(

allAttrs
userVals

)

Object private

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

`_filterUIEvent`

(

evt

)

Boolean private

Inherited from Widget: yui3/src/widget/js/WidgetUIEvents.js:117

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

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

Parameters:

evt DOMEventFacade

Returns:

Boolean:

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

`_finalizeNavigate`

(

path
nextScreen
opt_replaceHistory

)

private

Provided by the aui-sortable-list module.

Defined in alloy-ui/src/aui-surface/js/aui-surface-app.js:380

Finalizes a screen navigation.

Parameters:

path String

Path containing the querystring part.
nextScreen Screen
opt_replaceHistory Boolean

Replaces browser history.

`_fireAttrChange`

(

attrName
subAttrName
currVal
newVal
opts
[cfg]

)

private

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

`_getAttr`

(

name

)

Any protected chainable

Inherited from AttributeCore: yui3/src/attribute/js/AttributeCore.js:587

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

The name of the attribute.

Returns:

Any:

The value of the attribute.

`_getAttrCfg`

(

name

)

Object protected

Inherited from AttributeExtras: yui3/src/attribute/js/AttributeExtras.js:125

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: yui3/src/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: yui3/src/attribute/js/AttributeCore.js:986

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: yui3/src/attribute/js/AttributeCore.js:815

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

Parameters:

attrs String | 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: yui3/src/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.

`_getFullType`

(

type

)

String private

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

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

`_getHtmlParser`

() Object private

Inherited from Widget: yui3/src/widget/js/WidgetHTMLParser.js:187

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

Returns:

Object:

HTML_PARSER definition for this instance

`_getInstanceAttrCfgs`

(

allCfgs

)

Object private

Inherited from BaseCore: yui3/src/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 <code>addAttrs</code>.

`_getNodeToParse`

() Node private

Inherited from Widget: yui3/src/widget/js/WidgetHTMLParser.js:172

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:

The node reference to apply HTML_PARSER to.

`_getScreenInstance`

(

path

)

private

Provided by the aui-sortable-list module.

Defined in alloy-ui/src/aui-surface/js/aui-surface-app.js:494

Retrieves or create a screen instance to a path.

Parameters:

path String

Path containing the querystring part.

`_getSrcNode`

() Node protected

Inherited from Widget: yui3/src/widget/js/WidgetHTMLParser.js:74

Returns:

Node:

The Node to apply HTML_PARSER to

`_getStateVal`

(

name
[cfg]

)

Any private

Inherited from AttributeCore: yui3/src/attribute/js/AttributeCore.js:641

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: yui3/src/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.

`_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

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

`_handleNavigateError`

(

path
nextScreen
error

)

private

Provided by the aui-sortable-list module.

Defined in alloy-ui/src/aui-surface/js/aui-surface-app.js:412

Handle navigation error.

Parameters:

path String

Path containing the querystring part.
nextScreen Screen
error Error

`_hasPotentialSubscribers`

(

fullType

)

Boolean private

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

`_initAttrHost`

(

attrs
values
lazy

)

private

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

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.
lazy Boolean

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

`_initAttribute`

() private

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

Initializes AttributeCore

`_initAttrs`

(

attrs
values
lazy

)

protected

Inherited from AttributeCore: yui3/src/attribute/js/AttributeCore.js:1052

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 <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.
values Object

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.
lazy Boolean

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

`_initBase`

(

config

)

private

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

Internal construction logic for BaseCore.

Parameters:

config Object

The constructor configuration object

`_initHierarchy`

(

userVals

)

private

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

Object with configuration property name/value pairs

`_initHierarchyData`

() private

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

`_initUIEvent`

(

type

)

String private

Inherited from Widget: yui3/src/widget/js/WidgetUIEvents.js:176

Sets up infrastructure required to fire a UI event.

Parameters:

type String

String representing the name of the event

Returns:

String:

`_isLazyAttr`

(

name

)

Boolean private

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

`_isLinkSameOrigin`

(

hostname

)

Boolean private

Provided by the aui-sortable-list module.

Defined in alloy-ui/src/aui-surface/js/aui-surface-app.js:427

Tests if hostname is an offsite link.

Parameters:

hostname String

Link hostname to compare with window.location.hostname.

Returns:

Boolean:

`_isUIEvent`

(

type

)

String private

Inherited from Widget: yui3/src/widget/js/WidgetUIEvents.js:143

Determines if the specified event is a UI event.

Parameters:

type String

String representing the name of the event

Returns:

String:

Event Returns the name of the UI Event, otherwise undefined.

`_lockScroll`

() private

Provided by the aui-sortable-list module.

Defined in alloy-ui/src/aui-surface/js/aui-surface-app.js:451

Lock the document scroll in order to avoid the browser native back and forward navigation to change the scroll position. Surface app takes care of updating it when surfaces are ready.

`_makeId`

(

screenId

)

String

Provided by the aui-sortable-list module.

Defined in alloy-ui/src/aui-surface/js/aui-surface-base.js:202

Make the id for the element that holds content for a screen.

Parameters:

screenId String

The screen id the content belongs too.

Returns:

String:

`_mapInstance`

(

The

)

protected

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

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

boundingBox id

`_monitor`

(

what
eventType
o

)

private

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

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: yui3/src/attribute/js/AttributeCore.js:938

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.

`_onDocClick`

(

event

)

private

Provided by the aui-sortable-list module.

Defined in alloy-ui/src/aui-surface/js/aui-surface-app.js:528

Intercepts document clicks and test link elements in order to decide whether Surface app can navigate.

Parameters:

event EventFacade

Event facade

`_onDocFocus`

(

evt

)

protected

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

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

Parameters:

evt EventFacade

The event facade for the DOM focus event

`_onDocMouseDown`

(

evt

)

protected

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

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

Parameters:

evt EventFacade

The event facade for the DOM focus event

`_onLoad`

() private

Provided by the aui-sortable-list module.

Defined in alloy-ui/src/aui-surface/js/aui-surface-app.js:570

Listens to the window's load event in order avoid issues with some browsers that trigger popstate calls on the first load. For more information see http://stackoverflow.com/questions/6421769/popstate-on-pages-load-in-chrome.

`_onPopState`

(

event

)

private

Provided by the aui-sortable-list module.

Defined in alloy-ui/src/aui-surface/js/aui-surface-app.js:589

Handles browser history changes and fires app's navigation if the state belows to us. If we detect a popstate and the state is null, assume it is navigating to an external page or to a page we don't have route, then window.location.reload() is invoked in order to reload the content to the current url.

Parameters:

event EventFacade

Event facade

`_onScroll`

(

event

)

private

Provided by the aui-sortable-list module.

Defined in alloy-ui/src/aui-surface/js/aui-surface-app.js:621

Listens document scroll changes in order to capture the possible lock scroll position for history scrolling.

Parameters:

event EventFacade

Event facade

`_onTabSelectedChange`

(

event

)

protected

Defined in alloy-ui/src/aui-tabview/js/aui-tabview.js:166

Fire before selected attribute change.

Parameters:

event Object

`_parseType`

() private

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

`_preAddAttrs`

(

attrs
userVals
lazy

)

protected

Inherited from Widget: yui3/src/widget/js/WidgetHTMLParser.js:83

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

The full hash of statically defined ATTRS attributes being added for this instance
userVals Object

The hash of user values passed to the constructor
lazy Boolean

Whether or not to add the attributes lazily

`_preInitEventCfg`

(

config

)

private

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

`_preventNavigateFn`

(

event

)

Provided by the aui-sortable-list module.

Defined in alloy-ui/src/aui-surface/js/aui-surface-app.js:634

Fires when navigation is prevented from startNavigate event.

Parameters:

event EventFacade

`_protectAttrs`

(

attrs

)

Object deprecated protected

Inherited from AttributeCore: yui3/src/attribute/js/AttributeCore.js:924

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: yui3/src/event-custom/js/event-target.js:588

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 <code>etOpts</code> or <code>ceOpts</code>, this will be the default <code>CustomEvent</code> instance, and can be configured independently.

`_registerRoutes`

(

screenRoutes

)

private

Provided by the aui-sortable-list module.

Defined in alloy-ui/src/aui-surface/js/aui-surface-app.js:664

Registers a route for a screen.

Parameters:

screenRoutes Array

Array of objects with path and screen keys or A.ScreenRoute instances.

`_removeLoadingClassNames`

() protected

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

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

`_removeScreen`

(

path
screen

)

private

Provided by the aui-sortable-list module.

Defined in alloy-ui/src/aui-surface/js/aui-surface-app.js:645

Removes a screen.

Parameters:

path String

Path containing the querystring part.
screen Screen

`_renderBox`

(

parentNode

)

private

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

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

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.

`_renderBoxClassNames`

() protected

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

Applies standard class names to the boundingBox and contentBox

`_renderPanel`

() protected

Defined in alloy-ui/src/aui-tabview/js/aui-tabview.js:181

Render tab panel.

`_renderUI`

() protected

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

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

`_set`

(

name
val
[opts]

)

Object protected chainable

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

Allows setting of readOnly/writeOnce attributes. See <a href="#method_set">set</a> 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: yui3/src/attribute/js/AttributeCore.js:421

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

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 yui3/src/attribute/js/AttributeCore.js:783

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.

`_setAttrUI`

(

)

private

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

Parameters:

e EventFacade

`_setAttrVal`

(

attrName
subAttrName
prevVal
newVal
[opts]
[attrCfg]

)

Boolean private

Inherited from AttributeCore: yui3/src/attribute/js/AttributeCore.js:681

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:

Boolean:

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

`_setBB`

(

node

)

private

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

Setter for the boundingBox attribute

Parameters:

node Node | String

Returns:

Node

`_setBox`

(

id
node
template
isBounding

)

Node private

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

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

Parameters:

id String

The node's id attribute
node Node | String

The node reference
template String

HTML string template for the node
isBounding Boolean

true if this is the boundingBox, false if it's the contentBox

Returns:

Node:

The node

`_setCacheable`

() Object protected

Provided by the aui-sortable-list module.

Defined in alloy-ui/src/aui-surface/js/aui-surface-screen.js:221

Sets the cache content.

Returns:

Object:

Cached content.

`_setCB`

(

node

)

private

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

Setter for the contentBox attribute

Parameters:

node Node | String

Returns:

`_setId`

(

val

)

String

Provided by the aui-sortable-list module.

Defined in alloy-ui/src/aui-surface/js/aui-surface-screen.js:115

Sets the id attribute.

Parameters:

val String

The screen id to be set.

Returns:

String:

Value of the screen name concatenated with the id.

`_setScreenTitleFromFragment`

(

frag

)

Provided by the aui-sortable-list module.

Defined in alloy-ui/src/aui-surface/js/aui-surface-screen-html.js:134

Retrieves the title from the provided content and sets it to title attribute of the class.

Parameters:

frag Node

The container from which the title should be retrieve.

`_setStateVal`

(

name
value

)

private

Inherited from AttributeCore: yui3/src/attribute/js/AttributeCore.js:663

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

`_setUrlParams`

() String | Object protected

Provided by the aui-sortable-list module.

Defined in alloy-ui/src/aui-surface/js/aui-surface-screen-html.js:113

Setter for urlParams attribute.

Returns:

String | Object:

If the provided value was string, it will be converted to Object with one property - the provided string and "1" as value. Otherwise, the provided object will be passed directly to the attribute value.

`_stopPending`

() protected

Provided by the aui-sortable-list module.

Defined in alloy-ui/src/aui-surface/js/aui-surface-app.js:717

Cancels pending navigate with Cancel pending navigation error.

`_strSetter`

(

strings

)

String protected

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

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:

The full set of strings to set

`_syncAttrUI`

(

attrs

)

private

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

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

Parameters:

attrs Array

`_syncScrollPosition`

(

opt_replaceHistory

)

private

Provided by the aui-sortable-list module.

Defined in alloy-ui/src/aui-surface/js/aui-surface-app.js:687

Sync document scroll position to the values captured when the default back and forward navigation happened. The scroll position updates after beforeFlip is called and before the surface transitions.

Parameters:

opt_replaceHistory Boolean

Replaces browser history.

`_syncUI`

() protected

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

Updates the widget UI to reflect the attribute state.

`_syncUIChild`

() protected

Inherited from Widget: yui3/src/widget-child/js/Widget-Child.js:341

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

`_uiSetChildSelected`

(

selected

)

protected

Inherited from Widget: yui3/src/widget-child/js/Widget-Child.js:305

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

Parameters:

selected Number

The selected value to be reflected in the UI.

`_uiSetDim`

(

dim
val

)

private

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

Parameters:

dim String

The dimension - "width" or "height"
val Number | String

The value to set

`_uiSetDisabled`

(

val

)

protected

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

Sets the disabled state for the UI

Parameters:

val Boolean

`_uiSetFocused`

(

val
src

)

protected

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

Sets the focused state for the UI

Parameters:

val Boolean
src String

String representing the source that triggered an update to the UI.

`_uiSetHeight`

(

val

)

protected

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

Sets the height on the widget's bounding box element

Parameters:

val String | Number

`_uiSetTabIndex`

(

Number

)

protected

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

Set the tabIndex on the widget's rendered UI

Parameters:

Number Object

`_uiSetVisible`

(

val

)

protected

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

Sets the visible state for the UI

Parameters:

val Boolean

`_uiSetWidth`

(

val

)

protected

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

Sets the width on the widget's bounding box element

Parameters:

val String | Number

`_uiSizeCB`

(

expand

)

protected

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

Parameters:

expand Boolean

`_unbindDOM`

() protected

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

`_unbindUI`

() protected

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

`_updateHistory`

(

path
title
opt_replaceHistory

)

private

Provided by the aui-sortable-list module.

Defined in alloy-ui/src/aui-surface/js/aui-surface-app.js:730

Updates or replace browser history.

Parameters:

path String

Path containing the querystring part.
title String

Document title.
opt_replaceHistory Boolean

Replaces browser history.

`_validatePath`

(

value

)

protected

Provided by the aui-sortable-list module.

Defined in alloy-ui/src/aui-surface/js/aui-surface-screen-route.js:25

Validates the value of path attribute. A value will be accepted as valid if it is String, RegExp or Function.

Parameters:

value String | RegExp | Function

The provided value to be validated.

`_validateScreen`

(

value

)

protected

Provided by the aui-sortable-list module.

Defined in alloy-ui/src/aui-surface/js/aui-surface-screen-route.js:38

Validates the value of screen attribute. A value will be accepted as valid if it is component like A.Screen or class which extends A.Screen, for example A.HTMLScreen.

Parameters:

value Function

The provided value to be validated.

`_validateUrlParams`

() Boolean protected

Provided by the aui-sortable-list module.

Defined in alloy-ui/src/aui-surface/js/aui-surface-screen-html.js:150

Validates the value of urlParams. The value could be String or Object with key and values. During URL construction, they will be added to the other parameters.

Returns:

Boolean:

true if val is String or an Object.

`_validTabIndex`

(

tabIndex

)

protected

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

Parameters:

tabIndex Number

`_valueDisabled`

() Boolean protected

Defined in alloy-ui/src/aui-tabview/js/aui-tabview.js:200

Determines the value of the disabled attribute.

Returns:

Boolean:

`_valueId`

() String

Provided by the aui-sortable-list module.

Defined in alloy-ui/src/aui-surface/js/aui-surface-screen.js:126

Value of the id attribute.

Returns:

String:

`abortRequest`

()

Provided by the aui-sortable-list module.

Defined in alloy-ui/src/aui-surface/js/aui-surface-screen-html.js:11

Aborts any outstanding request.

`activate`

()

Provided by the aui-sortable-list module.

Defined in alloy-ui/src/aui-surface/js/aui-surface-screen.js:8

Fires when the screen is active. Allows a screen to perform any setup that requires its DOM to be visible. Lifecycle.

`addAttr`

(

name
config
lazy

)

Object chainable

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

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

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

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

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

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

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

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

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: yui3/src/attribute/js/AttributeCore.js:846

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

Returns:

Object:

A reference to the host object.

`addCache`

(

surfaceId
content

)

Provided by the aui-sortable-list module.

Defined in alloy-ui/src/aui-surface/js/aui-surface-screen.js:176

Adds content to the cache.

Parameters:

surfaceId String

The id of the surface DOM element.
content String

Content to be cached.

`addContent`

(

screenId
opt_content

)

Node

Provided by the aui-sortable-list module.

Defined in alloy-ui/src/aui-surface/js/aui-surface-base.js:53

Adds screen content to a surface. If content hasn't been passed, see if an element exists in the DOM that matches the id. By convention, the element should already be nested in the right element and should have an id that is a concatentation of the surface id + '-' + the screen id.

Parameters:

screenId String

The screen id the content belongs too.
opt_content String | Node

The string content or node to add.

Returns:

Node:

`addScreenRoutes`

(

or

)

chainable

Provided by the aui-sortable-list module.

Defined in alloy-ui/src/aui-surface/js/aui-surface-app.js:146

Adds one or more screens to the application.

Parameters:

or Object

{Array} screens Single object or an array of object. Each object should contain path and screen. The path should be a string or a regex that maps the navigation route to a screen class definition (not an instance), e.g: { path: "/home:param1", screen: Y.MyScreen } { path: /foo.+/, screen: Y.MyScreen }

`addSurfaces`

(

or

)

chainable

Provided by the aui-sortable-list module.

Defined in alloy-ui/src/aui-surface/js/aui-surface-app.js:163

Adds one or more surfaces to the application.

Parameters:

or Surface

{String} or [{Surface | String}] surfaces String (id) or Surface instance. You can also pass an Array which contains Surface instances or String (id). In case of ID, these should be the ID of surface DOM element.

`addTarget`

(

)

chainable

Inherited from EventTarget: yui3/src/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: yui3/src/event-custom/js/event-target.js:812

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 <code>this</code> 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

`ancestor`

(

depth

)

Widget

Inherited from Widget: yui3/src/widget-child/js/Widget-Child.js:279

Returns the Widget instance at the specified depth.

Parameters:

depth Number

Number representing the depth of the ancestor.

Returns:

Widget:

Widget instance.

`attrAdded`

(

name

)

Boolean

Inherited from AttributeCore: yui3/src/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: yui3/src/event-custom/js/event-target.js:849

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

`beforeDeactivate`

() Boolean

Provided by the aui-sortable-list module.

Defined in alloy-ui/src/aui-surface/js/aui-surface-screen.js:18

Gives the Screen a chance to cancel the navigation and stop itself from being deactivated. Can be used, for example, if the screen has unsaved state. Lifecycle.

Clean-up should not be preformed here, since the navigation may still be cancelled. Do clean-up in deactivate.

Returns:

Boolean:

`bindUI`

() protected

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

Configures/Sets up listeners to bind Widget State to UI/DOM

This method is not called by framework and is not chained automatically for the class hierarchy.

`blur`

() chainable

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

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

`bubble`

(

evt

)

Boolean

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

`clearCache`

()

Provided by the aui-sortable-list module.

Defined in alloy-ui/src/aui-surface/js/aui-surface-screen.js:192

Clears the cache.

`createChild`

(

screenId

)

Node | null

Provided by the aui-sortable-list module.

Defined in alloy-ui/src/aui-surface/js/aui-surface-base.js:84

Creates child node of the surface.

Parameters:

screenId String

The screen id.

Returns:

Node | null:

`deactivate`

()

Provided by the aui-sortable-list module.

Defined in alloy-ui/src/aui-surface/js/aui-surface-screen.js:53

Allows a screen to do any cleanup necessary after it has been deactivated, for example cancelling outstanding XHRs or stopping timers. Lifecycle.

`destroy`

(

destroyAllNodes

)

Widget chainable

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

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

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

Parameters:

destroyAllNodes Boolean

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

Returns:

Widget:

A reference to this object

`destructor`

()

Provided by the aui-sortable-list module.

Defined in alloy-ui/src/aui-surface/js/aui-surface-screen.js:201

Destroys a cacheable screen.

`destructor`

()

Inherited from Widget but overwritten in alloy-ui/src/aui-surface/js/aui-surface-screen.js:64

Destroy a screen, either after it is deactivated (in the case of a non-cacheable view) or when the App is itself disposed for whatever reason. Lifecycle.

`detach`

(

type
fn
context

)

EventTarget

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

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: yui3/src/event-custom/js/event-target.js:479

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

`disable`

() chainable

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

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

`dispatch`

() Promise

Provided by the aui-sortable-list module.

Defined in alloy-ui/src/aui-surface/js/aui-surface-app.js:189

Dispatches to the first route handler that matches the current path, if any.

Returns:

Promise:

Returns a pending request cancellable promise.

`enable`

() chainable

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

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

`fire`

(

type
arguments

)

Boolean

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

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.

`flip`

() Promise

Provided by the aui-sortable-list module.

Defined in alloy-ui/src/aui-surface/js/aui-surface-screen.js:33

Allows a screen to perform any setup immediately before the DOM is made visible. Lifecycle.

Returns:

Promise:

This can return a promise, which will pause the navigation until it is resolved.

`focus`

() chainable

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

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

`get`

(

name

)

Any

Inherited from AttributeCore: yui3/src/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. <code>get("x.y.z")</code>)

Returns:

Any:

The value of the attribute

`getAttrs`

(

attrs

)

Object

Inherited from AttributeCore: yui3/src/attribute/js/AttributeCore.js:803

Gets multiple attribute values.

Parameters:

attrs String | 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.

`getCache`

() Object protected

Provided by the aui-sortable-list module.

Defined in alloy-ui/src/aui-surface/js/aui-surface-screen.js:210

If the screen is cacheable returns the cached content for the surfaces.

Returns:

Object:

Cached content.

`getChild`

(

screenId

)

Node | null

Provided by the aui-sortable-list module.

Defined in alloy-ui/src/aui-surface/js/aui-surface-base.js:95

Gets child node of the surface.

Parameters:

screenId String

The screen id.

Returns:

Node | null:

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

Parameters:

args String multiple

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

`getEl`

(

opt_id

)

Node

Provided by the aui-sortable-list module.

Defined in alloy-ui/src/aui-surface/js/aui-surface-base.js:106

Retrieves the surface element from DOM, and sets it to the el property of the current instance.

Parameters:

opt_id String

The ID of the surface element. If not provided, this.el will be used.

Returns:

Node:

The retrieved element.

`getEvent`

(

type
prefixed

)

CustomEvent

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

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

`getSkinName`

(

[skinPrefix]

)

String

Inherited from Widget: yui3/src/widget/js/WidgetSkin.js:12

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

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

Returns:

String:

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

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

The string

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

The strings

`getSurfaceContent`

(

surfaceId

)

String | Node

Provided by the aui-sortable-list module.

Defined in alloy-ui/src/aui-surface/js/aui-surface-screen-html.js:22

Returns content for given surface from the provided content.

Parameters:

surfaceId String

The ID of the surface, which content should be loaded.

Returns:

String | Node:

String or Node instance which contains the content of the surface.

`getSurfaceContent`

(

surfaceId
opt_contents

)

String | Node

Provided by the aui-sortable-list module.

Defined in alloy-ui/src/aui-surface/js/aui-surface-screen.js:75

Returns the content for the given surface, or null if the surface isn't used by this screen. This will be called when a screen is initially constructed or, if a screen is non-cacheable, when navigated.

Parameters:

surfaceId String

The id of the surface DOM element.
opt_contents String

Optional content fetch by getSurfacesContent.

Returns:

String | Node:

This can return a string or node representing the content of the surface.

`getSurfacesContent`

(

path

)

String | Promise

Provided by the aui-sortable-list module.

Defined in alloy-ui/src/aui-surface/js/aui-surface-screen.js:91

Returns all contents for the surfaces. This will pass an opt_contents to getSurfaceContent with all information you need to fulfill the surfaces. Lifecycle.

Parameters:

path String

The requested path.

Returns:

String | Promise:

This can return a string representing the contents of the surfaces or a promise, which will pause the navigation until it is resolved. This is useful for loading async content.

`getTargets`

()

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

Returns an array of bubble targets for this object.

Returns:

EventTarget[]

`hide`

() chainable

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

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

Object with configuration property name/value pairs

Returns:

BaseCore:

A reference to this object

`initializer`

() protected

Provided by the aui-sortable-list module.

Defined in alloy-ui/src/aui-surface/js/aui-surface-base.js:34

Construction logic executed during Surface instantiation. Lifecycle.

`initializer`

() protected

Defined in alloy-ui/src/aui-tabview/js/aui-tabview.js:139

Construction logic executed during Tab instantiation. Lifecycle.

`initializer`

() protected

Inherited from Widget but overwritten in alloy-ui/src/aui-surface/js/aui-surface-app.js:120

Construction logic executed during SurfaceApp instantiation. Lifecycle.

`isRoot`

() Boolean

Inherited from Widget: yui3/src/widget-child/js/Widget-Child.js:267

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

Returns:

Boolean:

Boolean indicating if Widget is the root Widget in the object hierarchy.

`load`

() CancellablePromise

Provided by the aui-sortable-list module.

Defined in alloy-ui/src/aui-surface/js/aui-surface-screen-html.js:41

Loads the content for all surfaces in one AJAX request from the server.

Returns:

CancellablePromise:

Promise, which should be resolved with the returned content from the server.

`loadContent`

() CancellablePromise protected

Provided by the aui-sortable-list module.

Defined in alloy-ui/src/aui-surface/js/aui-surface-screen-html.js:61

Loads the content from server via single AJAX request.

Returns:

CancellablePromise:

Promise, which should be resolved with the returned content from the server.

`matchesPath`

(

path

)

Object | null

Provided by the aui-sortable-list module.

Defined in alloy-ui/src/aui-surface/js/aui-surface-app.js:203

Matches if path is a known route, if not found any returns null. The path could contain a fragment-id (#). If the path is the same as the current url, and the path contains a fragment, we do not prevent the default browser behavior.

Parameters:

path String

Path containing the querystring part.

Returns:

Object | null:

Route handler if match any or null if the path is the same as the current url and the path contains a fragment.

`matchesPath`

(

value

)

Boolean

Provided by the aui-sortable-list module.

Defined in alloy-ui/src/aui-surface/js/aui-surface-screen-route.js:2

Matches if the ScreenRouter can handle the tested value path, if not returns null.

Parameters:

value String

Path to test and may contains the querystring part.

Returns:

Boolean:

Returns true if matches.

`modifyAttr`

(

name
config

)

Inherited from AttributeExtras: yui3/src/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: <dl> <dt>readOnly;</dt> <dt>writeOnce;</dt> <dt>broadcast; and</dt> <dt>getter.</dt> </dl> 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).

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.

`navigate`

(

path
opt_replaceHistory

)

Promise

Provided by the aui-sortable-list module.

Defined in alloy-ui/src/aui-surface/js/aui-surface-app.js:233

Navigates to the specified path if there is a route handler that matches.

Parameters:

path String

Path containing the querystring part.
opt_replaceHistory Boolean

Replaces browser history.

Returns:

Promise:

Returns a pending request cancellable promise.

`navigate`

(

path

)

Promise

Provided by the aui-sortable-list module.

Defined in alloy-ui/src/aui-surface/js/aui-surface-app.js:251

Prefetches the specified path if there is a route handler that matches.

Parameters:

path String

Path containing the querystring part.

Returns:

Promise:

Returns a pending request cancellable promise.

`next`

(

circular

)

Widget

Inherited from Widget: yui3/src/widget-child/js/Widget-Child.js:191

Returns the Widget's next sibling.

Parameters:

circular Boolean

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

Returns:

Widget:

`on`

(

type
fn
[context]
[arg*]

)

EventHandle

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

 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

The name of the event
fn Function

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

Override <code>this</code> 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: yui3/src/event-custom/js/event-target.js:124

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

The name of the event
fn Function

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

Override <code>this</code> 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: yui3/src/event-custom/js/event-target.js:146

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

The name of the event
fn Function

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

Override <code>this</code> 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

`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

the type
[pre] String optional

The prefix. Defaults to this._yuievt.config.prefix

Returns:

Array:

an array containing: <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>

`previous`

(

circular

)

Widget

Inherited from Widget: yui3/src/widget-child/js/Widget-Child.js:216

Returns the Widget's previous sibling.

Parameters:

circular Boolean

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

Returns:

Widget:

`publish`

(

type
opts

)

CustomEvent

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

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=false] Boolean optional
 
 whether or not the YUI instance and YUI global are notified when the event is fired.
- [bubbles=true] Boolean optional
 
 Whether or not this event bubbles. Events can only bubble if <code>emitFacade</code> is true.
- [context=this] Object optional
 
 the default execution context for the listeners.
- [defaultFn] Function optional
 
 the default function to execute when this event fires if preventDefault was not called.
- [emitFacade=false] Boolean optional
 
 whether or not this event emits a facade.
- [prefix] String optional
 
 the prefix for this targets events, e.g., 'menu' in 'menu:click'.
- [fireOnce=false] Boolean optional
 
 if an event is configured to fire once, new subscribers after the fire will be notified immediately.
- [async=false] Boolean optional
 
 fireOnce event listeners will fire synchronously if the event has already fired unless <code>async</code> is <code>true</code>.
- [preventable=true] Boolean optional
 
 whether or not <code>preventDefault()</code> has an effect.
- [preventedFn] Function optional
 
 a function that is executed when <code>preventDefault()</code> is called.
- [queuable=false] Boolean optional
 
 whether or not this event can be queued during bubbling.
- [silent] Boolean optional
 
 if silent is true, debug messages are not provided for this event.
- [stoppedFn] Function optional
 
 a function that is executed when stopPropagation is called.
- [monitored] Boolean optional
 
 specifies whether or not this event should send notifications about when the event has been attached, detached, or published.
- [type] String optional
 
 the event type (valid option if not provided as the first parameter to publish).

Returns:

CustomEvent:

the custom event

`remove`

(

screenId

)

Provided by the aui-sortable-list module.

Defined in alloy-ui/src/aui-surface/js/aui-surface-base.js:167

Removes screen content from a surface.

Parameters:

screenId String

The screen id to remove.

`removeAttr`

(

name

)

Inherited from AttributeExtras: yui3/src/attribute/js/AttributeExtras.js:90

Removes an attribute from the host object

Parameters:

name String

The name of the attribute to be removed.

`removeTarget`

(

)

chainable

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

Removes a bubble target

Parameters:

o EventTarget

the target to remove

`render`

(

parentNode

)

final chainable

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

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

Parameters:

parentNode Object | String

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

`renderer`

() protected

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

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: yui3/src/widget/js/Widget.js:618

Adds nodes to the DOM

This method is not called by framework and is not chained automatically for the class hierarchy.

`reset`

(

name

)

Object chainable

Inherited from AttributeExtras: yui3/src/attribute/js/AttributeExtras.js:100

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 yui3/src/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. <code>set("x.y.z", 5)</code>).
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 yui3/src/attribute/js/AttributeCore.js:770

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`

(

screenId

)

Promise

Inherited from Widget but overwritten in alloy-ui/src/aui-surface/js/aui-surface-base.js:130

Shows screen content from a surface.

Parameters:

screenId String

The screen id to show.

Returns:

Promise:

This can return a promise, which will pause the navigation until it is resolved.

`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: yui3/src/widget/js/Widget.js:629

Refreshes the rendered UI, based on Widget State

This method is not called by framework and is not chained automatically for the class hierarchy.

`toString`

() String

Provided by the aui-sortable-list module.

Defined in alloy-ui/src/aui-surface/js/aui-surface-screen.js:107

Returns:

String:

`toString`

() String

Inherited from BaseCore but overwritten in alloy-ui/src/aui-surface/js/aui-surface-base.js:181

Returns:

String:

`transition`

(

from
to

)

Promise

Provided by the aui-sortable-list module.

Defined in alloy-ui/src/aui-surface/js/aui-surface-base.js:189

Invokes the transition function specified on transition attribute.

Parameters:

from Node
to Node

Returns:

Promise:

This can return a promise, which will pause the navigation until it is resolved.

`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

The type, or name of the event

Properties

`_allowAdHocAttrs`

Boolean protected

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

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)

`_request`

Object protected

Provided by the aui-sortable-list module.

Defined in alloy-ui/src/aui-surface/js/aui-surface-screen-html.js:2

Holds the IO request.

`_UI_ATTRS`

Object private

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

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

`activeChild`

Node protected

Provided by the aui-sortable-list module.

Defined in alloy-ui/src/aui-surface/js/aui-surface-base.js:6

Holds the active child element.

`activePath`

String protected

Provided by the aui-sortable-list module.

Defined in alloy-ui/src/aui-surface/js/aui-surface-app.js:14

Holds the active path containing the query parameters.

`activeScreen`

Screen protected

Provided by the aui-sortable-list module.

Defined in alloy-ui/src/aui-surface/js/aui-surface-app.js:5

Holds the active screen.

`ATTRS`

Object static

Defined in alloy-ui/src/aui-tabview/js/aui-tabview.js:97

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

`BOUNDING_TEMPLATE`

String

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

Property defining the markup template for bounding box.

`cache`

Object protected

Provided by the aui-sortable-list module.

Defined in alloy-ui/src/aui-surface/js/aui-surface-screen.js:167

Holds the cached data.

`CONTENT_TEMPLATE`

String

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

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.

`CSS_PREFIX`

String static

Defined in alloy-ui/src/aui-tabview/js/aui-tabview.js:119

Static property provides a string to identify the CSS prefix.

`DEF_PARENT_NODE`

String | Node

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

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

`DEF_UNIT`

String

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

Default unit to use for dimension values

`defaultChild`

Node protected

Provided by the aui-sortable-list module.

Defined in alloy-ui/src/aui-surface/js/aui-surface-base.js:15

Holds the default child element.

`el`

Node protected

Provided by the aui-sortable-list module.

Defined in alloy-ui/src/aui-surface/js/aui-surface-base.js:24

Holds the element with the specified surface id, if not found creates a new element with the specified id.

`EXTENDS`

Object static

Defined in alloy-ui/src/aui-tabview/js/aui-tabview.js:128

Static property used to define which component it extends.

`lockPageXOffset`

Number protected

Provided by the aui-sortable-list module.

Defined in alloy-ui/src/aui-surface/js/aui-surface-app.js:23

Holds the window hotizontal scroll position before navigation using back or forward happens to lock the scroll position until the surfaces are updated.

`lockPageYOffset`

Number protected

Provided by the aui-sortable-list module.

Defined in alloy-ui/src/aui-surface/js/aui-surface-app.js:34

Holds the window vertical scroll position before navigation using back or forward happens to lock the scroll position until the surfaces are updated.

`NAME`

String static

Defined in alloy-ui/src/aui-tabview/js/aui-tabview.js:88

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.

`pageXOffset`

Number protected

Provided by the aui-sortable-list module.

Defined in alloy-ui/src/aui-surface/js/aui-surface-app.js:45

Holds the window hotizontal scroll position when the navigation using back or forward happens to be restored after the surfaces are updated.

`pageYOffset`

Number protected

Provided by the aui-sortable-list module.

Defined in alloy-ui/src/aui-surface/js/aui-surface-app.js:55

Holds the window vertical scroll position when the navigation using back or forward happens to be restored after the surfaces are updated.

`pendingNavigate`

Promise protected

Provided by the aui-sortable-list module.

Defined in alloy-ui/src/aui-surface/js/aui-surface-app.js:65

Holds a deferred withe the current navigation.

`ROOT_TYPE`

Object

Inherited from WidgetChild: yui3/src/widget-child/js/Widget-Child.js:152

Constructor reference used to determine the root of a Widget-based object tree. Currently used to control the behavior of the <code>root</code> attribute so that recursing up the object heirarchy can be constrained to a specific type of Widget. Widget authors should set this property to the constructor function for a given Widget implementation.

`routes`

Array protected

Provided by the aui-sortable-list module.

Defined in alloy-ui/src/aui-surface/js/aui-surface-app.js:74

Holds the screen routes configuration.

`screens`

Object protected

Provided by the aui-sortable-list module.

Defined in alloy-ui/src/aui-surface/js/aui-surface-app.js:83

Maps the screen instances by the url containing the parameters.

`scrollHandle`

Object private

Provided by the aui-sortable-list module.

Defined in alloy-ui/src/aui-surface/js/aui-surface-app.js:92

Holds the scroll event handle.

`skipLoadPopstate`

Boolean protected

Provided by the aui-sortable-list module.

Defined in alloy-ui/src/aui-surface/js/aui-surface-app.js:101

When set to true the first erroneous popstate fired on page load will be ignored, only if window.history.state is also null.

`surfaces`

Object protected

Provided by the aui-sortable-list module.

Defined in alloy-ui/src/aui-surface/js/aui-surface-app.js:111

Maps that index the surfaces instances by the surface id.

`TRANSITION`

Unknown static

Provided by the aui-sortable-list module.

Defined in alloy-ui/src/aui-surface/js/aui-surface-base.js:246

Transition function that returns a promise, the navigation will be paused until all surfaces' promise have completed. This is useful for animations.

Sub-properties:

from Node
to Node

`UI_EVENTS`

Object

Inherited from Widget: yui3/src/widget/js/WidgetUIEvents.js:52

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

Attributes

`basePath`

String

Provided by the aui-sortable-list module.

Defined in alloy-ui/src/aui-surface/js/aui-surface-app.js:782

Absolute base path from which all routes should be evaluated.

Default: ''

`boundingBox`

String | Node

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

The outermost DOM node for the Widget, used for sizing and positioning of a Widget as well as a containing element for any decorator elements used for skinning.

`cacheable`

Boolean

Provided by the aui-sortable-list module.

Defined in alloy-ui/src/aui-surface/js/aui-surface-screen-html.js:164

Default: true

`cacheable`

Boolean

Provided by the aui-sortable-list module.

Defined in alloy-ui/src/aui-surface/js/aui-surface-screen.js:237

If false, the screen will be disposed after being deactivated. If true, the surface content will be left in the DOM with display:none.

Default: false

`content`

HTML

Inherited from Tab: yui3/src/tabview/js/tab.js:183

`contentBox`

String | Node

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

A DOM node that is a direct descendant of a Widget's bounding box that houses its content.

`defaultTitle`

String | Null

Provided by the aui-sortable-list module.

Defined in alloy-ui/src/aui-surface/js/aui-surface-app.js:754

Defines the default document title in case the screen doesn't have any title. If null, the default browser behavior for setting the title is used for when there's no title HTML tag on the document.

Default: null

`depth`

Number readonly

Inherited from WidgetChild: yui3/src/widget-child/js/Widget-Child.js:82

Number representing the depth of this Widget relative to the root Widget in the object heirarchy.

Default: -1

`destroyed`

Boolean readonly

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

Flag indicating whether or not this object has been through the destroy lifecycle phase.

Default: false

`disabled`

Boolean

Inherited from Widget but overwritten in alloy-ui/src/aui-tabview/js/aui-tabview.js:107

Defines if the tabs should be enable or not.

`focused`

Boolean readonly

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

Boolean indicating if the Widget, or one of its descendants, has focus.

Default: false

`height`

String | Number

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

String with units, or number, representing the height of the Widget. If a number is provided, the default unit, defined by the Widgets DEF_UNIT, property is used.

Default: EMPTY_STR

`id`

String

Inherited from Widget but overwritten in alloy-ui/src/aui-surface/js/aui-surface-base.js:230

The surface id.

Default: Generated using `A.guid()`.

`id`

String

Provided by the aui-sortable-list module.

Defined in alloy-ui/src/aui-surface/js/aui-surface-screen.js:138

The screen id.

Default: Generated using `A.guid()`.

`index`

Number readonly

Inherited from WidgetChild: yui3/src/widget-child/js/Widget-Child.js:45

Number representing the Widget's ordinal position in its parent Widget.

`initialized`

Boolean readonly

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

Flag indicating whether or not this object has been through the init lifecycle phase.

Default: false

`label`

HTML

Inherited from Tab: yui3/src/tabview/js/tab.js:174

`linkSelector`

String

Provided by the aui-sortable-list module.

Defined in alloy-ui/src/aui-surface/js/aui-surface-app.js:768

CSS selector string used to filter link click events so that only the links which match it will have the enhanced navigation behavior.

Default: "a"

`method`

String

Provided by the aui-sortable-list module.

Defined in alloy-ui/src/aui-surface/js/aui-surface-screen-html.js:173

Ajax request method.

Default: GET

`panelNode`

Y.Node

Inherited from Tab: yui3/src/tabview/js/tab.js:192

`parent`

Widget readonly

Inherited from WidgetChild: yui3/src/widget-child/js/Widget-Child.js:70

Retrieves the parent of the Widget in the object hierarchy.

`path`

String | RegExp | Function

Provided by the aui-sortable-list module.

Defined in alloy-ui/src/aui-surface/js/aui-surface-screen-route.js:52

Defines the path which will trigger the rendering of the screen, specified in screen attribute. Could be String, RegExp or Function. In case of Function, it will receive the URL as parameter and it should return true if this URL could be handled by the screen.

`render`

Boolean | Node

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

Whether or not to render the widget automatically after init, and optionally, to which parent node.

`rendered`

Boolean readonly

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

Flag indicating whether or not this Widget has been through the render lifecycle phase.

Default: false

`root`

Widget readonly

Inherited from WidgetChild: yui3/src/widget-child/js/Widget-Child.js:116

Returns the root Widget in the object hierarchy. If the ROOT_TYPE property is set, the search for the root Widget will be constrained to parent Widgets of the specified type.

`screen`

A.Screen

Provided by the aui-sortable-list module.

Defined in alloy-ui/src/aui-surface/js/aui-surface-screen-route.js:66

Defines the screen which will be rendered once a URL in the application matches the path, specified in path attribute. Could be A.Screen or its extension, like A.HTMLScreen.

`selected`

Number

Inherited from WidgetChild: yui3/src/widget-child/js/Widget-Child.js:26

Number indicating if the Widget is selected. Possible values are: <dl> <dt>0</dt> <dd>(Default) Not selected</dd> <dt>1</dt> <dd>Fully selected</dd> <dt>2</dt> <dd>Partially selected</dd> </dl>

Default: 0

`srcNode`

String | Node

Inherited from Widget: yui3/src/widget/js/WidgetHTMLParser.js:58

The DOM node to parse for configuration values, passed to the Widget's HTML_PARSER definition

`strings`

Object

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

Collection of strings used to label elements of the Widget's UI.

Default: null

`tabIndex`

Number

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

Number (between -32767 to 32767) indicating the widget's position in the default tab flow. The value is used to set the "tabIndex" attribute on the widget's bounding box. Negative values allow the widget to receive DOM focus programmatically (by calling the focus method), while being removed from the default tab flow. A value of null removes the "tabIndex" attribute from the widget's bounding box.

Default: null

`timeout`

Number

Provided by the aui-sortable-list module.

Defined in alloy-ui/src/aui-surface/js/aui-surface-screen-html.js:202

Time in milliseconds after which an Ajax request should time out.

Default: 30000

`title`

String

Provided by the aui-sortable-list module.

Defined in alloy-ui/src/aui-surface/js/aui-surface-screen.js:153

The document.title to set when the screen is active.

`titleSelector`

String

Provided by the aui-sortable-list module.

Defined in alloy-ui/src/aui-surface/js/aui-surface-screen-html.js:185

CSS selector used to extract a page title from the content of a page loaded via Pjax.

By default this is set to extract the title from the <title> element, but you could customize it to extract the title from an <h1>, or from any other element, if that's more appropriate for the content you're loading.

Default: "title"

`transition`

Function

Provided by the aui-sortable-list module.

Defined in alloy-ui/src/aui-surface/js/aui-surface-base.js:214

If false, the screen will be disposed after being deactivated. If true, the surface content will be left in the DOM with display:none.

Default: false

`triggerEvent`

String

Inherited from Tab: yui3/src/tabview/js/tab.js:165

Default: "click"

`urlParams`

String | Object

Provided by the aui-sortable-list module.

Defined in alloy-ui/src/aui-surface/js/aui-surface-screen-html.js:213

Could be String or Object with multiple keys and values. If String, the defaule value will be "1". If an Object with multiple keys and values, they will be concatenated to the URL.

Default: pjax

`visible`

Boolean

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

Boolean indicating whether or not the Widget is visible.

Default: TRUE

`width`

String | Number

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

String with units, or number, representing the width of the Widget. If a number is provided, the default unit, defined by the Widgets DEF_UNIT, property is used.

Default: EMPTY_STR

Events

`destroy`

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

`init`

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

`render`

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

Lifecycle event for the render phase, fired prior to rendering the UI for the widget (prior to invoking the widget's renderer method). Subscribers to the "on" moment of this event, will be notified before the widget is rendered. Subscribers to the "after" moment of this event, will be notified after rendering is complete.

Event Payload:

e EventFacade

The Event Facade

`widget:contentUpdate`

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

Notification event, which widget implementations can fire, when they change the content of the widget. This event has no default behavior and cannot be prevented, so the "on" or "after" moments are effectively equivalent (with on listeners being invoked before after listeners).

Event Payload:

e EventFacade

The Event Facade

APIs

A.Tab Class

Constructor

Parameters:

Example:

Index

Methods

Properties

Attributes

Events

Methods

_addAttrs

Parameters:

_addLazyAttr

Parameters:

_addOutOfOrder

Parameters:

_afterChildSelectedChange

Parameters:

_afterUiSetDisabled

Parameters:

_aggregateAttrs

Parameters:

Returns:

_applyParsedConfig

Returns:

_applyParser

Parameters:

_attrCfgHash

_baseDestroy

_baseInit

_bindAttrUI

Parameters:

_bindDOM

_bindUI

_bindUIChild

_cloneDefaultValue

Parameters:

_createUIEvent

Parameters:

_defAttrChangeFn

Parameters:

_defaultBB

_defaultCB

_defDestroyFn

Parameters:

_defInitFn

Parameters:

_defRenderFn

Parameters:

_defStartNavigateFn

Parameters:

_destroyBox

_destroyHierarchy

_destroyUIEvents

_doNavigate

Parameters:

Returns:

_filterAdHocAttrs

Parameters:

Returns:

_filterUIEvent

Parameters:

Returns:

_finalizeNavigate

Parameters:

_fireAttrChange

Parameters:

_getAttr

Parameters:

Returns:

_getAttrCfg

Parameters:

Returns:

_getAttrCfgs

Returns:

_getAttrInitVal

Parameters:

Returns:

`A.Tab`

`_addAttrs`

`_addLazyAttr`

`_addOutOfOrder`

`_afterChildSelectedChange`

`_afterUiSetDisabled`

`_aggregateAttrs`

`_applyParsedConfig`

`_applyParser`

`_attrCfgHash`

`_baseDestroy`

`_baseInit`

`_bindAttrUI`

`_bindDOM`

`_bindUI`

`_bindUIChild`

`_cloneDefaultValue`

`_createUIEvent`

`_defAttrChangeFn`

`_defaultBB`

`_defaultCB`

`_defDestroyFn`

`_defInitFn`

`_defRenderFn`

`_defStartNavigateFn`

`_destroyBox`

`_destroyHierarchy`

`_destroyUIEvents`

`_doNavigate`

`_filterAdHocAttrs`

`_filterUIEvent`

`_finalizeNavigate`

`_fireAttrChange`

`_getAttr`

`_getAttrCfg`

`_getAttrCfgs`

`_getAttrInitVal`

`_getAttrs`

`_getClasses`

`_getFullType`

`_getHtmlParser`

`_getInstanceAttrCfgs`

`_getNodeToParse`

`_getScreenInstance`

`_getSrcNode`

`_getStateVal`

`_getType`

`_getUIEventNode`

`_guid`

`_handleNavigateError`

`_hasPotentialSubscribers`

`_initAttrHost`

`_initAttribute`

`_initAttrs`

`_initBase`

`_initHierarchy`

`_initHierarchyData`

`_initUIEvent`

`_isLazyAttr`

`_isLinkSameOrigin`

`_isUIEvent`

`_lockScroll`

`_makeId`

`_mapInstance`

`_monitor`

`_normAttrVals`

`_onDocClick`

`_onDocFocus`

`_onDocMouseDown`