forked from volosoft/jtable
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathjquery.jtable.js
5248 lines (4362 loc) · 216 KB
/
jquery.jtable.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
jTable 1.0.19 (edited by Franky Van Liedekerke)
http://www.jtable.org
---------------------------------------------------------------------------
Copyright (C) 2011-2014 by Halil İbrahim Kalkan (http://www.halilibrahimkalkan.com)
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
*/
/************************************************************************
* CORE jTable module *
*************************************************************************/
(function ($) {
let unloadingPage;
$(window).on('beforeunload', function () {
unloadingPage = true;
});
$(window).on('unload', function () {
unloadingPage = false;
});
jTable = function (element, options) {
this.element = $(element);
this.options = $.extend(true, {}, this.options, options);
this._create();
}
jTable.prototype = {
options: {
// Options
tableId: undefined,
actions: {},
fields: {},
animationsEnabled: true,
defaultDateFormat: 'yy-mm-dd',
showCloseButton: false,
loadingAnimationDelay: 500,
saveUserPreferences: true,
jqueryuiTheme: false,
unAuthorizedRequestRedirectUrl: null,
listQueryParams: {},
ajaxSettings: {
type: 'POST',
dataType: 'json'
},
toolbar: {
hoverAnimation: true,
hoverAnimationDuration: 60,
hoverAnimationEasing: undefined,
items: []
},
// Events
closeRequested: function (event, data) { },
formCreated: function (event, data) { },
formSubmitting: function (event, data) { },
formClosed: function (event, data) { },
loadingRecords: function (event, data) { },
recordsLoaded: function (event, data) { },
rowInserted: function (event, data) { },
rowsRemoved: function (event, data) { },
// Localization
messages: {
serverCommunicationError: 'An error occured while communicating to the server.',
loadingMessage: 'Loading records...',
noDataAvailable: 'No data available!',
areYouSure: 'Are you sure?',
save: 'Save',
saving: 'Saving',
cancel: 'Cancel',
error: 'Error',
close: 'Close',
cannotLoadOptionsFor: 'Can not load options for field {0}'
}
},
/************************************************************************
* PRIVATE FIELDS *
*************************************************************************/
_$mainContainer: null, // Reference to the main container of all elements that are created by this plug-in (jQuery object)
_$titleDiv: null, // Reference to the title div (jQuery object)
_$toolbarDiv: null, // Reference to the toolbar div (jQuery object)
_$tableDiv: null, // Reference to the table main div
_$table: null, // Reference to the main <table> (jQuery object)
_$tableBody: null, // Reference to <body> in the table (jQuery object)
_$tableRows: null, // Array of all <tr> in the table (except "no data" row) (jQuery object array)
_$busyDialog: null, // Reference to the div that is used to block UI while busy (jQuery object)
_$errorDialog: null, // Reference to the error dialog div (jQuery object)
_columnList: null, // Name of all data columns in the table (select column and command columns are not included) (string array)
_fieldList: null, // Name of all fields of a record (defined in fields option) (string array)
_keyField: null, // Name of the key field of a record (that is defined as 'key: true' in the fields option) (string)
_firstDataColumnOffset: 0, // Start index of first record field in table columns (some columns can be placed before first data column, such as select checkbox column) (integer)
_lastPostData: null, // Last posted data on load method (object)
_cache: null, // General purpose cache dictionary (object)
_extraFieldTypes:[],
/************************************************************************
* CONSTRUCTOR AND INITIALIZATION METHODS *
*************************************************************************/
/* Contructor.
*************************************************************************/
_create: function () {
// Initialization
this._initializeSettings();
this._createFieldAndColumnList();
// Needs to be before _loadExtraSettings, so _loadExtraSettings can load the cookie
// But needs to come after _createFieldAndColumnList
this._cookieKeyPrefix = this._generateCookieKeyPrefix();
// Load optional extra settings for fields
// This is done before _normalizeFieldsOptions, so that runs all regular code and checks
this._loadExtraSettings();
// Normalize field options
this._normalizeFieldsOptions();
// Extra actions hook before table gets built
this._doExtraActions();
// Creating DOM elements
this._createMainContainer();
this._createTableTitle();
this._createToolBar();
this._createTableDiv();
this._createTable();
this._createBusyDialog();
this._createErrorDialog();
this._addNoDataRow();
},
/* Normalizes some options for all fields (sets default values).
*************************************************************************/
_normalizeFieldsOptions: function () {
let self = this;
$.each(self.options.fields, function (fieldName, props) {
self._normalizeFieldOptions(fieldName, props);
});
},
/* Normalizes some options for a field (sets default values).
*************************************************************************/
_normalizeFieldOptions: function (fieldName, props) {
if (props.listClass == undefined) {
props.listClass = '';
}
if (props.inputClass == undefined) {
props.inputClass = '';
}
if (props.placeholder == undefined) {
props.placeholder = '';
}
if (props.type == undefined) {
props.type = 'text';
}
// Convert dependsOn to array if it's a comma seperated lists
if (props.dependsOn && $.type(props.dependsOn) === 'string') {
let dependsOnArray = props.dependsOn.split(',');
props.dependsOn = [];
for (let i = 0; i < dependsOnArray.length; i++) {
props.dependsOn.push($.trim(dependsOnArray[i]));
}
}
},
/* Intializes some private variables.
************************************************************************/
_initializeSettings: function () {
this._lastPostData = {};
this._$tableRows = [];
this._columnList = [];
this._fieldList = [];
this._cache = [];
this._extraFieldTypes = [];
},
/* Fills _fieldList, _columnList arrays and sets _keyField variable.
*************************************************************************/
_createFieldAndColumnList: function () {
let self = this;
$.each(self.options.fields, function (name, props) {
// Add field to the field list
self._fieldList.push(name);
// Check if this field is the key field
if (props.key == true) {
self._keyField = name;
}
// Add field to column list if it is shown in the table
if (props.list != false && props.type != 'hidden') {
self._columnList.push(name);
}
});
},
/* Creates the main container div.
*************************************************************************/
_createMainContainer: function () {
this._$mainContainer = $('<div />')
.addClass('jtable-main-container')
.appendTo(this.element);
this._jqueryuiThemeAddClass(this._$mainContainer, 'ui-widget');
},
/* Creates title of the table if a title supplied in options.
*************************************************************************/
_createTableTitle: function () {
let self = this;
if (!self.options.title) {
return;
}
let $titleDiv = $('<div />')
.addClass('jtable-title')
.appendTo(self._$mainContainer);
self._jqueryuiThemeAddClass($titleDiv, 'ui-widget-header');
$('<div />')
.addClass('jtable-title-text')
.appendTo($titleDiv)
.append(self.options.title);
if (self.options.showCloseButton) {
let $textSpan = $('<span />')
.html(self.options.messages.close);
$('<button></button>')
.addClass('jtable-command-button jtable-close-button')
.attr('title', self.options.messages.close)
.append($textSpan)
.appendTo($titleDiv)
.on("click", function (e) {
e.preventDefault();
e.stopPropagation();
self._onCloseRequested();
});
}
self._$titleDiv = $titleDiv;
},
/* Creates the table surrounding div
*************************************************************************/
_createTableDiv: function () {
this._$tableDiv = $('<div />')
.addClass('jtable-table-div')
.appendTo(this._$mainContainer);
},
/* Creates the table.
*************************************************************************/
_createTable: function () {
this._$table = $('<table></table>')
.addClass('jtable')
.appendTo(this._$tableDiv);
if (this.options.tableId) {
this._$table.attr('id', this.options.tableId);
} else if (this._$tableDiv.attr('id')) {
this._$table.attr('id', 'jtable-' + this._$mainContainer.attr('id'));
}
this._jqueryuiThemeAddClass(this._$table, 'ui-widget-content');
this._createTableHead();
this._createTableBody();
},
/* Creates header (all column headers) of the table.
*************************************************************************/
_createTableHead: function () {
let $thead = $('<thead></thead>')
.appendTo(this._$table);
this._addRowToTableHead($thead);
},
/* Adds tr element to given thead element
*************************************************************************/
_addRowToTableHead: function ($thead) {
let $tr = $('<tr></tr>')
.appendTo($thead);
this._addColumnsToHeaderRow($tr);
},
/* Adds column header cells to given tr element.
*************************************************************************/
_addColumnsToHeaderRow: function ($tr) {
for (let i = 0; i < this._columnList.length; i++) {
let fieldName = this._columnList[i];
let $headerCell = this._createHeaderCellForField(fieldName, this.options.fields[fieldName]);
$headerCell.appendTo($tr);
}
},
/* Creates a header cell for given field.
* Returns th jQuery object.
*************************************************************************/
_createHeaderCellForField: function (fieldName, field) {
field.width = field.width || '10%'; //default column width: 10%.
let $headerTextSpan = $('<span />')
.addClass('jtable-column-header-text')
.html(field.title);
let $headerContainerDiv = $('<div />')
.addClass('jtable-column-header-container')
.append($headerTextSpan);
let $th = $('<th></th>')
.addClass('jtable-column-header')
.addClass(field.listClass)
.css('width', field.width)
.data('fieldName', fieldName)
.append($headerContainerDiv);
this._jqueryuiThemeAddClass($th, 'ui-state-default');
return $th;
},
/* Creates an empty header cell that can be used as command column headers.
*************************************************************************/
_createEmptyCommandHeader: function (extraclass) {
let $th = $('<th></th>')
.addClass('jtable-command-column-header' + ' ' + extraclass)
.css('width', '1%');
this._jqueryuiThemeAddClass($th, 'ui-state-default');
return $th;
},
/* Creates tbody tag and adds to the table
*************************************************************************/
_createTableBody: function () {
this._$tableBody = $('<tbody></tbody>').appendTo(this._$table);
},
/* Creates a dialov to block UI while jTable is busy
*************************************************************************/
_createBusyDialog: function () {
let self = this;
self._$busyDialog = $('<dialog />')
.addClass('jtable-busy-modal-dialog')
.prependTo(self._$mainContainer)
.on('close', function () {
// the close event is called upon close-call or pressing escape
$(document).off("keydown.jtable_escape");
});
self._$busyMessageDiv = $('<div />').addClass('jtable-busy-message').appendTo(self._$busyDialog);
self._jqueryuiThemeAddClass(self._$busyMessageDiv, 'ui-widget-header');
},
/* Creates and prepares error dialog
*************************************************************************/
_createErrorDialog: function () {
let self = this;
// Create a div for dialog and add to container element
self._$errorDialog = $('<dialog />')
.addClass('jtable-modal-dialog jtable-error-modal-dialog')
.appendTo(self._$mainContainer);
// the close event is called upon close-call or pressing escape
// self._$errorDialog.on('close', function () {
// });
$('<h2 id="errorDialogTitle"></h2>').css({padding: '0px'}).html(self.options.messages.error).appendTo(self._$errorDialog);
$('<div><p><span class="jtable-error-message"></span></p></div>').appendTo(self._$errorDialog);
$('<button class="jtable-dialog-button jtable-dialog-cancelbutton"></button>')
.html('<span>' + self.options.messages.close + '</span>')
.on('click', function () {
self._closeErrorDialog();
})
.appendTo(self._$errorDialog);
},
_closeErrorDialog() {
this._$errorDialog[0].close();
},
/************************************************************************
* PUBLIC METHODS *
*************************************************************************/
/* Loads data using AJAX call, clears table and fills with new data.
*************************************************************************/
load: function (extraPostData, completeCallback) {
let listQueryParams = typeof this.options.listQueryParams === "function"
? this.options.listQueryParams()
: this.options.listQueryParams;
// use spread operator to merge
this._lastPostData = { ...listQueryParams, ...(extraPostData || {}) };
this._reloadTable(completeCallback);
},
/* Refreshes (re-loads) table data with last postData.
*************************************************************************/
reload: function (completeCallback) {
this._reloadTable(completeCallback);
},
/* Gets a jQuery row object according to given record key
*************************************************************************/
getRowByKey: function (key) {
for (let i = 0; i < this._$tableRows.length; i++) {
if (key == this._getKeyValueOfRecord(this._$tableRows[i].data('record'))) {
return this._$tableRows[i];
}
}
return null;
},
/* Completely removes the table from it's container.
*************************************************************************/
destroy: function () {
this.element.empty();
$.Widget.prototype.destroy.call(this);
},
/************************************************************************
* PRIVATE METHODS *
*************************************************************************/
/* Used to change options dynamically after initialization.
*************************************************************************/
_setOption: function (key, value) {
},
/* Used by extensions to load additional settings from cookies or so
*************************************************************************/
_loadExtraSettings: function() {
},
/* Used by extensions to execute additional actions before table build is done
*************************************************************************/
_doExtraActions: function() {
},
/* LOADING RECORDS *****************************************************/
/* Performs an AJAX call to reload data of the table.
*************************************************************************/
_reloadTable: function (completeCallback) {
let self = this;
let completeReload = function(data) {
self._hideBusy();
//Show the error message if server returns error
if (data.Result != 'OK') {
self._showError(data.Message);
return;
}
// Re-generate table rows
self._removeAllRows('reloading');
self._addRecordsToTable(data.Records);
self._onRecordsLoaded(data);
// Call complete callback
if (completeCallback) {
completeCallback();
}
};
self._showBusy(self.options.messages.loadingMessage, self.options.loadingAnimationDelay); //Disable table since it's busy
self._onLoadingRecords();
// listAction may be a function, check if it is
if (typeof self.options.actions.listAction === "function") {
// Execute the function
let funcResult = self.options.actions.listAction(self._lastPostData, self._createJtParamsForLoading());
// Check if result is a jQuery Deferred object
if (self._isDeferredObject(funcResult)) {
funcResult.done(function(data) {
completeReload(data);
}).fail(function() {
self._showError(self.options.messages.serverCommunicationError);
}).always(function() {
self._hideBusy();
});
} else { // assume it's the data we're loading
completeReload(funcResult);
}
} else { // assume listAction as URL string.
// Generate URL (with query string parameters) to load records
/* let loadUrl = self._createRecordLoadUrl(); */
let loadUrl = self.options.actions.listAction;
let extraparams = self._createJtParamsForLoading();
// Load data from server using AJAX
self._ajax({
url: loadUrl,
data: { ...self._lastPostData, ...extraparams},
success: function (data) {
completeReload(data);
},
error: function () {
self._hideBusy();
self._showError(self.options.messages.serverCommunicationError);
}
});
}
},
/* Creates URL to load records.
*************************************************************************/
/*_createRecordLoadUrl: function () {
return this.options.actions.listAction;
},*/
_createJtParamsForLoading: function() {
return {
// Empty as default, extensions can override this method to add additional params to load request
};
},
/* TABLE MANIPULATION METHODS *******************************************/
/* Creates a row from given record
*************************************************************************/
_createRowFromRecord: function (record) {
let $tr = $('<tr></tr>')
.addClass('jtable-data-row')
.attr('data-record-key', this._getKeyValueOfRecord(record))
.data('record', record);
this._addCellsToRowUsingRecord($tr);
return $tr;
},
/* Adds all cells to given row.
*************************************************************************/
_addCellsToRowUsingRecord: function ($row) {
let record = $row.data('record');
for (let i = 0; i < this._columnList.length; i++) {
this._createCellForRecordField(record, this._columnList[i])
.appendTo($row);
}
},
/* Create a cell for given field.
*************************************************************************/
_createCellForRecordField: function (record, fieldName) {
return $('<td></td>')
.addClass(this.options.fields[fieldName].listClass)
.append((this._getDisplayTextForRecordField(record, fieldName)));
},
/* Adds a list of records to the table.
*************************************************************************/
_addRecordsToTable: function (records) {
let self = this;
$.each(records, function (index, record) {
self._addRowToTable(self._createRowFromRecord(record));
});
self._refreshRowStyles();
},
/* Adds a single row to the table.
*************************************************************************/
_addRowToTable: function ($row, options) {
//Set defaults
options = $.extend({
index: this._$tableRows.length,
isNewRow: false,
animationsEnabled: true
}, options);
// Remove 'no data' row if this is first row
if (this._$tableRows.length <= 0) {
this._removeNoDataRow();
}
// Add new row to the table according to it's index
options.index = this._normalizeNumber(options.index, 0, this._$tableRows.length, this._$tableRows.length);
if (options.index == this._$tableRows.length) {
// add as last row
this._$tableBody.append($row);
this._$tableRows.push($row);
} else if (options.index == 0) {
// add as first row
this._$tableBody.prepend($row);
this._$tableRows.unshift($row);
} else {
// insert to specified index
this._$tableRows[options.index - 1].after($row);
this._$tableRows.splice(options.index, 0, $row);
}
this._onRowInserted($row, options.isNewRow);
//Show animation if needed
if (options.isNewRow) {
this._refreshRowStyles();
if (this.options.animationsEnabled && options.animationsEnabled) {
this._showNewRowAnimation($row);
}
}
},
/* Shows created animation for a table row
* TODO: Make this animation cofigurable and changable
*************************************************************************/
_showNewRowAnimation: function ($tableRow) {
let className = 'jtable-row-created';
if (this.options.jqueryuiTheme) {
className = className + ' ui-state-highlight';
}
$tableRow.addClass(className, 'slow', '', function () {
$tableRow.removeClass(className, 5000);
});
},
/* Removes a row or rows (jQuery selection) from table.
*************************************************************************/
_removeRowsFromTable: function ($rows, reason) {
let self = this;
// Check if any row specified
if ($rows.length <= 0) {
return;
}
// remove from DOM
$rows.addClass('jtable-row-removed').remove();
// remove from _$tableRows array
$rows.each(function () {
let index = self._findRowIndex($(this));
if (index >= 0) {
self._$tableRows.splice(index, 1);
}
});
self._onRowsRemoved($rows, reason);
// Add 'no data' row if all rows removed from table
if (self._$tableRows.length == 0) {
self._addNoDataRow();
}
self._refreshRowStyles();
},
/* Finds index of a row in table.
*************************************************************************/
_findRowIndex: function ($row) {
return this._findIndexInArray($row, this._$tableRows, function ($row1, $row2) {
return $row1.data('record') == $row2.data('record');
});
},
/* Removes all rows in the table and adds 'no data' row.
*************************************************************************/
_removeAllRows: function (reason) {
//If no rows does exists, do nothing
if (this._$tableRows.length <= 0) {
return;
}
// Select all rows (to pass it on raising _onRowsRemoved event)
let $rows = this._$tableBody.find('tr.jtable-data-row');
// Remove all rows from DOM and the _$tableRows array
this._$tableBody.empty();
this._$tableRows = [];
this._onRowsRemoved($rows, reason);
// Add 'no data' row since we removed all rows
this._addNoDataRow();
},
/* Adds "no data available" row to the table.
*************************************************************************/
_addNoDataRow: function () {
if (this._$tableBody.find('>tr.jtable-no-data-row').length > 0) {
return;
}
let $tr = $('<tr></tr>')
.addClass('jtable-no-data-row')
.appendTo(this._$tableBody);
let totalColumnCount = this._$table.find('thead th').length;
$('<td></td>')
.attr('colspan', totalColumnCount)
.html(this.options.messages.noDataAvailable)
.appendTo($tr);
},
/* Removes "no data available" row from the table.
*************************************************************************/
_removeNoDataRow: function () {
this._$tableBody.find('.jtable-no-data-row').remove();
},
/* Refreshes styles of all rows in the table
*************************************************************************/
_refreshRowStyles: function () {
for (let i = 0; i < this._$tableRows.length; i++) {
if (i % 2 == 0) {
this._$tableRows[i].addClass('jtable-row-even');
} else {
this._$tableRows[i].removeClass('jtable-row-even');
}
}
},
/* RENDERING FIELD VALUES ***********************************************/
/* Gets text for a field of a record according to it's type.
*************************************************************************/
_getDisplayTextForRecordField: function (record, fieldName) {
let field = this.options.fields[fieldName];
let fieldValue = record[fieldName];
// if this is a custom field, call display function
if (field.display) {
return field.display({ record: record });
}
let extraFieldType = this._findItemByProperty(this._extraFieldTypes, 'type', field.type);
if (extraFieldType && extraFieldType.creator) {
return extraFieldType.creator(record, field);
}
else if (field.type == 'date' || field.type == 'dateJS') {
return this._getDisplayTextForDateRecordField(field, fieldValue);
} else if (field.type == 'checkbox') {
return this._getCheckBoxTextForFieldByValue(fieldName, fieldValue);
} else if (field.options) { // combobox or radio button list since there are options.
let options = this._getOptionsForField(fieldName, {
record: record,
value: fieldValue,
source: 'list',
dependedValues: this._createDependedValuesUsingRecord(record, field.dependsOn)
});
return this._findOptionByValue(options, fieldValue).DisplayText;
} else { // other types
return fieldValue;
}
},
/* Creates and returns an object that's properties are depended values of a record.
*************************************************************************/
_createDependedValuesUsingRecord: function (record, dependsOn) {
if (!dependsOn) {
return {};
}
let dependedValues = {};
for (let i = 0; i < dependsOn.length; i++) {
dependedValues[dependsOn[i]] = record[dependsOn[i]];
}
return dependedValues;
},
/* Finds an option object by given value.
*************************************************************************/
_findOptionByValue: function (options, value) {
return this._findItemByProperty(options, 'Value', value);
},
/* Finds an option object by given value.
*************************************************************************/
_findItemByProperty: function (items, key, value) {
for (let i = 0; i < items.length; i++) {
if (items[i][key] == value) {
return items[i];
}
}
return {}; // no item found
},
/* Gets text for a date field.
*************************************************************************/
_getDisplayTextForDateRecordField: function (field, fieldValue) {
if (!fieldValue) {
return '';
}
if (typeof $.fn.datepicker == 'function') {
let displayFormat = field.displayFormat || this.options.defaultDateFormat;
let date = this._parseDate(fieldValue);
return $.datepicker.formatDate(displayFormat, date);
} else {
return fieldValue;
}
},
/* Gets options for a field according to user preferences.
*************************************************************************/
_getOptionsForField: function (fieldName, funcParams) {
let field = this.options.fields[fieldName];
let optionsSource = field.options;
if (typeof optionsSource === "function") {
// prepare parameter to the function
funcParams = $.extend(true, {
_cacheCleared: false,
dependedValues: {},
clearCache: function () {
this._cacheCleared = true;
}
}, funcParams);
// call function and get actual options source
optionsSource = optionsSource(funcParams);
}
let options;
// Build options according to it's source type
if (typeof optionsSource == 'string') { // It is an Url to download options
let cacheKey = 'options_' + fieldName + '_' + optionsSource; // create a unique cache key
if (funcParams._cacheCleared || (!this._cache[cacheKey])) {
// if user calls clearCache() or options are not found in the cache, download options
this._cache[cacheKey] = this._buildOptionsFromArray(this._downloadOptions(fieldName, optionsSource));
this._sortFieldOptions(this._cache[cacheKey], field.optionsSorting);
} else {
// found on cache..
// if this method (_getOptionsForField) is called to get option for a specific value (on funcParams.source == 'list')
// and this value is not in cached options, we need to re-download options to get the unfound (probably new) option.
if (funcParams.value != undefined) {
let optionForValue = this._findOptionByValue(this._cache[cacheKey], funcParams.value);
if (optionForValue.DisplayText == undefined) { // this value is not in cached options...
this._cache[cacheKey] = this._buildOptionsFromArray(this._downloadOptions(fieldName, optionsSource));
this._sortFieldOptions(this._cache[cacheKey], field.optionsSorting);
}
}
}
options = this._cache[cacheKey];
} else if (Array.isArray(optionsSource)) { // It is an array of options
options = this._buildOptionsFromArray(optionsSource);
this._sortFieldOptions(options, field.optionsSorting);
} else { // It is an object that it's properties are options
options = this._buildOptionsArrayFromObject(optionsSource);
this._sortFieldOptions(options, field.optionsSorting);
}
return options;
},
/* Download options for a field from server.
*************************************************************************/
_downloadOptions: function (fieldName, url) {
let self = this;
let options = [];
self._ajax({
url: url,
async: false,
success: function (data) {
if (data.Result != 'OK') {
self._showError(data.Message);
return;
}
options = data.Options;
},
error: function () {
let errMessage = self._formatString(self.options.messages.cannotLoadOptionsFor, fieldName);
self._showError(errMessage);
}
});
return options;
},
/* Sorts given options according to sorting parameter.
* sorting can be: 'value', 'value-desc', 'text' or 'text-desc'.
*************************************************************************/
_sortFieldOptions: function (options, sorting) {
if ((!options) || (!options.length) || (!sorting)) {
return;
}
// Determine using value or text
let dataSelector;
if (sorting.startsWith('value')) {
dataSelector = function (option) {
return option.Value;
};
} else { // assume as text
dataSelector = function (option) {
return option.DisplayText;
};
}
// simple isNumeric function
let isNumeric = function (value) {
return !isNaN(value) && !isNaN(parseFloat(value));
};
let compareFunc;
if (isNumeric(dataSelector(options[0]))) {
// assume the option values are numeric
compareFunc = function (option1, option2) {
return dataSelector(option1) - dataSelector(option2);
};
} else {
// assume the option values are strings, so do stringcompare
compareFunc = function (option1, option2) {
return dataSelector(option1).localeCompare(dataSelector(option2));
};
}
if (sorting.includes('desc')) {
options.sort(function (a, b) {
return compareFunc(b, a);
});
} else { // assume as asc
options.sort(function (a, b) {
return compareFunc(a, b);
});
}
},
/* Creates an array of options from given object.
*************************************************************************/
_buildOptionsArrayFromObject: function (options) {
let list = [];
$.each(options, function (propName, propValue) {
list.push({
Value: propName,
DisplayText: propValue
});
});
return list;
},
/* Creates array of options from giving options array.
*************************************************************************/
_buildOptionsFromArray: function (optionsArray) {
let list = [];
for (let i = 0; i < optionsArray.length; i++) {
if ($.isPlainObject(optionsArray[i])) {
list.push(optionsArray[i]);