A.PropertyList

Uses:

Extends: DataTable

Defined in: alloy-ui/src/aui-datatable/js/aui-datatable-property-list.js:11

Module: aui-datatable-property-list
Parent Module: aui-datatable

A base class for PropertyList.

Constructor

`A.PropertyList`

(

config

)

Defined in alloy-ui/src/aui-datatable/js/aui-datatable-property-list.js:11

Parameters:

config Object

Object literal specifying widget configuration properties.

Index

Methods

`@renderUI`

() protected

Inherited from DataTable.Base: yui3/src/datatable/js/base.js:425

Available since 3.6.0

Instantiates the configured view class that will be responsible for setting up the View class.

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

`_addScrollbarPadding`

() protected

Inherited from DataTable: yui3/src/datatable/js/scroll.js:193

Available since 3.5.0

Adds padding to the last cells in the fixed header for vertically scrolling tables. This padding is equal in width to the scrollbar, so can't be relegated to a stylesheet.

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

`_afterColumnsChange`

(

)

protected

Inherited from DataTable: yui3/src/datatable/js/core.js:333

Available since 3.5.0

Updates the _columnMap property in response to changes in the columns attribute.

Parameters:

e EventFacade

The columnsChange event object

`_afterCssClassChange`

(

event

)

protected

Inherited from A.WidgetCssClass: alloy-ui/src/aui-widget/js/aui-widget-cssclass.js:60

Fires after the value of the cssClass attribute change.

Parameters:

event EventFacade

`_afterCurrentIndexChange`

(

event

)

protected

Inherited from A.WidgetToggle: alloy-ui/src/aui-widget/js/aui-widget-swipe.js:96

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

Parameters:

event EventFacade

`_afterDataChange`

(

)

protected

Inherited from DataTable: yui3/src/datatable/js/core.js:346

Available since 3.5.0

Updates the modelList attributes of the rendered views in response to the data attribute being assigned a new ModelList.

Parameters:

e EventFacade

the dataChange event

`_afterDisplayColumnsChange`

(

)

protected

Inherited from DataTable.Base: yui3/src/datatable/js/base.js:305

Available since 3.6.0

Updates the _displayColumns property.

Parameters:

e EventFacade

The columnsChange event

`_afterFocusedCellChange`

(

)

private

Inherited from DataTable: yui3/src/datatable/js/keynav.js:223

Sets the tabIndex on the focused cell and, if the DataTable has the focus, sets the focus on it.

Parameters:

e EventFacade

`_afterIndexChange`

(

event

)

protected

Inherited from A.WidgetToggle: alloy-ui/src/aui-widget/js/aui-widget-swipe.js:65

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

Parameters:

event EventFacade

`_afterKeyNavFocusedChange`

(

)

private

Inherited from DataTable: yui3/src/datatable/js/keynav.js:251

When the DataTable gets the focus, it ensures the correct cell regains the focus.

Parameters:

e EventFacade

`_afterKeyNavRender`

() private

Inherited from DataTable: yui3/src/datatable/js/keynav.js:275

Subscribes to the events on the DataTable elements once they have been rendered, finds out the header section and makes the top-left element focusable.

`_afterMessageColumnsChange`

(

)

protected

Inherited from DataTable: yui3/src/datatable/js/message.js:110

Available since 3.5.0

Updates the colspan of the <td> used to display the messages.

Parameters:

e EventFacade

The columnsChange event

`_afterMessageDataChange`

(

)

protected

Inherited from DataTable: yui3/src/datatable/js/message.js:133

Available since 3.5.0

Relays to _uiSetMessage to hide or show the message node.

Parameters:

e EventFacade

The dataChange event

`_afterRecordTypeChange`

(

)

protected

Inherited from DataTable: yui3/src/datatable/js/core.js:367

Available since 3.6.0

Assigns to the new recordType as the model for the data ModelList

Parameters:

e EventFacade

recordTypeChange event

`_afterRenderUI`

() protected

Defined in alloy-ui/src/aui-datatable/js/aui-datatable-property-list.js:61

Fires after the renderUI event.

`_afterResponsiveSwipe`

() protected

Inherited from A.WidgetToggle: alloy-ui/src/aui-widget/js/aui-widget-swipe.js:79

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

`_afterScrollableChange`

(

)

protected

Inherited from DataTable: yui3/src/datatable/js/scroll.js:218

Available since 3.5.0

Reacts to changes in the scrollable attribute by updating the _xScroll and _yScroll properties and syncing the scrolling structure accordingly.

Parameters:

e EventFacade

The relevant change event (ignored)

`_afterScrollCaptionChange`

(

)

protected

Inherited from DataTable: yui3/src/datatable/js/scroll.js:242

Available since 3.5.0

Reacts to changes in the caption attribute by adding, removing, or syncing the caption table when the table is set to scroll.

Parameters:

e EventFacade

The relevant change event (ignored)

`_afterScrollColumnsChange`

(

)

protected

Inherited from DataTable: yui3/src/datatable/js/scroll.js:257

Available since 3.5.0

Reacts to changes in the columns attribute of vertically scrolling tables by refreshing the fixed headers, scroll container, and virtual scrollbar position.

Parameters:

e EventFacade

The relevant change event (ignored)

`_afterScrollDataChange`

(

)

protected

Inherited from DataTable: yui3/src/datatable/js/scroll.js:277

Available since 3.5.0

Reacts to changes in vertically scrolling table's data ModelList by synchronizing the fixed column header widths and virtual scrollbar height.

Parameters:

e EventFacade

The relevant change event (ignored)

`_afterScrollHeightChange`

(

)

protected

Inherited from DataTable: yui3/src/datatable/js/scroll.js:292

Available since 3.5.0

Reacts to changes in the height attribute of vertically scrolling tables by updating the height of the <div> wrapping the data table and the virtual scrollbar. If scrollable was set to "y" or "xy" but lacking a declared height until the received change, _syncScrollUI is called to create the fixed headers etc.

Parameters:

e EventFacade

The relevant change event (ignored)

`_afterScrollWidthChange`

(

)

protected

Inherited from DataTable: yui3/src/datatable/js/scroll.js:331

Available since 3.5.0

Reacts to changes in the width of scrolling tables by expanding the width of the <div> wrapping the data table for horizontally scrolling tables or upding the position of the virtual scrollbar for vertically scrolling tables.

Parameters:

e EventFacade

The relevant change event (ignored)

`_afterShowMessagesChange`

(

)

protected

Inherited from DataTable: yui3/src/datatable/js/message.js:145

Available since 3.5.0

Removes the message node if showMessages is false, or relays to _uiSetMessage if true.

Parameters:

e EventFacade

The showMessagesChange event

`_afterSortByChange`

(

)

protected

Inherited from DataTable: yui3/src/datatable/js/sort.js:288

Available since 3.5.0

Sorts the data ModelList based on the new sortBy configuration.

Parameters:

e EventFacade

The sortByChange event

`_afterSortDataChange`

(

)

protected

Inherited from DataTable: yui3/src/datatable/js/sort.js:313

Available since 3.5.0

Applies the sorting logic to the new ModelList if the newVal is a new ModelList.

Parameters:

e EventFacade

the dataChange event

`_afterSortRecordChange`

(

)

protected

Inherited from DataTable: yui3/src/datatable/js/sort.js:332

Available since 3.5.0

Checks if any of the fields in the modified record are fields that are currently being sorted by, and if so, resorts the data ModelList.

Parameters:

e EventFacade

The Model's change event

`_afterUITriggerSort`

(

event

)

protected

Defined in alloy-ui/src/aui-datatable/js/aui-datatable-property-list.js:75

Fires after the UITriggerSort event.

Parameters:

event EventFacade

`_afterWidgetUISetVisible`

() protected

Inherited from A.WidgetToggle: alloy-ui/src/aui-widget/js/aui-widget-swipe.js:110

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

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

`_attachSwipeEvents`

() protected

Inherited from A.WidgetToggle: alloy-ui/src/aui-widget/js/aui-widget-swipe.js:124

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

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

`_bindMessageUI`

() protected

Inherited from DataTable: yui3/src/datatable/js/message.js:166

Available since 3.5.0

Binds the events necessary to keep the message node in sync with the current table and configuration state.

`_bindScrollbar`

() protected

Inherited from DataTable: yui3/src/datatable/js/scroll.js:348

Available since 3.5.0

Binds virtual scrollbar interaction to the _yScrollNode's scrollTop and vice versa.

`_bindScrollResize`

() protected

Inherited from DataTable: yui3/src/datatable/js/scroll.js:368

Available since 3.5.0

Binds to the window resize event to update the vertical scrolling table headers and wrapper <div> dimensions.

`_bindScrollUI`

() protected

Inherited from DataTable: yui3/src/datatable/js/scroll.js:385

Available since 3.5.0

Attaches internal subscriptions to keep the scrolling structure up to date with changes in the table's data, columns, caption, or height. The width is taken care of already.

This executes after the table's native bindUI method.

`_bindSortUI`

() protected

Inherited from DataTable: yui3/src/datatable/js/sort.js:352

Available since 3.5.0

Subscribes to state changes that warrant updating the UI, and adds the click handler for triggering the sort operation from the UI.

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

`_clearScrollLock`

() protected

Inherited from DataTable: yui3/src/datatable/js/scroll.js:413

Available since 3.5.0

Clears the lock and timer used to manage synchronizing the scroll position between the vertical scroll container and the virtual scrollbar.

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

`_createColumnGroup`

() protected

Inherited from DataTable: yui3/src/datatable/js/colwidths.js:175

Available since 3.5.0

Renders the table's <colgroup> and populates the _colgroupNode property.

`_createRecordClass`

(

attrs

)

Model protected

Inherited from DataTable: yui3/src/datatable/js/core.js:391

Available since 3.5.0

Creates a Model subclass from an array of attribute names or an object of attribute definitions. This is used to generate a class suitable to represent the data passed to the data attribute if no recordType is set.

Parameters:

attrs String | Object

Names assigned to the Model subclass's ATTRS or its entire ATTRS definition object

Returns:

Model:

`_createScrollbar`

() Node protected

Inherited from DataTable: yui3/src/datatable/js/scroll.js:428

Available since 3.5.0

Creates a virtual scrollbar from the _SCROLLBAR_TEMPLATE, assigning it to the _scrollbarNode property.

Returns:

Node:

The created Node

`_createScrollCaptionTable`

() Node protected

Inherited from DataTable: yui3/src/datatable/js/scroll.js:454

Available since 3.5.0

Creates a separate table to contain the caption when the table is configured to scroll vertically or horizontally.

Returns:

Node:

The created Node

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

`_createXScrollNode`

() Node protected

Inherited from DataTable: yui3/src/datatable/js/scroll.js:476

Available since 3.5.0

Populates the _xScrollNode property by creating the <div> Node described by the _X_SCROLLER_TEMPLATE.

Returns:

Node:

The created Node

`_createYScrollHeader`

() Node protected

Inherited from DataTable: yui3/src/datatable/js/scroll.js:496

Available since 3.5.0

Populates the _yScrollHeader property by creating the <table> Node described by the _Y_SCROLL_HEADER_TEMPLATE.

Returns:

Node:

The created Node

`_createYScrollNode`

() Node protected

Inherited from DataTable: yui3/src/datatable/js/scroll.js:518

Available since 3.5.0

Populates the _yScrollNode property by creating the <div> Node described by the _Y_SCROLLER_TEMPLATE.

Returns:

Node:

The created Node

`_defAddColumnFn`

(

)

protected

Inherited from DataTable: yui3/src/datatable/js/mutable.js:394

Available since 3.5.0

Default function for the addColumn event.

Inserts the specified column at the provided index.

Parameters:

e EventFacade

The addColumn event
- column Object
  
  The new column definition object
- index Number | Number[]
  
  The array index to insert the new column

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

`_defModifyColumnFn`

(

)

protected

Inherited from DataTable: yui3/src/datatable/js/mutable.js:424

Available since 3.5.0

Default function for the modifyColumn event.

Mixes the new column properties into the specified column definition.

Parameters:

e EventFacade

The modifyColumn event
- column Object | String | Number | Number[]
  
  The column definition object or identifier
- newColumnDef Object
  
  The properties to assign to the column

`_defMoveColumnFn`

(

)

protected

Inherited from DataTable: yui3/src/datatable/js/mutable.js:448

Available since 3.5.0

Default function for the moveColumn event.

Removes the specified column from its current location and inserts it at the specified array index (may be an array of indexes for nested headers).

Parameters:

e EventFacade

The moveColumn event
- column Object | String | Number | Number[]
  
  The column definition object or identifier
- index Object
  
  The destination index to move to

`_defRemoveColumnFn`

(

)

protected

Inherited from DataTable: yui3/src/datatable/js/mutable.js:501

Available since 3.5.0

Default function for the removeColumn event.

Splices the specified column from its containing columns array.

Parameters:

e EventFacade

The removeColumn event
- column Object | String | Number | Number[]
  
  The column definition object or identifier

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

`_defRenderViewFn`

(

)

protected

Inherited from DataTable.Base: yui3/src/datatable/js/base.js:336

The default behavior of the renderView event. Calls render() on the View instance on the event.

Parameters:

e EventFacade

The renderView event

`_defSortFn`

(

)

protected

Inherited from DataTable: yui3/src/datatable/js/sort.js:376

Available since 3.5.0

Sets the sortBy attribute from the sort event's e.sortBy value.

Parameters:

e EventFacade

The sort event

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

`_detachSwipeEvents`

() protected

Inherited from A.WidgetToggle: alloy-ui/src/aui-widget/js/aui-widget-swipe.js:145

Detaches all events related to the swipe funcionality.

`_disableScrolling`

() protected

Inherited from DataTable: yui3/src/datatable/js/scroll.js:546

Available since 3.5.0

Removes the nodes used to create horizontal and vertical scrolling and rejoins the caption to the main table if needed.

`_disableScrollView`

() protected

Inherited from A.WidgetToggle: alloy-ui/src/aui-widget/js/aui-widget-swipe.js:158

Disables the scroll view, removing the swipe funcionality.

`_disableXScrolling`

() protected

Inherited from DataTable: yui3/src/datatable/js/scroll.js:563

Available since 3.5.0

Removes the nodes used to allow horizontal scrolling.

`_disableYScrolling`

() protected

Inherited from DataTable: yui3/src/datatable/js/scroll.js:574

Available since 3.5.0

Removes the nodes used to allow vertical scrolling.

`_enableScrollView`

() protected

Inherited from A.WidgetToggle: alloy-ui/src/aui-widget/js/aui-widget-swipe.js:174

Enables the scroll view, adding the swipe funcionality.

`_extractDisplayColumns`

(

columns

)

protected

Inherited from DataTable.Base: yui3/src/datatable/js/base.js:348

Processes the full column array, distilling the columns down to those that correspond to cell data columns.

Parameters:

columns Object

The full set of table columns

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

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

`_focusedCellSetter`

(

cell

)

private

Inherited from DataTable: yui3/src/datatable/js/keynav.js:646

Setter method for the focusedCell attribute. Checks that the passed value is a Node, either a TD or TH and is contained within the DataTable contentBox.

Parameters:

cell Node

DataTable cell to receive the focus

Returns:

cell or Y.Attribute.INVALID_VALUE

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

`_getCellColumnName`

(

cell

)

protected

Inherited from DataTable: yui3/src/datatable/js/keynav.js:687

Retrieves the column name based from the data attribute on the cell if available. Other wise, extracts the column name from the classname

Parameters:

cell Node

Cell to get column name from

Returns:

String Column name of the provided cell

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

`_getColumns`

(

columns
name

)

protected

Inherited from DataTable: yui3/src/datatable/js/core.js:431

Available since 3.5.0

The getter for the columns attribute. Returns the array of column configuration objects if instance.get('columns') is called, or the specific column object if instance.get('columns.columnKey') is called.

Parameters:

columns Object

The full array of column objects
name String

The attribute name requested (e.g. 'columns' or 'columns.foo');

`_getColumnset`

(

ignored
name

)

deprecated protected

Inherited from DataTable: yui3/src/datatable/js/core.js:450

Deprecated: This will be removed with the `columnset` attribute in a future version.

Available since 3.5.0

Relays the get() request for the deprecated columnset attribute to the columns attribute.

THIS BREAKS BACKWARD COMPATIBILITY. 3.4.1 and prior implementations will expect a Columnset instance returned from get('columnset').

Parameters:

ignored Object

The current value stored in the columnset state
name String

The attribute name requested (e.g. 'columnset' or 'columnset.foo');

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

`_getRecordType`

(

val

)

Model

Inherited from DataTable: yui3/src/datatable/js/core.js:470

Returns the Model class of the instance's data attribute ModelList. If not set, returns the explicitly configured value.

Parameters:

val Model

The currently configured value

Returns:

Model:

`_getSortBy`

(

val
detail

)

protected

Inherited from DataTable: yui3/src/datatable/js/sort.js:388

Available since 3.5.0

Getter for the sortBy attribute.

Supports the special subattribute "sortBy.state" to get a normalized JSON version of the current sort state. Otherwise, returns the last assigned value.

For example:

<pre><code>var table = new Y.DataTable({ columns: [ ... ], data: [ ... ], sortBy: 'username' });

table.get('sortBy'); // 'username' table.get('sortBy.state'); // { key: 'username', dir: 1 }

table.sort(['lastName', { firstName: "desc" }]); table.get('sortBy'); // ['lastName', { firstName: "desc" }] table.get('sortBy.state'); // [{ key: "lastName", dir: 1 }, { key: "firstName", dir: -1 }] </code></pre>

Parameters:

val String | String | Object | Object

The current sortBy value
detail String

String passed to get(HERE). to parse subattributes

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

`_getTHParent`

(

thCell

)

Node protected

Inherited from DataTable: yui3/src/datatable/js/keynav.js:668

Retrieves the parent cell of the given TH cell. If there is no parent for the provided cell, null is returned.

Parameters:

thCell Node

Cell to find parent of

Returns:

Node:

Parent of the cell provided or null

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

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

`_initColumns`

() protected

Inherited from DataTable: yui3/src/datatable/js/core.js:488

Available since 3.5.0

Initializes the _columnMap property from the configured columns attribute. If columns is not set, but there are records in the data ModelList, use ATTRS of that class.

`_initCoreEvents`

() protected

Inherited from DataTable: yui3/src/datatable/js/core.js:517

Available since 3.6.0

Sets up the change event subscriptions to maintain internal state.

`_initData`

() ModelList protected

Inherited from DataTable: yui3/src/datatable/js/core.js:532

Available since 3.6.0

Defaults the data attribute to an empty ModelList if not set during construction. Uses the configured recordType for the ModelList's model proeprty if set.

Returns:

ModelList:

`_initDataProperty`

(

data

)

protected

Inherited from DataTable: yui3/src/datatable/js/core.js:554

Available since 3.6.0

Initializes the instance's data property from the value of the data attribute. If the attribute value is a ModelList, it is assigned directly to this.data. If it is an array, a ModelList is created, its model property is set to the configured recordType class, and it is seeded with the array data. This ModelList is then assigned to this.data.

Parameters:

data Array | ModelList | ArrayList

Collection of data to populate the DataTable

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

`_initHighlight`

() protected

Defined in alloy-ui/src/aui-datatable/js/aui-datatable-property-list.js:88

Initializer for the A.DataTable highlighter.

`_initMessageNode`

() protected

Inherited from DataTable: yui3/src/datatable/js/message.js:203

Available since 3.5.0

Creates the _messageNode property from the configured MESSAGE_TEMPLATE and inserts it before the <table>'s <tbody> node.

`_initMessageStrings`

() protected

Inherited from DataTable: yui3/src/datatable/js/message.js:224

Available since 3.5.0

Add the messaging related strings to the strings map.

`_initSortFn`

() protected

Inherited from DataTable: yui3/src/datatable/js/sort.js:477

Available since 3.5.0

Creates a _compare function for the data ModelList to allow custom sorting by multiple fields.

`_initSortStrings`

() protected

Inherited from DataTable: yui3/src/datatable/js/sort.js:532

Available since 3.5.0

Add the sort related strings to the strings map.

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

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

`_keyMoveColBottom`

(

)

private

Inherited from DataTable: yui3/src/datatable/js/keynav.js:630

Sets the focus on the last cell of the column containing the currently focused cell.

Parameters:

e EventFacade

Event Facade for the keydown event

`_keyMoveColTop`

(

)

private

Inherited from DataTable: yui3/src/datatable/js/keynav.js:601

Sets the focus on the top-most cell of the column containing the currently focused cell. It would normally be a header cell.

Parameters:

e EventFacade

Event Facade for the keydown event

`_keyMoveDown`

(

)

private

Inherited from DataTable: yui3/src/datatable/js/keynav.js:510

Sets the focus on the cell below the currently focused one. It will move into the data rows when the bottom of the header rows is reached. Does not wrap, following the WAI-ARIA recommendation.

Parameters:

e EventFacade

Event Facade for the keydown event

`_keyMoveFirst`

() private

Inherited from DataTable: yui3/src/datatable/js/keynav.js:365

Sets the focus on the very first cell in the header of the table.

`_keyMoveLeft`

(

)

private

Inherited from DataTable: yui3/src/datatable/js/keynav.js:375

Sets the focus on the cell to the left of the currently focused one. Does not wrap, following the WAI-ARIA recommendation.

Parameters:

e EventFacade

Event Facade for the keydown event

`_keyMoveRight`

(

)

private

Inherited from DataTable: yui3/src/datatable/js/keynav.js:397

Sets the focus on the cell to the right of the currently focused one. Does not wrap, following the WAI-ARIA recommendation.

Parameters:

e EventFacade

Event Facade for the keydown event

`_keyMoveRowEnd`

(

)

private

Inherited from DataTable: yui3/src/datatable/js/keynav.js:588

Sets the focus on the right-most cell of the row containing the currently focused cell.

Parameters:

e EventFacade

Event Facade for the keydown event

`_keyMoveRowStart`

(

)

private

Inherited from DataTable: yui3/src/datatable/js/keynav.js:575

Sets the focus on the left-most cell of the row containing the currently focused cell.

Parameters:

e EventFacade

Event Facade for the keydown event

`_keyMoveUp`

(

)

private

Inherited from DataTable: yui3/src/datatable/js/keynav.js:453

Sets the focus on the cell above the currently focused one. It will move into the headers when the top of the data rows is reached. Does not wrap, following the WAI-ARIA recommendation.

Parameters:

e EventFacade

Event Facade for the keydown event

`_keyNavFireEvent`

(

action
e

)

private

Inherited from DataTable: yui3/src/datatable/js/keynav.js:342

If the action associated to a key combination is a string and no method by that name was found in this instance, this method will fire an event using that string and provides extra information to the listener.

Parameters:

action String

Name of the event to fire
e EventFacade

Original facade from the keydown event.

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

`_onActiveCellChange`

(

event

)

protected

Defined in alloy-ui/src/aui-datatable/js/aui-datatable-property-list.js:103

Fires on activeCellChange event.

Parameters:

event EventFacade

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

`_onKeyNavClick`

(

)

private

Inherited from DataTable: yui3/src/datatable/js/keynav.js:295

In response to a click event, it sets the focus on the clicked cell

Parameters:

e EventFacade

`_onKeyNavKeyDown`

(

)

private

Inherited from DataTable: yui3/src/datatable/js/keynav.js:310

Responds to a key down event by executing the action set in the keyActions table.

Parameters:

e EventFacade

`_onResponsiveSwipe`

() protected

Inherited from A.WidgetToggle: alloy-ui/src/aui-widget/js/aui-widget-swipe.js:204

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

`_onSelectionKey`

(

event

)

protected

Defined in alloy-ui/src/aui-datatable/js/aui-datatable-property-list.js:124

Callback for the selection key event listener.

Parameters:

event EventFacade

`_onUITriggerSort`

(

)

protected

Inherited from DataTable: yui3/src/datatable/js/sort.js:545

Available since 3.5.0

Fires the sort event in response to user clicks on sortable column headers.

Parameters:

e DOMEventFacade

The click event

`_parseSortable`

() protected

Inherited from DataTable: yui3/src/datatable/js/sort.js:598

Available since 3.5.0

Normalizes the possible input values for the sortable attribute, storing the results in the _sortable property.

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

`_plugPaginator`

() protected

Inherited from A.WidgetToggle: alloy-ui/src/aui-widget/js/aui-widget-swipe.js:216

Plugs ScrollViewPaginator if the useScrollViewPaginator is true.

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

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

`_relayCoreAttrChange`

(

)

protected

Inherited from DataTable.Base: yui3/src/datatable/js/base.js:411

Available since 3.6.0

Relays attribute changes to the instance's view.

Parameters:

e EventFacade

The change event

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

`_removeScrollbar`

() protected

Inherited from DataTable: yui3/src/datatable/js/scroll.js:713

Available since 3.5.0

Removes the virtual scrollbar used by scrolling tables.

`_removeScrollCaptionTable`

() protected

Inherited from DataTable: yui3/src/datatable/js/scroll.js:621

Available since 3.5.0

Removes the table used to house the caption when the table is scrolling.

`_removeXScrollNode`

() protected

Inherited from DataTable: yui3/src/datatable/js/scroll.js:640

Available since 3.5.0

Removes the <div> wrapper used to contain the data table when the table is horizontally scrolling.

`_removeYScrollContainer`

() protected

Inherited from DataTable: yui3/src/datatable/js/scroll.js:659

Available since 3.5.0

Removes the <div> wrapper used to contain the data table and fixed header when the table is vertically scrolling.

`_removeYScrollHeader`

() protected

Inherited from DataTable: yui3/src/datatable/js/scroll.js:678

Available since 3.5.0

Removes the <table> used to contain the fixed column headers when the table is vertically scrolling.

`_removeYScrollNode`

() protected

Inherited from DataTable: yui3/src/datatable/js/scroll.js:694

Available since 3.5.0

Removes the <div> wrapper used to contain the data table when the table is vertically scrolling.

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

`_renderSortable`

() protected

Inherited from DataTable: yui3/src/datatable/js/sort.js:640

Available since 3.5.0

Initial application of the sortable UI.

`_renderUI`

() protected

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

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

`_scrollToCurrentIndex`

() protected

Inherited from A.WidgetToggle: alloy-ui/src/aui-widget/js/aui-widget-swipe.js:258

Scrolls to the widget's current index.

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

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

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

`_setCB`

(

node

)

private

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

Setter for the contentBox attribute

Parameters:

node Node | String

Returns:

Node

`_setColumnMap`

(

columns

)

protected

Inherited from DataTable: yui3/src/datatable/js/core.js:640

Available since 3.6.0

Iterates the array of column configurations to capture all columns with a key property. An map is built with column keys as the property name and the corresponding column object as the associated value. This map is then assigned to the instance's _columnMap property.

Parameters:

columns Object | String

The array of column config objects

`_setColumns`

(

val

)

Null | Object protected

Inherited from DataTable: yui3/src/datatable/js/core.js:685

Translates string columns into objects with that string as the value of its key property.

All columns are assigned a _yuid stamp and _id property corresponding to the column's configured name or key property with any spaces replaced with dashes. If the same name or key appears in multiple columns, subsequent appearances will have their _id appended with an incrementing number (e.g. if column "foo" is included in the columns attribute twice, the first will get _id of "foo", and the second an _id of "foo1"). Columns that are children of other columns will have the _parent property added, assigned the column object to which they belong.

Parameters:

val Null | Object | String

Array of config objects or strings

Returns:

Null | Object:

`_setColumnset`

(

val

)

deprecated protected

Inherited from DataTable: yui3/src/datatable/js/core.js:793

Deprecated: This will be removed with the deprecated `columnset` attribute in a later version.

Available since 3.5.0

Relays attribute assignments of the deprecated columnset attribute to the columns attribute. If a Columnset is object is passed, its basic object structure is mined.

Parameters:

val Array | Columnset

The columnset value to relay

`_setColumnWidth`

(

colIndex
width

)

protected

Inherited from DataTable: yui3/src/datatable/js/colwidths.js:198

Available since 3.5.0

Sets a columns's <col> element width style. This is needed to get around browser rendering differences.

The colIndex corresponds to the item index of the <col> in the table's <colgroup>.

To unset the width, pass a falsy value for the width.

Parameters:

colIndex Number

The display column index
width Number | String

The desired width

`_setData`

() protected

Inherited from DataTable: yui3/src/datatable/js/core.js:811

Available since 3.5.0

Accepts an object with each and getAttrs (preferably a ModelList or subclass) or an array of data objects. If an array is passes, it will create a ModelList to wrap the data. In doing so, it will set the created ModelList's model property to the class in the recordType attribute, which will be defaulted if not yet set.

If the data property is already set with a ModelList, passing an array as the value will call the ModelList's reset() method with that array rather than replacing the stored ModelList wholesale.

Any non-ModelList-ish and non-array value is invalid.

`_setRecordset`

(

val

)

deprecated protected

Inherited from DataTable: yui3/src/datatable/js/core.js:854

Deprecated: This will be removed with the deprecated `recordset` attribute in a later version.

Available since 3.5.0

Relays the value assigned to the deprecated recordset attribute to the data attribute. If a Recordset instance is passed, the raw object data will be culled from it.

Parameters:

val Object | Recordset

The recordset value to relay

`_setRecordType`

(

val

)

Function protected

Inherited from DataTable: yui3/src/datatable/js/core.js:882

Available since 3.5.0

Accepts a Base subclass (preferably a Model subclass). Alternately, it will generate a custom Model subclass from an array of attribute names or an object defining attributes and their respective configurations (it is assigned as the ATTRS of the new class).

Any other value is invalid.

Parameters:

val Function | String | Object

The Model subclass, array of attribute names, or the ATTRS definition for a custom model subclass

Returns:

Function:

A Base/Model subclass

`_setScrollable`

(

val

)

String protected

Inherited from DataTable: yui3/src/datatable/js/scroll.js:733

Available since 3.5.0

Accepts (case insensitive) values "x", "y", "xy", true, and false. true is translated to "xy" and upper case values are converted to lower case. All other values are invalid.

Parameters:

val String | Boolean

Incoming value for the scrollable attribute

Returns:

String:

`_setScrollProperties`

() protected

Inherited from DataTable: yui3/src/datatable/js/scroll.js:758

Available since 3.5.0

Assigns the _xScroll and _yScroll properties to true if an appropriate value is set in the scrollable attribute and the height and/or width is set.

`_setSortBy`

() protected

Inherited from DataTable: yui3/src/datatable/js/sort.js:653

Available since 3.5.0

Parses the current sortBy attribute into a normalized structure for the data ModelList's _compare method. Also updates the column configurations' sortDir properties.

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

`_setSwipe`

() protected

Inherited from A.WidgetToggle: alloy-ui/src/aui-widget/js/aui-widget-swipe.js:231

Sets swipe attribute.

`_sortComparator`

(

item

)

Model protected

Inherited from DataTable: yui3/src/datatable/js/sort.js:744

Available since 3.5.0

Replacement comparator for the data ModelList that defers sorting logic to the _compare method. The deferral is accomplished by returning this.

Parameters:

item Model

APIs

A.PropertyList Class

Constructor

Parameters:

Index

Methods

Properties

Attributes

Events

Methods

@renderUI

_addAttrs

Parameters:

_addLazyAttr

Parameters:

_addOutOfOrder

Parameters:

_addScrollbarPadding

_afterChildSelectedChange

Parameters:

_afterColumnsChange

Parameters:

_afterCssClassChange

Parameters:

_afterCurrentIndexChange

Parameters:

_afterDataChange

Parameters:

_afterDisplayColumnsChange

Parameters:

_afterFocusedCellChange

Parameters:

_afterIndexChange

Parameters:

_afterKeyNavFocusedChange

Parameters:

_afterKeyNavRender

_afterMessageColumnsChange

Parameters:

_afterMessageDataChange

Parameters:

_afterRecordTypeChange

Parameters:

_afterRenderUI

_afterResponsiveSwipe

_afterScrollableChange

Parameters:

_afterScrollCaptionChange

Parameters:

_afterScrollColumnsChange

Parameters:

_afterScrollDataChange

Parameters:

_afterScrollHeightChange

Parameters:

_afterScrollWidthChange

Parameters:

_afterShowMessagesChange

Parameters:

_afterSortByChange

Parameters:

_afterSortDataChange

Parameters:

_afterSortRecordChange

Parameters:

_afterUITriggerSort

Parameters:

_afterWidgetUISetVisible

_aggregateAttrs

Parameters:

Returns:

_applyParsedConfig

Returns:

_applyParser

Parameters:

_attachSwipeEvents

_attrCfgHash

_baseDestroy

_baseInit

`A.PropertyList`

`@renderUI`

`_addAttrs`

`_addLazyAttr`

`_addOutOfOrder`

`_addScrollbarPadding`

`_afterChildSelectedChange`

`_afterColumnsChange`

`_afterCssClassChange`

`_afterCurrentIndexChange`

`_afterDataChange`

`_afterDisplayColumnsChange`

`_afterFocusedCellChange`

`_afterIndexChange`

`_afterKeyNavFocusedChange`

`_afterKeyNavRender`

`_afterMessageColumnsChange`

`_afterMessageDataChange`

`_afterRecordTypeChange`

`_afterRenderUI`

`_afterResponsiveSwipe`

`_afterScrollableChange`

`_afterScrollCaptionChange`

`_afterScrollColumnsChange`

`_afterScrollDataChange`

`_afterScrollHeightChange`

`_afterScrollWidthChange`

`_afterShowMessagesChange`

`_afterSortByChange`

`_afterSortDataChange`

`_afterSortRecordChange`

`_afterUITriggerSort`

`_afterWidgetUISetVisible`

`_aggregateAttrs`

`_applyParsedConfig`

`_applyParser`

`_attachSwipeEvents`

`_attrCfgHash`

`_baseDestroy`

`_baseInit`

`_bindAttrUI`

`_bindDOM`

`_bindMessageUI`

`_bindScrollbar`

`_bindScrollResize`

`_bindScrollUI`

`_bindSortUI`

`_bindUI`

`_bindUIChild`

`_clearScrollLock`

`_cloneDefaultValue`

`_createColumnGroup`

`_createRecordClass`

`_createScrollbar`

`_createScrollCaptionTable`

`_createUIEvent`

`_createXScrollNode`

`_createYScrollHeader`

`_createYScrollNode`

`_defAddColumnFn`

`_defAttrChangeFn`

`_defaultBB`

`_defaultCB`

`_defDestroyFn`

`_defInitFn`

`_defModifyColumnFn`

`_defMoveColumnFn`

`_defRemoveColumnFn`

`_defRenderFn`

`_defRenderViewFn`

`_defSortFn`

`_destroyBox`

`_destroyHierarchy`

`_destroyUIEvents`

`_detachSwipeEvents`

`_disableScrolling`

`_disableScrollView`

`_disableXScrolling`

`_disableYScrolling`

`_enableScrollView`