deblan-mirror/TableFilter
1
0
Fork 0
mirror of https://github.com/koalyptus/TableFilter.git synced 2024-05-15 21:06:44 +02:00
Code Issues Releases Wiki Activity

Added comments to StatusBar for auto-generated documentation

Browse source
This commit is contained in:
Max Guglielmi 2016-08-07 00:48:00 +10:00
parent 0b1256d571
commit f43ccbfd50
11 changed files with 188 additions and 77 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
dist/tablefilter/style/colsVisibility.css vendored
View file

@ -1,6 +1,6 @@
/**
* tablefilter v0.2.51 by Max Guglielmi
* build date: 2016-08-06T09:41:00.544Z
* build date: 2016-08-06T14:43:01.297Z
* MIT License
*/
span.colVisSpan{text-align:left;}span.colVisSpan a.colVis{display:inline-block;padding:7px 5px 0;font-size:inherit;font-weight:inherit;vertical-align:top}div.colVisCont{position:relative;background:#fff;-webkit-box-shadow:3px 3px 2px #888;-moz-box-shadow:3px 3px 2px #888;box-shadow:3px 3px 2px #888;position:absolute;display:none;border:1px solid #ccc;height:auto;width:250px;background-color:#fff;margin:35px 0 0 -100px;z-index:10000;padding:10px 10px 10px 10px;text-align:left;font-size:12px;}div.colVisCont:after,div.colVisCont:before{bottom:100%;left:50%;border:solid transparent;content:" ";height:0;width:0;position:absolute;pointer-events:none}div.colVisCont:after{border-color:rgba(255,255,255,0);border-bottom-color:#fff;border-width:10px;margin-left:-10px}div.colVisCont:before{border-color:rgba(255,255,255,0);border-bottom-color:#ccc;border-width:12px;margin-left:-12px}div.colVisCont p{margin:6px auto 6px auto}div.colVisCont a.colVis{display:initial;font-weight:inherit}ul.cols_checklist{padding:0;margin:0;list-style:none;}ul.cols_checklist label{display:block}ul.cols_checklist input{vertical-align:middle;margin:2px 5px 2px 1px}li.cols_checklist_item{padding:4px;margin:0;}li.cols_checklist_item:hover{background-color:#335ea8;color:#fff}.cols_checklist_slc_item{background-color:#335ea8;color:#fff}

2
dist/tablefilter/style/filtersVisibility.css vendored
View file

@ -1,6 +1,6 @@
/**
* tablefilter v0.2.51 by Max Guglielmi
* build date: 2016-08-06T09:41:00.544Z
* build date: 2016-08-06T14:43:01.297Z
* MIT License
*/
span.expClpFlt a.btnExpClpFlt{width:35px;height:35px;display:inline-block;}span.expClpFlt a.btnExpClpFlt:hover{background-color:#f4f4f4}span.expClpFlt img{padding:8px 11px 11px 11px}

2
dist/tablefilter/style/tablefilter.css vendored
View file

@ -1,6 +1,6 @@
/**
* tablefilter v0.2.51 by Max Guglielmi
* build date: 2016-08-06T09:41:00.544Z
* build date: 2016-08-06T14:43:01.297Z
* MIT License
*/
.activeHeader{background-color:#66afe9 !important;color:#fff !important}

2
dist/tablefilter/style/themes/default/default.css vendored
View file

@ -1,6 +1,6 @@
/**
* tablefilter v0.2.51 by Max Guglielmi
* build date: 2016-08-06T09:41:00.544Z
* build date: 2016-08-06T14:43:01.297Z
* MIT License
*/
table.TF{border-left:1px solid #ccc;border-top:none;border-right:none;border-bottom:none;}table.TF th{background:#ebecee url("images/bg_th.jpg") left top repeat-x;border-bottom:1px solid #d0d0d0;border-right:1px solid #d0d0d0;border-left:1px solid #fff;border-top:1px solid #fff;color:#333}table.TF td{border-bottom:1px dotted #999;padding:5px}.fltrow{background-color:#ebecee !important;}.fltrow th,.fltrow td{border-bottom:1px dotted #666 !important;padding:1px 3px 1px 3px !important}.flt,select.flt,select.flt_multi,.flt_s,.single_flt,.div_checklist{border:1px solid #999 !important}input.flt{width:99% !important}.inf{height:$min-height;background:#d7d7d7 url("images/bg_infDiv.jpg") 0 0 repeat-x !important}input.reset{background:transparent url("images/btn_eraser.gif") center center no-repeat !important}.helpBtn:hover{background-color:transparent}.nextPage{background:transparent url("images/btn_next_page.gif") center center no-repeat !important;}.nextPage:hover{background:transparent url("images/btn_over_next_page.gif") center center no-repeat !important}.previousPage{background:transparent url("images/btn_previous_page.gif") center center no-repeat !important;}.previousPage:hover{background:transparent url("images/btn_over_previous_page.gif") center center no-repeat !important}.firstPage{background:transparent url("images/btn_first_page.gif") center center no-repeat !important;}.firstPage:hover{background:transparent url("images/btn_over_first_page.gif") center center no-repeat !important}.lastPage{background:transparent url("images/btn_last_page.gif") center center no-repeat !important;}.lastPage:hover{background:transparent url("images/btn_over_last_page.gif") center center no-repeat !important}div.grd_Cont{background-color:#ebecee !important;border:1px solid #ccc !important;padding:0 !important;}div.grd_Cont .even{background-color:#fff}div.grd_Cont .odd{background-color:#d5d5d5}div.grd_headTblCont{background-color:#ebecee !important;border-bottom:none !important;}div.grd_headTblCont table{border-right:none !important}div.grd_tblCont table th,div.grd_headTblCont table th,div.grd_headTblCont table td{background:#ebecee url("images/bg_th.jpg") left top repeat-x !important;border-bottom:1px solid #d0d0d0 !important;border-right:1px solid #d0d0d0 !important;border-left:1px solid #fff !important;border-top:1px solid #fff !important}div.grd_tblCont table td{border-bottom:1px solid #999 !important}.grd_inf{background:#d7d7d7 url("images/bg_infDiv.jpg") 0 0 repeat-x !important;border-top:1px solid #d0d0d0 !important}.loader{border:1px solid #999}.defaultLoader{width:32px;height:32px;background:transparent url("images/img_loading.gif") 0 0 no-repeat !important}.even{background-color:#fff}.odd{background-color:#d5d5d5}span.expClpFlt a.btnExpClpFlt:hover{background-color:transparent !important}.activeHeader{background:#999 !important}

2
dist/tablefilter/style/themes/mytheme/mytheme.css vendored
View file

@ -1,6 +1,6 @@
/**
* tablefilter v0.2.51 by Max Guglielmi
* build date: 2016-08-06T09:41:00.544Z
* build date: 2016-08-06T14:43:01.297Z
* MIT License
*/
table.TF{border-left:1px dotted #81963b;border-top:none;border-right:0;border-bottom:none;}table.TF th{background:#39424b url("images/bg_headers.jpg") left top repeat-x;border-bottom:0;border-right:1px dotted #d0d0d0;border-left:0;border-top:0;color:#fff}table.TF td{border-bottom:1px dotted #81963b;border-right:1px dotted #81963b;padding:5px}.fltrow{background-color:#81963b !important;}.fltrow th,.fltrow td{border-bottom:1px dotted #39424b !important;border-right:1px dotted #fff !important;border-left:0 !important;border-top:0 !important;padding:1px 3px 1px 3px !important}.flt,select.flt,select.flt_multi,.flt_s,.single_flt,.div_checklist{border:1px solid #687830 !important}input.flt{width:99% !important}.inf{background:#d8d8d8;height:$min-height}input.reset{width:53px;background:transparent url("images/btn_filter.png") center center no-repeat !important}.helpBtn:hover{background-color:transparent}.nextPage{background:transparent url("images/btn_next_page.gif") center center no-repeat !important}.previousPage{background:transparent url("images/btn_previous_page.gif") center center no-repeat !important}.firstPage{background:transparent url("images/btn_first_page.gif") center center no-repeat !important}.lastPage{background:transparent url("images/btn_last_page.gif") center center no-repeat !important}div.grd_Cont{background:#81963b url("images/bg_headers.jpg") left top repeat-x !important;border:1px solid #ccc !important;padding:0 1px 1px 1px !important;}div.grd_Cont .even{background-color:#bccd83}div.grd_Cont .odd{background-color:#fff}div.grd_headTblCont{background-color:#ebecee !important;border-bottom:none !important}div.grd_tblCont table{border-right:none !important;}div.grd_tblCont table td{border-bottom:1px dotted #81963b;border-right:1px dotted #81963b}div.grd_tblCont table th,div.grd_headTblCont table th{background:transparent url("images/bg_headers.jpg") 0 0 repeat-x !important;border-bottom:0 !important;border-right:1px dotted #d0d0d0 !important;border-left:0 !important;border-top:0 !important;padding:0 4px 0 4px !important;color:#fff !important;height:35px !important}div.grd_headTblCont table td{border-bottom:1px dotted #39424b !important;border-right:1px dotted #fff !important;border-left:0 !important;border-top:0 !important;background-color:#81963b !important;padding:1px 3px 1px 3px !important}.grd_inf{background-color:#d8d8d8;border-top:1px solid #d0d0d0 !important}.loader{border:0 !important;background:#81963b !important}.defaultLoader{width:32px;height:32px;background:transparent url("images/img_loading.gif") 0 0 no-repeat !important}.even{background-color:#bccd83}.odd{background-color:#fff}span.expClpFlt a.btnExpClpFlt:hover{background-color:transparent !important}.activeHeader{background:#81963b !important}

2
dist/tablefilter/style/themes/skyblue/skyblue.css vendored
View file

@ -1,6 +1,6 @@
/**
* tablefilter v0.2.51 by Max Guglielmi
* build date: 2016-08-06T09:41:00.544Z
* build date: 2016-08-06T14:43:01.297Z
* MIT License
*/
table.TF{padding:0;color:#000;border-right:1px solid #a4bed4;border-top:1px solid #a4bed4;border-left:1px solid #a4bed4;border-bottom:0;}table.TF th{margin:0;color:inherit;background:#d1e5fe url("images/bg_skyblue.gif") 0 0 repeat-x;border-color:#fdfdfd #a4bed4 #a4bed4 #fdfdfd;border-width:1px;border-style:solid}table.TF td{margin:0;padding:5px;color:inherit;border-bottom:1px solid #a4bed4;border-left:0;border-top:0;border-right:0}.fltrow{background-color:#d1e5fe !important;}.fltrow th,.fltrow td{padding:1px 3px 1px 3px !important}.flt,select.flt,select.flt_multi,.flt_s,.single_flt,.div_checklist{border:1px solid #a4bed4 !important}input.flt{width:99% !important}.inf{background-color:#e3efff !important;border:1px solid #a4bed4;height:$min-height;color:#004a6f}div.tot,div.status{border-right:0 !important}.helpBtn:hover{background-color:transparent}input.reset{background:transparent url("images/icn_clear_filters.png") center center no-repeat !important}.nextPage{background:transparent url("images/btn_next_page.gif") center center no-repeat !important;border:1px solid transparent !important;}.nextPage:hover{background:#ffe4ab url("images/btn_next_page.gif") center center no-repeat !important;border:1px solid #ffb552 !important}.previousPage{background:transparent url("images/btn_prev_page.gif") center center no-repeat !important;border:1px solid transparent !important;}.previousPage:hover{background:#ffe4ab url("images/btn_prev_page.gif") center center no-repeat !important;border:1px solid #ffb552 !important}.firstPage{background:transparent url("images/btn_first_page.gif") center center no-repeat !important;border:1px solid transparent !important;}.firstPage:hover{background:#ffe4ab url("images/btn_first_page.gif") center center no-repeat !important;border:1px solid #ffb552 !important}.lastPage{background:transparent url("images/btn_last_page.gif") center center no-repeat !important;border:1px solid transparent !important;}.lastPage:hover{background:#ffe4ab url("images/btn_last_page.gif") center center no-repeat !important;border:1px solid #ffb552 !important}.activeHeader{background:#ffe4ab !important;border:1px solid #ffb552 !important;color:inherit !important}div.grd_Cont{background-color:#d9eaed !important;border:1px solid #9cc !important;padding:0 !important;}div.grd_Cont .even{background-color:#fff}div.grd_Cont .odd{background-color:#e3efff}div.grd_headTblCont{background-color:#d9eaed !important;border-bottom:none !important}div.grd_tblCont table{border-right:none !important}div.grd_tblCont table th,div.grd_headTblCont table th,div.grd_headTblCont table td{background:#d9eaed url("images/bg_skyblue.gif") left top repeat-x;border-bottom:1px solid #a4bed4;border-right:1px solid #a4bed4 !important;border-left:1px solid #fff !important;border-top:1px solid #fff !important}div.grd_tblCont table td{border-bottom:1px solid #a4bed4 !important;border-right:0 !important;border-left:0 !important;border-top:0 !important}.grd_inf{background-color:#cce2fe;color:#004a6f;border-top:1px solid #9cc !important;}.grd_inf a{text-decoration:none;font-weight:bold}.loader{background-color:#2d8eef;border:1px solid #cce2fe;border-radius:5px}.even{background-color:#fff}.odd{background-color:#e3efff}span.expClpFlt a.btnExpClpFlt:hover{background-color:transparent !important}.ezActiveRow{background-color:#ffdc61 !important;color:inherit}.ezSelectedRow{background-color:#ffe4ab !important;color:inherit}.ezActiveCell{background-color:#fff !important;color:#000 !important;font-weight:bold}.ezETSelectedCell{background-color:#fff !important;font-weight:bold;color:#000 !important}

10
dist/tablefilter/tablefilter.js vendored
View file

File diff suppressed because one or more lines are too long

2
dist/tablefilter/tf-1.js vendored
View file

@ -1,6 +1,6 @@
/**
* tablefilter v0.2.51 by Max Guglielmi
* build date: 2016-08-06T09:41:00.458Z
* build date: 2016-08-06T14:43:01.282Z
* MIT License
*/

2
src/modules/rowsCounter.js
View file

@ -22,7 +22,7 @@ export class RowsCounter extends Feature {
/**
* ID of custom container element
* @type {string}
* @type {String}
*/
this.targetId = f.rows_counter_target_id || null;

225
src/modules/statusBar.js
View file

@ -3,11 +3,17 @@ import {root} from '../root';
import {createElm, createText, elm, removeElm} from '../dom';
import {isFn} from '../types';
/**
* Status bar UI component
* @export
* @class StatusBar
* @extends {Feature}
*/
export class StatusBar extends Feature {
/**
* Status bar UI component
* @param {Object} tf TableFilter instance
* Creates an instance of StatusBar
* @param {TableFilter} tf TableFilter instance
*/
constructor(tf) {
super(tf, 'statusBar');
@ -15,63 +21,161 @@ export class StatusBar extends Feature {
// Configuration object
let f = this.config;
//id of custom container element
this.statusBarTgtId = f.status_bar_target_id || null;
//element containing status bar label
this.statusBarDiv = null;
//status bar
this.statusBarSpan = null;
//status bar label
this.statusBarSpanText = null;
//defines status bar text
this.statusBarText = f.status_bar_text || '';
//defines css class status bar
this.statusBarCssClass = f.status_bar_css_class || 'status';
//delay for status bar clearing
this.statusBarCloseDelay = 250;
/**
* ID of custom container element
* @type {String}
*/
this.targetId = f.status_bar_target_id || null;
//calls function before message is displayed
/**
* Container DOM element
* @type {DOMElement}
* @private
*/
this.container = null;
/**
* Message container DOM element
* @type {DOMElement}
* @private
*/
this.msgContainer = null;
/**
* Label container DOM element
* @type {DOMElement}
* @private
*/
this.labelContainer = null;
/**
* Text preceding status message
* @type {String}
*/
this.text = f.status_bar_text || '';
/**
* Css class for container element
* @type {String}
*/
this.cssClass = f.status_bar_css_class || 'status';
/**
* Message visibility duration in milliseconds
* @type {Number}
* @private
*/
this.delay = 250;
/**
* Callback fired before the message is displayed
* @type {Function}
*/
this.onBeforeShowMsg = isFn(f.on_before_show_msg) ?
f.on_before_show_msg : null;
//calls function after message is displayed
/**
* Callback fired after the message is displayed
* @type {Function}
*/
this.onAfterShowMsg = isFn(f.on_after_show_msg) ?
f.on_after_show_msg : null;
//status messages
/**
* Message appearing upon filtering
* @type {String}
*/
this.msgFilter = f.msg_filter || 'Filtering data...';
//populating drop-downs
/**
* Message appearing when a drop-down filter is populated
* @type {String}
*/
this.msgPopulate = f.msg_populate || 'Populating filter...';
//populating drop-downs
/**
* Message appearing when a checklist filter is populated
* @type {String}
*/
this.msgPopulateCheckList = f.msg_populate_checklist ||
'Populating list...';
//changing paging page
/**
* Message appearing when a pagination page is changed
* @type {String}
*/
this.msgChangePage = f.msg_change_page || 'Collecting paging data...';
//clearing filters
/**
* Message appearing when filters are cleared
* @type {String}
*/
this.msgClear = f.msg_clear || 'Clearing filters...';
//changing nb results/page
/**
* Message appearing when the page length is changed
* @type {String}
*/
this.msgChangeResults = f.msg_change_results ||
'Changing results per page...';
//re-setting page
/**
* Message appearing when the page is re-set
* @type {String}
*/
this.msgResetPage = f.msg_reset_page || 'Re-setting page...';
//re-setting page length
/**
* Message appearing when the page length is re-set
* @type {String}
*/
this.msgResetPageLength = f.msg_reset_page_length ||
'Re-setting page length...';
//table sorting
/**
* Message appearing upon column sorting
* @type {String}
*/
this.msgSort = f.msg_sort || 'Sorting data...';
//extensions loading
/**
* Message appearing when extensions are loading
* @type {String}
*/
this.msgLoadExtensions = f.msg_load_extensions ||
'Loading extensions...';
//themes loading
/**
* Message appearing when themes are loading
* @type {String}
*/
this.msgLoadThemes = f.msg_load_themes || 'Loading theme(s)...';
// status bar div
this.prfxStatus = 'status_';
// status bar label
this.prfxStatusSpan = 'statusSpan_';
// text preceding status bar label
this.prfxStatusTxt = 'statusText_';
/**
* Prefix for container ID
* @type {String}
* @private
*/
this.prfxCont = 'status_';
/**
* Prefix for label container ID
* @type {String}
* @private
*/
this.prfxLabel = 'statusSpan_';
/**
* Prefix for text preceding the message
* @type {String}
* @private
*/
this.prfxText = 'statusText_';
}
/**
* Initializes StatusBar instance
*/
init() {
if (this.initialized) {
return;
@ -81,25 +185,23 @@ export class StatusBar extends Feature {
let emitter = this.emitter;
//status bar container
let statusDiv = createElm('div', ['id', this.prfxStatus + tf.id]);
statusDiv.className = this.statusBarCssClass;
let statusDiv = createElm('div', ['id', this.prfxCont + tf.id]);
statusDiv.className = this.cssClass;
//status bar label
let statusSpan = createElm('span', ['id', this.prfxStatusSpan + tf.id]);
let statusSpan = createElm('span', ['id', this.prfxLabel + tf.id]);
//preceding text
let statusSpanText = createElm('span',
['id', this.prfxStatusTxt + tf.id]);
statusSpanText.appendChild(createText(this.statusBarText));
let statusSpanText = createElm('span', ['id', this.prfxText + tf.id]);
statusSpanText.appendChild(createText(this.text));
// target element container
if (!this.statusBarTgtId) {
if (!this.targetId) {
tf.setToolbar();
}
let targetEl = (!this.statusBarTgtId) ?
tf.lDiv : elm(this.statusBarTgtId);
let targetEl = (!this.targetId) ? tf.lDiv : elm(this.targetId);
//default container: 'lDiv'
if (!this.statusBarTgtId) {
if (!this.targetId) {
statusDiv.appendChild(statusSpanText);
statusDiv.appendChild(statusSpan);
targetEl.appendChild(statusDiv);
@ -109,9 +211,9 @@ export class StatusBar extends Feature {
targetEl.appendChild(statusSpan);
}
this.statusBarDiv = statusDiv;
this.statusBarSpan = statusSpan;
this.statusBarSpanText = statusSpanText;
this.container = statusDiv;
this.msgContainer = statusSpan;
this.labelContainer = statusSpanText;
// Subscribe to events
emitter.on(['before-filtering'], () => this.message(this.msgFilter));
@ -145,9 +247,16 @@ export class StatusBar extends Feature {
() => this.message('')
);
/**
* @inherited
*/
this.initialized = true;
}
/**
* Display status message
* @param {String} [t=''] Message to be displayed
*/
message(t = '') {
if (!this.isEnabled()) {
return;
@ -157,18 +266,21 @@ export class StatusBar extends Feature {
this.onBeforeShowMsg.call(null, this.tf, t);
}
let d = t === '' ? this.statusBarCloseDelay : 1;
let d = t === '' ? this.delay : 1;
root.setTimeout(() => {
if (!this.initialized) {
return;
}
this.statusBarSpan.innerHTML = t;
this.msgContainer.innerHTML = t;
if (this.onAfterShowMsg) {
this.onAfterShowMsg.call(null, this.tf, t);
}
}, d);
}
/**
* Destroy StatusBar instance
*/
destroy() {
if (!this.initialized) {
return;
@ -176,13 +288,13 @@ export class StatusBar extends Feature {
let emitter = this.emitter;
this.statusBarDiv.innerHTML = '';
if (!this.statusBarTgtId) {
removeElm(this.statusBarDiv);
this.container.innerHTML = '';
if (!this.targetId) {
removeElm(this.container);
}
this.statusBarSpan = null;
this.statusBarSpanText = null;
this.statusBarDiv = null;
this.labelContainer = null;
this.msgContainer = null;
this.container = null;
// Unsubscribe to events
emitter.off(['before-filtering'], () => this.message(this.msgFilter));
@ -218,5 +330,4 @@ export class StatusBar extends Feature {
this.initialized = false;
}
}

14
test/test-status-bar.js
View file

@ -8,7 +8,7 @@ var statusBar = tf.feature('statusBar');
module('Sanity checks');
test('Status bar component', function() {
deepEqual(typeof statusBar, 'object', 'StatusBar instantiated');
notEqual(statusBar.statusBarDiv, null, 'statusBarDiv property');
notEqual(statusBar.container, null, 'container property');
});
module('Feature interface');
@ -57,8 +57,8 @@ test('Can check is enabled', function() {
module('UI elements');
test('Status bar UI elements', function() {
var container = statusBar.statusBarDiv,
label = statusBar.statusBarSpanText;
var container = statusBar.container,
label = statusBar.msgContainer;
deepEqual(container.nodeName, 'DIV', 'Status bar container');
deepEqual(label.nodeName, 'SPAN', 'Status bar label');
});
@ -66,17 +66,17 @@ test('Status bar UI elements', function() {
module('Destroy');
test('Remove UI', function() {
statusBar.destroy();
var container = statusBar.statusBarDiv,
label = statusBar.statusBarSpanText;
var container = statusBar.container,
label = statusBar.msgContainer;
deepEqual(container, null, 'Status bar container removed');
deepEqual(label, null, 'Status bar button removed');
});
test('Re-set UI', function() {
statusBar.statusBarText = '→←';
statusBar.text = '→←';
statusBar.init();
var label = statusBar.statusBarSpanText;
var label = statusBar.labelContainer;
notEqual(
label.innerHTML.indexOf('→←'), -1, 'Status bar text');
});