widget.js
418 lines
| 15.3 KiB
| application/javascript
|
JavascriptLexer
|
r14546 | //---------------------------------------------------------------------------- | ||
// 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"], | ||||
|
r14627 | function(WidgetManager, Underscore, Backbone){ | ||
|
r14609 | |||
|
r14546 | var WidgetModel = Backbone.Model.extend({ | ||
constructor: function (widget_manager, model_id, comm) { | ||||
|
r14792 | // Constructor | ||
|
r14561 | // | ||
// Creates a WidgetModel instance. | ||||
// | ||||
// Parameters | ||||
// ---------- | ||||
// widget_manager : WidgetManager instance | ||||
// model_id : string | ||||
// An ID unique to this model. | ||||
// comm : Comm instance (optional) | ||||
|
r14546 | this.widget_manager = widget_manager; | ||
this.pending_msgs = 0; | ||||
|
r14691 | this.msg_throttle = 3; | ||
|
r14546 | this.msg_buffer = null; | ||
|
r14563 | this.key_value_lock = null; | ||
|
r14546 | 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) { | ||||
|
r14609 | // Send a custom msg over the comm. | ||
|
r14546 | if (this.comm !== undefined) { | ||
|
r14655 | var data = {method: 'custom', content: content}; | ||
|
r14546 | this.comm.send(data, callbacks); | ||
|
r14741 | this.pending_msgs++; | ||
|
r14546 | } | ||
}, | ||||
_handle_comm_closed: function (msg) { | ||||
|
r14609 | // Handle when a widget is closed. | ||
|
r14546 | 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. | ||||
|
r14704 | _.each(this.views, function(view, i) { | ||
view.remove(); | ||||
}); | ||||
|
r14546 | }, | ||
_handle_comm_msg: function (msg) { | ||||
|
r14609 | // Handle incoming comm msg. | ||
|
r14546 | var method = msg.content.data.method; | ||
switch (method) { | ||||
case 'update': | ||||
this.apply_update(msg.content.data.state); | ||||
break; | ||||
case 'custom': | ||||
|
r14655 | this.trigger('msg:custom', msg.content.data.content); | ||
|
r14546 | break; | ||
|
r14559 | case 'display': | ||
|
r14620 | this.widget_manager.display_view(msg, this); | ||
|
r14559 | break; | ||
|
r14546 | } | ||
}, | ||||
apply_update: function (state) { | ||||
|
r14609 | // Handle when a widget is updated via the python side. | ||
|
r14686 | var that = this; | ||
|
r14664 | _.each(state, function(value, key) { | ||
|
r14686 | that.key_value_lock = [key, value]; | ||
|
r14664 | try { | ||
|
r14686 | that.set(key, that._unpack_models(value)); | ||
|
r14664 | } finally { | ||
|
r14686 | that.key_value_lock = null; | ||
|
r14546 | } | ||
|
r14664 | }); | ||
|
r14546 | }, | ||
_handle_status: function (msg, callbacks) { | ||||
|
r14609 | // Handle status msgs. | ||
// execution_state : ('busy', 'idle', 'starting') | ||||
|
r14596 | 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}; | ||||
|
r14792 | this.comm.send(data, callbacks); | ||
|
r14596 | this.msg_buffer = null; | ||
} else { | ||||
--this.pending_msgs; | ||||
} | ||||
|
r14546 | } | ||
} | ||||
}, | ||||
|
r14640 | callbacks: function(view) { | ||
|
r14639 | // Create msg callbacks for a comm msg. | ||
|
r14640 | var callbacks = this.widget_manager.callbacks(view); | ||
if (callbacks.iopub === undefined) { | ||||
callbacks.iopub = {}; | ||||
} | ||||
|
r14639 | var that = this; | ||
callbacks.iopub.status = function (msg) { | ||||
that._handle_status(msg, callbacks); | ||||
|
r14792 | }; | ||
|
r14639 | return callbacks; | ||
}, | ||||
|
r14546 | |||
|
r14639 | sync: function (method, model, options) { | ||
|
r14668 | // Handle sync to the back-end. Called when a model.save() is called. | ||
|
r14640 | |||
// Make sure a comm exists. | ||||
var error = options.error || function() { | ||||
console.error('Backbone sync error:', arguments); | ||||
|
r14792 | }; | ||
|
r14639 | if (this.comm === undefined) { | ||
error(); | ||||
return false; | ||||
} | ||||
|
r14640 | // Delete any key value pairs that the back-end already knows about. | ||
var attrs = (method === 'patch') ? options.attrs : model.toJSON(options); | ||||
|
r14639 | if (this.key_value_lock !== null) { | ||
|
r14640 | var key = this.key_value_lock[0]; | ||
var value = this.key_value_lock[1]; | ||||
if (attrs[key] === value) { | ||||
delete attrs[key]; | ||||
|
r14639 | } | ||
} | ||||
|
r14640 | // Only sync if there are attributes to send to the back-end. | ||
|
r14686 | if (_.size(attrs) > 0) { | ||
|
r14741 | |||
// If this message was sent via backbone itself, it will not | ||||
// have any callbacks. It's important that we create callbacks | ||||
// so we can listen for status messages, etc... | ||||
var callbacks = options.callbacks || this.callbacks(); | ||||
// Check throttle. | ||||
|
r14640 | 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. | ||||
// Combine updates if it is a 'patch' sync, otherwise replace updates | ||||
switch (method) { | ||||
case 'patch': | ||||
|
r14662 | this.msg_buffer = $.extend(this.msg_buffer || {}, attrs); | ||
|
r14640 | break; | ||
case 'update': | ||||
|
r14661 | case 'create': | ||
|
r14640 | this.msg_buffer = attrs; | ||
break; | ||||
default: | ||||
error(); | ||||
return false; | ||||
} | ||||
this.msg_buffer_callbacks = callbacks; | ||||
} else { | ||||
// We haven't exceeded the throttle, send the message like | ||||
|
r14741 | // normal. | ||
|
r14640 | var data = {method: 'backbone', sync_data: attrs}; | ||
this.comm.send(data, callbacks); | ||||
this.pending_msgs++; | ||||
} | ||||
|
r14546 | } | ||
// Since the comm is a one-way communication, assume the message | ||||
|
r14639 | // arrived. Don't call success since we don't have a model back from the server | ||
// this means we miss out on the 'sync' event. | ||||
|
r14546 | }, | ||
|
r14639 | save_changes: function(callbacks) { | ||
|
r14651 | // Push this model's state to the back-end | ||
// | ||||
// This invokes a Backbone.Sync. | ||||
|
r14618 | this.save(this.changedAttributes(), {patch: true, callbacks: callbacks}); | ||
}, | ||||
|
r14583 | _pack_models: function(value) { | ||
|
r14609 | // Replace models with model ids recursively. | ||
|
r14583 | if (value instanceof Backbone.Model) { | ||
return value.id; | ||||
} else if (value instanceof Object) { | ||||
var packed = {}; | ||||
|
r14686 | var that = this; | ||
|
r14664 | _.each(value, function(sub_value, key) { | ||
|
r14686 | packed[key] = that._pack_models(sub_value); | ||
|
r14664 | }); | ||
|
r14583 | return packed; | ||
} else { | ||||
return value; | ||||
} | ||||
}, | ||||
_unpack_models: function(value) { | ||||
|
r14609 | // Replace model ids with models recursively. | ||
|
r14583 | if (value instanceof Object) { | ||
var unpacked = {}; | ||||
|
r14686 | var that = this; | ||
|
r14664 | _.each(value, function(sub_value, key) { | ||
|
r14686 | unpacked[key] = that._unpack_models(sub_value); | ||
|
r14664 | }); | ||
|
r14583 | return unpacked; | ||
} else { | ||||
var model = this.widget_manager.get_model(value); | ||||
|
r14792 | if (model) { | ||
|
r14583 | return model; | ||
} else { | ||||
return value; | ||||
} | ||||
} | ||||
}, | ||||
|
r14546 | }); | ||
|
r14627 | WidgetManager.register_widget_model('WidgetModel', WidgetModel); | ||
|
r14546 | |||
|
r14564 | var WidgetView = Backbone.View.extend({ | ||
|
r14565 | initialize: function(parameters) { | ||
|
r14609 | // Public constructor. | ||
|
r14546 | this.model.on('change',this.update,this); | ||
|
r14565 | this.options = parameters.options; | ||
|
r14546 | this.child_views = []; | ||
this.model.views.push(this); | ||||
}, | ||||
update: function(){ | ||||
|
r14609 | // Triggered on model change. | ||
// | ||||
// Update view to be consistent with this.model | ||||
|
r14546 | }, | ||
|
r14598 | create_child_view: function(child_model, options) { | ||
|
r14609 | // Create and return a child view. | ||
// | ||||
|
r14617 | // -given a model and (optionally) a view name if the view name is | ||
|
r14609 | // not given, it defaults to the model's default view attribute. | ||
|
r14651 | |||
|
r14617 | // TODO: this is hacky, and makes the view depend on this cell attribute and widget manager behavior | ||
|
r14651 | // it would be great to have the widget manager add the cell metadata | ||
// to the subview without having to add it here. | ||||
|
r14689 | var child_view = this.model.widget_manager.create_view(child_model, options || {}, this); | ||
|
r14583 | this.child_views[child_model.id] = child_view; | ||
|
r14546 | return child_view; | ||
}, | ||||
|
r14598 | |||
delete_child_view: function(child_model, options) { | ||||
|
r14609 | // Delete a child view that was previously created using create_child_view. | ||
|
r14598 | var view = this.child_views[child_model.id]; | ||
|
r14667 | if (view !== undefined) { | ||
delete this.child_views[child_model.id]; | ||||
|
r14792 | view.remove(); | ||
|
r14667 | } | ||
|
r14546 | }, | ||
|
r14580 | 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); | ||||
|
r14583 | }, | ||
|
r14580 | |||
|
r14546 | callbacks: function(){ | ||
|
r14609 | // Create msg callbacks for a comm msg. | ||
|
r14640 | return this.model.callbacks(this); | ||
|
r14560 | }, | ||
|
r14546 | |||
render: function(){ | ||||
|
r14609 | // Render the view. | ||
// | ||||
// By default, this is only called the first time the view is created | ||||
|
r14546 | }, | ||
|
r14609 | |||
|
r14546 | send: function (content) { | ||
|
r14609 | // Send a custom msg associated with this view. | ||
|
r14546 | this.model.send(content, this.callbacks()); | ||
}, | ||||
touch: function () { | ||||
|
r14639 | this.model.save_changes(this.callbacks()); | ||
|
r14546 | }, | ||
}); | ||||
|
r14609 | |||
|
r14564 | var DOMWidgetView = WidgetView.extend({ | ||
|
r14546 | initialize: function (options) { | ||
|
r14609 | // Public constructor | ||
// In the future we may want to make changes more granular | ||||
// (e.g., trigger on visible:change). | ||||
|
r14546 | this.model.on('change', this.update, this); | ||
this.model.on('msg:custom', this.on_msg, this); | ||||
|
r14583 | DOMWidgetView.__super__.initialize.apply(this, arguments); | ||
|
r14546 | }, | ||
on_msg: function(msg) { | ||||
|
r14609 | // Handle DOM specific msgs. | ||
|
r14546 | 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) { | ||||
|
r14609 | // Add a DOM class to an element. | ||
|
r14567 | this._get_selector_element(selector).addClass(class_list); | ||
|
r14546 | }, | ||
remove_class: function (selector, class_list) { | ||||
|
r14609 | // Remove a DOM class from an element. | ||
|
r14567 | this._get_selector_element(selector).removeClass(class_list); | ||
|
r14546 | }, | ||
update: function () { | ||||
|
r14568 | // 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 | ||||
|
r14546 | var e = this.$el; | ||
var visible = this.model.get('visible'); | ||||
|
r14792 | setTimeout(function() {e.toggle(visible);},0); | ||
|
r14546 | |||
var css = this.model.get('_css'); | ||||
if (css === undefined) {return;} | ||||
|
r14686 | var that = this; | ||
|
r14664 | _.each(css, function(css_traits, selector){ | ||
// Apply the css traits to all elements that match the selector. | ||||
|
r14686 | var elements = that._get_selector_element(selector); | ||
|
r14664 | if (elements.length > 0) { | ||
_.each(css_traits, function(css_value, css_key){ | ||||
elements.css(css_key, css_value); | ||||
}); | ||||
|
r14546 | } | ||
|
r14664 | }); | ||
|
r14546 | }, | ||
_get_selector_element: function (selector) { | ||||
|
r14792 | // Get the elements via the css selector. | ||
|
r14609 | |||
// 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. | ||||
|
r14546 | var elements; | ||
|
r14792 | if (!selector) { | ||
|
r14546 | 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; | ||||
|
r14564 | IPython.DOMWidgetView = DOMWidgetView; | ||
|
r14546 | |||
|
r14627 | // Pass through WidgetManager namespace. | ||
return WidgetManager; | ||||
|
r14546 | }); | ||