##// END OF EJS Templates
widget changes continued
sylvain.corlay -
Show More
@@ -1,498 +1,496 b''
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; i < new_list.length; i++) {
362 for (i; 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 () {
408 initialize: function () {
409 // Public constructor
409 // Public constructor
410 DOMWidgetView.__super__.initialize.apply(this, arguments);
410 DOMWidgetView.__super__.initialize.apply(this, arguments);
411 this.on('displayed', this.show, this);
411 this.on('displayed', this.show, this);
412
413 this.model.on('msg:custom', this.on_msg, this);
412 this.model.on('msg:custom', this.on_msg, this);
414 this.model.on('change:visible', this.update_visible, this);
413 this.model.on('change:visible', this.update_visible, this);
415 this.model.on('change:_css', this.update_css, this);
414 this.model.on('change:_css', this.update_css, this);
416
417 this.update_visible(this.model, this.model.get("visible"));
415 this.update_visible(this.model, this.model.get("visible"));
418 this.update_css(this.model, this.model.get("_css"));
416 this.update_css(this.model, this.model.get("_css"));
419 },
417 },
420
418
421 on_msg: function(msg) {
419 on_msg: function(msg) {
422 // Handle DOM specific msgs.
420 // Handle DOM specific msgs.
423 switch(msg.msg_type) {
421 switch(msg.msg_type) {
424 case 'add_class':
422 case 'add_class':
425 this.add_class(msg.selector, msg.class_list);
423 this.add_class(msg.selector, msg.class_list);
426 break;
424 break;
427 case 'remove_class':
425 case 'remove_class':
428 this.remove_class(msg.selector, msg.class_list);
426 this.remove_class(msg.selector, msg.class_list);
429 break;
427 break;
430 }
428 }
431 },
429 },
432
430
433 add_class: function (selector, class_list) {
431 add_class: function (selector, class_list) {
434 // Add a DOM class to an element.
432 // Add a DOM class to an element.
435 this._get_selector_element(selector).addClass(class_list);
433 this._get_selector_element(selector).addClass(class_list);
436 },
434 },
437
435
438 remove_class: function (selector, class_list) {
436 remove_class: function (selector, class_list) {
439 // Remove a DOM class from an element.
437 // Remove a DOM class from an element.
440 this._get_selector_element(selector).removeClass(class_list);
438 this._get_selector_element(selector).removeClass(class_list);
441 },
439 },
442
440
443 update_visible: function(model, value) {
441 update_visible: function(model, value) {
444 // Update visibility
442 // Update visibility
445 // The very first update seems to happen before the element is
443 // The very first update seems to happen before the element is
446 // finished rendering so we use setTimeout to give the element time
444 // finished rendering so we use setTimeout to give the element time
447 // to render
445 // to render
448 var e = this.$el;
446 var e = this.$el;
449 setTimeout(function() {e.toggle(value);},0);
447 setTimeout(function() {e.toggle(value);},0);
450 },
448 },
451
449
452 update_css: function (model, css) {
450 update_css: function (model, css) {
453 // Update the contents of this view
451 // Update the css styling of this view.
454 var e = this.$el;
452 var e = this.$el;
455 if (css === undefined) {return;}
453 if (css === undefined) {return;}
456 for (var i = 0; i < css.length; i++) {
454 for (var i = 0; i < css.length; i++) {
457 // Apply the css traits to all elements that match the selector.
455 // Apply the css traits to all elements that match the selector.
458 var selector = css[i][0];
456 var selector = css[i][0];
459 var elements = this._get_selector_element(selector);
457 var elements = this._get_selector_element(selector);
460 if (elements.length > 0) {
458 if (elements.length > 0) {
461 var trait_key = css[i][1];
459 var trait_key = css[i][1];
462 var trait_value = css[i][2];
460 var trait_value = css[i][2];
463 elements.css(trait_key ,trait_value);
461 elements.css(trait_key ,trait_value);
464 }
462 }
465 }
463 }
466 },
464 },
467
465
468 _get_selector_element: function (selector) {
466 _get_selector_element: function (selector) {
469 // Get the elements via the css selector.
467 // Get the elements via the css selector.
470
468
471 // If the selector is blank, apply the style to the $el_to_style
469 // If the selector is blank, apply the style to the $el_to_style
472 // element. If the $el_to_style element is not defined, use apply
470 // element. If the $el_to_style element is not defined, use apply
473 // the style to the view's element.
471 // the style to the view's element.
474 var elements;
472 var elements;
475 if (!selector) {
473 if (!selector) {
476 if (this.$el_to_style === undefined) {
474 if (this.$el_to_style === undefined) {
477 elements = this.$el;
475 elements = this.$el;
478 } else {
476 } else {
479 elements = this.$el_to_style;
477 elements = this.$el_to_style;
480 }
478 }
481 } else {
479 } else {
482 elements = this.$el.find(selector);
480 elements = this.$el.find(selector);
483 }
481 }
484 return elements;
482 return elements;
485 },
483 },
486 });
484 });
487
485
488 var widget = {
486 var widget = {
489 'WidgetModel': WidgetModel,
487 'WidgetModel': WidgetModel,
490 'WidgetView': WidgetView,
488 'WidgetView': WidgetView,
491 'DOMWidgetView': DOMWidgetView,
489 'DOMWidgetView': DOMWidgetView,
492 };
490 };
493
491
494 // For backwards compatability.
492 // For backwards compatability.
495 $.extend(IPython, widget);
493 $.extend(IPython, widget);
496
494
497 return widget;
495 return widget;
498 });
496 });
@@ -1,284 +1,284 b''
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 ContainerView = widget.DOMWidgetView.extend({
10 var ContainerView = widget.DOMWidgetView.extend({
11 initialize: function(){
11 initialize: function(){
12 // Public constructor
12 // Public constructor
13 ContainerView.__super__.initialize.apply(this, arguments);
13 ContainerView.__super__.initialize.apply(this, arguments);
14 this.update_children([], this.model.get('children'));
14 this.update_children([], this.model.get('children'));
15 this.model.on('change:children', function(model, value) {
15 this.model.on('change:children', function(model, value) {
16 this.update_children(model.previous('children'), value);
16 this.update_children(model.previous('children'), value);
17 }, this);
17 }, this);
18 },
18 },
19
19
20 render: function(){
20 render: function(){
21 // Called when view is rendered.
21 // Called when view is rendered.
22 this.$el.addClass('widget-container').addClass('vbox');
22 this.$el.addClass('widget-container').addClass('vbox');
23 },
23 },
24
24
25 update_children: function(old_list, new_list) {
25 update_children: function(old_list, new_list) {
26 // Called when the children list changes.
26 // Called when the children list changes.
27 this.do_diff(old_list, new_list,
27 this.do_diff(old_list, new_list,
28 $.proxy(this.remove_child_model, this),
28 $.proxy(this.remove_child_model, this),
29 $.proxy(this.add_child_model, this));
29 $.proxy(this.add_child_model, this));
30 },
30 },
31
31
32 remove_child_model: function(model) {
32 remove_child_model: function(model) {
33 // Called when a model is removed from the children list.
33 // Called when a model is removed from the children list.
34 this.pop_child_view(model).remove();
34 this.pop_child_view(model).remove();
35 },
35 },
36
36
37 add_child_model: function(model) {
37 add_child_model: function(model) {
38 // Called when a model is added to the children list.
38 // Called when a model is added to the children list.
39 var view = this.create_child_view(model);
39 var view = this.create_child_view(model);
40 this.$el.append(view.$el);
40 this.$el.append(view.$el);
41
41
42 // Trigger the displayed event once this view is displayed.
42 // Trigger the displayed event of the child view.
43 this.after_displayed(function() {
43 this.after_displayed(function() {
44 view.trigger('displayed');
44 view.trigger('displayed');
45 });
45 });
46 },
46 },
47 });
47 });
48
48
49
49
50 var PopupView = widget.DOMWidgetView.extend({
50 var PopupView = widget.DOMWidgetView.extend({
51 render: function(){
51 render: function(){
52 // Called when view is rendered.
52 // Called when view is rendered.
53 var that = this;
53 var that = this;
54
54
55 this.$el.on("remove", function(){
55 this.$el.on("remove", function(){
56 that.$backdrop.remove();
56 that.$backdrop.remove();
57 });
57 });
58 this.$backdrop = $('<div />')
58 this.$backdrop = $('<div />')
59 .appendTo($('#notebook-container'))
59 .appendTo($('#notebook-container'))
60 .addClass('modal-dialog')
60 .addClass('modal-dialog')
61 .css('position', 'absolute')
61 .css('position', 'absolute')
62 .css('left', '0px')
62 .css('left', '0px')
63 .css('top', '0px');
63 .css('top', '0px');
64 this.$window = $('<div />')
64 this.$window = $('<div />')
65 .appendTo(this.$backdrop)
65 .appendTo(this.$backdrop)
66 .addClass('modal-content widget-modal')
66 .addClass('modal-content widget-modal')
67 .mousedown(function(){
67 .mousedown(function(){
68 that.bring_to_front();
68 that.bring_to_front();
69 });
69 });
70
70
71 // Set the elements array since the this.$window element is not child
71 // Set the elements array since the this.$window element is not child
72 // of this.$el and the parent widget manager or other widgets may
72 // of this.$el and the parent widget manager or other widgets may
73 // need to know about all of the top-level widgets. The IPython
73 // need to know about all of the top-level widgets. The IPython
74 // widget manager uses this to register the elements with the
74 // widget manager uses this to register the elements with the
75 // keyboard manager.
75 // keyboard manager.
76 this.additional_elements = [this.$window];
76 this.additional_elements = [this.$window];
77
77
78 this.$title_bar = $('<div />')
78 this.$title_bar = $('<div />')
79 .addClass('popover-title')
79 .addClass('popover-title')
80 .appendTo(this.$window)
80 .appendTo(this.$window)
81 .mousedown(function(){
81 .mousedown(function(){
82 that.bring_to_front();
82 that.bring_to_front();
83 });
83 });
84 this.$close = $('<button />')
84 this.$close = $('<button />')
85 .addClass('close icon-remove')
85 .addClass('close icon-remove')
86 .css('margin-left', '5px')
86 .css('margin-left', '5px')
87 .appendTo(this.$title_bar)
87 .appendTo(this.$title_bar)
88 .click(function(){
88 .click(function(){
89 that.hide();
89 that.hide();
90 event.stopPropagation();
90 event.stopPropagation();
91 });
91 });
92 this.$minimize = $('<button />')
92 this.$minimize = $('<button />')
93 .addClass('close icon-arrow-down')
93 .addClass('close icon-arrow-down')
94 .appendTo(this.$title_bar)
94 .appendTo(this.$title_bar)
95 .click(function(){
95 .click(function(){
96 that.popped_out = !that.popped_out;
96 that.popped_out = !that.popped_out;
97 if (!that.popped_out) {
97 if (!that.popped_out) {
98 that.$minimize
98 that.$minimize
99 .removeClass('icon-arrow-down')
99 .removeClass('icon-arrow-down')
100 .addClass('icon-arrow-up');
100 .addClass('icon-arrow-up');
101
101
102 that.$window
102 that.$window
103 .draggable('destroy')
103 .draggable('destroy')
104 .resizable('destroy')
104 .resizable('destroy')
105 .removeClass('widget-modal modal-content')
105 .removeClass('widget-modal modal-content')
106 .addClass('docked-widget-modal')
106 .addClass('docked-widget-modal')
107 .detach()
107 .detach()
108 .insertBefore(that.$show_button);
108 .insertBefore(that.$show_button);
109 that.$show_button.hide();
109 that.$show_button.hide();
110 that.$close.hide();
110 that.$close.hide();
111 } else {
111 } else {
112 that.$minimize
112 that.$minimize
113 .addClass('icon-arrow-down')
113 .addClass('icon-arrow-down')
114 .removeClass('icon-arrow-up');
114 .removeClass('icon-arrow-up');
115
115
116 that.$window
116 that.$window
117 .removeClass('docked-widget-modal')
117 .removeClass('docked-widget-modal')
118 .addClass('widget-modal modal-content')
118 .addClass('widget-modal modal-content')
119 .detach()
119 .detach()
120 .appendTo(that.$backdrop)
120 .appendTo(that.$backdrop)
121 .draggable({handle: '.popover-title', snap: '#notebook, .modal', snapMode: 'both'})
121 .draggable({handle: '.popover-title', snap: '#notebook, .modal', snapMode: 'both'})
122 .resizable()
122 .resizable()
123 .children('.ui-resizable-handle').show();
123 .children('.ui-resizable-handle').show();
124 that.show();
124 that.show();
125 that.$show_button.show();
125 that.$show_button.show();
126 that.$close.show();
126 that.$close.show();
127 }
127 }
128 event.stopPropagation();
128 event.stopPropagation();
129 });
129 });
130 this.$title = $('<div />')
130 this.$title = $('<div />')
131 .addClass('widget-modal-title')
131 .addClass('widget-modal-title')
132 .html("&nbsp;")
132 .html("&nbsp;")
133 .appendTo(this.$title_bar);
133 .appendTo(this.$title_bar);
134 this.$body = $('<div />')
134 this.$body = $('<div />')
135 .addClass('modal-body')
135 .addClass('modal-body')
136 .addClass('widget-modal-body')
136 .addClass('widget-modal-body')
137 .addClass('widget-container')
137 .addClass('widget-container')
138 .addClass('vbox')
138 .addClass('vbox')
139 .appendTo(this.$window);
139 .appendTo(this.$window);
140
140
141 this.$show_button = $('<button />')
141 this.$show_button = $('<button />')
142 .html("&nbsp;")
142 .html("&nbsp;")
143 .addClass('btn btn-info widget-modal-show')
143 .addClass('btn btn-info widget-modal-show')
144 .appendTo(this.$el)
144 .appendTo(this.$el)
145 .click(function(){
145 .click(function(){
146 that.show();
146 that.show();
147 });
147 });
148
148
149 this.$window.draggable({handle: '.popover-title', snap: '#notebook, .modal', snapMode: 'both'});
149 this.$window.draggable({handle: '.popover-title', snap: '#notebook, .modal', snapMode: 'both'});
150 this.$window.resizable();
150 this.$window.resizable();
151 this.$window.on('resize', function(){
151 this.$window.on('resize', function(){
152 that.$body.outerHeight(that.$window.innerHeight() - that.$title_bar.outerHeight());
152 that.$body.outerHeight(that.$window.innerHeight() - that.$title_bar.outerHeight());
153 });
153 });
154
154
155 this.$el_to_style = this.$body;
155 this.$el_to_style = this.$body;
156 this._shown_once = false;
156 this._shown_once = false;
157 this.popped_out = true;
157 this.popped_out = true;
158
158
159 this.update_children([], this.model.get('children'));
159 this.update_children([], this.model.get('children'));
160 this.model.on('change:children', function(model, value) {
160 this.model.on('change:children', function(model, value) {
161 this.update_children(model.previous('children'), value);
161 this.update_children(model.previous('children'), value);
162 }, this);
162 }, this);
163 },
163 },
164
164
165 hide: function() {
165 hide: function() {
166 // Called when the modal hide button is clicked.
166 // Called when the modal hide button is clicked.
167 this.$window.hide();
167 this.$window.hide();
168 this.$show_button.removeClass('btn-info');
168 this.$show_button.removeClass('btn-info');
169 },
169 },
170
170
171 show: function() {
171 show: function() {
172 // Called when the modal show button is clicked.
172 // Called when the modal show button is clicked.
173 this.$show_button.addClass('btn-info');
173 this.$show_button.addClass('btn-info');
174 this.$window.show();
174 this.$window.show();
175 if (this.popped_out) {
175 if (this.popped_out) {
176 this.$window.css("positon", "absolute");
176 this.$window.css("positon", "absolute");
177 this.$window.css("top", "0px");
177 this.$window.css("top", "0px");
178 this.$window.css("left", Math.max(0, (($('body').outerWidth() - this.$window.outerWidth()) / 2) +
178 this.$window.css("left", Math.max(0, (($('body').outerWidth() - this.$window.outerWidth()) / 2) +
179 $(window).scrollLeft()) + "px");
179 $(window).scrollLeft()) + "px");
180 this.bring_to_front();
180 this.bring_to_front();
181 }
181 }
182 },
182 },
183
183
184 bring_to_front: function() {
184 bring_to_front: function() {
185 // Make the modal top-most, z-ordered about the other modals.
185 // Make the modal top-most, z-ordered about the other modals.
186 var $widget_modals = $(".widget-modal");
186 var $widget_modals = $(".widget-modal");
187 var max_zindex = 0;
187 var max_zindex = 0;
188 $widget_modals.each(function (index, el){
188 $widget_modals.each(function (index, el){
189 var zindex = parseInt($(el).css('z-index'));
189 var zindex = parseInt($(el).css('z-index'));
190 if (!isNaN(zindex)) {
190 if (!isNaN(zindex)) {
191 max_zindex = Math.max(max_zindex, zindex);
191 max_zindex = Math.max(max_zindex, zindex);
192 }
192 }
193 });
193 });
194
194
195 // Start z-index of widget modals at 2000
195 // Start z-index of widget modals at 2000
196 max_zindex = Math.max(max_zindex, 2000);
196 max_zindex = Math.max(max_zindex, 2000);
197
197
198 $widget_modals.each(function (index, el){
198 $widget_modals.each(function (index, el){
199 $el = $(el);
199 $el = $(el);
200 if (max_zindex == parseInt($el.css('z-index'))) {
200 if (max_zindex == parseInt($el.css('z-index'))) {
201 $el.css('z-index', max_zindex - 1);
201 $el.css('z-index', max_zindex - 1);
202 }
202 }
203 });
203 });
204 this.$window.css('z-index', max_zindex);
204 this.$window.css('z-index', max_zindex);
205 },
205 },
206
206
207 update_children: function(old_list, new_list) {
207 update_children: function(old_list, new_list) {
208 // Called when the children list is modified.
208 // Called when the children list is modified.
209 this.do_diff(old_list, new_list,
209 this.do_diff(old_list, new_list,
210 $.proxy(this.remove_child_model, this),
210 $.proxy(this.remove_child_model, this),
211 $.proxy(this.add_child_model, this));
211 $.proxy(this.add_child_model, this));
212 },
212 },
213
213
214 remove_child_model: function(model) {
214 remove_child_model: function(model) {
215 // Called when a child is removed from children list.
215 // Called when a child is removed from children list.
216 this.pop_child_view(model).remove();
216 this.pop_child_view(model).remove();
217 },
217 },
218
218
219 add_child_model: function(model) {
219 add_child_model: function(model) {
220 // Called when a child is added to children list.
220 // Called when a child is added to children list.
221 var view = this.create_child_view(model);
221 var view = this.create_child_view(model);
222 this.$body.append(view.$el);
222 this.$body.append(view.$el);
223
223
224 // Trigger the displayed event once this view is displayed.
224 // Trigger the displayed event of the child view.
225 this.after_displayed(function() {
225 this.after_displayed(function() {
226 view.trigger('displayed');
226 view.trigger('displayed');
227 });
227 });
228 },
228 },
229
229
230 update: function(){
230 update: function(){
231 // Update the contents of this view
231 // Update the contents of this view
232 //
232 //
233 // Called when the model is changed. The model may have been
233 // Called when the model is changed. The model may have been
234 // changed by another view or by a state update from the back-end.
234 // changed by another view or by a state update from the back-end.
235 var description = this.model.get('description');
235 var description = this.model.get('description');
236 if (description.trim().length === 0) {
236 if (description.trim().length === 0) {
237 this.$title.html("&nbsp;"); // Preserve title height
237 this.$title.html("&nbsp;"); // Preserve title height
238 } else {
238 } else {
239 this.$title.text(description);
239 this.$title.text(description);
240 MathJax.Hub.Queue(["Typeset",MathJax.Hub,this.$title.get(0)]);
240 MathJax.Hub.Queue(["Typeset",MathJax.Hub,this.$title.get(0)]);
241 }
241 }
242
242
243 var button_text = this.model.get('button_text');
243 var button_text = this.model.get('button_text');
244 if (button_text.trim().length === 0) {
244 if (button_text.trim().length === 0) {
245 this.$show_button.html("&nbsp;"); // Preserve button height
245 this.$show_button.html("&nbsp;"); // Preserve button height
246 } else {
246 } else {
247 this.$show_button.text(button_text);
247 this.$show_button.text(button_text);
248 }
248 }
249
249
250 if (!this._shown_once) {
250 if (!this._shown_once) {
251 this._shown_once = true;
251 this._shown_once = true;
252 this.show();
252 this.show();
253 }
253 }
254
254
255 return PopupView.__super__.update.apply(this);
255 return PopupView.__super__.update.apply(this);
256 },
256 },
257
257
258 _get_selector_element: function(selector) {
258 _get_selector_element: function(selector) {
259 // Get an element view a 'special' jquery selector. (see widget.js)
259 // Get an element view a 'special' jquery selector. (see widget.js)
260 //
260 //
261 // Since the modal actually isn't within the $el in the DOM, we need to extend
261 // Since the modal actually isn't within the $el in the DOM, we need to extend
262 // the selector logic to allow the user to set css on the modal if need be.
262 // the selector logic to allow the user to set css on the modal if need be.
263 // The convention used is:
263 // The convention used is:
264 // "modal" - select the modal div
264 // "modal" - select the modal div
265 // "modal [selector]" - select element(s) within the modal div.
265 // "modal [selector]" - select element(s) within the modal div.
266 // "[selector]" - select elements within $el
266 // "[selector]" - select elements within $el
267 // "" - select the $el_to_style
267 // "" - select the $el_to_style
268 if (selector.substring(0, 5) == 'modal') {
268 if (selector.substring(0, 5) == 'modal') {
269 if (selector == 'modal') {
269 if (selector == 'modal') {
270 return this.$window;
270 return this.$window;
271 } else {
271 } else {
272 return this.$window.find(selector.substring(6));
272 return this.$window.find(selector.substring(6));
273 }
273 }
274 } else {
274 } else {
275 return PopupView.__super__._get_selector_element.apply(this, [selector]);
275 return PopupView.__super__._get_selector_element.apply(this, [selector]);
276 }
276 }
277 },
277 },
278 });
278 });
279
279
280 return {
280 return {
281 'ContainerView': ContainerView,
281 'ContainerView': ContainerView,
282 'PopupView': PopupView,
282 'PopupView': PopupView,
283 };
283 };
284 });
284 });
@@ -1,267 +1,248 b''
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 "base/js/utils",
6 "base/js/utils",
7 "jquery",
7 "jquery",
8 "bootstrap",
8 "bootstrap",
9 ], function(widget, utils, $){
9 ], function(widget, utils, $){
10
10
11 var AccordionView = widget.DOMWidgetView.extend({
11 var AccordionView = widget.DOMWidgetView.extend({
12 render: function(){
12 render: function(){
13 // Called when view is rendered.
13 // Called when view is rendered.
14 var guid = 'panel-group' + utils.uuid();
14 var guid = 'panel-group' + utils.uuid();
15 this.$el
15 this.$el
16 .attr('id', guid)
16 .attr('id', guid)
17 .addClass('panel-group');
17 .addClass('panel-group');
18 this.containers = [];
18 this.containers = [];
19 this.model_containers = {};
19 this.model_containers = {};
20 this.update_children([], this.model.get('children'));
20 this.update_children([], this.model.get('children'));
21 this.model.on('change:children', function(model, value, options) {
21 this.model.on('change:children', function(model, value, options) {
22 this.update_children(model.previous('children'), value);
22 this.update_children(model.previous('children'), value);
23 }, this);
23 }, this);
24 this.model.on('change:selected_index', function(model, value, options) {
24 this.model.on('change:selected_index', function(model, value, options) {
25 this.update_selected_index(model.previous('selected_index'), value, options);
25 this.update_selected_index(model.previous('selected_index'), value, options);
26 }, this);
26 }, this);
27 this.model.on('change:_titles', function(model, value, options) {
27 this.model.on('change:_titles', function(model, value, options) {
28 this.update_titles(value);
28 this.update_titles(value);
29 }, this);
29 }, this);
30 var that = this;
30 var that = this;
31 this.on('displayed', function() {
31 this.on('displayed', function() {
32 this.update_titles();
32 this.update_titles();
33 // Trigger model displayed events for any models that are child to
33 }
34 // this model when this model is displayed.
35 that.is_displayed = true;
36 for (var property in that.child_views) {
37 if (that.child_views.hasOwnProperty(property)) {
38 that.child_views[property].trigger('displayed');
39 }
40 }
41 }, this);
42 },
34 },
43
35
44 update_titles: function(titles) {
36 update_titles: function(titles) {
45 // Set tab titles
37 // Set tab titles
46 if (!titles) {
38 if (!titles) {
47 titles = this.model.get('_titles');
39 titles = this.model.get('_titles');
48 }
40 }
49
41
50 var that = this;
42 var that = this;
51 _.each(titles, function(title, page_index) {
43 _.each(titles, function(title, page_index) {
52 var accordian = that.containers[page_index];
44 var accordian = that.containers[page_index];
53 if (accordian !== undefined) {
45 if (accordian !== undefined) {
54 accordian
46 accordian
55 .find('.panel-heading')
47 .find('.panel-heading')
56 .find('.accordion-toggle')
48 .find('.accordion-toggle')
57 .text(title);
49 .text(title);
58 }
50 }
59 });
51 });
60 },
52 },
61
53
62 update_selected_index: function(old_index, new_index, options) {
54 update_selected_index: function(old_index, new_index, options) {
63 // Only update the selection if the selection wasn't triggered
55 // Only update the selection if the selection wasn't triggered
64 // by the front-end. It must be triggered by the back-end.
56 // by the front-end. It must be triggered by the back-end.
65 if (options === undefined || options.updated_view != this) {
57 if (options === undefined || options.updated_view != this) {
66 this.containers[old_index].find('.panel-collapse').collapse('hide');
58 this.containers[old_index].find('.panel-collapse').collapse('hide');
67 if (0 <= new_index && new_index < this.containers.length) {
59 if (0 <= new_index && new_index < this.containers.length) {
68 this.containers[new_index].find('.panel-collapse').collapse('show');
60 this.containers[new_index].find('.panel-collapse').collapse('show');
69 }
61 }
70 }
62 }
71 },
63 },
72
64
73 update_children: function(old_list, new_list) {
65 update_children: function(old_list, new_list) {
74 // Called when the children list is modified.
66 // Called when the children list is modified.
75 this.do_diff(old_list,
67 this.do_diff(old_list,
76 new_list,
68 new_list,
77 $.proxy(this.remove_child_model, this),
69 $.proxy(this.remove_child_model, this),
78 $.proxy(this.add_child_model, this));
70 $.proxy(this.add_child_model, this));
79 },
71 },
80
72
81 remove_child_model: function(model) {
73 remove_child_model: function(model) {
82 // Called when a child is removed from children list.
74 // Called when a child is removed from children list.
83 var accordion_group = this.model_containers[model.id];
75 var accordion_group = this.model_containers[model.id];
84 this.containers.splice(accordion_group.container_index, 1);
76 this.containers.splice(accordion_group.container_index, 1);
85 delete this.model_containers[model.id];
77 delete this.model_containers[model.id];
86 accordion_group.remove();
78 accordion_group.remove();
87 this.pop_child_view(model);
79 this.pop_child_view(model);
88 },
80 },
89
81
90 add_child_model: function(model) {
82 add_child_model: function(model) {
91 // Called when a child is added to children list.
83 // Called when a child is added to children list.
92 var view = this.create_child_view(model);
84 var view = this.create_child_view(model);
93 var index = this.containers.length;
85 var index = this.containers.length;
94 var uuid = utils.uuid();
86 var uuid = utils.uuid();
95 var accordion_group = $('<div />')
87 var accordion_group = $('<div />')
96 .addClass('panel panel-default')
88 .addClass('panel panel-default')
97 .appendTo(this.$el);
89 .appendTo(this.$el);
98 var accordion_heading = $('<div />')
90 var accordion_heading = $('<div />')
99 .addClass('panel-heading')
91 .addClass('panel-heading')
100 .appendTo(accordion_group);
92 .appendTo(accordion_group);
101 var that = this;
93 var that = this;
102 var accordion_toggle = $('<a />')
94 var accordion_toggle = $('<a />')
103 .addClass('accordion-toggle')
95 .addClass('accordion-toggle')
104 .attr('data-toggle', 'collapse')
96 .attr('data-toggle', 'collapse')
105 .attr('data-parent', '#' + this.$el.attr('id'))
97 .attr('data-parent', '#' + this.$el.attr('id'))
106 .attr('href', '#' + uuid)
98 .attr('href', '#' + uuid)
107 .click(function(evt){
99 .click(function(evt){
108
100
109 // Calling model.set will trigger all of the other views of the
101 // Calling model.set will trigger all of the other views of the
110 // model to update.
102 // model to update.
111 that.model.set("selected_index", index, {updated_view: that});
103 that.model.set("selected_index", index, {updated_view: that});
112 that.touch();
104 that.touch();
113 })
105 })
114 .text('Page ' + index)
106 .text('Page ' + index)
115 .appendTo(accordion_heading);
107 .appendTo(accordion_heading);
116 var accordion_body = $('<div />', {id: uuid})
108 var accordion_body = $('<div />', {id: uuid})
117 .addClass('panel-collapse collapse')
109 .addClass('panel-collapse collapse')
118 .appendTo(accordion_group);
110 .appendTo(accordion_group);
119 var accordion_inner = $('<div />')
111 var accordion_inner = $('<div />')
120 .addClass('panel-body')
112 .addClass('panel-body')
121 .appendTo(accordion_body);
113 .appendTo(accordion_body);
122 var container_index = this.containers.push(accordion_group) - 1;
114 var container_index = this.containers.push(accordion_group) - 1;
123 accordion_group.container_index = container_index;
115 accordion_group.container_index = container_index;
124 this.model_containers[model.id] = accordion_group;
116 this.model_containers[model.id] = accordion_group;
125 accordion_inner.append(view.$el);
117 accordion_inner.append(view.$el);
126
118
127 this.update();
119 this.update();
128 this.update_titles();
120 this.update_titles();
129
121
130 // Trigger the displayed event if this model is displayed.
122 // Trigger the displayed event of the child view.
131 if (this.is_displayed) {
123 this.after_displayed(function() {
132 view.trigger('displayed');
124 view.trigger('displayed');
133 }
125 });
134 },
126 },
135 });
127 });
136
128
137
129
138 var TabView = widget.DOMWidgetView.extend({
130 var TabView = widget.DOMWidgetView.extend({
139 initialize: function() {
131 initialize: function() {
140 // Public constructor.
132 // Public constructor.
141 this.containers = [];
133 this.containers = [];
142 TabView.__super__.initialize.apply(this, arguments);
134 TabView.__super__.initialize.apply(this, arguments);
143 },
135 },
144
136
145 render: function(){
137 render: function(){
146 // Called when view is rendered.
138 // Called when view is rendered.
147 var uuid = 'tabs'+utils.uuid();
139 var uuid = 'tabs'+utils.uuid();
148 var that = this;
140 var that = this;
149 this.$tabs = $('<div />', {id: uuid})
141 this.$tabs = $('<div />', {id: uuid})
150 .addClass('nav')
142 .addClass('nav')
151 .addClass('nav-tabs')
143 .addClass('nav-tabs')
152 .appendTo(this.$el);
144 .appendTo(this.$el);
153 this.$tab_contents = $('<div />', {id: uuid + 'Content'})
145 this.$tab_contents = $('<div />', {id: uuid + 'Content'})
154 .addClass('tab-content')
146 .addClass('tab-content')
155 .appendTo(this.$el);
147 .appendTo(this.$el);
156 this.containers = [];
148 this.containers = [];
157 this.update_children([], this.model.get('children'));
149 this.update_children([], this.model.get('children'));
158 this.model.on('change:children', function(model, value, options) {
150 this.model.on('change:children', function(model, value, options) {
159 this.update_children(model.previous('children'), value);
151 this.update_children(model.previous('children'), value);
160 }, this);
152 }, this);
161
162 // Trigger model displayed events for any models that are child to
163 // this model when this model is displayed.
164 this.on('displayed', function(){
165 that.is_displayed = true;
166 for (var property in that.child_views) {
167 if (that.child_views.hasOwnProperty(property)) {
168 that.child_views[property].trigger('displayed');
169 }
170 }
171 });
172 },
153 },
173
154
174 update_children: function(old_list, new_list) {
155 update_children: function(old_list, new_list) {
175 // Called when the children list is modified.
156 // Called when the children list is modified.
176 this.do_diff(old_list,
157 this.do_diff(old_list,
177 new_list,
158 new_list,
178 $.proxy(this.remove_child_model, this),
159 $.proxy(this.remove_child_model, this),
179 $.proxy(this.add_child_model, this));
160 $.proxy(this.add_child_model, this));
180 },
161 },
181
162
182 remove_child_model: function(model) {
163 remove_child_model: function(model) {
183 // Called when a child is removed from children list.
164 // Called when a child is removed from children list.
184 var view = this.pop_child_view(model);
165 var view = this.pop_child_view(model);
185 this.containers.splice(view.parent_tab.tab_text_index, 1);
166 this.containers.splice(view.parent_tab.tab_text_index, 1);
186 view.parent_tab.remove();
167 view.parent_tab.remove();
187 view.parent_container.remove();
168 view.parent_container.remove();
188 view.remove();
169 view.remove();
189 },
170 },
190
171
191 add_child_model: function(model) {
172 add_child_model: function(model) {
192 // Called when a child is added to children list.
173 // Called when a child is added to children list.
193 var view = this.create_child_view(model);
174 var view = this.create_child_view(model);
194 var index = this.containers.length;
175 var index = this.containers.length;
195 var uuid = utils.uuid();
176 var uuid = utils.uuid();
196
177
197 var that = this;
178 var that = this;
198 var tab = $('<li />')
179 var tab = $('<li />')
199 .css('list-style-type', 'none')
180 .css('list-style-type', 'none')
200 .appendTo(this.$tabs);
181 .appendTo(this.$tabs);
201 view.parent_tab = tab;
182 view.parent_tab = tab;
202
183
203 var tab_text = $('<a />')
184 var tab_text = $('<a />')
204 .attr('href', '#' + uuid)
185 .attr('href', '#' + uuid)
205 .attr('data-toggle', 'tab')
186 .attr('data-toggle', 'tab')
206 .text('Page ' + index)
187 .text('Page ' + index)
207 .appendTo(tab)
188 .appendTo(tab)
208 .click(function (e) {
189 .click(function (e) {
209
190
210 // Calling model.set will trigger all of the other views of the
191 // Calling model.set will trigger all of the other views of the
211 // model to update.
192 // model to update.
212 that.model.set("selected_index", index, {updated_view: this});
193 that.model.set("selected_index", index, {updated_view: this});
213 that.touch();
194 that.touch();
214 that.select_page(index);
195 that.select_page(index);
215 });
196 });
216 tab.tab_text_index = this.containers.push(tab_text) - 1;
197 tab.tab_text_index = this.containers.push(tab_text) - 1;
217
198
218 var contents_div = $('<div />', {id: uuid})
199 var contents_div = $('<div />', {id: uuid})
219 .addClass('tab-pane')
200 .addClass('tab-pane')
220 .addClass('fade')
201 .addClass('fade')
221 .append(view.$el)
202 .append(view.$el)
222 .appendTo(this.$tab_contents);
203 .appendTo(this.$tab_contents);
223 view.parent_container = contents_div;
204 view.parent_container = contents_div;
224
205
225 // Trigger the displayed event if this model is displayed.
206 // Trigger the displayed event of the child view.
226 if (this.is_displayed) {
207 this.after_displayed(function() {
227 view.trigger('displayed');
208 view.trigger('displayed');
228 }
209 });
229 },
210 },
230
211
231 update: function(options) {
212 update: function(options) {
232 // Update the contents of this view
213 // Update the contents of this view
233 //
214 //
234 // Called when the model is changed. The model may have been
215 // Called when the model is changed. The model may have been
235 // changed by another view or by a state update from the back-end.
216 // changed by another view or by a state update from the back-end.
236 if (options === undefined || options.updated_view != this) {
217 if (options === undefined || options.updated_view != this) {
237 // Set tab titles
218 // Set tab titles
238 var titles = this.model.get('_titles');
219 var titles = this.model.get('_titles');
239 var that = this;
220 var that = this;
240 _.each(titles, function(title, page_index) {
221 _.each(titles, function(title, page_index) {
241 var tab_text = that.containers[page_index];
222 var tab_text = that.containers[page_index];
242 if (tab_text !== undefined) {
223 if (tab_text !== undefined) {
243 tab_text.text(title);
224 tab_text.text(title);
244 }
225 }
245 });
226 });
246
227
247 var selected_index = this.model.get('selected_index');
228 var selected_index = this.model.get('selected_index');
248 if (0 <= selected_index && selected_index < this.containers.length) {
229 if (0 <= selected_index && selected_index < this.containers.length) {
249 this.select_page(selected_index);
230 this.select_page(selected_index);
250 }
231 }
251 }
232 }
252 return TabView.__super__.update.apply(this);
233 return TabView.__super__.update.apply(this);
253 },
234 },
254
235
255 select_page: function(index) {
236 select_page: function(index) {
256 // Select a page.
237 // Select a page.
257 this.$tabs.find('li')
238 this.$tabs.find('li')
258 .removeClass('active');
239 .removeClass('active');
259 this.containers[index].tab('show');
240 this.containers[index].tab('show');
260 },
241 },
261 });
242 });
262
243
263 return {
244 return {
264 'AccordionView': AccordionView,
245 'AccordionView': AccordionView,
265 'TabView': TabView,
246 'TabView': TabView,
266 };
247 };
267 });
248 });
General Comments 0
You need to be logged in to leave comments. Login now