Show More
@@ -0,0 +1,312 b'' | |||
|
1 | //---------------------------------------------------------------------------- | |
|
2 | // Copyright (C) 2013 The IPython Development Team | |
|
3 | // | |
|
4 | // Distributed under the terms of the BSD License. The full license is in | |
|
5 | // the file COPYING, distributed as part of this software. | |
|
6 | //---------------------------------------------------------------------------- | |
|
7 | ||
|
8 | //============================================================================ | |
|
9 | // Base Widget Model and View classes | |
|
10 | //============================================================================ | |
|
11 | ||
|
12 | /** | |
|
13 | * @module IPython | |
|
14 | * @namespace IPython | |
|
15 | **/ | |
|
16 | ||
|
17 | define(["notebook/js/widgetmanager", | |
|
18 | "underscore", | |
|
19 | "backbone"], | |
|
20 | function(widget_manager, underscore, backbone){ | |
|
21 | ||
|
22 | //-------------------------------------------------------------------- | |
|
23 | // WidgetModel class | |
|
24 | //-------------------------------------------------------------------- | |
|
25 | var WidgetModel = Backbone.Model.extend({ | |
|
26 | constructor: function (widget_manager, model_id, comm) { | |
|
27 | this.widget_manager = widget_manager; | |
|
28 | this.pending_msgs = 0; | |
|
29 | this.msg_throttle = 3; | |
|
30 | this.msg_buffer = null; | |
|
31 | this.id = model_id; | |
|
32 | this.views = []; | |
|
33 | ||
|
34 | if (comm !== undefined) { | |
|
35 | // Remember comm associated with the model. | |
|
36 | this.comm = comm; | |
|
37 | comm.model = this; | |
|
38 | ||
|
39 | // Hook comm messages up to model. | |
|
40 | comm.on_close($.proxy(this._handle_comm_closed, this)); | |
|
41 | comm.on_msg($.proxy(this._handle_comm_msg, this)); | |
|
42 | } | |
|
43 | return Backbone.Model.apply(this); | |
|
44 | }, | |
|
45 | ||
|
46 | send: function (content, callbacks) { | |
|
47 | if (this.comm !== undefined) { | |
|
48 | var data = {method: 'custom', custom_content: content}; | |
|
49 | this.comm.send(data, callbacks); | |
|
50 | } | |
|
51 | }, | |
|
52 | ||
|
53 | // Handle when a widget is closed. | |
|
54 | _handle_comm_closed: function (msg) { | |
|
55 | this.trigger('comm:close'); | |
|
56 | delete this.comm.model; // Delete ref so GC will collect widget model. | |
|
57 | delete this.comm; | |
|
58 | delete this.model_id; // Delete id from model so widget manager cleans up. | |
|
59 | // TODO: Handle deletion, like this.destroy(), and delete views, etc. | |
|
60 | }, | |
|
61 | ||
|
62 | ||
|
63 | // Handle incoming comm msg. | |
|
64 | _handle_comm_msg: function (msg) { | |
|
65 | var method = msg.content.data.method; | |
|
66 | switch (method) { | |
|
67 | case 'update': | |
|
68 | this.apply_update(msg.content.data.state); | |
|
69 | break; | |
|
70 | case 'custom': | |
|
71 | this.trigger('msg:custom', msg.content.data.custom_content); | |
|
72 | break; | |
|
73 | default: | |
|
74 | // pass on to widget manager | |
|
75 | this.widget_manager.handle_msg(msg, this); | |
|
76 | } | |
|
77 | }, | |
|
78 | ||
|
79 | ||
|
80 | // Handle when a widget is updated via the python side. | |
|
81 | apply_update: function (state) { | |
|
82 | this.updating = true; | |
|
83 | try { | |
|
84 | for (var key in state) { | |
|
85 | if (state.hasOwnProperty(key)) { | |
|
86 | this.set(key, state[key]); | |
|
87 | } | |
|
88 | } | |
|
89 | //TODO: are there callbacks that make sense in this case? If so, attach them here as an option | |
|
90 | this.save(); | |
|
91 | } finally { | |
|
92 | this.updating = false; | |
|
93 | } | |
|
94 | }, | |
|
95 | ||
|
96 | ||
|
97 | _handle_status: function (msg, callbacks) { | |
|
98 | //execution_state : ('busy', 'idle', 'starting') | |
|
99 | if (this.comm !== undefined && msg.content.execution_state ==='idle') { | |
|
100 | // Send buffer if this message caused another message to be | |
|
101 | // throttled. | |
|
102 | if (this.msg_buffer !== null && | |
|
103 | this.msg_throttle === this.pending_msgs) { | |
|
104 | var data = {method: 'backbone', sync_method: 'update', sync_data: this.msg_buffer}; | |
|
105 | this.comm.send(data, callbacks); | |
|
106 | this.msg_buffer = null; | |
|
107 | } else { | |
|
108 | // Only decrease the pending message count if the buffer | |
|
109 | // doesn't get flushed (sent). | |
|
110 | --this.pending_msgs; | |
|
111 | } | |
|
112 | } | |
|
113 | }, | |
|
114 | ||
|
115 | ||
|
116 | // Custom syncronization logic. | |
|
117 | _handle_sync: function (method, options) { | |
|
118 | var model_json = this.toJSON(); | |
|
119 | var attr; | |
|
120 | ||
|
121 | // Only send updated state if the state hasn't been changed | |
|
122 | // during an update. | |
|
123 | if (this.comm !== undefined) { | |
|
124 | if (!this.updating) { | |
|
125 | if (this.pending_msgs >= this.msg_throttle) { | |
|
126 | // The throttle has been exceeded, buffer the current msg so | |
|
127 | // it can be sent once the kernel has finished processing | |
|
128 | // some of the existing messages. | |
|
129 | if (method=='patch') { | |
|
130 | if (this.msg_buffer === null) { | |
|
131 | this.msg_buffer = $.extend({}, model_json); // Copy | |
|
132 | } | |
|
133 | for (attr in options.attrs) { | |
|
134 | this.msg_buffer[attr] = options.attrs[attr]; | |
|
135 | } | |
|
136 | } else { | |
|
137 | this.msg_buffer = $.extend({}, model_json); // Copy | |
|
138 | } | |
|
139 | ||
|
140 | } else { | |
|
141 | // We haven't exceeded the throttle, send the message like | |
|
142 | // normal. If this is a patch operation, just send the | |
|
143 | // changes. | |
|
144 | var send_json = model_json; | |
|
145 | if (method =='patch') { | |
|
146 | send_json = {}; | |
|
147 | for (attr in options.attrs) { | |
|
148 | send_json[attr] = options.attrs[attr]; | |
|
149 | } | |
|
150 | } | |
|
151 | ||
|
152 | var data = {method: 'backbone', sync_data: send_json}; | |
|
153 | this.comm.send(data, options.callbacks); | |
|
154 | this.pending_msgs++; | |
|
155 | } | |
|
156 | } | |
|
157 | } | |
|
158 | ||
|
159 | // Since the comm is a one-way communication, assume the message | |
|
160 | // arrived. | |
|
161 | return model_json; | |
|
162 | }, | |
|
163 | ||
|
164 | }); | |
|
165 | ||
|
166 | ||
|
167 | //-------------------------------------------------------------------- | |
|
168 | // WidgetView class | |
|
169 | //-------------------------------------------------------------------- | |
|
170 | var BaseWidgetView = Backbone.View.extend({ | |
|
171 | initialize: function(options) { | |
|
172 | this.model.on('change',this.update,this); | |
|
173 | this.widget_manager = options.widget_manager; | |
|
174 | this.comm_manager = options.widget_manager.comm_manager; | |
|
175 | this.options = options.options; | |
|
176 | this.child_views = []; | |
|
177 | this.model.views.push(this); | |
|
178 | }, | |
|
179 | ||
|
180 | update: function(){ | |
|
181 | // update view to be consistent with this.model | |
|
182 | // triggered on model change | |
|
183 | }, | |
|
184 | ||
|
185 | child_view: function(model_id, view_name, options) { | |
|
186 | // create and return a child view, given a model id for a model and (optionally) a view name | |
|
187 | // if the view name is not given, it defaults to the model's default view attribute | |
|
188 | var child_model = this.widget_manager.get_model(model_id); | |
|
189 | var child_view = this.widget_manager.create_view(child_model, view_name, options); | |
|
190 | this.child_views[model_id] = child_view; | |
|
191 | return child_view; | |
|
192 | }, | |
|
193 | ||
|
194 | update_child_views: function(old_list, new_list) { | |
|
195 | // this function takes an old list and new list of model ids | |
|
196 | // views in child_views that correspond to deleted ids are deleted | |
|
197 | // views corresponding to added ids are added child_views | |
|
198 | ||
|
199 | // delete old views | |
|
200 | _.each(_.difference(old_list, new_list), function(element, index, list) { | |
|
201 | var view = this.child_views[element]; | |
|
202 | delete this.child_views[element]; | |
|
203 | view.remove(); | |
|
204 | }, this); | |
|
205 | ||
|
206 | // add new views | |
|
207 | _.each(_.difference(new_list, old_list), function(element, index, list) { | |
|
208 | // this function adds the view to the child_views dictionary | |
|
209 | this.child_view(element); | |
|
210 | }, this); | |
|
211 | }, | |
|
212 | ||
|
213 | callbacks: function(){ | |
|
214 | return this.widget_manager.callbacks(this); | |
|
215 | } | |
|
216 | ||
|
217 | render: function(){ | |
|
218 | // render the view. By default, this is only called the first time the view is created | |
|
219 | }, | |
|
220 | send: function (content) { | |
|
221 | this.model.send(content, this.callbacks()); | |
|
222 | }, | |
|
223 | ||
|
224 | touch: function () { | |
|
225 | this.model.save(this.model.changedAttributes(), {patch: true, callbacks: this.callbacks()}); | |
|
226 | }, | |
|
227 | ||
|
228 | }); | |
|
229 | ||
|
230 | var WidgetView = BaseWidgetView.extend({ | |
|
231 | initialize: function (options) { | |
|
232 | // TODO: make changes more granular (e.g., trigger on visible:change) | |
|
233 | this.model.on('change', this.update, this); | |
|
234 | this.model.on('msg:custom', this.on_msg, this); | |
|
235 | BaseWidgetView.prototype.initialize.apply(this, arguments); | |
|
236 | }, | |
|
237 | ||
|
238 | on_msg: function(msg) { | |
|
239 | switch(msg.msg_type) { | |
|
240 | case 'add_class': | |
|
241 | this.add_class(msg.selector, msg.class_list); | |
|
242 | break; | |
|
243 | case 'remove_class': | |
|
244 | this.remove_class(msg.selector, msg.class_list); | |
|
245 | break; | |
|
246 | } | |
|
247 | }, | |
|
248 | ||
|
249 | add_class: function (selector, class_list) { | |
|
250 | var elements = this._get_selector_element(selector); | |
|
251 | if (elements.length > 0) { | |
|
252 | elements.addClass(class_list); | |
|
253 | } | |
|
254 | }, | |
|
255 | ||
|
256 | remove_class: function (selector, class_list) { | |
|
257 | var elements = this._get_selector_element(selector); | |
|
258 | if (elements.length > 0) { | |
|
259 | elements.removeClass(class_list); | |
|
260 | } | |
|
261 | }, | |
|
262 | ||
|
263 | update: function () { | |
|
264 | // the very first update seems to happen before the element is finished rendering | |
|
265 | // so we use setTimeout to give the element time to render | |
|
266 | var e = this.$el; | |
|
267 | var visible = this.model.get('visible'); | |
|
268 | setTimeout(function() {e.toggle(visible)},0); | |
|
269 | ||
|
270 | var css = this.model.get('_css'); | |
|
271 | if (css === undefined) {return;} | |
|
272 | for (var selector in css) { | |
|
273 | if (css.hasOwnProperty(selector)) { | |
|
274 | // Apply the css traits to all elements that match the selector. | |
|
275 | var elements = this._get_selector_element(selector); | |
|
276 | if (elements.length > 0) { | |
|
277 | var css_traits = css[selector]; | |
|
278 | for (var css_key in css_traits) { | |
|
279 | if (css_traits.hasOwnProperty(css_key)) { | |
|
280 | elements.css(css_key, css_traits[css_key]); | |
|
281 | } | |
|
282 | } | |
|
283 | } | |
|
284 | } | |
|
285 | } | |
|
286 | }, | |
|
287 | ||
|
288 | _get_selector_element: function (selector) { | |
|
289 | // Get the elements via the css selector. If the selector is | |
|
290 | // blank, apply the style to the $el_to_style element. If | |
|
291 | // the $el_to_style element is not defined, use apply the | |
|
292 | // style to the view's element. | |
|
293 | var elements; | |
|
294 | if (selector === undefined || selector === null || selector === '') { | |
|
295 | if (this.$el_to_style === undefined) { | |
|
296 | elements = this.$el; | |
|
297 | } else { | |
|
298 | elements = this.$el_to_style; | |
|
299 | } | |
|
300 | } else { | |
|
301 | elements = this.$el.find(selector); | |
|
302 | } | |
|
303 | return elements; | |
|
304 | }, | |
|
305 | }); | |
|
306 | ||
|
307 | IPython.WidgetModel = WidgetModel; | |
|
308 | IPython.WidgetView = WidgetView; | |
|
309 | IPython.BaseWidgetView = BaseWidgetView; | |
|
310 | ||
|
311 | return widget_manager; | |
|
312 | }); |
@@ -6,9 +6,10 b'' | |||
|
6 | 6 | //---------------------------------------------------------------------------- |
|
7 | 7 | |
|
8 | 8 | //============================================================================ |
|
9 | // Base Widget Model and View classes | |
|
9 | // Basic Widgets | |
|
10 | 10 | //============================================================================ |
|
11 | 11 | |
|
12 | <<<<<<< HEAD | |
|
12 | 13 | /** |
|
13 | 14 | * @module IPython |
|
14 | 15 | * @namespace IPython |
@@ -331,3 +332,18 b' function(widget_manager, underscore, backbone){' | |||
|
331 | 332 | |
|
332 | 333 | return widget_manager; |
|
333 | 334 | }); |
|
335 | ======= | |
|
336 | define([ | |
|
337 | "notebook/js/widgets/widget_bool", | |
|
338 | "notebook/js/widgets/widget_button", | |
|
339 | "notebook/js/widgets/widget_container", | |
|
340 | "notebook/js/widgets/widget_float", | |
|
341 | "notebook/js/widgets/widget_float_range", | |
|
342 | "notebook/js/widgets/widget_image", | |
|
343 | "notebook/js/widgets/widget_int", | |
|
344 | "notebook/js/widgets/widget_int_range", | |
|
345 | "notebook/js/widgets/widget_multicontainer", | |
|
346 | "notebook/js/widgets/widget_selection", | |
|
347 | "notebook/js/widgets/widget_string", | |
|
348 | ], function(){ return true; }); | |
|
349 | >>>>>>> renamed: basic_widgets.js -> init.js |
|
1 | NO CONTENT: file was removed |
General Comments 0
You need to be logged in to leave comments.
Login now