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

   1 if(!dojo._hasResource['openils.widget.EditPane']) {
   2     dojo.provide('openils.widget.EditPane');
   3     dojo.require('openils.widget.AutoWidget');
   4     dojo.require('openils.widget.AutoFieldWidget');
   5     dojo.require('fieldmapper.Fieldmapper');
   6     dojo.require('dijit.layout.ContentPane');
   7     dojo.require('openils.Util');
   8     dojo.require('openils.PermaCrud');
   9     dojo.require('dijit.form.Button');
  10
  11     dojo.declare(
  12         'openils.widget.EditPane',
  13         [dijit.layout.ContentPane, openils.widget.AutoWidget],
  14         {
  15             mode : 'update',
  16             onPostSubmit : null, // apply callback
  17             onCancel : null, // cancel callback
  18             hideActionButtons : false,
  19             fieldDocs : null,
  20             existingTable : null,
  21             suppressFields : null,
  22             requiredFields : null,
  23             paneStackCount : 1, // how many fields to add to each row, for compressing display
  24
  25             constructor : function(args) {
  26                 this.fieldList = [];
  27                 for(var k in args)
  28                     this[k] = args[k];
  29             },
  30
  31             /**
  32              * Builds a basic table of key / value pairs.  Keys are IDL display labels.
  33              * Values are dijit's, when values set
  34              */
  35             startup : function() {
  36                 this.inherited(arguments);
  37                 this.initAutoEnv();
  38                 if(this.readOnly)
  39                     this.hideSaveButton = true;
  40
  41                 // grab any field-level docs
  42                 /*
  43                 var pcrud = new openils.PermaCrud();
  44                 this.fieldDocs = pcrud.search('fdoc', {fm_class:this.fmClass});
  45                 */
  46
  47                 var table = this.existingTable;
  48                 if(!table) {
  49                     var table = this.table = document.createElement('table');
  50                     this.domNode.appendChild(table);
  51                 }
  52                 var tbody = document.createElement('tbody');
  53                 table.appendChild(tbody);
  54
  55                 this.limitPerms = [];
  56                 if(this.fmIDL.permacrud && this.fmIDL.permacrud[this.mode])
  57                     this.limitPerms = this.fmIDL.permacrud[this.mode].perms;
  58
  59                 if(!this.overrideWidgets)
  60                     this.overrideWidgets = {};
  61
  62                 if(!this.overrideWidgetClass)
  63                     this.overrideWidgetClass = {};
  64
  65                 if(!this.overrideWidgetArgs)
  66                     this.overrideWidgetArgs = {};
  67
  68                 var idx = 0;
  69                 var currentRow;
  70                 for(var f in this.sortedFieldList) {
  71                     var field = this.sortedFieldList[f];
  72                     if(!field || field.virtual || field.nonIdl) continue;
  73
  74                     if(this.suppressFields && this.suppressFields.indexOf(field.name) > -1)
  75                         continue;
  76
  77                     if(field.name == this.fmIDL.pkey && this.mode == 'create' && this.fmIDL.pkey_sequence)
  78                         continue; /* don't show auto-generated fields on create */
  79
  80                     if((idx++ % this.paneStackCount) == 0 || !currentRow) {
  81                         // time to start a new row
  82                         currentRow = document.createElement('tr');
  83                         tbody.appendChild(currentRow);
  84                     }
  85
  86                     //var docTd = document.createElement('td');
  87                     var nameTd = document.createElement('td');
  88                     var valTd = document.createElement('td');
  89                     var valSpan = document.createElement('span');
  90                     valTd.appendChild(valSpan);
  91                     dojo.addClass(nameTd, 'openils-widget-editpane-name-cell');
  92                     dojo.addClass(valTd, 'openils-widget-editpane-value-cell');
  93
  94                     /*
  95                     if(this.fieldDocs[field]) {
  96                         var helpLink = dojo.create('a');
  97                         var helpImg = dojo.create('img', {src:'/opac/images/advancedsearch-icon.png'}); // TODO Config
  98                         helpLink.appendChild(helpImg);
  99                         docTd.appendChild(helpLink);
 100                     }
 101                     */
 102
 103                     nameTd.appendChild(document.createTextNode(field.label));
 104                     currentRow.setAttribute('fmfield', field.name);
 105                     //currentRow.appendChild(docTd);
 106                     currentRow.appendChild(nameTd);
 107                     currentRow.appendChild(valTd);
 108                     //dojo.addClass(docTd, 'oils-fm-edit-pane-help');
 109
 110                     if(!this.overrideWidgetArgs[field.name])
 111                         this.overrideWidgetArgs[field.name] = {};
 112
 113                     var args = dojo.mixin(
 114                         {   // defaults
 115                             idlField : field,
 116                             fmObject : this.fmObject,
 117                             fmClass : this.fmClass,
 118                             parentNode : valSpan,
 119                             orgLimitPerms : this.limitPerms,
 120                             readOnly : this.readOnly,
 121                             widget : this.overrideWidgets[field.name],
 122                             widgetClass : this.overrideWidgetClass[field.name],
 123                             disableWidgetTest : this.disableWidgetTest
 124                         },
 125                         this.overrideWidgetArgs[field.name] // per-field overrides
 126                     );
 127
 128                     if (this.overrideWidgets[field.name]) {
 129                         if (this.overrideWidgets[field.name].shove &&
 130                             this.mode == "update") {
 131                             args.shove = true;
 132                         }
 133                     }
 134
 135                     if(args.readOnly) {
 136                         dojo.addClass(nameTd, 'openils-widget-editpane-ro-name-cell');
 137                         dojo.addClass(valTd, 'openils-widget-editpane-ro-value-cell');
 138                     }
 139
 140                     if(this.requiredFields && this.requiredFields.indexOf(field.name) >= 0) {
 141                         if(!args.dijitArgs) args.dijitArgs = {};
 142                         args.dijitArgs.required = true;
 143                     }
 144
 145                     var widget = new openils.widget.AutoFieldWidget(args);
 146
 147                     widget.build();
 148                     this.fieldList.push({name:field.name, widget:widget});
 149                 }
 150                 if(!this.hideActionButtons)
 151                     this.buildActionButtons(tbody);
 152
 153                 openils.Util.addCSSClass(table, 'oils-fm-edit-pane');
 154             },
 155
 156             applySaveOnEnter : function(widget) {
 157                 var self = this;
 158                 dojo.connect(this, 'onKeyDown',
 159                     function(e) {
 160                         if(e.keyCode == dojo.keys.ENTER)
 161                             self.performAutoEditAction();
 162                     }
 163                 );
 164             },
 165
 166             buildActionButtons : function(tbody) {
 167                 var row = document.createElement('tr');
 168                 var cancelTd = document.createElement('td');
 169                 var applyTd = document.createElement('td');
 170                 var cancelSpan = document.createElement('span');
 171                 var applySpan = document.createElement('span');
 172                 row.appendChild(cancelTd);
 173                 row.appendChild(applyTd);
 174                 cancelTd.appendChild(cancelSpan);
 175                 applyTd.appendChild(applySpan);
 176                 tbody.appendChild(row);
 177
 178                 var self = this;
 179                 new dijit.form.Button({
 180                     label:'Cancel', // XXX
 181                     onClick : this.onCancel
 182                 }, cancelSpan);
 183
 184                 if(this.hideSaveButton) return;
 185
 186                 new dijit.form.Button({
 187                     label:'Save',  // XXX
 188                     onClick: function() {self.performAutoEditAction();}
 189                 }, applySpan);
 190             },
 191
 192             getFields : function() {
 193                 return this.fieldList.map(function(a) { return a.name });
 194             },
 195
 196             getFieldValue : function(field) {
 197                 for(var i in this.fieldList) {
 198                     if(field == this.fieldList[i].name)
 199                         return this.fieldList[i].widget.getFormattedValue();
 200                 }
 201             },
 202
 203             performAutoEditAction : function() {
 204                 var self = this;
 205                 self.performEditAction({
 206                     oncomplete:function(req, cudResults) {
 207                         if(self.onPostSubmit)
 208                             self.onPostSubmit(req, cudResults);
 209                     }
 210                 });
 211             },
 212
 213             performEditAction : function(opts) {
 214                 var fields = this.getFields();
 215                 if(this.mode == 'create')
 216                     this.fmObject = new fieldmapper[this.fmClass]();
 217                 for(var idx in fields)
 218                     this.fmObject[fields[idx]](this.getFieldValue(fields[idx]));
 219                 if(this.mode == 'create' && this.fmIDL.pkey_sequence)
 220                     this.fmObject[this.fmIDL.pkey](null);
 221                 if (typeof(this.onSubmit) == "function") {
 222                     this.onSubmit(this.fmObject);
 223                 } else {
 224                     (new openils.PermaCrud())[this.mode](this.fmObject, opts);
 225                 }
 226             }
 227         }
 228     );
 229 }
 230