-
-
Notifications
You must be signed in to change notification settings - Fork 261
/
Element.js
2804 lines (2268 loc) · 69.6 KB
/
Element.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
/* ************************************************************************
qooxdoo - the new era of web development
http://qooxdoo.org
Copyright:
2004-2008 1&1 Internet AG, Germany, http://www.1und1.de
License:
LGPL: http://www.gnu.org/licenses/lgpl.html
EPL: http://www.eclipse.org/org/documents/epl-v10.php
See the LICENSE file in the project's top-level directory for details.
Authors:
* Sebastian Werner (wpbasti)
************************************************************************ */
/**
* High-performance, high-level DOM element creation and management.
*
* Includes support for HTML and style attributes. Elements also have
* got a powerful children and visibility management.
*
* Processes DOM insertion and modification with advanced logic
* to reduce the real transactions.
*
* From the view of the parent you can use the following children management
* methods:
* {@link #getChildren}, {@link #indexOf}, {@link #hasChild}, {@link #add},
* {@link #addAt}, {@link #remove}, {@link #removeAt}, {@link #removeAll}
*
* Each child itself also has got some powerful methods to control its
* position:
* {@link #getParent}, {@link #free},
* {@link #insertInto}, {@link #insertBefore}, {@link #insertAfter},
* {@link #moveTo}, {@link #moveBefore}, {@link #moveAfter},
*
* @require(qx.module.Animation)
*/
qx.Class.define("qx.html.Element",
{
extend : qx.core.Object,
/*
*****************************************************************************
CONSTRUCTOR
*****************************************************************************
*/
/**
* Creates a new Element
*
* @param tagName {String?"div"} Tag name of the element to create
* @param styles {Map?null} optional map of CSS styles, where the key is the name
* of the style and the value is the value to use.
* @param attributes {Map?null} optional map of element attributes, where the
* key is the name of the attribute and the value is the value to use.
*/
construct : function(tagName, styles, attributes)
{
this.base(arguments);
// {String} Set tag name
this.__nodeName = tagName || "div";
this.__styleValues = styles || null;
this.__attribValues = attributes || null;
},
/*
*****************************************************************************
STATICS
*****************************************************************************
*/
statics :
{
/*
---------------------------------------------------------------------------
STATIC DATA
---------------------------------------------------------------------------
*/
/** @type {Boolean} If debugging should be enabled */
DEBUG : false,
/** @type {Map} Contains the modified {@link qx.html.Element}s. The key is the hash code. */
_modified : {},
/** @type {Map} Contains the {@link qx.html.Element}s which should get hidden or visible at the next flush. The key is the hash code. */
_visibility : {},
/** @type {Map} Contains the {@link qx.html.Element}s which should scrolled at the next flush */
_scroll : {},
/** @type {Array} List of post actions for elements. The key is the action name. The value the {@link qx.html.Element}. */
_actions : [],
/** @type {Map} List of all selections. */
__selection : {},
__focusHandler : null,
__mouseCapture : null,
/*
---------------------------------------------------------------------------
PUBLIC ELEMENT FLUSH
---------------------------------------------------------------------------
*/
/**
* Schedule a deferred element queue flush. If the widget subsystem is used
* this method gets overwritten by {@link qx.ui.core.queue.Manager}.
*
* @param job {String} The job descriptor. Should always be <code>"element"</code>.
*/
_scheduleFlush : function(job) {
qx.html.Element.__deferredCall.schedule();
},
/**
* Flush the global modified list
*/
flush : function()
{
var obj;
if (qx.core.Environment.get("qx.debug"))
{
if (this.DEBUG) {
qx.log.Logger.debug(this, "Flushing elements...");
}
}
// blur elements, which will be removed
var focusHandler = this.__getFocusHandler();
var focusedDomElement = focusHandler.getFocus();
if (focusedDomElement && this.__willBecomeInvisible(focusedDomElement)) {
focusHandler.blur(focusedDomElement);
}
// decativate elements, which will be removed
var activeDomElement = focusHandler.getActive();
if (activeDomElement && this.__willBecomeInvisible(activeDomElement)) {
qx.bom.Element.deactivate(activeDomElement);
}
// release capture for elements, which will be removed
var captureDomElement = this.__getCaptureElement();
if (captureDomElement && this.__willBecomeInvisible(captureDomElement)) {
qx.bom.Element.releaseCapture(captureDomElement);
}
var later = [];
var modified = this._modified;
for (var hc in modified)
{
obj = modified[hc];
// Ignore all hidden elements except iframes
// but keep them until they get visible (again)
if (obj.__willBeSeeable() || obj.classname == "qx.html.Iframe")
{
// Separately queue rendered elements
if (obj.__element && qx.dom.Hierarchy.isRendered(obj.__element)) {
later.push(obj);
}
// Flush invisible elements first
else
{
if (qx.core.Environment.get("qx.debug"))
{
if (this.DEBUG) {
obj.debug("Flush invisible element");
}
}
obj.__flush();
}
// Cleanup modification list
delete modified[hc];
}
}
for (var i=0, l=later.length; i<l; i++)
{
obj = later[i];
if (qx.core.Environment.get("qx.debug"))
{
if (this.DEBUG) {
obj.debug("Flush rendered element");
}
}
obj.__flush();
}
// Process visibility list
var visibility = this._visibility;
for (var hc in visibility)
{
obj = visibility[hc];
var element = obj.__element;
if (!element)
{
delete visibility[hc];
continue;
}
if (qx.core.Environment.get("qx.debug"))
{
if (this.DEBUG) {
qx.log.Logger.debug(this, "Switching visibility to: " + obj.__visible);
}
}
// hiding or showind an object and deleting it right after that may
// cause an disposed object in the visibility queue [BUG #3607]
if (!obj.$$disposed) {
element.style.display = obj.__visible ? "" : "none";
// also hide the element (fixed some rendering problem in IE<8 & IE8 quirks)
if ((qx.core.Environment.get("engine.name") == "mshtml"))
{
if (!(document.documentMode >= 8)) {
element.style.visibility = obj.__visible ? "visible" : "hidden";
}
}
}
delete visibility[hc];
}
// Process scroll list
var scroll = this._scroll;
for (var hc in scroll)
{
obj = scroll[hc];
var elem = obj.__element;
if (elem && elem.offsetWidth)
{
var done = true;
// ScrollToX
if (obj.__lazyScrollX != null)
{
obj.__element.scrollLeft = obj.__lazyScrollX;
delete obj.__lazyScrollX;
}
// ScrollToY
if (obj.__lazyScrollY != null)
{
obj.__element.scrollTop = obj.__lazyScrollY;
delete obj.__lazyScrollY;
}
// ScrollIntoViewX
var intoViewX = obj.__lazyScrollIntoViewX;
if (intoViewX != null)
{
var child = intoViewX.element.getDomElement();
if (child && child.offsetWidth)
{
qx.bom.element.Scroll.intoViewX(child, elem, intoViewX.align);
delete obj.__lazyScrollIntoViewX;
}
else
{
done = false;
}
}
// ScrollIntoViewY
var intoViewY = obj.__lazyScrollIntoViewY;
if (intoViewY != null)
{
var child = intoViewY.element.getDomElement();
if (child && child.offsetWidth)
{
qx.bom.element.Scroll.intoViewY(child, elem, intoViewY.align);
delete obj.__lazyScrollIntoViewY;
}
else
{
done = false;
}
}
// Clear flag if all things are done
// Otherwise wait for the next flush
if (done) {
delete scroll[hc];
}
}
}
var activityEndActions = {
"releaseCapture": 1,
"blur": 1,
"deactivate": 1
}
// Process action list
for (var i=0; i<this._actions.length; i++)
{
var action = this._actions[i];
var element = action.element.__element;
if (!element || !activityEndActions[action.type] && !action.element.__willBeSeeable()) {
continue;
}
var args = action.args;
args.unshift(element);
qx.bom.Element[action.type].apply(qx.bom.Element, args);
}
this._actions = [];
// Process selection
for (var hc in this.__selection)
{
var selection = this.__selection[hc];
var elem = selection.element.__element;
if (elem)
{
qx.bom.Selection.set(elem, selection.start, selection.end);
delete this.__selection[hc];
}
}
// Fire appear/disappear events
qx.event.handler.Appear.refresh();
},
/**
* Get the focus handler
*
* @return {qx.event.handler.Focus} The focus handler
*/
__getFocusHandler : function()
{
if (!this.__focusHandler)
{
var eventManager = qx.event.Registration.getManager(window);
this.__focusHandler = eventManager.getHandler(qx.event.handler.Focus);
}
return this.__focusHandler;
},
/**
* Get the mouse capture element
*
* @return {Element} The mouse capture DOM element
*/
__getCaptureElement : function()
{
if (!this.__mouseCapture)
{
var eventManager = qx.event.Registration.getManager(window);
this.__mouseCapture = eventManager.getDispatcher(qx.event.dispatch.MouseCapture);
}
return this.__mouseCapture.getCaptureElement();
},
/**
* Whether the given DOM element will become invisible after the flush
*
* @param domElement {Element} The DOM element to check
* @return {Boolean} Whether the element will become invisible
*/
__willBecomeInvisible : function(domElement)
{
var element = qx.core.ObjectRegistry.fromHashCode(domElement.$$element);
return element && !element.__willBeSeeable();
}
},
/*
*****************************************************************************
MEMBERS
*****************************************************************************
*/
members :
{
/*
---------------------------------------------------------------------------
PROTECTED HELPERS/DATA
---------------------------------------------------------------------------
*/
__nodeName : null,
/** @type {Element} DOM element of this object */
__element : null,
/** @type {Boolean} Marker for always visible root nodes (often the body node) */
__root : false,
/** @type {Boolean} Whether the element should be included in the render result */
__included : true,
/** @type {Boolean} Whether the element should be visible in the render result */
__visible : true,
__lazyScrollIntoViewX : null,
__lazyScrollIntoViewY : null,
__lazyScrollX : null,
__lazyScrollY : null,
__styleJobs : null,
__attribJobs : null,
__propertyJobs : null,
__styleValues : null,
__attribValues : null,
__propertyValues : null,
__eventValues : null,
__children : null,
__modifiedChildren : null,
__parent : null,
/**
* Add the element to the global modification list.
*
*/
_scheduleChildrenUpdate : function()
{
if (this.__modifiedChildren) {
return;
}
this.__modifiedChildren = true;
qx.html.Element._modified[this.$$hash] = this;
qx.html.Element._scheduleFlush("element");
},
/**
* Internal helper to generate the DOM element
*
* @return {Element} DOM element
*/
_createDomElement : function() {
return qx.dom.Element.create(this.__nodeName);
},
/*
---------------------------------------------------------------------------
FLUSH OBJECT
---------------------------------------------------------------------------
*/
/**
* Syncs data of an HtmlElement object to the DOM.
*
*/
__flush : function()
{
if (qx.core.Environment.get("qx.debug"))
{
if (this.DEBUG) {
this.debug("Flush: " + this.getAttribute("id"));
}
}
var length;
var children = this.__children;
if (children)
{
length = children.length;
var child;
for (var i=0; i<length; i++)
{
child = children[i];
if (child.__visible && child.__included && !child.__element) {
child.__flush();
}
}
}
if (!this.__element)
{
this.__element = this._createDomElement();
this.__element.$$element = this.$$hash;
this._copyData(false);
if (children && length > 0) {
this._insertChildren();
}
}
else
{
this._syncData();
if (this.__modifiedChildren) {
this._syncChildren();
}
}
delete this.__modifiedChildren;
},
/*
---------------------------------------------------------------------------
SUPPORT FOR CHILDREN FLUSH
---------------------------------------------------------------------------
*/
/**
* Append all child nodes to the DOM
* element. This function is used when the element is initially
* created. After this initial apply {@link #_syncChildren} is used
* instead.
*
*/
_insertChildren : function()
{
var children = this.__children;
var length = children.length;
var child;
if (length > 2)
{
var domElement = document.createDocumentFragment();
for (var i=0; i<length; i++)
{
child = children[i];
if (child.__element && child.__included) {
domElement.appendChild(child.__element);
}
}
this.__element.appendChild(domElement);
}
else
{
var domElement = this.__element;
for (var i=0; i<length; i++)
{
child = children[i];
if (child.__element && child.__included) {
domElement.appendChild(child.__element);
}
}
}
},
/**
* Syncronize internal children hierarchy to the DOM. This is used
* for further runtime updates after the element has been created
* initially.
*
*/
_syncChildren : function()
{
var ObjectRegistry = qx.core.ObjectRegistry;
var dataChildren = this.__children;
var dataLength = dataChildren.length;
var dataChild;
var dataEl;
var domParent = this.__element;
var domChildren = domParent.childNodes;
var domPos = 0;
var domEl;
if (qx.core.Environment.get("qx.debug")) {
var domOperations = 0;
}
// Remove children from DOM which are excluded or remove first
for (var i=domChildren.length-1; i>=0; i--)
{
domEl = domChildren[i];
dataEl = ObjectRegistry.fromHashCode(domEl.$$element);
if (!dataEl || !dataEl.__included || dataEl.__parent !== this)
{
domParent.removeChild(domEl);
if (qx.core.Environment.get("qx.debug")) {
domOperations++;
}
}
}
// Start from beginning and bring DOM in sync
// with the data structure
for (var i=0; i<dataLength; i++)
{
dataChild = dataChildren[i];
// Only process visible childs
if (dataChild.__included)
{
dataEl = dataChild.__element;
domEl = domChildren[domPos];
if (!dataEl) {
continue;
}
// Only do something when out of sync
// If the data element is not there it may mean that it is still
// marked as visible=false
if (dataEl != domEl)
{
if (domEl) {
domParent.insertBefore(dataEl, domEl);
} else {
domParent.appendChild(dataEl);
}
if (qx.core.Environment.get("qx.debug")) {
domOperations++
}
}
// Increase counter
domPos++;
}
}
// User feedback
if (qx.core.Environment.get("qx.debug"))
{
if (qx.html.Element.DEBUG) {
this.debug("Synced DOM with " + domOperations + " operations");
}
}
},
/*
---------------------------------------------------------------------------
SUPPORT FOR ATTRIBUTE/STYLE/EVENT FLUSH
---------------------------------------------------------------------------
*/
/**
* Copies data between the internal representation and the DOM. This
* simply copies all the data and only works well directly after
* element creation. After this the data must be synced using {@link #_syncData}
*
* @param fromMarkup {Boolean} Whether the copy should respect styles
* given from markup
*/
_copyData : function(fromMarkup)
{
var elem = this.__element;
// Copy attributes
var data = this.__attribValues;
if (data)
{
var Attribute = qx.bom.element.Attribute;
for (var key in data) {
Attribute.set(elem, key, data[key]);
}
}
// Copy styles
var data = this.__styleValues;
if (data)
{
var Style = qx.bom.element.Style;
if (fromMarkup) {
Style.setStyles(elem, data);
}
else
{
// Set styles at once which is a lot faster in most browsers
// compared to separate modifications of many single style properties.
Style.setCss(elem, Style.compile(data));
}
}
// Copy properties
var data = this.__propertyValues;
if (data)
{
for (var key in data) {
this._applyProperty(key, data[key]);
}
}
// Attach events
var data = this.__eventValues;
if (data)
{
// Import listeners
qx.event.Registration.getManager(elem).importListeners(elem, data);
// Cleanup event map
// Events are directly attached through event manager
// after initial creation. This differs from the
// handling of styles and attributes where queuing happens
// through the complete runtime of the application.
delete this.__eventValues;
}
},
/**
* Syncronizes data between the internal representation and the DOM. This
* is the counterpart of {@link #_copyData} and is used for further updates
* after the element has been created.
*
*/
_syncData : function()
{
var elem = this.__element;
var Attribute = qx.bom.element.Attribute;
var Style = qx.bom.element.Style;
// Sync attributes
var jobs = this.__attribJobs;
if (jobs)
{
var data = this.__attribValues;
if (data)
{
var value;
for (var key in jobs)
{
value = data[key];
if (value !== undefined) {
Attribute.set(elem, key, value);
} else {
Attribute.reset(elem, key);
}
}
}
this.__attribJobs = null;
}
// Sync styles
var jobs = this.__styleJobs;
if (jobs)
{
var data = this.__styleValues;
if (data)
{
var styles = {};
for (var key in jobs) {
styles[key] = data[key]
}
Style.setStyles(elem, styles);
}
this.__styleJobs = null;
}
// Sync misc
var jobs = this.__propertyJobs;
if (jobs)
{
var data = this.__propertyValues;
if (data)
{
var value;
for (var key in jobs) {
this._applyProperty(key, data[key]);
}
}
this.__propertyJobs = null;
}
// Note: Events are directly kept in sync
},
/*
---------------------------------------------------------------------------
PRIVATE HELPERS/DATA
---------------------------------------------------------------------------
*/
/**
* Walk up the internal children hierarchy and
* look if one of the children is marked as root.
*
* This method is quite performance hungry as it
* really walks up recursively.
* @return {Boolean} <code>true</code> if the element will be seeable
*/
__willBeSeeable : function()
{
var pa = this;
// Any chance to cache this information in the parents?
while(pa)
{
if (pa.__root) {
return true;
}
if (!pa.__included || !pa.__visible) {
return false;
}
pa = pa.__parent;
}
return false;
},
/**
* Internal helper for all children addition needs
*
* @param child {var} the element to add
* @throws {Error} if the given element is already a child
* of this element
*/
__addChildHelper : function(child)
{
if (child.__parent === this) {
throw new Error("Child is already in: " + child);
}
if (child.__root) {
throw new Error("Root elements could not be inserted into other ones.");
}
// Remove from previous parent
if (child.__parent) {
child.__parent.remove(child);
}
// Convert to child of this object
child.__parent = this;
// Prepare array
if (!this.__children) {
this.__children = [];
}
// Schedule children update
if (this.__element) {
this._scheduleChildrenUpdate();
}
},
/**
* Internal helper for all children removal needs
*
* @param child {qx.html.Element} the removed element
* @throws {Error} if the given element is not a child
* of this element
*/
__removeChildHelper : function(child)
{
if (child.__parent !== this) {
throw new Error("Has no child: " + child);
}
// Schedule children update
if (this.__element) {
this._scheduleChildrenUpdate();
}
// Remove reference to old parent
delete child.__parent;
},
/**
* Internal helper for all children move needs
*
* @param child {qx.html.Element} the moved element
* @throws {Error} if the given element is not a child
* of this element
*/
__moveChildHelper : function(child)
{
if (child.__parent !== this) {
throw new Error("Has no child: " + child);
}
// Schedule children update
if (this.__element) {
this._scheduleChildrenUpdate();
}
},
/*
---------------------------------------------------------------------------
CHILDREN MANAGEMENT (EXECUTED ON THE PARENT)
---------------------------------------------------------------------------
*/
/**
* Returns a copy of the internal children structure.
*
* Please do not modify the array in place. If you need
* to work with the data in such a way make yourself
* a copy of the data first.
*
* @return {Array} the children list
*/
getChildren : function() {
return this.__children || null;
},
/**
* Get a child element at the given index
*
* @param index {Integer} child index
* @return {qx.html.Element|null} The child element or <code>null</code> if
* no child is found at that index.
*/
getChild : function(index)
{
var children = this.__children;
return children && children[index] || null;
},
/**
* Returns whether the element has any child nodes