##// END OF EJS Templates
Merge pull request #4569 from minrk/persist-celltoolbar...
Matthias Bussonnier -
r13724:64a09d76 merge
parent child Browse files
Show More
@@ -1,393 +1,393 b''
1 //----------------------------------------------------------------------------
1 //----------------------------------------------------------------------------
2 // Copyright (C) 2012 The IPython Development Team
2 // Copyright (C) 2012 The IPython Development Team
3 //
3 //
4 // Distributed under the terms of the BSD License. The full license is in
4 // Distributed under the terms of the BSD License. The full license is in
5 // the file COPYING, distributed as part of this software.
5 // the file COPYING, distributed as part of this software.
6 //----------------------------------------------------------------------------
6 //----------------------------------------------------------------------------
7
7
8 //============================================================================
8 //============================================================================
9 // CellToolbar
9 // CellToolbar
10 //============================================================================
10 //============================================================================
11
11
12
12
13 /**
13 /**
14 * A Module to control the per-cell toolbar.
14 * A Module to control the per-cell toolbar.
15 * @module IPython
15 * @module IPython
16 * @namespace IPython
16 * @namespace IPython
17 * @submodule CellToolbar
17 * @submodule CellToolbar
18 */
18 */
19 var IPython = (function (IPython) {
19 var IPython = (function (IPython) {
20 "use strict";
20 "use strict";
21
21
22 /**
22 /**
23 * @constructor
23 * @constructor
24 * @class CellToolbar
24 * @class CellToolbar
25 * @param {The cell to attach the metadata UI to} cell
25 * @param {The cell to attach the metadata UI to} cell
26 */
26 */
27 var CellToolbar = function (cell) {
27 var CellToolbar = function (cell) {
28 CellToolbar._instances.push(this);
28 CellToolbar._instances.push(this);
29 this.cell = cell;
29 this.cell = cell;
30 this.create_element();
30 this.create_element();
31 this.rebuild();
31 this.rebuild();
32 return this;
32 return this;
33 };
33 };
34
34
35
35
36 CellToolbar.prototype.create_element = function () {
36 CellToolbar.prototype.create_element = function () {
37 this.inner_element = $('<div/>').addClass('celltoolbar')
37 this.inner_element = $('<div/>').addClass('celltoolbar')
38 this.element = $('<div/>').addClass('ctb_hideshow')
38 this.element = $('<div/>').addClass('ctb_hideshow')
39 .append(this.inner_element);
39 .append(this.inner_element);
40 };
40 };
41
41
42
42
43 // The default css style for the outer celltoolbar div
43 // The default css style for the outer celltoolbar div
44 // (ctb_hideshow) is display: none. We add the ctb_show
44 // (ctb_hideshow) is display: none. We add the ctb_show
45 // class to either 1) the body to show all cell's toolbars
45 // class to either 1) the body to show all cell's toolbars
46 // or 2) to the individual celltoolbar divs to show just one
46 // or 2) to the individual celltoolbar divs to show just one
47 // cell's toolbar.
47 // cell's toolbar.
48
48
49 CellToolbar.global_hide = function () {
49 CellToolbar.global_hide = function () {
50 $('body').removeClass('ctb_show');
50 $('body').removeClass('ctb_show');
51 }
51 }
52
52
53
53
54 CellToolbar.global_show = function () {
54 CellToolbar.global_show = function () {
55 $('body').addClass('ctb_show');
55 $('body').addClass('ctb_show');
56 }
56 }
57
57
58
58
59 CellToolbar.prototype.hide = function () {
59 CellToolbar.prototype.hide = function () {
60 this.element.removeClass('ctb_show');
60 this.element.removeClass('ctb_show');
61 }
61 }
62
62
63
63
64 CellToolbar.prototype.show = function () {
64 CellToolbar.prototype.show = function () {
65 this.element.addClass('ctb_show');
65 this.element.addClass('ctb_show');
66 }
66 }
67
67
68
68
69 /**
69 /**
70 * Class variable that should contain a dict of all availlable callback
70 * Class variable that should contain a dict of all availlable callback
71 * we need to think of wether or not we allow nested namespace
71 * we need to think of wether or not we allow nested namespace
72 * @property _callback_dict
72 * @property _callback_dict
73 * @private
73 * @private
74 * @static
74 * @static
75 * @type Dict
75 * @type Dict
76 */
76 */
77 CellToolbar._callback_dict = {};
77 CellToolbar._callback_dict = {};
78
78
79
79
80 /**
80 /**
81 * Class variable that should contain the reverse order list of the button
81 * Class variable that should contain the reverse order list of the button
82 * to add to the toolbar of each cell
82 * to add to the toolbar of each cell
83 * @property _ui_controls_list
83 * @property _ui_controls_list
84 * @private
84 * @private
85 * @static
85 * @static
86 * @type List
86 * @type List
87 */
87 */
88 CellToolbar._ui_controls_list = [];
88 CellToolbar._ui_controls_list = [];
89
89
90
90
91 /**
91 /**
92 * Class variable that should contains the CellToolbar instances for each
92 * Class variable that should contains the CellToolbar instances for each
93 * cell of the notebook
93 * cell of the notebook
94 *
94 *
95 * @private
95 * @private
96 * @property _instances
96 * @property _instances
97 * @static
97 * @static
98 * @type List
98 * @type List
99 */
99 */
100 CellToolbar._instances =[]
100 CellToolbar._instances =[]
101
101
102
102
103 /**
103 /**
104 * keep a list of all the availlabel presets for the toolbar
104 * keep a list of all the availlabel presets for the toolbar
105 * @private
105 * @private
106 * @property _presets
106 * @property _presets
107 * @static
107 * @static
108 * @type Dict
108 * @type Dict
109 */
109 */
110 CellToolbar._presets ={}
110 CellToolbar._presets ={}
111
111
112
112
113 // this is by design not a prototype.
113 // this is by design not a prototype.
114 /**
114 /**
115 * Register a callback to create an UI element in a cell toolbar.
115 * Register a callback to create an UI element in a cell toolbar.
116 * @method register_callback
116 * @method register_callback
117 * @param name {String} name to use to refer to the callback. It is advised to use a prefix with the name
117 * @param name {String} name to use to refer to the callback. It is advised to use a prefix with the name
118 * for easier sorting and avoid collision
118 * for easier sorting and avoid collision
119 * @param callback {function(div, cell)} callback that will be called to generate the ui element
119 * @param callback {function(div, cell)} callback that will be called to generate the ui element
120 *
120 *
121 *
121 *
122 * The callback will receive the following element :
122 * The callback will receive the following element :
123 *
123 *
124 * * a div in which to add element.
124 * * a div in which to add element.
125 * * the cell it is responsible from
125 * * the cell it is responsible from
126 *
126 *
127 * @example
127 * @example
128 *
128 *
129 * Example that create callback for a button that toggle between `true` and `false` label,
129 * Example that create callback for a button that toggle between `true` and `false` label,
130 * with the metadata under the key 'foo' to reflect the status of the button.
130 * with the metadata under the key 'foo' to reflect the status of the button.
131 *
131 *
132 * // first param reference to a DOM div
132 * // first param reference to a DOM div
133 * // second param reference to the cell.
133 * // second param reference to the cell.
134 * var toggle = function(div, cell) {
134 * var toggle = function(div, cell) {
135 * var button_container = $(div)
135 * var button_container = $(div)
136 *
136 *
137 * // let's create a button that show the current value of the metadata
137 * // let's create a button that show the current value of the metadata
138 * var button = $('<div/>').button({label:String(cell.metadata.foo)});
138 * var button = $('<div/>').button({label:String(cell.metadata.foo)});
139 *
139 *
140 * // On click, change the metadata value and update the button label
140 * // On click, change the metadata value and update the button label
141 * button.click(function(){
141 * button.click(function(){
142 * var v = cell.metadata.foo;
142 * var v = cell.metadata.foo;
143 * cell.metadata.foo = !v;
143 * cell.metadata.foo = !v;
144 * button.button("option", "label", String(!v));
144 * button.button("option", "label", String(!v));
145 * })
145 * })
146 *
146 *
147 * // add the button to the DOM div.
147 * // add the button to the DOM div.
148 * button_container.append(button);
148 * button_container.append(button);
149 * }
149 * }
150 *
150 *
151 * // now we register the callback under the name `foo` to give the
151 * // now we register the callback under the name `foo` to give the
152 * // user the ability to use it later
152 * // user the ability to use it later
153 * CellToolbar.register_callback('foo', toggle);
153 * CellToolbar.register_callback('foo', toggle);
154 */
154 */
155 CellToolbar.register_callback = function(name, callback){
155 CellToolbar.register_callback = function(name, callback){
156 // Overwrite if it already exists.
156 // Overwrite if it already exists.
157 CellToolbar._callback_dict[name] = callback;
157 CellToolbar._callback_dict[name] = callback;
158 };
158 };
159
159
160
160
161 /**
161 /**
162 * Register a preset of UI element in a cell toolbar.
162 * Register a preset of UI element in a cell toolbar.
163 * Not supported Yet.
163 * Not supported Yet.
164 * @method register_preset
164 * @method register_preset
165 * @param name {String} name to use to refer to the preset. It is advised to use a prefix with the name
165 * @param name {String} name to use to refer to the preset. It is advised to use a prefix with the name
166 * for easier sorting and avoid collision
166 * for easier sorting and avoid collision
167 * @param preset_list {List of String} reverse order of the button in the toolbar. Each String of the list
167 * @param preset_list {List of String} reverse order of the button in the toolbar. Each String of the list
168 * should correspond to a name of a registerd callback.
168 * should correspond to a name of a registerd callback.
169 *
169 *
170 * @private
170 * @private
171 * @example
171 * @example
172 *
172 *
173 * CellToolbar.register_callback('foo.c1', function(div, cell){...});
173 * CellToolbar.register_callback('foo.c1', function(div, cell){...});
174 * CellToolbar.register_callback('foo.c2', function(div, cell){...});
174 * CellToolbar.register_callback('foo.c2', function(div, cell){...});
175 * CellToolbar.register_callback('foo.c3', function(div, cell){...});
175 * CellToolbar.register_callback('foo.c3', function(div, cell){...});
176 * CellToolbar.register_callback('foo.c4', function(div, cell){...});
176 * CellToolbar.register_callback('foo.c4', function(div, cell){...});
177 * CellToolbar.register_callback('foo.c5', function(div, cell){...});
177 * CellToolbar.register_callback('foo.c5', function(div, cell){...});
178 *
178 *
179 * CellToolbar.register_preset('foo.foo_preset1', ['foo.c1', 'foo.c2', 'foo.c5'])
179 * CellToolbar.register_preset('foo.foo_preset1', ['foo.c1', 'foo.c2', 'foo.c5'])
180 * CellToolbar.register_preset('foo.foo_preset2', ['foo.c4', 'foo.c5'])
180 * CellToolbar.register_preset('foo.foo_preset2', ['foo.c4', 'foo.c5'])
181 */
181 */
182 CellToolbar.register_preset = function(name, preset_list) {
182 CellToolbar.register_preset = function(name, preset_list) {
183 CellToolbar._presets[name] = preset_list
183 CellToolbar._presets[name] = preset_list
184 $([IPython.events]).trigger('preset_added.CellToolbar', {name: name});
184 $([IPython.events]).trigger('preset_added.CellToolbar', {name: name});
185 };
185 };
186
186
187
187
188 /**
188 /**
189 * List the names of the presets that are currently registered.
189 * List the names of the presets that are currently registered.
190 *
190 *
191 * @method list_presets
191 * @method list_presets
192 * @static
192 * @static
193 */
193 */
194 CellToolbar.list_presets = function() {
194 CellToolbar.list_presets = function() {
195 var keys = [];
195 var keys = [];
196 for (var k in CellToolbar._presets) {
196 for (var k in CellToolbar._presets) {
197 keys.push(k);
197 keys.push(k);
198 }
198 }
199 return keys;
199 return keys;
200 };
200 };
201
201
202
202
203 /**
203 /**
204 * Activate an UI preset from `register_preset`
204 * Activate an UI preset from `register_preset`
205 *
205 *
206 * This does not update the selection UI.
206 * This does not update the selection UI.
207 *
207 *
208 * @method activate_preset
208 * @method activate_preset
209 * @param preset_name {String} string corresponding to the preset name
209 * @param preset_name {String} string corresponding to the preset name
210 *
210 *
211 * @static
211 * @static
212 * @private
212 * @private
213 * @example
213 * @example
214 *
214 *
215 * CellToolbar.activate_preset('foo.foo_preset1');
215 * CellToolbar.activate_preset('foo.foo_preset1');
216 */
216 */
217 CellToolbar.activate_preset= function(preset_name){
217 CellToolbar.activate_preset = function(preset_name){
218 var preset = CellToolbar._presets[preset_name];
218 var preset = CellToolbar._presets[preset_name];
219
219
220 if(preset != undefined){
220 if(preset != undefined){
221 CellToolbar._ui_controls_list = preset;
221 CellToolbar._ui_controls_list = preset;
222 CellToolbar.rebuild_all();
222 CellToolbar.rebuild_all();
223 }
223 }
224 }
224 }
225
225
226
226
227 /**
227 /**
228 * This should be called on the class and not on a instance as it will trigger
228 * This should be called on the class and not on a instance as it will trigger
229 * rebuild of all the instances.
229 * rebuild of all the instances.
230 * @method rebuild_all
230 * @method rebuild_all
231 * @static
231 * @static
232 *
232 *
233 */
233 */
234 CellToolbar.rebuild_all = function(){
234 CellToolbar.rebuild_all = function(){
235 for(var i in CellToolbar._instances){
235 for(var i in CellToolbar._instances){
236 CellToolbar._instances[i].rebuild();
236 CellToolbar._instances[i].rebuild();
237 }
237 }
238 }
238 }
239
239
240 /**
240 /**
241 * Rebuild all the button on the toolbar to update it's state.
241 * Rebuild all the button on the toolbar to update it's state.
242 * @method rebuild
242 * @method rebuild
243 */
243 */
244 CellToolbar.prototype.rebuild = function(){
244 CellToolbar.prototype.rebuild = function(){
245 // strip evrything from the div
245 // strip evrything from the div
246 // which is probabli metainner.
246 // which is probabli metainner.
247 // or this.element.
247 // or this.element.
248 this.inner_element.empty();
248 this.inner_element.empty();
249
249
250 var cdict = CellToolbar._callback_dict;
250 var cdict = CellToolbar._callback_dict;
251 var preset = CellToolbar._ui_controls_list;
251 var preset = CellToolbar._ui_controls_list;
252 // Yes we iterate on the class varaible, not the instance one.
252 // Yes we iterate on the class varaible, not the instance one.
253 for ( var index in CellToolbar._ui_controls_list){
253 for ( var index in CellToolbar._ui_controls_list){
254 var local_div = $('<div/>').addClass('button_container');
254 var local_div = $('<div/>').addClass('button_container');
255 // Note,
255 // Note,
256 // do this the other way, wrap in try/catch and don't append if any errors.
256 // do this the other way, wrap in try/catch and don't append if any errors.
257 this.inner_element.append(local_div)
257 this.inner_element.append(local_div)
258 cdict[preset[index]](local_div, this.cell)
258 cdict[preset[index]](local_div, this.cell)
259 }
259 }
260 }
260 }
261
261
262
262
263 /**
263 /**
264 */
264 */
265 CellToolbar.utils = {};
265 CellToolbar.utils = {};
266
266
267
267
268 /**
268 /**
269 * A utility function to generate bindings between a checkbox and cell/metadata
269 * A utility function to generate bindings between a checkbox and cell/metadata
270 * @method utils.checkbox_ui_generator
270 * @method utils.checkbox_ui_generator
271 * @static
271 * @static
272 *
272 *
273 * @param name {string} Label in front of the checkbox
273 * @param name {string} Label in front of the checkbox
274 * @param setter {function( cell, newValue )}
274 * @param setter {function( cell, newValue )}
275 * A setter method to set the newValue
275 * A setter method to set the newValue
276 * @param getter {function( cell )}
276 * @param getter {function( cell )}
277 * A getter methods which return the current value.
277 * A getter methods which return the current value.
278 *
278 *
279 * @return callback {function( div, cell )} Callback to be passed to `register_callback`
279 * @return callback {function( div, cell )} Callback to be passed to `register_callback`
280 *
280 *
281 * @example
281 * @example
282 *
282 *
283 * An exmple that bind the subkey `slideshow.isSectionStart` to a checkbox with a `New Slide` label
283 * An exmple that bind the subkey `slideshow.isSectionStart` to a checkbox with a `New Slide` label
284 *
284 *
285 * var newSlide = CellToolbar.utils.checkbox_ui_generator('New Slide',
285 * var newSlide = CellToolbar.utils.checkbox_ui_generator('New Slide',
286 * // setter
286 * // setter
287 * function(cell, value){
287 * function(cell, value){
288 * // we check that the slideshow namespace exist and create it if needed
288 * // we check that the slideshow namespace exist and create it if needed
289 * if (cell.metadata.slideshow == undefined){cell.metadata.slideshow = {}}
289 * if (cell.metadata.slideshow == undefined){cell.metadata.slideshow = {}}
290 * // set the value
290 * // set the value
291 * cell.metadata.slideshow.isSectionStart = value
291 * cell.metadata.slideshow.isSectionStart = value
292 * },
292 * },
293 * //geter
293 * //geter
294 * function(cell){ var ns = cell.metadata.slideshow;
294 * function(cell){ var ns = cell.metadata.slideshow;
295 * // if the slideshow namespace does not exist return `undefined`
295 * // if the slideshow namespace does not exist return `undefined`
296 * // (will be interpreted as `false` by checkbox) otherwise
296 * // (will be interpreted as `false` by checkbox) otherwise
297 * // return the value
297 * // return the value
298 * return (ns == undefined)? undefined: ns.isSectionStart
298 * return (ns == undefined)? undefined: ns.isSectionStart
299 * }
299 * }
300 * );
300 * );
301 *
301 *
302 * CellToolbar.register_callback('newSlide', newSlide);
302 * CellToolbar.register_callback('newSlide', newSlide);
303 *
303 *
304 */
304 */
305 CellToolbar.utils.checkbox_ui_generator = function(name, setter, getter){
305 CellToolbar.utils.checkbox_ui_generator = function(name, setter, getter){
306 return function(div, cell) {
306 return function(div, cell) {
307 var button_container = $(div)
307 var button_container = $(div)
308
308
309 var chkb = $('<input/>').attr('type', 'checkbox');
309 var chkb = $('<input/>').attr('type', 'checkbox');
310 var lbl = $('<label/>').append($('<span/>').text(name));
310 var lbl = $('<label/>').append($('<span/>').text(name));
311 lbl.append(chkb);
311 lbl.append(chkb);
312 chkb.attr("checked", getter(cell));
312 chkb.attr("checked", getter(cell));
313
313
314 chkb.click(function(){
314 chkb.click(function(){
315 var v = getter(cell);
315 var v = getter(cell);
316 setter(cell, !v);
316 setter(cell, !v);
317 chkb.attr("checked", !v);
317 chkb.attr("checked", !v);
318 })
318 })
319 button_container.append($('<div/>').append(lbl));
319 button_container.append($('<div/>').append(lbl));
320
320
321 }
321 }
322 }
322 }
323
323
324
324
325 /**
325 /**
326 * A utility function to generate bindings between a dropdown list cell
326 * A utility function to generate bindings between a dropdown list cell
327 * @method utils.select_ui_generator
327 * @method utils.select_ui_generator
328 * @static
328 * @static
329 *
329 *
330 * @param list_list {list of sublist} List of sublist of metadata value and name in the dropdown list.
330 * @param list_list {list of sublist} List of sublist of metadata value and name in the dropdown list.
331 * subslit shoud contain 2 element each, first a string that woul be displayed in the dropdown list,
331 * subslit shoud contain 2 element each, first a string that woul be displayed in the dropdown list,
332 * and second the corresponding value to be passed to setter/return by getter. the corresponding value
332 * and second the corresponding value to be passed to setter/return by getter. the corresponding value
333 * should not be "undefined" or behavior can be unexpected.
333 * should not be "undefined" or behavior can be unexpected.
334 * @param setter {function( cell, newValue )}
334 * @param setter {function( cell, newValue )}
335 * A setter method to set the newValue
335 * A setter method to set the newValue
336 * @param getter {function( cell )}
336 * @param getter {function( cell )}
337 * A getter methods which return the current value of the metadata.
337 * A getter methods which return the current value of the metadata.
338 * @param [label=""] {String} optionnal label for the dropdown menu
338 * @param [label=""] {String} optionnal label for the dropdown menu
339 *
339 *
340 * @return callback {function( div, cell )} Callback to be passed to `register_callback`
340 * @return callback {function( div, cell )} Callback to be passed to `register_callback`
341 *
341 *
342 * @example
342 * @example
343 *
343 *
344 * var select_type = CellToolbar.utils.select_ui_generator([
344 * var select_type = CellToolbar.utils.select_ui_generator([
345 * ["<None>" , "None" ],
345 * ["<None>" , "None" ],
346 * ["Header Slide" , "header_slide" ],
346 * ["Header Slide" , "header_slide" ],
347 * ["Slide" , "slide" ],
347 * ["Slide" , "slide" ],
348 * ["Fragment" , "fragment" ],
348 * ["Fragment" , "fragment" ],
349 * ["Skip" , "skip" ],
349 * ["Skip" , "skip" ],
350 * ],
350 * ],
351 * // setter
351 * // setter
352 * function(cell, value){
352 * function(cell, value){
353 * // we check that the slideshow namespace exist and create it if needed
353 * // we check that the slideshow namespace exist and create it if needed
354 * if (cell.metadata.slideshow == undefined){cell.metadata.slideshow = {}}
354 * if (cell.metadata.slideshow == undefined){cell.metadata.slideshow = {}}
355 * // set the value
355 * // set the value
356 * cell.metadata.slideshow.slide_type = value
356 * cell.metadata.slideshow.slide_type = value
357 * },
357 * },
358 * //geter
358 * //geter
359 * function(cell){ var ns = cell.metadata.slideshow;
359 * function(cell){ var ns = cell.metadata.slideshow;
360 * // if the slideshow namespace does not exist return `undefined`
360 * // if the slideshow namespace does not exist return `undefined`
361 * // (will be interpreted as `false` by checkbox) otherwise
361 * // (will be interpreted as `false` by checkbox) otherwise
362 * // return the value
362 * // return the value
363 * return (ns == undefined)? undefined: ns.slide_type
363 * return (ns == undefined)? undefined: ns.slide_type
364 * }
364 * }
365 * CellToolbar.register_callback('slideshow.select', select_type);
365 * CellToolbar.register_callback('slideshow.select', select_type);
366 *
366 *
367 */
367 */
368 CellToolbar.utils.select_ui_generator = function(list_list, setter, getter, label){
368 CellToolbar.utils.select_ui_generator = function(list_list, setter, getter, label){
369 label= label? label: "";
369 label= label? label: "";
370 return function(div, cell) {
370 return function(div, cell) {
371 var button_container = $(div)
371 var button_container = $(div)
372 var lbl = $("<label/>").append($('<span/>').text(label));
372 var lbl = $("<label/>").append($('<span/>').text(label));
373 var select = $('<select/>').addClass('ui-widget ui-widget-content');
373 var select = $('<select/>').addClass('ui-widget ui-widget-content');
374 for(var itemn in list_list){
374 for(var itemn in list_list){
375 var opt = $('<option/>');
375 var opt = $('<option/>');
376 opt.attr('value', list_list[itemn][1])
376 opt.attr('value', list_list[itemn][1])
377 opt.text(list_list[itemn][0])
377 opt.text(list_list[itemn][0])
378 select.append(opt);
378 select.append(opt);
379 }
379 }
380 select.val(getter(cell));
380 select.val(getter(cell));
381 select.change(function(){
381 select.change(function(){
382 setter(cell, select.val());
382 setter(cell, select.val());
383 });
383 });
384 button_container.append($('<div/>').append(lbl).append(select));
384 button_container.append($('<div/>').append(lbl).append(select));
385
385
386 }
386 }
387 };
387 };
388
388
389
389
390 IPython.CellToolbar = CellToolbar;
390 IPython.CellToolbar = CellToolbar;
391
391
392 return IPython;
392 return IPython;
393 }(IPython));
393 }(IPython));
@@ -1,207 +1,209 b''
1 //----------------------------------------------------------------------------
1 //----------------------------------------------------------------------------
2 // Copyright (C) 2011 The IPython Development Team
2 // Copyright (C) 2011 The IPython Development Team
3 //
3 //
4 // Distributed under the terms of the BSD License. The full license is in
4 // Distributed under the terms of the BSD License. The full license is in
5 // the file COPYING, distributed as part of this software.
5 // the file COPYING, distributed as part of this software.
6 //----------------------------------------------------------------------------
6 //----------------------------------------------------------------------------
7
7
8 //============================================================================
8 //============================================================================
9 // ToolBar
9 // ToolBar
10 //============================================================================
10 //============================================================================
11
11
12 var IPython = (function (IPython) {
12 var IPython = (function (IPython) {
13 "use strict";
13 "use strict";
14
14
15 var MainToolBar = function (selector) {
15 var MainToolBar = function (selector) {
16 IPython.ToolBar.apply(this, arguments);
16 IPython.ToolBar.apply(this, arguments);
17 this.construct();
17 this.construct();
18 this.add_celltype_list();
18 this.add_celltype_list();
19 this.add_celltoolbar_list();
19 this.add_celltoolbar_list();
20 this.bind_events();
20 this.bind_events();
21 };
21 };
22
22
23 MainToolBar.prototype = new IPython.ToolBar();
23 MainToolBar.prototype = new IPython.ToolBar();
24
24
25 MainToolBar.prototype.construct = function () {
25 MainToolBar.prototype.construct = function () {
26 this.add_buttons_group([
26 this.add_buttons_group([
27 {
27 {
28 id : 'save_b',
28 id : 'save_b',
29 label : 'Save and Checkpoint',
29 label : 'Save and Checkpoint',
30 icon : 'icon-save',
30 icon : 'icon-save',
31 callback : function () {
31 callback : function () {
32 IPython.notebook.save_checkpoint();
32 IPython.notebook.save_checkpoint();
33 }
33 }
34 }
34 }
35 ]);
35 ]);
36 this.add_buttons_group([
36 this.add_buttons_group([
37 {
37 {
38 id : 'cut_b',
38 id : 'cut_b',
39 label : 'Cut Cell',
39 label : 'Cut Cell',
40 icon : 'icon-cut',
40 icon : 'icon-cut',
41 callback : function () {
41 callback : function () {
42 IPython.notebook.cut_cell();
42 IPython.notebook.cut_cell();
43 }
43 }
44 },
44 },
45 {
45 {
46 id : 'copy_b',
46 id : 'copy_b',
47 label : 'Copy Cell',
47 label : 'Copy Cell',
48 icon : 'icon-copy',
48 icon : 'icon-copy',
49 callback : function () {
49 callback : function () {
50 IPython.notebook.copy_cell();
50 IPython.notebook.copy_cell();
51 }
51 }
52 },
52 },
53 {
53 {
54 id : 'paste_b',
54 id : 'paste_b',
55 label : 'Paste Cell Below',
55 label : 'Paste Cell Below',
56 icon : 'icon-paste',
56 icon : 'icon-paste',
57 callback : function () {
57 callback : function () {
58 IPython.notebook.paste_cell_below();
58 IPython.notebook.paste_cell_below();
59 }
59 }
60 }
60 }
61 ],'cut_copy_paste');
61 ],'cut_copy_paste');
62
62
63 this.add_buttons_group([
63 this.add_buttons_group([
64 {
64 {
65 id : 'move_up_b',
65 id : 'move_up_b',
66 label : 'Move Cell Up',
66 label : 'Move Cell Up',
67 icon : 'icon-arrow-up',
67 icon : 'icon-arrow-up',
68 callback : function () {
68 callback : function () {
69 IPython.notebook.move_cell_up();
69 IPython.notebook.move_cell_up();
70 }
70 }
71 },
71 },
72 {
72 {
73 id : 'move_down_b',
73 id : 'move_down_b',
74 label : 'Move Cell Down',
74 label : 'Move Cell Down',
75 icon : 'icon-arrow-down',
75 icon : 'icon-arrow-down',
76 callback : function () {
76 callback : function () {
77 IPython.notebook.move_cell_down();
77 IPython.notebook.move_cell_down();
78 }
78 }
79 }
79 }
80 ],'move_up_down');
80 ],'move_up_down');
81
81
82 this.add_buttons_group([
82 this.add_buttons_group([
83 {
83 {
84 id : 'insert_above_b',
84 id : 'insert_above_b',
85 label : 'Insert Cell Above',
85 label : 'Insert Cell Above',
86 icon : 'icon-circle-arrow-up',
86 icon : 'icon-circle-arrow-up',
87 callback : function () {
87 callback : function () {
88 IPython.notebook.insert_cell_above('code');
88 IPython.notebook.insert_cell_above('code');
89 }
89 }
90 },
90 },
91 {
91 {
92 id : 'insert_below_b',
92 id : 'insert_below_b',
93 label : 'Insert Cell Below',
93 label : 'Insert Cell Below',
94 icon : 'icon-circle-arrow-down',
94 icon : 'icon-circle-arrow-down',
95 callback : function () {
95 callback : function () {
96 IPython.notebook.insert_cell_below('code');
96 IPython.notebook.insert_cell_below('code');
97 }
97 }
98 }
98 }
99 ],'insert_above_below');
99 ],'insert_above_below');
100
100
101 this.add_buttons_group([
101 this.add_buttons_group([
102 {
102 {
103 id : 'run_b',
103 id : 'run_b',
104 label : 'Run Cell',
104 label : 'Run Cell',
105 icon : 'icon-play',
105 icon : 'icon-play',
106 callback : function () {
106 callback : function () {
107 IPython.notebook.execute_selected_cell();
107 IPython.notebook.execute_selected_cell();
108 }
108 }
109 },
109 },
110 {
110 {
111 id : 'interrupt_b',
111 id : 'interrupt_b',
112 label : 'Interrupt',
112 label : 'Interrupt',
113 icon : 'icon-stop',
113 icon : 'icon-stop',
114 callback : function () {
114 callback : function () {
115 IPython.notebook.session.interrupt_kernel();
115 IPython.notebook.session.interrupt_kernel();
116 }
116 }
117 }
117 }
118 ],'run_int');
118 ],'run_int');
119 };
119 };
120
120
121 MainToolBar.prototype.add_celltype_list = function () {
121 MainToolBar.prototype.add_celltype_list = function () {
122 this.element
122 this.element
123 .append($('<select/>')
123 .append($('<select/>')
124 .attr('id','cell_type')
124 .attr('id','cell_type')
125 // .addClass('ui-widget-content')
125 // .addClass('ui-widget-content')
126 .append($('<option/>').attr('value','code').text('Code'))
126 .append($('<option/>').attr('value','code').text('Code'))
127 .append($('<option/>').attr('value','markdown').text('Markdown'))
127 .append($('<option/>').attr('value','markdown').text('Markdown'))
128 .append($('<option/>').attr('value','raw').text('Raw Text'))
128 .append($('<option/>').attr('value','raw').text('Raw Text'))
129 .append($('<option/>').attr('value','heading1').text('Heading 1'))
129 .append($('<option/>').attr('value','heading1').text('Heading 1'))
130 .append($('<option/>').attr('value','heading2').text('Heading 2'))
130 .append($('<option/>').attr('value','heading2').text('Heading 2'))
131 .append($('<option/>').attr('value','heading3').text('Heading 3'))
131 .append($('<option/>').attr('value','heading3').text('Heading 3'))
132 .append($('<option/>').attr('value','heading4').text('Heading 4'))
132 .append($('<option/>').attr('value','heading4').text('Heading 4'))
133 .append($('<option/>').attr('value','heading5').text('Heading 5'))
133 .append($('<option/>').attr('value','heading5').text('Heading 5'))
134 .append($('<option/>').attr('value','heading6').text('Heading 6'))
134 .append($('<option/>').attr('value','heading6').text('Heading 6'))
135 );
135 );
136 };
136 };
137
137
138
138
139 MainToolBar.prototype.add_celltoolbar_list = function () {
139 MainToolBar.prototype.add_celltoolbar_list = function () {
140 var label = $('<span/>').addClass("navbar-text").text('Cell Toolbar:');
140 var label = $('<span/>').addClass("navbar-text").text('Cell Toolbar:');
141 var select = $('<select/>')
141 var select = $('<select/>')
142 // .addClass('ui-widget-content')
142 // .addClass('ui-widget-content')
143 .attr('id', 'ctb_select')
143 .attr('id', 'ctb_select')
144 .append($('<option/>').attr('value', '').text('None'));
144 .append($('<option/>').attr('value', '').text('None'));
145 this.element.append(label).append(select);
145 this.element.append(label).append(select);
146 select.change(function() {
146 select.change(function() {
147 var val = $(this).val()
147 var val = $(this).val()
148 if (val =='') {
148 if (val =='') {
149 IPython.CellToolbar.global_hide();
149 IPython.CellToolbar.global_hide();
150 delete IPython.notebook.metadata.celltoolbar;
150 } else {
151 } else {
151 IPython.CellToolbar.global_show();
152 IPython.CellToolbar.global_show();
152 IPython.CellToolbar.activate_preset(val);
153 IPython.CellToolbar.activate_preset(val);
154 IPython.notebook.metadata.celltoolbar = val;
153 }
155 }
154 });
156 });
155 // Setup the currently registered presets.
157 // Setup the currently registered presets.
156 var presets = IPython.CellToolbar.list_presets();
158 var presets = IPython.CellToolbar.list_presets();
157 for (var i=0; i<presets.length; i++) {
159 for (var i=0; i<presets.length; i++) {
158 var name = presets[i];
160 var name = presets[i];
159 select.append($('<option/>').attr('value', name).text(name));
161 select.append($('<option/>').attr('value', name).text(name));
160 }
162 }
161 // Setup future preset registrations.
163 // Setup future preset registrations.
162 $([IPython.events]).on('preset_added.CellToolbar', function (event, data) {
164 $([IPython.events]).on('preset_added.CellToolbar', function (event, data) {
163 var name = data.name;
165 var name = data.name;
164 select.append($('<option/>').attr('value', name).text(name));
166 select.append($('<option/>').attr('value', name).text(name));
165 });
167 });
166 };
168 };
167
169
168
170
169 MainToolBar.prototype.bind_events = function () {
171 MainToolBar.prototype.bind_events = function () {
170 var that = this;
172 var that = this;
171
173
172 this.element.find('#cell_type').change(function () {
174 this.element.find('#cell_type').change(function () {
173 var cell_type = $(this).val();
175 var cell_type = $(this).val();
174 if (cell_type === 'code') {
176 if (cell_type === 'code') {
175 IPython.notebook.to_code();
177 IPython.notebook.to_code();
176 } else if (cell_type === 'markdown') {
178 } else if (cell_type === 'markdown') {
177 IPython.notebook.to_markdown();
179 IPython.notebook.to_markdown();
178 } else if (cell_type === 'raw') {
180 } else if (cell_type === 'raw') {
179 IPython.notebook.to_raw();
181 IPython.notebook.to_raw();
180 } else if (cell_type === 'heading1') {
182 } else if (cell_type === 'heading1') {
181 IPython.notebook.to_heading(undefined, 1);
183 IPython.notebook.to_heading(undefined, 1);
182 } else if (cell_type === 'heading2') {
184 } else if (cell_type === 'heading2') {
183 IPython.notebook.to_heading(undefined, 2);
185 IPython.notebook.to_heading(undefined, 2);
184 } else if (cell_type === 'heading3') {
186 } else if (cell_type === 'heading3') {
185 IPython.notebook.to_heading(undefined, 3);
187 IPython.notebook.to_heading(undefined, 3);
186 } else if (cell_type === 'heading4') {
188 } else if (cell_type === 'heading4') {
187 IPython.notebook.to_heading(undefined, 4);
189 IPython.notebook.to_heading(undefined, 4);
188 } else if (cell_type === 'heading5') {
190 } else if (cell_type === 'heading5') {
189 IPython.notebook.to_heading(undefined, 5);
191 IPython.notebook.to_heading(undefined, 5);
190 } else if (cell_type === 'heading6') {
192 } else if (cell_type === 'heading6') {
191 IPython.notebook.to_heading(undefined, 6);
193 IPython.notebook.to_heading(undefined, 6);
192 }
194 }
193 });
195 });
194 $([IPython.events]).on('selected_cell_type_changed.Notebook', function (event, data) {
196 $([IPython.events]).on('selected_cell_type_changed.Notebook', function (event, data) {
195 if (data.cell_type === 'heading') {
197 if (data.cell_type === 'heading') {
196 that.element.find('#cell_type').val(data.cell_type+data.level);
198 that.element.find('#cell_type').val(data.cell_type+data.level);
197 } else {
199 } else {
198 that.element.find('#cell_type').val(data.cell_type);
200 that.element.find('#cell_type').val(data.cell_type);
199 }
201 }
200 });
202 });
201 };
203 };
202
204
203 IPython.MainToolBar = MainToolBar;
205 IPython.MainToolBar = MainToolBar;
204
206
205 return IPython;
207 return IPython;
206
208
207 }(IPython));
209 }(IPython));
@@ -1,2262 +1,2269 b''
1 //----------------------------------------------------------------------------
1 //----------------------------------------------------------------------------
2 // Copyright (C) 2011 The IPython Development Team
2 // Copyright (C) 2011 The IPython Development Team
3 //
3 //
4 // Distributed under the terms of the BSD License. The full license is in
4 // Distributed under the terms of the BSD License. The full license is in
5 // the file COPYING, distributed as part of this software.
5 // the file COPYING, distributed as part of this software.
6 //----------------------------------------------------------------------------
6 //----------------------------------------------------------------------------
7
7
8 //============================================================================
8 //============================================================================
9 // Notebook
9 // Notebook
10 //============================================================================
10 //============================================================================
11
11
12 var IPython = (function (IPython) {
12 var IPython = (function (IPython) {
13 "use strict";
13 "use strict";
14
14
15 var utils = IPython.utils;
15 var utils = IPython.utils;
16 var key = IPython.utils.keycodes;
16 var key = IPython.utils.keycodes;
17
17
18 /**
18 /**
19 * A notebook contains and manages cells.
19 * A notebook contains and manages cells.
20 *
20 *
21 * @class Notebook
21 * @class Notebook
22 * @constructor
22 * @constructor
23 * @param {String} selector A jQuery selector for the notebook's DOM element
23 * @param {String} selector A jQuery selector for the notebook's DOM element
24 * @param {Object} [options] A config object
24 * @param {Object} [options] A config object
25 */
25 */
26 var Notebook = function (selector, options) {
26 var Notebook = function (selector, options) {
27 var options = options || {};
27 var options = options || {};
28 this._baseProjectUrl = options.baseProjectUrl;
28 this._baseProjectUrl = options.baseProjectUrl;
29 this.notebook_path = options.notebookPath;
29 this.notebook_path = options.notebookPath;
30 this.notebook_name = options.notebookName;
30 this.notebook_name = options.notebookName;
31 this.element = $(selector);
31 this.element = $(selector);
32 this.element.scroll();
32 this.element.scroll();
33 this.element.data("notebook", this);
33 this.element.data("notebook", this);
34 this.next_prompt_number = 1;
34 this.next_prompt_number = 1;
35 this.session = null;
35 this.session = null;
36 this.kernel = null;
36 this.kernel = null;
37 this.clipboard = null;
37 this.clipboard = null;
38 this.undelete_backup = null;
38 this.undelete_backup = null;
39 this.undelete_index = null;
39 this.undelete_index = null;
40 this.undelete_below = false;
40 this.undelete_below = false;
41 this.paste_enabled = false;
41 this.paste_enabled = false;
42 this.set_dirty(false);
42 this.set_dirty(false);
43 this.metadata = {};
43 this.metadata = {};
44 this._checkpoint_after_save = false;
44 this._checkpoint_after_save = false;
45 this.last_checkpoint = null;
45 this.last_checkpoint = null;
46 this.checkpoints = [];
46 this.checkpoints = [];
47 this.autosave_interval = 0;
47 this.autosave_interval = 0;
48 this.autosave_timer = null;
48 this.autosave_timer = null;
49 // autosave *at most* every two minutes
49 // autosave *at most* every two minutes
50 this.minimum_autosave_interval = 120000;
50 this.minimum_autosave_interval = 120000;
51 // single worksheet for now
51 // single worksheet for now
52 this.worksheet_metadata = {};
52 this.worksheet_metadata = {};
53 this.control_key_active = false;
53 this.control_key_active = false;
54 this.notebook_name_blacklist_re = /[\/\\:]/;
54 this.notebook_name_blacklist_re = /[\/\\:]/;
55 this.nbformat = 3 // Increment this when changing the nbformat
55 this.nbformat = 3 // Increment this when changing the nbformat
56 this.nbformat_minor = 0 // Increment this when changing the nbformat
56 this.nbformat_minor = 0 // Increment this when changing the nbformat
57 this.style();
57 this.style();
58 this.create_elements();
58 this.create_elements();
59 this.bind_events();
59 this.bind_events();
60 };
60 };
61
61
62 /**
62 /**
63 * Tweak the notebook's CSS style.
63 * Tweak the notebook's CSS style.
64 *
64 *
65 * @method style
65 * @method style
66 */
66 */
67 Notebook.prototype.style = function () {
67 Notebook.prototype.style = function () {
68 $('div#notebook').addClass('border-box-sizing');
68 $('div#notebook').addClass('border-box-sizing');
69 };
69 };
70
70
71 /**
71 /**
72 * Get the root URL of the notebook server.
72 * Get the root URL of the notebook server.
73 *
73 *
74 * @method baseProjectUrl
74 * @method baseProjectUrl
75 * @return {String} The base project URL
75 * @return {String} The base project URL
76 */
76 */
77 Notebook.prototype.baseProjectUrl = function(){
77 Notebook.prototype.baseProjectUrl = function(){
78 return this._baseProjectUrl || $('body').data('baseProjectUrl');
78 return this._baseProjectUrl || $('body').data('baseProjectUrl');
79 };
79 };
80
80
81 Notebook.prototype.notebookName = function() {
81 Notebook.prototype.notebookName = function() {
82 var name = $('body').data('notebookName');
82 var name = $('body').data('notebookName');
83 name = decodeURIComponent(name);
83 name = decodeURIComponent(name);
84 return name;
84 return name;
85 };
85 };
86
86
87 Notebook.prototype.notebookPath = function() {
87 Notebook.prototype.notebookPath = function() {
88 var path = $('body').data('notebookPath');
88 var path = $('body').data('notebookPath');
89 path = decodeURIComponent(path);
89 path = decodeURIComponent(path);
90 return path
90 return path
91 };
91 };
92
92
93 /**
93 /**
94 * Create an HTML and CSS representation of the notebook.
94 * Create an HTML and CSS representation of the notebook.
95 *
95 *
96 * @method create_elements
96 * @method create_elements
97 */
97 */
98 Notebook.prototype.create_elements = function () {
98 Notebook.prototype.create_elements = function () {
99 // We add this end_space div to the end of the notebook div to:
99 // We add this end_space div to the end of the notebook div to:
100 // i) provide a margin between the last cell and the end of the notebook
100 // i) provide a margin between the last cell and the end of the notebook
101 // ii) to prevent the div from scrolling up when the last cell is being
101 // ii) to prevent the div from scrolling up when the last cell is being
102 // edited, but is too low on the page, which browsers will do automatically.
102 // edited, but is too low on the page, which browsers will do automatically.
103 var that = this;
103 var that = this;
104 this.container = $("<div/>").addClass("container").attr("id", "notebook-container");
104 this.container = $("<div/>").addClass("container").attr("id", "notebook-container");
105 var end_space = $('<div/>').addClass('end_space');
105 var end_space = $('<div/>').addClass('end_space');
106 end_space.dblclick(function (e) {
106 end_space.dblclick(function (e) {
107 var ncells = that.ncells();
107 var ncells = that.ncells();
108 that.insert_cell_below('code',ncells-1);
108 that.insert_cell_below('code',ncells-1);
109 });
109 });
110 this.element.append(this.container);
110 this.element.append(this.container);
111 this.container.append(end_space);
111 this.container.append(end_space);
112 $('div#notebook').addClass('border-box-sizing');
112 $('div#notebook').addClass('border-box-sizing');
113 };
113 };
114
114
115 /**
115 /**
116 * Bind JavaScript events: key presses and custom IPython events.
116 * Bind JavaScript events: key presses and custom IPython events.
117 *
117 *
118 * @method bind_events
118 * @method bind_events
119 */
119 */
120 Notebook.prototype.bind_events = function () {
120 Notebook.prototype.bind_events = function () {
121 var that = this;
121 var that = this;
122
122
123 $([IPython.events]).on('set_next_input.Notebook', function (event, data) {
123 $([IPython.events]).on('set_next_input.Notebook', function (event, data) {
124 var index = that.find_cell_index(data.cell);
124 var index = that.find_cell_index(data.cell);
125 var new_cell = that.insert_cell_below('code',index);
125 var new_cell = that.insert_cell_below('code',index);
126 new_cell.set_text(data.text);
126 new_cell.set_text(data.text);
127 that.dirty = true;
127 that.dirty = true;
128 });
128 });
129
129
130 $([IPython.events]).on('set_dirty.Notebook', function (event, data) {
130 $([IPython.events]).on('set_dirty.Notebook', function (event, data) {
131 that.dirty = data.value;
131 that.dirty = data.value;
132 });
132 });
133
133
134 $([IPython.events]).on('select.Cell', function (event, data) {
134 $([IPython.events]).on('select.Cell', function (event, data) {
135 var index = that.find_cell_index(data.cell);
135 var index = that.find_cell_index(data.cell);
136 that.select(index);
136 that.select(index);
137 });
137 });
138
138
139 $([IPython.events]).on('status_autorestarting.Kernel', function () {
139 $([IPython.events]).on('status_autorestarting.Kernel', function () {
140 IPython.dialog.modal({
140 IPython.dialog.modal({
141 title: "Kernel Restarting",
141 title: "Kernel Restarting",
142 body: "The kernel appears to have died. It will restart automatically.",
142 body: "The kernel appears to have died. It will restart automatically.",
143 buttons: {
143 buttons: {
144 OK : {
144 OK : {
145 class : "btn-primary"
145 class : "btn-primary"
146 }
146 }
147 }
147 }
148 });
148 });
149 });
149 });
150
150
151
151
152 $(document).keydown(function (event) {
152 $(document).keydown(function (event) {
153
153
154 // Save (CTRL+S) or (AppleKey+S)
154 // Save (CTRL+S) or (AppleKey+S)
155 //metaKey = applekey on mac
155 //metaKey = applekey on mac
156 if ((event.ctrlKey || event.metaKey) && event.keyCode==83) {
156 if ((event.ctrlKey || event.metaKey) && event.keyCode==83) {
157 that.save_checkpoint();
157 that.save_checkpoint();
158 event.preventDefault();
158 event.preventDefault();
159 return false;
159 return false;
160 } else if (event.which === key.ESC) {
160 } else if (event.which === key.ESC) {
161 // Intercept escape at highest level to avoid closing
161 // Intercept escape at highest level to avoid closing
162 // websocket connection with firefox
162 // websocket connection with firefox
163 IPython.pager.collapse();
163 IPython.pager.collapse();
164 event.preventDefault();
164 event.preventDefault();
165 } else if (event.which === key.SHIFT) {
165 } else if (event.which === key.SHIFT) {
166 // ignore shift keydown
166 // ignore shift keydown
167 return true;
167 return true;
168 }
168 }
169 if (event.which === key.UPARROW && !event.shiftKey) {
169 if (event.which === key.UPARROW && !event.shiftKey) {
170 var cell = that.get_selected_cell();
170 var cell = that.get_selected_cell();
171 if (cell && cell.at_top()) {
171 if (cell && cell.at_top()) {
172 event.preventDefault();
172 event.preventDefault();
173 that.select_prev();
173 that.select_prev();
174 };
174 };
175 } else if (event.which === key.DOWNARROW && !event.shiftKey) {
175 } else if (event.which === key.DOWNARROW && !event.shiftKey) {
176 var cell = that.get_selected_cell();
176 var cell = that.get_selected_cell();
177 if (cell && cell.at_bottom()) {
177 if (cell && cell.at_bottom()) {
178 event.preventDefault();
178 event.preventDefault();
179 that.select_next();
179 that.select_next();
180 };
180 };
181 } else if (event.which === key.ENTER && event.shiftKey) {
181 } else if (event.which === key.ENTER && event.shiftKey) {
182 that.execute_selected_cell();
182 that.execute_selected_cell();
183 return false;
183 return false;
184 } else if (event.which === key.ENTER && event.altKey) {
184 } else if (event.which === key.ENTER && event.altKey) {
185 // Execute code cell, and insert new in place
185 // Execute code cell, and insert new in place
186 that.execute_selected_cell();
186 that.execute_selected_cell();
187 // Only insert a new cell, if we ended up in an already populated cell
187 // Only insert a new cell, if we ended up in an already populated cell
188 if (/\S/.test(that.get_selected_cell().get_text()) == true) {
188 if (/\S/.test(that.get_selected_cell().get_text()) == true) {
189 that.insert_cell_above('code');
189 that.insert_cell_above('code');
190 }
190 }
191 return false;
191 return false;
192 } else if (event.which === key.ENTER && event.ctrlKey) {
192 } else if (event.which === key.ENTER && event.ctrlKey) {
193 that.execute_selected_cell({terminal:true});
193 that.execute_selected_cell({terminal:true});
194 return false;
194 return false;
195 } else if (event.which === 77 && event.ctrlKey && that.control_key_active == false) {
195 } else if (event.which === 77 && event.ctrlKey && that.control_key_active == false) {
196 that.control_key_active = true;
196 that.control_key_active = true;
197 return false;
197 return false;
198 } else if (event.which === 88 && that.control_key_active) {
198 } else if (event.which === 88 && that.control_key_active) {
199 // Cut selected cell = x
199 // Cut selected cell = x
200 that.cut_cell();
200 that.cut_cell();
201 that.control_key_active = false;
201 that.control_key_active = false;
202 return false;
202 return false;
203 } else if (event.which === 67 && that.control_key_active) {
203 } else if (event.which === 67 && that.control_key_active) {
204 // Copy selected cell = c
204 // Copy selected cell = c
205 that.copy_cell();
205 that.copy_cell();
206 that.control_key_active = false;
206 that.control_key_active = false;
207 return false;
207 return false;
208 } else if (event.which === 86 && that.control_key_active) {
208 } else if (event.which === 86 && that.control_key_active) {
209 // Paste below selected cell = v
209 // Paste below selected cell = v
210 that.paste_cell_below();
210 that.paste_cell_below();
211 that.control_key_active = false;
211 that.control_key_active = false;
212 return false;
212 return false;
213 } else if (event.which === 68 && that.control_key_active) {
213 } else if (event.which === 68 && that.control_key_active) {
214 // Delete selected cell = d
214 // Delete selected cell = d
215 that.delete_cell();
215 that.delete_cell();
216 that.control_key_active = false;
216 that.control_key_active = false;
217 return false;
217 return false;
218 } else if (event.which === 65 && that.control_key_active) {
218 } else if (event.which === 65 && that.control_key_active) {
219 // Insert code cell above selected = a
219 // Insert code cell above selected = a
220 that.insert_cell_above('code');
220 that.insert_cell_above('code');
221 that.control_key_active = false;
221 that.control_key_active = false;
222 return false;
222 return false;
223 } else if (event.which === 66 && that.control_key_active) {
223 } else if (event.which === 66 && that.control_key_active) {
224 // Insert code cell below selected = b
224 // Insert code cell below selected = b
225 that.insert_cell_below('code');
225 that.insert_cell_below('code');
226 that.control_key_active = false;
226 that.control_key_active = false;
227 return false;
227 return false;
228 } else if (event.which === 89 && that.control_key_active) {
228 } else if (event.which === 89 && that.control_key_active) {
229 // To code = y
229 // To code = y
230 that.to_code();
230 that.to_code();
231 that.control_key_active = false;
231 that.control_key_active = false;
232 return false;
232 return false;
233 } else if (event.which === 77 && that.control_key_active) {
233 } else if (event.which === 77 && that.control_key_active) {
234 // To markdown = m
234 // To markdown = m
235 that.to_markdown();
235 that.to_markdown();
236 that.control_key_active = false;
236 that.control_key_active = false;
237 return false;
237 return false;
238 } else if (event.which === 84 && that.control_key_active) {
238 } else if (event.which === 84 && that.control_key_active) {
239 // To Raw = t
239 // To Raw = t
240 that.to_raw();
240 that.to_raw();
241 that.control_key_active = false;
241 that.control_key_active = false;
242 return false;
242 return false;
243 } else if (event.which === 49 && that.control_key_active) {
243 } else if (event.which === 49 && that.control_key_active) {
244 // To Heading 1 = 1
244 // To Heading 1 = 1
245 that.to_heading(undefined, 1);
245 that.to_heading(undefined, 1);
246 that.control_key_active = false;
246 that.control_key_active = false;
247 return false;
247 return false;
248 } else if (event.which === 50 && that.control_key_active) {
248 } else if (event.which === 50 && that.control_key_active) {
249 // To Heading 2 = 2
249 // To Heading 2 = 2
250 that.to_heading(undefined, 2);
250 that.to_heading(undefined, 2);
251 that.control_key_active = false;
251 that.control_key_active = false;
252 return false;
252 return false;
253 } else if (event.which === 51 && that.control_key_active) {
253 } else if (event.which === 51 && that.control_key_active) {
254 // To Heading 3 = 3
254 // To Heading 3 = 3
255 that.to_heading(undefined, 3);
255 that.to_heading(undefined, 3);
256 that.control_key_active = false;
256 that.control_key_active = false;
257 return false;
257 return false;
258 } else if (event.which === 52 && that.control_key_active) {
258 } else if (event.which === 52 && that.control_key_active) {
259 // To Heading 4 = 4
259 // To Heading 4 = 4
260 that.to_heading(undefined, 4);
260 that.to_heading(undefined, 4);
261 that.control_key_active = false;
261 that.control_key_active = false;
262 return false;
262 return false;
263 } else if (event.which === 53 && that.control_key_active) {
263 } else if (event.which === 53 && that.control_key_active) {
264 // To Heading 5 = 5
264 // To Heading 5 = 5
265 that.to_heading(undefined, 5);
265 that.to_heading(undefined, 5);
266 that.control_key_active = false;
266 that.control_key_active = false;
267 return false;
267 return false;
268 } else if (event.which === 54 && that.control_key_active) {
268 } else if (event.which === 54 && that.control_key_active) {
269 // To Heading 6 = 6
269 // To Heading 6 = 6
270 that.to_heading(undefined, 6);
270 that.to_heading(undefined, 6);
271 that.control_key_active = false;
271 that.control_key_active = false;
272 return false;
272 return false;
273 } else if (event.which === 79 && that.control_key_active) {
273 } else if (event.which === 79 && that.control_key_active) {
274 // Toggle output = o
274 // Toggle output = o
275 if (event.shiftKey){
275 if (event.shiftKey){
276 that.toggle_output_scroll();
276 that.toggle_output_scroll();
277 } else {
277 } else {
278 that.toggle_output();
278 that.toggle_output();
279 }
279 }
280 that.control_key_active = false;
280 that.control_key_active = false;
281 return false;
281 return false;
282 } else if (event.which === 83 && that.control_key_active) {
282 } else if (event.which === 83 && that.control_key_active) {
283 // Save notebook = s
283 // Save notebook = s
284 that.save_checkpoint();
284 that.save_checkpoint();
285 that.control_key_active = false;
285 that.control_key_active = false;
286 return false;
286 return false;
287 } else if (event.which === 74 && that.control_key_active) {
287 } else if (event.which === 74 && that.control_key_active) {
288 // Move cell down = j
288 // Move cell down = j
289 that.move_cell_down();
289 that.move_cell_down();
290 that.control_key_active = false;
290 that.control_key_active = false;
291 return false;
291 return false;
292 } else if (event.which === 75 && that.control_key_active) {
292 } else if (event.which === 75 && that.control_key_active) {
293 // Move cell up = k
293 // Move cell up = k
294 that.move_cell_up();
294 that.move_cell_up();
295 that.control_key_active = false;
295 that.control_key_active = false;
296 return false;
296 return false;
297 } else if (event.which === 80 && that.control_key_active) {
297 } else if (event.which === 80 && that.control_key_active) {
298 // Select previous = p
298 // Select previous = p
299 that.select_prev();
299 that.select_prev();
300 that.control_key_active = false;
300 that.control_key_active = false;
301 return false;
301 return false;
302 } else if (event.which === 78 && that.control_key_active) {
302 } else if (event.which === 78 && that.control_key_active) {
303 // Select next = n
303 // Select next = n
304 that.select_next();
304 that.select_next();
305 that.control_key_active = false;
305 that.control_key_active = false;
306 return false;
306 return false;
307 } else if (event.which === 76 && that.control_key_active) {
307 } else if (event.which === 76 && that.control_key_active) {
308 // Toggle line numbers = l
308 // Toggle line numbers = l
309 that.cell_toggle_line_numbers();
309 that.cell_toggle_line_numbers();
310 that.control_key_active = false;
310 that.control_key_active = false;
311 return false;
311 return false;
312 } else if (event.which === 73 && that.control_key_active) {
312 } else if (event.which === 73 && that.control_key_active) {
313 // Interrupt kernel = i
313 // Interrupt kernel = i
314 that.session.interrupt_kernel();
314 that.session.interrupt_kernel();
315 that.control_key_active = false;
315 that.control_key_active = false;
316 return false;
316 return false;
317 } else if (event.which === 190 && that.control_key_active) {
317 } else if (event.which === 190 && that.control_key_active) {
318 // Restart kernel = . # matches qt console
318 // Restart kernel = . # matches qt console
319 that.restart_kernel();
319 that.restart_kernel();
320 that.control_key_active = false;
320 that.control_key_active = false;
321 return false;
321 return false;
322 } else if (event.which === 72 && that.control_key_active) {
322 } else if (event.which === 72 && that.control_key_active) {
323 // Show keyboard shortcuts = h
323 // Show keyboard shortcuts = h
324 IPython.quick_help.show_keyboard_shortcuts();
324 IPython.quick_help.show_keyboard_shortcuts();
325 that.control_key_active = false;
325 that.control_key_active = false;
326 return false;
326 return false;
327 } else if (event.which === 90 && that.control_key_active) {
327 } else if (event.which === 90 && that.control_key_active) {
328 // Undo last cell delete = z
328 // Undo last cell delete = z
329 that.undelete();
329 that.undelete();
330 that.control_key_active = false;
330 that.control_key_active = false;
331 return false;
331 return false;
332 } else if ((event.which === 189 || event.which === 173) &&
332 } else if ((event.which === 189 || event.which === 173) &&
333 that.control_key_active) {
333 that.control_key_active) {
334 // how fun! '-' is 189 in Chrome, but 173 in FF and Opera
334 // how fun! '-' is 189 in Chrome, but 173 in FF and Opera
335 // Split cell = -
335 // Split cell = -
336 that.split_cell();
336 that.split_cell();
337 that.control_key_active = false;
337 that.control_key_active = false;
338 return false;
338 return false;
339 } else if (that.control_key_active) {
339 } else if (that.control_key_active) {
340 that.control_key_active = false;
340 that.control_key_active = false;
341 return true;
341 return true;
342 }
342 }
343 return true;
343 return true;
344 });
344 });
345
345
346 var collapse_time = function(time){
346 var collapse_time = function(time){
347 var app_height = $('#ipython-main-app').height(); // content height
347 var app_height = $('#ipython-main-app').height(); // content height
348 var splitter_height = $('div#pager_splitter').outerHeight(true);
348 var splitter_height = $('div#pager_splitter').outerHeight(true);
349 var new_height = app_height - splitter_height;
349 var new_height = app_height - splitter_height;
350 that.element.animate({height : new_height + 'px'}, time);
350 that.element.animate({height : new_height + 'px'}, time);
351 }
351 }
352
352
353 this.element.bind('collapse_pager', function (event,extrap) {
353 this.element.bind('collapse_pager', function (event,extrap) {
354 var time = (extrap != undefined) ? ((extrap.duration != undefined ) ? extrap.duration : 'fast') : 'fast';
354 var time = (extrap != undefined) ? ((extrap.duration != undefined ) ? extrap.duration : 'fast') : 'fast';
355 collapse_time(time);
355 collapse_time(time);
356 });
356 });
357
357
358 var expand_time = function(time) {
358 var expand_time = function(time) {
359 var app_height = $('#ipython-main-app').height(); // content height
359 var app_height = $('#ipython-main-app').height(); // content height
360 var splitter_height = $('div#pager_splitter').outerHeight(true);
360 var splitter_height = $('div#pager_splitter').outerHeight(true);
361 var pager_height = $('div#pager').outerHeight(true);
361 var pager_height = $('div#pager').outerHeight(true);
362 var new_height = app_height - pager_height - splitter_height;
362 var new_height = app_height - pager_height - splitter_height;
363 that.element.animate({height : new_height + 'px'}, time);
363 that.element.animate({height : new_height + 'px'}, time);
364 }
364 }
365
365
366 this.element.bind('expand_pager', function (event, extrap) {
366 this.element.bind('expand_pager', function (event, extrap) {
367 var time = (extrap != undefined) ? ((extrap.duration != undefined ) ? extrap.duration : 'fast') : 'fast';
367 var time = (extrap != undefined) ? ((extrap.duration != undefined ) ? extrap.duration : 'fast') : 'fast';
368 expand_time(time);
368 expand_time(time);
369 });
369 });
370
370
371 // Firefox 22 broke $(window).on("beforeunload")
371 // Firefox 22 broke $(window).on("beforeunload")
372 // I'm not sure why or how.
372 // I'm not sure why or how.
373 window.onbeforeunload = function (e) {
373 window.onbeforeunload = function (e) {
374 // TODO: Make killing the kernel configurable.
374 // TODO: Make killing the kernel configurable.
375 var kill_kernel = false;
375 var kill_kernel = false;
376 if (kill_kernel) {
376 if (kill_kernel) {
377 that.session.kill_kernel();
377 that.session.kill_kernel();
378 }
378 }
379 // if we are autosaving, trigger an autosave on nav-away.
379 // if we are autosaving, trigger an autosave on nav-away.
380 // still warn, because if we don't the autosave may fail.
380 // still warn, because if we don't the autosave may fail.
381 if (that.dirty) {
381 if (that.dirty) {
382 if ( that.autosave_interval ) {
382 if ( that.autosave_interval ) {
383 // schedule autosave in a timeout
383 // schedule autosave in a timeout
384 // this gives you a chance to forcefully discard changes
384 // this gives you a chance to forcefully discard changes
385 // by reloading the page if you *really* want to.
385 // by reloading the page if you *really* want to.
386 // the timer doesn't start until you *dismiss* the dialog.
386 // the timer doesn't start until you *dismiss* the dialog.
387 setTimeout(function () {
387 setTimeout(function () {
388 if (that.dirty) {
388 if (that.dirty) {
389 that.save_notebook();
389 that.save_notebook();
390 }
390 }
391 }, 1000);
391 }, 1000);
392 return "Autosave in progress, latest changes may be lost.";
392 return "Autosave in progress, latest changes may be lost.";
393 } else {
393 } else {
394 return "Unsaved changes will be lost.";
394 return "Unsaved changes will be lost.";
395 }
395 }
396 };
396 };
397 // Null is the *only* return value that will make the browser not
397 // Null is the *only* return value that will make the browser not
398 // pop up the "don't leave" dialog.
398 // pop up the "don't leave" dialog.
399 return null;
399 return null;
400 };
400 };
401 };
401 };
402
402
403 /**
403 /**
404 * Set the dirty flag, and trigger the set_dirty.Notebook event
404 * Set the dirty flag, and trigger the set_dirty.Notebook event
405 *
405 *
406 * @method set_dirty
406 * @method set_dirty
407 */
407 */
408 Notebook.prototype.set_dirty = function (value) {
408 Notebook.prototype.set_dirty = function (value) {
409 if (value === undefined) {
409 if (value === undefined) {
410 value = true;
410 value = true;
411 }
411 }
412 if (this.dirty == value) {
412 if (this.dirty == value) {
413 return;
413 return;
414 }
414 }
415 $([IPython.events]).trigger('set_dirty.Notebook', {value: value});
415 $([IPython.events]).trigger('set_dirty.Notebook', {value: value});
416 };
416 };
417
417
418 /**
418 /**
419 * Scroll the top of the page to a given cell.
419 * Scroll the top of the page to a given cell.
420 *
420 *
421 * @method scroll_to_cell
421 * @method scroll_to_cell
422 * @param {Number} cell_number An index of the cell to view
422 * @param {Number} cell_number An index of the cell to view
423 * @param {Number} time Animation time in milliseconds
423 * @param {Number} time Animation time in milliseconds
424 * @return {Number} Pixel offset from the top of the container
424 * @return {Number} Pixel offset from the top of the container
425 */
425 */
426 Notebook.prototype.scroll_to_cell = function (cell_number, time) {
426 Notebook.prototype.scroll_to_cell = function (cell_number, time) {
427 var cells = this.get_cells();
427 var cells = this.get_cells();
428 var time = time || 0;
428 var time = time || 0;
429 cell_number = Math.min(cells.length-1,cell_number);
429 cell_number = Math.min(cells.length-1,cell_number);
430 cell_number = Math.max(0 ,cell_number);
430 cell_number = Math.max(0 ,cell_number);
431 var scroll_value = cells[cell_number].element.position().top-cells[0].element.position().top ;
431 var scroll_value = cells[cell_number].element.position().top-cells[0].element.position().top ;
432 this.element.animate({scrollTop:scroll_value}, time);
432 this.element.animate({scrollTop:scroll_value}, time);
433 return scroll_value;
433 return scroll_value;
434 };
434 };
435
435
436 /**
436 /**
437 * Scroll to the bottom of the page.
437 * Scroll to the bottom of the page.
438 *
438 *
439 * @method scroll_to_bottom
439 * @method scroll_to_bottom
440 */
440 */
441 Notebook.prototype.scroll_to_bottom = function () {
441 Notebook.prototype.scroll_to_bottom = function () {
442 this.element.animate({scrollTop:this.element.get(0).scrollHeight}, 0);
442 this.element.animate({scrollTop:this.element.get(0).scrollHeight}, 0);
443 };
443 };
444
444
445 /**
445 /**
446 * Scroll to the top of the page.
446 * Scroll to the top of the page.
447 *
447 *
448 * @method scroll_to_top
448 * @method scroll_to_top
449 */
449 */
450 Notebook.prototype.scroll_to_top = function () {
450 Notebook.prototype.scroll_to_top = function () {
451 this.element.animate({scrollTop:0}, 0);
451 this.element.animate({scrollTop:0}, 0);
452 };
452 };
453
453
454 // Edit Notebook metadata
454 // Edit Notebook metadata
455
455
456 Notebook.prototype.edit_metadata = function () {
456 Notebook.prototype.edit_metadata = function () {
457 var that = this;
457 var that = this;
458 IPython.dialog.edit_metadata(this.metadata, function (md) {
458 IPython.dialog.edit_metadata(this.metadata, function (md) {
459 that.metadata = md;
459 that.metadata = md;
460 }, 'Notebook');
460 }, 'Notebook');
461 };
461 };
462
462
463 // Cell indexing, retrieval, etc.
463 // Cell indexing, retrieval, etc.
464
464
465 /**
465 /**
466 * Get all cell elements in the notebook.
466 * Get all cell elements in the notebook.
467 *
467 *
468 * @method get_cell_elements
468 * @method get_cell_elements
469 * @return {jQuery} A selector of all cell elements
469 * @return {jQuery} A selector of all cell elements
470 */
470 */
471 Notebook.prototype.get_cell_elements = function () {
471 Notebook.prototype.get_cell_elements = function () {
472 return this.container.children("div.cell");
472 return this.container.children("div.cell");
473 };
473 };
474
474
475 /**
475 /**
476 * Get a particular cell element.
476 * Get a particular cell element.
477 *
477 *
478 * @method get_cell_element
478 * @method get_cell_element
479 * @param {Number} index An index of a cell to select
479 * @param {Number} index An index of a cell to select
480 * @return {jQuery} A selector of the given cell.
480 * @return {jQuery} A selector of the given cell.
481 */
481 */
482 Notebook.prototype.get_cell_element = function (index) {
482 Notebook.prototype.get_cell_element = function (index) {
483 var result = null;
483 var result = null;
484 var e = this.get_cell_elements().eq(index);
484 var e = this.get_cell_elements().eq(index);
485 if (e.length !== 0) {
485 if (e.length !== 0) {
486 result = e;
486 result = e;
487 }
487 }
488 return result;
488 return result;
489 };
489 };
490
490
491 /**
491 /**
492 * Count the cells in this notebook.
492 * Count the cells in this notebook.
493 *
493 *
494 * @method ncells
494 * @method ncells
495 * @return {Number} The number of cells in this notebook
495 * @return {Number} The number of cells in this notebook
496 */
496 */
497 Notebook.prototype.ncells = function () {
497 Notebook.prototype.ncells = function () {
498 return this.get_cell_elements().length;
498 return this.get_cell_elements().length;
499 };
499 };
500
500
501 /**
501 /**
502 * Get all Cell objects in this notebook.
502 * Get all Cell objects in this notebook.
503 *
503 *
504 * @method get_cells
504 * @method get_cells
505 * @return {Array} This notebook's Cell objects
505 * @return {Array} This notebook's Cell objects
506 */
506 */
507 // TODO: we are often calling cells as cells()[i], which we should optimize
507 // TODO: we are often calling cells as cells()[i], which we should optimize
508 // to cells(i) or a new method.
508 // to cells(i) or a new method.
509 Notebook.prototype.get_cells = function () {
509 Notebook.prototype.get_cells = function () {
510 return this.get_cell_elements().toArray().map(function (e) {
510 return this.get_cell_elements().toArray().map(function (e) {
511 return $(e).data("cell");
511 return $(e).data("cell");
512 });
512 });
513 };
513 };
514
514
515 /**
515 /**
516 * Get a Cell object from this notebook.
516 * Get a Cell object from this notebook.
517 *
517 *
518 * @method get_cell
518 * @method get_cell
519 * @param {Number} index An index of a cell to retrieve
519 * @param {Number} index An index of a cell to retrieve
520 * @return {Cell} A particular cell
520 * @return {Cell} A particular cell
521 */
521 */
522 Notebook.prototype.get_cell = function (index) {
522 Notebook.prototype.get_cell = function (index) {
523 var result = null;
523 var result = null;
524 var ce = this.get_cell_element(index);
524 var ce = this.get_cell_element(index);
525 if (ce !== null) {
525 if (ce !== null) {
526 result = ce.data('cell');
526 result = ce.data('cell');
527 }
527 }
528 return result;
528 return result;
529 }
529 }
530
530
531 /**
531 /**
532 * Get the cell below a given cell.
532 * Get the cell below a given cell.
533 *
533 *
534 * @method get_next_cell
534 * @method get_next_cell
535 * @param {Cell} cell The provided cell
535 * @param {Cell} cell The provided cell
536 * @return {Cell} The next cell
536 * @return {Cell} The next cell
537 */
537 */
538 Notebook.prototype.get_next_cell = function (cell) {
538 Notebook.prototype.get_next_cell = function (cell) {
539 var result = null;
539 var result = null;
540 var index = this.find_cell_index(cell);
540 var index = this.find_cell_index(cell);
541 if (this.is_valid_cell_index(index+1)) {
541 if (this.is_valid_cell_index(index+1)) {
542 result = this.get_cell(index+1);
542 result = this.get_cell(index+1);
543 }
543 }
544 return result;
544 return result;
545 }
545 }
546
546
547 /**
547 /**
548 * Get the cell above a given cell.
548 * Get the cell above a given cell.
549 *
549 *
550 * @method get_prev_cell
550 * @method get_prev_cell
551 * @param {Cell} cell The provided cell
551 * @param {Cell} cell The provided cell
552 * @return {Cell} The previous cell
552 * @return {Cell} The previous cell
553 */
553 */
554 Notebook.prototype.get_prev_cell = function (cell) {
554 Notebook.prototype.get_prev_cell = function (cell) {
555 // TODO: off-by-one
555 // TODO: off-by-one
556 // nb.get_prev_cell(nb.get_cell(1)) is null
556 // nb.get_prev_cell(nb.get_cell(1)) is null
557 var result = null;
557 var result = null;
558 var index = this.find_cell_index(cell);
558 var index = this.find_cell_index(cell);
559 if (index !== null && index > 1) {
559 if (index !== null && index > 1) {
560 result = this.get_cell(index-1);
560 result = this.get_cell(index-1);
561 }
561 }
562 return result;
562 return result;
563 }
563 }
564
564
565 /**
565 /**
566 * Get the numeric index of a given cell.
566 * Get the numeric index of a given cell.
567 *
567 *
568 * @method find_cell_index
568 * @method find_cell_index
569 * @param {Cell} cell The provided cell
569 * @param {Cell} cell The provided cell
570 * @return {Number} The cell's numeric index
570 * @return {Number} The cell's numeric index
571 */
571 */
572 Notebook.prototype.find_cell_index = function (cell) {
572 Notebook.prototype.find_cell_index = function (cell) {
573 var result = null;
573 var result = null;
574 this.get_cell_elements().filter(function (index) {
574 this.get_cell_elements().filter(function (index) {
575 if ($(this).data("cell") === cell) {
575 if ($(this).data("cell") === cell) {
576 result = index;
576 result = index;
577 };
577 };
578 });
578 });
579 return result;
579 return result;
580 };
580 };
581
581
582 /**
582 /**
583 * Get a given index , or the selected index if none is provided.
583 * Get a given index , or the selected index if none is provided.
584 *
584 *
585 * @method index_or_selected
585 * @method index_or_selected
586 * @param {Number} index A cell's index
586 * @param {Number} index A cell's index
587 * @return {Number} The given index, or selected index if none is provided.
587 * @return {Number} The given index, or selected index if none is provided.
588 */
588 */
589 Notebook.prototype.index_or_selected = function (index) {
589 Notebook.prototype.index_or_selected = function (index) {
590 var i;
590 var i;
591 if (index === undefined || index === null) {
591 if (index === undefined || index === null) {
592 i = this.get_selected_index();
592 i = this.get_selected_index();
593 if (i === null) {
593 if (i === null) {
594 i = 0;
594 i = 0;
595 }
595 }
596 } else {
596 } else {
597 i = index;
597 i = index;
598 }
598 }
599 return i;
599 return i;
600 };
600 };
601
601
602 /**
602 /**
603 * Get the currently selected cell.
603 * Get the currently selected cell.
604 * @method get_selected_cell
604 * @method get_selected_cell
605 * @return {Cell} The selected cell
605 * @return {Cell} The selected cell
606 */
606 */
607 Notebook.prototype.get_selected_cell = function () {
607 Notebook.prototype.get_selected_cell = function () {
608 var index = this.get_selected_index();
608 var index = this.get_selected_index();
609 return this.get_cell(index);
609 return this.get_cell(index);
610 };
610 };
611
611
612 /**
612 /**
613 * Check whether a cell index is valid.
613 * Check whether a cell index is valid.
614 *
614 *
615 * @method is_valid_cell_index
615 * @method is_valid_cell_index
616 * @param {Number} index A cell index
616 * @param {Number} index A cell index
617 * @return True if the index is valid, false otherwise
617 * @return True if the index is valid, false otherwise
618 */
618 */
619 Notebook.prototype.is_valid_cell_index = function (index) {
619 Notebook.prototype.is_valid_cell_index = function (index) {
620 if (index !== null && index >= 0 && index < this.ncells()) {
620 if (index !== null && index >= 0 && index < this.ncells()) {
621 return true;
621 return true;
622 } else {
622 } else {
623 return false;
623 return false;
624 };
624 };
625 }
625 }
626
626
627 /**
627 /**
628 * Get the index of the currently selected cell.
628 * Get the index of the currently selected cell.
629
629
630 * @method get_selected_index
630 * @method get_selected_index
631 * @return {Number} The selected cell's numeric index
631 * @return {Number} The selected cell's numeric index
632 */
632 */
633 Notebook.prototype.get_selected_index = function () {
633 Notebook.prototype.get_selected_index = function () {
634 var result = null;
634 var result = null;
635 this.get_cell_elements().filter(function (index) {
635 this.get_cell_elements().filter(function (index) {
636 if ($(this).data("cell").selected === true) {
636 if ($(this).data("cell").selected === true) {
637 result = index;
637 result = index;
638 };
638 };
639 });
639 });
640 return result;
640 return result;
641 };
641 };
642
642
643
643
644 // Cell selection.
644 // Cell selection.
645
645
646 /**
646 /**
647 * Programmatically select a cell.
647 * Programmatically select a cell.
648 *
648 *
649 * @method select
649 * @method select
650 * @param {Number} index A cell's index
650 * @param {Number} index A cell's index
651 * @return {Notebook} This notebook
651 * @return {Notebook} This notebook
652 */
652 */
653 Notebook.prototype.select = function (index) {
653 Notebook.prototype.select = function (index) {
654 if (this.is_valid_cell_index(index)) {
654 if (this.is_valid_cell_index(index)) {
655 var sindex = this.get_selected_index()
655 var sindex = this.get_selected_index()
656 if (sindex !== null && index !== sindex) {
656 if (sindex !== null && index !== sindex) {
657 this.get_cell(sindex).unselect();
657 this.get_cell(sindex).unselect();
658 };
658 };
659 var cell = this.get_cell(index);
659 var cell = this.get_cell(index);
660 cell.select();
660 cell.select();
661 if (cell.cell_type === 'heading') {
661 if (cell.cell_type === 'heading') {
662 $([IPython.events]).trigger('selected_cell_type_changed.Notebook',
662 $([IPython.events]).trigger('selected_cell_type_changed.Notebook',
663 {'cell_type':cell.cell_type,level:cell.level}
663 {'cell_type':cell.cell_type,level:cell.level}
664 );
664 );
665 } else {
665 } else {
666 $([IPython.events]).trigger('selected_cell_type_changed.Notebook',
666 $([IPython.events]).trigger('selected_cell_type_changed.Notebook',
667 {'cell_type':cell.cell_type}
667 {'cell_type':cell.cell_type}
668 );
668 );
669 };
669 };
670 };
670 };
671 return this;
671 return this;
672 };
672 };
673
673
674 /**
674 /**
675 * Programmatically select the next cell.
675 * Programmatically select the next cell.
676 *
676 *
677 * @method select_next
677 * @method select_next
678 * @return {Notebook} This notebook
678 * @return {Notebook} This notebook
679 */
679 */
680 Notebook.prototype.select_next = function () {
680 Notebook.prototype.select_next = function () {
681 var index = this.get_selected_index();
681 var index = this.get_selected_index();
682 this.select(index+1);
682 this.select(index+1);
683 return this;
683 return this;
684 };
684 };
685
685
686 /**
686 /**
687 * Programmatically select the previous cell.
687 * Programmatically select the previous cell.
688 *
688 *
689 * @method select_prev
689 * @method select_prev
690 * @return {Notebook} This notebook
690 * @return {Notebook} This notebook
691 */
691 */
692 Notebook.prototype.select_prev = function () {
692 Notebook.prototype.select_prev = function () {
693 var index = this.get_selected_index();
693 var index = this.get_selected_index();
694 this.select(index-1);
694 this.select(index-1);
695 return this;
695 return this;
696 };
696 };
697
697
698
698
699 // Cell movement
699 // Cell movement
700
700
701 /**
701 /**
702 * Move given (or selected) cell up and select it.
702 * Move given (or selected) cell up and select it.
703 *
703 *
704 * @method move_cell_up
704 * @method move_cell_up
705 * @param [index] {integer} cell index
705 * @param [index] {integer} cell index
706 * @return {Notebook} This notebook
706 * @return {Notebook} This notebook
707 **/
707 **/
708 Notebook.prototype.move_cell_up = function (index) {
708 Notebook.prototype.move_cell_up = function (index) {
709 var i = this.index_or_selected(index);
709 var i = this.index_or_selected(index);
710 if (this.is_valid_cell_index(i) && i > 0) {
710 if (this.is_valid_cell_index(i) && i > 0) {
711 var pivot = this.get_cell_element(i-1);
711 var pivot = this.get_cell_element(i-1);
712 var tomove = this.get_cell_element(i);
712 var tomove = this.get_cell_element(i);
713 if (pivot !== null && tomove !== null) {
713 if (pivot !== null && tomove !== null) {
714 tomove.detach();
714 tomove.detach();
715 pivot.before(tomove);
715 pivot.before(tomove);
716 this.select(i-1);
716 this.select(i-1);
717 };
717 };
718 this.set_dirty(true);
718 this.set_dirty(true);
719 };
719 };
720 return this;
720 return this;
721 };
721 };
722
722
723
723
724 /**
724 /**
725 * Move given (or selected) cell down and select it
725 * Move given (or selected) cell down and select it
726 *
726 *
727 * @method move_cell_down
727 * @method move_cell_down
728 * @param [index] {integer} cell index
728 * @param [index] {integer} cell index
729 * @return {Notebook} This notebook
729 * @return {Notebook} This notebook
730 **/
730 **/
731 Notebook.prototype.move_cell_down = function (index) {
731 Notebook.prototype.move_cell_down = function (index) {
732 var i = this.index_or_selected(index);
732 var i = this.index_or_selected(index);
733 if ( this.is_valid_cell_index(i) && this.is_valid_cell_index(i+1)) {
733 if ( this.is_valid_cell_index(i) && this.is_valid_cell_index(i+1)) {
734 var pivot = this.get_cell_element(i+1);
734 var pivot = this.get_cell_element(i+1);
735 var tomove = this.get_cell_element(i);
735 var tomove = this.get_cell_element(i);
736 if (pivot !== null && tomove !== null) {
736 if (pivot !== null && tomove !== null) {
737 tomove.detach();
737 tomove.detach();
738 pivot.after(tomove);
738 pivot.after(tomove);
739 this.select(i+1);
739 this.select(i+1);
740 };
740 };
741 };
741 };
742 this.set_dirty();
742 this.set_dirty();
743 return this;
743 return this;
744 };
744 };
745
745
746
746
747 // Insertion, deletion.
747 // Insertion, deletion.
748
748
749 /**
749 /**
750 * Delete a cell from the notebook.
750 * Delete a cell from the notebook.
751 *
751 *
752 * @method delete_cell
752 * @method delete_cell
753 * @param [index] A cell's numeric index
753 * @param [index] A cell's numeric index
754 * @return {Notebook} This notebook
754 * @return {Notebook} This notebook
755 */
755 */
756 Notebook.prototype.delete_cell = function (index) {
756 Notebook.prototype.delete_cell = function (index) {
757 var i = this.index_or_selected(index);
757 var i = this.index_or_selected(index);
758 var cell = this.get_selected_cell();
758 var cell = this.get_selected_cell();
759 this.undelete_backup = cell.toJSON();
759 this.undelete_backup = cell.toJSON();
760 $('#undelete_cell').removeClass('disabled');
760 $('#undelete_cell').removeClass('disabled');
761 if (this.is_valid_cell_index(i)) {
761 if (this.is_valid_cell_index(i)) {
762 var ce = this.get_cell_element(i);
762 var ce = this.get_cell_element(i);
763 ce.remove();
763 ce.remove();
764 if (i === (this.ncells())) {
764 if (i === (this.ncells())) {
765 this.select(i-1);
765 this.select(i-1);
766 this.undelete_index = i - 1;
766 this.undelete_index = i - 1;
767 this.undelete_below = true;
767 this.undelete_below = true;
768 } else {
768 } else {
769 this.select(i);
769 this.select(i);
770 this.undelete_index = i;
770 this.undelete_index = i;
771 this.undelete_below = false;
771 this.undelete_below = false;
772 };
772 };
773 $([IPython.events]).trigger('delete.Cell', {'cell': cell, 'index': i});
773 $([IPython.events]).trigger('delete.Cell', {'cell': cell, 'index': i});
774 this.set_dirty(true);
774 this.set_dirty(true);
775 };
775 };
776 return this;
776 return this;
777 };
777 };
778
778
779 /**
779 /**
780 * Insert a cell so that after insertion the cell is at given index.
780 * Insert a cell so that after insertion the cell is at given index.
781 *
781 *
782 * Similar to insert_above, but index parameter is mandatory
782 * Similar to insert_above, but index parameter is mandatory
783 *
783 *
784 * Index will be brought back into the accissible range [0,n]
784 * Index will be brought back into the accissible range [0,n]
785 *
785 *
786 * @method insert_cell_at_index
786 * @method insert_cell_at_index
787 * @param type {string} in ['code','markdown','heading']
787 * @param type {string} in ['code','markdown','heading']
788 * @param [index] {int} a valid index where to inser cell
788 * @param [index] {int} a valid index where to inser cell
789 *
789 *
790 * @return cell {cell|null} created cell or null
790 * @return cell {cell|null} created cell or null
791 **/
791 **/
792 Notebook.prototype.insert_cell_at_index = function(type, index){
792 Notebook.prototype.insert_cell_at_index = function(type, index){
793
793
794 var ncells = this.ncells();
794 var ncells = this.ncells();
795 var index = Math.min(index,ncells);
795 var index = Math.min(index,ncells);
796 index = Math.max(index,0);
796 index = Math.max(index,0);
797 var cell = null;
797 var cell = null;
798
798
799 if (ncells === 0 || this.is_valid_cell_index(index) || index === ncells) {
799 if (ncells === 0 || this.is_valid_cell_index(index) || index === ncells) {
800 if (type === 'code') {
800 if (type === 'code') {
801 cell = new IPython.CodeCell(this.kernel);
801 cell = new IPython.CodeCell(this.kernel);
802 cell.set_input_prompt();
802 cell.set_input_prompt();
803 } else if (type === 'markdown') {
803 } else if (type === 'markdown') {
804 cell = new IPython.MarkdownCell();
804 cell = new IPython.MarkdownCell();
805 } else if (type === 'raw') {
805 } else if (type === 'raw') {
806 cell = new IPython.RawCell();
806 cell = new IPython.RawCell();
807 } else if (type === 'heading') {
807 } else if (type === 'heading') {
808 cell = new IPython.HeadingCell();
808 cell = new IPython.HeadingCell();
809 }
809 }
810
810
811 if(this._insert_element_at_index(cell.element,index)){
811 if(this._insert_element_at_index(cell.element,index)){
812 cell.render();
812 cell.render();
813 this.select(this.find_cell_index(cell));
813 this.select(this.find_cell_index(cell));
814 $([IPython.events]).trigger('create.Cell', {'cell': cell, 'index': index});
814 $([IPython.events]).trigger('create.Cell', {'cell': cell, 'index': index});
815 this.set_dirty(true);
815 this.set_dirty(true);
816 }
816 }
817 }
817 }
818 return cell;
818 return cell;
819
819
820 };
820 };
821
821
822 /**
822 /**
823 * Insert an element at given cell index.
823 * Insert an element at given cell index.
824 *
824 *
825 * @method _insert_element_at_index
825 * @method _insert_element_at_index
826 * @param element {dom element} a cell element
826 * @param element {dom element} a cell element
827 * @param [index] {int} a valid index where to inser cell
827 * @param [index] {int} a valid index where to inser cell
828 * @private
828 * @private
829 *
829 *
830 * return true if everything whent fine.
830 * return true if everything whent fine.
831 **/
831 **/
832 Notebook.prototype._insert_element_at_index = function(element, index){
832 Notebook.prototype._insert_element_at_index = function(element, index){
833 if (element === undefined){
833 if (element === undefined){
834 return false;
834 return false;
835 }
835 }
836
836
837 var ncells = this.ncells();
837 var ncells = this.ncells();
838
838
839 if (ncells === 0) {
839 if (ncells === 0) {
840 // special case append if empty
840 // special case append if empty
841 this.element.find('div.end_space').before(element);
841 this.element.find('div.end_space').before(element);
842 } else if ( ncells === index ) {
842 } else if ( ncells === index ) {
843 // special case append it the end, but not empty
843 // special case append it the end, but not empty
844 this.get_cell_element(index-1).after(element);
844 this.get_cell_element(index-1).after(element);
845 } else if (this.is_valid_cell_index(index)) {
845 } else if (this.is_valid_cell_index(index)) {
846 // otherwise always somewhere to append to
846 // otherwise always somewhere to append to
847 this.get_cell_element(index).before(element);
847 this.get_cell_element(index).before(element);
848 } else {
848 } else {
849 return false;
849 return false;
850 }
850 }
851
851
852 if (this.undelete_index !== null && index <= this.undelete_index) {
852 if (this.undelete_index !== null && index <= this.undelete_index) {
853 this.undelete_index = this.undelete_index + 1;
853 this.undelete_index = this.undelete_index + 1;
854 this.set_dirty(true);
854 this.set_dirty(true);
855 }
855 }
856 return true;
856 return true;
857 };
857 };
858
858
859 /**
859 /**
860 * Insert a cell of given type above given index, or at top
860 * Insert a cell of given type above given index, or at top
861 * of notebook if index smaller than 0.
861 * of notebook if index smaller than 0.
862 *
862 *
863 * default index value is the one of currently selected cell
863 * default index value is the one of currently selected cell
864 *
864 *
865 * @method insert_cell_above
865 * @method insert_cell_above
866 * @param type {string} cell type
866 * @param type {string} cell type
867 * @param [index] {integer}
867 * @param [index] {integer}
868 *
868 *
869 * @return handle to created cell or null
869 * @return handle to created cell or null
870 **/
870 **/
871 Notebook.prototype.insert_cell_above = function (type, index) {
871 Notebook.prototype.insert_cell_above = function (type, index) {
872 index = this.index_or_selected(index);
872 index = this.index_or_selected(index);
873 return this.insert_cell_at_index(type, index);
873 return this.insert_cell_at_index(type, index);
874 };
874 };
875
875
876 /**
876 /**
877 * Insert a cell of given type below given index, or at bottom
877 * Insert a cell of given type below given index, or at bottom
878 * of notebook if index greater thatn number of cell
878 * of notebook if index greater thatn number of cell
879 *
879 *
880 * default index value is the one of currently selected cell
880 * default index value is the one of currently selected cell
881 *
881 *
882 * @method insert_cell_below
882 * @method insert_cell_below
883 * @param type {string} cell type
883 * @param type {string} cell type
884 * @param [index] {integer}
884 * @param [index] {integer}
885 *
885 *
886 * @return handle to created cell or null
886 * @return handle to created cell or null
887 *
887 *
888 **/
888 **/
889 Notebook.prototype.insert_cell_below = function (type, index) {
889 Notebook.prototype.insert_cell_below = function (type, index) {
890 index = this.index_or_selected(index);
890 index = this.index_or_selected(index);
891 return this.insert_cell_at_index(type, index+1);
891 return this.insert_cell_at_index(type, index+1);
892 };
892 };
893
893
894
894
895 /**
895 /**
896 * Insert cell at end of notebook
896 * Insert cell at end of notebook
897 *
897 *
898 * @method insert_cell_at_bottom
898 * @method insert_cell_at_bottom
899 * @param {String} type cell type
899 * @param {String} type cell type
900 *
900 *
901 * @return the added cell; or null
901 * @return the added cell; or null
902 **/
902 **/
903 Notebook.prototype.insert_cell_at_bottom = function (type){
903 Notebook.prototype.insert_cell_at_bottom = function (type){
904 var len = this.ncells();
904 var len = this.ncells();
905 return this.insert_cell_below(type,len-1);
905 return this.insert_cell_below(type,len-1);
906 };
906 };
907
907
908 /**
908 /**
909 * Turn a cell into a code cell.
909 * Turn a cell into a code cell.
910 *
910 *
911 * @method to_code
911 * @method to_code
912 * @param {Number} [index] A cell's index
912 * @param {Number} [index] A cell's index
913 */
913 */
914 Notebook.prototype.to_code = function (index) {
914 Notebook.prototype.to_code = function (index) {
915 var i = this.index_or_selected(index);
915 var i = this.index_or_selected(index);
916 if (this.is_valid_cell_index(i)) {
916 if (this.is_valid_cell_index(i)) {
917 var source_element = this.get_cell_element(i);
917 var source_element = this.get_cell_element(i);
918 var source_cell = source_element.data("cell");
918 var source_cell = source_element.data("cell");
919 if (!(source_cell instanceof IPython.CodeCell)) {
919 if (!(source_cell instanceof IPython.CodeCell)) {
920 var target_cell = this.insert_cell_below('code',i);
920 var target_cell = this.insert_cell_below('code',i);
921 var text = source_cell.get_text();
921 var text = source_cell.get_text();
922 if (text === source_cell.placeholder) {
922 if (text === source_cell.placeholder) {
923 text = '';
923 text = '';
924 }
924 }
925 target_cell.set_text(text);
925 target_cell.set_text(text);
926 // make this value the starting point, so that we can only undo
926 // make this value the starting point, so that we can only undo
927 // to this state, instead of a blank cell
927 // to this state, instead of a blank cell
928 target_cell.code_mirror.clearHistory();
928 target_cell.code_mirror.clearHistory();
929 source_element.remove();
929 source_element.remove();
930 this.set_dirty(true);
930 this.set_dirty(true);
931 };
931 };
932 };
932 };
933 };
933 };
934
934
935 /**
935 /**
936 * Turn a cell into a Markdown cell.
936 * Turn a cell into a Markdown cell.
937 *
937 *
938 * @method to_markdown
938 * @method to_markdown
939 * @param {Number} [index] A cell's index
939 * @param {Number} [index] A cell's index
940 */
940 */
941 Notebook.prototype.to_markdown = function (index) {
941 Notebook.prototype.to_markdown = function (index) {
942 var i = this.index_or_selected(index);
942 var i = this.index_or_selected(index);
943 if (this.is_valid_cell_index(i)) {
943 if (this.is_valid_cell_index(i)) {
944 var source_element = this.get_cell_element(i);
944 var source_element = this.get_cell_element(i);
945 var source_cell = source_element.data("cell");
945 var source_cell = source_element.data("cell");
946 if (!(source_cell instanceof IPython.MarkdownCell)) {
946 if (!(source_cell instanceof IPython.MarkdownCell)) {
947 var target_cell = this.insert_cell_below('markdown',i);
947 var target_cell = this.insert_cell_below('markdown',i);
948 var text = source_cell.get_text();
948 var text = source_cell.get_text();
949 if (text === source_cell.placeholder) {
949 if (text === source_cell.placeholder) {
950 text = '';
950 text = '';
951 };
951 };
952 // The edit must come before the set_text.
952 // The edit must come before the set_text.
953 target_cell.edit();
953 target_cell.edit();
954 target_cell.set_text(text);
954 target_cell.set_text(text);
955 // make this value the starting point, so that we can only undo
955 // make this value the starting point, so that we can only undo
956 // to this state, instead of a blank cell
956 // to this state, instead of a blank cell
957 target_cell.code_mirror.clearHistory();
957 target_cell.code_mirror.clearHistory();
958 source_element.remove();
958 source_element.remove();
959 this.set_dirty(true);
959 this.set_dirty(true);
960 };
960 };
961 };
961 };
962 };
962 };
963
963
964 /**
964 /**
965 * Turn a cell into a raw text cell.
965 * Turn a cell into a raw text cell.
966 *
966 *
967 * @method to_raw
967 * @method to_raw
968 * @param {Number} [index] A cell's index
968 * @param {Number} [index] A cell's index
969 */
969 */
970 Notebook.prototype.to_raw = function (index) {
970 Notebook.prototype.to_raw = function (index) {
971 var i = this.index_or_selected(index);
971 var i = this.index_or_selected(index);
972 if (this.is_valid_cell_index(i)) {
972 if (this.is_valid_cell_index(i)) {
973 var source_element = this.get_cell_element(i);
973 var source_element = this.get_cell_element(i);
974 var source_cell = source_element.data("cell");
974 var source_cell = source_element.data("cell");
975 var target_cell = null;
975 var target_cell = null;
976 if (!(source_cell instanceof IPython.RawCell)) {
976 if (!(source_cell instanceof IPython.RawCell)) {
977 target_cell = this.insert_cell_below('raw',i);
977 target_cell = this.insert_cell_below('raw',i);
978 var text = source_cell.get_text();
978 var text = source_cell.get_text();
979 if (text === source_cell.placeholder) {
979 if (text === source_cell.placeholder) {
980 text = '';
980 text = '';
981 };
981 };
982 // The edit must come before the set_text.
982 // The edit must come before the set_text.
983 target_cell.edit();
983 target_cell.edit();
984 target_cell.set_text(text);
984 target_cell.set_text(text);
985 // make this value the starting point, so that we can only undo
985 // make this value the starting point, so that we can only undo
986 // to this state, instead of a blank cell
986 // to this state, instead of a blank cell
987 target_cell.code_mirror.clearHistory();
987 target_cell.code_mirror.clearHistory();
988 source_element.remove();
988 source_element.remove();
989 this.set_dirty(true);
989 this.set_dirty(true);
990 };
990 };
991 };
991 };
992 };
992 };
993
993
994 /**
994 /**
995 * Turn a cell into a heading cell.
995 * Turn a cell into a heading cell.
996 *
996 *
997 * @method to_heading
997 * @method to_heading
998 * @param {Number} [index] A cell's index
998 * @param {Number} [index] A cell's index
999 * @param {Number} [level] A heading level (e.g., 1 becomes &lt;h1&gt;)
999 * @param {Number} [level] A heading level (e.g., 1 becomes &lt;h1&gt;)
1000 */
1000 */
1001 Notebook.prototype.to_heading = function (index, level) {
1001 Notebook.prototype.to_heading = function (index, level) {
1002 level = level || 1;
1002 level = level || 1;
1003 var i = this.index_or_selected(index);
1003 var i = this.index_or_selected(index);
1004 if (this.is_valid_cell_index(i)) {
1004 if (this.is_valid_cell_index(i)) {
1005 var source_element = this.get_cell_element(i);
1005 var source_element = this.get_cell_element(i);
1006 var source_cell = source_element.data("cell");
1006 var source_cell = source_element.data("cell");
1007 var target_cell = null;
1007 var target_cell = null;
1008 if (source_cell instanceof IPython.HeadingCell) {
1008 if (source_cell instanceof IPython.HeadingCell) {
1009 source_cell.set_level(level);
1009 source_cell.set_level(level);
1010 } else {
1010 } else {
1011 target_cell = this.insert_cell_below('heading',i);
1011 target_cell = this.insert_cell_below('heading',i);
1012 var text = source_cell.get_text();
1012 var text = source_cell.get_text();
1013 if (text === source_cell.placeholder) {
1013 if (text === source_cell.placeholder) {
1014 text = '';
1014 text = '';
1015 };
1015 };
1016 // The edit must come before the set_text.
1016 // The edit must come before the set_text.
1017 target_cell.set_level(level);
1017 target_cell.set_level(level);
1018 target_cell.edit();
1018 target_cell.edit();
1019 target_cell.set_text(text);
1019 target_cell.set_text(text);
1020 // make this value the starting point, so that we can only undo
1020 // make this value the starting point, so that we can only undo
1021 // to this state, instead of a blank cell
1021 // to this state, instead of a blank cell
1022 target_cell.code_mirror.clearHistory();
1022 target_cell.code_mirror.clearHistory();
1023 source_element.remove();
1023 source_element.remove();
1024 this.set_dirty(true);
1024 this.set_dirty(true);
1025 };
1025 };
1026 $([IPython.events]).trigger('selected_cell_type_changed.Notebook',
1026 $([IPython.events]).trigger('selected_cell_type_changed.Notebook',
1027 {'cell_type':'heading',level:level}
1027 {'cell_type':'heading',level:level}
1028 );
1028 );
1029 };
1029 };
1030 };
1030 };
1031
1031
1032
1032
1033 // Cut/Copy/Paste
1033 // Cut/Copy/Paste
1034
1034
1035 /**
1035 /**
1036 * Enable UI elements for pasting cells.
1036 * Enable UI elements for pasting cells.
1037 *
1037 *
1038 * @method enable_paste
1038 * @method enable_paste
1039 */
1039 */
1040 Notebook.prototype.enable_paste = function () {
1040 Notebook.prototype.enable_paste = function () {
1041 var that = this;
1041 var that = this;
1042 if (!this.paste_enabled) {
1042 if (!this.paste_enabled) {
1043 $('#paste_cell_replace').removeClass('disabled')
1043 $('#paste_cell_replace').removeClass('disabled')
1044 .on('click', function () {that.paste_cell_replace();});
1044 .on('click', function () {that.paste_cell_replace();});
1045 $('#paste_cell_above').removeClass('disabled')
1045 $('#paste_cell_above').removeClass('disabled')
1046 .on('click', function () {that.paste_cell_above();});
1046 .on('click', function () {that.paste_cell_above();});
1047 $('#paste_cell_below').removeClass('disabled')
1047 $('#paste_cell_below').removeClass('disabled')
1048 .on('click', function () {that.paste_cell_below();});
1048 .on('click', function () {that.paste_cell_below();});
1049 this.paste_enabled = true;
1049 this.paste_enabled = true;
1050 };
1050 };
1051 };
1051 };
1052
1052
1053 /**
1053 /**
1054 * Disable UI elements for pasting cells.
1054 * Disable UI elements for pasting cells.
1055 *
1055 *
1056 * @method disable_paste
1056 * @method disable_paste
1057 */
1057 */
1058 Notebook.prototype.disable_paste = function () {
1058 Notebook.prototype.disable_paste = function () {
1059 if (this.paste_enabled) {
1059 if (this.paste_enabled) {
1060 $('#paste_cell_replace').addClass('disabled').off('click');
1060 $('#paste_cell_replace').addClass('disabled').off('click');
1061 $('#paste_cell_above').addClass('disabled').off('click');
1061 $('#paste_cell_above').addClass('disabled').off('click');
1062 $('#paste_cell_below').addClass('disabled').off('click');
1062 $('#paste_cell_below').addClass('disabled').off('click');
1063 this.paste_enabled = false;
1063 this.paste_enabled = false;
1064 };
1064 };
1065 };
1065 };
1066
1066
1067 /**
1067 /**
1068 * Cut a cell.
1068 * Cut a cell.
1069 *
1069 *
1070 * @method cut_cell
1070 * @method cut_cell
1071 */
1071 */
1072 Notebook.prototype.cut_cell = function () {
1072 Notebook.prototype.cut_cell = function () {
1073 this.copy_cell();
1073 this.copy_cell();
1074 this.delete_cell();
1074 this.delete_cell();
1075 }
1075 }
1076
1076
1077 /**
1077 /**
1078 * Copy a cell.
1078 * Copy a cell.
1079 *
1079 *
1080 * @method copy_cell
1080 * @method copy_cell
1081 */
1081 */
1082 Notebook.prototype.copy_cell = function () {
1082 Notebook.prototype.copy_cell = function () {
1083 var cell = this.get_selected_cell();
1083 var cell = this.get_selected_cell();
1084 this.clipboard = cell.toJSON();
1084 this.clipboard = cell.toJSON();
1085 this.enable_paste();
1085 this.enable_paste();
1086 };
1086 };
1087
1087
1088 /**
1088 /**
1089 * Replace the selected cell with a cell in the clipboard.
1089 * Replace the selected cell with a cell in the clipboard.
1090 *
1090 *
1091 * @method paste_cell_replace
1091 * @method paste_cell_replace
1092 */
1092 */
1093 Notebook.prototype.paste_cell_replace = function () {
1093 Notebook.prototype.paste_cell_replace = function () {
1094 if (this.clipboard !== null && this.paste_enabled) {
1094 if (this.clipboard !== null && this.paste_enabled) {
1095 var cell_data = this.clipboard;
1095 var cell_data = this.clipboard;
1096 var new_cell = this.insert_cell_above(cell_data.cell_type);
1096 var new_cell = this.insert_cell_above(cell_data.cell_type);
1097 new_cell.fromJSON(cell_data);
1097 new_cell.fromJSON(cell_data);
1098 var old_cell = this.get_next_cell(new_cell);
1098 var old_cell = this.get_next_cell(new_cell);
1099 this.delete_cell(this.find_cell_index(old_cell));
1099 this.delete_cell(this.find_cell_index(old_cell));
1100 this.select(this.find_cell_index(new_cell));
1100 this.select(this.find_cell_index(new_cell));
1101 };
1101 };
1102 };
1102 };
1103
1103
1104 /**
1104 /**
1105 * Paste a cell from the clipboard above the selected cell.
1105 * Paste a cell from the clipboard above the selected cell.
1106 *
1106 *
1107 * @method paste_cell_above
1107 * @method paste_cell_above
1108 */
1108 */
1109 Notebook.prototype.paste_cell_above = function () {
1109 Notebook.prototype.paste_cell_above = function () {
1110 if (this.clipboard !== null && this.paste_enabled) {
1110 if (this.clipboard !== null && this.paste_enabled) {
1111 var cell_data = this.clipboard;
1111 var cell_data = this.clipboard;
1112 var new_cell = this.insert_cell_above(cell_data.cell_type);
1112 var new_cell = this.insert_cell_above(cell_data.cell_type);
1113 new_cell.fromJSON(cell_data);
1113 new_cell.fromJSON(cell_data);
1114 };
1114 };
1115 };
1115 };
1116
1116
1117 /**
1117 /**
1118 * Paste a cell from the clipboard below the selected cell.
1118 * Paste a cell from the clipboard below the selected cell.
1119 *
1119 *
1120 * @method paste_cell_below
1120 * @method paste_cell_below
1121 */
1121 */
1122 Notebook.prototype.paste_cell_below = function () {
1122 Notebook.prototype.paste_cell_below = function () {
1123 if (this.clipboard !== null && this.paste_enabled) {
1123 if (this.clipboard !== null && this.paste_enabled) {
1124 var cell_data = this.clipboard;
1124 var cell_data = this.clipboard;
1125 var new_cell = this.insert_cell_below(cell_data.cell_type);
1125 var new_cell = this.insert_cell_below(cell_data.cell_type);
1126 new_cell.fromJSON(cell_data);
1126 new_cell.fromJSON(cell_data);
1127 };
1127 };
1128 };
1128 };
1129
1129
1130 // Cell undelete
1130 // Cell undelete
1131
1131
1132 /**
1132 /**
1133 * Restore the most recently deleted cell.
1133 * Restore the most recently deleted cell.
1134 *
1134 *
1135 * @method undelete
1135 * @method undelete
1136 */
1136 */
1137 Notebook.prototype.undelete = function() {
1137 Notebook.prototype.undelete = function() {
1138 if (this.undelete_backup !== null && this.undelete_index !== null) {
1138 if (this.undelete_backup !== null && this.undelete_index !== null) {
1139 var current_index = this.get_selected_index();
1139 var current_index = this.get_selected_index();
1140 if (this.undelete_index < current_index) {
1140 if (this.undelete_index < current_index) {
1141 current_index = current_index + 1;
1141 current_index = current_index + 1;
1142 }
1142 }
1143 if (this.undelete_index >= this.ncells()) {
1143 if (this.undelete_index >= this.ncells()) {
1144 this.select(this.ncells() - 1);
1144 this.select(this.ncells() - 1);
1145 }
1145 }
1146 else {
1146 else {
1147 this.select(this.undelete_index);
1147 this.select(this.undelete_index);
1148 }
1148 }
1149 var cell_data = this.undelete_backup;
1149 var cell_data = this.undelete_backup;
1150 var new_cell = null;
1150 var new_cell = null;
1151 if (this.undelete_below) {
1151 if (this.undelete_below) {
1152 new_cell = this.insert_cell_below(cell_data.cell_type);
1152 new_cell = this.insert_cell_below(cell_data.cell_type);
1153 } else {
1153 } else {
1154 new_cell = this.insert_cell_above(cell_data.cell_type);
1154 new_cell = this.insert_cell_above(cell_data.cell_type);
1155 }
1155 }
1156 new_cell.fromJSON(cell_data);
1156 new_cell.fromJSON(cell_data);
1157 this.select(current_index);
1157 this.select(current_index);
1158 this.undelete_backup = null;
1158 this.undelete_backup = null;
1159 this.undelete_index = null;
1159 this.undelete_index = null;
1160 }
1160 }
1161 $('#undelete_cell').addClass('disabled');
1161 $('#undelete_cell').addClass('disabled');
1162 }
1162 }
1163
1163
1164 // Split/merge
1164 // Split/merge
1165
1165
1166 /**
1166 /**
1167 * Split the selected cell into two, at the cursor.
1167 * Split the selected cell into two, at the cursor.
1168 *
1168 *
1169 * @method split_cell
1169 * @method split_cell
1170 */
1170 */
1171 Notebook.prototype.split_cell = function () {
1171 Notebook.prototype.split_cell = function () {
1172 // Todo: implement spliting for other cell types.
1172 // Todo: implement spliting for other cell types.
1173 var cell = this.get_selected_cell();
1173 var cell = this.get_selected_cell();
1174 if (cell.is_splittable()) {
1174 if (cell.is_splittable()) {
1175 var texta = cell.get_pre_cursor();
1175 var texta = cell.get_pre_cursor();
1176 var textb = cell.get_post_cursor();
1176 var textb = cell.get_post_cursor();
1177 if (cell instanceof IPython.CodeCell) {
1177 if (cell instanceof IPython.CodeCell) {
1178 cell.set_text(textb);
1178 cell.set_text(textb);
1179 var new_cell = this.insert_cell_above('code');
1179 var new_cell = this.insert_cell_above('code');
1180 new_cell.set_text(texta);
1180 new_cell.set_text(texta);
1181 this.select_next();
1181 this.select_next();
1182 } else if (cell instanceof IPython.MarkdownCell) {
1182 } else if (cell instanceof IPython.MarkdownCell) {
1183 cell.set_text(textb);
1183 cell.set_text(textb);
1184 cell.render();
1184 cell.render();
1185 var new_cell = this.insert_cell_above('markdown');
1185 var new_cell = this.insert_cell_above('markdown');
1186 new_cell.edit(); // editor must be visible to call set_text
1186 new_cell.edit(); // editor must be visible to call set_text
1187 new_cell.set_text(texta);
1187 new_cell.set_text(texta);
1188 new_cell.render();
1188 new_cell.render();
1189 this.select_next();
1189 this.select_next();
1190 }
1190 }
1191 };
1191 };
1192 };
1192 };
1193
1193
1194 /**
1194 /**
1195 * Combine the selected cell into the cell above it.
1195 * Combine the selected cell into the cell above it.
1196 *
1196 *
1197 * @method merge_cell_above
1197 * @method merge_cell_above
1198 */
1198 */
1199 Notebook.prototype.merge_cell_above = function () {
1199 Notebook.prototype.merge_cell_above = function () {
1200 var index = this.get_selected_index();
1200 var index = this.get_selected_index();
1201 var cell = this.get_cell(index);
1201 var cell = this.get_cell(index);
1202 if (!cell.is_mergeable()) {
1202 if (!cell.is_mergeable()) {
1203 return;
1203 return;
1204 }
1204 }
1205 if (index > 0) {
1205 if (index > 0) {
1206 var upper_cell = this.get_cell(index-1);
1206 var upper_cell = this.get_cell(index-1);
1207 if (!upper_cell.is_mergeable()) {
1207 if (!upper_cell.is_mergeable()) {
1208 return;
1208 return;
1209 }
1209 }
1210 var upper_text = upper_cell.get_text();
1210 var upper_text = upper_cell.get_text();
1211 var text = cell.get_text();
1211 var text = cell.get_text();
1212 if (cell instanceof IPython.CodeCell) {
1212 if (cell instanceof IPython.CodeCell) {
1213 cell.set_text(upper_text+'\n'+text);
1213 cell.set_text(upper_text+'\n'+text);
1214 } else if (cell instanceof IPython.MarkdownCell) {
1214 } else if (cell instanceof IPython.MarkdownCell) {
1215 cell.edit();
1215 cell.edit();
1216 cell.set_text(upper_text+'\n'+text);
1216 cell.set_text(upper_text+'\n'+text);
1217 cell.render();
1217 cell.render();
1218 };
1218 };
1219 this.delete_cell(index-1);
1219 this.delete_cell(index-1);
1220 this.select(this.find_cell_index(cell));
1220 this.select(this.find_cell_index(cell));
1221 };
1221 };
1222 };
1222 };
1223
1223
1224 /**
1224 /**
1225 * Combine the selected cell into the cell below it.
1225 * Combine the selected cell into the cell below it.
1226 *
1226 *
1227 * @method merge_cell_below
1227 * @method merge_cell_below
1228 */
1228 */
1229 Notebook.prototype.merge_cell_below = function () {
1229 Notebook.prototype.merge_cell_below = function () {
1230 var index = this.get_selected_index();
1230 var index = this.get_selected_index();
1231 var cell = this.get_cell(index);
1231 var cell = this.get_cell(index);
1232 if (!cell.is_mergeable()) {
1232 if (!cell.is_mergeable()) {
1233 return;
1233 return;
1234 }
1234 }
1235 if (index < this.ncells()-1) {
1235 if (index < this.ncells()-1) {
1236 var lower_cell = this.get_cell(index+1);
1236 var lower_cell = this.get_cell(index+1);
1237 if (!lower_cell.is_mergeable()) {
1237 if (!lower_cell.is_mergeable()) {
1238 return;
1238 return;
1239 }
1239 }
1240 var lower_text = lower_cell.get_text();
1240 var lower_text = lower_cell.get_text();
1241 var text = cell.get_text();
1241 var text = cell.get_text();
1242 if (cell instanceof IPython.CodeCell) {
1242 if (cell instanceof IPython.CodeCell) {
1243 cell.set_text(text+'\n'+lower_text);
1243 cell.set_text(text+'\n'+lower_text);
1244 } else if (cell instanceof IPython.MarkdownCell) {
1244 } else if (cell instanceof IPython.MarkdownCell) {
1245 cell.edit();
1245 cell.edit();
1246 cell.set_text(text+'\n'+lower_text);
1246 cell.set_text(text+'\n'+lower_text);
1247 cell.render();
1247 cell.render();
1248 };
1248 };
1249 this.delete_cell(index+1);
1249 this.delete_cell(index+1);
1250 this.select(this.find_cell_index(cell));
1250 this.select(this.find_cell_index(cell));
1251 };
1251 };
1252 };
1252 };
1253
1253
1254
1254
1255 // Cell collapsing and output clearing
1255 // Cell collapsing and output clearing
1256
1256
1257 /**
1257 /**
1258 * Hide a cell's output.
1258 * Hide a cell's output.
1259 *
1259 *
1260 * @method collapse
1260 * @method collapse
1261 * @param {Number} index A cell's numeric index
1261 * @param {Number} index A cell's numeric index
1262 */
1262 */
1263 Notebook.prototype.collapse = function (index) {
1263 Notebook.prototype.collapse = function (index) {
1264 var i = this.index_or_selected(index);
1264 var i = this.index_or_selected(index);
1265 this.get_cell(i).collapse();
1265 this.get_cell(i).collapse();
1266 this.set_dirty(true);
1266 this.set_dirty(true);
1267 };
1267 };
1268
1268
1269 /**
1269 /**
1270 * Show a cell's output.
1270 * Show a cell's output.
1271 *
1271 *
1272 * @method expand
1272 * @method expand
1273 * @param {Number} index A cell's numeric index
1273 * @param {Number} index A cell's numeric index
1274 */
1274 */
1275 Notebook.prototype.expand = function (index) {
1275 Notebook.prototype.expand = function (index) {
1276 var i = this.index_or_selected(index);
1276 var i = this.index_or_selected(index);
1277 this.get_cell(i).expand();
1277 this.get_cell(i).expand();
1278 this.set_dirty(true);
1278 this.set_dirty(true);
1279 };
1279 };
1280
1280
1281 /** Toggle whether a cell's output is collapsed or expanded.
1281 /** Toggle whether a cell's output is collapsed or expanded.
1282 *
1282 *
1283 * @method toggle_output
1283 * @method toggle_output
1284 * @param {Number} index A cell's numeric index
1284 * @param {Number} index A cell's numeric index
1285 */
1285 */
1286 Notebook.prototype.toggle_output = function (index) {
1286 Notebook.prototype.toggle_output = function (index) {
1287 var i = this.index_or_selected(index);
1287 var i = this.index_or_selected(index);
1288 this.get_cell(i).toggle_output();
1288 this.get_cell(i).toggle_output();
1289 this.set_dirty(true);
1289 this.set_dirty(true);
1290 };
1290 };
1291
1291
1292 /**
1292 /**
1293 * Toggle a scrollbar for long cell outputs.
1293 * Toggle a scrollbar for long cell outputs.
1294 *
1294 *
1295 * @method toggle_output_scroll
1295 * @method toggle_output_scroll
1296 * @param {Number} index A cell's numeric index
1296 * @param {Number} index A cell's numeric index
1297 */
1297 */
1298 Notebook.prototype.toggle_output_scroll = function (index) {
1298 Notebook.prototype.toggle_output_scroll = function (index) {
1299 var i = this.index_or_selected(index);
1299 var i = this.index_or_selected(index);
1300 this.get_cell(i).toggle_output_scroll();
1300 this.get_cell(i).toggle_output_scroll();
1301 };
1301 };
1302
1302
1303 /**
1303 /**
1304 * Hide each code cell's output area.
1304 * Hide each code cell's output area.
1305 *
1305 *
1306 * @method collapse_all_output
1306 * @method collapse_all_output
1307 */
1307 */
1308 Notebook.prototype.collapse_all_output = function () {
1308 Notebook.prototype.collapse_all_output = function () {
1309 var ncells = this.ncells();
1309 var ncells = this.ncells();
1310 var cells = this.get_cells();
1310 var cells = this.get_cells();
1311 for (var i=0; i<ncells; i++) {
1311 for (var i=0; i<ncells; i++) {
1312 if (cells[i] instanceof IPython.CodeCell) {
1312 if (cells[i] instanceof IPython.CodeCell) {
1313 cells[i].output_area.collapse();
1313 cells[i].output_area.collapse();
1314 }
1314 }
1315 };
1315 };
1316 // this should not be set if the `collapse` key is removed from nbformat
1316 // this should not be set if the `collapse` key is removed from nbformat
1317 this.set_dirty(true);
1317 this.set_dirty(true);
1318 };
1318 };
1319
1319
1320 /**
1320 /**
1321 * Expand each code cell's output area, and add a scrollbar for long output.
1321 * Expand each code cell's output area, and add a scrollbar for long output.
1322 *
1322 *
1323 * @method scroll_all_output
1323 * @method scroll_all_output
1324 */
1324 */
1325 Notebook.prototype.scroll_all_output = function () {
1325 Notebook.prototype.scroll_all_output = function () {
1326 var ncells = this.ncells();
1326 var ncells = this.ncells();
1327 var cells = this.get_cells();
1327 var cells = this.get_cells();
1328 for (var i=0; i<ncells; i++) {
1328 for (var i=0; i<ncells; i++) {
1329 if (cells[i] instanceof IPython.CodeCell) {
1329 if (cells[i] instanceof IPython.CodeCell) {
1330 cells[i].output_area.expand();
1330 cells[i].output_area.expand();
1331 cells[i].output_area.scroll_if_long();
1331 cells[i].output_area.scroll_if_long();
1332 }
1332 }
1333 };
1333 };
1334 // this should not be set if the `collapse` key is removed from nbformat
1334 // this should not be set if the `collapse` key is removed from nbformat
1335 this.set_dirty(true);
1335 this.set_dirty(true);
1336 };
1336 };
1337
1337
1338 /**
1338 /**
1339 * Expand each code cell's output area, and remove scrollbars.
1339 * Expand each code cell's output area, and remove scrollbars.
1340 *
1340 *
1341 * @method expand_all_output
1341 * @method expand_all_output
1342 */
1342 */
1343 Notebook.prototype.expand_all_output = function () {
1343 Notebook.prototype.expand_all_output = function () {
1344 var ncells = this.ncells();
1344 var ncells = this.ncells();
1345 var cells = this.get_cells();
1345 var cells = this.get_cells();
1346 for (var i=0; i<ncells; i++) {
1346 for (var i=0; i<ncells; i++) {
1347 if (cells[i] instanceof IPython.CodeCell) {
1347 if (cells[i] instanceof IPython.CodeCell) {
1348 cells[i].output_area.expand();
1348 cells[i].output_area.expand();
1349 cells[i].output_area.unscroll_area();
1349 cells[i].output_area.unscroll_area();
1350 }
1350 }
1351 };
1351 };
1352 // this should not be set if the `collapse` key is removed from nbformat
1352 // this should not be set if the `collapse` key is removed from nbformat
1353 this.set_dirty(true);
1353 this.set_dirty(true);
1354 };
1354 };
1355
1355
1356 /**
1356 /**
1357 * Clear each code cell's output area.
1357 * Clear each code cell's output area.
1358 *
1358 *
1359 * @method clear_all_output
1359 * @method clear_all_output
1360 */
1360 */
1361 Notebook.prototype.clear_all_output = function () {
1361 Notebook.prototype.clear_all_output = function () {
1362 var ncells = this.ncells();
1362 var ncells = this.ncells();
1363 var cells = this.get_cells();
1363 var cells = this.get_cells();
1364 for (var i=0; i<ncells; i++) {
1364 for (var i=0; i<ncells; i++) {
1365 if (cells[i] instanceof IPython.CodeCell) {
1365 if (cells[i] instanceof IPython.CodeCell) {
1366 cells[i].clear_output();
1366 cells[i].clear_output();
1367 // Make all In[] prompts blank, as well
1367 // Make all In[] prompts blank, as well
1368 // TODO: make this configurable (via checkbox?)
1368 // TODO: make this configurable (via checkbox?)
1369 cells[i].set_input_prompt();
1369 cells[i].set_input_prompt();
1370 }
1370 }
1371 };
1371 };
1372 this.set_dirty(true);
1372 this.set_dirty(true);
1373 };
1373 };
1374
1374
1375
1375
1376 // Other cell functions: line numbers, ...
1376 // Other cell functions: line numbers, ...
1377
1377
1378 /**
1378 /**
1379 * Toggle line numbers in the selected cell's input area.
1379 * Toggle line numbers in the selected cell's input area.
1380 *
1380 *
1381 * @method cell_toggle_line_numbers
1381 * @method cell_toggle_line_numbers
1382 */
1382 */
1383 Notebook.prototype.cell_toggle_line_numbers = function() {
1383 Notebook.prototype.cell_toggle_line_numbers = function() {
1384 this.get_selected_cell().toggle_line_numbers();
1384 this.get_selected_cell().toggle_line_numbers();
1385 };
1385 };
1386
1386
1387 // Session related things
1387 // Session related things
1388
1388
1389 /**
1389 /**
1390 * Start a new session and set it on each code cell.
1390 * Start a new session and set it on each code cell.
1391 *
1391 *
1392 * @method start_session
1392 * @method start_session
1393 */
1393 */
1394 Notebook.prototype.start_session = function () {
1394 Notebook.prototype.start_session = function () {
1395 this.session = new IPython.Session(this.notebook_name, this.notebook_path, this);
1395 this.session = new IPython.Session(this.notebook_name, this.notebook_path, this);
1396 this.session.start($.proxy(this._session_started, this));
1396 this.session.start($.proxy(this._session_started, this));
1397 };
1397 };
1398
1398
1399
1399
1400 /**
1400 /**
1401 * Once a session is started, link the code cells to the kernel
1401 * Once a session is started, link the code cells to the kernel
1402 *
1402 *
1403 */
1403 */
1404 Notebook.prototype._session_started = function(){
1404 Notebook.prototype._session_started = function(){
1405 this.kernel = this.session.kernel;
1405 this.kernel = this.session.kernel;
1406 var ncells = this.ncells();
1406 var ncells = this.ncells();
1407 for (var i=0; i<ncells; i++) {
1407 for (var i=0; i<ncells; i++) {
1408 var cell = this.get_cell(i);
1408 var cell = this.get_cell(i);
1409 if (cell instanceof IPython.CodeCell) {
1409 if (cell instanceof IPython.CodeCell) {
1410 cell.set_kernel(this.session.kernel);
1410 cell.set_kernel(this.session.kernel);
1411 };
1411 };
1412 };
1412 };
1413 };
1413 };
1414
1414
1415 /**
1415 /**
1416 * Prompt the user to restart the IPython kernel.
1416 * Prompt the user to restart the IPython kernel.
1417 *
1417 *
1418 * @method restart_kernel
1418 * @method restart_kernel
1419 */
1419 */
1420 Notebook.prototype.restart_kernel = function () {
1420 Notebook.prototype.restart_kernel = function () {
1421 var that = this;
1421 var that = this;
1422 IPython.dialog.modal({
1422 IPython.dialog.modal({
1423 title : "Restart kernel or continue running?",
1423 title : "Restart kernel or continue running?",
1424 body : $("<p/>").html(
1424 body : $("<p/>").html(
1425 'Do you want to restart the current kernel? You will lose all variables defined in it.'
1425 'Do you want to restart the current kernel? You will lose all variables defined in it.'
1426 ),
1426 ),
1427 buttons : {
1427 buttons : {
1428 "Continue running" : {},
1428 "Continue running" : {},
1429 "Restart" : {
1429 "Restart" : {
1430 "class" : "btn-danger",
1430 "class" : "btn-danger",
1431 "click" : function() {
1431 "click" : function() {
1432 that.session.restart_kernel();
1432 that.session.restart_kernel();
1433 }
1433 }
1434 }
1434 }
1435 }
1435 }
1436 });
1436 });
1437 };
1437 };
1438
1438
1439 /**
1439 /**
1440 * Run the selected cell.
1440 * Run the selected cell.
1441 *
1441 *
1442 * Execute or render cell outputs.
1442 * Execute or render cell outputs.
1443 *
1443 *
1444 * @method execute_selected_cell
1444 * @method execute_selected_cell
1445 * @param {Object} options Customize post-execution behavior
1445 * @param {Object} options Customize post-execution behavior
1446 */
1446 */
1447 Notebook.prototype.execute_selected_cell = function (options) {
1447 Notebook.prototype.execute_selected_cell = function (options) {
1448 // add_new: should a new cell be added if we are at the end of the nb
1448 // add_new: should a new cell be added if we are at the end of the nb
1449 // terminal: execute in terminal mode, which stays in the current cell
1449 // terminal: execute in terminal mode, which stays in the current cell
1450 var default_options = {terminal: false, add_new: true};
1450 var default_options = {terminal: false, add_new: true};
1451 $.extend(default_options, options);
1451 $.extend(default_options, options);
1452 var that = this;
1452 var that = this;
1453 var cell = that.get_selected_cell();
1453 var cell = that.get_selected_cell();
1454 var cell_index = that.find_cell_index(cell);
1454 var cell_index = that.find_cell_index(cell);
1455 if (cell instanceof IPython.CodeCell) {
1455 if (cell instanceof IPython.CodeCell) {
1456 cell.execute();
1456 cell.execute();
1457 }
1457 }
1458 if (default_options.terminal) {
1458 if (default_options.terminal) {
1459 cell.select_all();
1459 cell.select_all();
1460 } else {
1460 } else {
1461 if ((cell_index === (that.ncells()-1)) && default_options.add_new) {
1461 if ((cell_index === (that.ncells()-1)) && default_options.add_new) {
1462 that.insert_cell_below('code');
1462 that.insert_cell_below('code');
1463 // If we are adding a new cell at the end, scroll down to show it.
1463 // If we are adding a new cell at the end, scroll down to show it.
1464 that.scroll_to_bottom();
1464 that.scroll_to_bottom();
1465 } else {
1465 } else {
1466 that.select(cell_index+1);
1466 that.select(cell_index+1);
1467 };
1467 };
1468 };
1468 };
1469 this.set_dirty(true);
1469 this.set_dirty(true);
1470 };
1470 };
1471
1471
1472 /**
1472 /**
1473 * Execute all cells below the selected cell.
1473 * Execute all cells below the selected cell.
1474 *
1474 *
1475 * @method execute_cells_below
1475 * @method execute_cells_below
1476 */
1476 */
1477 Notebook.prototype.execute_cells_below = function () {
1477 Notebook.prototype.execute_cells_below = function () {
1478 this.execute_cell_range(this.get_selected_index(), this.ncells());
1478 this.execute_cell_range(this.get_selected_index(), this.ncells());
1479 this.scroll_to_bottom();
1479 this.scroll_to_bottom();
1480 };
1480 };
1481
1481
1482 /**
1482 /**
1483 * Execute all cells above the selected cell.
1483 * Execute all cells above the selected cell.
1484 *
1484 *
1485 * @method execute_cells_above
1485 * @method execute_cells_above
1486 */
1486 */
1487 Notebook.prototype.execute_cells_above = function () {
1487 Notebook.prototype.execute_cells_above = function () {
1488 this.execute_cell_range(0, this.get_selected_index());
1488 this.execute_cell_range(0, this.get_selected_index());
1489 };
1489 };
1490
1490
1491 /**
1491 /**
1492 * Execute all cells.
1492 * Execute all cells.
1493 *
1493 *
1494 * @method execute_all_cells
1494 * @method execute_all_cells
1495 */
1495 */
1496 Notebook.prototype.execute_all_cells = function () {
1496 Notebook.prototype.execute_all_cells = function () {
1497 this.execute_cell_range(0, this.ncells());
1497 this.execute_cell_range(0, this.ncells());
1498 this.scroll_to_bottom();
1498 this.scroll_to_bottom();
1499 };
1499 };
1500
1500
1501 /**
1501 /**
1502 * Execute a contiguous range of cells.
1502 * Execute a contiguous range of cells.
1503 *
1503 *
1504 * @method execute_cell_range
1504 * @method execute_cell_range
1505 * @param {Number} start Index of the first cell to execute (inclusive)
1505 * @param {Number} start Index of the first cell to execute (inclusive)
1506 * @param {Number} end Index of the last cell to execute (exclusive)
1506 * @param {Number} end Index of the last cell to execute (exclusive)
1507 */
1507 */
1508 Notebook.prototype.execute_cell_range = function (start, end) {
1508 Notebook.prototype.execute_cell_range = function (start, end) {
1509 for (var i=start; i<end; i++) {
1509 for (var i=start; i<end; i++) {
1510 this.select(i);
1510 this.select(i);
1511 this.execute_selected_cell({add_new:false});
1511 this.execute_selected_cell({add_new:false});
1512 };
1512 };
1513 };
1513 };
1514
1514
1515 // Persistance and loading
1515 // Persistance and loading
1516
1516
1517 /**
1517 /**
1518 * Getter method for this notebook's name.
1518 * Getter method for this notebook's name.
1519 *
1519 *
1520 * @method get_notebook_name
1520 * @method get_notebook_name
1521 * @return {String} This notebook's name
1521 * @return {String} This notebook's name
1522 */
1522 */
1523 Notebook.prototype.get_notebook_name = function () {
1523 Notebook.prototype.get_notebook_name = function () {
1524 var nbname = this.notebook_name.substring(0,this.notebook_name.length-6);
1524 var nbname = this.notebook_name.substring(0,this.notebook_name.length-6);
1525 return nbname;
1525 return nbname;
1526 };
1526 };
1527
1527
1528 /**
1528 /**
1529 * Setter method for this notebook's name.
1529 * Setter method for this notebook's name.
1530 *
1530 *
1531 * @method set_notebook_name
1531 * @method set_notebook_name
1532 * @param {String} name A new name for this notebook
1532 * @param {String} name A new name for this notebook
1533 */
1533 */
1534 Notebook.prototype.set_notebook_name = function (name) {
1534 Notebook.prototype.set_notebook_name = function (name) {
1535 this.notebook_name = name;
1535 this.notebook_name = name;
1536 };
1536 };
1537
1537
1538 /**
1538 /**
1539 * Check that a notebook's name is valid.
1539 * Check that a notebook's name is valid.
1540 *
1540 *
1541 * @method test_notebook_name
1541 * @method test_notebook_name
1542 * @param {String} nbname A name for this notebook
1542 * @param {String} nbname A name for this notebook
1543 * @return {Boolean} True if the name is valid, false if invalid
1543 * @return {Boolean} True if the name is valid, false if invalid
1544 */
1544 */
1545 Notebook.prototype.test_notebook_name = function (nbname) {
1545 Notebook.prototype.test_notebook_name = function (nbname) {
1546 nbname = nbname || '';
1546 nbname = nbname || '';
1547 if (this.notebook_name_blacklist_re.test(nbname) == false && nbname.length>0) {
1547 if (this.notebook_name_blacklist_re.test(nbname) == false && nbname.length>0) {
1548 return true;
1548 return true;
1549 } else {
1549 } else {
1550 return false;
1550 return false;
1551 };
1551 };
1552 };
1552 };
1553
1553
1554 /**
1554 /**
1555 * Load a notebook from JSON (.ipynb).
1555 * Load a notebook from JSON (.ipynb).
1556 *
1556 *
1557 * This currently handles one worksheet: others are deleted.
1557 * This currently handles one worksheet: others are deleted.
1558 *
1558 *
1559 * @method fromJSON
1559 * @method fromJSON
1560 * @param {Object} data JSON representation of a notebook
1560 * @param {Object} data JSON representation of a notebook
1561 */
1561 */
1562 Notebook.prototype.fromJSON = function (data) {
1562 Notebook.prototype.fromJSON = function (data) {
1563 var content = data.content;
1563 var content = data.content;
1564 var ncells = this.ncells();
1564 var ncells = this.ncells();
1565 var i;
1565 var i;
1566 for (i=0; i<ncells; i++) {
1566 for (i=0; i<ncells; i++) {
1567 // Always delete cell 0 as they get renumbered as they are deleted.
1567 // Always delete cell 0 as they get renumbered as they are deleted.
1568 this.delete_cell(0);
1568 this.delete_cell(0);
1569 };
1569 };
1570 // Save the metadata and name.
1570 // Save the metadata and name.
1571 this.metadata = content.metadata;
1571 this.metadata = content.metadata;
1572 this.notebook_name = data.name;
1572 this.notebook_name = data.name;
1573 // Only handle 1 worksheet for now.
1573 // Only handle 1 worksheet for now.
1574 var worksheet = content.worksheets[0];
1574 var worksheet = content.worksheets[0];
1575 if (worksheet !== undefined) {
1575 if (worksheet !== undefined) {
1576 if (worksheet.metadata) {
1576 if (worksheet.metadata) {
1577 this.worksheet_metadata = worksheet.metadata;
1577 this.worksheet_metadata = worksheet.metadata;
1578 }
1578 }
1579 var new_cells = worksheet.cells;
1579 var new_cells = worksheet.cells;
1580 ncells = new_cells.length;
1580 ncells = new_cells.length;
1581 var cell_data = null;
1581 var cell_data = null;
1582 var new_cell = null;
1582 var new_cell = null;
1583 for (i=0; i<ncells; i++) {
1583 for (i=0; i<ncells; i++) {
1584 cell_data = new_cells[i];
1584 cell_data = new_cells[i];
1585 // VERSIONHACK: plaintext -> raw
1585 // VERSIONHACK: plaintext -> raw
1586 // handle never-released plaintext name for raw cells
1586 // handle never-released plaintext name for raw cells
1587 if (cell_data.cell_type === 'plaintext'){
1587 if (cell_data.cell_type === 'plaintext'){
1588 cell_data.cell_type = 'raw';
1588 cell_data.cell_type = 'raw';
1589 }
1589 }
1590
1590
1591 new_cell = this.insert_cell_at_bottom(cell_data.cell_type);
1591 new_cell = this.insert_cell_at_bottom(cell_data.cell_type);
1592 new_cell.fromJSON(cell_data);
1592 new_cell.fromJSON(cell_data);
1593 };
1593 };
1594 };
1594 };
1595 if (content.worksheets.length > 1) {
1595 if (content.worksheets.length > 1) {
1596 IPython.dialog.modal({
1596 IPython.dialog.modal({
1597 title : "Multiple worksheets",
1597 title : "Multiple worksheets",
1598 body : "This notebook has " + data.worksheets.length + " worksheets, " +
1598 body : "This notebook has " + data.worksheets.length + " worksheets, " +
1599 "but this version of IPython can only handle the first. " +
1599 "but this version of IPython can only handle the first. " +
1600 "If you save this notebook, worksheets after the first will be lost.",
1600 "If you save this notebook, worksheets after the first will be lost.",
1601 buttons : {
1601 buttons : {
1602 OK : {
1602 OK : {
1603 class : "btn-danger"
1603 class : "btn-danger"
1604 }
1604 }
1605 }
1605 }
1606 });
1606 });
1607 }
1607 }
1608 };
1608 };
1609
1609
1610 /**
1610 /**
1611 * Dump this notebook into a JSON-friendly object.
1611 * Dump this notebook into a JSON-friendly object.
1612 *
1612 *
1613 * @method toJSON
1613 * @method toJSON
1614 * @return {Object} A JSON-friendly representation of this notebook.
1614 * @return {Object} A JSON-friendly representation of this notebook.
1615 */
1615 */
1616 Notebook.prototype.toJSON = function () {
1616 Notebook.prototype.toJSON = function () {
1617 var cells = this.get_cells();
1617 var cells = this.get_cells();
1618 var ncells = cells.length;
1618 var ncells = cells.length;
1619 var cell_array = new Array(ncells);
1619 var cell_array = new Array(ncells);
1620 for (var i=0; i<ncells; i++) {
1620 for (var i=0; i<ncells; i++) {
1621 cell_array[i] = cells[i].toJSON();
1621 cell_array[i] = cells[i].toJSON();
1622 };
1622 };
1623 var data = {
1623 var data = {
1624 // Only handle 1 worksheet for now.
1624 // Only handle 1 worksheet for now.
1625 worksheets : [{
1625 worksheets : [{
1626 cells: cell_array,
1626 cells: cell_array,
1627 metadata: this.worksheet_metadata
1627 metadata: this.worksheet_metadata
1628 }],
1628 }],
1629 metadata : this.metadata
1629 metadata : this.metadata
1630 };
1630 };
1631 return data;
1631 return data;
1632 };
1632 };
1633
1633
1634 /**
1634 /**
1635 * Start an autosave timer, for periodically saving the notebook.
1635 * Start an autosave timer, for periodically saving the notebook.
1636 *
1636 *
1637 * @method set_autosave_interval
1637 * @method set_autosave_interval
1638 * @param {Integer} interval the autosave interval in milliseconds
1638 * @param {Integer} interval the autosave interval in milliseconds
1639 */
1639 */
1640 Notebook.prototype.set_autosave_interval = function (interval) {
1640 Notebook.prototype.set_autosave_interval = function (interval) {
1641 var that = this;
1641 var that = this;
1642 // clear previous interval, so we don't get simultaneous timers
1642 // clear previous interval, so we don't get simultaneous timers
1643 if (this.autosave_timer) {
1643 if (this.autosave_timer) {
1644 clearInterval(this.autosave_timer);
1644 clearInterval(this.autosave_timer);
1645 }
1645 }
1646
1646
1647 this.autosave_interval = this.minimum_autosave_interval = interval;
1647 this.autosave_interval = this.minimum_autosave_interval = interval;
1648 if (interval) {
1648 if (interval) {
1649 this.autosave_timer = setInterval(function() {
1649 this.autosave_timer = setInterval(function() {
1650 if (that.dirty) {
1650 if (that.dirty) {
1651 that.save_notebook();
1651 that.save_notebook();
1652 }
1652 }
1653 }, interval);
1653 }, interval);
1654 $([IPython.events]).trigger("autosave_enabled.Notebook", interval);
1654 $([IPython.events]).trigger("autosave_enabled.Notebook", interval);
1655 } else {
1655 } else {
1656 this.autosave_timer = null;
1656 this.autosave_timer = null;
1657 $([IPython.events]).trigger("autosave_disabled.Notebook");
1657 $([IPython.events]).trigger("autosave_disabled.Notebook");
1658 };
1658 };
1659 };
1659 };
1660
1660
1661 /**
1661 /**
1662 * Save this notebook on the server.
1662 * Save this notebook on the server.
1663 *
1663 *
1664 * @method save_notebook
1664 * @method save_notebook
1665 */
1665 */
1666 Notebook.prototype.save_notebook = function (extra_settings) {
1666 Notebook.prototype.save_notebook = function (extra_settings) {
1667 // Create a JSON model to be sent to the server.
1667 // Create a JSON model to be sent to the server.
1668 var model = {};
1668 var model = {};
1669 model.name = this.notebook_name;
1669 model.name = this.notebook_name;
1670 model.path = this.notebook_path;
1670 model.path = this.notebook_path;
1671 model.content = this.toJSON();
1671 model.content = this.toJSON();
1672 model.content.nbformat = this.nbformat;
1672 model.content.nbformat = this.nbformat;
1673 model.content.nbformat_minor = this.nbformat_minor;
1673 model.content.nbformat_minor = this.nbformat_minor;
1674 // time the ajax call for autosave tuning purposes.
1674 // time the ajax call for autosave tuning purposes.
1675 var start = new Date().getTime();
1675 var start = new Date().getTime();
1676 // We do the call with settings so we can set cache to false.
1676 // We do the call with settings so we can set cache to false.
1677 var settings = {
1677 var settings = {
1678 processData : false,
1678 processData : false,
1679 cache : false,
1679 cache : false,
1680 type : "PUT",
1680 type : "PUT",
1681 data : JSON.stringify(model),
1681 data : JSON.stringify(model),
1682 headers : {'Content-Type': 'application/json'},
1682 headers : {'Content-Type': 'application/json'},
1683 success : $.proxy(this.save_notebook_success, this, start),
1683 success : $.proxy(this.save_notebook_success, this, start),
1684 error : $.proxy(this.save_notebook_error, this)
1684 error : $.proxy(this.save_notebook_error, this)
1685 };
1685 };
1686 if (extra_settings) {
1686 if (extra_settings) {
1687 for (var key in extra_settings) {
1687 for (var key in extra_settings) {
1688 settings[key] = extra_settings[key];
1688 settings[key] = extra_settings[key];
1689 }
1689 }
1690 }
1690 }
1691 $([IPython.events]).trigger('notebook_saving.Notebook');
1691 $([IPython.events]).trigger('notebook_saving.Notebook');
1692 var url = utils.url_path_join(
1692 var url = utils.url_path_join(
1693 this.baseProjectUrl(),
1693 this.baseProjectUrl(),
1694 'api/notebooks',
1694 'api/notebooks',
1695 this.notebookPath(),
1695 this.notebookPath(),
1696 this.notebook_name
1696 this.notebook_name
1697 );
1697 );
1698 $.ajax(url, settings);
1698 $.ajax(url, settings);
1699 };
1699 };
1700
1700
1701 /**
1701 /**
1702 * Success callback for saving a notebook.
1702 * Success callback for saving a notebook.
1703 *
1703 *
1704 * @method save_notebook_success
1704 * @method save_notebook_success
1705 * @param {Integer} start the time when the save request started
1705 * @param {Integer} start the time when the save request started
1706 * @param {Object} data JSON representation of a notebook
1706 * @param {Object} data JSON representation of a notebook
1707 * @param {String} status Description of response status
1707 * @param {String} status Description of response status
1708 * @param {jqXHR} xhr jQuery Ajax object
1708 * @param {jqXHR} xhr jQuery Ajax object
1709 */
1709 */
1710 Notebook.prototype.save_notebook_success = function (start, data, status, xhr) {
1710 Notebook.prototype.save_notebook_success = function (start, data, status, xhr) {
1711 this.set_dirty(false);
1711 this.set_dirty(false);
1712 $([IPython.events]).trigger('notebook_saved.Notebook');
1712 $([IPython.events]).trigger('notebook_saved.Notebook');
1713 this._update_autosave_interval(start);
1713 this._update_autosave_interval(start);
1714 if (this._checkpoint_after_save) {
1714 if (this._checkpoint_after_save) {
1715 this.create_checkpoint();
1715 this.create_checkpoint();
1716 this._checkpoint_after_save = false;
1716 this._checkpoint_after_save = false;
1717 };
1717 };
1718 };
1718 };
1719
1719
1720 /**
1720 /**
1721 * update the autosave interval based on how long the last save took
1721 * update the autosave interval based on how long the last save took
1722 *
1722 *
1723 * @method _update_autosave_interval
1723 * @method _update_autosave_interval
1724 * @param {Integer} timestamp when the save request started
1724 * @param {Integer} timestamp when the save request started
1725 */
1725 */
1726 Notebook.prototype._update_autosave_interval = function (start) {
1726 Notebook.prototype._update_autosave_interval = function (start) {
1727 var duration = (new Date().getTime() - start);
1727 var duration = (new Date().getTime() - start);
1728 if (this.autosave_interval) {
1728 if (this.autosave_interval) {
1729 // new save interval: higher of 10x save duration or parameter (default 30 seconds)
1729 // new save interval: higher of 10x save duration or parameter (default 30 seconds)
1730 var interval = Math.max(10 * duration, this.minimum_autosave_interval);
1730 var interval = Math.max(10 * duration, this.minimum_autosave_interval);
1731 // round to 10 seconds, otherwise we will be setting a new interval too often
1731 // round to 10 seconds, otherwise we will be setting a new interval too often
1732 interval = 10000 * Math.round(interval / 10000);
1732 interval = 10000 * Math.round(interval / 10000);
1733 // set new interval, if it's changed
1733 // set new interval, if it's changed
1734 if (interval != this.autosave_interval) {
1734 if (interval != this.autosave_interval) {
1735 this.set_autosave_interval(interval);
1735 this.set_autosave_interval(interval);
1736 }
1736 }
1737 }
1737 }
1738 };
1738 };
1739
1739
1740 /**
1740 /**
1741 * Failure callback for saving a notebook.
1741 * Failure callback for saving a notebook.
1742 *
1742 *
1743 * @method save_notebook_error
1743 * @method save_notebook_error
1744 * @param {jqXHR} xhr jQuery Ajax object
1744 * @param {jqXHR} xhr jQuery Ajax object
1745 * @param {String} status Description of response status
1745 * @param {String} status Description of response status
1746 * @param {String} error_msg HTTP error message
1746 * @param {String} error_msg HTTP error message
1747 */
1747 */
1748 Notebook.prototype.save_notebook_error = function (xhr, status, error_msg) {
1748 Notebook.prototype.save_notebook_error = function (xhr, status, error_msg) {
1749 $([IPython.events]).trigger('notebook_save_failed.Notebook');
1749 $([IPython.events]).trigger('notebook_save_failed.Notebook');
1750 };
1750 };
1751
1751
1752 Notebook.prototype.new_notebook = function(){
1752 Notebook.prototype.new_notebook = function(){
1753 var path = this.notebookPath();
1753 var path = this.notebookPath();
1754 var base_project_url = this.baseProjectUrl();
1754 var base_project_url = this.baseProjectUrl();
1755 var settings = {
1755 var settings = {
1756 processData : false,
1756 processData : false,
1757 cache : false,
1757 cache : false,
1758 type : "POST",
1758 type : "POST",
1759 dataType : "json",
1759 dataType : "json",
1760 async : false,
1760 async : false,
1761 success : function (data, status, xhr){
1761 success : function (data, status, xhr){
1762 var notebook_name = data.name;
1762 var notebook_name = data.name;
1763 window.open(
1763 window.open(
1764 utils.url_path_join(
1764 utils.url_path_join(
1765 base_project_url,
1765 base_project_url,
1766 'notebooks',
1766 'notebooks',
1767 path,
1767 path,
1768 notebook_name
1768 notebook_name
1769 ),
1769 ),
1770 '_blank'
1770 '_blank'
1771 );
1771 );
1772 }
1772 }
1773 };
1773 };
1774 var url = utils.url_path_join(
1774 var url = utils.url_path_join(
1775 base_project_url,
1775 base_project_url,
1776 'api/notebooks',
1776 'api/notebooks',
1777 path
1777 path
1778 );
1778 );
1779 $.ajax(url,settings);
1779 $.ajax(url,settings);
1780 };
1780 };
1781
1781
1782
1782
1783 Notebook.prototype.copy_notebook = function(){
1783 Notebook.prototype.copy_notebook = function(){
1784 var path = this.notebookPath();
1784 var path = this.notebookPath();
1785 var base_project_url = this.baseProjectUrl();
1785 var base_project_url = this.baseProjectUrl();
1786 var settings = {
1786 var settings = {
1787 processData : false,
1787 processData : false,
1788 cache : false,
1788 cache : false,
1789 type : "POST",
1789 type : "POST",
1790 dataType : "json",
1790 dataType : "json",
1791 data : JSON.stringify({copy_from : this.notebook_name}),
1791 data : JSON.stringify({copy_from : this.notebook_name}),
1792 async : false,
1792 async : false,
1793 success : function (data, status, xhr) {
1793 success : function (data, status, xhr) {
1794 window.open(utils.url_path_join(
1794 window.open(utils.url_path_join(
1795 base_project_url,
1795 base_project_url,
1796 'notebooks',
1796 'notebooks',
1797 data.path,
1797 data.path,
1798 data.name
1798 data.name
1799 ), '_blank');
1799 ), '_blank');
1800 }
1800 }
1801 };
1801 };
1802 var url = utils.url_path_join(
1802 var url = utils.url_path_join(
1803 base_project_url,
1803 base_project_url,
1804 'api/notebooks',
1804 'api/notebooks',
1805 path
1805 path
1806 );
1806 );
1807 $.ajax(url,settings);
1807 $.ajax(url,settings);
1808 };
1808 };
1809
1809
1810 Notebook.prototype.rename = function (nbname) {
1810 Notebook.prototype.rename = function (nbname) {
1811 var that = this;
1811 var that = this;
1812 var data = {name: nbname + '.ipynb'};
1812 var data = {name: nbname + '.ipynb'};
1813 var settings = {
1813 var settings = {
1814 processData : false,
1814 processData : false,
1815 cache : false,
1815 cache : false,
1816 type : "PATCH",
1816 type : "PATCH",
1817 data : JSON.stringify(data),
1817 data : JSON.stringify(data),
1818 dataType: "json",
1818 dataType: "json",
1819 headers : {'Content-Type': 'application/json'},
1819 headers : {'Content-Type': 'application/json'},
1820 success : $.proxy(that.rename_success, this),
1820 success : $.proxy(that.rename_success, this),
1821 error : $.proxy(that.rename_error, this)
1821 error : $.proxy(that.rename_error, this)
1822 };
1822 };
1823 $([IPython.events]).trigger('rename_notebook.Notebook', data);
1823 $([IPython.events]).trigger('rename_notebook.Notebook', data);
1824 var url = utils.url_path_join(
1824 var url = utils.url_path_join(
1825 this.baseProjectUrl(),
1825 this.baseProjectUrl(),
1826 'api/notebooks',
1826 'api/notebooks',
1827 this.notebookPath(),
1827 this.notebookPath(),
1828 this.notebook_name
1828 this.notebook_name
1829 );
1829 );
1830 $.ajax(url, settings);
1830 $.ajax(url, settings);
1831 };
1831 };
1832
1832
1833
1833
1834 Notebook.prototype.rename_success = function (json, status, xhr) {
1834 Notebook.prototype.rename_success = function (json, status, xhr) {
1835 this.notebook_name = json.name
1835 this.notebook_name = json.name
1836 var name = this.notebook_name
1836 var name = this.notebook_name
1837 var path = json.path
1837 var path = json.path
1838 this.session.rename_notebook(name, path);
1838 this.session.rename_notebook(name, path);
1839 $([IPython.events]).trigger('notebook_renamed.Notebook', json);
1839 $([IPython.events]).trigger('notebook_renamed.Notebook', json);
1840 }
1840 }
1841
1841
1842 Notebook.prototype.rename_error = function (json, status, xhr) {
1842 Notebook.prototype.rename_error = function (json, status, xhr) {
1843 var that = this;
1843 var that = this;
1844 var dialog = $('<div/>').append(
1844 var dialog = $('<div/>').append(
1845 $("<p/>").addClass("rename-message")
1845 $("<p/>").addClass("rename-message")
1846 .html('This notebook name already exists.')
1846 .html('This notebook name already exists.')
1847 )
1847 )
1848 IPython.dialog.modal({
1848 IPython.dialog.modal({
1849 title: "Notebook Rename Error!",
1849 title: "Notebook Rename Error!",
1850 body: dialog,
1850 body: dialog,
1851 buttons : {
1851 buttons : {
1852 "Cancel": {},
1852 "Cancel": {},
1853 "OK": {
1853 "OK": {
1854 class: "btn-primary",
1854 class: "btn-primary",
1855 click: function () {
1855 click: function () {
1856 IPython.save_widget.rename_notebook();
1856 IPython.save_widget.rename_notebook();
1857 }}
1857 }}
1858 },
1858 },
1859 open : function (event, ui) {
1859 open : function (event, ui) {
1860 var that = $(this);
1860 var that = $(this);
1861 // Upon ENTER, click the OK button.
1861 // Upon ENTER, click the OK button.
1862 that.find('input[type="text"]').keydown(function (event, ui) {
1862 that.find('input[type="text"]').keydown(function (event, ui) {
1863 if (event.which === utils.keycodes.ENTER) {
1863 if (event.which === utils.keycodes.ENTER) {
1864 that.find('.btn-primary').first().click();
1864 that.find('.btn-primary').first().click();
1865 }
1865 }
1866 });
1866 });
1867 that.find('input[type="text"]').focus();
1867 that.find('input[type="text"]').focus();
1868 }
1868 }
1869 });
1869 });
1870 }
1870 }
1871
1871
1872 /**
1872 /**
1873 * Request a notebook's data from the server.
1873 * Request a notebook's data from the server.
1874 *
1874 *
1875 * @method load_notebook
1875 * @method load_notebook
1876 * @param {String} notebook_name and path A notebook to load
1876 * @param {String} notebook_name and path A notebook to load
1877 */
1877 */
1878 Notebook.prototype.load_notebook = function (notebook_name, notebook_path) {
1878 Notebook.prototype.load_notebook = function (notebook_name, notebook_path) {
1879 var that = this;
1879 var that = this;
1880 this.notebook_name = notebook_name;
1880 this.notebook_name = notebook_name;
1881 this.notebook_path = notebook_path;
1881 this.notebook_path = notebook_path;
1882 // We do the call with settings so we can set cache to false.
1882 // We do the call with settings so we can set cache to false.
1883 var settings = {
1883 var settings = {
1884 processData : false,
1884 processData : false,
1885 cache : false,
1885 cache : false,
1886 type : "GET",
1886 type : "GET",
1887 dataType : "json",
1887 dataType : "json",
1888 success : $.proxy(this.load_notebook_success,this),
1888 success : $.proxy(this.load_notebook_success,this),
1889 error : $.proxy(this.load_notebook_error,this),
1889 error : $.proxy(this.load_notebook_error,this),
1890 };
1890 };
1891 $([IPython.events]).trigger('notebook_loading.Notebook');
1891 $([IPython.events]).trigger('notebook_loading.Notebook');
1892 var url = utils.url_path_join(
1892 var url = utils.url_path_join(
1893 this._baseProjectUrl,
1893 this._baseProjectUrl,
1894 'api/notebooks',
1894 'api/notebooks',
1895 this.notebookPath(),
1895 this.notebookPath(),
1896 this.notebook_name
1896 this.notebook_name
1897 );
1897 );
1898 $.ajax(url, settings);
1898 $.ajax(url, settings);
1899 };
1899 };
1900
1900
1901 /**
1901 /**
1902 * Success callback for loading a notebook from the server.
1902 * Success callback for loading a notebook from the server.
1903 *
1903 *
1904 * Load notebook data from the JSON response.
1904 * Load notebook data from the JSON response.
1905 *
1905 *
1906 * @method load_notebook_success
1906 * @method load_notebook_success
1907 * @param {Object} data JSON representation of a notebook
1907 * @param {Object} data JSON representation of a notebook
1908 * @param {String} status Description of response status
1908 * @param {String} status Description of response status
1909 * @param {jqXHR} xhr jQuery Ajax object
1909 * @param {jqXHR} xhr jQuery Ajax object
1910 */
1910 */
1911 Notebook.prototype.load_notebook_success = function (data, status, xhr) {
1911 Notebook.prototype.load_notebook_success = function (data, status, xhr) {
1912 this.fromJSON(data);
1912 this.fromJSON(data);
1913 if (this.ncells() === 0) {
1913 if (this.ncells() === 0) {
1914 this.insert_cell_below('code');
1914 this.insert_cell_below('code');
1915 };
1915 };
1916 this.set_dirty(false);
1916 this.set_dirty(false);
1917 this.select(0);
1917 this.select(0);
1918 this.scroll_to_top();
1918 this.scroll_to_top();
1919 if (data.orig_nbformat !== undefined && data.nbformat !== data.orig_nbformat) {
1919 if (data.orig_nbformat !== undefined && data.nbformat !== data.orig_nbformat) {
1920 var msg = "This notebook has been converted from an older " +
1920 var msg = "This notebook has been converted from an older " +
1921 "notebook format (v"+data.orig_nbformat+") to the current notebook " +
1921 "notebook format (v"+data.orig_nbformat+") to the current notebook " +
1922 "format (v"+data.nbformat+"). The next time you save this notebook, the " +
1922 "format (v"+data.nbformat+"). The next time you save this notebook, the " +
1923 "newer notebook format will be used and older versions of IPython " +
1923 "newer notebook format will be used and older versions of IPython " +
1924 "may not be able to read it. To keep the older version, close the " +
1924 "may not be able to read it. To keep the older version, close the " +
1925 "notebook without saving it.";
1925 "notebook without saving it.";
1926 IPython.dialog.modal({
1926 IPython.dialog.modal({
1927 title : "Notebook converted",
1927 title : "Notebook converted",
1928 body : msg,
1928 body : msg,
1929 buttons : {
1929 buttons : {
1930 OK : {
1930 OK : {
1931 class : "btn-primary"
1931 class : "btn-primary"
1932 }
1932 }
1933 }
1933 }
1934 });
1934 });
1935 } else if (data.orig_nbformat_minor !== undefined && data.nbformat_minor !== data.orig_nbformat_minor) {
1935 } else if (data.orig_nbformat_minor !== undefined && data.nbformat_minor !== data.orig_nbformat_minor) {
1936 var that = this;
1936 var that = this;
1937 var orig_vs = 'v' + data.nbformat + '.' + data.orig_nbformat_minor;
1937 var orig_vs = 'v' + data.nbformat + '.' + data.orig_nbformat_minor;
1938 var this_vs = 'v' + data.nbformat + '.' + this.nbformat_minor;
1938 var this_vs = 'v' + data.nbformat + '.' + this.nbformat_minor;
1939 var msg = "This notebook is version " + orig_vs + ", but we only fully support up to " +
1939 var msg = "This notebook is version " + orig_vs + ", but we only fully support up to " +
1940 this_vs + ". You can still work with this notebook, but some features " +
1940 this_vs + ". You can still work with this notebook, but some features " +
1941 "introduced in later notebook versions may not be available."
1941 "introduced in later notebook versions may not be available."
1942
1942
1943 IPython.dialog.modal({
1943 IPython.dialog.modal({
1944 title : "Newer Notebook",
1944 title : "Newer Notebook",
1945 body : msg,
1945 body : msg,
1946 buttons : {
1946 buttons : {
1947 OK : {
1947 OK : {
1948 class : "btn-danger"
1948 class : "btn-danger"
1949 }
1949 }
1950 }
1950 }
1951 });
1951 });
1952
1952
1953 }
1953 }
1954
1954
1955 // Create the session after the notebook is completely loaded to prevent
1955 // Create the session after the notebook is completely loaded to prevent
1956 // code execution upon loading, which is a security risk.
1956 // code execution upon loading, which is a security risk.
1957 if (this.session == null) {
1957 if (this.session == null) {
1958 this.start_session();
1958 this.start_session();
1959 }
1959 }
1960 // load our checkpoint list
1960 // load our checkpoint list
1961 IPython.notebook.list_checkpoints();
1961 this.list_checkpoints();
1962
1963 // load toolbar state
1964 if (this.metadata.celltoolbar) {
1965 IPython.CellToolbar.global_show();
1966 IPython.CellToolbar.activate_preset(this.metadata.celltoolbar);
1967 }
1968
1962 $([IPython.events]).trigger('notebook_loaded.Notebook');
1969 $([IPython.events]).trigger('notebook_loaded.Notebook');
1963 };
1970 };
1964
1971
1965 /**
1972 /**
1966 * Failure callback for loading a notebook from the server.
1973 * Failure callback for loading a notebook from the server.
1967 *
1974 *
1968 * @method load_notebook_error
1975 * @method load_notebook_error
1969 * @param {jqXHR} xhr jQuery Ajax object
1976 * @param {jqXHR} xhr jQuery Ajax object
1970 * @param {String} textStatus Description of response status
1977 * @param {String} textStatus Description of response status
1971 * @param {String} errorThrow HTTP error message
1978 * @param {String} errorThrow HTTP error message
1972 */
1979 */
1973 Notebook.prototype.load_notebook_error = function (xhr, textStatus, errorThrow) {
1980 Notebook.prototype.load_notebook_error = function (xhr, textStatus, errorThrow) {
1974 if (xhr.status === 400) {
1981 if (xhr.status === 400) {
1975 var msg = errorThrow;
1982 var msg = errorThrow;
1976 } else if (xhr.status === 500) {
1983 } else if (xhr.status === 500) {
1977 var msg = "An unknown error occurred while loading this notebook. " +
1984 var msg = "An unknown error occurred while loading this notebook. " +
1978 "This version can load notebook formats " +
1985 "This version can load notebook formats " +
1979 "v" + this.nbformat + " or earlier.";
1986 "v" + this.nbformat + " or earlier.";
1980 }
1987 }
1981 IPython.dialog.modal({
1988 IPython.dialog.modal({
1982 title: "Error loading notebook",
1989 title: "Error loading notebook",
1983 body : msg,
1990 body : msg,
1984 buttons : {
1991 buttons : {
1985 "OK": {}
1992 "OK": {}
1986 }
1993 }
1987 });
1994 });
1988 }
1995 }
1989
1996
1990 /********************* checkpoint-related *********************/
1997 /********************* checkpoint-related *********************/
1991
1998
1992 /**
1999 /**
1993 * Save the notebook then immediately create a checkpoint.
2000 * Save the notebook then immediately create a checkpoint.
1994 *
2001 *
1995 * @method save_checkpoint
2002 * @method save_checkpoint
1996 */
2003 */
1997 Notebook.prototype.save_checkpoint = function () {
2004 Notebook.prototype.save_checkpoint = function () {
1998 this._checkpoint_after_save = true;
2005 this._checkpoint_after_save = true;
1999 this.save_notebook();
2006 this.save_notebook();
2000 };
2007 };
2001
2008
2002 /**
2009 /**
2003 * Add a checkpoint for this notebook.
2010 * Add a checkpoint for this notebook.
2004 * for use as a callback from checkpoint creation.
2011 * for use as a callback from checkpoint creation.
2005 *
2012 *
2006 * @method add_checkpoint
2013 * @method add_checkpoint
2007 */
2014 */
2008 Notebook.prototype.add_checkpoint = function (checkpoint) {
2015 Notebook.prototype.add_checkpoint = function (checkpoint) {
2009 var found = false;
2016 var found = false;
2010 for (var i = 0; i < this.checkpoints.length; i++) {
2017 for (var i = 0; i < this.checkpoints.length; i++) {
2011 var existing = this.checkpoints[i];
2018 var existing = this.checkpoints[i];
2012 if (existing.id == checkpoint.id) {
2019 if (existing.id == checkpoint.id) {
2013 found = true;
2020 found = true;
2014 this.checkpoints[i] = checkpoint;
2021 this.checkpoints[i] = checkpoint;
2015 break;
2022 break;
2016 }
2023 }
2017 }
2024 }
2018 if (!found) {
2025 if (!found) {
2019 this.checkpoints.push(checkpoint);
2026 this.checkpoints.push(checkpoint);
2020 }
2027 }
2021 this.last_checkpoint = this.checkpoints[this.checkpoints.length - 1];
2028 this.last_checkpoint = this.checkpoints[this.checkpoints.length - 1];
2022 };
2029 };
2023
2030
2024 /**
2031 /**
2025 * List checkpoints for this notebook.
2032 * List checkpoints for this notebook.
2026 *
2033 *
2027 * @method list_checkpoints
2034 * @method list_checkpoints
2028 */
2035 */
2029 Notebook.prototype.list_checkpoints = function () {
2036 Notebook.prototype.list_checkpoints = function () {
2030 var url = utils.url_path_join(
2037 var url = utils.url_path_join(
2031 this.baseProjectUrl(),
2038 this.baseProjectUrl(),
2032 'api/notebooks',
2039 'api/notebooks',
2033 this.notebookPath(),
2040 this.notebookPath(),
2034 this.notebook_name,
2041 this.notebook_name,
2035 'checkpoints'
2042 'checkpoints'
2036 );
2043 );
2037 $.get(url).done(
2044 $.get(url).done(
2038 $.proxy(this.list_checkpoints_success, this)
2045 $.proxy(this.list_checkpoints_success, this)
2039 ).fail(
2046 ).fail(
2040 $.proxy(this.list_checkpoints_error, this)
2047 $.proxy(this.list_checkpoints_error, this)
2041 );
2048 );
2042 };
2049 };
2043
2050
2044 /**
2051 /**
2045 * Success callback for listing checkpoints.
2052 * Success callback for listing checkpoints.
2046 *
2053 *
2047 * @method list_checkpoint_success
2054 * @method list_checkpoint_success
2048 * @param {Object} data JSON representation of a checkpoint
2055 * @param {Object} data JSON representation of a checkpoint
2049 * @param {String} status Description of response status
2056 * @param {String} status Description of response status
2050 * @param {jqXHR} xhr jQuery Ajax object
2057 * @param {jqXHR} xhr jQuery Ajax object
2051 */
2058 */
2052 Notebook.prototype.list_checkpoints_success = function (data, status, xhr) {
2059 Notebook.prototype.list_checkpoints_success = function (data, status, xhr) {
2053 var data = $.parseJSON(data);
2060 var data = $.parseJSON(data);
2054 this.checkpoints = data;
2061 this.checkpoints = data;
2055 if (data.length) {
2062 if (data.length) {
2056 this.last_checkpoint = data[data.length - 1];
2063 this.last_checkpoint = data[data.length - 1];
2057 } else {
2064 } else {
2058 this.last_checkpoint = null;
2065 this.last_checkpoint = null;
2059 }
2066 }
2060 $([IPython.events]).trigger('checkpoints_listed.Notebook', [data]);
2067 $([IPython.events]).trigger('checkpoints_listed.Notebook', [data]);
2061 };
2068 };
2062
2069
2063 /**
2070 /**
2064 * Failure callback for listing a checkpoint.
2071 * Failure callback for listing a checkpoint.
2065 *
2072 *
2066 * @method list_checkpoint_error
2073 * @method list_checkpoint_error
2067 * @param {jqXHR} xhr jQuery Ajax object
2074 * @param {jqXHR} xhr jQuery Ajax object
2068 * @param {String} status Description of response status
2075 * @param {String} status Description of response status
2069 * @param {String} error_msg HTTP error message
2076 * @param {String} error_msg HTTP error message
2070 */
2077 */
2071 Notebook.prototype.list_checkpoints_error = function (xhr, status, error_msg) {
2078 Notebook.prototype.list_checkpoints_error = function (xhr, status, error_msg) {
2072 $([IPython.events]).trigger('list_checkpoints_failed.Notebook');
2079 $([IPython.events]).trigger('list_checkpoints_failed.Notebook');
2073 };
2080 };
2074
2081
2075 /**
2082 /**
2076 * Create a checkpoint of this notebook on the server from the most recent save.
2083 * Create a checkpoint of this notebook on the server from the most recent save.
2077 *
2084 *
2078 * @method create_checkpoint
2085 * @method create_checkpoint
2079 */
2086 */
2080 Notebook.prototype.create_checkpoint = function () {
2087 Notebook.prototype.create_checkpoint = function () {
2081 var url = utils.url_path_join(
2088 var url = utils.url_path_join(
2082 this.baseProjectUrl(),
2089 this.baseProjectUrl(),
2083 'api/notebooks',
2090 'api/notebooks',
2084 this.notebookPath(),
2091 this.notebookPath(),
2085 this.notebook_name,
2092 this.notebook_name,
2086 'checkpoints'
2093 'checkpoints'
2087 );
2094 );
2088 $.post(url).done(
2095 $.post(url).done(
2089 $.proxy(this.create_checkpoint_success, this)
2096 $.proxy(this.create_checkpoint_success, this)
2090 ).fail(
2097 ).fail(
2091 $.proxy(this.create_checkpoint_error, this)
2098 $.proxy(this.create_checkpoint_error, this)
2092 );
2099 );
2093 };
2100 };
2094
2101
2095 /**
2102 /**
2096 * Success callback for creating a checkpoint.
2103 * Success callback for creating a checkpoint.
2097 *
2104 *
2098 * @method create_checkpoint_success
2105 * @method create_checkpoint_success
2099 * @param {Object} data JSON representation of a checkpoint
2106 * @param {Object} data JSON representation of a checkpoint
2100 * @param {String} status Description of response status
2107 * @param {String} status Description of response status
2101 * @param {jqXHR} xhr jQuery Ajax object
2108 * @param {jqXHR} xhr jQuery Ajax object
2102 */
2109 */
2103 Notebook.prototype.create_checkpoint_success = function (data, status, xhr) {
2110 Notebook.prototype.create_checkpoint_success = function (data, status, xhr) {
2104 var data = $.parseJSON(data);
2111 var data = $.parseJSON(data);
2105 this.add_checkpoint(data);
2112 this.add_checkpoint(data);
2106 $([IPython.events]).trigger('checkpoint_created.Notebook', data);
2113 $([IPython.events]).trigger('checkpoint_created.Notebook', data);
2107 };
2114 };
2108
2115
2109 /**
2116 /**
2110 * Failure callback for creating a checkpoint.
2117 * Failure callback for creating a checkpoint.
2111 *
2118 *
2112 * @method create_checkpoint_error
2119 * @method create_checkpoint_error
2113 * @param {jqXHR} xhr jQuery Ajax object
2120 * @param {jqXHR} xhr jQuery Ajax object
2114 * @param {String} status Description of response status
2121 * @param {String} status Description of response status
2115 * @param {String} error_msg HTTP error message
2122 * @param {String} error_msg HTTP error message
2116 */
2123 */
2117 Notebook.prototype.create_checkpoint_error = function (xhr, status, error_msg) {
2124 Notebook.prototype.create_checkpoint_error = function (xhr, status, error_msg) {
2118 $([IPython.events]).trigger('checkpoint_failed.Notebook');
2125 $([IPython.events]).trigger('checkpoint_failed.Notebook');
2119 };
2126 };
2120
2127
2121 Notebook.prototype.restore_checkpoint_dialog = function (checkpoint) {
2128 Notebook.prototype.restore_checkpoint_dialog = function (checkpoint) {
2122 var that = this;
2129 var that = this;
2123 var checkpoint = checkpoint || this.last_checkpoint;
2130 var checkpoint = checkpoint || this.last_checkpoint;
2124 if ( ! checkpoint ) {
2131 if ( ! checkpoint ) {
2125 console.log("restore dialog, but no checkpoint to restore to!");
2132 console.log("restore dialog, but no checkpoint to restore to!");
2126 return;
2133 return;
2127 }
2134 }
2128 var body = $('<div/>').append(
2135 var body = $('<div/>').append(
2129 $('<p/>').addClass("p-space").text(
2136 $('<p/>').addClass("p-space").text(
2130 "Are you sure you want to revert the notebook to " +
2137 "Are you sure you want to revert the notebook to " +
2131 "the latest checkpoint?"
2138 "the latest checkpoint?"
2132 ).append(
2139 ).append(
2133 $("<strong/>").text(
2140 $("<strong/>").text(
2134 " This cannot be undone."
2141 " This cannot be undone."
2135 )
2142 )
2136 )
2143 )
2137 ).append(
2144 ).append(
2138 $('<p/>').addClass("p-space").text("The checkpoint was last updated at:")
2145 $('<p/>').addClass("p-space").text("The checkpoint was last updated at:")
2139 ).append(
2146 ).append(
2140 $('<p/>').addClass("p-space").text(
2147 $('<p/>').addClass("p-space").text(
2141 Date(checkpoint.last_modified)
2148 Date(checkpoint.last_modified)
2142 ).css("text-align", "center")
2149 ).css("text-align", "center")
2143 );
2150 );
2144
2151
2145 IPython.dialog.modal({
2152 IPython.dialog.modal({
2146 title : "Revert notebook to checkpoint",
2153 title : "Revert notebook to checkpoint",
2147 body : body,
2154 body : body,
2148 buttons : {
2155 buttons : {
2149 Revert : {
2156 Revert : {
2150 class : "btn-danger",
2157 class : "btn-danger",
2151 click : function () {
2158 click : function () {
2152 that.restore_checkpoint(checkpoint.id);
2159 that.restore_checkpoint(checkpoint.id);
2153 }
2160 }
2154 },
2161 },
2155 Cancel : {}
2162 Cancel : {}
2156 }
2163 }
2157 });
2164 });
2158 }
2165 }
2159
2166
2160 /**
2167 /**
2161 * Restore the notebook to a checkpoint state.
2168 * Restore the notebook to a checkpoint state.
2162 *
2169 *
2163 * @method restore_checkpoint
2170 * @method restore_checkpoint
2164 * @param {String} checkpoint ID
2171 * @param {String} checkpoint ID
2165 */
2172 */
2166 Notebook.prototype.restore_checkpoint = function (checkpoint) {
2173 Notebook.prototype.restore_checkpoint = function (checkpoint) {
2167 $([IPython.events]).trigger('notebook_restoring.Notebook', checkpoint);
2174 $([IPython.events]).trigger('notebook_restoring.Notebook', checkpoint);
2168 var url = utils.url_path_join(
2175 var url = utils.url_path_join(
2169 this.baseProjectUrl(),
2176 this.baseProjectUrl(),
2170 'api/notebooks',
2177 'api/notebooks',
2171 this.notebookPath(),
2178 this.notebookPath(),
2172 this.notebook_name,
2179 this.notebook_name,
2173 'checkpoints',
2180 'checkpoints',
2174 checkpoint
2181 checkpoint
2175 );
2182 );
2176 $.post(url).done(
2183 $.post(url).done(
2177 $.proxy(this.restore_checkpoint_success, this)
2184 $.proxy(this.restore_checkpoint_success, this)
2178 ).fail(
2185 ).fail(
2179 $.proxy(this.restore_checkpoint_error, this)
2186 $.proxy(this.restore_checkpoint_error, this)
2180 );
2187 );
2181 };
2188 };
2182
2189
2183 /**
2190 /**
2184 * Success callback for restoring a notebook to a checkpoint.
2191 * Success callback for restoring a notebook to a checkpoint.
2185 *
2192 *
2186 * @method restore_checkpoint_success
2193 * @method restore_checkpoint_success
2187 * @param {Object} data (ignored, should be empty)
2194 * @param {Object} data (ignored, should be empty)
2188 * @param {String} status Description of response status
2195 * @param {String} status Description of response status
2189 * @param {jqXHR} xhr jQuery Ajax object
2196 * @param {jqXHR} xhr jQuery Ajax object
2190 */
2197 */
2191 Notebook.prototype.restore_checkpoint_success = function (data, status, xhr) {
2198 Notebook.prototype.restore_checkpoint_success = function (data, status, xhr) {
2192 $([IPython.events]).trigger('checkpoint_restored.Notebook');
2199 $([IPython.events]).trigger('checkpoint_restored.Notebook');
2193 this.load_notebook(this.notebook_name, this.notebook_path);
2200 this.load_notebook(this.notebook_name, this.notebook_path);
2194 };
2201 };
2195
2202
2196 /**
2203 /**
2197 * Failure callback for restoring a notebook to a checkpoint.
2204 * Failure callback for restoring a notebook to a checkpoint.
2198 *
2205 *
2199 * @method restore_checkpoint_error
2206 * @method restore_checkpoint_error
2200 * @param {jqXHR} xhr jQuery Ajax object
2207 * @param {jqXHR} xhr jQuery Ajax object
2201 * @param {String} status Description of response status
2208 * @param {String} status Description of response status
2202 * @param {String} error_msg HTTP error message
2209 * @param {String} error_msg HTTP error message
2203 */
2210 */
2204 Notebook.prototype.restore_checkpoint_error = function (xhr, status, error_msg) {
2211 Notebook.prototype.restore_checkpoint_error = function (xhr, status, error_msg) {
2205 $([IPython.events]).trigger('checkpoint_restore_failed.Notebook');
2212 $([IPython.events]).trigger('checkpoint_restore_failed.Notebook');
2206 };
2213 };
2207
2214
2208 /**
2215 /**
2209 * Delete a notebook checkpoint.
2216 * Delete a notebook checkpoint.
2210 *
2217 *
2211 * @method delete_checkpoint
2218 * @method delete_checkpoint
2212 * @param {String} checkpoint ID
2219 * @param {String} checkpoint ID
2213 */
2220 */
2214 Notebook.prototype.delete_checkpoint = function (checkpoint) {
2221 Notebook.prototype.delete_checkpoint = function (checkpoint) {
2215 $([IPython.events]).trigger('notebook_restoring.Notebook', checkpoint);
2222 $([IPython.events]).trigger('notebook_restoring.Notebook', checkpoint);
2216 var url = utils.url_path_join(
2223 var url = utils.url_path_join(
2217 this.baseProjectUrl(),
2224 this.baseProjectUrl(),
2218 'api/notebooks',
2225 'api/notebooks',
2219 this.notebookPath(),
2226 this.notebookPath(),
2220 this.notebook_name,
2227 this.notebook_name,
2221 'checkpoints',
2228 'checkpoints',
2222 checkpoint
2229 checkpoint
2223 );
2230 );
2224 $.ajax(url, {
2231 $.ajax(url, {
2225 type: 'DELETE',
2232 type: 'DELETE',
2226 success: $.proxy(this.delete_checkpoint_success, this),
2233 success: $.proxy(this.delete_checkpoint_success, this),
2227 error: $.proxy(this.delete_notebook_error,this)
2234 error: $.proxy(this.delete_notebook_error,this)
2228 });
2235 });
2229 };
2236 };
2230
2237
2231 /**
2238 /**
2232 * Success callback for deleting a notebook checkpoint
2239 * Success callback for deleting a notebook checkpoint
2233 *
2240 *
2234 * @method delete_checkpoint_success
2241 * @method delete_checkpoint_success
2235 * @param {Object} data (ignored, should be empty)
2242 * @param {Object} data (ignored, should be empty)
2236 * @param {String} status Description of response status
2243 * @param {String} status Description of response status
2237 * @param {jqXHR} xhr jQuery Ajax object
2244 * @param {jqXHR} xhr jQuery Ajax object
2238 */
2245 */
2239 Notebook.prototype.delete_checkpoint_success = function (data, status, xhr) {
2246 Notebook.prototype.delete_checkpoint_success = function (data, status, xhr) {
2240 $([IPython.events]).trigger('checkpoint_deleted.Notebook', data);
2247 $([IPython.events]).trigger('checkpoint_deleted.Notebook', data);
2241 this.load_notebook(this.notebook_name, this.notebook_path);
2248 this.load_notebook(this.notebook_name, this.notebook_path);
2242 };
2249 };
2243
2250
2244 /**
2251 /**
2245 * Failure callback for deleting a notebook checkpoint.
2252 * Failure callback for deleting a notebook checkpoint.
2246 *
2253 *
2247 * @method delete_checkpoint_error
2254 * @method delete_checkpoint_error
2248 * @param {jqXHR} xhr jQuery Ajax object
2255 * @param {jqXHR} xhr jQuery Ajax object
2249 * @param {String} status Description of response status
2256 * @param {String} status Description of response status
2250 * @param {String} error_msg HTTP error message
2257 * @param {String} error_msg HTTP error message
2251 */
2258 */
2252 Notebook.prototype.delete_checkpoint_error = function (xhr, status, error_msg) {
2259 Notebook.prototype.delete_checkpoint_error = function (xhr, status, error_msg) {
2253 $([IPython.events]).trigger('checkpoint_delete_failed.Notebook');
2260 $([IPython.events]).trigger('checkpoint_delete_failed.Notebook');
2254 };
2261 };
2255
2262
2256
2263
2257 IPython.Notebook = Notebook;
2264 IPython.Notebook = Notebook;
2258
2265
2259
2266
2260 return IPython;
2267 return IPython;
2261
2268
2262 }(IPython));
2269 }(IPython));
General Comments 0
You need to be logged in to leave comments. Login now