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 // comma-separated list of supported or disabled grid features
33 // supported features:
34 // -display : columns are hidden by default
35 // -sort : columns are unsortable by default
36 // -multisort : sort priorities config disabled by default
39 // optional primary grid label
42 // if true, use the IDL class label as the mainLabel
45 // optional context menu label
48 // Hash of control functions.
50 // These functions are defined by the calling scope and
51 // invoked as-is by the grid w/ the specified parameters.
53 // itemRetrieved : function(item) {}
54 // allItemsRetrieved : function() {}
57 // These functions are defined by the grid and thus
58 // replace any values defined for these attributes from the
61 // activateItem : function(item) {}
62 // allItems : function(allItems) {}
63 // selectedItems : function(selected) {}
64 // selectItems : function(ids) {}
65 // setQuery : function(queryStruct) {} // causes reload
66 // setSort : function(sortSturct) {} // causes reload
70 // TODO: avoid hard-coded url
71 templateUrl : '/eg/staff/share/t_autogrid',
73 link : function(scope, element, attrs) {
74 // link() is called after page compilation, which means our
75 // eg-grid-field's have been parsed and loaded. Now it's
76 // safe to perform our initial page load.
78 // load auto fields after eg-grid-field's so they are not clobbered
79 scope.handleAutoFields();
82 scope.grid_element = element;
84 .find('.eg-grid-content-body')
85 .bind('contextmenu', scope.showActionContextMenu);
89 '$scope','$q','egCore','egGridFlatDataProvider','$location',
90 'egGridColumnsProvider','$filter','$window','$sce','$timeout',
91 function($scope, $q , egCore, egGridFlatDataProvider , $location,
92 egGridColumnsProvider , $filter , $window , $sce , $timeout) {
96 grid.init = function() {
99 $scope.showGridConf = false;
100 grid.totalCount = -1;
101 $scope.selected = {};
102 $scope.actions = []; // actions for selected items
103 $scope.menuItems = []; // global actions
105 // remove some unneeded values from the scope to reduce bloat
107 grid.idlClass = $scope.idlClass;
108 delete $scope.idlClass;
110 grid.persistKey = $scope.persistKey;
111 delete $scope.persistKey;
113 var stored_limit = 0;
114 if (grid.persistKey) {
115 var stored_limit = Number(
116 egCore.hatch.getLocalItem('eg.grid.' + grid.persistKey + '.limit')
119 grid.limit = Number(stored_limit) || Number($scope.pageSize) || 25;
121 grid.indexField = $scope.idField;
122 delete $scope.idField;
124 grid.dataProvider = $scope.itemsProvider;
126 var features = ($scope.features) ?
127 $scope.features.split(',') : [];
128 delete $scope.features;
130 if (!grid.indexField && grid.idlClass)
131 grid.indexField = egCore.idl.classes[grid.idlClass].pkey;
133 grid.columnsProvider = egGridColumnsProvider.instance({
134 idlClass : grid.idlClass,
135 defaultToHidden : (features.indexOf('-display') > -1),
136 defaultToNoSort : (features.indexOf('-sort') > -1),
137 defaultToNoMultiSort : (features.indexOf('-multisort') > -1)
140 $scope.handleAutoFields = function() {
141 if ($scope.autoFields) {
142 if (grid.autoLabel) {
144 egCore.idl.classes[grid.idlClass].label;
146 grid.columnsProvider.compileAutoColumns();
147 delete $scope.autoFields;
151 if (!grid.dataProvider) {
152 // no provider, um, provided.
153 // Use a flat data provider
155 grid.selfManagedData = true;
156 grid.dataProvider = egGridFlatDataProvider.instance({
157 indexField : grid.indexField,
158 idlClass : grid.idlClass,
159 columnsProvider : grid.columnsProvider,
164 $scope.itemFieldValue = grid.dataProvider.itemFieldValue;
165 $scope.indexValue = function(item) {
166 return grid.indexValue(item)
169 grid.applyControlFunctions();
171 grid.loadConfig().then(function() {
172 // link columns to scope after loadConfig(), since it
173 // replaces the columns array.
174 $scope.columns = grid.columnsProvider.columns;
177 // NOTE: grid.collect() is first called from link(), not here.
180 // link our control functions into the gridControls
181 // scope object so the caller can access them.
182 grid.applyControlFunctions = function() {
184 // we use some of these controls internally, so sett
185 // them up even if the caller doesn't request them.
186 var controls = $scope.gridControls || {};
188 // link in the control functions
189 controls.selectedItems = function() {
190 return grid.getSelectedItems()
193 controls.allItems = function() {
197 controls.selectItems = function(ids) {
199 $scope.selected = {};
200 angular.forEach(ids, function(i) {
201 $scope.selected[''+i] = true;
205 // if the caller provided a functional setQuery,
206 // extract the value before replacing it
207 if (controls.setQuery) {
208 grid.dataProvider.query =
212 controls.setQuery = function(query) {
213 grid.dataProvider.query = query;
217 // if the caller provided a functional setSort
218 // extract the value before replacing it
219 grid.dataProvider.sort =
220 controls.setSort ? controls.setSort() : [];
222 controls.setSort = function(sort) {
226 controls.refresh = function(noReset) {
227 if (!noReset) grid.offset = 0;
231 controls.setLimit = function(limit,forget) {
232 if (!forget && grid.persistKey)
233 egCore.hatch.setLocalItem('eg.grid.' + grid.persistKey + '.limit', limit);
236 controls.getLimit = function() {
239 controls.setOffset = function(offset) {
240 grid.offset = offset;
242 controls.getOffset = function() {
246 grid.dataProvider.refresh = controls.refresh;
247 grid.controls = controls;
250 // add a new (global) grid menu item
251 grid.addMenuItem = function(item) {
252 $scope.menuItems.push(item);
253 var handler = item.handler;
254 item.handler = function() {
255 $scope.gridMenuIsOpen = false; // close menu
258 item.handlerData, grid.getSelectedItems());
263 // add a selected-items action
264 grid.addAction = function(act) {
265 $scope.actions.push(act);
268 // remove the stored column configuration preferenc, then recover
269 // the column visibility information from the initial page load.
270 $scope.resetColumns = function() {
271 $scope.gridColumnPickerIsOpen = false;
272 egCore.hatch.removeItem('eg.grid.' + grid.persistKey)
274 grid.columnsProvider.reset();
275 if (grid.selfManagedData) grid.collect();
279 $scope.showAllColumns = function() {
280 $scope.gridColumnPickerIsOpen = false;
281 grid.columnsProvider.showAllColumns();
282 if (grid.selfManagedData) grid.collect();
285 $scope.hideAllColumns = function() {
286 $scope.gridColumnPickerIsOpen = false;
287 grid.columnsProvider.hideAllColumns();
288 // note: no need to fetch new data if no columns are visible
291 $scope.toggleColumnVisibility = function(col) {
292 $scope.gridColumnPickerIsOpen = false;
293 col.visible = !col.visible;
295 // egGridFlatDataProvider only retrieves data to be
296 // displayed. When column visibility changes, it's
297 // necessary to fetch the newly visible column data.
298 if (grid.selfManagedData) grid.collect();
301 // save the columns configuration (position, sort, width) to
302 // eg.grid.<persist-key>
303 $scope.saveConfig = function() {
304 $scope.gridColumnPickerIsOpen = false;
306 if (!grid.persistKey) {
308 "Cannot save settings without a grid persist-key");
312 // only store information about visible columns.
313 var conf = grid.columnsProvider.columns.filter(
314 function(col) {return Boolean(col.visible) });
316 // now scrunch the data down to just the needed info
317 conf = conf.map(function(col) {
318 var c = {name : col.name}
319 // Apart from the name, only store non-default values.
320 // No need to store col.visible, since that's implicit
321 if (col.flex != 2) c.flex = col.flex;
322 if (Number(col.sort)) c.sort = Number(c.sort);
326 egCore.hatch.setItem('eg.grid.' + grid.persistKey, conf)
328 // Save operation performed from the grid configuration UI.
329 // Hide the configuration UI and re-draw w/ sort applied
330 if ($scope.showGridConf)
331 $scope.toggleConfDisplay();
335 // load the columns configuration (position, sort, width) from
336 // eg.grid.<persist-key> and apply the loaded settings to the
337 // columns on our columnsProvider
338 grid.loadConfig = function() {
339 if (!grid.persistKey) return $q.when();
341 return egCore.hatch.getItem('eg.grid.' + grid.persistKey)
342 .then(function(conf) {
345 var columns = grid.columnsProvider.columns;
348 angular.forEach(conf, function(col) {
349 var grid_col = columns.filter(
350 function(c) {return c.name == col.name})[0];
353 // saved column does not match a column in the
354 // current grid. skip it.
358 grid_col.flex = col.flex || 2;
359 grid_col.sort = col.sort || 0;
360 // all saved columns are assumed to be true
361 grid_col.visible = true;
362 new_cols.push(grid_col);
365 // columns which are not expressed within the saved
366 // configuration are marked as non-visible and
367 // appended to the end of the new list of columns.
368 angular.forEach(columns, function(col) {
369 var found = conf.filter(
370 function(c) {return (c.name == col.name)})[0];
377 grid.columnsProvider.columns = new_cols;
382 $scope.onContextMenu = function($event) {
383 var col = angular.element($event.target).attr('column');
384 console.log('selected column ' + col);
387 $scope.page = function() {
388 return (grid.offset / grid.limit) + 1;
391 $scope.goToPage = function(page) {
393 if (angular.isNumber(page) && page > 0) {
394 grid.offset = (page - 1) * grid.limit;
399 $scope.offset = function(o) {
400 if (angular.isNumber(o))
405 $scope.limit = function(l) {
406 if (angular.isNumber(l)) {
408 egCore.hatch.setLocalItem('eg.grid.' + grid.persistKey + '.limit', l);
414 $scope.onFirstPage = function() {
415 return grid.offset == 0;
418 $scope.hasNextPage = function() {
419 // we have less data than requested, there must
420 // not be any more pages
421 if (grid.count() < grid.limit) return false;
423 // if the total count is not known, assume that a full
424 // page of data implies more pages are available.
425 if (grid.totalCount == -1) return true;
427 // we have a full page of data, but is there more?
428 return grid.totalCount > (grid.offset + grid.count());
431 $scope.incrementPage = function() {
432 grid.offset += grid.limit;
436 $scope.decrementPage = function() {
437 if (grid.offset < grid.limit) {
440 grid.offset -= grid.limit;
445 // number of items loaded for the current page of results
446 grid.count = function() {
447 return $scope.items.length;
450 // returns the unique identifier value for the provided item
451 // for internal consistency, indexValue is always coerced
453 grid.indexValue = function(item) {
454 if (angular.isObject(item)) {
456 if (angular.isFunction(item[grid.indexField]))
457 return ''+item[grid.indexField]();
458 return ''+item[grid.indexField]; // flat data
461 // passed a non-object; assume it's an index
465 // fires the hide handler function for a context action
466 $scope.actionHide = function(action) {
470 return action.hide(action);
473 // fires the action handler function for a context action
474 $scope.actionLauncher = function(action) {
475 if (!action.handler) {
477 'No handler specified for "' + action.label + '"');
481 action.handler(grid.getSelectedItems());
483 console.error('Error executing handler for "'
484 + action.label + '" => ' + E + "\n" + E.stack);
487 if ($scope.action_context_showing) $scope.hideActionContextMenu();
492 $scope.hideActionContextMenu = function () {
493 $($scope.menu_dom).css({
495 width: $scope.action_context_width,
496 top: $scope.action_context_y,
497 left: $scope.action_context_x
499 $($scope.action_context_parent).append($scope.menu_dom);
500 $scope.action_context_oldy = $scope.action_context_oldx = 0;
501 $('body').unbind('click.remove_context_menu_'+$scope.action_context_index);
502 $scope.action_context_showing = false;
505 $scope.action_context_showing = false;
506 $scope.showActionContextMenu = function ($event) {
508 // Have to gather these here, instead of inside link()
509 if (!$scope.menu_dom) $scope.menu_dom = $($scope.grid_element).find('.grid-action-dropdown')[0];
510 if (!$scope.action_context_parent) $scope.action_context_parent = $($scope.menu_dom).parent();
512 if (!grid.getSelectedItems().length) // Nothing selected, fire the click event
513 $event.target.click();
515 if (!$scope.action_context_showing) {
516 $scope.action_context_width = $($scope.menu_dom).css('width');
517 $scope.action_context_y = $($scope.menu_dom).css('top');
518 $scope.action_context_x = $($scope.menu_dom).css('left');
519 $scope.action_context_showing = true;
520 $scope.action_context_index = Math.floor((Math.random() * 1000) + 1);
522 $('body').append($($scope.menu_dom));
523 $('body').bind('click.remove_context_menu_'+$scope.action_context_index, $scope.hideActionContextMenu);
526 $($scope.menu_dom).css({
528 width: $scope.action_context_width,
536 // returns the list of selected item objects
537 grid.getSelectedItems = function() {
538 return $scope.items.filter(
540 return Boolean($scope.selected[grid.indexValue(item)]);
545 grid.getItemByIndex = function(index) {
546 for (var i = 0; i < $scope.items.length; i++) {
547 var item = $scope.items[i];
548 if (grid.indexValue(item) == index)
553 // selects one row after deselecting all of the others
554 grid.selectOneItem = function(index) {
555 $scope.selected = {};
556 $scope.selected[index] = true;
559 // selects or deselects an item, without affecting the others.
560 // returns true if the item is selected; false if de-selected.
561 grid.toggleSelectOneItem = function(index) {
562 if ($scope.selected[index]) {
563 delete $scope.selected[index];
566 return $scope.selected[index] = true;
570 grid.selectAllItems = function() {
571 angular.forEach($scope.items, function(item) {
572 $scope.selected[grid.indexValue(item)] = true
576 $scope.$watch('selectAll', function(newVal) {
578 grid.selectAllItems();
580 $scope.selected = {};
584 // returns true if item1 appears in the list before item2;
585 // false otherwise. this is slightly more efficient that
586 // finding the position of each then comparing them.
587 // item1 / item2 may be an item or an item index
588 grid.itemComesBefore = function(itemOrIndex1, itemOrIndex2) {
589 var idx1 = grid.indexValue(itemOrIndex1);
590 var idx2 = grid.indexValue(itemOrIndex2);
592 // use for() for early exit
593 for (var i = 0; i < $scope.items.length; i++) {
594 var idx = grid.indexValue($scope.items[i]);
595 if (idx == idx1) return true;
596 if (idx == idx2) return false;
601 // 0-based position of item in the current data set
602 grid.indexOf = function(item) {
603 var idx = grid.indexValue(item);
604 for (var i = 0; i < $scope.items.length; i++) {
605 if (grid.indexValue($scope.items[i]) == idx)
611 grid.modifyColumnFlex = function(column, val) {
613 // prevent flex:0; use hiding instead
617 $scope.modifyColumnFlex = function(col, val) {
618 grid.modifyColumnFlex(col, val);
621 // handles click, control-click, and shift-click
622 $scope.handleRowClick = function($event, item) {
623 var index = grid.indexValue(item);
625 var origSelected = Object.keys($scope.selected);
627 if ($event.ctrlKey || $event.metaKey /* mac command */) {
629 if (grid.toggleSelectOneItem(index))
630 grid.lastSelectedItemIndex = index;
632 } else if ($event.shiftKey) {
635 if (!grid.lastSelectedItemIndex ||
636 index == grid.lastSelectedItemIndex) {
637 grid.selectOneItem(index);
638 grid.lastSelectedItemIndex = index;
642 var selecting = false;
643 var ascending = grid.itemComesBefore(
644 grid.lastSelectedItemIndex, item);
646 grid.indexOf(grid.lastSelectedItemIndex);
648 // update to new last-selected
649 grid.lastSelectedItemIndex = index;
651 // select each row between the last selected and
652 // currently selected items
654 startPos += ascending ? 1 : -1;
655 var curItem = $scope.items[startPos];
657 var curIdx = grid.indexValue(curItem);
658 $scope.selected[curIdx] = true;
659 if (curIdx == index) break; // all done
664 grid.selectOneItem(index);
665 grid.lastSelectedItemIndex = index;
669 // Builds a sort expression from column sort priorities.
670 // called on page load and any time the priorities are modified.
671 grid.compileSort = function() {
672 var sortList = grid.columnsProvider.columns.filter(
673 function(col) { return Number(col.sort) != 0 }
676 if (Math.abs(a.sort) < Math.abs(b.sort))
682 if (sortList.length) {
683 grid.dataProvider.sort = sortList.map(function(col) {
685 blob[col.name] = col.sort < 0 ? 'desc' : 'asc';
691 // builds a sort expression using a single column,
692 // toggling between ascending and descending sort.
693 $scope.quickSort = function(col_name) {
694 var sort = grid.dataProvider.sort;
695 if (sort && sort.length &&
696 sort[0] == col_name) {
698 blob[col_name] = 'desc';
699 grid.dataProvider.sort = [blob];
701 grid.dataProvider.sort = [col_name];
708 // show / hide the grid configuration row
709 $scope.toggleConfDisplay = function() {
710 if ($scope.showGridConf) {
711 $scope.showGridConf = false;
712 if (grid.columnsProvider.hasSortableColumn()) {
713 // only refresh the grid if the user has the
714 // ability to modify the sort priorities.
720 $scope.showGridConf = true;
723 $scope.gridColumnPickerIsOpen = false;
726 // called when a dragged column is dropped onto itself
727 // or any other column
728 grid.onColumnDrop = function(target) {
729 if (angular.isUndefined(target)) return;
730 if (target == grid.dragColumn) return;
731 var srcIdx, targetIdx, srcCol;
732 angular.forEach(grid.columnsProvider.columns,
734 if (col.name == grid.dragColumn) {
737 } else if (col.name == target) {
743 if (srcIdx < targetIdx) targetIdx--;
745 // move src column from old location to new location in
746 // the columns array, then force a page refresh
747 grid.columnsProvider.columns.splice(srcIdx, 1);
748 grid.columnsProvider.columns.splice(targetIdx, 0, srcCol);
752 // prepares a string for inclusion within a CSV document
753 // by escaping commas and quotes and removing newlines.
754 grid.csvDatum = function(str) {
757 str = str.replace(/\n/g, '');
758 if (str.match(/\,/) || str.match(/"/)) {
759 str = str.replace(/"/g, '""');
760 str = '"' + str + '"';
765 // sets the download file name and inserts the current CSV
766 // into a Blob URL for browser download.
767 $scope.generateCSVExportURL = function() {
768 $scope.gridColumnPickerIsOpen = false;
770 // let the file name describe the grid
771 $scope.csvExportFileName =
772 ($scope.mainLabel || grid.persistKey || 'eg_grid_data')
773 .replace(/\s+/g, '_') + '_' + $scope.page();
775 // toss the CSV into a Blob and update the export URL
776 var csv = grid.generateCSV();
777 var blob = new Blob([csv], {type : 'text/plain'});
778 $scope.csvExportURL =
779 ($window.URL || $window.webkitURL).createObjectURL(blob);
782 $scope.printCSV = function() {
783 $scope.gridColumnPickerIsOpen = false;
786 content : grid.generateCSV(),
787 content_type : 'text/plain'
791 // generates CSV for the currently visible grid contents
792 grid.generateCSV = function() {
794 var colCount = grid.columnsProvider.columns.length;
797 angular.forEach(grid.columnsProvider.columns,
799 if (!col.visible) return;
800 csvStr += grid.csvDatum(col.label);
805 csvStr = csvStr.replace(/,$/,'\n');
808 angular.forEach($scope.items, function(item) {
809 angular.forEach(grid.columnsProvider.columns,
811 if (!col.visible) return;
813 var val = grid.dataProvider.itemFieldValue(item, col);
814 // filtered value (dates, etc.)
815 val = $filter('egGridValueFilter')(val, col);
816 csvStr += grid.csvDatum(val);
820 csvStr = csvStr.replace(/,$/,'\n');
826 // Interpolate the value for column.linkpath within the context
827 // of the row item to generate the final link URL.
828 $scope.generateLinkPath = function(col, item) {
829 return egCore.strings.$replace(col.linkpath, {item : item});
832 // If a column provides its own HTML template, translate it,
833 // using the current item for the template scope.
834 // note: $sce is required to avoid security restrictions and
835 // is OK here, since the template comes directly from a
836 // local HTML template (not user input).
837 $scope.translateCellTemplate = function(col, item) {
838 var html = egCore.strings.$replace(col.template, {item : item});
839 return $sce.trustAsHtml(html);
842 $scope.collect = function() { grid.collect() }
844 // asks the dataProvider for a page of data
845 grid.collect = function() {
847 // avoid firing the collect if there is nothing to collect.
848 if (grid.selfManagedData && !grid.dataProvider.query) return;
850 if (grid.collecting) return; // avoid parallel collect()
851 grid.collecting = true;
853 console.debug('egGrid.collect() offset='
854 + grid.offset + '; limit=' + grid.limit);
856 // ensure all of our dropdowns are closed
857 // TODO: git rid of these and just use dropdown-toggle,
858 // which is more reliable.
859 $scope.gridColumnPickerIsOpen = false;
860 $scope.gridRowCountIsOpen = false;
861 $scope.gridPageSelectIsOpen = false;
864 $scope.selected = {};
865 grid.dataProvider.get(grid.offset, grid.limit).then(
867 if (grid.controls.allItemsRetrieved)
868 grid.controls.allItemsRetrieved();
873 $scope.items.push(item)
874 if (grid.controls.itemRetrieved)
875 grid.controls.itemRetrieved(item);
877 }).finally(function() {
878 console.debug('egGrid.collect() complete');
879 grid.collecting = false
889 * eg-grid-field : used for collecting custom field data from the templates.
890 * This directive does not direct display, it just passes data up to the
893 .directive('egGridField', function() {
898 name : '@', // required; unique name
899 path : '@', // optional; flesh path
900 ignore: '@', // optional; fields to ignore when path is a wildcard
901 label : '@', // optional; display label
902 flex : '@', // optional; default flex width
903 dateformat : '@', // optional: passed down to egGridValueFilter
905 // if a field is part of an IDL object, but we are unable to
906 // determine the class, because it's nested within a hash
907 // (i.e. we can't navigate directly to the object via the IDL),
908 // idlClass lets us specify the class. This is particularly
909 // useful for nested wildcard fields.
910 parentIdlClass : '@',
912 // optional: for non-IDL columns, specifying a datatype
913 // lets the caller control which display filter is used.
914 // datatype should match the standard IDL datatypes.
917 link : function(scope, element, attrs, egGridCtrl) {
919 // boolean fields are presented as value-less attributes
928 'required' // if set, always fetch data for this column
931 if (angular.isDefined(attrs[field]))
936 // any HTML content within the field is its custom template
937 var tmpl = element.html();
938 if (tmpl && !tmpl.match(/^\s*$/))
939 scope.template = tmpl
941 egGridCtrl.columnsProvider.add(scope);
948 * eg-grid-action : used for specifying actions which may be applied
949 * to items within the grid.
951 .directive('egGridAction', function() {
957 label : '@', // Action label
958 handler : '=', // Action function handler
962 link : function(scope, element, attrs, egGridCtrl) {
963 egGridCtrl.addAction({
966 divider : scope.divider,
967 handler : scope.handler
974 .factory('egGridColumnsProvider', ['egCore', function(egCore) {
976 function ColumnsProvider(args) {
979 cols.stockVisible = [];
980 cols.idlClass = args.idlClass;
981 cols.defaultToHidden = args.defaultToHidden;
982 cols.defaultToNoSort = args.defaultToNoSort;
983 cols.defaultToNoMultiSort = args.defaultToNoMultiSort;
985 // resets column width, visibility, and sort behavior
986 // Visibility resets to the visibility settings defined in the
987 // template (i.e. the original egGridField values).
988 cols.reset = function() {
989 angular.forEach(cols.columns, function(col) {
992 if (cols.stockVisible.indexOf(col.name) > -1) {
1000 // returns true if any columns are sortable
1001 cols.hasSortableColumn = function() {
1002 return cols.columns.filter(
1004 return col.sortable || col.multisortable;
1009 cols.showAllColumns = function() {
1010 angular.forEach(cols.columns, function(column) {
1011 column.visible = true;
1015 cols.hideAllColumns = function() {
1016 angular.forEach(cols.columns, function(col) {
1021 cols.indexOf = function(name) {
1022 for (var i = 0; i < cols.columns.length; i++) {
1023 if (cols.columns[i].name == name)
1029 cols.findColumn = function(name) {
1030 return cols.columns[cols.indexOf(name)];
1033 cols.compileAutoColumns = function() {
1034 var idl_class = egCore.idl.classes[cols.idlClass];
1037 idl_class.fields.sort(
1038 function(a, b) { return a.name < b.name ? -1 : 1 }),
1040 if (field.virtual) return;
1041 if (field.datatype == 'link' || field.datatype == 'org_unit') {
1042 // if the field is a link and the linked class has a
1043 // "selector" field specified, use the selector field
1044 // as the display field for the columns.
1045 // flattener will take care of the fleshing.
1046 if (field['class']) {
1047 var selector_field = egCore.idl.classes[field['class']].fields
1048 .filter(function(f) { return Boolean(f.selector) })[0];
1049 if (selector_field) {
1050 field.path = field.name + '.' + selector_field.selector;
1054 cols.add(field, true);
1059 // if a column definition has a path with a wildcard, create
1060 // columns for all non-virtual fields at the specified
1061 // position in the path.
1062 cols.expandPath = function(colSpec) {
1064 var ignoreList = [];
1066 ignoreList = colSpec.ignore.split(' ');
1068 var dotpath = colSpec.path.replace(/\.?\*$/,'');
1072 if (colSpec.parentIdlClass) {
1073 class_obj = egCore.idl.classes[colSpec.parentIdlClass];
1075 class_obj = egCore.idl.classes[cols.idlClass];
1078 if (!class_obj) return;
1080 console.debug('egGrid: auto dotpath is: ' + dotpath);
1081 var path_parts = dotpath.split(/\./);
1083 // find the IDL class definition for the last element in the
1084 // path before the .*
1085 // an empty path_parts means expand the root class
1087 for (var path_idx in path_parts) {
1088 var part = path_parts[path_idx];
1089 idl_field = class_obj.field_map[part];
1091 // unless we're at the end of the list, this field should
1092 // link to another class.
1093 if (idl_field && idl_field['class'] && (
1094 idl_field.datatype == 'link' ||
1095 idl_field.datatype == 'org_unit')) {
1096 class_obj = egCore.idl.classes[idl_field['class']];
1098 if (path_idx < (path_parts.length - 1)) {
1099 // we ran out of classes to hop through before
1100 // we ran out of path components
1101 console.error("egGrid: invalid IDL path: " + dotpath);
1108 angular.forEach(class_obj.fields, function(field) {
1110 // Only show wildcard fields where we have data to show
1111 // Virtual and un-fleshed links will not have any data.
1112 if (field.virtual ||
1113 (field.datatype == 'link' || field.datatype == 'org_unit') ||
1114 ignoreList.indexOf(field.name) > -1
1118 var col = cols.cloneFromScope(colSpec);
1119 col.path = dotpath + '.' + field.name;
1120 console.debug('egGrid: field: ' +field.name + '; parent field: ' + js2JSON(idl_field));
1121 cols.add(col, false, true,
1122 {idl_parent : idl_field, idl_field : field, idl_class : class_obj});
1125 cols.columns = cols.columns.sort(
1127 if (a.explicit) return -1;
1128 if (b.explicit) return 1;
1129 if (a.idlclass && b.idlclass) {
1130 return a.idlclass < b.idlclass ? -1 : 1;
1131 return a.idlclass > b.idlclass ? 1 : -1;
1133 if (a.path && b.path) {
1134 return a.path < b.path ? -1 : 1;
1135 return a.path > b.path ? 1 : -1;
1138 return a.label < b.label ? -1 : 1;
1145 "egGrid: wildcard path does not resolve to an object: "
1150 // angular.clone(scopeObject) is not permittable. Manually copy
1151 // the fields over that we need (so the scope object can go away).
1152 cols.cloneFromScope = function(colSpec) {
1154 name : colSpec.name,
1155 label : colSpec.label,
1156 path : colSpec.path,
1157 flex : Number(colSpec.flex) || 2,
1158 sort : Number(colSpec.sort) || 0,
1159 required : colSpec.required,
1160 linkpath : colSpec.linkpath,
1161 template : colSpec.template,
1162 visible : colSpec.visible,
1163 hidden : colSpec.hidden,
1164 datatype : colSpec.datatype,
1165 sortable : colSpec.sortable,
1166 nonsortable : colSpec.nonsortable,
1167 multisortable : colSpec.multisortable,
1168 nonmultisortable : colSpec.nonmultisortable,
1169 dateformat : colSpec.dateformat,
1170 parentIdlClass : colSpec.parentIdlClass
1175 // Add a column to the columns collection.
1176 // Columns may come from a slim eg-columns-field or
1177 // directly from the IDL.
1178 cols.add = function(colSpec, fromIDL, fromExpand, idl_info) {
1180 // First added column with the specified path takes precedence.
1181 // This allows for specific definitions followed by wildcard
1182 // definitions. If a match is found, back out.
1183 if (cols.columns.filter(function(c) {
1184 return (c.path == colSpec.path) })[0]) {
1185 console.debug('skipping pre-existing column ' + colSpec.path);
1189 var column = fromExpand ? colSpec : cols.cloneFromScope(colSpec);
1191 if (column.path && column.path.match(/\*$/))
1192 return cols.expandPath(colSpec);
1194 if (!fromExpand) column.explicit = true;
1196 if (!column.name) column.name = column.path;
1197 if (!column.path) column.path = column.name;
1199 if (column.visible || (!cols.defaultToHidden && !column.hidden))
1200 column.visible = true;
1202 if (column.sortable || (!cols.defaultToNoSort && !column.nonsortable))
1203 column.sortable = true;
1205 if (column.multisortable ||
1206 (!cols.defaultToNoMultiSort && !column.nonmultisortable))
1207 column.multisortable = true;
1209 cols.columns.push(column);
1211 // Track which columns are visible by default in case we
1212 // need to reset column visibility
1214 cols.stockVisible.push(column.name);
1216 if (fromIDL) return; // directly from egIDL. nothing left to do.
1218 // lookup the matching IDL field
1219 if (!idl_info && cols.idlClass)
1220 idl_info = cols.idlFieldFromPath(column.path);
1223 // column is not represented within the IDL
1224 column.adhoc = true;
1228 column.datatype = idl_info.idl_field.datatype;
1230 if (!column.label) {
1231 column.label = idl_info.idl_field.label || column.name;
1234 if (fromExpand && idl_info.idl_class) {
1235 column.idlclass = '';
1236 if (idl_info.idl_parent) {
1237 column.idlclass = idl_info.idl_parent.label || idl_info.idl_parent.name;
1239 column.idlclass += idl_info.idl_class.label || idl_info.idl_class.name;
1244 // finds the IDL field from the dotpath, using the columns
1245 // idlClass as the base.
1246 cols.idlFieldFromPath = function(dotpath) {
1247 var class_obj = egCore.idl.classes[cols.idlClass];
1248 var path_parts = dotpath.split(/\./);
1252 for (var path_idx in path_parts) {
1253 var part = path_parts[path_idx];
1254 idl_parent = idl_field;
1255 idl_field = class_obj.field_map[part];
1257 if (idl_field && idl_field['class'] && (
1258 idl_field.datatype == 'link' ||
1259 idl_field.datatype == 'org_unit')) {
1260 class_obj = egCore.idl.classes[idl_field['class']];
1262 // else, path is not in the IDL, which is fine
1265 if (!idl_field) return null;
1268 idl_parent: idl_parent,
1269 idl_field : idl_field,
1270 idl_class : class_obj
1276 instance : function(args) { return new ColumnsProvider(args) }
1282 * Generic data provider template class. This is basically an abstract
1283 * class factory service whose instances can be locally modified to
1284 * meet the needs of each individual grid.
1286 .factory('egGridDataProvider',
1287 ['$q','$timeout','$filter','egCore',
1288 function($q , $timeout , $filter , egCore) {
1290 function GridDataProvider(args) {
1291 var gridData = this;
1292 if (!args) args = {};
1295 gridData.get = args.get;
1296 gridData.query = args.query;
1297 gridData.idlClass = args.idlClass;
1298 gridData.columnsProvider = args.columnsProvider;
1300 // Delivers a stream of array data via promise.notify()
1301 // Useful for passing an array of data to egGrid.get()
1302 // If a count is provided, the array will be trimmed to
1303 // the range defined by count and offset
1304 gridData.arrayNotifier = function(arr, offset, count) {
1305 if (!arr || arr.length == 0) return $q.when();
1306 if (count) arr = arr.slice(offset, offset + count);
1307 var def = $q.defer();
1308 // promise notifications are only witnessed when delivered
1309 // after the caller has his hands on the promise object
1310 $timeout(function() {
1311 angular.forEach(arr, def.notify);
1317 // Calls the grid refresh function. Once instantiated, the
1318 // grid will replace this function with it's own refresh()
1319 gridData.refresh = function(noReset) { }
1321 if (!gridData.get) {
1322 // returns a promise whose notify() delivers items
1323 gridData.get = function(index, count) {
1324 console.error("egGridDataProvider.get() not implemented");
1328 // attempts a flat field lookup first. If the column is not
1329 // found on the top-level object, attempts a nested lookup
1330 // TODO: consider a caching layer to speed up template
1331 // rendering, particularly for nested objects?
1332 gridData.itemFieldValue = function(item, column) {
1333 if (column.name in item) {
1334 if (typeof item[column.name] == 'function') {
1335 return item[column.name]();
1337 return item[column.name];
1340 return gridData.nestedItemFieldValue(item, column);
1344 // TODO: deprecate me
1345 gridData.flatItemFieldValue = function(item, column) {
1346 console.warn('gridData.flatItemFieldValue deprecated; '
1347 + 'leave provider.itemFieldValue unset');
1348 return item[column.name];
1351 // given an object and a dot-separated path to a field,
1352 // extract the value of the field. The path can refer
1353 // to function names or object attributes. If the final
1354 // value is an IDL field, run the value through its
1355 // corresponding output filter.
1356 gridData.nestedItemFieldValue = function(obj, column) {
1357 if (obj === null || obj === undefined || obj === '') return '';
1358 if (!column.path) return obj;
1361 var parts = column.path.split('.');
1363 angular.forEach(parts, function(step, idx) {
1364 // object is not fleshed to the expected extent
1365 if (!obj || typeof obj != 'object') {
1370 var cls = obj.classname;
1371 if (cls && (class_obj = egCore.idl.classes[cls])) {
1372 idl_field = class_obj.field_map[step];
1373 obj = obj[step] ? obj[step]() : '';
1375 if (angular.isFunction(obj[step])) {
1383 // We found a nested IDL object which may or may not have
1384 // been configured as a top-level column. Grab the datatype.
1385 if (idl_field && !column.datatype)
1386 column.datatype = idl_field.datatype;
1388 if (obj === null || obj === undefined || obj === '') return '';
1394 instance : function(args) {
1395 return new GridDataProvider(args);
1402 // Factory service for egGridDataManager instances, which are
1403 // responsible for collecting flattened grid data.
1404 .factory('egGridFlatDataProvider',
1405 ['$q','egCore','egGridDataProvider',
1406 function($q , egCore , egGridDataProvider) {
1409 instance : function(args) {
1410 var provider = egGridDataProvider.instance(args);
1412 provider.get = function(offset, count) {
1414 // no query means no call
1415 if (!provider.query ||
1416 angular.equals(provider.query, {}))
1419 // find all of the currently visible columns
1420 var queryFields = {}
1421 angular.forEach(provider.columnsProvider.columns,
1423 // only query IDL-tracked columns
1424 if (!col.adhoc && (col.required || col.visible))
1425 queryFields[col.name] = col.path;
1429 return egCore.net.request(
1431 'open-ils.fielder.flattened_search',
1432 egCore.auth.token(), provider.idlClass,
1433 queryFields, provider.query,
1434 { sort : provider.sort,
1440 //provider.itemFieldValue = provider.flatItemFieldValue;
1447 .directive('egGridColumnDragSource', function() {
1450 require : '^egGrid',
1451 link : function(scope, element, attrs, egGridCtrl) {
1452 angular.element(element).attr('draggable', 'true');
1454 element.bind('dragstart', function(e) {
1455 egGridCtrl.dragColumn = attrs.column;
1456 egGridCtrl.dragType = attrs.dragType || 'move'; // or resize
1457 egGridCtrl.colResizeDir = 0;
1459 if (egGridCtrl.dragType == 'move') {
1460 // style the column getting moved
1461 angular.element(e.target).addClass(
1462 'eg-grid-column-move-handle-active');
1466 element.bind('dragend', function(e) {
1467 if (egGridCtrl.dragType == 'move') {
1468 angular.element(e.target).removeClass(
1469 'eg-grid-column-move-handle-active');
1476 .directive('egGridColumnDragDest', function() {
1479 require : '^egGrid',
1480 link : function(scope, element, attrs, egGridCtrl) {
1482 element.bind('dragover', function(e) { // required for drop
1483 e.stopPropagation();
1485 e.dataTransfer.dropEffect = 'move';
1487 if (egGridCtrl.colResizeDir == 0) return; // move
1489 var cols = egGridCtrl.columnsProvider;
1490 var srcCol = egGridCtrl.dragColumn;
1491 var srcColIdx = cols.indexOf(srcCol);
1493 if (egGridCtrl.colResizeDir == -1) {
1494 if (cols.indexOf(attrs.column) <= srcColIdx) {
1495 egGridCtrl.modifyColumnFlex(
1496 egGridCtrl.columnsProvider.findColumn(
1497 egGridCtrl.dragColumn), -1);
1498 if (cols.columns[srcColIdx+1]) {
1499 // source column shrinks by one, column to the
1500 // right grows by one.
1501 egGridCtrl.modifyColumnFlex(
1502 cols.columns[srcColIdx+1], 1);
1507 if (cols.indexOf(attrs.column) > srcColIdx) {
1508 egGridCtrl.modifyColumnFlex(
1509 egGridCtrl.columnsProvider.findColumn(
1510 egGridCtrl.dragColumn), 1);
1511 if (cols.columns[srcColIdx+1]) {
1512 // source column grows by one, column to the
1513 // right grows by one.
1514 egGridCtrl.modifyColumnFlex(
1515 cols.columns[srcColIdx+1], -1);
1523 element.bind('dragenter', function(e) {
1524 e.stopPropagation();
1526 if (egGridCtrl.dragType == 'move') {
1527 angular.element(e.target).addClass('eg-grid-col-hover');
1529 // resize grips are on the right side of each column.
1530 // dragenter will either occur on the source column
1531 // (dragging left) or the column to the right.
1532 if (egGridCtrl.colResizeDir == 0) {
1533 if (egGridCtrl.dragColumn == attrs.column) {
1534 egGridCtrl.colResizeDir = -1; // west
1536 egGridCtrl.colResizeDir = 1; // east
1542 element.bind('dragleave', function(e) {
1543 e.stopPropagation();
1545 if (egGridCtrl.dragType == 'move') {
1546 angular.element(e.target).removeClass('eg-grid-col-hover');
1550 element.bind('drop', function(e) {
1551 e.stopPropagation();
1553 egGridCtrl.colResizeDir = 0;
1554 if (egGridCtrl.dragType == 'move') {
1555 angular.element(e.target).removeClass('eg-grid-col-hover');
1556 egGridCtrl.onColumnDrop(attrs.column); // move the column
1563 .directive('egGridMenuItem', function() {
1566 require : '^egGrid',
1569 handler : '=', // onclick handler function
1570 divider : '=', // if true, show a divider only
1571 handlerData : '=', // if set, passed as second argument to handler
1572 disabled : '=', // function
1573 hidden : '=' // function
1575 link : function(scope, element, attrs, egGridCtrl) {
1576 egGridCtrl.addMenuItem({
1577 label : scope.label,
1578 handler : scope.handler,
1579 divider : scope.divider,
1580 disabled : scope.disabled,
1581 hidden : scope.hidden,
1582 handlerData : scope.handlerData
1592 * Translates bare IDL object values into display values.
1593 * 1. Passes dates through the angular date filter
1594 * 2. Translates bools to Booleans so the browser can display translated
1595 * value. (Though we could manually translate instead..)
1596 * Others likely to follow...
1598 .filter('egGridValueFilter', ['$filter', function($filter) {
1599 return function(value, column) {
1600 switch(column.datatype) {
1603 // Browser will translate true/false for us
1605 case '1' : // legacy
1609 case '0' : // legacy
1612 // value may be null, '', etc.
1613 default : return '';
1616 // canned angular date filter FTW
1617 if (!column.dateformat)
1618 column.dateformat = 'shortDate';
1619 return $filter('date')(value, column.dateformat);
1621 return $filter('currency')(value);