Ignore null fleshed objects in autofleshing grid columns
[working/Evergreen.git] / Open-ILS / web / js / ui / default / staff / services / grid.js
1 angular.module('egGridMod', 
2     ['egCoreMod', 'egUiMod', 'ui.bootstrap'])
3
4 .directive('egGrid', function() {
5     return {
6         restrict : 'AE',
7         transclude : true,
8         scope : {
9
10             // IDL class hint (e.g. "aou")
11             idlClass : '@',
12
13             // default page size
14             pageSize : '@',
15
16             // if true, grid columns are derived from all non-virtual
17             // fields on the base idlClass
18             autoFields : '@',
19
20             // grid preferences will be stored / retrieved with this key
21             persistKey : '@',
22
23             // field whose value is unique and may be used for item
24             // reference / lookup.  This will usually be someting like
25             // "id".  This is not needed when using autoFields, since we
26             // can determine the primary key directly from the IDL.
27             idField : '@',
28
29             // Reference to externally provided egGridDataProvider
30             itemsProvider : '=',
31
32             // Reference to externally provided item-selection handler
33             onSelect : '=',
34
35             // Reference to externally provided after-item-selection handler
36             afterSelect : '=',
37
38             // comma-separated list of supported or disabled grid features
39             // supported features:
40             //  startSelected : init the grid with all rows selected by default
41             //  allowAll : add an "All" option to row count (really 10000)
42             //  -menu : don't show any menu buttons (or use space for them)
43             //  -picker : don't show the column picker
44             //  -pagination : don't show any pagination elements, and set
45             //                the limit to 10000
46             //  -actions : don't show the actions dropdown
47             //  -index : don't show the row index column (can't use "index"
48             //           as the idField in this case)
49             //  -display : columns are hidden by default
50             //  -sort    : columns are unsortable by default 
51             //  -multisort : sort priorities config disabled by default
52             //  -multiselect : only one row at a time can be selected;
53             //                 choosing this also disables the checkbox
54             //                 column
55             features : '@',
56
57             // optional primary grid label
58             mainLabel : '@',
59
60             // if true, use the IDL class label as the mainLabel
61             autoLabel : '=', 
62
63             // optional context menu label
64             menuLabel : '@',
65
66             // Hash of control functions.
67             //
68             //  These functions are defined by the calling scope and 
69             //  invoked as-is by the grid w/ the specified parameters.
70             //
71             //  itemRetrieved     : function(item) {}
72             //  allItemsRetrieved : function() {}
73             //
74             //  ---
75             //  If defined, the grid will watch the return value from
76             //  the function defined at watchQuery on each digest and 
77             //  re-draw the grid when query changes occur.
78             //
79             //  watchQuery : function() { /* return grid query */ }
80             //
81             //  ---------------
82             //  These functions are defined by the grid and thus
83             //  replace any values defined for these attributes from the
84             //  calling scope.
85             //
86             //  activateItem  : function(item) {}
87             //  allItems      : function(allItems) {}
88             //  selectedItems : function(selected) {}
89             //  selectItems   : function(ids) {}
90             //  setQuery      : function(queryStruct) {} // causes reload
91             //  setSort       : function(sortSturct) {} // causes reload
92             gridControls : '=',
93         },
94
95         // TODO: avoid hard-coded url
96         templateUrl : '/eg/staff/share/t_autogrid', 
97
98         link : function(scope, element, attrs) {     
99             // link() is called after page compilation, which means our
100             // eg-grid-field's have been parsed and loaded.  Now it's 
101             // safe to perform our initial page load.
102
103             // load auto fields after eg-grid-field's so they are not clobbered
104             scope.handleAutoFields();
105             scope.collect();
106
107             scope.grid_element = element;
108             $(element)
109                 .find('.eg-grid-content-body')
110                 .bind('contextmenu', scope.showActionContextMenu);
111         },
112
113         controller : [
114                     '$scope','$q','egCore','egGridFlatDataProvider','$location',
115                     'egGridColumnsProvider','$filter','$window','$sce','$timeout',
116             function($scope,  $q , egCore,  egGridFlatDataProvider , $location,
117                      egGridColumnsProvider , $filter , $window , $sce , $timeout) {
118
119             var grid = this;
120
121             grid.init = function() {
122                 grid.offset = 0;
123                 $scope.items = [];
124                 $scope.showGridConf = false;
125                 grid.totalCount = -1;
126                 $scope.selected = {};
127                 $scope.actionGroups = [{actions:[]}]; // Grouped actions for selected items
128                 $scope.menuItems = []; // global actions
129
130                 var features = ($scope.features) ? 
131                     $scope.features.split(',') : [];
132                 delete $scope.features;
133
134                 $scope.showIndex = (features.indexOf('-index') == -1);
135
136                 $scope.allowAll = (features.indexOf('allowAll') > -1);
137                 $scope.startSelected = $scope.selectAll = (features.indexOf('startSelected') > -1);
138                 $scope.showActions = (features.indexOf('-actions') == -1);
139                 $scope.showPagination = (features.indexOf('-pagination') == -1);
140                 $scope.showPicker = (features.indexOf('-picker') == -1);
141
142                 $scope.showMenu = (features.indexOf('-menu') == -1);
143
144                 // remove some unneeded values from the scope to reduce bloat
145
146                 grid.idlClass = $scope.idlClass;
147                 delete $scope.idlClass;
148
149                 grid.persistKey = $scope.persistKey;
150                 delete $scope.persistKey;
151
152                 var stored_limit = 0;
153                 if ($scope.showPagination) {
154                     if (grid.persistKey) {
155                         var stored_limit = Number(
156                             egCore.hatch.getLocalItem('eg.grid.' + grid.persistKey + '.limit')
157                         );
158                     }
159                 } else {
160                     stored_limit = 10000; // maybe support "Inf"?
161                 }
162
163                 grid.limit = Number(stored_limit) || Number($scope.pageSize) || 25;
164
165                 grid.indexField = $scope.idField;
166                 delete $scope.idField;
167
168                 grid.dataProvider = $scope.itemsProvider;
169
170                 if (!grid.indexField && grid.idlClass)
171                     grid.indexField = egCore.idl.classes[grid.idlClass].pkey;
172
173                 grid.columnsProvider = egGridColumnsProvider.instance({
174                     idlClass : grid.idlClass,
175                     defaultToHidden : (features.indexOf('-display') > -1),
176                     defaultToNoSort : (features.indexOf('-sort') > -1),
177                     defaultToNoMultiSort : (features.indexOf('-multisort') > -1)
178                 });
179                 $scope.canMultiSelect = (features.indexOf('-multiselect') == -1);
180
181                 $scope.handleAutoFields = function() {
182                     if ($scope.autoFields) {
183                         if (grid.autoLabel) {
184                             $scope.mainLabel = 
185                                 egCore.idl.classes[grid.idlClass].label;
186                         }
187                         grid.columnsProvider.compileAutoColumns();
188                         delete $scope.autoFields;
189                     }
190                 }
191    
192                 if (!grid.dataProvider) {
193                     // no provider, um, provided.
194                     // Use a flat data provider
195
196                     grid.selfManagedData = true;
197                     grid.dataProvider = egGridFlatDataProvider.instance({
198                         indexField : grid.indexField,
199                         idlClass : grid.idlClass,
200                         columnsProvider : grid.columnsProvider,
201                         query : $scope.query
202                     });
203                 }
204
205                 $scope.itemFieldValue = grid.dataProvider.itemFieldValue;
206                 $scope.indexValue = function(item) {
207                     return grid.indexValue(item)
208                 };
209
210                 grid.applyControlFunctions();
211
212                 grid.loadConfig().then(function() { 
213                     // link columns to scope after loadConfig(), since it
214                     // replaces the columns array.
215                     $scope.columns = grid.columnsProvider.columns;
216                 });
217
218                 // NOTE: grid.collect() is first called from link(), not here.
219             }
220
221             // link our control functions into the gridControls 
222             // scope object so the caller can access them.
223             grid.applyControlFunctions = function() {
224
225                 // we use some of these controls internally, so sett
226                 // them up even if the caller doesn't request them.
227                 var controls = $scope.gridControls || {};
228
229                 controls.columnMap = function() {
230                     var m = {};
231                     angular.forEach(grid.columnsProvider.columns, function (c) {
232                         m[c.name] = c;
233                     });
234                     return m;
235                 }
236
237                 controls.columnsProvider = function() {
238                     return grid.columnsProvider;
239                 }
240
241                 // link in the control functions
242                 controls.selectedItems = function() {
243                     return grid.getSelectedItems()
244                 }
245
246                 controls.allItems = function() {
247                     return $scope.items;
248                 }
249
250                 controls.selectItems = function(ids) {
251                     if (!ids) return;
252                     $scope.selected = {};
253                     angular.forEach(ids, function(i) {
254                         $scope.selected[''+i] = true;
255                     });
256                 }
257
258                 // if the caller provided a functional setQuery,
259                 // extract the value before replacing it
260                 if (controls.setQuery) {
261                     grid.dataProvider.query = 
262                         controls.setQuery();
263                 }
264
265                 controls.setQuery = function(query) {
266                     grid.dataProvider.query = query;
267                     controls.refresh();
268                 }
269
270                 if (controls.watchQuery) {
271                     // capture the initial query value
272                     grid.dataProvider.query = controls.watchQuery();
273
274                     // watch for changes
275                     $scope.gridWatchQuery = controls.watchQuery;
276                     $scope.$watch('gridWatchQuery()', function(newv) {
277                         controls.setQuery(newv);
278                     }, true);
279                 }
280
281                 // if the caller provided a functional setSort
282                 // extract the value before replacing it
283                 grid.dataProvider.sort = 
284                     controls.setSort ?  controls.setSort() : [];
285
286                 controls.setSort = function(sort) {
287                     controls.refresh();
288                 }
289
290                 controls.refresh = function(noReset) {
291                     if (!noReset) grid.offset = 0;
292                     grid.collect();
293                 }
294
295                 controls.setLimit = function(limit,forget) {
296                     if (!forget && grid.persistKey)
297                         egCore.hatch.setLocalItem('eg.grid.' + grid.persistKey + '.limit', limit);
298                     grid.limit = limit;
299                 }
300                 controls.getLimit = function() {
301                     return grid.limit;
302                 }
303                 controls.setOffset = function(offset) {
304                     grid.offset = offset;
305                 }
306                 controls.getOffset = function() {
307                     return grid.offset;
308                 }
309
310                 controls.saveConfig = function () {
311                     return $scope.saveConfig();
312                 }
313
314                 grid.dataProvider.refresh = controls.refresh;
315                 grid.controls = controls;
316             }
317
318             // If a menu item provides its own HTML template, translate it,
319             // using the menu item for the template scope.
320             // note: $sce is required to avoid security restrictions and
321             // is OK here, since the template comes directly from a
322             // local HTML template (not user input).
323             $scope.translateMenuItemTemplate = function(item) {
324                 var html = egCore.strings.$replace(item.template, {item : item});
325                 return $sce.trustAsHtml(html);
326             }
327
328             // add a new (global) grid menu item
329             grid.addMenuItem = function(item) {
330                 $scope.menuItems.push(item);
331                 var handler = item.handler;
332                 item.handler = function() {
333                     $scope.gridMenuIsOpen = false; // close menu
334                     if (handler) {
335                         handler(item, 
336                             item.handlerData, grid.getSelectedItems());
337                     }
338                 }
339             }
340
341             // add a selected-items action
342             grid.addAction = function(act) {
343                 var done = false;
344                 $scope.actionGroups.forEach(function(g){
345                     if (g.label === act.group) {
346                         g.actions.push(act);
347                         done = true;
348                     }
349                 });
350                 if (!done) {
351                     $scope.actionGroups.push({
352                         label : act.group,
353                         actions : [ act ]
354                     });
355                 }
356             }
357
358             // remove the stored column configuration preferenc, then recover 
359             // the column visibility information from the initial page load.
360             $scope.resetColumns = function() {
361                 $scope.gridColumnPickerIsOpen = false;
362                 egCore.hatch.removeItem('eg.grid.' + grid.persistKey)
363                 .then(function() {
364                     grid.columnsProvider.reset(); 
365                     if (grid.selfManagedData) grid.collect();
366                 });
367             }
368
369             $scope.showAllColumns = function() {
370                 $scope.gridColumnPickerIsOpen = false;
371                 grid.columnsProvider.showAllColumns();
372                 if (grid.selfManagedData) grid.collect();
373             }
374
375             $scope.hideAllColumns = function() {
376                 $scope.gridColumnPickerIsOpen = false;
377                 grid.columnsProvider.hideAllColumns();
378                 // note: no need to fetch new data if no columns are visible
379             }
380
381             $scope.toggleColumnVisibility = function(col) {
382                 $scope.gridColumnPickerIsOpen = false;
383                 col.visible = !col.visible;
384
385                 // egGridFlatDataProvider only retrieves data to be
386                 // displayed.  When column visibility changes, it's
387                 // necessary to fetch the newly visible column data.
388                 if (grid.selfManagedData) grid.collect();
389             }
390
391             // save the columns configuration (position, sort, width) to
392             // eg.grid.<persist-key>
393             $scope.saveConfig = function() {
394                 $scope.gridColumnPickerIsOpen = false;
395
396                 if (!grid.persistKey) {
397                     console.warn(
398                         "Cannot save settings without a grid persist-key");
399                     return;
400                 }
401
402                 // only store information about visible columns.
403                 var conf = grid.columnsProvider.columns.filter(
404                     function(col) {return Boolean(col.visible) });
405
406                 // now scrunch the data down to just the needed info
407                 conf = conf.map(function(col) {
408                     var c = {name : col.name}
409                     // Apart from the name, only store non-default values.
410                     // No need to store col.visible, since that's implicit
411                     if (col.align != 'left') c.align = col.align;
412                     if (col.flex != 2) c.flex = col.flex;
413                     if (Number(col.sort)) c.sort = Number(c.sort);
414                     return c;
415                 });
416
417                 egCore.hatch.setItem('eg.grid.' + grid.persistKey, conf)
418                 .then(function() { 
419                     // Save operation performed from the grid configuration UI.
420                     // Hide the configuration UI and re-draw w/ sort applied
421                     if ($scope.showGridConf) 
422                         $scope.toggleConfDisplay();
423                 });
424             }
425
426
427             // load the columns configuration (position, sort, width) from
428             // eg.grid.<persist-key> and apply the loaded settings to the
429             // columns on our columnsProvider
430             grid.loadConfig = function() {
431                 if (!grid.persistKey) return $q.when();
432
433                 return egCore.hatch.getItem('eg.grid.' + grid.persistKey)
434                 .then(function(conf) {
435                     if (!conf) return;
436
437                     var columns = grid.columnsProvider.columns;
438                     var new_cols = [];
439
440                     angular.forEach(conf, function(col) {
441                         var grid_col = columns.filter(
442                             function(c) {return c.name == col.name})[0];
443
444                         if (!grid_col) {
445                             // saved column does not match a column in the 
446                             // current grid.  skip it.
447                             return;
448                         }
449
450                         grid_col.align = col.align || 'left';
451                         grid_col.flex = col.flex || 2;
452                         grid_col.sort = col.sort || 0;
453                         // all saved columns are assumed to be true
454                         grid_col.visible = true;
455                         if (new_cols
456                                 .filter(function (c) {
457                                     return c.name == grid_col.name;
458                                 }).length == 0
459                         )
460                             new_cols.push(grid_col);
461                     });
462
463                     // columns which are not expressed within the saved 
464                     // configuration are marked as non-visible and 
465                     // appended to the end of the new list of columns.
466                     angular.forEach(columns, function(col) {
467                         var found = conf.filter(
468                             function(c) {return (c.name == col.name)})[0];
469                         if (!found) {
470                             col.visible = false;
471                             new_cols.push(col);
472                         }
473                     });
474
475                     grid.columnsProvider.columns = new_cols;
476                     grid.compileSort();
477
478                 });
479             }
480
481             $scope.onContextMenu = function($event) {
482                 var col = angular.element($event.target).attr('column');
483                 console.log('selected column ' + col);
484             }
485
486             $scope.page = function() {
487                 return (grid.offset / grid.limit) + 1;
488             }
489
490             $scope.goToPage = function(page) {
491                 page = Number(page);
492                 if (angular.isNumber(page) && page > 0) {
493                     grid.offset = (page - 1) * grid.limit;
494                     grid.collect();
495                 }
496             }
497
498             $scope.offset = function(o) {
499                 if (angular.isNumber(o))
500                     grid.offset = o;
501                 return grid.offset 
502             }
503
504             $scope.limit = function(l) { 
505                 if (angular.isNumber(l)) {
506                     if (grid.persistKey)
507                         egCore.hatch.setLocalItem('eg.grid.' + grid.persistKey + '.limit', l);
508                     grid.limit = l;
509                 }
510                 return grid.limit 
511             }
512
513             $scope.onFirstPage = function() {
514                 return grid.offset == 0;
515             }
516
517             $scope.hasNextPage = function() {
518                 // we have less data than requested, there must
519                 // not be any more pages
520                 if (grid.count() < grid.limit) return false;
521
522                 // if the total count is not known, assume that a full
523                 // page of data implies more pages are available.
524                 if (grid.totalCount == -1) return true;
525
526                 // we have a full page of data, but is there more?
527                 return grid.totalCount > (grid.offset + grid.count());
528             }
529
530             $scope.incrementPage = function() {
531                 grid.offset += grid.limit;
532                 grid.collect();
533             }
534
535             $scope.decrementPage = function() {
536                 if (grid.offset < grid.limit) {
537                     grid.offset = 0;
538                 } else {
539                     grid.offset -= grid.limit;
540                 }
541                 grid.collect();
542             }
543
544             // number of items loaded for the current page of results
545             grid.count = function() {
546                 return $scope.items.length;
547             }
548
549             // returns the unique identifier value for the provided item
550             // for internal consistency, indexValue is always coerced 
551             // into a string.
552             grid.indexValue = function(item) {
553                 if (angular.isObject(item)) {
554                     if (item !== null) {
555                         if (angular.isFunction(item[grid.indexField]))
556                             return ''+item[grid.indexField]();
557                         return ''+item[grid.indexField]; // flat data
558                     }
559                 }
560                 // passed a non-object; assume it's an index
561                 return ''+item; 
562             }
563
564             // fires the hide handler function for a context action
565             $scope.actionHide = function(action) {
566                 if (typeof action.hide == 'undefined') {
567                     return false;
568                 }
569                 if (angular.isFunction(action.hide))
570                     return action.hide(action);
571                 return action.hide;
572             }
573
574             // fires the disable handler function for a context action
575             $scope.actionDisable = function(action) {
576                 if (typeof action.disabled == 'undefined') {
577                     return false;
578                 }
579                 if (angular.isFunction(action.disabled))
580                     return action.disabled(action);
581                 return action.disabled;
582             }
583
584             // fires the action handler function for a context action
585             $scope.actionLauncher = function(action) {
586                 if (!action.handler) {
587                     console.error(
588                         'No handler specified for "' + action.label + '"');
589                 } else {
590
591                     try {
592                         action.handler(grid.getSelectedItems());
593                     } catch(E) {
594                         console.error('Error executing handler for "' 
595                             + action.label + '" => ' + E + "\n" + E.stack);
596                     }
597
598                     if ($scope.action_context_showing) $scope.hideActionContextMenu();
599                 }
600
601             }
602
603             $scope.hideActionContextMenu = function () {
604                 $($scope.menu_dom).css({
605                     display: '',
606                     width: $scope.action_context_width,
607                     top: $scope.action_context_y,
608                     left: $scope.action_context_x
609                 });
610                 $($scope.action_context_parent).append($scope.menu_dom);
611                 $scope.action_context_oldy = $scope.action_context_oldx = 0;
612                 $('body').unbind('click.remove_context_menu_'+$scope.action_context_index);
613                 $scope.action_context_showing = false;
614             }
615
616             $scope.action_context_showing = false;
617             $scope.showActionContextMenu = function ($event) {
618
619                 // Have to gather these here, instead of inside link()
620                 if (!$scope.menu_dom) $scope.menu_dom = $($scope.grid_element).find('.grid-action-dropdown')[0];
621                 if (!$scope.action_context_parent) $scope.action_context_parent = $($scope.menu_dom).parent();
622
623                 if (!grid.getSelectedItems().length) // Nothing selected, fire the click event
624                     $event.target.click();
625
626                 if (!$scope.action_context_showing) {
627                     $scope.action_context_width = $($scope.menu_dom).css('width');
628                     $scope.action_context_y = $($scope.menu_dom).css('top');
629                     $scope.action_context_x = $($scope.menu_dom).css('left');
630                     $scope.action_context_showing = true;
631                     $scope.action_context_index = Math.floor((Math.random() * 1000) + 1);
632
633                     $('body').append($($scope.menu_dom));
634                     $('body').bind('click.remove_context_menu_'+$scope.action_context_index, $scope.hideActionContextMenu);
635                 }
636
637                 $($scope.menu_dom).css({
638                     display: 'block',
639                     width: $scope.action_context_width,
640                     top: $event.pageY,
641                     left: $event.pageX
642                 });
643
644                 return false;
645             }
646
647             // returns the list of selected item objects
648             grid.getSelectedItems = function() {
649                 return $scope.items.filter(
650                     function(item) {
651                         return Boolean($scope.selected[grid.indexValue(item)]);
652                     }
653                 );
654             }
655
656             grid.getItemByIndex = function(index) {
657                 for (var i = 0; i < $scope.items.length; i++) {
658                     var item = $scope.items[i];
659                     if (grid.indexValue(item) == index) 
660                         return item;
661                 }
662             }
663
664             // selects one row after deselecting all of the others
665             grid.selectOneItem = function(index) {
666                 $scope.selected = {};
667                 $scope.selected[index] = true;
668             }
669
670             // selects or deselects an item, without affecting the others.
671             // returns true if the item is selected; false if de-selected.
672             // we overwrite the object so that we can watch $scope.selected
673             grid.toggleSelectOneItem = function(index) {
674                 if ($scope.selected[index]) {
675                     delete $scope.selected[index];
676                     $scope.selected = angular.copy($scope.selected);
677                     return false;
678                 } else {
679                     $scope.selected[index] = true;
680                     $scope.selected = angular.copy($scope.selected);
681                     return true;
682                 }
683             }
684
685             $scope.updateSelected = function () { 
686                     return $scope.selected = angular.copy($scope.selected);
687             };
688
689             grid.selectAllItems = function() {
690                 angular.forEach($scope.items, function(item) {
691                     $scope.selected[grid.indexValue(item)] = true
692                 }); 
693                 $scope.selected = angular.copy($scope.selected);
694             }
695
696             $scope.$watch('selectAll', function(newVal) {
697                 if (newVal) {
698                     grid.selectAllItems();
699                 } else {
700                     $scope.selected = {};
701                 }
702             });
703
704             if ($scope.onSelect) {
705                 $scope.$watch('selected', function(newVal) {
706                     $scope.onSelect(grid.getSelectedItems());
707                     if ($scope.afterSelect) $scope.afterSelect();
708                 });
709             }
710
711             // returns true if item1 appears in the list before item2;
712             // false otherwise.  this is slightly more efficient that
713             // finding the position of each then comparing them.
714             // item1 / item2 may be an item or an item index
715             grid.itemComesBefore = function(itemOrIndex1, itemOrIndex2) {
716                 var idx1 = grid.indexValue(itemOrIndex1);
717                 var idx2 = grid.indexValue(itemOrIndex2);
718
719                 // use for() for early exit
720                 for (var i = 0; i < $scope.items.length; i++) {
721                     var idx = grid.indexValue($scope.items[i]);
722                     if (idx == idx1) return true;
723                     if (idx == idx2) return false;
724                 }
725                 return false;
726             }
727
728             // 0-based position of item in the current data set
729             grid.indexOf = function(item) {
730                 var idx = grid.indexValue(item);
731                 for (var i = 0; i < $scope.items.length; i++) {
732                     if (grid.indexValue($scope.items[i]) == idx)
733                         return i;
734                 }
735                 return -1;
736             }
737
738             grid.modifyColumnFlex = function(column, val) {
739                 column.flex += val;
740                 // prevent flex:0;  use hiding instead
741                 if (column.flex < 1)
742                     column.flex = 1;
743             }
744             $scope.modifyColumnFlex = function(col, val) {
745                 grid.modifyColumnFlex(col, val);
746             }
747
748             // handles click, control-click, and shift-click
749             $scope.handleRowClick = function($event, item) {
750                 var index = grid.indexValue(item);
751
752                 var origSelected = Object.keys($scope.selected);
753
754                 if (!$scope.canMultiSelect) {
755                     grid.selectOneItem(index);
756                     grid.lastSelectedItemIndex = index;
757                     return;
758                 }
759
760                 if ($event.ctrlKey || $event.metaKey /* mac command */) {
761                     // control-click
762                     if (grid.toggleSelectOneItem(index)) 
763                         grid.lastSelectedItemIndex = index;
764
765                 } else if ($event.shiftKey) { 
766                     // shift-click
767
768                     if (!grid.lastSelectedItemIndex || 
769                             index == grid.lastSelectedItemIndex) {
770                         grid.selectOneItem(index);
771                         grid.lastSelectedItemIndex = index;
772
773                     } else {
774
775                         var selecting = false;
776                         var ascending = grid.itemComesBefore(
777                             grid.lastSelectedItemIndex, item);
778                         var startPos = 
779                             grid.indexOf(grid.lastSelectedItemIndex);
780
781                         // update to new last-selected
782                         grid.lastSelectedItemIndex = index;
783
784                         // select each row between the last selected and 
785                         // currently selected items
786                         while (true) {
787                             startPos += ascending ? 1 : -1;
788                             var curItem = $scope.items[startPos];
789                             if (!curItem) break;
790                             var curIdx = grid.indexValue(curItem);
791                             $scope.selected[curIdx] = true;
792                             if (curIdx == index) break; // all done
793                         }
794                         $scope.selected = angular.copy($scope.selected);
795                     }
796                         
797                 } else {
798                     grid.selectOneItem(index);
799                     grid.lastSelectedItemIndex = index;
800                 }
801             }
802
803             // Builds a sort expression from column sort priorities.
804             // called on page load and any time the priorities are modified.
805             grid.compileSort = function() {
806                 var sortList = grid.columnsProvider.columns.filter(
807                     function(col) { return Number(col.sort) != 0 }
808                 ).sort( 
809                     function(a, b) { 
810                         if (Math.abs(a.sort) < Math.abs(b.sort))
811                             return -1;
812                         return 1;
813                     }
814                 );
815
816                 if (sortList.length) {
817                     grid.dataProvider.sort = sortList.map(function(col) {
818                         var blob = {};
819                         blob[col.name] = col.sort < 0 ? 'desc' : 'asc';
820                         return blob;
821                     });
822                 }
823             }
824
825             // builds a sort expression using a single column, 
826             // toggling between ascending and descending sort.
827             $scope.quickSort = function(col_name) {
828                 var sort = grid.dataProvider.sort;
829                 if (sort && sort.length &&
830                     sort[0] == col_name) {
831                     var blob = {};
832                     blob[col_name] = 'desc';
833                     grid.dataProvider.sort = [blob];
834                 } else {
835                     grid.dataProvider.sort = [col_name];
836                 }
837
838                 grid.offset = 0;
839                 grid.collect();
840             }
841
842             // show / hide the grid configuration row
843             $scope.toggleConfDisplay = function() {
844                 if ($scope.showGridConf) {
845                     $scope.showGridConf = false;
846                     if (grid.columnsProvider.hasSortableColumn()) {
847                         // only refresh the grid if the user has the
848                         // ability to modify the sort priorities.
849                         grid.compileSort();
850                         grid.offset = 0;
851                         grid.collect();
852                     }
853                 } else {
854                     $scope.showGridConf = true;
855                 }
856
857                 $scope.gridColumnPickerIsOpen = false;
858             }
859
860             // called when a dragged column is dropped onto itself
861             // or any other column
862             grid.onColumnDrop = function(target) {
863                 if (angular.isUndefined(target)) return;
864                 if (target == grid.dragColumn) return;
865                 var srcIdx, targetIdx, srcCol;
866                 angular.forEach(grid.columnsProvider.columns,
867                     function(col, idx) {
868                         if (col.name == grid.dragColumn) {
869                             srcIdx = idx;
870                             srcCol = col;
871                         } else if (col.name == target) {
872                             targetIdx = idx;
873                         }
874                     }
875                 );
876
877                 if (srcIdx < targetIdx) targetIdx--;
878
879                 // move src column from old location to new location in 
880                 // the columns array, then force a page refresh
881                 grid.columnsProvider.columns.splice(srcIdx, 1);
882                 grid.columnsProvider.columns.splice(targetIdx, 0, srcCol);
883                 $scope.$apply(); 
884             }
885
886             // prepares a string for inclusion within a CSV document
887             // by escaping commas and quotes and removing newlines.
888             grid.csvDatum = function(str) {
889                 str = ''+str;
890                 if (!str) return '';
891                 str = str.replace(/\n/g, '');
892                 if (str.match(/\,/) || str.match(/"/)) {                                     
893                     str = str.replace(/"/g, '""');
894                     str = '"' + str + '"';                                           
895                 } 
896                 return str;
897             }
898
899             // sets the download file name and inserts the current CSV
900             // into a Blob URL for browser download.
901             $scope.generateCSVExportURL = function() {
902                 $scope.gridColumnPickerIsOpen = false;
903
904                 // let the file name describe the grid
905                 $scope.csvExportFileName = 
906                     ($scope.mainLabel || grid.persistKey || 'eg_grid_data')
907                     .replace(/\s+/g, '_') + '_' + $scope.page();
908
909                 // toss the CSV into a Blob and update the export URL
910                 var csv = grid.generateCSV();
911                 var blob = new Blob([csv], {type : 'text/plain'});
912                 $scope.csvExportURL = 
913                     ($window.URL || $window.webkitURL).createObjectURL(blob);
914             }
915
916             $scope.printCSV = function() {
917                 $scope.gridColumnPickerIsOpen = false;
918                 egCore.print.print({
919                     context : 'default', 
920                     content : grid.generateCSV(),
921                     content_type : 'text/plain'
922                 });
923             }
924
925             // generates CSV for the currently visible grid contents
926             grid.generateCSV = function() {
927                 var csvStr = '';
928                 var colCount = grid.columnsProvider.columns.length;
929
930                 // columns
931                 angular.forEach(grid.columnsProvider.columns,
932                     function(col) {
933                         if (!col.visible) return;
934                         csvStr += grid.csvDatum(col.label);
935                         csvStr += ',';
936                     }
937                 );
938
939                 csvStr = csvStr.replace(/,$/,'\n');
940
941                 // items
942                 angular.forEach($scope.items, function(item) {
943                     angular.forEach(grid.columnsProvider.columns, 
944                         function(col) {
945                             if (!col.visible) return;
946                             // bare value
947                             var val = grid.dataProvider.itemFieldValue(item, col);
948                             // filtered value (dates, etc.)
949                             val = $filter('egGridValueFilter')(val, col);
950                             csvStr += grid.csvDatum(val);
951                             csvStr += ',';
952                         }
953                     );
954                     csvStr = csvStr.replace(/,$/,'\n');
955                 });
956
957                 return csvStr;
958             }
959
960             // Interpolate the value for column.linkpath within the context
961             // of the row item to generate the final link URL.
962             $scope.generateLinkPath = function(col, item) {
963                 return egCore.strings.$replace(col.linkpath, {item : item});
964             }
965
966             // If a column provides its own HTML template, translate it,
967             // using the current item for the template scope.
968             // note: $sce is required to avoid security restrictions and
969             // is OK here, since the template comes directly from a
970             // local HTML template (not user input).
971             $scope.translateCellTemplate = function(col, item) {
972                 var html = egCore.strings.$replace(col.template, {item : item});
973                 return $sce.trustAsHtml(html);
974             }
975
976             $scope.collect = function() { grid.collect() }
977
978             // asks the dataProvider for a page of data
979             grid.collect = function() {
980
981                 // avoid firing the collect if there is nothing to collect.
982                 if (grid.selfManagedData && !grid.dataProvider.query) return;
983
984                 if (grid.collecting) return; // avoid parallel collect()
985                 grid.collecting = true;
986
987                 console.debug('egGrid.collect() offset=' 
988                     + grid.offset + '; limit=' + grid.limit);
989
990                 // ensure all of our dropdowns are closed
991                 // TODO: git rid of these and just use dropdown-toggle, 
992                 // which is more reliable.
993                 $scope.gridColumnPickerIsOpen = false;
994                 $scope.gridRowCountIsOpen = false;
995                 $scope.gridPageSelectIsOpen = false;
996
997                 $scope.items = [];
998                 $scope.selected = {};
999                 grid.dataProvider.get(grid.offset, grid.limit).then(
1000                 function() {
1001                     if (grid.controls.allItemsRetrieved)
1002                         grid.controls.allItemsRetrieved();
1003                 },
1004                 null, 
1005                 function(item) {
1006                     if (item) {
1007                         $scope.items.push(item)
1008                         if (grid.controls.itemRetrieved)
1009                             grid.controls.itemRetrieved(item);
1010                         if ($scope.selectAll)
1011                             $scope.selected[grid.indexValue(item)] = true
1012                     }
1013                 }).finally(function() { 
1014                     console.debug('egGrid.collect() complete');
1015                     grid.collecting = false 
1016                     $scope.selected = angular.copy($scope.selected);
1017                 });
1018             }
1019
1020             grid.init();
1021         }]
1022     };
1023 })
1024
1025 /**
1026  * eg-grid-field : used for collecting custom field data from the templates.
1027  * This directive does not direct display, it just passes data up to the 
1028  * parent grid.
1029  */
1030 .directive('egGridField', function() {
1031     return {
1032         require : '^egGrid',
1033         restrict : 'AE',
1034         scope : {
1035             flesher: '=', // optional; function that can flesh a linked field, given the value
1036             name  : '@', // required; unique name
1037             path  : '@', // optional; flesh path
1038             ignore: '@', // optional; fields to ignore when path is a wildcard
1039             label : '@', // optional; display label
1040             flex  : '@',  // optional; default flex width
1041             align  : '@',  // optional; default alignment, left/center/right
1042             dateformat : '@', // optional: passed down to egGridValueFilter
1043
1044             // if a field is part of an IDL object, but we are unable to
1045             // determine the class, because it's nested within a hash
1046             // (i.e. we can't navigate directly to the object via the IDL),
1047             // idlClass lets us specify the class.  This is particularly
1048             // useful for nested wildcard fields.
1049             parentIdlClass : '@', 
1050
1051             // optional: for non-IDL columns, specifying a datatype
1052             // lets the caller control which display filter is used.
1053             // datatype should match the standard IDL datatypes.
1054             datatype : '@'
1055         },
1056         link : function(scope, element, attrs, egGridCtrl) {
1057
1058             // boolean fields are presented as value-less attributes
1059             angular.forEach(
1060                 [
1061                     'visible', 
1062                     'hidden', 
1063                     'sortable', 
1064                     'nonsortable',
1065                     'multisortable',
1066                     'nonmultisortable',
1067                     'required' // if set, always fetch data for this column
1068                 ],
1069                 function(field) {
1070                     if (angular.isDefined(attrs[field]))
1071                         scope[field] = true;
1072                 }
1073             );
1074
1075             // any HTML content within the field is its custom template
1076             var tmpl = element.html();
1077             if (tmpl && !tmpl.match(/^\s*$/))
1078                 scope.template = tmpl
1079
1080             egGridCtrl.columnsProvider.add(scope);
1081             scope.$destroy();
1082         }
1083     };
1084 })
1085
1086 /**
1087  * eg-grid-action : used for specifying actions which may be applied
1088  * to items within the grid.
1089  */
1090 .directive('egGridAction', function() {
1091     return {
1092         require : '^egGrid',
1093         restrict : 'AE',
1094         transclude : true,
1095         scope : {
1096             group   : '@', // Action group, ungrouped if not set
1097             label   : '@', // Action label
1098             handler : '=',  // Action function handler
1099             hide    : '=',
1100             disabled : '=', // function
1101             divider : '='
1102         },
1103         link : function(scope, element, attrs, egGridCtrl) {
1104             egGridCtrl.addAction({
1105                 hide  : scope.hide,
1106                 group : scope.group,
1107                 label : scope.label,
1108                 divider : scope.divider,
1109                 handler : scope.handler,
1110                 disabled : scope.disabled,
1111             });
1112             scope.$destroy();
1113         }
1114     };
1115 })
1116
1117 .factory('egGridColumnsProvider', ['egCore', function(egCore) {
1118
1119     function ColumnsProvider(args) {
1120         var cols = this;
1121         cols.columns = [];
1122         cols.stockVisible = [];
1123         cols.idlClass = args.idlClass;
1124         cols.defaultToHidden = args.defaultToHidden;
1125         cols.defaultToNoSort = args.defaultToNoSort;
1126         cols.defaultToNoMultiSort = args.defaultToNoMultiSort;
1127
1128         // resets column width, visibility, and sort behavior
1129         // Visibility resets to the visibility settings defined in the 
1130         // template (i.e. the original egGridField values).
1131         cols.reset = function() {
1132             angular.forEach(cols.columns, function(col) {
1133                 col.align = 'left';
1134                 col.flex = 2;
1135                 col.sort = 0;
1136                 if (cols.stockVisible.indexOf(col.name) > -1) {
1137                     col.visible = true;
1138                 } else {
1139                     col.visible = false;
1140                 }
1141             });
1142         }
1143
1144         // returns true if any columns are sortable
1145         cols.hasSortableColumn = function() {
1146             return cols.columns.filter(
1147                 function(col) {
1148                     return col.sortable || col.multisortable;
1149                 }
1150             ).length > 0;
1151         }
1152
1153         cols.showAllColumns = function() {
1154             angular.forEach(cols.columns, function(column) {
1155                 column.visible = true;
1156             });
1157         }
1158
1159         cols.hideAllColumns = function() {
1160             angular.forEach(cols.columns, function(col) {
1161                 delete col.visible;
1162             });
1163         }
1164
1165         cols.indexOf = function(name) {
1166             for (var i = 0; i < cols.columns.length; i++) {
1167                 if (cols.columns[i].name == name) 
1168                     return i;
1169             }
1170             return -1;
1171         }
1172
1173         cols.findColumn = function(name) {
1174             return cols.columns[cols.indexOf(name)];
1175         }
1176
1177         cols.compileAutoColumns = function() {
1178             var idl_class = egCore.idl.classes[cols.idlClass];
1179
1180             angular.forEach(
1181                 idl_class.fields,
1182                 function(field) {
1183                     if (field.virtual) return;
1184                     if (field.datatype == 'link' || field.datatype == 'org_unit') {
1185                         // if the field is a link and the linked class has a
1186                         // "selector" field specified, use the selector field
1187                         // as the display field for the columns.
1188                         // flattener will take care of the fleshing.
1189                         if (field['class']) {
1190                             var selector_field = egCore.idl.classes[field['class']].fields
1191                                 .filter(function(f) { return Boolean(f.selector) })[0];
1192                             if (selector_field) {
1193                                 field.path = field.name + '.' + selector_field.selector;
1194                             }
1195                         }
1196                     }
1197                     cols.add(field, true);
1198                 }
1199             );
1200         }
1201
1202         // if a column definition has a path with a wildcard, create
1203         // columns for all non-virtual fields at the specified 
1204         // position in the path.
1205         cols.expandPath = function(colSpec) {
1206
1207             var ignoreList = [];
1208             if (colSpec.ignore)
1209                 ignoreList = colSpec.ignore.split(' ');
1210
1211             var dotpath = colSpec.path.replace(/\.?\*$/,'');
1212             var class_obj;
1213             var idl_field;
1214
1215             if (colSpec.parentIdlClass) {
1216                 class_obj = egCore.idl.classes[colSpec.parentIdlClass];
1217             } else {
1218                 class_obj = egCore.idl.classes[cols.idlClass];
1219             }
1220             var idl_parent = class_obj;
1221             var old_field_label = '';
1222
1223             if (!class_obj) return;
1224
1225             console.debug('egGrid: auto dotpath is: ' + dotpath);
1226             var path_parts = dotpath.split(/\./);
1227
1228             // find the IDL class definition for the last element in the
1229             // path before the .*
1230             // an empty path_parts means expand the root class
1231             if (path_parts) {
1232                 var old_field;
1233                 for (var path_idx in path_parts) {
1234                     old_field = idl_field;
1235
1236                     var part = path_parts[path_idx];
1237                     idl_field = class_obj.field_map[part];
1238
1239                     // unless we're at the end of the list, this field should
1240                     // link to another class.
1241                     if (idl_field && idl_field['class'] && (
1242                         idl_field.datatype == 'link' || 
1243                         idl_field.datatype == 'org_unit')) {
1244                         if (old_field_label) old_field_label += ' : ';
1245                         old_field_label += idl_field.label;
1246                         class_obj = egCore.idl.classes[idl_field['class']];
1247                         if (old_field) idl_parent = old_field;
1248                     } else {
1249                         if (path_idx < (path_parts.length - 1)) {
1250                             // we ran out of classes to hop through before
1251                             // we ran out of path components
1252                             console.error("egGrid: invalid IDL path: " + dotpath);
1253                         }
1254                     }
1255                 }
1256             }
1257
1258             if (class_obj) {
1259                 angular.forEach(class_obj.fields, function(field) {
1260
1261                     // Only show wildcard fields where we have data to show
1262                     // Virtual and un-fleshed links will not have any data.
1263                     if (field.virtual ||
1264                         (field.datatype == 'link' || field.datatype == 'org_unit') ||
1265                         ignoreList.indexOf(field.name) > -1
1266                     )
1267                         return;
1268
1269                     var col = cols.cloneFromScope(colSpec);
1270                     col.path = (dotpath ? dotpath + '.' + field.name : field.name);
1271
1272                     // log line below is very chatty.  disable until needed.
1273                     // console.debug('egGrid: field: ' +field.name + '; parent field: ' + js2JSON(idl_parent));
1274                     cols.add(col, false, true, 
1275                         {idl_parent : idl_parent, idl_field : field, idl_class : class_obj, field_parent_label : old_field_label });
1276                 });
1277
1278                 cols.columns = cols.columns.sort(
1279                     function(a, b) {
1280                         if (a.explicit) return -1;
1281                         if (b.explicit) return 1;
1282
1283                         if (a.idlclass && b.idlclass) {
1284                             if (a.idlclass < b.idlclass) return -1;
1285                             if (b.idlclass < a.idlclass) return 1;
1286                         }
1287
1288                         if (a.path && b.path && a.path.lastIndexOf('.') && b.path.lastIndexOf('.')) {
1289                             if (a.path.substring(0, a.path.lastIndexOf('.')) < b.path.substring(0, b.path.lastIndexOf('.'))) return -1;
1290                             if (b.path.substring(0, b.path.lastIndexOf('.')) < a.path.substring(0, a.path.lastIndexOf('.'))) return 1;
1291                         }
1292
1293                         if (a.label && b.label) {
1294                             if (a.label < b.label) return -1;
1295                             if (b.label < a.label) return 1;
1296                         }
1297
1298                         return a.name < b.name ? -1 : 1;
1299                     }
1300                 );
1301
1302
1303             } else {
1304                 console.error(
1305                     "egGrid: wildcard path does not resolve to an object: "
1306                     + dotpath);
1307             }
1308         }
1309
1310         // angular.clone(scopeObject) is not permittable.  Manually copy
1311         // the fields over that we need (so the scope object can go away).
1312         cols.cloneFromScope = function(colSpec) {
1313             return {
1314                 flesher  : colSpec.flesher,
1315                 name  : colSpec.name,
1316                 label : colSpec.label,
1317                 path  : colSpec.path,
1318                 align  : colSpec.align || 'left',
1319                 flex  : Number(colSpec.flex) || 2,
1320                 sort  : Number(colSpec.sort) || 0,
1321                 required : colSpec.required,
1322                 linkpath : colSpec.linkpath,
1323                 template : colSpec.template,
1324                 visible  : colSpec.visible,
1325                 hidden   : colSpec.hidden,
1326                 datatype : colSpec.datatype,
1327                 sortable : colSpec.sortable,
1328                 nonsortable      : colSpec.nonsortable,
1329                 multisortable    : colSpec.multisortable,
1330                 nonmultisortable : colSpec.nonmultisortable,
1331                 dateformat       : colSpec.dateformat,
1332                 parentIdlClass   : colSpec.parentIdlClass
1333             };
1334         }
1335
1336
1337         // Add a column to the columns collection.
1338         // Columns may come from a slim eg-columns-field or 
1339         // directly from the IDL.
1340         cols.add = function(colSpec, fromIDL, fromExpand, idl_info) {
1341
1342             // First added column with the specified path takes precedence.
1343             // This allows for specific definitions followed by wildcard
1344             // definitions.  If a match is found, back out.
1345             if (cols.columns.filter(function(c) {
1346                 return (c.path == colSpec.path) })[0]) {
1347                 console.debug('skipping pre-existing column ' + colSpec.path);
1348                 return;
1349             }
1350
1351             var column = fromExpand ? colSpec : cols.cloneFromScope(colSpec);
1352
1353             if (column.path && column.path.match(/\*$/)) 
1354                 return cols.expandPath(colSpec);
1355
1356             if (!fromExpand) column.explicit = true;
1357
1358             if (!column.name) column.name = column.path;
1359             if (!column.path) column.path = column.name;
1360
1361             if (column.visible || (!cols.defaultToHidden && !column.hidden))
1362                 column.visible = true;
1363
1364             if (column.sortable || (!cols.defaultToNoSort && !column.nonsortable))
1365                 column.sortable = true;
1366
1367             if (column.multisortable || 
1368                 (!cols.defaultToNoMultiSort && !column.nonmultisortable))
1369                 column.multisortable = true;
1370
1371             cols.columns.push(column);
1372
1373             // Track which columns are visible by default in case we
1374             // need to reset column visibility
1375             if (column.visible) 
1376                 cols.stockVisible.push(column.name);
1377
1378             if (fromIDL) return; // directly from egIDL.  nothing left to do.
1379
1380             // lookup the matching IDL field
1381             if (!idl_info && cols.idlClass) 
1382                 idl_info = cols.idlFieldFromPath(column.path);
1383
1384             if (!idl_info) {
1385                 // column is not represented within the IDL
1386                 column.adhoc = true; 
1387                 return; 
1388             }
1389
1390             column.datatype = idl_info.idl_field.datatype;
1391             
1392             if (!column.label) {
1393                 column.label = idl_info.idl_field.label || column.name;
1394             }
1395
1396             if (fromExpand && idl_info.idl_class) {
1397                 column.idlclass = '';
1398                 if (idl_info.field_parent_label && idl_info.idl_parent.label != idl_info.idl_class.label) {
1399                     column.idlclass = (idl_info.field_parent_label || idl_info.idl_parent.label || idl_info.idl_parent.name);
1400                 } else {
1401                     column.idlclass += idl_info.idl_class.label || idl_info.idl_class.name;
1402                 }
1403             }
1404         },
1405
1406         // finds the IDL field from the dotpath, using the columns
1407         // idlClass as the base.
1408         cols.idlFieldFromPath = function(dotpath) {
1409             var class_obj = egCore.idl.classes[cols.idlClass];
1410             var path_parts = dotpath.split(/\./);
1411
1412             var idl_parent;
1413             var idl_field;
1414             for (var path_idx in path_parts) {
1415                 var part = path_parts[path_idx];
1416                 idl_parent = idl_field;
1417                 idl_field = class_obj.field_map[part];
1418
1419                 if (idl_field && idl_field['class'] && (
1420                     idl_field.datatype == 'link' || 
1421                     idl_field.datatype == 'org_unit')) {
1422                     class_obj = egCore.idl.classes[idl_field['class']];
1423                 }
1424                 // else, path is not in the IDL, which is fine
1425             }
1426
1427             if (!idl_field) return null;
1428
1429             return {
1430                 idl_parent: idl_parent,
1431                 idl_field : idl_field,
1432                 idl_class : class_obj
1433             };
1434         }
1435     }
1436
1437     return {
1438         instance : function(args) { return new ColumnsProvider(args) }
1439     }
1440 }])
1441
1442
1443 /*
1444  * Generic data provider template class.  This is basically an abstract
1445  * class factory service whose instances can be locally modified to 
1446  * meet the needs of each individual grid.
1447  */
1448 .factory('egGridDataProvider', 
1449            ['$q','$timeout','$filter','egCore',
1450     function($q , $timeout , $filter , egCore) {
1451
1452         function GridDataProvider(args) {
1453             var gridData = this;
1454             if (!args) args = {};
1455
1456             gridData.sort = [];
1457             gridData.get = args.get;
1458             gridData.query = args.query;
1459             gridData.idlClass = args.idlClass;
1460             gridData.columnsProvider = args.columnsProvider;
1461
1462             // Delivers a stream of array data via promise.notify()
1463             // Useful for passing an array of data to egGrid.get()
1464             // If a count is provided, the array will be trimmed to
1465             // the range defined by count and offset
1466             gridData.arrayNotifier = function(arr, offset, count) {
1467                 if (!arr || arr.length == 0) return $q.when();
1468                 if (count) arr = arr.slice(offset, offset + count);
1469                 var def = $q.defer();
1470                 // promise notifications are only witnessed when delivered
1471                 // after the caller has his hands on the promise object
1472                 $timeout(function() {
1473                     angular.forEach(arr, def.notify);
1474                     def.resolve();
1475                 });
1476                 return def.promise;
1477             }
1478
1479             // Calls the grid refresh function.  Once instantiated, the
1480             // grid will replace this function with it's own refresh()
1481             gridData.refresh = function(noReset) { }
1482
1483             if (!gridData.get) {
1484                 // returns a promise whose notify() delivers items
1485                 gridData.get = function(index, count) {
1486                     console.error("egGridDataProvider.get() not implemented");
1487                 }
1488             }
1489
1490             // attempts a flat field lookup first.  If the column is not
1491             // found on the top-level object, attempts a nested lookup
1492             // TODO: consider a caching layer to speed up template 
1493             // rendering, particularly for nested objects?
1494             gridData.itemFieldValue = function(item, column) {
1495                 var val;
1496                 if (column.name in item) {
1497                     if (typeof item[column.name] == 'function') {
1498                         val = item[column.name]();
1499                     } else {
1500                         val = item[column.name];
1501                     }
1502                 } else {
1503                     val = gridData.nestedItemFieldValue(item, column);
1504                 }
1505
1506                 return val;
1507             }
1508
1509             // TODO: deprecate me
1510             gridData.flatItemFieldValue = function(item, column) {
1511                 console.warn('gridData.flatItemFieldValue deprecated; '
1512                     + 'leave provider.itemFieldValue unset');
1513                 return item[column.name];
1514             }
1515
1516             // given an object and a dot-separated path to a field,
1517             // extract the value of the field.  The path can refer
1518             // to function names or object attributes.  If the final
1519             // value is an IDL field, run the value through its
1520             // corresponding output filter.
1521             gridData.nestedItemFieldValue = function(obj, column) {
1522                 item = obj; // keep a copy around
1523
1524                 if (obj === null || obj === undefined || obj === '') return '';
1525                 if (!column.path) return obj;
1526
1527                 var idl_field;
1528                 var parts = column.path.split('.');
1529
1530                 angular.forEach(parts, function(step, idx) {
1531                     // object is not fleshed to the expected extent
1532                     if (typeof obj != 'object') {
1533                         if (typeof obj != 'undefined' && column.flesher) {
1534                             obj = column.flesher(obj, column, item);
1535                         } else {
1536                             obj = '';
1537                             return;
1538                         }
1539                     }
1540
1541                     if (!obj) return '';
1542
1543                     var cls = obj.classname;
1544                     if (cls && (class_obj = egCore.idl.classes[cls])) {
1545                         idl_field = class_obj.field_map[step];
1546                         obj = obj[step] ? obj[step]() : '';
1547                     } else {
1548                         if (angular.isFunction(obj[step])) {
1549                             obj = obj[step]();
1550                         } else {
1551                             obj = obj[step];
1552                         }
1553                     }
1554                 });
1555
1556                 // We found a nested IDL object which may or may not have 
1557                 // been configured as a top-level column.  Grab the datatype.
1558                 if (idl_field && !column.datatype) 
1559                     column.datatype = idl_field.datatype;
1560
1561                 if (obj === null || obj === undefined || obj === '') return '';
1562                 return obj;
1563             }
1564         }
1565
1566         return {
1567             instance : function(args) {
1568                 return new GridDataProvider(args);
1569             }
1570         };
1571     }
1572 ])
1573
1574
1575 // Factory service for egGridDataManager instances, which are
1576 // responsible for collecting flattened grid data.
1577 .factory('egGridFlatDataProvider', 
1578            ['$q','egCore','egGridDataProvider',
1579     function($q , egCore , egGridDataProvider) {
1580
1581         return {
1582             instance : function(args) {
1583                 var provider = egGridDataProvider.instance(args);
1584
1585                 provider.get = function(offset, count) {
1586
1587                     // no query means no call
1588                     if (!provider.query || 
1589                             angular.equals(provider.query, {})) 
1590                         return $q.when();
1591
1592                     // find all of the currently visible columns
1593                     var queryFields = {}
1594                     angular.forEach(provider.columnsProvider.columns, 
1595                         function(col) {
1596                             // only query IDL-tracked columns
1597                             if (!col.adhoc && (col.required || col.visible))
1598                                 queryFields[col.name] = col.path;
1599                         }
1600                     );
1601
1602                     return egCore.net.request(
1603                         'open-ils.fielder',
1604                         'open-ils.fielder.flattened_search',
1605                         egCore.auth.token(), provider.idlClass, 
1606                         queryFields, provider.query,
1607                         {   sort : provider.sort,
1608                             limit : count,
1609                             offset : offset
1610                         }
1611                     );
1612                 }
1613                 //provider.itemFieldValue = provider.flatItemFieldValue;
1614                 return provider;
1615             }
1616         };
1617     }
1618 ])
1619
1620 .directive('egGridColumnDragSource', function() {
1621     return {
1622         restrict : 'A',
1623         require : '^egGrid',
1624         link : function(scope, element, attrs, egGridCtrl) {
1625             angular.element(element).attr('draggable', 'true');
1626
1627             element.bind('dragstart', function(e) {
1628                 egGridCtrl.dragColumn = attrs.column;
1629                 egGridCtrl.dragType = attrs.dragType || 'move'; // or resize
1630                 egGridCtrl.colResizeDir = 0;
1631
1632                 if (egGridCtrl.dragType == 'move') {
1633                     // style the column getting moved
1634                     angular.element(e.target).addClass(
1635                         'eg-grid-column-move-handle-active');
1636                 }
1637             });
1638
1639             element.bind('dragend', function(e) {
1640                 if (egGridCtrl.dragType == 'move') {
1641                     angular.element(e.target).removeClass(
1642                         'eg-grid-column-move-handle-active');
1643                 }
1644             });
1645         }
1646     };
1647 })
1648
1649 .directive('egGridColumnDragDest', function() {
1650     return {
1651         restrict : 'A',
1652         require : '^egGrid',
1653         link : function(scope, element, attrs, egGridCtrl) {
1654
1655             element.bind('dragover', function(e) { // required for drop
1656                 e.stopPropagation();
1657                 e.preventDefault();
1658                 e.dataTransfer.dropEffect = 'move';
1659
1660                 if (egGridCtrl.colResizeDir == 0) return; // move
1661
1662                 var cols = egGridCtrl.columnsProvider;
1663                 var srcCol = egGridCtrl.dragColumn;
1664                 var srcColIdx = cols.indexOf(srcCol);
1665
1666                 if (egGridCtrl.colResizeDir == -1) {
1667                     if (cols.indexOf(attrs.column) <= srcColIdx) {
1668                         egGridCtrl.modifyColumnFlex(
1669                             egGridCtrl.columnsProvider.findColumn(
1670                                 egGridCtrl.dragColumn), -1);
1671                         if (cols.columns[srcColIdx+1]) {
1672                             // source column shrinks by one, column to the
1673                             // right grows by one.
1674                             egGridCtrl.modifyColumnFlex(
1675                                 cols.columns[srcColIdx+1], 1);
1676                         }
1677                         scope.$apply();
1678                     }
1679                 } else {
1680                     if (cols.indexOf(attrs.column) > srcColIdx) {
1681                         egGridCtrl.modifyColumnFlex( 
1682                             egGridCtrl.columnsProvider.findColumn(
1683                                 egGridCtrl.dragColumn), 1);
1684                         if (cols.columns[srcColIdx+1]) {
1685                             // source column grows by one, column to the 
1686                             // right grows by one.
1687                             egGridCtrl.modifyColumnFlex(
1688                                 cols.columns[srcColIdx+1], -1);
1689                         }
1690
1691                         scope.$apply();
1692                     }
1693                 }
1694             });
1695
1696             element.bind('dragenter', function(e) {
1697                 e.stopPropagation();
1698                 e.preventDefault();
1699                 if (egGridCtrl.dragType == 'move') {
1700                     angular.element(e.target).addClass('eg-grid-col-hover');
1701                 } else {
1702                     // resize grips are on the right side of each column.
1703                     // dragenter will either occur on the source column 
1704                     // (dragging left) or the column to the right.
1705                     if (egGridCtrl.colResizeDir == 0) {
1706                         if (egGridCtrl.dragColumn == attrs.column) {
1707                             egGridCtrl.colResizeDir = -1; // west
1708                         } else {
1709                             egGridCtrl.colResizeDir = 1; // east
1710                         }
1711                     }
1712                 }
1713             });
1714
1715             element.bind('dragleave', function(e) {
1716                 e.stopPropagation();
1717                 e.preventDefault();
1718                 if (egGridCtrl.dragType == 'move') {
1719                     angular.element(e.target).removeClass('eg-grid-col-hover');
1720                 }
1721             });
1722
1723             element.bind('drop', function(e) {
1724                 e.stopPropagation();
1725                 e.preventDefault();
1726                 egGridCtrl.colResizeDir = 0;
1727                 if (egGridCtrl.dragType == 'move') {
1728                     angular.element(e.target).removeClass('eg-grid-col-hover');
1729                     egGridCtrl.onColumnDrop(attrs.column); // move the column
1730                 }
1731             });
1732         }
1733     };
1734 })
1735  
1736 .directive('egGridMenuItem', function() {
1737     return {
1738         restrict : 'AE',
1739         require : '^egGrid',
1740         scope : {
1741             label : '@',  
1742             checkbox : '@',  
1743             checked : '=',  
1744             standalone : '=',  
1745             handler : '=', // onclick handler function
1746             divider : '=', // if true, show a divider only
1747             handlerData : '=', // if set, passed as second argument to handler
1748             disabled : '=', // function
1749             hidden : '=' // function
1750         },
1751         link : function(scope, element, attrs, egGridCtrl) {
1752             egGridCtrl.addMenuItem({
1753                 checkbox : scope.checkbox,
1754                 checked : scope.checked ? true : false,
1755                 label : scope.label,
1756                 standalone : scope.standalone ? true : false,
1757                 handler : scope.handler,
1758                 divider : scope.divider,
1759                 disabled : scope.disabled,
1760                 hidden : scope.hidden,
1761                 handlerData : scope.handlerData
1762             });
1763             scope.$destroy();
1764         }
1765     };
1766 })
1767
1768
1769
1770 /**
1771  * Translates bare IDL object values into display values.
1772  * 1. Passes dates through the angular date filter
1773  * 2. Translates bools to Booleans so the browser can display translated 
1774  *    value.  (Though we could manually translate instead..)
1775  * Others likely to follow...
1776  */
1777 .filter('egGridValueFilter', ['$filter', function($filter) {                         
1778     return function(value, column) {                                             
1779         switch(column.datatype) {                                                
1780             case 'bool':                                                       
1781                 switch(value) {
1782                     // Browser will translate true/false for us                    
1783                     case 't' : 
1784                     case '1' :  // legacy
1785                     case true:
1786                         return ''+true;
1787                     case 'f' : 
1788                     case '0' :  // legacy
1789                     case false:
1790                         return ''+false;
1791                     // value may be null,  '', etc.
1792                     default : return '';
1793                 }
1794             case 'timestamp':                                                  
1795                 // canned angular date filter FTW                              
1796                 if (!column.dateformat) 
1797                     column.dateformat = 'shortDate';
1798                 return $filter('date')(value, column.dateformat);
1799             case 'money':                                                  
1800                 return $filter('currency')(value);
1801             default:                                                           
1802                 return value;                                                  
1803         }                                                                      
1804     }                                                                          
1805 }]);
1806