From 3b5d89796f870cb88623a260628468db4a88ac28 Mon Sep 17 00:00:00 2001
From: Lebbeous Fogle-Weekley <lebbeous@esilibrary.com>
Date: Thu, 29 Mar 2012 05:06:25 -0400
Subject: [PATCH] create and edit working. not quite delete yet. also,

broke out line numbers and selectors into a separate dojo module for
flattener grid and autogrid to share. don't quite have it right though,
as flattenergrid works but for autogrid you can no longer see the lineno
and selector columns (although they are present in
grid.structure[0].cells[0])

hrm

Signed-off-by: Lebbeous Fogle-Weekley <lebbeous@esilibrary.com>
---
 Open-ILS/src/templates/conify/flattener_test.tt2   |  19 +--
 Open-ILS/web/js/dojo/openils/FlattenerStore.js     |  95 ++++++++------
 Open-ILS/web/js/dojo/openils/widget/AutoGrid.js    | 123 +-----------------
 .../web/js/dojo/openils/widget/FlattenerGrid.js    |  16 ++-
 .../js/dojo/openils/widget/_GridHelperColumns.js   | 140 +++++++++++++++++++++
 5 files changed, 223 insertions(+), 170 deletions(-)
 create mode 100644 Open-ILS/web/js/dojo/openils/widget/_GridHelperColumns.js

diff --git a/Open-ILS/src/templates/conify/flattener_test.tt2 b/Open-ILS/src/templates/conify/flattener_test.tt2
index b7404f4cf8..d8944a12d9 100644
--- a/Open-ILS/src/templates/conify/flattener_test.tt2
+++ b/Open-ILS/src/templates/conify/flattener_test.tt2
@@ -1,5 +1,11 @@
 [% WRAPPER base.tt2 %]
 [% ctx.page_title = 'Flattener Test' %]
+<!--
+        fmClass="'acp'"
+        defaultSort="['call_number']"
+        mapExtras="{copy_status: {path: 'status.name', filter: true}}"
+        query="{'copy_status': ['Available','Reshelving','In process'],'circ_lib': 'BR1'}">
+        -->
 <script type="text/javascript">
     dojo.require("dijit.form.Button");
     dojo.require("openils.widget.FlattenerGrid");
@@ -24,20 +30,17 @@
         jsid="grid"
         dojoType="openils.widget.FlattenerGrid"
         columnPersistKey='"conify.flattener_test"'
-        fmClass="'acp'"
+        fmClass="'brsrc'"
         autoHeight="10"
         editOnEnter="true"
         editStyle="pane"
-        defaultSort="['call_number']"
-        mapExtras="{copy_status: {path: 'status.name', filter: true}}"
-        query="{'copy_status': ['Available','Reshelving','In process'],'circ_lib': 'BR1'}">
+        defaultSort="['barcode']"
+        query="{'owner': 'BR1'}">
         <thead>
             <tr>
                 <th field="barcode" fpath="barcode">Barcode</th>
-                <th field="circ_lib_name" fpath="circ_lib.name">Circulation Library Name</th>
-                <th field="circ_lib" fpath="circ_lib.shortname" ffilter="true">Circulation Library</th>
-                <th field="call_number" fpath="call_number.label">Call Number</th>
-                <th field="shelving_loc" fpath="location.name" ffilter="true">Shelving Location</th>
+                <th field="owner" fpath="owner.shortname" ffilter="true">Circulation Library</th>
+                <th field="resource_type" fpath="type.name">Resource type</th>
             </tr>
         </thead>
     </table>
diff --git a/Open-ILS/web/js/dojo/openils/FlattenerStore.js b/Open-ILS/web/js/dojo/openils/FlattenerStore.js
index 4fbb547110..8b0a301146 100644
--- a/Open-ILS/web/js/dojo/openils/FlattenerStore.js
+++ b/Open-ILS/web/js/dojo/openils/FlattenerStore.js
@@ -179,8 +179,6 @@ if (!dojo._hasResource["openils.FlattenerStore"]) {
         },
 
         "isItemLoaded": function(/* anything */ something) {
-            //console.log("isItemLoaded(" + something + ")");
-
             /* XXX if 'something' is not an item at all, are we just supposed
              * to return false or throw an exception? */
             return this.isItem(something) && (
@@ -191,19 +189,16 @@ if (!dojo._hasResource["openils.FlattenerStore"]) {
         "close": function(/* object */ request) { /* no-op */ return; },
 
         "getLabel": function(/* object */ item) {
-            //console.log("getLabel(" + item + ")");
-            return "XXX TODO";
+            console.warn("[unimplemented] getLabel()");
         },
+
         "getLabelAttributes": function(/* object */ item) {
-            //console.log("getLabelAttributes(" + item + ")");
-            return ["XXX TODO"];
+            console.warn("[unimplemented] getLabelAttributes()");
         },
 
         "loadItem": function(/* object */ keywordArgs) {
-            //console.log("loadItem(" + dojo.toJson(keywordArgs) + ")");
-
-            if (!this.isItem(keywordArgs.item))
-                throw new FlattenerStoreError("not an item; can't load it");
+            if (!keywordArgs.force && this.isItemLoaded(keywordArgs.item))
+                return;
 
             keywordArgs.identity = this.getIdentity(keywordArgs.item);
             return this.fetchItemByIdentity(keywordArgs);
@@ -321,36 +316,60 @@ if (!dojo._hasResource["openils.FlattenerStore"]) {
             return [this.fmIdentifier];
         },
 
-        /* not officially part of dojo.data.api.Read, and mostly probably
-         * what fetchItemByIdentity should do?  */
-        "refreshItem": function(/* object */ item) {
-            console.log("refreshItem(" + dojo.toJson(item) + ")");
-            var post_params = this._prepare_flattener_params({"identity": this.getIdentity(item)});
+        "fetchItemByIdentity": function(/* object */ keywordArgs) {
+            var callback_scope = keywordArgs.scope || dojo.global;
+            var identity = keywordArgs.identity;
 
-            var self = this;
-            var process_fetch_one = function(obj, when) {
-                if (when < self._last_fetch) /* Stale response. Discard. */
-                    return;
+            if (typeof identity == "undefined")
+                throw new FlattenerStoreError(
+                    "fetchItemByIdentity() needs identity in keywordArgs"
+                );
+
+            /* First of force's two implications:
+             * fetch even if already loaded. */
+            if (this._current_items[identity] && !keywordArgs.force) {
+                keywordArgs.onItem.call(
+                    callback_scope, this._current_items[identity]
+                );
+
+                return;
+            }
 
-                /* don't call onBegin for this, even */
-                if (dojo.isArray(obj)) {
-                    if (obj.length == 1) {
-                        obj = obj[0];
-                        for (var prop in obj) {
-                            self.setValue(item, prop, obj[prop]);
+            var post_params = this._prepare_flattener_params(keywordArgs);
+
+            var process_fetch_one = dojo.hitch(
+                this, function(obj, when) {
+                    if (when < this._last_fetch) /* Stale response. Discard. */
+                        return;
+
+                    if (dojo.isArray(obj)) {
+                        if (obj.length <= 1) {
+                            obj = obj.pop() || null;    /* safe enough */
+                            /* Second of force's two implications: call setValue
+                             * ourselves.  Makes a DataGrid update. */
+                            if (keywordArgs.force && obj &&
+                                (origitem = this._current_items[identity])) {
+                                for (var prop in origitem)
+                                    this.setValue(origitem, prop, obj[prop]);
+                            }
+                            if (keywordArgs.onItem)
+                                keywordArgs.onItem.call(callback_scope, obj);
+                        } else {
+                            var e = new FlattenerStoreError("Too many results");
+                            if (keywordArgs.onError)
+                                keywordArgs.onError.call(callback_scope, e);
+                            else
+                                throw e;
                         }
-                    } else if (obj.length > 1) {
-                        throw new FlattenerStoreError("too many results");
                     } else {
-                        /* no results; not really an error from the
-                         * store's point of view I suppose? */
+                        var e = new FlattenerStoreError("Bad response");
+                        if (keywordArgs.onError)
+                            keywordArgs.onError.call(callback_scope, e);
+                        else
+                            throw e;
                     }
-                } else {
-                    throw new FlattenerStoreError("bad response");
                 }
-            };
-
-            console.log("post_params: " + dojo.toJson(post_params));
+            );
 
             var fetch_time = this._last_fetch = (new Date().getTime());
 
@@ -365,10 +384,6 @@ if (!dojo._hasResource["openils.FlattenerStore"]) {
             });
         },
 
-        "fetchItemByIdentity": function(/* object */ keywordArgs) {
-            console.warning("[unimplemented] fetchItemByIdentity() unneeded?");
-        },
-
         /* dojo.data.api.Write */
 
 /* to add:
@@ -393,8 +408,10 @@ if (!dojo._hasResource["openils.FlattenerStore"]) {
         },
 
         "setValue": function(item, attribute, value) {
+            /* Silently do nothing when setValue()'s caller wants to change
+             * the identifier.  They must be confused anyway. */
             if (attribute == this.fmIdentifier)
-                throw new FlattenerStoreError("can't change item identifier");
+                return;
 
             var old_value = dojo.clone(item[attribute]);
 
diff --git a/Open-ILS/web/js/dojo/openils/widget/AutoGrid.js b/Open-ILS/web/js/dojo/openils/widget/AutoGrid.js
index c3d5afcb30..f101585c6a 100644
--- a/Open-ILS/web/js/dojo/openils/widget/AutoGrid.js
+++ b/Open-ILS/web/js/dojo/openils/widget/AutoGrid.js
@@ -7,11 +7,12 @@ if(!dojo._hasResource['openils.widget.AutoGrid']) {
     dojo.require('openils.widget.EditPane');
     dojo.require('openils.widget.EditDialog');
     dojo.require('openils.widget.GridColumnPicker');
+    dojo.require('openils.widget._GridHelperColumns');
     dojo.require('openils.Util');
 
     dojo.declare(
         'openils.widget.AutoGrid',
-        [dojox.grid.DataGrid, openils.widget.AutoWidget],
+        [dojox.grid.DataGrid, openils.widget.AutoWidget, openils.widget._GridHelperColumns],
         {
 
             /* if true, pop up an edit dialog when user hits Enter on a give row */
@@ -24,10 +25,6 @@ if(!dojo._hasResource['openils.widget.AutoGrid']) {
             suppressFields : null,
             suppressEditFields : null,
             suppressFilterFields : null,
-            hideSelector : false,
-            hideLineNumber : false,
-            selectorWidth : '1.5',
-            lineNumberWidth : '1.5',
             showColumnPicker : false,
             columnPersistKey : null,
             displayLimit : 15,
@@ -40,14 +37,6 @@ if(!dojo._hasResource['openils.widget.AutoGrid']) {
             /* by default, don't show auto-generated (sequence) fields */
             showSequenceFields : false, 
 
-            // style the cells in the line number column
-            onStyleRow : function(row) {
-                if (!this.hideLineNumber) {
-                    var cellIdx = this.hideSelector ? 0 : 1;
-                    dojo.addClass(this.views.views[0].getCellNode(row.index, cellIdx), 'autoGridLineNumber');
-                }
-            },
-
             startup : function() {
                 var _this = this;
                 this.selectionMode = 'single';
@@ -55,7 +44,10 @@ if(!dojo._hasResource['openils.widget.AutoGrid']) {
                 openils.widget.AutoGrid.gridCache[this.sequence] = this;
                 this.inherited(arguments);
                 this.initAutoEnv();
+
                 this.attr('structure', this._compileStructure());
+                this._startupGridHelperColumns();
+
                 this.setStore(this.buildAutoStore());
                 this.cachedQueryOpts = {};
                 this._showing_create_pane = false;
@@ -68,15 +60,6 @@ if(!dojo._hasResource['openils.widget.AutoGrid']) {
                 else if(this.singleEditStyle) 
                     this._applySingleEditStyle();
 
-                if(!this.hideSelector) {
-                    dojo.connect(this, 'onHeaderCellClick', 
-                        function(e) {
-                            if(e.cell.index == 0)
-                                this.toggleSelectAll();
-                        }
-                    );
-                }
-
                 if(!this.hidePaginator) {
                     var self = this;
                     this.paginator = new dijit.layout.ContentPane();
@@ -148,17 +131,6 @@ if(!dojo._hasResource['openils.widget.AutoGrid']) {
                 dojo.style(this.loadProgressIndicator, 'visibility', 'visible');
             },
 
-            /* Don't allow sorting on the selector column */
-            canSort : function(rowIdx) {
-                if(rowIdx == 1 && !this.hideSelector)
-                    return false;
-                if(this.hideSelector && rowIdx == 1 && !this.hideLineNumber)
-                    return false;
-                if(!this.hideSelector && rowIdx == 2 && !this.hideLineNumber)
-                    return false;
-                return true;
-            },
-
             _compileStructure : function() {
                 var existing = (this.structure && this.structure[0].cells[0]) ? 
                     this.structure[0].cells[0] : [];
@@ -177,29 +149,6 @@ if(!dojo._hasResource['openils.widget.AutoGrid']) {
                     fields.push(entry);
                 }
 
-                if(!this.hideSelector) {
-                    // insert the selector column
-                    pushEntry({
-                        field : '+selector',
-                        formatter : function(rowIdx) { return self._formatRowSelectInput(rowIdx); },
-                        get : function(rowIdx, item) { if(item) return rowIdx; },
-                        width : this.selectorWidth,
-                        name : '&#x2713',
-                        nonSelectable : true
-                    });
-                }
-
-                if(!this.hideLineNumber) {
-                    // insert the line number column
-                    pushEntry({
-                        field : '+lineno',
-                        get : function(rowIdx, item) { if(item) return 1 + rowIdx; },
-                        width : this.lineNumberWidth,
-                        name : '#',
-                        nonSelectable : false
-                    });
-                }
-
                 if(!this.fieldOrder) {
                     /* no order defined, start with any explicit grid fields */
                     for(var e in existing) {
@@ -246,60 +195,6 @@ if(!dojo._hasResource['openils.widget.AutoGrid']) {
                 return [{cells: [fields]}];
             },
 
-            toggleSelectAll : function() {
-                var selected = this.getSelectedRows();
-                for(var i = 0; i < this.rowCount; i++) {
-                    if(selected[0])
-                        this.deSelectRow(i);
-                    else
-                        this.selectRow(i);
-                }
-            },
-
-            getSelectedRows : function() {
-                var rows = []; 
-                dojo.forEach(
-                    dojo.query('[name=autogrid.selector]', this.domNode),
-                    function(input) {
-                        if(input.checked)
-                            rows.push(input.getAttribute('row'));
-                    }
-                );
-                return rows;
-            },
-
-            getFirstSelectedRow : function() {
-                return this.getSelectedRows()[0];
-            },
-
-            getSelectedItems : function() {
-                var items = [];
-                var self = this;
-                dojo.forEach(this.getSelectedRows(), function(idx) { items.push(self.getItem(idx)); });
-                return items;
-            },
-
-            selectRow : function(rowIdx) {
-                var inputs = dojo.query('[name=autogrid.selector]', this.domNode);
-                for(var i = 0; i < inputs.length; i++) {
-                    if(inputs[i].getAttribute('row') == rowIdx) {
-                        if(!inputs[i].disabled)
-                            inputs[i].checked = true;
-                        break;
-                    }
-                }
-            },
-
-            deSelectRow : function(rowIdx) {
-                var inputs = dojo.query('[name=autogrid.selector]', this.domNode);
-                for(var i = 0; i < inputs.length; i++) {
-                    if(inputs[i].getAttribute('row') == rowIdx) {
-                        inputs[i].checked = false;
-                        break;
-                    }
-                }
-            },
-
             /**
              * @return {Array} List of every fieldmapper object in the data store
              */
@@ -334,14 +229,6 @@ if(!dojo._hasResource['openils.widget.AutoGrid']) {
                 );
             },
 
-            _formatRowSelectInput : function(rowIdx) {
-                if(rowIdx === null || rowIdx === undefined) return '';
-                var s = "<input type='checkbox' name='autogrid.selector' row='" + rowIdx + "'";
-                if(this.disableSelectorForRow && this.disableSelectorForRow(rowIdx)) 
-                    s += " disabled='disabled'";
-                return s + "/>";
-            },
-
             _applySingleEditStyle : function() {
                 this.onMouseOverRow = function(e) {};
                 this.onMouseOutRow = function(e) {};
diff --git a/Open-ILS/web/js/dojo/openils/widget/FlattenerGrid.js b/Open-ILS/web/js/dojo/openils/widget/FlattenerGrid.js
index 1aebd2ee40..0cdb3f4d07 100644
--- a/Open-ILS/web/js/dojo/openils/widget/FlattenerGrid.js
+++ b/Open-ILS/web/js/dojo/openils/widget/FlattenerGrid.js
@@ -7,10 +7,11 @@ if (!dojo._hasResource["openils.widget.FlattenerGrid"]) {
     dojo.require("openils.PermaCrud");
     dojo.require("openils.widget.GridColumnPicker");
     dojo.require("openils.widget.EditDialog");  /* includes EditPane */
+    dojo.require("openils.widget._GridHelperColumns");
 
     dojo.declare(
         "openils.widget.FlattenerGrid",
-        [dojox.grid.DataGrid], {
+        [dojox.grid.DataGrid, openils.widget._GridHelperColumns], {
             /* These potential constructor arguments are useful to
              * FlattenerGrid in their own right */
             "columnReordering": true,
@@ -19,7 +20,6 @@ if (!dojo._hasResource["openils.widget.FlattenerGrid"]) {
             /* These potential constructor arguments maybe useful to
              * FlattenerGrid in their own right, and are passed to
              * FlattenerStore. */
-            "editable": true,
             "fmClass": null,
             "fmIdentifier": null,
             "mapExtras": null,
@@ -131,6 +131,8 @@ if (!dojo._hasResource["openils.widget.FlattenerGrid"]) {
 
                 this.inherited(arguments);
 
+                this._startupGridHelperColumns();
+
                 this._showing_create_pane = false;
 
                 this.overrideEditWidgets = {};
@@ -215,7 +217,7 @@ if (!dojo._hasResource["openils.widget.FlattenerGrid"]) {
                         console.log("onPostSubmit");
                         /* ask the store to call flattener specially to get
                          * the flat row related to only this fmobj */
-                        grid.store.refreshItem(storeItem);
+                        grid.store.loadItem({"force": true, "item": storeItem});
 
                         if (grid.onPostUpdate)
                             grid.onPostUpdate(storeItem, rowIndex);
@@ -269,8 +271,12 @@ if (!dojo._hasResource["openils.widget.FlattenerGrid"]) {
                         if (grid.onPostCreate)
                             grid.onPostCreate(fmObject);
                         if (fmObject) {
-                            //grid.store.newItem(fmObject.toStoreItem());
-                            console.warn("[unfinished] here we have fmObject and must update the grid somehow");
+                            grid.store.fetchItemByIdentity({
+                                "identity": fmObject[grid.fmIdentifier](),
+                                "onItem": function(item) {
+                                    grid.store.onNew(item);
+                                }
+                            });
                         }
 
                         setTimeout(
diff --git a/Open-ILS/web/js/dojo/openils/widget/_GridHelperColumns.js b/Open-ILS/web/js/dojo/openils/widget/_GridHelperColumns.js
new file mode 100644
index 0000000000..bce2f4ceba
--- /dev/null
+++ b/Open-ILS/web/js/dojo/openils/widget/_GridHelperColumns.js
@@ -0,0 +1,140 @@
+/* to be inherited by autogrid and similar */
+if (!dojo._hasResource["openils.widget._GridHelperColumns"]) {
+    dojo._hasResource["openils.widget._GridHelperColumns"] = true;
+
+    dojo.provide("openils.widget._GridHelperColumns");
+    dojo.declare(
+        "openils.widget._GridHelperColumns", null, {
+
+            "hideSelector": false,
+            "selectorWidth": 1.5,
+            "hideLineNumber": false,
+            "lineNumberWidth": "1.5",
+
+            "getSelectedRows": function() {
+                var rows = [];
+                dojo.forEach(
+                    dojo.query('[name=autogrid.selector]', this.domNode),
+                    function(input) {
+                        if(input.checked)
+                            rows.push(input.getAttribute('row'));
+                    }
+                );
+                return rows;
+            },
+
+            "getFirstSelectedRow": function() {
+                return this.getSelectedRows()[0];
+            },
+
+            "getSelectedItems": function() {
+                var items = [];
+                var self = this;
+                dojo.forEach(this.getSelectedRows(), function(idx) { items.push(self.getItem(idx)); });
+                return items;
+            },
+
+            "selectRow": function(rowIdx) {
+                var inputs = dojo.query('[name=autogrid.selector]', this.domNode);
+                for(var i = 0; i < inputs.length; i++) {
+                    if(inputs[i].getAttribute('row') == rowIdx) {
+                        if(!inputs[i].disabled)
+                            inputs[i].checked = true;
+                        break;
+                    }
+                }
+            },
+
+            "deSelectRow": function(rowIdx) {
+                var inputs = dojo.query('[name=autogrid.selector]', this.domNode);
+                for(var i = 0; i < inputs.length; i++) {
+                    if(inputs[i].getAttribute('row') == rowIdx) {
+                        inputs[i].checked = false;
+                        break;
+                    }
+                }
+            },
+
+            "toggleSelectAll": function() {
+                var selected = this.getSelectedRows();
+                for(var i = 0; i < this.rowCount; i++) {
+                    if(selected[0])
+                        this.deSelectRow(i);
+                    else
+                        this.selectRow(i);
+                }
+            },
+
+            "_formatRowSelectInput": function(rowIdx) {
+                if (rowIdx === null || rowIdx === undefined)
+                    return "";
+                var s = "<input type='checkbox' name='autogrid.selector' row='"
+                    + rowIdx + "'";
+                if (this.disableSelectorForRow &&
+                        this.disableSelectorForRow(rowIdx))
+                    s += " disabled='disabled'";
+                return s + "/>";
+            },
+
+            // style the cells in the line number column
+            "onStyleRow": function(row) {
+                if (!this.hideLineNumber) {
+                    var cellIdx = this.hideSelector ? 0 : 1;
+                    dojo.addClass(
+                        this.views.views[0].getCellNode(row.index, cellIdx),
+                        "autoGridLineNumber"
+                    );
+                }
+            },
+
+            /* Don't allow sorting on the selector column */
+            "canSort": function(rowIdx) {
+                if (rowIdx == 1 && !this.hideSelector)
+                    return false;
+                if (this.hideSelector && rowIdx == 1 && !this.hideLineNumber)
+                    return false;
+                if (!this.hideSelector && rowIdx == 2 && !this.hideLineNumber)
+                    return false;
+                return true;
+            },
+
+            "_startupGridHelperColumns": function() {
+                if (!this.hideLineNumber) {
+                    console.log("line numbers");
+                    this.structure[0].cells[0].unshift({
+                        "field": "+lineno",
+                        "get": function(rowIdx, item) {
+                            if (item) return 1 + rowIdx;
+                        },
+                        "width": this.lineNumberWidth,
+                        "name": "#",
+                        "nonSelectable": false
+                    });
+                }
+                if (!this.hideSelector) {
+                    console.log("checkbox selectors");
+                    this.structure[0].cells[0].unshift({
+                        "field": "+selector",
+                        "formatter": dojo.hitch(
+                            this, function(rowIdx) {
+                                return this._formatRowSelectInput(rowIdx);
+                            }
+                        ),
+                        "get": function(rowIdx, item) {
+                            if (item) return rowIdx;
+                        },
+                        "width": this.selectorWidth,
+                        "name": "&#x2713",
+                        "nonSelectable": true
+                    });
+                    dojo.connect(
+                        this, "onHeaderCellClick", function(e) {
+                            if (e.cell.index == 0)
+                                this.toggleSelectAll();
+                        }
+                    );
+                }
+            }
+        }
+    );
+}
-- 
2.11.0