Added PEP8 style comments to all of the JS code.

IPython/html/static/notebook/js/widgets/widget.js

@@ -1,366 +1,381
 //----------------------------------------------------------------------------
 //  Copyright (C) 2013 The IPython Development Team
 //
 //  Distributed under the terms of the BSD License.  The full license is in
 //  the file COPYING, distributed as part of this software.
 //----------------------------------------------------------------------------
 
 //============================================================================
 // Base Widget Model and View classes
 //============================================================================
 
 /**
  * @module IPython
  * @namespace IPython
  **/
 
 define(["notebook/js/widgetmanager",
         "underscore",
         "backbone"], 
 function(widget_manager, underscore, backbone){
-    
-    //--------------------------------------------------------------------
-    // WidgetModel class
-    //--------------------------------------------------------------------
+
     var WidgetModel = Backbone.Model.extend({
         constructor: function (widget_manager, model_id, comm) {
             // Construcctor
             //
             // Creates a WidgetModel instance.
             //
             // Parameters
             // ----------
             // widget_manager : WidgetManager instance
             // model_id : string
             //      An ID unique to this model.
             // comm : Comm instance (optional)
             this.widget_manager = widget_manager;
             this.pending_msgs = 0;
             this.msg_throttle = 2;
             this.msg_buffer = null;
             this.key_value_lock = null;
             this.id = model_id;
             this.views = [];
 
             if (comm !== undefined) {
                 // Remember comm associated with the model.
                 this.comm = comm;
                 comm.model = this;
 
                 // Hook comm messages up to model.
                 comm.on_close($.proxy(this._handle_comm_closed, this));
                 comm.on_msg($.proxy(this._handle_comm_msg, this));
             }
             return Backbone.Model.apply(this);
         },
 
         send: function (content, callbacks) {
+            // Send a custom msg over the comm.
             if (this.comm !== undefined) {
                 var data = {method: 'custom', custom_content: content};
                 this.comm.send(data, callbacks);
             }
         },
 
-        // Handle when a widget is closed.
         _handle_comm_closed: function (msg) {
+            // Handle when a widget is closed.
             this.trigger('comm:close');
             delete this.comm.model; // Delete ref so GC will collect widget model.
             delete this.comm;
             delete this.model_id; // Delete id from model so widget manager cleans up.
             // TODO: Handle deletion, like this.destroy(), and delete views, etc.
         },
 
-
-        // Handle incoming comm msg.
         _handle_comm_msg: function (msg) {
+            // Handle incoming comm msg.
             var method = msg.content.data.method;
             switch (method) {
                 case 'update':
                     this.apply_update(msg.content.data.state);
                     break;
                 case 'custom':
                     this.trigger('msg:custom', msg.content.data.custom_content);
                     break;
                 case 'display':
                     this.widget_manager.display_view(msg.parent_header.msg_id, this);
                     break;
             }
         },
 
-
-        // Handle when a widget is updated via the python side.
         apply_update: function (state) {
+            // Handle when a widget is updated via the python side.
             for (var key in state) {
                 if (state.hasOwnProperty(key)) {
                     var value = state[key];
                     this.key_value_lock = [key, value];
                     try {
                         this.set(key, this._unpack_models(value));
                     } finally {
                         this.key_value_lock = null;
                     }
                 }
             }
             //TODO: are there callbacks that make sense in this case?  If so, attach them here as an option
             this.save();
         },
 
-
         _handle_status: function (msg, callbacks) {
-            //execution_state : ('busy', 'idle', 'starting')
+            // Handle status msgs.
+
+            // execution_state : ('busy', 'idle', 'starting')
             if (this.comm !== undefined) {
                 if (msg.content.execution_state ==='idle') {
                     // Send buffer if this message caused another message to be
                     // throttled.
                     if (this.msg_buffer !== null &&
                         this.msg_throttle === this.pending_msgs) {
                         var data = {method: 'backbone', sync_method: 'update', sync_data: this.msg_buffer};
                         this.comm.send(data, callbacks);  
                         this.msg_buffer = null;
                     } else {
                         --this.pending_msgs;
                     }
                 }
             }
         },
 
-
-        // Custom syncronization logic.
         _handle_sync: function (method, options) {
+            // Custom syncronization logic.
             var model_json = this.toJSON();
             var attr;
 
             // Only send updated state if the state hasn't been changed 
             // during an update.
             if (this.comm !== undefined) {    
                 if (this.pending_msgs >= this.msg_throttle) {
                     // The throttle has been exceeded, buffer the current msg so
                     // it can be sent once the kernel has finished processing 
                     // some of the existing messages.
                     if (this.msg_buffer === null) {
                         this.msg_buffer = $.extend({}, model_json); // Copy
                     }
                     for (attr in options.attrs) {
                         var value = this._pack_models(options.attrs[attr]);
                         if (this.key_value_lock === null || attr !== this.key_value_lock[0] || value !== this.key_value_lock[1]) {
                             this.msg_buffer[attr] = value;
                         }
                     }
 
                 } else {
                     // We haven't exceeded the throttle, send the message like 
                     // normal.  If this is a patch operation, just send the 
                     // changes.
                     var send_json = model_json;
                     send_json = {};
                     for (attr in options.attrs) {
                         var value = this._pack_models(options.attrs[attr]);
                         if (this.key_value_lock === null || attr !== this.key_value_lock[0] || value !== this.key_value_lock[1]) {
                             send_json[attr] = value;
                         }
                     }
                     
                     var is_empty = true;
                     for (var prop in send_json) if (send_json.hasOwnProperty(prop)) is_empty = false;
                     if (!is_empty) {
                         ++this.pending_msgs;
                         var data = {method: 'backbone', sync_data: send_json};
                         this.comm.send(data, options.callbacks);
                     }
                 }
             }
             
             // Since the comm is a one-way communication, assume the message 
             // arrived.
             return model_json;
         },
 
         _pack_models: function(value) {
+            // Replace models with model ids recursively.
             if (value instanceof Backbone.Model) {
                 return value.id;
             } else if (value instanceof Object) {
                 var packed = {};
                 for (var key in value) {
                     packed[key] = this._pack_models(value[key]);
                 }
                 return packed;
             } else {
                 return value;
             }
         },
 
         _unpack_models: function(value) {
+            // Replace model ids with models recursively.
             if (value instanceof Object) {
                 var unpacked = {};
                 for (var key in value) {
                     unpacked[key] = this._unpack_models(value[key]);
                 }
                 return unpacked;
             } else {
                 var model = this.widget_manager.get_model(value);
                 if (model !== null) {
                     return model;
                 } else {
                     return value;
                 }
             }
         },
 
     });
     widget_manager.register_widget_model('WidgetModel', WidgetModel);
 
 
-    //--------------------------------------------------------------------
-    // WidgetView class
-    //--------------------------------------------------------------------
     var WidgetView = Backbone.View.extend({
         initialize: function(parameters) {
+            // Public constructor.
             this.model.on('change',this.update,this);
             this.options = parameters.options;
             this.child_views = [];
             this.model.views.push(this);
         },
 
         update: function(){
-            // update view to be consistent with this.model
-            // triggered on model change
+            // Triggered on model change.
+            //
+            // Update view to be consistent with this.model
         },
 
         create_child_view: function(child_model, options) {
-            // create and return a child view, given a model and (optionally) a view name
-            // if the view name is not given, it defaults to the model's default view attribute
+            // Create and return a child view.
+            //
+            // - given a model and (optionally) a view name if the view name is 
+            // not given, it defaults to the model's default view attribute.
             var child_view = this.model.widget_manager.create_view(child_model, options);
             this.child_views[child_model.id] = child_view;
             return child_view;
         },
 
         delete_child_view: function(child_model, options) {
+            // Delete a child view that was previously created using create_child_view.
             var view = this.child_views[child_model.id];
             delete this.child_views[child_model.id];
             view.remove();
         },
 
         do_diff: function(old_list, new_list, removed_callback, added_callback) {
             // Difference a changed list and call remove and add callbacks for 
             // each removed and added item in the new list.
             //
             // Parameters
             // ----------
             // old_list : array
             // new_list : array
             // removed_callback : Callback(item)
             //      Callback that is called for each item removed.
             // added_callback : Callback(item)
             //      Callback that is called for each item added.
 
 
             // removed items
             _.each(_.difference(old_list, new_list), function(item, index, list) {
                 removed_callback(item);
             }, this);
 
             // added items
             _.each(_.difference(new_list, old_list), function(item, index, list) {
                 added_callback(item);
             }, this);
         },
 
         callbacks: function(){
+            // Create msg callbacks for a comm msg.
             return this.model.widget_manager.callbacks(this);
         },
 
         render: function(){
-            // render the view.  By default, this is only called the first time the view is created
+            // Render the view.
+            //
+            // By default, this is only called the first time the view is created
         },
+
         send: function (content) {
+            // Send a custom msg associated with this view.
             this.model.send(content, this.callbacks());
         },
 
         touch: function () {
+            // Associate recent model changes with this notebook.
             this.model.save(this.model.changedAttributes(), {patch: true, callbacks: this.callbacks()});
         },
 
     });
 
+
     var DOMWidgetView = WidgetView.extend({
         initialize: function (options) {
-            // TODO: make changes more granular (e.g., trigger on visible:change)
+            // Public constructor
+
+            // In the future we may want to make changes more granular 
+            // (e.g., trigger on visible:change).
             this.model.on('change', this.update, this);
             this.model.on('msg:custom', this.on_msg, this);
             DOMWidgetView.__super__.initialize.apply(this, arguments);
         },
         
         on_msg: function(msg) {
+            // Handle DOM specific msgs.
             switch(msg.msg_type) {
                 case 'add_class':
                     this.add_class(msg.selector, msg.class_list);
                     break;
                 case 'remove_class':
                     this.remove_class(msg.selector, msg.class_list);
                     break;
             }
         },
 
         add_class: function (selector, class_list) {
+            // Add a DOM class to an element.
             this._get_selector_element(selector).addClass(class_list);
         },
         
         remove_class: function (selector, class_list) {
+            // Remove a DOM class from an element.
             this._get_selector_element(selector).removeClass(class_list);
         },
     
         update: function () {
             // Update the contents of this view
             //
             // Called when the model is changed.  The model may have been 
             // changed by another view or by a state update from the back-end.
             //      The very first update seems to happen before the element is 
             // finished rendering so we use setTimeout to give the element time 
             // to render
             var e = this.$el;
             var visible = this.model.get('visible');
             setTimeout(function() {e.toggle(visible)},0);
      
             var css = this.model.get('_css');
             if (css === undefined) {return;}
             for (var selector in css) {
                 if (css.hasOwnProperty(selector)) {
                     // Apply the css traits to all elements that match the selector.
                     var elements = this._get_selector_element(selector);
                     if (elements.length > 0) {
                         var css_traits = css[selector];    
                         for (var css_key in css_traits) {
                             if (css_traits.hasOwnProperty(css_key)) {
                                 elements.css(css_key, css_traits[css_key]);
                             }
                         }
                     }
                 }
             }
         },
 
         _get_selector_element: function (selector) {
-            // Get the elements via the css selector.  If the selector is
-            // blank, apply the style to the $el_to_style element.  If
-            // the $el_to_style element is not defined, use apply the 
-            // style to the view's element.
+            // Get the elements via the css selector.  
+
+            // If the selector is blank, apply the style to the $el_to_style 
+            // element.  If the $el_to_style element is not defined, use apply 
+            // the style to the view's element.
             var elements;
             if (selector === undefined || selector === null || selector === '') {
                 if (this.$el_to_style === undefined) {
                     elements = this.$el;
                 } else {
                     elements = this.$el_to_style;
                 }
             } else {
                 elements = this.$el.find(selector);
             }
             return elements;
         },
     });
 
     IPython.WidgetModel = WidgetModel;
     IPython.WidgetView = WidgetView;
     IPython.DOMWidgetView = DOMWidgetView;
 
+    // Pass through widget_manager instance (probably not a good practice).
     return widget_manager;
 });

IPython/html/static/notebook/js/widgets/widget_bool.js

@@ -1,126 +1,125
 //----------------------------------------------------------------------------
 //  Copyright (C) 2013 The IPython Development Team
 //
 //  Distributed under the terms of the BSD License.  The full license is in
 //  the file COPYING, distributed as part of this software.
 //----------------------------------------------------------------------------
 
 //============================================================================
 // BoolWidget
 //============================================================================
 
 /**
  * @module IPython
  * @namespace IPython
  **/
 
 define(["notebook/js/widgets/widget"], function(widget_manager){
+
     var CheckBoxView = IPython.DOMWidgetView.extend({
-      
-        // Called when view is rendered.
         render : function(){
+            // Called when view is rendered.
             this.$el
                 .addClass('widget-hbox-single');
             this.$label = $('<div />')
                 .addClass('widget-hlabel')
                 .appendTo(this.$el)
                 .hide();
             this.$checkbox = $('<input />')
                 .attr('type', 'checkbox')
                 .appendTo(this.$el)
                 .click($.proxy(this.handle_click, this));
 
             this.$el_to_style = this.$checkbox; // Set default element to style
             this.update(); // Set defaults.
         },
 
         handle_click: function() {
+            // Handles when the checkbox is clicked.
+
             // Calling model.set will trigger all of the other views of the 
             // model to update.
             var value = this.model.get('value');
             this.model.set('value', ! value, {updated_view: this});
             this.touch();
         },
         
         update : function(options){
             // Update the contents of this view
             //
             // Called when the model is changed.  The model may have been 
             // changed by another view or by a state update from the back-end.
             this.$checkbox.prop('checked', this.model.get('value'));
 
             if (options === undefined || options.updated_view != this) {
                 var disabled = this.model.get('disabled');
                 this.$checkbox.prop('disabled', disabled);
 
                 var description = this.model.get('description');
                 if (description.length === 0) {
                     this.$label.hide();
                 } else {
                     this.$label.html(description);
                     this.$label.show();
                 }
             }
             return CheckBoxView.__super__.update.apply(this);
         },
         
     });
-
     widget_manager.register_widget_view('CheckBoxView', CheckBoxView);
 
+
     var ToggleButtonView = IPython.DOMWidgetView.extend({
-      
-        // Called when view is rendered.
         render : function() {
+            // Called when view is rendered.
             var that = this;
             this.setElement($('<button />')
                 .addClass('btn')
                 .attr('type', 'button')
                 .on('click', function (e) {
                     e.preventDefault();
                     that.handle_click();
                 }));
 
             this.update(); // Set defaults.
         },
         
         update : function(options){
             // Update the contents of this view
             //
             // Called when the model is changed.  The model may have been 
             // changed by another view or by a state update from the back-end.
             if (this.model.get('value')) {
                 this.$el.addClass('active');
             } else {
                 this.$el.removeClass('active');
             }
 
             if (options === undefined || options.updated_view != this) {
 
                 var disabled = this.model.get('disabled');
                 this.$el.prop('disabled', disabled);
 
                 var description = this.model.get('description');
                 if (description.length === 0) {
                     this.$el.html(' '); // Preserve button height
                 } else {
                     this.$el.html(description);
                 }
             }
             return ToggleButtonView.__super__.update.apply(this);
         },
         
-        // Handles and validates user input.
         handle_click: function(e) { 
+            // Handles and validates user input.
 
             // Calling model.set will trigger all of the other views of the 
             // model to update.
             var value = this.model.get('value');
             this.model.set('value', ! value, {updated_view: this});
             this.touch();
         },
     });
-
     widget_manager.register_widget_view('ToggleButtonView', ToggleButtonView);
-
 });

IPython/html/static/notebook/js/widgets/widget_button.js

@@ -1,62 +1,62
 //----------------------------------------------------------------------------
 //  Copyright (C) 2013 The IPython Development Team
 //
 //  Distributed under the terms of the BSD License.  The full license is in
 //  the file COPYING, distributed as part of this software.
 //----------------------------------------------------------------------------
 
 //============================================================================
 // ButtonWidget
 //============================================================================
 
 /**
  * @module IPython
  * @namespace IPython
  **/
 
 define(["notebook/js/widgets/widget"], function(widget_manager){
-    var ButtonView = IPython.DOMWidgetView.extend({
-      
-        // Called when view is rendered.
+
+    var ButtonView = IPython.DOMWidgetView.extend({  
         render : function(){
+            // Called when view is rendered.
             this.setElement($("<button />")
                 .addClass('btn'));
 
             this.update(); // Set defaults.
         },
         
         update : function(){
             // Update the contents of this view
             //
             // Called when the model is changed.  The model may have been 
             // changed by another view or by a state update from the back-end.
             var description = this.model.get('description');
             description = description.replace(/ /g, '&nbsp;', 'm');
             description = description.replace(/\n/g, '<br>\n', 'm');
             if (description.length === 0) {
                 this.$el.html('&nbsp;'); // Preserve button height
             } else {
                 this.$el.html(description);
             }
             
             if (this.model.get('disabled')) {
                 this.$el.attr('disabled','disabled');
             } else {
                 this.$el.removeAttr('disabled');
             }
 
             return ButtonView.__super__.update.apply(this);
         },
 
         events: {
+            // Dictionary of events and their handlers.
             'click': '_handle_click',
         },
         
         _handle_click: function(){
+            // Handles when the button is clicked.
             this.send({event: 'click'});
         },
     });
-
     widget_manager.register_widget_view('ButtonView', ButtonView);
-
 });

IPython/html/static/notebook/js/widgets/widget_container.js

@@ -1,270 +1,277
 //----------------------------------------------------------------------------
 //  Copyright (C) 2013 The IPython Development Team
 //
 //  Distributed under the terms of the BSD License.  The full license is in
 //  the file COPYING, distributed as part of this software.
 //----------------------------------------------------------------------------
 
 //============================================================================
 // ContainerWidget
 //============================================================================
 
 /**
  * @module IPython
  * @namespace IPython
  **/
 
 define(["notebook/js/widgets/widget"], function(widget_manager) {
-    var ContainerView = IPython.DOMWidgetView.extend({
-        
+
+    var ContainerView = IPython.DOMWidgetView.extend({    
         render: function(){
+            // Called when view is rendered.
             this.$el
                 .addClass('widget-container');
             this.children={};
             this.update_children([], this.model.get('children'));
             this.model.on('change:children', function(model, value, options) {
                 this.update_children(model.previous('children'), value);
             }, this);
             this.update()
         },
         
         update_children: function(old_list, new_list) {
+            // Called when the children list changes.
             this.do_diff(old_list, 
                 new_list, 
                 $.proxy(this.remove_child_model, this),
                 $.proxy(this.add_child_model, this));
         },
 
         remove_child_model: function(model) {
+            // Called when a model is removed from the children list.
             this.child_views[model.id].remove();
             this.delete_child_view(model);
         },
 
         add_child_model: function(model) {
+            // Called when a model is added to the children list.
             var view = this.create_child_view(model);
             this.$el.append(view.$el);
         },
         
         update: function(){
             // Update the contents of this view
             //
             // Called when the model is changed.  The model may have been 
             // changed by another view or by a state update from the back-end.
             return ContainerView.__super__.update.apply(this);
         },
     });
-
     widget_manager.register_widget_view('ContainerView', ContainerView);
 
 
-    var ModalView = IPython.DOMWidgetView.extend({
-        
+    var ModalView = IPython.DOMWidgetView.extend({ 
         render: function(){
+            // Called when view is rendered.
             var that = this;
             this.children={};
             this.update_children([], this.model.get('children'));
             this.model.on('change:children', function(model, value, options) {
                 this.update_children(model.previous('children'), value);
             }, this);
             
             this.$el
                 .html('')
                 .on("remove", function(){
                     that.$window.remove();
                 });
             this.$window = $('<div />')
                 .addClass('modal widget-modal')
                 .appendTo($('#notebook-container'))
                 .mousedown(function(){
                     that.bring_to_front();
                 });
             this.$title_bar = $('<div />')
                 .addClass('popover-title')
                 .appendTo(this.$window)
                 .mousedown(function(){
                     that.bring_to_front();
                 });
             this.$close = $('<button />')
                 .addClass('close icon-remove')
                 .css('margin-left', '5px')
                 .appendTo(this.$title_bar)
                 .click(function(){
                     that.hide();
                     event.stopPropagation();
                 });
             this.$minimize = $('<button />')
                 .addClass('close icon-arrow-down')
                 .appendTo(this.$title_bar)
                 .click(function(){
                     that.popped_out = !that.popped_out;
                     if (!that.popped_out) {
                         that.$minimize
                             .removeClass('icon-arrow-down')
                             .addClass('icon-arrow-up');
                             
                         that.$window
                             .draggable('destroy')
                             .resizable('destroy')
                             .removeClass('widget-modal modal')
                             .addClass('docked-widget-modal')
                             .detach()
                             .insertBefore(that.$show_button);
                         that.$show_button.hide();
                         that.$close.hide();
                     } else {
                         that.$minimize
                             .addClass('icon-arrow-down')
                             .removeClass('icon-arrow-up');
 
                         that.$window
                             .removeClass('docked-widget-modal')
                             .addClass('widget-modal modal')
                             .detach()
                             .appendTo($('#notebook-container'))
                             .draggable({handle: '.popover-title', snap: '#notebook, .modal', snapMode: 'both'})
                             .resizable()
                             .children('.ui-resizable-handle').show();
                         that.show();
                         that.$show_button.show();
                         that.$close.show();
                     }
                     event.stopPropagation();
                 });
             this.$title = $('<div />')
                 .addClass('widget-modal-title')
                 .html('&nbsp;')
                 .appendTo(this.$title_bar);
             this.$body = $('<div />')
                 .addClass('modal-body')
                 .addClass('widget-modal-body')
                 .addClass('widget-container')
                 .appendTo(this.$window);
             
             this.$show_button = $('<button />')
                 .html('&nbsp;')
                 .addClass('btn btn-info widget-modal-show')
                 .appendTo(this.$el)
                 .click(function(){
                     that.show();
                 });
             
             this.$window.draggable({handle: '.popover-title', snap: '#notebook, .modal', snapMode: 'both'});
             this.$window.resizable();
             this.$window.on('resize', function(){
                 that.$body.outerHeight(that.$window.innerHeight() - that.$title_bar.outerHeight());
             });
 
             this.$el_to_style = this.$body;
             this._shown_once = false;
             this.popped_out = true;
         },
         
         hide: function() {
+            // Called when the modal hide button is clicked.
             this.$window.hide();
             this.$show_button.removeClass('btn-info');
         },
         
         show: function() {
+            // Called when the modal show button is clicked.
             this.$show_button.addClass('btn-info');
-
             this.$window.show();
             if (this.popped_out) {
                 this.$window.css("positon", "absolute");
                 this.$window.css("top", "0px");
                 this.$window.css("left", Math.max(0, (($('body').outerWidth() - this.$window.outerWidth()) / 2) + 
                     $(window).scrollLeft()) + "px");
                 this.bring_to_front();
             }
         },
         
         bring_to_front: function() {
+            // Make the modal top-most, z-ordered about the other modals.
             var $widget_modals = $(".widget-modal");
             var max_zindex = 0;
             $widget_modals.each(function (index, el){
                 max_zindex = Math.max(max_zindex, parseInt($(el).css('z-index')));
             });
             
             // Start z-index of widget modals at 2000
             max_zindex = Math.max(max_zindex, 2000);
 
             $widget_modals.each(function (index, el){
                 $el = $(el);
                 if (max_zindex == parseInt($el.css('z-index'))) {
                     $el.css('z-index', max_zindex - 1);
                 }
             });
             this.$window.css('z-index', max_zindex);
         },
         
         update_children: function(old_list, new_list) {
+            // Called when the children list is modified.
             this.do_diff(old_list, 
                 new_list, 
                 $.proxy(this.remove_child_model, this),
                 $.proxy(this.add_child_model, this));
         },
 
         remove_child_model: function(model) {
+            // Called when a child is removed from children list.
             this.child_views[model.id].remove();
             this.delete_child_view(model);
         },
 
         add_child_model: function(model) {
+            // Called when a child is added to children list.
             var view = this.create_child_view(model);
             this.$body.append(view.$el);
         },
         
         update: function(){
             // Update the contents of this view
             //
             // Called when the model is changed.  The model may have been 
             // changed by another view or by a state update from the back-end.
             var description = this.model.get('description');
             description = description.replace(/ /g, '&nbsp;', 'm');
             description = description.replace(/\n/g, '<br>\n', 'm');
             if (description.length === 0) {
                 this.$title.html('&nbsp;'); // Preserve title height
             } else {
                 this.$title.html(description);
             }
             
             var button_text = this.model.get('button_text');
             button_text = button_text.replace(/ /g, '&nbsp;', 'm');
             button_text = button_text.replace(/\n/g, '<br>\n', 'm');
             if (button_text.length === 0) {
                 this.$show_button.html('&nbsp;'); // Preserve button height
             } else {
                 this.$show_button.html(button_text);
             }
             
             if (!this._shown_once) {
                 this._shown_once = true;
                 this.show();
             }
             
             return ModalView.__super__.update.apply(this);
         },
         
         _get_selector_element: function(selector) {
-
+            // Get an element view a 'special' jquery selector.  (see widget.js)
+            //
             // Since the modal actually isn't within the $el in the DOM, we need to extend
             // the selector logic to allow the user to set css on the modal if need be.
             // The convention used is:
             // "modal" - select the modal div
             // "modal [selector]" - select element(s) within the modal div.
             // "[selector]" - select elements within $el
             // "" - select the $el_to_style
             if (selector.substring(0, 5) == 'modal') {
                 if (selector == 'modal') {
                     return this.$window;
                 } else {
                     return this.$window.find(selector.substring(6));
                 }
             } else {
                 return ModalView.__super__._get_selector_element.apply(this, [selector]);
             }
         },
-        
     });
-
     widget_manager.register_widget_view('ModalView', ModalView);
 });

IPython/html/static/notebook/js/widgets/widget_float_range.js

@@ -1,266 +1,267
 //----------------------------------------------------------------------------
 //  Copyright (C) 2013 The IPython Development Team
 //
 //  Distributed under the terms of the BSD License.  The full license is in
 //  the file COPYING, distributed as part of this software.
 //----------------------------------------------------------------------------
 
 //============================================================================
 // FloatRangeWidget
 //============================================================================
 
 /**
  * @module IPython
  * @namespace IPython
  **/
 
 define(["notebook/js/widgets/widget"], function(widget_manager){
+
     var FloatSliderView = IPython.DOMWidgetView.extend({
-        
-        // Called when view is rendered.
         render : function(){
+            // Called when view is rendered.
             this.$el
                 .addClass('widget-hbox-single');
             this.$label = $('<div />')
                 .appendTo(this.$el)
                 .addClass('widget-hlabel')
                 .hide();
             this.$slider = $('<div />')
                 .slider({})
                 .addClass('slider');
             
             // Put the slider in a container 
             this.$slider_container = $('<div />')
                 .addClass('widget-hslider')
                 .append(this.$slider);    
             this.$el_to_style = this.$slider_container; // Set default element to style
             this.$el.append(this.$slider_container);
             
             // Set defaults.
             this.update();
         },
         
         update : function(options){
             // Update the contents of this view
             //
             // Called when the model is changed.  The model may have been 
             // changed by another view or by a state update from the back-end.
             
             if (options === undefined || options.updated_view != this) {
                 // JQuery slider option keys.  These keys happen to have a
                 // one-to-one mapping with the corrosponding keys of the model.
                 var jquery_slider_keys = ['step', 'max', 'min', 'disabled'];
                 for (var index in jquery_slider_keys) {
                     var key = jquery_slider_keys[index];
                     if (this.model.get(key) !== undefined) {
                         this.$slider.slider("option", key, this.model.get(key));
                     }
                 }
 
                 // WORKAROUND FOR JQUERY SLIDER BUG.
                 // The horizontal position of the slider handle
                 // depends on the value of the slider at the time
                 // of orientation change.  Before applying the new
                 // workaround, we set the value to the minimum to
                 // make sure that the horizontal placement of the
                 // handle in the vertical slider is always 
                 // consistent.
                 var orientation = this.model.get('orientation');
                 var value = this.model.get('min');
                 this.$slider.slider('option', 'value', value);
                 this.$slider.slider('option', 'orientation', orientation);
                 value = this.model.get('value');
                 this.$slider.slider('option', 'value', value);
 
                 // Use the right CSS classes for vertical & horizontal sliders
                 if (orientation=='vertical') {
                     this.$slider_container
                         .removeClass('widget-hslider')
                         .addClass('widget-vslider');
                     this.$el
                         .removeClass('widget-hbox-single')
                         .addClass('widget-vbox-single');
                     this.$label
                         .removeClass('widget-hlabel')
                         .addClass('widget-vlabel');
 
                 } else {
                     this.$slider_container
                         .removeClass('widget-vslider')
                         .addClass('widget-hslider');
                     this.$el
                         .removeClass('widget-vbox-single')
                         .addClass('widget-hbox-single');
                     this.$label
                         .removeClass('widget-vlabel')
                         .addClass('widget-hlabel');
                 }
 
                 var description = this.model.get('description');
                 if (description.length === 0) {
                     this.$label.hide();
                 } else {
                     this.$label.html(description);
                     this.$label.show();
                 }
             }
             return FloatSliderView.__super__.update.apply(this);
         },
         
-        // Handles: User input
-        events: { "slide" : "handleSliderChange" }, 
+        events: {
+            // Dictionary of events and their handlers.
+            "slide" : "handleSliderChange" 
+        }, 
+
         handleSliderChange: function(e, ui) { 
-            
+            // Handle when the slider value is changed.
+
             // Calling model.set will trigger all of the other views of the 
             // model to update.
             this.model.set('value', ui.value, {updated_view: this}); 
             this.touch();
         },
     });
-
     widget_manager.register_widget_view('FloatSliderView', FloatSliderView);
 
 
-    var FloatTextView = IPython.DOMWidgetView.extend({
-        
-        // Called when view is rendered.
+    var FloatTextView = IPython.DOMWidgetView.extend({    
         render : function(){
+            // Called when view is rendered.
             this.$el
                 .addClass('widget-hbox-single');
             this.$label = $('<div />')
                 .appendTo(this.$el)
                 .addClass('widget-hlabel')
                 .hide();
             this.$textbox = $('<input type="text" />')
                 .addClass('input')
                 .addClass('widget-numeric-text')
                 .appendTo(this.$el);
             this.$el_to_style = this.$textbox; // Set default element to style
             this.update(); // Set defaults.
         },
         
         update : function(options){
             // Update the contents of this view
             //
             // Called when the model is changed.  The model may have been 
             // changed by another view or by a state update from the back-end.
-
             if (options === undefined || options.updated_view != this) {
                 var value = this.model.get('value');
                 if (parseFloat(this.$textbox.val()) != value) {
                     this.$textbox.val(value);
                 }
                 
                 if (this.model.get('disabled')) {
                     this.$textbox.attr('disabled','disabled');
                 } else {
                     this.$textbox.removeAttr('disabled');
                 }
 
                 var description = this.model.get('description');
                 if (description.length === 0) {
                     this.$label.hide();
                 } else {
                     this.$label.html(description);
                     this.$label.show();
                 }
             }
             return FloatTextView.__super__.update.apply(this);
         },
         
+        events: {
+            // Dictionary of events and their handlers.
+
+            "keyup input" : "handleChanging",
+            "paste input" : "handleChanging",
+            "cut input" : "handleChanging",
+
+            // Fires only when control is validated or looses focus.
+            "change input" : "handleChanged"
+        }, 
         
-        events: {"keyup input" : "handleChanging",
-                "paste input" : "handleChanging",
-                "cut input" : "handleChanging",
-                "change input" : "handleChanged"}, // Fires only when control is validated or looses focus.
-        
-        // Handles and validates user input.
         handleChanging: function(e) { 
-            
+            // Handles and validates user input.
+        
             // Try to parse value as a float.
             var numericalValue = 0.0;
             if (e.target.value !== '') {
                 numericalValue = parseFloat(e.target.value);
             }
             
             // If parse failed, reset value to value stored in model.
             if (isNaN(numericalValue)) {
                 e.target.value = this.model.get('value');
             } else if (!isNaN(numericalValue)) {
                 if (this.model.get('max') !== undefined) {
                     numericalValue = Math.min(this.model.get('max'), numericalValue);
                 }
                 if (this.model.get('min') !== undefined) {
                     numericalValue = Math.max(this.model.get('min'), numericalValue);
                 }
 
                 // Apply the value if it has changed.
                 if (numericalValue != this.model.get('value')) {
             
                     // Calling model.set will trigger all of the other views of the 
                     // model to update.
                     this.model.set('value', numericalValue, {updated_view: this});
                     this.touch();
                 }
             }
         },
         
-        // Applies validated input.
         handleChanged: function(e) { 
-            // Update the textbox
+            // Applies validated input.
             if (this.model.get('value') != e.target.value) {
                 e.target.value = this.model.get('value');
             }
         }
     });
-
     widget_manager.register_widget_view('FloatTextView', FloatTextView);
 
 
-    var ProgressView = IPython.DOMWidgetView.extend({
-        
-        // Called when view is rendered.
+    var ProgressView = IPython.DOMWidgetView.extend({    
         render : function(){
+            // Called when view is rendered.
             this.$el
                 .addClass('widget-hbox-single');
             this.$label = $('<div />')
                 .appendTo(this.$el)
                 .addClass('widget-hlabel')
                 .hide();
             this.$progress = $('<div />')
                 .addClass('progress')
                 .addClass('widget-progress')
                 .appendTo(this.$el);
             this.$el_to_style = this.$progress; // Set default element to style
             this.$bar = $('<div />')
                 .addClass('bar')
                 .css('width', '50%')
                 .appendTo(this.$progress);
             this.update(); // Set defaults.
         },
         
         update : function(){
             // Update the contents of this view
             //
             // Called when the model is changed.  The model may have been 
             // changed by another view or by a state update from the back-end.
             var value = this.model.get('value');
             var max = this.model.get('max');
             var min = this.model.get('min');
             var percent = 100.0 * (value - min) / (max - min);
             this.$bar.css('width', percent + '%');
             
             var description = this.model.get('description');
             if (description.length === 0) {
                 this.$label.hide();
             } else {
                 this.$label.html(description);
                 this.$label.show();
             }
             return ProgressView.__super__.update.apply(this);
-        },
-        
+        }, 
     });
-
     widget_manager.register_widget_view('ProgressView', ProgressView);
 });

IPython/html/static/notebook/js/widgets/widget_image.js

@@ -1,54 +1,51
 //----------------------------------------------------------------------------
 //  Copyright (C) 2013 The IPython Development Team
 //
 //  Distributed under the terms of the BSD License.  The full license is in
 //  the file COPYING, distributed as part of this software.
 //----------------------------------------------------------------------------
 
 //============================================================================
 // ImageWidget
 //============================================================================
 
 /**
  * @module IPython
  * @namespace IPython
  **/
 
 define(["notebook/js/widgets/widget"], function(widget_manager){
-    var ImageView = IPython.DOMWidgetView.extend({
-      
-        // Called when view is rendered.
+
+    var ImageView = IPython.DOMWidgetView.extend({  
         render : function(){
+            // Called when view is rendered.
             this.setElement($("<img />"));
             this.update(); // Set defaults.
         },
         
         update : function(){
             // Update the contents of this view
             //
             // Called when the model is changed.  The model may have been 
             // changed by another view or by a state update from the back-end.
             var image_src = 'data:image/' + this.model.get('format') + ';base64,' + this.model.get('_b64value');
             this.$el.attr('src', image_src);
             
             var width = this.model.get('width');
             if (width !== undefined && width.length > 0) {
                 this.$el.attr('width', width);
             } else {
                 this.$el.removeAttr('width');
             }
             
             var height = this.model.get('height');
             if (height !== undefined && height.length > 0) {
                 this.$el.attr('height', height);
             } else {
                 this.$el.removeAttr('height');
             }
             return ImageView.__super__.update.apply(this);
         },
-        
     });
-
     widget_manager.register_widget_view('ImageView', ImageView);
-
 });

IPython/html/static/notebook/js/widgets/widget_int_range.js

@@ -1,215 +1,220
 //----------------------------------------------------------------------------
 //  Copyright (C) 2013 The IPython Development Team
 //
 //  Distributed under the terms of the BSD License.  The full license is in
 //  the file COPYING, distributed as part of this software.
 //----------------------------------------------------------------------------
 
 //============================================================================
 // IntRangeWidget
 //============================================================================
 
 /**
  * @module IPython
  * @namespace IPython
  **/
 
 define(["notebook/js/widgets/widget"], function(widget_manager){
-    var IntSliderView = IPython.DOMWidgetView.extend({
-        
-        // Called when view is rendered.
+
+    var IntSliderView = IPython.DOMWidgetView.extend({    
         render : function(){
+            // Called when view is rendered.
             this.$el
                 .addClass('widget-hbox-single');
             this.$label = $('<div />')
                 .appendTo(this.$el)
                 .addClass('widget-hlabel')
                 .hide();
             this.$slider = $('<div />')
                 .slider({})
                 .addClass('slider');
             
             // Put the slider in a container 
             this.$slider_container = $('<div />')
                 .addClass('widget-hslider')
                 .append(this.$slider);    
             this.$el_to_style = this.$slider_container; // Set default element to style
             this.$el.append(this.$slider_container);
             
             // Set defaults.
             this.update();
         },
         
         update : function(options){
             // Update the contents of this view
             //
             // Called when the model is changed.  The model may have been 
             // changed by another view or by a state update from the back-end.
             if (options === undefined || options.updated_view != this) {
                 // JQuery slider option keys.  These keys happen to have a
                 // one-to-one mapping with the corrosponding keys of the model.
                 var jquery_slider_keys = ['step', 'max', 'min', 'disabled'];
                 for (var index in jquery_slider_keys) {
                     var key = jquery_slider_keys[index];
                     if (this.model.get(key) !== undefined) {
                         this.$slider.slider("option", key, this.model.get(key));
                     }
                 }
 
                 // WORKAROUND FOR JQUERY SLIDER BUG.
                 // The horizontal position of the slider handle
                 // depends on the value of the slider at the time
                 // of orientation change.  Before applying the new
                 // workaround, we set the value to the minimum to
                 // make sure that the horizontal placement of the
                 // handle in the vertical slider is always 
                 // consistent.
                 var orientation = this.model.get('orientation');
                 var value = this.model.get('min');
                 this.$slider.slider('option', 'value', value);
                 this.$slider.slider('option', 'orientation', orientation);
                 value = this.model.get('value');
                 this.$slider.slider('option', 'value', value);
 
                 // Use the right CSS classes for vertical & horizontal sliders
                 if (orientation=='vertical') {
                     this.$slider_container
                         .removeClass('widget-hslider')
                         .addClass('widget-vslider');
                     this.$el
                         .removeClass('widget-hbox-single')
                         .addClass('widget-vbox-single');
                     this.$label
                         .removeClass('widget-hlabel')
                         .addClass('widget-vlabel');
 
                 } else {
                     this.$slider_container
                         .removeClass('widget-vslider')
                         .addClass('widget-hslider');
                     this.$el
                         .removeClass('widget-vbox-single')
                         .addClass('widget-hbox-single');
                     this.$label
                         .removeClass('widget-vlabel')
                         .addClass('widget-hlabel');
                 }
 
                 var description = this.model.get('description');
                 if (description.length === 0) {
                     this.$label.hide();
                 } else {
                     this.$label.html(description);
                     this.$label.show();
                 }
             }
             return IntSliderView.__super__.update.apply(this);
         },
         
-        // Handles: User input
-        events: { "slide" : "handleSliderChange" }, 
+        events: {
+            // Dictionary of events and their handlers.
+            "slide" : "handleSliderChange"
+        }, 
+
         handleSliderChange: function(e, ui) { 
-            
+            // Called when the slider value is changed.
+
             // Calling model.set will trigger all of the other views of the 
             // model to update.
             this.model.set('value', ~~ui.value, {updated_view: this}); // Double bit-wise not to truncate decimel
             this.touch();
         },
     });
-
     widget_manager.register_widget_view('IntSliderView', IntSliderView);
 
-    var IntTextView = IPython.DOMWidgetView.extend({
-        
-        // Called when view is rendered.
+
+    var IntTextView = IPython.DOMWidgetView.extend({    
         render : function(){
+            // Called when view is rendered.
             this.$el
                 .addClass('widget-hbox-single');
             this.$label = $('<div />')
                 .appendTo(this.$el)
                 .addClass('widget-hlabel')
                 .hide();
             this.$textbox = $('<input type="text" />')
                 .addClass('input')
                 .addClass('widget-numeric-text')
                 .appendTo(this.$el);
             this.$el_to_style = this.$textbox; // Set default element to style
             this.update(); // Set defaults.
         },
         
         update : function(options){
             // Update the contents of this view
             //
             // Called when the model is changed.  The model may have been 
             // changed by another view or by a state update from the back-end.
             if (options === undefined || options.updated_view != this) {
                 var value = this.model.get('value');
                 if (parseInt(this.$textbox.val()) != value) {
                     this.$textbox.val(value);
                 }
                 
                 if (this.model.get('disabled')) {
                     this.$textbox.attr('disabled','disabled');
                 } else {
                     this.$textbox.removeAttr('disabled');
                 }
 
                 var description = this.model.get('description');
                 if (description.length === 0) {
                     this.$label.hide();
                 } else {
                     this.$label.html(description);
                     this.$label.show();
                 }
             }
             return IntTextView.__super__.update.apply(this);
         },
+
+        events: {
+            // Dictionary of events and their handlers.
+            "keyup input" : "handleChanging",
+            "paste input" : "handleChanging",
+            "cut input" : "handleChanging",
+
+            // Fires only when control is validated or looses focus.
+            "change input" : "handleChanged"
+        }, 
         
-        
-        events: {"keyup input" : "handleChanging",
-                "paste input" : "handleChanging",
-                "cut input" : "handleChanging",
-                "change input" : "handleChanged"}, // Fires only when control is validated or looses focus.
-        
-        // Handles and validates user input.
         handleChanging: function(e) { 
+            // Handles and validates user input.
             
             // Try to parse value as a float.
             var numericalValue = 0;
             if (e.target.value !== '') {
                 numericalValue = parseInt(e.target.value);
             }
             
             // If parse failed, reset value to value stored in model.
             if (isNaN(numericalValue)) {
                 e.target.value = this.model.get('value');
             } else if (!isNaN(numericalValue)) {
                 if (this.model.get('max') !== undefined) {
                     numericalValue = Math.min(this.model.get('max'), numericalValue);
                 }
                 if (this.model.get('min') !== undefined) {
                     numericalValue = Math.max(this.model.get('min'), numericalValue);
                 }
                 
                 // Apply the value if it has changed.
                 if (numericalValue != this.model.get('value')) {
             
                     // Calling model.set will trigger all of the other views of the 
                     // model to update.
                     this.model.set('value', numericalValue, {updated_view: this});
                     this.touch();
                 }
             }
         },
         
-        // Applies validated input.
         handleChanged: function(e) { 
-            // Update the textbox
+            // Applies validated input.
             if (this.model.get('value') != e.target.value) {
                 e.target.value = this.model.get('value');
             }
         }
     });
-
     widget_manager.register_widget_view('IntTextView', IntTextView);
 });

IPython/html/static/notebook/js/widgets/widget_selection.js

@@ -1,379 +1,371
 //----------------------------------------------------------------------------
 //  Copyright (C) 2013 The IPython Development Team
 //
 //  Distributed under the terms of the BSD License.  The full license is in
 //  the file COPYING, distributed as part of this software.
 //----------------------------------------------------------------------------
 
 //============================================================================
 // SelectionWidget
 //============================================================================
 
 /**
  * @module IPython
  * @namespace IPython
  **/
 
 define(["notebook/js/widgets/widget"], function(widget_manager){
+
     var DropdownView = IPython.DOMWidgetView.extend({
-        
-        // Called when view is rendered.
         render : function(){
-            
+            // Called when view is rendered.            
             this.$el
                 .addClass('widget-hbox-single')
                 .html('');
             this.$label = $('<div />')
                 .appendTo(this.$el)
                 .addClass('widget-hlabel')
                 .hide();
             this.$buttongroup = $('<div />')
                 .addClass('widget_item')
                 .addClass('btn-group')
                 .appendTo(this.$el);
             this.$el_to_style = this.$buttongroup; // Set default element to style
             this.$droplabel = $('<button />')
                 .addClass('btn')
                 .addClass('widget-combo-btn')
                 .html('&nbsp;')
                 .appendTo(this.$buttongroup);
             this.$dropbutton = $('<button />')
                 .addClass('btn')
                 .addClass('dropdown-toggle')
                 .addClass('widget-combo-carrot-btn')
                 .attr('data-toggle', 'dropdown')
                 .html('<span class="caret"></span>')
                 .appendTo(this.$buttongroup);
             this.$droplist = $('<ul />')
                 .addClass('dropdown-menu')
                 .appendTo(this.$buttongroup);
             
             // Set defaults.
             this.update();
         },
         
         update : function(options){
             // Update the contents of this view
             //
             // Called when the model is changed.  The model may have been 
             // changed by another view or by a state update from the back-end.
 
             if (options === undefined || options.updated_view != this) {
                 var selected_item_text = this.model.get('value');
                 selected_item_text = selected_item_text.replace(/ /g, '&nbsp;');
                 selected_item_text = selected_item_text.replace(/\n/g, '<br>\n');
                 if (selected_item_text.length === 0) {
                     this.$droplabel.html('&nbsp;');
                 } else {
                     this.$droplabel.html(selected_item_text);    
                 }
                 
                 var items = this.model.get('values');
                 this.$droplist.html('');
                 for (var index in items) {
                     var that = this;
                     var item_button = $('<a href="#"/>')
                         .html(items[index])
                         .on('click', $.proxy(this.handle_click, this));
                     this.$droplist.append($('<li />').append(item_button));
                 }
                 
                 if (this.model.get('disabled')) {
                     this.$buttongroup.attr('disabled','disabled');
                     this.$droplabel.attr('disabled','disabled');
                     this.$dropbutton.attr('disabled','disabled');
                     this.$droplist.attr('disabled','disabled');
                 } else {
                     this.$buttongroup.removeAttr('disabled');
                     this.$droplabel.removeAttr('disabled');
                     this.$dropbutton.removeAttr('disabled');
                     this.$droplist.removeAttr('disabled');
                 }
 
                 var description = this.model.get('description');
                 if (description.length === 0) {
                     this.$label.hide();
                 } else {
                     this.$label.html(description);
                     this.$label.show();
                 }
             }
             return DropdownView.__super__.update.apply(this);
         },
 
-        // Handle when a value is clicked.
         handle_click: function (e) {
+            // Handle when a value is clicked.
             
             // Calling model.set will trigger all of the other views of the 
             // model to update.
             this.model.set('value', $(e.target).html(), {updated_view: this});
             this.touch();
         },
         
     });
-
     widget_manager.register_widget_view('DropdownView', DropdownView);
 
-    var RadioButtonsView = IPython.DOMWidgetView.extend({
-        
-        // Called when view is rendered.
+
+    var RadioButtonsView = IPython.DOMWidgetView.extend({    
         render : function(){
+            // Called when view is rendered.
             this.$el
                 .addClass('widget-hbox');
             this.$label = $('<div />')
                 .appendTo(this.$el)
                 .addClass('widget-hlabel')
                 .hide();
             this.$container = $('<div />')
                 .appendTo(this.$el)
                 .addClass('widget-container')
                 .addClass('vbox');
             this.$el_to_style = this.$container; // Set default element to style
             this.update();
         },
         
         update : function(options){
             // Update the contents of this view
             //
             // Called when the model is changed.  The model may have been 
             // changed by another view or by a state update from the back-end.
             if (options === undefined || options.updated_view != this) {
                 // Add missing items to the DOM.
                 var items = this.model.get('values');
                 var disabled = this.model.get('disabled');
                 for (var index in items) {
                     var item_query = ' :input[value="' + items[index] + '"]';
                     if (this.$el.find(item_query).length === 0) {
                         var $label = $('<label />')
                             .addClass('radio')
                             .html(items[index])
                             .appendTo(this.$container);
                         
                         $('<input />')
                             .attr('type', 'radio')
                             .addClass(this.model)
                             .val(items[index])
                             .prependTo($label)
                             .on('click', $.proxy(this.handle_click, this));
                     }
                     
                     var $item_element = this.$container.find(item_query);
                     if (this.model.get('value') == items[index]) {
                         $item_element.prop('checked', true);
                     } else {
                         $item_element.prop('checked', false);
                     }
                     $item_element.prop('disabled', disabled);
                 }
                 
                 // Remove items that no longer exist.
                 this.$container.find('input').each(function(i, obj) {
                     var value = $(obj).val();
                     var found = false;
                     for (var index in items) {
                         if (items[index] == value) {
                             found = true;
                             break;
                         }
                     }
                     
                     if (!found) {
                         $(obj).parent().remove();
                     }
                 });
 
                 var description = this.model.get('description');
                 if (description.length === 0) {
                     this.$label.hide();
                 } else {
                     this.$label.html(description);
                     this.$label.show();
                 }
             }
             return RadioButtonsView.__super__.update.apply(this);
         },
 
-        // Handle when a value is clicked.
         handle_click: function (e) {
+            // Handle when a value is clicked.
             
             // Calling model.set will trigger all of the other views of the 
             // model to update.
             this.model.set('value', $(e.target).val(), {updated_view: this});
             this.touch();
         },
     });
-
     widget_manager.register_widget_view('RadioButtonsView', RadioButtonsView);
 
 
-    var ToggleButtonsView = IPython.DOMWidgetView.extend({
-        
-        // Called when view is rendered.
+    var ToggleButtonsView = IPython.DOMWidgetView.extend({    
         render : function(){
+            // Called when view is rendered.
             this.$el
                 .addClass('widget-hbox-single');
             this.$label = $('<div />')
                 .appendTo(this.$el)
                 .addClass('widget-hlabel')
                 .hide();
             this.$buttongroup = $('<div />')
                 .addClass('btn-group')
                 .attr('data-toggle', 'buttons-radio')
                 .appendTo(this.$el);
             this.$el_to_style = this.$buttongroup; // Set default element to style
             this.update();
         },
         
         update : function(options){
             // Update the contents of this view
             //
             // Called when the model is changed.  The model may have been 
             // changed by another view or by a state update from the back-end.
             if (options === undefined || options.updated_view != this) {
                 // Add missing items to the DOM.
                 var items = this.model.get('values');
                 var disabled = this.model.get('disabled');
                 for (var index in items) {
                     var item_query = ' :contains("' + items[index] + '")';
                     if (this.$buttongroup.find(item_query).length === 0) {
                         $('<button />')
                             .attr('type', 'button')
                             .addClass('btn')
                             .html(items[index])
                             .appendTo(this.$buttongroup)
                             .on('click', $.proxy(this.handle_click, this));
                     }
                     
                     var $item_element = this.$buttongroup.find(item_query);
                     if (this.model.get('value') == items[index]) {
                         $item_element.addClass('active');
                     } else {
                         $item_element.removeClass('active');
                     }
                     $item_element.prop('disabled', disabled);
                 }
                 
                 // Remove items that no longer exist.
                 this.$buttongroup.find('button').each(function(i, obj) {
                     var value = $(obj).html();
                     var found = false;
                     for (var index in items) {
                         if (items[index] == value) {
                             found = true;
                             break;
                         }
                     }
                     
                     if (!found) {
                         $(obj).remove();
                     }
                 });
 
                 var description = this.model.get('description');
                 if (description.length === 0) {
                     this.$label.hide();
                 } else {
                     this.$label.html(description);
                     this.$label.show();
                 }
             }
             return ToggleButtonsView.__super__.update.apply(this);
         },
 
-        // Handle when a value is clicked.
         handle_click: function (e) {
+            // Handle when a value is clicked.
             
             // Calling model.set will trigger all of the other views of the 
             // model to update.
             this.model.set('value', $(e.target).html(), {updated_view: this});
             this.touch();
-        },
-        
+        },    
     });
-
     widget_manager.register_widget_view('ToggleButtonsView', ToggleButtonsView);
 
-    var ListBoxView = IPython.DOMWidgetView.extend({
-        
-        // Called when view is rendered.
+
+    var ListBoxView = IPython.DOMWidgetView.extend({    
         render : function(){
+            // Called when view is rendered.
             this.$el
                 .addClass('widget-hbox');
             this.$label = $('<div />')
                 .appendTo(this.$el)
                 .addClass('widget-hlabel')
                 .hide();
             this.$listbox = $('<select />')
                 .addClass('widget-listbox')
                 .attr('size', 6)
                 .appendTo(this.$el);
             this.$el_to_style = this.$listbox; // Set default element to style
             this.update();
         },
         
         update : function(options){
             // Update the contents of this view
             //
             // Called when the model is changed.  The model may have been 
             // changed by another view or by a state update from the back-end.
             if (options === undefined || options.updated_view != this) {
                 // Add missing items to the DOM.
                 var items = this.model.get('values');
                 for (var index in items) {
                     var item_query = ' :contains("' + items[index] + '")';
                     if (this.$listbox.find(item_query).length === 0) {
                         $('<option />')
                             .html(items[index])
                             .attr('value', items[index])
                             .appendTo(this.$listbox)
                             .on('click', $.proxy(this.handle_click, this));
                     }
                 }
 
                 // Select the correct element
                 this.$listbox.val(this.model.get('value'));
                 
                 // Disable listbox if needed
                 var disabled = this.model.get('disabled');
                 this.$listbox.prop('disabled', disabled);
 
                 // Remove items that no longer exist.
                 this.$listbox.find('option').each(function(i, obj) {
                     var value = $(obj).html();
                     var found = false;
                     for (var index in items) {
                         if (items[index] == value) {
                             found = true;
                             break;
                         }
                     }
                     
                     if (!found) {
                         $(obj).remove();
                     }
                 });
 
                 var description = this.model.get('description');
                 if (description.length === 0) {
                     this.$label.hide();
                 } else {
                     this.$label.html(description);
                     this.$label.show();
                 }
             }
             return ListBoxView.__super__.update.apply(this);
         },
 
-        // Handle when a value is clicked.
         handle_click: function (e) {
+            // Handle when a value is clicked.
             
             // Calling model.set will trigger all of the other views of the 
             // model to update.
             this.model.set('value', $(e.target).html(), {updated_view: this});
             this.touch();
-        },
-        
+        },    
     });
-
     widget_manager.register_widget_view('ListBoxView', ListBoxView);
 });

IPython/html/static/notebook/js/widgets/widget_selectioncontainer.js

@@ -1,248 +1,244
 //----------------------------------------------------------------------------
 //  Copyright (C) 2013 The IPython Development Team
 //
 //  Distributed under the terms of the BSD License.  The full license is in
 //  the file COPYING, distributed as part of this software.
 //----------------------------------------------------------------------------
 
 //============================================================================
 // SelectionContainerWidget
 //============================================================================
 
 /**
  * @module IPython
  * @namespace IPython
  **/
 
 define(["notebook/js/widgets/widget"], function(widget_manager){
+
     var AccordionView = IPython.DOMWidgetView.extend({
-        
         render: function(){
+            // Called when view is rendered.
             var guid = 'accordion' + IPython.utils.uuid();
             this.$el
                 .attr('id', guid)
                 .addClass('accordion');
             this.containers = [];
             this.model_containers = {};
             this.update_children([], this.model.get('children'));
             this.model.on('change:children', function(model, value, options) {
                 this.update_children(model.previous('children'), value);
             }, this);
         },
         
         update: function(options) {
             // Update the contents of this view
             //
             // Called when the model is changed.  The model may have been 
             // changed by another view or by a state update from the back-end.
-            
             if (options === undefined || options.updated_view != this) {
                 // Set tab titles
                 var titles = this.model.get('_titles');
                 for (var page_index in titles) {
 
                     var accordian = this.containers[page_index];
                     if (accordian !== undefined) {
                         accordian
                             .find('.accordion-heading')
                             .find('.accordion-toggle')
                             .html(titles[page_index]);
                     }
                 }
 
                 // Set selected page
                 var selected_index = this.model.get("selected_index");
                 if (0 <= selected_index && selected_index < this.containers.length) {
                     for (var index in this.containers) {
                         if (index==selected_index) {
                             this.containers[index].find('.accordion-body').collapse('show');    
                         } else {
                             this.containers[index].find('.accordion-body').collapse('hide');    
                         }
                         
                     }
                 }
             }
             return AccordionView.__super__.update.apply(this);
         },
         
         update_children: function(old_list, new_list) {
+            // Called when the children list is modified.
             this.do_diff(old_list, 
                 new_list, 
                 $.proxy(this.remove_child_model, this),
                 $.proxy(this.add_child_model, this));
         },
 
         remove_child_model: function(model) {
+            // Called when a child is removed from children list.
             var accordion_group = this.model_containers[model.id];
             this.containers.splice(accordion_group.container_index, 1);
             delete this.model_containers[model.id];
             accordion_group.remove();
             this.delete_child_view(model);
         },
 
         add_child_model: function(model) {
+            // Called when a child is added to children list.
             var view = this.create_child_view(model);
             var index = this.containers.length;
             var uuid = IPython.utils.uuid();
             var accordion_group = $('<div />')
                 .addClass('accordion-group')
                 .appendTo(this.$el);
             var accordion_heading = $('<div />')
                 .addClass('accordion-heading')
                 .appendTo(accordion_group);
             var that = this;
             var accordion_toggle = $('<a />')
                 .addClass('accordion-toggle')
                 .attr('data-toggle', 'collapse')
                 .attr('data-parent', '#' + this.$el.attr('id'))
                 .attr('href', '#' + uuid)
                 .click(function(evt){ 
             
                     // Calling model.set will trigger all of the other views of the 
                     // model to update.
                     that.model.set("selected_index", index, {updated_view: this});
                     that.touch();
                  })
                 .html('Page ' + index)
                 .appendTo(accordion_heading);
             var accordion_body = $('<div />', {id: uuid})
                 .addClass('accordion-body collapse')
                 .appendTo(accordion_group);
             var accordion_inner = $('<div />')
                 .addClass('accordion-inner')
                 .appendTo(accordion_body);
             var container_index = this.containers.push(accordion_group) - 1;
             accordion_group.container_index = container_index;
             this.model_containers[model.id] = accordion_group;
             accordion_inner.append(view.$el);
 
             this.update();
 
             // Stupid workaround to close the bootstrap accordion tabs which
             // open by default even though they don't have the `in` class
             // attached to them.  For some reason a delay is required.  
             // TODO: Better fix.
             setTimeout(function(){ that.update(); }, 500);
         },
     });
-
     widget_manager.register_widget_view('AccordionView', AccordionView);
     
-    var TabView = IPython.DOMWidgetView.extend({
-        
+
+    var TabView = IPython.DOMWidgetView.extend({    
         initialize: function() {
+            // Public constructor.
             this.containers = [];
             TabView.__super__.initialize.apply(this, arguments);
         },
 
         render: function(){
+            // Called when view is rendered.
             var uuid = 'tabs'+IPython.utils.uuid();
             var that = this;
             this.$tabs = $('<div />', {id: uuid})
                 .addClass('nav')
                 .addClass('nav-tabs')
                 .appendTo(this.$el);
             this.$tab_contents = $('<div />', {id: uuid + 'Content'})
                 .addClass('tab-content')
                 .appendTo(this.$el);
             this.containers = [];
             this.update_children([], this.model.get('children'));
             this.model.on('change:children', function(model, value, options) {
                 this.update_children(model.previous('children'), value);
             }, this);
         },
-        
-        update_children: function(old_list, new_list) {
-            _.each(this.containers, function(element, index, list) {
-                element.remove();
-            }, this);
-            this.containers = [];
-            this.update_child_views(old_list, new_list);
-            _.each(new_list, function(element, index, list) {
-                this.add_child_view(this.child_views[element]);
-            }, this)
-        },
-        
+
         update_children: function(old_list, new_list) {
+            // Called when the children list is modified.
             this.do_diff(old_list, 
                 new_list, 
                 $.proxy(this.remove_child_model, this),
                 $.proxy(this.add_child_model, this));
         },
 
         remove_child_model: function(model) {
+            // Called when a child is removed from children list.
             var view = this.child_views[model.id];
             this.containers.splice(view.parent_tab.tab_text_index, 1);
             view.parent_tab.remove();
             view.parent_container.remove();
             view.remove();
             this.delete_child_view(model);
         },
 
         add_child_model: function(model) {
+            // Called when a child is added to children list.
             var view = this.create_child_view(model);
             var index = this.containers.length;
             var uuid = IPython.utils.uuid();
 
             var that = this;
             var tab = $('<li />')
                 .css('list-style-type', 'none')
                 .appendTo(this.$tabs);
             view.parent_tab = tab;
 
             var tab_text = $('<a />')
                 .attr('href', '#' + uuid)
                 .attr('data-toggle', 'tab') 
                 .html('Page ' + index)
                 .appendTo(tab)
                 .click(function (e) {
             
                     // Calling model.set will trigger all of the other views of the 
                     // model to update.
                     that.model.set("selected_index", index, {updated_view: this});
                     that.touch();
                     that.select_page(index);
                 });
             tab.tab_text_index = this.containers.push(tab_text) - 1;
 
             var contents_div = $('<div />', {id: uuid})
                 .addClass('tab-pane')
                 .addClass('fade')
                 .append(view.$el)
                 .appendTo(this.$tab_contents);
             view.parent_container = contents_div;
         },
 
         update: function(options) {
             // Update the contents of this view
             //
             // Called when the model is changed.  The model may have been 
             // changed by another view or by a state update from the back-end.
             if (options === undefined || options.updated_view != this) {
                 // Set tab titles
                 var titles = this.model.get('_titles');
                 for (var page_index in titles) {
                     var tab_text = this.containers[page_index];
                     if (tab_text !== undefined) {
                         tab_text.html(titles[page_index]);
                     }
                 }
 
                 var selected_index = this.model.get('selected_index');
                 if (0 <= selected_index && selected_index < this.containers.length) {
                     this.select_page(selected_index);
                 }
             }
             return TabView.__super__.update.apply(this);
         },
 
         select_page: function(index) {
+            // Select a page.
             this.$tabs.find('li')
                 .removeClass('active');
             this.containers[index].tab('show');
         },
     });
-
     widget_manager.register_widget_view('TabView', TabView);
 });

IPython/html/static/notebook/js/widgets/widget_string.js

@@ -1,199 +1,197
 //----------------------------------------------------------------------------
 //  Copyright (C) 2013 The IPython Development Team
 //
 //  Distributed under the terms of the BSD License.  The full license is in
 //  the file COPYING, distributed as part of this software.
 //----------------------------------------------------------------------------
 
 //============================================================================
 // StringWidget
 //============================================================================
 
 /**
  * @module IPython
  * @namespace IPython
  **/
 
 define(["notebook/js/widgets/widget"], function(widget_manager){
-    var HTMLView = IPython.DOMWidgetView.extend({
-      
-        // Called when view is rendered.
+
+    var HTMLView = IPython.DOMWidgetView.extend({  
         render : function(){
+            // Called when view is rendered.
             this.update(); // Set defaults.
         },
         
         update : function(){
             // Update the contents of this view
             //
             // Called when the model is changed.  The model may have been 
             // changed by another view or by a state update from the back-end.
             this.$el.html(this.model.get('value'));
             return HTMLView.__super__.update.apply(this);
         },
-        
     });
-
     widget_manager.register_widget_view('HTMLView', HTMLView);
 
 
-    var LatexView = IPython.DOMWidgetView.extend({
-      
-        // Called when view is rendered.
+    var LatexView = IPython.DOMWidgetView.extend({  
         render : function(){
+            // Called when view is rendered.
             this.update(); // Set defaults.
         },
         
         update : function(){
             // Update the contents of this view
             //
             // Called when the model is changed.  The model may have been 
             // changed by another view or by a state update from the back-end.
             this.$el.html(this.model.get('value'));
             MathJax.Hub.Queue(["Typeset",MathJax.Hub,this.$el.get(0)]);
 
             return LatexView.__super__.update.apply(this);
-        },
-        
+        }, 
     });
-
     widget_manager.register_widget_view('LatexView', LatexView);
 
-    var TextAreaView = IPython.DOMWidgetView.extend({
-      
-        // Called when view is rendered.
+
+    var TextAreaView = IPython.DOMWidgetView.extend({  
         render: function(){
+            // Called when view is rendered.
             this.$el
                 .addClass('widget-hbox')
                 .html('');
             this.$label = $('<div />')
                 .appendTo(this.$el)
                 .addClass('widget-hlabel')
                 .hide();
             this.$textbox = $('<textarea />')
                 .attr('rows', 5)
                 .addClass('widget-text')
                 .appendTo(this.$el);
             this.$el_to_style = this.$textbox; // Set default element to style
             this.update(); // Set defaults.
 
             this.model.on('msg:custom', $.proxy(this._handle_textarea_msg, this));
         },
 
-
         _handle_textarea_msg: function (content){
+            // Handle when a custom msg is recieved from the back-end.
             if (content.method == "scroll_to_bottom") {
                 this.scroll_to_bottom();                
             }
         },
 
-
         scroll_to_bottom: function (){
+            // Scroll the text-area view to the bottom.
             this.$textbox.scrollTop(this.$textbox[0].scrollHeight);
         },
 
-        
         update: function(options){
             // Update the contents of this view
             //
             // Called when the model is changed.  The model may have been 
             // changed by another view or by a state update from the back-end.
             if (options === undefined || options.updated_view != this) {
                 this.$textbox.val(this.model.get('value'));
 
                 var disabled = this.model.get('disabled');
                 this.$textbox.prop('disabled', disabled);
 
                 var description = this.model.get('description');
                 if (description.length === 0) {
                     this.$label.hide();
                 } else {
                     this.$label.html(description);
                     this.$label.show();
                 }
             }
             return TextAreaView.__super__.update.apply(this);
         },
         
-        events: {"keyup textarea": "handleChanging",
-                "paste textarea": "handleChanging",
-                "cut textarea": "handleChanging"},
+        events: {
+            // Dictionary of events and their handlers.
+            "keyup textarea": "handleChanging",
+            "paste textarea": "handleChanging",
+            "cut textarea": "handleChanging"
+        },
         
-        // Handles and validates user input.
         handleChanging: function(e) { 
+            // Handles and validates user input.
             
             // Calling model.set will trigger all of the other views of the 
             // model to update.
             this.model.set('value', e.target.value, {updated_view: this});
             this.touch();
         },
     });
-
     widget_manager.register_widget_view('TextAreaView', TextAreaView);
 
-    var TextBoxView = IPython.DOMWidgetView.extend({
-      
-        // Called when view is rendered.
+
+    var TextBoxView = IPython.DOMWidgetView.extend({  
         render: function(){
+            // Called when view is rendered.
             this.$el
                 .addClass('widget-hbox-single')
                 .html('');
             this.$label = $('<div />')
                 .addClass('widget-hlabel')
                 .appendTo(this.$el)
                 .hide();
             this.$textbox = $('<input type="text" />')
                 .addClass('input')
                 .addClass('widget-text')
                 .appendTo(this.$el);
             this.$el_to_style = this.$textbox; // Set default element to style
             this.update(); // Set defaults.
         },
         
         update: function(options){
             // Update the contents of this view
             //
             // Called when the model is changed.  The model may have been 
             // changed by another view or by a state update from the back-end.
             if (options === undefined || options.updated_view != this) {
                 if (this.$textbox.val() != this.model.get('value')) {
                     this.$textbox.val(this.model.get('value'));
                 }
 
                 var disabled = this.model.get('disabled');
                 this.$textbox.prop('disabled', disabled);
 
                 var description = this.model.get('description');
                 if (description.length === 0) {
                     this.$label.hide();
                 } else {
                     this.$label.html(description);
                     this.$label.show();
                 }
             }
             return TextBoxView.__super__.update.apply(this);
         },
         
-        events: {"keyup input": "handleChanging",
-                "paste input": "handleChanging",
-                "cut input": "handleChanging",
-                "keypress input": "handleKeypress"},
+        events: {
+            // Dictionary of events and their handlers.
+            "keyup input": "handleChanging",
+            "paste input": "handleChanging",
+            "cut input": "handleChanging",
+            "keypress input": "handleKeypress"
+        },
         
-        // Handles and validates user input.
         handleChanging: function(e) { 
+            // Handles and validates user input.
             
             // Calling model.set will trigger all of the other views of the 
             // model to update.
             this.model.set('value', e.target.value, {updated_view: this});
             this.touch();
         },
         
-        // Handles text submition
         handleKeypress: function(e) { 
+            // Handles text submition
             if (e.keyCode == 13) { // Return key
                 this.send({event: 'submit'});
             }
         },
     });
-
     widget_manager.register_widget_view('TextBoxView', TextBoxView);
 });