Show More
@@ -1,210 +1,207 b'' | |||||
1 | //---------------------------------------------------------------------------- |
|
1 | //---------------------------------------------------------------------------- | |
2 | // Copyright (C) 2013 The IPython Development Team |
|
2 | // Copyright (C) 2013 The IPython Development Team | |
3 | // |
|
3 | // | |
4 | // Distributed under the terms of the BSD License. The full license is in |
|
4 | // Distributed under the terms of the BSD License. The full license is in | |
5 | // the file COPYING, distributed as part of this software. |
|
5 | // the file COPYING, distributed as part of this software. | |
6 | //---------------------------------------------------------------------------- |
|
6 | //---------------------------------------------------------------------------- | |
7 |
|
7 | |||
8 | //============================================================================ |
|
8 | //============================================================================ | |
9 | // WidgetModel, WidgetView, and WidgetManager |
|
9 | // WidgetModel, WidgetView, and WidgetManager | |
10 | //============================================================================ |
|
10 | //============================================================================ | |
11 | /** |
|
11 | /** | |
12 | * Base Widget classes |
|
12 | * Base Widget classes | |
13 | * @module IPython |
|
13 | * @module IPython | |
14 | * @namespace IPython |
|
14 | * @namespace IPython | |
15 | * @submodule widget |
|
15 | * @submodule widget | |
16 | */ |
|
16 | */ | |
17 |
|
17 | |||
18 | (function () { |
|
18 | (function () { | |
19 | "use strict"; |
|
19 | "use strict"; | |
20 |
|
20 | |||
21 | // Use require.js 'define' method so that require.js is intelligent enough to |
|
21 | // Use require.js 'define' method so that require.js is intelligent enough to | |
22 | // syncronously load everything within this file when it is being 'required' |
|
22 | // syncronously load everything within this file when it is being 'required' | |
23 | // elsewhere. |
|
23 | // elsewhere. | |
24 | define(["underscore", |
|
24 | define(["underscore", | |
25 | "backbone", |
|
25 | "backbone", | |
26 | ], function (Underscore, Backbone) { |
|
26 | ], function (Underscore, Backbone) { | |
27 |
|
27 | |||
28 | //-------------------------------------------------------------------- |
|
28 | //-------------------------------------------------------------------- | |
29 | // WidgetManager class |
|
29 | // WidgetManager class | |
30 | //-------------------------------------------------------------------- |
|
30 | //-------------------------------------------------------------------- | |
31 | var WidgetManager = function (comm_manager) { |
|
31 | var WidgetManager = function (comm_manager) { | |
32 | // Public constructor |
|
32 | // Public constructor | |
33 | WidgetManager._managers.push(this); |
|
33 | WidgetManager._managers.push(this); | |
34 |
|
34 | |||
35 | // Attach a comm manager to the |
|
35 | // Attach a comm manager to the | |
36 | this.comm_manager = comm_manager; |
|
36 | this.comm_manager = comm_manager; | |
37 | this._models = {}; /* Dictionary of model ids and model instances */ |
|
37 | this._models = {}; /* Dictionary of model ids and model instances */ | |
38 |
|
38 | |||
39 | // Register already-registered widget model types with the comm manager. |
|
39 | // Register already-registered widget model types with the comm manager. | |
40 | var that = this; |
|
40 | var that = this; | |
41 | _.each(WidgetManager._model_types, function(model_type, model_name) { |
|
41 | _.each(WidgetManager._model_types, function(model_type, model_name) { | |
42 | that.comm_manager.register_target(model_name, $.proxy(that._handle_comm_open, that)); |
|
42 | that.comm_manager.register_target(model_name, $.proxy(that._handle_comm_open, that)); | |
43 | }); |
|
43 | }); | |
44 | }; |
|
44 | }; | |
45 |
|
45 | |||
46 | //-------------------------------------------------------------------- |
|
46 | //-------------------------------------------------------------------- | |
47 | // Class level |
|
47 | // Class level | |
48 | //-------------------------------------------------------------------- |
|
48 | //-------------------------------------------------------------------- | |
49 | WidgetManager._model_types = {}; /* Dictionary of model type names (target_name) and model types. */ |
|
49 | WidgetManager._model_types = {}; /* Dictionary of model type names (target_name) and model types. */ | |
50 | WidgetManager._view_types = {}; /* Dictionary of view names and view types. */ |
|
50 | WidgetManager._view_types = {}; /* Dictionary of view names and view types. */ | |
51 | WidgetManager._managers = []; /* List of widget managers */ |
|
51 | WidgetManager._managers = []; /* List of widget managers */ | |
52 |
|
52 | |||
53 | WidgetManager.register_widget_model = function (model_name, model_type) { |
|
53 | WidgetManager.register_widget_model = function (model_name, model_type) { | |
54 | // Registers a widget model by name. |
|
54 | // Registers a widget model by name. | |
55 | WidgetManager._model_types[model_name] = model_type; |
|
55 | WidgetManager._model_types[model_name] = model_type; | |
56 |
|
56 | |||
57 | // Register the widget with the comm manager. Make sure to pass this object's context |
|
57 | // Register the widget with the comm manager. Make sure to pass this object's context | |
58 | // in so `this` works in the call back. |
|
58 | // in so `this` works in the call back. | |
59 | _.each(WidgetManager._managers, function(instance, i) { |
|
59 | _.each(WidgetManager._managers, function(instance, i) { | |
60 | if (instance.comm_manager !== null) { |
|
60 | if (instance.comm_manager !== null) { | |
61 | instance.comm_manager.register_target(model_name, $.proxy(instance._handle_comm_open, instance)); |
|
61 | instance.comm_manager.register_target(model_name, $.proxy(instance._handle_comm_open, instance)); | |
62 | } |
|
62 | } | |
63 | }); |
|
63 | }); | |
64 | }; |
|
64 | }; | |
65 |
|
65 | |||
66 | WidgetManager.register_widget_view = function (view_name, view_type) { |
|
66 | WidgetManager.register_widget_view = function (view_name, view_type) { | |
67 | // Registers a widget view by name. |
|
67 | // Registers a widget view by name. | |
68 | WidgetManager._view_types[view_name] = view_type; |
|
68 | WidgetManager._view_types[view_name] = view_type; | |
69 | }; |
|
69 | }; | |
70 |
|
70 | |||
71 | //-------------------------------------------------------------------- |
|
71 | //-------------------------------------------------------------------- | |
72 | // Instance level |
|
72 | // Instance level | |
73 | //-------------------------------------------------------------------- |
|
73 | //-------------------------------------------------------------------- | |
74 | WidgetManager.prototype.display_view = function(msg, model) { |
|
74 | WidgetManager.prototype.display_view = function(msg, model) { | |
75 | // Displays a view for a particular model. |
|
75 | // Displays a view for a particular model. | |
76 | var cell = this.get_msg_cell(msg.parent_header.msg_id); |
|
76 | var cell = this.get_msg_cell(msg.parent_header.msg_id); | |
77 | if (cell === null) { |
|
77 | if (cell === null) { | |
78 | console.log("Could not determine where the display" + |
|
78 | console.log("Could not determine where the display" + | |
79 | " message was from. Widget will not be displayed"); |
|
79 | " message was from. Widget will not be displayed"); | |
80 | } else { |
|
80 | } else { | |
81 | var view = this.create_view(model, {cell: cell}); |
|
81 | var view = this.create_view(model, {cell: cell}); | |
82 | if (view === null) { |
|
82 | if (view === null) { | |
83 | console.error("View creation failed", model); |
|
83 | console.error("View creation failed", model); | |
84 | } |
|
84 | } | |
85 | if (cell.widget_subarea) { |
|
85 | if (cell.widget_subarea) { | |
86 |
|
86 | |||
87 | cell.widget_area.show(); |
|
87 | cell.widget_area.show(); | |
|
88 | // Have the IPython keyboard manager disable its event | |||
|
89 | // handling so the widget can capture keyboard input. | |||
|
90 | // Note, this is only done on the outer most widget. | |||
|
91 | IPython.keyboard_manager.register_events(view.$el); | |||
88 | cell.widget_subarea.append(view.$el); |
|
92 | cell.widget_subarea.append(view.$el); | |
89 | } |
|
93 | } | |
90 | } |
|
94 | } | |
91 | }; |
|
95 | }; | |
92 |
|
96 | |||
93 | WidgetManager.prototype.create_view = function(model, options, view) { |
|
97 | WidgetManager.prototype.create_view = function(model, options, view) { | |
94 | // Creates a view for a particular model. |
|
98 | // Creates a view for a particular model. | |
95 | var view_name = model.get('_view_name'); |
|
99 | var view_name = model.get('_view_name'); | |
96 | var ViewType = WidgetManager._view_types[view_name]; |
|
100 | var ViewType = WidgetManager._view_types[view_name]; | |
97 | if (ViewType) { |
|
101 | if (ViewType) { | |
98 |
|
102 | |||
99 | // If a view is passed into the method, use that view's cell as |
|
103 | // If a view is passed into the method, use that view's cell as | |
100 | // the cell for the view that is created. |
|
104 | // the cell for the view that is created. | |
101 | options = options || {}; |
|
105 | options = options || {}; | |
102 | if (view !== undefined) { |
|
106 | if (view !== undefined) { | |
103 | options.cell = view.options.cell; |
|
107 | options.cell = view.options.cell; | |
104 | } |
|
108 | } | |
105 |
|
109 | |||
106 | // Create and render the view... |
|
110 | // Create and render the view... | |
107 | var parameters = {model: model, options: options}; |
|
111 | var parameters = {model: model, options: options}; | |
108 | view = new ViewType(parameters); |
|
112 | view = new ViewType(parameters); | |
109 | view.render(); |
|
113 | view.render(); | |
110 | model.views.push(view); |
|
114 | model.views.push(view); | |
111 | model.on('destroy', view.remove, view); |
|
115 | model.on('destroy', view.remove, view); | |
112 |
|
116 | |||
113 | this._handle_new_view(view); |
|
117 | this._handle_new_view(view); | |
114 | return view; |
|
118 | return view; | |
115 | } |
|
119 | } | |
116 | return null; |
|
120 | return null; | |
117 | }; |
|
121 | }; | |
118 |
|
122 | |||
119 | WidgetManager.prototype._handle_new_view = function (view) { |
|
123 | WidgetManager.prototype._handle_new_view = function (view) { | |
120 | // Called when a view has been created and rendered. |
|
124 | // Called when a view has been created and rendered. | |
121 |
|
||||
122 | // If the view has a well defined element, inform the keyboard |
|
|||
123 | // manager about the view's element, so as the element can |
|
|||
124 | // escape the dreaded command mode. |
|
|||
125 | if (view.$el) { |
|
|||
126 | IPython.keyboard_manager.register_events(view.$el); |
|
|||
127 | } |
|
|||
128 | }; |
|
125 | }; | |
129 |
|
126 | |||
130 | WidgetManager.prototype.get_msg_cell = function (msg_id) { |
|
127 | WidgetManager.prototype.get_msg_cell = function (msg_id) { | |
131 | var cell = null; |
|
128 | var cell = null; | |
132 | // First, check to see if the msg was triggered by cell execution. |
|
129 | // First, check to see if the msg was triggered by cell execution. | |
133 | if (IPython.notebook) { |
|
130 | if (IPython.notebook) { | |
134 | cell = IPython.notebook.get_msg_cell(msg_id); |
|
131 | cell = IPython.notebook.get_msg_cell(msg_id); | |
135 | } |
|
132 | } | |
136 | if (cell !== null) { |
|
133 | if (cell !== null) { | |
137 | return cell; |
|
134 | return cell; | |
138 | } |
|
135 | } | |
139 | // Second, check to see if a get_cell callback was defined |
|
136 | // Second, check to see if a get_cell callback was defined | |
140 | // for the message. get_cell callbacks are registered for |
|
137 | // for the message. get_cell callbacks are registered for | |
141 | // widget messages, so this block is actually checking to see if the |
|
138 | // widget messages, so this block is actually checking to see if the | |
142 | // message was triggered by a widget. |
|
139 | // message was triggered by a widget. | |
143 | var kernel = this.comm_manager.kernel; |
|
140 | var kernel = this.comm_manager.kernel; | |
144 | if (kernel) { |
|
141 | if (kernel) { | |
145 | var callbacks = kernel.get_callbacks_for_msg(msg_id); |
|
142 | var callbacks = kernel.get_callbacks_for_msg(msg_id); | |
146 | if (callbacks && callbacks.iopub && |
|
143 | if (callbacks && callbacks.iopub && | |
147 | callbacks.iopub.get_cell !== undefined) { |
|
144 | callbacks.iopub.get_cell !== undefined) { | |
148 | return callbacks.iopub.get_cell(); |
|
145 | return callbacks.iopub.get_cell(); | |
149 | } |
|
146 | } | |
150 | } |
|
147 | } | |
151 |
|
148 | |||
152 | // Not triggered by a cell or widget (no get_cell callback |
|
149 | // Not triggered by a cell or widget (no get_cell callback | |
153 | // exists). |
|
150 | // exists). | |
154 | return null; |
|
151 | return null; | |
155 | }; |
|
152 | }; | |
156 |
|
153 | |||
157 | WidgetManager.prototype.callbacks = function (view) { |
|
154 | WidgetManager.prototype.callbacks = function (view) { | |
158 | // callback handlers specific a view |
|
155 | // callback handlers specific a view | |
159 | var callbacks = {}; |
|
156 | var callbacks = {}; | |
160 | if (view && view.options.cell) { |
|
157 | if (view && view.options.cell) { | |
161 |
|
158 | |||
162 | // Try to get output handlers |
|
159 | // Try to get output handlers | |
163 | var cell = view.options.cell; |
|
160 | var cell = view.options.cell; | |
164 | var handle_output = null; |
|
161 | var handle_output = null; | |
165 | var handle_clear_output = null; |
|
162 | var handle_clear_output = null; | |
166 | if (cell.output_area) { |
|
163 | if (cell.output_area) { | |
167 | handle_output = $.proxy(cell.output_area.handle_output, cell.output_area); |
|
164 | handle_output = $.proxy(cell.output_area.handle_output, cell.output_area); | |
168 | handle_clear_output = $.proxy(cell.output_area.handle_clear_output, cell.output_area); |
|
165 | handle_clear_output = $.proxy(cell.output_area.handle_clear_output, cell.output_area); | |
169 | } |
|
166 | } | |
170 |
|
167 | |||
171 | // Create callback dict using what is known |
|
168 | // Create callback dict using what is known | |
172 | var that = this; |
|
169 | var that = this; | |
173 | callbacks = { |
|
170 | callbacks = { | |
174 | iopub : { |
|
171 | iopub : { | |
175 | output : handle_output, |
|
172 | output : handle_output, | |
176 | clear_output : handle_clear_output, |
|
173 | clear_output : handle_clear_output, | |
177 |
|
174 | |||
178 | // Special function only registered by widget messages. |
|
175 | // Special function only registered by widget messages. | |
179 | // Allows us to get the cell for a message so we know |
|
176 | // Allows us to get the cell for a message so we know | |
180 | // where to add widgets if the code requires it. |
|
177 | // where to add widgets if the code requires it. | |
181 | get_cell : function () { |
|
178 | get_cell : function () { | |
182 | return cell; |
|
179 | return cell; | |
183 | }, |
|
180 | }, | |
184 | }, |
|
181 | }, | |
185 | }; |
|
182 | }; | |
186 | } |
|
183 | } | |
187 | return callbacks; |
|
184 | return callbacks; | |
188 | }; |
|
185 | }; | |
189 |
|
186 | |||
190 | WidgetManager.prototype.get_model = function (model_id) { |
|
187 | WidgetManager.prototype.get_model = function (model_id) { | |
191 | // Look-up a model instance by its id. |
|
188 | // Look-up a model instance by its id. | |
192 | var model = this._models[model_id]; |
|
189 | var model = this._models[model_id]; | |
193 | if (model !== undefined && model.id == model_id) { |
|
190 | if (model !== undefined && model.id == model_id) { | |
194 | return model; |
|
191 | return model; | |
195 | } |
|
192 | } | |
196 | return null; |
|
193 | return null; | |
197 | }; |
|
194 | }; | |
198 |
|
195 | |||
199 | WidgetManager.prototype._handle_comm_open = function (comm, msg) { |
|
196 | WidgetManager.prototype._handle_comm_open = function (comm, msg) { | |
200 | // Handle when a comm is opened. |
|
197 | // Handle when a comm is opened. | |
201 | var model_id = comm.comm_id; |
|
198 | var model_id = comm.comm_id; | |
202 | var widget_type_name = msg.content.target_name; |
|
199 | var widget_type_name = msg.content.target_name; | |
203 | var widget_model = new WidgetManager._model_types[widget_type_name](this, model_id, comm); |
|
200 | var widget_model = new WidgetManager._model_types[widget_type_name](this, model_id, comm); | |
204 | this._models[model_id] = widget_model; |
|
201 | this._models[model_id] = widget_model; | |
205 | }; |
|
202 | }; | |
206 |
|
203 | |||
207 | IPython.WidgetManager = WidgetManager; |
|
204 | IPython.WidgetManager = WidgetManager; | |
208 | return IPython.WidgetManager; |
|
205 | return IPython.WidgetManager; | |
209 | }); |
|
206 | }); | |
210 | }()); |
|
207 | }()); |
General Comments 0
You need to be logged in to leave comments.
Login now