-
Notifications
You must be signed in to change notification settings - Fork 4
/
backbone-elements.js
225 lines (193 loc) · 6.1 KB
/
backbone-elements.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
/**
* |-------------------|
* | Backbone-Elements |
* |-------------------|
* Backbone-Elements is freely distributable under the MIT license.
*
* <a href="https://github.com/chalbert/Backbone-Elements">More details & documentation</a>
*
* @author Nicolas Gilbert
* @version 1.0
*
* @requires _
* @requires Backbone
*/
(function(factory){
'use strict';
if (typeof define === 'function' && define.amd) {
define(['underscore', 'backbone'], factory);
} else {
factory(_, Backbone);
}
})(function (_, Backbone){
'use strict';
/**
* @borrows Backbone.View#initialize
*/
var initialize = Backbone.View.prototype.initialize,
/**
* @lends BackboneElements
*/
BackboneElements = {
/** @constructs*/
initialize: function(){
this.eventMap = this.events;
/**
* @property {Object} Hash of elements & selectors. Create a new object to preserve prototype.
* @example
* elements: {
* content: '#content',
* link: 'a',
* button: '.btn'
* }
*/
this.elements = _.extend({}, this.elements || {});
this.events = this.mapEvents(this.events);
this.refreshElements();
initialize.apply(this, arguments);
},
/**
* Generates a standard Backbone.View events hash
*
* @param {Object} [eventHash] The hash of elements name & events
*/
mapEvents: function(eventHash){
if (!eventHash) return;
var eventStack = {};
_.each(eventHash, function(events, element){
_.extend(eventStack, this.formatElementEvents(element, events));
}, this);
return eventStack;
},
/**
* Returns the jQuery object for an element
*
* @param element
* @return {jQuery Object}
*/
$get: function (element) {
if (!element) return $(this.el);
this.ensureElementExist(element);
this.refreshElement(element);
return this['$' + element];
},
/**
* Sets a cached jQuery objects for each element
*
* @param {Object} [elements] New objects to add
* @example
* view.refreshElements({content: '#content'})
* assert(view.$content === view.$el.find('#content');
*/
refreshElements: function(elements){
// Add new elements to existing ones
elements = _.extend(this.elements || {}, elements);
_.each(elements, function(selector, element) {
this['$' + element] = $(this.el).find(selector);
}, this);
},
/**
* Refresh a single element
* @param {Object} [element] The element to refesh
*/
refreshElement: function(element){
this.ensureElementExist(element);
this['$' + element] = $(this.el).find(this.elements[element]);
},
/**
* Return 'true' if 'element' is an element
*
* @param {String} element Element name
* @returns True if an element of this name exists
*/
isElement: function(element){
if (element === '') return true;
return (this.elements) && (this.elements[element]);
},
/**
* Format an element-based event into a standard Backbone.View event
*
* @param {String} element Element name
* @param {String} eventString Space-separated list of events
* @returns {Object} Hash of events
*
* @example
* events: {
* element: 'click focus'
* }
*
* will be converted to:
*
* events: {
* 'click .my-selector': 'element_click',
* 'focus .my-selector': 'element_focus'
* }
*/
formatElementEvents: function(element, eventString){
this.ensureElementExist(element);
var events = eventString.split(' '),
eventStack = {};
_.each(events, function(event){
var key = this.getEventKey(element, event),
method = this.getEventMethod(element, event);
eventStack[key] = method;
}, this);
return eventStack;
},
/**
*
* @returns {String} Either empty for root element, or selector
* @param {String} element The element name
*/
getElementSelector: function(element){
return (element === '')
? ''
: this.elements[element];
},
/**
* Ensure the requested element exist
*
* @throws {Error} If the element doesn't exist
* @param {String} element The element name
*/
ensureElementExist: function(element){
if (!this.isElement(element)) {
throw "Element '" + element + "' does not exist.";
}
},
/**
* Generates the key for the event hash
*
* @param {String} element Element's name
* @param {String} event Event name
*/
getEventKey: function(element, event){
var selector = this.getElementSelector(element),
key = event + ((selector === '') ? '' : (' ' + selector));
return key;
},
/**
* Generates the name of the method
*
* @param {String} element Element's name
* @param {String} event Event name
*
* @returns {String} The name of the callback method
*/
getEventMethod: function(element, event){
// Replace event attributes
event = event.replace(':', '_');
// If element is not empty, join to the event's name with underscore
return (element ? element + '_' : '') + event;
}
};
/**
* Add BackboneElements to Backbone.View
*
* @name Backbone.View
* @borrows BackboneElements
* @lends Backbone.View.prototype
*/
_.extend(Backbone.View.prototype, BackboneElements);
return Backbone;
});