widgetmanager.js
204 lines
| 8.4 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 | ||||
*/ | ||||
|
r14457 | (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. | ||||
|
r14483 | define(["underscore", | ||
"backbone", | ||||
|
r14641 | ], function (Underscore, Backbone) { | ||
|
r14624 | |||
|
r14457 | //-------------------------------------------------------------------- | ||
// WidgetManager class | ||||
//-------------------------------------------------------------------- | ||||
|
r14624 | var WidgetManager = function (comm_manager) { | ||
// Public constructor | ||||
WidgetManager._managers.push(this); | ||||
|
r14342 | |||
|
r14624 | // Attach a comm manager to the | ||
|
r14457 | this.comm_manager = comm_manager; | ||
|
r14664 | this._models = {}; /* Dictionary of model ids and model instances */ | ||
|
r14457 | |||
|
r14486 | // Register already-registered widget model types with the comm manager. | ||
|
r14678 | var that = this; | ||
|
r14686 | _.each(WidgetManager._model_types, function(model_type, model_name) { | ||
that.comm_manager.register_target(model_name, $.proxy(that._handle_comm_open, that)); | ||||
|
r14664 | }); | ||
|
r14457 | }; | ||
|
r14342 | |||
|
r14624 | //-------------------------------------------------------------------- | ||
// Class level | ||||
//-------------------------------------------------------------------- | ||||
WidgetManager._model_types = {}; /* Dictionary of model type names (target_name) and model types. */ | ||||
WidgetManager._view_types = {}; /* Dictionary of view names and view types. */ | ||||
WidgetManager._managers = []; /* List of widget managers */ | ||||
WidgetManager.register_widget_model = function (model_name, model_type) { | ||||
// Registers a widget model by name. | ||||
WidgetManager._model_types[model_name] = model_type; | ||||
|
r14342 | |||
|
r14457 | // Register the widget with the comm manager. Make sure to pass this object's context | ||
// in so `this` works in the call back. | ||||
|
r14664 | _.each(WidgetManager._managers, function(instance, i) { | ||
|
r14624 | if (instance.comm_manager !== null) { | ||
instance.comm_manager.register_target(model_name, $.proxy(instance._handle_comm_open, instance)); | ||||
} | ||||
|
r14664 | }); | ||
|
r14457 | }; | ||
|
r14342 | |||
|
r14624 | WidgetManager.register_widget_view = function (view_name, view_type) { | ||
// Registers a widget view by name. | ||||
WidgetManager._view_types[view_name] = view_type; | ||||
|
r14457 | }; | ||
|
r14512 | |||
|
r14624 | //-------------------------------------------------------------------- | ||
// Instance level | ||||
//-------------------------------------------------------------------- | ||||
|
r14620 | WidgetManager.prototype.display_view = function(msg, model) { | ||
|
r14734 | // Displays a view for a particular model. | ||
|
r14620 | var cell = this.get_msg_cell(msg.parent_header.msg_id); | ||
|
r14559 | if (cell === null) { | ||
console.log("Could not determine where the display" + | ||||
" message was from. Widget will not be displayed"); | ||||
} else { | ||||
|
r14617 | var view = this.create_view(model, {cell: cell}); | ||
|
r14666 | if (view === null) { | ||
|
r14620 | console.error("View creation failed", model); | ||
} | ||||
|
r14791 | if (cell.widget_subarea) { | ||
|
r14559 | cell.widget_area.show(); | ||
|
r14948 | this._handle_display_view(view); | ||
|
r14559 | cell.widget_subarea.append(view.$el); | ||
} | ||||
|
r14506 | } | ||
|
r14734 | }; | ||
|
r14559 | |||
|
r14948 | WidgetManager.prototype._handle_display_view = function (view) { | ||
// Have the IPython keyboard manager disable its event | ||||
// handling so the widget can capture keyboard input. | ||||
// Note, this is only done on the outer most widget. | ||||
IPython.keyboard_manager.register_events(view.$el); | ||||
}; | ||||
|
r14689 | WidgetManager.prototype.create_view = function(model, options, view) { | ||
|
r14734 | // Creates a view for a particular model. | ||
|
r14701 | var view_name = model.get('_view_name'); | ||
|
r14624 | var ViewType = WidgetManager._view_types[view_name]; | ||
|
r14791 | if (ViewType) { | ||
|
r14689 | |||
// If a view is passed into the method, use that view's cell as | ||||
// the cell for the view that is created. | ||||
options = options || {}; | ||||
if (view !== undefined) { | ||||
options.cell = view.options.cell; | ||||
} | ||||
|
r14734 | // Create and render the view... | ||
|
r14565 | var parameters = {model: model, options: options}; | ||
|
r14791 | view = new ViewType(parameters); | ||
|
r14486 | view.render(); | ||
|
r14512 | model.views.push(view); | ||
model.on('destroy', view.remove, view); | ||||
|
r14486 | return view; | ||
} | ||||
|
r14666 | return null; | ||
|
r14734 | }; | ||
|
r14457 | WidgetManager.prototype.get_msg_cell = function (msg_id) { | ||
|
r14534 | var cell = null; | ||
|
r14486 | // First, check to see if the msg was triggered by cell execution. | ||
|
r14791 | if (IPython.notebook) { | ||
|
r14486 | cell = IPython.notebook.get_msg_cell(msg_id); | ||
} | ||||
|
r14534 | if (cell !== null) { | ||
|
r14791 | return cell; | ||
|
r14534 | } | ||
|
r14486 | // 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. | ||||
|
r14624 | var kernel = this.comm_manager.kernel; | ||
|
r14791 | if (kernel) { | ||
|
r14486 | var callbacks = kernel.get_callbacks_for_msg(msg_id); | ||
|
r14791 | if (callbacks && callbacks.iopub && | ||
|
r14486 | callbacks.iopub.get_cell !== undefined) { | ||
return callbacks.iopub.get_cell(); | ||||
|
r14791 | } | ||
|
r14457 | } | ||
|
r14486 | |||
// Not triggered by a cell or widget (no get_cell callback | ||||
// exists). | ||||
return null; | ||||
|
r14457 | }; | ||
|
r14469 | |||
|
r14534 | WidgetManager.prototype.callbacks = function (view) { | ||
// callback handlers specific a view | ||||
var callbacks = {}; | ||||
|
r14791 | if (view && view.options.cell) { | ||
|
r14741 | |||
|
r14534 | // Try to get output handlers | ||
|
r14741 | var cell = view.options.cell; | ||
|
r14534 | var handle_output = null; | ||
var handle_clear_output = null; | ||||
|
r14791 | if (cell.output_area) { | ||
|
r14534 | 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, | ||||
// 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; | ||||
}; | ||||
|
r14512 | WidgetManager.prototype.get_model = function (model_id) { | ||
|
r14668 | // Look-up a model instance by its id. | ||
|
r14664 | var model = this._models[model_id]; | ||
|
r14512 | if (model !== undefined && model.id == model_id) { | ||
|
r14469 | return model; | ||
} | ||||
return null; | ||||
}; | ||||
|
r14486 | WidgetManager.prototype._handle_comm_open = function (comm, msg) { | ||
|
r14668 | // Handle when a comm is opened. | ||
|
r14624 | var model_id = comm.comm_id; | ||
|
r14457 | var widget_type_name = msg.content.target_name; | ||
|
r14624 | var widget_model = new WidgetManager._model_types[widget_type_name](this, model_id, comm); | ||
|
r14664 | this._models[model_id] = widget_model; | ||
|
r14457 | }; | ||
IPython.WidgetManager = WidgetManager; | ||||
|
r14624 | return IPython.WidgetManager; | ||
|
r14457 | }); | ||
|
r14486 | }()); | ||