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 */
19 defaultCellWidth : null,
21 suppressFields : null,
23 selectorWidth : '1.5',
24 showColumnPicker : false,
25 columnPickerPrefix : null,
28 requiredFields : null,
29 showPaginator : false,
30 showLoadFilter : false,
31 suppressLinkedFields : null, // list of fields whose linked display data should not be fetched from the server
33 /* by default, don't show auto-generated (sequence) fields */
34 showSequenceFields : false,
36 startup : function() {
37 this.selectionMode = 'single';
38 this.sequence = openils.widget.AutoGrid.sequence++;
39 openils.widget.AutoGrid.gridCache[this.sequence] = this;
40 this.inherited(arguments);
42 this.attr('structure', this._compileStructure());
43 this.setStore(this.buildAutoStore());
44 this.cachedQueryOpts = {};
46 if(this.showColumnPicker) {
47 if(!this.columnPickerPrefix) {
48 console.error("No columnPickerPrefix defined");
50 var picker = new openils.widget.GridColumnPicker(
51 openils.User.authtoken, this.columnPickerPrefix, this);
52 if(openils.User.authtoken) {
55 openils.Util.addOnLoad(function() { picker.load() });
60 this.overrideEditWidgets = {};
61 this.overrideEditWidgetClass = {};
62 this.overrideWidgetArgs = {};
65 this._applyEditOnEnter();
66 else if(this.singleEditStyle)
67 this._applySingleEditStyle();
69 if(!this.hideSelector) {
70 dojo.connect(this, 'onHeaderCellClick',
73 this.toggleSelectAll();
78 if(this.showPaginator) {
80 this.paginator = new dijit.layout.ContentPane();
83 var back = dojo.create('a', {
84 innerHTML : 'Back', // TODO i18n
85 style : 'padding-right:6px;',
86 href : 'javascript:void(0);',
87 onclick : function() {
89 self.cachedQueryOpts.offset = self.displayOffset -= self.displayLimit;
90 if(self.displayOffset < 0)
91 self.cachedQueryOpts.offset = self.displayOffset = 0;
95 self.loadAll(self.cachedQueryOpts, self.cachedQuerySearch);
99 var forw = dojo.create('a', {
100 innerHTML : 'Next', // TODO i18n
101 style : 'padding-right:6px;',
102 href : 'javascript:void(0);',
103 onclick : function() {
105 self.cachedQueryOpts.offset = self.displayOffset += self.displayLimit;
109 self.loadAll(self.cachedQueryOpts, self.cachedQuerySearch);
113 dojo.place(this.paginator.domNode, this.domNode, 'before');
114 dojo.place(back, this.paginator.domNode);
115 dojo.place(forw, this.paginator.domNode);
117 if(this.showLoadFilter) {
118 dojo.require('openils.widget.PCrudFilterDialog');
121 innerHTML : 'Filter', // TODO i18n
122 style : 'padding-right:6px;',
123 href : 'javascript:void(0);',
124 onclick : function() {
125 var dialog = new openils.widget.PCrudFilterDialog({fmClass:self.fmClass})
126 dialog.onApply = function(filter) {
128 self.loadAll(self.cachedQueryOpts, filter);
134 this.paginator.domNode
139 this.loadProgressIndicator = dojo.create('img', {
140 src:'/opac/images/progressbar_green.gif', // TODO configured path
141 style:'height:16px;width:16px;'
143 dojo.place(this.loadProgressIndicator, this.paginator.domNode);
147 hideLoadProgressIndicator : function() {
148 dojo.style(this.loadProgressIndicator, 'visibility', 'hidden');
151 showLoadProgressIndicator : function() {
152 dojo.style(this.loadProgressIndicator, 'visibility', 'visible');
155 /* Don't allow sorting on the selector column */
156 canSort : function(rowIdx) {
157 if(rowIdx == 1 && !this.hideSelector)
162 _compileStructure : function() {
163 var existing = (this.structure && this.structure[0].cells[0]) ?
164 this.structure[0].cells[0] : [];
168 function pushEntry(entry) {
169 if(self.suppressFields) {
170 if(dojo.indexOf(self.suppressFields, entry.field) != -1)
174 entry.get = openils.widget.AutoGrid.defaultGetter
175 if(!entry.width && self.defaultCellWidth)
176 entry.width = self.defaultCellWidth;
180 if(!this.hideSelector) {
181 // insert the selector column
184 formatter : function(rowIdx) { return self._formatRowSelectInput(rowIdx); },
185 get : function(rowIdx, item) { if(item) return rowIdx; },
186 width : this.selectorWidth,
193 if(!this.fieldOrder) {
194 /* no order defined, start with any explicit grid fields */
195 for(var e in existing) {
196 var entry = existing[e];
197 var field = this.fmIDL.fields.filter(
198 function(i){return (i.name == entry.field)})[0];
199 if(field) entry.name = entry.name || field.label;
204 for(var f in this.sortedFieldList) {
205 var field = this.sortedFieldList[f];
206 if(!field || field.virtual) continue;
208 // field was already added above
209 if(fields.filter(function(i){return (i.field == field.name)})[0])
212 var entry = existing.filter(function(i){return (i.field == field.name)})[0];
214 entry.name = field.label;
216 // unless specifically requested, hide sequence fields
217 if(!this.showSequenceFields && field.name == this.fmIDL.pkey && this.fmIDL.pkey_sequence)
220 entry = {field:field.name, name:field.label};
225 if(this.fieldOrder) {
226 /* append any explicit non-IDL grid fields to the end */
227 for(var e in existing) {
228 var entry = existing[e];
229 var field = fields.filter(
230 function(i){return (i.field == entry.field)})[0];
231 if(field) continue; // don't duplicate
236 return [{cells: [fields]}];
239 toggleSelectAll : function() {
240 var selected = this.getSelectedRows();
241 for(var i = 0; i < this.rowCount; i++) {
249 getSelectedRows : function() {
252 dojo.query('[name=autogrid.selector]', this.domNode),
255 rows.push(input.getAttribute('row'));
261 getFirstSelectedRow : function() {
262 return this.getSelectedRows()[0];
265 getSelectedItems : function() {
268 dojo.forEach(this.getSelectedRows(), function(idx) { items.push(self.getItem(idx)); });
272 selectRow : function(rowIdx) {
273 var inputs = dojo.query('[name=autogrid.selector]', this.domNode);
274 for(var i = 0; i < inputs.length; i++) {
275 if(inputs[i].getAttribute('row') == rowIdx) {
276 if(!inputs[i].disabled)
277 inputs[i].checked = true;
283 deSelectRow : function(rowIdx) {
284 var inputs = dojo.query('[name=autogrid.selector]', this.domNode);
285 for(var i = 0; i < inputs.length; i++) {
286 if(inputs[i].getAttribute('row') == rowIdx) {
287 inputs[i].checked = false;
294 * @return {Array} List of every fieldmapper object in the data store
296 getAllObjects : function() {
300 onComplete : function(list) {
303 objs.push(new fieldmapper[self.fmClass]().fromStoreItem(item));
312 * Deletes the underlying object for all selected rows
314 deleteSelected : function() {
315 var items = this.getSelectedItems();
316 var total = items.length;
318 dojo.require('openils.PermaCrud');
321 var fmObject = new fieldmapper[self.fmClass]().fromStoreItem(item);
322 new openils.PermaCrud()['eliminate'](fmObject, {oncomplete : function(r) { self.store.deleteItem(item) }});
327 _formatRowSelectInput : function(rowIdx) {
328 if(rowIdx === null || rowIdx === undefined) return '';
329 var s = "<input type='checkbox' name='autogrid.selector' row='" + rowIdx + "'";
330 if(this.disableSelectorForRow && this.disableSelectorForRow(rowIdx))
331 s += " disabled='disabled'";
335 _applySingleEditStyle : function() {
336 this.onMouseOverRow = function(e) {};
337 this.onMouseOutRow = function(e) {};
338 this.onCellFocus = function(cell, rowIndex) {
339 this.selection.deselectAll();
340 this.selection.select(this.focus.rowIndex);
344 /* capture keydown and launch edit dialog on enter */
345 _applyEditOnEnter : function() {
346 this._applySingleEditStyle();
348 dojo.connect(this, 'onRowDblClick',
350 if(this.editStyle == 'pane')
351 this._drawEditPane(this.selection.getFirstSelected(), this.focus.rowIndex);
353 this._drawEditDialog(this.selection.getFirstSelected(), this.focus.rowIndex);
357 dojo.connect(this, 'onKeyDown',
359 if(e.keyCode == dojo.keys.ENTER) {
360 this.selection.deselectAll();
361 this.selection.select(this.focus.rowIndex);
362 if(this.editStyle == 'pane')
363 this._drawEditPane(this.selection.getFirstSelected(), this.focus.rowIndex);
365 this._drawEditDialog(this.selection.getFirstSelected(), this.focus.rowIndex);
371 _makeEditPane : function(storeItem, rowIndex, onPostSubmit, onCancel) {
373 var fmObject = new fieldmapper[this.fmClass]().fromStoreItem(storeItem);
374 var idents = grid.store.getIdentityAttributes();
377 var pane = new openils.widget.EditPane({
379 overrideWidgets : this.overrideEditWidgets,
380 overrideWidgetClass : this.overrideEditWidgetClass,
381 overrideWidgetArgs : this.overrideWidgetArgs,
382 disableWidgetTest : this.disableWidgetTest,
383 requiredFields : this.requiredFields,
384 onPostSubmit : function() {
385 for(var i in fmObject._fields) {
386 var field = fmObject._fields[i];
387 if(idents.filter(function(j){return (j == field)})[0])
388 continue; // don't try to edit an identifier field
389 grid.store.setValue(storeItem, field, fmObject[field]());
391 if(self.onPostUpdate)
392 self.onPostUpdate(storeItem, rowIndex);
396 grid.views.views[0].getCellNode(rowIndex, 0).focus();
403 onCancel : function() {
404 setTimeout(function(){
405 grid.views.views[0].getCellNode(rowIndex, 0).focus();},200);
406 if(onCancel) onCancel();
410 pane.fieldOrder = this.fieldOrder;
411 pane.mode = 'update';
415 _makeCreatePane : function(onPostSubmit, onCancel) {
417 var pane = new openils.widget.EditPane({
418 fmClass : this.fmClass,
419 overrideWidgets : this.overrideEditWidgets,
420 overrideWidgetClass : this.overrideEditWidgetClass,
421 overrideWidgetArgs : this.overrideWidgetArgs,
422 disableWidgetTest : this.disableWidgetTest,
423 requiredFields : this.requiredFields,
424 onPostSubmit : function(req, cudResults) {
425 var fmObject = cudResults[0];
426 if(grid.onPostCreate)
427 grid.onPostCreate(fmObject);
429 grid.store.newItem(fmObject.toStoreItem());
430 setTimeout(function(){
432 grid.selection.select(grid.rowCount-1);
433 grid.views.views[0].getCellNode(grid.rowCount-1, 1).focus();
437 onPostSubmit(fmObject);
439 onCancel : function() {
440 if(onCancel) onCancel();
443 pane.fieldOrder = this.fieldOrder;
444 pane.mode = 'create';
449 * Creates an EditPane with a copy of the data from the provided store
450 * item for cloning said item
451 * @param {Object} storeItem Dojo data item
452 * @param {Number} rowIndex The Grid row index of the item to be cloned
453 * @param {Function} onPostSubmit Optional callback for post-submit behavior
454 * @param {Function} onCancel Optional callback for clone cancelation
455 * @return {Object} The clone EditPane
457 _makeClonePane : function(storeItem, rowIndex, onPostSubmit, onCancel) {
458 var clonePane = this._makeCreatePane(onPostSubmit, onCancel);
459 var origPane = this._makeEditPane(storeItem, rowIndex);
462 dojo.forEach(origPane.fieldList,
464 if(field.widget.widget.attr('disabled')) return;
465 var w = clonePane.fieldList.filter(
466 function(i) { return (i.name == field.name) })[0];
467 w.widget.baseWidgetValue(field.widget.widgetValue); // sync widgets
468 w.widget.onload = function(){w.widget.baseWidgetValue(field.widget.widgetValue)}; // async widgets
476 _drawEditDialog : function(storeItem, rowIndex) {
478 var done = function() { self.hideDialog(); };
479 var pane = this._makeEditPane(storeItem, rowIndex, done, done);
480 this.editDialog = new openils.widget.EditDialog({editPane:pane});
481 this.editDialog.startup();
482 this.editDialog.show();
486 * Generates an EditDialog for object creation and displays it to the user
488 showCreateDialog : function() {
490 var done = function() { self.hideDialog(); };
491 var pane = this._makeCreatePane(done, done);
492 this.editDialog = new openils.widget.EditDialog({editPane:pane});
493 this.editDialog.startup();
494 this.editDialog.show();
497 _drawEditPane : function(storeItem, rowIndex) {
499 var done = function() { self.hidePane(); };
500 dojo.style(this.domNode, 'display', 'none');
501 this.editPane = this._makeEditPane(storeItem, rowIndex, done, done);
502 this.editPane.startup();
503 this.domNode.parentNode.insertBefore(this.editPane.domNode, this.domNode);
504 if(this.onEditPane) this.onEditPane(this.editPane);
507 showClonePane : function(onPostSubmit) {
509 var done = function() { self.hidePane(); };
512 var row = this.getFirstSelectedRow();
515 var postSubmit = (onPostSubmit) ?
516 function(result) { onPostSubmit(self.getItem(row), result); self.hidePane(); } :
519 dojo.style(this.domNode, 'display', 'none');
520 this.editPane = this._makeClonePane(this.getItem(row), row, postSubmit, done);
521 this.domNode.parentNode.insertBefore(this.editPane.domNode, this.domNode);
522 if(this.onEditPane) this.onEditPane(this.editPane);
525 showCreatePane : function() {
527 var done = function() { self.hidePane(); };
528 dojo.style(this.domNode, 'display', 'none');
529 this.editPane = this._makeCreatePane(done, done);
530 this.editPane.startup();
531 this.domNode.parentNode.insertBefore(this.editPane.domNode, this.domNode);
532 if(this.onEditPane) this.onEditPane(this.editPane);
535 hideDialog : function() {
536 this.editDialog.hide();
537 this.editDialog.destroy();
538 delete this.editDialog;
542 hidePane : function() {
543 this.domNode.parentNode.removeChild(this.editPane.domNode);
544 this.editPane.destroy();
545 delete this.editPane;
546 dojo.style(this.domNode, 'display', 'block');
550 resetStore : function() {
551 this.setStore(this.buildAutoStore());
554 loadAll : function(opts, search) {
555 dojo.require('openils.PermaCrud');
556 if(this.loadProgressIndicator)
557 dojo.style(this.loadProgressIndicator, 'visibility', 'visible');
560 {limit : this.displayLimit, offset : this.displayOffset},
563 opts = dojo.mixin(opts, {
566 onresponse : function(r) {
567 var item = openils.Util.readResponse(r);
568 self.store.newItem(item.toStoreItem());
570 oncomplete : function() {
571 if(self.loadProgressIndicator)
572 dojo.style(self.loadProgressIndicator, 'visibility', 'hidden');
576 this.cachedQuerySearch = search;
577 this.cachedQueryOpts = opts;
579 new openils.PermaCrud().search(this.fmClass, search, opts);
581 new openils.PermaCrud().retrieveAll(this.fmClass, opts);
586 // static ID generater seed
587 openils.widget.AutoGrid.sequence = 0;
588 openils.widget.AutoGrid.gridCache = {};
590 openils.widget.AutoGrid.markupFactory = dojox.grid.DataGrid.markupFactory;
592 openils.widget.AutoGrid.defaultGetter = function(rowIndex, item) {
594 var val = this.grid.store.getValue(item, this.field);
595 var autoWidget = new openils.widget.AutoFieldWidget({
596 fmClass: this.grid.fmClass,
600 forceSync : true, // prevents many simultaneous requests for the same data
601 suppressLinkedFields : this.grid.suppressLinkedFields
607 // With proper caching, this should not be necessary to prevent grid render flickering
612 var node = _this.grid.getCell(_this.index).view.getCellNode(rowIndex, _this.index);
614 node.innerHTML = ww.getDisplayString();
620 return autoWidget.getDisplayString();