forked from marionettejs/backbone.marionette
-
Notifications
You must be signed in to change notification settings - Fork 0
/
backbone.marionette.js
516 lines (435 loc) · 14.8 KB
/
backbone.marionette.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
// Backbone.Marionette v0.4.1
//
// Copyright (C)2011 Derick Bailey, Muted Solutions, LLC
// Distributed Under MIT License
//
// Documentation and Full License Available at:
// http://github.com/derickbailey/backbone.marionette
Backbone.Marionette = (function(Backbone, _, $){
var Marionette = {};
Marionette.version = "0.4.1";
// Region Manager
// --------------
// Manage the visual regions of your composite application. See
// http://lostechies.com/derickbailey/2011/12/12/composite-js-apps-regions-and-region-managers/
Marionette.RegionManager = function(options){
this.options = options || {};
if (!this.el){
var err = new Error("An 'el' must be specified");
err.name = "NoElError";
throw err;
}
this.$el = $(this.el);
};
_.extend(Marionette.RegionManager.prototype, Backbone.Events, {
// Displays a backbone view instance inside of the region.
// Handles calling the `render` method for you. Reads content
// directly from the `el` attribute. Also calls an optional
// `onShow` and `close` method on your view, just after showing
// or just before closing the view, respectively.
show: function(view){
var oldView = this.currentView;
this.currentView = view;
this._closeView(oldView);
this._openView(view);
},
_closeView: function(view){
if (view && view.close){
view.close();
}
},
_openView: function(view){
view.render();
this.$el.html(view.el);
if (view.onShow){
view.onShow();
}
}
});
// Item View
// ---------
// A single item view implementation that contains code for rendering
// with underscore.js templates, serializing the view's model or collection,
// and calling several methods on extended views, such as `onRender`.
Marionette.ItemView = Backbone.View.extend({
constructor: function(){
var args = slice.call(arguments);
Backbone.View.prototype.constructor.apply(this, args);
_.bindAll(this, "render");
},
// Serialize the model or collection for the view. If a model is
// found, `.toJSON()` is called. If a collection is found, `.toJSON()`
// is also called, but is used to populate an `items` array in the
// resulting data. If both are found, defaults to the model.
// You can override the `serializeData` method in your own view
// definition, to provide custom serialization for your view's data.
serializeData: function(){
var data;
if (this.collection) {
data = {};
data.items = this.collection.toJSON();
}
if (this.model) { data = this.model.toJSON(); }
return data;
},
// Either provide a `template: "#foo"` selector in the view
// definition, or provide it at instantiation: `new
// MyView({ template: "#foo" });`.
template: function(){
return $(this.options.template);
},
// Render the view, defaulting to underscore.js templates.
// You can override this in your view definition.
render: function(){
var that = this;
var data = this.serializeData();
this.getTemplate(function(template){
var html = that.renderTemplate(template, data);
that.$el.html(html);
if (that.onRender){
that.onRender();
}
});
return this;
},
// Default implementation uses underscore.js templates. Override
// this method to use your own templating engine.
renderTemplate: function(template, data){
if (!template || template.length === 0){
var err = new Error("A template must be specified");
err.name = "NoTemplateError";
throw err;
}
return _.template(template.html(), data);
},
// Retrieve the template from the call's context. The
// `template` attribute can either be a function that
// returns a jQuery object, or a jQuery selector string
// directly. The string value must be a valid jQuery
// selector.
getTemplate: function(callback){
var template = this.template;
if (_.isFunction(template)){
var templateData = template.call(this);
callback.call(this, templateData);
} else {
Marionette.TemplateManager.get(template, callback);
}
},
// Default `close` implementation, for removing a view from the
// DOM and unbinding it. Region managers will call this method
// for you. You can specify an `onClose` method in your view to
// add custom code that is called after the view is closed.
close: function(){
this.unbindAll();
this.unbind();
this.remove();
if (this.onClose){
this.onClose();
}
}
});
// Collection View
// ---------------
// A view that iterates over a Backbone.Collection
// and renders an individual ItemView for each model.
Marionette.CollectionView = Backbone.View.extend({
modelView: Marionette.ItemView,
constructor: function(){
Backbone.View.prototype.constructor.apply(this, arguments);
_.bindAll(this, "addChildView", "render");
this.bindTo(this.collection, "add", this.addChildView, this);
this.bindTo(this.collection, "remove", this.removeChildView, this);
},
// Loop through all of the items and render
// each of them with the specified `itemView`.
render: function(){
this.renderModel();
this.collection.each(this.addChildView);
if (this.onRender){
this.onRender();
}
return this;
},
// Render an individual model, if we have one, as
// part of a composite view (branch / leaf). For example:
// a treeview.
renderModel: function(){
if (this.model){
var modelView = new this.modelView({
model: this.model,
template: this.template
});
modelView.render();
this.$el.append(modelView.el);
}
},
// Render the child item's view and add it to the
// HTML for the collection view.
addChildView: function(item){
var html = this.renderItem(item);
this.appendHtml(this.$el, html);
},
// Remove the child view and close it
removeChildView: function(item){
var view = this.children[item.cid];
if (view){
view.close();
delete this.children[item.cid];
}
},
// Append the HTML to the collection's `el`.
// Override this method to do something other
// then `.append`.
appendHtml: function(el, html){
el.append(html);
},
// Render the individual item by instantiating
// a specifid `itemView`. Override this method
// to provide custom item rendering for each
// item in the collection.
renderItem: function(item){
if (!this.itemView){
var err = new Error("An `itemView` must be specified");
err.name = "NoItemViewError";
throw err;
}
var view = new this.itemView({
model: item
});
view.render();
this.storeChild(view);
return view.el;
},
// Store references to all of the child `itemView`
// instances so they can be managed and cleaned up, later.
storeChild: function(view){
if (!this.children){
this.children = {};
}
this.children[view.model.cid] = view;
},
// Handle cleanup and other closing needs for
// the collection of views.
close: function(){
this.unbind();
this.unbindAll();
this.remove();
if (this.children){
_.each(this.children, function(childView){
childView.close();
});
}
if (this.onClose){
this.onClose();
}
}
});
// BindTo: Event Binding
// ---------------------
// BindTo facilitates the binding and unbinding of events
// from objects that extend `Backbone.Events`. It makes
// unbinding events, even with anonymous callback functions,
// easy.
//
// Thanks to Johnny Oshika for this code.
// http://stackoverflow.com/questions/7567404/backbone-js-repopulate-or-recreate-the-view/7607853#7607853
Marionette.BindTo = {
// Store the event binding in array so it can be unbound
// easily, at a later point in time.
bindTo: function (obj, eventName, callback, context) {
context = context || this;
obj.on(eventName, callback, context);
if (!this.bindings) this.bindings = [];
this.bindings.push({
obj: obj,
eventName: eventName,
callback: callback,
context: context
});
},
// Unbind all of the events that we have stored.
unbindAll: function () {
_.each(this.bindings, function (binding) {
binding.obj.off(binding.eventName, binding.callback);
});
this.bindings = [];
}
};
// AppRouter
// ---------
// Reduce the boilerplate code of handling route events
// and then calling a single method on another object.
// Have your routers configured to call the method on
// your object, directly.
//
// Configure an AppRouter with `appRoutes`.
//
// App routers can only take one `controller` object.
// It is reocmmended that you divide your controller
// objects in to smaller peices of related functionality
// and have multiple routers / controllers, instead of
// just one giant router and controller.
//
// You can also add standard routes to an AppRouter.
Marionette.AppRouter = Backbone.Router.extend({
constructor: function(options){
Backbone.Router.prototype.constructor.call(this, options);
if (this.appRoutes){
this.processAppRoutes(options.controller, this.appRoutes);
}
},
processAppRoutes: function(app, appRoutes){
var method, methodName;
var route, routesLength;
var routes = [];
var router = this;
for(route in appRoutes){
routes.unshift([route, appRoutes[route]]);
}
routesLength = routes.length;
for (var i = 0; i < routesLength; i++){
route = routes[i][0];
methodName = routes[i][1];
method = app[methodName];
router.route(route, methodName, method);
}
}
});
// Callbacks
// ---------
// A simple way of managing a collection of callbacks
// and executing them at a later point in time.
Marionette.Callbacks = function(){
this.callbacks = [];
this.callbackOptions = {};
};
_.extend(Marionette.Callbacks.prototype, {
// Add a callback
add: function(callback){
this.callbacks.push(callback);
},
// Run all registered callbacks in an async-friendly
// manner. Additional callbacks can be added while this
// is running and they will be picked up and executed after
// the current ones.
run: function(context){
var callback = this.callbacks.pop();
while (callback || this.callbacks.length > 0){
callback && callback.call(context, this.callbackOptions);
callback = this.callbacks.pop();
}
},
// Set an options object that is passed to all of the
// callback methods.
setOptions: function(options){
this.callbackOptions = options;
}
});
// Composite Application
// ---------------------
// Contain and manage the composite application as a whole.
// Stores and starts up `RegionManager` objects, includes an
// event aggregator as `app.vent`
Marionette.Application = function(options){
this.initCallbacks = new Marionette.Callbacks();
this.vent = _.extend({}, Backbone.Events, Marionette.BindTo);
_.extend(this, options);
};
_.extend(Marionette.Application.prototype, Backbone.Events, {
// Add an initializer that is either run at when the `start`
// method is called, or run immediately if added after `start`
// has already been called.
addInitializer: function(initializer){
this.initCallbacks.add(initializer);
this.isStarted && this.initCallbacks.run(this);
},
// kick off all of the application's processes.
// initializes all of the regions that have been added
// to the app, and runs all of the initializer functions
start: function(options){
this.isStarted = true;
this.initCallbacks.setOptions(options);
this.trigger("initialize:before", options);
this.initCallbacks.run(this);
this.trigger("initialize:after", options);
this.trigger("start", options);
},
// Add region managers to your app.
// Accepts a hash of named strings or RegionManager objects
// addRegions({something: "#someRegion"})
// addRegions{{something: RegionManager.extend({el: "#someRegion"}) });
addRegions: function(regions){
var regionValue, regionObj;
for(var region in regions){
if (regions.hasOwnProperty(region)){
regionValue = regions[region];
if (typeof regionValue === "string"){
regionObj = Marionette.RegionManager.extend({
el: regionValue
});
} else {
regionObj = regionValue;
}
this[region] = new regionObj();
}
}
}
});
// Template Manager
// ----------------
// Manage templates stored in `<script>` blocks,
// caching them for faster access.
Marionette.TemplateManager = {
templates: {},
// Get the specified template by id. Either
// retrieves the cached version, or loads it
// from the DOM.
get: function(templateId, callback){
var template = this.templates[templateId];
if (template){
callback && callback.call(this, template);
} else {
var that = this;
this.loadTemplate(templateId, function(template){
that.templates[templateId] = template;
callback && callback.call(that, template);
});
}
},
// Load a template from the DOM.
loadTemplate: function(templateId, callback){
callback.call(this, $(templateId));
},
// Clear templates from the cache. If no arguments
// are specified, clears all templates:
// `clear()`
//
// If arguments are specified, clears each of the
// specified templates from the cache:
// `clear("#t1", "#t2", "...")`
clear: function(){
var length = arguments.length;
if (length > 1){
for(var i=0; i<length; i++){
delete this.templates[arguments[i]];
}
} else {
this.templates = {};
}
}
};
// Helpers
// -------
// For slicing `arguments` in functions
var slice = Array.prototype.slice;
// Copy the `extend` function used by Backbone's classes
var extend = Backbone.View.extend;
Marionette.RegionManager.extend = extend;
Marionette.Application.extend = extend;
// Copy the features of `BindTo` on to these objects
_.extend(Marionette.ItemView.prototype, Marionette.BindTo);
_.extend(Marionette.CollectionView.prototype, Marionette.BindTo);
_.extend(Marionette.Application.prototype, Marionette.BindTo);
return Marionette;
})(Backbone, _, window.jQuery || window.Zepto || window.ender);