/* * TableSorter 2.0 - Client-side table sorting with ease! * Version 2.0.10 * @requires jQuery v1.2.3 * * Copyright (c) 2007 Christian Bach * Examples and docs at: http://tablesorter.com * Dual licensed under the MIT and GPL licenses: * http://www.opensource.org/licenses/mit-license.php * http://www.gnu.org/licenses/gpl.html * * @description Create a sortable table with multi-column sorting capabilities * * @example $('table').tablesorter(); * @desc Create a simple tablesorter interface. * * @example $('table').tablesorter({ sortList:[[0,0],[1,0]] }); * @desc Create a tablesorter interface and sort on the first and secound column column headers. * * @example $('table').tablesorter({ headers: { 0: { sorter: false}, 1: {sorter: false} } }); * @desc Create a tablesorter interface and disableing the first and second column headers. * * @example $('table').tablesorter({ headers: { 0: {sorter:"digit"}, 1: {sorter:"currency"} } }); * @desc Create a tablesorter interface and set a column parser for the first and second column. * * @param Object settings An object literal containing key/value pairs to provide optional settings. * * @option String cssHeader (optional) A string of the class name to be appended to sortable tr elements in the thead of the table. * Default value: "header" * * @option String cssAsc (optional) A string of the class name to be appended to sortable tr elements in the thead on a ascending sort. * Default value: "headerSortUp" * * @option String cssDesc (optional) A string of the class name to be appended to sortable tr elements in the thead on a descending sort. * Default value: "headerSortDown" * * @option String sortInitialOrder (optional) A string of the inital sorting order can be asc or desc. * Default value: "asc" * * @option String sortMultisortKey (optional) A string of the multi-column sort key. * Default value: "shiftKey" * * @option String textExtraction (optional) A string of the text-extraction method to use. For complex html structures inside td * cell set this option to "complex", on large tables the complex option can be slow. * Default value: "simple" * * @option Object headers (optional) An array containing the forces sorting rules. This option let's you specify a default sorting rule. * Default value: null * * @option Array sortList (optional) An array containing the forces sorting rules. This option let's you specify a default sorting rule. * Default value: null * * @option Array sortForce (optional) An array containing forced sorting rules. This option let's you specify a default sorting rule, * which is prepended to user-selected rules. * Default value: null * * @option Boolean sortLocaleCompare (optional) Boolean flag indicating whatever to use String.localeCampare method or not. * Default set to true. * * @option Array sortAppend (optional) An array containing forced sorting rules. This option let's you specify a default sorting rule, * which is appended to user-selected rules. * Default value: null * * @option Boolean widthFixed (optional) Boolean flag indicating if tablesorter should apply fixed widths to the table columns. * This is useful when using the pager companion plugin. This options requires the dimension jquery plugin. * Default value: false * * @option Boolean cancelSelection (optional) Boolean flag indicating if tablesorter should cancel selection of the table headers text. * Default value: true * * @option Boolean debug (optional) Boolean flag indicating if tablesorter should display debuging information usefull for development. * * @type jQuery * @name tablesorter * @cat Plugins/Tablesorter * @author Christian Bach/christian.bach@polyester.se */ (function($){ $.extend({ tablesorter: new function(){ var parsers = [], widgets = [], tbl; this.defaults = { cssHeader: "header", cssAsc: "headerSortUp", cssDesc: "headerSortDown", cssChildRow: "expand-child", sortInitialOrder: "asc", sortMultiSortKey: "shiftKey", sortForce: null, sortAppend: null, sortLocaleCompare: false, textExtraction: "simple", parsers: {}, widgets: [], widgetZebra: { css: ["even", "odd"] }, headers: {}, widthFixed: false, cancelSelection: true, sortList: [], headerList: [], dateFormat: "us", onRenderHeader: null, selectorHeaders: 'thead th', tableClass : 'tablesorter', debug: false }; /* debuging utils */ function log(s) { if (typeof console !== "undefined" && typeof console.debug !== "undefined") { console.log(s); } else { alert(s); } } function benchmark(s, d) { log(s + "," + (new Date().getTime() - d.getTime()) + "ms"); } this.benchmark = benchmark; function getElementText(config, node) { var text = ""; if (!node) { return ""; } if (!config.supportsTextContent) { config.supportsTextContent = node.textContent || false; } if (config.textExtraction === "simple") { if (config.supportsTextContent) { text = node.textContent; } else { if (node.childNodes[0] && node.childNodes[0].hasChildNodes()) { text = node.childNodes[0].innerHTML; } else { text = node.innerHTML; } } } else { if (typeof(config.textExtraction) === "function") { text = config.textExtraction(node); } else { text = $(node).text(); } } return text; } /* parsers utils */ function getParserById(name) { var i, l = parsers.length; for (i = 0; i < l; i++) { if (parsers[i].id.toLowerCase() === name.toLowerCase()) { return parsers[i]; } } return false; } function getNodeFromRowAndCellIndex(rows, rowIndex, cellIndex) { return rows[rowIndex].cells[cellIndex]; } function trimAndGetNodeText(config, node) { return $.trim(getElementText(config, node)); } function detectParserForColumn(table, rows, rowIndex, cellIndex) { var i, l = parsers.length, node = false, nodeValue = '', keepLooking = true; while (nodeValue === '' && keepLooking) { rowIndex++; if (rows[rowIndex]) { node = getNodeFromRowAndCellIndex(rows, rowIndex, cellIndex); nodeValue = trimAndGetNodeText(table.config, node); if (table.config.debug) { log('Checking if value was empty on row:' + rowIndex); } } else { keepLooking = false; } } for (i = 1; i < l; i++) { if (parsers[i].is(nodeValue, table, node)) { return parsers[i]; } } // 0 is always the generic parser (text) return parsers[0]; } function buildParserCache(table, $headers) { if (table.tBodies.length === 0) { return; } // In the case of empty tables var rows = table.tBodies[0].rows, list, cells, l, i, p, parsersDebug = ""; if (rows[0]) { list = []; cells = rows[0].cells; l = cells.length; for (i = 0; i < l; i++) { p = false; if ($.metadata && ($($headers[i]).metadata() && $($headers[i]).metadata().sorter)) { p = getParserById($($headers[i]).metadata().sorter); } else if ((table.config.headers[i] && table.config.headers[i].sorter)) { p = getParserById(table.config.headers[i].sorter); } if (!p) { p = detectParserForColumn(table, rows, -1, i); } if (table.config.debug) { parsersDebug += "column:" + i + " parser:" + p.id + "\n"; } list.push(p); } } if (table.config.debug) { log(parsersDebug); } return list; } /* utils */ function buildCache(table) { var totalRows = (table.tBodies[0] && table.tBodies[0].rows.length) || 0, totalCells = (table.tBodies[0].rows[0] && table.tBodies[0].rows[0].cells.length) || 0, parsers = table.config.parsers, cache = { row: [], normalized: [] }, i, j, c, cols, cacheTime; if (table.config.debug) { cacheTime = new Date(); } for (i = 0; i < totalRows; ++i) { /** Add the table data to main data array */ c = $(table.tBodies[0].rows[i]); cols = []; // if this is a child row, add it to the last row's children and // continue to the next row if (c.hasClass(table.config.cssChildRow)) { cache.row[cache.row.length - 1] = cache.row[cache.row.length - 1].add(c); // go to the next for loop continue; } cache.row.push(c); for (j = 0; j < totalCells; ++j) { cols.push(parsers[j].format(getElementText(table.config, c[0].cells[j]), table, c[0].cells[j])); } cols.push(cache.normalized.length); // add position for rowCache cache.normalized.push(cols); cols = null; } if (table.config.debug) { benchmark("Building cache for " + totalRows + " rows:", cacheTime); } return cache; } function getWidgetById(name) { var i, l = widgets.length; for (i = 0; i < l; i++) { if (widgets[i].id.toLowerCase() === name.toLowerCase()) { return widgets[i]; } } } function applyWidget(table) { var c = table.config.widgets, i, l = c.length; for (i = 0; i < l; i++) { getWidgetById(c[i]).format(table); } } function appendToTable(table, cache) { var c = cache, r = c.row, n = c.normalized, totalRows = n.length, checkCell = (n[0].length - 1), tableBody = $(table.tBodies[0]), rows = [], i, j, l, pos, appendTime; if (table.config.debug) { appendTime = new Date(); } for (i = 0; i < totalRows; i++) { pos = n[i][checkCell]; rows.push(r[pos]); if (!table.config.appender) { l = r[pos].length; for (j = 0; j < l; j++) { tableBody[0].appendChild(r[pos][j]); } } } if (table.config.appender) { table.config.appender(table, rows); } rows = null; if (table.config.debug) { benchmark("Rebuilt table:", appendTime); } // apply table widgets applyWidget(table); // trigger sortend setTimeout(function () { $(table).trigger("sortEnd", table); }, 0); } // from: // http://www.javascripttoolbox.com/lib/table/examples.php // http://www.javascripttoolbox.com/temp/table_cellindex.html function computeTableHeaderCellIndexes(t) { var matrix = [], lookup = {}, thead = t.getElementsByTagName('THEAD')[0], trs = thead.getElementsByTagName('TR'), i, j, k, l, c, cells, rowIndex, cellId, rowSpan, colSpan, firstAvailCol, matrixrow; for (i = 0; i < trs.length; i++) { cells = trs[i].cells; for (j = 0; j < cells.length; j++) { c = cells[j]; rowIndex = c.parentNode.rowIndex; cellId = rowIndex + "-" + c.cellIndex; rowSpan = c.rowSpan || 1; colSpan = c.colSpan || 1; if (typeof(matrix[rowIndex]) === "undefined") { matrix[rowIndex] = []; } // Find first available column in the first row for (k = 0; k < matrix[rowIndex].length + 1; k++) { if (typeof(matrix[rowIndex][k]) === "undefined") { firstAvailCol = k; break; } } lookup[cellId] = firstAvailCol; for (k = rowIndex; k < rowIndex + rowSpan; k++) { if (typeof(matrix[k]) === "undefined") { matrix[k] = []; } matrixrow = matrix[k]; for (l = firstAvailCol; l < firstAvailCol + colSpan; l++) { matrixrow[l] = "x"; } } } } return lookup; } function formatSortingOrder(v) { if (typeof(v) !== "number") { // look for "d" instead of "desc" return (v.toLowerCase().charAt(0) === "d") ? 1 : 0; } else { return (v === 1) ? 1 : 0; } } function checkHeaderMetadata(cell) { return (($.metadata) && ($(cell).metadata().sorter === false)); } function checkHeaderOptions(table, i) { return ((table.config.headers[i]) && (table.config.headers[i].sorter === false)); } function checkHeaderLocked(table, i) { if ((table.config.headers[i]) && (table.config.headers[i].lockedOrder !== null)) { return table.config.headers[i].lockedOrder; } return false; } function checkHeaderOrder(table, i) { if ((table.config.headers[i]) && (table.config.headers[i].sortInitialOrder)) { return table.config.headers[i].sortInitialOrder; } return table.config.sortInitialOrder; } function buildHeaders(table) { var meta = ($.metadata) ? true : false, header_index = computeTableHeaderCellIndexes(table), $th, lock, time, $tableHeaders; if (table.config.debug) { time = new Date(); } $tableHeaders = $(table.config.selectorHeaders, table) .wrapInner("") .each(function (index) { this.column = header_index[this.parentNode.rowIndex + "-" + this.cellIndex]; // this.column = index; this.order = formatSortingOrder( checkHeaderOrder(table, index) ); this.count = this.order; if (checkHeaderMetadata(this) || checkHeaderOptions(table, index)) { this.sortDisabled = true; } this.lockedOrder = false; lock = checkHeaderLocked(table, index); if (typeof(lock) !== 'undefined' && lock !== false) { this.order = this.lockedOrder = formatSortingOrder(lock); } if (!this.sortDisabled) { $th = $(this).addClass(table.config.cssHeader); if (table.config.onRenderHeader) { table.config.onRenderHeader.apply($th, [index]); } } // add cell to headerList table.config.headerList[index] = this; }); if (table.config.debug) { benchmark("Built headers:", time); log($tableHeaders); } return $tableHeaders; } function checkCellColSpan(table, rows, row) { var i, cell, arr = [], r = table.tHead.rows, c = r[row].cells; for (i = 0; i < c.length; i++) { cell = c[i]; if (cell.colSpan > 1) { arr = arr.concat(checkCellColSpan(table, rows, row++)); // what is headerArr? } else { if (table.tHead.length === 1 || (cell.rowSpan > 1 || !r[row + 1])) { arr.push(cell); } } } return arr; } function isValueInArray(v, a) { var i, l = a.length; for (i = 0; i < l; i++) { if (a[i][0] === v) { return true; } } return false; } function setHeadersCss(table, $headers, list, css) { // remove all header information $headers.removeClass(css[0]).removeClass(css[1]); var h = [], i, l; $headers.each(function (offset) { if (!this.sortDisabled) { h[this.column] = $(this); } }); l = list.length; for (i = 0; i < l; i++) { h[list[i][0]].addClass(css[list[i][1]]); } } function fixColumnWidth(table, $headers) { var c = table.config, colgroup; if (c.widthFixed) { colgroup = $('