A Widget for displaying tabular data. Before feature modules are use()d,
this class is functionally equivalent to DataTable.Base. However, feature
modules can modify this class in non-destructive ways, expanding the API and
functionality.
This is the primary DataTable class. Out of the box, it provides the ability to dynamically generate an HTML table from a set of column configurations and row data. But feature module inclusion can add table sorting, pagintaion, highlighting, selection, and more.
// The functionality of this table would require additional modules be use()d,
// but the feature APIs are aggregated onto Y.DataTable.
// (Snippet is for illustration. Not all features are available today.)
var table = new Y.DataTable({
columns: [
{ type: 'checkbox', defaultChecked: true },
{ key: 'firstName', sortable: true, resizable: true },
{ key: 'lastName', sortable: true },
{ key: 'role', formatter: toRoleName }
],
data: {
source: 'http://myserver.com/service/json',
type: 'json',
schema: {
resultListLocator: 'results.users',
fields: [
'username',
'firstName',
'lastName',
{ key: 'role', type: 'number' }
]
}
},
recordType: UserModel,
pagedData: {
location: 'footer',
pageSizes: [20, 50, 'all'],
rowsPerPage: 20,
pageLinks: 5
},
editable: true
});
The column configurations are set in the form of an array of objects, where each object corresponds to a column. For columns populated directly from the row data, a 'key' property is required to bind the column to that property or attribute in the row data.
Not all columns need to relate to row data, nor do all properties or attributes
of the row data need to have a corresponding column. However, only those
columns included in the columns configuration attribute will be rendered.
Other column configuration properties are supported by the configured
view, class as well as any features added by plugins or class extensions.
See the description of DataTable.TableView and its subviews
DataTable.HeaderView, DataTable.BodyView, and DataTable.FooterView (and other
DataTable feature classes) to see what column properties they support.
Some examples of column configurations would be:
// Basic
var columns = [{ key: 'firstName' }, { key: 'lastName' }, { key: 'age' }];
// For columns without any additional configuration, strings can be used
var columns = ['firstName', 'lastName', 'age'];
// Multi-row column headers (see DataTable.HeaderView for details)
var columns = [
{
label: 'Name',
children: [
{ key: 'firstName' },
{ key: 'lastName' }
]
},
'age' // mixing and matching objects and strings is ok
];
// Including columns that are not related 1:1 to row data fields/attributes
// (See DataTable.BodyView for details)
var columns = [
{
label: 'Name', // Needed for the column header
formatter: function (o) {
// Fill the column cells with data from firstName and lastName
if (o.data.age > 55) {
o.className += ' senior';
}
return o.data.lastName + ', ' + o.data.firstName;
}
},
'age'
];
// Columns that include feature configurations (for illustration; not all
// features are available today).
var columns = [
{ type: 'checkbox', defaultChecked: true },
{ key: 'firstName', sortable: true, resizable: true, min-width: '300px' },
{ key: 'lastName', sortable: true, resizable: true, min-width: '300px' },
{ key: 'age', emptyCellValue: 'unknown' }
];
The data configuration attribute is responsible for housing the data objects
that will be rendered as rows. You can provide this information in two ways by default:
If an array of objects is passed, it will be translated into a ModelList filled
with instances of the class provided to the recordType attribute. This
attribute can also create a custom Model subclass from an array of field names
or an object of attribute configurations. If no recordType is provided, one
will be created for you from available information (see _initRecordType).
Providing either your own ModelList instance for data, or at least Model
class for recordType, is the best way to control client-server
synchronization when modifying data on the client side.
The ModelList instance that manages the table's data is available in the data
property on the DataTable instance.
Table rendering is a collaborative process between the DataTable and its
configured view. The DataTable creates an instance of the configured view
(DataTable.TableView by default), and calls its render() method.
DataTable.TableView, for instance, then creates the <table> and <caption>,
then delegates the rendering of the specific sections of the table to subviews,
which can be configured as headerView, bodyView, and footerView.
DataTable.TableView defaults the headerView to DataTable.HeaderView and the
bodyView to DataTable.BodyView, but leaves the footerView unassigned.
Setting any subview to null will result in that table section not being
rendered.
@renderUIInstantiates the configured view class that will be responsible for
setting up the View class.
_addAttrscfgs
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).
cfgs
Object
An object with attribute name/configuration pairs.
values
Object
An object with attribute name/value pairs, defining the initial values to apply. Values defined in the cfgs argument will be over-written by values in this argument unless defined as read only.
lazy
Boolean
Whether or not to delay the intialization of these attributes until the first call to get/set. Individual attributes can over-ride this behavior by defining a lazyAdd configuration property in their configuration. See addAttr.
_addLazyAttrname
[lazyCfg]
Finishes initializing an attribute which has been lazily added.
_addOutOfOrdername
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: ...
}
});_addScrollbarPaddingAdds 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.
_afterChildSelectedChangeevent
Default attribute change listener for the selected
attribute, responsible for updating the UI, in response to
attribute changes.
event
EventFacade
The event facade for the attribute change.
_afterColumnsChangee
Updates the _columnMap property in response to changes in the columns
attribute.
e
EventFacade
The columnsChange event object
_afterDataChangee
Updates the modelList attributes of the rendered views in response to the
data attribute being assigned a new ModelList.
e
EventFacade
the dataChange event
_afterDisplayColumnsChangee
Updates the _displayColumns property.
e
EventFacade
The columnsChange event
_afterFocusedCellChangee
Sets the tabIndex on the focused cell and, if the DataTable has the focus, sets the focus on it.
_afterMessageColumnsChangee
Updates the colspan of the <td> used to display the messages.
e
EventFacade
The columnsChange event
_afterMessageDataChangee
Relays to _uiSetMessage to hide or show the message node.
e
EventFacade
The dataChange event
_afterRecordTypeChangee
Assigns to the new recordType as the model for the data ModelList
e
EventFacade
recordTypeChange event
_afterScrollableChangee
Reacts to changes in the scrollable attribute by updating the _xScroll
and _yScroll properties and syncing the scrolling structure accordingly.
e
EventFacade
The relevant change event (ignored)
_afterScrollCaptionChangee
Reacts to changes in the caption attribute by adding, removing, or
syncing the caption table when the table is set to scroll.
e
EventFacade
The relevant change event (ignored)
_afterScrollColumnsChangee
Reacts to changes in the columns attribute of vertically scrolling tables
by refreshing the fixed headers, scroll container, and virtual scrollbar
position.
e
EventFacade
The relevant change event (ignored)
_afterScrollDataChangee
Reacts to changes in vertically scrolling table's data ModelList by
synchronizing the fixed column header widths and virtual scrollbar height.
e
EventFacade
The relevant change event (ignored)
_afterScrollHeightChangee
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.
e
EventFacade
The relevant change event (ignored)
_afterScrollWidthChangee
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.
e
EventFacade
The relevant change event (ignored)
_afterShowMessagesChangee
Removes the message node if showMessages is false, or relays to
_uiSetMessage if true.
e
EventFacade
The showMessagesChange event
_afterSortByChangee
Sorts the data ModelList based on the new sortBy configuration.
e
EventFacade
The sortByChange event
_afterSortDataChangee
Applies the sorting logic to the new ModelList if the newVal is a new
ModelList.
e
EventFacade
the dataChange event
_afterSortRecordChangee
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.
e
EventFacade
The Model's change event
_aggregateAttrsallAttrs
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).
allAttrs
Array
An array of ATTRS definitions across classes in the hierarchy (subclass first, Base last)
The aggregate set of ATTRS definitions for the instance
_applyParserconfig
Utility method used to apply the HTML_PARSER configuration for the
instance, to retrieve config data values.
config
Object
User configuration object (will be populated with values from Node)
_attrCfgHashUtility method to define the attribute hash used to filter/whitelist property mixes for this class for iteration performance reasons.
_baseDestroyInternal destroy implementation for BaseCore
_baseInitInternal initialization implementation for BaseCore
_bindAttrUIattrs
Binds after listeners for the list of attributes provided
attrs
Array
_bindDOMSets up DOM listeners, on elements rendered by the widget.
_bindMessageUIBinds the events necessary to keep the message node in sync with the current table and configuration state.
_bindScrollbarBinds virtual scrollbar interaction to the _yScrollNode's scrollTop and
vice versa.
_bindScrollResizeBinds to the window resize event to update the vertical scrolling table
headers and wrapper <div> dimensions.
_bindScrollUIAttaches 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.
_bindSortUISubscribes to state changes that warrant updating the UI, and adds the click handler for triggering the sort operation from the UI.
_bindUISets up DOM and CustomEvent listeners for the widget.
_bindUIChildBinds 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.
_clearScrollLockClears the lock and timer used to manage synchronizing the scroll position between the vertical scroll container and the virtual scrollbar.
_cloneDefaultValuecfg
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.
cfg
Object
_createColumnGroupRenders the table's <colgroup> and populates the _colgroupNode property.
_createRecordClassattrs
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.
_createScrollbarCreates a virtual scrollbar from the _SCROLLBAR_TEMPLATE, assigning it to
the _scrollbarNode property.
The created Node
_createScrollCaptionTableCreates a separate table to contain the caption when the table is configured to scroll vertically or horizontally.
The created Node
_createUIEventtype
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.
type
String
String representing the name of the event
_createXScrollNodePopulates the _xScrollNode property by creating the <div> Node described
by the _X_SCROLLER_TEMPLATE.
The created Node
_createYScrollHeaderPopulates the _yScrollHeader property by creating the <table> Node
described by the _Y_SCROLL_HEADER_TEMPLATE.
The created Node
_createYScrollNodePopulates the _yScrollNode property by creating the <div> Node described
by the _Y_SCROLLER_TEMPLATE.
The created Node
_defAddColumnFne
Default function for the addColumn event.
Inserts the specified column at the provided index.
e
EventFacade
The addColumn event
_defAttrChangeFne
eventFastPath
Default function for attribute change events.
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
_defaultBBReturns 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).
_defaultCBReturns 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)
_defInitFne
Default init event handler
e
EventFacade
Event object, with a cfg property which refers to the configuration object passed to the constructor.
_defModifyColumnFne
Default function for the modifyColumn event.
Mixes the new column properties into the specified column definition.
_defMoveColumnFne
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).
_defRemoveColumnFne
Default function for the removeColumn event.
Splices the specified column from its containing columns array.
e
EventFacade
The removeColumn event
_defRenderFne
parentNode
Default render handler
e
EventFacade
The Event object
parentNode
Node
The parent node to render to, if passed in to the render method
_defRenderViewFne
The default behavior of the renderView event. Calls render() on the
View instance on the event.
e
EventFacade
The renderView event
_defSortFne
Sets the sortBy attribute from the sort event's e.sortBy value.
e
EventFacade
The sort event
_destroyBoxRemoves and destroys the widgets rendered boundingBox, contentBox, and detaches bound UI events.
_destroyHierarchyDestroys the class hierarchy for this instance by invoking the destructor method on the prototype of each class in the hierarchy.
_destroyUIEventsDestructor logic for UI event infrastructure, invoked during Widget destruction.
_disableScrollingRemoves the nodes used to create horizontal and vertical scrolling and rejoins the caption to the main table if needed.
_disableXScrollingRemoves the nodes used to allow horizontal scrolling.
_disableYScrollingRemoves the nodes used to allow vertical scrolling.
_extractDisplayColumnscolumns
Processes the full column array, distilling the columns down to those that correspond to cell data columns.
columns
Object[]
The full set of table columns
_filterAdHocAttrsallAttrs
userVals
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.
The set of adhoc attributes passed in, in the form of an object with attribute name/configuration pairs.
_filterUIEventevt
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.
evt
DOMEventFacade
true if it's OK to fire the custom UI event, false if not.
_fireAttrChangeattrName
subAttrName
currVal
newVal
opts
[cfg]
Utility method to help setup the event payload and fire the attribute change event.
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.
_focusedCellSettercell
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.
cell
Node
DataTable cell to receive the focus
cell or Y.Attribute.INVALID_VALUE
_getAttrname
Provides the common implementation for the public get method, allowing Attribute hosts to over-ride either method.
See get for argument details.
name
String
The name of the attribute.
The value of the attribute.
_getAttrCfgname
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.
name
String
Optional. The attribute name. If not provided, the method will return the configuration for all attributes.
The configuration properties for the given attribute, or all attributes.
_getAttrCfgsReturns an aggregated set of attribute configurations, by traversing the class hierarchy.
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.
_getAttrInitValattr
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.
The initial value of the attribute.
_getAttrsattrs
Implementation behind the public getAttrs method, to get multiple attribute values.
An object with attribute name/value pairs.
_getCellColumnNamecell
Retrieves the column name based from the data attribute on the cell if available. Other wise, extracts the column name from the classname
cell
Node
Cell to get column name from
String Column name of the provided cell
_getClassesReturns the class hierarchy for this object, with BaseCore being the last class in the array.
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.
_getColumnscolumns
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.
_getColumnsetignored
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').
_getFullTypetype
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.
type
String
The short type to prefix
The prefixed type, if a prefix is set, otherwise the type passed in
_getHtmlParserGets the HTML_PARSER definition for this instance, by merging HTML_PARSER definitions across the class hierarchy.
HTML_PARSER definition for this instance
_getInstanceAttrCfgsallCfgs
A helper method used to isolate the attrs config for this instance to pass to addAttrs,
from the static cached ATTRS for the class.
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.
The set of attributes to be added for this instance, suitable
for passing through to addAttrs.
_getNodeToParseDetermines 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.
The node reference to apply HTML_PARSER to.
_getRecordTypeval
Returns the Model class of the instance's data attribute ModelList. If
not set, returns the explicitly configured value.
val
Model
The currently configured value
_getSortByval
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:
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 }]
_getStateValname
[cfg]
Gets the stored value for the attribute, from either the internal state object, or the state proxy if it exits
The stored value of the attribute
_getTHParentthCell
Retrieves the parent cell of the given TH cell. If there is no parent for the provided cell, null is returned.
thCell
Node
Cell to find parent of
Parent of the cell provided or null
_getTypeIf the instance has a prefix attribute and the event type is not prefixed, the instance prefix is applied to the supplied type.
_getUIEventNodeReturns the node on which to bind delegate listeners.
Override of Widget's implementation of _getUIEventNode() to ensure that all event listeners are bound to the Widget's topmost DOM element. This ensures that the firing of each type of Widget UI event (click, mousedown, etc.) is facilitated by a single, top-level, delegated DOM event listener.
_guid_hasPotentialSubscribersfullType
fullType
String
The fully prefixed type name
Whether the event has potential subscribers or not
_initAttrHostattrs
values
lazy
Constructor logic for attributes. Initializes the host state, and sets up the inital attributes passed to the constructor.
attrs
Object
The attributes to add during construction (passed through to addAttrs). These can also be defined on the constructor being augmented with Attribute by defining the ATTRS property on the constructor.
values
Object
The initial attribute values to apply (passed through to addAttrs). These are not merged/cloned. The caller is responsible for isolating user provided values if required.
lazy
Boolean
Whether or not to add attributes lazily (passed through to addAttrs).
_initAttributeInitializes AttributeCore
_initAttrsattrs
values
lazy
Utility method to set up initial attributes defined during construction, either through the constructor.ATTRS property, or explicitly passed in.
attrs
Object
The attributes to add during construction (passed through to addAttrs). These can also be defined on the constructor being augmented with Attribute by defining the ATTRS property on the constructor.
values
Object
The initial attribute values to apply (passed through to addAttrs). These are not merged/cloned. The caller is responsible for isolating user provided values if required.
lazy
Boolean
Whether or not to add attributes lazily (passed through to addAttrs).
_initBaseconfig
Internal construction logic for BaseCore.
config
Object
The constructor configuration object
_initColumnsInitializes 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.
_initCoreEventsSets up the change event subscriptions to maintain internal state.
_initDataDefaults the data attribute to an empty ModelList if not set during
construction. Uses the configured recordType for the ModelList's model
proeprty if set.
_initDataPropertydata
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.
_initHierarchyuserVals
Initializes the class hierarchy for the instance, which includes initializing attributes for each class defined in the class's static ATTRS property and invoking the initializer method on the prototype of each class in the hierarchy.
userVals
Object
Object with configuration property name/value pairs
_initHierarchyDataA 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.
_initMessageNodeCreates the _messageNode property from the configured MESSAGE_TEMPLATE
and inserts it before the <table>'s <tbody> node.
_initMessageStringsAdd the messaging related strings to the strings map.
_initSortFnCreates a _compare function for the data ModelList to allow custom
sorting by multiple fields.
_initSortStringsAdd the sort related strings to the strings map.
_initUIEventtype
Sets up infrastructure required to fire a UI event.
type
String
String representing the name of the event
_isLazyAttrname
Checks whether or not the attribute is one which has been added lazily and still requires initialization.
name
String
The name of the attribute
true if it's a lazily added attribute, false otherwise.
_isUIEventtype
Determines if the specified event is a UI event.
type
String
String representing the name of the event
Event Returns the name of the UI Event, otherwise undefined.
_keyMoveColBottome
Sets the focus on the last cell of the column containing the currently focused cell.
e
EventFacade
Event Facade for the keydown event
_keyMoveColTope
Sets the focus on the top-most cell of the column containing the currently focused cell. It would normally be a header cell.
e
EventFacade
Event Facade for the keydown event
_keyMoveDowne
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.
e
EventFacade
Event Facade for the keydown event
_keyMoveFirstSets the focus on the very first cell in the header of the table.
_keyMoveLefte
Sets the focus on the cell to the left of the currently focused one. Does not wrap, following the WAI-ARIA recommendation.
e
EventFacade
Event Facade for the keydown event
_keyMoveRighte
Sets the focus on the cell to the right of the currently focused one. Does not wrap, following the WAI-ARIA recommendation.
e
EventFacade
Event Facade for the keydown event
_keyMoveRowEnde
Sets the focus on the right-most cell of the row containing the currently focused cell.
e
EventFacade
Event Facade for the keydown event
_keyMoveRowStarte
Sets the focus on the left-most cell of the row containing the currently focused cell.
e
EventFacade
Event Facade for the keydown event
_keyMoveUpe
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.
e
EventFacade
Event Facade for the keydown event
_mapInstanceThe
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.
The
String
boundingBox id
_monitorwhat
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.
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
_normAttrValsvalueHash
Utility method to normalize attribute values. The base implementation simply merges the hash to protect the original.
valueHash
Object
An object with attribute name/value pairs
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.
_onDocFocusevt
DOM focus event handler, used to sync the state of the Widget with the DOM
evt
EventFacade
The event facade for the DOM focus event
_onDocMouseDownevt
"mousedown" event handler for the owner document of the widget's bounding box.
evt
EventFacade
The event facade for the DOM focus event
_onUITriggerSorte
Fires the sort event in response to user clicks on sortable column
headers.
e
DOMEventFacade
The click event
_parseSortableNormalizes the possible input values for the sortable attribute, storing
the results in the _sortable property.
_parseTypeReturns an array with the detach key (if provided), and the prefixed event name from _getType Y.on('detachcategory| menu:click', fn)
_preAddAttrsattrs
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.
_preInitEventCfgconfig
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.
config
Object
The user configuration object
_protectAttrsattrs
Utility method to protect an attribute configuration hash, by merging the entire object and the individual attr config objects.
attrs
Object
A hash of attribute to configuration object pairs.
A protected version of the attrs argument.
_publishfullType
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.
The published event. If called without etOpts or ceOpts, this will
be the default CustomEvent instance, and can be configured independently.
_relayCoreAttrChangee
Relays attribute changes to the instance's view.
e
EventFacade
The change event
_removeLoadingClassNamesRemoves class names representative of the widget's loading state from the boundingBox.
_removeScrollbarRemoves the virtual scrollbar used by scrolling tables.
_removeScrollCaptionTableRemoves the table used to house the caption when the table is scrolling.
_removeXScrollNodeRemoves the <div> wrapper used to contain the data table when the table
is horizontally scrolling.
_removeYScrollContainerRemoves the <div> wrapper used to contain the data table and fixed header
when the table is vertically scrolling.
_removeYScrollHeaderRemoves the <table> used to contain the fixed column headers when the
table is vertically scrolling.
_removeYScrollNodeRemoves the <div> wrapper used to contain the data table when the table
is vertically scrolling.
_renderBoxparentNode
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.
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.
_renderBoxClassNamesApplies standard class names to the boundingBox and contentBox
_renderSortableInitial application of the sortable UI.
_renderUIInitializes the UI state for the Widget's bounding/content boxes.
_setname
val
[opts]
Allows setting of readOnly/writeOnce attributes. See set for argument details.
A reference to the host object.
_setAttrname
value
[opts]
force
Provides the common implementation for the public set and protected _set methods.
See set for argument details.
A reference to the host object.
_setAttrsattrs
[opts]
Implementation behind the public setAttrs method, to set multiple attribute values.
A reference to the host object.
_setAttrValattrName
subAttrName
prevVal
newVal
[opts]
[attrCfg]
Updates the stored value of the attribute in the privately held State object, if validation and setter passes.
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.
true if the new attribute value was stored, false if not.
_setBBnode
Setter for the boundingBox attribute
Node
_setBoxid
node
template
isBounding
Helper method to set the bounding/content box, or create it from the provided template if not found.
The node
_setCBnode
Setter for the contentBox attribute
Node
_setColumnMapcolumns
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.
_setColumnsval
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.
_setColumnsetval
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.
val
Array | Columnset
The columnset value to relay
_setColumnWidthcolIndex
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.
_setDataAccepts 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.
_setRecordsetval
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.
_setRecordTypeval
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.
A Base/Model subclass
_setScrollableval
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.
_setScrollPropertiesAssigns 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.
_setSortByParses the current sortBy attribute into a normalized structure for the
data ModelList's _compare method. Also updates the column
configurations' sortDir properties.
_setStateValname
value
Sets the stored value for the attribute, in either the internal state object, or the state proxy if it exits
name
String
The name of the attribute
value
Any
The value of the attribute
_sortComparatoritem
Replacement comparator for the data ModelList that defers sorting logic
to the _compare method. The deferral is accomplished by returning this.
item
Model
The record being evaluated for sort position
The record
_strSetterstrings
The default setter for the strings attribute. Merges partial sets into the full string set, to allow users to partial sets of strings
strings
Object
The full set of strings to set
_syncAttrUIattrs
Invokes the _uiSet=ATTR NAME> method for the list of attributes provided
attrs
Array
_syncMessageUISynchronizes the message UI with the table state.
_syncScrollCaptionUISplits the caption from the data <table> if the table is configured to
scroll. If not, rejoins the caption to the data <table> if it needs to
be.
_syncScrollColumnWidthsAssigns widths to the fixed header columns to match the columns in the data table.
_syncScrollHeadersCreates matching headers in the fixed header table for vertically scrolling tables and synchronizes the column widths.
_syncScrollPositione
Keeps the virtual scrollbar and the scrolling <div> wrapper around the
data table in vertically scrolling tables in sync.
e
DOMEventFacade
The scroll event
_syncScrollUIWraps the table for X and Y scrolling, if necessary, if the scrollable
attribute is set. Synchronizes dimensions and DOM placement of all
scrolling related nodes.
_syncUIUpdates the widget UI to reflect the attribute state.
_syncUIChildSynchronizes the UI to match the WidgetChild state.
This method is invoked after bindUI is invoked for the Widget class using YUI's aop infrastructure.
_syncXScrollUIxy
Wraps the table in a scrolling <div> of the configured width for "x"
scrolling.
xy
Boolean
True if the table is configured with scrollable ="xy"
_syncYScrollUIxy
Wraps the table in a scrolling <div> of the configured height (accounting
for the caption if there is one) if "y" scrolling is enabled. Otherwise,
unwraps the table if necessary.
xy
Boolean
True if the table is configured with scrollable = "xy"
_uiSetChildSelectedselected
Updates the UI to reflect the selected attribute value.
selected
Number
The selected value to be reflected in the UI.
_uiSetColumnWidthsPopulates the table's <colgroup> with a <col> per item in the columns
attribute without children. It is assumed that these are the columns that
have data cells renderered for them.
_uiSetDimdim
val
_uiSetFocusedval
src
Sets the focused state for the UI
_uiSetHeightval
Sets the height on the widget's bounding box element
_uiSetMessagee
Calls hideMessage or showMessage as appropriate based on the presence of
records in the data ModelList.
This is called when data is reset or records are added or removed. Also,
if the showMessages attribute is updated. In either case, if the
triggering event has a message property on the EventFacade, it will be
passed to showMessage (if appropriate). If no such property is on the
facade, the emptyMessage will be used (see the strings).
e
EventFacade
The columnsChange event
_uiSetScrollableAssigns the appropriate class to the boundingBox to identify the DataTable
as horizontally scrolling, vertically scrolling, or both (adds both classes).
Classes added are "yui3-datatable-scrollable-x" or "...-y"
_uiSetScrollbarHeightUpdates the virtual scrollbar's height to avoid overlapping with the fixed headers.
_uiSetScrollbarPositionscroller
Updates the virtual scrollbar's placement to avoid overlapping the fixed headers or the data table.
scroller
Node
Reference node to position the scrollbar over
_uiSetSortableApplies the appropriate classes to the boundingBox and column headers to
indicate sort state and sortability.
Also currently wraps the header content of sortable columns in a <div>
liner to give a CSS anchor for sort indicators.
_uiSetTabIndexNumber
Set the tabIndex on the widget's rendered UI
Number
Object
_uiSetWidthval
Sets the width on the widget's bounding box element
_uiSetYScrollWidthwidth
Assigns the width of the <div> wrapping the data table in vertically
scrolling tables.
If the table can't compress to the specified width, the container is expanded accordingly.
width
String
The CSS width to attempt to set
_unbindDOM_unbindScrollbarDetaches the scroll event subscriptions used to maintain scroll position
parity between the scrollable <div> wrapper around the data table and the
virtual scrollbar for vertically scrolling tables.
_unbindScrollResizeDetaches the resize event subscription used to maintain column parity for vertically scrolling tables with percentage widths.
_unbindUI_validateSortableval
Allows values true, false, "auto", or arrays of column names through.
val
Any
The input value to set("sortable", VAL)
_validateSortByval
Allows strings, arrays of strings, objects, or arrays of objects.
_validateViewVerifies the input value is a function with a render method on its
prototype. null is also accepted to remove the default View.
addAttrname
config
lazy
Adds an attribute with the provided configuration to the host object.
The config argument object supports the following properties:
A function, which will return the initial value to set on the attribute. This is useful for cases where the attribute configuration is defined statically, but needs to reference the host instance ("this") to obtain an initial value. If both the value and valueFn properties are defined, the value returned by the valueFn has precedence over the value property, unless it returns undefined, in which case the value property is used.
valueFn can also be set to a string, representing the name of the instance method to be used to retrieve the value.
The writeOnce attribute can also be set to the string "initOnly", in which case the attribute can only be set during initialization (when used with Base, this means it can only be set during construction)
The setter function used to massage or normalize the value passed to the set method for the attribute. The value returned by the setter will be the final stored value. Returning Attribute.INVALID_VALUE, from the setter will prevent the value from being stored.
setter can also be set to a string, representing the name of the instance method to be used as the setter function.
The getter function used to massage or normalize the value returned by the get method for the attribute. The value returned by the getter function is the value which will be returned to the user when they invoke get.
getter can also be set to a string, representing the name of the instance method to be used as the getter function.
The validator function invoked prior to setting the stored value. Returning false from the validator function will prevent the value from being stored.
validator can also be set to a string, representing the name of the instance method to be used as the validator function.
The setter, getter and validator are invoked with the value and name passed in as the first and second arguments, and with the context ("this") set to the host object.
Configuration properties outside of the list mentioned above are considered private properties used internally by attribute, and are not intended for public use.
name
String
The name of the attribute.
config
Object
An object with attribute configuration property/value pairs, specifying the configuration for the attribute.
NOTE: The configuration object is modified when adding an attribute, so if you need to protect the original values, you will need to merge the object.
lazy
Boolean
(optional) Whether or not to add this attribute lazily (on the first call to get/set).
A reference to the host object.
addAttrscfgs
values
lazy
Configures a group of attributes, and sets initial values.
NOTE: This method does not isolate the configuration object by merging/cloning. The caller is responsible for merging/cloning the configuration object if required.
cfgs
Object
An object with attribute name/configuration pairs.
values
Object
An object with attribute name/value pairs, defining the initial values to apply. Values defined in the cfgs argument will be over-written by values in this argument unless defined as read only.
lazy
Boolean
Whether or not to delay the intialization of these attributes until the first call to get/set. Individual attributes can over-ride this behavior by defining a lazyAdd configuration property in their configuration. See addAttr.
A reference to the host object.
addColumnconfig
[index]
Adds the column configuration to the DataTable's columns configuration.
If the index parameter is supplied, it is injected at that index. If the
table has nested headers, inject a subcolumn by passing an array of indexes
to identify the new column's final location.
The index parameter is required if adding a nested column.
This method is a convienience method for fetching the DataTable's columns
attribute, updating it, and calling
table.set('columns', _updatedColumnsDefs_)
For example:
// Becomes last column
table.addColumn('name');
// Inserted after the current second column, moving the current third column
// to index 4
table.addColumn({ key: 'price', formatter: currencyFormatter }, 2 );
// Insert a new column in a set of headers three rows deep. The index array
// translates to
// [ 2, -- in the third column's children
// 1, -- in the second child's children
// 3 ] -- as the fourth child column
table.addColumn({ key: 'age', sortable: true }, [ 2, 1, 3 ]);
addRowdata
[config]
[callback]
Adds a new record to the DataTable's data ModelList. Record data can be
an object of field values or an instance of the DataTable's configured
recordType class.
This relays all parameters to the data ModelList's add method.
If a configuration object is passed as a second argument, and that object
has sync: true set, the underlying Model will be save()d.
If the DataTable's autoSync attribute is set to true, the additional
argument is not needed.
If syncing and the last argument is a function, that function will be used
as a callback to the Model's save() method.
data
Object
The data or Model instance for the new record
[config]
Object
optional
Configuration to pass along
[callback]
Function
optional
Callback function for Model's save()
err
Error | Null
If an error occurred or validation
failed, this parameter will contain the error. If the sync operation
succeeded, err will be null.
response
Any
The server's response. This value will
be passed to the parse() method, which is expected to parse it and
return an attribute hash.
addRowsdata
[config]
[callback]
Adds an array of new records to the DataTable's data ModelList. Record data
can be an array of objects containing field values or an array of instance of
the DataTable's configured recordType class.
This relays all parameters to the data ModelList's add method.
Technically, this is an alias to addRow, but please use the appropriately
named method for readability.
If a configuration object is passed as a second argument, and that object
has sync: true set, the underlying Models will be save()d.
If the DataTable's autoSync attribute is set to true, the additional
argument is not needed.
If syncing and the last argument is a function, that function will be used
as a callback to each Model's save() method.
data
Object[]
The data or Model instances to add
[config]
Object
optional
Configuration to pass along
[callback]
Function
optional
Callback function for each Model's save()
err
Error | Null
If an error occurred or validation
failed, this parameter will contain the error. If the sync operation
succeeded, err will be null.
response
Any
The server's response. This value will
be passed to the parse() method, which is expected to parse it and
return an attribute hash.
addTargeto
Registers another EventTarget as a bubble target. Bubble order is determined by the order registered. Multiple targets can be specified.
Events can only bubble if emitFacade is true.
Included in the event-custom-complex submodule.
o
EventTarget
the target to add
aftertype
fn
[context]
[arg*]
Subscribe to a custom event hosted by this object. The supplied callback will execute after any listeners add via the subscribe method, and after the default function, if configured for the event, has executed.
A subscription handle capable of detaching the subscription
ancestordepth
Returns the Widget instance at the specified depth.
depth
Number
Number representing the depth of the ancestor.
Widget instance.
attrAddedname
Checks if the given attribute has been added to the host
name
String
The name of the attribute to check.
true if an attribute with the given name has been added, false if it hasn't. This method will return true for lazily added attributes.
beforeExecutes the callback before a DOM event, custom event or method. If the first argument is a function, it is assumed the target is a method. For DOM and custom events, this is an alias for Y.on.
For DOM and custom events: type, callback, context, 0-n arguments
For methods: callback, object (method host), methodName, context, 0-n arguments
detach handle
bindUIAttaches subscriptions to relay core change events to the view.
blurCauses the Widget to lose focus by setting the "focused" attribute to "false"
bubbleevt
Propagate an event. Requires the event-custom-complex module.
evt
CustomEvent
the custom event to propagate
the aggregated return value from Event.Custom.fire
delegatetype
fn
spec
context
args
Pass through to delegate() called from the contentBox.
type
String
the event type to delegate
fn
Function
the callback function to execute. This function will be provided the event object for the delegated event.
spec
String | Function
a selector that must match the target of the event or a function to test target and its parents for a match
context
Object
optional argument that specifies what 'this' refers to
args
Any
multiple
0..n additional arguments to pass on to the callback function. These arguments will be added after the event object.
the detach handle
destroydestroyAllNodes
Destroy lifecycle method. Fires the destroy event, prior to invoking destructors for the class hierarchy. Overrides Base's implementation, to support arguments to destroy
Subscribers to the destroy event can invoke preventDefault on the event object, to prevent destruction from proceeding.
destroyAllNodes
Boolean
If true, all nodes contained within the Widget are removed and destroyed. Defaults to false due to potentially high run-time cost.
A reference to this object
destructorCleans up external event subscriptions.
destructorTears down the instance.
detachtype
fn
context
Detach one or more listeners the from the specified event
type
String | Object
Either the handle to the subscriber or the type of event. If the type is not specified, it will attempt to remove the listener from all hosted events.
fn
Function
The subscribed function to unsubscribe, if not supplied, all subscribers will be removed.
context
Object
The custom object passed to subscribe. This is optional, but if supplied will be used to disambiguate multiple listeners that are the same (e.g., you subscribe many object using a function that lives on the prototype)
the host
detachAlltype
Removes all listeners from the specified event. If the event type is not specified, all listeners from all hosted custom events will be removed.
type
String
The type, or name of the event
disableSet the Widget's "disabled" attribute to "true".
enableSet the Widget's "disabled" attribute to "false".
firetype
arguments
Fire a custom event by name. The callback functions will be executed from the context specified when the event was created, and with the following parameters.
The first argument is the event type, and any additional arguments are passed to the listeners as parameters. If the first of these is an object literal, and the event is configured to emit an event facade, that object is mixed into the event facade and the facade is provided in place of the original object.
If the custom event object hasn't been created, then the event hasn't been published and it has no subscribers. For performance sake, we immediate exit in this case. This means the event won't bubble, so if the intention is that a bubble target be notified, the event must be published on this object first.
type
String | Object
The type of the event, or an object that contains a 'type' property.
arguments
Object*
an arbitrary set of parameters to pass to the handler. If the first of these is an object literal and the event is configured to emit an event facade, the event facade will replace that parameter after the properties the object literal contains are copied to the event facade.
True if the whole lifecycle of the event went through, false if at any point the event propagation was halted.
focusCauses the Widget to receive the focus by setting the "focused" attribute to "true".
getname
Returns the current value of the attribute. If the attribute has been configured with a 'getter' function, this method will delegate to the 'getter' to obtain the value of the attribute.
name
String
The name of the attribute. If the value of the attribute is an Object,
dot notation can be used to obtain the value of a property of the object (e.g. get("x.y.z"))
The value of the attribute
getAttrsattrs
Gets multiple attribute values.
An object with attribute name/value pairs.
getCellseed
[shift]
Returns the <td> Node from the given row and column index. Alternately,
the seed can be a Node. If so, the nearest ancestor cell is returned.
If the seed is a cell, it is returned. If there is no cell at the given
coordinates, null is returned.
Optionally, include an offset array or string to return a cell near the
cell identified by the seed. The offset can be an array containing the
number of rows to shift followed by the number of columns to shift, or one
of "above", "below", "next", or "previous".
// Previous cell in the previous row
var cell = table.getCell(e.target, [-1, -1]);
// Next cell
var cell = table.getCell(e.target, 'next');
var cell = table.getCell(e.taregt, [0, 1];
This is actually just a pass through to the view instance's method
by the same name.
getClassNameargs
Generate a standard prefixed classname for the Widget, prefixed by the default prefix defined
by the Y.config.classNamePrefix attribute used by ClassNameManager and
Widget.NAME.toLowerCase() (e.g. "yui-widget-xxxxx-yyyyy", based on default values for
the prefix and widget class name).
The instance based version of this method can be used to generate standard prefixed classnames, based on the instances NAME, as opposed to Widget.NAME. This method should be used when you need to use a constant class name across different types instances.
args
String*
multiple
0..n strings which should be concatenated, using the default separator defined by ClassNameManager, to create the class name
getColumnname
Gets the column configuration object for the given key, name, or index. For
nested columns, name can be an array of indexes, each identifying the index
of that column in the respective parent's "children" array.
If you pass a column object, it will be returned.
For columns with keys, you can also fetch the column with
instance.get('columns.foo').
the column configuration object
getEventtype
prefixed
Returns the custom event of the provided type has been created, a falsy value otherwise
the custom event or null
getRecordseed
Returns the Model associated to the record id, clientId, or index (not
row index). If none of those yield a Model from the data ModelList, the
arguments will be passed to the view instance's getRecord method
if it has one.
If no Model can be found, null is returned.
getRowid
Returns the <tr> Node from the given row index, Model, or Model's
clientId. If the rows haven't been rendered yet, or if the row can't be
found by the input, null is returned.
This is actually just a pass through to the view instance's method
by the same name.
getSkinName[skinPrefix]
Returns the name of the skin that's currently applied to the widget.
Searches up the Widget's ancestor axis for, by default, a class yui3-skin-(name), and returns the (name) portion. Otherwise, returns null.
This is only really useful after the widget's DOM structure is in the document, either by render or by progressive enhancement.
[skinPrefix]
String
optional
The prefix which the implementation uses for the skin ("yui3-skin-" is the default).
NOTE: skinPrefix will be used as part of a regular expression:
new RegExp('\b' + skinPrefix + '(\S+)')Although an unlikely use case, literal characters which may result in an invalid regular expression should be escaped.
The name of the skin, or null, if a matching skin class is not found.
getStringkey
Helper method to get a specific string value
key
String
The string
getStringskey
Helper method to get the complete set of strings for the widget
key
String
The strings
getTargetsReturns an array of bubble targets for this object.
EventTarget[]
hideHides the Widget by setting the "visible" attribute to "false".
initcfg
Init lifecycle method, invoked during construction. Sets up attributes and invokes initializers for the class hierarchy.
cfg
Object
Object with configuration property name/value pairs
A reference to this object
initializerconfig
Initializes the columns, recordType and data ModelList.
config
Object
Configuration object passed to constructor
initializerSets up the initial sort state and instance properties. Publishes events and subscribes to attribute change events to maintain internal state.
initializerconfig
Sets up event handlers and AOP advice methods to bind the DataTable's natural behaviors with the scrolling APIs and state.
config
Object
The config object passed to the constructor (ignored)
initializerHooks up to the rendering lifecycle to also render the <colgroup> and
subscribe to columnChange events.
initializerMerges in the message related strings and hooks into the rendering cycle to also render and bind the message node.
initializerPublishes the events used by the mutation methods:
isRootDetermines if the Widget is the root Widget in the object hierarchy.
Boolean indicating if Widget is the root Widget in the object hierarchy.
modifyAttrname
config
Updates the configuration of an attribute which has already been added.
The properties which can be modified through this interface are limited to the following subset of attributes, which can be safely modified after a value has already been set on the attribute:
Note: New attributes cannot be added using this interface. New attributes must be added using addAttr, or an appropriate manner for a class which utilises Attributes (e.g. the ATTRS property in Base).
modifyColumnname
config
Updates an existing column definition. Fires the modifyColumn event.
For example:
// Add a formatter to the existing 'price' column definition
table.modifyColumn('price', { formatter: currencyFormatter });
// Change the label on a header cell in a set of nested headers three rows
// deep. The index array translates to
// [ 2, -- in the third column's children
// 1, -- the second child
// 3 ] -- the fourth child column
table.modifyColumn([2, 1, 3], { label: 'Experience' });
modifyRowid
data
[config]
[callback]
Updates an existing record in the DataTable's data ModelList. The record
can be provided explicitly or targeted by it's id (see ModelList's
getById method), clientId, or index in the ModelList.
After locating the target Model, this relays the all other passed
arguments to the Model's setAttrs method.
If a configuration object is passed as a second argument, and that object
has sync: true set, the underlying Model will be save()d.
If the DataTable's autoSync attribute is set to true, the additional
argument is not needed.
If syncing and the last argument is a function, that function will be used
as a callback to the Model's save() method.
id
Object | String | Number
The Model instance or identifier
data
Object
New data values for the Model
[config]
Object
optional
Configuration to pass along to setAttrs()
[callback]
Function
optional
Callback function for Model's save()
err
Error | Null
If an error occurred or validation
failed, this parameter will contain the error. If the sync operation
succeeded, err will be null.
response
Any
The server's response. This value will
be passed to the parse() method, which is expected to parse it and
return an attribute hash.
moveColumnname
index
Moves an existing column to a new location. Fires the moveColumn event.
The destination index can be a number or array of numbers to place a column header in a nested header row.