##// END OF EJS Templates
Add docs/source/whatsnew/pr/interact-manual.rst
Add docs/source/whatsnew/pr/interact-manual.rst

File last commit:

r17688:bf4687aa
r17943:80a6dc6e
Show More
widget_box.js
307 lines | 11.7 KiB | application/javascript | JavascriptLexer
// Copyright (c) IPython Development Team.
// Distributed under the terms of the Modified BSD License.
define([
"widgets/js/widget",
"jqueryui",
"bootstrap",
], function(widget, $){
var BoxView = widget.DOMWidgetView.extend({
initialize: function(){
// Public constructor
BoxView.__super__.initialize.apply(this, arguments);
this.model.on('change:children', function(model, value) {
this.update_children(model.previous('children'), value);
}, this);
},
render: function(){
// Called when view is rendered.
this.$box = this.$el;
this.$box.addClass('widget-box');
this.update_children([], this.model.get('children'));
},
update_children: function(old_list, new_list) {
// Called when the children list changes.
this.do_diff(old_list, new_list,
$.proxy(this.remove_child_model, this),
$.proxy(this.add_child_model, this));
},
remove_child_model: function(model) {
// Called when a model is removed from the children list.
this.pop_child_view(model).remove();
},
add_child_model: function(model) {
// Called when a model is added to the children list.
var view = this.create_child_view(model);
this.$box.append(view.$el);
// Trigger the displayed event of the child view.
this.after_displayed(function() {
view.trigger('displayed');
});
},
});
var FlexBoxView = BoxView.extend({
render: function(){
FlexBoxView.__super__.render.apply(this);
this.model.on('change:orientation', this.update_orientation, this);
this.model.on('change:flex', this._flex_changed, this);
this.model.on('change:pack', this._pack_changed, this);
this.model.on('change:align', this._align_changed, this);
this._flex_changed();
this._pack_changed();
this._align_changed();
this.update_orientation();
},
update_orientation: function(){
var orientation = this.model.get("orientation");
if (orientation == "vertical") {
this.$box.removeClass("hbox").addClass("vbox");
} else {
this.$box.removeClass("vbox").addClass("hbox");
}
},
_flex_changed: function(){
if (this.model.previous('flex')) {
this.$box.removeClass('box-flex' + this.model.previous('flex'));
}
this.$box.addClass('box-flex' + this.model.get('flex'));
},
_pack_changed: function(){
if (this.model.previous('pack')) {
this.$box.removeClass(this.model.previous('pack'));
}
this.$box.addClass(this.model.get('pack'));
},
_align_changed: function(){
if (this.model.previous('align')) {
this.$box.removeClass('align-' + this.model.previous('align'));
}
this.$box.addClass('align-' + this.model.get('align'));
},
});
var PopupView = BoxView.extend({
render: function(){
// Called when view is rendered.
var that = this;
this.$el.on("remove", function(){
that.$backdrop.remove();
});
this.$backdrop = $('<div />')
.appendTo($('#notebook-container'))
.addClass('modal-dialog')
.css('position', 'absolute')
.css('left', '0px')
.css('top', '0px');
this.$window = $('<div />')
.appendTo(this.$backdrop)
.addClass('modal-content widget-modal')
.mousedown(function(){
that.bring_to_front();
});
// Set the elements array since the this.$window element is not child
// of this.$el and the parent widget manager or other widgets may
// need to know about all of the top-level widgets. The IPython
// widget manager uses this to register the elements with the
// keyboard manager.
this.additional_elements = [this.$window];
this.$title_bar = $('<div />')
.addClass('popover-title')
.appendTo(this.$window)
.mousedown(function(){
that.bring_to_front();
});
this.$close = $('<button />')
.addClass('close fa fa-remove')
.css('margin-left', '5px')
.appendTo(this.$title_bar)
.click(function(){
that.hide();
event.stopPropagation();
});
this.$minimize = $('<button />')
.addClass('close fa fa-arrow-down')
.appendTo(this.$title_bar)
.click(function(){
that.popped_out = !that.popped_out;
if (!that.popped_out) {
that.$minimize
.removeClass('fa fa-arrow-down')
.addClass('fa fa-arrow-up');
that.$window
.draggable('destroy')
.resizable('destroy')
.removeClass('widget-modal modal-content')
.addClass('docked-widget-modal')
.detach()
.insertBefore(that.$show_button);
that.$show_button.hide();
that.$close.hide();
} else {
that.$minimize
.addClass('fa fa-arrow-down')
.removeClass('fa fa-arrow-up');
that.$window
.removeClass('docked-widget-modal')
.addClass('widget-modal modal-content')
.detach()
.appendTo(that.$backdrop)
.draggable({handle: '.popover-title', snap: '#notebook, .modal', snapMode: 'both'})
.resizable()
.children('.ui-resizable-handle').show();
that.show();
that.$show_button.show();
that.$close.show();
}
event.stopPropagation();
});
this.$title = $('<div />')
.addClass('widget-modal-title')
.html("&nbsp;")
.appendTo(this.$title_bar);
this.$box = $('<div />')
.addClass('modal-body')
.addClass('widget-modal-body')
.addClass('widget-box')
.addClass('vbox')
.appendTo(this.$window);
this.$show_button = $('<button />')
.html("&nbsp;")
.addClass('btn btn-info widget-modal-show')
.appendTo(this.$el)
.click(function(){
that.show();
});
this.$window.draggable({handle: '.popover-title', snap: '#notebook, .modal', snapMode: 'both'});
this.$window.resizable();
this.$window.on('resize', function(){
that.$box.outerHeight(that.$window.innerHeight() - that.$title_bar.outerHeight());
});
this._shown_once = false;
this.popped_out = true;
this.update_children([], this.model.get('children'));
this.model.on('change:children', function(model, value) {
this.update_children(model.previous('children'), value);
}, this);
},
hide: function() {
// Called when the modal hide button is clicked.
this.$window.hide();
this.$show_button.removeClass('btn-info');
},
show: function() {
// Called when the modal show button is clicked.
this.$show_button.addClass('btn-info');
this.$window.show();
if (this.popped_out) {
this.$window.css("positon", "absolute");
this.$window.css("top", "0px");
this.$window.css("left", Math.max(0, (($('body').outerWidth() - this.$window.outerWidth()) / 2) +
$(window).scrollLeft()) + "px");
this.bring_to_front();
}
},
bring_to_front: function() {
// Make the modal top-most, z-ordered about the other modals.
var $widget_modals = $(".widget-modal");
var max_zindex = 0;
$widget_modals.each(function (index, el){
var zindex = parseInt($(el).css('z-index'));
if (!isNaN(zindex)) {
max_zindex = Math.max(max_zindex, zindex);
}
});
// Start z-index of widget modals at 2000
max_zindex = Math.max(max_zindex, 2000);
$widget_modals.each(function (index, el){
$el = $(el);
if (max_zindex == parseInt($el.css('z-index'))) {
$el.css('z-index', max_zindex - 1);
}
});
this.$window.css('z-index', max_zindex);
},
update: function(){
// Update the contents of this view
//
// Called when the model is changed. The model may have been
// changed by another view or by a state update from the back-end.
var description = this.model.get('description');
if (description.trim().length === 0) {
this.$title.html("&nbsp;"); // Preserve title height
} else {
this.$title.text(description);
MathJax.Hub.Queue(["Typeset",MathJax.Hub,this.$title.get(0)]);
}
var button_text = this.model.get('button_text');
if (button_text.trim().length === 0) {
this.$show_button.html("&nbsp;"); // Preserve button height
} else {
this.$show_button.text(button_text);
}
if (!this._shown_once) {
this._shown_once = true;
this.show();
}
return PopupView.__super__.update.apply(this);
},
_get_selector_element: function(selector) {
// Get an element view a 'special' jquery selector. (see widget.js)
//
// Since the modal actually isn't within the $el in the DOM, we need to extend
// the selector logic to allow the user to set css on the modal if need be.
// The convention used is:
// "modal" - select the modal div
// "modal [selector]" - select element(s) within the modal div.
// "[selector]" - select elements within $el
// "" - select the $el
if (selector.substring(0, 5) == 'modal') {
if (selector == 'modal') {
return this.$window;
} else {
return this.$window.find(selector.substring(6));
}
} else {
return PopupView.__super__._get_selector_element.apply(this, [selector]);
}
},
});
return {
'BoxView': BoxView,
'PopupView': PopupView,
'FlexBoxView': FlexBoxView,
};
});