| 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
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208 |
2
2
1
1
1
1
2
2
2
2
2
2
2
957
957
957
957
957
186
957
949
949
949
949
949
957
166
166
8
8
4
4
166
4
953
945
953
953
714
77
77
77
77
637
953
949
949
1
949
949
8
8
8
949
949
716
949
945
949
949
949
949
949
278
949
21
21
21
949
561
949
520
520
429
41
388
164
224
4
429
408
429
935
935
935
29
29
29
419
12
12
12
12
4
8
12
12
12
12
12
12
317
242
75
9
4
5
5
5
418
8
418
1163
1163
736
736
736
427
214
427
20
407
322
322
32
322
322
627
627
627
103
103
103
103
627
627
1
626
626
626
626
310
306
310
316
316
316
316
316
178
194
45
89
149
178
985
985
985
985
985
1
957
359
156
957
290
251
957
957
957
957
957
2
955
1
957
957
957
111
957
957
16
2
2
1
957
472
485
957
1
957
957
634
323
359
359
148
265
265
211
323
985
985
985
985
76
76
985
985
985
985
520
2
518
518
520
465
465
465
465
465
202
263
1
437
437
437
1
463
502
463
630
630
630
28
359
173
173
359
359
119
115
191
191
191
191
191
165
165
165
165
165
149
149
89
150
93
89
48
89
60
60
1898
520
1378
552
169
169
169
169
4
169
4
169
169
24
772
772
1
772
1
772
381
772
190
772
380
1029
1029
1029
1
1028
1028
1028
1028
1028
1028
1028
1028
93
93
1028
1028
139
139
139
155
4
139
2
2
2
1033
1033
1033
60
1033
1021
1033
1021
1021
1033
2
2
2
2
2903
2
690
7
407
407
322
12
12
310
407
190
217
838
156
156
156
265
265
265
261
265
156
186
186
500
299
2
2
2
2
8
2
2
263
263
263
235
263
263
2
2
2
2
8
2
2
28
2
2
2
| /*!
* backbone.layoutmanager.js v0.10.0
* Copyright 2015, Tim Branyen (@tbranyen)
* backbone.layoutmanager.js may be freely distributed under the MIT license.
*/
(function(window, factory) {
"use strict";
// AMD. Register as an anonymous module. Wrap in function so we have access
// to root via `this`.
if (typeof define === "function" && define.amd) {
define(["backbone", "underscore", "jquery"], function() {
return factory.apply(window, arguments);
});
}
// Node. Does not work with strict CommonJS, but only CommonJS-like
// environments that support module.exports, like Node.
else Iif (typeof exports === "object") {
var Backbone = require("backbone");
var _ = require("underscore");
// In a browserify build, since this is the entry point, Backbone.$
// is not bound. Ensure that it is.
Backbone.$ = Backbone.$ || require("jquery");
module.exports = factory.call(window, Backbone, _, Backbone.$);
}
// Browser globals.
else {
factory.call(window, window.Backbone, window._, window.Backbone.$);
}
}(typeof global === "object" ? global : this, function(Backbone, _, $) {
"use strict";
// Create a reference to the global object. In browsers, it will map to the
// `window` object; in Node, it will be `global`.
var window = this;
// Maintain reference to the original constructor.
var ViewConstructor = Backbone.View;
// Cache these methods for performance.
var aPush = Array.prototype.push;
var aConcat = Array.prototype.concat;
var aSplice = Array.prototype.splice;
var trim = String.prototype.trim ?
_.bind(String.prototype.trim.call, String.prototype.trim) :
$.trim;
// LayoutManager is a wrapper around a `Backbone.View`.
// Backbone.View.extend takes options (protoProps, staticProps)
var LayoutManager = Backbone.View.extend({
_render: function() {
// Keep the view consistent between callbacks and deferreds.
var view = this;
// Shorthand the manager.
var manager = view.__manager__;
// Cache these properties.
var beforeRender = view.beforeRender;
// Create a deferred instead of going off
var def = view.deferred();
// Ensure all nested Views are properly scrubbed if re-rendering.
if (view.hasRendered) {
view._removeViews();
}
// This continues the render flow after `beforeRender` has completed.
manager.callback = function() {
// Clean up asynchronous manager properties.
delete manager.isAsync;
delete manager.callback;
// Always emit a beforeRender event.
view.trigger("beforeRender", view);
// Render!
view._viewRender(manager).render().promise().then(function() {
// Complete this deferred once resolved.
def.resolve();
});
};
// If a beforeRender function is defined, call it.
if (beforeRender) {
var ret = beforeRender.call(view, view);
if (ret && ret.then) {
manager.isAsync = true;
ret.then(function() {
manager.callback();
def.resolve();
}, def.resolve);
}
if (ret === false) {
return def.resolve();
}
}
if (!manager.isAsync) {
manager.callback();
}
// Return this intermediary promise.
return def.promise();
},
// This function is responsible for pairing the rendered template into the
// DOM element.
_applyTemplate: function(rendered, manager, def) {
// Actually put the rendered contents into the element.
if (_.isString(rendered)) {
// If no container is specified, we must replace the content.
if (manager.noel) {
rendered = $.parseHTML(rendered, true);
// Remove extra root elements.
this.$el.slice(1).remove();
// Swap out the View on the first top level element to avoid
// duplication.
this.$el.replaceWith(rendered);
// Don't delegate events here - we'll do that in resolve()
this.setElement(rendered, false);
} else {
this.html(this.$el, rendered);
}
}
// Resolve only after fetch and render have succeeded.
def.resolveWith(this, [this]);
},
// Creates a deferred and returns a function to call when finished.
// This gets passed to all _render methods. The `root` value here is passed
// from the `manage(this).render()` line in the `_render` function
_viewRender: function(manager) {
var url, contents, def;
var root = this;
// Once the template is successfully fetched, use its contents to proceed.
// Context argument is first, since it is bound for partial application
// reasons.
function done(context, template) {
// Store the rendered template someplace so it can be re-assignable.
var rendered;
// Trigger this once the render method has completed.
manager.callback = function(rendered) {
// Clean up asynchronous manager properties.
delete manager.isAsync;
delete manager.callback;
root._applyTemplate(rendered, manager, def);
};
// Ensure the cache is up-to-date.
LayoutManager.cache(url, template);
// Render the View into the el property.
if (template) {
rendered = root.renderTemplate.call(root, template, context);
}
// If the function was synchronous, continue execution.
if (!manager.isAsync) {
root._applyTemplate(rendered, manager, def);
}
}
return {
// This `render` function is what gets called inside of the View render,
// when `manage(this).render` is called. Returns a promise that can be
// used to know when the element has been rendered into its parent.
render: function() {
var context = root.serialize;
var template = root.template;
// Create a deferred specifically for fetching.
def = root.deferred();
// If data is a function, immediately call it.
if (_.isFunction(context)) {
context = context.call(root);
}
// Set the internal callback to trigger once the asynchronous or
// synchronous behavior has completed.
manager.callback = function(contents) {
// Clean up asynchronous manager properties.
delete manager.isAsync;
delete manager.callback;
done(context, contents);
};
// Set the url to the prefix + the view's template property.
if (typeof template === "string") {
url = root.prefix + template;
}
// Check if contents are already cached and if they are, simply process
// the template with the correct data.
if (contents = LayoutManager.cache(url)) {
done(context, contents, url);
return def;
}
// Fetch layout and template contents.
if (typeof template === "string") {
contents = root.fetchTemplate.call(root, root.prefix +
template);
// If the template is already a function, simply call it.
} else if (typeof template === "function") {
contents = template;
// If its not a string and not undefined, pass the value to `fetch`.
} else if (template != null) {
contents = root.fetchTemplate.call(root, template);
}
// If the function was synchronous, continue execution.
if (!manager.isAsync) {
done(context, contents);
}
return def;
}
};
},
// This named function allows for significantly easier debugging.
constructor: function Layout(options) {
// Grant this View superpowers.
this.manage = true;
// Give this View access to all passed options as instance properties.
_.extend(this, options);
// Have Backbone set up the rest of this View.
Backbone.View.apply(this, arguments);
},
// This method is used within specific methods to indicate that they should
// be treated as asynchronous. This method should only be used within the
// render chain, otherwise unexpected behavior may occur.
async: function() {
var manager = this.__manager__;
// Set this View's action to be asynchronous.
manager.isAsync = true;
// Return the callback.
return manager.callback;
},
promise: function() {
return this.__manager__.renderDeferred.promise();
},
// Sometimes it's desirable to only render the child views under the parent.
// This is typical for a layout that does not change. This method will
// iterate over the provided views or delegate to `getViews` to fetch child
// Views and aggregate all render promises and return the parent View.
// The internal `promise()` method will return the aggregate promise that
// resolves once all children have completed their render.
renderViews: function(views) {
var root = this;
var manager = root.__manager__;
var newDeferred = root.deferred();
// If the caller provided an array of views then render those, otherwise
// delegate to getViews.
if (views && _.isArray(views)) {
views = _.chain(views);
} else {
views = root.getViews(views);
}
// Collect all promises from rendering the child views and wait till they
// all complete.
var promises = views.map(function(view) {
return view.render().__manager__.renderDeferred;
}).value();
// Simulate a parent render to remain consistent.
manager.renderDeferred = newDeferred.promise();
// Once all child views have completed rendering, resolve parent deferred
// with the correct context.
root.when(promises).then(function() {
newDeferred.resolveWith(root, [root]);
});
// Allow this method to be chained.
return root;
},
// Shorthand to `setView` function with the `insert` flag set.
insertView: function(selector, view, options) {
// If the `view` argument exists, then a selector was passed in. This code
// path will forward the selector on to `setView`.
if (view instanceof Backbone.View) {
return this.setView(selector, view, true, options);
}
// If no `view` argument is defined, then assume the first argument is the
// View, somewhat now confusingly named `selector`.
return this.setView(selector, true, view);
},
// Iterate over an object and ensure every value is wrapped in an array to
// ensure they will be inserted, then pass that object to `setViews`.
insertViews: function(views) {
// If an array of views was passed it should be inserted into the
// root view. Much like calling insertView without a selector.
if (_.isArray(views)) {
return this.setViews({ "": views });
}
_.each(views, function(view, selector) {
views[selector] = _.isArray(view) ? view : [view];
});
return this.setViews(views);
},
// Returns the View that matches the `getViews` filter function.
getView: function(fn) {
// If `getView` is invoked with undefined as the first argument, then the
// second argument will be used instead. This is to allow
// `getViews(undefined, fn)` to work as `getViews(fn)`. Useful for when
// you are allowing an optional selector.
if (fn == null) {
fn = arguments[1];
}
return this.getViews(fn).first().value();
},
// Provide a filter function to get a flattened array of all the subviews.
// If the filter function is omitted it will return all subviews. If a
// String is passed instead, it will return the Views for that selector.
getViews: function(fn) {
var views;
// If the filter argument is a String, then return a chained Version of the
// elements. The value at the specified filter may be undefined, a single
// view, or an array of views; in all cases, chain on a flat array.
if (typeof fn === "string") {
fn = this.sections[fn] || fn;
views = this.views[fn] || [];
// If Views is undefined you are concatenating an `undefined` to an array
// resulting in a value being returned. Defaulting to an array prevents
// this.
//return _.chain([].concat(views || []));
return _.chain([].concat(views));
}
// Generate an array of all top level (no deeply nested) Views flattened.
views = _.chain(this.views).map(function(view) {
return _.isArray(view) ? view : [view];
}, this).flatten();
// If the argument passed is an Object, then pass it to `_.where`.
if (typeof fn === "object") {
return views.where(fn);
}
// If a filter function is provided, run it on all Views and return a
// wrapped chain. Otherwise, simply return a wrapped chain of all Views.
return typeof fn === "function" ? views.filter(fn) : views;
},
// Use this to remove Views, internally uses `getViews` so you can pass the
// same argument here as you would to that method.
removeView: function(fn) {
var views;
// Allow an optional selector or function to find the right model and
// remove nested Views based off the results of the selector or filter.
views = this.getViews(fn).each(function(nestedView) {
nestedView.remove();
});
// call value incase the chain is evaluated lazily to ensure the views get
// removed
views.value();
return views;
},
// This takes in a partial name and view instance and assigns them to
// the internal collection of views. If a view is not a LayoutManager
// instance, then mix in the LayoutManager prototype. This ensures
// all Views can be used successfully.
//
// Must definitely wrap any render method passed in or defaults to a
// typical render function `return layout(this).render()`.
setView: function(name, view, insert, insertOptions) {
var manager, selector, existing;
// Parent view, the one you are setting a View on.
var root = this;
// If no name was passed, use an empty string and shift all arguments.
if (typeof name !== "string") {
insertOptions = insert;
insert = view;
view = name;
name = "";
}
// Shorthand the `__manager__` property.
manager = view.__manager__;
// If the View has not been properly set up, throw an Error message
// indicating that the View needs `manage: true` set.
if (!manager) {
throw new Error("The argument associated with selector '" + name +
"' is defined and a View. Set `manage` property to true for " +
"Backbone.View instances.");
}
// Add reference to the parentView.
manager.parent = root;
// Add reference to the placement selector used.
selector = manager.selector = root.sections[name] || name;
// Reference existing views at this selector.
existing = root.views[selector];
// Code path is less complex for Views that are not being inserted. Simply
// remove existing Views and bail out with the assignment.
if (!insert) {
// Ensure remove is called only when swapping in a new view (when the
// view is the same, it does not need to be removed or cleaned up).
if (root.getView(name) !== view) {
root.removeView(name);
}
// Assign to main views object and return for chainability.
return root.views[selector] = view;
}
// Ensure this.views[selector] is an array and push this View to
// the end.
root.views[selector] = aConcat.call([], root.views[name] || [], view);
// If we're inserting, we need to insert into the views array. If one
// already exists, we may want to insert at a particular index.
Iif (insertOptions && _.isNumber(insertOptions.insertAt) && existing) {
// If an index is specified & existing views are presesnt,
// splice there.
existing.splice(insertOptions.insertAt, 0, view);
root.views[selector] = existing;
// Mark where we inserted for later reference when inserting
// into the DOM.
root.__manager__.insertAt = insertOptions.insertAt;
} else {
// If no index is supplied, ensure this.views[selector] is an array
// and push this View to the end.
root.views[selector] = aConcat.call([], existing || [], view);
}
// Put the parent view into `insert` mode.
root.__manager__.insert = true;
return view;
},
// Allows the setting of multiple views instead of a single view.
setViews: function(views) {
// Iterate over all the views and use the View's view method to assign.
_.each(views, function(view, name) {
// If the view is an array put all views into insert mode.
if (_.isArray(view)) {
return _.each(view, function(view) {
this.insertView(name, view);
}, this);
}
// Assign each view using the view function.
this.setView(name, view);
}, this);
// Allow for chaining
return this;
},
// By default this should find all nested views and render them into
// the this.el and call done once all of them have successfully been
// resolved.
//
// This function returns a promise that can be chained to determine
// once all subviews and main view have been rendered into the view.el.
render: function() {
var root = this;
var manager = root.__manager__;
var parent = manager.parent;
var rentManager = parent && parent.__manager__;
var def = root.deferred();
// Triggered once the render has succeeded.
function resolve() {
// Insert all subViews into the parent at once.
_.each(root.views, function(views, selector) {
// Fragments aren't used on arrays of subviews.
if (_.isArray(views)) {
root.htmlBatch(root, views, selector);
}
});
// If there is a parent and we weren't attached to it via the previous
// method (single view), attach.
if (parent && !manager.insertedViaFragment) {
if (!root.contains(parent.el, root.el)) {
// Apply the partial using parent's html() method.
parent.partial(parent.$el, root.$el, rentManager, manager);
}
}
// Ensure events are always correctly bound after rendering.
root.delegateEvents();
// Set this View as successfully rendered.
root.hasRendered = true;
manager.renderInProgress = false;
// Clear triggeredByRAF flag.
delete manager.triggeredByRAF;
// Only process the queue if it exists.
if (manager.queue && manager.queue.length) {
// Ensure that the next render is only called after all other
// `done` handlers have completed. This will prevent `render`
// callbacks from firing out of order.
(manager.queue.shift())();
} else {
// Once the queue is depleted, remove it, the render process has
// completed.
delete manager.queue;
}
// Reusable function for triggering the afterRender callback and event.
function completeRender() {
var console = window.console;
var afterRender = root.afterRender;
if (afterRender) {
afterRender.call(root, root);
}
// Always emit an afterRender event.
root.trigger("afterRender", root);
// If there are multiple top level elements and `el: false` is used,
// display a warning message and a stack trace.
if (manager.noel && root.$el.length > 1) {
// Do not display a warning while testing or if warning suppression
// is enabled.
if (_.isFunction(console.warn) && !root.suppressWarnings) {
console.warn("`el: false` with multiple top level elements is " +
"not supported.");
// Provide a stack trace if available to aid with debugging.
if (_.isFunction(console.trace)) {
console.trace();
}
}
}
}
// If the parent is currently rendering, wait until it has completed
// until calling the nested View's `afterRender`.
if (rentManager && (rentManager.renderInProgress || rentManager.queue)) {
// Wait until the parent View has finished rendering, which could be
// asynchronous, and trigger afterRender on this View once it has
// completed.
parent.once("afterRender", completeRender);
} else {
// This View and its parent have both rendered.
completeRender();
}
return def.resolveWith(root, [root]);
}
// Actually facilitate a render.
function actuallyRender() {
// The `_viewRender` method is broken out to abstract away from having
// too much code in `actuallyRender`.
root._render().done(function() {
// If there are no children to worry about, complete the render
// instantly.
if (!_.keys(root.views).length) {
return resolve();
}
// Create a list of promises to wait on until rendering is done.
// Since this method will run on all children as well, its sufficient
// for a full hierarchical.
var promises = _.map(root.views, function(view) {
var insert = _.isArray(view);
// If items are being inserted, they will be in a non-zero length
// Array.
if (insert && view.length) {
// Mark each subview's manager so they don't attempt to attach by
// themselves. Return a single promise representing the entire
// render.
return root.when(_.map(view, function(subView) {
subView.__manager__.insertedViaFragment = true;
return subView.render().__manager__.renderDeferred;
}));
}
// Only return the fetch deferred, resolve the main deferred after
// the element has been attached to it's parent.
return !insert ? view.render().__manager__.renderDeferred : view;
});
// Once all nested Views have been rendered, resolve this View's
// deferred.
root.when(promises).done(resolve);
});
}
// Mark this render as in progress. This will prevent
// afterRender from being fired until the entire chain has rendered.
manager.renderInProgress = true;
// Start the render.
// Register this request & cancel any that conflict.
root._registerWithRAF(actuallyRender, def);
// Put the deferred inside of the `__manager__` object, since we don't want
// end users accessing this directly anymore in favor of the `afterRender`
// event. So instead of doing `render().promise().then(...` do
// `render().once("afterRender", ...`.
// FIXME: I think we need to move back to promises so that we don't
// miss events, regardless of sync/async (useRAF setting)
manager.renderDeferred = def;
// Return the actual View for chainability purposes.
return root;
},
// Ensure the cleanup function is called whenever remove is called.
remove: function() {
// Force remove itself from its parent.
LayoutManager._removeView(this, true);
// Call the original remove function.
return this._remove.apply(this, arguments);
},
// Register a view render with RAF.
_registerWithRAF: function(callback, deferred) {
var root = this;
var manager = root.__manager__;
var rentManager = manager.parent && manager.parent.__manager__;
// Allow RAF processing to be shut off using `useRAF`:false.
if (this.useRAF === false) {
if (manager.queue) {
aPush.call(manager.queue, callback);
} else {
manager.queue = [];
callback();
}
return;
}
// Keep track of all deferreds so we can resolve them.
manager.deferreds = manager.deferreds || [];
manager.deferreds.push(deferred);
// Schedule resolving all deferreds that are waiting.
deferred.done(resolveDeferreds);
// Cancel any other renders on this view that are queued to execute.
this._cancelQueuedRAFRender();
// Trigger immediately if the parent was triggered by RAF.
// The flag propagates downward so this view's children are also
// rendered immediately.
if (rentManager && rentManager.triggeredByRAF) {
return finish();
}
// Register this request with requestAnimationFrame.
manager.rafID = root.requestAnimationFrame(finish);
function finish() {
// Remove this ID as it is no longer valid.
manager.rafID = null;
// Set flag (will propagate to children) so they render
// without waiting for RAF.
manager.triggeredByRAF = true;
// Call original cb.
callback();
}
// Resolve all deferreds that were cancelled previously, if any.
// This allows the user to bind callbacks to any render callback,
// even if it was cancelled above.
function resolveDeferreds() {
for (var i = 0; i < manager.deferreds.length; i++){
manager.deferreds[i].resolveWith(root, [root]);
}
manager.deferreds = [];
}
},
// Cancel any queued render requests.
_cancelQueuedRAFRender: function() {
var root = this;
var manager = root.__manager__;
if (manager.rafID != null) {
root.cancelAnimationFrame(manager.rafID);
}
}
},
// Static Properties
{
// Clearable cache.
_cache: {},
// Remove all nested Views.
_removeViews: function(root, force) {
// Shift arguments around.
if (typeof root === "boolean") {
force = root;
root = this;
}
// Allow removeView to be called on instances.
root = root || this;
// Iterate over all of the nested View's and remove.
root.getViews().each(function(view) {
// Force doesn't care about if a View has rendered or not.
if (view.hasRendered || force) {
LayoutManager._removeView(view, force);
}
// call value() in case this chain is evaluated lazily
}).value();
},
// Remove a single nested View.
_removeView: function(view, force) {
var parentViews;
// Shorthand the managers for easier access.
var manager = view.__manager__;
var rentManager = manager.parent && manager.parent.__manager__;
// Test for keep.
var keep = typeof view.keep === "boolean" ? view.keep : view.options.keep;
// In insert mode, remove views that do not have `keep` attribute set,
// unless the force flag is set.
if ((!keep && rentManager && rentManager.insert === true) || force) {
// Clean out the events.
LayoutManager.cleanViews(view);
// Since we are removing this view, force subviews to remove
view._removeViews(true);
// Remove the View completely.
view.$el.remove();
// Cancel any pending renders, if present.
view._cancelQueuedRAFRender();
// Bail out early if no parent exists.
if (!manager.parent) { return; }
// Assign (if they exist) the sibling Views to a property.
parentViews = manager.parent.views[manager.selector];
// If this is an array of items remove items that are not marked to
// keep.
if (_.isArray(parentViews)) {
// Remove duplicate Views.
_.each(_.clone(parentViews), function(view, i) {
// If the managers match, splice off this View.
if (view && view.__manager__ === manager) {
aSplice.call(parentViews, i, 1);
}
});
if (_.isEmpty(parentViews)) {
manager.parent.trigger("empty", manager.selector);
}
return;
}
// Otherwise delete the parent selector.
delete manager.parent.views[manager.selector];
manager.parent.trigger("empty", manager.selector);
}
},
// Cache templates into LayoutManager._cache.
cache: function(path, contents) {
// If template path is found in the cache, return the contents.
if (path in this._cache && contents == null) {
return this._cache[path];
// Ensure path and contents aren't undefined.
} else if (path != null && contents != null) {
return this._cache[path] = contents;
}
// If the template is not in the cache, return undefined.
},
// Accept either a single view or an array of views to clean of all DOM
// events internal model and collection references and all Backbone.Events.
cleanViews: function(views) {
// Clear out all existing views.
_.each(aConcat.call([], views), function(view) {
// fire cleanup event to the attached handlers
view.trigger("cleanup", view);
// Remove all custom events attached to this View.
view.unbind();
// Automatically unbind `model`.
if (view.model instanceof Backbone.Model) {
view.model.off(null, null, view);
}
// Automatically unbind `collection`.
if (view.collection instanceof Backbone.Collection) {
view.collection.off(null, null, view);
}
// Automatically unbind events bound to this View.
view.stopListening();
// If a custom cleanup method was provided on the view, call it after
// the initial cleanup is done
if (_.isFunction(view.cleanup)) {
view.cleanup();
}
});
},
// This static method allows for global configuration of LayoutManager.
configure: function(options) {
_.extend(LayoutManager.prototype, options);
// Allow LayoutManager to manage Backbone.View.prototype.
if (options.manage) {
Backbone.View.prototype.manage = true;
}
// Disable the element globally.
if (options.el === false) {
Backbone.View.prototype.el = false;
}
// Allow global configuration of `suppressWarnings`.
if (options.suppressWarnings === true) {
Backbone.View.prototype.suppressWarnings = true;
}
// Allow global configuration of `useRAF`.
if (options.useRAF === false) {
Backbone.View.prototype.useRAF = false;
}
// Allow underscore to be swapped out
if (options._) {
_ = options._;
}
},
// Configure a View to work with the LayoutManager plugin.
setupView: function(views, options) {
// Ensure that options is always an object, and clone it so that
// changes to the original object don't screw up this view.
options = _.extend({}, options);
// Set up all Views passed.
_.each(aConcat.call([], views), function(view) {
// If the View has already been setup, no need to do it again.
if (view.__manager__) {
return;
}
var views, declaredViews;
var proto = LayoutManager.prototype;
// Ensure necessary properties are set.
_.defaults(view, {
// Ensure a view always has a views object.
views: {},
// Ensure a view always has a sections object.
sections: {},
// Internal state object used to store whether or not a View has been
// taken over by layout manager and if it has been rendered into the
// DOM.
__manager__: {},
// Add the ability to remove all Views.
_removeViews: LayoutManager._removeViews,
// Add the ability to remove itself.
_removeView: LayoutManager._removeView
// Mix in all LayoutManager prototype properties as well.
}, LayoutManager.prototype);
// Assign passed options.
view.options = options;
// Merge the View options into the View.
_.extend(view, options);
// By default the original Remove function is the Backbone.View one.
view._remove = Backbone.View.prototype.remove;
// Ensure the render is always set correctly.
view.render = LayoutManager.prototype.render;
// If the user provided their own remove override, use that instead of
// the default.
if (view.remove !== proto.remove) {
view._remove = view.remove;
view.remove = proto.remove;
}
// Normalize views to exist on either instance or options, default to
// options.
views = options.views || view.views;
// Set the internal views, only if selectors have been provided.
if (_.keys(views).length) {
// Keep original object declared containing Views.
declaredViews = views;
// Reset the property to avoid duplication or overwritting.
view.views = {};
// If any declared view is wrapped in a function, invoke it.
_.each(declaredViews, function(declaredView, key) {
if (typeof declaredView === "function") {
declaredViews[key] = declaredView.call(view, view);
}
});
// Set the declared Views.
view.setViews(declaredViews);
}
});
}
});
LayoutManager.VERSION = "0.10.0";
// Expose through Backbone object.
Backbone.Layout = LayoutManager;
// Override _configure to provide extra functionality that is necessary in
// order for the render function reference to be bound during initialize.
Backbone.View.prototype.constructor = function(options) {
var noel;
// Ensure options is always an object.
options = options || {};
// Remove the container element provided by Backbone.
if ("el" in options ? options.el === false : this.el === false) {
noel = true;
}
// If manage is set, do it!
if (options.manage || this.manage) {
// Set up this View.
LayoutManager.setupView(this, options);
}
// Assign the `noel` property once we're sure the View we're working with is
// managed by LayoutManager.
if (this.__manager__) {
this.__manager__.noel = noel;
this.__manager__.suppressWarnings = options.suppressWarnings;
}
// Act like nothing happened.
ViewConstructor.apply(this, arguments);
};
Backbone.View = Backbone.View.prototype.constructor;
// Copy over the extend method.
Backbone.View.extend = ViewConstructor.extend;
// Copy over the prototype as well.
Backbone.View.prototype = ViewConstructor.prototype;
// Default configuration options; designed to be overriden.
var defaultOptions = {
// Prefix template/layout paths.
prefix: "",
// Use requestAnimationFrame to queue up view rendering and cancel
// repeat requests. Leave on for better performance.
useRAF: true,
// Can be used to supply a different deferred implementation.
deferred: function() {
return $.Deferred();
},
// Fetch is passed a path and is expected to return template contents as a
// function or string.
fetchTemplate: function(path) {
return _.template($(path).html());
},
// By default, render using underscore's templating and trim output.
renderTemplate: function(template, context) {
return trim(template.call(this, context));
},
// By default, pass model attributes to the templates
serialize: function() {
return this.model ? _.clone(this.model.attributes) : {};
},
// This is the most common way you will want to partially apply a view into
// a layout.
partial: function($root, $el, rentManager, manager) {
var $filtered;
// If selector is specified, attempt to find it.
if (manager.selector) {
if (rentManager.noel) {
$filtered = $root.filter(manager.selector);
$root = $filtered.length ? $filtered : $root.find(manager.selector);
} else {
$root = $root.find(manager.selector);
}
}
// Use the insert method if the parent's `insert` argument is true.
if (rentManager.insert) {
this.insert($root, $el, rentManager.insertAt);
} else {
this.html($root, $el);
}
},
// Override this with a custom HTML method, passed a root element and content
// (a jQuery collection or a string) to replace the innerHTML with.
html: function($root, content) {
$root.empty().append(content);
},
// Used for inserting subViews in a single batch. This gives a small
// performance boost as we write to a disconnected fragment instead of to the
// DOM directly. Smarter browsers like Chrome will batch writes internally
// and layout as seldom as possible, but even in that case this provides a
// decent boost. jQuery will use a DocumentFragment for the batch update,
// but Cheerio in Node will not.
htmlBatch: function(rootView, subViews, selector) {
// Shorthand the parent manager object.
var rentManager = rootView.__manager__;
// Create a simplified manager object that tells partial() where
// place the elements.
var manager = { selector: selector };
// Get the elements to be inserted into the root view.
var els = _.reduce(subViews, function(memo, sub) {
// Check if keep is present - do boolean check in case the user
// has created a `keep` function.
var keep = typeof sub.keep === "boolean" ? sub.keep : sub.options.keep;
// If a subView is present, don't push it. This can only happen if
// `keep: true`. We do the keep check for speed as $.contains is not
// cheap.
var exists = keep && $.contains(rootView.el, sub.el);
// If there is an element and it doesn't already exist in our structure
// attach it.
if (sub.el && !exists) {
memo.push(sub.el);
}
return memo;
}, []);
// Use partial to apply the elements. Wrap els in jQ obj for cheerio.
return this.partial(rootView.$el, $(els), rentManager, manager);
},
// Very similar to HTML except this one will appendChild by default.
insert: function($root, $el, insertAt) {
Iif (_.isNumber(insertAt)) {
// If an index is supplied, use it.
this.insertAtIndex($root, $el, insertAt);
} else {
$root.append($el);
}
},
// Called by `insert` if an `insertAt` is provided. Inserts a view
// at a particular position.
insertAtIndex: function($root, $el, insertAt) {
var $baseEl;
// If insertAt is < 0, it behaves like the index in Array#splice.
if (insertAt < 0) {
$baseEl = $root.children()
.eq(Math.max(0, $root.children().length + insertAt));
} else {
$baseEl = $root.children().eq(insertAt);
}
if ($baseEl.length) {
// If a reference point is found for insertion, put this view behind it.
$baseEl.before($el);
} else {
// If no reference point is found (index is greater than the length of
// of the array of elements), append it.
this.insert($root, $el);
}
},
// Return a deferred for when all promises resolve/reject.
when: function(promises) {
return $.when.apply(null, promises);
},
// A method to determine if a View contains another.
contains: function(parent, child) {
return $.contains(parent, child);
},
// Based on:
// http://paulirish.com/2011/requestanimationframe-for-smart-animating/
// requestAnimationFrame polyfill by Erik Möller. fixes from Paul Irish and
// Tino Zijdel.
requestAnimationFrame: (function() {
var lastTime = 0;
var vendors = ["ms", "moz", "webkit", "o"];
var requestAnimationFrame = window.requestAnimationFrame;
for (var i = 0; i < vendors.length && !window.requestAnimationFrame; ++i) {
requestAnimationFrame = window[vendors[i] + "RequestAnimationFrame"];
}
Eif (!requestAnimationFrame){
requestAnimationFrame = function(callback) {
var currTime = new Date().getTime();
var timeToCall = Math.max(0, 16 - (currTime - lastTime));
var id = window.setTimeout(function() {
callback(currTime + timeToCall);
}, timeToCall);
lastTime = currTime + timeToCall;
return id;
};
}
return _.bind(requestAnimationFrame, window);
})(),
cancelAnimationFrame: (function() {
var vendors = ["ms", "moz", "webkit", "o"];
var cancelAnimationFrame = window.cancelAnimationFrame;
for (var i = 0; i < vendors.length && !window.cancelAnimationFrame; ++i) {
cancelAnimationFrame =
window[vendors[i] + "CancelAnimationFrame"] ||
window[vendors[i] + "CancelRequestAnimationFrame"];
}
Eif (!cancelAnimationFrame) {
cancelAnimationFrame = function(id) {
clearTimeout(id);
};
}
return _.bind(cancelAnimationFrame, window);
})()
};
// Extend LayoutManager with default options.
_.extend(LayoutManager.prototype, defaultOptions);
// Assign `LayoutManager` object for AMD loaders.
return LayoutManager;
}));
|