-
Notifications
You must be signed in to change notification settings - Fork 0
/
Abstract.js
353 lines (303 loc) · 8.89 KB
/
Abstract.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
var Class = require( 'class' ),
Abstract;
/**
* The base component class all other UI components inherit from.
* @class Abstract
* @constructor
* @requires ptclass
* @version 0.1
*/
Abstract = Class.create( ( function() {
// GLOBAL STATICS
// RETURN METHODS OBJECT
return {
/**
* Class constructor
* @method initialize
* @public
* @param {Object} $element JQuery object for DOM node wrapped by this component
* @param {Object} settings Custom settings for this component
*/
initialize: function( $element, settings ) {
// PRIVATE INSTANCE PROPERTIES
/**
* Instance of Abstract
* @property Abstract
* @type Object
* @private
*/
var Abstract = this,
/**
* Default configuration values
* @property defaults
* @private
* @type {Object}
*/
defaults = {
/**
* A selector that matches nodes to observe
* @property observe
* @type {String}
*/
observe: '',
/**
* A selector that matches nodes to notify of events
* @property notify
* @type {String}
*/
notify: ''
},
/**
* A jQuery collection that is observed for events
* @property $observe
* @private
* @type {Array}
*/
$observe,
/**
* A jQuery collection that is notified of events
* @property subscribe
* @private
* @type {Array}
*/
$notify,
/**
* The namespace used in all event bindings
* See <a href="http://docs.jquery.com/Namespaced_Events">JQuery Namespaced Events</a>.
* @property namespace
* @private
* @type {Object}
*/
namespace,
/**
* Used store events that the Lu control is listening to
* @property eventStore
* @private
* @type {Object}
*/
eventStore = {};
// MIX THE DEFAULTS INTO THE SETTINGS VALUES
_.defaults( settings, defaults );
// PRIVATE METHODS
/**
* Augments arguments
* @method params
* @private
*/
function params() {
var parameters = Array.prototype.slice.call( arguments );
if( namespace ) {
parameters[0] = parameters[0].split( ' ' );
_.each( parameters[0], function( item, index ) {
parameters[0][index] = item + '.' + namespace;
} );
parameters[0] = parameters[0].join( ' ' );
}
_.each( parameters, function( item, index ) {
if( typeof item === 'function' ) {
parameters[index] = function() {
item.apply( $element, arguments );
};
}
} );
return parameters;
}
/**
* Adds an event, or a string of joined events to the eventStore
* @method addEventToStorage
* @private
* @param {String} event The event(s) to add
* @param {String} method The method (ex: 'on', 'one')
*/
function addEventToStorage( event, method ) {
_.each( event.trim().split( /\s+/g ), function( item ) {
eventStore[item] = { method: method };
} );
}
/**
* Removes an event, or a string of joined events from the eventStore
* @method removeEventFromStorage
* @private
* @param {String} event The event(s) to remove
*/
function removeEventFromStorage( event ) {
_.each( event.trim().split( /\s+/g ), function( item ) {
if ( eventStore[event] ) {
delete eventStore[event];
}
} );
}
/**
* Creates an event listener for a type
* @method on
* @private
*/
function on() {
addEventToStorage( arguments[0], 'on' );
return $element.on.apply( $element, params.apply( this, arguments ) );
}
/**
* Creates an event listener for a type, fires exactly once.
* @method one
* @private
*/
function one() {
addEventToStorage( arguments[0], 'one' );
return $element.one.apply( $element, params.apply( this, arguments ) );
}
/**
* Unbinds event listeners of a type
* @method off
* @private
*/
function off() {
var event = arguments[0];
removeEventFromStorage( event );
return $element.off.apply( $element, params.apply( this, arguments ) );
}
/**
* Fires a custom event
* @method trigger
* @private
*/
function trigger( event, parameters ) {
var store = eventStore[ event ];
$element.lu( 'notify', event, parameters );
if( store && store.method === 'one' ) {
removeEventFromStorage( event );
}
return $element.trigger.call( $element, event, parameters );
}
/**
* Observe events from $observer
* @method observe
* @private
* @param {Array} $observer A jQuery collection to be observed
*/
function observe( $observer ) {
$observer.lu( 'observe', $element );
}
// Set up observers and notifiers
$observe = $( settings.observe );
$notify = $( settings.notify );
//Reverse Notification
$notify = $( settings.notify ).add( $element.lu( 'getDescendants' ) );
namespace = settings.namespace;
if( $observe.length ) {
observe( $observe );
}
if( $notify.length ) {
$element.lu( 'observe', $notify );
}
if( !namespace ) {
namespace = $element.lu( 'getParent', function( index, item ) {
var control = $( item ).lu( 'getControl' ),
namespace;
if( !control ) {
return false;
}
namespace = control.getNamespace();
if( namespace ) {
return true;
}
return false;
} );
if( namespace.length > 0 ) {
namespace = namespace.lu( 'getControl' ).getNamespace();
}
}
// PRIVILEGED METHODS
/**
* Privileged accessor to on with logging
* @method on
* @public
*/
Abstract.on = function() {
$element.lu( 'console' ).log( 'on called with arguments :: ', arguments );
return on.apply( $element, arguments );
};
/**
* Privileged accessor to one with logging
* @method on
* @public
*/
Abstract.one = function() {
$element.lu( 'console' ).log( 'one called with arguments :: ', arguments );
return one.apply( $element, arguments );
};
/**
* Privileged accessor to off with logging
* @method on
* @public
*/
Abstract.off = function() {
$element.lu( 'console' ).log( 'off called with arguments :: ', arguments );
return off.apply( $element, arguments );
};
/**
* Privileged accessor to trigger with logging
* @method on
* @public
*/
Abstract.trigger = function() {
$element.lu( 'console' ).log( 'trigger called with arguments :: ', arguments );
return trigger.apply( $element, arguments );
};
/**
* Privileged accessor to observe with logging
* @method on
* @public
*/
Abstract.observe = function( $observer ) {
$element.lu( 'console' ).log( 'observe called with arguments :: ', arguments );
return observe( $observer );
};
/**
* Cease observation of events
* @method unobserve
* @public
* @param {Array} $subscriber A jQuery collection to unsubscribe
*/
Abstract.unobserve = function( $observer ) {
$element.lu( 'console' ).log( 'unobserve called with arguments :: ', arguments );
return $element.lu( 'unobserve', $observer );
};
/**
* Gets the current namspace
* @method getNamespace
* @public
* @return namespace
*/
Abstract.getNamespace = function() {
return namespace;
};
/**
* Sets the namespace
* @method setNamespace
* @public
* @param {String} value the new namespace
* @return namespace
*/
Abstract.setNamespace = function( value ) {
namespace = value;
return namespace;
};
/**
* Returns and array of events the control is listening too
* @public
* @return events list
*/
Abstract.events = function() {
return _.keys( eventStore );
};
}
};
}() ) );
//Export to Common JS Loader
if( typeof module !== 'undefined' ) {
if( typeof module.setExports === 'function' ){
module.setExports( Abstract );
} else if( module.exports ) {
module.exports = Abstract;
}
}