Note todos for widgets

IPython/html/static/notebook/js/widgetmanager.js

@@ -1,209 +1,208 b''
 //----------------------------------------------------------------------------
 //  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.
 //----------------------------------------------------------------------------
 
 //============================================================================
 // WidgetModel, WidgetView, and WidgetManager
 //============================================================================
 /**
  * Base Widget classes
  * @module IPython
  * @namespace IPython
  * @submodule widget
  */
 
 (function () {
     "use strict";
 
     // Use require.js 'define' method so that require.js is intelligent enough to
     // syncronously load everything within this file when it is being 'required' 
     // elsewhere.
     define(["underscore",
              "backbone",
             ], function (underscore, backbone) {
 
         //--------------------------------------------------------------------
         // WidgetManager class
         //--------------------------------------------------------------------
         var WidgetManager = function () {
             this.comm_manager = null;
             this.widget_model_types = {};
             this.widget_view_types = {};
             this._model_instances = {};
             
             Backbone.sync = function (method, model, options, error) {
                 var result = model._handle_sync(method, options);
                 if (options.success) {
                   options.success(result);
                 }
             }; 
         };
 
 
         WidgetManager.prototype.attach_comm_manager = function (comm_manager) {
             this.comm_manager = comm_manager;
 
             // Register already-registered widget model types with the comm manager.
             for (var widget_model_name in this.widget_model_types) {
                 this.comm_manager.register_target(widget_model_name, $.proxy(this._handle_comm_open, this));
             }
         };
 
 
         WidgetManager.prototype.register_widget_model = function (widget_model_name, widget_model_type) {
             // Register the widget with the comm manager.  Make sure to pass this object's context
             // in so `this` works in the call back.
             if (this.comm_manager !== null) {
                 this.comm_manager.register_target(widget_model_name, $.proxy(this._handle_comm_open, this));
             }
             this.widget_model_types[widget_model_name] = widget_model_type;
         };
 
 
         WidgetManager.prototype.register_widget_view = function (widget_view_name, widget_view_type) {
             this.widget_view_types[widget_view_name] = widget_view_type;
         };
 	WidgetManager.prototype.handle_msg = function(msg, model) {
 	    var method = msg.content.data.method;
 	    switch (method) {
 		case 'display':
 		    var cell = this.get_msg_cell(msg.parent_header.msg_id);
 		    if (cell === null) {
 			console.log("Could not determine where the display" + 
 				    " message was from.  Widget will not be displayed");
 		    } else {
 			var view = this.create_view(model, 
 						    msg.content.data.view_name, cell);
 			if (view !== undefined 
 			    && cell.widget_subarea !== undefined 
 			    && cell.widget_subarea !== null) {
                             cell.widget_area.show();
                             cell.widget_subarea.append(view.$el);
 			}
 		    }
 		    break;
 	    }
 	}
 
 	WidgetManager.prototype.create_view = function(model, view_name, cell) {
 	    view_name = view_name || model.get('default_view_name');
             var ViewType = this.widget_view_types[view_name];
             if (ViewType !== undefined && ViewType !== null) {
                 var view = new ViewType({model: model, widget_manager: this, cell: cell});
                 view.render();
 		model.views.push(view);
+		model.on('destroy', view.remove, view);
 		/*
-                // jng: Handle when the view element is remove from the page.
-		// observe the view destruction event and do this.  We may need
-		// to override the view's remove method to trigger this event.
+                // TODO: handle view deletion.  Don't forget to delete child views
                 var that = this;
                 view.$el.on("remove", function () { 
                     var index = that.views.indexOf(view);
                     if (index > -1) {
                         that.views.splice(index, 1);
                     }
                     view.remove(); // Clean-up view 
 
                     // Close the comm if there are no views left.
                     if (that.views.length() === 0) {
-			//jng: trigger comm close event
+			//trigger comm close event?
                         }
 
 		        
                         if (that.comm !== undefined) {
                             that.comm.close();
                             delete that.comm.model; // Delete ref so GC will collect widget model.
                             delete that.comm;
                         }
                         delete that.widget_id; // Delete id from model so widget manager cleans up.
                     });
 		*/
                 return view;
             }
         },
 
         WidgetManager.prototype.get_msg_cell = function (msg_id) {
 	    var cell = null;
             // First, check to see if the msg was triggered by cell execution.
             if (IPython.notebook !== undefined && IPython.notebook !== null) {
                 cell = IPython.notebook.get_msg_cell(msg_id);
             }
 	    if (cell !== null) {
 		return cell
 	    }
             // Second, check to see if a get_cell callback was defined
             // for the message.  get_cell callbacks are registered for
             // widget messages, so this block is actually checking to see if the
             // message was triggered by a widget.
             var kernel = this.get_kernel();
             if (kernel !== undefined && kernel !== null) {
                 var callbacks = kernel.get_callbacks_for_msg(msg_id);
                 if (callbacks !== undefined && 
                     callbacks.iopub !== undefined && 
                     callbacks.iopub.get_cell !== undefined) {
 
                     return callbacks.iopub.get_cell();
                 }    
             }
             
             // Not triggered by a cell or widget (no get_cell callback 
             // exists).
             return null;
         };
 
 
         WidgetManager.prototype.get_model = function (widget_id) {
             var model = this._model_instances[widget_id];
             if (model !== undefined && model.id == widget_id) {
                 return model;
             }
             return null;
         };
 
 
         WidgetManager.prototype.get_kernel = function () {
             if (this.comm_manager === null) {
                 return null;
             } else {
                 return this.comm_manager.kernel;
             }
         };
 
 
         WidgetManager.prototype.on_create_widget = function (callback) {
             this._create_widget_callback = callback;
         };
 
 
         WidgetManager.prototype._handle_create_widget = function (widget_model) {
             if (this._create_widget_callback) {
                 try {
                     this._create_widget_callback(widget_model);
                 } catch (e) {
                     console.log("Exception in WidgetManager callback", e, widget_model);
                 }
             }
         };
 
 
         WidgetManager.prototype._handle_comm_open = function (comm, msg) {
             var widget_type_name = msg.content.target_name;
             var widget_model = new this.widget_model_types[widget_type_name](this, comm.comm_id, comm);
             this._model_instances[comm.comm_id] = widget_model;
             this._handle_create_widget(widget_model);
         };
         
         //--------------------------------------------------------------------
         // Init code
         //--------------------------------------------------------------------
         IPython.WidgetManager = WidgetManager;
         if (IPython.widget_manager === undefined || IPython.widget_manager === null) {
             IPython.widget_manager = new WidgetManager();    
         }
 
         return IPython.widget_manager;
     });
 }());

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

@@ -1,311 +1,309 b''
 //----------------------------------------------------------------------------
 //  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, widget_id, comm) {
             this.widget_manager = widget_manager;
             this.pending_msgs = 0;
             this.msg_throttle = 3;
             this.msg_buffer = null;
             this.id = widget_id;
 	    this.views = [];
 
             if (comm !== undefined) {
                 // Remember comm associated with the model.
                 this.comm = comm;
                 comm.model = this;
 
                 // Hook comm messages up to model.
 		var that = this;
                 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) {
             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) {
-	    // jng: widget manager should observe the comm_close event and delete views when triggered
-	    
 	    this.trigger('comm:close');
             delete this.comm.model; // Delete ref so GC will collect widget model.
             delete this.comm;
             delete this.widget_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) {
             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;
 		default:
 		    // pass on to widget manager
 		    this.widget_manager.handle_msg(msg, this);
             }
         },
 
 
         // Handle when a widget is updated via the python side.
         apply_update: function (state) {
             this.updating = true;
             try {
                 for (var key in state) {
                     if (state.hasOwnProperty(key)) {
                             this.set(key, state[key]);
                     }
                 }
                 this.save();
             } finally {
                 this.updating = false;
             }
         },
 
 
         _handle_status: function (msg, callbacks) {
             //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 {
 
                         // Only decrease the pending message count if the buffer
                         // doesn't get flushed (sent).
                         --this.pending_msgs;
                     }
                 }
             }
         },
 
 
         // Custom syncronization logic.
         _handle_sync: function (method, options) {
             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.updating) {
                     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 (method=='patch') {
                             if (this.msg_buffer === null) {
                                 this.msg_buffer = $.extend({}, model_json); // Copy
                             }
                             for (attr in options.attrs) {
                                 this.msg_buffer[attr] = options.attrs[attr];
                             }
                         } else {
                             this.msg_buffer = $.extend({}, model_json); // Copy
                         }
 
                     } 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;
                         if (method =='patch') {
                             send_json = {};
                             for (attr in options.attrs) {
                                 send_json[attr] = options.attrs[attr];
                             }
                         }
 
                         var data = {method: 'backbone', sync_method: method, sync_data: send_json};
                         this.comm.send(data, this.callbacks);
                         this.pending_msgs++;
                     }
                 }
             }
             
             // Since the comm is a one-way communication, assume the message 
             // arrived.
             return model_json;
         },
 
     });
 
 
     //--------------------------------------------------------------------
     // WidgetView class
     //--------------------------------------------------------------------
     var BaseWidgetView = Backbone.View.extend({
         initialize: function(options) {
             this.model.on('change',this.update,this);
 	    this.widget_manager = options.widget_manager;
 	    this.comm_manager = options.widget_manager.comm_manager;
 	    this.cell = options.cell;
 	    this.child_views = [];
         },
 
 	update: function(){
 	    // update thyself to be consistent with this.model
 	},
 
 	child_view: function(comm_id, view_name) {
 	    var child_model = this.comm_manager.comms[comm_id].model;
 	    var child_view = this.widget_manager.create_view(child_model, view_name, this.cell);
 	    this.child_views.push(child_view);
 	    return child_view;
 	},
 
 	render: function(){
 	    // render thyself
 	},
         send: function (content) {
             this.model.send(content, this.cell_callbacks(this.cell));
         },
 
         touch: function () {
             this.model.callbacks = this.cell_callbacks();
             this.model.save(this.model.changedAttributes(), {patch: true});
         },
 
         cell_callbacks: function () {
 	    // callback handlers specific to this view's cell
             var callbacks = {};
 	    var cell = this.cell;
             if (cell !== null) {
                 
                 // Try to get output handlers
                 var handle_output = null;
                 var handle_clear_output = null;
                 if (cell.output_area !== undefined && cell.output_area !== null) {
                     handle_output = $.proxy(cell.output_area.handle_output, cell.output_area);
                     handle_clear_output = $.proxy(cell.output_area.handle_clear_output, cell.output_area);
                 }
 
                 // Create callback dict using what is known
                 var that = this;
                 callbacks = {
                     iopub : {
                         output : handle_output,
                         clear_output : handle_clear_output,
 
                         status : function (msg) {
                             that._handle_status(msg, that.cell_callbacks());
                         },
 
                         // Special function only registered by widget messages.
                         // Allows us to get the cell for a message so we know
                         // where to add widgets if the code requires it.
                         get_cell : function () {
                             return cell;
                         },
                     },
                 };
             }
             return callbacks;
         },
 
     });
 
     var WidgetView = BaseWidgetView.extend({
         initialize: function (options) {
 	    this.model.on('change:visible', function() {this.$el.toggle(this.model.get('visible'))}, this);
 	    this.model.on('change', this.update_css, this);
 	    BaseWidgetView.prototype.initialize.apply(this, arguments);
         },
 			  
 	
         add_class: function (selector, class_list) {
             var elements = this._get_selector_element(selector);
             if (elements.length > 0) {
                 elements.addClass(class_list);
             }
         },
         
         remove_class: function (selector, class_list) {
             var elements = this._get_selector_element(selector);
             if (elements.length > 0) {
                 elements.removeClass(class_list);
             }
         },
 	
         update_css: function () {
 	    var css = this.model.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.
             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;
 
     return widget_manager;
 });