1 angular.module('egGridMod',
2 ['egCoreMod', 'egUiMod', 'ui.bootstrap'])
4 .directive('egGrid', function() {
10 // IDL class hint (e.g. "aou")
16 // if true, grid columns are derived from all non-virtual
17 // fields on the base idlClass
20 // grid preferences will be stored / retrieved with this key
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.
29 // Reference to externally provided egGridDataProvider
32 // Reference to externally provided item-selection handler
35 // Reference to externally provided after-item-selection handler
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
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
57 // optional: object containing function to conditionally apply
61 // optional: object that enables status icon field and contains
62 // function to handle what status icons should exist and why.
65 // optional primary grid label
68 // if true, use the IDL class label as the mainLabel
71 // optional context menu label
74 dateformat : '@', // optional: passed down to egGridValueFilter
75 datecontext: '@', // optional: passed down to egGridValueFilter to choose TZ
76 datefilter: '@', // optional: passed down to egGridValueFilter to choose specialized date filters
77 dateonlyinterval: '@', // optional: passed down to egGridValueFilter to choose a "better" format
79 // Hash of control functions.
81 // These functions are defined by the calling scope and
82 // invoked as-is by the grid w/ the specified parameters.
84 // collectStarted : function() {}
85 // itemRetrieved : function(item) {}
86 // allItemsRetrieved : function() {}
89 // If defined, the grid will watch the return value from
90 // the function defined at watchQuery on each digest and
91 // re-draw the grid when query changes occur.
93 // watchQuery : function() { /* return grid query */ }
96 // These functions are defined by the grid and thus
97 // replace any values defined for these attributes from the
100 // activateItem : function(item) {}
101 // allItems : function(allItems) {}
102 // selectedItems : function(selected) {}
103 // selectItems : function(ids) {}
104 // setQuery : function(queryStruct) {} // causes reload
105 // setSort : function(sortSturct) {} // causes reload
109 // TODO: avoid hard-coded url
110 templateUrl : '/eg/staff/share/t_autogrid',
112 link : function(scope, element, attrs) {
114 // Give the grid config loading steps time to fetch the
115 // workstation setting and apply columns before loading data.
116 var loadPromise = scope.configLoadPromise || $q.when();
117 loadPromise.then(function() {
119 // load auto fields after eg-grid-field's so they are not clobbered
120 scope.handleAutoFields();
123 scope.grid_element = element;
126 $(element).attr('id', attrs.persistKey);
130 .find('.eg-grid-content-body')
131 .bind('contextmenu', scope.showActionContextMenu);
136 '$scope','$q','egCore','egGridFlatDataProvider','$location',
137 'egGridColumnsProvider','$filter','$window','$sce','$timeout',
138 'egProgressDialog','$uibModal','egConfirmDialog','egStrings',
139 function($scope, $q , egCore, egGridFlatDataProvider , $location,
140 egGridColumnsProvider , $filter , $window , $sce , $timeout,
141 egProgressDialog, $uibModal , egConfirmDialog , egStrings) {
144 grid.init = function() {
147 $scope.showGridConf = false;
148 grid.totalCount = -1;
149 $scope.selected = {};
150 $scope.actionGroups = [{actions:[]}]; // Grouped actions for selected items
151 $scope.menuItems = []; // global actions
153 // returns true if any rows are selected.
154 $scope.hasSelected = function() {
155 return grid.getSelectedItems().length > 0 };
157 var features = ($scope.features) ?
158 $scope.features.split(',') : [];
159 delete $scope.features;
161 $scope.showIndex = (features.indexOf('-index') == -1);
163 $scope.allowAll = (features.indexOf('allowAll') > -1);
164 $scope.startSelected = $scope.selectAll = (features.indexOf('startSelected') > -1);
165 $scope.showActions = (features.indexOf('-actions') == -1);
166 $scope.showPagination = (features.indexOf('-pagination') == -1);
167 $scope.showPicker = (features.indexOf('-picker') == -1);
169 $scope.showMenu = (features.indexOf('-menu') == -1);
171 // remove some unneeded values from the scope to reduce bloat
173 grid.idlClass = $scope.idlClass;
174 delete $scope.idlClass;
176 grid.persistKey = $scope.persistKey;
177 delete $scope.persistKey;
179 var stored_limit = 0;
180 if ($scope.showPagination) {
181 // localStorage of grid limits is deprecated. Limits
182 // are now stored along with the columns configuration.
183 // Values found in localStorage will be migrated upon
185 if (grid.persistKey) {
186 var stored_limit = Number(
187 egCore.hatch.getLocalItem('eg.grid.' + grid.persistKey + '.limit')
191 stored_limit = 10000; // maybe support "Inf"?
194 grid.limit = Number(stored_limit) || Number($scope.pageSize) || 25;
196 grid.indexField = $scope.idField;
197 delete $scope.idField;
199 grid.dataProvider = $scope.itemsProvider;
201 if (!grid.indexField && grid.idlClass)
202 grid.indexField = egCore.idl.classes[grid.idlClass].pkey;
204 grid.columnsProvider = egGridColumnsProvider.instance({
205 idlClass : grid.idlClass,
206 clientSort : (features.indexOf('clientsort') > -1 && features.indexOf('-clientsort') == -1),
207 defaultToHidden : (features.indexOf('-display') > -1),
208 defaultToNoSort : (features.indexOf('-sort') > -1),
209 defaultToNoMultiSort : (features.indexOf('-multisort') > -1),
210 defaultDateFormat : $scope.dateformat,
211 defaultDateContext : $scope.datecontext,
212 defaultDateFilter : $scope.datefilter,
213 defaultDateOnlyInterval : $scope.dateonlyinterval
215 $scope.canMultiSelect = (features.indexOf('-multiselect') == -1);
217 $scope.handleAutoFields = function() {
218 if ($scope.autoFields) {
219 if (grid.autoLabel) {
221 egCore.idl.classes[grid.idlClass].label;
223 grid.columnsProvider.compileAutoColumns();
224 delete $scope.autoFields;
228 if (!grid.dataProvider) {
229 // no provider, um, provided.
230 // Use a flat data provider
232 grid.selfManagedData = true;
233 grid.dataProvider = egGridFlatDataProvider.instance({
234 indexField : grid.indexField,
235 idlClass : grid.idlClass,
236 columnsProvider : grid.columnsProvider,
241 // make grid ref available in get() to set totalCount, if known.
242 // this allows us disable the 'next' paging button correctly
243 grid.dataProvider.grid = grid;
245 grid.dataProvider.columnsProvider = grid.columnsProvider;
247 $scope.itemFieldValue = grid.dataProvider.itemFieldValue;
248 $scope.indexValue = function(item) {
249 return grid.indexValue(item)
252 grid.applyControlFunctions();
254 $scope.configLoadPromise = grid.loadConfig().then(function() {
255 // link columns to scope after loadConfig(), since it
256 // replaces the columns array.
257 $scope.columns = grid.columnsProvider.columns;
260 // NOTE: grid.collect() is first called from link(), not here.
263 // link our control functions into the gridControls
264 // scope object so the caller can access them.
265 grid.applyControlFunctions = function() {
267 // we use some of these controls internally, so sett
268 // them up even if the caller doesn't request them.
269 var controls = $scope.gridControls || {};
271 controls.columnMap = function() {
273 angular.forEach(grid.columnsProvider.columns, function (c) {
279 controls.columnsProvider = function() {
280 return grid.columnsProvider;
283 controls.contextMenuItem = function() {
284 return $scope.contextMenuItem;
287 // link in the control functions
288 controls.selectedItems = function() {
289 return grid.getSelectedItems()
292 controls.selectItemsByValue = function(c,v) {
293 return grid.selectItemsByValue(c,v)
296 controls.allItems = function() {
300 controls.selectItems = function(ids) {
302 $scope.selected = {};
303 angular.forEach(ids, function(i) {
304 $scope.selected[''+i] = true;
308 // if the caller provided a functional setQuery,
309 // extract the value before replacing it
310 if (controls.setQuery) {
311 grid.dataProvider.query =
315 controls.setQuery = function(query) {
316 grid.dataProvider.query = query;
320 if (controls.watchQuery) {
321 // capture the initial query value
322 grid.dataProvider.query = controls.watchQuery();
325 $scope.gridWatchQuery = controls.watchQuery;
326 $scope.$watch('gridWatchQuery()', function(newv) {
327 controls.setQuery(newv);
331 // if the caller provided a functional setSort
332 // extract the value before replacing it
333 grid.dataProvider.sort =
334 controls.setSort ? controls.setSort() : [];
336 controls.setSort = function(sort) {
340 controls.refresh = function(noReset) {
341 if (!noReset) grid.offset = 0;
345 controls.prepend = function(limit) {
349 controls.setLimit = function(limit,forget) {
351 if (!forget && grid.persistKey) {
355 controls.getLimit = function() {
358 controls.setOffset = function(offset) {
359 grid.offset = offset;
361 controls.getOffset = function() {
365 controls.saveConfig = function () {
366 return $scope.saveConfig();
369 grid.dataProvider.refresh = controls.refresh;
370 grid.dataProvider.prepend = controls.prepend;
371 grid.controls = controls;
374 // If a menu item provides its own HTML template, translate it,
375 // using the menu item for the template scope.
376 // note: $sce is required to avoid security restrictions and
377 // is OK here, since the template comes directly from a
378 // local HTML template (not user input).
379 $scope.translateMenuItemTemplate = function(item) {
380 var html = egCore.strings.$replace(item.template, {item : item});
381 return $sce.trustAsHtml(html);
384 // add a new (global) grid menu item
385 grid.addMenuItem = function(item) {
386 $scope.menuItems.push(item);
387 var handler = item.handler;
388 item.handler = function() {
389 $scope.gridMenuIsOpen = false; // close menu
392 item.handlerData, grid.getSelectedItems());
397 // add a selected-items action
398 grid.addAction = function(act) {
400 $scope.actionGroups.forEach(function(g){
401 if (g.label === act.group) {
407 $scope.actionGroups.push({
414 // remove the stored column configuration preferenc, then recover
415 // the column visibility information from the initial page load.
416 $scope.resetColumns = function() {
417 $scope.gridColumnPickerIsOpen = false;
418 egCore.hatch.removeItem('eg.grid.' + grid.persistKey)
420 grid.columnsProvider.reset();
421 if (grid.selfManagedData) grid.collect();
425 $scope.showAllColumns = function() {
426 $scope.gridColumnPickerIsOpen = false;
427 grid.columnsProvider.showAllColumns();
428 if (grid.selfManagedData) grid.collect();
431 $scope.hideAllColumns = function() {
432 $scope.gridColumnPickerIsOpen = false;
433 grid.columnsProvider.hideAllColumns();
434 // note: no need to fetch new data if no columns are visible
437 $scope.toggleColumnVisibility = function(col) {
438 $scope.gridColumnPickerIsOpen = false;
439 col.visible = !col.visible;
441 // egGridFlatDataProvider only retrieves data to be
442 // displayed. When column visibility changes, it's
443 // necessary to fetch the newly visible column data.
444 if (grid.selfManagedData) grid.collect();
447 // save the columns configuration (position, sort, width) to
448 // eg.grid.<persist-key>
449 $scope.saveConfig = function() {
450 $scope.gridColumnPickerIsOpen = false;
452 if (!grid.persistKey) {
454 "Cannot save settings without a grid persist-key");
458 // only store information about visible columns.
459 var cols = grid.columnsProvider.columns.filter(
460 function(col) {return Boolean(col.visible) });
462 // now scrunch the data down to just the needed info
463 cols = cols.map(function(col) {
464 var c = {name : col.name}
465 // Apart from the name, only store non-default values.
466 // No need to store col.visible, since that's implicit
467 if (col.align != 'left') c.align = col.align;
468 if (col.flex != 2) c.flex = col.flex;
469 if (Number(col.sort)) c.sort = Number(col.sort);
479 egCore.hatch.setItem('eg.grid.' + grid.persistKey, conf)
481 // Save operation performed from the grid configuration UI.
482 // Hide the configuration UI and re-draw w/ sort applied
483 if ($scope.showGridConf)
484 $scope.toggleConfDisplay();
486 // Once a version-2 grid config is saved (with limit
487 // included) we can remove the local limit pref.
488 egCore.hatch.removeLocalItem(
489 'eg.grid.' + grid.persistKey + '.limit');
494 // load the columns configuration (position, sort, width) from
495 // eg.grid.<persist-key> and apply the loaded settings to the
496 // columns on our columnsProvider
497 grid.loadConfig = function() {
498 if (!grid.persistKey) return $q.when();
500 return egCore.hatch.getItem('eg.grid.' + grid.persistKey)
501 .then(function(conf) {
504 // load all column options before validating saved columns
505 $scope.handleAutoFields();
507 var columns = grid.columnsProvider.columns;
510 if (Array.isArray(conf)) {
512 'upgrading version 1 grid config to version 2');
520 grid.limit = Number(conf.limit);
523 angular.forEach(conf.columns, function(col) {
524 var grid_col = columns.filter(
525 function(c) {return c.name == col.name})[0];
528 // saved column does not match a column in the
529 // current grid. skip it.
533 grid_col.align = col.align || 'left';
534 grid_col.flex = col.flex || 2;
535 grid_col.sort = col.sort || 0;
536 // all saved columns are assumed to be true
537 grid_col.visible = true;
539 .filter(function (c) {
540 return c.name == grid_col.name;
543 new_cols.push(grid_col);
546 // columns which are not expressed within the saved
547 // configuration are marked as non-visible and
548 // appended to the end of the new list of columns.
549 angular.forEach(columns, function(col) {
550 var found = conf.columns.filter(
551 function(c) {return (c.name == col.name)})[0];
558 grid.columnsProvider.columns = new_cols;
564 $scope.onContextMenu = function($event) {
565 var col = angular.element($event.target).attr('column');
566 console.log('selected column ' + col);
569 $scope.page = function() {
570 return (grid.offset / grid.limit) + 1;
573 $scope.goToPage = function(page) {
575 if (angular.isNumber(page) && page > 0) {
576 grid.offset = (page - 1) * grid.limit;
581 $scope.offset = function(o) {
582 if (angular.isNumber(o))
587 $scope.limit = function(l) {
588 if (angular.isNumber(l)) {
590 if (grid.persistKey) {
597 $scope.onFirstPage = function() {
598 return grid.offset == 0;
601 $scope.hasNextPage = function() {
602 // we have less data than requested, there must
603 // not be any more pages
604 if (grid.count() < grid.limit) return false;
606 // if the total count is not known, assume that a full
607 // page of data implies more pages are available.
608 if (grid.totalCount == -1) return true;
610 // we have a full page of data, but is there more?
611 return grid.totalCount > (grid.offset + grid.count());
614 $scope.incrementPage = function() {
615 grid.offset += grid.limit;
619 $scope.decrementPage = function() {
620 if (grid.offset < grid.limit) {
623 grid.offset -= grid.limit;
628 // number of items loaded for the current page of results
629 grid.count = function() {
630 return $scope.items.length;
633 // returns the unique identifier value for the provided item
634 // for internal consistency, indexValue is always coerced
636 grid.indexValue = function(item) {
637 if (angular.isObject(item)) {
639 if (angular.isFunction(item[grid.indexField]))
640 return ''+item[grid.indexField]();
641 return ''+item[grid.indexField]; // flat data
644 // passed a non-object; assume it's an index
648 // fires the hide handler function for a context action
649 $scope.actionHide = function(action) {
650 if (typeof action.hide == 'undefined') {
653 if (angular.isFunction(action.hide))
654 return action.hide(action);
658 // fires the disable handler function for a context action
659 $scope.actionDisable = function(action) {
660 if (!action.handler) {
661 // we're probably a divider, so there's no action
665 if (grid.getSelectedItems().length == 0 && action.handler.length > 0) {
668 if (typeof action.disabled == 'undefined') {
671 if (angular.isFunction(action.disabled))
672 return action.disabled(action);
673 return action.disabled;
676 // fires the action handler function for a context action
677 $scope.actionLauncher = function(action) {
678 if (!action.handler) {
680 'No handler specified for "' + action.label + '"');
684 action.handler(grid.getSelectedItems());
686 console.error('Error executing handler for "'
687 + action.label + '" => ' + E + "\n" + E.stack);
690 if ($scope.action_context_showing) $scope.hideActionContextMenu();
695 $scope.hideActionContextMenu = function () {
696 $($scope.menu_dom).css({
698 width: $scope.action_context_width,
699 top: $scope.action_context_y,
700 left: $scope.action_context_x
702 $($scope.action_context_parent).append($scope.menu_dom);
703 $scope.action_context_oldy = $scope.action_context_oldx = 0;
704 $('body').unbind('click.remove_context_menu_'+$scope.action_context_index);
705 $scope.action_context_showing = false;
708 $scope.action_context_showing = false;
709 $scope.showActionContextMenu = function ($event) {
711 // Have to gather these here, instead of inside link()
712 if (!$scope.menu_dom) $scope.menu_dom = $($scope.grid_element).find('.grid-action-dropdown')[0];
713 if (!$scope.action_context_parent) $scope.action_context_parent = $($scope.menu_dom).parent();
715 // we need the the row that got right-clicked...
716 var e = $event.target; // the DOM element
717 var s = undefined; // the angular scope for that element
718 while(e){ // searching for the row
719 // abort & use the browser default context menu for links (lp1669856):
720 if(e.tagName.toLowerCase() === 'a' && e.href){ return true; }
721 s = angular.element(e).scope();
722 if(s.hasOwnProperty('item')){ break; }
726 $scope.contextMenuItem = grid.indexValue(s.item);
728 // select the right-clicked row if it is not already selected (lp1776557):
729 if(!$scope.selected[grid.indexValue(s.item)]){ $event.target.click(); }
731 if (!$scope.action_context_showing) {
732 $scope.action_context_width = $($scope.menu_dom).css('width');
733 $scope.action_context_y = $($scope.menu_dom).css('top');
734 $scope.action_context_x = $($scope.menu_dom).css('left');
735 $scope.action_context_showing = true;
736 $scope.action_context_index = Math.floor((Math.random() * 1000) + 1);
738 $('body').append($($scope.menu_dom));
739 $('body').bind('click.remove_context_menu_'+$scope.action_context_index, $scope.hideActionContextMenu);
742 $($scope.menu_dom).css({
744 width: $scope.action_context_width,
752 // returns the list of selected item objects
753 grid.getSelectedItems = function() {
754 return $scope.items.filter(
756 return Boolean($scope.selected[grid.indexValue(item)]);
761 grid.getItemByIndex = function(index) {
762 for (var i = 0; i < $scope.items.length; i++) {
763 var item = $scope.items[i];
764 if (grid.indexValue(item) == index)
769 // selects one row after deselecting all of the others
770 grid.selectOneItem = function(index) {
771 $scope.selected = {};
772 $scope.selected[index] = true;
775 // selects items by a column value, first clearing selected list.
776 // we overwrite the object so that we can watch $scope.selected
777 grid.selectItemsByValue = function(column, value) {
778 $scope.selected = {};
779 angular.forEach($scope.items, function(item) {
781 if (angular.isFunction(item[column]))
782 col_value = item[column]();
784 col_value = item[column];
786 if (value == col_value) $scope.selected[grid.indexValue(item)] = true
790 // selects or deselects an item, without affecting the others.
791 // returns true if the item is selected; false if de-selected.
792 // we overwrite the object so that we can watch $scope.selected
793 grid.toggleSelectOneItem = function(index) {
794 if ($scope.selected[index]) {
795 delete $scope.selected[index];
796 $scope.selected = angular.copy($scope.selected);
799 $scope.selected[index] = true;
800 $scope.selected = angular.copy($scope.selected);
805 $scope.updateSelected = function () {
806 return $scope.selected = angular.copy($scope.selected);
809 grid.selectAllItems = function() {
810 angular.forEach($scope.items, function(item) {
811 $scope.selected[grid.indexValue(item)] = true
813 $scope.selected = angular.copy($scope.selected);
816 $scope.$watch('selectAll', function(newVal) {
818 grid.selectAllItems();
820 $scope.selected = {};
824 if ($scope.onSelect) {
825 $scope.$watch('selected', function(newVal) {
826 $scope.onSelect(grid.getSelectedItems());
827 if ($scope.afterSelect) $scope.afterSelect();
831 // returns true if item1 appears in the list before item2;
832 // false otherwise. this is slightly more efficient that
833 // finding the position of each then comparing them.
834 // item1 / item2 may be an item or an item index
835 grid.itemComesBefore = function(itemOrIndex1, itemOrIndex2) {
836 var idx1 = grid.indexValue(itemOrIndex1);
837 var idx2 = grid.indexValue(itemOrIndex2);
839 // use for() for early exit
840 for (var i = 0; i < $scope.items.length; i++) {
841 var idx = grid.indexValue($scope.items[i]);
842 if (idx == idx1) return true;
843 if (idx == idx2) return false;
848 // 0-based position of item in the current data set
849 grid.indexOf = function(item) {
850 var idx = grid.indexValue(item);
851 for (var i = 0; i < $scope.items.length; i++) {
852 if (grid.indexValue($scope.items[i]) == idx)
858 grid.modifyColumnFlex = function(column, val) {
860 // prevent flex:0; use hiding instead
864 $scope.modifyColumnFlex = function(col, val) {
865 $scope.lastModColumn = col;
866 grid.modifyColumnFlex(col, val);
869 $scope.isLastModifiedColumn = function(col) {
870 if ($scope.lastModColumn)
871 return $scope.lastModColumn === col;
875 grid.modifyColumnPos = function(col, diff) {
876 var srcIdx, targetIdx;
877 angular.forEach(grid.columnsProvider.columns,
878 function(c, i) { if (c.name == col.name) srcIdx = i });
880 targetIdx = srcIdx + diff;
883 } else if (targetIdx >= grid.columnsProvider.columns.length) {
884 // Target index follows the last visible column.
886 angular.forEach(grid.columnsProvider.columns,
887 function(column, idx) {
888 if (column.visible) lastVisible = idx;
892 // When moving a column (down) causes one or more
893 // visible columns to shuffle forward, our column
894 // moves into the slot of the last visible column.
895 // Otherwise, put it into the slot directly following
896 // the last visible column.
898 srcIdx <= lastVisible ? lastVisible : lastVisible + 1;
901 // Splice column out of old position, insert at new position.
902 grid.columnsProvider.columns.splice(srcIdx, 1);
903 grid.columnsProvider.columns.splice(targetIdx, 0, col);
906 $scope.modifyColumnPos = function(col, diff) {
907 $scope.lastModColumn = col;
908 return grid.modifyColumnPos(col, diff);
912 // handles click, control-click, and shift-click
913 $scope.handleRowClick = function($event, item) {
914 var index = grid.indexValue(item);
916 var origSelected = Object.keys($scope.selected);
918 if (!$scope.canMultiSelect) {
919 grid.selectOneItem(index);
920 grid.lastSelectedItemIndex = index;
924 if ($event.ctrlKey || $event.metaKey /* mac command */) {
926 if (grid.toggleSelectOneItem(index))
927 grid.lastSelectedItemIndex = index;
929 } else if ($event.shiftKey) {
932 if (!grid.lastSelectedItemIndex ||
933 index == grid.lastSelectedItemIndex) {
934 grid.selectOneItem(index);
935 grid.lastSelectedItemIndex = index;
939 var selecting = false;
940 var ascending = grid.itemComesBefore(
941 grid.lastSelectedItemIndex, item);
943 grid.indexOf(grid.lastSelectedItemIndex);
945 // update to new last-selected
946 grid.lastSelectedItemIndex = index;
948 // select each row between the last selected and
949 // currently selected items
951 startPos += ascending ? 1 : -1;
952 var curItem = $scope.items[startPos];
954 var curIdx = grid.indexValue(curItem);
955 $scope.selected[curIdx] = true;
956 if (curIdx == index) break; // all done
958 $scope.selected = angular.copy($scope.selected);
962 grid.selectOneItem(index);
963 grid.lastSelectedItemIndex = index;
967 // Builds a sort expression from column sort priorities.
968 // called on page load and any time the priorities are modified.
969 grid.compileSort = function() {
970 var sortList = grid.columnsProvider.columns.filter(
971 function(col) { return Number(col.sort) != 0 }
974 if (Math.abs(a.sort) < Math.abs(b.sort))
980 if (sortList.length) {
981 grid.dataProvider.sort = sortList.map(function(col) {
983 blob[col.name] = col.sort < 0 ? 'desc' : 'asc';
989 // builds a sort expression using a single column,
990 // toggling between ascending and descending sort.
991 $scope.quickSort = function(col_name) {
992 var sort = grid.dataProvider.sort;
993 if (sort && sort.length &&
994 sort[0] == col_name) {
996 blob[col_name] = 'desc';
997 grid.dataProvider.sort = [blob];
999 grid.dataProvider.sort = [col_name];
1006 // show / hide the grid configuration row
1007 $scope.toggleConfDisplay = function() {
1008 if ($scope.showGridConf) {
1009 $scope.showGridConf = false;
1010 if (grid.columnsProvider.hasSortableColumn()) {
1011 // only refresh the grid if the user has the
1012 // ability to modify the sort priorities.
1018 $scope.showGridConf = true;
1021 delete $scope.lastModColumn;
1022 $scope.gridColumnPickerIsOpen = false;
1025 // called when a dragged column is dropped onto itself
1026 // or any other column
1027 grid.onColumnDrop = function(target) {
1028 if (angular.isUndefined(target)) return;
1029 if (target == grid.dragColumn) return;
1030 var srcIdx, targetIdx, srcCol;
1031 angular.forEach(grid.columnsProvider.columns,
1032 function(col, idx) {
1033 if (col.name == grid.dragColumn) {
1036 } else if (col.name == target) {
1042 if (srcIdx < targetIdx) targetIdx--;
1044 // move src column from old location to new location in
1045 // the columns array, then force a page refresh
1046 grid.columnsProvider.columns.splice(srcIdx, 1);
1047 grid.columnsProvider.columns.splice(targetIdx, 0, srcCol);
1051 // prepares a string for inclusion within a CSV document
1052 // by escaping commas and quotes and removing newlines.
1053 grid.csvDatum = function(str) {
1055 if (!str) return '';
1056 str = str.replace(/\n/g, '');
1057 if (str.match(/\,/) || str.match(/"/)) {
1058 str = str.replace(/"/g, '""');
1059 str = '"' + str + '"';
1064 /** Export the full data set as CSV.
1066 * 1. User clicks the 'download csv' link
1067 * 2. All grid data is retrieved asychronously
1068 * 3. Once all data is all present and CSV-ized, the download
1069 * attributes are linked to the href.
1070 * 4. The href .click() action is prgrammatically fired again,
1071 * telling the browser to download the data, now that the
1072 * data is available for download.
1073 * 5 Once downloaded, the href attributes are reset.
1075 grid.csvExportInProgress = false;
1076 $scope.generateCSVExportURL = function($event) {
1078 if (grid.csvExportInProgress) {
1079 // This is secondary href click handler. Give the
1080 // browser a moment to start the download, then reset
1081 // the CSV download attributes / state.
1084 $scope.csvExportURL = '';
1085 $scope.csvExportFileName = '';
1086 grid.csvExportInProgress = false;
1092 grid.csvExportInProgress = true;
1093 $scope.gridColumnPickerIsOpen = false;
1095 // let the file name describe the grid
1096 $scope.csvExportFileName =
1097 ($scope.mainLabel || grid.persistKey || 'eg_grid_data')
1098 .replace(/\s+/g, '_') + '_' + $scope.page();
1100 // toss the CSV into a Blob and update the export URL
1101 grid.generateCSV().then(function(csv) {
1102 var blob = new Blob([csv], {type : 'text/plain'});
1103 $scope.csvExportURL =
1104 ($window.URL || $window.webkitURL).createObjectURL(blob);
1106 // Fire the 2nd click event now that the browser has
1107 // information on how to download the CSV file.
1108 $timeout(function() {$event.target.click()});
1113 * TODO: does this serve any purpose given we can
1114 * print formatted HTML? If so, generateCSV() now
1115 * returns a promise, needs light refactoring...
1116 $scope.printCSV = function() {
1117 $scope.gridColumnPickerIsOpen = false;
1118 egCore.print.print({
1119 context : 'default',
1120 content : grid.generateCSV(),
1121 content_type : 'text/plain'
1126 // Given a row item and column definition, extract the
1127 // text content for printing. Templated columns must be
1128 // processed and parsed as HTML, then boiled down to their
1130 grid.getItemTextContent = function(item, col) {
1133 val = $scope.translateCellTemplate(col, item);
1135 var node = new DOMParser()
1136 .parseFromString(val, 'text/html');
1137 val = $(node).text();
1140 val = grid.dataProvider.itemFieldValue(item, col);
1141 if (val === null || val === undefined || val === '') return '';
1142 val = $filter('egGridValueFilter')(val, col, item);
1147 $scope.getHtmlTooltip = function(col, item) {
1148 return grid.getItemTextContent(item, col);
1152 * Fetches all grid data and transates each item into a simple
1153 * key-value pair of column name => text-value.
1154 * Included in the response for convenience is the list of
1155 * currently visible column definitions.
1156 * TODO: currently fetches a maximum of 10k rows. Does this
1157 * need to be configurable?
1159 grid.getAllItemsAsText = function() {
1160 var text_items = [];
1162 // we don't know the total number of rows we're about
1163 // to retrieve, but we can indicate the number retrieved
1164 // so far as each item arrives.
1165 var progressDialog = egProgressDialog.open({value : 0});
1166 return progressDialog.opened.then(function() {
1167 var visible_cols = grid.columnsProvider.columns.filter(
1168 function(c) { return c.visible });
1170 return grid.dataProvider.get(0, 10000).then(
1172 return {items : text_items, columns : visible_cols};
1176 egProgressDialog.increment();
1178 angular.forEach(visible_cols, function(col) {
1179 text_item[col.name] =
1180 grid.getItemTextContent(item, col);
1182 text_items.push(text_item);
1184 ).finally(egProgressDialog.close);
1188 // Fetch "all" of the grid data, translate it into print-friendly
1189 // text, and send it to the printer service.
1190 $scope.printHTML = function() {
1191 $scope.gridColumnPickerIsOpen = false;
1192 return grid.getAllItemsAsText().then(function(text_items) {
1193 return egCore.print.print({
1194 template : 'grid_html',
1200 $scope.printSelectedRows = function() {
1201 $scope.gridColumnPickerIsOpen = false;
1203 var columns = grid.columnsProvider.columns.filter(
1204 function(c) { return c.visible }
1206 var selectedItems = grid.getSelectedItems();
1207 var scope = {items: [], columns};
1208 var template = 'grid_html';
1210 angular.forEach(selectedItems, function(item) {
1212 angular.forEach(columns, function(col) {
1213 textItem[col.name] =
1214 grid.getItemTextContent(item, col);
1216 scope.items.push(textItem);
1219 egCore.print.print({template, scope});
1222 $scope.showColumnDialog = function() {
1223 return $uibModal.open({
1224 templateUrl: './share/t_grid_columns',
1227 controller: ['$scope', '$uibModalInstance',
1228 function($dialogScope, $uibModalInstance) {
1229 $dialogScope.modifyColumnPos = $scope.modifyColumnPos;
1230 $dialogScope.disableMultiSort = $scope.disableMultiSort;
1231 $dialogScope.columns = $scope.columns;
1233 // Push visible columns to the top of the list
1234 $dialogScope.elevateVisible = function() {
1236 angular.forEach($dialogScope.columns, function(col) {
1237 if (col.visible) new_cols.push(col);
1239 angular.forEach($dialogScope.columns, function(col) {
1240 if (!col.visible) new_cols.push(col);
1243 // Update all references to the list of columns
1244 $dialogScope.columns =
1246 grid.columnsProvider.columns =
1250 $dialogScope.toggle = function(col) {
1251 col.visible = !Boolean(col.visible);
1253 $dialogScope.ok = $dialogScope.cancel = function() {
1254 delete $scope.lastModColumn;
1255 if (grid.columnsProvider.hasSortableColumn()) {
1256 // only refresh the grid if the user has the
1257 // ability to modify the sort priorities.
1262 $uibModalInstance.close()
1269 // generates CSV for the currently visible grid contents
1270 grid.generateCSV = function() {
1271 return grid.getAllItemsAsText().then(function(text_items) {
1272 var columns = text_items.columns;
1273 var items = text_items.items;
1277 angular.forEach(columns, function(col) {
1278 csvStr += grid.csvDatum(col.label);
1282 csvStr = csvStr.replace(/,$/,'\n');
1285 angular.forEach(items, function(item) {
1286 angular.forEach(columns, function(col) {
1287 csvStr += grid.csvDatum(item[col.name]);
1290 csvStr = csvStr.replace(/,$/,'\n');
1297 // Interpolate the value for column.linkpath within the context
1298 // of the row item to generate the final link URL.
1299 $scope.generateLinkPath = function(col, item) {
1300 return egCore.strings.$replace(col.linkpath, {item : item});
1303 // If a column provides its own HTML template, translate it,
1304 // using the current item for the template scope.
1305 // note: $sce is required to avoid security restrictions and
1306 // is OK here, since the template comes directly from a
1307 // local HTML template (not user input).
1308 $scope.translateCellTemplate = function(col, item) {
1309 var html = egCore.strings.$replace(col.template, {item : item});
1310 return $sce.trustAsHtml(html);
1313 $scope.collect = function() { grid.collect() }
1316 $scope.confirmAllowAllAndCollect = function(){
1317 egConfirmDialog.open(egStrings.CONFIRM_LONG_RUNNING_ACTION_ALL_ROWS_TITLE,
1318 egStrings.CONFIRM_LONG_RUNNING_ACTION_MSG)
1322 $scope.limit(10000);
1327 // asks the dataProvider for a page of data
1328 grid.collect = function() {
1330 // avoid firing the collect if there is nothing to collect.
1331 if (grid.selfManagedData && !grid.dataProvider.query) return;
1333 if (grid.collecting) return; // avoid parallel collect()
1334 grid.collecting = true;
1336 console.debug('egGrid.collect() offset='
1337 + grid.offset + '; limit=' + grid.limit);
1339 // ensure all of our dropdowns are closed
1340 // TODO: git rid of these and just use dropdown-toggle,
1341 // which is more reliable.
1342 $scope.gridColumnPickerIsOpen = false;
1343 $scope.gridRowCountIsOpen = false;
1344 $scope.gridPageSelectIsOpen = false;
1347 $scope.selected = {};
1349 // Inform the caller we've asked the data provider
1350 // for data. This is useful for knowing when collection
1351 // has started (e.g. to display a progress dialg) when
1352 // using the stock (flattener) data provider, where the
1353 // user is not directly defining a get() handler.
1354 if (grid.controls.collectStarted)
1355 grid.controls.collectStarted(grid.offset, grid.limit);
1357 grid.dataProvider.get(grid.offset, grid.limit).then(
1359 if (grid.controls.allItemsRetrieved)
1360 grid.controls.allItemsRetrieved();
1365 $scope.items.push(item)
1366 if (grid.controls.itemRetrieved)
1367 grid.controls.itemRetrieved(item);
1368 if ($scope.selectAll)
1369 $scope.selected[grid.indexValue(item)] = true
1371 }).finally(function() {
1372 console.debug('egGrid.collect() complete');
1373 grid.collecting = false
1374 $scope.selected = angular.copy($scope.selected);
1378 grid.prepend = function(limit) {
1379 var ran_into_duplicate = false;
1380 var sort = grid.dataProvider.sort;
1381 if (sort && sort.length) {
1382 // If sorting is in effect, we have no way
1383 // of knowing that the new item should be
1384 // visible _if the sort order is retained_.
1385 // However, since the grids that do prepending in
1386 // the first place are ones where we always
1387 // want the new row to show up on top, we'll
1388 // remove the current sort options.
1389 grid.dataProvider.sort = [];
1391 if (grid.offset > 0) {
1392 // if we're prepending, we're forcing the
1393 // offset back to zero to display the top
1399 if (grid.collecting) return; // avoid parallel collect() or prepend()
1400 grid.collecting = true;
1401 console.debug('egGrid.prepend() starting');
1402 // Note that we can count on the most-recently added
1403 // item being at offset 0 in the data provider only
1404 // for arrayNotifier data sources that do not have
1405 // sort options currently set.
1406 grid.dataProvider.get(0, 1).then(
1411 var newIdx = grid.indexValue(item);
1412 angular.forEach($scope.items, function(existing) {
1413 if (grid.indexValue(existing) == newIdx) {
1414 console.debug('egGrid.prepend(): refusing to add duplicate item ' + newIdx);
1415 ran_into_duplicate = true;
1419 $scope.items.unshift(item);
1420 if (limit && $scope.items.length > limit) {
1421 // this accommodates the checkin grid that
1422 // allows the user to set a definite limit
1423 // without requiring that entire collect()
1424 $scope.items.length = limit;
1426 if ($scope.items.length > grid.limit) {
1427 $scope.items.length = grid.limit;
1429 if (grid.controls.itemRetrieved)
1430 grid.controls.itemRetrieved(item);
1431 if ($scope.selectAll)
1432 $scope.selected[grid.indexValue(item)] = true
1434 }).finally(function() {
1435 console.debug('egGrid.prepend() complete');
1436 grid.collecting = false;
1437 $scope.selected = angular.copy($scope.selected);
1438 if (ran_into_duplicate) {
1450 * eg-grid-field : used for collecting custom field data from the templates.
1451 * This directive does not direct display, it just passes data up to the
1454 .directive('egGridField', function() {
1456 require : '^egGrid',
1459 flesher: '=', // optional; function that can flesh a linked field, given the value
1460 comparator: '=', // optional; function that can sort the thing at the end of 'path'
1461 name : '@', // required; unique name
1462 path : '@', // optional; flesh path
1463 ignore: '@', // optional; fields to ignore when path is a wildcard
1464 label : '@', // optional; display label
1465 flex : '@', // optional; default flex width
1466 align : '@', // optional; default alignment, left/center/right
1467 dateformat : '@', // optional: passed down to egGridValueFilter
1468 datecontext: '@', // optional: passed down to egGridValueFilter to choose TZ
1469 datefilter: '@', // optional: passed down to egGridValueFilter to choose specialized date filters
1470 dateonlyinterval: '@', // optional: passed down to egGridValueFilter to choose a "better" format
1472 // if a field is part of an IDL object, but we are unable to
1473 // determine the class, because it's nested within a hash
1474 // (i.e. we can't navigate directly to the object via the IDL),
1475 // idlClass lets us specify the class. This is particularly
1476 // useful for nested wildcard fields.
1477 parentIdlClass : '@',
1479 // optional: for non-IDL columns, specifying a datatype
1480 // lets the caller control which display filter is used.
1481 // datatype should match the standard IDL datatypes.
1484 // optional hash of functions that can be imported into
1485 // the directive's scope; meant for cases where the "compiled"
1489 // optional: CSS class name that we want to have for this field.
1490 // Auto generated from path if nothing is passed in via eg-grid-field declaration
1493 link : function(scope, element, attrs, egGridCtrl) {
1495 // boolean fields are presented as value-less attributes
1505 'required' // if set, always fetch data for this column
1508 if (angular.isDefined(attrs[field]))
1509 scope[field] = true;
1513 scope.cssSelector = attrs['cssSelector'] ? attrs['cssSelector'] : "";
1515 // auto-generate CSS selector name for field if none declared in tt2 and there's a path
1516 if (scope.path && !scope.cssSelector){
1517 var cssClass = 'grid' + "." + scope.path;
1518 cssClass = cssClass.replace(/\./g,'-');
1519 element.addClass(cssClass);
1520 scope.cssSelector = cssClass;
1523 // any HTML content within the field is its custom template
1524 var tmpl = element.html();
1525 if (tmpl && !tmpl.match(/^\s*$/))
1526 scope.template = tmpl
1528 egGridCtrl.columnsProvider.add(scope);
1535 * eg-grid-action : used for specifying actions which may be applied
1536 * to items within the grid.
1538 .directive('egGridAction', function() {
1540 require : '^egGrid',
1544 group : '@', // Action group, ungrouped if not set
1545 label : '@', // Action label
1546 handler : '=', // Action function handler
1548 disabled : '=', // function
1551 link : function(scope, element, attrs, egGridCtrl) {
1552 egGridCtrl.addAction({
1554 group : scope.group,
1555 label : scope.label,
1556 divider : scope.divider,
1557 handler : scope.handler,
1558 disabled : scope.disabled,
1565 .factory('egGridColumnsProvider', ['egCore', function(egCore) {
1567 function ColumnsProvider(args) {
1570 cols.stockVisible = [];
1571 cols.idlClass = args.idlClass;
1572 cols.clientSort = args.clientSort;
1573 cols.defaultToHidden = args.defaultToHidden;
1574 cols.defaultToNoSort = args.defaultToNoSort;
1575 cols.defaultToNoMultiSort = args.defaultToNoMultiSort;
1576 cols.defaultDateFormat = args.defaultDateFormat;
1577 cols.defaultDateContext = args.defaultDateContext;
1579 // resets column width, visibility, and sort behavior
1580 // Visibility resets to the visibility settings defined in the
1581 // template (i.e. the original egGridField values).
1582 cols.reset = function() {
1583 angular.forEach(cols.columns, function(col) {
1587 if (cols.stockVisible.indexOf(col.name) > -1) {
1590 col.visible = false;
1595 // returns true if any columns are sortable
1596 cols.hasSortableColumn = function() {
1597 return cols.columns.filter(
1599 return col.sortable || col.multisortable;
1604 cols.showAllColumns = function() {
1605 angular.forEach(cols.columns, function(column) {
1606 column.visible = true;
1610 cols.hideAllColumns = function() {
1611 angular.forEach(cols.columns, function(col) {
1616 cols.indexOf = function(name) {
1617 for (var i = 0; i < cols.columns.length; i++) {
1618 if (cols.columns[i].name == name)
1624 cols.findColumn = function(name) {
1625 return cols.columns[cols.indexOf(name)];
1628 cols.compileAutoColumns = function() {
1629 var idl_class = egCore.idl.classes[cols.idlClass];
1634 if (field.virtual) return;
1635 // Columns declared in the markup take precedence
1636 // of matching auto-columns.
1637 if (cols.findColumn(field.name)) return;
1638 if (field.datatype == 'link' || field.datatype == 'org_unit') {
1639 // if the field is a link and the linked class has a
1640 // "selector" field specified, use the selector field
1641 // as the display field for the columns.
1642 // flattener will take care of the fleshing.
1643 if (field['class']) {
1644 var selector_field = egCore.idl.classes[field['class']].fields
1645 .filter(function(f) { return Boolean(f.selector) })[0];
1646 if (selector_field) {
1647 field.path = field.name + '.' + selector_field.selector;
1651 cols.add(field, true);
1656 // if a column definition has a path with a wildcard, create
1657 // columns for all non-virtual fields at the specified
1658 // position in the path.
1659 cols.expandPath = function(colSpec) {
1661 var ignoreList = [];
1663 ignoreList = colSpec.ignore.split(' ');
1665 var dotpath = colSpec.path.replace(/\.?\*$/,'');
1669 if (colSpec.parentIdlClass) {
1670 class_obj = egCore.idl.classes[colSpec.parentIdlClass];
1672 class_obj = egCore.idl.classes[cols.idlClass];
1674 var idl_parent = class_obj;
1675 var old_field_label = '';
1677 if (!class_obj) return;
1679 //console.debug('egGrid: auto dotpath is: ' + dotpath);
1680 var path_parts = dotpath.split(/\./);
1682 // find the IDL class definition for the last element in the
1683 // path before the .*
1684 // an empty path_parts means expand the root class
1687 for (var path_idx in path_parts) {
1688 old_field = idl_field;
1690 var part = path_parts[path_idx];
1691 idl_field = class_obj.field_map[part];
1693 // unless we're at the end of the list, this field should
1694 // link to another class.
1695 if (idl_field && idl_field['class'] && (
1696 idl_field.datatype == 'link' ||
1697 idl_field.datatype == 'org_unit')) {
1698 if (old_field_label) old_field_label += ' : ';
1699 old_field_label += idl_field.label;
1700 class_obj = egCore.idl.classes[idl_field['class']];
1701 if (old_field) idl_parent = old_field;
1703 if (path_idx < (path_parts.length - 1)) {
1704 // we ran out of classes to hop through before
1705 // we ran out of path components
1706 console.error("egGrid: invalid IDL path: " + dotpath);
1713 angular.forEach(class_obj.fields, function(field) {
1715 // Only show wildcard fields where we have data to show
1716 // Virtual and un-fleshed links will not have any data.
1717 if (field.virtual ||
1718 (field.datatype == 'link' || field.datatype == 'org_unit') ||
1719 ignoreList.indexOf(field.name) > -1
1723 var col = cols.cloneFromScope(colSpec);
1724 col.path = (dotpath ? dotpath + '.' + field.name : field.name);
1726 // log line below is very chatty. disable until needed.
1727 // console.debug('egGrid: field: ' +field.name + '; parent field: ' + js2JSON(idl_parent));
1728 cols.add(col, false, true,
1729 {idl_parent : idl_parent, idl_field : field, idl_class : class_obj, field_parent_label : old_field_label });
1732 cols.columns = cols.columns.sort(
1734 if (a.explicit) return -1;
1735 if (b.explicit) return 1;
1737 if (a.idlclass && b.idlclass) {
1738 if (a.idlclass < b.idlclass) return -1;
1739 if (b.idlclass < a.idlclass) return 1;
1742 if (a.path && b.path && a.path.lastIndexOf('.') && b.path.lastIndexOf('.')) {
1743 if (a.path.substring(0, a.path.lastIndexOf('.')) < b.path.substring(0, b.path.lastIndexOf('.'))) return -1;
1744 if (b.path.substring(0, b.path.lastIndexOf('.')) < a.path.substring(0, a.path.lastIndexOf('.'))) return 1;
1747 if (a.label && b.label) {
1748 if (a.label < b.label) return -1;
1749 if (b.label < a.label) return 1;
1752 return a.name < b.name ? -1 : 1;
1759 "egGrid: wildcard path does not resolve to an object: "
1764 // angular.clone(scopeObject) is not permittable. Manually copy
1765 // the fields over that we need (so the scope object can go away).
1766 cols.cloneFromScope = function(colSpec) {
1768 flesher : colSpec.flesher,
1769 comparator : colSpec.comparator,
1770 name : colSpec.name,
1771 label : colSpec.label,
1772 path : colSpec.path,
1773 align : colSpec.align || 'left',
1774 flex : Number(colSpec.flex) || 2,
1775 sort : Number(colSpec.sort) || 0,
1776 required : colSpec.required,
1777 linkpath : colSpec.linkpath,
1778 template : colSpec.template,
1779 visible : colSpec.visible,
1780 compiled : colSpec.compiled,
1781 handlers : colSpec.handlers,
1782 hidden : colSpec.hidden,
1783 datatype : colSpec.datatype,
1784 sortable : colSpec.sortable,
1785 nonsortable : colSpec.nonsortable,
1786 multisortable : colSpec.multisortable,
1787 nonmultisortable : colSpec.nonmultisortable,
1788 dateformat : colSpec.dateformat,
1789 datecontext : colSpec.datecontext,
1790 datefilter : colSpec.datefilter,
1791 dateonlyinterval : colSpec.dateonlyinterval,
1792 parentIdlClass : colSpec.parentIdlClass,
1793 cssSelector : colSpec.cssSelector
1798 // Add a column to the columns collection.
1799 // Columns may come from a slim eg-columns-field or
1800 // directly from the IDL.
1801 cols.add = function(colSpec, fromIDL, fromExpand, idl_info) {
1803 // First added column with the specified path takes precedence.
1804 // This allows for specific definitions followed by wildcard
1805 // definitions. If a match is found, back out.
1806 if (cols.columns.filter(function(c) {
1807 return (c.path == colSpec.path) })[0]) {
1808 console.debug('skipping pre-existing column ' + colSpec.path);
1812 var column = fromExpand ? colSpec : cols.cloneFromScope(colSpec);
1814 if (column.path && column.path.match(/\*$/))
1815 return cols.expandPath(colSpec);
1817 if (!fromExpand) column.explicit = true;
1819 if (!column.name) column.name = column.path;
1820 if (!column.path) column.path = column.name;
1822 if (column.visible || (!cols.defaultToHidden && !column.hidden))
1823 column.visible = true;
1825 if (column.sortable || (!cols.defaultToNoSort && !column.nonsortable))
1826 column.sortable = true;
1828 if (column.multisortable ||
1829 (!cols.defaultToNoMultiSort && !column.nonmultisortable))
1830 column.multisortable = true;
1832 if (cols.defaultDateFormat && ! column.dateformat) {
1833 column.dateformat = cols.defaultDateFormat;
1836 if (cols.defaultDateOnlyInterval && ! column.dateonlyinterval) {
1837 column.dateonlyinterval = cols.defaultDateOnlyInterval;
1840 if (cols.defaultDateContext && ! column.datecontext) {
1841 column.datecontext = cols.defaultDateContext;
1844 if (cols.defaultDateFilter && ! column.datefilter) {
1845 column.datefilter = cols.defaultDateFilter;
1848 cols.columns.push(column);
1850 // Track which columns are visible by default in case we
1851 // need to reset column visibility
1853 cols.stockVisible.push(column.name);
1855 if (fromIDL) return; // directly from egIDL. nothing left to do.
1857 // lookup the matching IDL field
1858 if (!idl_info && cols.idlClass)
1859 idl_info = cols.idlFieldFromPath(column.path);
1862 // column is not represented within the IDL
1863 column.adhoc = true;
1867 column.datatype = idl_info.idl_field.datatype;
1869 if (!column.label) {
1870 column.label = idl_info.idl_field.label || column.name;
1873 if (fromExpand && idl_info.idl_class) {
1874 column.idlclass = '';
1875 if (idl_info.field_parent_label && idl_info.idl_parent.label != idl_info.idl_class.label) {
1876 column.idlclass = (idl_info.field_parent_label || idl_info.idl_parent.label || idl_info.idl_parent.name);
1878 column.idlclass += idl_info.idl_class.label || idl_info.idl_class.name;
1883 // finds the IDL field from the dotpath, using the columns
1884 // idlClass as the base.
1885 cols.idlFieldFromPath = function(dotpath) {
1886 var class_obj = egCore.idl.classes[cols.idlClass];
1887 if (!dotpath) return null;
1889 var path_parts = dotpath.split(/\./);
1893 for (var path_idx in path_parts) {
1894 var part = path_parts[path_idx];
1895 idl_parent = idl_field;
1896 idl_field = class_obj.field_map[part];
1899 if (idl_field['class'] && (
1900 idl_field.datatype == 'link' ||
1901 idl_field.datatype == 'org_unit')) {
1902 class_obj = egCore.idl.classes[idl_field['class']];
1910 idl_parent: idl_parent,
1911 idl_field : idl_field,
1912 idl_class : class_obj
1918 instance : function(args) { return new ColumnsProvider(args) }
1924 * Generic data provider template class. This is basically an abstract
1925 * class factory service whose instances can be locally modified to
1926 * meet the needs of each individual grid.
1928 .factory('egGridDataProvider',
1929 ['$q','$timeout','$filter','egCore',
1930 function($q , $timeout , $filter , egCore) {
1932 function GridDataProvider(args) {
1933 var gridData = this;
1934 if (!args) args = {};
1937 gridData.get = args.get;
1938 gridData.query = args.query;
1939 gridData.idlClass = args.idlClass;
1940 gridData.columnsProvider = args.columnsProvider;
1941 gridData.comparators = {
1942 "string":function(x,y){
1943 var l_x = x.toLowerCase();
1944 var l_y = y.toLowerCase();
1945 if (l_x < l_y) return -1;
1946 if (l_x > l_y) return 1;
1949 "default":function(x,y){
1950 if (x < y) return -1;
1951 if (x > y) return 1;
1955 // Delivers a stream of array data via promise.notify()
1956 // Useful for passing an array of data to egGrid.get()
1957 // If a count is provided, the array will be trimmed to
1958 // the range defined by count and offset
1959 gridData.arrayNotifier = function(arr, offset, count) {
1960 if (!arr || arr.length == 0) return $q.when();
1962 if (gridData.columnsProvider.clientSort
1964 && gridData.sort.length > 0
1966 var sorter_cache = [];
1967 arr.sort(function(a,b) {
1968 for (var si = 0; si < gridData.sort.length; si++) {
1969 if (!sorter_cache[si]) { // Build sort structure on first comparison, reuse thereafter
1970 var field = gridData.sort[si];
1973 if (angular.isObject(field)) {
1974 dir = Object.values(field)[0];
1975 field = Object.keys(field)[0];
1978 var path = gridData.columnsProvider.findColumn(field).path || field;
1979 var comparator = gridData.columnsProvider.findColumn(field).comparator;
1981 sorter_cache[si] = {
1984 comparator : comparator
1988 var sc = sorter_cache[si];
1992 if (a._isfieldmapper || angular.isFunction(a[sc.field])) {
1993 try {af = a[sc.field](); bf = b[sc.field]() } catch (e) {};
1995 af = a[sc.field]; bf = b[sc.field];
1997 if (af === undefined && sc.field.indexOf('.') > -1) { // assume an object, not flat path
1998 var parts = sc.field.split('.');
2001 angular.forEach(parts, function (p) {
2003 if (af._isfieldmapper || angular.isFunction(af[p])) af = af[p]();
2007 if (bf._isfieldmapper || angular.isFunction(bf[p])) bf = bf[p]();
2013 if (af === undefined) af = null;
2014 if (bf === undefined) bf = null;
2016 if (af === null && bf !== null) return 1;
2017 if (bf === null && af !== null) return -1;
2019 var comparator = sc.comparator || (
2020 gridData.comparators[typeof af] ? gridData.comparators[typeof af]:gridData.comparators["default"]
2023 if (!(bf === null && af === null)) {
2024 var partial = comparator(af,bf);
2026 if (sc.dir == 'desc') {
2027 if (partial > 0) return -1;
2039 if (count) arr = arr.slice(offset, offset + count);
2040 var def = $q.defer();
2041 // promise notifications are only witnessed when delivered
2042 // after the caller has his hands on the promise object
2043 $timeout(function() {
2044 angular.forEach(arr, def.notify);
2050 // Calls the grid refresh function. Once instantiated, the
2051 // grid will replace this function with it's own refresh()
2052 gridData.refresh = function(noReset) { }
2053 gridData.prepend = function(limit) { }
2055 if (!gridData.get) {
2056 // returns a promise whose notify() delivers items
2057 gridData.get = function(index, count) {
2058 console.error("egGridDataProvider.get() not implemented");
2062 // attempts a flat field lookup first. If the column is not
2063 // found on the top-level object, attempts a nested lookup
2064 // TODO: consider a caching layer to speed up template
2065 // rendering, particularly for nested objects?
2066 gridData.itemFieldValue = function(item, column) {
2068 if (column.name in item) {
2069 if (typeof item[column.name] == 'function') {
2070 val = item[column.name]();
2072 val = item[column.name];
2075 val = gridData.nestedItemFieldValue(item, column);
2081 // TODO: deprecate me
2082 gridData.flatItemFieldValue = function(item, column) {
2083 console.warn('gridData.flatItemFieldValue deprecated; '
2084 + 'leave provider.itemFieldValue unset');
2085 return item[column.name];
2088 // given an object and a dot-separated path to a field,
2089 // extract the value of the field. The path can refer
2090 // to function names or object attributes. If the final
2091 // value is an IDL field, run the value through its
2092 // corresponding output filter.
2093 gridData.nestedItemFieldValue = function(obj, column) {
2094 item = obj; // keep a copy around
2096 if (obj === null || obj === undefined || obj === '') return '';
2097 if (!column.path) return obj;
2100 var parts = column.path.split('.');
2102 angular.forEach(parts, function(step, idx) {
2103 // object is not fleshed to the expected extent
2104 if (typeof obj != 'object') {
2105 if (typeof obj != 'undefined' && column.flesher) {
2106 obj = column.flesher(obj, column, item);
2113 if (!obj) return '';
2115 var cls = obj.classname;
2116 if (cls && (class_obj = egCore.idl.classes[cls])) {
2117 idl_field = class_obj.field_map[step];
2118 obj = obj[step] ? obj[step]() : '';
2120 if (angular.isFunction(obj[step])) {
2128 // We found a nested IDL object which may or may not have
2129 // been configured as a top-level column. Grab the datatype.
2130 if (idl_field && !column.datatype)
2131 column.datatype = idl_field.datatype;
2133 if (obj === null || obj === undefined || obj === '') return '';
2139 instance : function(args) {
2140 return new GridDataProvider(args);
2147 // Factory service for egGridDataManager instances, which are
2148 // responsible for collecting flattened grid data.
2149 .factory('egGridFlatDataProvider',
2150 ['$q','egCore','egGridDataProvider',
2151 function($q , egCore , egGridDataProvider) {
2154 instance : function(args) {
2155 var provider = egGridDataProvider.instance(args);
2157 provider.get = function(offset, count) {
2159 // no query means no call
2160 if (!provider.query ||
2161 angular.equals(provider.query, {}))
2164 // find all of the currently visible columns
2165 var queryFields = {}
2166 angular.forEach(provider.columnsProvider.columns,
2168 // only query IDL-tracked columns
2169 if (!col.adhoc && col.name && col.path && (col.required || col.visible))
2170 queryFields[col.name] = col.path;
2174 return egCore.net.request(
2176 'open-ils.fielder.flattened_search',
2177 egCore.auth.token(), provider.idlClass,
2178 queryFields, provider.query,
2179 { sort : provider.sort,
2185 //provider.itemFieldValue = provider.flatItemFieldValue;
2192 .directive('egGridColumnDragSource', function() {
2195 require : '^egGrid',
2196 link : function(scope, element, attrs, egGridCtrl) {
2197 angular.element(element).attr('draggable', 'true');
2199 element.bind('dragstart', function(e) {
2200 egGridCtrl.dragColumn = attrs.column;
2201 egGridCtrl.dragType = attrs.dragType || 'move'; // or resize
2202 egGridCtrl.colResizeDir = 0;
2204 if (egGridCtrl.dragType == 'move') {
2205 // style the column getting moved
2206 angular.element(e.target).addClass(
2207 'eg-grid-column-move-handle-active');
2211 element.bind('dragend', function(e) {
2212 if (egGridCtrl.dragType == 'move') {
2213 angular.element(e.target).removeClass(
2214 'eg-grid-column-move-handle-active');
2221 .directive('egGridColumnDragDest', function() {
2224 require : '^egGrid',
2225 link : function(scope, element, attrs, egGridCtrl) {
2227 element.bind('dragover', function(e) { // required for drop
2228 e.stopPropagation();
2230 e.dataTransfer.dropEffect = 'move';
2232 if (egGridCtrl.colResizeDir == 0) return; // move
2234 var cols = egGridCtrl.columnsProvider;
2235 var srcCol = egGridCtrl.dragColumn;
2236 var srcColIdx = cols.indexOf(srcCol);
2238 if (egGridCtrl.colResizeDir == -1) {
2239 if (cols.indexOf(attrs.column) <= srcColIdx) {
2240 egGridCtrl.modifyColumnFlex(
2241 egGridCtrl.columnsProvider.findColumn(
2242 egGridCtrl.dragColumn), -1);
2243 if (cols.columns[srcColIdx+1]) {
2244 // source column shrinks by one, column to the
2245 // right grows by one.
2246 egGridCtrl.modifyColumnFlex(
2247 cols.columns[srcColIdx+1], 1);
2252 if (cols.indexOf(attrs.column) > srcColIdx) {
2253 egGridCtrl.modifyColumnFlex(
2254 egGridCtrl.columnsProvider.findColumn(
2255 egGridCtrl.dragColumn), 1);
2256 if (cols.columns[srcColIdx+1]) {
2257 // source column grows by one, column to the
2258 // right grows by one.
2259 egGridCtrl.modifyColumnFlex(
2260 cols.columns[srcColIdx+1], -1);
2268 element.bind('dragenter', function(e) {
2269 e.stopPropagation();
2271 if (egGridCtrl.dragType == 'move') {
2272 angular.element(e.target).addClass('eg-grid-col-hover');
2274 // resize grips are on the right side of each column.
2275 // dragenter will either occur on the source column
2276 // (dragging left) or the column to the right.
2277 if (egGridCtrl.colResizeDir == 0) {
2278 if (egGridCtrl.dragColumn == attrs.column) {
2279 egGridCtrl.colResizeDir = -1; // west
2281 egGridCtrl.colResizeDir = 1; // east
2287 element.bind('dragleave', function(e) {
2288 e.stopPropagation();
2290 if (egGridCtrl.dragType == 'move') {
2291 angular.element(e.target).removeClass('eg-grid-col-hover');
2295 element.bind('drop', function(e) {
2296 e.stopPropagation();
2298 egGridCtrl.colResizeDir = 0;
2299 if (egGridCtrl.dragType == 'move') {
2300 angular.element(e.target).removeClass('eg-grid-col-hover');
2301 egGridCtrl.onColumnDrop(attrs.column); // move the column
2308 .directive('egGridMenuItem', function() {
2311 require : '^egGrid',
2317 handler : '=', // onclick handler function
2318 divider : '=', // if true, show a divider only
2319 handlerData : '=', // if set, passed as second argument to handler
2320 disabled : '=', // function
2321 hidden : '=' // function
2323 link : function(scope, element, attrs, egGridCtrl) {
2324 egGridCtrl.addMenuItem({
2325 checkbox : scope.checkbox,
2326 checked : scope.checked ? true : false,
2327 label : scope.label,
2328 standalone : scope.standalone ? true : false,
2329 handler : scope.handler,
2330 divider : scope.divider,
2331 disabled : scope.disabled,
2332 hidden : scope.hidden,
2333 handlerData : scope.handlerData
2340 /* https://stackoverflow.com/questions/17343696/adding-an-ng-click-event-inside-a-filter/17344875#17344875 */
2341 .directive('compile', ['$compile', function ($compile) {
2342 return function(scope, element, attrs) {
2343 // pass through column defs from grid cell's scope
2344 scope.col = scope.$parent.col;
2347 // watch the 'compile' expression for changes
2348 return scope.$eval(attrs.compile);
2351 // when the 'compile' expression changes
2352 // assign it into the current DOM
2353 element.html(value);
2355 // compile the new DOM and link it to the current
2357 // NOTE: we only compile .childNodes so that
2358 // we don't get into infinite loop compiling ourselves
2359 $compile(element.contents())(scope);
2368 * Translates bare IDL object values into display values.
2369 * 1. Passes dates through the angular date filter
2370 * 2. Converts bools to translated Yes/No strings
2371 * Others likely to follow...
2373 .filter('egGridValueFilter', ['$filter','egCore', 'egStrings', function($filter,egCore,egStrings) {
2374 function traversePath(obj,path) {
2375 var list = path.split('.');
2376 for (var part in path) {
2377 if (obj[path]) obj = obj[path]
2383 var GVF = function(value, column, item) {
2384 switch(column.datatype) {
2388 case '1' : // legacy
2390 return egStrings.YES;
2392 case '0' : // legacy
2394 return egStrings.NO;
2395 // value may be null, '', etc.
2396 default : return '';
2399 var interval = angular.isFunction(item[column.dateonlyinterval])
2400 ? item[column.dateonlyinterval]()
2401 : item[column.dateonlyinterval];
2403 if (column.dateonlyinterval && !interval) // try it as a dotted path
2404 interval = traversePath(item, column.dateonlyinterval);
2406 var context = angular.isFunction(item[column.datecontext])
2407 ? item[column.datecontext]()
2408 : item[column.datecontext];
2410 if (column.datecontext && !context) // try it as a dotted path
2411 context = traversePath(item, column.datecontext);
2413 var date_filter = column.datefilter || 'egOrgDateInContext';
2415 return $filter(date_filter)(value, column.dateformat, context, interval);
2417 return $filter('currency')(value);
2423 GVF.$stateful = true;