Show More
@@ -1,411 +1,411 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 | // Base Widget Model and View classes |
|
10 | 10 | //============================================================================ |
|
11 | 11 | |
|
12 | 12 | /** |
|
13 | 13 | * @module IPython |
|
14 | 14 | * @namespace IPython |
|
15 | 15 | **/ |
|
16 | 16 | |
|
17 | 17 | define(["notebook/js/widgetmanager", |
|
18 | 18 | "underscore", |
|
19 | 19 | "backbone"], |
|
20 | 20 | function(WidgetManager, Underscore, Backbone){ |
|
21 | 21 | |
|
22 | 22 | var WidgetModel = Backbone.Model.extend({ |
|
23 | 23 | constructor: function (widget_manager, model_id, comm) { |
|
24 | 24 | // Construcctor |
|
25 | 25 | // |
|
26 | 26 | // Creates a WidgetModel instance. |
|
27 | 27 | // |
|
28 | 28 | // Parameters |
|
29 | 29 | // ---------- |
|
30 | 30 | // widget_manager : WidgetManager instance |
|
31 | 31 | // model_id : string |
|
32 | 32 | // An ID unique to this model. |
|
33 | 33 | // comm : Comm instance (optional) |
|
34 | 34 | this.widget_manager = widget_manager; |
|
35 | 35 | this.pending_msgs = 0; |
|
36 |
this.msg_throttle = |
|
|
36 | this.msg_throttle = 3; | |
|
37 | 37 | this.msg_buffer = null; |
|
38 | 38 | this.key_value_lock = null; |
|
39 | 39 | this.id = model_id; |
|
40 | 40 | this.views = []; |
|
41 | 41 | |
|
42 | 42 | if (comm !== undefined) { |
|
43 | 43 | // Remember comm associated with the model. |
|
44 | 44 | this.comm = comm; |
|
45 | 45 | comm.model = this; |
|
46 | 46 | |
|
47 | 47 | // Hook comm messages up to model. |
|
48 | 48 | comm.on_close($.proxy(this._handle_comm_closed, this)); |
|
49 | 49 | comm.on_msg($.proxy(this._handle_comm_msg, this)); |
|
50 | 50 | } |
|
51 | 51 | return Backbone.Model.apply(this); |
|
52 | 52 | }, |
|
53 | 53 | |
|
54 | 54 | send: function (content, callbacks) { |
|
55 | 55 | // Send a custom msg over the comm. |
|
56 | 56 | if (this.comm !== undefined) { |
|
57 | 57 | var data = {method: 'custom', content: content}; |
|
58 | 58 | this.comm.send(data, callbacks); |
|
59 | 59 | } |
|
60 | 60 | }, |
|
61 | 61 | |
|
62 | 62 | _handle_comm_closed: function (msg) { |
|
63 | 63 | // Handle when a widget is closed. |
|
64 | 64 | this.trigger('comm:close'); |
|
65 | 65 | delete this.comm.model; // Delete ref so GC will collect widget model. |
|
66 | 66 | delete this.comm; |
|
67 | 67 | delete this.model_id; // Delete id from model so widget manager cleans up. |
|
68 | 68 | // TODO: Handle deletion, like this.destroy(), and delete views, etc. |
|
69 | 69 | }, |
|
70 | 70 | |
|
71 | 71 | _handle_comm_msg: function (msg) { |
|
72 | 72 | // Handle incoming comm msg. |
|
73 | 73 | var method = msg.content.data.method; |
|
74 | 74 | switch (method) { |
|
75 | 75 | case 'update': |
|
76 | 76 | this.apply_update(msg.content.data.state); |
|
77 | 77 | break; |
|
78 | 78 | case 'custom': |
|
79 | 79 | this.trigger('msg:custom', msg.content.data.content); |
|
80 | 80 | break; |
|
81 | 81 | case 'display': |
|
82 | 82 | this.widget_manager.display_view(msg, this); |
|
83 | 83 | break; |
|
84 | 84 | } |
|
85 | 85 | }, |
|
86 | 86 | |
|
87 | 87 | apply_update: function (state) { |
|
88 | 88 | // Handle when a widget is updated via the python side. |
|
89 | 89 | var that = this; |
|
90 | 90 | _.each(state, function(value, key) { |
|
91 | 91 | that.key_value_lock = [key, value]; |
|
92 | 92 | try { |
|
93 | 93 | that.set(key, that._unpack_models(value)); |
|
94 | 94 | } finally { |
|
95 | 95 | that.key_value_lock = null; |
|
96 | 96 | } |
|
97 | 97 | }); |
|
98 | 98 | }, |
|
99 | 99 | |
|
100 | 100 | _handle_status: function (msg, callbacks) { |
|
101 | 101 | // Handle status msgs. |
|
102 | 102 | |
|
103 | 103 | // execution_state : ('busy', 'idle', 'starting') |
|
104 | 104 | if (this.comm !== undefined) { |
|
105 | 105 | if (msg.content.execution_state ==='idle') { |
|
106 | 106 | // Send buffer if this message caused another message to be |
|
107 | 107 | // throttled. |
|
108 | 108 | if (this.msg_buffer !== null && |
|
109 | 109 | this.msg_throttle === this.pending_msgs) { |
|
110 | 110 | var data = {method: 'backbone', sync_method: 'update', sync_data: this.msg_buffer}; |
|
111 | 111 | this.comm.send(data, callbacks); |
|
112 | 112 | this.msg_buffer = null; |
|
113 | 113 | } else { |
|
114 | 114 | --this.pending_msgs; |
|
115 | 115 | } |
|
116 | 116 | } |
|
117 | 117 | } |
|
118 | 118 | }, |
|
119 | 119 | |
|
120 | 120 | callbacks: function(view) { |
|
121 | 121 | // Create msg callbacks for a comm msg. |
|
122 | 122 | var callbacks = this.widget_manager.callbacks(view); |
|
123 | 123 | |
|
124 | 124 | if (callbacks.iopub === undefined) { |
|
125 | 125 | callbacks.iopub = {}; |
|
126 | 126 | } |
|
127 | 127 | |
|
128 | 128 | var that = this; |
|
129 | 129 | callbacks.iopub.status = function (msg) { |
|
130 | 130 | that._handle_status(msg, callbacks); |
|
131 | 131 | } |
|
132 | 132 | return callbacks; |
|
133 | 133 | }, |
|
134 | 134 | |
|
135 | 135 | sync: function (method, model, options) { |
|
136 | 136 | // Handle sync to the back-end. Called when a model.save() is called. |
|
137 | 137 | |
|
138 | 138 | // Make sure a comm exists. |
|
139 | 139 | var error = options.error || function() { |
|
140 | 140 | console.error('Backbone sync error:', arguments); |
|
141 | 141 | } |
|
142 | 142 | if (this.comm === undefined) { |
|
143 | 143 | error(); |
|
144 | 144 | return false; |
|
145 | 145 | } |
|
146 | 146 | |
|
147 | 147 | // Delete any key value pairs that the back-end already knows about. |
|
148 | 148 | var attrs = (method === 'patch') ? options.attrs : model.toJSON(options); |
|
149 | 149 | if (this.key_value_lock !== null) { |
|
150 | 150 | var key = this.key_value_lock[0]; |
|
151 | 151 | var value = this.key_value_lock[1]; |
|
152 | 152 | if (attrs[key] === value) { |
|
153 | 153 | delete attrs[key]; |
|
154 | 154 | } |
|
155 | 155 | } |
|
156 | 156 | |
|
157 | 157 | // Only sync if there are attributes to send to the back-end. |
|
158 | 158 | if (_.size(attrs) > 0) { |
|
159 | 159 | var callbacks = options.callbacks || {}; |
|
160 | 160 | if (this.pending_msgs >= this.msg_throttle) { |
|
161 | 161 | // The throttle has been exceeded, buffer the current msg so |
|
162 | 162 | // it can be sent once the kernel has finished processing |
|
163 | 163 | // some of the existing messages. |
|
164 | 164 | |
|
165 | 165 | // Combine updates if it is a 'patch' sync, otherwise replace updates |
|
166 | 166 | switch (method) { |
|
167 | 167 | case 'patch': |
|
168 | 168 | this.msg_buffer = $.extend(this.msg_buffer || {}, attrs); |
|
169 | 169 | break; |
|
170 | 170 | case 'update': |
|
171 | 171 | case 'create': |
|
172 | 172 | this.msg_buffer = attrs; |
|
173 | 173 | break; |
|
174 | 174 | default: |
|
175 | 175 | error(); |
|
176 | 176 | return false; |
|
177 | 177 | } |
|
178 | 178 | this.msg_buffer_callbacks = callbacks; |
|
179 | 179 | |
|
180 | 180 | } else { |
|
181 | 181 | // We haven't exceeded the throttle, send the message like |
|
182 | 182 | // normal. If this is a patch operation, just send the |
|
183 | 183 | // changes. |
|
184 | 184 | var data = {method: 'backbone', sync_data: attrs}; |
|
185 | 185 | this.comm.send(data, callbacks); |
|
186 | 186 | this.pending_msgs++; |
|
187 | 187 | } |
|
188 | 188 | } |
|
189 | 189 | // Since the comm is a one-way communication, assume the message |
|
190 | 190 | // arrived. Don't call success since we don't have a model back from the server |
|
191 | 191 | // this means we miss out on the 'sync' event. |
|
192 | 192 | }, |
|
193 | 193 | |
|
194 | 194 | save_changes: function(callbacks) { |
|
195 | 195 | // Push this model's state to the back-end |
|
196 | 196 | // |
|
197 | 197 | // This invokes a Backbone.Sync. |
|
198 | 198 | this.save(this.changedAttributes(), {patch: true, callbacks: callbacks}); |
|
199 | 199 | }, |
|
200 | 200 | |
|
201 | 201 | _pack_models: function(value) { |
|
202 | 202 | // Replace models with model ids recursively. |
|
203 | 203 | if (value instanceof Backbone.Model) { |
|
204 | 204 | return value.id; |
|
205 | 205 | } else if (value instanceof Object) { |
|
206 | 206 | var packed = {}; |
|
207 | 207 | var that = this; |
|
208 | 208 | _.each(value, function(sub_value, key) { |
|
209 | 209 | packed[key] = that._pack_models(sub_value); |
|
210 | 210 | }); |
|
211 | 211 | return packed; |
|
212 | 212 | } else { |
|
213 | 213 | return value; |
|
214 | 214 | } |
|
215 | 215 | }, |
|
216 | 216 | |
|
217 | 217 | _unpack_models: function(value) { |
|
218 | 218 | // Replace model ids with models recursively. |
|
219 | 219 | if (value instanceof Object) { |
|
220 | 220 | var unpacked = {}; |
|
221 | 221 | var that = this; |
|
222 | 222 | _.each(value, function(sub_value, key) { |
|
223 | 223 | unpacked[key] = that._unpack_models(sub_value); |
|
224 | 224 | }); |
|
225 | 225 | return unpacked; |
|
226 | 226 | } else { |
|
227 | 227 | var model = this.widget_manager.get_model(value); |
|
228 | 228 | if (model !== null) { |
|
229 | 229 | return model; |
|
230 | 230 | } else { |
|
231 | 231 | return value; |
|
232 | 232 | } |
|
233 | 233 | } |
|
234 | 234 | }, |
|
235 | 235 | |
|
236 | 236 | }); |
|
237 | 237 | WidgetManager.register_widget_model('WidgetModel', WidgetModel); |
|
238 | 238 | |
|
239 | 239 | |
|
240 | 240 | var WidgetView = Backbone.View.extend({ |
|
241 | 241 | initialize: function(parameters) { |
|
242 | 242 | // Public constructor. |
|
243 | 243 | this.model.on('change',this.update,this); |
|
244 | 244 | this.options = parameters.options; |
|
245 | 245 | this.child_views = []; |
|
246 | 246 | this.model.views.push(this); |
|
247 | 247 | }, |
|
248 | 248 | |
|
249 | 249 | update: function(){ |
|
250 | 250 | // Triggered on model change. |
|
251 | 251 | // |
|
252 | 252 | // Update view to be consistent with this.model |
|
253 | 253 | }, |
|
254 | 254 | |
|
255 | 255 | create_child_view: function(child_model, options) { |
|
256 | 256 | // Create and return a child view. |
|
257 | 257 | // |
|
258 | 258 | // -given a model and (optionally) a view name if the view name is |
|
259 | 259 | // not given, it defaults to the model's default view attribute. |
|
260 | 260 | |
|
261 | 261 | // TODO: this is hacky, and makes the view depend on this cell attribute and widget manager behavior |
|
262 | 262 | // it would be great to have the widget manager add the cell metadata |
|
263 | 263 | // to the subview without having to add it here. |
|
264 | 264 | var child_view = this.model.widget_manager.create_view(child_model, options || {}, this); |
|
265 | 265 | this.child_views[child_model.id] = child_view; |
|
266 | 266 | return child_view; |
|
267 | 267 | }, |
|
268 | 268 | |
|
269 | 269 | delete_child_view: function(child_model, options) { |
|
270 | 270 | // Delete a child view that was previously created using create_child_view. |
|
271 | 271 | var view = this.child_views[child_model.id]; |
|
272 | 272 | if (view !== undefined) { |
|
273 | 273 | delete this.child_views[child_model.id]; |
|
274 | 274 | view.remove(); |
|
275 | 275 | } |
|
276 | 276 | }, |
|
277 | 277 | |
|
278 | 278 | do_diff: function(old_list, new_list, removed_callback, added_callback) { |
|
279 | 279 | // Difference a changed list and call remove and add callbacks for |
|
280 | 280 | // each removed and added item in the new list. |
|
281 | 281 | // |
|
282 | 282 | // Parameters |
|
283 | 283 | // ---------- |
|
284 | 284 | // old_list : array |
|
285 | 285 | // new_list : array |
|
286 | 286 | // removed_callback : Callback(item) |
|
287 | 287 | // Callback that is called for each item removed. |
|
288 | 288 | // added_callback : Callback(item) |
|
289 | 289 | // Callback that is called for each item added. |
|
290 | 290 | |
|
291 | 291 | |
|
292 | 292 | // removed items |
|
293 | 293 | _.each(_.difference(old_list, new_list), function(item, index, list) { |
|
294 | 294 | removed_callback(item); |
|
295 | 295 | }, this); |
|
296 | 296 | |
|
297 | 297 | // added items |
|
298 | 298 | _.each(_.difference(new_list, old_list), function(item, index, list) { |
|
299 | 299 | added_callback(item); |
|
300 | 300 | }, this); |
|
301 | 301 | }, |
|
302 | 302 | |
|
303 | 303 | callbacks: function(){ |
|
304 | 304 | // Create msg callbacks for a comm msg. |
|
305 | 305 | return this.model.callbacks(this); |
|
306 | 306 | }, |
|
307 | 307 | |
|
308 | 308 | render: function(){ |
|
309 | 309 | // Render the view. |
|
310 | 310 | // |
|
311 | 311 | // By default, this is only called the first time the view is created |
|
312 | 312 | }, |
|
313 | 313 | |
|
314 | 314 | send: function (content) { |
|
315 | 315 | // Send a custom msg associated with this view. |
|
316 | 316 | this.model.send(content, this.callbacks()); |
|
317 | 317 | }, |
|
318 | 318 | |
|
319 | 319 | touch: function () { |
|
320 | 320 | this.model.save_changes(this.callbacks()); |
|
321 | 321 | }, |
|
322 | 322 | }); |
|
323 | 323 | |
|
324 | 324 | |
|
325 | 325 | var DOMWidgetView = WidgetView.extend({ |
|
326 | 326 | initialize: function (options) { |
|
327 | 327 | // Public constructor |
|
328 | 328 | |
|
329 | 329 | // In the future we may want to make changes more granular |
|
330 | 330 | // (e.g., trigger on visible:change). |
|
331 | 331 | this.model.on('change', this.update, this); |
|
332 | 332 | this.model.on('msg:custom', this.on_msg, this); |
|
333 | 333 | DOMWidgetView.__super__.initialize.apply(this, arguments); |
|
334 | 334 | }, |
|
335 | 335 | |
|
336 | 336 | on_msg: function(msg) { |
|
337 | 337 | // Handle DOM specific msgs. |
|
338 | 338 | switch(msg.msg_type) { |
|
339 | 339 | case 'add_class': |
|
340 | 340 | this.add_class(msg.selector, msg.class_list); |
|
341 | 341 | break; |
|
342 | 342 | case 'remove_class': |
|
343 | 343 | this.remove_class(msg.selector, msg.class_list); |
|
344 | 344 | break; |
|
345 | 345 | } |
|
346 | 346 | }, |
|
347 | 347 | |
|
348 | 348 | add_class: function (selector, class_list) { |
|
349 | 349 | // Add a DOM class to an element. |
|
350 | 350 | this._get_selector_element(selector).addClass(class_list); |
|
351 | 351 | }, |
|
352 | 352 | |
|
353 | 353 | remove_class: function (selector, class_list) { |
|
354 | 354 | // Remove a DOM class from an element. |
|
355 | 355 | this._get_selector_element(selector).removeClass(class_list); |
|
356 | 356 | }, |
|
357 | 357 | |
|
358 | 358 | update: function () { |
|
359 | 359 | // Update the contents of this view |
|
360 | 360 | // |
|
361 | 361 | // Called when the model is changed. The model may have been |
|
362 | 362 | // changed by another view or by a state update from the back-end. |
|
363 | 363 | // The very first update seems to happen before the element is |
|
364 | 364 | // finished rendering so we use setTimeout to give the element time |
|
365 | 365 | // to render |
|
366 | 366 | var e = this.$el; |
|
367 | 367 | var visible = this.model.get('visible'); |
|
368 | 368 | setTimeout(function() {e.toggle(visible)},0); |
|
369 | 369 | |
|
370 | 370 | var css = this.model.get('_css'); |
|
371 | 371 | if (css === undefined) {return;} |
|
372 | 372 | var that = this; |
|
373 | 373 | _.each(css, function(css_traits, selector){ |
|
374 | 374 | // Apply the css traits to all elements that match the selector. |
|
375 | 375 | var elements = that._get_selector_element(selector); |
|
376 | 376 | if (elements.length > 0) { |
|
377 | 377 | _.each(css_traits, function(css_value, css_key){ |
|
378 | 378 | elements.css(css_key, css_value); |
|
379 | 379 | }); |
|
380 | 380 | } |
|
381 | 381 | }); |
|
382 | 382 | |
|
383 | 383 | }, |
|
384 | 384 | |
|
385 | 385 | _get_selector_element: function (selector) { |
|
386 | 386 | // Get the elements via the css selector. |
|
387 | 387 | |
|
388 | 388 | // If the selector is blank, apply the style to the $el_to_style |
|
389 | 389 | // element. If the $el_to_style element is not defined, use apply |
|
390 | 390 | // the style to the view's element. |
|
391 | 391 | var elements; |
|
392 | 392 | if (selector === undefined || selector === null || selector === '') { |
|
393 | 393 | if (this.$el_to_style === undefined) { |
|
394 | 394 | elements = this.$el; |
|
395 | 395 | } else { |
|
396 | 396 | elements = this.$el_to_style; |
|
397 | 397 | } |
|
398 | 398 | } else { |
|
399 | 399 | elements = this.$el.find(selector); |
|
400 | 400 | } |
|
401 | 401 | return elements; |
|
402 | 402 | }, |
|
403 | 403 | }); |
|
404 | 404 | |
|
405 | 405 | IPython.WidgetModel = WidgetModel; |
|
406 | 406 | IPython.WidgetView = WidgetView; |
|
407 | 407 | IPython.DOMWidgetView = DOMWidgetView; |
|
408 | 408 | |
|
409 | 409 | // Pass through WidgetManager namespace. |
|
410 | 410 | return WidgetManager; |
|
411 | 411 | }); |
General Comments 0
You need to be logged in to leave comments.
Login now