##// END OF EJS Templates
Initial crack at using specific traits for styling.
Jonathan Frederic -
Show More
@@ -1,477 +1,504
1 // Copyright (c) IPython Development Team.
1 // Copyright (c) IPython Development Team.
2 // Distributed under the terms of the Modified BSD License.
2 // Distributed under the terms of the Modified BSD License.
3
3
4 define(["widgets/js/manager",
4 define(["widgets/js/manager",
5 "underscore",
5 "underscore",
6 "backbone",
6 "backbone",
7 "jquery",
7 "jquery",
8 "base/js/namespace",
8 "base/js/namespace",
9 ], function(widgetmanager, _, Backbone, $, IPython){
9 ], function(widgetmanager, _, Backbone, $, IPython){
10
10
11 var WidgetModel = Backbone.Model.extend({
11 var WidgetModel = Backbone.Model.extend({
12 constructor: function (widget_manager, model_id, comm) {
12 constructor: function (widget_manager, model_id, comm) {
13 // Constructor
13 // Constructor
14 //
14 //
15 // Creates a WidgetModel instance.
15 // Creates a WidgetModel instance.
16 //
16 //
17 // Parameters
17 // Parameters
18 // ----------
18 // ----------
19 // widget_manager : WidgetManager instance
19 // widget_manager : WidgetManager instance
20 // model_id : string
20 // model_id : string
21 // An ID unique to this model.
21 // An ID unique to this model.
22 // comm : Comm instance (optional)
22 // comm : Comm instance (optional)
23 this.widget_manager = widget_manager;
23 this.widget_manager = widget_manager;
24 this._buffered_state_diff = {};
24 this._buffered_state_diff = {};
25 this.pending_msgs = 0;
25 this.pending_msgs = 0;
26 this.msg_buffer = null;
26 this.msg_buffer = null;
27 this.key_value_lock = null;
27 this.key_value_lock = null;
28 this.id = model_id;
28 this.id = model_id;
29 this.views = [];
29 this.views = [];
30
30
31 if (comm !== undefined) {
31 if (comm !== undefined) {
32 // Remember comm associated with the model.
32 // Remember comm associated with the model.
33 this.comm = comm;
33 this.comm = comm;
34 comm.model = this;
34 comm.model = this;
35
35
36 // Hook comm messages up to model.
36 // Hook comm messages up to model.
37 comm.on_close($.proxy(this._handle_comm_closed, this));
37 comm.on_close($.proxy(this._handle_comm_closed, this));
38 comm.on_msg($.proxy(this._handle_comm_msg, this));
38 comm.on_msg($.proxy(this._handle_comm_msg, this));
39 }
39 }
40 return Backbone.Model.apply(this);
40 return Backbone.Model.apply(this);
41 },
41 },
42
42
43 send: function (content, callbacks) {
43 send: function (content, callbacks) {
44 // Send a custom msg over the comm.
44 // Send a custom msg over the comm.
45 if (this.comm !== undefined) {
45 if (this.comm !== undefined) {
46 var data = {method: 'custom', content: content};
46 var data = {method: 'custom', content: content};
47 this.comm.send(data, callbacks);
47 this.comm.send(data, callbacks);
48 this.pending_msgs++;
48 this.pending_msgs++;
49 }
49 }
50 },
50 },
51
51
52 _handle_comm_closed: function (msg) {
52 _handle_comm_closed: function (msg) {
53 // Handle when a widget is closed.
53 // Handle when a widget is closed.
54 this.trigger('comm:close');
54 this.trigger('comm:close');
55 delete this.comm.model; // Delete ref so GC will collect widget model.
55 delete this.comm.model; // Delete ref so GC will collect widget model.
56 delete this.comm;
56 delete this.comm;
57 delete this.model_id; // Delete id from model so widget manager cleans up.
57 delete this.model_id; // Delete id from model so widget manager cleans up.
58 _.each(this.views, function(view, i) {
58 _.each(this.views, function(view, i) {
59 view.remove();
59 view.remove();
60 });
60 });
61 },
61 },
62
62
63 _handle_comm_msg: function (msg) {
63 _handle_comm_msg: function (msg) {
64 // Handle incoming comm msg.
64 // Handle incoming comm msg.
65 var method = msg.content.data.method;
65 var method = msg.content.data.method;
66 switch (method) {
66 switch (method) {
67 case 'update':
67 case 'update':
68 this.apply_update(msg.content.data.state);
68 this.apply_update(msg.content.data.state);
69 break;
69 break;
70 case 'custom':
70 case 'custom':
71 this.trigger('msg:custom', msg.content.data.content);
71 this.trigger('msg:custom', msg.content.data.content);
72 break;
72 break;
73 case 'display':
73 case 'display':
74 this.widget_manager.display_view(msg, this);
74 this.widget_manager.display_view(msg, this);
75 break;
75 break;
76 }
76 }
77 },
77 },
78
78
79 apply_update: function (state) {
79 apply_update: function (state) {
80 // Handle when a widget is updated via the python side.
80 // Handle when a widget is updated via the python side.
81 var that = this;
81 var that = this;
82 _.each(state, function(value, key) {
82 _.each(state, function(value, key) {
83 that.key_value_lock = [key, value];
83 that.key_value_lock = [key, value];
84 try {
84 try {
85 WidgetModel.__super__.set.apply(that, [key, that._unpack_models(value)]);
85 WidgetModel.__super__.set.apply(that, [key, that._unpack_models(value)]);
86 } finally {
86 } finally {
87 that.key_value_lock = null;
87 that.key_value_lock = null;
88 }
88 }
89 });
89 });
90 },
90 },
91
91
92 _handle_status: function (msg, callbacks) {
92 _handle_status: function (msg, callbacks) {
93 // Handle status msgs.
93 // Handle status msgs.
94
94
95 // execution_state : ('busy', 'idle', 'starting')
95 // execution_state : ('busy', 'idle', 'starting')
96 if (this.comm !== undefined) {
96 if (this.comm !== undefined) {
97 if (msg.content.execution_state ==='idle') {
97 if (msg.content.execution_state ==='idle') {
98 // Send buffer if this message caused another message to be
98 // Send buffer if this message caused another message to be
99 // throttled.
99 // throttled.
100 if (this.msg_buffer !== null &&
100 if (this.msg_buffer !== null &&
101 (this.get('msg_throttle') || 3) === this.pending_msgs) {
101 (this.get('msg_throttle') || 3) === this.pending_msgs) {
102 var data = {method: 'backbone', sync_method: 'update', sync_data: this.msg_buffer};
102 var data = {method: 'backbone', sync_method: 'update', sync_data: this.msg_buffer};
103 this.comm.send(data, callbacks);
103 this.comm.send(data, callbacks);
104 this.msg_buffer = null;
104 this.msg_buffer = null;
105 } else {
105 } else {
106 --this.pending_msgs;
106 --this.pending_msgs;
107 }
107 }
108 }
108 }
109 }
109 }
110 },
110 },
111
111
112 callbacks: function(view) {
112 callbacks: function(view) {
113 // Create msg callbacks for a comm msg.
113 // Create msg callbacks for a comm msg.
114 var callbacks = this.widget_manager.callbacks(view);
114 var callbacks = this.widget_manager.callbacks(view);
115
115
116 if (callbacks.iopub === undefined) {
116 if (callbacks.iopub === undefined) {
117 callbacks.iopub = {};
117 callbacks.iopub = {};
118 }
118 }
119
119
120 var that = this;
120 var that = this;
121 callbacks.iopub.status = function (msg) {
121 callbacks.iopub.status = function (msg) {
122 that._handle_status(msg, callbacks);
122 that._handle_status(msg, callbacks);
123 };
123 };
124 return callbacks;
124 return callbacks;
125 },
125 },
126
126
127 set: function(key, val, options) {
127 set: function(key, val, options) {
128 // Set a value.
128 // Set a value.
129 var return_value = WidgetModel.__super__.set.apply(this, arguments);
129 var return_value = WidgetModel.__super__.set.apply(this, arguments);
130
130
131 // Backbone only remembers the diff of the most recent set()
131 // Backbone only remembers the diff of the most recent set()
132 // operation. Calling set multiple times in a row results in a
132 // operation. Calling set multiple times in a row results in a
133 // loss of diff information. Here we keep our own running diff.
133 // loss of diff information. Here we keep our own running diff.
134 this._buffered_state_diff = $.extend(this._buffered_state_diff, this.changedAttributes() || {});
134 this._buffered_state_diff = $.extend(this._buffered_state_diff, this.changedAttributes() || {});
135 return return_value;
135 return return_value;
136 },
136 },
137
137
138 sync: function (method, model, options) {
138 sync: function (method, model, options) {
139 // Handle sync to the back-end. Called when a model.save() is called.
139 // Handle sync to the back-end. Called when a model.save() is called.
140
140
141 // Make sure a comm exists.
141 // Make sure a comm exists.
142 var error = options.error || function() {
142 var error = options.error || function() {
143 console.error('Backbone sync error:', arguments);
143 console.error('Backbone sync error:', arguments);
144 };
144 };
145 if (this.comm === undefined) {
145 if (this.comm === undefined) {
146 error();
146 error();
147 return false;
147 return false;
148 }
148 }
149
149
150 // Delete any key value pairs that the back-end already knows about.
150 // Delete any key value pairs that the back-end already knows about.
151 var attrs = (method === 'patch') ? options.attrs : model.toJSON(options);
151 var attrs = (method === 'patch') ? options.attrs : model.toJSON(options);
152 if (this.key_value_lock !== null) {
152 if (this.key_value_lock !== null) {
153 var key = this.key_value_lock[0];
153 var key = this.key_value_lock[0];
154 var value = this.key_value_lock[1];
154 var value = this.key_value_lock[1];
155 if (attrs[key] === value) {
155 if (attrs[key] === value) {
156 delete attrs[key];
156 delete attrs[key];
157 }
157 }
158 }
158 }
159
159
160 // Only sync if there are attributes to send to the back-end.
160 // Only sync if there are attributes to send to the back-end.
161 attrs = this._pack_models(attrs);
161 attrs = this._pack_models(attrs);
162 if (_.size(attrs) > 0) {
162 if (_.size(attrs) > 0) {
163
163
164 // If this message was sent via backbone itself, it will not
164 // If this message was sent via backbone itself, it will not
165 // have any callbacks. It's important that we create callbacks
165 // have any callbacks. It's important that we create callbacks
166 // so we can listen for status messages, etc...
166 // so we can listen for status messages, etc...
167 var callbacks = options.callbacks || this.callbacks();
167 var callbacks = options.callbacks || this.callbacks();
168
168
169 // Check throttle.
169 // Check throttle.
170 if (this.pending_msgs >= (this.get('msg_throttle') || 3)) {
170 if (this.pending_msgs >= (this.get('msg_throttle') || 3)) {
171 // The throttle has been exceeded, buffer the current msg so
171 // The throttle has been exceeded, buffer the current msg so
172 // it can be sent once the kernel has finished processing
172 // it can be sent once the kernel has finished processing
173 // some of the existing messages.
173 // some of the existing messages.
174
174
175 // Combine updates if it is a 'patch' sync, otherwise replace updates
175 // Combine updates if it is a 'patch' sync, otherwise replace updates
176 switch (method) {
176 switch (method) {
177 case 'patch':
177 case 'patch':
178 this.msg_buffer = $.extend(this.msg_buffer || {}, attrs);
178 this.msg_buffer = $.extend(this.msg_buffer || {}, attrs);
179 break;
179 break;
180 case 'update':
180 case 'update':
181 case 'create':
181 case 'create':
182 this.msg_buffer = attrs;
182 this.msg_buffer = attrs;
183 break;
183 break;
184 default:
184 default:
185 error();
185 error();
186 return false;
186 return false;
187 }
187 }
188 this.msg_buffer_callbacks = callbacks;
188 this.msg_buffer_callbacks = callbacks;
189
189
190 } else {
190 } else {
191 // We haven't exceeded the throttle, send the message like
191 // We haven't exceeded the throttle, send the message like
192 // normal.
192 // normal.
193 var data = {method: 'backbone', sync_data: attrs};
193 var data = {method: 'backbone', sync_data: attrs};
194 this.comm.send(data, callbacks);
194 this.comm.send(data, callbacks);
195 this.pending_msgs++;
195 this.pending_msgs++;
196 }
196 }
197 }
197 }
198 // Since the comm is a one-way communication, assume the message
198 // Since the comm is a one-way communication, assume the message
199 // arrived. Don't call success since we don't have a model back from the server
199 // arrived. Don't call success since we don't have a model back from the server
200 // this means we miss out on the 'sync' event.
200 // this means we miss out on the 'sync' event.
201 this._buffered_state_diff = {};
201 this._buffered_state_diff = {};
202 },
202 },
203
203
204 save_changes: function(callbacks) {
204 save_changes: function(callbacks) {
205 // Push this model's state to the back-end
205 // Push this model's state to the back-end
206 //
206 //
207 // This invokes a Backbone.Sync.
207 // This invokes a Backbone.Sync.
208 this.save(this._buffered_state_diff, {patch: true, callbacks: callbacks});
208 this.save(this._buffered_state_diff, {patch: true, callbacks: callbacks});
209 },
209 },
210
210
211 _pack_models: function(value) {
211 _pack_models: function(value) {
212 // Replace models with model ids recursively.
212 // Replace models with model ids recursively.
213 var that = this;
213 var that = this;
214 var packed;
214 var packed;
215 if (value instanceof Backbone.Model) {
215 if (value instanceof Backbone.Model) {
216 return "IPY_MODEL_" + value.id;
216 return "IPY_MODEL_" + value.id;
217
217
218 } else if ($.isArray(value)) {
218 } else if ($.isArray(value)) {
219 packed = [];
219 packed = [];
220 _.each(value, function(sub_value, key) {
220 _.each(value, function(sub_value, key) {
221 packed.push(that._pack_models(sub_value));
221 packed.push(that._pack_models(sub_value));
222 });
222 });
223 return packed;
223 return packed;
224
224
225 } else if (value instanceof Object) {
225 } else if (value instanceof Object) {
226 packed = {};
226 packed = {};
227 _.each(value, function(sub_value, key) {
227 _.each(value, function(sub_value, key) {
228 packed[key] = that._pack_models(sub_value);
228 packed[key] = that._pack_models(sub_value);
229 });
229 });
230 return packed;
230 return packed;
231
231
232 } else {
232 } else {
233 return value;
233 return value;
234 }
234 }
235 },
235 },
236
236
237 _unpack_models: function(value) {
237 _unpack_models: function(value) {
238 // Replace model ids with models recursively.
238 // Replace model ids with models recursively.
239 var that = this;
239 var that = this;
240 var unpacked;
240 var unpacked;
241 if ($.isArray(value)) {
241 if ($.isArray(value)) {
242 unpacked = [];
242 unpacked = [];
243 _.each(value, function(sub_value, key) {
243 _.each(value, function(sub_value, key) {
244 unpacked.push(that._unpack_models(sub_value));
244 unpacked.push(that._unpack_models(sub_value));
245 });
245 });
246 return unpacked;
246 return unpacked;
247
247
248 } else if (value instanceof Object) {
248 } else if (value instanceof Object) {
249 unpacked = {};
249 unpacked = {};
250 _.each(value, function(sub_value, key) {
250 _.each(value, function(sub_value, key) {
251 unpacked[key] = that._unpack_models(sub_value);
251 unpacked[key] = that._unpack_models(sub_value);
252 });
252 });
253 return unpacked;
253 return unpacked;
254
254
255 } else if (typeof value === 'string' && value.slice(0,10) === "IPY_MODEL_") {
255 } else if (typeof value === 'string' && value.slice(0,10) === "IPY_MODEL_") {
256 var model = this.widget_manager.get_model(value.slice(10, value.length));
256 var model = this.widget_manager.get_model(value.slice(10, value.length));
257 if (model) {
257 if (model) {
258 return model;
258 return model;
259 } else {
259 } else {
260 return value;
260 return value;
261 }
261 }
262 } else {
262 } else {
263 return value;
263 return value;
264 }
264 }
265 },
265 },
266
266
267 });
267 });
268 widgetmanager.WidgetManager.register_widget_model('WidgetModel', WidgetModel);
268 widgetmanager.WidgetManager.register_widget_model('WidgetModel', WidgetModel);
269
269
270
270
271 var WidgetView = Backbone.View.extend({
271 var WidgetView = Backbone.View.extend({
272 initialize: function(parameters) {
272 initialize: function(parameters) {
273 // Public constructor.
273 // Public constructor.
274 this.model.on('change',this.update,this);
274 this.model.on('change',this.update,this);
275 this.options = parameters.options;
275 this.options = parameters.options;
276 this.child_model_views = {};
276 this.child_model_views = {};
277 this.child_views = {};
277 this.child_views = {};
278 this.model.views.push(this);
278 this.model.views.push(this);
279 this.id = this.id || IPython.utils.uuid();
279 this.id = this.id || IPython.utils.uuid();
280 this.on('displayed', function() {
280 this.on('displayed', function() {
281 this.is_displayed = true;
281 this.is_displayed = true;
282 }, this);
282 }, this);
283 },
283 },
284
284
285 update: function(){
285 update: function(){
286 // Triggered on model change.
286 // Triggered on model change.
287 //
287 //
288 // Update view to be consistent with this.model
288 // Update view to be consistent with this.model
289 },
289 },
290
290
291 create_child_view: function(child_model, options) {
291 create_child_view: function(child_model, options) {
292 // Create and return a child view.
292 // Create and return a child view.
293 //
293 //
294 // -given a model and (optionally) a view name if the view name is
294 // -given a model and (optionally) a view name if the view name is
295 // not given, it defaults to the model's default view attribute.
295 // not given, it defaults to the model's default view attribute.
296
296
297 // TODO: this is hacky, and makes the view depend on this cell attribute and widget manager behavior
297 // TODO: this is hacky, and makes the view depend on this cell attribute and widget manager behavior
298 // it would be great to have the widget manager add the cell metadata
298 // it would be great to have the widget manager add the cell metadata
299 // to the subview without having to add it here.
299 // to the subview without having to add it here.
300 options = $.extend({ parent: this }, options || {});
300 options = $.extend({ parent: this }, options || {});
301 var child_view = this.model.widget_manager.create_view(child_model, options, this);
301 var child_view = this.model.widget_manager.create_view(child_model, options, this);
302
302
303 // Associate the view id with the model id.
303 // Associate the view id with the model id.
304 if (this.child_model_views[child_model.id] === undefined) {
304 if (this.child_model_views[child_model.id] === undefined) {
305 this.child_model_views[child_model.id] = [];
305 this.child_model_views[child_model.id] = [];
306 }
306 }
307 this.child_model_views[child_model.id].push(child_view.id);
307 this.child_model_views[child_model.id].push(child_view.id);
308
308
309 // Remember the view by id.
309 // Remember the view by id.
310 this.child_views[child_view.id] = child_view;
310 this.child_views[child_view.id] = child_view;
311 return child_view;
311 return child_view;
312 },
312 },
313
313
314 pop_child_view: function(child_model) {
314 pop_child_view: function(child_model) {
315 // Delete a child view that was previously created using create_child_view.
315 // Delete a child view that was previously created using create_child_view.
316 var view_ids = this.child_model_views[child_model.id];
316 var view_ids = this.child_model_views[child_model.id];
317 if (view_ids !== undefined) {
317 if (view_ids !== undefined) {
318
318
319 // Only delete the first view in the list.
319 // Only delete the first view in the list.
320 var view_id = view_ids[0];
320 var view_id = view_ids[0];
321 var view = this.child_views[view_id];
321 var view = this.child_views[view_id];
322 delete this.child_views[view_id];
322 delete this.child_views[view_id];
323 view_ids.splice(0,1);
323 view_ids.splice(0,1);
324 child_model.views.pop(view);
324 child_model.views.pop(view);
325
325
326 // Remove the view list specific to this model if it is empty.
326 // Remove the view list specific to this model if it is empty.
327 if (view_ids.length === 0) {
327 if (view_ids.length === 0) {
328 delete this.child_model_views[child_model.id];
328 delete this.child_model_views[child_model.id];
329 }
329 }
330 return view;
330 return view;
331 }
331 }
332 return null;
332 return null;
333 },
333 },
334
334
335 do_diff: function(old_list, new_list, removed_callback, added_callback) {
335 do_diff: function(old_list, new_list, removed_callback, added_callback) {
336 // Difference a changed list and call remove and add callbacks for
336 // Difference a changed list and call remove and add callbacks for
337 // each removed and added item in the new list.
337 // each removed and added item in the new list.
338 //
338 //
339 // Parameters
339 // Parameters
340 // ----------
340 // ----------
341 // old_list : array
341 // old_list : array
342 // new_list : array
342 // new_list : array
343 // removed_callback : Callback(item)
343 // removed_callback : Callback(item)
344 // Callback that is called for each item removed.
344 // Callback that is called for each item removed.
345 // added_callback : Callback(item)
345 // added_callback : Callback(item)
346 // Callback that is called for each item added.
346 // Callback that is called for each item added.
347
347
348 // Walk the lists until an unequal entry is found.
348 // Walk the lists until an unequal entry is found.
349 var i;
349 var i;
350 for (i = 0; i < new_list.length; i++) {
350 for (i = 0; i < new_list.length; i++) {
351 if (i >= old_list.length || new_list[i] !== old_list[i]) {
351 if (i >= old_list.length || new_list[i] !== old_list[i]) {
352 break;
352 break;
353 }
353 }
354 }
354 }
355
355
356 // Remove the non-matching items from the old list.
356 // Remove the non-matching items from the old list.
357 for (var j = i; j < old_list.length; j++) {
357 for (var j = i; j < old_list.length; j++) {
358 removed_callback(old_list[j]);
358 removed_callback(old_list[j]);
359 }
359 }
360
360
361 // Add the rest of the new list items.
361 // Add the rest of the new list items.
362 for (; i < new_list.length; i++) {
362 for (; i < new_list.length; i++) {
363 added_callback(new_list[i]);
363 added_callback(new_list[i]);
364 }
364 }
365 },
365 },
366
366
367 callbacks: function(){
367 callbacks: function(){
368 // Create msg callbacks for a comm msg.
368 // Create msg callbacks for a comm msg.
369 return this.model.callbacks(this);
369 return this.model.callbacks(this);
370 },
370 },
371
371
372 render: function(){
372 render: function(){
373 // Render the view.
373 // Render the view.
374 //
374 //
375 // By default, this is only called the first time the view is created
375 // By default, this is only called the first time the view is created
376 },
376 },
377
377
378 show: function(){
378 show: function(){
379 // Show the widget-area
379 // Show the widget-area
380 if (this.options && this.options.cell &&
380 if (this.options && this.options.cell &&
381 this.options.cell.widget_area !== undefined) {
381 this.options.cell.widget_area !== undefined) {
382 this.options.cell.widget_area.show();
382 this.options.cell.widget_area.show();
383 }
383 }
384 },
384 },
385
385
386 send: function (content) {
386 send: function (content) {
387 // Send a custom msg associated with this view.
387 // Send a custom msg associated with this view.
388 this.model.send(content, this.callbacks());
388 this.model.send(content, this.callbacks());
389 },
389 },
390
390
391 touch: function () {
391 touch: function () {
392 this.model.save_changes(this.callbacks());
392 this.model.save_changes(this.callbacks());
393 },
393 },
394
394
395 after_displayed: function (callback, context) {
395 after_displayed: function (callback, context) {
396 // Calls the callback right away is the view is already displayed
396 // Calls the callback right away is the view is already displayed
397 // otherwise, register the callback to the 'displayed' event.
397 // otherwise, register the callback to the 'displayed' event.
398 if (this.is_displayed) {
398 if (this.is_displayed) {
399 callback.apply(context);
399 callback.apply(context);
400 } else {
400 } else {
401 this.on('displayed', callback, context);
401 this.on('displayed', callback, context);
402 }
402 }
403 },
403 },
404 });
404 });
405
405
406
406
407 var DOMWidgetView = WidgetView.extend({
407 var DOMWidgetView = WidgetView.extend({
408 initialize: function (parameters) {
408 initialize: function (parameters) {
409 // Public constructor
409 // Public constructor
410 DOMWidgetView.__super__.initialize.apply(this, [parameters]);
410 DOMWidgetView.__super__.initialize.apply(this, [parameters]);
411 this.on('displayed', this.show, this);
411 this.on('displayed', this.show, this);
412 this.after_displayed(function() {
412 this.after_displayed(function() {
413 this.update_visible(this.model, this.model.get("visible"));
413 this.update_visible(this.model, this.model.get("visible"));
414 this.update_css(this.model, this.model.get("_css"));
414 this.update_css(this.model, this.model.get("_css"));
415 }, this);
415 }, this);
416 this.model.on('change:visible', this.update_visible, this);
416 this.model.on('change:visible', this.update_visible, this);
417 this.model.on('change:_css', this.update_css, this);
417 this.model.on('change:_css', this.update_css, this);
418 this.model.on('change:_dom_classes', function(model, new_classes) {
418 this.model.on('change:_dom_classes', function(model, new_classes) {
419 var old_classes = model.previous('children');
419 var old_classes = model.previous('children');
420 this.update_classes(old_classes, new_classes);
420 this.update_classes(old_classes, new_classes);
421 }, this);
421 }, this);
422 this.model.on('change:fore_color', function (model, value) {
423 this.update_attr('color', value); }, this);
424 this.model.on('change:back_color', function (model, value) {
425 this.update_attr('background', value); }, this);
426 this.model.on('change:width', function (model, value) {
427 this.update_attr('width', value); }, this);
428 this.model.on('change:height', function (model, value) {
429 this.update_attr('height', value); }, this);
430 this.model.on('change:border_color', function (model, value) {
431 this.update_attr('border-color', value); }, this);
432 this.model.on('change:border_width', function (model, value) {
433 this.update_attr('border-width', value); }, this);
434 this.model.on('change:border_style', function (model, value) {
435 this.update_attr('border-style', value); }, this);
436 this.model.on('change:font_style', function (model, value) {
437 this.update_attr('font-style', value); }, this);
438 this.model.on('change:font_weight', function (model, value) {
439 this.update_attr('font-weight', value); }, this);
440 this.model.on('change:font_size', function (model, value) {
441 this.update_attr('font-size', value); }, this);
442 this.model.on('change:font_family', function (model, value) {
443 this.update_attr('font-family', value); }, this);
422 this.update_classes([], this.model.get('_dom_classes'));
444 this.update_classes([], this.model.get('_dom_classes'));
423 },
445 },
424
446
447 update_attr: function(name, value) {
448 // Set a css attr of the widget view.
449 this.$el.css(name, value);
450 },
451
425 update_visible: function(model, value) {
452 update_visible: function(model, value) {
426 // Update visibility
453 // Update visibility
427 this.$el.toggle(value);
454 this.$el.toggle(value);
428 },
455 },
429
456
430 update_css: function (model, css) {
457 update_css: function (model, css) {
431 // Update the css styling of this view.
458 // Update the css styling of this view.
432 var e = this.$el;
459 var e = this.$el;
433 if (css === undefined) {return;}
460 if (css === undefined) {return;}
434 for (var i = 0; i < css.length; i++) {
461 for (var i = 0; i < css.length; i++) {
435 // Apply the css traits to all elements that match the selector.
462 // Apply the css traits to all elements that match the selector.
436 var selector = css[i][0];
463 var selector = css[i][0];
437 var elements = this._get_selector_element(selector);
464 var elements = this._get_selector_element(selector);
438 if (elements.length > 0) {
465 if (elements.length > 0) {
439 var trait_key = css[i][1];
466 var trait_key = css[i][1];
440 var trait_value = css[i][2];
467 var trait_value = css[i][2];
441 elements.css(trait_key ,trait_value);
468 elements.css(trait_key ,trait_value);
442 }
469 }
443 }
470 }
444 },
471 },
445
472
446 update_classes: function (old_classes, new_classes) {
473 update_classes: function (old_classes, new_classes) {
447 // Update the DOM classes applied to the topmost element.
474 // Update the DOM classes applied to the topmost element.
448 this.do_diff(old_classes, new_classes, function(removed) {
475 this.do_diff(old_classes, new_classes, function(removed) {
449 this.$el.removeClass(removed);
476 this.$el.removeClass(removed);
450 }, function(added) {
477 }, function(added) {
451 this.$el.addClass(added);
478 this.$el.addClass(added);
452 });
479 });
453 },
480 },
454
481
455 _get_selector_element: function (selector) {
482 _get_selector_element: function (selector) {
456 // Get the elements via the css selector.
483 // Get the elements via the css selector.
457 var elements;
484 var elements;
458 if (!selector) {
485 if (!selector) {
459 elements = this.$el;
486 elements = this.$el;
460 } else {
487 } else {
461 elements = this.$el.find(selector).addBack(selector);
488 elements = this.$el.find(selector).addBack(selector);
462 }
489 }
463 return elements;
490 return elements;
464 },
491 },
465 });
492 });
466
493
467 var widget = {
494 var widget = {
468 'WidgetModel': WidgetModel,
495 'WidgetModel': WidgetModel,
469 'WidgetView': WidgetView,
496 'WidgetView': WidgetView,
470 'DOMWidgetView': DOMWidgetView,
497 'DOMWidgetView': DOMWidgetView,
471 };
498 };
472
499
473 // For backwards compatability.
500 // For backwards compatability.
474 $.extend(IPython, widget);
501 $.extend(IPython, widget);
475
502
476 return widget;
503 return widget;
477 });
504 });
@@ -1,307 +1,312
1 // Copyright (c) IPython Development Team.
1 // Copyright (c) IPython Development Team.
2 // Distributed under the terms of the Modified BSD License.
2 // Distributed under the terms of the Modified BSD License.
3
3
4 define([
4 define([
5 "widgets/js/widget",
5 "widgets/js/widget",
6 "jqueryui",
6 "jqueryui",
7 "bootstrap",
7 "bootstrap",
8 ], function(widget, $){
8 ], function(widget, $){
9
9
10 var BoxView = widget.DOMWidgetView.extend({
10 var BoxView = widget.DOMWidgetView.extend({
11 initialize: function(){
11 initialize: function(){
12 // Public constructor
12 // Public constructor
13 BoxView.__super__.initialize.apply(this, arguments);
13 BoxView.__super__.initialize.apply(this, arguments);
14 this.model.on('change:children', function(model, value) {
14 this.model.on('change:children', function(model, value) {
15 this.update_children(model.previous('children'), value);
15 this.update_children(model.previous('children'), value);
16 }, this);
16 }, this);
17 },
17 },
18
18
19 update_attr: function(name, value) {
20 // Set a css attr of the widget view.
21 this.$box.css(name, value);
22 },
23
19 render: function(){
24 render: function(){
20 // Called when view is rendered.
25 // Called when view is rendered.
21 this.$box = this.$el;
26 this.$box = this.$el;
22 this.$box.addClass('widget-box');
27 this.$box.addClass('widget-box');
23 this.update_children([], this.model.get('children'));
28 this.update_children([], this.model.get('children'));
24 },
29 },
25
30
26 update_children: function(old_list, new_list) {
31 update_children: function(old_list, new_list) {
27 // Called when the children list changes.
32 // Called when the children list changes.
28 this.do_diff(old_list, new_list,
33 this.do_diff(old_list, new_list,
29 $.proxy(this.remove_child_model, this),
34 $.proxy(this.remove_child_model, this),
30 $.proxy(this.add_child_model, this));
35 $.proxy(this.add_child_model, this));
31 },
36 },
32
37
33 remove_child_model: function(model) {
38 remove_child_model: function(model) {
34 // Called when a model is removed from the children list.
39 // Called when a model is removed from the children list.
35 this.pop_child_view(model).remove();
40 this.pop_child_view(model).remove();
36 },
41 },
37
42
38 add_child_model: function(model) {
43 add_child_model: function(model) {
39 // Called when a model is added to the children list.
44 // Called when a model is added to the children list.
40 var view = this.create_child_view(model);
45 var view = this.create_child_view(model);
41 this.$box.append(view.$el);
46 this.$box.append(view.$el);
42
47
43 // Trigger the displayed event of the child view.
48 // Trigger the displayed event of the child view.
44 this.after_displayed(function() {
49 this.after_displayed(function() {
45 view.trigger('displayed');
50 view.trigger('displayed');
46 });
51 });
47 },
52 },
48 });
53 });
49
54
50
55
51 var FlexBoxView = BoxView.extend({
56 var FlexBoxView = BoxView.extend({
52 render: function(){
57 render: function(){
53 FlexBoxView.__super__.render.apply(this);
58 FlexBoxView.__super__.render.apply(this);
54 this.model.on('change:orientation', this.update_orientation, this);
59 this.model.on('change:orientation', this.update_orientation, this);
55 this.model.on('change:flex', this._flex_changed, this);
60 this.model.on('change:flex', this._flex_changed, this);
56 this.model.on('change:pack', this._pack_changed, this);
61 this.model.on('change:pack', this._pack_changed, this);
57 this.model.on('change:align', this._align_changed, this);
62 this.model.on('change:align', this._align_changed, this);
58 this._flex_changed();
63 this._flex_changed();
59 this._pack_changed();
64 this._pack_changed();
60 this._align_changed();
65 this._align_changed();
61 this.update_orientation();
66 this.update_orientation();
62 },
67 },
63
68
64 update_orientation: function(){
69 update_orientation: function(){
65 var orientation = this.model.get("orientation");
70 var orientation = this.model.get("orientation");
66 if (orientation == "vertical") {
71 if (orientation == "vertical") {
67 this.$box.removeClass("hbox").addClass("vbox");
72 this.$box.removeClass("hbox").addClass("vbox");
68 } else {
73 } else {
69 this.$box.removeClass("vbox").addClass("hbox");
74 this.$box.removeClass("vbox").addClass("hbox");
70 }
75 }
71 },
76 },
72
77
73 _flex_changed: function(){
78 _flex_changed: function(){
74 if (this.model.previous('flex')) {
79 if (this.model.previous('flex')) {
75 this.$box.removeClass('box-flex' + this.model.previous('flex'));
80 this.$box.removeClass('box-flex' + this.model.previous('flex'));
76 }
81 }
77 this.$box.addClass('box-flex' + this.model.get('flex'));
82 this.$box.addClass('box-flex' + this.model.get('flex'));
78 },
83 },
79
84
80 _pack_changed: function(){
85 _pack_changed: function(){
81 if (this.model.previous('pack')) {
86 if (this.model.previous('pack')) {
82 this.$box.removeClass(this.model.previous('pack'));
87 this.$box.removeClass(this.model.previous('pack'));
83 }
88 }
84 this.$box.addClass(this.model.get('pack'));
89 this.$box.addClass(this.model.get('pack'));
85 },
90 },
86
91
87 _align_changed: function(){
92 _align_changed: function(){
88 if (this.model.previous('align')) {
93 if (this.model.previous('align')) {
89 this.$box.removeClass('align-' + this.model.previous('align'));
94 this.$box.removeClass('align-' + this.model.previous('align'));
90 }
95 }
91 this.$box.addClass('align-' + this.model.get('align'));
96 this.$box.addClass('align-' + this.model.get('align'));
92 },
97 },
93 });
98 });
94
99
95 var PopupView = BoxView.extend({
100 var PopupView = BoxView.extend({
96
101
97 render: function(){
102 render: function(){
98 // Called when view is rendered.
103 // Called when view is rendered.
99 var that = this;
104 var that = this;
100
105
101 this.$el.on("remove", function(){
106 this.$el.on("remove", function(){
102 that.$backdrop.remove();
107 that.$backdrop.remove();
103 });
108 });
104 this.$backdrop = $('<div />')
109 this.$backdrop = $('<div />')
105 .appendTo($('#notebook-container'))
110 .appendTo($('#notebook-container'))
106 .addClass('modal-dialog')
111 .addClass('modal-dialog')
107 .css('position', 'absolute')
112 .css('position', 'absolute')
108 .css('left', '0px')
113 .css('left', '0px')
109 .css('top', '0px');
114 .css('top', '0px');
110 this.$window = $('<div />')
115 this.$window = $('<div />')
111 .appendTo(this.$backdrop)
116 .appendTo(this.$backdrop)
112 .addClass('modal-content widget-modal')
117 .addClass('modal-content widget-modal')
113 .mousedown(function(){
118 .mousedown(function(){
114 that.bring_to_front();
119 that.bring_to_front();
115 });
120 });
116
121
117 // Set the elements array since the this.$window element is not child
122 // Set the elements array since the this.$window element is not child
118 // of this.$el and the parent widget manager or other widgets may
123 // of this.$el and the parent widget manager or other widgets may
119 // need to know about all of the top-level widgets. The IPython
124 // need to know about all of the top-level widgets. The IPython
120 // widget manager uses this to register the elements with the
125 // widget manager uses this to register the elements with the
121 // keyboard manager.
126 // keyboard manager.
122 this.additional_elements = [this.$window];
127 this.additional_elements = [this.$window];
123
128
124 this.$title_bar = $('<div />')
129 this.$title_bar = $('<div />')
125 .addClass('popover-title')
130 .addClass('popover-title')
126 .appendTo(this.$window)
131 .appendTo(this.$window)
127 .mousedown(function(){
132 .mousedown(function(){
128 that.bring_to_front();
133 that.bring_to_front();
129 });
134 });
130 this.$close = $('<button />')
135 this.$close = $('<button />')
131 .addClass('close fa fa-remove')
136 .addClass('close fa fa-remove')
132 .css('margin-left', '5px')
137 .css('margin-left', '5px')
133 .appendTo(this.$title_bar)
138 .appendTo(this.$title_bar)
134 .click(function(){
139 .click(function(){
135 that.hide();
140 that.hide();
136 event.stopPropagation();
141 event.stopPropagation();
137 });
142 });
138 this.$minimize = $('<button />')
143 this.$minimize = $('<button />')
139 .addClass('close fa fa-arrow-down')
144 .addClass('close fa fa-arrow-down')
140 .appendTo(this.$title_bar)
145 .appendTo(this.$title_bar)
141 .click(function(){
146 .click(function(){
142 that.popped_out = !that.popped_out;
147 that.popped_out = !that.popped_out;
143 if (!that.popped_out) {
148 if (!that.popped_out) {
144 that.$minimize
149 that.$minimize
145 .removeClass('fa fa-arrow-down')
150 .removeClass('fa fa-arrow-down')
146 .addClass('fa fa-arrow-up');
151 .addClass('fa fa-arrow-up');
147
152
148 that.$window
153 that.$window
149 .draggable('destroy')
154 .draggable('destroy')
150 .resizable('destroy')
155 .resizable('destroy')
151 .removeClass('widget-modal modal-content')
156 .removeClass('widget-modal modal-content')
152 .addClass('docked-widget-modal')
157 .addClass('docked-widget-modal')
153 .detach()
158 .detach()
154 .insertBefore(that.$show_button);
159 .insertBefore(that.$show_button);
155 that.$show_button.hide();
160 that.$show_button.hide();
156 that.$close.hide();
161 that.$close.hide();
157 } else {
162 } else {
158 that.$minimize
163 that.$minimize
159 .addClass('fa fa-arrow-down')
164 .addClass('fa fa-arrow-down')
160 .removeClass('fa fa-arrow-up');
165 .removeClass('fa fa-arrow-up');
161
166
162 that.$window
167 that.$window
163 .removeClass('docked-widget-modal')
168 .removeClass('docked-widget-modal')
164 .addClass('widget-modal modal-content')
169 .addClass('widget-modal modal-content')
165 .detach()
170 .detach()
166 .appendTo(that.$backdrop)
171 .appendTo(that.$backdrop)
167 .draggable({handle: '.popover-title', snap: '#notebook, .modal', snapMode: 'both'})
172 .draggable({handle: '.popover-title', snap: '#notebook, .modal', snapMode: 'both'})
168 .resizable()
173 .resizable()
169 .children('.ui-resizable-handle').show();
174 .children('.ui-resizable-handle').show();
170 that.show();
175 that.show();
171 that.$show_button.show();
176 that.$show_button.show();
172 that.$close.show();
177 that.$close.show();
173 }
178 }
174 event.stopPropagation();
179 event.stopPropagation();
175 });
180 });
176 this.$title = $('<div />')
181 this.$title = $('<div />')
177 .addClass('widget-modal-title')
182 .addClass('widget-modal-title')
178 .html("&nbsp;")
183 .html("&nbsp;")
179 .appendTo(this.$title_bar);
184 .appendTo(this.$title_bar);
180 this.$box = $('<div />')
185 this.$box = $('<div />')
181 .addClass('modal-body')
186 .addClass('modal-body')
182 .addClass('widget-modal-body')
187 .addClass('widget-modal-body')
183 .addClass('widget-box')
188 .addClass('widget-box')
184 .addClass('vbox')
189 .addClass('vbox')
185 .appendTo(this.$window);
190 .appendTo(this.$window);
186
191
187 this.$show_button = $('<button />')
192 this.$show_button = $('<button />')
188 .html("&nbsp;")
193 .html("&nbsp;")
189 .addClass('btn btn-info widget-modal-show')
194 .addClass('btn btn-info widget-modal-show')
190 .appendTo(this.$el)
195 .appendTo(this.$el)
191 .click(function(){
196 .click(function(){
192 that.show();
197 that.show();
193 });
198 });
194
199
195 this.$window.draggable({handle: '.popover-title', snap: '#notebook, .modal', snapMode: 'both'});
200 this.$window.draggable({handle: '.popover-title', snap: '#notebook, .modal', snapMode: 'both'});
196 this.$window.resizable();
201 this.$window.resizable();
197 this.$window.on('resize', function(){
202 this.$window.on('resize', function(){
198 that.$box.outerHeight(that.$window.innerHeight() - that.$title_bar.outerHeight());
203 that.$box.outerHeight(that.$window.innerHeight() - that.$title_bar.outerHeight());
199 });
204 });
200
205
201 this._shown_once = false;
206 this._shown_once = false;
202 this.popped_out = true;
207 this.popped_out = true;
203
208
204 this.update_children([], this.model.get('children'));
209 this.update_children([], this.model.get('children'));
205 this.model.on('change:children', function(model, value) {
210 this.model.on('change:children', function(model, value) {
206 this.update_children(model.previous('children'), value);
211 this.update_children(model.previous('children'), value);
207 }, this);
212 }, this);
208 },
213 },
209
214
210 hide: function() {
215 hide: function() {
211 // Called when the modal hide button is clicked.
216 // Called when the modal hide button is clicked.
212 this.$window.hide();
217 this.$window.hide();
213 this.$show_button.removeClass('btn-info');
218 this.$show_button.removeClass('btn-info');
214 },
219 },
215
220
216 show: function() {
221 show: function() {
217 // Called when the modal show button is clicked.
222 // Called when the modal show button is clicked.
218 this.$show_button.addClass('btn-info');
223 this.$show_button.addClass('btn-info');
219 this.$window.show();
224 this.$window.show();
220 if (this.popped_out) {
225 if (this.popped_out) {
221 this.$window.css("positon", "absolute");
226 this.$window.css("positon", "absolute");
222 this.$window.css("top", "0px");
227 this.$window.css("top", "0px");
223 this.$window.css("left", Math.max(0, (($('body').outerWidth() - this.$window.outerWidth()) / 2) +
228 this.$window.css("left", Math.max(0, (($('body').outerWidth() - this.$window.outerWidth()) / 2) +
224 $(window).scrollLeft()) + "px");
229 $(window).scrollLeft()) + "px");
225 this.bring_to_front();
230 this.bring_to_front();
226 }
231 }
227 },
232 },
228
233
229 bring_to_front: function() {
234 bring_to_front: function() {
230 // Make the modal top-most, z-ordered about the other modals.
235 // Make the modal top-most, z-ordered about the other modals.
231 var $widget_modals = $(".widget-modal");
236 var $widget_modals = $(".widget-modal");
232 var max_zindex = 0;
237 var max_zindex = 0;
233 $widget_modals.each(function (index, el){
238 $widget_modals.each(function (index, el){
234 var zindex = parseInt($(el).css('z-index'));
239 var zindex = parseInt($(el).css('z-index'));
235 if (!isNaN(zindex)) {
240 if (!isNaN(zindex)) {
236 max_zindex = Math.max(max_zindex, zindex);
241 max_zindex = Math.max(max_zindex, zindex);
237 }
242 }
238 });
243 });
239
244
240 // Start z-index of widget modals at 2000
245 // Start z-index of widget modals at 2000
241 max_zindex = Math.max(max_zindex, 2000);
246 max_zindex = Math.max(max_zindex, 2000);
242
247
243 $widget_modals.each(function (index, el){
248 $widget_modals.each(function (index, el){
244 $el = $(el);
249 $el = $(el);
245 if (max_zindex == parseInt($el.css('z-index'))) {
250 if (max_zindex == parseInt($el.css('z-index'))) {
246 $el.css('z-index', max_zindex - 1);
251 $el.css('z-index', max_zindex - 1);
247 }
252 }
248 });
253 });
249 this.$window.css('z-index', max_zindex);
254 this.$window.css('z-index', max_zindex);
250 },
255 },
251
256
252 update: function(){
257 update: function(){
253 // Update the contents of this view
258 // Update the contents of this view
254 //
259 //
255 // Called when the model is changed. The model may have been
260 // Called when the model is changed. The model may have been
256 // changed by another view or by a state update from the back-end.
261 // changed by another view or by a state update from the back-end.
257 var description = this.model.get('description');
262 var description = this.model.get('description');
258 if (description.trim().length === 0) {
263 if (description.trim().length === 0) {
259 this.$title.html("&nbsp;"); // Preserve title height
264 this.$title.html("&nbsp;"); // Preserve title height
260 } else {
265 } else {
261 this.$title.text(description);
266 this.$title.text(description);
262 MathJax.Hub.Queue(["Typeset",MathJax.Hub,this.$title.get(0)]);
267 MathJax.Hub.Queue(["Typeset",MathJax.Hub,this.$title.get(0)]);
263 }
268 }
264
269
265 var button_text = this.model.get('button_text');
270 var button_text = this.model.get('button_text');
266 if (button_text.trim().length === 0) {
271 if (button_text.trim().length === 0) {
267 this.$show_button.html("&nbsp;"); // Preserve button height
272 this.$show_button.html("&nbsp;"); // Preserve button height
268 } else {
273 } else {
269 this.$show_button.text(button_text);
274 this.$show_button.text(button_text);
270 }
275 }
271
276
272 if (!this._shown_once) {
277 if (!this._shown_once) {
273 this._shown_once = true;
278 this._shown_once = true;
274 this.show();
279 this.show();
275 }
280 }
276
281
277 return PopupView.__super__.update.apply(this);
282 return PopupView.__super__.update.apply(this);
278 },
283 },
279
284
280 _get_selector_element: function(selector) {
285 _get_selector_element: function(selector) {
281 // Get an element view a 'special' jquery selector. (see widget.js)
286 // Get an element view a 'special' jquery selector. (see widget.js)
282 //
287 //
283 // Since the modal actually isn't within the $el in the DOM, we need to extend
288 // Since the modal actually isn't within the $el in the DOM, we need to extend
284 // the selector logic to allow the user to set css on the modal if need be.
289 // the selector logic to allow the user to set css on the modal if need be.
285 // The convention used is:
290 // The convention used is:
286 // "modal" - select the modal div
291 // "modal" - select the modal div
287 // "modal [selector]" - select element(s) within the modal div.
292 // "modal [selector]" - select element(s) within the modal div.
288 // "[selector]" - select elements within $el
293 // "[selector]" - select elements within $el
289 // "" - select the $el
294 // "" - select the $el
290 if (selector.substring(0, 5) == 'modal') {
295 if (selector.substring(0, 5) == 'modal') {
291 if (selector == 'modal') {
296 if (selector == 'modal') {
292 return this.$window;
297 return this.$window;
293 } else {
298 } else {
294 return this.$window.find(selector.substring(6));
299 return this.$window.find(selector.substring(6));
295 }
300 }
296 } else {
301 } else {
297 return PopupView.__super__._get_selector_element.apply(this, [selector]);
302 return PopupView.__super__._get_selector_element.apply(this, [selector]);
298 }
303 }
299 },
304 },
300 });
305 });
301
306
302 return {
307 return {
303 'BoxView': BoxView,
308 'BoxView': BoxView,
304 'PopupView': PopupView,
309 'PopupView': PopupView,
305 'FlexBoxView': FlexBoxView,
310 'FlexBoxView': FlexBoxView,
306 };
311 };
307 });
312 });
@@ -1,383 +1,425
1 """Base Widget class. Allows user to create widgets in the back-end that render
1 """Base Widget class. Allows user to create widgets in the back-end that render
2 in the IPython notebook front-end.
2 in the IPython notebook front-end.
3 """
3 """
4 #-----------------------------------------------------------------------------
4 #-----------------------------------------------------------------------------
5 # Copyright (c) 2013, the IPython Development Team.
5 # Copyright (c) 2013, the IPython Development Team.
6 #
6 #
7 # Distributed under the terms of the Modified BSD License.
7 # Distributed under the terms of the Modified BSD License.
8 #
8 #
9 # The full license is in the file COPYING.txt, distributed with this software.
9 # The full license is in the file COPYING.txt, distributed with this software.
10 #-----------------------------------------------------------------------------
10 #-----------------------------------------------------------------------------
11
11
12 #-----------------------------------------------------------------------------
12 #-----------------------------------------------------------------------------
13 # Imports
13 # Imports
14 #-----------------------------------------------------------------------------
14 #-----------------------------------------------------------------------------
15 from contextlib import contextmanager
15 from contextlib import contextmanager
16 import collections
16 import collections
17
17
18 from IPython.core.getipython import get_ipython
18 from IPython.core.getipython import get_ipython
19 from IPython.kernel.comm import Comm
19 from IPython.kernel.comm import Comm
20 from IPython.config import LoggingConfigurable
20 from IPython.config import LoggingConfigurable
21 from IPython.utils.traitlets import Unicode, Dict, Instance, Bool, List, Tuple, Int, Set
21 from IPython.utils.traitlets import Unicode, Dict, Instance, Bool, List,
22 CaselessStrEnum, Tuple, CTuple, CUnicode, Int, Set
22 from IPython.utils.py3compat import string_types
23 from IPython.utils.py3compat import string_types
23
24
24 #-----------------------------------------------------------------------------
25 #-----------------------------------------------------------------------------
25 # Classes
26 # Classes
26 #-----------------------------------------------------------------------------
27 #-----------------------------------------------------------------------------
27 class CallbackDispatcher(LoggingConfigurable):
28 class CallbackDispatcher(LoggingConfigurable):
28 """A structure for registering and running callbacks"""
29 """A structure for registering and running callbacks"""
29 callbacks = List()
30 callbacks = List()
30
31
31 def __call__(self, *args, **kwargs):
32 def __call__(self, *args, **kwargs):
32 """Call all of the registered callbacks."""
33 """Call all of the registered callbacks."""
33 value = None
34 value = None
34 for callback in self.callbacks:
35 for callback in self.callbacks:
35 try:
36 try:
36 local_value = callback(*args, **kwargs)
37 local_value = callback(*args, **kwargs)
37 except Exception as e:
38 except Exception as e:
38 ip = get_ipython()
39 ip = get_ipython()
39 if ip is None:
40 if ip is None:
40 self.log.warn("Exception in callback %s: %s", callback, e, exc_info=True)
41 self.log.warn("Exception in callback %s: %s", callback, e, exc_info=True)
41 else:
42 else:
42 ip.showtraceback()
43 ip.showtraceback()
43 else:
44 else:
44 value = local_value if local_value is not None else value
45 value = local_value if local_value is not None else value
45 return value
46 return value
46
47
47 def register_callback(self, callback, remove=False):
48 def register_callback(self, callback, remove=False):
48 """(Un)Register a callback
49 """(Un)Register a callback
49
50
50 Parameters
51 Parameters
51 ----------
52 ----------
52 callback: method handle
53 callback: method handle
53 Method to be registered or unregistered.
54 Method to be registered or unregistered.
54 remove=False: bool
55 remove=False: bool
55 Whether to unregister the callback."""
56 Whether to unregister the callback."""
56
57
57 # (Un)Register the callback.
58 # (Un)Register the callback.
58 if remove and callback in self.callbacks:
59 if remove and callback in self.callbacks:
59 self.callbacks.remove(callback)
60 self.callbacks.remove(callback)
60 elif not remove and callback not in self.callbacks:
61 elif not remove and callback not in self.callbacks:
61 self.callbacks.append(callback)
62 self.callbacks.append(callback)
62
63
63 def _show_traceback(method):
64 def _show_traceback(method):
64 """decorator for showing tracebacks in IPython"""
65 """decorator for showing tracebacks in IPython"""
65 def m(self, *args, **kwargs):
66 def m(self, *args, **kwargs):
66 try:
67 try:
67 return(method(self, *args, **kwargs))
68 return(method(self, *args, **kwargs))
68 except Exception as e:
69 except Exception as e:
69 ip = get_ipython()
70 ip = get_ipython()
70 if ip is None:
71 if ip is None:
71 self.log.warn("Exception in widget method %s: %s", method, e, exc_info=True)
72 self.log.warn("Exception in widget method %s: %s", method, e, exc_info=True)
72 else:
73 else:
73 ip.showtraceback()
74 ip.showtraceback()
74 return m
75 return m
75
76
76 class Widget(LoggingConfigurable):
77 class Widget(LoggingConfigurable):
77 #-------------------------------------------------------------------------
78 #-------------------------------------------------------------------------
78 # Class attributes
79 # Class attributes
79 #-------------------------------------------------------------------------
80 #-------------------------------------------------------------------------
80 _widget_construction_callback = None
81 _widget_construction_callback = None
81 widgets = {}
82 widgets = {}
82
83
83 @staticmethod
84 @staticmethod
84 def on_widget_constructed(callback):
85 def on_widget_constructed(callback):
85 """Registers a callback to be called when a widget is constructed.
86 """Registers a callback to be called when a widget is constructed.
86
87
87 The callback must have the following signature:
88 The callback must have the following signature:
88 callback(widget)"""
89 callback(widget)"""
89 Widget._widget_construction_callback = callback
90 Widget._widget_construction_callback = callback
90
91
91 @staticmethod
92 @staticmethod
92 def _call_widget_constructed(widget):
93 def _call_widget_constructed(widget):
93 """Static method, called when a widget is constructed."""
94 """Static method, called when a widget is constructed."""
94 if Widget._widget_construction_callback is not None and callable(Widget._widget_construction_callback):
95 if Widget._widget_construction_callback is not None and callable(Widget._widget_construction_callback):
95 Widget._widget_construction_callback(widget)
96 Widget._widget_construction_callback(widget)
96
97
97 #-------------------------------------------------------------------------
98 #-------------------------------------------------------------------------
98 # Traits
99 # Traits
99 #-------------------------------------------------------------------------
100 #-------------------------------------------------------------------------
100 _model_name = Unicode('WidgetModel', help="""Name of the backbone model
101 _model_name = Unicode('WidgetModel', help="""Name of the backbone model
101 registered in the front-end to create and sync this widget with.""")
102 registered in the front-end to create and sync this widget with.""")
102 _view_name = Unicode('WidgetView', help="""Default view registered in the front-end
103 _view_name = Unicode('WidgetView', help="""Default view registered in the front-end
103 to use to represent the widget.""", sync=True)
104 to use to represent the widget.""", sync=True)
104 comm = Instance('IPython.kernel.comm.Comm')
105 comm = Instance('IPython.kernel.comm.Comm')
105
106
106 msg_throttle = Int(3, sync=True, help="""Maximum number of msgs the
107 msg_throttle = Int(3, sync=True, help="""Maximum number of msgs the
107 front-end can send before receiving an idle msg from the back-end.""")
108 front-end can send before receiving an idle msg from the back-end.""")
108
109
109 keys = List()
110 keys = List()
110 def _keys_default(self):
111 def _keys_default(self):
111 return [name for name in self.traits(sync=True)]
112 return [name for name in self.traits(sync=True)]
112
113
113 _property_lock = Tuple((None, None))
114 _property_lock = Tuple((None, None))
114 _send_state_lock = Int(0)
115 _send_state_lock = Int(0)
115 _states_to_send = Set(allow_none=False)
116 _states_to_send = Set(allow_none=False)
116 _display_callbacks = Instance(CallbackDispatcher, ())
117 _display_callbacks = Instance(CallbackDispatcher, ())
117 _msg_callbacks = Instance(CallbackDispatcher, ())
118 _msg_callbacks = Instance(CallbackDispatcher, ())
118
119
119 #-------------------------------------------------------------------------
120 #-------------------------------------------------------------------------
120 # (Con/de)structor
121 # (Con/de)structor
121 #-------------------------------------------------------------------------
122 #-------------------------------------------------------------------------
122 def __init__(self, **kwargs):
123 def __init__(self, **kwargs):
123 """Public constructor"""
124 """Public constructor"""
124 self._model_id = kwargs.pop('model_id', None)
125 self._model_id = kwargs.pop('model_id', None)
125 super(Widget, self).__init__(**kwargs)
126 super(Widget, self).__init__(**kwargs)
126
127
127 self.on_trait_change(self._handle_property_changed, self.keys)
128 self.on_trait_change(self._handle_property_changed, self.keys)
128 Widget._call_widget_constructed(self)
129 Widget._call_widget_constructed(self)
129 self.open()
130 self.open()
130
131
131 def __del__(self):
132 def __del__(self):
132 """Object disposal"""
133 """Object disposal"""
133 self.close()
134 self.close()
134
135
135 #-------------------------------------------------------------------------
136 #-------------------------------------------------------------------------
136 # Properties
137 # Properties
137 #-------------------------------------------------------------------------
138 #-------------------------------------------------------------------------
138
139
139 def open(self):
140 def open(self):
140 """Open a comm to the frontend if one isn't already open."""
141 """Open a comm to the frontend if one isn't already open."""
141 if self.comm is None:
142 if self.comm is None:
142 if self._model_id is None:
143 if self._model_id is None:
143 self.comm = Comm(target_name=self._model_name)
144 self.comm = Comm(target_name=self._model_name)
144 self._model_id = self.model_id
145 self._model_id = self.model_id
145 else:
146 else:
146 self.comm = Comm(target_name=self._model_name, comm_id=self._model_id)
147 self.comm = Comm(target_name=self._model_name, comm_id=self._model_id)
147 self.comm.on_msg(self._handle_msg)
148 self.comm.on_msg(self._handle_msg)
148 Widget.widgets[self.model_id] = self
149 Widget.widgets[self.model_id] = self
149
150
150 # first update
151 # first update
151 self.send_state()
152 self.send_state()
152
153
153 @property
154 @property
154 def model_id(self):
155 def model_id(self):
155 """Gets the model id of this widget.
156 """Gets the model id of this widget.
156
157
157 If a Comm doesn't exist yet, a Comm will be created automagically."""
158 If a Comm doesn't exist yet, a Comm will be created automagically."""
158 return self.comm.comm_id
159 return self.comm.comm_id
159
160
160 #-------------------------------------------------------------------------
161 #-------------------------------------------------------------------------
161 # Methods
162 # Methods
162 #-------------------------------------------------------------------------
163 #-------------------------------------------------------------------------
163
164
164 def close(self):
165 def close(self):
165 """Close method.
166 """Close method.
166
167
167 Closes the underlying comm.
168 Closes the underlying comm.
168 When the comm is closed, all of the widget views are automatically
169 When the comm is closed, all of the widget views are automatically
169 removed from the front-end."""
170 removed from the front-end."""
170 if self.comm is not None:
171 if self.comm is not None:
171 Widget.widgets.pop(self.model_id, None)
172 Widget.widgets.pop(self.model_id, None)
172 self.comm.close()
173 self.comm.close()
173 self.comm = None
174 self.comm = None
174
175
175 def send_state(self, key=None):
176 def send_state(self, key=None):
176 """Sends the widget state, or a piece of it, to the front-end.
177 """Sends the widget state, or a piece of it, to the front-end.
177
178
178 Parameters
179 Parameters
179 ----------
180 ----------
180 key : unicode, or iterable (optional)
181 key : unicode, or iterable (optional)
181 A single property's name or iterable of property names to sync with the front-end.
182 A single property's name or iterable of property names to sync with the front-end.
182 """
183 """
183 self._send({
184 self._send({
184 "method" : "update",
185 "method" : "update",
185 "state" : self.get_state(key=key)
186 "state" : self.get_state(key=key)
186 })
187 })
187
188
188 def get_state(self, key=None):
189 def get_state(self, key=None):
189 """Gets the widget state, or a piece of it.
190 """Gets the widget state, or a piece of it.
190
191
191 Parameters
192 Parameters
192 ----------
193 ----------
193 key : unicode or iterable (optional)
194 key : unicode or iterable (optional)
194 A single property's name or iterable of property names to get.
195 A single property's name or iterable of property names to get.
195 """
196 """
196 if key is None:
197 if key is None:
197 keys = self.keys
198 keys = self.keys
198 elif isinstance(key, string_types):
199 elif isinstance(key, string_types):
199 keys = [key]
200 keys = [key]
200 elif isinstance(key, collections.Iterable):
201 elif isinstance(key, collections.Iterable):
201 keys = key
202 keys = key
202 else:
203 else:
203 raise ValueError("key must be a string, an iterable of keys, or None")
204 raise ValueError("key must be a string, an iterable of keys, or None")
204 state = {}
205 state = {}
205 for k in keys:
206 for k in keys:
206 f = self.trait_metadata(k, 'to_json', self._trait_to_json)
207 f = self.trait_metadata(k, 'to_json', self._trait_to_json)
207 value = getattr(self, k)
208 value = getattr(self, k)
208 state[k] = f(value)
209 state[k] = f(value)
209 return state
210 return state
210
211
211 def send(self, content):
212 def send(self, content):
212 """Sends a custom msg to the widget model in the front-end.
213 """Sends a custom msg to the widget model in the front-end.
213
214
214 Parameters
215 Parameters
215 ----------
216 ----------
216 content : dict
217 content : dict
217 Content of the message to send.
218 Content of the message to send.
218 """
219 """
219 self._send({"method": "custom", "content": content})
220 self._send({"method": "custom", "content": content})
220
221
221 def on_msg(self, callback, remove=False):
222 def on_msg(self, callback, remove=False):
222 """(Un)Register a custom msg receive callback.
223 """(Un)Register a custom msg receive callback.
223
224
224 Parameters
225 Parameters
225 ----------
226 ----------
226 callback: callable
227 callback: callable
227 callback will be passed two arguments when a message arrives::
228 callback will be passed two arguments when a message arrives::
228
229
229 callback(widget, content)
230 callback(widget, content)
230
231
231 remove: bool
232 remove: bool
232 True if the callback should be unregistered."""
233 True if the callback should be unregistered."""
233 self._msg_callbacks.register_callback(callback, remove=remove)
234 self._msg_callbacks.register_callback(callback, remove=remove)
234
235
235 def on_displayed(self, callback, remove=False):
236 def on_displayed(self, callback, remove=False):
236 """(Un)Register a widget displayed callback.
237 """(Un)Register a widget displayed callback.
237
238
238 Parameters
239 Parameters
239 ----------
240 ----------
240 callback: method handler
241 callback: method handler
241 Must have a signature of::
242 Must have a signature of::
242
243
243 callback(widget, **kwargs)
244 callback(widget, **kwargs)
244
245
245 kwargs from display are passed through without modification.
246 kwargs from display are passed through without modification.
246 remove: bool
247 remove: bool
247 True if the callback should be unregistered."""
248 True if the callback should be unregistered."""
248 self._display_callbacks.register_callback(callback, remove=remove)
249 self._display_callbacks.register_callback(callback, remove=remove)
249
250
250 #-------------------------------------------------------------------------
251 #-------------------------------------------------------------------------
251 # Support methods
252 # Support methods
252 #-------------------------------------------------------------------------
253 #-------------------------------------------------------------------------
253 @contextmanager
254 @contextmanager
254 def _lock_property(self, key, value):
255 def _lock_property(self, key, value):
255 """Lock a property-value pair.
256 """Lock a property-value pair.
256
257
257 The value should be the JSON state of the property.
258 The value should be the JSON state of the property.
258
259
259 NOTE: This, in addition to the single lock for all state changes, is
260 NOTE: This, in addition to the single lock for all state changes, is
260 flawed. In the future we may want to look into buffering state changes
261 flawed. In the future we may want to look into buffering state changes
261 back to the front-end."""
262 back to the front-end."""
262 self._property_lock = (key, value)
263 self._property_lock = (key, value)
263 try:
264 try:
264 yield
265 yield
265 finally:
266 finally:
266 self._property_lock = (None, None)
267 self._property_lock = (None, None)
267
268
268 @contextmanager
269 @contextmanager
269 def hold_sync(self):
270 def hold_sync(self):
270 """Hold syncing any state until the context manager is released"""
271 """Hold syncing any state until the context manager is released"""
271 # We increment a value so that this can be nested. Syncing will happen when
272 # We increment a value so that this can be nested. Syncing will happen when
272 # all levels have been released.
273 # all levels have been released.
273 self._send_state_lock += 1
274 self._send_state_lock += 1
274 try:
275 try:
275 yield
276 yield
276 finally:
277 finally:
277 self._send_state_lock -=1
278 self._send_state_lock -=1
278 if self._send_state_lock == 0:
279 if self._send_state_lock == 0:
279 self.send_state(self._states_to_send)
280 self.send_state(self._states_to_send)
280 self._states_to_send.clear()
281 self._states_to_send.clear()
281
282
282 def _should_send_property(self, key, value):
283 def _should_send_property(self, key, value):
283 """Check the property lock (property_lock)"""
284 """Check the property lock (property_lock)"""
284 to_json = self.trait_metadata(key, 'to_json', self._trait_to_json)
285 to_json = self.trait_metadata(key, 'to_json', self._trait_to_json)
285 if (key == self._property_lock[0]
286 if (key == self._property_lock[0]
286 and to_json(value) == self._property_lock[1]):
287 and to_json(value) == self._property_lock[1]):
287 return False
288 return False
288 elif self._send_state_lock > 0:
289 elif self._send_state_lock > 0:
289 self._states_to_send.add(key)
290 self._states_to_send.add(key)
290 return False
291 return False
291 else:
292 else:
292 return True
293 return True
293
294
294 # Event handlers
295 # Event handlers
295 @_show_traceback
296 @_show_traceback
296 def _handle_msg(self, msg):
297 def _handle_msg(self, msg):
297 """Called when a msg is received from the front-end"""
298 """Called when a msg is received from the front-end"""
298 data = msg['content']['data']
299 data = msg['content']['data']
299 method = data['method']
300 method = data['method']
300 if not method in ['backbone', 'custom']:
301 if not method in ['backbone', 'custom']:
301 self.log.error('Unknown front-end to back-end widget msg with method "%s"' % method)
302 self.log.error('Unknown front-end to back-end widget msg with method "%s"' % method)
302
303
303 # Handle backbone sync methods CREATE, PATCH, and UPDATE all in one.
304 # Handle backbone sync methods CREATE, PATCH, and UPDATE all in one.
304 if method == 'backbone' and 'sync_data' in data:
305 if method == 'backbone' and 'sync_data' in data:
305 sync_data = data['sync_data']
306 sync_data = data['sync_data']
306 self._handle_receive_state(sync_data) # handles all methods
307 self._handle_receive_state(sync_data) # handles all methods
307
308
308 # Handle a custom msg from the front-end
309 # Handle a custom msg from the front-end
309 elif method == 'custom':
310 elif method == 'custom':
310 if 'content' in data:
311 if 'content' in data:
311 self._handle_custom_msg(data['content'])
312 self._handle_custom_msg(data['content'])
312
313
313 def _handle_receive_state(self, sync_data):
314 def _handle_receive_state(self, sync_data):
314 """Called when a state is received from the front-end."""
315 """Called when a state is received from the front-end."""
315 for name in self.keys:
316 for name in self.keys:
316 if name in sync_data:
317 if name in sync_data:
317 json_value = sync_data[name]
318 json_value = sync_data[name]
318 from_json = self.trait_metadata(name, 'from_json', self._trait_from_json)
319 from_json = self.trait_metadata(name, 'from_json', self._trait_from_json)
319 with self._lock_property(name, json_value):
320 with self._lock_property(name, json_value):
320 setattr(self, name, from_json(json_value))
321 setattr(self, name, from_json(json_value))
321
322
322 def _handle_custom_msg(self, content):
323 def _handle_custom_msg(self, content):
323 """Called when a custom msg is received."""
324 """Called when a custom msg is received."""
324 self._msg_callbacks(self, content)
325 self._msg_callbacks(self, content)
325
326
326 def _handle_property_changed(self, name, old, new):
327 def _handle_property_changed(self, name, old, new):
327 """Called when a property has been changed."""
328 """Called when a property has been changed."""
328 # Make sure this isn't information that the front-end just sent us.
329 # Make sure this isn't information that the front-end just sent us.
329 if self._should_send_property(name, new):
330 if self._should_send_property(name, new):
330 # Send new state to front-end
331 # Send new state to front-end
331 self.send_state(key=name)
332 self.send_state(key=name)
332
333
333 def _handle_displayed(self, **kwargs):
334 def _handle_displayed(self, **kwargs):
334 """Called when a view has been displayed for this widget instance"""
335 """Called when a view has been displayed for this widget instance"""
335 self._display_callbacks(self, **kwargs)
336 self._display_callbacks(self, **kwargs)
336
337
337 def _trait_to_json(self, x):
338 def _trait_to_json(self, x):
338 """Convert a trait value to json
339 """Convert a trait value to json
339
340
340 Traverse lists/tuples and dicts and serialize their values as well.
341 Traverse lists/tuples and dicts and serialize their values as well.
341 Replace any widgets with their model_id
342 Replace any widgets with their model_id
342 """
343 """
343 if isinstance(x, dict):
344 if isinstance(x, dict):
344 return {k: self._trait_to_json(v) for k, v in x.items()}
345 return {k: self._trait_to_json(v) for k, v in x.items()}
345 elif isinstance(x, (list, tuple)):
346 elif isinstance(x, (list, tuple)):
346 return [self._trait_to_json(v) for v in x]
347 return [self._trait_to_json(v) for v in x]
347 elif isinstance(x, Widget):
348 elif isinstance(x, Widget):
348 return "IPY_MODEL_" + x.model_id
349 return "IPY_MODEL_" + x.model_id
349 else:
350 else:
350 return x # Value must be JSON-able
351 return x # Value must be JSON-able
351
352
352 def _trait_from_json(self, x):
353 def _trait_from_json(self, x):
353 """Convert json values to objects
354 """Convert json values to objects
354
355
355 Replace any strings representing valid model id values to Widget references.
356 Replace any strings representing valid model id values to Widget references.
356 """
357 """
357 if isinstance(x, dict):
358 if isinstance(x, dict):
358 return {k: self._trait_from_json(v) for k, v in x.items()}
359 return {k: self._trait_from_json(v) for k, v in x.items()}
359 elif isinstance(x, (list, tuple)):
360 elif isinstance(x, (list, tuple)):
360 return [self._trait_from_json(v) for v in x]
361 return [self._trait_from_json(v) for v in x]
361 elif isinstance(x, string_types) and x.startswith('IPY_MODEL_') and x[10:] in Widget.widgets:
362 elif isinstance(x, string_types) and x.startswith('IPY_MODEL_') and x[10:] in Widget.widgets:
362 # we want to support having child widgets at any level in a hierarchy
363 # we want to support having child widgets at any level in a hierarchy
363 # trusting that a widget UUID will not appear out in the wild
364 # trusting that a widget UUID will not appear out in the wild
364 return Widget.widgets[x]
365 return Widget.widgets[x]
365 else:
366 else:
366 return x
367 return x
367
368
368 def _ipython_display_(self, **kwargs):
369 def _ipython_display_(self, **kwargs):
369 """Called when `IPython.display.display` is called on the widget."""
370 """Called when `IPython.display.display` is called on the widget."""
370 # Show view. By sending a display message, the comm is opened and the
371 # Show view. By sending a display message, the comm is opened and the
371 # initial state is sent.
372 # initial state is sent.
372 self._send({"method": "display"})
373 self._send({"method": "display"})
373 self._handle_displayed(**kwargs)
374 self._handle_displayed(**kwargs)
374
375
375 def _send(self, msg):
376 def _send(self, msg):
376 """Sends a message to the model in the front-end."""
377 """Sends a message to the model in the front-end."""
377 self.comm.send(msg)
378 self.comm.send(msg)
378
379
379
380
380 class DOMWidget(Widget):
381 class DOMWidget(Widget):
381 visible = Bool(True, help="Whether the widget is visible.", sync=True)
382 visible = Bool(True, help="Whether the widget is visible.", sync=True)
382 _css = CTuple(sync=True, help="CSS property list: (selector, key, value)")
383 _css = CTuple(sync=True, help="CSS property list: (selector, key, value)")
383 _dom_classes = CTuple(sync=True, help="DOM classes applied to widget.$el.")
384 _dom_classes = CTuple(sync=True, help="DOM classes applied to widget.$el.")
385
386 width = CUnicode(sync=True)
387 height = CUnicode(sync=True)
388
389 fore_color = Unicode(sync=True)
390 back_color = Unicode(sync=True)
391 border_color = Unicode(sync=True)
392
393 border_width = CUnicode(sync=True)
394 border_style = CaselessStrEnum(values=[ # http://www.w3schools.com/cssref/pr_border-style.asp
395 'none',
396 'hidden',
397 'dotted',
398 'dashed',
399 'solid',
400 'double',
401 'groove',
402 'ridge',
403 'inset',
404 'outset',
405 'initial',
406 'inherit', ''],
407 default_value='', sync=True)
408
409 font_style = CaselessStrEnum(values=[ # http://www.w3schools.com/cssref/pr_font_font-style.asp
410 'normal',
411 'italic',
412 'oblique',
413 'initial',
414 'inherit', ''],
415 default_value='', sync=True)
416 font_weight = CaselessStrEnum(values=[ # http://www.w3schools.com/cssref/pr_font_weight.asp
417 'normal',
418 'bold',
419 'bolder',
420 'lighter',
421 'initial',
422 'inherit', ''] + [str(100 * (i+1)) for i in range(9)],
423 default_value='', sync=True)
424 font_size = CUnicode(sync=True)
425 font_family = Unicode(sync=True)
General Comments 0
You need to be logged in to leave comments. Login now