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) {
145 grid.init = function() {
148 $scope.showGridConf = false;
149 grid.totalCount = -1;
150 $scope.selected = {};
151 $scope.actionGroups = [{actions:[]}]; // Grouped actions for selected items
152 $scope.menuItems = []; // global actions
154 // returns true if any rows are selected.
155 $scope.hasSelected = function() {
156 return grid.getSelectedItems().length > 0 };
158 var features = ($scope.features) ?
159 $scope.features.split(',') : [];
160 delete $scope.features;
162 $scope.showIndex = (features.indexOf('-index') == -1);
164 $scope.allowAll = (features.indexOf('allowAll') > -1);
165 $scope.startSelected = $scope.selectAll = (features.indexOf('startSelected') > -1);
166 $scope.showActions = (features.indexOf('-actions') == -1);
167 $scope.showPagination = (features.indexOf('-pagination') == -1);
168 $scope.showPicker = (features.indexOf('-picker') == -1);
170 $scope.showMenu = (features.indexOf('-menu') == -1);
172 // remove some unneeded values from the scope to reduce bloat
174 grid.idlClass = $scope.idlClass;
175 delete $scope.idlClass;
177 grid.persistKey = $scope.persistKey;
178 delete $scope.persistKey;
180 var stored_limit = 0;
181 if ($scope.showPagination) {
182 // localStorage of grid limits is deprecated. Limits
183 // are now stored along with the columns configuration.
184 // Values found in localStorage will be migrated upon
186 if (grid.persistKey) {
187 var stored_limit = Number(
188 egCore.hatch.getLocalItem('eg.grid.' + grid.persistKey + '.limit')
192 stored_limit = 10000; // maybe support "Inf"?
195 grid.limit = Number(stored_limit) || Number($scope.pageSize) || 25;
197 grid.indexField = $scope.idField;
198 delete $scope.idField;
200 grid.dataProvider = $scope.itemsProvider;
202 if (!grid.indexField && grid.idlClass)
203 grid.indexField = egCore.idl.classes[grid.idlClass].pkey;
205 grid.columnsProvider = egGridColumnsProvider.instance({
206 idlClass : grid.idlClass,
207 clientSort : (features.indexOf('clientsort') > -1 && features.indexOf('-clientsort') == -1),
208 defaultToHidden : (features.indexOf('-display') > -1),
209 defaultToNoSort : (features.indexOf('-sort') > -1),
210 defaultToNoMultiSort : (features.indexOf('-multisort') > -1),
211 defaultDateFormat : $scope.dateformat,
212 defaultDateContext : $scope.datecontext,
213 defaultDateFilter : $scope.datefilter,
214 defaultDateOnlyInterval : $scope.dateonlyinterval
216 $scope.canMultiSelect = (features.indexOf('-multiselect') == -1);
218 $scope.handleAutoFields = function() {
219 if ($scope.autoFields) {
220 if (grid.autoLabel) {
222 egCore.idl.classes[grid.idlClass].label;
224 grid.columnsProvider.compileAutoColumns();
225 delete $scope.autoFields;
229 if (!grid.dataProvider) {
230 // no provider, um, provided.
231 // Use a flat data provider
233 grid.selfManagedData = true;
234 grid.dataProvider = egGridFlatDataProvider.instance({
235 indexField : grid.indexField,
236 idlClass : grid.idlClass,
237 columnsProvider : grid.columnsProvider,
242 // make grid ref available in get() to set totalCount, if known.
243 // this allows us disable the 'next' paging button correctly
244 grid.dataProvider.grid = grid;
246 grid.dataProvider.columnsProvider = grid.columnsProvider;
248 $scope.itemFieldValue = grid.dataProvider.itemFieldValue;
249 $scope.indexValue = function(item) {
250 return grid.indexValue(item)
253 grid.applyControlFunctions();
255 $scope.configLoadPromise = grid.loadConfig().then(function() {
256 // link columns to scope after loadConfig(), since it
257 // replaces the columns array.
258 $scope.columns = grid.columnsProvider.columns;
259 grid.dataProvider.refresh();
262 // NOTE: grid.collect() is first called from link(), not here.
265 // link our control functions into the gridControls
266 // scope object so the caller can access them.
267 grid.applyControlFunctions = function() {
269 // we use some of these controls internally, so sett
270 // them up even if the caller doesn't request them.
271 var controls = $scope.gridControls || {};
273 controls.columnMap = function() {
275 angular.forEach(grid.columnsProvider.columns, function (c) {
281 controls.columnsProvider = function() {
282 return grid.columnsProvider;
285 // link in the control functions
286 controls.selectedItems = function() {
287 return grid.getSelectedItems()
290 controls.selectItemsByValue = function(c,v) {
291 return grid.selectItemsByValue(c,v)
294 controls.allItems = function() {
298 controls.selectItems = function(ids) {
300 $scope.selected = {};
301 angular.forEach(ids, function(i) {
302 $scope.selected[''+i] = true;
306 // if the caller provided a functional setQuery,
307 // extract the value before replacing it
308 if (controls.setQuery) {
309 grid.dataProvider.query =
313 controls.setQuery = function(query) {
314 grid.dataProvider.query = query;
318 if (controls.watchQuery) {
319 // capture the initial query value
320 grid.dataProvider.query = controls.watchQuery();
323 $scope.gridWatchQuery = controls.watchQuery;
324 $scope.$watch('gridWatchQuery()', function(newv) {
325 controls.setQuery(newv);
329 // if the caller provided a functional setSort
330 // extract the value before replacing it
331 grid.dataProvider.sort =
332 controls.setSort ? controls.setSort() : [];
334 controls.setSort = function(sort) {
338 controls.refresh = function(noReset) {
339 if (!noReset) grid.offset = 0;
343 controls.prepend = function(limit) {
347 controls.setLimit = function(limit,forget) {
349 if (!forget && grid.persistKey) {
353 controls.getLimit = function() {
356 controls.setOffset = function(offset) {
357 grid.offset = offset;
359 controls.getOffset = function() {
363 controls.saveConfig = function () {
364 return $scope.saveConfig();
367 grid.dataProvider.refresh = controls.refresh;
368 grid.dataProvider.prepend = controls.prepend;
369 grid.controls = controls;
372 // If a menu item provides its own HTML template, translate it,
373 // using the menu item for the template scope.
374 // note: $sce is required to avoid security restrictions and
375 // is OK here, since the template comes directly from a
376 // local HTML template (not user input).
377 $scope.translateMenuItemTemplate = function(item) {
378 var html = egCore.strings.$replace(item.template, {item : item});
379 return $sce.trustAsHtml(html);
382 // add a new (global) grid menu item
383 grid.addMenuItem = function(item) {
384 $scope.menuItems.push(item);
385 var handler = item.handler;
386 item.handler = function() {
387 $scope.gridMenuIsOpen = false; // close menu
390 item.handlerData, grid.getSelectedItems());
395 // add a selected-items action
396 grid.addAction = function(act) {
398 $scope.actionGroups.forEach(function(g){
399 if (g.label === act.group) {
405 $scope.actionGroups.push({
412 // remove the stored column configuration preferenc, then recover
413 // the column visibility information from the initial page load.
414 $scope.resetColumns = function() {
415 $scope.gridColumnPickerIsOpen = false;
416 egCore.hatch.removeItem('eg.grid.' + grid.persistKey)
418 grid.columnsProvider.reset();
419 if (grid.selfManagedData) grid.collect();
423 $scope.showAllColumns = function() {
424 $scope.gridColumnPickerIsOpen = false;
425 grid.columnsProvider.showAllColumns();
426 if (grid.selfManagedData) grid.collect();
429 $scope.hideAllColumns = function() {
430 $scope.gridColumnPickerIsOpen = false;
431 grid.columnsProvider.hideAllColumns();
432 // note: no need to fetch new data if no columns are visible
435 $scope.toggleColumnVisibility = function(col) {
436 $scope.gridColumnPickerIsOpen = false;
437 col.visible = !col.visible;
439 // egGridFlatDataProvider only retrieves data to be
440 // displayed. When column visibility changes, it's
441 // necessary to fetch the newly visible column data.
442 if (grid.selfManagedData) grid.collect();
445 // save the columns configuration (position, sort, width) to
446 // eg.grid.<persist-key>
447 $scope.saveConfig = function() {
448 $scope.gridColumnPickerIsOpen = false;
450 if (!grid.persistKey) {
452 "Cannot save settings without a grid persist-key");
456 // only store information about visible columns.
457 var cols = grid.columnsProvider.columns.filter(
458 function(col) {return Boolean(col.visible) });
460 // now scrunch the data down to just the needed info
461 cols = cols.map(function(col) {
462 var c = {name : col.name}
463 // Apart from the name, only store non-default values.
464 // No need to store col.visible, since that's implicit
465 if (col.align != 'left') c.align = col.align;
466 if (col.flex != 2) c.flex = col.flex;
467 if (Number(col.sort)) c.sort = Number(col.sort);
477 egCore.hatch.setItem('eg.grid.' + grid.persistKey, conf)
479 // Save operation performed from the grid configuration UI.
480 // Hide the configuration UI and re-draw w/ sort applied
481 if ($scope.showGridConf)
482 $scope.toggleConfDisplay();
484 // Once a version-2 grid config is saved (with limit
485 // included) we can remove the local limit pref.
486 egCore.hatch.removeLocalItem(
487 'eg.grid.' + grid.persistKey + '.limit');
492 // load the columns configuration (position, sort, width) from
493 // eg.grid.<persist-key> and apply the loaded settings to the
494 // columns on our columnsProvider
495 grid.loadConfig = function() {
496 if (!grid.persistKey) return $q.when();
498 return egCore.hatch.getItem('eg.grid.' + grid.persistKey)
499 .then(function(conf) {
502 // load all column options before validating saved columns
503 $scope.handleAutoFields();
505 var columns = grid.columnsProvider.columns;
508 if (Array.isArray(conf)) {
510 'upgrading version 1 grid config to version 2');
518 grid.limit = Number(conf.limit);
521 angular.forEach(conf.columns, function(col) {
522 var grid_col = columns.filter(
523 function(c) {return c.name == col.name})[0];
526 // saved column does not match a column in the
527 // current grid. skip it.
531 grid_col.align = col.align || 'left';
532 grid_col.flex = col.flex || 2;
533 grid_col.sort = col.sort || 0;
534 // all saved columns are assumed to be true
535 grid_col.visible = true;
537 .filter(function (c) {
538 return c.name == grid_col.name;
541 new_cols.push(grid_col);
544 // columns which are not expressed within the saved
545 // configuration are marked as non-visible and
546 // appended to the end of the new list of columns.
547 angular.forEach(columns, function(col) {
548 var found = conf.columns.filter(
549 function(c) {return (c.name == col.name)})[0];
556 grid.columnsProvider.columns = new_cols;
562 $scope.onContextMenu = function($event) {
563 var col = angular.element($event.target).attr('column');
564 console.log('selected column ' + col);
567 $scope.page = function() {
568 return (grid.offset / grid.limit) + 1;
571 $scope.goToPage = function(page) {
573 if (angular.isNumber(page) && page > 0) {
574 grid.offset = (page - 1) * grid.limit;
579 $scope.offset = function(o) {
580 if (angular.isNumber(o))
585 $scope.limit = function(l) {
586 if (angular.isNumber(l)) {
588 if (grid.persistKey) {
595 $scope.onFirstPage = function() {
596 return grid.offset == 0;
599 $scope.hasNextPage = function() {
600 // we have less data than requested, there must
601 // not be any more pages
602 if (grid.count() < grid.limit) return false;
604 // if the total count is not known, assume that a full
605 // page of data implies more pages are available.
606 if (grid.totalCount == -1) return true;
608 // we have a full page of data, but is there more?
609 return grid.totalCount > (grid.offset + grid.count());
612 $scope.incrementPage = function() {
613 grid.offset += grid.limit;
617 $scope.decrementPage = function() {
618 if (grid.offset < grid.limit) {
621 grid.offset -= grid.limit;
626 // number of items loaded for the current page of results
627 grid.count = function() {
628 return $scope.items.length;
631 // returns the unique identifier value for the provided item
632 // for internal consistency, indexValue is always coerced
634 grid.indexValue = function(item) {
635 if (angular.isObject(item)) {
637 if (angular.isFunction(item[grid.indexField]))
638 return ''+item[grid.indexField]();
639 return ''+item[grid.indexField]; // flat data
642 // passed a non-object; assume it's an index
646 // fires the hide handler function for a context action
647 $scope.actionHide = function(action) {
648 if (typeof action.hide == 'undefined') {
651 if (angular.isFunction(action.hide))
652 return action.hide(action);
656 // fires the disable handler function for a context action
657 $scope.actionDisable = function(action) {
658 if (typeof action.disabled == 'undefined') {
661 if (angular.isFunction(action.disabled))
662 return action.disabled(action);
663 return action.disabled;
666 // fires the action handler function for a context action
667 $scope.actionLauncher = function(action) {
668 if (!action.handler) {
670 'No handler specified for "' + action.label + '"');
674 action.handler(grid.getSelectedItems());
676 console.error('Error executing handler for "'
677 + action.label + '" => ' + E + "\n" + E.stack);
680 if ($scope.action_context_showing) $scope.hideActionContextMenu();
685 $scope.hideActionContextMenu = function () {
686 $($scope.menu_dom).css({
688 width: $scope.action_context_width,
689 top: $scope.action_context_y,
690 left: $scope.action_context_x
692 $($scope.action_context_parent).append($scope.menu_dom);
693 $scope.action_context_oldy = $scope.action_context_oldx = 0;
694 $('body').unbind('click.remove_context_menu_'+$scope.action_context_index);
695 $scope.action_context_showing = false;
698 $scope.action_context_showing = false;
699 $scope.showActionContextMenu = function ($event) {
701 // Have to gather these here, instead of inside link()
702 if (!$scope.menu_dom) $scope.menu_dom = $($scope.grid_element).find('.grid-action-dropdown')[0];
703 if (!$scope.action_context_parent) $scope.action_context_parent = $($scope.menu_dom).parent();
705 // we need the the row that got right-clicked...
706 var e = $event.target; // the DOM element
707 var s = undefined; // the angular scope for that element
708 while(e){ // searching for the row
709 // abort & use the browser default context menu for links (lp1669856):
710 if(e.tagName.toLowerCase() === 'a' && e.href){ return true; }
711 s = angular.element(e).scope();
712 if(s.hasOwnProperty('item')){ break; }
715 // select the right-clicked row if it is not already selected (lp1776557):
716 if(!$scope.selected[grid.indexValue(s.item)]){ $event.target.click(); }
718 if (!$scope.action_context_showing) {
719 $scope.action_context_width = $($scope.menu_dom).css('width');
720 $scope.action_context_y = $($scope.menu_dom).css('top');
721 $scope.action_context_x = $($scope.menu_dom).css('left');
722 $scope.action_context_showing = true;
723 $scope.action_context_index = Math.floor((Math.random() * 1000) + 1);
725 $('body').append($($scope.menu_dom));
726 $('body').bind('click.remove_context_menu_'+$scope.action_context_index, $scope.hideActionContextMenu);
729 $($scope.menu_dom).css({
731 width: $scope.action_context_width,
739 // returns the list of selected item objects
740 grid.getSelectedItems = function() {
741 return $scope.items.filter(
743 return Boolean($scope.selected[grid.indexValue(item)]);
748 grid.getItemByIndex = function(index) {
749 for (var i = 0; i < $scope.items.length; i++) {
750 var item = $scope.items[i];
751 if (grid.indexValue(item) == index)
756 // selects one row after deselecting all of the others
757 grid.selectOneItem = function(index) {
758 $scope.selected = {};
759 $scope.selected[index] = true;
762 // selects items by a column value, first clearing selected list.
763 // we overwrite the object so that we can watch $scope.selected
764 grid.selectItemsByValue = function(column, value) {
765 $scope.selected = {};
766 angular.forEach($scope.items, function(item) {
768 if (angular.isFunction(item[column]))
769 col_value = item[column]();
771 col_value = item[column];
773 if (value == col_value) $scope.selected[grid.indexValue(item)] = true
777 // selects or deselects an item, without affecting the others.
778 // returns true if the item is selected; false if de-selected.
779 // we overwrite the object so that we can watch $scope.selected
780 grid.toggleSelectOneItem = function(index) {
781 if ($scope.selected[index]) {
782 delete $scope.selected[index];
783 $scope.selected = angular.copy($scope.selected);
786 $scope.selected[index] = true;
787 $scope.selected = angular.copy($scope.selected);
792 $scope.updateSelected = function () {
793 return $scope.selected = angular.copy($scope.selected);
796 grid.selectAllItems = function() {
797 angular.forEach($scope.items, function(item) {
798 $scope.selected[grid.indexValue(item)] = true
800 $scope.selected = angular.copy($scope.selected);
803 $scope.$watch('selectAll', function(newVal) {
805 grid.selectAllItems();
807 $scope.selected = {};
811 if ($scope.onSelect) {
812 $scope.$watch('selected', function(newVal) {
813 $scope.onSelect(grid.getSelectedItems());
814 if ($scope.afterSelect) $scope.afterSelect();
818 // returns true if item1 appears in the list before item2;
819 // false otherwise. this is slightly more efficient that
820 // finding the position of each then comparing them.
821 // item1 / item2 may be an item or an item index
822 grid.itemComesBefore = function(itemOrIndex1, itemOrIndex2) {
823 var idx1 = grid.indexValue(itemOrIndex1);
824 var idx2 = grid.indexValue(itemOrIndex2);
826 // use for() for early exit
827 for (var i = 0; i < $scope.items.length; i++) {
828 var idx = grid.indexValue($scope.items[i]);
829 if (idx == idx1) return true;
830 if (idx == idx2) return false;
835 // 0-based position of item in the current data set
836 grid.indexOf = function(item) {
837 var idx = grid.indexValue(item);
838 for (var i = 0; i < $scope.items.length; i++) {
839 if (grid.indexValue($scope.items[i]) == idx)
845 grid.modifyColumnFlex = function(column, val) {
847 // prevent flex:0; use hiding instead
851 $scope.modifyColumnFlex = function(col, val) {
852 $scope.lastModColumn = col;
853 grid.modifyColumnFlex(col, val);
856 $scope.isLastModifiedColumn = function(col) {
857 if ($scope.lastModColumn)
858 return $scope.lastModColumn === col;
862 grid.modifyColumnPos = function(col, diff) {
863 var srcIdx, targetIdx;
864 angular.forEach(grid.columnsProvider.columns,
865 function(c, i) { if (c.name == col.name) srcIdx = i });
867 targetIdx = srcIdx + diff;
870 } else if (targetIdx >= grid.columnsProvider.columns.length) {
871 // Target index follows the last visible column.
873 angular.forEach(grid.columnsProvider.columns,
874 function(column, idx) {
875 if (column.visible) lastVisible = idx;
879 // When moving a column (down) causes one or more
880 // visible columns to shuffle forward, our column
881 // moves into the slot of the last visible column.
882 // Otherwise, put it into the slot directly following
883 // the last visible column.
885 srcIdx <= lastVisible ? lastVisible : lastVisible + 1;
888 // Splice column out of old position, insert at new position.
889 grid.columnsProvider.columns.splice(srcIdx, 1);
890 grid.columnsProvider.columns.splice(targetIdx, 0, col);
893 $scope.modifyColumnPos = function(col, diff) {
894 $scope.lastModColumn = col;
895 return grid.modifyColumnPos(col, diff);
899 // handles click, control-click, and shift-click
900 $scope.handleRowClick = function($event, item) {
901 var index = grid.indexValue(item);
903 var origSelected = Object.keys($scope.selected);
905 if (!$scope.canMultiSelect) {
906 grid.selectOneItem(index);
907 grid.lastSelectedItemIndex = index;
911 if ($event.ctrlKey || $event.metaKey /* mac command */) {
913 if (grid.toggleSelectOneItem(index))
914 grid.lastSelectedItemIndex = index;
916 } else if ($event.shiftKey) {
919 if (!grid.lastSelectedItemIndex ||
920 index == grid.lastSelectedItemIndex) {
921 grid.selectOneItem(index);
922 grid.lastSelectedItemIndex = index;
926 var selecting = false;
927 var ascending = grid.itemComesBefore(
928 grid.lastSelectedItemIndex, item);
930 grid.indexOf(grid.lastSelectedItemIndex);
932 // update to new last-selected
933 grid.lastSelectedItemIndex = index;
935 // select each row between the last selected and
936 // currently selected items
938 startPos += ascending ? 1 : -1;
939 var curItem = $scope.items[startPos];
941 var curIdx = grid.indexValue(curItem);
942 $scope.selected[curIdx] = true;
943 if (curIdx == index) break; // all done
945 $scope.selected = angular.copy($scope.selected);
949 grid.selectOneItem(index);
950 grid.lastSelectedItemIndex = index;
954 // Builds a sort expression from column sort priorities.
955 // called on page load and any time the priorities are modified.
956 grid.compileSort = function() {
957 var sortList = grid.columnsProvider.columns.filter(
958 function(col) { return Number(col.sort) != 0 }
961 if (Math.abs(a.sort) < Math.abs(b.sort))
967 if (sortList.length) {
968 grid.dataProvider.sort = sortList.map(function(col) {
970 blob[col.name] = col.sort < 0 ? 'desc' : 'asc';
976 // builds a sort expression using a single column,
977 // toggling between ascending and descending sort.
978 $scope.quickSort = function(col_name) {
979 var sort = grid.dataProvider.sort;
980 if (sort && sort.length &&
981 sort[0] == col_name) {
983 blob[col_name] = 'desc';
984 grid.dataProvider.sort = [blob];
986 grid.dataProvider.sort = [col_name];
993 // show / hide the grid configuration row
994 $scope.toggleConfDisplay = function() {
995 if ($scope.showGridConf) {
996 $scope.showGridConf = false;
997 if (grid.columnsProvider.hasSortableColumn()) {
998 // only refresh the grid if the user has the
999 // ability to modify the sort priorities.
1005 $scope.showGridConf = true;
1008 delete $scope.lastModColumn;
1009 $scope.gridColumnPickerIsOpen = false;
1012 // called when a dragged column is dropped onto itself
1013 // or any other column
1014 grid.onColumnDrop = function(target) {
1015 if (angular.isUndefined(target)) return;
1016 if (target == grid.dragColumn) return;
1017 var srcIdx, targetIdx, srcCol;
1018 angular.forEach(grid.columnsProvider.columns,
1019 function(col, idx) {
1020 if (col.name == grid.dragColumn) {
1023 } else if (col.name == target) {
1029 if (srcIdx < targetIdx) targetIdx--;
1031 // move src column from old location to new location in
1032 // the columns array, then force a page refresh
1033 grid.columnsProvider.columns.splice(srcIdx, 1);
1034 grid.columnsProvider.columns.splice(targetIdx, 0, srcCol);
1038 // prepares a string for inclusion within a CSV document
1039 // by escaping commas and quotes and removing newlines.
1040 grid.csvDatum = function(str) {
1042 if (!str) return '';
1043 str = str.replace(/\n/g, '');
1044 if (str.match(/\,/) || str.match(/"/)) {
1045 str = str.replace(/"/g, '""');
1046 str = '"' + str + '"';
1051 /** Export the full data set as CSV.
1053 * 1. User clicks the 'download csv' link
1054 * 2. All grid data is retrieved asychronously
1055 * 3. Once all data is all present and CSV-ized, the download
1056 * attributes are linked to the href.
1057 * 4. The href .click() action is prgrammatically fired again,
1058 * telling the browser to download the data, now that the
1059 * data is available for download.
1060 * 5 Once downloaded, the href attributes are reset.
1062 grid.csvExportInProgress = false;
1063 $scope.generateCSVExportURL = function($event) {
1065 if (grid.csvExportInProgress) {
1066 // This is secondary href click handler. Give the
1067 // browser a moment to start the download, then reset
1068 // the CSV download attributes / state.
1071 $scope.csvExportURL = '';
1072 $scope.csvExportFileName = '';
1073 grid.csvExportInProgress = false;
1079 grid.csvExportInProgress = true;
1080 $scope.gridColumnPickerIsOpen = false;
1082 // let the file name describe the grid
1083 $scope.csvExportFileName =
1084 ($scope.mainLabel || grid.persistKey || 'eg_grid_data')
1085 .replace(/\s+/g, '_') + '_' + $scope.page();
1087 // toss the CSV into a Blob and update the export URL
1088 grid.generateCSV().then(function(csv) {
1089 var blob = new Blob([csv], {type : 'text/plain'});
1090 $scope.csvExportURL =
1091 ($window.URL || $window.webkitURL).createObjectURL(blob);
1093 // Fire the 2nd click event now that the browser has
1094 // information on how to download the CSV file.
1095 $timeout(function() {$event.target.click()});
1100 * TODO: does this serve any purpose given we can
1101 * print formatted HTML? If so, generateCSV() now
1102 * returns a promise, needs light refactoring...
1103 $scope.printCSV = function() {
1104 $scope.gridColumnPickerIsOpen = false;
1105 egCore.print.print({
1106 context : 'default',
1107 content : grid.generateCSV(),
1108 content_type : 'text/plain'
1113 // Given a row item and column definition, extract the
1114 // text content for printing. Templated columns must be
1115 // processed and parsed as HTML, then boiled down to their
1117 grid.getItemTextContent = function(item, col) {
1120 val = $scope.translateCellTemplate(col, item);
1122 var node = new DOMParser()
1123 .parseFromString(val, 'text/html');
1124 val = $(node).text();
1127 val = grid.dataProvider.itemFieldValue(item, col);
1128 if (val === null || val === undefined || val === '') return '';
1129 val = $filter('egGridValueFilter')(val, col, item);
1134 $scope.getHtmlTooltip = function(col, item) {
1135 return grid.getItemTextContent(item, col);
1139 * Fetches all grid data and transates each item into a simple
1140 * key-value pair of column name => text-value.
1141 * Included in the response for convenience is the list of
1142 * currently visible column definitions.
1143 * TODO: currently fetches a maximum of 10k rows. Does this
1144 * need to be configurable?
1146 grid.getAllItemsAsText = function() {
1147 var text_items = [];
1149 // we don't know the total number of rows we're about
1150 // to retrieve, but we can indicate the number retrieved
1151 // so far as each item arrives.
1152 egProgressDialog.open({value : 0});
1154 var visible_cols = grid.columnsProvider.columns.filter(
1155 function(c) { return c.visible });
1157 return grid.dataProvider.get(0, 10000).then(
1159 return {items : text_items, columns : visible_cols};
1163 egProgressDialog.increment();
1165 angular.forEach(visible_cols, function(col) {
1166 text_item[col.name] =
1167 grid.getItemTextContent(item, col);
1169 text_items.push(text_item);
1171 ).finally(egProgressDialog.close);
1174 // Fetch "all" of the grid data, translate it into print-friendly
1175 // text, and send it to the printer service.
1176 $scope.printHTML = function() {
1177 $scope.gridColumnPickerIsOpen = false;
1178 return grid.getAllItemsAsText().then(function(text_items) {
1179 return egCore.print.print({
1180 template : 'grid_html',
1186 $scope.showColumnDialog = function() {
1187 return $uibModal.open({
1188 templateUrl: './share/t_grid_columns',
1191 controller: ['$scope', '$uibModalInstance',
1192 function($dialogScope, $uibModalInstance) {
1193 $dialogScope.modifyColumnPos = $scope.modifyColumnPos;
1194 $dialogScope.disableMultiSort = $scope.disableMultiSort;
1195 $dialogScope.columns = $scope.columns;
1197 // Push visible columns to the top of the list
1198 $dialogScope.elevateVisible = function() {
1200 angular.forEach($dialogScope.columns, function(col) {
1201 if (col.visible) new_cols.push(col);
1203 angular.forEach($dialogScope.columns, function(col) {
1204 if (!col.visible) new_cols.push(col);
1207 // Update all references to the list of columns
1208 $dialogScope.columns =
1210 grid.columnsProvider.columns =
1214 $dialogScope.toggle = function(col) {
1215 col.visible = !Boolean(col.visible);
1217 $dialogScope.ok = $dialogScope.cancel = function() {
1218 delete $scope.lastModColumn;
1219 $uibModalInstance.close()
1226 // generates CSV for the currently visible grid contents
1227 grid.generateCSV = function() {
1228 return grid.getAllItemsAsText().then(function(text_items) {
1229 var columns = text_items.columns;
1230 var items = text_items.items;
1234 angular.forEach(columns, function(col) {
1235 csvStr += grid.csvDatum(col.label);
1239 csvStr = csvStr.replace(/,$/,'\n');
1242 angular.forEach(items, function(item) {
1243 angular.forEach(columns, function(col) {
1244 csvStr += grid.csvDatum(item[col.name]);
1247 csvStr = csvStr.replace(/,$/,'\n');
1254 // Interpolate the value for column.linkpath within the context
1255 // of the row item to generate the final link URL.
1256 $scope.generateLinkPath = function(col, item) {
1257 return egCore.strings.$replace(col.linkpath, {item : item});
1260 // If a column provides its own HTML template, translate it,
1261 // using the current item for the template scope.
1262 // note: $sce is required to avoid security restrictions and
1263 // is OK here, since the template comes directly from a
1264 // local HTML template (not user input).
1265 $scope.translateCellTemplate = function(col, item) {
1266 var html = egCore.strings.$replace(col.template, {item : item});
1267 return $sce.trustAsHtml(html);
1270 $scope.collect = function() { grid.collect() }
1273 $scope.confirmAllowAllAndCollect = function(){
1274 egConfirmDialog.open(egStrings.CONFIRM_LONG_RUNNING_ACTION_ALL_ROWS_TITLE,
1275 egStrings.CONFIRM_LONG_RUNNING_ACTION_MSG)
1279 $scope.limit(10000);
1284 // asks the dataProvider for a page of data
1285 grid.collect = function() {
1287 // avoid firing the collect if there is nothing to collect.
1288 if (grid.selfManagedData && !grid.dataProvider.query) return;
1290 if (grid.collecting) return; // avoid parallel collect()
1291 grid.collecting = true;
1293 console.debug('egGrid.collect() offset='
1294 + grid.offset + '; limit=' + grid.limit);
1296 // ensure all of our dropdowns are closed
1297 // TODO: git rid of these and just use dropdown-toggle,
1298 // which is more reliable.
1299 $scope.gridColumnPickerIsOpen = false;
1300 $scope.gridRowCountIsOpen = false;
1301 $scope.gridPageSelectIsOpen = false;
1304 $scope.selected = {};
1306 // Inform the caller we've asked the data provider
1307 // for data. This is useful for knowing when collection
1308 // has started (e.g. to display a progress dialg) when
1309 // using the stock (flattener) data provider, where the
1310 // user is not directly defining a get() handler.
1311 if (grid.controls.collectStarted)
1312 grid.controls.collectStarted(grid.offset, grid.limit);
1314 grid.dataProvider.get(grid.offset, grid.limit).then(
1316 if (grid.controls.allItemsRetrieved)
1317 grid.controls.allItemsRetrieved();
1322 $scope.items.push(item)
1323 if (grid.controls.itemRetrieved)
1324 grid.controls.itemRetrieved(item);
1325 if ($scope.selectAll)
1326 $scope.selected[grid.indexValue(item)] = true
1328 }).finally(function() {
1329 console.debug('egGrid.collect() complete');
1330 grid.collecting = false
1331 $scope.selected = angular.copy($scope.selected);
1335 grid.prepend = function(limit) {
1336 var ran_into_duplicate = false;
1337 var sort = grid.dataProvider.sort;
1338 if (sort && sort.length) {
1339 // If sorting is in effect, we have no way
1340 // of knowing that the new item should be
1341 // visible _if the sort order is retained_.
1342 // However, since the grids that do prepending in
1343 // the first place are ones where we always
1344 // want the new row to show up on top, we'll
1345 // remove the current sort options.
1346 grid.dataProvider.sort = [];
1348 if (grid.offset > 0) {
1349 // if we're prepending, we're forcing the
1350 // offset back to zero to display the top
1356 if (grid.collecting) return; // avoid parallel collect() or prepend()
1357 grid.collecting = true;
1358 console.debug('egGrid.prepend() starting');
1359 // Note that we can count on the most-recently added
1360 // item being at offset 0 in the data provider only
1361 // for arrayNotifier data sources that do not have
1362 // sort options currently set.
1363 grid.dataProvider.get(0, 1).then(
1368 var newIdx = grid.indexValue(item);
1369 angular.forEach($scope.items, function(existing) {
1370 if (grid.indexValue(existing) == newIdx) {
1371 console.debug('egGrid.prepend(): refusing to add duplicate item ' + newIdx);
1372 ran_into_duplicate = true;
1376 $scope.items.unshift(item);
1377 if (limit && $scope.items.length > limit) {
1378 // this accommodates the checkin grid that
1379 // allows the user to set a definite limit
1380 // without requiring that entire collect()
1381 $scope.items.length = limit;
1383 if ($scope.items.length > grid.limit) {
1384 $scope.items.length = grid.limit;
1386 if (grid.controls.itemRetrieved)
1387 grid.controls.itemRetrieved(item);
1388 if ($scope.selectAll)
1389 $scope.selected[grid.indexValue(item)] = true
1391 }).finally(function() {
1392 console.debug('egGrid.prepend() complete');
1393 grid.collecting = false;
1394 $scope.selected = angular.copy($scope.selected);
1395 if (ran_into_duplicate) {
1407 * eg-grid-field : used for collecting custom field data from the templates.
1408 * This directive does not direct display, it just passes data up to the
1411 .directive('egGridField', function() {
1413 require : '^egGrid',
1416 flesher: '=', // optional; function that can flesh a linked field, given the value
1417 comparator: '=', // optional; function that can sort the thing at the end of 'path'
1418 name : '@', // required; unique name
1419 path : '@', // optional; flesh path
1420 ignore: '@', // optional; fields to ignore when path is a wildcard
1421 label : '@', // optional; display label
1422 flex : '@', // optional; default flex width
1423 align : '@', // optional; default alignment, left/center/right
1424 dateformat : '@', // optional: passed down to egGridValueFilter
1425 datecontext: '@', // optional: passed down to egGridValueFilter to choose TZ
1426 datefilter: '@', // optional: passed down to egGridValueFilter to choose specialized date filters
1427 dateonlyinterval: '@', // optional: passed down to egGridValueFilter to choose a "better" format
1429 // if a field is part of an IDL object, but we are unable to
1430 // determine the class, because it's nested within a hash
1431 // (i.e. we can't navigate directly to the object via the IDL),
1432 // idlClass lets us specify the class. This is particularly
1433 // useful for nested wildcard fields.
1434 parentIdlClass : '@',
1436 // optional: for non-IDL columns, specifying a datatype
1437 // lets the caller control which display filter is used.
1438 // datatype should match the standard IDL datatypes.
1441 // optional hash of functions that can be imported into
1442 // the directive's scope; meant for cases where the "compiled"
1446 // optional: CSS class name that we want to have for this field.
1447 // Auto generated from path if nothing is passed in via eg-grid-field declaration
1450 link : function(scope, element, attrs, egGridCtrl) {
1452 // boolean fields are presented as value-less attributes
1462 'required' // if set, always fetch data for this column
1465 if (angular.isDefined(attrs[field]))
1466 scope[field] = true;
1470 scope.cssSelector = attrs['cssSelector'] ? attrs['cssSelector'] : "";
1472 // auto-generate CSS selector name for field if none declared in tt2 and there's a path
1473 if (scope.path && !scope.cssSelector){
1474 var cssClass = 'grid' + "." + scope.path;
1475 cssClass = cssClass.replace(/\./g,'-');
1476 element.addClass(cssClass);
1477 scope.cssSelector = cssClass;
1480 // any HTML content within the field is its custom template
1481 var tmpl = element.html();
1482 if (tmpl && !tmpl.match(/^\s*$/))
1483 scope.template = tmpl
1485 egGridCtrl.columnsProvider.add(scope);
1492 * eg-grid-action : used for specifying actions which may be applied
1493 * to items within the grid.
1495 .directive('egGridAction', function() {
1497 require : '^egGrid',
1501 group : '@', // Action group, ungrouped if not set
1502 label : '@', // Action label
1503 handler : '=', // Action function handler
1505 disabled : '=', // function
1508 link : function(scope, element, attrs, egGridCtrl) {
1509 egGridCtrl.addAction({
1511 group : scope.group,
1512 label : scope.label,
1513 divider : scope.divider,
1514 handler : scope.handler,
1515 disabled : scope.disabled,
1522 .factory('egGridColumnsProvider', ['egCore', function(egCore) {
1524 function ColumnsProvider(args) {
1527 cols.stockVisible = [];
1528 cols.idlClass = args.idlClass;
1529 cols.clientSort = args.clientSort;
1530 cols.defaultToHidden = args.defaultToHidden;
1531 cols.defaultToNoSort = args.defaultToNoSort;
1532 cols.defaultToNoMultiSort = args.defaultToNoMultiSort;
1533 cols.defaultDateFormat = args.defaultDateFormat;
1534 cols.defaultDateContext = args.defaultDateContext;
1536 // resets column width, visibility, and sort behavior
1537 // Visibility resets to the visibility settings defined in the
1538 // template (i.e. the original egGridField values).
1539 cols.reset = function() {
1540 angular.forEach(cols.columns, function(col) {
1544 if (cols.stockVisible.indexOf(col.name) > -1) {
1547 col.visible = false;
1552 // returns true if any columns are sortable
1553 cols.hasSortableColumn = function() {
1554 return cols.columns.filter(
1556 return col.sortable || col.multisortable;
1561 cols.showAllColumns = function() {
1562 angular.forEach(cols.columns, function(column) {
1563 column.visible = true;
1567 cols.hideAllColumns = function() {
1568 angular.forEach(cols.columns, function(col) {
1573 cols.indexOf = function(name) {
1574 for (var i = 0; i < cols.columns.length; i++) {
1575 if (cols.columns[i].name == name)
1581 cols.findColumn = function(name) {
1582 return cols.columns[cols.indexOf(name)];
1585 cols.compileAutoColumns = function() {
1586 var idl_class = egCore.idl.classes[cols.idlClass];
1591 if (field.virtual) return;
1592 // Columns declared in the markup take precedence
1593 // of matching auto-columns.
1594 if (cols.findColumn(field.name)) return;
1595 if (field.datatype == 'link' || field.datatype == 'org_unit') {
1596 // if the field is a link and the linked class has a
1597 // "selector" field specified, use the selector field
1598 // as the display field for the columns.
1599 // flattener will take care of the fleshing.
1600 if (field['class']) {
1601 var selector_field = egCore.idl.classes[field['class']].fields
1602 .filter(function(f) { return Boolean(f.selector) })[0];
1603 if (selector_field) {
1604 field.path = field.name + '.' + selector_field.selector;
1608 cols.add(field, true);
1613 // if a column definition has a path with a wildcard, create
1614 // columns for all non-virtual fields at the specified
1615 // position in the path.
1616 cols.expandPath = function(colSpec) {
1618 var ignoreList = [];
1620 ignoreList = colSpec.ignore.split(' ');
1622 var dotpath = colSpec.path.replace(/\.?\*$/,'');
1626 if (colSpec.parentIdlClass) {
1627 class_obj = egCore.idl.classes[colSpec.parentIdlClass];
1629 class_obj = egCore.idl.classes[cols.idlClass];
1631 var idl_parent = class_obj;
1632 var old_field_label = '';
1634 if (!class_obj) return;
1636 //console.debug('egGrid: auto dotpath is: ' + dotpath);
1637 var path_parts = dotpath.split(/\./);
1639 // find the IDL class definition for the last element in the
1640 // path before the .*
1641 // an empty path_parts means expand the root class
1644 for (var path_idx in path_parts) {
1645 old_field = idl_field;
1647 var part = path_parts[path_idx];
1648 idl_field = class_obj.field_map[part];
1650 // unless we're at the end of the list, this field should
1651 // link to another class.
1652 if (idl_field && idl_field['class'] && (
1653 idl_field.datatype == 'link' ||
1654 idl_field.datatype == 'org_unit')) {
1655 if (old_field_label) old_field_label += ' : ';
1656 old_field_label += idl_field.label;
1657 class_obj = egCore.idl.classes[idl_field['class']];
1658 if (old_field) idl_parent = old_field;
1660 if (path_idx < (path_parts.length - 1)) {
1661 // we ran out of classes to hop through before
1662 // we ran out of path components
1663 console.error("egGrid: invalid IDL path: " + dotpath);
1670 angular.forEach(class_obj.fields, function(field) {
1672 // Only show wildcard fields where we have data to show
1673 // Virtual and un-fleshed links will not have any data.
1674 if (field.virtual ||
1675 (field.datatype == 'link' || field.datatype == 'org_unit') ||
1676 ignoreList.indexOf(field.name) > -1
1680 var col = cols.cloneFromScope(colSpec);
1681 col.path = (dotpath ? dotpath + '.' + field.name : field.name);
1683 // log line below is very chatty. disable until needed.
1684 // console.debug('egGrid: field: ' +field.name + '; parent field: ' + js2JSON(idl_parent));
1685 cols.add(col, false, true,
1686 {idl_parent : idl_parent, idl_field : field, idl_class : class_obj, field_parent_label : old_field_label });
1689 cols.columns = cols.columns.sort(
1691 if (a.explicit) return -1;
1692 if (b.explicit) return 1;
1694 if (a.idlclass && b.idlclass) {
1695 if (a.idlclass < b.idlclass) return -1;
1696 if (b.idlclass < a.idlclass) return 1;
1699 if (a.path && b.path && a.path.lastIndexOf('.') && b.path.lastIndexOf('.')) {
1700 if (a.path.substring(0, a.path.lastIndexOf('.')) < b.path.substring(0, b.path.lastIndexOf('.'))) return -1;
1701 if (b.path.substring(0, b.path.lastIndexOf('.')) < a.path.substring(0, a.path.lastIndexOf('.'))) return 1;
1704 if (a.label && b.label) {
1705 if (a.label < b.label) return -1;
1706 if (b.label < a.label) return 1;
1709 return a.name < b.name ? -1 : 1;
1716 "egGrid: wildcard path does not resolve to an object: "
1721 // angular.clone(scopeObject) is not permittable. Manually copy
1722 // the fields over that we need (so the scope object can go away).
1723 cols.cloneFromScope = function(colSpec) {
1725 flesher : colSpec.flesher,
1726 comparator : colSpec.comparator,
1727 name : colSpec.name,
1728 label : colSpec.label,
1729 path : colSpec.path,
1730 align : colSpec.align || 'left',
1731 flex : Number(colSpec.flex) || 2,
1732 sort : Number(colSpec.sort) || 0,
1733 required : colSpec.required,
1734 linkpath : colSpec.linkpath,
1735 template : colSpec.template,
1736 visible : colSpec.visible,
1737 compiled : colSpec.compiled,
1738 handlers : colSpec.handlers,
1739 hidden : colSpec.hidden,
1740 datatype : colSpec.datatype,
1741 sortable : colSpec.sortable,
1742 nonsortable : colSpec.nonsortable,
1743 multisortable : colSpec.multisortable,
1744 nonmultisortable : colSpec.nonmultisortable,
1745 dateformat : colSpec.dateformat,
1746 datecontext : colSpec.datecontext,
1747 datefilter : colSpec.datefilter,
1748 dateonlyinterval : colSpec.dateonlyinterval,
1749 parentIdlClass : colSpec.parentIdlClass,
1750 cssSelector : colSpec.cssSelector
1755 // Add a column to the columns collection.
1756 // Columns may come from a slim eg-columns-field or
1757 // directly from the IDL.
1758 cols.add = function(colSpec, fromIDL, fromExpand, idl_info) {
1760 // First added column with the specified path takes precedence.
1761 // This allows for specific definitions followed by wildcard
1762 // definitions. If a match is found, back out.
1763 if (cols.columns.filter(function(c) {
1764 return (c.path == colSpec.path) })[0]) {
1765 console.debug('skipping pre-existing column ' + colSpec.path);
1769 var column = fromExpand ? colSpec : cols.cloneFromScope(colSpec);
1771 if (column.path && column.path.match(/\*$/))
1772 return cols.expandPath(colSpec);
1774 if (!fromExpand) column.explicit = true;
1776 if (!column.name) column.name = column.path;
1777 if (!column.path) column.path = column.name;
1779 if (column.visible || (!cols.defaultToHidden && !column.hidden))
1780 column.visible = true;
1782 if (column.sortable || (!cols.defaultToNoSort && !column.nonsortable))
1783 column.sortable = true;
1785 if (column.multisortable ||
1786 (!cols.defaultToNoMultiSort && !column.nonmultisortable))
1787 column.multisortable = true;
1789 if (cols.defaultDateFormat && ! column.dateformat) {
1790 column.dateformat = cols.defaultDateFormat;
1793 if (cols.defaultDateOnlyInterval && ! column.dateonlyinterval) {
1794 column.dateonlyinterval = cols.defaultDateOnlyInterval;
1797 if (cols.defaultDateContext && ! column.datecontext) {
1798 column.datecontext = cols.defaultDateContext;
1801 if (cols.defaultDateFilter && ! column.datefilter) {
1802 column.datefilter = cols.defaultDateFilter;
1805 cols.columns.push(column);
1807 // Track which columns are visible by default in case we
1808 // need to reset column visibility
1810 cols.stockVisible.push(column.name);
1812 if (fromIDL) return; // directly from egIDL. nothing left to do.
1814 // lookup the matching IDL field
1815 if (!idl_info && cols.idlClass)
1816 idl_info = cols.idlFieldFromPath(column.path);
1819 // column is not represented within the IDL
1820 column.adhoc = true;
1824 column.datatype = idl_info.idl_field.datatype;
1826 if (!column.label) {
1827 column.label = idl_info.idl_field.label || column.name;
1830 if (fromExpand && idl_info.idl_class) {
1831 column.idlclass = '';
1832 if (idl_info.field_parent_label && idl_info.idl_parent.label != idl_info.idl_class.label) {
1833 column.idlclass = (idl_info.field_parent_label || idl_info.idl_parent.label || idl_info.idl_parent.name);
1835 column.idlclass += idl_info.idl_class.label || idl_info.idl_class.name;
1840 // finds the IDL field from the dotpath, using the columns
1841 // idlClass as the base.
1842 cols.idlFieldFromPath = function(dotpath) {
1843 var class_obj = egCore.idl.classes[cols.idlClass];
1844 if (!dotpath) return null;
1846 var path_parts = dotpath.split(/\./);
1850 for (var path_idx in path_parts) {
1851 var part = path_parts[path_idx];
1852 idl_parent = idl_field;
1853 idl_field = class_obj.field_map[part];
1856 if (idl_field['class'] && (
1857 idl_field.datatype == 'link' ||
1858 idl_field.datatype == 'org_unit')) {
1859 class_obj = egCore.idl.classes[idl_field['class']];
1867 idl_parent: idl_parent,
1868 idl_field : idl_field,
1869 idl_class : class_obj
1875 instance : function(args) { return new ColumnsProvider(args) }
1881 * Generic data provider template class. This is basically an abstract
1882 * class factory service whose instances can be locally modified to
1883 * meet the needs of each individual grid.
1885 .factory('egGridDataProvider',
1886 ['$q','$timeout','$filter','egCore',
1887 function($q , $timeout , $filter , egCore) {
1889 function GridDataProvider(args) {
1890 var gridData = this;
1891 if (!args) args = {};
1894 gridData.get = args.get;
1895 gridData.query = args.query;
1896 gridData.idlClass = args.idlClass;
1897 gridData.columnsProvider = args.columnsProvider;
1899 // Delivers a stream of array data via promise.notify()
1900 // Useful for passing an array of data to egGrid.get()
1901 // If a count is provided, the array will be trimmed to
1902 // the range defined by count and offset
1903 gridData.arrayNotifier = function(arr, offset, count) {
1904 if (!arr || arr.length == 0) return $q.when();
1906 if (gridData.columnsProvider.clientSort
1908 && gridData.sort.length > 0
1910 var sorter_cache = [];
1911 arr.sort(function(a,b) {
1912 for (var si = 0; si < gridData.sort.length; si++) {
1913 if (!sorter_cache[si]) { // Build sort structure on first comparison, reuse thereafter
1914 var field = gridData.sort[si];
1917 if (angular.isObject(field)) {
1918 dir = Object.values(field)[0];
1919 field = Object.keys(field)[0];
1922 var path = gridData.columnsProvider.findColumn(field).path || field;
1923 var comparator = gridData.columnsProvider.findColumn(field).comparator ||
1924 function (x,y) { if (x < y) return -1; if (x > y) return 1; return 0 };
1926 sorter_cache[si] = {
1929 comparator : comparator
1933 var sc = sorter_cache[si];
1937 if (a._isfieldmapper || angular.isFunction(a[sc.field])) {
1938 try {af = a[sc.field](); bf = b[sc.field]() } catch (e) {};
1940 af = a[sc.field]; bf = b[sc.field];
1942 if (af === undefined && sc.field.indexOf('.') > -1) { // assume an object, not flat path
1943 var parts = sc.field.split('.');
1946 angular.forEach(parts, function (p) {
1948 if (af._isfieldmapper || angular.isFunction(af[p])) af = af[p]();
1952 if (bf._isfieldmapper || angular.isFunction(bf[p])) bf = bf[p]();
1958 if (af === undefined) af = null;
1959 if (bf === undefined) bf = null;
1961 if (af === null && bf !== null) return 1;
1962 if (bf === null && af !== null) return -1;
1964 if (!(bf === null && af === null)) {
1965 var partial = sc.comparator(af,bf);
1967 if (sc.dir == 'desc') {
1968 if (partial > 0) return -1;
1980 if (count) arr = arr.slice(offset, offset + count);
1981 var def = $q.defer();
1982 // promise notifications are only witnessed when delivered
1983 // after the caller has his hands on the promise object
1984 $timeout(function() {
1985 angular.forEach(arr, def.notify);
1991 // Calls the grid refresh function. Once instantiated, the
1992 // grid will replace this function with it's own refresh()
1993 gridData.refresh = function(noReset) { }
1994 gridData.prepend = function(limit) { }
1996 if (!gridData.get) {
1997 // returns a promise whose notify() delivers items
1998 gridData.get = function(index, count) {
1999 console.error("egGridDataProvider.get() not implemented");
2003 // attempts a flat field lookup first. If the column is not
2004 // found on the top-level object, attempts a nested lookup
2005 // TODO: consider a caching layer to speed up template
2006 // rendering, particularly for nested objects?
2007 gridData.itemFieldValue = function(item, column) {
2009 if (column.name in item) {
2010 if (typeof item[column.name] == 'function') {
2011 val = item[column.name]();
2013 val = item[column.name];
2016 val = gridData.nestedItemFieldValue(item, column);
2022 // TODO: deprecate me
2023 gridData.flatItemFieldValue = function(item, column) {
2024 console.warn('gridData.flatItemFieldValue deprecated; '
2025 + 'leave provider.itemFieldValue unset');
2026 return item[column.name];
2029 // given an object and a dot-separated path to a field,
2030 // extract the value of the field. The path can refer
2031 // to function names or object attributes. If the final
2032 // value is an IDL field, run the value through its
2033 // corresponding output filter.
2034 gridData.nestedItemFieldValue = function(obj, column) {
2035 item = obj; // keep a copy around
2037 if (obj === null || obj === undefined || obj === '') return '';
2038 if (!column.path) return obj;
2041 var parts = column.path.split('.');
2043 angular.forEach(parts, function(step, idx) {
2044 // object is not fleshed to the expected extent
2045 if (typeof obj != 'object') {
2046 if (typeof obj != 'undefined' && column.flesher) {
2047 obj = column.flesher(obj, column, item);
2054 if (!obj) return '';
2056 var cls = obj.classname;
2057 if (cls && (class_obj = egCore.idl.classes[cls])) {
2058 idl_field = class_obj.field_map[step];
2059 obj = obj[step] ? obj[step]() : '';
2061 if (angular.isFunction(obj[step])) {
2069 // We found a nested IDL object which may or may not have
2070 // been configured as a top-level column. Grab the datatype.
2071 if (idl_field && !column.datatype)
2072 column.datatype = idl_field.datatype;
2074 if (obj === null || obj === undefined || obj === '') return '';
2080 instance : function(args) {
2081 return new GridDataProvider(args);
2088 // Factory service for egGridDataManager instances, which are
2089 // responsible for collecting flattened grid data.
2090 .factory('egGridFlatDataProvider',
2091 ['$q','egCore','egGridDataProvider',
2092 function($q , egCore , egGridDataProvider) {
2095 instance : function(args) {
2096 var provider = egGridDataProvider.instance(args);
2098 provider.get = function(offset, count) {
2100 // no query means no call
2101 if (!provider.query ||
2102 angular.equals(provider.query, {}))
2105 // find all of the currently visible columns
2106 var queryFields = {}
2107 angular.forEach(provider.columnsProvider.columns,
2109 // only query IDL-tracked columns
2110 if (!col.adhoc && col.name && col.path && (col.required || col.visible))
2111 queryFields[col.name] = col.path;
2115 return egCore.net.request(
2117 'open-ils.fielder.flattened_search',
2118 egCore.auth.token(), provider.idlClass,
2119 queryFields, provider.query,
2120 { sort : provider.sort,
2126 //provider.itemFieldValue = provider.flatItemFieldValue;
2133 .directive('egGridColumnDragSource', function() {
2136 require : '^egGrid',
2137 link : function(scope, element, attrs, egGridCtrl) {
2138 angular.element(element).attr('draggable', 'true');
2140 element.bind('dragstart', function(e) {
2141 egGridCtrl.dragColumn = attrs.column;
2142 egGridCtrl.dragType = attrs.dragType || 'move'; // or resize
2143 egGridCtrl.colResizeDir = 0;
2145 if (egGridCtrl.dragType == 'move') {
2146 // style the column getting moved
2147 angular.element(e.target).addClass(
2148 'eg-grid-column-move-handle-active');
2152 element.bind('dragend', function(e) {
2153 if (egGridCtrl.dragType == 'move') {
2154 angular.element(e.target).removeClass(
2155 'eg-grid-column-move-handle-active');
2162 .directive('egGridColumnDragDest', function() {
2165 require : '^egGrid',
2166 link : function(scope, element, attrs, egGridCtrl) {
2168 element.bind('dragover', function(e) { // required for drop
2169 e.stopPropagation();
2171 e.dataTransfer.dropEffect = 'move';
2173 if (egGridCtrl.colResizeDir == 0) return; // move
2175 var cols = egGridCtrl.columnsProvider;
2176 var srcCol = egGridCtrl.dragColumn;
2177 var srcColIdx = cols.indexOf(srcCol);
2179 if (egGridCtrl.colResizeDir == -1) {
2180 if (cols.indexOf(attrs.column) <= srcColIdx) {
2181 egGridCtrl.modifyColumnFlex(
2182 egGridCtrl.columnsProvider.findColumn(
2183 egGridCtrl.dragColumn), -1);
2184 if (cols.columns[srcColIdx+1]) {
2185 // source column shrinks by one, column to the
2186 // right grows by one.
2187 egGridCtrl.modifyColumnFlex(
2188 cols.columns[srcColIdx+1], 1);
2193 if (cols.indexOf(attrs.column) > srcColIdx) {
2194 egGridCtrl.modifyColumnFlex(
2195 egGridCtrl.columnsProvider.findColumn(
2196 egGridCtrl.dragColumn), 1);
2197 if (cols.columns[srcColIdx+1]) {
2198 // source column grows by one, column to the
2199 // right grows by one.
2200 egGridCtrl.modifyColumnFlex(
2201 cols.columns[srcColIdx+1], -1);
2209 element.bind('dragenter', function(e) {
2210 e.stopPropagation();
2212 if (egGridCtrl.dragType == 'move') {
2213 angular.element(e.target).addClass('eg-grid-col-hover');
2215 // resize grips are on the right side of each column.
2216 // dragenter will either occur on the source column
2217 // (dragging left) or the column to the right.
2218 if (egGridCtrl.colResizeDir == 0) {
2219 if (egGridCtrl.dragColumn == attrs.column) {
2220 egGridCtrl.colResizeDir = -1; // west
2222 egGridCtrl.colResizeDir = 1; // east
2228 element.bind('dragleave', function(e) {
2229 e.stopPropagation();
2231 if (egGridCtrl.dragType == 'move') {
2232 angular.element(e.target).removeClass('eg-grid-col-hover');
2236 element.bind('drop', function(e) {
2237 e.stopPropagation();
2239 egGridCtrl.colResizeDir = 0;
2240 if (egGridCtrl.dragType == 'move') {
2241 angular.element(e.target).removeClass('eg-grid-col-hover');
2242 egGridCtrl.onColumnDrop(attrs.column); // move the column
2249 .directive('egGridMenuItem', function() {
2252 require : '^egGrid',
2258 handler : '=', // onclick handler function
2259 divider : '=', // if true, show a divider only
2260 handlerData : '=', // if set, passed as second argument to handler
2261 disabled : '=', // function
2262 hidden : '=' // function
2264 link : function(scope, element, attrs, egGridCtrl) {
2265 egGridCtrl.addMenuItem({
2266 checkbox : scope.checkbox,
2267 checked : scope.checked ? true : false,
2268 label : scope.label,
2269 standalone : scope.standalone ? true : false,
2270 handler : scope.handler,
2271 divider : scope.divider,
2272 disabled : scope.disabled,
2273 hidden : scope.hidden,
2274 handlerData : scope.handlerData
2281 /* https://stackoverflow.com/questions/17343696/adding-an-ng-click-event-inside-a-filter/17344875#17344875 */
2282 .directive('compile', ['$compile', function ($compile) {
2283 return function(scope, element, attrs) {
2284 // pass through column defs from grid cell's scope
2285 scope.col = scope.$parent.col;
2288 // watch the 'compile' expression for changes
2289 return scope.$eval(attrs.compile);
2292 // when the 'compile' expression changes
2293 // assign it into the current DOM
2294 element.html(value);
2296 // compile the new DOM and link it to the current
2298 // NOTE: we only compile .childNodes so that
2299 // we don't get into infinite loop compiling ourselves
2300 $compile(element.contents())(scope);
2309 * Translates bare IDL object values into display values.
2310 * 1. Passes dates through the angular date filter
2311 * 2. Converts bools to translated Yes/No strings
2312 * Others likely to follow...
2314 .filter('egGridValueFilter', ['$filter','egCore', 'egStrings', function($filter,egCore,egStrings) {
2315 function traversePath(obj,path) {
2316 var list = path.split('.');
2317 for (var part in path) {
2318 if (obj[path]) obj = obj[path]
2324 var GVF = function(value, column, item) {
2325 switch(column.datatype) {
2328 // Browser will translate true/false for us
2330 case '1' : // legacy
2332 return egStrings.YES;
2334 case '0' : // legacy
2336 return egStrings.NO;
2337 // value may be null, '', etc.
2338 default : return '';
2341 var interval = angular.isFunction(item[column.dateonlyinterval])
2342 ? item[column.dateonlyinterval]()
2343 : item[column.dateonlyinterval];
2345 if (column.dateonlyinterval && !interval) // try it as a dotted path
2346 interval = traversePath(item, column.dateonlyinterval);
2348 var context = angular.isFunction(item[column.datecontext])
2349 ? item[column.datecontext]()
2350 : item[column.datecontext];
2352 if (column.datecontext && !context) // try it as a dotted path
2353 context = traversePath(item, column.datecontext);
2355 var date_filter = column.datefilter || 'egOrgDateInContext';
2357 return $filter(date_filter)(value, column.dateformat, context, interval);
2359 return $filter('currency')(value);
2365 GVF.$stateful = true;