##// END OF EJS Templates
review pass on widgetmanager.js
MinRK -
Show More
@@ -1,216 +1,210 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 (Underscore, 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 if (cell.widget_subarea !== undefined
86 && cell.widget_subarea !== null) {
85 if (cell.widget_subarea) {
87 86
88 87 cell.widget_area.show();
89 88 cell.widget_subarea.append(view.$el);
90 89 }
91 90 }
92 91 };
93 92
94 93 WidgetManager.prototype.create_view = function(model, options, view) {
95 94 // Creates a view for a particular model.
96 95 var view_name = model.get('_view_name');
97 96 var ViewType = WidgetManager._view_types[view_name];
98 if (ViewType !== undefined && ViewType !== null) {
97 if (ViewType) {
99 98
100 99 // If a view is passed into the method, use that view's cell as
101 100 // the cell for the view that is created.
102 101 options = options || {};
103 102 if (view !== undefined) {
104 103 options.cell = view.options.cell;
105 104 }
106 105
107 106 // Create and render the view...
108 107 var parameters = {model: model, options: options};
109 var view = new ViewType(parameters);
108 view = new ViewType(parameters);
110 109 view.render();
111 110 model.views.push(view);
112 111 model.on('destroy', view.remove, view);
113 112
114 113 this._handle_new_view(view);
115 114 return view;
116 115 }
117 116 return null;
118 117 };
119 118
120 119 WidgetManager.prototype._handle_new_view = function (view) {
121 120 // Called when a view has been created and rendered.
122 121
123 122 // If the view has a well defined element, inform the keyboard
124 123 // manager about the view's element, so as the element can
125 124 // escape the dreaded command mode.
126 if (view.$el !== undefined && view.$el !== null) {
125 if (view.$el) {
127 126 IPython.keyboard_manager.register_events(view.$el);
128 127 }
129 }
128 };
130 129
131 130 WidgetManager.prototype.get_msg_cell = function (msg_id) {
132 131 var cell = null;
133 132 // First, check to see if the msg was triggered by cell execution.
134 if (IPython.notebook !== undefined && IPython.notebook !== null) {
133 if (IPython.notebook) {
135 134 cell = IPython.notebook.get_msg_cell(msg_id);
136 135 }
137 136 if (cell !== null) {
138 return cell
137 return cell;
139 138 }
140 139 // Second, check to see if a get_cell callback was defined
141 140 // for the message. get_cell callbacks are registered for
142 141 // widget messages, so this block is actually checking to see if the
143 142 // message was triggered by a widget.
144 143 var kernel = this.comm_manager.kernel;
145 if (kernel !== undefined && kernel !== null) {
144 if (kernel) {
146 145 var callbacks = kernel.get_callbacks_for_msg(msg_id);
147 if (callbacks !== undefined &&
148 callbacks.iopub !== undefined &&
146 if (callbacks && callbacks.iopub &&
149 147 callbacks.iopub.get_cell !== undefined) {
150
151 148 return callbacks.iopub.get_cell();
152 }
149 }
153 150 }
154 151
155 152 // Not triggered by a cell or widget (no get_cell callback
156 153 // exists).
157 154 return null;
158 155 };
159 156
160 157 WidgetManager.prototype.callbacks = function (view) {
161 158 // callback handlers specific a view
162 159 var callbacks = {};
163 if (view !== undefined &&
164 view !== null &&
165 view.options.cell !== undefined &&
166 view.options.cell !== null) {
160 if (view && view.options.cell) {
167 161
168 162 // Try to get output handlers
169 163 var cell = view.options.cell;
170 164 var handle_output = null;
171 165 var handle_clear_output = null;
172 if (cell.output_area !== undefined && cell.output_area !== null) {
166 if (cell.output_area) {
173 167 handle_output = $.proxy(cell.output_area.handle_output, cell.output_area);
174 168 handle_clear_output = $.proxy(cell.output_area.handle_clear_output, cell.output_area);
175 169 }
176 170
177 171 // Create callback dict using what is known
178 172 var that = this;
179 173 callbacks = {
180 174 iopub : {
181 175 output : handle_output,
182 176 clear_output : handle_clear_output,
183 177
184 178 // Special function only registered by widget messages.
185 179 // Allows us to get the cell for a message so we know
186 180 // where to add widgets if the code requires it.
187 181 get_cell : function () {
188 182 return cell;
189 183 },
190 184 },
191 185 };
192 186 }
193 187 return callbacks;
194 188 };
195 189
196 190 WidgetManager.prototype.get_model = function (model_id) {
197 191 // Look-up a model instance by its id.
198 192 var model = this._models[model_id];
199 193 if (model !== undefined && model.id == model_id) {
200 194 return model;
201 195 }
202 196 return null;
203 197 };
204 198
205 199 WidgetManager.prototype._handle_comm_open = function (comm, msg) {
206 200 // Handle when a comm is opened.
207 201 var model_id = comm.comm_id;
208 202 var widget_type_name = msg.content.target_name;
209 203 var widget_model = new WidgetManager._model_types[widget_type_name](this, model_id, comm);
210 204 this._models[model_id] = widget_model;
211 205 };
212 206
213 207 IPython.WidgetManager = WidgetManager;
214 208 return IPython.WidgetManager;
215 209 });
216 210 }());
General Comments 0
You need to be logged in to leave comments. Login now