Show More
@@ -1,497 +1,498 b'' | |||
|
1 | 1 | // Copyright (c) IPython Development Team. |
|
2 | 2 | // Distributed under the terms of the Modified BSD License. |
|
3 | 3 | |
|
4 | 4 | define(["widgets/js/manager", |
|
5 | 5 | "underscore", |
|
6 | 6 | "backbone", |
|
7 | 7 | "jquery", |
|
8 | 8 | "base/js/namespace", |
|
9 | 9 | ], function(widgetmanager, _, Backbone, $, IPython){ |
|
10 | 10 | |
|
11 | 11 | var WidgetModel = Backbone.Model.extend({ |
|
12 | 12 | constructor: function (widget_manager, model_id, comm) { |
|
13 | 13 | // Constructor |
|
14 | 14 | // |
|
15 | 15 | // Creates a WidgetModel instance. |
|
16 | 16 | // |
|
17 | 17 | // Parameters |
|
18 | 18 | // ---------- |
|
19 | 19 | // widget_manager : WidgetManager instance |
|
20 | 20 | // model_id : string |
|
21 | 21 | // An ID unique to this model. |
|
22 | 22 | // comm : Comm instance (optional) |
|
23 | 23 | this.widget_manager = widget_manager; |
|
24 | 24 | this._buffered_state_diff = {}; |
|
25 | 25 | this.pending_msgs = 0; |
|
26 | 26 | this.msg_buffer = null; |
|
27 | 27 | this.key_value_lock = null; |
|
28 | 28 | this.id = model_id; |
|
29 | 29 | this.views = []; |
|
30 | 30 | |
|
31 | 31 | if (comm !== undefined) { |
|
32 | 32 | // Remember comm associated with the model. |
|
33 | 33 | this.comm = comm; |
|
34 | 34 | comm.model = this; |
|
35 | 35 | |
|
36 | 36 | // Hook comm messages up to model. |
|
37 | 37 | comm.on_close($.proxy(this._handle_comm_closed, this)); |
|
38 | 38 | comm.on_msg($.proxy(this._handle_comm_msg, this)); |
|
39 | 39 | } |
|
40 | 40 | return Backbone.Model.apply(this); |
|
41 | 41 | }, |
|
42 | 42 | |
|
43 | 43 | send: function (content, callbacks) { |
|
44 | 44 | // Send a custom msg over the comm. |
|
45 | 45 | if (this.comm !== undefined) { |
|
46 | 46 | var data = {method: 'custom', content: content}; |
|
47 | 47 | this.comm.send(data, callbacks); |
|
48 | 48 | this.pending_msgs++; |
|
49 | 49 | } |
|
50 | 50 | }, |
|
51 | 51 | |
|
52 | 52 | _handle_comm_closed: function (msg) { |
|
53 | 53 | // Handle when a widget is closed. |
|
54 | 54 | this.trigger('comm:close'); |
|
55 | 55 | delete this.comm.model; // Delete ref so GC will collect widget model. |
|
56 | 56 | delete this.comm; |
|
57 | 57 | delete this.model_id; // Delete id from model so widget manager cleans up. |
|
58 | 58 | _.each(this.views, function(view, i) { |
|
59 | 59 | view.remove(); |
|
60 | 60 | }); |
|
61 | 61 | }, |
|
62 | 62 | |
|
63 | 63 | _handle_comm_msg: function (msg) { |
|
64 | 64 | // Handle incoming comm msg. |
|
65 | 65 | var method = msg.content.data.method; |
|
66 | 66 | switch (method) { |
|
67 | 67 | case 'update': |
|
68 | 68 | this.apply_update(msg.content.data.state); |
|
69 | 69 | break; |
|
70 | 70 | case 'custom': |
|
71 | 71 | this.trigger('msg:custom', msg.content.data.content); |
|
72 | 72 | break; |
|
73 | 73 | case 'display': |
|
74 | 74 | this.widget_manager.display_view(msg, this); |
|
75 | 75 | break; |
|
76 | 76 | } |
|
77 | 77 | }, |
|
78 | 78 | |
|
79 | 79 | apply_update: function (state) { |
|
80 | 80 | // Handle when a widget is updated via the python side. |
|
81 | 81 | var that = this; |
|
82 | 82 | _.each(state, function(value, key) { |
|
83 | 83 | that.key_value_lock = [key, value]; |
|
84 | 84 | try { |
|
85 | 85 | WidgetModel.__super__.set.apply(that, [key, that._unpack_models(value)]); |
|
86 | 86 | } finally { |
|
87 | 87 | that.key_value_lock = null; |
|
88 | 88 | } |
|
89 | 89 | }); |
|
90 | 90 | }, |
|
91 | 91 | |
|
92 | 92 | _handle_status: function (msg, callbacks) { |
|
93 | 93 | // Handle status msgs. |
|
94 | 94 | |
|
95 | 95 | // execution_state : ('busy', 'idle', 'starting') |
|
96 | 96 | if (this.comm !== undefined) { |
|
97 | 97 | if (msg.content.execution_state ==='idle') { |
|
98 | 98 | // Send buffer if this message caused another message to be |
|
99 | 99 | // throttled. |
|
100 | 100 | if (this.msg_buffer !== null && |
|
101 | 101 | (this.get('msg_throttle') || 3) === this.pending_msgs) { |
|
102 | 102 | var data = {method: 'backbone', sync_method: 'update', sync_data: this.msg_buffer}; |
|
103 | 103 | this.comm.send(data, callbacks); |
|
104 | 104 | this.msg_buffer = null; |
|
105 | 105 | } else { |
|
106 | 106 | --this.pending_msgs; |
|
107 | 107 | } |
|
108 | 108 | } |
|
109 | 109 | } |
|
110 | 110 | }, |
|
111 | 111 | |
|
112 | 112 | callbacks: function(view) { |
|
113 | 113 | // Create msg callbacks for a comm msg. |
|
114 | 114 | var callbacks = this.widget_manager.callbacks(view); |
|
115 | 115 | |
|
116 | 116 | if (callbacks.iopub === undefined) { |
|
117 | 117 | callbacks.iopub = {}; |
|
118 | 118 | } |
|
119 | 119 | |
|
120 | 120 | var that = this; |
|
121 | 121 | callbacks.iopub.status = function (msg) { |
|
122 | 122 | that._handle_status(msg, callbacks); |
|
123 | 123 | }; |
|
124 | 124 | return callbacks; |
|
125 | 125 | }, |
|
126 | 126 | |
|
127 | 127 | set: function(key, val, options) { |
|
128 | 128 | // Set a value. |
|
129 | 129 | var return_value = WidgetModel.__super__.set.apply(this, arguments); |
|
130 | 130 | |
|
131 | 131 | // Backbone only remembers the diff of the most recent set() |
|
132 | 132 | // operation. Calling set multiple times in a row results in a |
|
133 | 133 | // loss of diff information. Here we keep our own running diff. |
|
134 | 134 | this._buffered_state_diff = $.extend(this._buffered_state_diff, this.changedAttributes() || {}); |
|
135 | 135 | return return_value; |
|
136 | 136 | }, |
|
137 | 137 | |
|
138 | 138 | sync: function (method, model, options) { |
|
139 | 139 | // Handle sync to the back-end. Called when a model.save() is called. |
|
140 | 140 | |
|
141 | 141 | // Make sure a comm exists. |
|
142 | 142 | var error = options.error || function() { |
|
143 | 143 | console.error('Backbone sync error:', arguments); |
|
144 | 144 | }; |
|
145 | 145 | if (this.comm === undefined) { |
|
146 | 146 | error(); |
|
147 | 147 | return false; |
|
148 | 148 | } |
|
149 | 149 | |
|
150 | 150 | // Delete any key value pairs that the back-end already knows about. |
|
151 | 151 | var attrs = (method === 'patch') ? options.attrs : model.toJSON(options); |
|
152 | 152 | if (this.key_value_lock !== null) { |
|
153 | 153 | var key = this.key_value_lock[0]; |
|
154 | 154 | var value = this.key_value_lock[1]; |
|
155 | 155 | if (attrs[key] === value) { |
|
156 | 156 | delete attrs[key]; |
|
157 | 157 | } |
|
158 | 158 | } |
|
159 | 159 | |
|
160 | 160 | // Only sync if there are attributes to send to the back-end. |
|
161 | 161 | attrs = this._pack_models(attrs); |
|
162 | 162 | if (_.size(attrs) > 0) { |
|
163 | 163 | |
|
164 | 164 | // If this message was sent via backbone itself, it will not |
|
165 | 165 | // have any callbacks. It's important that we create callbacks |
|
166 | 166 | // so we can listen for status messages, etc... |
|
167 | 167 | var callbacks = options.callbacks || this.callbacks(); |
|
168 | 168 | |
|
169 | 169 | // Check throttle. |
|
170 | 170 | if (this.pending_msgs >= (this.get('msg_throttle') || 3)) { |
|
171 | 171 | // The throttle has been exceeded, buffer the current msg so |
|
172 | 172 | // it can be sent once the kernel has finished processing |
|
173 | 173 | // some of the existing messages. |
|
174 | 174 | |
|
175 | 175 | // Combine updates if it is a 'patch' sync, otherwise replace updates |
|
176 | 176 | switch (method) { |
|
177 | 177 | case 'patch': |
|
178 | 178 | this.msg_buffer = $.extend(this.msg_buffer || {}, attrs); |
|
179 | 179 | break; |
|
180 | 180 | case 'update': |
|
181 | 181 | case 'create': |
|
182 | 182 | this.msg_buffer = attrs; |
|
183 | 183 | break; |
|
184 | 184 | default: |
|
185 | 185 | error(); |
|
186 | 186 | return false; |
|
187 | 187 | } |
|
188 | 188 | this.msg_buffer_callbacks = callbacks; |
|
189 | 189 | |
|
190 | 190 | } else { |
|
191 | 191 | // We haven't exceeded the throttle, send the message like |
|
192 | 192 | // normal. |
|
193 | 193 | var data = {method: 'backbone', sync_data: attrs}; |
|
194 | 194 | this.comm.send(data, callbacks); |
|
195 | 195 | this.pending_msgs++; |
|
196 | 196 | } |
|
197 | 197 | } |
|
198 | 198 | // Since the comm is a one-way communication, assume the message |
|
199 | 199 | // arrived. Don't call success since we don't have a model back from the server |
|
200 | 200 | // this means we miss out on the 'sync' event. |
|
201 | 201 | this._buffered_state_diff = {}; |
|
202 | 202 | }, |
|
203 | 203 | |
|
204 | 204 | save_changes: function(callbacks) { |
|
205 | 205 | // Push this model's state to the back-end |
|
206 | 206 | // |
|
207 | 207 | // This invokes a Backbone.Sync. |
|
208 | 208 | this.save(this._buffered_state_diff, {patch: true, callbacks: callbacks}); |
|
209 | 209 | }, |
|
210 | 210 | |
|
211 | 211 | _pack_models: function(value) { |
|
212 | 212 | // Replace models with model ids recursively. |
|
213 | 213 | var that = this; |
|
214 | 214 | var packed; |
|
215 | 215 | if (value instanceof Backbone.Model) { |
|
216 | 216 | return "IPY_MODEL_" + value.id; |
|
217 | 217 | |
|
218 | 218 | } else if ($.isArray(value)) { |
|
219 | 219 | packed = []; |
|
220 | 220 | _.each(value, function(sub_value, key) { |
|
221 | 221 | packed.push(that._pack_models(sub_value)); |
|
222 | 222 | }); |
|
223 | 223 | return packed; |
|
224 | 224 | |
|
225 | 225 | } else if (value instanceof Object) { |
|
226 | 226 | packed = {}; |
|
227 | 227 | _.each(value, function(sub_value, key) { |
|
228 | 228 | packed[key] = that._pack_models(sub_value); |
|
229 | 229 | }); |
|
230 | 230 | return packed; |
|
231 | 231 | |
|
232 | 232 | } else { |
|
233 | 233 | return value; |
|
234 | 234 | } |
|
235 | 235 | }, |
|
236 | 236 | |
|
237 | 237 | _unpack_models: function(value) { |
|
238 | 238 | // Replace model ids with models recursively. |
|
239 | 239 | var that = this; |
|
240 | 240 | var unpacked; |
|
241 | 241 | if ($.isArray(value)) { |
|
242 | 242 | unpacked = []; |
|
243 | 243 | _.each(value, function(sub_value, key) { |
|
244 | 244 | unpacked.push(that._unpack_models(sub_value)); |
|
245 | 245 | }); |
|
246 | 246 | return unpacked; |
|
247 | 247 | |
|
248 | 248 | } else if (value instanceof Object) { |
|
249 | 249 | unpacked = {}; |
|
250 | 250 | _.each(value, function(sub_value, key) { |
|
251 | 251 | unpacked[key] = that._unpack_models(sub_value); |
|
252 | 252 | }); |
|
253 | 253 | return unpacked; |
|
254 | 254 | |
|
255 | 255 | } else if (typeof value === 'string' && value.slice(0,10) === "IPY_MODEL_") { |
|
256 | 256 | var model = this.widget_manager.get_model(value.slice(10, value.length)); |
|
257 | 257 | if (model) { |
|
258 | 258 | return model; |
|
259 | 259 | } else { |
|
260 | 260 | return value; |
|
261 | 261 | } |
|
262 | 262 | } else { |
|
263 | 263 | return value; |
|
264 | 264 | } |
|
265 | 265 | }, |
|
266 | 266 | |
|
267 | 267 | }); |
|
268 | 268 | widgetmanager.WidgetManager.register_widget_model('WidgetModel', WidgetModel); |
|
269 | 269 | |
|
270 | 270 | |
|
271 | 271 | var WidgetView = Backbone.View.extend({ |
|
272 | 272 | initialize: function(parameters) { |
|
273 | 273 | // Public constructor. |
|
274 | 274 | this.model.on('change',this.update,this); |
|
275 | 275 | this.options = parameters.options; |
|
276 | 276 | this.child_model_views = {}; |
|
277 | 277 | this.child_views = {}; |
|
278 | 278 | this.model.views.push(this); |
|
279 | 279 | this.id = this.id || IPython.utils.uuid(); |
|
280 | 280 | this.on('displayed', function() { |
|
281 | 281 | this.is_displayed = true; |
|
282 | 282 | }, this); |
|
283 | 283 | }, |
|
284 | 284 | |
|
285 | 285 | update: function(){ |
|
286 | 286 | // Triggered on model change. |
|
287 | 287 | // |
|
288 | 288 | // Update view to be consistent with this.model |
|
289 | 289 | }, |
|
290 | 290 | |
|
291 | 291 | create_child_view: function(child_model, options) { |
|
292 | 292 | // Create and return a child view. |
|
293 | 293 | // |
|
294 | 294 | // -given a model and (optionally) a view name if the view name is |
|
295 | 295 | // not given, it defaults to the model's default view attribute. |
|
296 | 296 | |
|
297 | 297 | // TODO: this is hacky, and makes the view depend on this cell attribute and widget manager behavior |
|
298 | 298 | // it would be great to have the widget manager add the cell metadata |
|
299 | 299 | // to the subview without having to add it here. |
|
300 | 300 | options = $.extend({ parent: this }, options || {}); |
|
301 | 301 | var child_view = this.model.widget_manager.create_view(child_model, options, this); |
|
302 | 302 | |
|
303 | 303 | // Associate the view id with the model id. |
|
304 | 304 | if (this.child_model_views[child_model.id] === undefined) { |
|
305 | 305 | this.child_model_views[child_model.id] = []; |
|
306 | 306 | } |
|
307 | 307 | this.child_model_views[child_model.id].push(child_view.id); |
|
308 | 308 | |
|
309 | 309 | // Remember the view by id. |
|
310 | 310 | this.child_views[child_view.id] = child_view; |
|
311 | 311 | return child_view; |
|
312 | 312 | }, |
|
313 | 313 | |
|
314 | 314 | pop_child_view: function(child_model) { |
|
315 | 315 | // Delete a child view that was previously created using create_child_view. |
|
316 | 316 | var view_ids = this.child_model_views[child_model.id]; |
|
317 | 317 | if (view_ids !== undefined) { |
|
318 | 318 | |
|
319 | 319 | // Only delete the first view in the list. |
|
320 | 320 | var view_id = view_ids[0]; |
|
321 | 321 | var view = this.child_views[view_id]; |
|
322 | 322 | delete this.child_views[view_id]; |
|
323 | 323 | view_ids.splice(0,1); |
|
324 | 324 | child_model.views.pop(view); |
|
325 | 325 | |
|
326 | 326 | // Remove the view list specific to this model if it is empty. |
|
327 | 327 | if (view_ids.length === 0) { |
|
328 | 328 | delete this.child_model_views[child_model.id]; |
|
329 | 329 | } |
|
330 | 330 | return view; |
|
331 | 331 | } |
|
332 | 332 | return null; |
|
333 | 333 | }, |
|
334 | 334 | |
|
335 | 335 | do_diff: function(old_list, new_list, removed_callback, added_callback) { |
|
336 | 336 | // Difference a changed list and call remove and add callbacks for |
|
337 | 337 | // each removed and added item in the new list. |
|
338 | 338 | // |
|
339 | 339 | // Parameters |
|
340 | 340 | // ---------- |
|
341 | 341 | // old_list : array |
|
342 | 342 | // new_list : array |
|
343 | 343 | // removed_callback : Callback(item) |
|
344 | 344 | // Callback that is called for each item removed. |
|
345 | 345 | // added_callback : Callback(item) |
|
346 | 346 | // Callback that is called for each item added. |
|
347 | 347 | |
|
348 | 348 | // Walk the lists until an unequal entry is found. |
|
349 | 349 | var i; |
|
350 | 350 | for (i = 0; i < new_list.length; i++) { |
|
351 | 351 | if (i < old_list.length || new_list[i] !== old_list[i]) { |
|
352 | 352 | break; |
|
353 | 353 | } |
|
354 | 354 | } |
|
355 | 355 | |
|
356 | 356 | // Remove the non-matching items from the old list. |
|
357 | 357 | for (var j = i; j < old_list.length; j++) { |
|
358 | 358 | removed_callback(old_list[j]); |
|
359 | 359 | } |
|
360 | 360 | |
|
361 | 361 | // Add the rest of the new list items. |
|
362 | 362 | for (i; i < new_list.length; i++) { |
|
363 | 363 | added_callback(new_list[i]); |
|
364 | 364 | } |
|
365 | 365 | }, |
|
366 | 366 | |
|
367 | 367 | callbacks: function(){ |
|
368 | 368 | // Create msg callbacks for a comm msg. |
|
369 | 369 | return this.model.callbacks(this); |
|
370 | 370 | }, |
|
371 | 371 | |
|
372 | 372 | render: function(){ |
|
373 | 373 | // Render the view. |
|
374 | 374 | // |
|
375 | 375 | // By default, this is only called the first time the view is created |
|
376 | 376 | }, |
|
377 | 377 | |
|
378 | 378 | show: function(){ |
|
379 | 379 | // Show the widget-area |
|
380 | 380 | if (this.options && this.options.cell && |
|
381 | 381 | this.options.cell.widget_area !== undefined) { |
|
382 | 382 | this.options.cell.widget_area.show(); |
|
383 | 383 | } |
|
384 | 384 | }, |
|
385 | 385 | |
|
386 | 386 | send: function (content) { |
|
387 | 387 | // Send a custom msg associated with this view. |
|
388 | 388 | this.model.send(content, this.callbacks()); |
|
389 | 389 | }, |
|
390 | 390 | |
|
391 | 391 | touch: function () { |
|
392 | 392 | this.model.save_changes(this.callbacks()); |
|
393 | 393 | }, |
|
394 | 394 | |
|
395 | 395 | after_displayed: function (callback, context) { |
|
396 | 396 | // Calls the callback right away is the view is already displayed |
|
397 | 397 | // otherwise, register the callback to the 'displayed' event. |
|
398 | 398 | if (this.is_displayed) { |
|
399 | 399 | callback.apply(context); |
|
400 | 400 | } else { |
|
401 | 401 | this.on('displayed', callback, context); |
|
402 | 402 | } |
|
403 | 403 | }, |
|
404 | 404 | }); |
|
405 | 405 | |
|
406 | 406 | |
|
407 | 407 | var DOMWidgetView = WidgetView.extend({ |
|
408 | 408 | initialize: function (options) { |
|
409 | 409 | // Public constructor |
|
410 | ||
|
411 | // In the future we may want to make changes more granular | |
|
412 | // (e.g., trigger on visible:change). | |
|
413 | this.model.on('change', this.update, this); | |
|
414 | this.model.on('msg:custom', this.on_msg, this); | |
|
415 | 410 | DOMWidgetView.__super__.initialize.apply(this, arguments); |
|
416 | 411 | this.on('displayed', this.show, this); |
|
412 | ||
|
413 | this.model.on('msg:custom', this.on_msg, this); | |
|
414 | this.model.on('change:visible', this.update_visible, this); | |
|
415 | this.model.on('change:_css', this.update_css, this); | |
|
416 | ||
|
417 | this.update_visible(this.model, this.model.get("visible")); | |
|
418 | this.update_css(this.model, this.model.get("_css")); | |
|
417 | 419 | }, |
|
418 | 420 | |
|
419 | 421 | on_msg: function(msg) { |
|
420 | 422 | // Handle DOM specific msgs. |
|
421 | 423 | switch(msg.msg_type) { |
|
422 | 424 | case 'add_class': |
|
423 | 425 | this.add_class(msg.selector, msg.class_list); |
|
424 | 426 | break; |
|
425 | 427 | case 'remove_class': |
|
426 | 428 | this.remove_class(msg.selector, msg.class_list); |
|
427 | 429 | break; |
|
428 | 430 | } |
|
429 | 431 | }, |
|
430 | 432 | |
|
431 | 433 | add_class: function (selector, class_list) { |
|
432 | 434 | // Add a DOM class to an element. |
|
433 | 435 | this._get_selector_element(selector).addClass(class_list); |
|
434 | 436 | }, |
|
435 | 437 | |
|
436 | 438 | remove_class: function (selector, class_list) { |
|
437 | 439 | // Remove a DOM class from an element. |
|
438 | 440 | this._get_selector_element(selector).removeClass(class_list); |
|
439 | 441 | }, |
|
440 | 442 | |
|
441 |
update: function |
|
|
442 |
// Update |
|
|
443 | // | |
|
444 | // Called when the model is changed. The model may have been | |
|
445 | // changed by another view or by a state update from the back-end. | |
|
443 | update_visible: function(model, value) { | |
|
444 | // Update visibility | |
|
446 | 445 | // The very first update seems to happen before the element is |
|
447 | 446 | // finished rendering so we use setTimeout to give the element time |
|
448 | 447 | // to render |
|
449 | 448 | var e = this.$el; |
|
450 | var visible = this.model.get('visible'); | |
|
451 | setTimeout(function() {e.toggle(visible);},0); | |
|
449 | setTimeout(function() {e.toggle(value);},0); | |
|
450 | }, | |
|
452 | 451 | |
|
453 | var css = this.model.get('_css'); | |
|
452 | update_css: function (model, css) { | |
|
453 | // Update the contents of this view | |
|
454 | var e = this.$el; | |
|
454 | 455 | if (css === undefined) {return;} |
|
455 | 456 | for (var i = 0; i < css.length; i++) { |
|
456 | 457 | // Apply the css traits to all elements that match the selector. |
|
457 | 458 | var selector = css[i][0]; |
|
458 | 459 | var elements = this._get_selector_element(selector); |
|
459 | 460 | if (elements.length > 0) { |
|
460 | 461 | var trait_key = css[i][1]; |
|
461 | 462 | var trait_value = css[i][2]; |
|
462 | 463 | elements.css(trait_key ,trait_value); |
|
463 | 464 | } |
|
464 | 465 | } |
|
465 | 466 | }, |
|
466 | 467 | |
|
467 | 468 | _get_selector_element: function (selector) { |
|
468 | 469 | // Get the elements via the css selector. |
|
469 | 470 | |
|
470 | 471 | // If the selector is blank, apply the style to the $el_to_style |
|
471 | 472 | // element. If the $el_to_style element is not defined, use apply |
|
472 | 473 | // the style to the view's element. |
|
473 | 474 | var elements; |
|
474 | 475 | if (!selector) { |
|
475 | 476 | if (this.$el_to_style === undefined) { |
|
476 | 477 | elements = this.$el; |
|
477 | 478 | } else { |
|
478 | 479 | elements = this.$el_to_style; |
|
479 | 480 | } |
|
480 | 481 | } else { |
|
481 | 482 | elements = this.$el.find(selector); |
|
482 | 483 | } |
|
483 | 484 | return elements; |
|
484 | 485 | }, |
|
485 | 486 | }); |
|
486 | 487 | |
|
487 | 488 | var widget = { |
|
488 | 489 | 'WidgetModel': WidgetModel, |
|
489 | 490 | 'WidgetView': WidgetView, |
|
490 | 491 | 'DOMWidgetView': DOMWidgetView, |
|
491 | 492 | }; |
|
492 | 493 | |
|
493 | 494 | // For backwards compatability. |
|
494 | 495 | $.extend(IPython, widget); |
|
495 | 496 | |
|
496 | 497 | return widget; |
|
497 | 498 | }); |
@@ -1,292 +1,282 b'' | |||
|
1 | 1 | // Copyright (c) IPython Development Team. |
|
2 | 2 | // Distributed under the terms of the Modified BSD License. |
|
3 | 3 | |
|
4 | 4 | define([ |
|
5 | 5 | "widgets/js/widget", |
|
6 | 6 | "jqueryui", |
|
7 | 7 | "bootstrap", |
|
8 | 8 | ], function(widget, $){ |
|
9 | 9 | |
|
10 | 10 | var ContainerView = widget.DOMWidgetView.extend({ |
|
11 | 11 | render: function(){ |
|
12 | 12 | // Called when view is rendered. |
|
13 | 13 | this.$el.addClass('widget-container') |
|
14 | 14 | .addClass('vbox'); |
|
15 | 15 | this.update_children([], this.model.get('children')); |
|
16 |
this.model.on('change:children', function(model, value |
|
|
16 | this.model.on('change:children', function(model, value) { | |
|
17 | 17 | this.update_children(model.previous('children'), value); |
|
18 | 18 | }, this); |
|
19 | this.update(); | |
|
20 | 19 | }, |
|
21 | 20 | |
|
22 | 21 | update_children: function(old_list, new_list) { |
|
23 | 22 | // Called when the children list changes. |
|
24 | 23 | this.do_diff(old_list, |
|
25 | 24 | new_list, |
|
26 | 25 | $.proxy(this.remove_child_model, this), |
|
27 | 26 | $.proxy(this.add_child_model, this)); |
|
28 | 27 | }, |
|
29 | 28 | |
|
30 | 29 | remove_child_model: function(model) { |
|
31 | 30 | // Called when a model is removed from the children list. |
|
32 | 31 | this.pop_child_view(model).remove(); |
|
33 | 32 | }, |
|
34 | 33 | |
|
35 | 34 | add_child_model: function(model) { |
|
36 | 35 | // Called when a model is added to the children list. |
|
37 | 36 | var view = this.create_child_view(model); |
|
38 | 37 | this.$el.append(view.$el); |
|
39 | 38 | |
|
40 | 39 | // Trigger the displayed event once this view is displayed. |
|
41 | 40 | this.after_displayed(function() { |
|
42 | 41 | view.trigger('displayed'); |
|
43 | 42 | }); |
|
44 | 43 | }, |
|
45 | ||
|
46 | update: function(){ | |
|
47 | // Update the contents of this view | |
|
48 | // | |
|
49 | // Called when the model is changed. The model may have been | |
|
50 | // changed by another view or by a state update from the back-end. | |
|
51 | return ContainerView.__super__.update.apply(this); | |
|
52 | }, | |
|
53 | 44 | }); |
|
54 | 45 | |
|
55 | 46 | |
|
56 | 47 | var PopupView = widget.DOMWidgetView.extend({ |
|
57 | 48 | render: function(){ |
|
58 | 49 | // Called when view is rendered. |
|
59 | 50 | var that = this; |
|
60 | 51 | |
|
61 | 52 | this.$el.on("remove", function(){ |
|
62 | 53 | that.$backdrop.remove(); |
|
63 | 54 | }); |
|
64 | 55 | this.$backdrop = $('<div />') |
|
65 | 56 | .appendTo($('#notebook-container')) |
|
66 | 57 | .addClass('modal-dialog') |
|
67 | 58 | .css('position', 'absolute') |
|
68 | 59 | .css('left', '0px') |
|
69 | 60 | .css('top', '0px'); |
|
70 | 61 | this.$window = $('<div />') |
|
71 | 62 | .appendTo(this.$backdrop) |
|
72 | 63 | .addClass('modal-content widget-modal') |
|
73 | 64 | .mousedown(function(){ |
|
74 | 65 | that.bring_to_front(); |
|
75 | 66 | }); |
|
76 | 67 | |
|
77 | 68 | // Set the elements array since the this.$window element is not child |
|
78 | 69 | // of this.$el and the parent widget manager or other widgets may |
|
79 | 70 | // need to know about all of the top-level widgets. The IPython |
|
80 | 71 | // widget manager uses this to register the elements with the |
|
81 | 72 | // keyboard manager. |
|
82 | 73 | this.additional_elements = [this.$window]; |
|
83 | 74 | |
|
84 | 75 | this.$title_bar = $('<div />') |
|
85 | 76 | .addClass('popover-title') |
|
86 | 77 | .appendTo(this.$window) |
|
87 | 78 | .mousedown(function(){ |
|
88 | 79 | that.bring_to_front(); |
|
89 | 80 | }); |
|
90 | 81 | this.$close = $('<button />') |
|
91 | 82 | .addClass('close icon-remove') |
|
92 | 83 | .css('margin-left', '5px') |
|
93 | 84 | .appendTo(this.$title_bar) |
|
94 | 85 | .click(function(){ |
|
95 | 86 | that.hide(); |
|
96 | 87 | event.stopPropagation(); |
|
97 | 88 | }); |
|
98 | 89 | this.$minimize = $('<button />') |
|
99 | 90 | .addClass('close icon-arrow-down') |
|
100 | 91 | .appendTo(this.$title_bar) |
|
101 | 92 | .click(function(){ |
|
102 | 93 | that.popped_out = !that.popped_out; |
|
103 | 94 | if (!that.popped_out) { |
|
104 | 95 | that.$minimize |
|
105 | 96 | .removeClass('icon-arrow-down') |
|
106 | 97 | .addClass('icon-arrow-up'); |
|
107 | 98 | |
|
108 | 99 | that.$window |
|
109 | 100 | .draggable('destroy') |
|
110 | 101 | .resizable('destroy') |
|
111 | 102 | .removeClass('widget-modal modal-content') |
|
112 | 103 | .addClass('docked-widget-modal') |
|
113 | 104 | .detach() |
|
114 | 105 | .insertBefore(that.$show_button); |
|
115 | 106 | that.$show_button.hide(); |
|
116 | 107 | that.$close.hide(); |
|
117 | 108 | } else { |
|
118 | 109 | that.$minimize |
|
119 | 110 | .addClass('icon-arrow-down') |
|
120 | 111 | .removeClass('icon-arrow-up'); |
|
121 | 112 | |
|
122 | 113 | that.$window |
|
123 | 114 | .removeClass('docked-widget-modal') |
|
124 | 115 | .addClass('widget-modal modal-content') |
|
125 | 116 | .detach() |
|
126 | 117 | .appendTo(that.$backdrop) |
|
127 | 118 | .draggable({handle: '.popover-title', snap: '#notebook, .modal', snapMode: 'both'}) |
|
128 | 119 | .resizable() |
|
129 | 120 | .children('.ui-resizable-handle').show(); |
|
130 | 121 | that.show(); |
|
131 | 122 | that.$show_button.show(); |
|
132 | 123 | that.$close.show(); |
|
133 | 124 | } |
|
134 | 125 | event.stopPropagation(); |
|
135 | 126 | }); |
|
136 | 127 | this.$title = $('<div />') |
|
137 | 128 | .addClass('widget-modal-title') |
|
138 | 129 | .html(" ") |
|
139 | 130 | .appendTo(this.$title_bar); |
|
140 | 131 | this.$body = $('<div />') |
|
141 | 132 | .addClass('modal-body') |
|
142 | 133 | .addClass('widget-modal-body') |
|
143 | 134 | .addClass('widget-container') |
|
144 | 135 | .addClass('vbox') |
|
145 | 136 | .appendTo(this.$window); |
|
146 | 137 | |
|
147 | 138 | this.$show_button = $('<button />') |
|
148 | 139 | .html(" ") |
|
149 | 140 | .addClass('btn btn-info widget-modal-show') |
|
150 | 141 | .appendTo(this.$el) |
|
151 | 142 | .click(function(){ |
|
152 | 143 | that.show(); |
|
153 | 144 | }); |
|
154 | 145 | |
|
155 | 146 | this.$window.draggable({handle: '.popover-title', snap: '#notebook, .modal', snapMode: 'both'}); |
|
156 | 147 | this.$window.resizable(); |
|
157 | 148 | this.$window.on('resize', function(){ |
|
158 | 149 | that.$body.outerHeight(that.$window.innerHeight() - that.$title_bar.outerHeight()); |
|
159 | 150 | }); |
|
160 | 151 | |
|
161 | 152 | this.$el_to_style = this.$body; |
|
162 | 153 | this._shown_once = false; |
|
163 | 154 | this.popped_out = true; |
|
164 | 155 | |
|
165 | 156 | this.update_children([], this.model.get('children')); |
|
166 |
this.model.on('change:children', function(model, value |
|
|
157 | this.model.on('change:children', function(model, value) { | |
|
167 | 158 | this.update_children(model.previous('children'), value); |
|
168 | 159 | }, this); |
|
169 | this.update(); | |
|
170 | 160 | }, |
|
171 | 161 | |
|
172 | 162 | hide: function() { |
|
173 | 163 | // Called when the modal hide button is clicked. |
|
174 | 164 | this.$window.hide(); |
|
175 | 165 | this.$show_button.removeClass('btn-info'); |
|
176 | 166 | }, |
|
177 | 167 | |
|
178 | 168 | show: function() { |
|
179 | 169 | // Called when the modal show button is clicked. |
|
180 | 170 | this.$show_button.addClass('btn-info'); |
|
181 | 171 | this.$window.show(); |
|
182 | 172 | if (this.popped_out) { |
|
183 | 173 | this.$window.css("positon", "absolute"); |
|
184 | 174 | this.$window.css("top", "0px"); |
|
185 | 175 | this.$window.css("left", Math.max(0, (($('body').outerWidth() - this.$window.outerWidth()) / 2) + |
|
186 | 176 | $(window).scrollLeft()) + "px"); |
|
187 | 177 | this.bring_to_front(); |
|
188 | 178 | } |
|
189 | 179 | }, |
|
190 | 180 | |
|
191 | 181 | bring_to_front: function() { |
|
192 | 182 | // Make the modal top-most, z-ordered about the other modals. |
|
193 | 183 | var $widget_modals = $(".widget-modal"); |
|
194 | 184 | var max_zindex = 0; |
|
195 | 185 | $widget_modals.each(function (index, el){ |
|
196 | 186 | var zindex = parseInt($(el).css('z-index')); |
|
197 | 187 | if (!isNaN(zindex)) { |
|
198 | 188 | max_zindex = Math.max(max_zindex, zindex); |
|
199 | 189 | } |
|
200 | 190 | }); |
|
201 | 191 | |
|
202 | 192 | // Start z-index of widget modals at 2000 |
|
203 | 193 | max_zindex = Math.max(max_zindex, 2000); |
|
204 | 194 | |
|
205 | 195 | $widget_modals.each(function (index, el){ |
|
206 | 196 | $el = $(el); |
|
207 | 197 | if (max_zindex == parseInt($el.css('z-index'))) { |
|
208 | 198 | $el.css('z-index', max_zindex - 1); |
|
209 | 199 | } |
|
210 | 200 | }); |
|
211 | 201 | this.$window.css('z-index', max_zindex); |
|
212 | 202 | }, |
|
213 | 203 | |
|
214 | 204 | update_children: function(old_list, new_list) { |
|
215 | 205 | // Called when the children list is modified. |
|
216 | 206 | this.do_diff(old_list, |
|
217 | 207 | new_list, |
|
218 | 208 | $.proxy(this.remove_child_model, this), |
|
219 | 209 | $.proxy(this.add_child_model, this)); |
|
220 | 210 | }, |
|
221 | 211 | |
|
222 | 212 | remove_child_model: function(model) { |
|
223 | 213 | // Called when a child is removed from children list. |
|
224 | 214 | this.pop_child_view(model).remove(); |
|
225 | 215 | }, |
|
226 | 216 | |
|
227 | 217 | add_child_model: function(model) { |
|
228 | 218 | // Called when a child is added to children list. |
|
229 | 219 | var view = this.create_child_view(model); |
|
230 | 220 | this.$body.append(view.$el); |
|
231 | 221 | |
|
232 | 222 | // Trigger the displayed event once this view is displayed. |
|
233 | 223 | this.after_displayed(function() { |
|
234 | 224 | view.trigger('displayed'); |
|
235 | 225 | }); |
|
236 | 226 | }, |
|
237 | 227 | |
|
238 | 228 | update: function(){ |
|
239 | 229 | // Update the contents of this view |
|
240 | 230 | // |
|
241 | 231 | // Called when the model is changed. The model may have been |
|
242 | 232 | // changed by another view or by a state update from the back-end. |
|
243 | 233 | var description = this.model.get('description'); |
|
244 | 234 | if (description.trim().length === 0) { |
|
245 | 235 | this.$title.html(" "); // Preserve title height |
|
246 | 236 | } else { |
|
247 | 237 | this.$title.text(description); |
|
248 | 238 | MathJax.Hub.Queue(["Typeset",MathJax.Hub,this.$title.get(0)]); |
|
249 | 239 | } |
|
250 | 240 | |
|
251 | 241 | var button_text = this.model.get('button_text'); |
|
252 | 242 | if (button_text.trim().length === 0) { |
|
253 | 243 | this.$show_button.html(" "); // Preserve button height |
|
254 | 244 | } else { |
|
255 | 245 | this.$show_button.text(button_text); |
|
256 | 246 | } |
|
257 | 247 | |
|
258 | 248 | if (!this._shown_once) { |
|
259 | 249 | this._shown_once = true; |
|
260 | 250 | this.show(); |
|
261 | 251 | } |
|
262 | 252 | |
|
263 | 253 | return PopupView.__super__.update.apply(this); |
|
264 | 254 | }, |
|
265 | 255 | |
|
266 | 256 | _get_selector_element: function(selector) { |
|
267 | 257 | // Get an element view a 'special' jquery selector. (see widget.js) |
|
268 | 258 | // |
|
269 | 259 | // Since the modal actually isn't within the $el in the DOM, we need to extend |
|
270 | 260 | // the selector logic to allow the user to set css on the modal if need be. |
|
271 | 261 | // The convention used is: |
|
272 | 262 | // "modal" - select the modal div |
|
273 | 263 | // "modal [selector]" - select element(s) within the modal div. |
|
274 | 264 | // "[selector]" - select elements within $el |
|
275 | 265 | // "" - select the $el_to_style |
|
276 | 266 | if (selector.substring(0, 5) == 'modal') { |
|
277 | 267 | if (selector == 'modal') { |
|
278 | 268 | return this.$window; |
|
279 | 269 | } else { |
|
280 | 270 | return this.$window.find(selector.substring(6)); |
|
281 | 271 | } |
|
282 | 272 | } else { |
|
283 | 273 | return PopupView.__super__._get_selector_element.apply(this, [selector]); |
|
284 | 274 | } |
|
285 | 275 | }, |
|
286 | 276 | }); |
|
287 | 277 | |
|
288 | 278 | return { |
|
289 | 279 | 'ContainerView': ContainerView, |
|
290 | 280 | 'PopupView': PopupView, |
|
291 | 281 | }; |
|
292 | 282 | }); |
General Comments 0
You need to be logged in to leave comments.
Login now