widget.js
762 lines
| 28.9 KiB
| application/javascript
|
JavascriptLexer
|
r17198 | // Copyright (c) IPython Development Team. | ||
// Distributed under the terms of the Modified BSD License. | ||||
|
r14546 | |||
|
r15427 | define(["widgets/js/manager", | ||
|
r14546 | "underscore", | ||
|
r18892 | "backbone", | ||
"jquery", | ||||
"base/js/utils", | ||||
|
r17216 | "base/js/namespace", | ||
|
r18907 | ], function(widgetmanager, _, Backbone, $, utils, IPython){ | ||
|
r14609 | |||
|
r14546 | var WidgetModel = Backbone.Model.extend({ | ||
|
r18888 | constructor: function (widget_manager, model_id, comm) { | ||
|
r19176 | /** | ||
* Constructor | ||||
* | ||||
* Creates a WidgetModel instance. | ||||
* | ||||
* Parameters | ||||
* ---------- | ||||
* widget_manager : WidgetManager instance | ||||
* model_id : string | ||||
* An ID unique to this model. | ||||
* comm : Comm instance (optional) | ||||
*/ | ||||
|
r14546 | this.widget_manager = widget_manager; | ||
|
r18907 | this.state_change = Promise.resolve(); | ||
|
r15280 | this._buffered_state_diff = {}; | ||
|
r14546 | this.pending_msgs = 0; | ||
this.msg_buffer = null; | ||||
|
r17839 | this.state_lock = null; | ||
|
r14546 | this.id = model_id; | ||
|
r18007 | this.views = {}; | ||
|
r19360 | this._resolve_received_state = {}; | ||
|
r14546 | |||
if (comm !== undefined) { | ||||
// Remember comm associated with the model. | ||||
this.comm = comm; | ||||
comm.model = this; | ||||
// Hook comm messages up to model. | ||||
comm.on_close($.proxy(this._handle_comm_closed, this)); | ||||
comm.on_msg($.proxy(this._handle_comm_msg, this)); | ||||
|
r19350 | |||
// Assume the comm is alive. | ||||
|
r19360 | this.set_comm_live(true); | ||
|
r19350 | } else { | ||
|
r19360 | this.set_comm_live(false); | ||
|
r14546 | } | ||
|
r19566 | |||
// Listen for the events that lead to the websocket being terminated. | ||||
var that = this; | ||||
var died = function() { | ||||
that.set_comm_live(false); | ||||
}; | ||||
widget_manager.notebook.events.on('kernel_disconnected.Kernel', died); | ||||
widget_manager.notebook.events.on('kernel_killed.Kernel', died); | ||||
widget_manager.notebook.events.on('kernel_restarting.Kernel', died); | ||||
widget_manager.notebook.events.on('kernel_dead.Kernel', died); | ||||
|
r14546 | return Backbone.Model.apply(this); | ||
}, | ||||
send: function (content, callbacks) { | ||||
|
r19176 | /** | ||
* Send a custom msg over the comm. | ||||
*/ | ||||
|
r14546 | if (this.comm !== undefined) { | ||
|
r14655 | var data = {method: 'custom', content: content}; | ||
|
r14546 | this.comm.send(data, callbacks); | ||
|
r14741 | this.pending_msgs++; | ||
|
r14546 | } | ||
}, | ||||
|
r19350 | request_state: function(callbacks) { | ||
/** | ||||
* Request a state push from the back-end. | ||||
*/ | ||||
if (!this.comm) { | ||||
console.error("Could not request_state because comm doesn't exist!"); | ||||
return; | ||||
} | ||||
|
r19351 | |||
|
r19360 | var msg_id = this.comm.send({method: 'request_state'}, callbacks || this.widget_manager.callbacks()); | ||
|
r19351 | // Promise that is resolved when a state is received | ||
// from the back-end. | ||||
var that = this; | ||||
var received_state = new Promise(function(resolve) { | ||||
|
r19360 | that._resolve_received_state[msg_id] = resolve; | ||
|
r19351 | }); | ||
return received_state; | ||||
|
r19350 | }, | ||
|
r19360 | set_comm_live: function(live) { | ||
|
r19350 | /** | ||
|
r19360 | * Change the comm_live state of the model. | ||
|
r19350 | */ | ||
|
r19360 | if (this.comm_live === undefined || this.comm_live != live) { | ||
this.comm_live = live; | ||||
this.trigger(live ? 'comm:live' : 'comm:dead', {model: this}); | ||||
|
r19350 | } | ||
}, | ||||
close: function(comm_closed) { | ||||
|
r19176 | /** | ||
|
r19350 | * Close model | ||
|
r19176 | */ | ||
|
r19350 | if (this.comm && !comm_closed) { | ||
this.comm.close(); | ||||
} | ||||
|
r17857 | this.stopListening(); | ||
|
r17848 | this.trigger('destroy', this); | ||
|
r14546 | delete this.comm.model; // Delete ref so GC will collect widget model. | ||
delete this.comm; | ||||
delete this.model_id; // Delete id from model so widget manager cleans up. | ||||
|
r19170 | _.each(this.views, function(v, id, views) { | ||
v.then(function(view) { | ||||
view.remove(); | ||||
delete views[id]; | ||||
}); | ||||
}); | ||||
|
r14546 | }, | ||
|
r19350 | _handle_comm_closed: function (msg) { | ||
/** | ||||
* Handle when a widget is closed. | ||||
*/ | ||||
this.trigger('comm:close'); | ||||
this.close(true); | ||||
}, | ||||
|
r14546 | _handle_comm_msg: function (msg) { | ||
|
r19176 | /** | ||
* Handle incoming comm msg. | ||||
*/ | ||||
|
r14546 | var method = msg.content.data.method; | ||
|
r18893 | var that = this; | ||
|
r14546 | switch (method) { | ||
case 'update': | ||||
|
r19360 | this.state_change = this.state_change | ||
.then(function() { | ||||
return that.set_state(msg.content.data.state); | ||||
}).catch(utils.reject("Couldn't process update msg for model id '" + String(that.id) + "'", true)) | ||||
.then(function() { | ||||
var parent_id = msg.parent_header.msg_id; | ||||
if (that._resolve_received_state[parent_id] !== undefined) { | ||||
that._resolve_received_state[parent_id].call(); | ||||
delete that._resolve_received_state[parent_id]; | ||||
} | ||||
|
r19361 | }).catch(utils.reject("Couldn't resolve state request promise", true)); | ||
|
r14546 | break; | ||
case 'custom': | ||||
|
r14655 | this.trigger('msg:custom', msg.content.data.content); | ||
|
r14546 | break; | ||
|
r14559 | case 'display': | ||
|
r19351 | this.widget_manager.display_view(msg, this) | ||
|
r19361 | .catch(utils.reject('Could not process display view msg', true)); | ||
|
r14559 | break; | ||
|
r14546 | } | ||
}, | ||||
|
r18072 | set_state: function (state) { | ||
|
r18888 | var that = this; | ||
|
r14609 | // Handle when a widget is updated via the python side. | ||
|
r18893 | return this._unpack_models(state).then(function(state) { | ||
|
r18888 | that.state_lock = state; | ||
try { | ||||
|
r18893 | WidgetModel.__super__.set.call(that, state); | ||
|
r18888 | } finally { | ||
that.state_lock = null; | ||||
|
r18884 | } | ||
|
r19361 | }).catch(utils.reject("Couldn't set model state", true)); | ||
|
r19350 | }, | ||
get_state: function() { | ||||
// Get the serializable state of the model. | ||||
state = this.toJSON(); | ||||
for (var key in state) { | ||||
if (state.hasOwnProperty(key)) { | ||||
state[key] = this._pack_models(state[key]); | ||||
} | ||||
} | ||||
return state; | ||||
|
r14546 | }, | ||
_handle_status: function (msg, callbacks) { | ||||
|
r19176 | /** | ||
* Handle status msgs. | ||||
* | ||||
* execution_state : ('busy', 'idle', 'starting') | ||||
*/ | ||||
|
r14596 | if (this.comm !== undefined) { | ||
if (msg.content.execution_state ==='idle') { | ||||
// Send buffer if this message caused another message to be | ||||
// throttled. | ||||
if (this.msg_buffer !== null && | ||||
|
r15369 | (this.get('msg_throttle') || 3) === this.pending_msgs) { | ||
|
r14596 | var data = {method: 'backbone', sync_method: 'update', sync_data: this.msg_buffer}; | ||
|
r14792 | this.comm.send(data, callbacks); | ||
|
r14596 | this.msg_buffer = null; | ||
} else { | ||||
--this.pending_msgs; | ||||
} | ||||
|
r14546 | } | ||
} | ||||
}, | ||||
|
r14640 | callbacks: function(view) { | ||
|
r19176 | /** | ||
* Create msg callbacks for a comm msg. | ||||
*/ | ||||
|
r14640 | var callbacks = this.widget_manager.callbacks(view); | ||
if (callbacks.iopub === undefined) { | ||||
callbacks.iopub = {}; | ||||
} | ||||
|
r14639 | var that = this; | ||
callbacks.iopub.status = function (msg) { | ||||
that._handle_status(msg, callbacks); | ||||
|
r14792 | }; | ||
|
r14639 | return callbacks; | ||
}, | ||||
|
r14546 | |||
|
r15279 | set: function(key, val, options) { | ||
|
r19176 | /** | ||
* Set a value. | ||||
*/ | ||||
|
r15280 | var return_value = WidgetModel.__super__.set.apply(this, arguments); | ||
// Backbone only remembers the diff of the most recent set() | ||||
|
r15281 | // operation. Calling set multiple times in a row results in a | ||
|
r15280 | // loss of diff information. Here we keep our own running diff. | ||
this._buffered_state_diff = $.extend(this._buffered_state_diff, this.changedAttributes() || {}); | ||||
return return_value; | ||||
|
r15279 | }, | ||
|
r14639 | sync: function (method, model, options) { | ||
|
r19176 | /** | ||
* Handle sync to the back-end. Called when a model.save() is called. | ||||
* | ||||
* Make sure a comm exists. | ||||
*/ | ||||
|
r14640 | var error = options.error || function() { | ||
console.error('Backbone sync error:', arguments); | ||||
|
r14792 | }; | ||
|
r14639 | if (this.comm === undefined) { | ||
error(); | ||||
return false; | ||||
} | ||||
|
r14640 | // Delete any key value pairs that the back-end already knows about. | ||
|
r15274 | var attrs = (method === 'patch') ? options.attrs : model.toJSON(options); | ||
|
r17839 | if (this.state_lock !== null) { | ||
var keys = Object.keys(this.state_lock); | ||||
|
r17925 | for (var i=0; i<keys.length; i++) { | ||
|
r17839 | var key = keys[i]; | ||
if (attrs[key] === this.state_lock[key]) { | ||||
delete attrs[key]; | ||||
} | ||||
|
r14639 | } | ||
} | ||||
|
r14640 | // Only sync if there are attributes to send to the back-end. | ||
|
r15279 | attrs = this._pack_models(attrs); | ||
|
r14686 | if (_.size(attrs) > 0) { | ||
|
r14741 | |||
// If this message was sent via backbone itself, it will not | ||||
// have any callbacks. It's important that we create callbacks | ||||
// so we can listen for status messages, etc... | ||||
var callbacks = options.callbacks || this.callbacks(); | ||||
// Check throttle. | ||||
|
r15369 | if (this.pending_msgs >= (this.get('msg_throttle') || 3)) { | ||
|
r14640 | // The throttle has been exceeded, buffer the current msg so | ||
// it can be sent once the kernel has finished processing | ||||
// some of the existing messages. | ||||
// Combine updates if it is a 'patch' sync, otherwise replace updates | ||||
switch (method) { | ||||
case 'patch': | ||||
|
r14662 | this.msg_buffer = $.extend(this.msg_buffer || {}, attrs); | ||
|
r14640 | break; | ||
case 'update': | ||||
|
r14661 | case 'create': | ||
|
r14640 | this.msg_buffer = attrs; | ||
break; | ||||
default: | ||||
error(); | ||||
return false; | ||||
} | ||||
this.msg_buffer_callbacks = callbacks; | ||||
} else { | ||||
// We haven't exceeded the throttle, send the message like | ||||
|
r14741 | // normal. | ||
|
r14640 | var data = {method: 'backbone', sync_data: attrs}; | ||
this.comm.send(data, callbacks); | ||||
this.pending_msgs++; | ||||
} | ||||
|
r14546 | } | ||
// Since the comm is a one-way communication, assume the message | ||||
|
r14639 | // arrived. Don't call success since we don't have a model back from the server | ||
// this means we miss out on the 'sync' event. | ||||
|
r15280 | this._buffered_state_diff = {}; | ||
|
r14546 | }, | ||
|
r14639 | save_changes: function(callbacks) { | ||
|
r19176 | /** | ||
* Push this model's state to the back-end | ||||
* | ||||
* This invokes a Backbone.Sync. | ||||
*/ | ||||
|
r15280 | this.save(this._buffered_state_diff, {patch: true, callbacks: callbacks}); | ||
|
r14618 | }, | ||
|
r14583 | _pack_models: function(value) { | ||
|
r19176 | /** | ||
* Replace models with model ids recursively. | ||||
*/ | ||||
|
r17199 | var that = this; | ||
var packed; | ||||
|
r14583 | if (value instanceof Backbone.Model) { | ||
|
r17262 | return "IPY_MODEL_" + value.id; | ||
|
r15063 | |||
} else if ($.isArray(value)) { | ||||
|
r17199 | packed = []; | ||
|
r15063 | _.each(value, function(sub_value, key) { | ||
packed.push(that._pack_models(sub_value)); | ||||
}); | ||||
return packed; | ||||
|
r18821 | } else if (value instanceof Date || value instanceof String) { | ||
|
r18820 | return value; | ||
|
r14583 | } else if (value instanceof Object) { | ||
|
r17199 | packed = {}; | ||
|
r14664 | _.each(value, function(sub_value, key) { | ||
|
r14686 | packed[key] = that._pack_models(sub_value); | ||
|
r14664 | }); | ||
|
r14583 | return packed; | ||
|
r15063 | |||
|
r14583 | } else { | ||
return value; | ||||
} | ||||
}, | ||||
_unpack_models: function(value) { | ||||
|
r19176 | /** | ||
* Replace model ids with models recursively. | ||||
*/ | ||||
|
r17198 | var that = this; | ||
var unpacked; | ||||
|
r18888 | if ($.isArray(value)) { | ||
unpacked = []; | ||||
_.each(value, function(sub_value, key) { | ||||
unpacked.push(that._unpack_models(sub_value)); | ||||
}); | ||||
|
r18907 | return Promise.all(unpacked); | ||
|
r18888 | } else if (value instanceof Object) { | ||
|
r18896 | unpacked = {}; | ||
|
r18888 | _.each(value, function(sub_value, key) { | ||
|
r18896 | unpacked[key] = that._unpack_models(sub_value); | ||
|
r18888 | }); | ||
|
r18935 | return utils.resolve_promises_dict(unpacked); | ||
|
r18888 | } else if (typeof value === 'string' && value.slice(0,10) === "IPY_MODEL_") { | ||
// get_model returns a promise already | ||||
return this.widget_manager.get_model(value.slice(10, value.length)); | ||||
} else { | ||||
|
r18907 | return Promise.resolve(value); | ||
|
r18888 | } | ||
|
r14583 | }, | ||
|
r18008 | on_some_change: function(keys, callback, context) { | ||
|
r19176 | /** | ||
* on_some_change(["key1", "key2"], foo, context) differs from | ||||
* on("change:key1 change:key2", foo, context). | ||||
* If the widget attributes key1 and key2 are both modified, | ||||
* the second form will result in foo being called twice | ||||
* while the first will call foo only once. | ||||
*/ | ||||
|
r17838 | this.on('change', function() { | ||
if (keys.some(this.hasChanged, this)) { | ||||
callback.apply(context); | ||||
} | ||||
}, this); | ||||
}, | ||||
|
r14546 | }); | ||
|
r17202 | widgetmanager.WidgetManager.register_widget_model('WidgetModel', WidgetModel); | ||
|
r14546 | |||
|
r14564 | var WidgetView = Backbone.View.extend({ | ||
|
r14565 | initialize: function(parameters) { | ||
|
r19176 | /** | ||
* Public constructor. | ||||
*/ | ||||
|
r14546 | this.model.on('change',this.update,this); | ||
|
r19572 | |||
// Bubble the comm live events. | ||||
|
r19566 | this.model.on('comm:live', function() { | ||
|
r19572 | this.trigger('comm:live', this); | ||
|
r19566 | }, this); | ||
this.model.on('comm:dead', function() { | ||||
|
r19572 | this.trigger('comm:dead', this); | ||
|
r19566 | }, this); | ||
|
r14565 | this.options = parameters.options; | ||
|
r17270 | this.on('displayed', function() { | ||
this.is_displayed = true; | ||||
}, this); | ||||
|
r14546 | }, | ||
update: function(){ | ||||
|
r19176 | /** | ||
* Triggered on model change. | ||||
* | ||||
* Update view to be consistent with this.model | ||||
*/ | ||||
|
r14546 | }, | ||
|
r14598 | create_child_view: function(child_model, options) { | ||
|
r19176 | /** | ||
* Create and promise that resolves to a child view of a given model | ||||
*/ | ||||
|
r18884 | var that = this; | ||
|
r18888 | options = $.extend({ parent: this }, options || {}); | ||
|
r19080 | return this.model.widget_manager.create_view(child_model, options).catch(utils.reject("Couldn't create child view"), true); | ||
|
r14546 | }, | ||
callbacks: function(){ | ||||
|
r19176 | /** | ||
* Create msg callbacks for a comm msg. | ||||
*/ | ||||
|
r14640 | return this.model.callbacks(this); | ||
|
r14560 | }, | ||
|
r14546 | |||
render: function(){ | ||||
|
r19176 | /** | ||
* Render the view. | ||||
* | ||||
* By default, this is only called the first time the view is created | ||||
*/ | ||||
|
r14546 | }, | ||
|
r14609 | |||
|
r14546 | send: function (content) { | ||
|
r19176 | /** | ||
* Send a custom msg associated with this view. | ||||
*/ | ||||
|
r14546 | this.model.send(content, this.callbacks()); | ||
}, | ||||
touch: function () { | ||||
|
r14639 | this.model.save_changes(this.callbacks()); | ||
|
r14546 | }, | ||
|
r17270 | |||
|
r17329 | after_displayed: function (callback, context) { | ||
|
r19176 | /** | ||
* Calls the callback right away is the view is already displayed | ||||
* otherwise, register the callback to the 'displayed' event. | ||||
*/ | ||||
|
r17270 | if (this.is_displayed) { | ||
callback.apply(context); | ||||
} else { | ||||
this.on('displayed', callback, context); | ||||
} | ||||
|
r19350 | }, | ||
remove: function () { | ||||
// Raise a remove event when the view is removed. | ||||
WidgetView.__super__.remove.apply(this, arguments); | ||||
this.trigger('remove'); | ||||
|
r19194 | } | ||
|
r14546 | }); | ||
|
r14609 | |||
|
r14564 | var DOMWidgetView = WidgetView.extend({ | ||
|
r17448 | initialize: function (parameters) { | ||
|
r19176 | /** | ||
* Public constructor | ||||
*/ | ||||
|
r17448 | DOMWidgetView.__super__.initialize.apply(this, [parameters]); | ||
|
r17347 | this.model.on('change:visible', this.update_visible, this); | ||
this.model.on('change:_css', this.update_css, this); | ||||
|
r17727 | |||
|
r17720 | this.model.on('change:_dom_classes', function(model, new_classes) { | ||
|
r17731 | var old_classes = model.previous('_dom_classes'); | ||
|
r17720 | this.update_classes(old_classes, new_classes); | ||
}, this); | ||||
|
r17727 | |||
|
r17860 | this.model.on('change:color', function (model, value) { | ||
|
r17722 | this.update_attr('color', value); }, this); | ||
|
r17727 | |||
|
r17860 | this.model.on('change:background_color', function (model, value) { | ||
|
r17722 | this.update_attr('background', value); }, this); | ||
|
r17727 | |||
|
r17722 | this.model.on('change:width', function (model, value) { | ||
this.update_attr('width', value); }, this); | ||||
|
r17727 | |||
|
r17722 | this.model.on('change:height', function (model, value) { | ||
this.update_attr('height', value); }, this); | ||||
|
r17727 | |||
|
r17722 | this.model.on('change:border_color', function (model, value) { | ||
this.update_attr('border-color', value); }, this); | ||||
|
r17727 | |||
|
r17722 | this.model.on('change:border_width', function (model, value) { | ||
this.update_attr('border-width', value); }, this); | ||||
|
r17727 | |||
|
r17722 | this.model.on('change:border_style', function (model, value) { | ||
this.update_attr('border-style', value); }, this); | ||||
|
r17727 | |||
|
r17722 | this.model.on('change:font_style', function (model, value) { | ||
this.update_attr('font-style', value); }, this); | ||||
|
r17727 | |||
|
r17722 | this.model.on('change:font_weight', function (model, value) { | ||
this.update_attr('font-weight', value); }, this); | ||||
|
r17727 | |||
|
r17722 | this.model.on('change:font_size', function (model, value) { | ||
|
r17947 | this.update_attr('font-size', this._default_px(value)); }, this); | ||
|
r17727 | |||
|
r17722 | this.model.on('change:font_family', function (model, value) { | ||
this.update_attr('font-family', value); }, this); | ||||
|
r17727 | |||
this.model.on('change:padding', function (model, value) { | ||||
this.update_attr('padding', value); }, this); | ||||
this.model.on('change:margin', function (model, value) { | ||||
|
r17947 | this.update_attr('margin', this._default_px(value)); }, this); | ||
this.model.on('change:border_radius', function (model, value) { | ||||
this.update_attr('border-radius', this._default_px(value)); }, this); | ||||
|
r17727 | |||
|
r17386 | this.after_displayed(function() { | ||
this.update_visible(this.model, this.model.get("visible")); | ||||
|
r17727 | this.update_classes([], this.model.get('_dom_classes')); | ||
|
r18177 | |||
|
r17860 | this.update_attr('color', this.model.get('color')); | ||
this.update_attr('background', this.model.get('background_color')); | ||||
|
r17727 | this.update_attr('width', this.model.get('width')); | ||
this.update_attr('height', this.model.get('height')); | ||||
this.update_attr('border-color', this.model.get('border_color')); | ||||
this.update_attr('border-width', this.model.get('border_width')); | ||||
this.update_attr('border-style', this.model.get('border_style')); | ||||
this.update_attr('font-style', this.model.get('font_style')); | ||||
this.update_attr('font-weight', this.model.get('font_weight')); | ||||
this.update_attr('font-size', this.model.get('font_size')); | ||||
this.update_attr('font-family', this.model.get('font_family')); | ||||
this.update_attr('padding', this.model.get('padding')); | ||||
this.update_attr('margin', this.model.get('margin')); | ||||
|
r17947 | this.update_attr('border-radius', this.model.get('border_radius')); | ||
|
r18177 | |||
this.update_css(this.model, this.model.get("_css")); | ||||
|
r17386 | }, this); | ||
|
r14546 | }, | ||
|
r17386 | |||
|
r17947 | _default_px: function(value) { | ||
|
r19176 | /** | ||
* Makes browser interpret a numerical string as a pixel value. | ||||
*/ | ||||
|
r17947 | if (/^\d+\.?(\d+)?$/.test(value.trim())) { | ||
return value.trim() + 'px'; | ||||
|
r14546 | } | ||
|
r17947 | return value; | ||
|
r14546 | }, | ||
|
r17722 | update_attr: function(name, value) { | ||
|
r19176 | /** | ||
* Set a css attr of the widget view. | ||||
*/ | ||||
|
r17722 | this.$el.css(name, value); | ||
|
r14546 | }, | ||
|
r17386 | |||
|
r17347 | update_visible: function(model, value) { | ||
|
r19176 | /** | ||
* Update visibility | ||||
*/ | ||||
|
r19186 | switch(value) { | ||
case null: // python None | ||||
this.$el.show().css('visibility', 'hidden'); break; | ||||
case false: | ||||
this.$el.hide(); break; | ||||
case true: | ||||
this.$el.show().css('visibility', ''); break; | ||||
} | ||||
|
r17347 | }, | ||
update_css: function (model, css) { | ||||
|
r19176 | /** | ||
* Update the css styling of this view. | ||||
*/ | ||||
|
r14546 | var e = this.$el; | ||
if (css === undefined) {return;} | ||||
|
r17177 | for (var i = 0; i < css.length; i++) { | ||
|
r14664 | // Apply the css traits to all elements that match the selector. | ||
|
r17177 | var selector = css[i][0]; | ||
var elements = this._get_selector_element(selector); | ||||
|
r14664 | if (elements.length > 0) { | ||
|
r17177 | var trait_key = css[i][1]; | ||
var trait_value = css[i][2]; | ||||
elements.css(trait_key ,trait_value); | ||||
|
r14546 | } | ||
|
r17177 | } | ||
|
r14546 | }, | ||
|
r17728 | update_classes: function (old_classes, new_classes, $el) { | ||
|
r19176 | /** | ||
* Update the DOM classes applied to an element, default to this.$el. | ||||
*/ | ||||
|
r17728 | if ($el===undefined) { | ||
$el = this.$el; | ||||
} | ||||
|
r19064 | _.difference(old_classes, new_classes).map(function(c) {$el.removeClass(c);}) | ||
_.difference(new_classes, old_classes).map(function(c) {$el.addClass(c);}) | ||||
|
r17720 | }, | ||
|
r17728 | update_mapped_classes: function(class_map, trait_name, previous_trait_value, $el) { | ||
|
r19176 | /** | ||
* Update the DOM classes applied to the widget based on a single | ||||
* trait's value. | ||||
* | ||||
* Given a trait value classes map, this function automatically | ||||
* handles applying the appropriate classes to the widget element | ||||
* and removing classes that are no longer valid. | ||||
* | ||||
* Parameters | ||||
* ---------- | ||||
* class_map: dictionary | ||||
* Dictionary of trait values to class lists. | ||||
* Example: | ||||
* { | ||||
* success: ['alert', 'alert-success'], | ||||
* info: ['alert', 'alert-info'], | ||||
* warning: ['alert', 'alert-warning'], | ||||
* danger: ['alert', 'alert-danger'] | ||||
* }; | ||||
* trait_name: string | ||||
* Name of the trait to check the value of. | ||||
* previous_trait_value: optional string, default '' | ||||
* Last trait value | ||||
* $el: optional jQuery element handle, defaults to this.$el | ||||
* Element that the classes are applied to. | ||||
*/ | ||||
|
r17728 | var key = previous_trait_value; | ||
if (key === undefined) { | ||||
key = this.model.previous(trait_name); | ||||
} | ||||
var old_classes = class_map[key] ? class_map[key] : []; | ||||
key = this.model.get(trait_name); | ||||
var new_classes = class_map[key] ? class_map[key] : []; | ||||
this.update_classes(old_classes, new_classes, $el || this.$el); | ||||
}, | ||||
|
r14546 | _get_selector_element: function (selector) { | ||
|
r19176 | /** | ||
* Get the elements via the css selector. | ||||
*/ | ||||
|
r14546 | var elements; | ||
|
r14792 | if (!selector) { | ||
|
r17420 | elements = this.$el; | ||
|
r14546 | } else { | ||
|
r17420 | elements = this.$el.find(selector).addBack(selector); | ||
|
r14546 | } | ||
return elements; | ||||
}, | ||||
|
r19197 | |||
|
r19198 | typeset: function(element, text){ | ||
|
r19235 | utils.typeset.apply(null, arguments); | ||
|
r19197 | }, | ||
|
r14546 | }); | ||
|
r18996 | |||
var ViewList = function(create_view, remove_view, context) { | ||||
|
r19176 | /** | ||
|
r19177 | * - create_view and remove_view are default functions called when adding or removing views | ||
* - create_view takes a model and returns a view or a promise for a view for that model | ||||
* - remove_view takes a view and destroys it (including calling `view.remove()`) | ||||
* - each time the update() function is called with a new list, the create and remove | ||||
|
r19176 | * callbacks will be called in an order so that if you append the views created in the | ||
* create callback and remove the views in the remove callback, you will duplicate | ||||
* the order of the list. | ||||
|
r19177 | * - the remove callback defaults to just removing the view (e.g., pass in null for the second parameter) | ||
* - the context defaults to the created ViewList. If you pass another context, the create and remove | ||||
|
r19176 | * will be called in that context. | ||
*/ | ||||
|
r18996 | |||
this.initialize.apply(this, arguments); | ||||
|
r19023 | }; | ||
|
r18996 | |||
_.extend(ViewList.prototype, { | ||||
initialize: function(create_view, remove_view, context) { | ||||
this._handler_context = context || this; | ||||
this._models = []; | ||||
|
r19377 | this.views = []; // list of promises for views | ||
|
r18996 | this._create_view = create_view; | ||
|
r19002 | this._remove_view = remove_view || function(view) {view.remove();}; | ||
|
r18996 | }, | ||
update: function(new_models, create_view, remove_view, context) { | ||||
|
r19176 | /** | ||
* the create_view, remove_view, and context arguments override the defaults | ||||
* specified when the list is created. | ||||
|
r19377 | * after this function, the .views attribute is a list of promises for views | ||
* if you want to perform some action on the list of views, do something like | ||||
* `Promise.all(myviewlist.views).then(function(views) {...});` | ||||
|
r19176 | */ | ||
|
r18996 | var remove = remove_view || this._remove_view; | ||
var create = create_view || this._create_view; | ||||
var context = context || this._handler_context; | ||||
|
r19377 | var i = 0; | ||
// first, skip past the beginning of the lists if they are identical | ||||
for (; i < new_models.length; i++) { | ||||
if (i >= this._models.length || new_models[i] !== this._models[i]) { | ||||
break; | ||||
|
r18996 | } | ||
|
r19377 | } | ||
var first_removed = i; | ||||
// Remove the non-matching items from the old list. | ||||
var removed = this.views.splice(first_removed, this.views.length-first_removed); | ||||
for (var j = 0; j < removed.length; j++) { | ||||
removed[j].then(function(view) { | ||||
remove.call(context, view) | ||||
|
r18996 | }); | ||
|
r19377 | } | ||
// Add the rest of the new list items. | ||||
for (; i < new_models.length; i++) { | ||||
this.views.push(Promise.resolve(create.call(context, new_models[i]))); | ||||
} | ||||
// make a copy of the input array | ||||
this._models = new_models.slice(); | ||||
|
r18996 | }, | ||
remove: function() { | ||||
|
r19176 | /** | ||
* removes every view in the list; convenience function for `.update([])` | ||||
* that should be faster | ||||
* returns a promise that resolves after this removal is done | ||||
*/ | ||||
|
r18996 | var that = this; | ||
|
r19407 | return Promise.all(this.views).then(function(views) { | ||
|
r19087 | for (var i = 0; i < that.views.length; i++) { | ||
|
r19377 | that._remove_view.call(that._handler_context, views[i]); | ||
|
r19023 | } | ||
|
r18996 | that.views = []; | ||
|
r19377 | that._models = []; | ||
|
r18996 | }); | ||
}, | ||||
}); | ||||
|
r17216 | var widget = { | ||
|
r17198 | 'WidgetModel': WidgetModel, | ||
'WidgetView': WidgetView, | ||||
'DOMWidgetView': DOMWidgetView, | ||||
|
r18996 | 'ViewList': ViewList, | ||
|
r17198 | }; | ||
|
r17216 | |||
// For backwards compatability. | ||||
$.extend(IPython, widget); | ||||
return widget; | ||||
|
r14546 | }); | ||