forked from davebalmer/jo
-
Notifications
You must be signed in to change notification settings - Fork 0
/
jo.js
4576 lines (3485 loc) · 91 KB
/
jo.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
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
/**
joLog
=====
Wrapper for `console.log()` (or whatever device-specific logging you have). Also could
be extended to send log information to a RESTful service as well, handy for devices
which don't have decent logging abilities.
Use
---
It's an all-in-one utility that's smart enough to ferret out whatever you throw at it
and display it in the console.
joLog("x=", x, "listdata=", listdata);
Basically, fill it up with strings, variables, objects, arrays and the function will
produce a string version of each argument (where appropriate; browser debuggers tend to
display objects nicely) in the same console line. Simple, effective, easy to use.
*/
joLog = function() {
// whoops, nothing to log; later we might downshift to something else
if (typeof console === "undefined" || typeof console.log === "undefined" || !console.log)
return;
var strings = [];
for (var i = 0; i < arguments.length; i++) {
// TODO: stringify for objects and arrays
strings.push(arguments[i]);
}
// spit out our line
console.log(strings.join(" "));
}
/**
- - -
jo
===
Singleton which the framework uses to store global infomation. It also is
responsible for initializing the rest of the framework, detecting your environment,
and notifying your application when jo is ready to use.
Methods
-------
- `load()`
This method should be called after your DOM is loaded and before your app uses
jo. Typically, you can call this function from your document's `onLoad` method,
but it is recommended you use more device-specific "ready" notification if
they are available.
- `getPlatform()`
Returns the platform you're running in as a string. Usually this is not needed,
but can be useful.
- `getVersion()`
Returns the version of jo you loaded in the form of a string (e.g. `0.1.1`).
- `matchPlatform(string)`
Feed in a string list of desired platforms (e.g. `"mozilla chrome ipad"`),
and returns true if the identified platform is in the test list.
Events
------
- `loadEvent`
- `unloadEvent`
These events are fired after jo loads or unloads, and can be used in your
application to perform initialization or cleanup tasks.
Function
========
jo extends the Function object to add a few goodies which augment JavaScript
in a farily non-intrusive way.
Methods
-------
- `extend(superclass, prototype)`
Gives you an easy way to extend a class using JavaScript's natural prototypal
inheritance. See Class Patterns for more information.
- `bind(context)`
Returns a private function wrapper which automagically resolves context
for `this` when your method is called.
HTMLElement
===========
This is a standard DOM element for JavaScript. Most of the jo views, continers
and controls deal with these so your application doesn't need to.
Methods
-------
Not a complete list by any means, but the useful ones for our
purposes are:
- `appendChild(node)`
- `insertChild(before, node)`
- `removeChild(node)`
Properties
----------
jo uses these properties quite a bit:
- `innerHTML`
- `className`
- `style`
*/
// syntactic sugar to make it easier to extend a class
Function.prototype.extend = function(superclass, proto) {
// create our new subclass
this.prototype = new superclass();
// optional subclass methods and properties
if (proto) {
for (var i in proto)
this.prototype[i] = proto[i];
}
};
// add bind() method if we don't have it already
if (typeof Function.prototype.bind === 'undefined') {
Function.prototype.bind = function(context) {
var self = this;
function callbind() {
return self.apply(context, arguments);
}
return callbind;
};
}
// just a place to hang our hat
jo = {
platform: "webkit",
version: "0.2.0",
useragent: [
'ipad',
'iphone',
'webos',
'android',
'opera',
'chrome',
'safari',
'mozilla',
'gecko',
'explorer'
],
debug: false,
setDebug: function(state) {
this.debug = state;
},
flag: {
stopback: false
},
load: function(call, context) {
joDOM.enable();
this.loadEvent = new joSubject(this);
this.unloadEvent = new joSubject(this);
// capture these events, prevent default for applications
document.body.onMouseDown = function(e) { e.preventDefault(); };
document.body.onDragStart = function(e) { e.preventDefault(); };
// quick test to see which environment we're in
if (typeof navigator == 'object' && navigator.userAgent) {
var agent = navigator.userAgent.toLowerCase();
for (var i = 0; i < this.useragent.length; i++) {
if (agent.indexOf(this.useragent[i]) >= 0) {
this.platform = this.useragent[i];
break;
}
}
}
if (joEvent) {
// detect if we're on a touch or mouse based browser
var o = document.createElement('div');
var test = ("ontouchstart" in o);
if (!test) {
o.setAttribute("ontouchstart", 'return;');
test = (typeof o.ontouchstart === 'function');
}
joEvent.touchy = test;
o = null;
}
if (joGesture)
joGesture.load();
joLog("Jo", this.version, "loaded for", this.platform, "environment.");
this.loadEvent.fire();
},
tagMap: {},
tagMapLoaded: false,
// make a map of node.tagName -> joView class constructor
initTagMap: function() {
// we only do this once per session
if (this.tagMapLoaded)
return;
var key = this.tagMap;
// defaults
key.JOVIEW = joView;
key.BODY = joScreen;
// run through all our children of joView
// and add to our joCollect.view object
for (var p in window) {
var o = window[p];
if (typeof o === 'function'
&& o.prototype
&& typeof o.prototype.tagName !== 'undefined'
&& o.prototype instanceof joView) {
var tag = o.prototype.tagName.toUpperCase();
if (o.prototype.type) {
// handle tags with multiple types
if (!key[tag])
key[tag] = {};
key[tag][o.prototype.type] = o;
}
else {
key[tag] = o;
}
}
}
},
getPlatform: function() {
return this.platform;
},
matchPlatform: function(test) {
return (test.indexOf(this.platform) >= 0);
},
getVersion: function() {
return this.version;
},
getLanguage: function() {
return this.language;
}
};
/**
joDOM
======
Singleton with utility methods for manipulating DOM elements.
Methods
-------
- `get(id)`
Returns an HTMLElement which has the given id or if the
id is not a string returns the value of id.
- `create(type, style)`
Type is a valid HTML tag type. Style is the same as `setStyle()`
method. Returns an HTMLElement.
// simple
var x = joDOM.create("div", "mycssclass");
// more interesting
var x = joDOM.create("div", {
id: "name",
className: "selected",
background: "#fff",
color: "#000"
});
- `setStyle(tag, style)`
Style can be an object literal with
style information (including "id" or "className") or a string. If
it's a string, it will simply use the style string as the className
for the new element.
Note that the preferred and most cross-platform method for working
with the DOM is to use `className` and possibly `id` and put your
actual style information in your CSS file. That said, sometimes it's
easier to just set the background color in the code. Up to you.
- `getParentWithin(node, ancestor)`
Returns an HTMLElement which is
the first child of the ancestor which is a parent of a given node.
- `addCSSClass(HTMLElement, classname)`
Adds a CSS class to an element unless it is already there.
- `removeCSSClass(HTMLElement, classname)`
Removes a CSS class from an element if it exists.
- `toggleCSSClass(HTMLElement, classname)`
Auto add or remove a class from an element.
*/
joDOM = {
enabled: false,
get: function(id) {
if (typeof id === "string") {
return document.getElementById(id);
}
else if (typeof id === 'object') {
if (id instanceof joView)
return id.container;
else
return id;
}
},
remove: function(node) {
if (node.parentNode) {
node.parentNode.removeChild(node);
}
},
enable: function() {
this.enabled = true;
},
getParentWithin: function(node, ancestor) {
while (node.parentNode !== window && node.parentNode !== ancestor) {
node = node.parentNode;
}
return node;
},
addCSSClass: function(node, classname) {
var node = joDOM.get(node);
if (typeof node.className !== "undefined") {
var n = node.className.split(/\s+/);
for (var i = 0, l = n.length; i < l; i++) {
if (n[i] == classname)
return;
}
n.push(classname);
node.className = n.join(" ");
}
else {
node.className = classname;
}
},
removeCSSClass: function(node, classname, toggle) {
var node = joDOM.get(node);
if (typeof node.className !== "undefined") {
var n = node.className.split(/\s+/);
for (var i = 0, l = n.length; i < l; i++) {
if (n[i] == classname) {
if (l == 1)
node.className = "";
else {
n.splice(i, i);
node.className = n.join(" ");
}
return;
}
}
if (toggle) {
n.push(classname);
node.className = n.join(" ");
}
}
else {
node.className = classname;
}
},
toggleCSSClass: function(node, classname) {
this.removeCSSClass(node, classname, true);
},
create: function(tag, style) {
if (!this.enabled)
return null;
if (typeof tag === "object" && typeof tag.tagName === "string") {
// being used to create a container for a joView
var o = document.createElement(tag.tagName);
if (tag.className)
this.setStyle(o, tag.className);
}
else {
var o = document.createElement(tag);
if (style)
this.setStyle(o, style);
}
return o;
},
setStyle: function(node, style) {
if (typeof style === "string") {
node.className = style;
}
else if (typeof style === "object") {
for (var i in style) {
switch (i) {
case "id":
case "className":
node[i] = style[i];
break;
default:
node.style[i] = style[i];
}
}
}
else if (typeof style !== "undefined") {
throw("joDOM.setStyle(): unrecognized type for style argument; must be object or string.");
}
},
applyCSS: function(style, oldnode) {
// TODO: should insert before and then remove the old node
if (oldnode)
document.body.removeChild(oldnode);
var css = joDOM.create('jostyle');
css.innerHTML = '<style>' + style + '</style>';
document.body.appendChild(css);
return css;
},
removeCSS: function(node) {
document.body.removeChild(node);
},
loadCSS: function(filename, oldnode) {
// you can just replace the source for a given
// link if one is passed in
if (oldnode)
var css = oldnode;
else
var css = joDOM.create('link');
css.rel = 'stylesheet';
css.type = 'text/css';
css.href = filename + (jo.debug ? ("?" + joTime.timestamp()) : "");
if (!oldnode)
document.body.appendChild(css);
return css;
}
};
joCSSRule = function(data) {
this.setData(data);
};
joCSSRule.prototype = {
container: null,
setData: function(data) {
this.data = data || "";
if (data)
this.enable();
},
clear: function() {
this.setData();
},
disable: function() {
joDOM.removeCSS(this.container);
},
enable: function() {
this.container = joDOM.applyCSS(this.data, this.container);
}
};
/**
joEvent
========
Singleton with DOM event model utility methods. Ideally, application-level
code shouldn't have to use this, but library code does.
Methods
-------
- `on(HTMLElement, event, Function, context, data)`
Set a DOM event listener for an HTMLElement which calls a given Function
with an optional context for `this` and optional static data.
- `stop(event)`
Prevent default and stop event propogation.
- `getTarget(event)`
Returns the HTMLElement which a DOM event relates to.
*/
joEvent = {
eventMap: {
"mousedown": "touchstart",
"mousemove": "touchmove",
"mouseup": "touchend",
"mouseout": "touchcancel"
},
touchy: false,
getTarget: function(e) {
if (!e)
var e = window.event;
return e.target ? e.target : e.srcElement;
},
capture: function(element, event, call, context, data) {
this.on(element, event, call, context, data, true);
},
on: function(element, event, call, context, data, capture) {
if (!call || !element)
return false;
if (this.touchy) {
if (this.eventMap[event])
event = this.eventMap[event];
}
var element = joDOM.get(element);
var call = call;
var data = data || "";
function wrappercall(e) {
// support touchy platforms,
// might reverse this to turn non-touch into touch
if (e.touches && e.touches.length == 1) {
var touches = e.touches[0];
e.pageX = touches.pageX;
e.pageY = touches.pageY;
e.screenX = touches.screenX;
e.screenY = touches.screenY;
}
if (context)
call.call(context, e, data);
else
call(e, data);
};
if (!window.addEventListener)
element.attachEvent("on" + event, wrappercall);
else
element.addEventListener(event, wrappercall, capture || false);
return wrappercall;
},
remove: function(element, event, wrappercall) {
element.removeEventListener(event, wrappercall);
},
stop: function(e) {
if (e.stopPropagation)
e.stopPropagation();
else
e.cancelBubble = true;
},
preventDefault: function(e) {
e.preventDefault();
},
block: function(e) {
if (window.event)
var e = window.event;
if (typeof e.target == 'undefined')
e.target = e.srcElement;
switch (e.target.nodeName.toLowerCase()) {
case 'input':
case 'textarea':
return true;
break;
default:
return false;
}
}
};
/**
joSubject
==========
Class for custom events using the Observer Pattern. This is designed to be used
inside a subject to create events observers can subscribe to. Unlike the classic
observer pattern, a subject can fire more than one event when called, and
each observer gets data from the subject. This is very similar to YUI 2.x event model.
You can also "lock" the notification chain by using the `capture()` method, which
tells the event to only notify the most recent subscriber (observer) which requested
to capture the event exclusively.
Methods
-------
- `subscribe(Function, context, data)`
Both `context` and `data` are optional. Also, you may use the `Function.bind(this)`
approach instead of passing in the `context` as a separate argument. All subscribers
will be notified when the event is fired.
- `unsubscribe(Function, context)`
Does what you'd think.
- `fire(data)`
Calls subscriber methods for all observers, and passes in: `data` from the subject,
a reference to the `subject` and any static `data` which was passed in the
`subscribe()` call.
- `capture(Function, context, data)`
Only the last subscriber to capture this event will be notified until it is
released. Note that you can stack `capture()` calls to produce a modal event
heiarchy.
- `release(Function, context)`
Removes the most recent subscription called with `capture()`, freeing up the next
subscribers in the list to be notified the next time the event is fired.
Use
---
### In the subject (or "publisher") object
// inside the Subject, we setup an event observers can subscribe to
this.changeEvent = new joSubject(this);
// to fire the event inside the Subject
this.changeEvent.fire(somedata);
### In the observer (or "subscriber") object
// simple case, using Function.bind()
somesubject.changeEvent.subscribe(this.mymethod.bind());
// explicit context (this)
somesubject.changeEvent.subscribe(this.mymethod, this);
// optional data which gets passed with the event fires
somesubject.changeEvent.subscribe(this.mymethod, this, "hello");
This is a very flexible way to handle messages between objects. Each subject
may have multiple events which any number of observer objects can subscribe
to.
*/
joSubject = function(subject) {
this.subscriptions = [];
this.subject = subject;
};
joSubject.prototype = {
subscribe: function(call, observer, data) {
if (!call)
return false;
var o = { "call": call };
if (observer)
o.observer = observer;
if (data)
o.data = data;
this.subscriptions.push(o);
return this.subject;
},
unsubscribe: function(call, observer) {
if (!call)
return false;
for (var i = 0, l = this.subscriptions.length; i < l; i++) {
var sub = this.subscriptions[i];
if (sub.call === call && (typeof sub.observer === 'undefined' || sub.observer === observer)) {
this.subscriptions.splice(i, 1);
break;
}
}
return this.subject;
},
fire: function(data) {
if (typeof data === 'undefined')
var data = "";
for (var i = 0, l = this.subscriptions.length; i < l; i++) {
var sub = this.subscriptions[i];
var subjectdata = (typeof sub.data !== 'undefined') ? sub.data : null;
if (sub.observer)
sub.call.call(sub.observer, data, this.subject, subjectdata);
else
sub.call(data, this.subject, subjectdata);
// if this subscriber wants to capture events,
// stop calling other subscribers
if (sub.capture)
break;
}
},
capture: function(call, observer, data) {
if (!call)
return false;
var o = { "call": call, capture: true };
if (observer)
o.observer = observer;
if (data)
o.data = data;
this.subscriptions.unshift(o);
return this.subject;
},
release: function(call, observer) {
return this.unsubscribe(call, observer);
}
};
/**
joTime
======
Time utility functions. More will be added, but only as needed by the
framework. There are entire libraries dedicated to extensive datetime
manipulation, and Jo doesn't pretend to be one of them.
Methods
-------
- `timestamp()`
Returns a current timestamp in milliseconds from 01/01/1970 from
the system clock.
Constants
---------
- `SEC`, `MIN`, `HOUR`, `DAY`
Convenience global constants which make it easier to manipulate
timestamps.
Use
---
var twoHoursLater = joTime.timestamp() + (HOUR * 2);
*/
var SEC = 1000;
var MIN = 60 * SEC;
var HOUR = 60 * MIN;
var DAY = 24 * HOUR;
joTime = {
timestamp: function() {
var now = new Date();
return now / 1;
}
};
/**
joYield
========
Utility function which calls a given method within a given context after `n`
milliseconds with optional static data.
Use
-----
joYield(Function, context, delay, data);
Note that delay defaults to 100ms if not specified, and `data` is optional.
*/
function joYield(call, context, delay, data) {
if (!delay)
var delay = 100;
if (!context)
var context = this;
var timer = window.setTimeout(function() {
call.call(context, data);
}, delay);
return timer;
};
/**
joCache
=======
A singleton which makes it easy to setup deferred object creation and cached
results. This is a performance menchanism initially designed for UI views, but
could be extended to handle data requests and other object types.
Methods
-------
- `set(key, call, context)`
Defines a factory (`call`) for building an object keyed from the `key` string.
The `context` argument is optional, but provides a reference for `this`.
- `get(key)`
Returns an object based on the `key` string. If an object has not been created
which corresponds to the `key`, joCache will call the constructor defined to
create it and store the reference for future calls to `get()`.
Use
---
Defining a view for on-demand use:
joCache.set("home", function() {
return new joCard([
new joTitle("Home"),
new joMenu([
"Top Stories",
"Latest News",
"Old News",
"No News"
])
]);
});
Displaying a view later:
mystack.push(joCache.get("home"));
// the first call to get() will instantiate
// the view, subsequent calls will return the
// view that was created the first time
*/
joCache = {
cache: {},
set: function(key, call, context) {
if (call)
this.cache[key] = { "call": call, "context": context || this };
},
get: function(key) {
var cache = this.cache[key] || null;
if (cache) {
if (!cache.view)
cache.view = cache.call(cache.context, cache.call);
return cache.view;
}
else {
return new joView("View not found: " + key);
}
}
};
/**
joChain
========
Class which strings asyncronous calls together.
> In serious need of rework; doesn't meet original goal of sequencing
> these calls. This class might also become deprecated.
Methods
-------
- `add(Function, context, data)`
- `start()`
- `stop()`
- `next()`
*/
joChain = function() {
this.queue = [];
this.active = false;
this.addEvent = new joSubject("add", this);
this.startEvent = new joSubject("start", this);
this.stopEvent = new joSubject("stop", this);
this.nextEvent = new joSubject("next", this);
this.stop();
this.delay = 100;
};
joChain.prototype = {
add: function(call, context, data) {
if (!context)
var context = this;
if (!data)
var data = "";
this.queue.push({
"call":call,
"context": context,
"data": data
});
if (this.active && !this.timer)
this.next();
},
start: function() {
this.active = true;
this.startEvent.fire();
this.next();
},
stop: function() {
this.active = false;
if (this.timer != null)
window.clearTimeout(this.timer);
this.timer = null;
this.stopEvent.fire();
},
next: function() {
var nextcall = this.queue.shift();
if (!nextcall) {
this.timer = null;
return;
}
this.nextEvent.fire(nextcall);