##// END OF EJS Templates
Added missing parameter to get_msg_cell call
Jonathan Frederic -
Show More
@@ -1,485 +1,485 b''
1 1 //----------------------------------------------------------------------------
2 2 // Copyright (C) 2013 The IPython Development Team
3 3 //
4 4 // Distributed under the terms of the BSD License. The full license is in
5 5 // the file COPYING, distributed as part of this software.
6 6 //----------------------------------------------------------------------------
7 7
8 8 //============================================================================
9 9 // WidgetModel, WidgetView, and WidgetManager
10 10 //============================================================================
11 11 /**
12 12 * Base Widget classes
13 13 * @module IPython
14 14 * @namespace IPython
15 15 * @submodule widget
16 16 */
17 17
18 18 "use strict";
19 19
20 20 // Use require.js 'define' method so that require.js is intelligent enough to
21 21 // syncronously load everything within this file when it is being 'required'
22 22 // elsewhere.
23 23 define(["components/underscore/underscore-min",
24 24 "components/backbone/backbone-min",
25 25 ], function(){
26 26
27 27
28 28 //--------------------------------------------------------------------
29 29 // WidgetModel class
30 30 //--------------------------------------------------------------------
31 31 var WidgetModel = Backbone.Model.extend({
32 32 constructor: function(comm_manager, comm, widget_view_types) {
33 33 this.comm_manager = comm_manager;
34 34 this.widget_view_types = widget_view_types;
35 35 this.pending_msgs = 0;
36 36 this.msg_throttle = 3;
37 37 this.msg_buffer = null;
38 38 this.views = {};
39 39
40 40 // Remember comm associated with the model.
41 41 this.comm = comm;
42 42 comm.model = this;
43 43
44 44 // Hook comm messages up to model.
45 45 comm.on_close($.proxy(this.handle_comm_closed, this));
46 46 comm.on_msg($.proxy(this.handle_comm_msg, this));
47 47
48 48 return Backbone.Model.apply(this);
49 49 },
50 50
51 51
52 52 update_other_views: function(caller) {
53 53 this.last_modified_view = caller;
54 54 this.save(this.changedAttributes(), {patch: true});
55 55
56 56 for (var output_area in this.views) {
57 57 var views = this.views[output_area];
58 58 for (var view_index in views) {
59 59 var view = views[view_index];
60 60 if (view !== caller) {
61 61 view.update();
62 62 }
63 63 }
64 64 }
65 65 },
66 66
67 67
68 68 handle_status: function (output_area, msg) {
69 69 //execution_state : ('busy', 'idle', 'starting')
70 70 if (msg.content.execution_state=='idle') {
71 71
72 72 // Send buffer if this message caused another message to be
73 73 // throttled.
74 74 if (this.msg_buffer != null &&
75 75 this.msg_throttle == this.pending_msgs) {
76 76
77 77 var output_area = this._get_output_area(msg.parent_header.msg_id);
78 78 var callbacks = this._make_callbacks(output_area);
79 79 var data = {sync_method: 'update', sync_data: this.msg_buffer};
80 80 this.comm.send(data, callbacks);
81 81 this.msg_buffer = null;
82 82 } else {
83 83
84 84 // Only decrease the pending message count if the buffer
85 85 // doesn't get flushed (sent).
86 86 --this.pending_msgs;
87 87 }
88 88 }
89 89 },
90 90
91 91
92 92 // Custom syncronization logic.
93 93 handle_sync: function (method, options) {
94 94 var model_json = this.toJSON();
95 95
96 96 // Only send updated state if the state hasn't been changed
97 97 // during an update.
98 98 if (!this.updating) {
99 99 if (this.pending_msgs >= this.msg_throttle) {
100 100 // The throttle has been exceeded, buffer the current msg so
101 101 // it can be sent once the kernel has finished processing
102 102 // some of the existing messages.
103 103 if (method=='patch') {
104 104 if (this.msg_buffer == null) {
105 105 this.msg_buffer = $.extend({}, model_json); // Copy
106 106 }
107 107 for (var attr in options.attrs) {
108 108 this.msg_buffer[attr] = options.attrs[attr];
109 109 }
110 110 } else {
111 111 this.msg_buffer = $.extend({}, model_json); // Copy
112 112 }
113 113
114 114 } else {
115 115 // We haven't exceeded the throttle, send the message like
116 116 // normal. If this is a patch operation, just send the
117 117 // changes.
118 118 var send_json = model_json;
119 119 if (method=='patch') {
120 120 send_json = {};
121 121 for (var attr in options.attrs) {
122 122 send_json[attr] = options.attrs[attr];
123 123 }
124 124 }
125 125
126 126 var data = {sync_method: method, sync_data: send_json};
127 127
128 128 var output_area = null;
129 129 if (this.last_modified_view != undefined && this.last_modified_view != null) {
130 130 output_area = this.last_modified_view.output_area;
131 131 }
132 132
133 133 var callbacks = this._make_callbacks(output_area);
134 134 this.comm.send(data, callbacks);
135 135 this.pending_msgs++;
136 136 }
137 137 }
138 138
139 139 // Since the comm is a one-way communication, assume the message
140 140 // arrived.
141 141 return model_json;
142 142 },
143 143
144 144
145 145 // Handle incomming comm msg.
146 146 handle_comm_msg: function (msg) {
147 147 var method = msg.content.data.method;
148 148 switch (method){
149 149 case 'display':
150 150
151 151 // Try to get the cell index.
152 152 var output_area = this._get_output_area(msg.parent_header.msg_id);
153 153 if (output_area == null) {
154 154 console.log("Could not determine where the display" +
155 155 " message was from. Widget will not be displayed")
156 156 } else {
157 157 this.display_view(msg.content.data.view_name,
158 158 msg.content.data.parent,
159 159 output_area);
160 160 }
161 161 break;
162 162 case 'update':
163 163 this.handle_update(msg.content.data.state);
164 164 break;
165 165 }
166 166 },
167 167
168 168
169 169 // Handle when a widget is updated via the python side.
170 170 handle_update: function (state) {
171 171 this.updating = true;
172 172 try {
173 173 for (var key in state) {
174 174 if (state.hasOwnProperty(key)) {
175 175 if (key == "_css"){
176 176 this.css = state[key];
177 177 } else {
178 178 this.set(key, state[key]);
179 179 }
180 180 }
181 181 }
182 182 this.id = this.comm.comm_id;
183 183 this.save();
184 184 } finally {
185 185 this.updating = false;
186 186 }
187 187 },
188 188
189 189
190 190 // Handle when a widget is closed.
191 191 handle_comm_closed: function (msg) {
192 192 for (var output_area in this.views) {
193 193 var views = this.views[output_area];
194 194 for (var view_index in views) {
195 195 var view = views[view_index];
196 196 view.remove();
197 197 }
198 198 }
199 199 },
200 200
201 201
202 202 // Create view that represents the model.
203 203 display_view: function (view_name, parent_comm_id, output_area) {
204 204 var new_views = [];
205 205
206 206 var displayed = false;
207 207 if (parent_comm_id != undefined) {
208 208 var parent_comm = this.comm_manager.comms[parent_comm_id];
209 209 var parent_model = parent_comm.model;
210 210 var parent_views = parent_model.views[output_area];
211 211 for (var parent_view_index in parent_views) {
212 212 var parent_view = parent_views[parent_view_index];
213 213 if (parent_view.display_child != undefined) {
214 214 var view = this._create_view(view_name, output_area);
215 215 new_views.push(view);
216 216 parent_view.display_child(view);
217 217 displayed = true;
218 218 }
219 219 }
220 220 }
221 221
222 222 if (!displayed) {
223 223 // No parent view is defined or exists. Add the view's
224 224 // element to cell's widget div.
225 225 var view = this._create_view(view_name, output_area);
226 226 new_views.push(view);
227 227 this._get_widget_area_element(output_area, true)
228 228 .append(view.$el);
229 229
230 230 }
231 231
232 232 for (var view_index in new_views) {
233 233 var view = new_views[view_index];
234 234 view.update();
235 235 }
236 236 },
237 237
238 238
239 239 // Create a view
240 240 _create_view: function (view_name, output_area) {
241 241 var view = new this.widget_view_types[view_name]({model: this});
242 242 view.render();
243 243 if (this.views[output_area]==undefined) {
244 244 this.views[output_area] = []
245 245 }
246 246 this.views[output_area].push(view);
247 247 view.output_area = output_area;
248 248
249 249 // Handle when the view element is remove from the page.
250 250 var that = this;
251 251 view.$el.on("remove", function(){
252 252 var index = that.views[output_area].indexOf(view);
253 253 if (index > -1) {
254 254 that.views[output_area].splice(index, 1);
255 255 }
256 256 view.remove(); // Clean-up view
257 257 if (that.views[output_area].length()==0) {
258 258 delete that.views[output_area];
259 259 }
260 260
261 261 // Close the comm if there are no views left.
262 262 if (that.views.length()==0) {
263 263 that.comm.close();
264 264 }
265 265 });
266 266 return view;
267 267 },
268 268
269 269
270 270 // Build a callback dict.
271 271 _make_callbacks: function (output_area) {
272 272 var callbacks = {};
273 273 if (output_area != null) {
274 274 var that = this;
275 275 callbacks = {
276 276 iopub : {
277 277 output : $.proxy(output_area.handle_output, output_area),
278 278 clear_output : $.proxy(output_area.handle_clear_output, output_area),
279 279 status : function(msg){
280 280 that.handle_status(output_area, msg);
281 281 },
282 282 get_output_area : function() {
283 283 if (that.last_modified_view != undefined &&
284 284 that.last_modified_view.output_area != undefined) {
285 285 return that.last_modified_view.output_area;
286 286 } else {
287 287 return null
288 288 }
289 289 },
290 290 },
291 291 };
292 292 }
293 293 return callbacks;
294 294 },
295 295
296 296
297 297 // Get the output area corresponding to the msg_id.
298 298 // output_area is an instance of Ipython.OutputArea
299 299 _get_output_area: function (msg_id) {
300 300
301 301 // First, check to see if the msg was triggered by cell execution.
302 var cell = IPython.notebook.get_msg_cell();
302 var cell = IPython.notebook.get_msg_cell(msg_id);
303 303 if (cell != null) {
304 304 return cell.output_area;
305 305 }
306 306
307 307 // Second, check to see if a get_output_area callback was defined
308 308 // for the message. get_output_area callbacks are registered for
309 309 // widget messages, so this block is actually checking to see if the
310 310 // message was triggered by a widget.
311 311 var kernel = this.comm_manager.kernel;
312 312 var callbacks = kernel.get_callbacks_for_msg(msg_id);
313 313 if (callbacks != undefined &&
314 314 callbacks.iopub != undefined &&
315 315 callbacks.iopub.get_output_area != undefined) {
316 316
317 317 var output_area = callbacks.iopub.get_output_area();
318 318 if (output_area != null) {
319 319 return output_area;
320 320 }
321 321 }
322 322
323 323 // Not triggered by a cell or widget (no get_output_area callback
324 324 // exists).
325 325 return null;
326 326 },
327 327
328 328 // Gets widget output area (as a JQuery element) from the
329 329 // output_area (Ipython.OutputArea instance)
330 330 _get_widget_area_element: function (output_area, show) {
331 331 var widget_area = output_area.element
332 332 .parent() // output_wrapper
333 333 .parent() // cell
334 334 .find('.widget-area');
335 335 if (show) { widget_area.show(); }
336 336 return widget_area.find('.widget-subarea');
337 337 },
338 338
339 339 });
340 340
341 341
342 342 //--------------------------------------------------------------------
343 343 // WidgetView class
344 344 //--------------------------------------------------------------------
345 345 var WidgetView = Backbone.View.extend({
346 346
347 347 initialize: function() {
348 348 this.visible = true;
349 349 this.model.on('change',this.update,this);
350 350 this._add_class_calls = this.model.get('_add_class')[0];
351 351 this._remove_class_calls = this.model.get('_remove_class')[0];
352 352 },
353 353
354 354 update: function() {
355 355 if (this.model.get('visible') != undefined) {
356 356 if (this.visible != this.model.get('visible')) {
357 357 this.visible = this.model.get('visible');
358 358 if (this.visible) {
359 359 this.$el.show();
360 360 } else {
361 361 this.$el.hide();
362 362 }
363 363 }
364 364 }
365 365
366 366 if (this.model.css != undefined) {
367 367 for (var selector in this.model.css) {
368 368 if (this.model.css.hasOwnProperty(selector)) {
369 369
370 370 // Apply the css traits to all elements that match the selector.
371 371 var elements = this.get_selector_element(selector);
372 372 if (elements.length > 0) {
373 373 var css_traits = this.model.css[selector];
374 374 for (var css_key in css_traits) {
375 375 if (css_traits.hasOwnProperty(css_key)) {
376 376 elements.css(css_key, css_traits[css_key]);
377 377 }
378 378 }
379 379 }
380 380 }
381 381 }
382 382 }
383 383
384 384 var add_class = this.model.get('_add_class');
385 385 if (add_class != undefined){
386 386 var add_class_calls = add_class[0];
387 387 if (add_class_calls > this._add_class_calls) {
388 388 this._add_class_calls = add_class_calls;
389 389 var elements = this.get_selector_element(add_class[1]);
390 390 if (elements.length > 0) {
391 391 elements.addClass(add_class[2]);
392 392 }
393 393 }
394 394 }
395 395
396 396 var remove_class = this.model.get('_remove_class');
397 397 if (remove_class != undefined){
398 398 var remove_class_calls = remove_class[0];
399 399 if (remove_class_calls > this._remove_class_calls) {
400 400 this._remove_class_calls = remove_class_calls;
401 401 var elements = this.get_selector_element(remove_class[1]);
402 402 if (elements.length > 0) {
403 403 elements.removeClass(remove_class[2]);
404 404 }
405 405 }
406 406 }
407 407 },
408 408
409 409 get_selector_element: function(selector) {
410 410 // Get the elements via the css selector. If the selector is
411 411 // blank, apply the style to the $el_to_style element. If
412 412 // the $el_to_style element is not defined, use apply the
413 413 // style to the view's element.
414 414 var elements = this.$el.find(selector);
415 415 if (selector=='') {
416 416 if (this.$el_to_style == undefined) {
417 417 elements = this.$el;
418 418 } else {
419 419 elements = this.$el_to_style;
420 420 }
421 421 }
422 422 return elements;
423 423 },
424 424 });
425 425
426 426
427 427 //--------------------------------------------------------------------
428 428 // WidgetManager class
429 429 //--------------------------------------------------------------------
430 430 var WidgetManager = function(){
431 431 this.comm_manager = null;
432 432 this.widget_model_types = {};
433 433 this.widget_view_types = {};
434 434
435 435 var that = this;
436 436 Backbone.sync = function(method, model, options, error) {
437 437 var result = model.handle_sync(method, options);
438 438 if (options.success) {
439 439 options.success(result);
440 440 }
441 441 };
442 442 }
443 443
444 444
445 445 WidgetManager.prototype.attach_comm_manager = function (comm_manager) {
446 446 this.comm_manager = comm_manager;
447 447
448 448 // Register already register widget model types with the comm manager.
449 449 for (var widget_model_name in this.widget_model_types) {
450 450 this.comm_manager.register_target(widget_model_name, $.proxy(this.handle_com_open, this));
451 451 }
452 452 }
453 453
454 454
455 455 WidgetManager.prototype.register_widget_model = function (widget_model_name, widget_model_type) {
456 456 // Register the widget with the comm manager. Make sure to pass this object's context
457 457 // in so `this` works in the call back.
458 458 if (this.comm_manager!=null) {
459 459 this.comm_manager.register_target(widget_model_name, $.proxy(this.handle_com_open, this));
460 460 }
461 461 this.widget_model_types[widget_model_name] = widget_model_type;
462 462 }
463 463
464 464
465 465 WidgetManager.prototype.register_widget_view = function (widget_view_name, widget_view_type) {
466 466 this.widget_view_types[widget_view_name] = widget_view_type;
467 467 }
468 468
469 469
470 470 WidgetManager.prototype.handle_com_open = function (comm, msg) {
471 471 var widget_type_name = msg.content.target_name;
472 472 var widget_model = new this.widget_model_types[widget_type_name](this.comm_manager, comm, this.widget_view_types);
473 473 }
474 474
475 475
476 476 //--------------------------------------------------------------------
477 477 // Init code
478 478 //--------------------------------------------------------------------
479 479 IPython.WidgetManager = WidgetManager;
480 480 IPython.WidgetModel = WidgetModel;
481 481 IPython.WidgetView = WidgetView;
482 482
483 483 IPython.widget_manager = new WidgetManager();
484 484
485 485 });
General Comments 0
You need to be logged in to leave comments. Login now