datatable/js/head.js

cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith/**
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke SmithView class responsible for rendering the `<thead>` section of a table. Used as
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smiththe default `headerView` for `Y.DataTable.Base` and `Y.DataTable` classes.
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith
53c97f474022b2633bdeccab063f518c4015f27aLuke Smith@module datatable
53c97f474022b2633bdeccab063f518c4015f27aLuke Smith@submodule datatable-head
53c97f474022b2633bdeccab063f518c4015f27aLuke Smith@since 3.5.0
53c97f474022b2633bdeccab063f518c4015f27aLuke Smith**/
53c97f474022b2633bdeccab063f518c4015f27aLuke Smithvar Lang = Y.Lang,
53c97f474022b2633bdeccab063f518c4015f27aLuke Smith    fromTemplate = Lang.sub,
53c97f474022b2633bdeccab063f518c4015f27aLuke Smith    isArray = Lang.isArray,
53c97f474022b2633bdeccab063f518c4015f27aLuke Smith    toArray = Y.Array,
53c97f474022b2633bdeccab063f518c4015f27aLuke Smith
53c97f474022b2633bdeccab063f518c4015f27aLuke Smith    ClassNameManager = Y.ClassNameManager,
53c97f474022b2633bdeccab063f518c4015f27aLuke Smith    _getClassName    = ClassNameManager.getClassName;
53c97f474022b2633bdeccab063f518c4015f27aLuke Smith
53c97f474022b2633bdeccab063f518c4015f27aLuke Smith/**
53c97f474022b2633bdeccab063f518c4015f27aLuke SmithView class responsible for rendering the `<thead>` section of a table. Used as
53c97f474022b2633bdeccab063f518c4015f27aLuke Smiththe default `headerView` for `Y.DataTable.Base` and `Y.DataTable` classes.
53c97f474022b2633bdeccab063f518c4015f27aLuke Smith
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke SmithTranslates the provided array of column configuration objects into a rendered
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith`<thead>` based on the data in those objects.
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke SmithThe structure of the column data is expected to be a single array of objects,
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smithwhere each object corresponds to a `<th>`.  Those objects may contain a
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith`children` property containing a similarly structured array to indicate the
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smithnested cells should be grouped under the parent column's colspan in a separate
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smithrow of header cells. E.g.
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith
e0a1afd287c016be5722249b10ba81684f33886bLuke Smith<pre><code>
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smithnew Y.DataTable.HeaderView({
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith  container: tableNode,
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith  columns: [
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith    { key: 'id' }, // no nesting
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith    { key: 'name', children: [
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith      { key: 'firstName', label: 'First' },
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith      { key: 'lastName',  label: 'Last' } ] }
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith  ]
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith}).render();
e0a1afd287c016be5722249b10ba81684f33886bLuke Smith</code></pre>
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke SmithThis would translate to the following visualization:
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith
e0a1afd287c016be5722249b10ba81684f33886bLuke Smith<pre>
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith---------------------
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith|    |     name     |
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith|    |---------------
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith| id | First | Last |
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith---------------------
e0a1afd287c016be5722249b10ba81684f33886bLuke Smith</pre>
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke SmithSupported properties of the column objects include:
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith
f39a00618075d3d23264518f0a533e38e5b78e53Luke Smith  * `label`     - The HTML content of the header cell.
f39a00618075d3d23264518f0a533e38e5b78e53Luke Smith  * `key`       - If `label` is not specified, the `key` is used for content.
f39a00618075d3d23264518f0a533e38e5b78e53Luke Smith  * `children`  - Array of columns to appear below this column in the next
f39a00618075d3d23264518f0a533e38e5b78e53Luke Smith                  row.
98c5417a3887b19a2b5e7e4eb790663d74c31240Luke Smith  * `headerTemplate` - Overrides the instance's `CELL_TEMPLATE` for cells in this
98c5417a3887b19a2b5e7e4eb790663d74c31240Luke Smith    column only.
f39a00618075d3d23264518f0a533e38e5b78e53Luke Smith  * `abbr`      - The content of the 'abbr' attribute of the `<th>`
f39a00618075d3d23264518f0a533e38e5b78e53Luke Smith  * `className` - Adds this string of CSS classes to the column header
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke SmithThrough the life of instantiation and rendering, the column objects will have
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smiththe following properties added to them:
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith
b2c3f7ee9595487fa2c245134423177b4421db5dLuke Smith  * `id`       - (Defaulted by DataTable) The id to assign the rendered column
f39a00618075d3d23264518f0a533e38e5b78e53Luke Smith  * `_colspan` - To supply the `<th>` attribute
f39a00618075d3d23264518f0a533e38e5b78e53Luke Smith  * `_rowspan` - To supply the `<th>` attribute
cbd1c850256eb95dbf47fbaa52e294346aa05de5Luke Smith  * `_parent`  - (Added by DataTable) If the column is a child of another
cbd1c850256eb95dbf47fbaa52e294346aa05de5Luke Smith    column, this points to its parent column
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke SmithThe column object is also used to provide values for {placeholder} tokens in the
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smithinstance's `CELL_TEMPLATE`, so you can modify the template and include other
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smithcolumn object properties to populate them.
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith@class HeaderView
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith@namespace DataTable
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith@extends View
53c97f474022b2633bdeccab063f518c4015f27aLuke Smith@since 3.5.0
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith**/
a3e011a6940a2707d43148e12f3d3cd6fd388794Luke SmithY.namespace('DataTable').HeaderView = Y.Base.create('tableHeader', Y.View, [], {
0e7d399f99fcb097a927af7e6588f393740585a2Luke Smith    // -- Instance properties -------------------------------------------------
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith    /**
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith    Template used to create the table's header cell markup.  Override this to
8a6a44314c3b8b5125191793d3f3e0baa8d31b7cLuke Smith    customize how header cell markup is created.
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith    @property CELL_TEMPLATE
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith    @type {HTML}
b2c3f7ee9595487fa2c245134423177b4421db5dLuke Smith    @default '<th id="{id}" colspan="{_colspan}" rowspan="{_rowspan}" class="{className}" scope="col" {_id}{abbr}>{content}</th>'
53c97f474022b2633bdeccab063f518c4015f27aLuke Smith    @since 3.5.0
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith    **/
8a6a44314c3b8b5125191793d3f3e0baa8d31b7cLuke Smith    CELL_TEMPLATE:
b2c3f7ee9595487fa2c245134423177b4421db5dLuke Smith        '<th id="{id}" colspan="{_colspan}" rowspan="{_rowspan}" class="{className}" scope="col" {_id}{abbr}>{content}</th>',
a3e011a6940a2707d43148e12f3d3cd6fd388794Luke Smith
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith    /**
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith    The data representation of the header rows to render.  This is assigned by
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith    parsing the `columns` configuration array, and is used by the render()
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith    method.
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith    @property columns
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith    @type {Array[]}
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith    @default (initially unset)
53c97f474022b2633bdeccab063f518c4015f27aLuke Smith    @since 3.5.0
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith    **/
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith    //TODO: should this be protected?
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith    //columns: null,
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith
8a6a44314c3b8b5125191793d3f3e0baa8d31b7cLuke Smith    /**
8a6a44314c3b8b5125191793d3f3e0baa8d31b7cLuke Smith    Template used to create the table's header row markup.  Override this to
8a6a44314c3b8b5125191793d3f3e0baa8d31b7cLuke Smith    customize the row markup.
8a6a44314c3b8b5125191793d3f3e0baa8d31b7cLuke Smith
8a6a44314c3b8b5125191793d3f3e0baa8d31b7cLuke Smith    @property ROW_TEMPLATE
8a6a44314c3b8b5125191793d3f3e0baa8d31b7cLuke Smith    @type {HTML}
8a6a44314c3b8b5125191793d3f3e0baa8d31b7cLuke Smith    @default '<tr>{content}</tr>'
53c97f474022b2633bdeccab063f518c4015f27aLuke Smith    @since 3.5.0
8a6a44314c3b8b5125191793d3f3e0baa8d31b7cLuke Smith    **/
8a6a44314c3b8b5125191793d3f3e0baa8d31b7cLuke Smith    ROW_TEMPLATE:
8a6a44314c3b8b5125191793d3f3e0baa8d31b7cLuke Smith        '<tr>{content}</tr>',
8a6a44314c3b8b5125191793d3f3e0baa8d31b7cLuke Smith
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith    /**
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith    The object that serves as the source of truth for column and row data.
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith    This property is assigned at instantiation from the `source` property of
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith    the configuration object passed to the constructor.
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith    @property source
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith    @type {Object}
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith    @default (initially unset)
53c97f474022b2633bdeccab063f518c4015f27aLuke Smith    @since 3.5.0
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith    **/
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith    //TODO: should this be protected?
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith    //source: null,
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith
0e7d399f99fcb097a927af7e6588f393740585a2Luke Smith    // -- Public methods ------------------------------------------------------
0e7d399f99fcb097a927af7e6588f393740585a2Luke Smith
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith    /**
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith    Builds a CSS class name from the provided tokens.  If the instance is
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith    created with `cssPrefix` or `source` in the configuration, it will use this
201232b90752c6d505c32c25b94ba1c66e41f256Luke Smith    prefix (the `_cssPrefix` of the `source` object) as the base token.  This
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith    allows class instances to generate markup with class names that correspond
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith    to the parent class that is consuming them.
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith    @method getClassName
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith    @param {String} token* Any number of tokens to include in the class name
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith    @return {String} The generated class name
53c97f474022b2633bdeccab063f518c4015f27aLuke Smith    @since 3.5.0
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith    **/
b30dbdf0ef8772c980fc59f2d2015a295c0b4dc3Luke Smith    getClassName: function () {
b30dbdf0ef8772c980fc59f2d2015a295c0b4dc3Luke Smith        var args = toArray(arguments);
b30dbdf0ef8772c980fc59f2d2015a295c0b4dc3Luke Smith        args.unshift(this._cssPrefix);
b30dbdf0ef8772c980fc59f2d2015a295c0b4dc3Luke Smith        args.push(true);
b30dbdf0ef8772c980fc59f2d2015a295c0b4dc3Luke Smith
b30dbdf0ef8772c980fc59f2d2015a295c0b4dc3Luke Smith        return _getClassName.apply(ClassNameManager, args);
b30dbdf0ef8772c980fc59f2d2015a295c0b4dc3Luke Smith    },
b30dbdf0ef8772c980fc59f2d2015a295c0b4dc3Luke Smith
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith    /**
1a40b51b558814291aa784dfd7335004602428ceLuke Smith    Creates the `<thead>` Node content by assembling markup generated by
201232b90752c6d505c32c25b94ba1c66e41f256Luke Smith    populating the `ROW_TEMPLATE` and `CELL_TEMPLATE` templates with content
1a40b51b558814291aa784dfd7335004602428ceLuke Smith    from the `columns` property.
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith    @method render
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith    @return {HeaderView} The instance
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith    @chainable
53c97f474022b2633bdeccab063f518c4015f27aLuke Smith    @since 3.5.0
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith    **/
a3e011a6940a2707d43148e12f3d3cd6fd388794Luke Smith    render: function () {
1a40b51b558814291aa784dfd7335004602428ceLuke Smith        var thead    = this.get('container'),
d15134141197c4fc93eb6094020e03eb72aa8d73Luke Smith            columns  = this.columns,
a3e011a6940a2707d43148e12f3d3cd6fd388794Luke Smith            defaults = {
f39a00618075d3d23264518f0a533e38e5b78e53Luke Smith                _colspan: 1,
d6e29a74bc75003aba4b292a76e9f581648f954aLuke Smith                _rowspan: 1,
d6e29a74bc75003aba4b292a76e9f581648f954aLuke Smith                abbr: ''
1a40b51b558814291aa784dfd7335004602428ceLuke Smith            },
96d244052f752c6f3eb40b7b2a382cc5ee42f19dLuke Smith            i, len, j, jlen, col, html, content, values;
b30dbdf0ef8772c980fc59f2d2015a295c0b4dc3Luke Smith
1a40b51b558814291aa784dfd7335004602428ceLuke Smith        if (thead && columns) {
1a40b51b558814291aa784dfd7335004602428ceLuke Smith            html = '';
a3e011a6940a2707d43148e12f3d3cd6fd388794Luke Smith
79fac3c43e396f54a5fb368ac33ff7c21df23397Luke Smith            if (columns.length) {
79fac3c43e396f54a5fb368ac33ff7c21df23397Luke Smith                for (i = 0, len = columns.length; i < len; ++i) {
1a40b51b558814291aa784dfd7335004602428ceLuke Smith                    content = '';
79fac3c43e396f54a5fb368ac33ff7c21df23397Luke Smith
79fac3c43e396f54a5fb368ac33ff7c21df23397Luke Smith                    for (j = 0, jlen = columns[i].length; j < jlen; ++j) {
79fac3c43e396f54a5fb368ac33ff7c21df23397Luke Smith                        col = columns[i][j];
67f9d521f66b7ed61ab64c26dd3602e6a4dcda57Luke Smith                        values = Y.merge(
67f9d521f66b7ed61ab64c26dd3602e6a4dcda57Luke Smith                            defaults,
67f9d521f66b7ed61ab64c26dd3602e6a4dcda57Luke Smith                            col, {
96d244052f752c6f3eb40b7b2a382cc5ee42f19dLuke Smith                                className: this.getClassName('header'),
67f9d521f66b7ed61ab64c26dd3602e6a4dcda57Luke Smith                                content  : col.label || col.key ||
d6e29a74bc75003aba4b292a76e9f581648f954aLuke Smith                                           ("Column " + (j + 1))
67f9d521f66b7ed61ab64c26dd3602e6a4dcda57Luke Smith                            }
67f9d521f66b7ed61ab64c26dd3602e6a4dcda57Luke Smith                        );
f8dd5569a14fbf6cf9e64bf54ff0df1752dd33b4Luke Smith
8a6a44314c3b8b5125191793d3f3e0baa8d31b7cLuke Smith                        values._id = col._id ?
8a6a44314c3b8b5125191793d3f3e0baa8d31b7cLuke Smith                            ' data-yui3-col-id="' + col._id + '"' : '';
8a6a44314c3b8b5125191793d3f3e0baa8d31b7cLuke Smith
d6e29a74bc75003aba4b292a76e9f581648f954aLuke Smith                        if (col.abbr) {
8a6a44314c3b8b5125191793d3f3e0baa8d31b7cLuke Smith                            values.abbr = ' abbr="' + col.abbr + '"';
d6e29a74bc75003aba4b292a76e9f581648f954aLuke Smith                        }
d6e29a74bc75003aba4b292a76e9f581648f954aLuke Smith
96d244052f752c6f3eb40b7b2a382cc5ee42f19dLuke Smith                        if (col.className) {
99ce7146615ea9b6d1c15c1c6ddb695fd2613d40Luke Smith                            values.className += ' ' + col.className;
96d244052f752c6f3eb40b7b2a382cc5ee42f19dLuke Smith                        }
96d244052f752c6f3eb40b7b2a382cc5ee42f19dLuke Smith
aa183dc1d529080100b0bab8eda249454fe0a9baLuke Smith                        if (col._first) {
aa183dc1d529080100b0bab8eda249454fe0a9baLuke Smith                            values.className += ' ' + this.getClassName('first', 'header');
aa183dc1d529080100b0bab8eda249454fe0a9baLuke Smith                        }
aa183dc1d529080100b0bab8eda249454fe0a9baLuke Smith
f8dd5569a14fbf6cf9e64bf54ff0df1752dd33b4Luke Smith                        if (col._id) {
67f9d521f66b7ed61ab64c26dd3602e6a4dcda57Luke Smith                            values.className +=
67f9d521f66b7ed61ab64c26dd3602e6a4dcda57Luke Smith                                ' ' + this.getClassName('col', col._id);
f8dd5569a14fbf6cf9e64bf54ff0df1752dd33b4Luke Smith                        }
f8dd5569a14fbf6cf9e64bf54ff0df1752dd33b4Luke Smith
98c5417a3887b19a2b5e7e4eb790663d74c31240Luke Smith                        content += fromTemplate(
98c5417a3887b19a2b5e7e4eb790663d74c31240Luke Smith                            col.headerTemplate || this.CELL_TEMPLATE, values);
a3e011a6940a2707d43148e12f3d3cd6fd388794Luke Smith                    }
a3e011a6940a2707d43148e12f3d3cd6fd388794Luke Smith
1a40b51b558814291aa784dfd7335004602428ceLuke Smith                    html += fromTemplate(this.ROW_TEMPLATE, {
1a40b51b558814291aa784dfd7335004602428ceLuke Smith                        content: content
79fac3c43e396f54a5fb368ac33ff7c21df23397Luke Smith                    });
79fac3c43e396f54a5fb368ac33ff7c21df23397Luke Smith                }
a3e011a6940a2707d43148e12f3d3cd6fd388794Luke Smith            }
a3e011a6940a2707d43148e12f3d3cd6fd388794Luke Smith
1a40b51b558814291aa784dfd7335004602428ceLuke Smith            thead.setContent(html);
a3e011a6940a2707d43148e12f3d3cd6fd388794Luke Smith        }
a3e011a6940a2707d43148e12f3d3cd6fd388794Luke Smith
a3e011a6940a2707d43148e12f3d3cd6fd388794Luke Smith        this.bindUI();
a3e011a6940a2707d43148e12f3d3cd6fd388794Luke Smith
a3e011a6940a2707d43148e12f3d3cd6fd388794Luke Smith        return this;
a3e011a6940a2707d43148e12f3d3cd6fd388794Luke Smith    },
a3e011a6940a2707d43148e12f3d3cd6fd388794Luke Smith
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith    // -- Protected and private properties and methods ------------------------
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith    /**
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith    The base token for classes created with the `getClassName` method.
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith    @property _cssPrefix
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith    @type {String}
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith    @default 'yui3-table'
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith    @protected
53c97f474022b2633bdeccab063f518c4015f27aLuke Smith    @since 3.5.0
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith    **/
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith    _cssPrefix: ClassNameManager.getClassName('table'),
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith    /**
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith    Handles changes in the source's columns attribute.  Redraws the headers.
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith
1080d9c735088a474affe30611ae889315840a17Luke Smith    @method _afterColumnsChange
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith    @param {EventFacade} e The `columnsChange` event object
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith    @protected
53c97f474022b2633bdeccab063f518c4015f27aLuke Smith    @since 3.5.0
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith    **/
1080d9c735088a474affe30611ae889315840a17Luke Smith    _afterColumnsChange: function (e) {
1080d9c735088a474affe30611ae889315840a17Luke Smith        this.columns = this._parseColumns(e.newVal);
1080d9c735088a474affe30611ae889315840a17Luke Smith
1080d9c735088a474affe30611ae889315840a17Luke Smith        this.render();
a3e011a6940a2707d43148e12f3d3cd6fd388794Luke Smith    },
a3e011a6940a2707d43148e12f3d3cd6fd388794Luke Smith
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith    /**
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith    Binds event subscriptions from the UI and the source (if assigned).
d15134141197c4fc93eb6094020e03eb72aa8d73Luke Smith
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith    @method bindUI
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith    @protected
53c97f474022b2633bdeccab063f518c4015f27aLuke Smith    @since 3.5.0
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith    **/
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith    bindUI: function () {
1080d9c735088a474affe30611ae889315840a17Luke Smith        if (this.source && !this._eventHandles.columnsChange) {
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith            // TODO: How best to decouple this?
1080d9c735088a474affe30611ae889315840a17Luke Smith            this._eventHandles.columnsChange =
1080d9c735088a474affe30611ae889315840a17Luke Smith                this.source.after('columnsChange',
1080d9c735088a474affe30611ae889315840a17Luke Smith                    Y.bind('_afterColumnsChange', this));
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith        }
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith    },
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith
1080d9c735088a474affe30611ae889315840a17Luke Smith    /**
1080d9c735088a474affe30611ae889315840a17Luke Smith    Destroys the instance.
1080d9c735088a474affe30611ae889315840a17Luke Smith
1080d9c735088a474affe30611ae889315840a17Luke Smith    @method destructor
1080d9c735088a474affe30611ae889315840a17Luke Smith    @protected
53c97f474022b2633bdeccab063f518c4015f27aLuke Smith    @since 3.5.0
1080d9c735088a474affe30611ae889315840a17Luke Smith    **/
1080d9c735088a474affe30611ae889315840a17Luke Smith    destructor: function () {
1080d9c735088a474affe30611ae889315840a17Luke Smith        (new Y.EventHandle(Y.Object.values(this._eventHandles))).detach();
1080d9c735088a474affe30611ae889315840a17Luke Smith    },
1080d9c735088a474affe30611ae889315840a17Luke Smith
1080d9c735088a474affe30611ae889315840a17Luke Smith    /**
1080d9c735088a474affe30611ae889315840a17Luke Smith    Holds the event subscriptions needing to be detached when the instance is
1080d9c735088a474affe30611ae889315840a17Luke Smith    `destroy()`ed.
1080d9c735088a474affe30611ae889315840a17Luke Smith
1080d9c735088a474affe30611ae889315840a17Luke Smith    @property _eventHandles
1080d9c735088a474affe30611ae889315840a17Luke Smith    @type {Object}
1080d9c735088a474affe30611ae889315840a17Luke Smith    @default undefined (initially unset)
1080d9c735088a474affe30611ae889315840a17Luke Smith    @protected
53c97f474022b2633bdeccab063f518c4015f27aLuke Smith    @since 3.5.0
1080d9c735088a474affe30611ae889315840a17Luke Smith    **/
1080d9c735088a474affe30611ae889315840a17Luke Smith    //_eventHandles: null,
1080d9c735088a474affe30611ae889315840a17Luke Smith
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith    /**
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith    Initializes the instance. Reads the following configuration properties:
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith      * `columns` - (REQUIRED) The initial column information
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith      * `cssPrefix` - The base string for classes generated by `getClassName`
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith      * `source` - The object to serve as source of truth for column info
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith    @method initializer
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith    @param {Object} config Configuration data
e0a1afd287c016be5722249b10ba81684f33886bLuke Smith    @protected
53c97f474022b2633bdeccab063f518c4015f27aLuke Smith    @since 3.5.0
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith    **/
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith    initializer: function (config) {
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith        config || (config = {});
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith        var cssPrefix = config.cssPrefix || (config.source || {}).cssPrefix;
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith        this.source  = config.source;
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith        this.columns = this._parseColumns(config.columns);
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith        this._eventHandles = [];
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith        if (cssPrefix) {
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith            this._cssPrefix = cssPrefix;
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith        }
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith    },
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith    /**
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith    Translate the input column format into a structure useful for rendering a
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith    `<thead>`, rows, and cells.  The structure of the input is expected to be a
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith    single array of objects, where each object corresponds to a `<th>`.  Those
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith    objects may contain a `children` property containing a similarly structured
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith    array to indicate the nested cells should be grouped under the parent
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith    column's colspan in a separate row of header cells. E.g.
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith
e0a1afd287c016be5722249b10ba81684f33886bLuke Smith    <pre><code>
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith    [
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith      { key: 'id' }, // no nesting
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith      { key: 'name', children: [
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith        { key: 'firstName', label: 'First' },
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith        { key: 'lastName',  label: 'Last' } ] }
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith    ]
e0a1afd287c016be5722249b10ba81684f33886bLuke Smith    </code></pre>
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith    would indicate two header rows with the first column 'id' being assigned a
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith    `rowspan` of `2`, the 'name' column appearing in the first row with a
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith    `colspan` of `2`, and the 'firstName' and 'lastName' columns appearing in
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith    the second row, below the 'name' column.
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith
e0a1afd287c016be5722249b10ba81684f33886bLuke Smith    <pre>
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith    ---------------------
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith    |    |     name     |
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith    |    |---------------
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith    | id | First | Last |
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith    ---------------------
e0a1afd287c016be5722249b10ba81684f33886bLuke Smith    </pre>
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith    Supported properties of the column objects include:
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith      * `label`    - The HTML content of the header cell.
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith      * `key`      - If `label` is not specified, the `key` is used for content.
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith      * `children` - Array of columns to appear below this column in the next
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith                     row.
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith      * `abbr`     - The content of the 'abbr' attribute of the `<th>`
98c5417a3887b19a2b5e7e4eb790663d74c31240Luke Smith      * `headerTemplate` - Overrides the instance's `CELL_TEMPLATE` for cells
98c5417a3887b19a2b5e7e4eb790663d74c31240Luke Smith        in this column only.
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith    The output structure is basically a simulation of the `<thead>` structure
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith    with arrays for rows and objects for cells.  Column objects have the
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith    following properties added to them:
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith
b2c3f7ee9595487fa2c245134423177b4421db5dLuke Smith      * `id`       - (Defaulted by DataTable) The id to assign the rendered
b2c3f7ee9595487fa2c245134423177b4421db5dLuke Smith                     column
b2c3f7ee9595487fa2c245134423177b4421db5dLuke Smith      * `_colspan` - Per the `<th>` attribute
b2c3f7ee9595487fa2c245134423177b4421db5dLuke Smith      * `_rowspan` - Per the `<th>` attribute
b2c3f7ee9595487fa2c245134423177b4421db5dLuke Smith      * `_parent`  - (Added by DataTable) If the column is a child of another
b2c3f7ee9595487fa2c245134423177b4421db5dLuke Smith        column, this points to its parent column
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith    The column object is also used to provide values for {placeholder}
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith    replacement in the `CELL_TEMPLATE`, so you can modify the template and
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith    include other column object properties to populate them.
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith    @method _parseColumns
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith    @param {Object[]} data Array of column object data
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith    @return {Array[]} An array of arrays corresponding to the header row
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith            structure to render
e0a1afd287c016be5722249b10ba81684f33886bLuke Smith    @protected
53c97f474022b2633bdeccab063f518c4015f27aLuke Smith    @since 3.5.0
cfb2dc43f7aba18c4c6b0db07ca060089bd2e670Luke Smith    **/
d15134141197c4fc93eb6094020e03eb72aa8d73Luke Smith    _parseColumns: function (data) {
d15134141197c4fc93eb6094020e03eb72aa8d73Luke Smith        var columns = [],
deb753fedac28c24a82440a4f7ca53df8a72a124Luke Smith            stack = [],
d15134141197c4fc93eb6094020e03eb72aa8d73Luke Smith            rowSpan = 1,
deb753fedac28c24a82440a4f7ca53df8a72a124Luke Smith            entry, row, col, children, parent, i, len, j;
d15134141197c4fc93eb6094020e03eb72aa8d73Luke Smith
d15134141197c4fc93eb6094020e03eb72aa8d73Luke Smith        if (isArray(data) && data.length) {
d15134141197c4fc93eb6094020e03eb72aa8d73Luke Smith            // First pass, assign colspans and calculate row count for
d15134141197c4fc93eb6094020e03eb72aa8d73Luke Smith            // non-nested headers' rowspan
deb753fedac28c24a82440a4f7ca53df8a72a124Luke Smith            stack.push([data, -1]);
d15134141197c4fc93eb6094020e03eb72aa8d73Luke Smith
deb753fedac28c24a82440a4f7ca53df8a72a124Luke Smith            while (stack.length) {
deb753fedac28c24a82440a4f7ca53df8a72a124Luke Smith                entry = stack[stack.length - 1];
deb753fedac28c24a82440a4f7ca53df8a72a124Luke Smith                row   = entry[0];
deb753fedac28c24a82440a4f7ca53df8a72a124Luke Smith                i     = entry[1] + 1;
d15134141197c4fc93eb6094020e03eb72aa8d73Luke Smith
d15134141197c4fc93eb6094020e03eb72aa8d73Luke Smith                for (len = row.length; i < len; ++i) {
d15134141197c4fc93eb6094020e03eb72aa8d73Luke Smith                    col = row[i];
d15134141197c4fc93eb6094020e03eb72aa8d73Luke Smith                    children = col.children;
d15134141197c4fc93eb6094020e03eb72aa8d73Luke Smith
d15134141197c4fc93eb6094020e03eb72aa8d73Luke Smith                    Y.stamp(col);
d15134141197c4fc93eb6094020e03eb72aa8d73Luke Smith
d15134141197c4fc93eb6094020e03eb72aa8d73Luke Smith                    if (isArray(children) && children.length) {
deb753fedac28c24a82440a4f7ca53df8a72a124Luke Smith                        stack.push([children, -1]);
deb753fedac28c24a82440a4f7ca53df8a72a124Luke Smith                        entry[1] = i;
deb753fedac28c24a82440a4f7ca53df8a72a124Luke Smith
deb753fedac28c24a82440a4f7ca53df8a72a124Luke Smith                        rowSpan = Math.max(rowSpan, stack.length);
d15134141197c4fc93eb6094020e03eb72aa8d73Luke Smith
d15134141197c4fc93eb6094020e03eb72aa8d73Luke Smith                        // break to let the while loop process the children
d15134141197c4fc93eb6094020e03eb72aa8d73Luke Smith                        break;
d15134141197c4fc93eb6094020e03eb72aa8d73Luke Smith                    } else {
f39a00618075d3d23264518f0a533e38e5b78e53Luke Smith                        col._colspan = 1;
d15134141197c4fc93eb6094020e03eb72aa8d73Luke Smith                    }
d15134141197c4fc93eb6094020e03eb72aa8d73Luke Smith                }
d15134141197c4fc93eb6094020e03eb72aa8d73Luke Smith
d15134141197c4fc93eb6094020e03eb72aa8d73Luke Smith                if (i >= len) {
d15134141197c4fc93eb6094020e03eb72aa8d73Luke Smith                    // All columns in this row are processed
deb753fedac28c24a82440a4f7ca53df8a72a124Luke Smith                    if (stack.length > 1) {
deb753fedac28c24a82440a4f7ca53df8a72a124Luke Smith                        entry  = stack[stack.length - 2];
deb753fedac28c24a82440a4f7ca53df8a72a124Luke Smith                        parent = entry[0][entry[1]];
deb753fedac28c24a82440a4f7ca53df8a72a124Luke Smith
f39a00618075d3d23264518f0a533e38e5b78e53Luke Smith                        parent._colspan = 0;
d15134141197c4fc93eb6094020e03eb72aa8d73Luke Smith
d15134141197c4fc93eb6094020e03eb72aa8d73Luke Smith                        for (i = 0, len = row.length; i < len; ++i) {
d15134141197c4fc93eb6094020e03eb72aa8d73Luke Smith                            // Can't use .length because in 3+ rows, colspan
d15134141197c4fc93eb6094020e03eb72aa8d73Luke Smith                            // needs to aggregate the colspans of children
f39a00618075d3d23264518f0a533e38e5b78e53Luke Smith                            parent._colspan += row[i]._colspan;
d15134141197c4fc93eb6094020e03eb72aa8d73Luke Smith                        }
d15134141197c4fc93eb6094020e03eb72aa8d73Luke Smith                    }
deb753fedac28c24a82440a4f7ca53df8a72a124Luke Smith                    stack.pop();
d15134141197c4fc93eb6094020e03eb72aa8d73Luke Smith                }
d15134141197c4fc93eb6094020e03eb72aa8d73Luke Smith            }
d15134141197c4fc93eb6094020e03eb72aa8d73Luke Smith
d15134141197c4fc93eb6094020e03eb72aa8d73Luke Smith            // Second pass, build row arrays and assign rowspan
d15134141197c4fc93eb6094020e03eb72aa8d73Luke Smith            for (i = 0; i < rowSpan; ++i) {
d15134141197c4fc93eb6094020e03eb72aa8d73Luke Smith                columns.push([]);
d15134141197c4fc93eb6094020e03eb72aa8d73Luke Smith            }
d15134141197c4fc93eb6094020e03eb72aa8d73Luke Smith
deb753fedac28c24a82440a4f7ca53df8a72a124Luke Smith            stack.push([data, -1]);
d15134141197c4fc93eb6094020e03eb72aa8d73Luke Smith
deb753fedac28c24a82440a4f7ca53df8a72a124Luke Smith            while (stack.length) {
deb753fedac28c24a82440a4f7ca53df8a72a124Luke Smith                entry = stack[stack.length - 1];
deb753fedac28c24a82440a4f7ca53df8a72a124Luke Smith                row   = entry[0];
deb753fedac28c24a82440a4f7ca53df8a72a124Luke Smith                i     = entry[1] + 1;
d15134141197c4fc93eb6094020e03eb72aa8d73Luke Smith
d15134141197c4fc93eb6094020e03eb72aa8d73Luke Smith                for (len = row.length; i < len; ++i) {
d15134141197c4fc93eb6094020e03eb72aa8d73Luke Smith                    col = row[i];
d15134141197c4fc93eb6094020e03eb72aa8d73Luke Smith                    children = col.children;
d15134141197c4fc93eb6094020e03eb72aa8d73Luke Smith
deb753fedac28c24a82440a4f7ca53df8a72a124Luke Smith                    columns[stack.length - 1].push(col);
d15134141197c4fc93eb6094020e03eb72aa8d73Luke Smith
deb753fedac28c24a82440a4f7ca53df8a72a124Luke Smith                    entry[1] = i;
d15134141197c4fc93eb6094020e03eb72aa8d73Luke Smith
67f9d521f66b7ed61ab64c26dd3602e6a4dcda57Luke Smith                    // collect the IDs of parent cols
b2c3f7ee9595487fa2c245134423177b4421db5dLuke Smith                    col._headers = [col.id];
67f9d521f66b7ed61ab64c26dd3602e6a4dcda57Luke Smith
67f9d521f66b7ed61ab64c26dd3602e6a4dcda57Luke Smith                    for (j = stack.length - 2; j >= 0; --j) {
67f9d521f66b7ed61ab64c26dd3602e6a4dcda57Luke Smith                        parent = stack[j][0][stack[j][1]];
67f9d521f66b7ed61ab64c26dd3602e6a4dcda57Luke Smith
b2c3f7ee9595487fa2c245134423177b4421db5dLuke Smith                        col._headers.unshift(parent.id);
67f9d521f66b7ed61ab64c26dd3602e6a4dcda57Luke Smith                    }
67f9d521f66b7ed61ab64c26dd3602e6a4dcda57Luke Smith
d15134141197c4fc93eb6094020e03eb72aa8d73Luke Smith                    if (children && children.length) {
deb753fedac28c24a82440a4f7ca53df8a72a124Luke Smith                        // parent cells must assume rowspan 1 (long story)
d15134141197c4fc93eb6094020e03eb72aa8d73Luke Smith
d15134141197c4fc93eb6094020e03eb72aa8d73Luke Smith                        // break to let the while loop process the children
deb753fedac28c24a82440a4f7ca53df8a72a124Luke Smith                        stack.push([children, -1]);
d15134141197c4fc93eb6094020e03eb72aa8d73Luke Smith                        break;
d15134141197c4fc93eb6094020e03eb72aa8d73Luke Smith                    } else {
f39a00618075d3d23264518f0a533e38e5b78e53Luke Smith                        col._rowspan = rowSpan - stack.length + 1;
d15134141197c4fc93eb6094020e03eb72aa8d73Luke Smith                    }
d15134141197c4fc93eb6094020e03eb72aa8d73Luke Smith                }
d15134141197c4fc93eb6094020e03eb72aa8d73Luke Smith
d15134141197c4fc93eb6094020e03eb72aa8d73Luke Smith                if (i >= len) {
d15134141197c4fc93eb6094020e03eb72aa8d73Luke Smith                    // All columns in this row are processed
deb753fedac28c24a82440a4f7ca53df8a72a124Luke Smith                    stack.pop();
d15134141197c4fc93eb6094020e03eb72aa8d73Luke Smith                }
d15134141197c4fc93eb6094020e03eb72aa8d73Luke Smith            }
d15134141197c4fc93eb6094020e03eb72aa8d73Luke Smith        }
d15134141197c4fc93eb6094020e03eb72aa8d73Luke Smith
aa183dc1d529080100b0bab8eda249454fe0a9baLuke Smith        for (i = 0, len = columns.length; i < len; i += col._rowspan) {
aa183dc1d529080100b0bab8eda249454fe0a9baLuke Smith            col = columns[i][0];
aa183dc1d529080100b0bab8eda249454fe0a9baLuke Smith
aa183dc1d529080100b0bab8eda249454fe0a9baLuke Smith            col._first = true;
aa183dc1d529080100b0bab8eda249454fe0a9baLuke Smith        }
aa183dc1d529080100b0bab8eda249454fe0a9baLuke Smith
d15134141197c4fc93eb6094020e03eb72aa8d73Luke Smith        return columns;
a3e011a6940a2707d43148e12f3d3cd6fd388794Luke Smith    }
a3e011a6940a2707d43148e12f3d3cd6fd388794Luke Smith});