Special XML conversion code for Firefox >= 20.0
[infodrom/rico3] / minsrc / ricoGridCommon.js
1 /*
2  *  (c) 2005-2009 Richard Cowin (http://openrico.org)
3  *  (c) 2005-2009 Matt Brown (http://dowdybrown.com)
4  *
5  *  Licensed under the Apache License, Version 2.0 (the "License"); you may not use this
6  *  file except in compliance with the License. You may obtain a copy of the License at
7  *
8  *         http://www.apache.org/licenses/LICENSE-2.0
9  *
10  *  Unless required by applicable law or agreed to in writing, software distributed under the
11  *  License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
12  *  either express or implied. See the License for the specific language governing permissions
13  *  and limitations under the License.
14  */
15
16 if(typeof Rico=='undefined') throw("GridCommon requires the Rico JavaScript framework");
17
18 /**
19  * Define methods that are common to both SimpleGrid and LiveGrid
20  */
21 Rico.GridCommon = {
22
23   baseInit: function() {
24     this.options = {
25       saveColumnInfo   : {width:true, filter:false, sort:false},  // save info in cookies?
26       cookiePrefix     : 'RicoGrid.',
27       allowColResize   : true,      // allow user to resize columns
28       windowResize     : true,      // Resize grid on window.resize event? Set to false when embedded in an accordian.
29       click            : null,
30       dblclick         : null,
31       contextmenu      : null,
32       menuEvent        : null,      // event that triggers menus - click, dblclick, contextmenu, or none (no menus)
33       defaultWidth     : -1,        // if -1, then use unformatted column width
34       scrollBarWidth   : 19,        // this is the value used in positioning calculations, it does not actually change the width of the scrollbar
35       minScrollWidth   : 100,       // min scroll area width when width of frozen columns exceeds window width
36       frozenColumns    : 0,
37       exportWindow     : "height=400,width=500,scrollbars=1,menubar=1,resizable=1,location=0,toolbar=0,status=0",
38       exportStyleList  : ['background-color','color','text-align','font-weight','font-size','font-family'],
39       exportImgTags    : false,       // applies to grid header and to SimpleGrid cells (not LiveGrid cells)
40       exportFormFields : true,
41       FilterLocation   : null,        // heading row number to place filters. -1=add a new heading row.
42       FilterAllToken   : '___ALL___', // select box value to use to indicate ALL
43       columnSpecs      : []
44     };
45     this.hdrCells=[];
46     this.headerColCnt=0;
47     this.headerRowIdx=0;       // row in header which gets resizers (no colspan's in this row)
48     this.tabs=new Array(2);
49     this.thead=new Array(2);
50     this.tbody=new Array(2);
51   },
52
53   attachMenuEvents: function() {
54     var i;
55     if (!this.options.menuEvent || this.options.menuEvent=='none') return;
56     this.hideScroll=navigator.userAgent.match(/Macintosh\b.*\b(Firefox|Camino)\b/i) || (Rico.isOpera && parseFloat(window.opera.version())<9.5);
57     this.options[this.options.menuEvent]=Rico.eventHandle(this,'handleMenuClick');
58     if (this.highlightDiv) {
59       switch (this.options.highlightElem) {
60         case 'cursorRow':
61           this.attachMenu(this.highlightDiv[0]);
62           break;
63         case 'cursorCell':
64           for (i=0; i<2; i++) {
65             this.attachMenu(this.highlightDiv[i]);
66           }
67           break;
68       }
69     }
70     for (i=0; i<2; i++) {
71       this.attachMenu(this.tbody[i]);
72     }
73   },
74
75   attachMenu: function(elem) {
76     if (this.options.click)
77       Rico.eventBind(elem, 'click', this.options.click, false);
78     if (this.options.dblclick) {
79       if (Rico.isWebKit || Rico.isOpera)
80         Rico.eventBind(elem, 'click', Rico.eventHandle(this,'handleDblClick'), false);
81       else
82         Rico.eventBind(elem, 'dblclick', this.options.dblclick, false);
83     }
84     if (this.options.contextmenu) {
85       if (Rico.isOpera || Rico.isKonqueror)
86         Rico.eventBind(elem, 'click', Rico.eventHandle(this,'handleContextMenu'), false);
87       else
88         Rico.eventBind(elem, 'contextmenu', this.options.contextmenu, false);
89     }
90   },
91
92 /**
93  * implement double-click for browsers that don't support a double-click event (e.g. Safari)
94  */
95   handleDblClick: function(e) {
96     var elem=Rico.eventElement(e);
97     if (this.dblClickElem == elem) {
98       this.options.dblclick(e);
99     } else {
100       this.dblClickElem = elem;
101       this.safariTimer=Rico.runLater(300,this,'clearDblClick');
102     }
103   },
104
105   clearDblClick: function() {
106     this.dblClickElem=null;
107   },
108
109 /**
110  * implement right-click for browsers that don't support contextmenu event (e.g. Opera, Konqueror)
111  * use control-click instead
112  */
113   handleContextMenu: function(e) {
114     var b;
115     if( typeof( e.which ) == 'number' )
116       b = e.which; //Netscape compatible
117     else if( typeof( e.button ) == 'number' )
118       b = e.button; //DOM
119     else
120       return;
121     if (b==1 && e.ctrlKey) {
122       this.options.contextmenu(e);
123     }
124   },
125
126   cancelMenu: function() {
127     if (this.menu) this.menu.cancelmenu();
128   },
129
130 /**
131  * gather info from original headings
132  */
133   getColumnInfo: function(hdrSrc) {
134     Rico.log('getColumnInfo: len='+hdrSrc.length);
135     if (hdrSrc.length == 0) return 0;
136     this.headerRowCnt=hdrSrc.length;
137     var r,c,colcnt;
138     for (r=0; r<this.headerRowCnt; r++) {
139       var headerRow = hdrSrc[r];
140       var headerCells=headerRow.cells;
141       if (r >= this.hdrCells.length) this.hdrCells[r]=[];
142       for (c=0; c<headerCells.length; c++) {
143         var obj={};
144         obj.cell=headerCells[c];
145         obj.colSpan=headerCells[c].colSpan || 1;  // Safari & Konqueror return default colspan of 0
146         if (this.options.defaultWidth < 0) obj.initWidth=headerCells[c].offsetWidth;
147         this.hdrCells[r].push(obj);
148       }
149       if (headerRow.id.slice(-5)=='_main') {
150         colcnt=this.hdrCells[r].length;
151         this.headerRowIdx=r;
152       }
153     }
154     if (!colcnt) {
155       this.headerRowIdx=this.headerRowCnt-1;
156       colcnt=this.hdrCells[this.headerRowIdx].length;
157     }
158     Rico.log("getColumnInfo: colcnt="+colcnt);
159     return colcnt;
160   },
161
162   addHeadingRow: function(className) {
163     var r=this.headerRowCnt++;
164     this.hdrCells[r]=[];
165     for( var h=0; h < 2; h++ ) {
166       var row = this.thead[h].insertRow(-1);
167       var newClass='ricoLG_hdg '+this.tableId+'_hdg'+r;
168       if (className) newClass+=' '+className;
169       row.className=newClass;
170       var limit= h==0 ? this.options.frozenColumns : this.headerColCnt-this.options.frozenColumns;
171       for( var c=0; c < limit; c++ ) {
172         var hdrCell=row.insertCell(-1);
173         var colDiv=Rico.wrapChildren(hdrCell,'ricoLG_col');
174         Rico.wrapChildren(colDiv,'ricoLG_cell');
175         this.hdrCells[r].push({cell:hdrCell,colSpan:1});
176       }
177     }
178     return r;
179   },
180   
181 /**
182  * create column array
183  */
184   createColumnArray: function(columnType) {
185     this.direction=Rico.getStyle(this.outerDiv,'direction').toLowerCase();  // ltr or rtl
186     this.align=this.direction=='rtl' ? ['right','left'] : ['left','right'];
187     Rico.log('createColumnArray: dir='+this.direction);
188     for (var i=0; i<2; i++) Rico.addClass(this.thead[i].rows[this.headerRowIdx],'rico_ResizeRow');
189     this.columns = [];
190     for (var c=0; c < this.headerColCnt; c++) {
191       Rico.log("createColumnArray: c="+c);
192       var tabidx=c<this.options.frozenColumns ? 0 : 1;
193       var col=new Rico[columnType](this, c, this.hdrCells[this.headerRowIdx][c], tabidx);
194       this.columns.push(col);
195       if (c > 0) this.columns[c-1].next=col;
196     }
197     this.getCookie();
198     Rico.runLater(100,this,'insertResizers');  // avoids peek-a-boo bug in column 1 in IE6/7
199   },
200
201 /**
202  * Insert resizing handles
203  */
204   insertResizers: function() {
205     if (!this.options.allowColResize) return;
206     for (var x=0;x<this.columns.length;x++) {
207       this.columns[x].insertResizer();
208     }
209   },
210
211 /**
212  * Create div structure
213  */
214   createDivs: function() {
215     Rico.log("createDivs start");
216     this.outerDiv = this.createDiv("outer");
217     if (Rico.theme.gridContainer) Rico.addClass(this.outerDiv,Rico.theme.gridContainer);
218     if (this.outerDiv.firstChild && this.outerDiv.firstChild.tagName && this.outerDiv.firstChild.tagName.toUpperCase()=='TABLE') {
219       this.structTab=this.outerDiv.firstChild;
220       this.structTabLeft=this.structTab.rows[0].cells[0];
221       this.structTabUR=this.structTab.rows[0].cells[1];
222       this.structTabLR=this.structTab.rows[1].cells[0];
223     } else {
224       this.structTab = document.createElement("table");
225       this.structTab.border=0;
226       this.structTab.cellPadding=0;
227       this.structTab.cellSpacing=0;
228       var tr1=this.structTab.insertRow(-1);
229       tr1.vAlign='top';
230       this.structTabLeft=tr1.insertCell(-1);
231       this.structTabLeft.rowSpan=2;
232       this.structTabLeft.style.padding='0px';
233       this.structTabLeft.style.border='none';
234       var tr2=this.structTab.insertRow(-1);
235       tr2.vAlign='top';
236       this.structTabUR=tr1.insertCell(-1);
237       this.structTabUR.style.padding='0px';
238       this.structTabUR.style.border='none';
239       this.structTabLR=tr2.insertCell(-1);
240       this.structTabLR.style.padding='0px';
241       this.structTabLR.style.border='none';
242       this.outerDiv.appendChild(this.structTab);
243     }
244     Rico.addClass(this.structTab,'ricoLG_StructTab');
245     //this.structTabLR.style.overflow='hidden';
246     //if (Rico.isOpera) this.outerDiv.style.overflow="hidden";
247     this.frozenTabs = this.createDiv("frozenTabs",this.structTabLeft);
248     this.innerDiv   = this.createDiv("inner",this.structTabUR);
249     this.scrollDiv  = this.createDiv("scroll",this.structTabLR);
250     this.resizeDiv  = this.createDiv("resize",this.outerDiv,true);
251
252     this.messagePopup=new Rico.Popup();
253     this.messagePopup.createContainer({hideOnEscape:false, hideOnClick:false, parent:this.outerDiv});
254     this.messagePopup.content.className='ricoLG_messageDiv';
255     if (Rico.theme.gridMessage) Rico.addClass(this.messagePopup.content,Rico.theme.gridMessage);
256
257     this.keywordPopup=new Rico.Window('', {zIndex:-1, parent:this.outerDiv});
258     Rico.addClass(this.keywordPopup.container, 'ricoLG_keywordDiv');
259     var instructions=this.keywordPopup.contentDiv.appendChild(document.createElement("p"));
260     instructions.innerHTML=Rico.getPhraseById("keywordPrompt");
261     this.keywordBox=this.keywordPopup.contentDiv.appendChild(document.createElement("input"));
262     this.keywordBox.size=20;
263     Rico.eventBind(this.keywordBox,"keypress", Rico.eventHandle(this,'keywordKey'), false);
264     this.keywordPopup.contentDiv.appendChild(Rico.floatButton('Checkmark', Rico.eventHandle(this,'processKeyword')));
265     var s=this.keywordPopup.contentDiv.appendChild(document.createElement("p"));
266     Rico.setStyle(s,{clear:'both'});
267
268     //this.frozenTabs.style[this.align[0]]='0px';
269     //this.innerDiv.style[this.align[0]]='0px';
270     Rico.log("createDivs end");
271   },
272   
273   keywordKey: function(e) {
274     switch (Rico.eventKey(e)) {
275       case 27: this.closeKeyword(); Rico.eventStop(e); return false;
276       case 13: this.processKeyword(); Rico.eventStop(e); return false;
277     }
278     return true;
279   },
280   
281   openKeyword: function(colnum) {
282     this.keywordCol=colnum;
283     this.keywordBox.value='';
284     this.keywordPopup.setTitle(this.columns[colnum].displayName);
285     this.keywordPopup.centerPopup();
286     this.keywordBox.focus();
287   },
288   
289   closeKeyword: function() {
290     this.keywordPopup.closePopup();
291     this.cancelMenu();
292   },
293   
294   processKeyword: function() {
295     var keyword=this.keywordBox.value;
296     this.closeKeyword();
297     this.columns[this.keywordCol].setFilterKW(keyword);
298   },
299
300 /**
301  * Create a div and give it a standardized id and class name.
302  * If the div already exists, then just assign the class name.
303  */
304   createDiv: function(elemName,elemParent,hidden) {
305     var id=this.tableId+"_"+elemName+"Div";
306     var newdiv=document.getElementById(id);
307     if (!newdiv) {
308       newdiv = document.createElement("div");
309       newdiv.id = id;
310       if (elemParent) elemParent.appendChild(newdiv);
311     }
312     newdiv.className = "ricoLG_"+elemName+"Div";
313     if (hidden) Rico.hide(newdiv);
314     return newdiv;
315   },
316
317 /**
318  * Common code used to size & position divs in both SimpleGrid & LiveGrid
319  */
320   baseSizeDivs: function() {
321     this.setOtherHdrCellWidths();
322
323     if (this.options.frozenColumns) {
324       Rico.show(this.tabs[0]);
325       Rico.show(this.frozenTabs);
326       // order of next 3 lines is critical in IE6
327       this.hdrHt=Math.max(Rico.nan2zero(this.thead[0].offsetHeight),this.thead[1].offsetHeight);
328       this.dataHt=Math.max(Rico.nan2zero(this.tbody[0].offsetHeight),this.tbody[1].offsetHeight);
329       this.frzWi=this.borderWidth(this.tabs[0]);
330     } else {
331       Rico.hide(this.tabs[0]);
332       Rico.hide(this.frozenTabs);
333       this.frzWi=0;
334       this.hdrHt=this.thead[1].offsetHeight;
335       this.dataHt=this.tbody[1].offsetHeight;
336     }
337
338     var wiLimit,i;
339     var borderWi=this.borderWidth(this.columns[0].dataCell);
340     Rico.log('baseSizeDivs '+this.tableId+': hdrHt='+this.hdrHt+' dataHt='+this.dataHt);
341     Rico.log(this.tableId+' frzWi='+this.frzWi+' borderWi='+borderWi);
342     for (i=0; i<this.options.frozenColumns; i++) {
343       if (this.columns[i].visible) this.frzWi+=parseInt(this.columns[i].colWidth,10)+borderWi;
344     }
345     this.scrTabWi=this.borderWidth(this.tabs[1]);
346     this.scrTabWi0=this.scrTabWi;
347     Rico.log('scrTabWi: '+this.scrTabWi);
348     for (i=this.options.frozenColumns; i<this.columns.length; i++) {
349       if (this.columns[i].visible) this.scrTabWi+=parseInt(this.columns[i].colWidth,10)+borderWi;
350     }
351     this.scrWi=this.scrTabWi+this.options.scrollBarWidth;
352     if (this.sizeTo=='parent') {
353       if (Rico.isIE) Rico.hide(this.outerDiv);
354       wiLimit=this.outerDiv.parentNode.offsetWidth;
355       if (Rico.isIE) Rico.show(this.outerDiv);
356     }  else {
357       wiLimit=Rico.windowWidth()-this.options.scrollBarWidth-8;
358     }
359     if (this.outerDiv.parentNode.clientWidth > 0)
360       wiLimit=Math.min(this.outerDiv.parentNode.clientWidth, wiLimit);
361     var overage=this.frzWi+this.scrWi-wiLimit;
362     Rico.log('baseSizeDivs '+this.tableId+': scrWi='+this.scrWi+' wiLimit='+wiLimit+' overage='+overage+' clientWidth='+this.outerDiv.parentNode.clientWidth);
363     if (overage > 0 && this.options.frozenColumns < this.columns.length)
364       this.scrWi=Math.max(this.scrWi-overage, this.options.minScrollWidth);
365     this.scrollDiv.style.width=this.scrWi+'px';
366     //this.scrollDiv.style.top=this.hdrHt+'px';
367     //this.frozenTabs.style.width=this.scrollDiv.style[this.align[0]]=this.innerDiv.style[this.align[0]]=this.frzWi+'px';
368     this.frozenTabs.style.width=this.frzWi+'px';
369     this.outerDiv.style.width=(this.frzWi+this.scrWi)+'px';
370   },
371
372 /**
373  * Returns the sum of the left & right border widths of an element
374  */
375   borderWidth: function(elem) {
376     var l=Rico.nan2zero(Rico.getStyle(elem,'borderLeftWidth'));
377     var r=Rico.nan2zero(Rico.getStyle(elem,'borderRightWidth'));
378     Rico.log((elem.id || elem.tagName)+' borderWidth: L='+l+', R='+r);
379     return l + r;
380 //    return Rico.nan2zero(Rico.getStyle(elem,'borderLeftWidth')) + Rico.nan2zero(Rico.getStyle(elem,'borderRightWidth'));
381   },
382
383   setOtherHdrCellWidths: function() {
384     var c,i,j,r,w,hdrcell,cell,origSpan,newSpan,divs;
385     for (r=0; r<this.hdrCells.length; r++) {
386       if (r==this.headerRowIdx) continue;
387       Rico.log('setOtherHdrCellWidths: r='+r);
388       c=i=0;
389       while (i<this.headerColCnt && c<this.hdrCells[r].length) {
390         hdrcell=this.hdrCells[r][c];
391         cell=hdrcell.cell;
392         origSpan=newSpan=hdrcell.colSpan;
393         for (w=j=0; j<origSpan; j++, i++) {
394           if (this.columns[i].hdrCell.style.display=='none')
395             newSpan--;
396           else if (this.columns[i].hdrColDiv.style.display!='none')
397             w+=parseInt(this.columns[i].colWidth,10);
398         }
399         if (!hdrcell.hdrColDiv || !hdrcell.hdrCellDiv) {
400           divs=cell.getElementsByTagName('div');
401           hdrcell.hdrColDiv=(divs.length<1) ? Rico.wrapChildren(cell,'ricoLG_col') : divs[0];
402           hdrcell.hdrCellDiv=(divs.length<2) ? Rico.wrapChildren(hdrcell.hdrColDiv,'ricoLG_cell') : divs[1];
403         }
404         if (newSpan==0) {
405           cell.style.display='none';
406         } else if (w==0) {
407           hdrcell.hdrColDiv.style.display='none';
408           cell.colSpan=newSpan;
409         } else {
410           cell.style.display='';
411           hdrcell.hdrColDiv.style.display='';
412           cell.colSpan=newSpan;
413           hdrcell.hdrColDiv.style.width=w+'px';
414         }
415         c++;
416       }
417     }
418   },
419
420   initFilterImage: function(filterRowNum){
421     this.filterAnchor=document.getElementById(this.tableId+'_filterLink');
422     if (!this.filterAnchor) return;
423     this.filterRows=Rico.select('tr.'+this.tableId+'_hdg'+filterRowNum);
424     if (this.filterRows.length!=2) return;
425     for (var i=0, r=[]; i<2; i++) r[i]=Rico.select('.ricoLG_cell',this.filterRows[i]);
426     this.filterElements=r[0].concat(r[1]);
427     this.saveHeight = this.filterElements[0].offsetHeight;
428     var pt=Rico.getStyle(this.filterElements[0],'paddingTop');
429     var pb=Rico.getStyle(this.filterElements[0],'paddingBottom');
430     if (pt) this.saveHeight-=parseInt(pt,10);
431     if (pb) this.saveHeight-=parseInt(pb,10);
432     this.rowNum = filterRowNum;
433     this.setFilterImage(false);
434     //Rico.eventBind(this.filterAnchor, 'click', Rico.eventHandle(this,'toggleFilterRow'), false);
435   },
436
437   toggleFilterRow: function() {
438     if ( Rico.visible(this.filterRows[0]) )
439       this.slideFilterUp();
440     else
441       this.slideFilterDown();
442   },
443
444   setFilterImage: function(expandFlag) {
445     var altText=Rico.getPhraseById((expandFlag ? 'show' : 'hide')+'FilterRow');
446     this.filterAnchor.innerHTML = '<img src="'+Rico.imgDir+'tableFilter'+(expandFlag ? 'Expand' : 'Collapse')+'.gif" alt="'+altText+'" border="0">';
447   },
448
449 /**
450  * Returns a div for the cell at the specified row and column index.
451  * In SimpleGrid, r can refer to any row in the grid.
452  * In LiveGrid, r refers to a visible row (row 0 is the first visible row).
453  */
454   cell: function(r,c) {
455     return (0<=c && c<this.columns.length && r>=0) ? this.columns[c].cell(r) : null;
456   },
457
458 /**
459  * Returns the screen height available for a grid
460  */
461   availHt: function() {
462     var divPos=Rico.cumulativeOffset(this.outerDiv);
463     return Rico.windowHeight()-divPos.top-2*this.options.scrollBarWidth-15;  // allow for scrollbar and some margin
464   },
465
466   hideMsg: function() {
467     this.messagePopup.closePopup();
468   },
469
470   showMsg: function(msg) {
471     this.messagePopup.setContent(msg);
472     this.messagePopup.centerPopup();
473     Rico.log("showMsg: "+msg);
474   },
475
476 /**
477  * @return array of column objects which have invisible status
478  */
479   listInvisible: function(attr) {
480     var hiddenColumns=[];
481     for (var x=0;x<this.columns.length;x++) {
482       if (!this.columns[x].visible)
483         hiddenColumns.push(attr ? this.columns[x][attr] : this.columns[x]);
484     }
485     return hiddenColumns;
486   },
487
488 /**
489  * @return index of left-most visibile column, or -1 if there are no visible columns
490  */
491   firstVisible: function() {
492     for (var x=0;x<this.columns.length;x++) {
493       if (this.columns[x].visible) return x;
494     }
495     return -1;
496   },
497
498 /**
499  * Show all columns
500  */
501   showAll: function() {
502     var invisible=this.listInvisible();
503     for (var x=0;x<invisible.length;x++)
504       invisible[x].showColumn();
505   },
506   
507   chooseColumns: function() {
508     this.menu.cancelmenu();
509     var x,z,col,itemDiv,span,contentDiv;\r
510     if (!this.columnChooser) {
511       Rico.log('creating columnChooser');
512       z=Rico.getStyle(this.outerDiv.offsetParent,'zIndex');
513       if (typeof z!='number') z=0;
514       this.columnChooser=new Rico.Window(Rico.getPhraseById('gridChooseCols'), {zIndex:z+2, parent:this.outerDiv});
515       Rico.addClass(this.columnChooser.container, 'ricoLG_chooserDiv');
516       contentDiv=this.columnChooser.contentDiv;
517       for (x=0;x<this.columns.length;x++) {
518         col=this.columns[x];
519         itemDiv=contentDiv.appendChild(document.createElement('div'));
520         col.ChooserBox=Rico.createFormField(itemDiv,'input','checkbox');
521         span=itemDiv.appendChild(document.createElement('span'));
522         span.innerHTML=col.displayName;
523         Rico.eventBind(col.ChooserBox, 'click', Rico.eventHandle(col,'chooseColumn'), false);
524       }
525     }
526     Rico.log('opening columnChooser');
527     this.columnChooser.openPopup(3,this.hdrHt+3);
528     for (x=0;x<this.columns.length;x++) {
529       this.columns[x].ChooserBox.checked=this.columns[x].visible;
530       this.columns[x].ChooserBox.disabled = !this.columns[x].canHideShow();
531     }
532   },
533
534   blankRow: function(r) {
535     for (var c=0; c < this.columns.length; c++) {
536       this.columns[c].clearCell(r);
537     }
538   },
539   
540   getExportStyles: function(chkelem) {
541     var exportStyles=this.options.exportStyleList;
542     var bgImg=Rico.getStyle(chkelem,'backgroundImage');
543     if (!bgImg || bgImg=='none') return exportStyles;
544     for (var styles=[],i=0; i<exportStyles.length; i++)
545       if (exportStyles[i]!='background-color' && exportStyles[i]!='color') styles.push(exportStyles[i]);
546     return styles;
547   },
548
549 /**
550  * Support function for printVisible()
551  */
552   exportStart: function() {
553     var r,c,i,j,hdrcell,newSpan,divs,cell;
554     var exportStyles=this.getExportStyles(this.thead[0]);
555     //alert(exportStyles.join('\n'));
556     this.exportRows=[];
557     this.exportText="<html><head></head><body><table border='1' cellspacing='0'>";\r
558     for (c=0; c<this.columns.length; c++) {\r
559       if (this.columns[c].visible) this.exportText+="<col width='"+parseInt(this.columns[c].colWidth,10)+"'>";
560     }\r
561     this.exportText+="<thead style='display: table-header-group;'>";
562     if (this.exportHeader) this.exportText+=this.exportHeader;
563     for (r=0; r<this.hdrCells.length; r++) {
564       if (this.hdrCells[r].length==0 || !Rico.visible(this.hdrCells[r][0].cell.parentNode)) continue;
565       this.exportText+="<tr>";
566       for (c=0,i=0; c<this.hdrCells[r].length; c++) {
567         hdrcell=this.hdrCells[r][c];
568         newSpan=hdrcell.colSpan;
569         for (j=0; j<hdrcell.colSpan; j++, i++) {
570           if (!this.columns[i].visible) newSpan--;
571         }
572         if (newSpan > 0) {
573           divs=Rico.select('.ricoLG_cell',hdrcell.cell);
574           cell=divs && divs.length>0 ? divs[0] : hdrcell.cell;
575           this.exportText+="<td style='"+this.exportStyle(cell,exportStyles)+"'";
576           if (hdrcell.colSpan > 1) this.exportText+=" colspan='"+newSpan+"'";
577           this.exportText+=">"+Rico.getInnerText(cell,!this.options.exportImgTags, !this.options.exportFormFields, 'NoExport')+"</td>";
578         }
579       }
580       this.exportText+="</tr>";
581     }
582     this.exportText+="</thead><tbody>";
583   },
584
585 /**
586  * Support function for printVisible().
587  */
588   exportFinish: function() {
589     if (this.hideMsg) this.hideMsg();
590     window.status=Rico.getPhraseById('exportComplete');
591     if (this.exportRows.length > 0) this.exportText+='<tr>'+this.exportRows.join('</tr><tr>')+'</tr>';
592     if (this.exportFooter) this.exportText+=this.exportFooter;
593     this.exportText+="</tbody></table></body></html>";
594     if (this.cancelMenu) this.cancelMenu();
595     var w=window.open('','_blank',this.options.exportWindow);
596     if (w == null) {
597       alert(Rico.getPhraseById('disableBlocker'));
598     } else {
599       w.document.open();
600       w.document.write(this.exportText);
601       w.document.close();
602     }
603     this.exportText=undefined;
604     this.exportRows=undefined;
605   },
606
607 /**
608  * Support function for printVisible()
609  */
610   exportStyle: function(elem,styleList) {
611     for (var i=0,s=''; i < styleList.length; i++) {
612       try {
613         var curstyle=Rico.getStyle(elem,styleList[i]);
614         if (curstyle) s+=styleList[i]+':'+curstyle+';';
615       } catch(e) {};
616     }
617     return s;
618   },
619
620 /**
621  * Gets the value of the grid cookie and interprets the contents.
622  * All information for a particular grid is stored in a single cookie.
623  * This may include column widths, column hide/show status, current sort, and any column filters.
624  */
625   getCookie: function() {
626     var c=Rico.getCookie(this.options.cookiePrefix+this.tableId);
627     if (!c) return;
628     var cookieVals=c.split(',');
629     for (var i=0; i<cookieVals.length; i++) {
630       var v=cookieVals[i].split(':');
631       if (v.length!=2) continue;
632       var colnum=parseInt(v[0].slice(1),10);
633       if (colnum < 0 || colnum >= this.columns.length) continue;
634       var col=this.columns[colnum];
635       switch (v[0].charAt(0)) {
636         case 'w':
637           col.setColWidth(v[1]);
638           col.customWidth=true;
639           break;
640         case 'h':
641           if (v[1].toLowerCase()=='true')
642             col.hideshow(true,true);
643           else
644             col.hideshow(false,true);
645           break;
646         case 's':
647           if (!this.options.saveColumnInfo.sort || !col.sortable) break;
648           col.setSorted(v[1]);
649           break;
650         case 'f':
651           if (!this.options.saveColumnInfo.filter || !col.filterable) break;
652           var filterTemp=v[1].split('~');
653           col.filterOp=filterTemp.shift();
654           col.filterValues = [];
655           col.filterType = Rico.ColumnConst.USERFILTER;
656           for (var j=0; j<filterTemp.length; j++)
657             col.filterValues.push(unescape(filterTemp[j]));
658           break;
659       }
660     }
661   },
662
663 /**
664  * Sets the grid cookie.
665  * All information for a particular grid is stored in a single cookie.
666  * This may include column widths, column hide/show status, current sort, and any column filters.
667  */
668   setCookie: function() {
669     var cookieVals=[];
670     for (var i=0; i<this.columns.length; i++) {
671       var col=this.columns[i];
672       if (this.options.saveColumnInfo.width) {
673         if (col.customWidth) cookieVals.push('w'+i+':'+col.colWidth);
674         if (col.customVisible) cookieVals.push('h'+i+':'+col.visible);
675       }
676       if (this.options.saveColumnInfo.sort) {
677         if (col.currentSort != Rico.ColumnConst.UNSORTED)
678           cookieVals.push('s'+i+':'+col.currentSort);
679       }
680       if (this.options.saveColumnInfo.filter && col.filterType == Rico.ColumnConst.USERFILTER) {
681         var filterTemp=[col.filterOp];
682         for (var j=0; j<col.filterValues.length; j++)
683           filterTemp.push(escape(col.filterValues[j]));
684         cookieVals.push('f'+i+':'+filterTemp.join('~'));
685       }
686     }
687     Rico.setCookie(this.options.cookiePrefix+this.tableId, cookieVals.join(','), this.options.cookieDays, this.options.cookiePath, this.options.cookieDomain);
688   }
689
690 };
691
692
693 Rico.ColumnConst = {
694   UNFILTERED:   0,
695   SYSTEMFILTER: 1,
696   USERFILTER:   2,
697
698   UNSORTED:  0,
699   SORT_ASC:  "ASC",
700   SORT_DESC: "DESC",
701
702   MINWIDTH: 10
703 }
704
705
706 /**
707  * @class Define methods that are common to columns in both SimpleGrid and LiveGrid
708  */
709 Rico.TableColumnBase = function() {};
710
711 Rico.TableColumnBase.prototype = {
712
713 /**
714  * Common code used to initialize the column in both SimpleGrid & LiveGrid
715  */
716   baseInit: function(liveGrid,colIdx,hdrInfo,tabIdx) {
717     Rico.log("TableColumnBase.baseInit index="+colIdx+" tabIdx="+tabIdx);
718     this.liveGrid  = liveGrid;
719     this.index     = colIdx;
720     this.hideWidth = Rico.isKonqueror || Rico.isWebKit || liveGrid.headerRowCnt>1 ? 5 : 2;  // column width used for "hidden" columns. Anything less than 5 causes problems with Konqueror. Best to keep this greater than padding used inside cell.
721     this.options   = liveGrid.options;
722     this.tabIdx    = tabIdx;
723     this.hdrCell   = hdrInfo.cell;
724     this.body = document.getElementsByTagName("body")[0];
725     this.displayName  = this.getDisplayName(this.hdrCell);
726     var divs=this.hdrCell.getElementsByTagName('div');
727     this.hdrColDiv=(divs.length<1) ? Rico.wrapChildren(this.hdrCell,'ricoLG_col') : divs[0];
728     this.hdrCellDiv=(divs.length<2) ? Rico.wrapChildren(this.hdrColDiv,'ricoLG_cell') : divs[1];
729     var sectionIndex= tabIdx==0 ? colIdx : colIdx-liveGrid.options.frozenColumns;
730     this.dataCell = liveGrid.tbody[tabIdx].rows[0].cells[sectionIndex];
731     divs=this.dataCell.getElementsByTagName('div');
732     this.dataColDiv=(divs.length<1) ? Rico.wrapChildren(this.dataCell,'ricoLG_col') : divs[0];
733
734     this.mouseDownHandler= Rico.eventHandle(this,'handleMouseDown');
735     this.mouseMoveHandler= Rico.eventHandle(this,'handleMouseMove');
736     this.mouseUpHandler  = Rico.eventHandle(this,'handleMouseUp');
737     this.mouseOutHandler = Rico.eventHandle(this,'handleMouseOut');
738
739     this.format={type:"text"};
740     var spec = liveGrid.options.columnSpecs[colIdx];
741     if (typeof spec == 'object') Rico.extend(this.format, spec);
742     Rico.addClass(this.dataColDiv, this.colClassName());
743     this.visible=true;
744     if (typeof this.format.visible=='boolean') this.visible=this.format.visible;
745     this.sortable     = typeof this.format.canSort=='boolean' ? this.format.canSort : liveGrid.options.canSortDefault;
746     this.currentSort  = Rico.ColumnConst.UNSORTED;
747     this.filterable   = typeof this.format.canFilter=='boolean' ? this.format.canFilter : liveGrid.options.canFilterDefault;
748     this.filterType   = Rico.ColumnConst.UNFILTERED;
749     this.hideable     = typeof this.format.canHide=='boolean' ? this.format.canHide : liveGrid.options.canHideDefault;
750
751     var wi;
752     switch (typeof this.format.width) {
753       case 'number': wi=this.format.width; break;
754       case 'string': wi=parseInt(this.format.width,10); break;
755       default:       wi=hdrInfo.initWidth; break;
756     }
757     wi=(typeof(wi)=='number') ? Math.max(wi,Rico.ColumnConst.MINWIDTH) : liveGrid.options.defaultWidth;
758     this.setColWidth(wi);
759     if (!this.visible) this.setDisplay('none');
760   },
761   
762   colClassName: function() {
763     return this.format.ClassName ? this.format.ClassName : this.liveGrid.tableId+'_col'+this.index;
764   },
765
766   insertResizer: function() {
767     //this.hdrCell.style.width='';
768     if (this.format.noResize) return;
769     var resizer=document.createElement('div');
770     resizer.className='ricoLG_Resize';
771     resizer.style[this.liveGrid.align[1]]='0px';
772     this.hdrCellDiv.appendChild(resizer);
773     Rico.eventBind(resizer,"mousedown", this.mouseDownHandler, false);
774   },
775
776 /**
777  * get the display name of a column
778  */
779   getDisplayName: function(el) {
780     var anchors=el.getElementsByTagName("A");
781     var s=anchors.length > 0 ? anchors[0].innerHTML : Rico.stripTags(el.innerHTML);
782     return Rico.trim(s);
783   },
784
785   _clear: function(gridCell) {
786     gridCell.innerHTML='&nbsp;';
787   },
788
789   clearCell: function(rowIndex) {
790     var gridCell=this.cell(rowIndex);
791     this._clear(gridCell,rowIndex);
792     if (this.liveGrid.buffer && this.liveGrid.buffer.options.acceptStyle) gridCell.style.cssText='';
793   },
794
795   dataTable: function() {
796     return this.liveGrid.tabs[this.tabIdx];
797   },
798
799   numRows: function() {
800     return this.dataColDiv.childNodes.length;
801   },
802
803   clearColumn: function() {
804     var childCnt=this.numRows();
805     for (var r=0; r<childCnt; r++)
806       this.clearCell(r);
807   },
808
809   cell: function(r) {
810     return this.dataColDiv.childNodes[r];
811   },
812
813   getFormattedValue: function(r,xImg,xForm,xClass) {
814     return Rico.getInnerText(this.cell(r),xImg,xForm,xClass);
815   },
816
817   setColWidth: function(wi) {
818     if (typeof wi=='number') {
819       wi=parseInt(wi,10);
820       if (wi < Rico.ColumnConst.MINWIDTH) return;
821       wi=wi+'px';
822     }
823     Rico.log('setColWidth '+this.index+': '+wi);
824     this.colWidth=wi;
825     this.hdrColDiv.style.width=wi;
826     this.dataColDiv.style.width=wi;
827   },
828
829   pluginMouseEvents: function() {
830     if (this.mousePluggedIn==true) return;
831     Rico.eventBind(this.body,"mousemove", this.mouseMoveHandler, false);
832     Rico.eventBind(this.body,"mouseup",   this.mouseUpHandler  , false);
833     Rico.eventBind(this.body,"mouseout",  this.mouseOutHandler , false);
834     this.mousePluggedIn=true;
835   },
836
837   unplugMouseEvents: function() {
838     Rico.eventUnbind(this.body,"mousemove", this.mouseMoveHandler, false);
839     Rico.eventUnbind(this.body,"mouseup",   this.mouseUpHandler  , false);
840     Rico.eventUnbind(this.body,"mouseout",  this.mouseOutHandler , false);
841     this.mousePluggedIn=false;
842   },
843
844   handleMouseDown: function(e) {
845     this.resizeStart=Rico.eventClient(e).x;
846     this.origWidth=parseInt(this.colWidth,10);
847     var p=Rico.positionedOffset(this.hdrCell);
848     if (this.liveGrid.direction=='rtl') {
849       this.edge=p.left;
850       switch (this.tabIdx) {
851         case 0: this.edge+=this.liveGrid.innerDiv.offsetWidth; break;
852         case 1: this.edge-=this.liveGrid.scrollDiv.scrollLeft; break;
853       }
854     } else {
855       this.edge=p.left+this.hdrCell.offsetWidth;
856       if (this.tabIdx>0) this.edge+=Rico.nan2zero(this.liveGrid.tabs[0].offsetWidth);
857     }
858     this.liveGrid.resizeDiv.style.left=this.edge+"px";
859     this.liveGrid.resizeDiv.style.display="";
860     this.liveGrid.outerDiv.style.cursor='e-resize';
861     this.tmpHighlight=this.liveGrid.highlightEnabled;
862     this.liveGrid.highlightEnabled=false;
863     this.pluginMouseEvents();
864     Rico.eventStop(e);
865   },
866
867   handleMouseMove: function(e) {
868     var delta=Rico.eventClient(e).x-this.resizeStart;
869     var newWidth=(this.liveGrid.direction=='rtl') ? this.origWidth-delta : this.origWidth+delta;
870     if (newWidth < Rico.ColumnConst.MINWIDTH) return;
871     this.liveGrid.resizeDiv.style.left=(this.edge+delta)+"px";
872     this.colWidth=newWidth;
873     Rico.eventStop(e);
874   },
875
876   handleMouseUp: function(e) {
877     this.unplugMouseEvents();
878     Rico.log('handleMouseUp '+this.liveGrid.tableId);
879     this.liveGrid.outerDiv.style.cursor='';
880     this.liveGrid.resizeDiv.style.display="none";
881     this.setColWidth(this.colWidth);
882     this.customWidth=true;
883     this.liveGrid.setCookie();
884     this.liveGrid.highlightEnabled=this.tmpHighlight;
885     this.liveGrid.sizeDivs();
886     Rico.eventStop(e);
887   },
888
889   handleMouseOut: function(e) {
890     var reltg = Rico.eventRelatedTarget(e) || e.toElement;
891     while (reltg != null && reltg.nodeName.toLowerCase() != 'body')
892       reltg=reltg.parentNode;
893     if (reltg!=null && reltg.nodeName.toLowerCase() == 'body') return true;
894     this.handleMouseUp(e);
895     return true;
896   },
897
898   setDisplay: function(d) {
899     this.hdrCell.style.display=d;
900     this.hdrColDiv.style.display=d;
901     this.dataCell.style.display=d;
902     this.dataColDiv.style.display=d;
903   },
904   
905   hideshow: function(visible,noresize) {
906     this.setDisplay(visible ? '' : 'none');
907     this.liveGrid.cancelMenu();
908     this.visible=visible;
909     this.customVisible=true;
910     if (noresize) return;
911     this.liveGrid.setCookie();
912     this.liveGrid.sizeDivs();
913   },
914
915   hideColumn: function() {
916     Rico.log('hideColumn '+this.liveGrid.tableId);
917     this.hideshow(false,false);
918   },
919
920   showColumn: function() {
921     Rico.log('showColumn '+this.liveGrid.tableId);
922     this.hideshow(true,false);
923   },
924
925   chooseColumn: function(e) {
926     var elem=Rico.eventElement(e);
927     this.hideshow(elem.checked,false);
928   },
929
930   setImage: function() {
931     if ( this.currentSort == Rico.ColumnConst.SORT_ASC ) {
932        this.imgSort.style.display='inline-block';
933        this.imgSort.className=Rico.theme.sortAsc || 'rico-icon ricoLG_sortAsc';
934     } else if ( this.currentSort == Rico.ColumnConst.SORT_DESC ) {
935        this.imgSort.style.display='inline-block';
936        this.imgSort.className=Rico.theme.sortDesc || 'rico-icon ricoLG_sortDesc';
937     } else {
938        this.imgSort.style.display='none';
939     }
940     if (this.filterType == Rico.ColumnConst.USERFILTER) {
941        this.imgFilter.style.display='inline-block';
942        this.imgFilter.title=this.getFilterText();
943     } else {
944        this.imgFilter.style.display='none';
945     }
946   },
947
948   canHideShow: function() {
949     return this.hideable;
950   }
951
952 };