Skip to content

Working on using actions for menu. #329

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Sep 19, 2015
Merged

Working on using actions for menu. #329

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c2fc31a
Bind menu click to actions
Carreau Aug 24, 2015
552a5a0
make sure to loop only on dict keys
Carreau Sep 18, 2015
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
56 changes: 55 additions & 1 deletion notebook/static/notebook/js/actions.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ define(function(require){
Object.seal(this);
};

var events = require('base/js/events');

/**
* A bunch of predefined `Simple Actions` used by Jupyter.
* `Simple Actions` have the following keys:
Expand Down Expand Up @@ -37,6 +39,21 @@ define(function(require){
*
**/
var _actions = {
'toggle-toolbar':{
help: 'hide/show the toolbar',
handler : function(env){
$('div#maintoolbar').toggle();
events.trigger('resize-header.Page');
}
},
'toggle-header':{
help: 'hide/show the header',
handler : function(env){
$('#header-container').toggle();
$('.header-bar').toggle();
events.trigger('resize-header.Page');
}
},
'run-select-next': {
icon: 'fa-step-forward',
help : 'run cell, select below',
Expand All @@ -59,7 +76,7 @@ define(function(require){
env.notebook.execute_cell_and_insert_below();
}
},
'run-all': {
'run-all-cells': {
help: 'run all cells',
help_index: 'bd',
handler: function (env) {
Expand All @@ -81,6 +98,16 @@ define(function(require){
help_index: 'bf',
handler: function (env) {
env.notebook.restart_kernel();
},
},
'run-all-cells-above':{
handler : function (env) {
env.notebook.execute_cells_above();
}
},
'run-all-cells-below':{
handler : function (env) {
env.notebook.execute_cells_below();
}
},
'go-to-command-mode': {
Expand Down Expand Up @@ -281,6 +308,11 @@ define(function(require){
env.notebook.toggle_output_scroll();
}
},
'clear-output-selected-cell' : {
handler : function (env) {
env.notebook.clear_output();
}
},
'move-selected-cell-down' : {
icon: 'fa-arrow-down',
help_index : 'eb',
Expand Down Expand Up @@ -335,6 +367,13 @@ define(function(require){
env.notebook.undelete_cell();
}
},
// TODO reminder
// open an issue, merge with above merge with last cell of notebook if at top.
'merge-selected-cell-with-cell-before' : {
handler : function (env) {
env.notebook.merge_cell_above();
}
},
'merge-selected-cell-with-cell-after' : {
help : 'merge cell below',
help_index : 'ek',
Expand Down Expand Up @@ -456,6 +495,21 @@ define(function(require){
return env.notebook.scroll_cell_percent(cell, 0, 0);
}
},
'duplicate-notebook':{
help: "Create an open a copy of current notebook",
handler : function (env, event) {
if (env.notebook.dirty) {
env.notebook.save_notebook({async : false});
}
env.notebook.copy_notebook();
}
},
'rename-notebook':{
help: "Rename current notebook",
handler : function (env, event) {
env.notebook.save_widget.rename_notebook({notebook: env.notebook})
}
},
'save-notebook':{
help: "Save and Checkpoint",
help_index : 'fb',
Expand Down
15 changes: 14 additions & 1 deletion notebook/static/notebook/js/main.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,7 @@ require([
var save_widget = new savewidget.SaveWidget('span#save_widget', {
events: events,
keyboard_manager: keyboard_manager});
acts.extend_env({save_widget:save_widget})
var contents = new contents.Contents({
base_url: common_options.base_url,
common_config: common_config
Expand Down Expand Up @@ -112,7 +113,8 @@ require([
contents: contents,
events: events,
save_widget: save_widget,
quick_help: quick_help},
quick_help: quick_help,
actions: acts},
common_options));
var notification_area = new notificationarea.NotebookNotificationArea(
'#notification_area', {
Expand Down Expand Up @@ -159,11 +161,22 @@ require([
IPython.keyboard_manager = keyboard_manager;
IPython.save_widget = save_widget;
IPython.tooltip = notebook.tooltip;

try {
events.trigger('app_initialized.NotebookApp');
} catch (e) {
console.error("Error in app_initialized callback", e);
}

Object.defineProperty( IPython, 'actions', {
get: function() {
console.warn('accessing "actions" on the global IPython/Jupyter is not recommended. Pass it to your objects contructors at creation time');
return acts;
},
enumerable: true,
configurable: false
});

utils.load_extensions_from_config(config_section);
utils.load_extensions_from_config(common_config);
notebook.load_notebook(common_options.notebook_path);
Expand Down
152 changes: 52 additions & 100 deletions notebook/static/notebook/js/menubar.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ define([
this.events = options.events;
this.save_widget = options.save_widget;
this.quick_help = options.quick_help;
this.actions = options.actions;

try {
this.tour = new tour.Tour(this.notebook, this.events);
Expand Down Expand Up @@ -90,6 +91,8 @@ define([
/**
* Update header spacer size.
*/
console.warn('`_size_header` is deprecated and will be removed in future versions.'+
' Please trigger the `resize-header.Page` manually if you rely on it.')
this.events.trigger('resize-header.Page');
};

Expand Down Expand Up @@ -153,12 +156,6 @@ define([
that.save_widget.rename_notebook({notebook: that.notebook});
});

this.element.find('#save_checkpoint').click(function () {
that.notebook.save_checkpoint();
});

this.element.find('#restore_checkpoint').click(function () {
});

this.element.find('#trust_notebook').click(function () {
that.notebook.trust_notebook();
Expand Down Expand Up @@ -190,99 +187,60 @@ define([
});
Copy link
Contributor

@jdfreder jdfreder Sep 15, 2015

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No actions for the above two :( ?


// Edit
this.element.find('#cut_cell').click(function () {
that.notebook.cut_cell();
});
this.element.find('#copy_cell').click(function () {
that.notebook.copy_cell();
});
this.element.find('#delete_cell').click(function () {
that.notebook.delete_cell();
});
this.element.find('#undelete_cell').click(function () {
that.notebook.undelete_cell();
});
this.element.find('#split_cell').click(function () {
that.notebook.split_cell();
});
this.element.find('#merge_cell_above').click(function () {
that.notebook.merge_cell_above();
});
this.element.find('#merge_cell_below').click(function () {
that.notebook.merge_cell_below();
});
this.element.find('#move_cell_up').click(function () {
that.notebook.move_cell_up();
});
this.element.find('#move_cell_down').click(function () {
that.notebook.move_cell_down();
});
this.element.find('#edit_nb_metadata').click(function () {
that.notebook.edit_metadata({
notebook: that.notebook,
keyboard_manager: that.notebook.keyboard_manager});
});
this.element.find('#search_and_replace').click(function(event) {
that.actions.call('ipython.search-and-replace-dialog', event, that);
});

// View
this.element.find('#toggle_header').click(function () {
$('#header-container').toggle();
$('.header-bar').toggle();
that._size_header();
});
this.element.find('#toggle_toolbar').click(function () {
$('div#maintoolbar').toggle();
that._size_header();
});
// Insert
this.element.find('#insert_cell_above').click(function () {
that.notebook.insert_cell_above('code');
that.notebook.select_prev();
});
this.element.find('#insert_cell_below').click(function () {
that.notebook.insert_cell_below('code');
that.notebook.select_next();
});
// Cell
this.element.find('#run_cell').click(function () {
that.notebook.execute_cell();
});
this.element.find('#run_cell_select_below').click(function () {
that.notebook.execute_cell_and_select_below();
});
this.element.find('#run_cell_insert_below').click(function () {
that.notebook.execute_cell_and_insert_below();
});
this.element.find('#run_all_cells').click(function () {
that.notebook.execute_all_cells();
});
this.element.find('#run_all_cells_above').click(function () {
that.notebook.execute_cells_above();
});
this.element.find('#run_all_cells_below').click(function () {
that.notebook.execute_cells_below();
});
this.element.find('#to_code').click(function () {
that.notebook.to_code();
});
this.element.find('#to_markdown').click(function () {
that.notebook.to_markdown();
});
this.element.find('#to_raw').click(function () {
that.notebook.to_raw();
});

this.element.find('#toggle_current_output').click(function () {
that.notebook.toggle_output();
});
this.element.find('#toggle_current_output_scroll').click(function () {
that.notebook.toggle_output_scroll();
});
this.element.find('#clear_current_output').click(function () {
that.notebook.clear_output();
});

var id_actions_dict = {
'#search_and_replace' : 'ipython.search-and-replace-dialog',
Copy link
Member Author

@Carreau Carreau Sep 17, 2015

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

And added search and replace here.

'#save_checkpoint': 'ipython.save-notebook',
'#restart_kernel': 'ipython.restart-kernel',
'#int_kernel': 'ipython.interrupt-kernel',
'#cut_cell': 'ipython.cut-selected-cell',
'#copy_cell': 'ipython.copy-selected-cell',
'#delete_cell': 'ipython.delete-cell',
'#undelete_cell': 'ipython.undo-last-cell-deletion',
'#split_cell': 'ipython.split-cell-at-cursor',
'#merge_cell_above': 'ipython.merge-selected-cell-with-cell-before',
'#merge_cell_below': 'ipython.merge-selected-cell-with-cell-after',
'#move_cell_up': 'ipython.move-selected-cell-up',
'#move_cell_down': 'ipython.move-selected-cell-down',
'#toggle_header': 'ipython.toggle-header',
'#toggle_toolbar': 'ipython.toggle-toolbar',
'#insert_cell_above': 'ipython.insert-cell-before',
'#insert_cell_below': 'ipython.insert-cell-after',
'#run_cell': 'ipython.execute-in-place',
'#run_cell_select_below': 'ipython.run-select-next',
'#run_cell_insert_below': 'ipython.execute-and-insert-after',
'#run_all_cells': 'ipython.run-all-cells',
'#run_all_cells_above': 'ipython.run-all-cells-above',
'#run_all_cells_below': 'ipython.run-all-cells-below',
'#to_code': 'ipython.change-selected-cell-to-code-cell',
'#to_markdown': 'ipython.change-selected-cell-to-markdown-cell',
'#to_raw': 'ipython.change-selected-cell-to-raw-cell',
'#toggle_current_output': 'ipython.toggle-output-visibility-selected-cell',
'#toggle_current_output_scroll': 'ipython.toggle-output-scrolling-selected-cell',
'#clear_current_output': 'ipython.clear-output-selected-cell',
};

for(var idx in id_actions_dict){
Copy link
Member

@minrk minrk Sep 18, 2015

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

for-in always needs Object.hasOwnProperty because js is the best.

Copy link
Member

@minrk minrk Sep 18, 2015

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually, I think Object.keys(id_actions_dict) works, too.

if (!id_actions_dict.hasOwnProperty(idx)){
continue;
}
var id_act = id_actions_dict[idx];
if(!that.actions.exists(id_act)){
console.warn('actions', id_act, 'does not exist, still binding it in case it will be defined later...' )
}
// Immediately-Invoked Function Expression cause JS.
(function(that, id_act, idx){
that.element.find(idx).click(function(event){
that.actions.call(id_act, event)
Copy link
Member Author

@Carreau Carreau Sep 17, 2015

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I now pass event in here.

})
})(that, id_act, idx);
}


this.element.find('#toggle_all_output').click(function () {
that.notebook.toggle_all_output();
Expand All @@ -295,12 +253,6 @@ define([
});

// Kernel
this.element.find('#int_kernel').click(function () {
that.notebook.kernel.interrupt();
});
this.element.find('#restart_kernel').click(function () {
that.notebook.restart_kernel();
});
this.element.find('#restart_run_all').click(function () {
that.actions.call('ipython.restart-run-all');
});
Expand Down