1
0
Fork 0
mirror of https://github.com/koalyptus/TableFilter.git synced 2024-06-03 06:22:34 +02:00
TableFilter/src-es6/extensions/colsVisibility/colsVisibility.js

333 lines
13 KiB
JavaScript
Raw Normal View History

2015-04-17 07:01:06 +02:00
import {Dom} from '../../dom';
import {Types} from '../../types';
import {Event} from '../../event';
2015-04-12 10:32:24 +02:00
export class ColsVisibility{
/**
2015-04-12 12:24:32 +02:00
* Columns Visibility extension
2015-04-12 10:32:24 +02:00
* @param {Object} tf TableFilter instance
*/
constructor(tf, ext){
// Configuration object
var f = tf.config();
this.colsVisibility = f.cols_visibility;
2015-04-17 07:01:06 +02:00
this.colVisExtLoaded = false;
this.colVisExtName = ext.name;
this.colVisExtDesc = ext.description;
2015-04-12 10:32:24 +02:00
//show/hide cols span element
2015-04-17 07:01:06 +02:00
this.colVisSpanEl = null;
2015-04-12 10:32:24 +02:00
//show/hide cols button element
2015-04-17 07:01:06 +02:00
this.btnColVisEl = null;
2015-04-12 10:32:24 +02:00
//show/hide cols container div element
2015-04-17 07:01:06 +02:00
this.colVisContEl = null;
2015-04-12 12:24:32 +02:00
//tick to hide or show column
2015-04-17 07:01:06 +02:00
this.colVisTickToHide = Boolean(f.colvis_tick_to_hide || true);
2015-04-12 12:24:32 +02:00
//enables/disables cols manager generation
2015-04-17 07:01:06 +02:00
this.colVisManager = Boolean(f.colvis_manager || true);
2015-04-12 12:24:32 +02:00
//only if external headers
2015-04-17 07:01:06 +02:00
this.colVisHeadersTbl = f.colvis_headers_table || null;
2015-04-12 12:24:32 +02:00
//only if external headers
2015-04-17 07:01:06 +02:00
this.colVisHeadersIndex = f.colvis_headers_index || 1;
2015-04-12 12:24:32 +02:00
//id of container element
2015-04-17 07:01:06 +02:00
this.colVisContElTgtId = f.colvis_container_target_id || null;
2015-04-12 12:24:32 +02:00
//alternative headers text
2015-04-17 07:01:06 +02:00
this.colVisHeadersText = f.colvis_headers_text || null;
2015-04-12 12:24:32 +02:00
//id of button container element
2015-04-17 07:01:06 +02:00
this.btnColVisTgtId = f.btn_colvis_target_id || null;
2015-04-12 12:24:32 +02:00
//defines show/hide cols text
2015-04-17 07:01:06 +02:00
this.btnColVisText = f.btn_colvis_text || 'Display columns▼';
2015-04-12 12:24:32 +02:00
//defines show/hide cols button innerHtml
2015-04-17 07:01:06 +02:00
this.btnColVisHtml = f.btn_colvis_html || null;
2015-04-12 12:24:32 +02:00
//defines css class for show/hide cols button
2015-04-17 07:01:06 +02:00
this.btnColVisCssClass = f.btn_colvis_css_class || 'colVis';
2015-04-12 12:24:32 +02:00
//defines close link text
2015-04-17 07:01:06 +02:00
this.btnColVisCloseText = f.btn_colvis_close_text || 'Close';
2015-04-12 12:24:32 +02:00
//defines close button innerHtml
2015-04-17 07:01:06 +02:00
this.btnColVisCloseHtml = f.btn_colvis_close_html || null;
2015-04-12 12:24:32 +02:00
//defines css class for close button
2015-04-17 07:01:06 +02:00
this.btnColVisCloseCssClass =
f.btn_colvis_close_css_class || this.btnColVisCssClass;
2015-04-15 09:09:20 +02:00
2015-04-17 07:01:06 +02:00
this.colVisExtPath = ext.path || 'TFExt_ColsVisibility/';
this.colVisStylesheet = 'TFExt_ColsVisibility.css';
2015-04-15 09:09:20 +02:00
//span containing show/hide cols button
2015-04-17 07:01:06 +02:00
this.prfxColVisSpan = 'colVis_';
2015-04-15 09:09:20 +02:00
//defines css class span containing show/hide cols
2015-04-17 07:01:06 +02:00
this.colVisSpanCss = f.colvis_span_css_class || 'colVisSpan';
this.prfxColVisCont = 'colVisCont_';
2015-04-15 09:09:20 +02:00
//defines css class div containing show/hide cols
2015-04-17 07:01:06 +02:00
this.colVisContCss = f.colvis_cont_css_class || 'colVisCont';
2015-04-15 09:09:20 +02:00
//defines css class for cols list (ul)
2015-04-17 07:01:06 +02:00
this.colVisListCss = f.colvis_list_css_class ||'cols_checklist';
2015-04-15 09:09:20 +02:00
//defines css class for list item (li)
2015-04-17 07:01:06 +02:00
this.colVisListItemCssClass = f.checklist_item_css_class ||
2015-04-15 09:09:20 +02:00
'cols_checklist_item';
//defines css class for selected list item (li)
2015-04-17 07:01:06 +02:00
this.colVisListSlcItemCssClass =
2015-04-15 09:09:20 +02:00
f.checklist_selected_item_css_class || 'cols_checklist_slc_item';
//text preceding columns list
2015-04-17 07:01:06 +02:00
this.colVisText = f.colvis_text || 'Hide columns: ';
this.colVisAtStart = f.colvis_at_start || null;
this.colVisEnableHover = Boolean(f.colvis_enable_hover) || false;
2015-04-15 09:09:20 +02:00
//enables select all option
2015-04-17 07:01:06 +02:00
this.colVisEnableTickAll = Boolean(f.colvis_enable_tick_all) || false;
2015-04-15 09:09:20 +02:00
//text preceding columns list
2015-04-17 07:01:06 +02:00
this.colVisTickAllText = f.colvis_tick_all_text || 'Select all:';
this.colVisIsOpen = false;
2015-04-15 09:09:20 +02:00
//array containing hidden columns indexes
2015-04-17 07:01:06 +02:00
this.colVisHiddenCols = [];
2015-04-15 09:09:20 +02:00
this.tblHasColTag = (Dom.tag(tf.tbl,'col').length > 0);
//callback invoked just after cols manager is loaded
this.onColsManagerLoaded = Types.isFn(f.on_cols_manager_loaded) ?
f.on_cols_manager_loaded : null;
//calls function before cols manager is opened
this.onBeforeOpenColsManager =
Types.isFn(f.on_before_open_cols_manager) ?
f.on_before_open_cols_manager : null;
//calls function after cols manager is opened
this.onAfterOpenColsManager = Types.isFn(f.on_after_open_cols_manager) ?
f.on_after_open_cols_manager : null;
//calls function before cols manager is closed
this.onBeforeCloseColsManager =
Types.isFn(f.on_before_close_cols_manager) ?
f.on_before_close_cols_manager : null;
//calls function after cols manager is closed
this.onAfterCloseColsManager =
Types.isFn(f.on_after_close_cols_manager) ?
f.on_after_close_cols_manager : null;
//calls function before col is hidden
this.onBeforeColIsHidden = Types.isFn(f.on_before_col_is_hidden) ?
f.on_before_col_is_hidden : null;
//calls function after col is hidden
this.onAfterColIsHidden = Types.isFn(f.on_after_col_is_hidden) ?
f.on_after_col_is_hidden : null;
//calls function before col is displayed
this.onBeforeColIsDisplayed = Types.isFn(f.on_before_col_is_displayed) ?
f.on_before_col_is_displayed : null;
//calls function after col is displayed
this.onAfterColIsDisplayed = Types.isFn(f.on_after_col_is_displayed) ?
f.on_after_col_is_displayed : null;
//Grid layout compatibility
if(tf.gridLayout){
2015-04-17 07:01:06 +02:00
this.colVisHeadersTbl = tf.headTbl; //headers table
this.colVisHeadersIndex = 0; //headers index
2015-04-15 09:09:20 +02:00
this.onAfterColIsDisplayed = function(){};
this.onAfterColIsHidden = function(){};
}
//Extension event definition
//event name for TF event manager
tf.Evt.name.colsvisibility = 'ShowColsVisibility';
//event status message
tf.msgShowColsVisibility = 'Show/Hide columns';
tf.Evt._ShowColsVisibility = function(){ o.ShowColsVisibility(); };
//event name for TF event manager
tf.Evt.name.checkitem = 'CheckItem';
//event status message
tf.msgCheckItem = 'Showing/hiding columns';
tf.Evt._CheckItem = function(li){ o.CheckItem(li); };
//Loads extension stylesheet
tf.includeFile(
ext.name+'Style',
2015-04-17 07:01:06 +02:00
this.colVisExtPath + this.colVisStylesheet,
2015-04-15 09:09:20 +02:00
null,
'link'
);
2015-04-17 07:01:06 +02:00
this.tf = tf;
2015-04-15 09:09:20 +02:00
//Sets button
2015-04-17 07:01:06 +02:00
// if(this.colVisManager) o.SetShowHideColsBtn();
2015-04-15 09:09:20 +02:00
this.init();
2015-04-17 07:01:06 +02:00
this.colVisExtLoaded = true;
}
toggle(evt){
2015-04-15 09:09:20 +02:00
}
init(){
2015-04-17 07:01:06 +02:00
if(this.colVisManager){
this.buildBtn();
}
}
buildBtn(){
var tf = this.tf;
// if(!tf.hasGrid && !tf.isFirstLoad){
// return;
// }
if(this.btnColVisEl){
return;
}
var colVisSpan = Dom.createElm('span',
['id', this.prfxColVisSpan+tf.id]);
colVisSpan.className = this.colVisSpanCss;
//Container element (rdiv or custom element)
if(!this.btnColVisTgtId){
this.SetTopDiv();
}
var targetEl = !this.btnColVisTgtId ?
tf.rDiv : Dom.id(this.btnColVisTgtId);
2015-04-15 09:09:20 +02:00
2015-04-17 07:01:06 +02:00
if(this.btnColVisTgtId){
targetEl.firstChild.parentNode.insertBefore(
colVisSpan, targetEl.firstChild);
} else {
targetEl.appendChild(colVisSpan);
}
if(!this.btnColVisHtml){
var btn = Dom.createElm('a', ['href','javascript:;']);
btn.className = this.btnColVisCssClass;
btn.title = this.colVisExtDesc;
btn.innerHTML = this.btnColVisText;
colVisSpan.appendChild(btn);
if(!this.colVisEnableHover){
// btn.onclick = this.Evt._ShowColsVisibility;
Event.add(btn, 'click', (evt)=> { this.toggle(evt); });
} else {
// var o = this;
// btn.onmouseover = this.Evt._ShowColsVisibility;
Event.add(btn, 'mouseover', (evt)=> { this.toggle(evt); });
}
} else { //Custom html
colVisSpan.innerHTML = this.btnColVisHtml;
var colVisEl = colVisSpan.firstChild;
if(!this.colVisEnableHover){
// colVisEl.onclick = this.Evt._ShowColsVisibility;
Event.add(colVisEl,
'click', (evt)=> { this.toggle(evt); });
} else {
// colVisEl.onmouseover = this.Evt._ShowColsVisibility;
Event.add(colVisEl,
'mouseover', (evt)=> { this.toggle(evt); });
}
}
this.colVisSpanEl = colVisSpan;
this.btnColVisEl = this.colVisSpanEl.firstChild;
// this.SetColsVisibilityManager();
this.setManager();
if(this.onColsManagerLoaded){
this.onColsManagerLoaded.call(null, this);
}
2015-04-12 10:32:24 +02:00
}
2015-04-17 07:01:06 +02:00
setManager(){
var tf = this.tf;
// if(!this.hasGrid && !this.isFirstLoad) return;
var container = !this.colVisContElTgtId ?
Dom.createElm('div', ['id', this.prfxColVisCont+tf.id]) :
Dom.id(this.colVisContElTgtId);
container.className = this.colVisContCss;
//Extension description
var extNameLabel = Dom.createElm('p');
extNameLabel.innerHTML = this.colVisText;
container.appendChild(extNameLabel);
//Headers list
var ul = Dom.createElm('ul' ,['id', 'ul'+this.colVisExtName+'_'+tf.id]);
ul.className = this.colVisListCss;
var tbl = this.colVisHeadersTbl ? this.colVisHeadersTbl : tf.tbl;
var headerIndex = (o.colVisHeadersTbl)
? o.colVisHeadersIndex : o.GetHeadersRowIndex();
var headerRow = tbl.rows[headerIndex];
//Tick all option
if(o.showHideEnableTickAll){
var li = tf_CreateCheckItem('col__'+o.id, o.showHideTickAllText, o.showHideTickAllText);
tf_AddClass(li,this.colVisListItemCssClass);
ul.appendChild(li);
var isAllTicked = false;
li.check.onclick = function(){
for(var h=0; h<headerRow.cells.length; h++)
{
var itm = tf_Id('col_'+h+'_'+o.id);
if(!isAllTicked && itm.checked) itm.checked = false;
if(isAllTicked && !itm.checked) itm.checked = true;
if(itm) itm.click();
}
isAllTicked = (isAllTicked ? false : true);
};
if(tf_isIE)
{//IE: label looses check capability
li.label.onclick = function(){ this.firstChild.click(); };
}
}
for(var i=0; i<headerRow.cells.length; i++)
{
var cell = headerRow.cells[i];
var cellText = (o.colVisHeadersText && o.colVisHeadersText[i])
? o.colVisHeadersText[i] : tf_GetHeaderText(cell);
var li = tf_CreateCheckItem('col_'+i+'_'+o.id, cellText, cellText);
tf_AddClass(li,this.colVisListItemCssClass);
if(!o.colVisTickToHide) tf_AddClass(li,this.colVisListSlcItemCssClass);
ul.appendChild(li);
if(!o.colVisTickToHide) li.check.checked = true;
li.check.onclick = function(){ o.Evt._CheckItem(this.parentNode); };
if(tf_isIE)
{//IE: label looses check capability
li.label.onclick = function(){ this.firstChild.click(); };
}
}
//separator
var p = tf_CreateElm('p',['align','center']);
//Close link
if(this.btnColVisCloseHtml==null)
{
var btn = tf_CreateElm( 'a', ['href','javascript:;'] );
btn.className = this.btnColVisCloseCssClass;
btn.innerHTML = this.btnColVisCloseText;
btn.onclick = this.Evt._ShowColsVisibility;
p.appendChild(btn);
} else {
p.innerHTML = this.btnColVisCloseHtml;
var btn = p.firstChild;
btn.onclick = this.Evt._ShowColsVisibility;
}
container.appendChild(ul);
container.appendChild(p);
//this.colVisSpanEl.appendChild(container);
this.btnColVisEl.parentNode.insertBefore(container, this.btnColVisEl);
this.colVisContEl = container;
//IE6 only: options are not checked if colVisTickToHide=false
if(tf_isIE && !o.colVisTickToHide)
for(var i=0; i<headerRow.cells.length; i++)
tf_Id('col_'+i+'_'+o.id).checked = true;
if(this.colVisAtStart != null)
{
var a = this.colVisAtStart;
for(var k=0; k<a.length; k++)
{
var itm = tf_Id('col_'+a[k]+'_'+o.id);
if(itm) itm.click();
}
}
}
2015-04-12 10:32:24 +02:00
}