Open-ILS/web/js/dojo/openils/widget/AutoGrid.js

   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');
  11
  12     dojo.declare(
  13         'openils.widget.AutoGrid',
  14         [dojox.grid.DataGrid, openils.widget.AutoWidget],
  15         {
  16
  17             /* if true, pop up an edit dialog when user hits Enter on a give row */
  18             editOnEnter : false,
  19             defaultCellWidth : null,
  20             editStyle : 'dialog',
  21             suppressFields : null,
  22             hideSelector : false,
  23             selectorWidth : '1.5',
  24             showColumnPicker : false,
  25             columnPickerPrefix : null,
  26             displayLimit : 15,
  27             displayOffset : 0,
  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
  32
  33             /* by default, don't show auto-generated (sequence) fields */
  34             showSequenceFields : false,
  35
  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);
  41                 this.initAutoEnv();
  42                 this.attr('structure', this._compileStructure());
  43                 this.setStore(this.buildAutoStore());
  44                 this.cachedQueryOpts = {};
  45
  46                 if(this.showColumnPicker) {
  47                     if(!this.columnPickerPrefix) {
  48                         console.error("No columnPickerPrefix defined");
  49                     } else {
  50                         var picker = new openils.widget.GridColumnPicker(
  51                             openils.User.authtoken, this.columnPickerPrefix, this);
  52                         if(openils.User.authtoken) {
  53                             picker.load();
  54                         } else {
  55                             openils.Util.addOnLoad(function() { picker.load() });
  56                         }
  57                     }
  58                 }
  59
  60                 this.overrideEditWidgets = {};
  61                 this.overrideEditWidgetClass = {};
  62                 this.overrideWidgetArgs = {};
  63
  64                 if(this.editOnEnter)
  65                     this._applyEditOnEnter();
  66                 else if(this.singleEditStyle)
  67                     this._applySingleEditStyle();
  68
  69                 if(!this.hideSelector) {
  70                     dojo.connect(this, 'onHeaderCellClick',
  71                         function(e) {
  72                             if(e.cell.index == 0)
  73                                 this.toggleSelectAll();
  74                         }
  75                     );
  76                 }
  77
  78                 if(this.showPaginator) {
  79                     var self = this;
  80                     this.paginator = new dijit.layout.ContentPane();
  81
  82
  83                     var back = dojo.create('a', {
  84                         innerHTML : 'Back',  // TODO i18n
  85                         style : 'padding-right:6px;',
  86                         href : 'javascript:void(0);',
  87                         onclick : function() {
  88                             self.resetStore();
  89                             self.cachedQueryOpts.offset = self.displayOffset -= self.displayLimit;
  90                             if(self.displayOffset < 0)
  91                                 self.cachedQueryOpts.offset = self.displayOffset = 0;
  92                             if(self.dataLoader)
  93                                 self.dataLoader()
  94                             else
  95                                 self.loadAll(self.cachedQueryOpts, self.cachedQuerySearch);
  96                         }
  97                     });
  98
  99                     var forw = dojo.create('a', {
 100                         innerHTML : 'Next',  // TODO i18n
 101                         style : 'padding-right:6px;',
 102                         href : 'javascript:void(0);',
 103                         onclick : function() {
 104                             self.resetStore();
 105                             self.cachedQueryOpts.offset = self.displayOffset += self.displayLimit;
 106                             if(self.dataLoader)
 107                                 self.dataLoader()
 108                             else
 109                                 self.loadAll(self.cachedQueryOpts, self.cachedQuerySearch);
 110                         }
 111                     });
 112
 113                     dojo.place(this.paginator.domNode, this.domNode, 'before');
 114                     dojo.place(back, this.paginator.domNode);
 115                     dojo.place(forw, this.paginator.domNode);
 116
 117                     if(this.showLoadFilter) {
 118                         dojo.require('openils.widget.PCrudFilterDialog');
 119                         dojo.place(
 120                             dojo.create('a', {
 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) {
 127                                         self.resetStore();
 128                                         self.loadAll(self.cachedQueryOpts, filter);
 129                                     };
 130                                     dialog.startup();
 131                                     dialog.show();
 132                                 }
 133                             }),
 134                             this.paginator.domNode
 135                         );
 136                     }
 137
 138                     // progress image
 139                     this.loadProgressIndicator = dojo.create('img', {
 140                         src:'/opac/images/progressbar_green.gif', // TODO configured path
 141                         style:'height:16px;width:16px;'
 142                     });
 143                     dojo.place(this.loadProgressIndicator, this.paginator.domNode);
 144                 }
 145             },
 146
 147             hideLoadProgressIndicator : function() {
 148                 dojo.style(this.loadProgressIndicator, 'visibility', 'hidden');
 149             },
 150
 151             showLoadProgressIndicator : function() {
 152                 dojo.style(this.loadProgressIndicator, 'visibility', 'visible');
 153             },
 154
 155             /* Don't allow sorting on the selector column */
 156             canSort : function(rowIdx) {
 157                 if(rowIdx == 1 && !this.hideSelector)
 158                     return false;
 159                 return true;
 160             },
 161
 162             _compileStructure : function() {
 163                 var existing = (this.structure && this.structure[0].cells[0]) ?
 164                     this.structure[0].cells[0] : [];
 165                 var fields = [];
 166
 167                 var self = this;
 168                 function pushEntry(entry) {
 169                     if(self.suppressFields) {
 170                         if(dojo.indexOf(self.suppressFields, entry.field) != -1)
 171                             return;
 172                     }
 173                     if(!entry.get)
 174                         entry.get = openils.widget.AutoGrid.defaultGetter
 175                     if(!entry.width && self.defaultCellWidth)
 176                         entry.width = self.defaultCellWidth;
 177                     fields.push(entry);
 178                 }
 179
 180                 if(!this.hideSelector) {
 181                     // insert the selector column
 182                     pushEntry({
 183                         field : '+selector',
 184                         formatter : function(rowIdx) { return self._formatRowSelectInput(rowIdx); },
 185                         get : function(rowIdx, item) { if(item) return rowIdx; },
 186                         width : this.selectorWidth,
 187                         name : '&#x2713',
 188                         nonSelectable : true
 189                     });
 190                 }
 191
 192
 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;
 200                         pushEntry(entry);
 201                     }
 202                 }
 203
 204                 for(var f in this.sortedFieldList) {
 205                     var field = this.sortedFieldList[f];
 206                     if(!field || field.virtual) continue;
 207
 208                     // field was already added above
 209                     if(fields.filter(function(i){return (i.field == field.name)})[0])
 210                         continue;
 211
 212                     var entry = existing.filter(function(i){return (i.field == field.name)})[0];
 213                     if(entry) {
 214                         entry.name = field.label;
 215                     } else {
 216                         // unless specifically requested, hide sequence fields
 217                         if(!this.showSequenceFields && field.name == this.fmIDL.pkey && this.fmIDL.pkey_sequence)
 218                             continue;
 219
 220                         entry = {field:field.name, name:field.label};
 221                     }
 222                     pushEntry(entry);
 223                 }
 224
 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
 232                         pushEntry(entry);
 233                     }
 234                 }
 235
 236                 return [{cells: [fields]}];
 237             },
 238
 239             toggleSelectAll : function() {
 240                 var selected = this.getSelectedRows();
 241                 for(var i = 0; i < this.rowCount; i++) {
 242                     if(selected[0])
 243                         this.deSelectRow(i);
 244                     else
 245                         this.selectRow(i);
 246                 }
 247             },
 248
 249             getSelectedRows : function() {
 250                 var rows = [];
 251                 dojo.forEach(
 252                     dojo.query('[name=autogrid.selector]', this.domNode),
 253                     function(input) {
 254                         if(input.checked)
 255                             rows.push(input.getAttribute('row'));
 256                     }
 257                 );
 258                 return rows;
 259             },
 260
 261             getFirstSelectedRow : function() {
 262                 return this.getSelectedRows()[0];
 263             },
 264
 265             getSelectedItems : function() {
 266                 var items = [];
 267                 var self = this;
 268                 dojo.forEach(this.getSelectedRows(), function(idx) { items.push(self.getItem(idx)); });
 269                 return items;
 270             },
 271
 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;
 278                         break;
 279                     }
 280                 }
 281             },
 282
 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;
 288                         break;
 289                     }
 290                 }
 291             },
 292
 293             /**
 294              * @return {Array} List of every fieldmapper object in the data store
 295              */
 296             getAllObjects : function() {
 297                 var objs = [];
 298                 var self = this;
 299                 this.store.fetch({
 300                     onComplete : function(list) {
 301                         dojo.forEach(list,
 302                             function(item) {
 303                                 objs.push(new fieldmapper[self.fmClass]().fromStoreItem(item));
 304                             }
 305                         )
 306                     }
 307                 });
 308                 return objs;
 309             },
 310
 311             /**
 312              * Deletes the underlying object for all selected rows
 313              */
 314             deleteSelected : function() {
 315                 var items = this.getSelectedItems();
 316                 var total = items.length;
 317                 var self = this;
 318                 dojo.require('openils.PermaCrud');
 319                 dojo.forEach(items,
 320                     function(item) {
 321                         var fmObject = new fieldmapper[self.fmClass]().fromStoreItem(item);
 322                         new openils.PermaCrud()['eliminate'](fmObject, {oncomplete : function(r) { self.store.deleteItem(item) }});
 323                     }
 324                 );
 325             },
 326
 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'";
 332                 return s + "/>";
 333             },
 334
 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);
 341                 };
 342             },
 343
 344             /* capture keydown and launch edit dialog on enter */
 345             _applyEditOnEnter : function() {
 346                 this._applySingleEditStyle();
 347
 348                 dojo.connect(this, 'onRowDblClick',
 349                     function(e) {
 350                         if(this.editStyle == 'pane')
 351                             this._drawEditPane(this.selection.getFirstSelected(), this.focus.rowIndex);
 352                         else
 353                             this._drawEditDialog(this.selection.getFirstSelected(), this.focus.rowIndex);
 354                     }
 355                 );
 356
 357                 dojo.connect(this, 'onKeyDown',
 358                     function(e) {
 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);
 364                             else
 365                                 this._drawEditDialog(this.selection.getFirstSelected(), this.focus.rowIndex);
 366                         }
 367                     }
 368                 );
 369             },
 370
 371             _makeEditPane : function(storeItem, rowIndex, onPostSubmit, onCancel) {
 372                 var grid = this;
 373                 var fmObject = new fieldmapper[this.fmClass]().fromStoreItem(storeItem);
 374                 var idents = grid.store.getIdentityAttributes();
 375                 var self = this;
 376
 377                 var pane = new openils.widget.EditPane({
 378                     fmObject:fmObject,
 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]());
 390                         }
 391                         if(self.onPostUpdate)
 392                             self.onPostUpdate(storeItem, rowIndex);
 393                         setTimeout(
 394                             function(){
 395                                 try {
 396                                     grid.views.views[0].getCellNode(rowIndex, 0).focus();
 397                                 } catch (E) {}
 398                             },200
 399                         );
 400                         if(onPostSubmit)
 401                             onPostSubmit();
 402                     },
 403                     onCancel : function() {
 404                         setTimeout(function(){
 405                             grid.views.views[0].getCellNode(rowIndex, 0).focus();},200);
 406                         if(onCancel) onCancel();
 407                     }
 408                 });
 409
 410                 pane.fieldOrder = this.fieldOrder;
 411                 pane.mode = 'update';
 412                 return pane;
 413             },
 414
 415             _makeCreatePane : function(onPostSubmit, onCancel) {
 416                 var grid = this;
 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);
 428                         if(fmObject)
 429                             grid.store.newItem(fmObject.toStoreItem());
 430                         setTimeout(function(){
 431                             try {
 432                                 grid.selection.select(grid.rowCount-1);
 433                                 grid.views.views[0].getCellNode(grid.rowCount-1, 1).focus();
 434                             } catch (E) {}
 435                         },200);
 436                         if(onPostSubmit)
 437                             onPostSubmit(fmObject);
 438                     },
 439                     onCancel : function() {
 440                         if(onCancel) onCancel();
 441                     }
 442                 });
 443                 pane.fieldOrder = this.fieldOrder;
 444                 pane.mode = 'create';
 445                 return pane;
 446             },
 447
 448             /**
 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
 456              */
 457             _makeClonePane : function(storeItem, rowIndex, onPostSubmit, onCancel) {
 458                 var clonePane = this._makeCreatePane(onPostSubmit, onCancel);
 459                 var origPane = this._makeEditPane(storeItem, rowIndex);
 460                 clonePane.startup();
 461                 origPane.startup();
 462                 dojo.forEach(origPane.fieldList,
 463                     function(field) {
 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
 469                     }
 470                 );
 471                 origPane.destroy();
 472                 return clonePane;
 473             },
 474
 475
 476             _drawEditDialog : function(storeItem, rowIndex) {
 477                 var self = this;
 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();
 483             },
 484
 485             /**
 486              * Generates an EditDialog for object creation and displays it to the user
 487              */
 488             showCreateDialog : function() {
 489                 var self = this;
 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();
 495             },
 496
 497             _drawEditPane : function(storeItem, rowIndex) {
 498                 var self = this;
 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);
 505             },
 506
 507             showClonePane : function(onPostSubmit) {
 508                 var self = this;
 509                 var done = function() { self.hidePane(); };
 510
 511
 512                 var row = this.getFirstSelectedRow();
 513                 if(!row) return;
 514
 515                 var postSubmit = (onPostSubmit) ?
 516                     function(result) { onPostSubmit(self.getItem(row), result); self.hidePane(); } :
 517                     done;
 518
 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);
 523             },
 524
 525             showCreatePane : function() {
 526                 var self = this;
 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);
 533             },
 534
 535             hideDialog : function() {
 536                 this.editDialog.hide();
 537                 this.editDialog.destroy();
 538                 delete this.editDialog;
 539                 this.update();
 540             },
 541
 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');
 547                 this.update();
 548             },
 549
 550             resetStore : function() {
 551                 this.setStore(this.buildAutoStore());
 552             },
 553
 554             loadAll : function(opts, search) {
 555                 dojo.require('openils.PermaCrud');
 556                 if(this.loadProgressIndicator)
 557                     dojo.style(this.loadProgressIndicator, 'visibility', 'visible');
 558                 var self = this;
 559                 opts = dojo.mixin(
 560                     {limit : this.displayLimit, offset : this.displayOffset},
 561                     opts || {}
 562                 );
 563                 opts = dojo.mixin(opts, {
 564                     async : true,
 565                     streaming : true,
 566                     onresponse : function(r) {
 567                         var item = openils.Util.readResponse(r);
 568                         self.store.newItem(item.toStoreItem());
 569                     },
 570                     oncomplete : function() {
 571                         if(self.loadProgressIndicator)
 572                             dojo.style(self.loadProgressIndicator, 'visibility', 'hidden');
 573                     }
 574                 });
 575
 576                 this.cachedQuerySearch = search;
 577                 this.cachedQueryOpts = opts;
 578                 if(search)
 579                     new openils.PermaCrud().search(this.fmClass, search, opts);
 580                 else
 581                     new openils.PermaCrud().retrieveAll(this.fmClass, opts);
 582             }
 583         }
 584     );
 585
 586     // static ID generater seed
 587     openils.widget.AutoGrid.sequence = 0;
 588     openils.widget.AutoGrid.gridCache = {};
 589
 590     openils.widget.AutoGrid.markupFactory = dojox.grid.DataGrid.markupFactory;
 591
 592     openils.widget.AutoGrid.defaultGetter = function(rowIndex, item) {
 593         if(!item) return '';
 594         var val = this.grid.store.getValue(item, this.field);
 595         var autoWidget = new openils.widget.AutoFieldWidget({
 596             fmClass: this.grid.fmClass,
 597             fmField: this.field,
 598             widgetValue : val,
 599             readOnly : true,
 600             forceSync : true, // prevents many simultaneous requests for the same data
 601             suppressLinkedFields : this.grid.suppressLinkedFields
 602         });
 603
 604         autoWidget.build();
 605
 606         /*
 607         // With proper caching, this should not be necessary to prevent grid render flickering
 608         var _this = this;
 609         autoWidget.build(
 610             function(w, ww) {
 611                 try {
 612                     var node = _this.grid.getCell(_this.index).view.getCellNode(rowIndex, _this.index);
 613                     if(node)
 614                         node.innerHTML = ww.getDisplayString();
 615                 } catch(E) {}
 616             }
 617         );
 618         */
 619
 620         return autoWidget.getDisplayString();
 621     }
 622 }
 623