Deluge.Events is a singleton that components of the UI can use to fire global events
+ * @singleton + * Class for holding global events that occur within the UI. + */ + Events = Ext.extend(Ext.util.Observable, { + constructor: function() { this.toRegister = []; this.on('login', this.onLogin, this); - Events.superclass.constructor.call(this); - }, - - addListener: function(eventName, fn, scope, o) { - this.addEvents(eventName); + Events.superclass.constructor.call(this); + }, + + /** + * Append an event handler to this object. + */ + addListener: function(eventName, fn, scope, o) { + this.addEvents(eventName); if (/[A-Z]/.test(eventName.substring(0, 1))) { if (!Deluge.Client) { this.toRegister.push(eventName); @@ -55,8 +57,8 @@ Copyright: Deluge.Client.web.register_event_listener(eventName); } } - Events.superclass.addListener.call(this, eventName, fn, scope, o); - }, + Events.superclass.addListener.call(this, eventName, fn, scope, o); + }, poll: function() { Deluge.Client.web.get_events({ @@ -65,6 +67,9 @@ Copyright: }); }, + /** + * Starts the EventsManager checking for events. + */ start: function() { Ext.each(this.toRegister, function(eventName) { Deluge.Client.web.register_event_listener(eventName); @@ -74,18 +79,23 @@ Copyright: this.poll(); }, + /** + * Stops the EventsManager checking for events. + */ stop: function() { if (this.running) { clearInterval(this.running); } }, + // private onLogin: function() { this.start(); this.on('PluginEnabledEvent', this.onPluginEnabled, this); this.on('PluginDisabledEvent', this.onPluginDisabled, this); }, + // private onPollSuccess: function(events) { if (!events) return; Ext.each(events, function(event) { @@ -94,8 +104,18 @@ Copyright: this.fireEvent.apply(this, args); }, this); } - }); - Events.prototype.on = Events.prototype.addListener - Events.prototype.fire = Events.prototype.fireEvent - Deluge.Events = new Events(); + }); + + /** + * Appends an event handler to this object (shorthand for {@link #addListener}) + * @method + */ + Events.prototype.on = Events.prototype.addListener + + /** + * Fires the specified event with the passed parameters (minus the event name). + * @method + */ + Events.prototype.fire = Events.prototype.fireEvent + Deluge.Events = new Events(); })(); diff --git a/deluge/ui/web/js/deluge-all/Deluge.Formatters.js b/deluge/ui/web/js/deluge-all/Deluge.Formatters.js index 6a64f0c17..aebb3bee2 100644 --- a/deluge/ui/web/js/deluge-all/Deluge.Formatters.js +++ b/deluge/ui/web/js/deluge-all/Deluge.Formatters.js @@ -32,16 +32,19 @@ Copyright: */ /** - * @description A collection of functions for string formatting values. - * @namespace Deluge.Formatters + * A collection of functions for string formatting values. + * @class Deluge.Formatters + * @author Damien Churchill['queue', 'name', 'total_size', 'state', 'progress', 'num_seeds', + * 'total_seeds', 'num_peers', 'total_peers', 'download_payload_rate', + * 'upload_payload_rate', 'eta', 'ratio', 'distributed_copies', + * 'is_auto_managed', 'time_added', 'tracker_host']*/ Grid: [ 'queue', 'name', 'total_size', 'state', 'progress', 'num_seeds', @@ -47,10 +53,12 @@ Deluge.Keys = { ], /** - * @description Keys used in the status tab of the statistics panel. - * These get extended - * by {@link Deluge.Keys.Grid}. - * @static + * Keys used in the status tab of the statistics panel. + * These get updated to include the keys in {@link #Grid}. + *
['total_done', 'total_payload_download', 'total_uploaded', + * 'total_payload_upload', 'next_announce', 'tracker_status', 'num_pieces', + * 'piece_length', 'is_auto_managed', 'active_time', 'seeding_time', + * 'seed_rank']*/ Status: [ 'total_done', 'total_payload_download', 'total_uploaded', @@ -60,8 +68,7 @@ Deluge.Keys = { ], /** - * @static - * @description Keys used in the files tab of the statistics panel. + * Keys used in the files tab of the statistics panel. *
['files', 'file_progress', 'file_priorities']*/ Files: [ @@ -69,17 +76,15 @@ Deluge.Keys = { ], /** - * @description Keys used in the peers tab of the statistics panel. + * Keys used in the peers tab of the statistics panel. *
['peers']- * @static */ Peers: [ 'peers' ], /** - * @description Keys used in the details tab of the statistics panel. - * @static + * Keys used in the details tab of the statistics panel. */ Details: [ 'name', 'save_path', 'total_size', 'num_files', 'tracker_status', @@ -87,8 +92,7 @@ Deluge.Keys = { ], /** - * @static - * @description Keys used in the options tab of the statistics panel. + * Keys used in the options tab of the statistics panel. *
['max_download_speed', 'max_upload_speed', 'max_connections', 'max_upload_slots', * 'is_auto_managed', 'stop_at_ratio', 'stop_ratio', 'remove_at_ratio', 'private', * 'prioritize_first_last']diff --git a/deluge/ui/web/js/deluge-all/Deluge.MultiOptionsManager.js b/deluge/ui/web/js/deluge-all/Deluge.MultiOptionsManager.js index 627fe7864..96f6e8b00 100644 --- a/deluge/ui/web/js/deluge-all/Deluge.MultiOptionsManager.js +++ b/deluge/ui/web/js/deluge-all/Deluge.MultiOptionsManager.js @@ -35,6 +35,7 @@ Copyright: * @description A class that can be used to manage options throughout the ui. * @namespace Deluge * @class Deluge.MultiOptionsManager + * @extends Deluge.OptionsManager */ Deluge.MultiOptionsManager = Ext.extend(Deluge.OptionsManager, { @@ -73,7 +74,7 @@ Deluge.MultiOptionsManager = Ext.extend(Deluge.OptionsManager, { /** * Get the value for an option - * @param {String|Array} [option] A single option or an array of options to return. + * @param {String/Array} option A single option or an array of options to return. * @returns {Object} the options value. */ get: function() { @@ -97,7 +98,7 @@ Deluge.MultiOptionsManager = Ext.extend(Deluge.OptionsManager, { /** * Get the default value for an option. - * @param {String|Array} [option] A single option or an array of options to return. + * @param {String} option A single option. * @returns {Object} the value of the option */ getDefault: function(option) { @@ -182,7 +183,7 @@ Deluge.MultiOptionsManager = Ext.extend(Deluge.OptionsManager, { /** * Update the value for the specified option and id. * @param {String} id - * @param {String|Object} option or options to update + * @param {String/Object} option or options to update * @param {Object} [value]; */ update: function(option, value) { @@ -212,9 +213,7 @@ Deluge.MultiOptionsManager = Ext.extend(Deluge.OptionsManager, { } }, - /****************** - * Event Handlers * - ******************/ + // Event Handlers /** * Stops a form fields value from being blocked by the change functions * @param {Ext.form.Field} field @@ -224,6 +223,13 @@ Deluge.MultiOptionsManager = Ext.extend(Deluge.OptionsManager, { this.update(field._doption, field.getValue()); }, + /** + * Handles updating binds when an option's value is changed. + * @param {String} id The current option id + * @param {String} option The option that has changed. + * @param {Mixed} newValue The new value + * @private + */ onChange: function(id, option, newValue, oldValue) { // If we don't have a bind there's nothing to do. if (Ext.isEmpty(this.binds[option])) return; diff --git a/deluge/ui/web/js/deluge-all/Deluge.OptionsManager.js b/deluge/ui/web/js/deluge-all/Deluge.OptionsManager.js index 52c13ffc9..58ee98079 100644 --- a/deluge/ui/web/js/deluge-all/Deluge.OptionsManager.js +++ b/deluge/ui/web/js/deluge-all/Deluge.OptionsManager.js @@ -43,9 +43,6 @@ Ext.namespace('Deluge'); */ Deluge.OptionsManager = Ext.extend(Ext.util.Observable, { - /** - * Create a new instance of the OptionsManager. - */ constructor: function(config) { config = config || {}; this.binds = {}; @@ -54,8 +51,25 @@ Deluge.OptionsManager = Ext.extend(Ext.util.Observable, { this.focused = null; this.addEvents({ + /** + * @event add + * Fires when an option is added + */ 'add': true, + + /** + * @event changed + * Fires when an option is changed + * @param {String} option The changed option + * @param {Mixed} value The options new value + * @param {Mixed} oldValue The options old value + */ 'changed': true, + + /** + * @event reset + * Fires when the options are reset + */ 'reset': true }); this.on('changed', this.onChange, this); @@ -205,7 +219,7 @@ Deluge.OptionsManager = Ext.extend(Ext.util.Observable, { /** * Update the value for the specified option and id. - * @param {String|Object} option or options to update + * @param {String/Object} option or options to update * @param {Object} [value]; */ update: function(option, value) { @@ -233,9 +247,6 @@ Deluge.OptionsManager = Ext.extend(Ext.util.Observable, { } }, - /****************** - * Event Handlers * - ******************/ /** * Lets the option manager know when a field is blurred so if a value * so value changing operations can continue on that field. diff --git a/deluge/ui/web/js/deluge-all/Deluge.Preferences.Proxy.js b/deluge/ui/web/js/deluge-all/Deluge.Preferences.Proxy.js index bf75b3697..c9f858122 100644 --- a/deluge/ui/web/js/deluge-all/Deluge.Preferences.Proxy.js +++ b/deluge/ui/web/js/deluge-all/Deluge.Preferences.Proxy.js @@ -121,9 +121,7 @@ Ext.deluge.preferences.ProxyField = Ext.extend(Ext.form.FieldSet, { } }, - /** - * Set the values of the proxies - */ + // Set the values of the proxies setValue: function(value) { this.setting = true; this.type.setValue(value['type']); diff --git a/deluge/ui/web/js/deluge-all/Deluge.Torrents.js b/deluge/ui/web/js/deluge-all/Deluge.Torrents.js index 737f90f96..d6a86621e 100644 --- a/deluge/ui/web/js/deluge-all/Deluge.Torrents.js +++ b/deluge/ui/web/js/deluge-all/Deluge.Torrents.js @@ -79,7 +79,7 @@ Copyright: * Ext.deluge.TorrentGrid Class * * @author Damien Churchill