]> git.wh0rd.org Git - tt-rss.git/commitdiff
define custom dojo modules with define() instead of require(), update startup module...
authorAndrew Dolgov <noreply@fakecake.org>
Thu, 23 Aug 2018 06:56:34 +0000 (09:56 +0300)
committerAndrew Dolgov <noreply@fakecake.org>
Thu, 23 Aug 2018 06:56:34 +0000 (09:56 +0300)
12 files changed:
js/FeedStoreModel.js [new file with mode: 0644]
js/FeedTree.js
js/PrefFeedStore.js [new file with mode: 0644]
js/PrefFeedTree.js
js/PrefFilterStore.js [new file with mode: 0644]
js/PrefFilterTree.js
js/PrefLabelTree.js
js/prefs.js
js/tt-rss.js
lib/CheckBoxStoreModel.js [new file with mode: 0644]
lib/CheckBoxTree.js
lib/_CheckBoxTreeNode.js [new file with mode: 0644]

diff --git a/js/FeedStoreModel.js b/js/FeedStoreModel.js
new file mode 100644 (file)
index 0000000..49641a7
--- /dev/null
@@ -0,0 +1,98 @@
+define(["dojo/_base/declare", "dijit/tree/ForestStoreModel"], function (declare) {
+
+       return declare("fox.FeedStoreModel", dijit.tree.ForestStoreModel, {
+               getItemsInCategory: function (id) {
+                       if (!this.store._itemsByIdentity) return undefined;
+
+                       cat = this.store._itemsByIdentity['CAT:' + id];
+
+                       if (cat && cat.items)
+                               return cat.items;
+                       else
+                               return undefined;
+
+               },
+               getItemById: function (id) {
+                       return this.store._itemsByIdentity[id];
+               },
+               getFeedValue: function (feed, is_cat, key) {
+                       if (!this.store._itemsByIdentity) return undefined;
+
+                       if (is_cat)
+                               treeItem = this.store._itemsByIdentity['CAT:' + feed];
+                       else
+                               treeItem = this.store._itemsByIdentity['FEED:' + feed];
+
+                       if (treeItem)
+                               return this.store.getValue(treeItem, key);
+               },
+               getFeedName: function (feed, is_cat) {
+                       return this.getFeedValue(feed, is_cat, 'name');
+               },
+               getFeedUnread: function (feed, is_cat) {
+                       var unread = parseInt(this.getFeedValue(feed, is_cat, 'unread'));
+                       return (isNaN(unread)) ? 0 : unread;
+               },
+               setFeedUnread: function (feed, is_cat, unread) {
+                       return this.setFeedValue(feed, is_cat, 'unread', parseInt(unread));
+               },
+               setFeedValue: function (feed, is_cat, key, value) {
+                       if (!value) value = '';
+                       if (!this.store._itemsByIdentity) return undefined;
+
+                       if (is_cat)
+                               treeItem = this.store._itemsByIdentity['CAT:' + feed];
+                       else
+                               treeItem = this.store._itemsByIdentity['FEED:' + feed];
+
+                       if (treeItem)
+                               return this.store.setValue(treeItem, key, value);
+               },
+               getNextUnreadFeed: function (feed, is_cat) {
+                       if (!this.store._itemsByIdentity)
+                               return null;
+
+                       if (is_cat) {
+                               treeItem = this.store._itemsByIdentity['CAT:' + feed];
+                       } else {
+                               treeItem = this.store._itemsByIdentity['FEED:' + feed];
+                       }
+
+                       items = this.store._arrayOfAllItems;
+
+                       for (var i = 0; i < items.length; i++) {
+                               if (items[i] == treeItem) {
+
+                                       for (var j = i + 1; j < items.length; j++) {
+                                               var unread = this.store.getValue(items[j], 'unread');
+                                               var id = this.store.getValue(items[j], 'id');
+
+                                               if (unread > 0 && ((is_cat && id.match("CAT:")) || (!is_cat && id.match("FEED:")))) {
+                                                       if (!is_cat || !(this.store.hasAttribute(items[j], 'parent_id') && this.store.getValue(items[j], 'parent_id') == feed)) return items[j];
+                                               }
+                                       }
+
+                                       for (var j = 0; j < i; j++) {
+                                               var unread = this.store.getValue(items[j], 'unread');
+                                               var id = this.store.getValue(items[j], 'id');
+
+                                               if (unread > 0 && ((is_cat && id.match("CAT:")) || (!is_cat && id.match("FEED:")))) {
+                                                       if (!is_cat || !(this.store.hasAttribute(items[j], 'parent_id') && this.store.getValue(items[j], 'parent_id') == feed)) return items[j];
+                                               }
+                                       }
+                               }
+                       }
+
+                       return null;
+               },
+               hasCats: function () {
+                       if (this.store && this.store._itemsByIdentity)
+                               return this.store._itemsByIdentity['CAT:-1'] != undefined;
+                       else
+                               return false;
+               },
+
+       });
+});
+
+
index aff481e2cd75e99cc8962af2af4e8d8e8fae15a4..636abed6e30d3032d737f02bff9450b8ec512978 100755 (executable)
@@ -1,101 +1,4 @@
-require(["dojo/_base/declare", "dijit/tree/ForestStoreModel"], function (declare) {
-
-       return declare("fox.FeedStoreModel", dijit.tree.ForestStoreModel, {
-               getItemsInCategory: function (id) {
-                       if (!this.store._itemsByIdentity) return undefined;
-
-                       cat = this.store._itemsByIdentity['CAT:' + id];
-
-                       if (cat && cat.items)
-                               return cat.items;
-                       else
-                               return undefined;
-
-               },
-               getItemById: function (id) {
-                       return this.store._itemsByIdentity[id];
-               },
-               getFeedValue: function (feed, is_cat, key) {
-                       if (!this.store._itemsByIdentity) return undefined;
-
-                       if (is_cat)
-                               treeItem = this.store._itemsByIdentity['CAT:' + feed];
-                       else
-                               treeItem = this.store._itemsByIdentity['FEED:' + feed];
-
-                       if (treeItem)
-                               return this.store.getValue(treeItem, key);
-               },
-               getFeedName: function (feed, is_cat) {
-                       return this.getFeedValue(feed, is_cat, 'name');
-               },
-               getFeedUnread: function (feed, is_cat) {
-                       var unread = parseInt(this.getFeedValue(feed, is_cat, 'unread'));
-                       return (isNaN(unread)) ? 0 : unread;
-               },
-               setFeedUnread: function (feed, is_cat, unread) {
-                       return this.setFeedValue(feed, is_cat, 'unread', parseInt(unread));
-               },
-               setFeedValue: function (feed, is_cat, key, value) {
-                       if (!value) value = '';
-                       if (!this.store._itemsByIdentity) return undefined;
-
-                       if (is_cat)
-                               treeItem = this.store._itemsByIdentity['CAT:' + feed];
-                       else
-                               treeItem = this.store._itemsByIdentity['FEED:' + feed];
-
-                       if (treeItem)
-                               return this.store.setValue(treeItem, key, value);
-               },
-               getNextUnreadFeed: function (feed, is_cat) {
-                       if (!this.store._itemsByIdentity)
-                               return null;
-
-                       if (is_cat) {
-                               treeItem = this.store._itemsByIdentity['CAT:' + feed];
-                       } else {
-                               treeItem = this.store._itemsByIdentity['FEED:' + feed];
-                       }
-
-                       items = this.store._arrayOfAllItems;
-
-                       for (var i = 0; i < items.length; i++) {
-                               if (items[i] == treeItem) {
-
-                                       for (var j = i + 1; j < items.length; j++) {
-                                               var unread = this.store.getValue(items[j], 'unread');
-                                               var id = this.store.getValue(items[j], 'id');
-
-                                               if (unread > 0 && ((is_cat && id.match("CAT:")) || (!is_cat && id.match("FEED:")))) {
-                                                       if (!is_cat || !(this.store.hasAttribute(items[j], 'parent_id') && this.store.getValue(items[j], 'parent_id') == feed)) return items[j];
-                                               }
-                                       }
-
-                                       for (var j = 0; j < i; j++) {
-                                               var unread = this.store.getValue(items[j], 'unread');
-                                               var id = this.store.getValue(items[j], 'id');
-
-                                               if (unread > 0 && ((is_cat && id.match("CAT:")) || (!is_cat && id.match("FEED:")))) {
-                                                       if (!is_cat || !(this.store.hasAttribute(items[j], 'parent_id') && this.store.getValue(items[j], 'parent_id') == feed)) return items[j];
-                                               }
-                                       }
-                               }
-                       }
-
-                       return null;
-               },
-               hasCats: function () {
-                       if (this.store && this.store._itemsByIdentity)
-                               return this.store._itemsByIdentity['CAT:-1'] != undefined;
-                       else
-                               return false;
-               },
-
-       });
-});
-
-require(["dojo/_base/declare", "dojo/dom-construct", "dijit/Tree", "dijit/Menu"], function (declare, domConstruct) {
+define(["dojo/_base/declare", "dojo/dom-construct", "dijit/Tree", "dijit/Menu"], function (declare, domConstruct) {
 
        return declare("fox.FeedTree", dijit.Tree, {
                _onKeyPress: function(/* Event */ e) {
diff --git a/js/PrefFeedStore.js b/js/PrefFeedStore.js
new file mode 100644 (file)
index 0000000..152ebba
--- /dev/null
@@ -0,0 +1,20 @@
+define(["dojo/_base/declare", "dojo/data/ItemFileWriteStore"], function (declare) {
+
+       return declare("fox.PrefFeedStore", dojo.data.ItemFileWriteStore, {
+
+               _saveEverything: function(saveCompleteCallback, saveFailedCallback,
+                                                                 newFileContentString) {
+
+                       dojo.xhrPost({
+                               url: "backend.php",
+                               content: {op: "pref-feeds", method: "savefeedorder",
+                                       payload: newFileContentString},
+                               error: saveFailedCallback,
+                               load: saveCompleteCallback});
+               },
+
+       });
+
+});
+
+
index 0079f0b1b0e8cb8c43e7582c3f22f091e4d0d40c..b3ea0c4259be86781d759685cdfea26aac026a69 100644 (file)
@@ -1,23 +1,4 @@
-require(["dojo/_base/declare", "dojo/data/ItemFileWriteStore"], function (declare) {
-
-       return declare("fox.PrefFeedStore", dojo.data.ItemFileWriteStore, {
-
-               _saveEverything: function(saveCompleteCallback, saveFailedCallback,
-                                                                 newFileContentString) {
-
-                       dojo.xhrPost({
-                               url: "backend.php",
-                               content: {op: "pref-feeds", method: "savefeedorder",
-                                       payload: newFileContentString},
-                               error: saveFailedCallback,
-                               load: saveCompleteCallback});
-               },
-
-       });
-
-});
-
-require(["dojo/_base/declare", "dojo/dom-construct", "lib/CheckBoxTree"], function (declare, domConstruct) {
+define(["dojo/_base/declare", "dojo/dom-construct", "lib/CheckBoxTree"], function (declare, domConstruct) {
 
        return declare("fox.PrefFeedTree", lib.CheckBoxTree, {
                _createTreeNode: function(args) {
diff --git a/js/PrefFilterStore.js b/js/PrefFilterStore.js
new file mode 100644 (file)
index 0000000..cccec64
--- /dev/null
@@ -0,0 +1,22 @@
+define(["dojo/_base/declare", "dojo/data/ItemFileWriteStore"], function (declare) {
+
+       return declare("fox.PrefFilterStore", dojo.data.ItemFileWriteStore, {
+
+               _saveEverything: function (saveCompleteCallback, saveFailedCallback,
+                                                                  newFileContentString) {
+
+                       dojo.xhrPost({
+                               url: "backend.php",
+                               content: {
+                                       op: "pref-filters", method: "savefilterorder",
+                                       payload: newFileContentString
+                               },
+                               error: saveFailedCallback,
+                               load: saveCompleteCallback
+                       });
+               },
+
+       });
+});
+
+
index 5c854cbd8a1807ff575ce48d212a5bcdf5f6b6d7..3249fbc26761694a0445c06f90aae73ab41e3f00 100644 (file)
@@ -1,25 +1,4 @@
-require(["dojo/_base/declare", "dojo/data/ItemFileWriteStore"], function (declare) {
-
-       return declare("fox.PrefFilterStore", dojo.data.ItemFileWriteStore, {
-
-               _saveEverything: function (saveCompleteCallback, saveFailedCallback,
-                                                                  newFileContentString) {
-
-                       dojo.xhrPost({
-                               url: "backend.php",
-                               content: {
-                                       op: "pref-filters", method: "savefilterorder",
-                                       payload: newFileContentString
-                               },
-                               error: saveFailedCallback,
-                               load: saveCompleteCallback
-                       });
-               },
-
-       });
-});
-
-require(["dojo/_base/declare", "dojo/dom-construct", "lib/CheckBoxTree"], function (declare, domConstruct) {
+define(["dojo/_base/declare", "dojo/dom-construct", "lib/CheckBoxTree"], function (declare, domConstruct) {
 
        return declare("fox.PrefFilterTree", lib.CheckBoxTree, {
                _createTreeNode: function(args) {
index 9c43346b3354bc0c732c1c5423d3cf05fc39ea67..2215dcdb082fb5ed2726d042028d584111232c53 100644 (file)
@@ -1,4 +1,4 @@
-require(["dojo/_base/declare", "dojo/dom-construct", "lib/CheckBoxTree", "dijit/form/DropDownButton"], function (declare, domConstruct) {
+define(["dojo/_base/declare", "dojo/dom-construct", "lib/CheckBoxTree", "dijit/form/DropDownButton"], function (declare, domConstruct) {
 
        return declare("fox.PrefLabelTree", lib.CheckBoxTree, {
                setNameById: function (id, name) {
index 79ad15cecb5d6cd606c21366c3cfd916dc93bdf7..c2190280c431615c94aea89f80c31b2775adf235 100755 (executable)
@@ -832,6 +832,10 @@ function init() {
                "dijit/Tree",
                "dijit/tree/dndSource",
                "dojo/data/ItemFileWriteStore",
+               "lib/CheckBoxStoreModel",
+               "lib/CheckBoxTree",
+               "fox/PrefFeedStore",
+               "fox/PrefFilterStore",
                "fox/PrefFeedTree",
                "fox/PrefFilterTree",
                "fox/PrefLabelTree"], function (dojo, ready, parser) {
index 284df974652759ac4072f5c3f4925e42e77c9213..3f65a2cea0eff9f2227540538b14f5c1feb7ce83 100644 (file)
@@ -245,6 +245,7 @@ function init() {
                        "dijit/tree/dndSource",
                        "dijit/tree/ForestStoreModel",
                        "dojo/data/ItemFileWriteStore",
+                       "fox/FeedStoreModel",
                        "fox/FeedTree" ], function (dojo, ready, parser) {
 
                        ready(function() {
diff --git a/lib/CheckBoxStoreModel.js b/lib/CheckBoxStoreModel.js
new file mode 100644 (file)
index 0000000..5dd9c5f
--- /dev/null
@@ -0,0 +1,341 @@
+//dojo.provide("lib.CheckBoxTree");
+//dojo.provide("lib.CheckBoxStoreModel");
+
+// THIS WIDGET IS BASED ON DOJO/DIJIT 1.4.0 AND WILL NOT WORK WITH PREVIOUS VERSIONS
+//
+//     Release date: 02/05/2010
+//
+
+//dojo.require("dijit.Tree");
+//dojo.require("dijit.form.CheckBox");
+
+define(["dojo/_base/declare", "dijit/tree/TreeStoreModel"], function (declare) {
+
+       return declare( "lib.CheckBoxStoreModel", dijit.tree.TreeStoreModel,
+               {
+                       // checkboxAll: Boolean
+                       //              If true, every node in the tree will receive a checkbox regardless if the 'checkbox' attribute
+                       //              is specified in the dojo.data.
+                       checkboxAll: true,
+
+                       // checkboxState: Boolean
+                       //              The default state applied to every checkbox unless otherwise specified in the dojo.data.
+                       //              (see also: checkboxIdent)
+                       checkboxState: false,
+
+                       // checkboxRoot: Boolean
+                       //              If true, the root node will receive a checkbox eventhough it's not a true entry in the store.
+                       //              This attribute is independent of the showRoot attribute of the tree itself. If the tree
+                       //              attribute 'showRoot' is set to false to checkbox for the root will not show either.
+                       checkboxRoot: false,
+
+                       // checkboxStrict: Boolean
+                       //              If true, a strict parent-child checkbox relation is maintained. For example, if all children
+                       //              are checked the parent will automatically be checked or if any of the children are unchecked
+                       //              the parent will be unchecked.
+                       checkboxStrict: true,
+
+                       // checkboxIdent: String
+                       //              The attribute name (attribute of the dojo.data.item) that specifies that items checkbox initial
+                       //              state. Example: { name:'Egypt', type:'country', checkbox: true }
+                       //              If a dojo.data.item has no 'checkbox' attribute specified it will depend on the attribute
+                       //              'checkboxAll' if one will be created automatically and if so what the initial state will be as
+                       //              specified by 'checkboxState'.
+                       checkboxIdent: "checkbox",
+
+                       updateCheckbox: function(/*dojo.data.Item*/ storeItem, /*Boolean*/ newState ) {
+                               // summary:
+                               //              Update the checkbox state (true/false) for the item and the associated parent and
+                               //              child checkboxes if any.
+                               // description:
+                               //              Update a single checkbox state (true/false) for the item and the associated parent
+                               //              and child checkboxes if any. This function is called from the tree if a user checked
+                               //              or unchecked a checkbox on the tree. The parent and child tree nodes are updated to
+                               //              maintain consistency if 'checkboxStrict' is set to true.
+                               //      storeItem:
+                               //              The item in the dojo.data.store whos checkbox state needs updating.
+                               //      newState:
+                               //              The new state of the checkbox: true or false
+                               //      example:
+                               //      | model.updateCheckboxState(item, true);
+                               //
+
+                               this._setCheckboxState( storeItem, newState );
+                               //if( this.checkboxStrict ) { I don't need all this 1-1 stuff, only parent -> child (fox)
+                               this._updateChildCheckbox( storeItem, newState );
+                               //this._updateParentCheckbox( storeItem, newState );
+                               //}
+                       },
+                       setAllChecked: function(checked) {
+                               var items = this.store._arrayOfAllItems;
+                               this.setCheckboxState(items, checked);
+                       },
+                       setCheckboxState: function(items, checked) {
+                               for (var i = 0; i < items.length; i++) {
+                                       this._setCheckboxState(items[i], checked);
+                               }
+                       },
+                       getCheckedItems: function() {
+                               var items = this.store._arrayOfAllItems;
+                               var result = [];
+
+                               for (var i = 0; i < items.length; i++) {
+                                       if (this.store.getValue(items[i], 'checkbox'))
+                                               result.push(items[i]);
+                               }
+
+                               return result;
+                       },
+
+                       getCheckboxState: function(/*dojo.data.Item*/ storeItem) {
+                               // summary:
+                               //              Get the current checkbox state from the dojo.data.store.
+                               // description:
+                               //              Get the current checkbox state from the dojo.data store. A checkbox can have three
+                               //              different states: true, false or undefined. Undefined in this context means no
+                               //              checkbox identifier (checkboxIdent) was found in the dojo.data store. Depending on
+                               //              the checkbox attributes as specified above the following will take place:
+                               //              a)      If the current checkbox state is undefined and the checkbox attribute 'checkboxAll' or
+                               //                      'checkboxRoot' is true one will be created and the default state 'checkboxState' will
+                               //                      be applied.
+                               //              b)      If the current state is undefined and 'checkboxAll' is false the state undefined remains
+                               //                      unchanged and is returned. This will prevent any tree node from creating a checkbox.
+                               //
+                               //      storeItem:
+                               //              The item in the dojo.data.store whos checkbox state is returned.
+                               //      example:
+                               //      | var currState = model.getCheckboxState(item);
+                               //
+                               var currState = undefined;
+
+                               // Special handling required for the 'fake' root entry (the root is NOT a dojo.data.item).
+                               // this stuff is only relevant for Forest store -fox
+                               /*              if ( storeItem == this.root ) {
+                                if( typeof(storeItem.checkbox) == "undefined" ) {
+                                this.root.checkbox = undefined;                // create a new checbox reference as undefined.
+                                if( this.checkboxRoot ) {
+                                currState = this.root.checkbox = this.checkboxState;
+                                }
+                                } else {
+                                currState = this.root.checkbox;
+                                }
+                                } else {       // a valid dojo.store.item
+                                currState = this.store.getValue(storeItem, this.checkboxIdent);
+                                if( currState == undefined && this.checkboxAll) {
+                                this._setCheckboxState( storeItem, this.checkboxState );
+                                currState = this.checkboxState;
+                                }
+                                } */
+
+                               currState = this.store.getValue(storeItem, this.checkboxIdent);
+                               if( currState == undefined && this.checkboxAll) {
+                                       this._setCheckboxState( storeItem, this.checkboxState );
+                                       currState = this.checkboxState;
+                               }
+
+                               return currState;  // the current state of the checkbox (true/false or undefined)
+                       },
+
+                       _setCheckboxState: function(/*dojo.data.Item*/ storeItem, /*Boolean*/ newState ) {
+                               // summary:
+                               //              Set/update the checkbox state on the dojo.data store.
+                               // description:
+                               //              Set/update the checkbox state on the dojo.data.store. Retreive the current
+                               //              state of the checkbox and validate if an update is required, this will keep
+                               //              update events to a minimum. On completion a 'onCheckboxChange' event is
+                               //              triggered.
+                               //              If the current state is undefined (ie: no checkbox attribute specified for
+                               //              this dojo.data.item) the 'checkboxAll' attribute is checked     to see if one
+                               //              needs to be created. In case of the root the 'checkboxRoot' attribute is checked.
+                               //              NOTE: the store.setValue function will create the 'checkbox' attribute for the
+                               //              item if none exists.
+                               //      storeItem:
+                               //              The item in the dojo.data.store whos checkbox state is updated.
+                               //      newState:
+                               //              The new state of the checkbox: true or false
+                               //      example:
+                               //      | model.setCheckboxState(item, true);
+                               //
+                               var stateChanged = true;
+
+                               if( storeItem != this.root ) {
+                                       var currState = this.store.getValue(storeItem, this.checkboxIdent);
+                                       if( currState != newState && ( currState !== undefined || this.checkboxAll ) ) {
+                                               this.store.setValue(storeItem, this.checkboxIdent, newState);
+                                       } else {
+                                               stateChanged = false;   // No changes to the checkbox
+                                       }
+                               } else {  // Tree root instance
+                                       if( this.root.checkbox != newState && ( this.root.checkbox !== undefined || this.checkboxRoot ) ) {
+                                               this.root.checkbox = newState;
+                                       } else {
+                                               stateChanged = false;
+                                       }
+                               }
+                               if( stateChanged ) {    // In case of any changes trigger the update event.
+                                       this.onCheckboxChange(storeItem);
+                               }
+                               return stateChanged;
+                       },
+
+                       _updateChildCheckbox: function(/*dojo.data.Item*/ parentItem, /*Boolean*/ newState ) {
+                               //      summary:
+                               //              Set all child checkboxes to true/false depending on the parent checkbox state.
+                               //      description:
+                               //              If a parent checkbox changes state, all child and grandchild checkboxes will be
+                               //              updated to reflect the change. For example, if the parent state is set to true,
+                               //              all child and grandchild checkboxes will receive that same 'true' state.
+                               //              If a child checkbox changes state and has multiple parent, all of its parents
+                               //              need to be re-evaluated.
+                               //      parentItem:
+                               //              The parent dojo.data.item whos child/grandchild checkboxes require updating.
+                               //      newState:
+                               //              The new state of the checkbox: true or false
+                               //
+
+                               if( this.mayHaveChildren( parentItem )) {
+                                       this.getChildren( parentItem, dojo.hitch( this,
+                                               function( children ) {
+                                                       dojo.forEach( children, function(child) {
+                                                               if( this._setCheckboxState(child, newState) ) {
+                                                                       var parents = this._getParentsItem(child);
+                                                                       if( parents.length > 1 ) {
+                                                                               this._updateParentCheckbox( child, newState );
+                                                                       }
+                                                               }
+                                                               if( this.mayHaveChildren( child )) {
+                                                                       this._updateChildCheckbox( child, newState );
+                                                               }
+                                                       }, this );
+                                               }),
+                                               function(err) {
+                                                       console.error(this, ": updating child checkboxes: ", err);
+                                               }
+                                       );
+                               }
+                       },
+
+                       _updateParentCheckbox: function(/*dojo.data.Item*/ storeItem, /*Boolean*/ newState ) {
+                               //      summary:
+                               //              Update the parent checkbox state depending on the state of all child checkboxes.
+                               //      description:
+                               //              Update the parent checkbox state depending on the state of all child checkboxes.
+                               //              The parent checkbox automatically changes state if ALL child checkboxes are true
+                               //              or false. If, as a result, the parent checkbox changes state, we will check if
+                               //              its parent needs to be updated as well all the way upto the root.
+                               //      storeItem:
+                               //              The dojo.data.item whos parent checkboxes require updating.
+                               //      newState:
+                               //              The new state of the checkbox: true or false
+                               //
+                               var parents = this._getParentsItem(storeItem);
+                               dojo.forEach( parents, function( parentItem ) {
+                                       if( newState ) { // new state = true (checked)
+                                               this.getChildren( parentItem, dojo.hitch( this,
+                                                       function(siblings) {
+                                                               var allChecked  = true;
+                                                               dojo.some( siblings, function(sibling) {
+                                                                       siblState = this.getCheckboxState(sibling);
+                                                                       if( siblState !== undefined && allChecked )
+                                                                               allChecked = siblState;
+                                                                       return !(allChecked);
+                                                               }, this );
+                                                               if( allChecked ) {
+                                                                       this._setCheckboxState( parentItem, true );
+                                                                       this._updateParentCheckbox( parentItem, true );
+                                                               }
+                                                       }),
+                                                       function(err) {
+                                                               console.error(this, ": updating parent checkboxes: ", err);
+                                                       }
+                                               );
+                                       } else {        // new state = false (unchecked)
+                                               if( this._setCheckboxState( parentItem, false ) ) {
+                                                       this._updateParentCheckbox( parentItem, false );
+                                               }
+                                       }
+                               }, this );
+                       },
+
+                       _getParentsItem: function(/*dojo.data.Item*/ storeItem ) {
+                               // summary:
+                               //              Get the parent(s) of a dojo.data item.
+                               // description:
+                               //              Get the parent(s) of a dojo.data item. The '_reverseRefMap' entry of the item is
+                               //              used to identify the parent(s). A child will have a parent reference if the parent
+                               //              specified the '_reference' attribute.
+                               //              For example: children:[{_reference:'Mexico'}, {_reference:'Canada'}, ...
+                               //      storeItem:
+                               //              The dojo.data.item whos parent(s) will be returned.
+                               //
+                               var parents = [];
+
+                               if( storeItem != this.root ) {
+                                       var references = storeItem[this.store._reverseRefMap];
+                                       for(itemId in references ) {
+                                               parents.push(this.store._itemsByIdentity[itemId]);
+                                       }
+                                       if (!parents.length) {
+                                               parents.push(this.root);
+                                       }
+                               }
+                               return parents; // parent(s) of a dojo.data.item (Array of dojo.data.items)
+                       },
+
+                       validateData: function(/*dojo.data.Item*/ storeItem, /*thisObject*/ scope ) {
+                               // summary:
+                               //              Validate/normalize the parent(s) checkbox data in the dojo.data store.
+                               // description:
+                               //              Validate/normalize the parent-child checkbox relationship if the attribute
+                               //              'checkboxStrict' is set to true. This function is called as part of the post
+                               //              creation of the Tree instance. All parent checkboxes are set to the appropriate
+                               //              state according to the actual state(s) of their children.
+                               //              This will potentionally overwrite whatever was specified for the parent in the
+                               //              dojo.data store. This will garantee the tree is in a consistent state after startup.
+                               //      storeItem:
+                               //              The element to start traversing the dojo.data.store, typically model.root
+                               //      scope:
+                               //              The scope to use when this method executes.
+                               //      example:
+                               //      | this.model.validateData(this.model.root, this.model);
+                               //
+                               if( !scope.checkboxStrict ) {
+                                       return;
+                               }
+                               scope.getChildren( storeItem, dojo.hitch( scope,
+                                       function(children) {
+                                               var allChecked  = true;
+                                               var childState;
+                                               dojo.forEach( children, function( child ) {
+                                                       if( this.mayHaveChildren( child )) {
+                                                               this.validateData( child, this );
+                                                       }
+                                                       childState = this.getCheckboxState( child );
+                                                       if( childState !== undefined && allChecked )
+                                                               allChecked = childState;
+                                               }, this);
+
+                                               if ( this._setCheckboxState( storeItem, allChecked) ) {
+                                                       this._updateParentCheckbox( storeItem, allChecked);
+                                               }
+                                       }),
+                                       function(err) {
+                                               console.error(this, ": validating checkbox data: ", err);
+                                       }
+                               );
+                       },
+
+                       onCheckboxChange: function(/*dojo.data.Item*/ storeItem ) {
+                               // summary:
+                               //              Callback whenever a checkbox state has changed state, so that
+                               //              the Tree can update the checkbox.  This callback is generally
+                               //              triggered by the '_setCheckboxState' function.
+                               // tags:
+                               //              callback
+                       }
+
+               });
+
+});
+
+
index 41c74ab3bbc7f958672c02e1c5c41d9b64fe66b4..2b0c71642b8010474cd51fe422bf629ad981f798 100644 (file)
@@ -1,385 +1,4 @@
-//dojo.provide("lib.CheckBoxTree");
-//dojo.provide("lib.CheckBoxStoreModel");
-
-// THIS WIDGET IS BASED ON DOJO/DIJIT 1.4.0 AND WILL NOT WORK WITH PREVIOUS VERSIONS
-//
-//     Release date: 02/05/2010
-//
-
-//dojo.require("dijit.Tree");
-//dojo.require("dijit.form.CheckBox");
-
-require(["dojo/_base/declare", "dijit/tree/TreeStoreModel"], function (declare) {
-
-       return declare( "lib.CheckBoxStoreModel", dijit.tree.TreeStoreModel,
-               {
-                       // checkboxAll: Boolean
-                       //              If true, every node in the tree will receive a checkbox regardless if the 'checkbox' attribute
-                       //              is specified in the dojo.data.
-                       checkboxAll: true,
-
-                       // checkboxState: Boolean
-                       //              The default state applied to every checkbox unless otherwise specified in the dojo.data.
-                       //              (see also: checkboxIdent)
-                       checkboxState: false,
-
-                       // checkboxRoot: Boolean
-                       //              If true, the root node will receive a checkbox eventhough it's not a true entry in the store.
-                       //              This attribute is independent of the showRoot attribute of the tree itself. If the tree
-                       //              attribute 'showRoot' is set to false to checkbox for the root will not show either.
-                       checkboxRoot: false,
-
-                       // checkboxStrict: Boolean
-                       //              If true, a strict parent-child checkbox relation is maintained. For example, if all children
-                       //              are checked the parent will automatically be checked or if any of the children are unchecked
-                       //              the parent will be unchecked.
-                       checkboxStrict: true,
-
-                       // checkboxIdent: String
-                       //              The attribute name (attribute of the dojo.data.item) that specifies that items checkbox initial
-                       //              state. Example: { name:'Egypt', type:'country', checkbox: true }
-                       //              If a dojo.data.item has no 'checkbox' attribute specified it will depend on the attribute
-                       //              'checkboxAll' if one will be created automatically and if so what the initial state will be as
-                       //              specified by 'checkboxState'.
-                       checkboxIdent: "checkbox",
-
-                       updateCheckbox: function(/*dojo.data.Item*/ storeItem, /*Boolean*/ newState ) {
-                               // summary:
-                               //              Update the checkbox state (true/false) for the item and the associated parent and
-                               //              child checkboxes if any.
-                               // description:
-                               //              Update a single checkbox state (true/false) for the item and the associated parent
-                               //              and child checkboxes if any. This function is called from the tree if a user checked
-                               //              or unchecked a checkbox on the tree. The parent and child tree nodes are updated to
-                               //              maintain consistency if 'checkboxStrict' is set to true.
-                               //      storeItem:
-                               //              The item in the dojo.data.store whos checkbox state needs updating.
-                               //      newState:
-                               //              The new state of the checkbox: true or false
-                               //      example:
-                               //      | model.updateCheckboxState(item, true);
-                               //
-
-                               this._setCheckboxState( storeItem, newState );
-                               //if( this.checkboxStrict ) { I don't need all this 1-1 stuff, only parent -> child (fox)
-                               this._updateChildCheckbox( storeItem, newState );
-                               //this._updateParentCheckbox( storeItem, newState );
-                               //}
-                       },
-                       setAllChecked: function(checked) {
-                               var items = this.store._arrayOfAllItems;
-                               this.setCheckboxState(items, checked);
-                       },
-                       setCheckboxState: function(items, checked) {
-                               for (var i = 0; i < items.length; i++) {
-                                       this._setCheckboxState(items[i], checked);
-                               }
-                       },
-                       getCheckedItems: function() {
-                               var items = this.store._arrayOfAllItems;
-                               var result = [];
-
-                               for (var i = 0; i < items.length; i++) {
-                                       if (this.store.getValue(items[i], 'checkbox'))
-                                               result.push(items[i]);
-                               }
-
-                               return result;
-                       },
-
-                       getCheckboxState: function(/*dojo.data.Item*/ storeItem) {
-                               // summary:
-                               //              Get the current checkbox state from the dojo.data.store.
-                               // description:
-                               //              Get the current checkbox state from the dojo.data store. A checkbox can have three
-                               //              different states: true, false or undefined. Undefined in this context means no
-                               //              checkbox identifier (checkboxIdent) was found in the dojo.data store. Depending on
-                               //              the checkbox attributes as specified above the following will take place:
-                               //              a)      If the current checkbox state is undefined and the checkbox attribute 'checkboxAll' or
-                               //                      'checkboxRoot' is true one will be created and the default state 'checkboxState' will
-                               //                      be applied.
-                               //              b)      If the current state is undefined and 'checkboxAll' is false the state undefined remains
-                               //                      unchanged and is returned. This will prevent any tree node from creating a checkbox.
-                               //
-                               //      storeItem:
-                               //              The item in the dojo.data.store whos checkbox state is returned.
-                               //      example:
-                               //      | var currState = model.getCheckboxState(item);
-                               //
-                               var currState = undefined;
-
-                               // Special handling required for the 'fake' root entry (the root is NOT a dojo.data.item).
-                               // this stuff is only relevant for Forest store -fox
-                               /*              if ( storeItem == this.root ) {
-                                if( typeof(storeItem.checkbox) == "undefined" ) {
-                                this.root.checkbox = undefined;                // create a new checbox reference as undefined.
-                                if( this.checkboxRoot ) {
-                                currState = this.root.checkbox = this.checkboxState;
-                                }
-                                } else {
-                                currState = this.root.checkbox;
-                                }
-                                } else {       // a valid dojo.store.item
-                                currState = this.store.getValue(storeItem, this.checkboxIdent);
-                                if( currState == undefined && this.checkboxAll) {
-                                this._setCheckboxState( storeItem, this.checkboxState );
-                                currState = this.checkboxState;
-                                }
-                                } */
-
-                               currState = this.store.getValue(storeItem, this.checkboxIdent);
-                               if( currState == undefined && this.checkboxAll) {
-                                       this._setCheckboxState( storeItem, this.checkboxState );
-                                       currState = this.checkboxState;
-                               }
-
-                               return currState;  // the current state of the checkbox (true/false or undefined)
-                       },
-
-                       _setCheckboxState: function(/*dojo.data.Item*/ storeItem, /*Boolean*/ newState ) {
-                               // summary:
-                               //              Set/update the checkbox state on the dojo.data store.
-                               // description:
-                               //              Set/update the checkbox state on the dojo.data.store. Retreive the current
-                               //              state of the checkbox and validate if an update is required, this will keep
-                               //              update events to a minimum. On completion a 'onCheckboxChange' event is
-                               //              triggered.
-                               //              If the current state is undefined (ie: no checkbox attribute specified for
-                               //              this dojo.data.item) the 'checkboxAll' attribute is checked     to see if one
-                               //              needs to be created. In case of the root the 'checkboxRoot' attribute is checked.
-                               //              NOTE: the store.setValue function will create the 'checkbox' attribute for the
-                               //              item if none exists.
-                               //      storeItem:
-                               //              The item in the dojo.data.store whos checkbox state is updated.
-                               //      newState:
-                               //              The new state of the checkbox: true or false
-                               //      example:
-                               //      | model.setCheckboxState(item, true);
-                               //
-                               var stateChanged = true;
-
-                               if( storeItem != this.root ) {
-                                       var currState = this.store.getValue(storeItem, this.checkboxIdent);
-                                       if( currState != newState && ( currState !== undefined || this.checkboxAll ) ) {
-                                               this.store.setValue(storeItem, this.checkboxIdent, newState);
-                                       } else {
-                                               stateChanged = false;   // No changes to the checkbox
-                                       }
-                               } else {  // Tree root instance
-                                       if( this.root.checkbox != newState && ( this.root.checkbox !== undefined || this.checkboxRoot ) ) {
-                                               this.root.checkbox = newState;
-                                       } else {
-                                               stateChanged = false;
-                                       }
-                               }
-                               if( stateChanged ) {    // In case of any changes trigger the update event.
-                                       this.onCheckboxChange(storeItem);
-                               }
-                               return stateChanged;
-                       },
-
-                       _updateChildCheckbox: function(/*dojo.data.Item*/ parentItem, /*Boolean*/ newState ) {
-                               //      summary:
-                               //              Set all child checkboxes to true/false depending on the parent checkbox state.
-                               //      description:
-                               //              If a parent checkbox changes state, all child and grandchild checkboxes will be
-                               //              updated to reflect the change. For example, if the parent state is set to true,
-                               //              all child and grandchild checkboxes will receive that same 'true' state.
-                               //              If a child checkbox changes state and has multiple parent, all of its parents
-                               //              need to be re-evaluated.
-                               //      parentItem:
-                               //              The parent dojo.data.item whos child/grandchild checkboxes require updating.
-                               //      newState:
-                               //              The new state of the checkbox: true or false
-                               //
-
-                               if( this.mayHaveChildren( parentItem )) {
-                                       this.getChildren( parentItem, dojo.hitch( this,
-                                               function( children ) {
-                                                       dojo.forEach( children, function(child) {
-                                                               if( this._setCheckboxState(child, newState) ) {
-                                                                       var parents = this._getParentsItem(child);
-                                                                       if( parents.length > 1 ) {
-                                                                               this._updateParentCheckbox( child, newState );
-                                                                       }
-                                                               }
-                                                               if( this.mayHaveChildren( child )) {
-                                                                       this._updateChildCheckbox( child, newState );
-                                                               }
-                                                       }, this );
-                                               }),
-                                               function(err) {
-                                                       console.error(this, ": updating child checkboxes: ", err);
-                                               }
-                                       );
-                               }
-                       },
-
-                       _updateParentCheckbox: function(/*dojo.data.Item*/ storeItem, /*Boolean*/ newState ) {
-                               //      summary:
-                               //              Update the parent checkbox state depending on the state of all child checkboxes.
-                               //      description:
-                               //              Update the parent checkbox state depending on the state of all child checkboxes.
-                               //              The parent checkbox automatically changes state if ALL child checkboxes are true
-                               //              or false. If, as a result, the parent checkbox changes state, we will check if
-                               //              its parent needs to be updated as well all the way upto the root.
-                               //      storeItem:
-                               //              The dojo.data.item whos parent checkboxes require updating.
-                               //      newState:
-                               //              The new state of the checkbox: true or false
-                               //
-                               var parents = this._getParentsItem(storeItem);
-                               dojo.forEach( parents, function( parentItem ) {
-                                       if( newState ) { // new state = true (checked)
-                                               this.getChildren( parentItem, dojo.hitch( this,
-                                                       function(siblings) {
-                                                               var allChecked  = true;
-                                                               dojo.some( siblings, function(sibling) {
-                                                                       siblState = this.getCheckboxState(sibling);
-                                                                       if( siblState !== undefined && allChecked )
-                                                                               allChecked = siblState;
-                                                                       return !(allChecked);
-                                                               }, this );
-                                                               if( allChecked ) {
-                                                                       this._setCheckboxState( parentItem, true );
-                                                                       this._updateParentCheckbox( parentItem, true );
-                                                               }
-                                                       }),
-                                                       function(err) {
-                                                               console.error(this, ": updating parent checkboxes: ", err);
-                                                       }
-                                               );
-                                       } else {        // new state = false (unchecked)
-                                               if( this._setCheckboxState( parentItem, false ) ) {
-                                                       this._updateParentCheckbox( parentItem, false );
-                                               }
-                                       }
-                               }, this );
-                       },
-
-                       _getParentsItem: function(/*dojo.data.Item*/ storeItem ) {
-                               // summary:
-                               //              Get the parent(s) of a dojo.data item.
-                               // description:
-                               //              Get the parent(s) of a dojo.data item. The '_reverseRefMap' entry of the item is
-                               //              used to identify the parent(s). A child will have a parent reference if the parent
-                               //              specified the '_reference' attribute.
-                               //              For example: children:[{_reference:'Mexico'}, {_reference:'Canada'}, ...
-                               //      storeItem:
-                               //              The dojo.data.item whos parent(s) will be returned.
-                               //
-                               var parents = [];
-
-                               if( storeItem != this.root ) {
-                                       var references = storeItem[this.store._reverseRefMap];
-                                       for(itemId in references ) {
-                                               parents.push(this.store._itemsByIdentity[itemId]);
-                                       }
-                                       if (!parents.length) {
-                                               parents.push(this.root);
-                                       }
-                               }
-                               return parents; // parent(s) of a dojo.data.item (Array of dojo.data.items)
-                       },
-
-                       validateData: function(/*dojo.data.Item*/ storeItem, /*thisObject*/ scope ) {
-                               // summary:
-                               //              Validate/normalize the parent(s) checkbox data in the dojo.data store.
-                               // description:
-                               //              Validate/normalize the parent-child checkbox relationship if the attribute
-                               //              'checkboxStrict' is set to true. This function is called as part of the post
-                               //              creation of the Tree instance. All parent checkboxes are set to the appropriate
-                               //              state according to the actual state(s) of their children.
-                               //              This will potentionally overwrite whatever was specified for the parent in the
-                               //              dojo.data store. This will garantee the tree is in a consistent state after startup.
-                               //      storeItem:
-                               //              The element to start traversing the dojo.data.store, typically model.root
-                               //      scope:
-                               //              The scope to use when this method executes.
-                               //      example:
-                               //      | this.model.validateData(this.model.root, this.model);
-                               //
-                               if( !scope.checkboxStrict ) {
-                                       return;
-                               }
-                               scope.getChildren( storeItem, dojo.hitch( scope,
-                                       function(children) {
-                                               var allChecked  = true;
-                                               var childState;
-                                               dojo.forEach( children, function( child ) {
-                                                       if( this.mayHaveChildren( child )) {
-                                                               this.validateData( child, this );
-                                                       }
-                                                       childState = this.getCheckboxState( child );
-                                                       if( childState !== undefined && allChecked )
-                                                               allChecked = childState;
-                                               }, this);
-
-                                               if ( this._setCheckboxState( storeItem, allChecked) ) {
-                                                       this._updateParentCheckbox( storeItem, allChecked);
-                                               }
-                                       }),
-                                       function(err) {
-                                               console.error(this, ": validating checkbox data: ", err);
-                                       }
-                               );
-                       },
-
-                       onCheckboxChange: function(/*dojo.data.Item*/ storeItem ) {
-                               // summary:
-                               //              Callback whenever a checkbox state has changed state, so that
-                               //              the Tree can update the checkbox.  This callback is generally
-                               //              triggered by the '_setCheckboxState' function.
-                               // tags:
-                               //              callback
-                       }
-
-               });
-
-});
-
-require(["dojo/_base/declare", "dojo/dom-construct", "dijit/Tree"], function (declare, domConstruct) {
-
-       return declare("lib._CheckBoxTreeNode", dijit._TreeNode,
-               {
-                       // _checkbox: [protected] dojo.doc.element
-                       //              Local reference to the dojo.doc.element of type 'checkbox'
-                       _checkbox: null,
-
-                       _createCheckbox: function () {
-                               // summary:
-                               //              Create a checkbox on the CheckBoxTreeNode
-                               // description:
-                               //              Create a checkbox on the CheckBoxTreeNode. The checkbox is ONLY created if a
-                               //              valid reference was found in the dojo.data store or the attribute 'checkboxAll'
-                               //              is set to true. If the current state is 'undefined' no reference was found and
-                               //              'checkboxAll' is set to false.
-                               //              Note: the attribute 'checkboxAll' is validated by the getCheckboxState function
-                               //              therefore no need to do that here. (see getCheckboxState for details).
-                               //
-                               var currState = this.tree.model.getCheckboxState(this.item);
-                               if (currState !== undefined) {
-                                       this._checkbox = new dijit.form.CheckBox();
-                                       //this._checkbox = dojo.doc.createElement('input');
-                                       this._checkbox.type = 'checkbox';
-                                       this._checkbox.attr('checked', currState);
-                                       domConstruct.place(this._checkbox.domNode, this.expandoNode, 'after');
-                               }
-                       },
-
-                       postCreate: function () {
-                               // summary:
-                               //              Handle the creation of the checkbox after the CheckBoxTreeNode has been instanciated.
-                               // description:
-                               //              Handle the creation of the checkbox after the CheckBoxTreeNode has been instanciated.
-                               this._createCheckbox();
-                               this.inherited(arguments);
-                       }
-
-               });
-});
-
-require(["dojo/_base/declare", "dijit/Tree"], function (declare) {
+define(["dojo/_base/declare", "dijit/Tree", "lib/_CheckBoxTreeNode" ], function (declare) {
 
        return declare( "lib.CheckBoxTree", dijit.Tree,
                {
diff --git a/lib/_CheckBoxTreeNode.js b/lib/_CheckBoxTreeNode.js
new file mode 100644 (file)
index 0000000..4babffe
--- /dev/null
@@ -0,0 +1,42 @@
+define(["dojo/_base/declare", "dojo/dom-construct", "dijit/Tree"], function (declare, domConstruct) {
+
+       return declare("lib._CheckBoxTreeNode", dijit._TreeNode,
+               {
+                       // _checkbox: [protected] dojo.doc.element
+                       //              Local reference to the dojo.doc.element of type 'checkbox'
+                       _checkbox: null,
+
+                       _createCheckbox: function () {
+                               // summary:
+                               //              Create a checkbox on the CheckBoxTreeNode
+                               // description:
+                               //              Create a checkbox on the CheckBoxTreeNode. The checkbox is ONLY created if a
+                               //              valid reference was found in the dojo.data store or the attribute 'checkboxAll'
+                               //              is set to true. If the current state is 'undefined' no reference was found and
+                               //              'checkboxAll' is set to false.
+                               //              Note: the attribute 'checkboxAll' is validated by the getCheckboxState function
+                               //              therefore no need to do that here. (see getCheckboxState for details).
+                               //
+                               var currState = this.tree.model.getCheckboxState(this.item);
+                               if (currState !== undefined) {
+                                       this._checkbox = new dijit.form.CheckBox();
+                                       //this._checkbox = dojo.doc.createElement('input');
+                                       this._checkbox.type = 'checkbox';
+                                       this._checkbox.attr('checked', currState);
+                                       domConstruct.place(this._checkbox.domNode, this.expandoNode, 'after');
+                               }
+                       },
+
+                       postCreate: function () {
+                               // summary:
+                               //              Handle the creation of the checkbox after the CheckBoxTreeNode has been instanciated.
+                               // description:
+                               //              Handle the creation of the checkbox after the CheckBoxTreeNode has been instanciated.
+                               this._createCheckbox();
+                               this.inherited(arguments);
+                       }
+
+               });
+});
+
+