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