widget.js
551 lines
| 20.6 KiB
| application/javascript
|
JavascriptLexer
|
r14224 | //---------------------------------------------------------------------------- | ||
// 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 | ||||
*/ | ||||
|
r14237 | "use strict"; | ||
|
r14263 | // 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. | ||||
|
r14285 | define(["components/underscore/underscore-min", | ||
"components/backbone/backbone-min", | ||||
|
r14374 | ], function(underscore, backbone){ | ||
|
r14263 | |||
|
r14342 | |||
//-------------------------------------------------------------------- | ||||
// WidgetModel class | ||||
//-------------------------------------------------------------------- | ||||
var WidgetModel = Backbone.Model.extend({ | ||||
|
r14378 | constructor: function(comm_manager, comm, widget_manager) { | ||
|
r14342 | this.comm_manager = comm_manager; | ||
|
r14378 | this.widget_manager = widget_manager; | ||
|
r14342 | this.pending_msgs = 0; | ||
this.msg_throttle = 3; | ||||
this.msg_buffer = null; | ||||
this.views = {}; | ||||
// Remember comm associated with the model. | ||||
this.comm = comm; | ||||
comm.model = this; | ||||
// Hook comm messages up to model. | ||||
|
r14379 | comm.on_close($.proxy(this._handle_comm_closed, this)); | ||
comm.on_msg($.proxy(this._handle_comm_msg, this)); | ||||
|
r14342 | |||
return Backbone.Model.apply(this); | ||||
}, | ||||
update_other_views: function(caller) { | ||||
this.last_modified_view = caller; | ||||
this.save(this.changedAttributes(), {patch: true}); | ||||
|
r14378 | for (var cell in this.views) { | ||
var views = this.views[cell]; | ||||
|
r14342 | for (var view_index in views) { | ||
var view = views[view_index]; | ||||
if (view !== caller) { | ||||
view.update(); | ||||
|
r14263 | } | ||
|
r14227 | } | ||
|
r14342 | } | ||
}, | ||||
|
r14278 | |||
|
r14342 | |||
|
r14385 | on_view_displayed: function (callback) { | ||
this._view_displayed_callback = callback; | ||||
} | ||||
on_close: function (callback) { | ||||
this._close_callback = callback; | ||||
} | ||||
|
r14379 | // Handle when a widget is closed. | ||
_handle_comm_closed: function (msg) { | ||||
for (var cell in this.views) { | ||||
var views = this.views[cell]; | ||||
for (var view_index in views) { | ||||
var view = views[view_index]; | ||||
view.remove(); | ||||
} | ||||
} | ||||
}, | ||||
// Handle incomming comm msg. | ||||
_handle_comm_msg: function (msg) { | ||||
var method = msg.content.data.method; | ||||
switch (method){ | ||||
case 'display': | ||||
|
r14385 | // Try to get the cell. | ||
|
r14379 | 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 { | ||||
this._display_view(msg.content.data.view_name, | ||||
msg.content.data.parent, | ||||
cell); | ||||
} | ||||
break; | ||||
case 'update': | ||||
this._handle_update(msg.content.data.state); | ||||
break; | ||||
} | ||||
}, | ||||
// Handle when a widget is updated via the python side. | ||||
_handle_update: function (state) { | ||||
this.updating = true; | ||||
try { | ||||
for (var key in state) { | ||||
if (state.hasOwnProperty(key)) { | ||||
if (key == "_css"){ | ||||
|
r14384 | |||
// Set the css value of the model as an attribute | ||||
// instead of a backbone trait because we are only | ||||
// interested in backend css -> frontend css. In | ||||
// other words, if the css dict changes in the | ||||
// frontend, we don't need to push the changes to | ||||
// the backend. | ||||
|
r14379 | this.css = state[key]; | ||
} else { | ||||
this.set(key, state[key]); | ||||
} | ||||
} | ||||
} | ||||
this.id = this.comm.comm_id; | ||||
this.save(); | ||||
} finally { | ||||
this.updating = false; | ||||
} | ||||
}, | ||||
_handle_status: function (cell, msg) { | ||||
|
r14342 | //execution_state : ('busy', 'idle', 'starting') | ||
if (msg.content.execution_state=='idle') { | ||||
// Send buffer if this message caused another message to be | ||||
// throttled. | ||||
if (this.msg_buffer != null && | ||||
|
r14346 | this.msg_throttle == this.pending_msgs) { | ||
|
r14378 | var cell = this._get_msg_cell(msg.parent_header.msg_id); | ||
var callbacks = this._make_callbacks(cell); | ||||
|
r14346 | var data = {sync_method: 'update', sync_data: this.msg_buffer}; | ||
this.comm.send(data, callbacks); | ||||
this.msg_buffer = null; | ||||
|
r14342 | } else { | ||
// Only decrease the pending message count if the buffer | ||||
// doesn't get flushed (sent). | ||||
--this.pending_msgs; | ||||
|
r14278 | } | ||
|
r14342 | } | ||
}, | ||||
// Custom syncronization logic. | ||||
|
r14379 | _handle_sync: function (method, options) { | ||
|
r14342 | var model_json = this.toJSON(); | ||
// Only send updated state if the state hasn't been changed | ||||
// during an update. | ||||
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) { | ||||
|
r14278 | this.msg_buffer = $.extend({}, model_json); // Copy | ||
} | ||||
|
r14342 | for (var attr in options.attrs) { | ||
this.msg_buffer[attr] = options.attrs[attr]; | ||||
|
r14278 | } | ||
|
r14342 | } else { | ||
this.msg_buffer = $.extend({}, model_json); // Copy | ||||
} | ||||
|
r14278 | |||
|
r14342 | } 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 (var attr in options.attrs) { | ||||
send_json[attr] = options.attrs[attr]; | ||||
} | ||||
|
r14278 | } | ||
|
r14342 | |||
var data = {sync_method: method, sync_data: send_json}; | ||||
|
r14353 | |||
|
r14378 | var cell = null; | ||
|
r14353 | if (this.last_modified_view != undefined && this.last_modified_view != null) { | ||
|
r14378 | cell = this.last_modified_view.cell; | ||
|
r14353 | } | ||
|
r14378 | var callbacks = this._make_callbacks(cell); | ||
|
r14342 | this.comm.send(data, callbacks); | ||
this.pending_msgs++; | ||||
|
r14278 | } | ||
|
r14342 | } | ||
// Since the comm is a one-way communication, assume the message | ||||
// arrived. | ||||
return model_json; | ||||
}, | ||||
|
r14385 | _handle_view_displayed: function(view) { | ||
if (this._view_displayed_callback) { | ||||
try { | ||||
this._view_displayed_callback(view) | ||||
} catch (e) { | ||||
console.log("Exception in widget model view displayed callback", e, view, this); | ||||
} | ||||
} | ||||
} | ||||
|
r14342 | // Create view that represents the model. | ||
|
r14379 | _display_view: function (view_name, parent_comm_id, cell) { | ||
|
r14342 | var new_views = []; | ||
|
r14383 | // Try creating and adding the view to it's parent. | ||
|
r14342 | var displayed = false; | ||
if (parent_comm_id != undefined) { | ||||
var parent_comm = this.comm_manager.comms[parent_comm_id]; | ||||
var parent_model = parent_comm.model; | ||||
|
r14378 | var parent_views = parent_model.views[cell]; | ||
|
r14342 | for (var parent_view_index in parent_views) { | ||
var parent_view = parent_views[parent_view_index]; | ||||
if (parent_view.display_child != undefined) { | ||||
|
r14378 | var view = this._create_view(view_name, cell); | ||
|
r14382 | if (view != null) { | ||
new_views.push(view); | ||||
parent_view.display_child(view); | ||||
displayed = true; | ||||
|
r14385 | this._handle_view_displayed(view); | ||
|
r14382 | } | ||
|
r14285 | } | ||
} | ||||
|
r14342 | } | ||
|
r14383 | // If no parent view is defined or exists. Add the view's | ||
// element to cell's widget div. | ||||
|
r14342 | if (!displayed) { | ||
|
r14378 | var view = this._create_view(view_name, cell); | ||
|
r14382 | if (view != null) { | ||
new_views.push(view); | ||||
|
r14378 | |||
|
r14382 | if (cell.widget_subarea != undefined && cell.widget_subarea != null) { | ||
cell.widget_area.show(); | ||||
cell.widget_subarea.append(view.$el); | ||||
|
r14385 | this._handle_view_displayed(view); | ||
|
r14382 | } | ||
|
r14378 | } | ||
|
r14342 | } | ||
|
r14383 | // Force the new view(s) to update their selves | ||
|
r14342 | for (var view_index in new_views) { | ||
var view = new_views[view_index]; | ||||
view.update(); | ||||
} | ||||
}, | ||||
// Create a view | ||||
|
r14378 | _create_view: function (view_name, cell) { | ||
|
r14382 | var view_type = this.widget_manager.widget_view_types[view_name]; | ||
if (view_type != undefined && view_type != null) { | ||||
var view = new view_type({model: this}); | ||||
view.render(); | ||||
if (this.views[cell]==undefined) { | ||||
this.views[cell] = [] | ||||
|
r14285 | } | ||
|
r14382 | this.views[cell].push(view); | ||
view.cell = cell; | ||||
|
r14285 | |||
|
r14382 | // Handle when the view element is remove from the page. | ||
var that = this; | ||||
view.$el.on("remove", function(){ | ||||
var index = that.views[cell].indexOf(view); | ||||
if (index > -1) { | ||||
that.views[cell].splice(index, 1); | ||||
} | ||||
view.remove(); // Clean-up view | ||||
if (that.views[cell].length()==0) { | ||||
delete that.views[cell]; | ||||
} | ||||
// Close the comm if there are no views left. | ||||
if (that.views.length()==0) { | ||||
|
r14385 | if (that._close_callback) { | ||
try { | ||||
that._close_callback(that) | ||||
} catch (e) { | ||||
console.log("Exception in widget model close callback", e, that); | ||||
} | ||||
} | ||||
|
r14382 | that.comm.close(); | ||
} | ||||
}); | ||||
return view; | ||||
} | ||||
return null; | ||||
|
r14342 | }, | ||
|
r14278 | |||
|
r14342 | // Build a callback dict. | ||
|
r14378 | _make_callbacks: function (cell) { | ||
|
r14342 | var callbacks = {}; | ||
|
r14378 | if (cell != null && cell.output_area != undefined && cell.output_area != null) { | ||
|
r14342 | var that = this; | ||
callbacks = { | ||||
iopub : { | ||||
|
r14378 | output : $.proxy(cell.output_area.handle_output, cell.output_area), | ||
clear_output : $.proxy(cell.output_area.handle_clear_output, cell.output_area), | ||||
|
r14342 | status : function(msg){ | ||
|
r14379 | that._handle_status(cell, msg); | ||
|
r14278 | }, | ||
|
r14384 | |||
// 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. | ||||
|
r14378 | get_cell : function() { | ||
|
r14342 | if (that.last_modified_view != undefined && | ||
|
r14378 | that.last_modified_view.cell != undefined) { | ||
return that.last_modified_view.cell; | ||||
|
r14342 | } else { | ||
return null | ||||
} | ||||
}, | ||||
}, | ||||
}; | ||||
} | ||||
return callbacks; | ||||
}, | ||||
|
r14278 | |||
|
r14342 | // Get the output area corresponding to the msg_id. | ||
|
r14378 | // cell is an instance of IPython.Cell | ||
_get_msg_cell: function (msg_id) { | ||||
|
r14346 | |||
|
r14371 | // First, check to see if the msg was triggered by cell execution. | ||
|
r14378 | var cell = this.widget_manager.get_msg_cell(msg_id); | ||
|
r14371 | if (cell != null) { | ||
|
r14378 | return cell; | ||
|
r14342 | } | ||
|
r14316 | |||
|
r14378 | // Second, check to see if a get_cell callback was defined | ||
// for the message. get_cell callbacks are registered for | ||||
|
r14371 | // widget messages, so this block is actually checking to see if the | ||
// message was triggered by a widget. | ||||
var kernel = this.comm_manager.kernel; | ||||
var callbacks = kernel.get_callbacks_for_msg(msg_id); | ||||
if (callbacks != undefined && | ||||
callbacks.iopub != undefined && | ||||
|
r14378 | callbacks.iopub.get_cell != undefined) { | ||
|
r14371 | |||
|
r14378 | return callbacks.iopub.get_cell(); | ||
|
r14342 | } | ||
|
r14263 | |||
|
r14378 | // Not triggered by a cell or widget (no get_cell callback | ||
|
r14371 | // exists). | ||
|
r14342 | return null; | ||
}, | ||||
}); | ||||
//-------------------------------------------------------------------- | ||||
// WidgetView class | ||||
//-------------------------------------------------------------------- | ||||
var WidgetView = Backbone.View.extend({ | ||||
initialize: function() { | ||||
this.visible = true; | ||||
this.model.on('change',this.update,this); | ||||
this._add_class_calls = this.model.get('_add_class')[0]; | ||||
this._remove_class_calls = this.model.get('_remove_class')[0]; | ||||
}, | ||||
update: function() { | ||||
if (this.model.get('visible') != undefined) { | ||||
if (this.visible != this.model.get('visible')) { | ||||
this.visible = this.model.get('visible'); | ||||
if (this.visible) { | ||||
this.$el.show(); | ||||
} else { | ||||
this.$el.hide(); | ||||
|
r14311 | } | ||
} | ||||
|
r14342 | } | ||
if (this.model.css != undefined) { | ||||
for (var selector in this.model.css) { | ||||
if (this.model.css.hasOwnProperty(selector)) { | ||||
// Apply the css traits to all elements that match the selector. | ||||
|
r14379 | var elements = this._get_selector_element(selector); | ||
|
r14342 | if (elements.length > 0) { | ||
var css_traits = this.model.css[selector]; | ||||
for (var css_key in css_traits) { | ||||
if (css_traits.hasOwnProperty(css_key)) { | ||||
elements.css(css_key, css_traits[css_key]); | ||||
|
r14224 | } | ||
} | ||||
} | ||||
} | ||||
} | ||||
|
r14342 | } | ||
var add_class = this.model.get('_add_class'); | ||||
if (add_class != undefined){ | ||||
var add_class_calls = add_class[0]; | ||||
if (add_class_calls > this._add_class_calls) { | ||||
this._add_class_calls = add_class_calls; | ||||
|
r14379 | var elements = this._get_selector_element(add_class[1]); | ||
|
r14342 | if (elements.length > 0) { | ||
elements.addClass(add_class[2]); | ||||
|
r14313 | } | ||
|
r14342 | } | ||
} | ||||
var remove_class = this.model.get('_remove_class'); | ||||
if (remove_class != undefined){ | ||||
var remove_class_calls = remove_class[0]; | ||||
if (remove_class_calls > this._remove_class_calls) { | ||||
this._remove_class_calls = remove_class_calls; | ||||
|
r14379 | var elements = this._get_selector_element(remove_class[1]); | ||
|
r14342 | if (elements.length > 0) { | ||
elements.removeClass(remove_class[2]); | ||||
} | ||||
} | ||||
} | ||||
}, | ||||
|
r14379 | _get_selector_element: function(selector) { | ||
|
r14342 | // 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 = this.$el.find(selector); | ||||
if (selector=='') { | ||||
if (this.$el_to_style == undefined) { | ||||
elements = this.$el; | ||||
} else { | ||||
elements = this.$el_to_style; | ||||
|
r14313 | } | ||
|
r14342 | } | ||
return elements; | ||||
}, | ||||
}); | ||||
//-------------------------------------------------------------------- | ||||
// WidgetManager class | ||||
//-------------------------------------------------------------------- | ||||
var WidgetManager = function(){ | ||||
this.comm_manager = null; | ||||
this.widget_model_types = {}; | ||||
this.widget_view_types = {}; | ||||
var that = this; | ||||
Backbone.sync = function(method, model, options, error) { | ||||
|
r14379 | var result = model._handle_sync(method, options); | ||
|
r14342 | if (options.success) { | ||
options.success(result); | ||||
} | ||||
}; | ||||
} | ||||
WidgetManager.prototype.attach_comm_manager = function (comm_manager) { | ||||
this.comm_manager = comm_manager; | ||||
// Register already register widget model types with the comm manager. | ||||
for (var widget_model_name in this.widget_model_types) { | ||||
|
r14380 | this.comm_manager.register_target(widget_model_name, $.proxy(this._handle_com_open, this)); | ||
|
r14257 | } | ||
|
r14342 | } | ||
|
r14237 | |||
|
r14278 | |||
|
r14342 | 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) { | ||||
|
r14380 | this.comm_manager.register_target(widget_model_name, $.proxy(this._handle_com_open, this)); | ||
|
r14257 | } | ||
|
r14342 | this.widget_model_types[widget_model_name] = widget_model_type; | ||
} | ||||
|
r14263 | |||
|
r14278 | |||
|
r14342 | WidgetManager.prototype.register_widget_view = function (widget_view_name, widget_view_type) { | ||
this.widget_view_types[widget_view_name] = widget_view_type; | ||||
} | ||||
|
r14263 | |||
|
r14278 | |||
|
r14378 | WidgetManager.prototype.get_msg_cell = function (msg_id) { | ||
if (IPython.notebook != undefined && IPython.notebook != null) { | ||||
return IPython.notebook.get_msg_cell(msg_id); | ||||
} | ||||
|
r14342 | } | ||
|
r14381 | |||
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); | ||||
} | ||||
} | ||||
} | ||||
|
r14255 | |||
|
r14224 | |||
|
r14380 | WidgetManager.prototype._handle_com_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_manager, comm, this); | ||||
|
r14381 | this._handle_create_widget(widget_model); | ||
|
r14380 | } | ||
|
r14381 | |||
|
r14380 | |||
|
r14342 | //-------------------------------------------------------------------- | ||
// Init code | ||||
//-------------------------------------------------------------------- | ||||
IPython.WidgetManager = WidgetManager; | ||||
IPython.WidgetModel = WidgetModel; | ||||
IPython.WidgetView = WidgetView; | ||||
|
r14224 | |||
|
r14374 | if (IPython.widget_manager==undefined || IPython.widget_manager==null) { | ||
IPython.widget_manager = new WidgetManager(); | ||||
} | ||||
return IPython.widget_manager; | ||||
|
r14263 | }); | ||