]> git.evergreen-ils.org Git - working/Evergreen.git/blob - Open-ILS/xul/staff_client/chrome/content/util/list.js
add context menu to xul list column headers
[working/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     this.row_count = { 'total' : 0, 'fleshed' : 0 };
9
10     this.unique_row_counter = 0;
11
12     this.sub_sorts = [];
13
14     if (!this.node) throw('Could not find element ' + id);
15     switch(this.node.nodeName) {
16         case 'listbox' : 
17         case 'tree' : break;
18         case 'richlistbox' :
19             throw(this.node.nodeName + ' not yet supported'); break;
20         default: throw(this.node.nodeName + ' not supported'); break;
21     }
22
23     JSAN.use('util.error'); this.error = new util.error();
24
25     JSAN.use('OpenILS.data'); this.data = new OpenILS.data(); this.data.stash_retrieve();
26
27     JSAN.use('util.functional');
28     JSAN.use('util.widgets');
29
30     return this;
31 };
32
33 util.list.prototype = {
34
35     'init' : function (params) {
36
37         var obj = this;
38         obj.scratch_data = {};
39
40         // If set, save and restore columns as if the tree/list id was the value of columns_saved_under
41         obj.columns_saved_under = params.columns_saved_under;
42
43         JSAN.use('util.widgets');
44
45         obj.printer_context = params.printer_context;
46
47         if (typeof params.map_row_to_column == 'function') obj.map_row_to_column = params.map_row_to_column;
48         if (typeof params.map_row_to_columns == 'function') {
49             obj.map_row_to_columns = params.map_row_to_columns;
50         } else {
51             obj.map_row_to_columns = obj.std_map_row_to_columns();
52         }
53         if (typeof params.retrieve_row == 'function') obj.retrieve_row = params.retrieve_row;
54
55         obj.prebuilt = false;
56         if (typeof params.prebuilt != 'undefined') obj.prebuilt = params.prebuilt;
57
58         if (typeof params.columns == 'undefined') throw('util.list.init: No columns');
59         obj.columns = [
60             {
61                 'id' : 'lineno',
62                 'label' : document.getElementById('offlineStrings').getString('list.line_number'),
63                 'flex' : '0',
64                 'no_sort' : 'true',
65                 'properties' : 'ordinal', // column properties for css styling
66                 'hidden' : 'false',
67                 'editable' : false,
68                 'render' : function(my,scratch) {
69                     // special code will handle this based on the attribute we set
70                     // here.  All cells for this column need to be updated whenever
71                     // a list adds, removes, or sorts rows
72                     return '_';
73                 }
74             }
75         ];
76         for (var i = 0; i < params.columns.length; i++) {
77             if (typeof params.columns[i] == 'object') {
78                 obj.columns.push( params.columns[i] );
79             } else {
80                 var cols = obj.fm_columns( params.columns[i] );
81                 for (var j = 0; j < cols.length; j++) {
82                     obj.columns.push( cols[j] );
83                 }
84             }
85         }
86
87         switch(obj.node.nodeName) {
88             case 'tree' : obj._init_tree(params); break;
89             case 'listbox' : obj._init_listbox(params); break;
90             default: throw('NYI: Need ._init() for ' + obj.node.nodeName); break;
91         }
92     },
93
94     '_init_tree' : function (params) {
95         var obj = this;
96         if (this.prebuilt) {
97         
98             this.treechildren = this.node.lastChild;    
99         
100         } else {
101             var treecols = document.createElement('treecols');
102             this.node.appendChild(treecols);
103             this.treecols = treecols;
104             if (document.getElementById('column_sort_menu')) {
105                 treecols.setAttribute('context','column_sort_menu');
106             }
107
108             var check_for_id_collisions = {};
109             for (var i = 0; i < this.columns.length; i++) {
110                 var treecol = document.createElement('treecol');
111                 for (var j in this.columns[i]) {
112                     var value = this.columns[i][j];
113                     if (j=='id') {
114                         if (typeof check_for_id_collisions[value] == 'undefined') {
115                             check_for_id_collisions[value] = true;
116                         } else {
117                             // Column id's are important for sorting and saving list configuration.  Collisions started happening because
118                             // we were using field names as id's, and then later combining column definitions for multiple objects that
119                             // shared field names.  The downside to this sort of automatic collision prevention is that these generated
120                             // id's can change as we add and remove columns, possibly breaking saved list configurations.
121                             dump('Column collision with id = ' + value + ', renaming to ');
122                             value = value + '_collision_' + i;
123                             dump(value + '\n');
124                         }
125                     }
126                     treecol.setAttribute(j,value);
127                 }
128                 treecols.appendChild(treecol);
129
130                 if (this.columns[i].type == 'checkbox') {
131                     treecol.addEventListener(
132                         'click',
133                         function(ev) {
134                             setTimeout(
135                                 function() {
136                                     var toggle = ev.target.getAttribute('toggleAll') || 'on';
137                                     if (toggle == 'off') toggle = 'on'; else toggle = 'off';
138                                     ev.target.setAttribute('toggleAll',toggle);
139                                     obj._toggle_checkbox_column(ev.target,toggle);
140                                 }, 0
141                             );
142                         },
143                         false
144                     );
145                 } else {
146                     treecol.addEventListener(
147                         'sort_first_asc',
148                         function(ev) {
149                             dump('sort_first_asc\n');
150                             ev.target.setAttribute('sortDir','asc');
151                             obj.first_sort = {
152                                 'target' : ev.target,
153                                 'sortDir' : 'asc'
154                             };
155                             obj.sub_sorts = [];
156                             util.widgets.dispatch('sort',ev.target);
157                         },
158                         false
159                     );
160                     treecol.addEventListener(
161                         'sort_first_desc',
162                         function(ev) {
163                             dump('sort_first_desc\n');
164                             ev.target.setAttribute('sortDir','desc');
165                             obj.first_sort = {
166                                 'target' : ev.target,
167                                 'sortDir' : 'desc'
168                             };
169                             obj.sub_sorts = [];
170                             util.widgets.dispatch('sort',ev.target);
171                         },
172                         false
173                     );
174                     treecol.addEventListener(
175                         'sort_next_asc',
176                         function(ev) {
177                             dump('sort_next_asc\n');
178                             ev.target.setAttribute('sortDir','asc');
179                             obj.sub_sorts.push({
180                                 'target' : ev.target,
181                                 'sortDir' : 'asc'
182                             });
183                             util.widgets.dispatch('sort',ev.target);
184                         },
185                         false
186                     );
187                     treecol.addEventListener(
188                         'sort_next_desc',
189                         function(ev) {
190                             dump('sort_next_desc\n');
191                             ev.target.setAttribute('sortDir','desc');
192                             obj.sub_sorts.push({
193                                 'target' : ev.target,
194                                 'sortDir' : 'desc'
195                             });
196                             util.widgets.dispatch('sort',ev.target);
197                         },
198                         false
199                     );
200
201                     treecol.addEventListener(
202                         'click', 
203                         function(ev) {
204                             dump('click\n');
205                             if (ev.button == 2 /* context menu click */ || ev.target.getAttribute('no_sort')) {
206                                 return;
207                             }
208                             if (document.popupNode
209                                 && document.popupNode.nodeName == 'treecol'
210                                 && document.popupNode.hasAttribute('locked')
211                             ) {
212                                 return;
213                             }
214                             dump('click2\n');
215
216                             if (ev.ctrlKey) { // sub sort
217                                 dump('click3\n');
218                                 var sortDir = 'asc';
219                                 if (ev.shiftKey) {
220                                     sortDir = 'desc';
221                                 }
222                                 ev.target.setAttribute('sortDir',sortDir);
223                                 obj.sub_sorts.push({
224                                     'target' : ev.target,
225                                     'sortDir' : sortDir
226                                 });
227                             } else { // first sort
228                                 dump('click4\n');
229                                 var sortDir = ev.target.getAttribute('sortDir') || 'desc';
230                                 if (sortDir == 'desc') sortDir = 'asc'; else sortDir = 'desc';
231                                 if (ev.shiftKey) {
232                                     sortDir = 'desc';
233                                 }
234                                 ev.target.setAttribute('sortDir',sortDir);
235                                 obj.first_sort = {
236                                     'target' : ev.target,
237                                     'sortDir' : sortDir
238                                 };
239                                 obj.sub_sorts = [];
240                             }
241                             util.widgets.dispatch('sort',ev.target);
242                         },
243                         false
244                     );
245
246                     treecol.addEventListener(
247                         'sort',
248                         function(ev) {
249                             dump('sort\n');
250                             if (!obj.first_sort) {
251                                 return;
252                             }
253                             dump('sort2\n');
254
255                             function do_it() {
256                                 dump('sort3\n');
257                                 obj._sort_tree();
258                             }
259
260                             if (obj.row_count.total != obj.row_count.fleshed
261                                 && (obj.row_count.total - obj.row_count.fleshed) > 50
262                             ) {
263                                 var r = window.confirm(
264                                     document.getElementById('offlineStrings').getFormattedString(
265                                         'list.row_fetch_warning',
266                                         [obj.row_count.fleshed,obj.row_count.total]
267                                     )
268                                 );
269
270                                 if (r) {
271                                     setTimeout( do_it, 0 );
272                                 }
273
274                             } else {
275                                     setTimeout( do_it, 0 );
276                             }
277
278                         },
279                         false
280                     );
281                 }
282                 var splitter = document.createElement('splitter');
283                 splitter.setAttribute('class','tree-splitter');
284                 treecols.appendChild(splitter);
285             }
286
287             var treechildren = document.createElement('treechildren');
288             this.node.appendChild(treechildren);
289             this.treechildren = treechildren;
290         }
291         if (typeof params.on_sort == 'function') {
292             this.on_sort = params.on_sort;
293         }
294         if (typeof params.on_checkbox_toggle == 'function') {
295             this.on_checkbox_toggle = params.on_checkbox_toggle;
296         }
297         this.node.addEventListener(
298             'select',
299             function(ev) {
300                 if (typeof params.on_select == 'function') {
301                     params.on_select(ev);
302                 }
303                 var x = document.getElementById(obj.node.id + '_clipfield');
304                 if (x) {
305                     var sel = obj.retrieve_selection();
306                     x.setAttribute('disabled', sel.length == 0);
307                 }
308             },
309             false
310         );
311         if (typeof params.on_click == 'function') {
312             this.node.addEventListener(
313                 'click',
314                 params.on_click,
315                 false
316             );
317         }
318         if (typeof params.on_dblclick == 'function') {
319             this.node.addEventListener(
320                 'dblclick',
321                 params.on_dblclick,
322                 false
323             );
324         }
325
326         /*
327         this.node.addEventListener(
328             'mousemove',
329             function(ev) { obj.detect_visible(); },
330             false
331         );
332         */
333         this.node.addEventListener(
334             'keypress',
335             function(ev) { obj.auto_retrieve(); },
336             false
337         );
338         this.node.addEventListener(
339             'click',
340             function(ev) { obj.auto_retrieve(); },
341             false
342         );
343         window.addEventListener(
344             'resize',
345             function(ev) { obj.auto_retrieve(); },
346             false
347         );
348         /* FIXME -- find events on scrollbar to trigger this */
349         obj.detect_visible_polling();    
350         /*
351         var scrollbar = document.getAnonymousNodes( document.getAnonymousNodes(this.node)[1] )[1];
352         var slider = document.getAnonymousNodes( scrollbar )[2];
353         alert('scrollbar = ' + scrollbar.nodeName + ' grippy = ' + slider.nodeName);
354         scrollbar.addEventListener('click',function(){alert('sb click');},false);
355         scrollbar.addEventListener('command',function(){alert('sb command');},false);
356         scrollbar.addEventListener('scroll',function(){alert('sb scroll');},false);
357         slider.addEventListener('click',function(){alert('slider click');},false);
358         slider.addEventListener('command',function(){alert('slider command');},false);
359         slider.addEventListener('scroll',function(){alert('slider scroll');},false);
360         */
361         this.node.addEventListener('scroll',function(){ obj.auto_retrieve(); },false);
362
363         this.restores_columns(params);
364     },
365
366     '_init_listbox' : function (params) {
367         if (this.prebuilt) {
368         } else {
369             var listhead = document.createElement('listhead');
370             this.node.appendChild(listhead);
371
372             var listcols = document.createElement('listcols');
373             this.node.appendChild(listcols);
374
375             for (var i = 0; i < this.columns.length; i++) {
376                 var listheader = document.createElement('listheader');
377                 listhead.appendChild(listheader);
378                 var listcol = document.createElement('listcol');
379                 listcols.appendChild(listcol);
380                 for (var j in this.columns[i]) {
381                     listheader.setAttribute(j,this.columns[i][j]);
382                     listcol.setAttribute(j,this.columns[i][j]);
383                 };
384             }
385         }
386     },
387
388     'save_columns' : function (params) {
389         var obj = this;
390         if (obj.data.hash.aous['gui.disable_local_save_columns']) {
391             alert(document.getElementById('offlineStrings').getString('list.column_save_disabled'));
392         } else {
393             switch (this.node.nodeName) {
394                 case 'tree' : this._save_columns_tree(params); break;
395                 default: throw('NYI: Need .save_columns() for ' + this.node.nodeName); break;
396             }
397         }
398     },
399
400     '_save_columns_tree' : function (params) {
401         var obj = this;
402         try {
403             var id = obj.node.getAttribute('id');
404             if (obj.columns_saved_under) { id = obj.columns_saved_under; }
405             if (!id) {
406                 alert("FIXME: The columns for this list cannot be saved because the list has no id.");
407                 return;
408             }
409             var my_cols = {};
410             var nl = obj.node.getElementsByTagName('treecol');
411             for (var i = 0; i < nl.length; i++) {
412                 var col = nl[i];
413                 var col_id = col.getAttribute('id');
414                 if (!col_id) {
415                     alert('FIXME: A column in this list does not have an id and cannot be saved');
416                     continue;
417                 }
418                 var col_hidden = col.getAttribute('hidden'); 
419                 var col_width = col.getAttribute('width'); 
420                 var col_ordinal = col.getAttribute('ordinal'); 
421                 my_cols[ col_id ] = { 'hidden' : col_hidden, 'width' : col_width, 'ordinal' : col_ordinal };
422             }
423             netscape.security.PrivilegeManager.enablePrivilege('UniversalXPConnect');
424             JSAN.use('util.file'); var file = new util.file('tree_columns_for_'+window.escape(id));
425             file.set_object(my_cols);
426             file.close();
427             alert(document.getElementById('offlineStrings').getString('list.columns_saved'));
428         } catch(E) {
429             obj.error.standard_unexpected_error_alert('_save_columns_tree',E);
430         }
431     },
432
433     'restores_columns' : function (params) {
434         var obj = this;
435         switch (this.node.nodeName) {
436             case 'tree' : this._restores_columns_tree(params); break;
437             default: throw('NYI: Need .restores_columns() for ' + this.node.nodeName); break;
438         }
439     },
440
441     '_restores_columns_tree' : function (params) {
442         var obj = this;
443         try {
444             var id = obj.node.getAttribute('id');
445             if (obj.columns_saved_under) { id = obj.columns_saved_under; }
446             if (!id) {
447                 alert("FIXME: The columns for this list cannot be restored because the list has no id.");
448                 return;
449             }
450
451             var my_cols;
452             if (! obj.data.hash.aous) { obj.data.hash.aous = {}; }
453             if (! obj.data.hash.aous['gui.disable_local_save_columns']) {
454                 netscape.security.PrivilegeManager.enablePrivilege('UniversalXPConnect');
455                 JSAN.use('util.file'); var file = new util.file('tree_columns_for_'+window.escape(id));
456                 if (file._file.exists()) {
457                     my_cols = file.get_object(); file.close();
458                 }
459             }
460             /* local file will trump remote file if allowed, so save ourselves an http request if this is the case */
461             if (obj.data.hash.aous['url.remote_column_settings'] && ! my_cols ) {
462                 try {
463                     var x = new XMLHttpRequest();
464                     var url = obj.data.hash.aous['url.remote_column_settings'] + '/tree_columns_for_' + window.escape(id);
465                     x.open("GET", url, false);
466                     x.send(null);
467                     if (x.status == 200) {
468                         my_cols = JSON2js( x.responseText );
469                     }
470                 } catch(E) {
471                     // This can happen in the offline interface if you logged in previously and url.remote_column_settings is set.
472                     // 1) You may be really "offline" now
473                     // 2) the URL may just be a path component without a hostname (ie "/xul/column_settings/"), which won't work
474                     // when appended to chrome://open_ils_staff_client/
475                     dump('Error retrieving column settings from ' + url + ': ' + E + '\n');
476                 }
477             }
478
479             if (my_cols) {
480                 var nl = obj.node.getElementsByTagName('treecol');
481                 for (var i = 0; i < nl.length; i++) {
482                     var col = nl[i];
483                     var col_id = col.getAttribute('id');
484                     if (!col_id) {
485                         alert('FIXME: A column in this list does not have an id and cannot be saved');
486                         continue;
487                     }
488                     if (typeof my_cols[col_id] != 'undefined') {
489                         col.setAttribute('hidden',my_cols[col_id].hidden); 
490                         col.setAttribute('width',my_cols[col_id].width); 
491                         col.setAttribute('ordinal',my_cols[col_id].ordinal); 
492                     } else {
493                         obj.error.sdump('D_ERROR','WARNING: Column ' + col_id + ' did not have a saved state.');
494                     }
495                 }
496             }
497         } catch(E) {
498             obj.error.standard_unexpected_error_alert('_restore_columns_tree',E);
499         }
500     },
501
502     'clear' : function (params) {
503         var obj = this;
504         switch (this.node.nodeName) {
505             case 'tree' : this._clear_tree(params); break;
506             case 'listbox' : this._clear_listbox(params); break;
507             default: throw('NYI: Need .clear() for ' + this.node.nodeName); break;
508         }
509         this.error.sdump('D_LIST','Clearing list ' + this.node.getAttribute('id') + '\n');
510         this.row_count.total = 0;
511         this.row_count.fleshed = 0;
512         setTimeout( function() { obj.exec_on_all_fleshed(); }, 0 );
513     },
514
515     '_clear_tree' : function(params) {
516         var obj = this;
517         if (obj.error.sdump_levels.D_LIST_DUMP_ON_CLEAR) {
518             obj.error.sdump('D_LIST_DUMP_ON_CLEAR',obj.dump());
519         }
520         if (obj.error.sdump_levels.D_LIST_DUMP_WITH_KEYS_ON_CLEAR) {
521             obj.error.sdump('D_LIST_DUMP_WITH_KEYS_ON_CLEAR',obj.dump_with_keys());
522         }
523         while (obj.treechildren.lastChild) obj.treechildren.removeChild( obj.treechildren.lastChild );
524     },
525
526     '_clear_listbox' : function(params) {
527         var obj = this;
528         var items = [];
529         var nl = this.node.getElementsByTagName('listitem');
530         for (var i = 0; i < nl.length; i++) {
531             items.push( nl[i] );
532         }
533         for (var i = 0; i < items.length; i++) {
534             this.node.removeChild(items[i]);
535         }
536     },
537
538     'append' : function (params) {
539         var rnode;
540         var obj = this;
541         switch (this.node.nodeName) {
542             case 'tree' : rparams = this._append_to_tree(params); break;
543             case 'listbox' : rparams = this._append_to_listbox(params); break;
544             default: throw('NYI: Need .append() for ' + this.node.nodeName); break;
545         }
546         if (rparams && params.attributes) {
547             for (var i in params.attributes) {
548                 rparams.treeitem_node.setAttribute(i,params.attributes[i]);
549             }
550         }
551         this.row_count.total++;
552         if (this.row_count.fleshed == this.row_count.total) {
553             setTimeout( function() { obj.exec_on_all_fleshed(); }, 0 );
554         }
555         rparams.treeitem_node.setAttribute('unique_row_counter',obj.unique_row_counter);
556         rparams.unique_row_counter = obj.unique_row_counter++;
557         if (typeof params.on_append == 'function') {
558             params.on_append(rparams);
559         }
560         return rparams;
561     },
562     
563     'refresh_row' : function (params) {
564         var rnode;
565         var obj = this;
566         switch (this.node.nodeName) {
567             case 'tree' : rparams = this._refresh_row_in_tree(params); break;
568             default: throw('NYI: Need .refresh_row() for ' + this.node.nodeName); break;
569         }
570         if (rparams && params.attributes) {
571             for (var i in params.attributes) {
572                 rparams.treeitem_node.setAttribute(i,params.attributes[i]);
573             }
574         }
575         this.row_count.fleshed--;
576         return rparams;
577     },
578
579
580     '_append_to_tree' : function (params) {
581
582         var obj = this;
583
584         if (typeof params.row == 'undefined') throw('util.list.append: Object must contain a row');
585
586         var s = ('util.list.append: params = ' + (params) + '\n');
587
588         var treechildren_node = this.treechildren;
589
590         if (params.node && params.node.nodeName == 'treeitem') {
591             params.node.setAttribute('container','true'); /* params.node.setAttribute('open','true'); */
592             if (params.node.lastChild.nodeName == 'treechildren') {
593                 treechildren_node = params.node.lastChild;
594             } else {
595                 treechildren_node = document.createElement('treechildren');
596                 params.node.appendChild(treechildren_node);
597             }
598         }
599
600         var treeitem = document.createElement('treeitem');
601         treeitem.setAttribute('retrieve_id',params.retrieve_id);
602         if (typeof params.to_bottom != 'undefined') {
603             treechildren_node.appendChild( treeitem );
604             if (typeof params.no_auto_select == 'undefined') {
605                 if (!obj.auto_select_pending) {
606                     obj.auto_select_pending = true;
607                     setTimeout(function() {
608                         dump('auto-selecting\n');
609                         var idx = Number(obj.node.view.rowCount)-1;
610                         try { obj.node.view.selection.select(idx); } catch(E) { obj.error.sdump('D_WARN','tree auto select: ' + E + '\n'); }
611                         try { if (typeof params.on_select == 'function') params.on_select(); } catch(E) { obj.error.sdump('D_WARN','tree auto select, on_select: ' + E + '\n'); }
612                         obj.auto_select_pending = false;
613                         try { util.widgets.dispatch('flesh',obj.node.contentView.getItemAtIndex(idx).firstChild); } catch(E) { obj.error.sdump('D_WARN','tree auto select, flesh: ' + E + '\n'); }
614                     }, 1000);
615                 }
616             }
617         } else {
618             if (treechildren_node.firstChild) {
619                 treechildren_node.insertBefore( treeitem, treechildren_node.firstChild );
620             } else {
621                 treechildren_node.appendChild( treeitem );
622             }
623             if (typeof params.no_auto_select == 'undefined') {
624                 if (!obj.auto_select_pending) {
625                     obj.auto_select_pending = true;
626                     setTimeout(function() {
627                         try { obj.node.view.selection.select(0); } catch(E) { obj.error.sdump('D_WARN','tree auto select: ' + E + '\n'); }
628                         try { if (typeof params.on_select == 'function') params.on_select(); } catch(E) { obj.error.sdump('D_WARN','tree auto select, on_select: ' + E + '\n'); }
629                         obj.auto_select_pending = false;
630                         try { util.widgets.dispatch('flesh',obj.node.contentView.getItemAtIndex(0).firstChild); } catch(E) { obj.error.sdump('D_WARN','tree auto select, flesh: ' + E + '\n'); }
631                     }, 1000);
632                 }
633             }
634         }
635         var treerow = document.createElement('treerow');
636         treeitem.appendChild( treerow );
637         treerow.setAttribute('retrieve_id',params.retrieve_id);
638         if (params.row_properties) treerow.setAttribute('properties',params.row_properties);
639
640         s += ('tree = ' + this.node + '  treechildren = ' + treechildren_node + '\n');
641         s += ('treeitem = ' + treeitem + '  treerow = ' + treerow + '\n');
642
643         obj.put_retrieving_label(treerow);
644
645         if (typeof params.retrieve_row == 'function' || typeof this.retrieve_row == 'function') {
646             treerow.addEventListener(
647                 'flesh',
648                 function() {
649
650                     if (treerow.getAttribute('retrieved') == 'true') return; /* already running */
651
652                     treerow.setAttribute('retrieved','true');
653
654                     //dump('fleshing = ' + params.retrieve_id + '\n');
655
656                     function inc_fleshed() {
657                         if (treerow.getAttribute('fleshed') == 'true') return; /* already fleshed */
658                         treerow.setAttribute('fleshed','true');
659                         obj.row_count.fleshed++;
660                         if (obj.row_count.fleshed >= obj.row_count.total) {
661                             setTimeout( function() { obj.exec_on_all_fleshed(); }, 0 );
662                         }
663                     }
664
665                     params.treeitem_node = treeitem;
666                     params.on_retrieve = function(p) {
667                         try {
668                             p.row = params.row;
669                             obj._map_row_to_treecell(p,treerow);
670                             inc_fleshed();
671                             var idx = obj.node.contentView.getIndexOfItem( params.treeitem_node );
672                             dump('idx = ' + idx + '\n');
673                             // if current row is selected, send another select event to re-sync data that the client code fetches on selects
674                             if ( obj.node.view.selection.isSelected( idx ) ) {
675                                 dump('dispatching select event for on_retrieve for idx = ' + idx + '\n');
676                                 util.widgets.dispatch('select',obj.node);
677                             }
678                         } catch(E) {
679                             // Let's not alert on this for now.  Getting contentView has no properties in record buckets under certain conditions
680                             dump('fixme2: ' + E + '\n');
681                         }
682                     }
683
684                     if (typeof params.retrieve_row == 'function') {
685
686                         params.retrieve_row( params );
687
688                     } else if (typeof obj.retrieve_row == 'function') {
689
690                             obj.retrieve_row( params );
691
692                     } else {
693                     
694                             inc_fleshed();
695                     }
696                     obj.refresh_ordinals();
697                 },
698                 false
699             );
700             if (typeof params.flesh_immediately != 'undefined') {
701                 if (params.flesh_immediately) {
702                     setTimeout(
703                         function() {
704                             util.widgets.dispatch('flesh',treerow);
705                         }, 0
706                     );
707                 }
708             }
709         } else {
710             treerow.addEventListener(
711                 'flesh',
712                 function() {
713                     //dump('fleshing anon\n');
714                     if (treerow.getAttribute('fleshed') == 'true') return; /* already fleshed */
715                     obj._map_row_to_treecell(params,treerow);
716                     treerow.setAttribute('retrieved','true');
717                     treerow.setAttribute('fleshed','true');
718                     obj.row_count.fleshed++;
719                     if (obj.row_count.fleshed >= obj.row_count.total) {
720                         setTimeout( function() { obj.exec_on_all_fleshed(); }, 0 );
721                     }
722                     obj.refresh_ordinals();
723                 },
724                 false
725             );
726             if (typeof params.flesh_immediately != 'undefined') {
727                 if (params.flesh_immediately) {
728                     setTimeout(
729                         function() {
730                             util.widgets.dispatch('flesh',treerow);
731                         }, 0
732                     );
733                 }
734             }
735         }
736         this.error.sdump('D_LIST',s);
737
738             try {
739
740                 if (obj.trim_list && obj.row_count.total >= obj.trim_list) {
741                     // Remove oldest row
742                     //if (typeof params.to_bottom != 'undefined') 
743                     if (typeof params.to_top == 'undefined') {
744                         if (typeof params.on_delete == 'function') { params.on_delete( treechildren_node.firstChild.getAttribute('unique_row_counter') ); }
745                         treechildren_node.removeChild( treechildren_node.firstChild );
746                     } else {
747                         if (typeof params.on_delete == 'function') { params.on_delete( treechildren_node.lastChild.getAttribute('unique_row_counter') ); }
748                         treechildren_node.removeChild( treechildren_node.lastChild );
749                     }
750                 }
751             } catch(E) {
752             }
753
754         setTimeout( function() { obj.auto_retrieve(); obj.refresh_ordinals(); }, 0 );
755
756         params.treeitem_node = treeitem;
757         return params;
758     },
759
760     '_refresh_row_in_tree' : function (params) {
761
762         var obj = this;
763
764         if (typeof params.row == 'undefined') throw('util.list.refresh_row: Object must contain a row');
765         if (typeof params.treeitem_node == 'undefined') throw('util.list.refresh_row: Object must contain a treeitem_node');
766         if (params.treeitem_node.nodeName != 'treeitem') throw('util.list.refresh_rwo: treeitem_node must be a treeitem');
767
768         var s = ('util.list.refresh_row: params = ' + (params) + '\n');
769
770         var treeitem = params.treeitem_node;
771         treeitem.setAttribute('retrieve_id',params.retrieve_id);
772         if (typeof params.to_bottom != 'undefined') {
773             if (typeof params.no_auto_select == 'undefined') {
774                 if (!obj.auto_select_pending) {
775                     obj.auto_select_pending = true;
776                     setTimeout(function() {
777                         dump('auto-selecting\n');
778                         var idx = Number(obj.node.view.rowCount)-1;
779                         try { obj.node.view.selection.select(idx); } catch(E) { obj.error.sdump('D_WARN','tree auto select: ' + E + '\n'); }
780                         try { if (typeof params.on_select == 'function') params.on_select(); } catch(E) { obj.error.sdump('D_WARN','tree auto select, on_select: ' + E + '\n'); }
781                         obj.auto_select_pending = false;
782                         try { util.widgets.dispatch('flesh',obj.node.contentView.getItemAtIndex(idx).firstChild); } catch(E) { obj.error.sdump('D_WARN','tree auto select, flesh: ' + E + '\n'); }
783                     }, 1000);
784                 }
785             }
786         }
787         //var delete_me = [];
788         //for (var i in treeitem.childNodes) if (treeitem.childNodes[i].nodeName == 'treerow') delete_me.push(treeitem.childNodes[i]);
789         //for (var i = 0; i < delete_me.length; i++) treeitem.removeChild(delete_me[i]);
790         var prev_treerow = treeitem.firstChild; /* FIXME: worry about hierarchal lists like copy_browser? */
791         var treerow = document.createElement('treerow');
792         while (prev_treerow.firstChild) {
793             treerow.appendChild( prev_treerow.removeChild( prev_treerow.firstChild ) );
794         }
795         treeitem.replaceChild( treerow, prev_treerow );
796         treerow.setAttribute('retrieve_id',params.retrieve_id);
797         if (params.row_properties) treerow.setAttribute('properties',params.row_properties);
798
799         s += ('tree = ' + this.node.nodeName + '\n');
800         s += ('treeitem = ' + treeitem.nodeName + '  treerow = ' + treerow.nodeName + '\n');
801
802         obj.put_retrieving_label(treerow);
803
804         if (typeof params.retrieve_row == 'function' || typeof this.retrieve_row == 'function') {
805
806             s += 'found a retrieve_row function\n';
807
808             treerow.addEventListener(
809                 'flesh',
810                 function() {
811
812                     if (treerow.getAttribute('retrieved') == 'true') return; /* already running */
813
814                     treerow.setAttribute('retrieved','true');
815
816                     //dump('fleshing = ' + params.retrieve_id + '\n');
817
818                     function inc_fleshed() {
819                         if (treerow.getAttribute('fleshed') == 'true') return; /* already fleshed */
820                         treerow.setAttribute('fleshed','true');
821                         obj.row_count.fleshed++;
822                         if (obj.row_count.fleshed >= obj.row_count.total) {
823                             setTimeout( function() { obj.exec_on_all_fleshed(); }, 0 );
824                         }
825                     }
826
827                     params.treeitem_node = treeitem;
828                     params.on_retrieve = function(p) {
829                         try {
830                             p.row = params.row;
831                             obj._map_row_to_treecell(p,treerow);
832                             inc_fleshed();
833                             var idx = obj.node.contentView.getIndexOfItem( params.treeitem_node );
834                             dump('idx = ' + idx + '\n');
835                             // if current row is selected, send another select event to re-sync data that the client code fetches on selects
836                             if ( obj.node.view.selection.isSelected( idx ) ) {
837                                 dump('dispatching select event for on_retrieve for idx = ' + idx + '\n');
838                                 util.widgets.dispatch('select',obj.node);
839                             }
840                         } catch(E) {
841                             // Let's not alert on this for now.  Getting contentView has no properties in record buckets under certain conditions
842                             dump('fixme2: ' + E + '\n');
843                         }
844                     }
845
846                     if (typeof params.retrieve_row == 'function') {
847
848                         params.retrieve_row( params );
849
850                     } else if (typeof obj.retrieve_row == 'function') {
851
852                             obj.retrieve_row( params );
853
854                     } else {
855                     
856                             inc_fleshed();
857                     }
858                     obj.refresh_ordinals();
859                 },
860                 false
861             );
862             if (typeof params.flesh_immediately != 'undefined') {
863                 if (params.flesh_immediately) {
864                     setTimeout(
865                         function() {
866                             util.widgets.dispatch('flesh',treerow);
867                         }, 0
868                     );
869                 }
870             }
871
872         } else {
873
874             s += 'did not find a retrieve_row function\n';
875
876             treerow.addEventListener(
877                 'flesh',
878                 function() {
879                     //dump('fleshing anon\n');
880                     if (treerow.getAttribute('fleshed') == 'true') return; /* already fleshed */
881                     obj._map_row_to_treecell(params,treerow);
882                     treerow.setAttribute('retrieved','true');
883                     treerow.setAttribute('fleshed','true');
884                     obj.row_count.fleshed++;
885                     if (obj.row_count.fleshed >= obj.row_count.total) {
886                         setTimeout( function() { obj.exec_on_all_fleshed(); }, 0 );
887                     }
888                     obj.refresh_ordinals();
889                 },
890                 false
891             );
892             if (typeof params.flesh_immediately != 'undefined') {
893                 if (params.flesh_immediately) {
894                     setTimeout(
895                         function() {
896                             util.widgets.dispatch('flesh',treerow);
897                         }, 0
898                     );
899                 }
900             }
901
902         }
903
904             try {
905
906                 if (obj.trim_list && obj.row_count.total >= obj.trim_list) {
907                     // Remove oldest row
908                     //if (typeof params.to_bottom != 'undefined') 
909                     if (typeof params.to_top == 'undefined') {
910                         treechildren_node.removeChild( treechildren_node.firstChild );
911                     } else {
912                         treechildren_node.removeChild( treechildren_node.lastChild );
913                     }
914                 }
915             } catch(E) {
916             }
917
918         setTimeout( function() { obj.auto_retrieve(); obj.refresh_ordinals(); }, 0 );
919
920         JSAN.use('util.widgets'); util.widgets.dispatch('select',obj.node);
921
922         this.error.sdump('D_LIST',s);
923
924         return params;
925     },
926
927     'refresh_ordinals' : function() {
928         var obj = this;
929         try {
930             if (obj.refresh_ordinals_timeout_id) { return; }
931
932             function _refresh_ordinals(clear) {
933                 var nl = obj.node.getElementsByAttribute('label','_');
934                 for (var i = 0; i < nl.length; i++) {
935                     nl[i].setAttribute(
936                         'ord_col',
937                         'true'
938                     );
939                     nl[i].setAttribute( // treecell properties for css styling
940                         'properties',
941                         'ordinal'
942                     );
943                 }
944                 nl = obj.node.getElementsByAttribute('ord_col','true');
945                 for (var i = 0; i < nl.length; i++) {
946                     nl[i].setAttribute(
947                         'label',
948                         // we could just use 'i' here if we trust the order of elements
949                         1 + obj.node.contentView.getIndexOfItem(nl[i].parentNode.parentNode) // treeitem
950                     );
951                 }
952                 if (clear) { obj.refresh_ordinals_timeout_id = null; }
953             }
954
955             // spamming this to cover race conditions
956             setTimeout(_refresh_ordinals, 500); // for speedy looking UI updates
957             setTimeout(_refresh_ordinals, 2000); // for most uses
958             obj.refresh_ordinals_timeout_id = setTimeout(
959                 function() {
960                     _refresh_ordinals(true);
961                 },
962                 4000 // just in case, say with a slow rendering list
963             );
964
965         } catch(E) {
966             alert('Error in list.js, refresh_ordinals(): ' + E);
967         }
968     },
969
970     'put_retrieving_label' : function(treerow) {
971         var obj = this;
972         try {
973             for (var i = 0; i < obj.columns.length; i++) {
974                 var treecell;
975                 if (typeof treerow.childNodes[i] == 'undefined') {
976                     treecell = document.createElement('treecell');
977                     treerow.appendChild(treecell);
978                 } else {
979                     treecell = treerow.childNodes[i];
980                 }
981                 treecell.setAttribute('label',document.getElementById('offlineStrings').getString('list.row_retrieving'));
982             }
983         } catch(E) {
984             alert('Error in list.js, put_retrieving_label(): ' + E);
985         }
986     },
987
988     'detect_visible' : function() {
989         var obj = this;
990         try {
991             //dump('detect_visible  obj.node = ' + obj.node + '\n');
992             /* FIXME - this is a hack.. if the implementation of tree changes, this could break */
993             try {
994                 /*var s = ''; var A = document.getAnonymousNodes(obj.node);
995                 for (var i in A) {
996                     var B = A[i];
997                     s += '\t' + (typeof B.nodeName != 'undefined' ? B.nodeName : B ) + '\n'; 
998                     if (typeof B.childNodes != 'undefined') for (var j = 0; j < B.childNodes.length; j++) {
999                         var C = B.childNodes[j];
1000                         s += '\t\t' + C.nodeName + '\n';
1001                     }
1002                 }
1003                 obj.error.sdump('D_XULRUNNER','document.getAnonymousNodes(' + obj.node.nodeName + ') = \n' + s + '\n');*/
1004                 var scrollbar = document.getAnonymousNodes(obj.node)[2].firstChild;
1005                 var curpos = scrollbar.getAttribute('curpos');
1006                 var maxpos = scrollbar.getAttribute('maxpos');
1007                 //alert('curpos = ' + curpos + ' maxpos = ' + maxpos + ' obj.curpos = ' + obj.curpos + ' obj.maxpos = ' + obj.maxpos + '\n');
1008                 if ((curpos != obj.curpos) || (maxpos != obj.maxpos)) {
1009                     if ( obj.auto_retrieve() > 0 ) {
1010                         obj.curpos = curpos; obj.maxpos = maxpos;
1011                     }
1012                 }
1013             } catch(E) {
1014                 obj.error.sdump('D_XULRUNNER', 'List implementation changed? ' + E);
1015             }
1016         } catch(E) { obj.error.sdump('D_ERROR',E); }
1017     },
1018
1019     'detect_visible_polling' : function() {
1020         try {
1021             //alert('detect_visible_polling');
1022             var obj = this;
1023             obj.detect_visible();
1024             setTimeout(function() { try { obj.detect_visible_polling(); } catch(E) { alert(E); } },2000);
1025         } catch(E) {
1026             alert(E);
1027         }
1028     },
1029
1030
1031     'auto_retrieve' : function(params) {
1032         var obj = this;
1033         switch (this.node.nodeName) {
1034             case 'tree' : obj._auto_retrieve_tree(params); break;
1035             default: throw('NYI: Need .auto_retrieve() for ' + obj.node.nodeName); break;
1036         }
1037     },
1038
1039     '_auto_retrieve_tree' : function (params) {
1040         var obj = this;
1041         if (!obj.auto_retrieve_in_progress) {
1042             obj.auto_retrieve_in_progress = true;
1043             setTimeout(
1044                 function() {
1045                     try {
1046                             //alert('auto_retrieve\n');
1047                             var count = 0;
1048                             var startpos = obj.node.treeBoxObject.getFirstVisibleRow();
1049                             var endpos = obj.node.treeBoxObject.getLastVisibleRow();
1050                             if (startpos > endpos) endpos = obj.node.treeBoxObject.getPageLength();
1051                             //dump('startpos = ' + startpos + ' endpos = ' + endpos + '\n');
1052                             for (var i = startpos; i < endpos + 4; i++) {
1053                                 try {
1054                                     //dump('trying index ' + i + '\n');
1055                                     var item = obj.node.contentView.getItemAtIndex(i).firstChild;
1056                                     if (item && item.getAttribute('retrieved') != 'true' ) {
1057                                         //dump('\tgot an unfleshed item = ' + item + ' = ' + item.nodeName + '\n');
1058                                         util.widgets.dispatch('flesh',item); count++;
1059                                     }
1060                                 } catch(E) {
1061                                     //dump(i + ' : ' + E + '\n');
1062                                 }
1063                             }
1064                             obj.auto_retrieve_in_progress = false;
1065                             return count;
1066                     } catch(E) { alert(E); }
1067                 }, 1
1068             );
1069         }
1070     },
1071
1072     'exec_on_all_fleshed' : function() {
1073         var obj = this;
1074         try {
1075             if (obj.on_all_fleshed) {
1076                 if (typeof obj.on_all_fleshed == 'function') {
1077                     dump('exec_on_all_fleshed == function\n');
1078                     setTimeout( 
1079                         function() { 
1080                             try { obj.on_all_fleshed(); } catch(E) { obj.error.standard_unexpected_error_alert('_full_retrieve_tree callback',obj.on_all_fleshed); }
1081                         }, 0 
1082                     );
1083                 } else if (typeof obj.on_all_fleshed.length != 'undefined') {
1084                     dump('exec_on_all_fleshed == array\n');
1085                     setTimeout(
1086                         function() {
1087                             try {
1088                                 dump('exec_on_all_fleshed, processing on_all_fleshed array, length = ' + obj.on_all_fleshed.length + '\n');
1089                                 var f = obj.on_all_fleshed.pop();
1090                                 if (typeof f == 'function') { 
1091                                     try { f(); } catch(E) { obj.error.standard_unexpected_error_alert('_full_retrieve_tree callback',f); } 
1092                                 }
1093                                 if (obj.on_all_fleshed.length > 0) arguments.callee(); 
1094                             } catch(E) {
1095                                 obj.error.standard_unexpected_error_alert('exec_on_all_fleshed callback error',E);
1096                             }
1097                         }, 0
1098                     ); 
1099                 } else {
1100                     obj.error.standard_unexpected_error_alert('unexpected on_all_fleshed object: ', obj.on_all_fleshed);
1101                 }
1102             }
1103         } catch(E) {
1104             obj.error.standard_unexpected_error_alert('exec_on_all-fleshed error',E);
1105         }
1106     },
1107
1108     'full_retrieve' : function(params) {
1109         var obj = this;
1110         switch (this.node.nodeName) {
1111             case 'tree' : obj._full_retrieve_tree(params); break;
1112             default: throw('NYI: Need .full_retrieve() for ' + obj.node.nodeName); break;
1113         }
1114         obj.refresh_ordinals();
1115     },
1116
1117     '_full_retrieve_tree' : function(params) {
1118         var obj = this;
1119         try {
1120             if (obj.row_count.fleshed >= obj.row_count.total) {
1121                 dump('Full retrieve... tree seems to be in sync\n' + js2JSON(obj.row_count) + '\n');
1122                 obj.exec_on_all_fleshed();
1123             } else {
1124                 dump('Full retrieve... syncing tree' + js2JSON(obj.row_count) + '\n');
1125                 JSAN.use('util.widgets');
1126                 var nodes = obj.treechildren.childNodes;
1127                 for (var i = 0; i < nodes.length; i++) {
1128                     util.widgets.dispatch('flesh',nodes[i].firstChild);
1129                 }
1130             }
1131         } catch(E) {
1132             obj.error.standard_unexpected_error_alert('_full_retrieve_tree',E);
1133         }
1134     },
1135
1136     '_append_to_listbox' : function (params) {
1137
1138         var obj = this;
1139
1140         if (typeof params.row == 'undefined') throw('util.list.append: Object must contain a row');
1141
1142         var s = ('util.list.append: params = ' + (params) + '\n');
1143
1144         var listitem = document.createElement('listitem');
1145
1146         s += ('listbox = ' + this.node + '  listitem = ' + listitem + '\n');
1147
1148         if (typeof params.retrieve_row == 'function' || typeof this.retrieve_row == 'function') {
1149
1150             setTimeout(
1151                 function() {
1152                     listitem.setAttribute('retrieve_id',params.retrieve_id);
1153                     //FIXME//Make async and fire when row is visible in list
1154                     var row;
1155
1156                     params.treeitem_node = listitem;
1157                     params.on_retrieve = function(row) {
1158                         params.row = row;
1159                         obj._map_row_to_listcell(params,listitem);
1160                         obj.node.appendChild( listitem );
1161                         util.widgets.dispatch('select',obj.node);
1162                     }
1163
1164                     if (typeof params.retrieve_row == 'function') {
1165
1166                         row = params.retrieve_row( params );
1167
1168                     } else {
1169
1170                         if (typeof obj.retrieve_row == 'function') {
1171
1172                             row = obj.retrieve_row( params );
1173
1174                         }
1175                     }
1176                 }, 0
1177             );
1178         } else {
1179             this._map_row_to_listcell(params,listitem);
1180             this.node.appendChild( listitem );
1181         }
1182
1183         this.error.sdump('D_LIST',s);
1184         params.treeitem_node = listitem;
1185         return params;
1186
1187     },
1188
1189     '_map_row_to_treecell' : function(params,treerow) {
1190         var obj = this;
1191         var s = '';
1192
1193         if (typeof params.map_row_to_column == 'function' || typeof this.map_row_to_column == 'function') {
1194
1195             for (var i = 0; i < this.columns.length; i++) {
1196                 var treecell;
1197                 if (typeof treerow.childNodes[i] == 'undefined') {
1198                     treecell = document.createElement('treecell');
1199                     treerow.appendChild( treecell );
1200                 } else {
1201                     treecell = treerow.childNodes[i];
1202                 }
1203                 
1204                 if ( this.columns[i].editable == false ) { treecell.setAttribute('editable','false'); }
1205                 var label = '';
1206                 var sort_value = '';
1207
1208                 // What skip columns is doing is rendering the treecells as blank/empty
1209                 if (params.skip_columns && (params.skip_columns.indexOf(i) != -1)) {
1210                     treecell.setAttribute('label',label);
1211                     s += ('treecell = ' + treecell + ' with label = ' + label + '\n');
1212                     continue;
1213                 }
1214                 if (params.skip_all_columns_except && (params.skip_all_columns_except.indexOf(i) == -1)) {
1215                     treecell.setAttribute('label',label);
1216                     s += ('treecell = ' + treecell + ' with label = ' + label + '\n');
1217                     continue;
1218                 }
1219     
1220                 if (typeof params.map_row_to_column == 'function')  {
1221     
1222                     label = params.map_row_to_column(params.row,this.columns[i],this.scratch_data);
1223     
1224                 } else if (typeof this.map_row_to_column == 'function') {
1225     
1226                     label = this.map_row_to_column(params.row,this.columns[i],this.scratch_data);
1227     
1228                 }
1229                 if (this.columns[i].type == 'checkbox') { treecell.setAttribute('value',label); } else { treecell.setAttribute('label',label ? label : ''); }
1230                 s += ('treecell = ' + treecell + ' with label = ' + label + '\n');
1231             }
1232         } else if (typeof params.map_row_to_columns == 'function' || typeof this.map_row_to_columns == 'function') {
1233
1234             var labels = [];
1235             var sort_values = [];
1236
1237             if (typeof params.map_row_to_columns == 'function') {
1238
1239                 var values = params.map_row_to_columns(params.row,this.columns,this.scratch_data);
1240                 if (typeof values.values == 'undefined') {
1241                     labels = values;
1242                 } else {
1243                     labels = values.values;
1244                     sort_values = values.sort_values;
1245                 }
1246
1247             } else if (typeof this.map_row_to_columns == 'function') {
1248
1249                 var values = this.map_row_to_columns(params.row,this.columns,this.scratch_data);
1250                 if (typeof values.values == 'undefined') {
1251                     labels = values;
1252                 } else {
1253                     labels = values.values;
1254                     sort_values = values.sort_values;
1255                 }
1256             }
1257             for (var i = 0; i < labels.length; i++) {
1258                 var treecell;
1259                 if (typeof treerow.childNodes[i] == 'undefined') {
1260                     treecell = document.createElement('treecell');
1261                     treerow.appendChild(treecell);
1262                 } else {
1263                     treecell = treerow.childNodes[i];
1264                 }
1265                 if ( this.columns[i].editable == false ) { treecell.setAttribute('editable','false'); }
1266                 if ( this.columns[i].type == 'checkbox') {
1267                     treecell.setAttribute('value', labels[i]);
1268                 } else {
1269                     treecell.setAttribute('label',typeof labels[i] == 'string' || typeof labels[i] == 'number' ? labels[i] : '');
1270                 }
1271                 if (sort_values[i]) {
1272                     treecell.setAttribute('sort_value',js2JSON(sort_values[i]));
1273                 }
1274                 s += ('treecell = ' + treecell + ' with label = ' + labels[i] + '\n');
1275             }
1276
1277         } else {
1278
1279             throw('No row to column mapping function.');
1280         }
1281         this.error.sdump('D_LIST',s);
1282     },
1283
1284     '_map_row_to_listcell' : function(params,listitem) {
1285         var obj = this;
1286         var s = '';
1287         for (var i = 0; i < this.columns.length; i++) {
1288             var value = '';
1289             if (typeof params.map_row_to_column == 'function')  {
1290
1291                 value = params.map_row_to_column(params.row,this.columns[i],this.scratch_data);
1292
1293             } else {
1294
1295                 if (typeof this.map_row_to_column == 'function') {
1296
1297                     value = this.map_row_to_column(params.row,this.columns[i],this.scratch_data);
1298                 }
1299             }
1300             if (typeof value == 'string' || typeof value == 'number') {
1301                 var listcell = document.createElement('listcell');
1302                 listcell.setAttribute('label',value);
1303                 listitem.appendChild(listcell);
1304                 s += ('listcell = ' + listcell + ' with label = ' + value + '\n');
1305             } else {
1306                 listitem.appendChild(value);
1307                 s += ('listcell = ' + value + ' is really a ' + value.nodeName + '\n');
1308             }
1309         }
1310         this.error.sdump('D_LIST',s);
1311     },
1312
1313     'select_all' : function(params) {
1314         var obj = this;
1315         switch(this.node.nodeName) {
1316             case 'tree' : return this._select_all_from_tree(params); break;
1317             default: throw('NYI: Need ._select_all_from_() for ' + this.node.nodeName); break;
1318         }
1319     },
1320
1321     '_select_all_from_tree' : function(params) {
1322         var obj = this;
1323         this.node.view.selection.selectAll();
1324     },
1325
1326     'retrieve_selection' : function(params) {
1327         var obj = this;
1328         switch(this.node.nodeName) {
1329             case 'tree' : return this._retrieve_selection_from_tree(params); break;
1330             default: throw('NYI: Need ._retrieve_selection_from_() for ' + this.node.nodeName); break;
1331         }
1332     },
1333
1334     '_retrieve_selection_from_tree' : function(params) {
1335         var obj = this;
1336         var list = [];
1337         var start = new Object();
1338         var end = new Object();
1339         var numRanges = this.node.view.selection.getRangeCount();
1340         for (var t=0; t<numRanges; t++){
1341             this.node.view.selection.getRangeAt(t,start,end);
1342             for (var v=start.value; v<=end.value; v++){
1343                 var i = this.node.contentView.getItemAtIndex(v);
1344                 list.push( i );
1345             }
1346         }
1347         return list;
1348     },
1349
1350     'dump' : function(params) {
1351         var obj = this;
1352         switch(this.node.nodeName) {
1353             case 'tree' : return this._dump_tree(params); break;
1354             default: throw('NYI: Need .dump() for ' + this.node.nodeName); break;
1355         }
1356     },
1357
1358     '_dump_tree' : function(params) {
1359         var obj = this;
1360         var dump = [];
1361         for (var i = 0; i < this.treechildren.childNodes.length; i++) {
1362             var row = [];
1363             var treeitem = this.treechildren.childNodes[i];
1364             var treerow = treeitem.firstChild;
1365             for (var j = 0; j < treerow.childNodes.length; j++) {
1366                 row.push( treerow.childNodes[j].getAttribute('label') );
1367             }
1368             dump.push( row );
1369         }
1370         return dump;
1371     },
1372
1373     'dump_with_keys' : function(params) {
1374         var obj = this;
1375         switch(this.node.nodeName) {
1376             case 'tree' : return this._dump_tree_with_keys(params); break;
1377             default: throw('NYI: Need .dump_with_keys() for ' + this.node.nodeName); break;
1378         }
1379
1380     },
1381
1382     '_dump_tree_with_keys' : function(params) {
1383         var obj = this;
1384         var dump = [];
1385
1386         function process_tree(treechildren) {
1387             for (var i = 0; i < treechildren.childNodes.length; i++) {
1388                 var row = {};
1389                 var treeitem = treechildren.childNodes[i];
1390                 var treerow = treeitem.firstChild;
1391                 for (var j = 0; j < treerow.childNodes.length; j++) {
1392                     if (typeof obj.columns[j] == 'undefined') {
1393                         dump('=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=\n');
1394                         dump('_dump_tree_with_keys @ ' + location.href + '\n');
1395                         dump('\ttreerow.childNodes.length='+treerow.childNodes.length+' j='+j+' obj.columns.length='+obj.columns.length+'\n');
1396                         debugger;
1397                     } else {
1398                         row[ obj.columns[j].id ] = treerow.childNodes[j].getAttribute('label');
1399                         var sort = treerow.childNodes[j].getAttribute('sort_value');
1400                         if(sort) {
1401                             row[ obj.columns[j].id + '_sort_value' ] = sort;
1402                         }
1403                     }
1404                 }
1405                 dump.push( row );
1406                 if (treeitem.childNodes.length > 1) {
1407                     process_tree(treeitem.lastChild);
1408                 }
1409             }
1410         }
1411
1412         process_tree(this.treechildren);
1413
1414         return dump;
1415     },
1416
1417     'dump_csv' : function(params) {
1418         var obj = this;
1419         switch(this.node.nodeName) {
1420             case 'tree' : return this._dump_tree_csv(params); break;
1421             default: throw('NYI: Need .dump_csv() for ' + this.node.nodeName); break;
1422         }
1423
1424     },
1425
1426     '_dump_tree_csv' : function(params) {
1427         var obj = this;
1428         var _dump = '';
1429         var ord_cols = [];
1430         for (var j = 0; j < obj.columns.length; j++) {
1431             if (obj.node.treeBoxObject.columns.getColumnAt(j).element.getAttribute('hidden') == 'true') {
1432                 /* skip */
1433             } else {
1434                 ord_cols.push( [ obj.node.treeBoxObject.columns.getColumnAt(j).element.getAttribute('ordinal'), j ] );
1435             }
1436         }
1437         ord_cols.sort( function(a,b) { 
1438             if ( Number( a[0] ) < Number( b[0] ) ) return -1; 
1439             if ( Number( a[0] ) > Number( b[0] ) ) return 1; 
1440             return 0;
1441         } );
1442         for (var j = 0; j < ord_cols.length; j++) {
1443             if (_dump) _dump += ',';
1444             _dump += '"' + obj.columns[ ord_cols[j][1] ].label.replace(/"/g, '""') + '"';
1445         }
1446         _dump += '\r\n';
1447
1448         function process_tree(treechildren) {
1449             for (var i = 0; i < treechildren.childNodes.length; i++) {
1450                 var row = '';
1451                 var treeitem = treechildren.childNodes[i];
1452                 var treerow = treeitem.firstChild;
1453                 for (var j = 0; j < ord_cols.length; j++) {
1454                     if (row) row += ',';
1455                     row += '"' + treerow.childNodes[ ord_cols[j][1] ].getAttribute('label').replace(/"/g, '""') + '"';
1456                 }
1457                 _dump +=  row + '\r\n';
1458                 if (treeitem.childNodes.length > 1) {
1459                     process_tree(treeitem.lastChild);
1460                 }
1461             }
1462         }
1463
1464         process_tree(this.treechildren);
1465
1466         return _dump;
1467     },
1468
1469     'dump_extended_format' : function(params) {
1470         var obj = this;
1471         switch(this.node.nodeName) {
1472             case 'tree' : return this._dump_tree_extended_format(params); break;
1473             default: throw('NYI: Need .dump_extended_format() for ' + this.node.nodeName); break;
1474         }
1475
1476     },
1477
1478     '_dump_tree_extended_format' : function(params) {
1479         var obj = this;
1480         var _dump = '';
1481         var ord_cols = [];
1482         for (var j = 0; j < obj.columns.length; j++) {
1483             if (obj.node.treeBoxObject.columns.getColumnAt(j).element.getAttribute('hidden') == 'true') {
1484                 /* skip */
1485             } else {
1486                 ord_cols.push( [ obj.node.treeBoxObject.columns.getColumnAt(j).element.getAttribute('ordinal'), j ] );
1487             }
1488         }
1489         ord_cols.sort( function(a,b) { 
1490             if ( Number( a[0] ) < Number( b[0] ) ) return -1; 
1491             if ( Number( a[0] ) > Number( b[0] ) ) return 1; 
1492             return 0;
1493         } );
1494
1495         function process_tree(treechildren) {
1496             for (var i = 0; i < treechildren.childNodes.length; i++) {
1497                 var row = document.getElementById('offlineStrings').getString('list.dump_extended_format.record_separator') + '\r\n';
1498                 var treeitem = treechildren.childNodes[i];
1499                 var treerow = treeitem.firstChild;
1500                 for (var j = 0; j < ord_cols.length; j++) {
1501                     row += obj.columns[ ord_cols[j][1] ].label + ': ' + treerow.childNodes[ ord_cols[j][1] ].getAttribute('label') + '\r\n';
1502                 }
1503                 _dump +=  row + '\r\n';
1504                 if (treeitem.childNodes.length > 1) {
1505                     process_tree(treeitem.lastChild);
1506                 }
1507             }
1508         }
1509
1510         process_tree(this.treechildren);
1511
1512         return _dump;
1513     },
1514
1515     'dump_csv_to_clipboard' : function(params) {
1516         var obj = this;
1517         if (typeof params == 'undefined') params = {};
1518         if (params.no_full_retrieve) {
1519             copy_to_clipboard( obj.dump_csv( params ) );
1520         } else {
1521             obj.wrap_in_full_retrieve( function() { copy_to_clipboard( obj.dump_csv( params ) ); } );
1522         }
1523     },
1524
1525     'dump_csv_to_printer' : function(params) {
1526         var obj = this;
1527         if (typeof params == 'undefined') params = {};
1528         JSAN.use('util.print'); var print = new util.print(params.printer_context || obj.printer_context);
1529         if (params.no_full_retrieve) {
1530             print.simple( obj.dump_csv( params ), {'content_type':'text/plain'} );
1531         } else {
1532             obj.wrap_in_full_retrieve( 
1533                 function() { 
1534                     print.simple( obj.dump_csv( params ), {'content_type':'text/plain'} );
1535                 }
1536             );
1537         }
1538     },
1539
1540     'dump_extended_format_to_printer' : function(params) {
1541         var obj = this;
1542         if (typeof params == 'undefined') params = {};
1543         JSAN.use('util.print'); var print = new util.print(params.printer_context || obj.printer_context);
1544         if (params.no_full_retrieve) {
1545             print.simple( obj.dump_extended_format( params ), {'content_type':'text/plain'} );
1546         } else {
1547             obj.wrap_in_full_retrieve( 
1548                 function() { 
1549                     print.simple( obj.dump_extended_format( params ), {'content_type':'text/plain'} );
1550                 }
1551             );
1552         }
1553     },
1554
1555     'dump_csv_to_file' : function(params) {
1556         var obj = this;
1557         JSAN.use('util.file'); var f = new util.file();
1558         if (typeof params == 'undefined') params = {};
1559         if (params.no_full_retrieve) {
1560             params.data = obj.dump_csv( params );
1561             params.not_json = true;
1562             if (!params.title) params.title = document.getElementById('offlineStrings').getString('list.save_csv_as');
1563             f.export_file( params );
1564         } else {
1565             obj.wrap_in_full_retrieve( 
1566                 function() { 
1567                     params.data = obj.dump_csv( params );
1568                     params.not_json = true;
1569                     if (!params.title) params.title = document.getElementById('offlineStrings').getString('list.save_csv_as');
1570                     f.export_file( params );
1571                 }
1572             );
1573         }
1574     },
1575
1576     'print' : function(params) {
1577         if (!params) params = {};
1578         switch(this.node.nodeName) {
1579             case 'tree' : return this._print_tree(params); break;
1580             default: throw('NYI: Need ._print() for ' + this.node.nodeName); break;
1581         }
1582     },
1583
1584     '_print_tree' : function(params) {
1585         var obj = this;
1586         try {
1587             var data = obj.data; data.stash_retrieve();
1588             if (!params.staff && data.list.au && data.list.au[0]) {
1589                 params.staff = data.list.au[0];
1590             }
1591             if (!params.lib && data.list.au && data.list.au[0] && data.list.au[0].ws_ou() && data.hash.aou && data.hash.aou[ data.list.au[0].ws_ou() ]) {
1592                 params.lib = data.hash.aou[ data.list.au[0].ws_ou() ];
1593                 params.lib.children(null);
1594             }
1595             if (params.template && data.print_list_templates[ params.template ]) {
1596                 var template = data.print_list_templates[ params.template ];
1597                 if (template.inherit) {
1598                     template = data.print_list_templates[ template.inherit ];
1599                     // if someone wants to implement recursion later, feel free
1600                 }
1601                 for (var i in template) params[i] = template[i];
1602             }
1603             obj.wrap_in_full_retrieve(
1604                 function() {
1605                     try {
1606                         if (!params.list) params.list = obj.dump_with_keys();
1607                         JSAN.use('util.print'); var print = new util.print(params.printer_context || obj.printer_context);
1608                         print.tree_list( params );
1609                         if (typeof params.callback == 'function') params.callback();
1610                     } catch(E) {
1611                         obj.error.standard_unexpected_error_alert('inner _print_tree',E);
1612                     }
1613                 }
1614             );
1615             
1616         } catch(E) {
1617             obj.error.standard_unexpected_error_alert('_print_tree',E);
1618         }
1619     },
1620
1621     'dump_selected_with_keys' : function(params) {
1622         var obj = this;
1623         switch(this.node.nodeName) {
1624             case 'tree' : return this._dump_tree_selection_with_keys(params); break;
1625             default: throw('NYI: Need .dump_selection_with_keys() for ' + this.node.nodeName); break;
1626         }
1627
1628     },
1629
1630     '_dump_tree_selection_with_keys' : function(params) {
1631         var obj = this;
1632         var dump = [];
1633         var list = obj._retrieve_selection_from_tree();
1634         for (var i = 0; i < list.length; i++) {
1635             var row = {};
1636             var treeitem = list[i];
1637             var treerow = treeitem.firstChild;
1638             for (var j = 0; j < treerow.childNodes.length; j++) {
1639                 var value = treerow.childNodes[j].getAttribute('label');
1640                 if (params.skip_hidden_columns) if (obj.node.treeBoxObject.columns.getColumnAt(j).element.getAttribute('hidden') == 'true') continue;
1641                 if (typeof obj.columns[j] == 'undefined') {
1642                     dump('=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=\n');
1643                     dump('_dump_tree_selection_with_keys @ ' + location.href + '\n');
1644                     dump('\ttreerow.childNodes.length='+treerow.childNodes.length+' j='+j+' obj.columns.length='+obj.columns.length+'\n');
1645                     debugger;
1646                 } else {
1647                     var id = obj.columns[j].id; if (params.labels_instead_of_ids) id = obj.columns[j].label;
1648                     row[ id ] = value;
1649                 }
1650             }
1651             dump.push( row );
1652         }
1653         return dump;
1654     },
1655
1656     'clipboard' : function(params) {
1657         try {
1658             var obj = this;
1659             var dump = obj.dump_selected_with_keys({'skip_hidden_columns':true,'labels_instead_of_ids':true});
1660             obj.data.stash_retrieve();
1661             obj.data.list_clipboard = dump; obj.data.stash('list_clipboard');
1662             JSAN.use('util.window'); var win = new util.window();
1663             win.open(urls.XUL_LIST_CLIPBOARD,'list_clipboard','chrome,resizable,modal');
1664             window.focus(); // sometimes the main window will lower after a clipboard action
1665         } catch(E) {
1666             this.error.standard_unexpected_error_alert('clipboard',E);
1667         }
1668     },
1669
1670     'dump_retrieve_ids' : function(params) {
1671         var obj = this;
1672         switch(this.node.nodeName) {
1673             case 'tree' : return this._dump_retrieve_ids_tree(params); break;
1674             default: throw('NYI: Need .dump_retrieve_ids() for ' + this.node.nodeName); break;
1675         }
1676     },
1677
1678     '_dump_retrieve_ids_tree' : function(params) {
1679         var obj = this;
1680         var dump = [];
1681         for (var i = 0; i < this.treechildren.childNodes.length; i++) {
1682             var treeitem = this.treechildren.childNodes[i];
1683             dump.push( treeitem.getAttribute('retrieve_id') );
1684         }
1685         return dump;
1686     },
1687
1688     'wrap_in_full_retrieve' : function(f) {
1689         var obj = this;
1690         if (typeof obj.on_all_fleshed == 'function') { // legacy
1691             obj.on_all_fleshed = [ obj.on_all_fleshed ];
1692         }
1693         if (! obj.on_all_fleshed) obj.on_all_fleshed = [];
1694         obj.on_all_fleshed.push(f);
1695         obj.full_retrieve();
1696     },
1697
1698     '_sort_tree' : function() {
1699         var obj = this;
1700         try {
1701             if (obj.node.getAttribute('no_sort')) {
1702                 return;
1703             }
1704
1705             var sorts = [ obj.first_sort ].concat( obj.sub_sorts );
1706             var columns = util.functional.map_list(
1707                 sorts,
1708                 function(e,idx) {
1709                     return e.target;
1710                 }
1711             );
1712             var column_positions = [];
1713             for (var i = 0; i < columns.length; i++) {
1714                 for (var j = 0; j < obj.columns.length; j++) {
1715                     if (obj.columns[j].id == columns[i].id) {
1716                         column_positions.push( function(a){return a;}(j) );
1717                     }
1718                 }
1719             }
1720             obj.wrap_in_full_retrieve(
1721                 function() {
1722                     try {
1723                         JSAN.use('util.money');
1724                         var rows = [];
1725                         var treeitems = obj.treechildren.childNodes;
1726                         for (var i = 0; i < treeitems.length; i++) {
1727                             var treeitem = treeitems[i];
1728                             var treerow = treeitem.firstChild;
1729
1730                             function get_value(treecell) {
1731                                 value = ( {
1732                                     'value' : treecell
1733                                         ? treecell.getAttribute('label')
1734                                         : '',
1735                                     'sort_value' : treecell ? treecell.hasAttribute('sort_value')
1736                                         ? JSON2js(
1737                                             treecell.getAttribute('sort_value'))
1738                                         : '' : ''
1739                                 } );
1740                                 return value;
1741                             }
1742
1743                             var values = [];
1744                             for (var j = 0; j < column_positions.length; j++) {
1745                                 var treecell = treerow.childNodes[ column_positions[j] ];
1746                                 values.push({
1747                                     'position' : column_positions[j],
1748                                     'value' : get_value(treecell)
1749                                 });
1750                             }
1751
1752                             rows.push({
1753                                 'values' : values,
1754                                 'node' : treeitem
1755                             });
1756                         }
1757                         rows = rows.sort( function(A,B) {
1758                             function normalize(a,b,p) {
1759                                 if (a.sort_value) {
1760                                     a = a.sort_value;
1761                                     b = b.sort_value;
1762                                 } else {
1763                                     a = a.value;
1764                                     b = b.value;
1765                                     if (obj.columns[p].getAttribute('sort_type')) {
1766                                         switch(obj.columns[p].getAttribute('sort_type')) {
1767                                             case 'date' :
1768                                                 JSAN.use('util.date'); // to pull in dojo.date.locale
1769                                                 a = dojo.date.locale.parse(a,{});
1770                                                 b = dojo.date.locale.parse(b,{});
1771                                             break;
1772                                             case 'number' :
1773                                                 a = Number(a); b = Number(b);
1774                                             break;
1775                                             case 'money' :
1776                                                 a = util.money.dollars_float_to_cents_integer(a);
1777                                                 b = util.money.dollars_float_to_cents_integer(b);
1778                                             break;
1779                                             case 'title' : /* special case for "a" and "the".  doesn't use marc 245 indicator */
1780                                                 a = String( a ).toUpperCase().replace( /^\s*(THE|A|AN)\s+/, '' );
1781                                                 b = String( b ).toUpperCase().replace( /^\s*(THE|A|AN)\s+/, '' );
1782                                             break;
1783                                             default:
1784                                                 a = String( a ).toUpperCase();
1785                                                 b = String( b ).toUpperCase();
1786                                             break;
1787                                         }
1788                                     } else {
1789                                         if (typeof a == 'string' || typeof b == 'string') {
1790                                             a = String( a ).toUpperCase();
1791                                             b = String( b ).toUpperCase();
1792                                         }
1793                                     }
1794                                 }
1795                                 return [ a, b ];
1796                             }
1797
1798                             for (var i = 0; i < sorts.length; i++) {
1799                                 var values;
1800                                 if (sorts[i].sortDir == 'asc') {
1801                                     values = normalize(
1802                                         A['values'][i]['value'],
1803                                         B['values'][i]['value'],
1804                                         A['values'][i]['position']
1805                                     );
1806                                 } else {
1807                                     values = normalize(
1808                                         B['values'][i]['value'],
1809                                         A['values'][i]['value'],
1810                                         A['values'][i]['position']
1811                                     );
1812                                 }
1813                                 if (values[0] < values[1] ) {
1814                                     return -1;
1815                                 }
1816                                 if (values[0] > values[1] ) {
1817                                     return 1;
1818                                 }
1819                             }
1820                             return 0; 
1821                         } );
1822                         while(obj.treechildren.lastChild) obj.treechildren.removeChild( obj.treechildren.lastChild );
1823                         for (var i = 0; i < rows.length; i++) {
1824                             obj.treechildren.appendChild( rows[i].node );
1825                         }
1826                         if (typeof obj.on_sort == 'function') obj.on_sort();
1827                     } catch(E) {
1828                         obj.error.standard_unexpected_error_alert('sorting',E); 
1829                     }
1830                     obj.refresh_ordinals();
1831                 }
1832             );
1833         } catch(E) {
1834             obj.error.standard_unexpected_error_alert('pre sorting', E);
1835         }
1836     },
1837
1838     '_toggle_checkbox_column' : function(col,toggle) {
1839         var obj = this;
1840         try {
1841             if (obj.node.getAttribute('no_toggle')) {
1842                 return;
1843             }
1844             var col_pos;
1845             for (var i = 0; i < obj.columns.length; i++) { 
1846                 if (obj.columns[i].id == col.id) col_pos = function(a){return a;}(i); 
1847             }
1848             var treeitems = obj.treechildren.childNodes;
1849             for (var i = 0; i < treeitems.length; i++) {
1850                 var treeitem = treeitems[i];
1851                 var treerow = treeitem.firstChild;
1852                 var treecell = treerow.childNodes[ col_pos ];
1853                 treecell.setAttribute('value',(toggle == 'on'));
1854             }
1855             if (typeof obj.on_checkbox_toggle == 'function') obj.on_checkbox_toggle(toggle);
1856         } catch(E) {
1857             obj.error.standard_unexpected_error_alert('pre toggle', E);
1858         }
1859     },
1860
1861     'render_list_actions' : function(params) {
1862         var obj = this;
1863         switch(this.node.nodeName) {
1864             case 'tree' : return this._render_list_actions_for_tree(params); break;
1865             default: throw('NYI: Need ._render_list_actions() for ' + this.node.nodeName); break;
1866         }
1867     },
1868
1869     '_render_list_actions_for_tree' : function(params) {
1870         var obj = this;
1871         try {
1872             var btn = document.createElement('button');
1873             btn.setAttribute('id',obj.node.id + '_list_actions');
1874             btn.setAttribute('type','menu');
1875             btn.setAttribute('allowevents','true');
1876             //btn.setAttribute('oncommand','this.firstChild.showPopup();');
1877             btn.setAttribute('label',document.getElementById('offlineStrings').getString('list.actions.menu.label'));
1878             btn.setAttribute('accesskey',document.getElementById('offlineStrings').getString('list.actions.menu.accesskey'));
1879             var mp = document.createElement('menupopup');
1880             btn.appendChild(mp);
1881             var mi = document.createElement('menuitem');
1882             mi.setAttribute('id',obj.node.id + '_clipfield');
1883             mi.setAttribute('disabled','true');
1884             mi.setAttribute('label',document.getElementById('offlineStrings').getString('list.actions.field_to_clipboard.label'));
1885             mi.setAttribute('accesskey',document.getElementById('offlineStrings').getString('list.actions.field_to_clipboard.accesskey'));
1886             mp.appendChild(mi);
1887             mi = document.createElement('menuitem');
1888             mi.setAttribute('id',obj.node.id + '_csv_to_clipboard');
1889             mi.setAttribute('label',document.getElementById('offlineStrings').getString('list.actions.csv_to_clipboard.label'));
1890             mi.setAttribute('accesskey',document.getElementById('offlineStrings').getString('list.actions.csv_to_clipboard.accesskey'));
1891             mp.appendChild(mi);
1892             mi = document.createElement('menuitem');
1893             mi.setAttribute('id',obj.node.id + '_csv_to_printer');
1894             mi.setAttribute('label',document.getElementById('offlineStrings').getString('list.actions.csv_to_printer.label'));
1895             mi.setAttribute('accesskey',document.getElementById('offlineStrings').getString('list.actions.csv_to_printer.accesskey'));
1896             mp.appendChild(mi);
1897             mi = document.createElement('menuitem');
1898             mi.setAttribute('id',obj.node.id + '_extended_to_printer');
1899             mi.setAttribute('label',document.getElementById('offlineStrings').getString('list.actions.extended_to_printer.label'));
1900             mi.setAttribute('accesskey',document.getElementById('offlineStrings').getString('list.actions.extended_to_printer.accesskey'));
1901             mp.appendChild(mi);
1902             mi = document.createElement('menuitem');
1903             mi.setAttribute('id',obj.node.id + '_csv_to_file');
1904             mi.setAttribute('label',document.getElementById('offlineStrings').getString('list.actions.csv_to_file.label'));
1905             mi.setAttribute('accesskey',document.getElementById('offlineStrings').getString('list.actions.csv_to_file.accesskey'));
1906             mp.appendChild(mi);
1907             mi = document.createElement('menuitem');
1908             mi.setAttribute('id',obj.node.id + '_save_columns');
1909             mi.setAttribute('label',document.getElementById('offlineStrings').getString('list.actions.save_column_configuration.label'));
1910             mi.setAttribute('accesskey',document.getElementById('offlineStrings').getString('list.actions.save_column_configuration.accesskey'));
1911             if (obj.data.hash.aous['gui.disable_local_save_columns']) {
1912                 mi.setAttribute('disabled','true');
1913             }
1914             mp.appendChild(mi);
1915             return btn;
1916         } catch(E) {
1917             obj.error.standard_unexpected_error_alert('rendering list actions',E);
1918         }
1919     },
1920
1921     'set_list_actions' : function(params) {
1922         var obj = this;
1923         switch(this.node.nodeName) {
1924             case 'tree' : return this._set_list_actions_for_tree(params); break;
1925             default: throw('NYI: Need ._set_list_actions() for ' + this.node.nodeName); break;
1926         }
1927     },
1928
1929     '_set_list_actions_for_tree' : function(params) {
1930         // This should be called after the button element from render_list_actions has been appended to the DOM
1931         var obj = this;
1932         try {
1933             var x = document.getElementById(obj.node.id + '_clipfield');
1934             if (x) {
1935                 x.addEventListener(
1936                     'command',
1937                     function() {
1938                         obj.clipboard(params);
1939                         if (params && typeof params.on_complete == 'function') {
1940                             params.on_complete(params);
1941                         }
1942                     },
1943                     false
1944                 );
1945             }
1946             x = document.getElementById(obj.node.id + '_csv_to_clipboard');
1947             if (x) {
1948                 x.addEventListener(
1949                     'command',
1950                     function() {
1951                         obj.dump_csv_to_clipboard(params);
1952                         if (params && typeof params.on_complete == 'function') {
1953                             params.on_complete(params);
1954                         }
1955                     },
1956                     false
1957                 );
1958             }
1959             x = document.getElementById(obj.node.id + '_csv_to_printer');
1960             if (x) {
1961                 x.addEventListener(
1962                     'command',
1963                     function() {
1964                         obj.dump_csv_to_printer(params);
1965                         if (params && typeof params.on_complete == 'function') {
1966                             params.on_complete(params);
1967                         }
1968                     },
1969                     false
1970                 );
1971             }
1972             x = document.getElementById(obj.node.id + '_extended_to_printer');
1973             if (x) {
1974                 x.addEventListener(
1975                     'command',
1976                     function() {
1977                         obj.dump_extended_format_to_printer(params);
1978                         if (params && typeof params.on_complete == 'function') {
1979                             params.on_complete(params);
1980                         }
1981                     },
1982                     false
1983                 );
1984             }
1985
1986             x = document.getElementById(obj.node.id + '_csv_to_file');
1987             if (x) {
1988                 x.addEventListener(
1989                     'command',
1990                     function() {
1991                         obj.dump_csv_to_file(params);
1992                         if (params && typeof params.on_complete == 'function') {
1993                             params.on_complete(params);
1994                         }
1995                     },
1996                     false
1997                 );
1998             }
1999             x = document.getElementById(obj.node.id + '_save_columns');
2000             if (x) {
2001                 x.addEventListener(
2002                     'command',
2003                     function() {
2004                         obj.save_columns(params);
2005                         if (params && typeof params.on_complete == 'function') {
2006                             params.on_complete(params);
2007                         }
2008                     },
2009                     false
2010                 );
2011             }
2012
2013         } catch(E) {
2014             obj.error.standard_unexpected_error_alert('setting list actions',E);
2015         }
2016     },
2017
2018     // Takes fieldmapper class name and attempts to spit out column definitions suitable for .init
2019     'fm_columns' : function(hint,column_extras,prefix) {
2020         var obj = this;
2021         var columns = [];
2022         if (!prefix) { prefix = ''; }
2023         try {
2024             // requires the dojo library fieldmapper.autoIDL
2025             if (typeof fieldmapper == 'undefined') { throw 'fieldmapper undefined'; }
2026             if (typeof fieldmapper.IDL == 'undefined') { throw 'fieldmapper.IDL undefined'; }
2027             if (typeof fieldmapper.IDL.fmclasses == 'undefined') { throw 'fieldmapper.IDL.fmclasses undefined'; }
2028             if (typeof fieldmapper.IDL.fmclasses[hint] == 'undefined') { throw 'fieldmapper.IDL.fmclasses.' + hint + ' undefined'; }
2029             var my_class = fieldmapper.IDL.fmclasses[hint]; 
2030             var data = obj.data; data.stash_retrieve();
2031
2032             function col_def(my_field) {
2033                 var col_id = prefix + hint + '_' + my_field.name;
2034                 var dataobj = hint;
2035                 var datafield = my_field.name;
2036                 var fleshed_display_field;
2037                 if (column_extras) {
2038                     if (column_extras['*']) {
2039                         if (column_extras['*']['dataobj']) {
2040                             dataobj = column_extras['*']['dataobj'];
2041                         }
2042                     }
2043                     if (column_extras[col_id]) {
2044                         if (column_extras[col_id]['dataobj']) {
2045                             dataobj = column_extras[col_id]['dataobj'];
2046                         }
2047                         if (column_extras[col_id]['datafield']) {
2048                             datafield = column_extras[col_id]['datafield'];
2049                         }
2050                         if (column_extras[col_id]['fleshed_display_field']) {
2051                             fleshed_display_field = column_extras[col_id]['fleshed_display_field'];
2052                         }
2053                     }
2054                 }
2055                 var def = {
2056                     'id' : col_id,
2057                     'label' : my_field.label || my_field.name,
2058                     'sort_type' : [ 'int', 'float', 'id', 'number' ].indexOf(my_field.datatype) > -1 ? 'number' : 
2059                         ( my_field.datatype == 'money' ? 'money' : 
2060                         ( my_field.datatype == 'timestamp' ? 'date' : 'default')),
2061                     'hidden' : my_field.virtual || my_field.datatype == 'link',
2062                     'flex' : 1
2063                 };                    
2064                 // my_field.datatype => bool float id int interval link money number org_unit text timestamp
2065                 if (my_field.datatype == 'link') {
2066                     def.render = function(my) { 
2067                         // is the object fleshed?
2068                         return my[dataobj][datafield]() && typeof my[dataobj][datafield]() == 'object'
2069                             // yes, show the display field
2070                             ? my[dataobj][datafield]()[fleshed_display_field||my_field.key]()
2071                             // no, do we have its class in data.hash?
2072                             : ( typeof data.hash[ my[dataobj].Structure.field_map[datafield].class ] != 'undefined'
2073                                 // yes, do we have this particular object cached?
2074                                 ? ( data.hash[ my[dataobj].Structure.field_map[datafield].class ][ my[dataobj][datafield]() ]
2075                                     // yes, show the display field
2076                                     ? data.hash[ my[dataobj].Structure.field_map[datafield].class ][ my[dataobj][datafield]() ][
2077                                         fleshed_display_field||my_field.key
2078                                     ]()
2079                                     // no, just show the raw value
2080                                     : my[dataobj][datafield]()
2081                                 )
2082                                 // no, just show the raw value
2083                                 : my[dataobj][datafield]()
2084                             ); 
2085                     }
2086                 } else {
2087                     def.render = function(my) { return my[dataobj][datafield](); }
2088                 }
2089                 if (my_field.datatype == 'timestamp') {
2090                     JSAN.use('util.date');
2091                     def.render = function(my) {
2092                         return util.date.formatted_date( my[dataobj][datafield](), '%{localized}' );
2093                     }
2094                     def.sort_value = function(my) {
2095                         return util.date.db_date2Date( my[dataobj][datafield]() ).getTime();
2096                     }
2097                 }
2098                 if (my_field.datatype == 'org_unit') {
2099                     def.render = function(my) {
2100                         return typeof my[dataobj][datafield]() == 'object' ? my[dataobj][datafield]().shortname() : data.hash.aou[ my[dataobj][datafield]() ].shortname();
2101                     }
2102                 }
2103                 if (my_field.datatype == 'money') {
2104                     JSAN.use('util.money');
2105                     def.render = function(my) {
2106                         return util.money.sanitize( my[dataobj][datafield]() );
2107                     }
2108                     def.sort_value = function(my) {
2109                         return util.money.dollars_float_to_cents_integer( my[dataobj][datafield]() );
2110                     }
2111                 }
2112                 if (column_extras) {
2113                     if (column_extras['*']) {
2114                         for (var attr in column_extras['*']) {
2115                             def[attr] = column_extras['*'][attr];
2116                         }
2117                         if (column_extras['*']['expanded_label']) {
2118                             def.label = my_class.label + ': ' + def.label;
2119                         }
2120                         if (column_extras['*']['label_prefix']) {
2121                             def.label = column_extras['*']['label_prefix'] + def.label;
2122                         }
2123                         if (column_extras['*']['remove_virtual']) {
2124                             if (my_field.virtual) {
2125                                 def.remove_me = true;
2126                             }
2127                         }
2128                     }
2129                     if (column_extras[col_id]) {
2130                         for (var attr in column_extras[col_id]) {
2131                             def[attr] = column_extras[col_id][attr];
2132                         }
2133                         if (column_extras[col_id]['keep_me']) {
2134                             def.remove_me = false;
2135                         }
2136                         if (column_extras[col_id]['label_prefix']) {
2137                             def.label = column_extras[col_id]['label_prefix'] + def.label;
2138                         }
2139                     }
2140                 }
2141                 if (def.remove_me) {
2142                     dump('Skipping ' + def.label + '\n');
2143                     return null;
2144                 } else {
2145                     dump('Defining ' + def.label + '\n');
2146                     return def;
2147                 }
2148             }
2149  
2150             for (var i = 0; i < my_class.fields.length; i++) {
2151                 var my_field = my_class.fields[i];
2152                 var def = col_def(my_field);
2153                 if (def) {
2154                     columns.push( def );
2155                 }
2156             }
2157
2158         } catch(E) {
2159             obj.error.standard_unexpected_error_alert('fm_columns()',E);
2160         }
2161         return columns;
2162     },
2163     // Default for the map_row_to_columns function for .init
2164     'std_map_row_to_columns' : function(error_value) {
2165         return function(row,cols,scratch) {
2166             // row contains { 'my' : { 'acp' : {}, 'circ' : {}, 'mvr' : {} } }
2167             // cols contains all of the objects listed above in columns
2168             // scratch is a temporary space shared by all cells/rows (or just per row if not explicitly passed in)
2169             if (!scratch) { scratch = {}; }
2170
2171             var obj = {};
2172             JSAN.use('util.error'); obj.error = new util.error();
2173             JSAN.use('OpenILS.data'); obj.data = new OpenILS.data(); obj.data.init({'via':'stash'});
2174             JSAN.use('util.network'); obj.network = new util.network();
2175             JSAN.use('util.money');
2176
2177             var my = row.my;
2178             var values = [];
2179             var sort_values = [];
2180             var cmd = '';
2181             try {
2182                 for (var i = 0; i < cols.length; i++) {
2183                     switch (typeof cols[i].render) {
2184                         case 'function': try { values[i] = cols[i].render(my,scratch); } catch(E) { values[i] = error_value; obj.error.sdump('D_COLUMN_RENDER_ERROR',E); } break;
2185                         case 'string' : cmd += 'try { ' + cols[i].render + '; values['+i+'] = v; } catch(E) { values['+i+'] = error_value; }'; break;
2186                         default: cmd += 'values['+i+'] = "??? '+(typeof cols[i].render)+'"; ';
2187                     }
2188                     switch (typeof cols[i].sort_value) {
2189                         case 'function':
2190                             try {
2191                                 sort_values[i] = cols[i].sort_value(my,scratch);
2192                             } catch(E) {
2193                                 sort_values[i] = error_value;
2194                                 obj.error.sdump('D_COLUMN_RENDER_ERROR',E);
2195                             }
2196                         break;
2197                         case 'string' :
2198                             cmd += 'try { '
2199                                 + cols[i].sort_value
2200                                 + '; values['
2201                                 + i
2202                                 +'] = v; } catch(E) { sort_values['
2203                                 + i
2204                                 + '] = error_value; }';
2205                         break;
2206                         default:
2207                             cmd += 'sort_values['+i+'] = values[' + i + '];';
2208                     }
2209                 }
2210                 if (cmd) eval( cmd );
2211             } catch(E) {
2212                 obj.error.sdump('D_WARN','map_row_to_column: ' + E);
2213                 if (error_value) { value = error_value; } else { value = '   ' };
2214             }
2215             return { 'values' : values, 'sort_values' : sort_values };
2216         }
2217     }
2218 }
2219 dump('exiting util.list.js\n');