upstream/ipython Commit - r14609:af37dd33

Added PEP8 style comments to all of the JS code.

Jonathan Frederic -

r14609:af37dd33

parent child

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

0 +41 -26

                      "underscore",
                      "backbone"],
              function(widget_manager, underscore, backbone){
-                 //--------------------------------------------------------------------
-                 // WidgetModel class
-                 //--------------------------------------------------------------------
                  var WidgetModel = Backbone.Model.extend({
                      constructor: function (widget_manager, model_id, comm) {
                          // Construcctor
                      },
                      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;
                          // 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':
                          }
                      },
-                     // 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.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
                          }
                      },
-                     // Custom syncronization logic.
                      _handle_sync: function (method, options) {
+                         // Custom syncronization logic.
                          var model_json = this.toJSON();
                          var attr;
                      },
                      _pack_models: function(value) {
+                         // Replace models with model ids recursively.
                          if (value instanceof Backbone.Model) {
                              return value.id;
                          } else if (value instanceof Object) {
                      },
                      _unpack_models: function(value) {
+                         // Replace model ids with models recursively.
                          if (value instanceof Object) {
                              var unpacked = {};
                              for (var key in 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 = [];
                      },
                      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();
                      },
                      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);
                      },
                      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);
                      },
                      },
                      _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) {
                  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

0 +7 -8

               **/
              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 />')
                      },
                      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');
                      },
                  });
                  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')
                          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.
                          this.touch();
                      },
                  });
                  widget_manager.register_widget_view('ToggleButtonView', ToggleButtonView);
              });

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

0 +5 -5

               **/
              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'));
                      },
                      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

0 +16 -9

               **/
              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={};
                      },
                      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),
                      },
                      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);
                      },
                          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'));
                      },
                      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");
                      },
                      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){
                      },
                      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),
                      },
                      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);
                      },
                      },
                      _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:
                              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

0 +27 -26

               **/
              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 />')
                          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 />')
                          //
                          // 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) {
                          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 !== '') {
                          }
                      },
-                     // 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 />')
                              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

0 +3 -6

               **/
              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.
                      },
                          }
                          return ImageView.__super__.update.apply(this);
                      },
                  });
                  widget_manager.register_widget_view('ImageView', ImageView);
              });

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

0 +25 -20

               **/
              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 />')
                          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 />')
                          }
                          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;
                          }
                      },
-                     // 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

0 +16 -24

               **/
              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('');
                          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.
                      },
                  });
                  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 />')
                          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.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 />')
                          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 />')
                          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

0 +14 -18

               **/
              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)
                          //
                          // 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');
                      },
                      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),
                      },
                      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];
                      },
                      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();
                          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})
                              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),
                      },
                      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();
                      },
                      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();
                      },
                      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

0 +30 -32

               **/
              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.
                      },
                          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.
                      },
                          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.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
                          //
                          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.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('');
                          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.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);
              });

General Comments 0

Write
Preview

You need to be logged in to leave comments. Login now

No TODOs yet

	Site-wide shortcuts
/	Use quick search box
g h	Goto home page
g g	Goto my private gists page
g G	Goto my public gists page
g 0-9	Goto bookmarked items from 0-9
n r	New repository page
n g	New gist page

	Repositories
g s	Goto summary page
g c	Goto changelog page
g f	Goto files page
g F	Goto files page with file search activated
g p	Goto pull requests page
g o	Goto repository settings
g O	Goto repository access permissions settings
t s	Toggle sidebar on some pages