annotate DataTables-1.9.4/media/src/DataTables.js @ 0:ac5f9272033b draft

first upload
author saskia-hiltemann
date Tue, 01 Jul 2014 11:42:23 -0400
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
1 /**
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
2 * @summary DataTables
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
3 * @description Paginate, search and sort HTML tables
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
4 * @version 1.9.4
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
5 * @file jquery.dataTables.js
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
6 * @author Allan Jardine (www.sprymedia.co.uk)
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
7 * @contact www.sprymedia.co.uk/contact
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
8 *
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
9 * @copyright Copyright 2008-2012 Allan Jardine, all rights reserved.
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
10 *
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
11 * This source file is free software, under either the GPL v2 license or a
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
12 * BSD style license, available at:
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
13 * http://datatables.net/license_gpl2
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
14 * http://datatables.net/license_bsd
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
15 *
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
16 * This source file is distributed in the hope that it will be useful, but
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
17 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
18 * or FITNESS FOR A PARTICULAR PURPOSE. See the license files for details.
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
19 *
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
20 * For details please refer to: http://www.datatables.net
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
21 */
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
22
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
23 /*jslint evil: true, undef: true, browser: true */
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
24 /*globals $, jQuery,define,_fnExternApiFunc,_fnInitialise,_fnInitComplete,_fnLanguageCompat,_fnAddColumn,_fnColumnOptions,_fnAddData,_fnCreateTr,_fnGatherData,_fnBuildHead,_fnDrawHead,_fnDraw,_fnReDraw,_fnAjaxUpdate,_fnAjaxParameters,_fnAjaxUpdateDraw,_fnServerParams,_fnAddOptionsHtml,_fnFeatureHtmlTable,_fnScrollDraw,_fnAdjustColumnSizing,_fnFeatureHtmlFilter,_fnFilterComplete,_fnFilterCustom,_fnFilterColumn,_fnFilter,_fnBuildSearchArray,_fnBuildSearchRow,_fnFilterCreateSearch,_fnDataToSearch,_fnSort,_fnSortAttachListener,_fnSortingClasses,_fnFeatureHtmlPaginate,_fnPageChange,_fnFeatureHtmlInfo,_fnUpdateInfo,_fnFeatureHtmlLength,_fnFeatureHtmlProcessing,_fnProcessingDisplay,_fnVisibleToColumnIndex,_fnColumnIndexToVisible,_fnNodeToDataIndex,_fnVisbleColumns,_fnCalculateEnd,_fnConvertToWidth,_fnCalculateColumnWidths,_fnScrollingWidthAdjust,_fnGetWidestNode,_fnGetMaxLenString,_fnStringToCss,_fnDetectType,_fnSettingsFromNode,_fnGetDataMaster,_fnGetTrNodes,_fnGetTdNodes,_fnEscapeRegex,_fnDeleteIndex,_fnReOrderIndex,_fnColumnOrdering,_fnLog,_fnClearTable,_fnSaveState,_fnLoadState,_fnCreateCookie,_fnReadCookie,_fnDetectHeader,_fnGetUniqueThs,_fnScrollBarWidth,_fnApplyToChildren,_fnMap,_fnGetRowData,_fnGetCellData,_fnSetCellData,_fnGetObjectDataFn,_fnSetObjectDataFn,_fnApplyColumnDefs,_fnBindAction,_fnCallbackReg,_fnCallbackFire,_fnJsonString,_fnRender,_fnNodeToColumnIndex,_fnInfoMacros,_fnBrowserDetect,_fnGetColumns*/
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
25
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
26 (/** @lends <global> */function( window, document, undefined ) {
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
27
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
28 (function( factory ) {
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
29 "use strict";
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
30
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
31 // Define as an AMD module if possible
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
32 if ( typeof define === 'function' && define.amd )
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
33 {
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
34 define( ['jquery'], factory );
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
35 }
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
36 /* Define using browser globals otherwise
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
37 * Prevent multiple instantiations if the script is loaded twice
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
38 */
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
39 else if ( jQuery && !jQuery.fn.dataTable )
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
40 {
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
41 factory( jQuery );
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
42 }
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
43 }
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
44 (/** @lends <global> */function( $ ) {
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
45 "use strict";
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
46 /**
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
47 * DataTables is a plug-in for the jQuery Javascript library. It is a
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
48 * highly flexible tool, based upon the foundations of progressive
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
49 * enhancement, which will add advanced interaction controls to any
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
50 * HTML table. For a full list of features please refer to
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
51 * <a href="http://datatables.net">DataTables.net</a>.
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
52 *
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
53 * Note that the <i>DataTable</i> object is not a global variable but is
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
54 * aliased to <i>jQuery.fn.DataTable</i> and <i>jQuery.fn.dataTable</i> through which
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
55 * it may be accessed.
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
56 *
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
57 * @class
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
58 * @param {object} [oInit={}] Configuration object for DataTables. Options
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
59 * are defined by {@link DataTable.defaults}
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
60 * @requires jQuery 1.3+
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
61 *
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
62 * @example
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
63 * // Basic initialisation
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
64 * $(document).ready( function {
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
65 * $('#example').dataTable();
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
66 * } );
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
67 *
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
68 * @example
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
69 * // Initialisation with configuration options - in this case, disable
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
70 * // pagination and sorting.
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
71 * $(document).ready( function {
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
72 * $('#example').dataTable( {
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
73 * "bPaginate": false,
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
74 * "bSort": false
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
75 * } );
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
76 * } );
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
77 */
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
78 var DataTable = function( oInit )
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
79 {
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
80 require('core.columns.js');
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
81 require('core.data.js');
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
82 require('core.draw.js');
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
83 require('core.ajax.js');
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
84 require('core.filter.js');
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
85 require('core.info.js');
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
86 require('core.init.js');
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
87 require('core.length.js');
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
88 require('core.page.js');
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
89 require('core.processing.js');
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
90 require('core.scrolling.js');
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
91 require('core.sizing.js');
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
92 require('core.sort.js');
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
93 require('core.state.js');
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
94 require('core.support.js');
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
95
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
96 require('api.methods.js');
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
97 require('api.internal.js');
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
98
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
99 var _that = this;
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
100 this.each(function() {
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
101 require('core.constructor.js');
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
102 } );
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
103 _that = null;
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
104 return this;
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
105 };
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
106
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
107 require('api.static.js');
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
108
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
109 /**
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
110 * Version string for plug-ins to check compatibility. Allowed format is
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
111 * a.b.c.d.e where: a:int, b:int, c:int, d:string(dev|beta), e:int. d and
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
112 * e are optional
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
113 * @member
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
114 * @type string
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
115 * @default Version number
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
116 */
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
117 DataTable.version = "1.9.4";
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
118
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
119 /**
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
120 * Private data store, containing all of the settings objects that are created for the
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
121 * tables on a given page.
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
122 *
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
123 * Note that the <i>DataTable.settings</i> object is aliased to <i>jQuery.fn.dataTableExt</i>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
124 * through which it may be accessed and manipulated, or <i>jQuery.fn.dataTable.settings</i>.
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
125 * @member
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
126 * @type array
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
127 * @default []
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
128 * @private
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
129 */
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
130 DataTable.settings = [];
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
131
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
132 /**
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
133 * Object models container, for the various models that DataTables has available
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
134 * to it. These models define the objects that are used to hold the active state
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
135 * and configuration of the table.
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
136 * @namespace
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
137 */
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
138 DataTable.models = {};
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
139 require('model.ext.js');
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
140 require('model.search.js');
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
141 require('model.row.js');
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
142 require('model.column.js');
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
143 require('model.defaults.js');
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
144 require('model.defaults.columns.js');
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
145 require('model.settings.js');
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
146
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
147 /**
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
148 * Extension object for DataTables that is used to provide all extension options.
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
149 *
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
150 * Note that the <i>DataTable.ext</i> object is available through
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
151 * <i>jQuery.fn.dataTable.ext</i> where it may be accessed and manipulated. It is
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
152 * also aliased to <i>jQuery.fn.dataTableExt</i> for historic reasons.
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
153 * @namespace
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
154 * @extends DataTable.models.ext
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
155 */
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
156 DataTable.ext = $.extend( true, {}, DataTable.models.ext );
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
157 require('ext.classes.js');
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
158 require('ext.paging.js');
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
159 require('ext.sorting.js');
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
160 require('ext.types.js');
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
161
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
162 // jQuery aliases
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
163 $.fn.DataTable = DataTable;
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
164 $.fn.dataTable = DataTable;
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
165 $.fn.dataTableSettings = DataTable.settings;
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
166 $.fn.dataTableExt = DataTable.ext;
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
167
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
168
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
169 // Information about events fired by DataTables - for documentation.
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
170 /**
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
171 * Draw event, fired whenever the table is redrawn on the page, at the same point as
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
172 * fnDrawCallback. This may be useful for binding events or performing calculations when
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
173 * the table is altered at all.
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
174 * @name DataTable#draw
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
175 * @event
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
176 * @param {event} e jQuery event object
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
177 * @param {object} o DataTables settings object {@link DataTable.models.oSettings}
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
178 */
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
179
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
180 /**
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
181 * Filter event, fired when the filtering applied to the table (using the build in global
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
182 * global filter, or column filters) is altered.
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
183 * @name DataTable#filter
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
184 * @event
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
185 * @param {event} e jQuery event object
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
186 * @param {object} o DataTables settings object {@link DataTable.models.oSettings}
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
187 */
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
188
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
189 /**
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
190 * Page change event, fired when the paging of the table is altered.
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
191 * @name DataTable#page
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
192 * @event
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
193 * @param {event} e jQuery event object
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
194 * @param {object} o DataTables settings object {@link DataTable.models.oSettings}
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
195 */
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
196
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
197 /**
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
198 * Sort event, fired when the sorting applied to the table is altered.
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
199 * @name DataTable#sort
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
200 * @event
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
201 * @param {event} e jQuery event object
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
202 * @param {object} o DataTables settings object {@link DataTable.models.oSettings}
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
203 */
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
204
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
205 /**
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
206 * DataTables initialisation complete event, fired when the table is fully drawn,
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
207 * including Ajax data loaded, if Ajax data is required.
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
208 * @name DataTable#init
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
209 * @event
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
210 * @param {event} e jQuery event object
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
211 * @param {object} oSettings DataTables settings object
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
212 * @param {object} json The JSON object request from the server - only
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
213 * present if client-side Ajax sourced data is used</li></ol>
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
214 */
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
215
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
216 /**
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
217 * State save event, fired when the table has changed state a new state save is required.
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
218 * This method allows modification of the state saving object prior to actually doing the
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
219 * save, including addition or other state properties (for plug-ins) or modification
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
220 * of a DataTables core property.
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
221 * @name DataTable#stateSaveParams
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
222 * @event
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
223 * @param {event} e jQuery event object
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
224 * @param {object} oSettings DataTables settings object
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
225 * @param {object} json The state information to be saved
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
226 */
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
227
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
228 /**
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
229 * State load event, fired when the table is loading state from the stored data, but
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
230 * prior to the settings object being modified by the saved state - allowing modification
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
231 * of the saved state is required or loading of state for a plug-in.
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
232 * @name DataTable#stateLoadParams
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
233 * @event
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
234 * @param {event} e jQuery event object
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
235 * @param {object} oSettings DataTables settings object
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
236 * @param {object} json The saved state information
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
237 */
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
238
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
239 /**
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
240 * State loaded event, fired when state has been loaded from stored data and the settings
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
241 * object has been modified by the loaded data.
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
242 * @name DataTable#stateLoaded
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
243 * @event
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
244 * @param {event} e jQuery event object
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
245 * @param {object} oSettings DataTables settings object
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
246 * @param {object} json The saved state information
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
247 */
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
248
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
249 /**
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
250 * Processing event, fired when DataTables is doing some kind of processing (be it,
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
251 * sort, filter or anything else). Can be used to indicate to the end user that
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
252 * there is something happening, or that something has finished.
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
253 * @name DataTable#processing
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
254 * @event
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
255 * @param {event} e jQuery event object
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
256 * @param {object} oSettings DataTables settings object
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
257 * @param {boolean} bShow Flag for if DataTables is doing processing or not
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
258 */
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
259
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
260 /**
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
261 * Ajax (XHR) event, fired whenever an Ajax request is completed from a request to
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
262 * made to the server for new data (note that this trigger is called in fnServerData,
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
263 * if you override fnServerData and which to use this event, you need to trigger it in
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
264 * you success function).
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
265 * @name DataTable#xhr
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
266 * @event
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
267 * @param {event} e jQuery event object
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
268 * @param {object} o DataTables settings object {@link DataTable.models.oSettings}
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
269 * @param {object} json JSON returned from the server
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
270 */
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
271
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
272 /**
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
273 * Destroy event, fired when the DataTable is destroyed by calling fnDestroy or passing
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
274 * the bDestroy:true parameter in the initialisation object. This can be used to remove
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
275 * bound events, added DOM nodes, etc.
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
276 * @name DataTable#destroy
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
277 * @event
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
278 * @param {event} e jQuery event object
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
279 * @param {object} o DataTables settings object {@link DataTable.models.oSettings}
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
280 */
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
281 }));
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
282
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
283 }(window, document));
ac5f9272033b first upload
saskia-hiltemann
parents:
diff changeset
284