Open-ILS/xul/staff_client/chrome/content/util/list.js

   1 dump('entering util.list.js\n');
   2
   3 if (typeof main == 'undefined') main = {};
   4 util.list = function (id) {
   5
   6         this.node = document.getElementById(id);
   7
   8         if (!this.node) throw('Could not find element ' + id);
   9         switch(this.node.nodeName) {
  10                 case 'listbox' :
  11                 case 'tree' : break;
  12                 case 'richlistbox' :
  13                         throw(this.node.nodeName + ' not yet supported'); break;
  14                 default: throw(this.node.nodeName + ' not supported'); break;
  15         }
  16
  17         JSAN.use('util.error'); this.error = new util.error();
  18
  19         return this;
  20 };
  21
  22 util.list.prototype = {
  23
  24         'init' : function (params) {
  25
  26                 JSAN.use('util.widgets');
  27
  28                 if (typeof params.map_row_to_column == 'function') this.map_row_to_column = params.map_row_to_column;
  29                 if (typeof params.retrieve_row == 'function') this.retrieve_row = params.retrieve_row;
  30
  31                 this.prebuilt = false;
  32                 if (typeof params.prebuilt != 'undefined') this.prebuilt = params.prebuilt;
  33
  34                 if (typeof params.columns == 'undefined') throw('util.list.init: No columns');
  35                 this.columns = params.columns;
  36
  37                 switch(this.node.nodeName) {
  38                         case 'tree' : this._init_tree(params); break;
  39                         case 'listbox' : this._init_listbox(params); break;
  40                         default: throw('NYI: Need ._init() for ' + this.node.nodeName); break;
  41                 }
  42         },
  43
  44         '_init_tree' : function (params) {
  45                 var obj = this;
  46                 if (this.prebuilt) {
  47
  48                         this.treechildren = this.node.lastChild;
  49
  50                 } else {
  51                         var treecols = document.createElement('treecols');
  52                         this.node.appendChild(treecols);
  53
  54                         for (var i = 0; i < this.columns.length; i++) {
  55                                 var treecol = document.createElement('treecol');
  56                                 for (var j in this.columns[i]) {
  57                                         treecol.setAttribute(j,this.columns[i][j]);
  58                                 }
  59                                 treecols.appendChild(treecol);
  60                                 var splitter = document.createElement('splitter');
  61                                 splitter.setAttribute('class','tree-splitter');
  62                                 treecols.appendChild(splitter);
  63                         }
  64
  65                         var treechildren = document.createElement('treechildren');
  66                         this.node.appendChild(treechildren);
  67                         this.treechildren = treechildren;
  68                 }
  69                 if (typeof params.on_select == 'function') {
  70                         this.node.addEventListener(
  71                                 'select',
  72                                 params.on_select,
  73                                 false
  74                         );
  75                 }
  76                 if (typeof params.on_click == 'function') {
  77                         this.node.addEventListener(
  78                                 'click',
  79                                 params.on_click,
  80                                 false
  81                         );
  82                 }
  83                 /*
  84                 this.node.addEventListener(
  85                         'mousemove',
  86                         function(ev) { obj.detect_visible(); },
  87                         false
  88                 );
  89                 */
  90                 this.node.addEventListener(
  91                         'keypress',
  92                         function(ev) { obj.auto_retrieve(); },
  93                         false
  94                 );
  95                 this.node.addEventListener(
  96                         'click',
  97                         function(ev) { obj.auto_retrieve(); },
  98                         false
  99                 );
 100                 window.addEventListener(
 101                         'resize',
 102                         function(ev) { obj.auto_retrieve(); },
 103                         false
 104                 );
 105                 /* FIXME -- find events on scrollbar to trigger this */
 106                 //obj.detect_visible_polling();
 107                 /*
 108                 var scrollbar = document.getAnonymousNodes( document.getAnonymousNodes(this.node)[1] )[1];
 109                 var slider = document.getAnonymousNodes( scrollbar )[2];
 110                 alert('scrollbar = ' + scrollbar.nodeName + ' grippy = ' + slider.nodeName);
 111                 scrollbar.addEventListener('click',function(){alert('sb click');},false);
 112                 scrollbar.addEventListener('command',function(){alert('sb command');},false);
 113                 scrollbar.addEventListener('scroll',function(){alert('sb scroll');},false);
 114                 slider.addEventListener('click',function(){alert('slider click');},false);
 115                 slider.addEventListener('command',function(){alert('slider command');},false);
 116                 slider.addEventListener('scroll',function(){alert('slider scroll');},false);
 117                 */
 118                 this.node.addEventListener('scroll',function(){ obj.auto_retrieve(); },false);
 119         },
 120
 121         '_init_listbox' : function (params) {
 122                 if (this.prebuilt) {
 123                 } else {
 124                         var listhead = document.createElement('listhead');
 125                         this.node.appendChild(listhead);
 126
 127                         var listcols = document.createElement('listcols');
 128                         this.node.appendChild(listcols);
 129
 130                         for (var i = 0; i < this.columns.length; i++) {
 131                                 var listheader = document.createElement('listheader');
 132                                 listhead.appendChild(listheader);
 133                                 var listcol = document.createElement('listcol');
 134                                 listcols.appendChild(listcol);
 135                                 for (var j in this.columns[i]) {
 136                                         listheader.setAttribute(j,this.columns[i][j]);
 137                                         listcol.setAttribute(j,this.columns[i][j]);
 138                                 };
 139                         }
 140                 }
 141         },
 142
 143         'clear' : function (params) {
 144                 switch (this.node.nodeName) {
 145                         case 'tree' : this._clear_tree(params); break;
 146                         case 'listbox' : this._clear_listbox(params); break;
 147                         default: throw('NYI: Need .clear() for ' + this.node.nodeName); break;
 148                 }
 149                 this.error.sdump('D_LIST','Clearing list ' + this.node.getAttribute('id') + '\n');
 150         },
 151
 152         '_clear_tree' : function(params) {
 153                 var obj = this;
 154                 if (obj.error.sdump_levels.D_LIST_DUMP_ON_CLEAR) {
 155                         obj.error.sdump('D_LIST_DUMP_ON_CLEAR',obj.dump());
 156                 }
 157                 if (obj.error.sdump_levels.D_LIST_DUMP_WITH_KEYS_ON_CLEAR) {
 158                         obj.error.sdump('D_LIST_DUMP_WITH_KEYS_ON_CLEAR',obj.dump_with_keys());
 159                 }
 160                 while (obj.treechildren.lastChild) obj.treechildren.removeChild( obj.treechildren.lastChild );
 161         },
 162
 163         '_clear_listbox' : function(params) {
 164                 var items = [];
 165                 var nl = this.node.getElementsByTagName('listitem');
 166                 for (var i = 0; i < nl.length; i++) {
 167                         items.push( nl[i] );
 168                 }
 169                 for (var i = 0; i < items.length; i++) {
 170                         this.node.removeChild(items[i]);
 171                 }
 172         },
 173
 174         'append' : function (params) {
 175                 var rnode;
 176                 switch (this.node.nodeName) {
 177                         case 'tree' : rnode = this._append_to_tree(params); break;
 178                         case 'listbox' : rnode = this._append_to_listbox(params); break;
 179                         default: throw('NYI: Need .append() for ' + this.node.nodeName); break;
 180                 }
 181                 if (rnode && params.attributes) {
 182                         for (var i in params.attributes) {
 183                                 rnode.setAttribute(i,params.attributes[i]);
 184                         }
 185                 }
 186                 return rnode;
 187         },
 188
 189         '_append_to_tree' : function (params) {
 190
 191                 var obj = this;
 192
 193                 if (typeof params.row == 'undefined') throw('util.list.append: Object must contain a row');
 194
 195                 var s = ('util.list.append: params = ' + (params) + '\n');
 196
 197                 var treechildren_node = this.treechildren;
 198
 199                 if (params.node && params.node.nodeName == 'treeitem') {
 200                         params.node.setAttribute('container','true'); /* params.node.setAttribute('open','true'); */
 201                         if (params.node.lastChild.nodeName == 'treechildren') {
 202                                 treechildren_node = params.node.lastChild;
 203                         } else {
 204                                 treechildren_node = document.createElement('treechildren');
 205                                 params.node.appendChild(treechildren_node);
 206                         }
 207                 }
 208
 209                 var treeitem = document.createElement('treeitem');
 210                 treeitem.setAttribute('retrieve_id',params.retrieve_id);
 211                 treechildren_node.appendChild( treeitem );
 212                 var treerow = document.createElement('treerow');
 213                 treeitem.appendChild( treerow );
 214
 215                 s += ('tree = ' + this.node + '  treechildren = ' + treechildren_node + '\n');
 216                 s += ('treeitem = ' + treeitem + '  treerow = ' + treerow + '\n');
 217
 218                 if (typeof params.retrieve_row == 'function' || typeof this.retrieve_row == 'function') {
 219
 220                         treerow.setAttribute('retrieve_id',params.retrieve_id);
 221                         obj.put_retrieving_label(treerow);
 222                         treerow.addEventListener(
 223                                 'flesh',
 224                                 function() {
 225                                         //dump('fleshing = ' + params.retrieve_id + '\n');
 226                                         var row;
 227
 228                                         params.row_node = treeitem;
 229                                         params.on_retrieve = function(row) {
 230                                                 params.row = row;
 231                                                 obj._map_row_to_treecell(params,treerow);
 232                                         }
 233
 234                                         if (typeof params.retrieve_row == 'function') {
 235
 236                                                 row = params.retrieve_row( params );
 237
 238                                         } else {
 239
 240                                                 if (typeof obj.retrieve_row == 'function') {
 241
 242                                                         row = obj.retrieve_row( params );
 243
 244                                                 }
 245                                         }
 246
 247                                         treerow.setAttribute('retrieved','true');
 248                                 },
 249                                 false
 250                         );
 251                         /*
 252                         setTimeout(
 253                                 function() {
 254                                         util.widgets.dispatch('flesh',treerow);
 255                                 }, 0
 256                         );
 257                         */
 258                 } else {
 259                         obj.put_retrieving_label(treerow);
 260                         treerow.addEventListener(
 261                                 'flesh',
 262                                 function() {
 263                                         //dump('fleshing anon\n');
 264                                         obj._map_row_to_treecell(params,treerow);
 265                                         treerow.setAttribute('retrieved','true');
 266                                 },
 267                                 false
 268                         );
 269                         /*
 270                         setTimeout(
 271                                 function() {
 272                                         util.widgets.dispatch('flesh',treerow);
 273                                 }, 0
 274                         );
 275                         */
 276                 }
 277                 this.error.sdump('D_LIST',s);
 278
 279                 setTimeout( function() { obj.auto_retrieve(); }, 0 );
 280
 281                 return treeitem;
 282         },
 283
 284         'put_retrieving_label' : function(treerow) {
 285                 var obj = this;
 286                 try {
 287                         /*
 288                         var cols_idx = 0;
 289                         dump('put_retrieving_label.  columns = ' + js2JSON(obj.columns) + '\n');
 290                         while( obj.columns[cols_idx] && obj.columns[cols_idx].hidden && obj.columns[cols_idx].hidden == 'true') {
 291                                 dump('\t' + cols_idx);
 292                                 var treecell = document.createElement('treecell');
 293                                 treerow.appendChild(treecell);
 294                                 cols_idx++;
 295                         }
 296                         */
 297                         for (var i = 0; i < obj.columns.length; i++) {
 298                         var treecell = document.createElement('treecell'); treecell.setAttribute('label','Retrieving...');
 299                         treerow.appendChild(treecell);
 300                         }
 301                         /*
 302                         dump('\t' + cols_idx + '\n');
 303                         */
 304                 } catch(E) {
 305                         alert(E);
 306                 }
 307         },
 308
 309         'detect_visible' : function() {
 310                 try {
 311                         var obj = this;
 312                         //dump('detect_visible  obj.node = ' + obj.node + '\n');
 313                         /* FIXME - this is a hack.. if the implementation of tree changes, this could break */
 314                         var scrollbar = document.getAnonymousNodes( document.getAnonymousNodes(obj.node)[1] )[1];
 315                         var curpos = scrollbar.getAttribute('curpos');
 316                         var maxpos = scrollbar.getAttribute('maxpos');
 317                         //alert('curpos = ' + curpos + ' maxpos = ' + maxpos + ' obj.curpos = ' + obj.curpos + ' obj.maxpos = ' + obj.maxpos + '\n');
 318                         if ((curpos != obj.curpos) || (maxpos != obj.maxpos)) {
 319                                 if ( obj.auto_retrieve() > 0 ) {
 320                                         obj.curpos = curpos; obj.maxpos = maxpos;
 321                                 }
 322                         }
 323                 } catch(E) { alert(E); }
 324         },
 325
 326         'detect_visible_polling' : function() {
 327                 try {
 328                         //alert('detect_visible_polling');
 329                         var obj = this;
 330                         obj.detect_visible();
 331                         setTimeout(function() { try { obj.detect_visible_polling(); } catch(E) { alert(E); } },2000);
 332                 } catch(E) {
 333                         alert(E);
 334                 }
 335         },
 336
 337         'auto_retrieve' : function () {
 338                 var obj = this;
 339                 if (!obj.auto_retrieve_in_progress) {
 340                         obj.auto_retrieve_in_progress = true;
 341                         setTimeout(
 342                                 function() {
 343                                         try {
 344                                                         //alert('auto_retrieve\n');
 345                                                         var count = 0;
 346                                                         var startpos = obj.node.treeBoxObject.getFirstVisibleRow();
 347                                                         var endpos = obj.node.treeBoxObject.getLastVisibleRow();
 348                                                         if (startpos > endpos) endpos = obj.node.treeBoxObject.getPageLength();
 349                                                         //dump('startpos = ' + startpos + ' endpos = ' + endpos + '\n');
 350                                                         for (var i = startpos; i < endpos + 2; i++) {
 351                                                                 try {
 352                                                                         //dump('trying index ' + i + '\n');
 353                                                                         var item = obj.node.contentView.getItemAtIndex(i).firstChild;
 354                                                                         if (item && item.getAttribute('retrieved') != 'true' ) {
 355                                                                                 //dump('\tgot an unfleshed item = ' + item + ' = ' + item.nodeName + '\n');
 356                                                                                 util.widgets.dispatch('flesh',item); count++;
 357                                                                         }
 358                                                                 } catch(E) {
 359                                                                         //dump(i + ' : ' + E + '\n');
 360                                                                 }
 361                                                         }
 362                                                         obj.auto_retrieve_in_progress = false;
 363                                                         return count;
 364                                         } catch(E) { alert(E); }
 365                                 }, 1
 366                         );
 367                 }
 368         },
 369
 370         '_append_to_listbox' : function (params) {
 371
 372                 var obj = this;
 373
 374                 if (typeof params.row == 'undefined') throw('util.list.append: Object must contain a row');
 375
 376                 var s = ('util.list.append: params = ' + (params) + '\n');
 377
 378                 var listitem = document.createElement('listitem');
 379
 380                 s += ('listbox = ' + this.node + '  listitem = ' + listitem + '\n');
 381
 382                 if (typeof params.retrieve_row == 'function' || typeof this.retrieve_row == 'function') {
 383
 384                         setTimeout(
 385                                 function() {
 386                                         listitem.setAttribute('retrieve_id',params.retrieve_id);
 387                                         //FIXME//Make async and fire when row is visible in list
 388                                         var row;
 389
 390                                         params.row_node = listitem;
 391                                         params.on_retrieve = function(row) {
 392                                                 params.row = row;
 393                                                 obj._map_row_to_listcell(params,listitem);
 394                                                 obj.node.appendChild( listitem );
 395                                         }
 396
 397                                         if (typeof params.retrieve_row == 'function') {
 398
 399                                                 row = params.retrieve_row( params );
 400
 401                                         } else {
 402
 403                                                 if (typeof obj.retrieve_row == 'function') {
 404
 405                                                         row = obj.retrieve_row( params );
 406
 407                                                 }
 408                                         }
 409                                 }, 0
 410                         );
 411                 } else {
 412                         this._map_row_to_listcell(params,listitem);
 413                         this.node.appendChild( listitem );
 414                 }
 415
 416                 this.error.sdump('D_LIST',s);
 417                 return listitem;
 418
 419         },
 420
 421         '_map_row_to_treecell' : function(params,treerow) {
 422                 var s = '';
 423                 util.widgets.remove_children(treerow);
 424                 for (var i = 0; i < this.columns.length; i++) {
 425                         var treecell = document.createElement('treecell');
 426                         var label = '';
 427                         if (params.skip_columns && (params.skip_columns.indexOf(i) != -1)) {
 428                                 treecell.setAttribute('label',label);
 429                                 treerow.appendChild( treecell );
 430                                 s += ('treecell = ' + treecell + ' with label = ' + label + '\n');
 431                                 continue;
 432                         }
 433                         if (params.skip_all_columns_except && (params.skip_all_columns_except.indexOf(i) == -1)) {
 434                                 treecell.setAttribute('label',label);
 435                                 treerow.appendChild( treecell );
 436                                 s += ('treecell = ' + treecell + ' with label = ' + label + '\n');
 437                                 continue;
 438                         }
 439                         if (typeof params.map_row_to_column == 'function')  {
 440
 441                                 label = params.map_row_to_column(params.row,this.columns[i]);
 442
 443                         } else {
 444
 445                                 if (typeof this.map_row_to_column == 'function') {
 446
 447                                         label = this.map_row_to_column(params.row,this.columns[i]);
 448
 449                                 } else {
 450
 451                                         throw('No map_row_to_column function');
 452
 453                                 }
 454                         }
 455                         treecell.setAttribute('label',label);
 456                         treerow.appendChild( treecell );
 457                         s += ('treecell = ' + treecell + ' with label = ' + label + '\n');
 458                 }
 459                 this.error.sdump('D_LIST',s);
 460         },
 461
 462         '_map_row_to_listcell' : function(params,listitem) {
 463                 var s = '';
 464                 for (var i = 0; i < this.columns.length; i++) {
 465                         var value = '';
 466                         if (typeof params.map_row_to_column == 'function')  {
 467
 468                                 value = params.map_row_to_column(params.row,this.columns[i]);
 469
 470                         } else {
 471
 472                                 if (typeof this.map_row_to_column == 'function') {
 473
 474                                         value = this.map_row_to_column(params.row,this.columns[i]);
 475                                 }
 476                         }
 477                         if (typeof value == 'string' || typeof value == 'number') {
 478                                 var listcell = document.createElement('listcell');
 479                                 listcell.setAttribute('label',value);
 480                                 listitem.appendChild(listcell);
 481                                 s += ('listcell = ' + listcell + ' with label = ' + value + '\n');
 482                         } else {
 483                                 listitem.appendChild(value);
 484                                 s += ('listcell = ' + value + ' is really a ' + value.nodeName + '\n');
 485                         }
 486                 }
 487                 this.error.sdump('D_LIST',s);
 488         },
 489
 490         'retrieve_selection' : function(params) {
 491                 switch(this.node.nodeName) {
 492                         case 'tree' : return this._retrieve_selection_from_tree(params); break;
 493                         default: throw('NYI: Need ._retrieve_selection_from_() for ' + this.node.nodeName); break;
 494                 }
 495         },
 496
 497         '_retrieve_selection_from_tree' : function(params) {
 498                 var list = [];
 499                 var start = new Object();
 500                 var end = new Object();
 501                 var numRanges = this.node.view.selection.getRangeCount();
 502                 for (var t=0; t<numRanges; t++){
 503                         this.node.view.selection.getRangeAt(t,start,end);
 504                         for (var v=start.value; v<=end.value; v++){
 505                                 var i = this.node.contentView.getItemAtIndex(v);
 506                                 list.push( i );
 507                         }
 508                 }
 509                 return list;
 510         },
 511
 512         'dump' : function(params) {
 513                 switch(this.node.nodeName) {
 514                         case 'tree' : return this._dump_tree(params); break;
 515                         default: throw('NYI: Need .dump() for ' + this.node.nodeName); break;
 516                 }
 517         },
 518
 519         '_dump_tree' : function(params) {
 520                 var dump = [];
 521                 for (var i = 0; i < this.treechildren.childNodes.length; i++) {
 522                         var row = [];
 523                         var treeitem = this.treechildren.childNodes[i];
 524                         var treerow = treeitem.firstChild;
 525                         for (var j = 0; j < treerow.childNodes.length; j++) {
 526                                 row.push( treerow.childNodes[j].getAttribute('label') );
 527                         }
 528                         dump.push( row );
 529                 }
 530                 return dump;
 531         },
 532
 533         'dump_with_keys' : function(params) {
 534                 switch(this.node.nodeName) {
 535                         case 'tree' : return this._dump_tree_with_keys(params); break;
 536                         default: throw('NYI: Need .dump_with_keys() for ' + this.node.nodeName); break;
 537                 }
 538
 539         },
 540
 541         '_dump_tree_with_keys' : function(params) {
 542                 var obj = this;
 543                 var dump = [];
 544                 for (var i = 0; i < this.treechildren.childNodes.length; i++) {
 545                         var row = {};
 546                         var treeitem = this.treechildren.childNodes[i];
 547                         var treerow = treeitem.firstChild;
 548                         for (var j = 0; j < treerow.childNodes.length; j++) {
 549                                 row[ obj.columns[j].id ] = treerow.childNodes[j].getAttribute('label');
 550                         }
 551                         dump.push( row );
 552                 }
 553                 return dump;
 554         },
 555
 556         'dump_retrieve_ids' : function(params) {
 557                 switch(this.node.nodeName) {
 558                         case 'tree' : return this._dump_retrieve_ids_tree(params); break;
 559                         default: throw('NYI: Need .dump_retrieve_ids() for ' + this.node.nodeName); break;
 560                 }
 561         },
 562
 563         '_dump_retrieve_ids_tree' : function(params) {
 564                 var dump = [];
 565                 for (var i = 0; i < this.treechildren.childNodes.length; i++) {
 566                         var treeitem = this.treechildren.childNodes[i];
 567                         dump.push( treeitem.getAttribute('retrieve_id') );
 568                 }
 569                 return dump;
 570         },
 571
 572 }
 573 dump('exiting util.list.js\n');