Show More
@@ -1,210 +1,209 b'' | |||
|
1 | 1 | //---------------------------------------------------------------------------- |
|
2 | 2 | // Copyright (C) 2013 The IPython Development Team |
|
3 | 3 | // |
|
4 | 4 | // Distributed under the terms of the BSD License. The full license is in |
|
5 | 5 | // the file COPYING, distributed as part of this software. |
|
6 | 6 | //---------------------------------------------------------------------------- |
|
7 | 7 | |
|
8 | 8 | //============================================================================ |
|
9 | 9 | // WidgetModel, WidgetView, and WidgetManager |
|
10 | 10 | //============================================================================ |
|
11 | 11 | /** |
|
12 | 12 | * Base Widget classes |
|
13 | 13 | * @module IPython |
|
14 | 14 | * @namespace IPython |
|
15 | 15 | * @submodule widget |
|
16 | 16 | */ |
|
17 | 17 | |
|
18 | 18 | (function () { |
|
19 | 19 | "use strict"; |
|
20 | 20 | |
|
21 | 21 | // Use require.js 'define' method so that require.js is intelligent enough to |
|
22 | 22 | // syncronously load everything within this file when it is being 'required' |
|
23 | 23 | // elsewhere. |
|
24 | 24 | define(["underscore", |
|
25 | 25 | "backbone", |
|
26 | 26 | ], function (_, Backbone) { |
|
27 | 27 | |
|
28 | 28 | //-------------------------------------------------------------------- |
|
29 | 29 | // WidgetManager class |
|
30 | 30 | //-------------------------------------------------------------------- |
|
31 | 31 | var WidgetManager = function (comm_manager) { |
|
32 | 32 | // Public constructor |
|
33 | 33 | WidgetManager._managers.push(this); |
|
34 | 34 | |
|
35 | 35 | // Attach a comm manager to the |
|
36 | 36 | this.comm_manager = comm_manager; |
|
37 | 37 | this._models = {}; /* Dictionary of model ids and model instances */ |
|
38 | 38 | |
|
39 | 39 | // Register already-registered widget model types with the comm manager. |
|
40 | 40 | var that = this; |
|
41 | 41 | _.each(WidgetManager._model_types, function(model_type, model_name) { |
|
42 | 42 | that.comm_manager.register_target(model_name, $.proxy(that._handle_comm_open, that)); |
|
43 | 43 | }); |
|
44 | 44 | }; |
|
45 | 45 | |
|
46 | 46 | //-------------------------------------------------------------------- |
|
47 | 47 | // Class level |
|
48 | 48 | //-------------------------------------------------------------------- |
|
49 | 49 | WidgetManager._model_types = {}; /* Dictionary of model type names (target_name) and model types. */ |
|
50 | 50 | WidgetManager._view_types = {}; /* Dictionary of view names and view types. */ |
|
51 | 51 | WidgetManager._managers = []; /* List of widget managers */ |
|
52 | 52 | |
|
53 | 53 | WidgetManager.register_widget_model = function (model_name, model_type) { |
|
54 | 54 | // Registers a widget model by name. |
|
55 | 55 | WidgetManager._model_types[model_name] = model_type; |
|
56 | 56 | |
|
57 | 57 | // Register the widget with the comm manager. Make sure to pass this object's context |
|
58 | 58 | // in so `this` works in the call back. |
|
59 | 59 | _.each(WidgetManager._managers, function(instance, i) { |
|
60 | 60 | if (instance.comm_manager !== null) { |
|
61 | 61 | instance.comm_manager.register_target(model_name, $.proxy(instance._handle_comm_open, instance)); |
|
62 | 62 | } |
|
63 | 63 | }); |
|
64 | 64 | }; |
|
65 | 65 | |
|
66 | 66 | WidgetManager.register_widget_view = function (view_name, view_type) { |
|
67 | 67 | // Registers a widget view by name. |
|
68 | 68 | WidgetManager._view_types[view_name] = view_type; |
|
69 | 69 | }; |
|
70 | 70 | |
|
71 | 71 | //-------------------------------------------------------------------- |
|
72 | 72 | // Instance level |
|
73 | 73 | //-------------------------------------------------------------------- |
|
74 | 74 | WidgetManager.prototype.display_view = function(msg, model) { |
|
75 | 75 | // Displays a view for a particular model. |
|
76 | 76 | var cell = this.get_msg_cell(msg.parent_header.msg_id); |
|
77 | 77 | if (cell === null) { |
|
78 | 78 | console.log("Could not determine where the display" + |
|
79 | 79 | " message was from. Widget will not be displayed"); |
|
80 | 80 | } else { |
|
81 | 81 | var view = this.create_view(model, {cell: cell}); |
|
82 | 82 | if (view === null) { |
|
83 | 83 | console.error("View creation failed", model); |
|
84 | 84 | } |
|
85 | 85 | if (cell.widget_subarea) { |
|
86 | 86 | cell.widget_area.show(); |
|
87 | 87 | this._handle_display_view(view); |
|
88 | 88 | cell.widget_subarea.append(view.$el); |
|
89 | 89 | } |
|
90 | 90 | } |
|
91 | 91 | }; |
|
92 | 92 | |
|
93 | 93 | WidgetManager.prototype._handle_display_view = function (view) { |
|
94 | 94 | // Have the IPython keyboard manager disable its event |
|
95 | 95 | // handling so the widget can capture keyboard input. |
|
96 | 96 | // Note, this is only done on the outer most widgets. |
|
97 | 97 | IPython.keyboard_manager.register_events(view.$el); |
|
98 | 98 | |
|
99 | 99 | if (view.additional_elements) { |
|
100 | 100 | for (var i = 0; i < view.additional_elements.length; i++) { |
|
101 | 101 | IPython.keyboard_manager.register_events(view.additional_elements[i]); |
|
102 | 102 | } |
|
103 | 103 | } |
|
104 | 104 | }; |
|
105 | 105 | |
|
106 | 106 | WidgetManager.prototype.create_view = function(model, options, view) { |
|
107 | 107 | // Creates a view for a particular model. |
|
108 | 108 | var view_name = model.get('_view_name'); |
|
109 | 109 | var ViewType = WidgetManager._view_types[view_name]; |
|
110 | 110 | if (ViewType) { |
|
111 | 111 | |
|
112 | 112 | // If a view is passed into the method, use that view's cell as |
|
113 | 113 | // the cell for the view that is created. |
|
114 | 114 | options = options || {}; |
|
115 | 115 | if (view !== undefined) { |
|
116 | 116 | options.cell = view.options.cell; |
|
117 | 117 | } |
|
118 | 118 | |
|
119 | 119 | // Create and render the view... |
|
120 | 120 | var parameters = {model: model, options: options}; |
|
121 | 121 | view = new ViewType(parameters); |
|
122 | 122 | view.render(); |
|
123 | model.views.push(view); | |
|
124 | 123 | model.on('destroy', view.remove, view); |
|
125 | 124 | return view; |
|
126 | 125 | } |
|
127 | 126 | return null; |
|
128 | 127 | }; |
|
129 | 128 | |
|
130 | 129 | WidgetManager.prototype.get_msg_cell = function (msg_id) { |
|
131 | 130 | var cell = null; |
|
132 | 131 | // First, check to see if the msg was triggered by cell execution. |
|
133 | 132 | if (IPython.notebook) { |
|
134 | 133 | cell = IPython.notebook.get_msg_cell(msg_id); |
|
135 | 134 | } |
|
136 | 135 | if (cell !== null) { |
|
137 | 136 | return cell; |
|
138 | 137 | } |
|
139 | 138 | // Second, check to see if a get_cell callback was defined |
|
140 | 139 | // for the message. get_cell callbacks are registered for |
|
141 | 140 | // widget messages, so this block is actually checking to see if the |
|
142 | 141 | // message was triggered by a widget. |
|
143 | 142 | var kernel = this.comm_manager.kernel; |
|
144 | 143 | if (kernel) { |
|
145 | 144 | var callbacks = kernel.get_callbacks_for_msg(msg_id); |
|
146 | 145 | if (callbacks && callbacks.iopub && |
|
147 | 146 | callbacks.iopub.get_cell !== undefined) { |
|
148 | 147 | return callbacks.iopub.get_cell(); |
|
149 | 148 | } |
|
150 | 149 | } |
|
151 | 150 | |
|
152 | 151 | // Not triggered by a cell or widget (no get_cell callback |
|
153 | 152 | // exists). |
|
154 | 153 | return null; |
|
155 | 154 | }; |
|
156 | 155 | |
|
157 | 156 | WidgetManager.prototype.callbacks = function (view) { |
|
158 | 157 | // callback handlers specific a view |
|
159 | 158 | var callbacks = {}; |
|
160 | 159 | if (view && view.options.cell) { |
|
161 | 160 | |
|
162 | 161 | // Try to get output handlers |
|
163 | 162 | var cell = view.options.cell; |
|
164 | 163 | var handle_output = null; |
|
165 | 164 | var handle_clear_output = null; |
|
166 | 165 | if (cell.output_area) { |
|
167 | 166 | handle_output = $.proxy(cell.output_area.handle_output, cell.output_area); |
|
168 | 167 | handle_clear_output = $.proxy(cell.output_area.handle_clear_output, cell.output_area); |
|
169 | 168 | } |
|
170 | 169 | |
|
171 | 170 | // Create callback dict using what is known |
|
172 | 171 | var that = this; |
|
173 | 172 | callbacks = { |
|
174 | 173 | iopub : { |
|
175 | 174 | output : handle_output, |
|
176 | 175 | clear_output : handle_clear_output, |
|
177 | 176 | |
|
178 | 177 | // Special function only registered by widget messages. |
|
179 | 178 | // Allows us to get the cell for a message so we know |
|
180 | 179 | // where to add widgets if the code requires it. |
|
181 | 180 | get_cell : function () { |
|
182 | 181 | return cell; |
|
183 | 182 | }, |
|
184 | 183 | }, |
|
185 | 184 | }; |
|
186 | 185 | } |
|
187 | 186 | return callbacks; |
|
188 | 187 | }; |
|
189 | 188 | |
|
190 | 189 | WidgetManager.prototype.get_model = function (model_id) { |
|
191 | 190 | // Look-up a model instance by its id. |
|
192 | 191 | var model = this._models[model_id]; |
|
193 | 192 | if (model !== undefined && model.id == model_id) { |
|
194 | 193 | return model; |
|
195 | 194 | } |
|
196 | 195 | return null; |
|
197 | 196 | }; |
|
198 | 197 | |
|
199 | 198 | WidgetManager.prototype._handle_comm_open = function (comm, msg) { |
|
200 | 199 | // Handle when a comm is opened. |
|
201 | 200 | var model_id = comm.comm_id; |
|
202 | 201 | var widget_type_name = msg.content.target_name; |
|
203 | 202 | var widget_model = new WidgetManager._model_types[widget_type_name](this, model_id, comm); |
|
204 | 203 | this._models[model_id] = widget_model; |
|
205 | 204 | }; |
|
206 | 205 | |
|
207 | 206 | IPython.WidgetManager = WidgetManager; |
|
208 | 207 | return IPython.WidgetManager; |
|
209 | 208 | }); |
|
210 | 209 | }()); |
General Comments 0
You need to be logged in to leave comments.
Login now