1 if(!dojo._hasResource['openils.widget.AutoGrid']) {
2 dojo.provide('openils.widget.AutoGrid');
3 dojo.require('dojox.grid.DataGrid');
4 dojo.require('dijit.layout.ContentPane');
5 dojo.require('openils.widget.AutoWidget');
6 dojo.require('openils.widget.AutoFieldWidget');
7 dojo.require('openils.widget.EditPane');
8 dojo.require('openils.widget.EditDialog');
9 dojo.require('openils.widget.GridColumnPicker');
10 dojo.require('openils.Util');
13 'openils.widget.AutoGrid',
14 [dojox.grid.DataGrid, openils.widget.AutoWidget],
17 /* if true, pop up an edit dialog when user hits Enter on a give row */
18 editPaneOnSubmit : null,
19 createPaneOnSubmit : null,
21 defaultCellWidth : null,
24 suppressFields : null,
25 suppressEditFields : null,
26 suppressFilterFields : null,
28 hideLineNumber : false,
29 selectorWidth : '1.5',
30 lineNumberWidth : '1.5',
31 showColumnPicker : false,
32 columnPickerPrefix : null,
35 requiredFields : null,
36 hidePaginator : false,
37 showLoadFilter : false,
38 suppressLinkedFields : null, // list of fields whose linked display data should not be fetched from the server
40 /* by default, don't show auto-generated (sequence) fields */
41 showSequenceFields : false,
43 // style the cells in the line number column
44 onStyleRow : function(row) {
45 if (!this.hideLineNumber) {
46 var cellIdx = this.hideSelector ? 0 : 1;
47 dojo.addClass(this.views.views[0].getCellNode(row.index, cellIdx), 'autoGridLineNumber');
51 startup : function() {
52 this.selectionMode = 'single';
53 this.sequence = openils.widget.AutoGrid.sequence++;
54 openils.widget.AutoGrid.gridCache[this.sequence] = this;
55 this.inherited(arguments);
57 this.attr('structure', this._compileStructure());
58 this.setStore(this.buildAutoStore());
59 this.cachedQueryOpts = {};
60 this._showing_create_pane = false;
62 if(this.showColumnPicker) {
63 if(!this.columnPickerPrefix) {
64 console.error("No columnPickerPrefix defined");
66 var picker = new openils.widget.GridColumnPicker(
67 openils.User.authtoken, this.columnPickerPrefix, this);
68 if(openils.User.authtoken) {
71 openils.Util.addOnLoad(function() { picker.load() });
76 this.overrideEditWidgets = {};
77 this.overrideEditWidgetClass = {};
78 this.overrideWidgetArgs = {};
81 this._applyEditOnEnter();
82 else if(this.singleEditStyle)
83 this._applySingleEditStyle();
85 if(!this.hideSelector) {
86 dojo.connect(this, 'onHeaderCellClick',
89 this.toggleSelectAll();
94 if(!this.hidePaginator) {
96 this.paginator = new dijit.layout.ContentPane();
99 var back = dojo.create('a', {
100 innerHTML : 'Back', // TODO i18n
101 style : 'padding-right:6px;',
102 href : 'javascript:void(0);',
103 onclick : function() {
104 self.cachedQueryOpts.offset = self.displayOffset -= self.displayLimit;
105 if(self.displayOffset < 0)
106 self.cachedQueryOpts.offset = self.displayOffset = 0;
111 var forw = dojo.create('a', {
112 innerHTML : 'Next', // TODO i18n
113 style : 'padding-right:6px;',
114 href : 'javascript:void(0);',
115 onclick : function() {
116 self.cachedQueryOpts.offset = self.displayOffset += self.displayLimit;
121 dojo.place(this.paginator.domNode, this.domNode, 'before');
122 dojo.place(back, this.paginator.domNode);
123 dojo.place(forw, this.paginator.domNode);
125 if(this.showLoadFilter) {
126 dojo.require('openils.widget.PCrudFilterDialog');
129 innerHTML : 'Filter', // TODO i18n
130 style : 'padding-right:6px;',
131 href : 'javascript:void(0);',
132 onclick : function() {
133 if (!self.filterDialog) {
134 self.filterDialog = new openils.widget.PCrudFilterDialog({fmClass:self.fmClass, suppressFilterFields:self.suppressFilterFields})
135 self.filterDialog.onApply = function(filter) {
137 self.loadAll(self.cachedQueryOpts, filter);
139 self.filterDialog.startup();
141 self.filterDialog.show();
144 this.paginator.domNode
149 this.loadProgressIndicator = dojo.create('img', {
150 src:'/opac/images/progressbar_green.gif', // TODO configured path
151 style:'height:16px;width:16px;'
153 dojo.place(this.loadProgressIndicator, this.paginator.domNode);
157 hideLoadProgressIndicator : function() {
158 dojo.style(this.loadProgressIndicator, 'visibility', 'hidden');
161 showLoadProgressIndicator : function() {
162 dojo.style(this.loadProgressIndicator, 'visibility', 'visible');
165 /* Don't allow sorting on the selector column */
166 canSort : function(rowIdx) {
167 if(rowIdx == 1 && !this.hideSelector)
169 if(this.hideSelector && rowIdx == 1 && !this.hideLineNumber)
171 if(!this.hideSelector && rowIdx == 2 && !this.hideLineNumber)
176 _compileStructure : function() {
177 var existing = (this.structure && this.structure[0].cells[0]) ?
178 this.structure[0].cells[0] : [];
182 function pushEntry(entry) {
183 if(self.suppressFields) {
184 if(dojo.indexOf(self.suppressFields, entry.field) != -1)
188 entry.get = openils.widget.AutoGrid.defaultGetter
189 if(!entry.width && self.defaultCellWidth)
190 entry.width = self.defaultCellWidth;
194 if(!this.hideSelector) {
195 // insert the selector column
198 formatter : function(rowIdx) { return self._formatRowSelectInput(rowIdx); },
199 get : function(rowIdx, item) { if(item) return rowIdx; },
200 width : this.selectorWidth,
206 if(!this.hideLineNumber) {
207 // insert the line number column
210 get : function(rowIdx, item) { if(item) return 1 + rowIdx; },
211 width : this.lineNumberWidth,
213 nonSelectable : false
217 if(!this.fieldOrder) {
218 /* no order defined, start with any explicit grid fields */
219 for(var e in existing) {
220 var entry = existing[e];
221 var field = this.fmIDL.fields.filter(
222 function(i){return (i.name == entry.field)})[0];
223 if(field) entry.name = entry.name || field.label;
228 for(var f in this.sortedFieldList) {
229 var field = this.sortedFieldList[f];
230 if(!field || field.virtual) continue;
232 // field was already added above
233 if(fields.filter(function(i){return (i.field == field.name)})[0])
236 var entry = existing.filter(function(i){return (i.field == field.name)})[0];
238 entry.name = entry.name || field.label;
240 // unless specifically requested, hide sequence fields
241 if(!this.showSequenceFields && field.name == this.fmIDL.pkey && this.fmIDL.pkey_sequence)
244 entry = {field:field.name, name:field.label};
249 if(this.fieldOrder) {
250 /* append any explicit non-IDL grid fields to the end */
251 for(var e in existing) {
252 var entry = existing[e];
253 var field = fields.filter(
254 function(i){return (i.field == entry.field)})[0];
255 if(field) continue; // don't duplicate
260 return [{cells: [fields]}];
263 toggleSelectAll : function() {
264 var selected = this.getSelectedRows();
265 for(var i = 0; i < this.rowCount; i++) {
273 getSelectedRows : function() {
276 dojo.query('[name=autogrid.selector]', this.domNode),
279 rows.push(input.getAttribute('row'));
285 getFirstSelectedRow : function() {
286 return this.getSelectedRows()[0];
289 getSelectedItems : function() {
292 dojo.forEach(this.getSelectedRows(), function(idx) { items.push(self.getItem(idx)); });
296 selectRow : function(rowIdx) {
297 var inputs = dojo.query('[name=autogrid.selector]', this.domNode);
298 for(var i = 0; i < inputs.length; i++) {
299 if(inputs[i].getAttribute('row') == rowIdx) {
300 if(!inputs[i].disabled)
301 inputs[i].checked = true;
307 deSelectRow : function(rowIdx) {
308 var inputs = dojo.query('[name=autogrid.selector]', this.domNode);
309 for(var i = 0; i < inputs.length; i++) {
310 if(inputs[i].getAttribute('row') == rowIdx) {
311 inputs[i].checked = false;
318 * @return {Array} List of every fieldmapper object in the data store
320 getAllObjects : function() {
324 onComplete : function(list) {
327 objs.push(new fieldmapper[self.fmClass]().fromStoreItem(item));
336 * Deletes the underlying object for all selected rows
338 deleteSelected : function() {
339 var items = this.getSelectedItems();
340 var total = items.length;
342 dojo.require('openils.PermaCrud');
345 var fmObject = new fieldmapper[self.fmClass]().fromStoreItem(item);
346 new openils.PermaCrud()['eliminate'](fmObject, {oncomplete : function(r) { self.store.deleteItem(item) }});
351 _formatRowSelectInput : function(rowIdx) {
352 if(rowIdx === null || rowIdx === undefined) return '';
353 var s = "<input type='checkbox' name='autogrid.selector' row='" + rowIdx + "'";
354 if(this.disableSelectorForRow && this.disableSelectorForRow(rowIdx))
355 s += " disabled='disabled'";
359 _applySingleEditStyle : function() {
360 this.onMouseOverRow = function(e) {};
361 this.onMouseOutRow = function(e) {};
362 this.onCellFocus = function(cell, rowIndex) {
363 this.selection.deselectAll();
364 this.selection.select(this.focus.rowIndex);
368 /* capture keydown and launch edit dialog on enter */
369 _applyEditOnEnter : function() {
370 this._applySingleEditStyle();
372 dojo.connect(this, 'onRowDblClick',
374 if(this.editStyle == 'pane')
375 this._drawEditPane(this.selection.getFirstSelected(), this.focus.rowIndex);
377 this._drawEditDialog(this.selection.getFirstSelected(), this.focus.rowIndex);
381 dojo.connect(this, 'onKeyDown',
383 if(e.keyCode == dojo.keys.ENTER) {
384 this.selection.deselectAll();
385 this.selection.select(this.focus.rowIndex);
386 if(this.editStyle == 'pane')
387 this._drawEditPane(this.selection.getFirstSelected(), this.focus.rowIndex);
389 this._drawEditDialog(this.selection.getFirstSelected(), this.focus.rowIndex);
395 _makeEditPane : function(storeItem, rowIndex, onPostSubmit, onCancel) {
397 var fmObject = new fieldmapper[this.fmClass]().fromStoreItem(storeItem);
398 var idents = grid.store.getIdentityAttributes();
401 var pane = new openils.widget.EditPane({
403 hideSaveButton : this.editReadOnly,
404 readOnly : this.editReadOnly,
405 overrideWidgets : this.overrideEditWidgets,
406 overrideWidgetClass : this.overrideEditWidgetClass,
407 overrideWidgetArgs : this.overrideWidgetArgs,
408 disableWidgetTest : this.disableWidgetTest,
409 requiredFields : this.requiredFields,
410 suppressFields : this.suppressEditFields,
411 onPostSubmit : function() {
412 for(var i in fmObject._fields) {
413 var field = fmObject._fields[i];
414 if(idents.filter(function(j){return (j == field)})[0])
415 continue; // don't try to edit an identifier field
416 grid.store.setValue(storeItem, field, fmObject[field]());
418 if(self.onPostUpdate)
419 self.onPostUpdate(storeItem, rowIndex);
423 grid.views.views[0].getCellNode(rowIndex, 0).focus();
430 onCancel : function() {
431 setTimeout(function(){
432 grid.views.views[0].getCellNode(rowIndex, 0).focus();},200);
433 if(onCancel) onCancel();
437 if (typeof this.editPaneOnSubmit == "function")
438 pane.onSubmit = this.editPaneOnSubmit;
439 pane.fieldOrder = this.fieldOrder;
440 pane.mode = 'update';
444 _makeCreatePane : function(onPostSubmit, onCancel) {
446 var pane = new openils.widget.EditPane({
447 fmClass : this.fmClass,
448 overrideWidgets : this.overrideEditWidgets,
449 overrideWidgetClass : this.overrideEditWidgetClass,
450 overrideWidgetArgs : this.overrideWidgetArgs,
451 disableWidgetTest : this.disableWidgetTest,
452 requiredFields : this.requiredFields,
453 suppressFields : this.suppressEditFields,
454 onPostSubmit : function(req, cudResults) {
455 var fmObject = cudResults[0];
456 if(grid.onPostCreate)
457 grid.onPostCreate(fmObject);
459 grid.store.newItem(fmObject.toStoreItem());
460 setTimeout(function(){
462 grid.selection.select(grid.rowCount-1);
463 grid.views.views[0].getCellNode(grid.rowCount-1, 1).focus();
467 onPostSubmit(fmObject);
469 onCancel : function() {
470 if(onCancel) onCancel();
473 if (typeof this.createPaneOnSubmit == "function")
474 pane.onSubmit = this.createPaneOnSubmit;
475 pane.fieldOrder = this.fieldOrder;
476 pane.mode = 'create';
481 * Creates an EditPane with a copy of the data from the provided store
482 * item for cloning said item
483 * @param {Object} storeItem Dojo data item
484 * @param {Number} rowIndex The Grid row index of the item to be cloned
485 * @param {Function} onPostSubmit Optional callback for post-submit behavior
486 * @param {Function} onCancel Optional callback for clone cancelation
487 * @return {Object} The clone EditPane
489 _makeClonePane : function(storeItem, rowIndex, onPostSubmit, onCancel) {
490 var clonePane = this._makeCreatePane(onPostSubmit, onCancel);
491 var origPane = this._makeEditPane(storeItem, rowIndex);
494 dojo.forEach(origPane.fieldList,
496 if(field.widget.widget.attr('disabled')) return;
497 var w = clonePane.fieldList.filter(
498 function(i) { return (i.name == field.name) })[0];
499 w.widget.baseWidgetValue(field.widget.widget.attr('value')); // sync widgets
500 w.widget.onload = function(){w.widget.baseWidgetValue(field.widget.widget.attr('value'))}; // async widgets
508 _drawEditDialog : function(storeItem, rowIndex) {
510 var done = function() { self.hideDialog(); };
511 var pane = this._makeEditPane(storeItem, rowIndex, done, done);
512 this.editDialog = new openils.widget.EditDialog({editPane:pane});
513 this.editDialog.startup();
514 this.editDialog.show();
518 * Generates an EditDialog for object creation and displays it to the user
520 showCreateDialog : function() {
522 var done = function() { self.hideDialog(); };
523 var pane = this._makeCreatePane(done, done);
524 this.editDialog = new openils.widget.EditDialog({editPane:pane});
525 this.editDialog.startup();
526 this.editDialog.show();
529 _drawEditPane : function(storeItem, rowIndex) {
531 var done = function() { self.hidePane(); };
532 dojo.style(this.domNode, 'display', 'none');
533 this.editPane = this._makeEditPane(storeItem, rowIndex, done, done);
534 this.editPane.startup();
535 this.domNode.parentNode.insertBefore(this.editPane.domNode, this.domNode);
536 if(this.onEditPane) this.onEditPane(this.editPane);
539 showClonePane : function(onPostSubmit) {
541 var done = function() { self.hidePane(); };
544 var row = this.getFirstSelectedRow();
547 var postSubmit = (onPostSubmit) ?
548 function(result) { onPostSubmit(self.getItem(row), result); self.hidePane(); } :
551 dojo.style(this.domNode, 'display', 'none');
552 this.editPane = this._makeClonePane(this.getItem(row), row, postSubmit, done);
553 this.domNode.parentNode.insertBefore(this.editPane.domNode, this.domNode);
554 if(this.onEditPane) this.onEditPane(this.editPane);
557 showCreatePane : function() {
558 if (this._showing_create_pane)
560 this._showing_create_pane = true;
563 var done = function() {
564 self._showing_create_pane = false;
567 dojo.style(this.domNode, 'display', 'none');
568 this.editPane = this._makeCreatePane(done, done);
569 this.editPane.startup();
570 this.domNode.parentNode.insertBefore(this.editPane.domNode, this.domNode);
571 if(this.onEditPane) this.onEditPane(this.editPane);
574 hideDialog : function() {
575 this.editDialog.hide();
576 this.editDialog.destroy();
577 delete this.editDialog;
581 hidePane : function() {
582 this.domNode.parentNode.removeChild(this.editPane.domNode);
583 this.editPane.destroy();
584 delete this.editPane;
585 dojo.style(this.domNode, 'display', 'block');
589 resetStore : function() {
590 this.setStore(this.buildAutoStore());
593 refresh : function() {
598 this.loadAll(this.cachedQueryOpts, this.cachedQuerySearch);
601 loadAll : function(opts, search) {
602 dojo.require('openils.PermaCrud');
603 if(this.loadProgressIndicator)
604 dojo.style(this.loadProgressIndicator, 'visibility', 'visible');
607 {limit : this.displayLimit, offset : this.displayOffset},
610 opts = dojo.mixin(opts, {
613 onresponse : function(r) {
614 var item = openils.Util.readResponse(r);
615 self.store.newItem(item.toStoreItem());
617 oncomplete : function() {
618 if(self.loadProgressIndicator)
619 dojo.style(self.loadProgressIndicator, 'visibility', 'hidden');
623 this.cachedQuerySearch = search;
624 this.cachedQueryOpts = opts;
626 new openils.PermaCrud().search(this.fmClass, search, opts);
628 new openils.PermaCrud().retrieveAll(this.fmClass, opts);
633 // static ID generater seed
634 openils.widget.AutoGrid.sequence = 0;
635 openils.widget.AutoGrid.gridCache = {};
637 openils.widget.AutoGrid.markupFactory = dojox.grid.DataGrid.markupFactory;
639 openils.widget.AutoGrid.defaultGetter = function(rowIndex, item) {
641 if(!this.grid.overrideWidgetArgs[this.field])
642 this.grid.overrideWidgetArgs[this.field] = {};
643 var val = this.grid.store.getValue(item, this.field);
644 var autoWidget = new openils.widget.AutoFieldWidget(dojo.mixin({
645 fmClass: this.grid.fmClass,
649 forceSync : true, // prevents many simultaneous requests for the same data
650 suppressLinkedFields : this.grid.suppressLinkedFields
651 },this.grid.overrideWidgetArgs[this.field]));
656 // With proper caching, this should not be necessary to prevent grid render flickering
661 var node = _this.grid.getCell(_this.index).view.getCellNode(rowIndex, _this.index);
663 node.innerHTML = ww.getDisplayString();
669 return autoWidget.getDisplayString();
672 openils.widget.AutoGrid.orgUnitGetter = function(rowIndex, item) {
673 if (!item) return "";
674 return fieldmapper.aou.findOrgUnit(
675 this.grid.store.getValue(item, this.field)