A.PropertyList Class
A base class for PropertyList.
Constructor
A.PropertyList
-
config
Parameters:
-
config
ObjectObject literal specifying widget configuration properties.
Index
Methods
- @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
- _extractDisplayColumns
- _filterAdHocAttrs
- _filterUIEvent
- _fireAttrChange
- _focusedCellSetter
- _getAttr
- _getAttrCfg
- _getAttrCfgs
- _getAttrInitVal
- _getAttrs
- _getCellColumnName
- _getClasses
- _getColumns
- _getColumnset deprecated
- _getFullType
- _getHtmlParser
- _getInstanceAttrCfgs
- _getNodeToParse
- _getRecordType
- _getSortBy
- _getSrcNode
- _getStateVal
- _getTHParent
- _getType
- _getUIEventNode
- _guid
- _hasPotentialSubscribers
- _initAttrHost
- _initAttribute
- _initAttrs
- _initBase
- _initColumns
- _initCoreEvents
- _initData
- _initDataProperty
- _initHierarchy
- _initHierarchyData
- _initHighlight
- _initMessageNode
- _initMessageStrings
- _initSortFn
- _initSortStrings
- _initUIEvent
- _isLazyAttr
- _isUIEvent
- _keyMoveColBottom
- _keyMoveColTop
- _keyMoveDown
- _keyMoveFirst
- _keyMoveLeft
- _keyMoveRight
- _keyMoveRowEnd
- _keyMoveRowStart
- _keyMoveUp
- _keyNavFireEvent
- _mapInstance
- _monitor
- _normAttrVals
- _onActiveCellChange
- _onDocFocus
- _onDocMouseDown
- _onKeyNavClick
- _onKeyNavKeyDown
- _onResponsiveSwipe
- _onSelectionKey
- _onUITriggerSort
- _parseSortable
- _parseType
- _plugPaginator
- _preAddAttrs
- _preInitEventCfg
- _protectAttrs deprecated
- _publish
- _relayCoreAttrChange
- _removeLoadingClassNames
- _removeScrollbar
- _removeScrollCaptionTable
- _removeXScrollNode
- _removeYScrollContainer
- _removeYScrollHeader
- _removeYScrollNode
- _renderBox
- _renderBoxClassNames
- _renderSortable
- _renderUI
- _scrollToCurrentIndex
- _set
- _setAttr
- _setAttrs
- _setAttrUI
- _setAttrVal
- _setBB
- _setBox
- _setCB
- _setColumnMap
- _setColumns
- _setColumnset deprecated
- _setColumnWidth
- _setData
- _setRecordset deprecated
- _setRecordType
- _setScrollable
- _setScrollProperties
- _setSortBy
- _setStateVal
- _setSwipe
- _sortComparator
- _strSetter
- _syncAttrUI
- _syncMessageUI
- _syncPropertyListScrollUI
- _syncScrollCaptionUI
- _syncScrollColumnWidths
- _syncScrollHeaders
- _syncScrollPosition
- _syncScrollUI
- _syncUI
- _syncUIChild
- _syncXScrollUI
- _syncYScrollUI
- _uiSetChildSelected
- _uiSetColumnWidths
- _uiSetCssClass
- _uiSetDim
- _uiSetDisabled
- _uiSetFocused
- _uiSetHeight
- _uiSetMessage
- _uiSetScrollable
- _uiSetScrollbarHeight
- _uiSetScrollbarPosition
- _uiSetSortable
- _uiSetSwipe
- _uiSetTabIndex
- _uiSetVisible
- _uiSetWidth
- _uiSetYScrollWidth
- _uiSizeCB
- _unbindDOM
- _unbindScrollbar
- _unbindScrollResize
- _unbindUI
- _validateSortable
- _validateSortBy
- _validateView
- _validTabIndex
- addAttr
- addAttrs
- addColumn
- addRow
- addRows
- addTarget
- after
- ancestor
- attrAdded
- before
- bindUI
- blur
- bubble
- delegate
- destroy
- destructor
- detach
- detachAll
- disable
- enable
- fire
- focus
- get
- getAttrs
- getCell
- getClassName
- getColumn
- getDefaultEditor
- getEvent
- getRecord
- getRow
- getSkinName
- getString deprecated
- getStrings deprecated
- getTargets
- hide
- hideMessage
- init
- initializer
- isRoot
- modifyAttr
- modifyColumn
- modifyRow
- moveColumn
- next
- on
- once
- onceAfter
- parseType
- previous
- publish
- removeAttr
- removeColumn
- removeRow
- removeTarget
- render
- renderer
- renderUI
- reset
- scrollTo
- set
- setAttrs
- setColumnWidth
- show
- showMessage
- sort
- subscribe deprecated
- syncUI
- toggle
- toggleSort
- toString
- unsubscribe deprecated
- unsubscribeAll deprecated
Properties
- _allowAdHocAttrs
- _CAPTION_TABLE_TEMPLATE
- _columnMap
- _displayColumns
- _keyNavColPrefix
- _keyNavColRegExp
- _keyNavNestedHeaders
- _keyNavSubscr
- _keyNavTHead
- _messageNode
- _SCROLL_LINER_TEMPLATE
- _SCROLLBAR_TEMPLATE
- _sortable
- _sortBy
- _tableNode
- _UI_ATTRS
- _X_SCROLLER_TEMPLATE
- _xScroll
- _xScrollNode
- _Y_SCROLL_HEADER_TEMPLATE
- _Y_SCROLLER_TEMPLATE
- _yScroll
- _yScrollHeader
- _yScrollNode
- ATTRS static
- BOUNDING_TEMPLATE
- COL_TEMPLATE
- COLGROUP_TEMPLATE
- CONTENT_TEMPLATE
- CSS_PREFIX static
- data
- DEF_PARENT_NODE
- DEF_UNIT
- keyActions
- MESSAGE_TEMPLATE
- name deprecated
- SORTABLE_HEADER_TEMPLATE
- UI_EVENTS
Attributes
- autoSync
- bodyConfig
- bodyView
- booleanLabels
- boundingBox
- caption
- columns
- columnset
- contentBox
- cssClass
- currencyFormat
- data
- dateFormat
- destroyed
- disabled
- editEvent
- focused
- focusedCell
- footerConfig
- footerView
- headerConfig
- headerView
- height
- id
- initialized
- keyIntoHeaders
- numberFormat
- recordset
- recordType
- render
- rendered
- scrollable
- showMessages
- sortable
- sortBy
- srcNode
- strings
- summary
- swipe
- tabIndex
- useScrollViewPaginator
- view
- viewConfig
- visible
- width
Methods
@renderUI
()
protected
Instantiates the configured view
class that will be responsible for
setting up the View class.
_addAttrs
-
cfgs
-
values
-
lazy
Implementation behind the public addAttrs method.
This method is invoked directly by get if it encounters a scenario in which an attribute's valueFn attempts to obtain the value an attribute in the same group of attributes, which has not yet been added (on demand initialization).
Parameters:
-
cfgs
Object<p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p>An object with attribute name/configuration pairs.</p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p>
-
values
Object<p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p>An object with attribute name/value pairs, defining the initial values to apply. Values defined in the cfgs argument will be over-written by values in this argument unless defined as read only.</p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p>
-
lazy
Boolean<p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p>Whether or not to delay the intialization of these attributes until the first call to get/set. Individual attributes can over-ride this behavior by defining a lazyAdd configuration property in their configuration. See <a href="#method_addAttr">addAttr</a>.</p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p>
_addLazyAttr
-
name
-
[lazyCfg]
Finishes initializing an attribute which has been lazily added.
Parameters:
-
name
Object<p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p>The name of the attribute</p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p>
-
[lazyCfg]
Object optional<p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p>Optional config hash for the attribute. This is added for performance along the critical path, where the calling method has already obtained lazy config from state.</p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p>
_addOutOfOrder
-
name
-
cfg
Utility method used by get/set to add attributes encountered out of order when calling addAttrs().
For example, if:
this.addAttrs({
foo: {
setter: function() {
// make sure this bar is available when foo is added
this.get("bar");
}
},
bar: {
value: ...
}
});
Parameters:
-
name
String<p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p>attribute name</p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p>
-
cfg
Object<p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p>attribute configuration</p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p>
_addScrollbarPadding
()
protected
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
Default attribute change listener for the <code>selected</code> attribute, responsible for updating the UI, in response to attribute changes.
Parameters:
-
event
EventFacade<p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p>The event facade for the attribute change.</p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p>
_afterColumnsChange
-
e
Updates the _columnMap
property in response to changes in the columns
attribute.
Parameters:
-
e
EventFacadeThe
columnsChange
event object
_afterCssClassChange
-
event
Fires after the value of the cssClass attribute change.
Parameters:
-
event
EventFacade
_afterCurrentIndexChange
-
event
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
-
e
Updates the modelList
attributes of the rendered views in response to the
data
attribute being assigned a new ModelList.
Parameters:
-
e
EventFacadethe
dataChange
event
_afterDisplayColumnsChange
-
e
Updates the _displayColumns
property.
Parameters:
-
e
EventFacadeThe
columnsChange
event
_afterFocusedCellChange
-
e
Sets the tabIndex on the focused cell and, if the DataTable has the focus, sets the focus on it.
Parameters:
_afterIndexChange
-
event
Fired after the scrollview's index
attribute is changed. Will update
the widget's index accordingly.
Parameters:
-
event
EventFacade
_afterMessageColumnsChange
-
e
Updates the colspan of the <td>
used to display the messages.
Parameters:
-
e
EventFacadeThe columnsChange event
_afterMessageDataChange
-
e
Relays to _uiSetMessage
to hide or show the message node.
Parameters:
-
e
EventFacadeThe dataChange event
_afterRecordTypeChange
-
e
Assigns to the new recordType as the model for the data ModelList
Parameters:
-
e
EventFacaderecordTypeChange event
_afterRenderUI
()
protected
Fires after the renderUI
event.
_afterResponsiveSwipe
()
protected
Fired after the widget's responsive
event. This adds back the swipe css
class that was removed by _onResponsiveSwipe
and then syncs the scroll UI.
_afterScrollableChange
-
e
Reacts to changes in the scrollable
attribute by updating the _xScroll
and _yScroll
properties and syncing the scrolling structure accordingly.
Parameters:
-
e
EventFacadeThe relevant change event (ignored)
_afterScrollCaptionChange
-
e
Reacts to changes in the caption
attribute by adding, removing, or
syncing the caption table when the table is set to scroll.
Parameters:
-
e
EventFacadeThe relevant change event (ignored)
_afterScrollColumnsChange
-
e
Reacts to changes in the columns
attribute of vertically scrolling tables
by refreshing the fixed headers, scroll container, and virtual scrollbar
position.
Parameters:
-
e
EventFacadeThe relevant change event (ignored)
_afterScrollDataChange
-
e
Reacts to changes in vertically scrolling table's data
ModelList by
synchronizing the fixed column header widths and virtual scrollbar height.
Parameters:
-
e
EventFacadeThe relevant change event (ignored)
_afterScrollHeightChange
-
e
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
EventFacadeThe relevant change event (ignored)
_afterScrollWidthChange
-
e
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
EventFacadeThe relevant change event (ignored)
_afterShowMessagesChange
-
e
Removes the message node if showMessages
is false
, or relays to
_uiSetMessage
if true
.
Parameters:
-
e
EventFacadeThe showMessagesChange event
_afterSortByChange
-
e
Sorts the data
ModelList based on the new sortBy
configuration.
Parameters:
-
e
EventFacadeThe
sortByChange
event
_afterSortDataChange
-
e
Applies the sorting logic to the new ModelList if the newVal
is a new
ModelList.
Parameters:
-
e
EventFacadethe
dataChange
event
_afterSortRecordChange
-
e
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
EventFacadeThe Model's
change
event
_afterUITriggerSort
-
event
Fires after the UITriggerSort
event.
Parameters:
-
event
EventFacade
_afterWidgetUISetVisible
()
protected
Fired after the widget's _uiSetVisible function is called. It prepares the swipe funcionality for use.
_aggregateAttrs
-
allAttrs
A helper method, used by _initHierarchyData to aggregate attribute configuration across the instances class hierarchy.
The method will protect the attribute configuration value to protect the statically defined default value in ATTRS if required (if the value is an object literal, array or the attribute configuration has cloneDefaultValue set to shallow or deep).
Parameters:
-
allAttrs
Array<p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p>An array of ATTRS definitions across classes in the hierarchy (subclass first, Base last)</p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p>
Returns:
<p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p>The aggregate set of ATTRS definitions for the instance</p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p>
_applyParsedConfig
()
Object
protected
Returns:
<p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p>The merged configuration literal</p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p>
_applyParser
-
config
Utility method used to apply the <code>HTML_PARSER</code> configuration for the instance, to retrieve config data values.
Parameters:
-
config
Object<p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p>User configuration object (will be populated with values from Node)</p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p>
_attachSwipeEvents
()
protected
Listens to the necessary events for the swipe funcionality to work correctly.
_attrCfgHash
()
private
Utility method to define the attribute hash used to filter/whitelist property mixes for this class for iteration performance reasons.
_baseDestroy
()
private
Internal destroy implementation for BaseCore
_baseInit
()
private
Internal initialization implementation for BaseCore
_bindAttrUI
-
attrs
Binds after listeners for the list of attributes provided
Parameters:
-
attrs
Array
_bindDOM
()
protected
Sets up DOM listeners, on elements rendered by the widget.
_bindMessageUI
()
protected
Binds the events necessary to keep the message node in sync with the current table and configuration state.
_bindScrollbar
()
protected
Binds virtual scrollbar interaction to the _yScrollNode
's scrollTop
and
vice versa.
_bindScrollResize
()
protected
Binds to the window resize event to update the vertical scrolling table
headers and wrapper <div>
dimensions.
_bindScrollUI
()
protected
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
Subscribes to state changes that warrant updating the UI, and adds the click handler for triggering the sort operation from the UI.
_bindUI
()
protected
Sets up DOM and CustomEvent listeners for the widget.
_bindUIChild
()
protected
Binds event listeners responsible for updating the UI state in response to WidgetChild related state changes. <p> This method is invoked after bindUI is invoked for the Widget class using YUI's aop infrastructure. </p>
_clearScrollLock
()
protected
Clears the lock and timer used to manage synchronizing the scroll position between the vertical scroll container and the virtual scrollbar.
_cloneDefaultValue
-
cfg
This method assumes that the value has already been checked to be an object. Since it's on a critical path, we don't want to re-do the check.
Parameters:
-
cfg
Object
_createColumnGroup
()
protected
Renders the table's <colgroup>
and populates the _colgroupNode
property.
_createRecordClass
-
attrs
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 | ObjectNames assigned to the Model subclass's
ATTRS
or its entireATTRS
definition object
Returns:
_createScrollbar
()
Node
protected
Creates a virtual scrollbar from the _SCROLLBAR_TEMPLATE
, assigning it to
the _scrollbarNode
property.
Returns:
The created Node
_createScrollCaptionTable
()
Node
protected
Creates a separate table to contain the caption when the table is configured to scroll vertically or horizontally.
Returns:
The created Node
_createUIEvent
-
type
Binds a delegated DOM event listener of the specified type to the Widget's outtermost DOM element to facilitate the firing of a Custom Event of the same type for the Widget instance.
Parameters:
-
type
String<p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p>String representing the name of the event</p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p>
_createXScrollNode
()
Node
protected
Populates the _xScrollNode
property by creating the <div>
Node described
by the _X_SCROLLER_TEMPLATE
.
Returns:
The created Node
_createYScrollHeader
()
Node
protected
Populates the _yScrollHeader
property by creating the <table>
Node
described by the _Y_SCROLL_HEADER_TEMPLATE
.
Returns:
The created Node
_createYScrollNode
()
Node
protected
Populates the _yScrollNode
property by creating the <div>
Node described
by the _Y_SCROLLER_TEMPLATE
.
Returns:
The created Node
_defAddColumnFn
-
e
Default function for the addColumn
event.
Inserts the specified column at the provided index.
Parameters:
-
e
EventFacadeThe
addColumn
event
_defAttrChangeFn
-
e
-
eventFastPath
Default function for attribute change events.
Parameters:
-
e
EventFacade<p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p>The event object for attribute change events.</p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p>
-
eventFastPath
Boolean<p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p>Whether or not we're using this as a fast path in the case of no listeners or not</p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p>
_defaultBB
()
protected
Returns the default value for the boundingBox attribute.
For the Widget class, this will most commonly be null (resulting in a new boundingBox node instance being created), unless a srcNode was provided and CONTENT_TEMPLATE is null, in which case it will be srcNode. This behavior was introduced in @VERSION@ to accomodate single-box widgets whose BB & CB both point to srcNode (e.g. Y.Button).
_defaultCB
()
protected
Returns the default value for the contentBox attribute.
For the Widget class, this will be the srcNode if provided, otherwise null (resulting in a new contentBox node instance being created)
_defDestroyFn
-
e
Default destroy event handler
Parameters:
-
e
EventFacade<p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p>Event object</p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p>
_defInitFn
-
e
Default init event handler
Parameters:
-
e
EventFacade<p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p>Event object, with a cfg property which refers to the configuration object passed to the constructor.</p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p>
_defModifyColumnFn
-
e
Default function for the modifyColumn
event.
Mixes the new column properties into the specified column definition.
Parameters:
-
e
EventFacadeThe
modifyColumn
event
_defMoveColumnFn
-
e
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
EventFacadeThe
moveColumn
event
_defRemoveColumnFn
-
e
Default function for the removeColumn
event.
Splices the specified column from its containing columns array.
Parameters:
-
e
EventFacadeThe
removeColumn
event
_defRenderFn
-
e
-
parentNode
Default render handler
Parameters:
-
e
EventFacade<p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p>The Event object</p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p>
-
parentNode
Node<p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p>The parent node to render to, if passed in to the <code>render</code> method</p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p>
_defRenderViewFn
-
e
The default behavior of the renderView
event. Calls render()
on the
View
instance on the event.
Parameters:
-
e
EventFacadeThe
renderView
event
_defSortFn
-
e
Sets the sortBy
attribute from the sort
event's e.sortBy
value.
Parameters:
-
e
EventFacadeThe
sort
event
_destroyBox
()
protected
Removes and destroys the widgets rendered boundingBox, contentBox, and detaches bound UI events.
_destroyHierarchy
()
private
Destroys the class hierarchy for this instance by invoking the destructor method on the prototype of each class in the hierarchy.
_destroyUIEvents
()
private
Destructor logic for UI event infrastructure, invoked during Widget destruction.
_detachSwipeEvents
()
protected
Detaches all events related to the swipe funcionality.
_disableScrolling
()
protected
Removes the nodes used to create horizontal and vertical scrolling and rejoins the caption to the main table if needed.
_disableScrollView
()
protected
Disables the scroll view, removing the swipe funcionality.
_disableXScrolling
()
protected
Removes the nodes used to allow horizontal scrolling.
_disableYScrolling
()
protected
Removes the nodes used to allow vertical scrolling.
_enableScrollView
()
protected
Enables the scroll view, adding the swipe funcionality.
_extractDisplayColumns
-
columns
Processes the full column array, distilling the columns down to those that correspond to cell data columns.
Parameters:
-
columns
ObjectThe full set of table columns
_filterAdHocAttrs
-
allAttrs
-
userVals
Parameters:
-
allAttrs
Object<p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p>The set of all attribute configurations for this instance. Attributes will be removed from this set, if they belong to the filtered class, so that by the time all classes are processed, allCfgs will be empty.</p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p>
-
userVals
Object<p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p>The config object passed in by the user, from which adhoc attrs are to be filtered.</p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p>
Returns:
<p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p>The set of adhoc attributes passed in, in the form of an object with attribute name/configuration pairs.</p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p>
_filterUIEvent
-
evt
This method is used to determine if we should fire the UI Event or not. The default implementation makes sure that for nested delegates (nested unrelated widgets), we don't fire the UI event listener more than once at each level.
<p>For example, without the additional filter, if you have nested widgets, each widget will have a delegate listener. If you click on the inner widget, the inner delegate listener's filter will match once, but the outer will match twice (based on delegate's design) - once for the inner widget, and once for the outer.</p>
Parameters:
-
evt
DOMEventFacade
Returns:
<p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p>true if it's OK to fire the custom UI event, false if not.</p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p>
_fireAttrChange
-
attrName
-
subAttrName
-
currVal
-
newVal
-
opts
-
[cfg]
Utility method to help setup the event payload and fire the attribute change event.
Parameters:
-
attrName
String<p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p>The name of the attribute</p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p>
-
subAttrName
String<p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p>The full path of the property being changed, if this is a sub-attribute value being change. Otherwise null.</p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p>
-
currVal
Any<p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p>The current value of the attribute</p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p>
-
newVal
Any<p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p>The new value of the attribute</p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p>
-
opts
Object<p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p>Any additional event data to mix into the attribute change event's event facade.</p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p>
-
[cfg]
Object optional<p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p>The attribute config stored in State, if already available.</p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p>
_focusedCellSetter
-
cell
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
NodeDataTable cell to receive the focus
Returns:
cell or Y.Attribute.INVALID_VALUE
_getAttr
-
name
Provides the common implementation for the public get method, allowing Attribute hosts to over-ride either method.
See <a href="#method_get">get</a> for argument details.
Parameters:
-
name
String<p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p>The name of the attribute.</p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p>
Returns:
<p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p>The value of the attribute.</p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p>
_getAttrCfg
-
name
Returns an object with the configuration properties (and value) for the given attribute. If attrName is not provided, returns the configuration properties for all attributes.
Parameters:
-
name
String<p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p>Optional. The attribute name. If not provided, the method will return the configuration for all attributes.</p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p>
Returns:
<p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p>The configuration properties for the given attribute, or all attributes.</p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p>
_getAttrCfgs
()
Object
protected
Returns an aggregated set of attribute configurations, by traversing the class hierarchy.
Returns:
<p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p>The hash of attribute configurations, aggregated across classes in the hierarchy This value is cached the first time the method, or _getClasses, is invoked. Subsequent invocations return the cached value.</p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p>
_getAttrInitVal
-
attr
-
cfg
-
initValues
Returns the initial value of the given attribute from either the default configuration provided, or the over-ridden value if it exists in the set of initValues provided and the attribute is not read-only.
Parameters:
-
attr
String<p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p>The name of the attribute</p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p>
-
cfg
Object<p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p>The attribute configuration object</p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p>
-
initValues
Object<p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p>The object with simple and complex attribute name/value pairs returned from _normAttrVals</p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p>
Returns:
<p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p>The initial value of the attribute.</p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p>
_getAttrs
-
attrs
Implementation behind the public getAttrs method, to get multiple attribute values.
Parameters:
-
attrs
String | Boolean<p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p>Optional. An array of attribute names. If omitted, all attribute values are returned. If set to true, all attributes modified from their initial values are returned.</p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p>
Returns:
<p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p>An object with attribute name/value pairs.</p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p>
_getCellColumnName
-
cell
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
NodeCell to get column name from
Returns:
String Column name of the provided cell
_getClasses
()
Function
protected
Returns the class hierarchy for this object, with BaseCore being the last class in the array.
Returns:
<p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p>An array of classes (constructor functions), making up the class hierarchy for this object. This value is cached the first time the method, or _getAttrCfgs, is invoked. Subsequent invocations return the cached value.</p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p>
_getColumns
-
columns
-
name
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
ObjectThe full array of column objects
-
name
StringThe attribute name requested (e.g. 'columns' or 'columns.foo');
_getColumnset
-
ignored
-
name
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
ObjectThe current value stored in the
columnset
state -
name
StringThe attribute name requested (e.g. 'columnset' or 'columnset.foo');
_getFullType
-
type
Returns the fully qualified type, given a short type string. That is, returns "foo:bar" when given "bar" if "foo" is the configured prefix.
NOTE: This method, unlike _getType, does no checking of the value passed in, and is designed to be used with the low level _publish() method, for critical path implementations which need to fast-track publish for performance reasons.
Parameters:
-
type
String<p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p>The short type to prefix</p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p>
Returns:
<p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p>The prefixed type, if a prefix is set, otherwise the type passed in</p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p>
_getHtmlParser
()
Object
private
Gets the HTML_PARSER definition for this instance, by merging HTML_PARSER definitions across the class hierarchy.
Returns:
<p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p>HTML_PARSER definition for this instance</p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p>
_getInstanceAttrCfgs
-
allCfgs
A helper method used to isolate the attrs config for this instance to pass to addAttrs
,
from the static cached ATTRS for the class.
Parameters:
-
allCfgs
Object<p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p>The set of all attribute configurations for this instance. Attributes will be removed from this set, if they belong to the filtered class, so that by the time all classes are processed, allCfgs will be empty.</p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p>
Returns:
<p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p>The set of attributes to be added for this instance, suitable for passing through to <code>addAttrs</code>.</p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p>
_getNodeToParse
()
Node
private
Determines whether we have a node reference which we should try and parse.
The current implementation does not parse nodes generated from CONTENT_TEMPLATE, only explicitly set srcNode, or contentBox attributes.
Returns:
<p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p>The node reference to apply HTML_PARSER to.</p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p>
_getRecordType
-
val
Returns the Model class of the instance's data
attribute ModelList. If
not set, returns the explicitly configured value.
Parameters:
-
val
ModelThe currently configured value
Returns:
_getSortBy
-
val
-
detail
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 | ObjectThe current sortBy value
-
detail
StringString passed to
get(HERE)
. to parse subattributes
_getSrcNode
()
Node
protected
Returns:
<p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p>The Node to apply HTML_PARSER to</p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p>
_getStateVal
-
name
-
[cfg]
Gets the stored value for the attribute, from either the internal state object, or the state proxy if it exits
Parameters:
-
name
String<p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p>The name of the attribute</p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p>
-
[cfg]
Object optional<p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p>Optional config hash for the attribute. This is added for performance along the critical path, where the calling method has already obtained the config from state.</p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p>
Returns:
<p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p>The stored value of the attribute</p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p>
_getTHParent
-
thCell
Retrieves the parent cell of the given TH cell. If there is no parent for the provided cell, null is returned.
Parameters:
-
thCell
NodeCell to find parent of
Returns:
Parent of the cell provided or null
_getType
()
private
If the instance has a prefix attribute and the event type is not prefixed, the instance prefix is applied to the supplied type.
_getUIEventNode
()
protected
Returns the node on which to bind delegate listeners.
_guid
()
protected
_hasPotentialSubscribers
-
fullType
Parameters:
-
fullType
String<p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p>The fully prefixed type name</p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p>
Returns:
<p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p>Whether the event has potential subscribers or not</p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p>
_initAttrHost
-
attrs
-
values
-
lazy
Constructor logic for attributes. Initializes the host state, and sets up the inital attributes passed to the constructor.
Parameters:
-
attrs
Object<p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p>The attributes to add during construction (passed through to <a href="#method_addAttrs">addAttrs</a>). These can also be defined on the constructor being augmented with Attribute by defining the ATTRS property on the constructor.</p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p>
-
values
Object<p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p>The initial attribute values to apply (passed through to <a href="#method_addAttrs">addAttrs</a>). These are not merged/cloned. The caller is responsible for isolating user provided values if required.</p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p>
-
lazy
Boolean<p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p>Whether or not to add attributes lazily (passed through to <a href="#method_addAttrs">addAttrs</a>).</p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p>
_initAttribute
()
private
Initializes AttributeCore
_initAttrs
-
attrs
-
values
-
lazy
Utility method to set up initial attributes defined during construction, either through the constructor.ATTRS property, or explicitly passed in.
Parameters:
-
attrs
Object<p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p>The attributes to add during construction (passed through to <a href="#method_addAttrs">addAttrs</a>). These can also be defined on the constructor being augmented with Attribute by defining the ATTRS property on the constructor.</p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p>
-
values
Object<p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p>The initial attribute values to apply (passed through to <a href="#method_addAttrs">addAttrs</a>). These are not merged/cloned. The caller is responsible for isolating user provided values if required.</p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p>
-
lazy
Boolean<p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p>Whether or not to add attributes lazily (passed through to <a href="#method_addAttrs">addAttrs</a>).</p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p>
_initBase
-
config
Internal construction logic for BaseCore.
Parameters:
-
config
Object<p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p>The constructor configuration object</p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p>
_initColumns
()
protected
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
Sets up the change event subscriptions to maintain internal state.
_initData
()
ModelList
protected
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:
_initDataProperty
-
data
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
.
_initHierarchy
-
userVals
Initializes the class hierarchy for the instance, which includes initializing attributes for each class defined in the class's static <a href="#property_BaseCore.ATTRS">ATTRS</a> property and invoking the initializer method on the prototype of each class in the hierarchy.
Parameters:
-
userVals
Object<p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p>Object with configuration property name/value pairs</p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p>
_initHierarchyData
()
private
A helper method used by _getClasses and _getAttrCfgs, which determines both the array of classes and aggregate set of attribute configurations across the class hierarchy for the instance.
_initHighlight
()
protected
Initializer for the A.DataTable
highlighter.
_initMessageNode
()
protected
Creates the _messageNode
property from the configured MESSAGE_TEMPLATE
and inserts it before the <table>
's <tbody>
node.
_initMessageStrings
()
protected
Add the messaging related strings to the strings
map.
_initSortFn
()
protected
Creates a _compare
function for the data
ModelList to allow custom
sorting by multiple fields.
_initSortStrings
()
protected
Add the sort related strings to the strings
map.
_initUIEvent
-
type
Sets up infrastructure required to fire a UI event.
Parameters:
-
type
String<p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p>String representing the name of the event</p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p>
Returns:
_isLazyAttr
-
name
Checks whether or not the attribute is one which has been added lazily and still requires initialization.
Parameters:
-
name
String<p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p>The name of the attribute</p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p>
Returns:
<p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p>true if it's a lazily added attribute, false otherwise.</p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p>
_isUIEvent
-
type
Determines if the specified event is a UI event.
Parameters:
-
type
String<p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p>String representing the name of the event</p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p>
Returns:
<p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p>Event Returns the name of the UI Event, otherwise undefined.</p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p>
_keyMoveColBottom
-
e
Sets the focus on the last cell of the column containing the currently focused cell.
Parameters:
-
e
EventFacadeEvent Facade for the keydown event
_keyMoveColTop
-
e
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
EventFacadeEvent Facade for the keydown event
_keyMoveDown
-
e
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
EventFacadeEvent Facade for the keydown event
_keyMoveFirst
()
private
Sets the focus on the very first cell in the header of the table.
_keyMoveLeft
-
e
Sets the focus on the cell to the left of the currently focused one. Does not wrap, following the WAI-ARIA recommendation.
Parameters:
-
e
EventFacadeEvent Facade for the keydown event
_keyMoveRight
-
e
Sets the focus on the cell to the right of the currently focused one. Does not wrap, following the WAI-ARIA recommendation.
Parameters:
-
e
EventFacadeEvent Facade for the keydown event
_keyMoveRowEnd
-
e
Sets the focus on the right-most cell of the row containing the currently focused cell.
Parameters:
-
e
EventFacadeEvent Facade for the keydown event
_keyMoveRowStart
-
e
Sets the focus on the left-most cell of the row containing the currently focused cell.
Parameters:
-
e
EventFacadeEvent Facade for the keydown event
_keyMoveUp
-
e
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
EventFacadeEvent Facade for the keydown event
_mapInstance
-
The
Utility method used to add an entry to the boundingBox id to instance map.
This method can be used to populate the instance with lazily created boundingBox Node references.
Parameters:
-
The
String<p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p>boundingBox id</p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p>
_monitor
-
what
-
eventType
-
o
This is the entry point for the event monitoring system. You can monitor 'attach', 'detach', 'fire', and 'publish'. When configured, these events generate an event. click -> click_attach, click_detach, click_publish -- these can be subscribed to like other events to monitor the event system. Inividual published events can have monitoring turned on or off (publish can't be turned off before it it published) by setting the events 'monitor' config.
Parameters:
-
what
String<p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p>'attach', 'detach', 'fire', or 'publish'</p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p>
-
eventType
String | CustomEvent<p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p>The prefixed name of the event being monitored, or the CustomEvent object.</p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p>
-
o
Object<p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p>Information about the event interaction, such as fire() args, subscription category, publish config</p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p>
_normAttrVals
-
valueHash
Utility method to normalize attribute values. The base implementation simply merges the hash to protect the original.
Parameters:
-
valueHash
Object<p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p>An object with attribute name/value pairs</p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p>
Returns:
<p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p>An object literal with 2 properties - "simple" and "complex", containing simple and complex attribute values respectively keyed by the top level attribute name, or null, if valueHash is falsey.</p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p>
_onActiveCellChange
-
event
Fires on activeCellChange
event.
Parameters:
-
event
EventFacade
_onDocFocus
-
evt
DOM focus event handler, used to sync the state of the Widget with the DOM
Parameters:
-
evt
EventFacade<p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p>The event facade for the DOM focus event</p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p>
_onDocMouseDown
-
evt
"mousedown" event handler for the owner document of the widget's bounding box.
Parameters:
-
evt
EventFacade<p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p>The event facade for the DOM focus event</p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p>
_onResponsiveSwipe
()
protected
Fired on the widget's responsive
event. This removes the swipe css class,
so the responsive code can correctly calculate the widget's size. The css
class will be added back by _afterResponsiveSwipe
.
_onSelectionKey
-
event
Callback for the selection key event listener.
Parameters:
-
event
EventFacade
_onUITriggerSort
-
e
Fires the sort
event in response to user clicks on sortable column
headers.
Parameters:
-
e
DOMEventFacadeThe
click
event
_parseSortable
()
protected
Normalizes the possible input values for the sortable
attribute, storing
the results in the _sortable
property.
_parseType
()
private
Returns an array with the detach key (if provided), and the prefixed event name from _getType Y.on('detachcategory| menu:click', fn)
_plugPaginator
()
protected
Plugs ScrollViewPaginator if the useScrollViewPaginator
is true.
_preAddAttrs
-
attrs
-
userVals
-
lazy
Implement the BaseCore _preAddAttrs method hook, to add
the srcNode and related attributes, so that HTML_PARSER
(which relies on this.get("srcNode")
) can merge in it's
results before the rest of the attributes are added.
Parameters:
-
attrs
Object<p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p>The full hash of statically defined ATTRS attributes being added for this instance</p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p>
-
userVals
Object<p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p>The hash of user values passed to the constructor</p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p>
-
lazy
Boolean<p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p>Whether or not to add the attributes lazily</p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p>
_preInitEventCfg
-
config
Handles the special on, after and target properties which allow the user to easily configure on and after listeners as well as bubble targets during construction, prior to init.
Parameters:
-
config
Object<p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p>The user configuration object</p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p>
_protectAttrs
-
attrs
Utility method to protect an attribute configuration hash, by merging the entire object and the individual attr config objects.
Parameters:
-
attrs
Object<p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p>A hash of attribute to configuration object pairs.</p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p>
Returns:
<p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p>A protected version of the attrs argument.</p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p>
_publish
-
fullType
-
etOpts
-
ceOpts
The low level event publish implementation. It expects all the massaging to have been done
outside of this method. e.g. the type
to fullType
conversion. It's designed to be a fast
path publish, which can be used by critical code paths to improve performance.
Parameters:
-
fullType
String<p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p>The prefixed type of the event to publish.</p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p>
-
etOpts
Object<p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p>The EventTarget specific configuration to mix into the published event.</p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p>
-
ceOpts
Object<p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p>The publish specific configuration to mix into the published event.</p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p>
Returns:
<p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p>The published event. If called without <code>etOpts</code> or <code>ceOpts</code>, this will be the default <code>CustomEvent</code> instance, and can be configured independently.</p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p>
_relayCoreAttrChange
-
e
Relays attribute changes to the instance's view
.
Parameters:
-
e
EventFacadeThe change event
_removeLoadingClassNames
()
protected
Removes class names representative of the widget's loading state from the boundingBox.
_removeScrollbar
()
protected
Removes the virtual scrollbar used by scrolling tables.
_removeScrollCaptionTable
()
protected
Removes the table used to house the caption when the table is scrolling.
_removeXScrollNode
()
protected
Removes the <div>
wrapper used to contain the data table when the table
is horizontally scrolling.
_removeYScrollContainer
()
protected
Removes the <div>
wrapper used to contain the data table and fixed header
when the table is vertically scrolling.
_removeYScrollHeader
()
protected
Removes the <table>
used to contain the fixed column headers when the
table is vertically scrolling.
_removeYScrollNode
()
protected
Removes the <div>
wrapper used to contain the data table when the table
is vertically scrolling.
_renderBox
-
parentNode
Helper method to collect the boundingBox and contentBox and append to the provided parentNode, if not already a child. The owner document of the boundingBox, or the owner document of the contentBox will be used as the document into which the Widget is rendered if a parentNode is node is not provided. If both the boundingBox and the contentBox are not currently in the document, and no parentNode is provided, the widget will be rendered to the current document's body.
Parameters:
-
parentNode
Node<p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p>The parentNode to render the widget to. If not provided, and both the boundingBox and the contentBox are not currently in the document, the widget will be rendered to the current document's body.</p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p>
_renderBoxClassNames
()
protected
Applies standard class names to the boundingBox and contentBox
_renderSortable
()
protected
Initial application of the sortable UI.
_renderUI
()
protected
Initializes the UI state for the Widget's bounding/content boxes.
_scrollToCurrentIndex
()
protected
Scrolls to the widget's current index.
_set
-
name
-
val
-
[opts]
Allows setting of readOnly/writeOnce attributes. See <a href="#method_set">set</a> for argument details.
Parameters:
-
name
String<p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p>The name of the attribute.</p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p>
-
val
Any<p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p>The value to set the attribute to.</p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p>
-
[opts]
Object optional<p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p>Optional data providing the circumstances for the change.</p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p>
Returns:
<p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p>A reference to the host object.</p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p>
_setAttr
-
name
-
value
-
[opts]
-
force
Provides the common implementation for the public set and protected _set methods.
See <a href="#method_set">set</a> for argument details.
Parameters:
-
name
String<p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p>The name of the attribute.</p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p>
-
value
Any<p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p>The value to set the attribute to.</p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p>
-
[opts]
Object optional<p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p>Optional data providing the circumstances for the change.</p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p>
-
force
Boolean<p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p>If true, allows the caller to set values for readOnly or writeOnce attributes which have already been set.</p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p>
Returns:
<p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p>A reference to the host object.</p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p>
_setAttrs
-
attrs
-
[opts]
Implementation behind the public setAttrs method, to set multiple attribute values.
Parameters:
-
attrs
Object<p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p>An object with attributes name/value pairs.</p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p>
-
[opts]
Object optional<p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p>Optional data providing the circumstances for the change</p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p>
Returns:
<p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p>A reference to the host object.</p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p>
_setAttrVal
-
attrName
-
subAttrName
-
prevVal
-
newVal
-
[opts]
-
[attrCfg]
Updates the stored value of the attribute in the privately held State object, if validation and setter passes.
Parameters:
-
attrName
String<p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p>The attribute name.</p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p>
-
subAttrName
String<p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p>The sub-attribute name, if setting a sub-attribute property ("x.y.z").</p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p>
-
prevVal
Any<p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p>The currently stored value of the attribute.</p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p>
-
newVal
Any<p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p>The value which is going to be stored.</p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p>
-
[opts]
Object optional<p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p>Optional data providing the circumstances for the change.</p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p>
-
[attrCfg]
Object optional<p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p>Optional config hash for the attribute. This is added for performance along the critical path, where the calling method has already obtained the config from state.</p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p>
Returns:
<p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p>true if the new attribute value was stored, false if not.</p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p>
_setBB
-
node
Setter for the boundingBox attribute
Parameters:
-
node
Node | String
Returns:
<p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p>Node</p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p>
_setBox
-
id
-
node
-
template
-
isBounding
Helper method to set the bounding/content box, or create it from the provided template if not found.
Parameters:
-
id
String<p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p>The node's id attribute</p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p>
-
node
Node | String<p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p>The node reference</p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p>
-
template
String<p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p>HTML string template for the node</p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p>
-
isBounding
Boolean<p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p>true if this is the boundingBox, false if it's the contentBox</p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p>
Returns:
<p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p>The node</p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p>
_setCB
-
node
Setter for the contentBox attribute
Parameters:
-
node
Node | String
Returns:
<p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p>Node</p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p>
_setColumnMap
-
columns
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 | StringThe array of column config objects
_setColumns
-
val
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 | StringArray of config objects or strings
Returns:
_setColumnset
-
val
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 | ColumnsetThe columnset value to relay
_setColumnWidth
-
colIndex
-
width
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
.
_setData
()
protected
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
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 | RecordsetThe recordset value to relay
_setRecordType
-
val
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 | ObjectThe Model subclass, array of attribute names, or the
ATTRS
definition for a custom model subclass
Returns:
A Base/Model subclass
_setScrollable
-
val
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 | BooleanIncoming value for the
scrollable
attribute
Returns:
_setScrollProperties
()
protected
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
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
Sets the stored value for the attribute, in either the internal state object, or the state proxy if it exits
Parameters:
-
name
String<p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p>The name of the attribute</p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p>
-
value
Any<p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p><p>The value of the attribute</p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p></p>
_setSwipe
()
protected
Sets swipe
attribute.