@@ -11,3 +11,7 @@ File.open("#{directory}/../#{filename}", "w") do |file| file << JsminImproved.jsmin(File.read(filename)) end end + +puts "building documentation" + +`rm -rf #{directory}/../docs && cd #{directory}/jsdoc-toolkit && java -jar jsrun.jar app/run.js -t=templates/jsdoc -d=../../docs/ ../../src/` build_tools/build.rb @@ -1,3 +1,6 @@ #!/usr/bin/ruby -puts `rm -rf ../docs && cd jsdoc-toolkit && java -jar jsrun.jar app/run.js -t=templates/jsdoc -d=../../docs/ ../../src/` +directory = File.dirname(__FILE__) +puts "rm -rf #{directory}/../docs && cd #{directory}/jsdoc-toolkit && java -jar jsrun.jar app/run.js -t=templates/jsdoc -d=../../docs/ ../../src/" + +puts `rm -rf #{directory}/../docs && cd #{directory}/jsdoc-toolkit && java -jar jsrun.jar app/run.js -t=templates/jsdoc -d=../../docs/ ../../src/` build_tools/create_documentation.rb @@ -281,7 +281,7 @@ It all starts with the Model. </div> <div class="fineprint" style="clear:both"> - Documentation generated by <a href="http://www.jsdoctoolkit.org/" target="_blankt">JsDoc Toolkit</a> 2.1.0 on Sat Mar 14 2009 19:21:44 GMT-0400 (EDT) + Documentation generated by <a href="http://www.jsdoctoolkit.org/" target="_blankt">JsDoc Toolkit</a> 2.1.0 on Sun Mar 15 2009 12:24:47 GMT-0400 (EDT) </div> </body> </html> \ No newline at end of file docs/files.html @@ -268,7 +268,7 @@ ul.inheritsList </div> <div class="fineprint" style="clear:both"> - Documentation generated by <a href="http://www.jsdoctoolkit.org/" target="_blankt">JsDoc Toolkit</a> 2.1.0 on Sat Mar 14 2009 19:21:44 GMT-0400 (EDT) + Documentation generated by <a href="http://www.jsdoctoolkit.org/" target="_blankt">JsDoc Toolkit</a> 2.1.0 on Sun Mar 15 2009 12:24:47 GMT-0400 (EDT) </div> </body> </html> \ No newline at end of file docs/index.html @@ -317,7 +317,7 @@ ul.inheritsList  <div class="fineprint" style="clear:both"> - Documentation generated by <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a> 2.1.0 on Sat Mar 14 2009 19:21:44 GMT-0400 (EDT) + Documentation generated by <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a> 2.1.0 on Sun Mar 15 2009 12:24:47 GMT-0400 (EDT) </div> </body> </html> docs/symbols/JsController.html @@ -695,7 +695,7 @@ ul.inheritsList  <div class="fineprint" style="clear:both"> - Documentation generated by <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a> 2.1.0 on Sat Mar 14 2009 19:21:44 GMT-0400 (EDT) + Documentation generated by <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a> 2.1.0 on Sun Mar 15 2009 12:24:47 GMT-0400 (EDT) </div> </body> </html> docs/symbols/JsModel#instance.html @@ -1187,7 +1187,7 @@ ul.inheritsList  <div class="fineprint" style="clear:both"> - Documentation generated by <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a> 2.1.0 on Sat Mar 14 2009 19:21:44 GMT-0400 (EDT) + Documentation generated by <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a> 2.1.0 on Sun Mar 15 2009 12:24:47 GMT-0400 (EDT) </div> </body> </html> docs/symbols/JsModel.html @@ -665,7 +665,7 @@ ul.inheritsList  <div class="fineprint" style="clear:both"> - Documentation generated by <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a> 2.1.0 on Sat Mar 14 2009 19:21:44 GMT-0400 (EDT) + Documentation generated by <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a> 2.1.0 on Sun Mar 15 2009 12:24:47 GMT-0400 (EDT) </div> </body> </html> docs/symbols/JsView.html @@ -410,7 +410,11 @@ ul.inheritsList </div> <div class="description"> Controllers allow some decently powerful hooks. You can specify a model, and an - onAfterCreate, onInstanceChange, onInstanceDestroy, onInstanceCreate + onInstanceChange, onInstanceDestroy, onInstanceCreate. + + If your controller listens to a model, but you are not dependent on real-time updates, + you can add the option "looselyCoupled: true" and all updates will be done with + setTimeout, which will be a performance enhancement. </div> @@ -418,6 +422,7 @@ ul.inheritsList <pre class="code"> MBX.DesktopUploadController = MBX.JsController.create("DesktopUpload", { + looselyCoupled: false, // false is the default ANewMethod: function (something) { return something; } @@ -561,7 +566,7 @@ ul.inheritsList  <div class="fineprint" style="clear:both"> - Documentation generated by <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a> 2.1.0 on Sat Mar 14 2009 19:21:44 GMT-0400 (EDT) + Documentation generated by <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a> 2.1.0 on Sun Mar 15 2009 12:24:47 GMT-0400 (EDT) </div> </body> </html> docs/symbols/MBX.JsController.html @@ -522,7 +522,7 @@ ul.inheritsList  <div class="fineprint" style="clear:both"> - Documentation generated by <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a> 2.1.0 on Sat Mar 14 2009 19:21:44 GMT-0400 (EDT) + Documentation generated by <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a> 2.1.0 on Sun Mar 15 2009 12:24:47 GMT-0400 (EDT) </div> </body> </html> docs/symbols/MBX.JsModel.html @@ -439,7 +439,11 @@ ul.inheritsList </div> <div class="description"> create a new view handler... specify a model and some - functions and some great magic happens + functions and some great magic happens. + + If your view listens to a model, but you are not dependent on real-time updates, + you can add the option "looselyCoupled: true" and all updates will be done with + setTimeout, which will be a performance enhancement. </div> @@ -448,6 +452,7 @@ ul.inheritsList <pre class="code"> MBX.JsView.create({ model: MBX.DesktopUpload, + looselyCoupled: false, // false is the default onCreate: function (upload) { //create the upload }, @@ -763,7 +768,7 @@ ul.inheritsList  <div class="fineprint" style="clear:both"> - Documentation generated by <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a> 2.1.0 on Sat Mar 14 2009 19:21:44 GMT-0400 (EDT) + Documentation generated by <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a> 2.1.0 on Sun Mar 15 2009 12:24:47 GMT-0400 (EDT) </div> </body> </html> docs/symbols/MBX.JsView.html @@ -578,7 +578,7 @@ ul.inheritsList  <div class="fineprint" style="clear:both"> - Documentation generated by <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a> 2.1.0 on Sat Mar 14 2009 19:21:44 GMT-0400 (EDT) + Documentation generated by <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a> 2.1.0 on Sun Mar 15 2009 12:24:47 GMT-0400 (EDT) </div> </body> </html> docs/symbols/MBX.Queue.html @@ -258,7 +258,7 @@ ul.inheritsList  <div class="fineprint" style="clear:both"> - Documentation generated by <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a> 2.1.0 on Sat Mar 14 2009 19:21:44 GMT-0400 (EDT) + Documentation generated by <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a> 2.1.0 on Sun Mar 15 2009 12:24:47 GMT-0400 (EDT) </div> </body> </html> docs/symbols/_global_.html @@ -135,107 +135,113 @@ 128 var newEvent = this.model.Event.newInstance; 129 var destroyEvent = this.model.Event.destroyInstance; 130 var attributeEvent = this.model.Event.changeAttribute; -131 -132 this.eventSubscriptions = []; -133 this.eventSubscriptions.push(MBX.EventHandler.subscribe(MBX, changeEvent, this._onInstanceChange.bind(this))); -134 this.eventSubscriptions.push(MBX.EventHandler.subscribe(MBX, newEvent, this._onInstanceCreate.bind(this))); -135 this.eventSubscriptions.push(MBX.EventHandler.subscribe(MBX, destroyEvent, this._onInstanceDestroy.bind(this))); -136 this.eventSubscriptions.push(MBX.EventHandler.subscribe(MBX, attributeEvent, this._onAttributeChange.bind(this))); -137 }, -138 -139 /** -140 @private -141 @requires MBX.JsModel -142 @requires this.model -143 */ -144 _unsubscribeToEvents: function () { -145 if (this.eventSubscriptions && this.eventSubscriptions[0]) { -146 this.eventSubscriptions.each(function (subscription) { -147 MBX.EventHandler.unsubscribe(subscription); -148 }); -149 } -150 } -151 }; -152 -153 /** -154 This is mostly used internally and is fired on MBX everytime a controller is created -155 @memberOf MBX.JsController -156 @name MBX.JsController.Event -157 */ -158 publicObj.Event = { -159 newController: "new_controller", -160 afterRender: "render_finished" -161 }; -162 -163 /** -164 call extend() to add methods and/or attributes to ALL controllers -165 @param {Object} methsAndAttrs -166 @name MBX.JsController.extend -167 @function -168 */ -169 publicObj.extend = function (methsAndAttrs) { -170 methsAndAttrs = methsAndAttrs || {}; -171 Object.extend(JsController.prototype, methsAndAttrs); -172 }; -173 -174 /** -175 Controllers allow some decently powerful hooks. You can specify a model, and an -176 onAfterCreate, onInstanceChange, onInstanceDestroy, onInstanceCreate -177 -178 @name MBX.JsController.create -179 @param {String} name the name of the controller -180 @param {Object} opts used to extend the controller methods at instantiation -181 @see JsController -182 @function -183 @example -184 MBX.DesktopUploadController = MBX.JsController.create("DesktopUpload", { -185 ANewMethod: function (something) { -186 return something; -187 } -188 }) -189 MBX.DesktopUpload.ANewMethod("boo") == "boo"; -190 @example -191 MBX.DesktopUploadController = MBX.JsController.create("DesktopUpload", { -192 model: MBX.DesktopUpload, -193 onInstanceCreate: function (instance) { -194 alert(instance.get('greeting')); -195 } -196 }); -197 MBX.DesktopUpload.create({ greeting: 'hi' }); // will alert('hi'); -198 @example -199 MBX.DesktopUploadController = MBX.JsController.create("DesktopUpload", { -200 model: MBX.DesktopUpload, -201 onInstanceChange: function (instance) { -202 alert(instance.get('greeting')); -203 } -204 }); -205 var instance = MBX.DesktopUpload.create(); -206 instance.set('greeting', 'hi'); // will alert('hi') -207 */ -208 publicObj.create = function (name, opts) { -209 if (controllerCache[name]) { -210 throw new Error("A controller with the name of " + name + " is already in use"); -211 } -212 var controller = new JsController(name, opts); -213 if (typeof controller.afterCreate == "function") { -214 controller.afterCreate(); -215 } -216 return controller; -217 }; -218 -219 /** -220 Destroy a controller and unsubscribe its event listeners -221 @param {String} name the name of the controller -222 @name MBX.JsController.destroyController -223 @function -224 */ -225 publicObj.destroyController = function (name) { -226 if (controllerCache[name]) { -227 controllerCache[name]._unsubscribeToEvents(); -228 delete controllerCache[name]; -229 } -230 }; -231 -232 return publicObj; -233 })(); -234 </pre></body></html> \ No newline at end of file +131 var defer = this.looselyCoupled; +132 +133 this.eventSubscriptions = []; +134 this.eventSubscriptions.push(MBX.EventHandler.subscribe(MBX, changeEvent, this._onInstanceChange.bind(this), {defer: defer})); +135 this.eventSubscriptions.push(MBX.EventHandler.subscribe(MBX, newEvent, this._onInstanceCreate.bind(this), {defer: defer})); +136 this.eventSubscriptions.push(MBX.EventHandler.subscribe(MBX, destroyEvent, this._onInstanceDestroy.bind(this), {defer: defer})); +137 this.eventSubscriptions.push(MBX.EventHandler.subscribe(MBX, attributeEvent, this._onAttributeChange.bind(this), {defer: defer})); +138 }, +139 +140 /** +141 @private +142 @requires MBX.JsModel +143 @requires this.model +144 */ +145 _unsubscribeToEvents: function () { +146 if (this.eventSubscriptions && this.eventSubscriptions[0]) { +147 this.eventSubscriptions.each(function (subscription) { +148 MBX.EventHandler.unsubscribe(subscription); +149 }); +150 } +151 } +152 }; +153 +154 /** +155 This is mostly used internally and is fired on MBX everytime a controller is created +156 @memberOf MBX.JsController +157 @name MBX.JsController.Event +158 */ +159 publicObj.Event = { +160 newController: "new_controller", +161 afterRender: "render_finished" +162 }; +163 +164 /** +165 call extend() to add methods and/or attributes to ALL controllers +166 @param {Object} methsAndAttrs +167 @name MBX.JsController.extend +168 @function +169 */ +170 publicObj.extend = function (methsAndAttrs) { +171 methsAndAttrs = methsAndAttrs || {}; +172 Object.extend(JsController.prototype, methsAndAttrs); +173 }; +174 +175 /** +176 Controllers allow some decently powerful hooks. You can specify a model, and an +177 onInstanceChange, onInstanceDestroy, onInstanceCreate. +178 +179 If your controller listens to a model, but you are not dependent on real-time updates, +180 you can add the option "looselyCoupled: true" and all updates will be done with +181 setTimeout, which will be a performance enhancement. +182 +183 @name MBX.JsController.create +184 @param {String} name the name of the controller +185 @param {Object} opts used to extend the controller methods at instantiation +186 @see JsController +187 @function +188 @example +189 MBX.DesktopUploadController = MBX.JsController.create("DesktopUpload", { +190 looselyCoupled: false, // false is the default +191 ANewMethod: function (something) { +192 return something; +193 } +194 }) +195 MBX.DesktopUpload.ANewMethod("boo") == "boo"; +196 @example +197 MBX.DesktopUploadController = MBX.JsController.create("DesktopUpload", { +198 model: MBX.DesktopUpload, +199 onInstanceCreate: function (instance) { +200 alert(instance.get('greeting')); +201 } +202 }); +203 MBX.DesktopUpload.create({ greeting: 'hi' }); // will alert('hi'); +204 @example +205 MBX.DesktopUploadController = MBX.JsController.create("DesktopUpload", { +206 model: MBX.DesktopUpload, +207 onInstanceChange: function (instance) { +208 alert(instance.get('greeting')); +209 } +210 }); +211 var instance = MBX.DesktopUpload.create(); +212 instance.set('greeting', 'hi'); // will alert('hi') +213 */ +214 publicObj.create = function (name, opts) { +215 if (controllerCache[name]) { +216 throw new Error("A controller with the name of " + name + " is already in use"); +217 } +218 var controller = new JsController(name, opts); +219 if (typeof controller.initialize == "function") { +220 controller.initialize(); +221 } +222 return controller; +223 }; +224 +225 /** +226 Destroy a controller and unsubscribe its event listeners +227 @param {String} name the name of the controller +228 @name MBX.JsController.destroyController +229 @function +230 */ +231 publicObj.destroyController = function (name) { +232 if (controllerCache[name]) { +233 controllerCache[name]._unsubscribeToEvents(); +234 delete controllerCache[name]; +235 } +236 }; +237 +238 return publicObj; +239 })(); +240 </pre></body></html> \ No newline at end of file docs/symbols/src/src_js_controller.js.html @@ -76,8 +76,8 @@ 69 this._subscribeToEvents(); 70 } 71 - 72 if (typeof this.afterCreate == 'function') { - 73 this.afterCreate(); + 72 if (typeof this.initialize == 'function') { + 73 this.initialize(); 74 } 75 }; 76 @@ -143,178 +143,185 @@ 136 var newEvent = this.model.Event.newInstance; 137 var destroyEvent = this.model.Event.destroyInstance; 138 var attributeEvent = this.model.Event.changeAttribute; -139 -140 this.eventSubscriptions = []; -141 this.eventSubscriptions.push(MBX.EventHandler.subscribe(MBX, changeEvent, this._onInstanceChange.bind(this))); -142 this.eventSubscriptions.push(MBX.EventHandler.subscribe(MBX, newEvent, this._onInstanceCreate.bind(this))); -143 this.eventSubscriptions.push(MBX.EventHandler.subscribe(MBX, destroyEvent, this._onInstanceDestroy.bind(this))); -144 this.eventSubscriptions.push(MBX.EventHandler.subscribe(MBX, attributeEvent, this._onAttributeChange.bind(this))); -145 }, -146 -147 /** return the CSS class for the model associated with this view -148 @param {String} prePend any string to prepend to the model -149 @see MBX.JsView.modelCSS -150 */ -151 modelCSS: function (prePend) { -152 return MBX.JsView.modelCSS(this.model, prePend); -153 }, -154 -155 /** given an instance of a model, give the recommended instance class -156 @see MBX.JsView.cssForInstance -157 */ -158 cssForInstance: function (instance, prePend) { -159 return MBX.JsView.cssForInstance(instance, prePend); -160 }, -161 -162 /** given an instance, return the relevent elements -163 @param {JsModel#instance} instance the instance you want to find elements -164 @returns {Array} an array of extended dom elements that match the relevent class names -165 */ -166 elementsFromInstance: function (instance) { -167 return $$(this.modelCSS(".") + " " + cssForInstance(".")); -168 }, -169 -170 /** return all the various collections of dom elements that have the appropriate classes -171 @returns {Array} array of extended dom elements that match collection CSS -172 */ -173 domCollections: function () { -174 var findString = [jsElementClass, this.modelCSS("."), '.collection'].join(''); -175 return $$(findString); -176 } -177 -178 }; -179 -180 /** create a new view handler... specify a model and some -181 functions and some great magic happens -182 @name MBX.JsView.create -183 @function -184 @param {Object} opts the various options specified for a view -185 @example -186 MBX.JsView.create({ -187 model: MBX.DesktopUpload, -188 onCreate: function (upload) { -189 //create the upload -190 }, -191 onChange: function (upload) { -192 // any upload changes -193 }, -194 onDestroy: function (upload) { -195 // handle destroys -196 } -197 }); -198 */ -199 self.create = function (opts) { -200 return new View(opts); -201 }; -202 -203 /** -204 call extend() to add methods and/or attributes to ALL views -205 @param {Object} methsAndAttrs -206 @name MBX.JsView.extend -207 @function -208 */ -209 self.extend = function (methsAndAttrs) { -210 methsAndAttrs = methsAndAttrs || {}; -211 Object.extend(View.prototype, methsAndAttrs); -212 }; -213 -214 /** Added to prototype elements when a view is created -215 allows you to observe particular keys of a model object -216 @name MBX.JsView.updatesOn -217 @function -218 @param {JsModel#instance} obj the model instance to watch -219 @param {String} key the key to watch -220 @param {Object} opts handler or preProcess functions to execute -221 @returns {DOM element} the dom element that was called (for chaining) -222 */ -223 self.updatesOn = function (element, obj, key, opts) { -224 if (!obj || !key) { -225 throw new Error("You must specify a key or an object with updatesOn"); -226 } -227 element = $(element); -228 opts = opts || {}; -229 -230 var changeHandler = function (evt) { -231 var content = obj.get(key); -232 if (opts.preProcess) { -233 content = opts.preProcess(obj, content, key); -234 } -235 if (opts.handler) { -236 opts.handler(obj, element, content); -237 } else { -238 element.update(content); -239 } -240 }; -241 -242 var sub = MBX.EventHandler.subscribe(obj, key + "_changed", changeHandler); -243 -244 element.__JsViewSubscriptions = element.__JsViewSubscriptions || []; -245 element.__JsViewSubscriptions.push(sub); -246 -247 obj.__JsViewSubscriptions = obj.__JsViewSubscriptions || []; -248 obj.__JsViewSubscriptions.push(sub); -249 -250 if (opts.updateNow) { -251 changeHandler(); -252 } +139 var defer = this.looselyCoupled; +140 +141 this.eventSubscriptions = []; +142 this.eventSubscriptions.push(MBX.EventHandler.subscribe(MBX, changeEvent, this._onInstanceChange.bind(this), {defer: defer})); +143 this.eventSubscriptions.push(MBX.EventHandler.subscribe(MBX, newEvent, this._onInstanceCreate.bind(this), {defer: defer})); +144 this.eventSubscriptions.push(MBX.EventHandler.subscribe(MBX, destroyEvent, this._onInstanceDestroy.bind(this), {defer: defer})); +145 this.eventSubscriptions.push(MBX.EventHandler.subscribe(MBX, attributeEvent, this._onAttributeChange.bind(this), {defer: defer})); +146 }, +147 +148 /** return the CSS class for the model associated with this view +149 @param {String} prePend any string to prepend to the model +150 @see MBX.JsView.modelCSS +151 */ +152 modelCSS: function (prePend) { +153 return MBX.JsView.modelCSS(this.model, prePend); +154 }, +155 +156 /** given an instance of a model, give the recommended instance class +157 @see MBX.JsView.cssForInstance +158 */ +159 cssForInstance: function (instance, prePend) { +160 return MBX.JsView.cssForInstance(instance, prePend); +161 }, +162 +163 /** given an instance, return the relevent elements +164 @param {JsModel#instance} instance the instance you want to find elements +165 @returns {Array} an array of extended dom elements that match the relevent class names +166 */ +167 elementsFromInstance: function (instance) { +168 return $$(this.modelCSS(".") + " " + cssForInstance(".")); +169 }, +170 +171 /** return all the various collections of dom elements that have the appropriate classes +172 @returns {Array} array of extended dom elements that match collection CSS +173 */ +174 domCollections: function () { +175 var findString = [jsElementClass, this.modelCSS("."), '.collection'].join(''); +176 return $$(findString); +177 } +178 +179 }; +180 +181 /** create a new view handler... specify a model and some +182 functions and some great magic happens. +183 +184 If your view listens to a model, but you are not dependent on real-time updates, +185 you can add the option "looselyCoupled: true" and all updates will be done with +186 setTimeout, which will be a performance enhancement. +187 +188 @name MBX.JsView.create +189 @function +190 @param {Object} opts the various options specified for a view +191 @example +192 MBX.JsView.create({ +193 model: MBX.DesktopUpload, +194 looselyCoupled: false, // false is the default +195 onCreate: function (upload) { +196 //create the upload +197 }, +198 onChange: function (upload) { +199 // any upload changes +200 }, +201 onDestroy: function (upload) { +202 // handle destroys +203 } +204 }); +205 */ +206 self.create = function (opts) { +207 return new View(opts); +208 }; +209 +210 /** +211 call extend() to add methods and/or attributes to ALL views +212 @param {Object} methsAndAttrs +213 @name MBX.JsView.extend +214 @function +215 */ +216 self.extend = function (methsAndAttrs) { +217 methsAndAttrs = methsAndAttrs || {}; +218 Object.extend(View.prototype, methsAndAttrs); +219 }; +220 +221 /** Added to prototype elements when a view is created +222 allows you to observe particular keys of a model object +223 @name MBX.JsView.updatesOn +224 @function +225 @param {JsModel#instance} obj the model instance to watch +226 @param {String} key the key to watch +227 @param {Object} opts handler or preProcess functions to execute +228 @returns {DOM element} the dom element that was called (for chaining) +229 */ +230 self.updatesOn = function (element, obj, key, opts) { +231 if (!obj || !key) { +232 throw new Error("You must specify a key or an object with updatesOn"); +233 } +234 element = $(element); +235 opts = opts || {}; +236 +237 var changeHandler = function (evt) { +238 var content = obj.get(key); +239 if (opts.preProcess) { +240 content = opts.preProcess(obj, content, key); +241 } +242 if (opts.handler) { +243 opts.handler(obj, element, content); +244 } else { +245 element.update(content); +246 } +247 }; +248 +249 var sub = MBX.EventHandler.subscribe(obj, key + "_changed", changeHandler); +250 +251 element.__JsViewSubscriptions = element.__JsViewSubscriptions || []; +252 element.__JsViewSubscriptions.push(sub); 253 -254 return element; -255 }; -256 -257 /** stop updating this instance, all event handlers are removed -258 Preferred method of accessing this function is through extended elements -259 @name MBX.JsView.stopUpdating -260 @function -261 @param {DOM Element} element the element to stop observing - this will usually be filled for you by prototype -262 @returns {DOM Element} element for chaining -263 @example -264 $("el").stopUpdating(); -265 */ -266 self.stopUpdating = function (element) { -267 element = $(element); -268 if (element.__JsViewSubscriptions) { -269 while (element.__JsViewSubscriptions.length > 0) { -270 MBX.EventHandler.unsubscribe(element.__JsViewSubscriptions.pop()); -271 } -272 } -273 return element; -274 }; -275 -276 /** attach a JsModel#instance to this DOM element -277 Preferred method of accessing this function is through extended elements -278 @name MBX.JsView.assignInstance -279 @function -280 @example -281 $("el").assignInstance(instance); -282 $("el").getInstance(); // == instance -283 */ -284 self.assignInstance = function (element, instance) { -285 element = $(element); -286 element.__JsViewMvcInstance = instance; -287 element.addClassName(MBX.JsView.modelCSS(instance.parentClass)); -288 element.addClassName(MBX.JsView.cssForInstance(instance)); -289 return element; -290 }; -291 -292 /** fetch a JsModel#instance from this DOM element -293 Preferred method of accessing this function is through extended elements -294 @name MBX.JsView.getInstance -295 @function -296 @example -297 $("el").assignInstance(instance); -298 $("el").getInstance(); // == instance -299 */ -300 self.getInstance = function (element, instance) { -301 return element.__JsViewMvcInstance; -302 }; -303 -304 Element.addMethods({ -305 updatesOn: self.updatesOn, -306 stopUpdating: self.stopUpdating, -307 assignInstance: self.assignInstance, -308 getInstance: self.getInstance -309 }); +254 obj.__JsViewSubscriptions = obj.__JsViewSubscriptions || []; +255 obj.__JsViewSubscriptions.push(sub); +256 +257 if (opts.updateNow) { +258 changeHandler(); +259 } +260 +261 return element; +262 }; +263 +264 /** stop updating this instance, all event handlers are removed +265 Preferred method of accessing this function is through extended elements +266 @name MBX.JsView.stopUpdating +267 @function +268 @param {DOM Element} element the element to stop observing - this will usually be filled for you by prototype +269 @returns {DOM Element} element for chaining +270 @example +271 $("el").stopUpdating(); +272 */ +273 self.stopUpdating = function (element) { +274 element = $(element); +275 if (element.__JsViewSubscriptions) { +276 while (element.__JsViewSubscriptions.length > 0) { +277 MBX.EventHandler.unsubscribe(element.__JsViewSubscriptions.pop()); +278 } +279 } +280 return element; +281 }; +282 +283 /** attach a JsModel#instance to this DOM element +284 Preferred method of accessing this function is through extended elements +285 @name MBX.JsView.assignInstance +286 @function +287 @example +288 $("el").assignInstance(instance); +289 $("el").getInstance(); // == instance +290 */ +291 self.assignInstance = function (element, instance) { +292 element = $(element); +293 element.__JsViewMvcInstance = instance; +294 element.addClassName(MBX.JsView.modelCSS(instance.parentClass)); +295 element.addClassName(MBX.JsView.cssForInstance(instance)); +296 return element; +297 }; +298 +299 /** fetch a JsModel#instance from this DOM element +300 Preferred method of accessing this function is through extended elements +301 @name MBX.JsView.getInstance +302 @function +303 @example +304 $("el").assignInstance(instance); +305 $("el").getInstance(); // == instance +306 */ +307 self.getInstance = function (element, instance) { +308 return element.__JsViewMvcInstance; +309 }; 310 -311 return self; -312 })(); -313 </pre></body></html> \ No newline at end of file +311 Element.addMethods({ +312 updatesOn: self.updatesOn, +313 stopUpdating: self.stopUpdating, +314 assignInstance: self.assignInstance, +315 getInstance: self.getInstance +316 }); +317 +318 return self; +319 })(); +320 </pre></body></html> \ No newline at end of file docs/symbols/src/src_js_view.js.html @@ -3,8 +3,8 @@ if(!("MBX"in window)){MBX={};} MBX.JsController=(function(){var publicObj={};var controllerCache={};var jsElementClass='.js_updateable';JsController=function(name,opts){opts=opts||{};if(!name){throw new Error("A name must be specified");} if(controllerCache[name]){throw new Error("A controller by that name exists");} this.controllerName=name;Object.extend(this,opts);if(opts.model){this._subscribeToEvents();} -controllerCache[name]=this;MBX.EventHandler.fireCustom(MBX,publicObj.Event.newController,{object:this});};JsController.prototype={_onInstanceChange:function(evt){if(this.onInstanceChange){this.onInstanceChange(evt.object,evt.key);}},_onInstanceCreate:function(evt){if(this.onInstanceCreate){this.onInstanceCreate(evt.object);}},fireAfterRender:function(){MBX.EventHandler.fireCustom(MBX,this.controllerName+"_"+MBX.JsController.Event.afterRender);},_onInstanceDestroy:function(evt){if(this.onInstanceDestroy){this.onInstanceDestroy(evt.object);}},_onAttributeChange:function(evt){if(typeof this.onAttributeChange=='function'){this.onAttributeChange(evt.key);}},_subscribeToEvents:function(){var changeEvent=this.model.Event.changeInstance;var newEvent=this.model.Event.newInstance;var destroyEvent=this.model.Event.destroyInstance;var attributeEvent=this.model.Event.changeAttribute;var defer=this.loosleyCoupled;this.eventSubscriptions=[];this.eventSubscriptions.push(MBX.EventHandler.subscribe(MBX,changeEvent,this._onInstanceChange.bind(this),{defer:defer}));this.eventSubscriptions.push(MBX.EventHandler.subscribe(MBX,newEvent,this._onInstanceCreate.bind(this),{defer:defer}));this.eventSubscriptions.push(MBX.EventHandler.subscribe(MBX,destroyEvent,this._onInstanceDestroy.bind(this),{defer:defer}));this.eventSubscriptions.push(MBX.EventHandler.subscribe(MBX,attributeEvent,this._onAttributeChange.bind(this),{defer:defer}));},_unsubscribeToEvents:function(){if(this.eventSubscriptions&&this.eventSubscriptions[0]){this.eventSubscriptions.each(function(subscription){MBX.EventHandler.unsubscribe(subscription);});}}};publicObj.Event={newController:"new_controller",afterRender:"render_finished"};publicObj.extend=function(methsAndAttrs){methsAndAttrs=methsAndAttrs||{};Object.extend(JsController.prototype,methsAndAttrs);};publicObj.create=function(name,opts){if(controllerCache[name]){throw new Error("A controller with the name of "+name+" is already in use");} -var controller=new JsController(name,opts);if(typeof controller.afterCreate=="function"){controller.afterCreate();} +controllerCache[name]=this;MBX.EventHandler.fireCustom(MBX,publicObj.Event.newController,{object:this});};JsController.prototype={_onInstanceChange:function(evt){if(this.onInstanceChange){this.onInstanceChange(evt.object,evt.key);}},_onInstanceCreate:function(evt){if(this.onInstanceCreate){this.onInstanceCreate(evt.object);}},fireAfterRender:function(){MBX.EventHandler.fireCustom(MBX,this.controllerName+"_"+MBX.JsController.Event.afterRender);},_onInstanceDestroy:function(evt){if(this.onInstanceDestroy){this.onInstanceDestroy(evt.object);}},_onAttributeChange:function(evt){if(typeof this.onAttributeChange=='function'){this.onAttributeChange(evt.key);}},_subscribeToEvents:function(){var changeEvent=this.model.Event.changeInstance;var newEvent=this.model.Event.newInstance;var destroyEvent=this.model.Event.destroyInstance;var attributeEvent=this.model.Event.changeAttribute;var defer=this.looselyCoupled;this.eventSubscriptions=[];this.eventSubscriptions.push(MBX.EventHandler.subscribe(MBX,changeEvent,this._onInstanceChange.bind(this),{defer:defer}));this.eventSubscriptions.push(MBX.EventHandler.subscribe(MBX,newEvent,this._onInstanceCreate.bind(this),{defer:defer}));this.eventSubscriptions.push(MBX.EventHandler.subscribe(MBX,destroyEvent,this._onInstanceDestroy.bind(this),{defer:defer}));this.eventSubscriptions.push(MBX.EventHandler.subscribe(MBX,attributeEvent,this._onAttributeChange.bind(this),{defer:defer}));},_unsubscribeToEvents:function(){if(this.eventSubscriptions&&this.eventSubscriptions[0]){this.eventSubscriptions.each(function(subscription){MBX.EventHandler.unsubscribe(subscription);});}}};publicObj.Event={newController:"new_controller",afterRender:"render_finished"};publicObj.extend=function(methsAndAttrs){methsAndAttrs=methsAndAttrs||{};Object.extend(JsController.prototype,methsAndAttrs);};publicObj.create=function(name,opts){if(controllerCache[name]){throw new Error("A controller with the name of "+name+" is already in use");} +var controller=new JsController(name,opts);if(typeof controller.initialize=="function"){controller.initialize();} return controller;};publicObj.destroyController=function(name){if(controllerCache[name]){controllerCache[name]._unsubscribeToEvents();delete controllerCache[name];}};return publicObj;})(); if(!("MBX"in window)){MBX={};} MBX.Constructor=function(o){function F(){} @@ -23,7 +23,7 @@ return true;},extendInstances:function(attrs){attrs=attrs||{};Object.extend(this this.attributes[key]=value;if(changed){MBX.EventHandler.fireCustom(MBX,this.Event.changeAttribute,{object:this,key:key});MBX.EventHandler.fireCustom(this,key+"_changed");}},get:function(key){return this.attributes[key];},onInstanceCreate:function(func){return MBX.EventHandler.subscribe(MBX,this.Event.newInstance,func);},onInstanceDestroy:function(func){return MBX.EventHandler.subscribe(MBX,this.Event.destroyInstance,func);},onInstanceChange:function(func){return MBX.EventHandler.subscribe(MBX,this.Event.changeInstance,func);}};publicObj.Event={newModel:"new_model"};publicObj.create=function(name,opts){return new JsModel(name,opts);};publicObj.nextGUID=function(){return currentGUID++;};publicObj.extend=function(methsAndAttrs){methsAndAttrs=methsAndAttrs||{};Object.extend(JsModel.prototype,methsAndAttrs);};publicObj.extendInstancePrototype=function(methsAndAttrs){Object.extend(oneJsModelInstance,methsAndAttrs);};publicObj.destroyModel=function(name){delete modelCache[name];};return publicObj;})(); if(!("MBX"in window)){MBX={};} MBX.JsView=(function(){var self={};var jsElementClass='.js_updateable';self.modelCSS=function(model,prePend){prePend=prePend||"";return prePend+model.modelName.toLowerCase();};self.cssForInstance=function(instance,prePend){prePend=prePend||"";return prePend+self.modelCSS(instance.parentClass)+"_"+instance.primaryKey().toLowerCase().gsub(/[^\w\-]/,"_");};var View=function(opts){opts=opts||{};Object.extend(this,opts);if(this.model){this._subscribeToEvents();} -if(typeof this.afterCreate=='function'){this.afterCreate();}};View.prototype={div:function(className,opts){opts=opts||{};Object.extend(opts,{className:className});return new Element('div',opts);},imageTag:function(src,opts){opts=opts||{};Object.extend(opts,{src:src});return new Element("img",opts);},_onInstanceChange:function(evt){if(typeof this.onInstanceChange=='function'){this.onInstanceChange(evt.object,evt.key);}},_onInstanceCreate:function(evt){if(typeof this.onInstanceCreate=='function'){this.onInstanceCreate(evt.object);}},_onInstanceDestroy:function(evt){if(typeof this.onInstanceDestroy=='function'){this.onInstanceDestroy(evt.object);}},_onAttributeChange:function(evt){if(typeof this.onAttributeChange=='function'){this.onAttributeChange(evt.key);}},_subscribeToEvents:function(){var changeEvent=this.model.Event.changeInstance;var newEvent=this.model.Event.newInstance;var destroyEvent=this.model.Event.destroyInstance;var attributeEvent=this.model.Event.changeAttribute;var defer=this.looselyCoupled;this.eventSubscriptions=[];this.eventSubscriptions.push(MBX.EventHandler.subscribe(MBX,changeEvent,this._onInstanceChange.bind(this),{defer:defer}));this.eventSubscriptions.push(MBX.EventHandler.subscribe(MBX,newEvent,this._onInstanceCreate.bind(this),{defer:defer}));this.eventSubscriptions.push(MBX.EventHandler.subscribe(MBX,destroyEvent,this._onInstanceDestroy.bind(this),{defer:defer}));this.eventSubscriptions.push(MBX.EventHandler.subscribe(MBX,attributeEvent,this._onAttributeChange.bind(this),{defer:defer}));},modelCSS:function(prePend){return MBX.JsView.modelCSS(this.model,prePend);},cssForInstance:function(instance,prePend){return MBX.JsView.cssForInstance(instance,prePend);},elementsFromInstance:function(instance){return $$(this.modelCSS(".")+" "+cssForInstance("."));},domCollections:function(){var findString=[jsElementClass,this.modelCSS("."),'.collection'].join('');return $$(findString);}};self.create=function(opts){return new View(opts);};self.extend=function(methsAndAttrs){methsAndAttrs=methsAndAttrs||{};Object.extend(View.prototype,methsAndAttrs);};self.updatesOn=function(element,obj,key,opts){if(!obj||!key){throw new Error("You must specify a key or an object with updatesOn");} +if(typeof this.initialize=='function'){this.initialize();}};View.prototype={div:function(className,opts){opts=opts||{};Object.extend(opts,{className:className});return new Element('div',opts);},imageTag:function(src,opts){opts=opts||{};Object.extend(opts,{src:src});return new Element("img",opts);},_onInstanceChange:function(evt){if(typeof this.onInstanceChange=='function'){this.onInstanceChange(evt.object,evt.key);}},_onInstanceCreate:function(evt){if(typeof this.onInstanceCreate=='function'){this.onInstanceCreate(evt.object);}},_onInstanceDestroy:function(evt){if(typeof this.onInstanceDestroy=='function'){this.onInstanceDestroy(evt.object);}},_onAttributeChange:function(evt){if(typeof this.onAttributeChange=='function'){this.onAttributeChange(evt.key);}},_subscribeToEvents:function(){var changeEvent=this.model.Event.changeInstance;var newEvent=this.model.Event.newInstance;var destroyEvent=this.model.Event.destroyInstance;var attributeEvent=this.model.Event.changeAttribute;var defer=this.looselyCoupled;this.eventSubscriptions=[];this.eventSubscriptions.push(MBX.EventHandler.subscribe(MBX,changeEvent,this._onInstanceChange.bind(this),{defer:defer}));this.eventSubscriptions.push(MBX.EventHandler.subscribe(MBX,newEvent,this._onInstanceCreate.bind(this),{defer:defer}));this.eventSubscriptions.push(MBX.EventHandler.subscribe(MBX,destroyEvent,this._onInstanceDestroy.bind(this),{defer:defer}));this.eventSubscriptions.push(MBX.EventHandler.subscribe(MBX,attributeEvent,this._onAttributeChange.bind(this),{defer:defer}));},modelCSS:function(prePend){return MBX.JsView.modelCSS(this.model,prePend);},cssForInstance:function(instance,prePend){return MBX.JsView.cssForInstance(instance,prePend);},elementsFromInstance:function(instance){return $$(this.modelCSS(".")+" "+cssForInstance("."));},domCollections:function(){var findString=[jsElementClass,this.modelCSS("."),'.collection'].join('');return $$(findString);}};self.create=function(opts){return new View(opts);};self.extend=function(methsAndAttrs){methsAndAttrs=methsAndAttrs||{};Object.extend(View.prototype,methsAndAttrs);};self.updatesOn=function(element,obj,key,opts){if(!obj||!key){throw new Error("You must specify a key or an object with updatesOn");} element=$(element);opts=opts||{};var changeHandler=function(evt){var content=obj.get(key);if(opts.preProcess){content=opts.preProcess(obj,content,key);} if(opts.handler){opts.handler(obj,element,content);}else{element.update(content);}};var sub=MBX.EventHandler.subscribe(obj,key+"_changed",changeHandler);element.__JsViewSubscriptions=element.__JsViewSubscriptions||[];element.__JsViewSubscriptions.push(sub);obj.__JsViewSubscriptions=obj.__JsViewSubscriptions||[];obj.__JsViewSubscriptions.push(sub);if(opts.updateNow){changeHandler();} return element;};self.stopUpdating=function(element){element=$(element);if(element.__JsViewSubscriptions){while(element.__JsViewSubscriptions.length>0){MBX.EventHandler.unsubscribe(element.__JsViewSubscriptions.pop());}} mamoo_min.js 86417e6d8cf05b640a503016caf1ce94cf40c17e topper topper@toppingdesign.com http://github.com/tobowers/mamoo/commit/42759f886436161bdce26088631ec23358693516 42759f886436161bdce26088631ec23358693516

2009-03-15T09:25:09-07:00

rebuild based on last changes 5d67805ae796d9b46cc072facfa669352919db2e topper topper@toppingdesign.com