/
element.dart
1753 lines (1587 loc) · 58.2 KB
/
element.dart
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
/*
* Copyright (C) 2019-present Alibaba Inc. All rights reserved.
* Author: Kraken Team.
*/
import 'dart:async';
import 'dart:ffi';
import 'dart:typed_data';
import 'dart:ui';
import 'package:flutter/foundation.dart';
import 'package:flutter/gestures.dart';
import 'package:flutter/painting.dart';
import 'package:flutter/rendering.dart';
import 'package:flutter/scheduler.dart';
import 'package:kraken/bridge.dart';
import 'package:kraken/css.dart';
import 'package:kraken/dom.dart';
import 'package:kraken/rendering.dart';
import 'package:kraken/src/dom/sliver_manager.dart';
import 'package:meta/meta.dart';
import 'element_native_methods.dart';
final RegExp _splitRegExp = RegExp(r'\s+');
const String _ONE_SPACE = ' ';
const String _STYLE_PROPERTY = 'style';
const String _CLASS_NAME = 'class';
/// Defined by W3C Standard,
/// Most element's default width is 300 in pixel,
/// height is 150 in pixel.
const String ELEMENT_DEFAULT_WIDTH = '300px';
const String ELEMENT_DEFAULT_HEIGHT = '150px';
typedef TestElement = bool Function(Element element);
enum StickyPositionType {
relative,
fixed,
}
enum BoxSizeType {
// Element which have intrinsic before layout. Such as <img /> and <video />
intrinsic,
// Element which have width or min-width properties defined.
specified,
// Element which neither have intrinsic or predefined size.
automatic,
}
mixin ElementBase on Node {
RenderLayoutBox? _renderLayoutBox;
RenderIntrinsic? _renderIntrinsic;
RenderBoxModel? get renderBoxModel => _renderLayoutBox ?? _renderIntrinsic;
set renderBoxModel(RenderBoxModel? value) {
if (value == null) {
_renderIntrinsic = null;
_renderLayoutBox = null;
} else if (value is RenderIntrinsic) {
_renderIntrinsic = value;
} else if (value is RenderLayoutBox) {
_renderLayoutBox = value;
} else {
if (!kReleaseMode) throw FlutterError('Unknown RenderBoxModel value.');
}
}
late RenderStyle renderStyle;
}
typedef BeforeRendererAttach = RenderObject Function();
typedef GetTargetId = int Function();
typedef GetRootElementFontSize = double Function();
typedef GetChildNodes = List<Node> Function();
/// Get the viewport size of current element.
typedef GetViewportSize = Size Function();
/// Get the render box model of current element.
typedef GetRenderBoxModel = RenderBoxModel? Function();
class Element extends Node
with
ElementBase,
ElementNativeMethods,
ElementEventMixin,
ElementOverflowMixin {
final Map<String, dynamic> properties = <String, dynamic>{};
// Default to unknown, assign by [createElement], used by inspector.
String tagName = UNKNOWN;
/// Is element an intrinsic box.
final bool _isIntrinsicBox;
/// The style of the element, not inline style.
late CSSStyleDeclaration style;
/// The default user-agent style.
final Map<String, dynamic> _defaultStyle;
/// The inline style is a map of style property name to style property value.
final Map<String, dynamic> inlineStyle = {};
/// The Element.classList is a read-only property that returns a collection of the class attributes of the element.
final List<String> _classList = [];
List<String> get classList {
return _classList;
}
set className(String className) {
_classList.clear();
List<String> classList = className.split(_splitRegExp);
if (classList.isNotEmpty) {
_classList.addAll(classList);
}
recalculateStyle();
}
String get className => _classList.join(_ONE_SPACE);
final bool _isDefaultRepaintBoundary;
/// Whether should as a repaintBoundary for this element when style changed
bool get isRepaintBoundary {
// Following cases should always convert to repaint boundary for performance consideration.
// Intrinsic element such as <canvas>.
if (_isDefaultRepaintBoundary || _forceToRepaintBoundary) return true;
// Overflow style.
bool hasOverflowScroll = renderStyle.overflowX == CSSOverflowType.scroll || renderStyle.overflowX == CSSOverflowType.auto ||
renderStyle.overflowY == CSSOverflowType.scroll || renderStyle.overflowY == CSSOverflowType.auto;
// Transform style.
bool hasTransform = renderStyle.transformMatrix != null;
// Fixed position style.
bool hasPositionedFixed = renderStyle.position == CSSPositionType.fixed;
return hasOverflowScroll || hasTransform || hasPositionedFixed;
}
bool _forceToRepaintBoundary = false;
set forceToRepaintBoundary(bool value) {
if (_forceToRepaintBoundary == value) {
return;
}
_forceToRepaintBoundary = value;
_updateRenderBoxModel();
}
Element(int targetId, Pointer<NativeEventTarget> nativeEventTarget, ElementManager elementManager,
{ Map<String, dynamic> defaultStyle = const {},
// Whether element allows children.
bool isIntrinsicBox = false,
bool isDefaultRepaintBoundary = false})
: _defaultStyle = defaultStyle,
_isIntrinsicBox = isIntrinsicBox,
_isDefaultRepaintBoundary = isDefaultRepaintBoundary,
super(NodeType.ELEMENT_NODE, targetId, nativeEventTarget, elementManager) {
// Init style and add change listener.
style = CSSStyleDeclaration.computedStyle(this, _defaultStyle, _onStyleChanged);
// Init render style.
renderStyle = RenderStyle(target: this);
}
@override
String get nodeName => tagName;
@override
RenderBox? get renderer => renderBoxModel;
@override
RenderBox createRenderer() {
if (renderBoxModel != null) {
return renderBoxModel!;
}
_updateRenderBoxModel();
return renderBoxModel!;
}
void _updateRenderBoxModel() {
RenderBoxModel nextRenderBoxModel;
if (_isIntrinsicBox) {
nextRenderBoxModel = _createRenderIntrinsic(isRepaintBoundary: isRepaintBoundary, previousIntrinsic: _renderIntrinsic);
} else {
nextRenderBoxModel = _createRenderLayout(isRepaintBoundary: isRepaintBoundary, previousRenderLayoutBox: _renderLayoutBox);
}
RenderBox? previousRenderBoxModel = renderBoxModel;
if (nextRenderBoxModel != previousRenderBoxModel) {
RenderBox? parentRenderBox;
RenderBox? after;
if (previousRenderBoxModel != null) {
parentRenderBox = previousRenderBoxModel.parent as RenderBox?;
after = (previousRenderBoxModel.parentData as ContainerParentDataMixin<RenderBox>?)?.previousSibling;
_detachRenderBoxModel(previousRenderBoxModel);
if (parentRenderBox != null) {
_attachRenderBoxModel(parentRenderBox, nextRenderBoxModel, after: after);
}
}
renderBoxModel = nextRenderBoxModel;
// Ensure that the event responder is bound.
_ensureEventResponderBound();
}
}
RenderIntrinsic _createRenderIntrinsic({
RenderIntrinsic? previousIntrinsic,
bool isRepaintBoundary = false
}) {
RenderIntrinsic nextIntrinsic;
if (previousIntrinsic == null) {
if (isRepaintBoundary) {
nextIntrinsic = RenderRepaintBoundaryIntrinsic(
renderStyle,
);
} else {
nextIntrinsic = RenderIntrinsic(
renderStyle,
);
}
} else {
if (previousIntrinsic is RenderRepaintBoundaryIntrinsic) {
if (isRepaintBoundary) {
// RenderRepaintBoundaryIntrinsic --> RenderRepaintBoundaryIntrinsic
nextIntrinsic = previousIntrinsic;
} else {
// RenderRepaintBoundaryIntrinsic --> RenderIntrinsic
nextIntrinsic = previousIntrinsic.toIntrinsic();
}
} else {
if (isRepaintBoundary) {
// RenderIntrinsic --> RenderRepaintBoundaryIntrinsic
nextIntrinsic = previousIntrinsic.toRepaintBoundaryIntrinsic();
} else {
// RenderIntrinsic --> RenderIntrinsic
nextIntrinsic = previousIntrinsic;
}
}
}
return nextIntrinsic;
}
// Create renderLayoutBox if type changed and copy children if there has previous renderLayoutBox.
RenderLayoutBox _createRenderLayout({
RenderLayoutBox? previousRenderLayoutBox,
RenderStyle? renderStyle,
bool isRepaintBoundary = false
}) {
renderStyle = renderStyle ?? this.renderStyle;
CSSDisplay display = this.renderStyle.display;
RenderLayoutBox? nextRenderLayoutBox;
if (display == CSSDisplay.flex || display == CSSDisplay.inlineFlex) {
if (previousRenderLayoutBox == null) {
if (isRepaintBoundary) {
nextRenderLayoutBox = RenderRepaintBoundaryFlexLayout(
renderStyle: renderStyle,
);
} else {
nextRenderLayoutBox = RenderFlexLayout(
renderStyle: renderStyle,
);
}
} else if (previousRenderLayoutBox is RenderFlowLayout) {
if (previousRenderLayoutBox is RenderRepaintBoundaryFlowLayout) {
if (isRepaintBoundary) {
// RenderRepaintBoundaryFlowLayout --> RenderRepaintBoundaryFlexLayout
nextRenderLayoutBox = previousRenderLayoutBox.toRepaintBoundaryFlexLayout();
} else {
// RenderRepaintBoundaryFlowLayout --> RenderFlexLayout
nextRenderLayoutBox = previousRenderLayoutBox.toFlexLayout();
}
} else {
if (isRepaintBoundary) {
// RenderFlowLayout --> RenderRepaintBoundaryFlexLayout
nextRenderLayoutBox = previousRenderLayoutBox.toRepaintBoundaryFlexLayout();
} else {
// RenderFlowLayout --> RenderFlexLayout
nextRenderLayoutBox = previousRenderLayoutBox.toFlexLayout();
}
}
} else if (previousRenderLayoutBox is RenderFlexLayout) {
if (previousRenderLayoutBox is RenderRepaintBoundaryFlexLayout) {
if (isRepaintBoundary) {
// RenderRepaintBoundaryFlexLayout --> RenderRepaintBoundaryFlexLayout
nextRenderLayoutBox = previousRenderLayoutBox;
} else {
// RenderRepaintBoundaryFlexLayout --> RenderFlexLayout
nextRenderLayoutBox = previousRenderLayoutBox.toFlexLayout();
}
} else {
if (isRepaintBoundary) {
// RenderFlexLayout --> RenderRepaintBoundaryFlexLayout
nextRenderLayoutBox = previousRenderLayoutBox.toRepaintBoundaryFlexLayout();
} else {
// RenderFlexLayout --> RenderFlexLayout
nextRenderLayoutBox = previousRenderLayoutBox;
}
}
} else if (previousRenderLayoutBox is RenderSliverListLayout) {
// RenderSliverListLayout --> RenderFlexLayout
nextRenderLayoutBox = previousRenderLayoutBox.toFlexLayout();
}
} else if (display == CSSDisplay.block ||
display == CSSDisplay.none ||
display == CSSDisplay.inline ||
display == CSSDisplay.inlineBlock) {
if (previousRenderLayoutBox == null) {
if (isRepaintBoundary) {
nextRenderLayoutBox = RenderRepaintBoundaryFlowLayout(
renderStyle: renderStyle,
);
} else {
nextRenderLayoutBox = RenderFlowLayout(
renderStyle: renderStyle,
);
}
} else if (previousRenderLayoutBox is RenderFlowLayout) {
if (previousRenderLayoutBox is RenderRepaintBoundaryFlowLayout) {
if (isRepaintBoundary) {
// RenderRepaintBoundaryFlowLayout --> RenderRepaintBoundaryFlowLayout
nextRenderLayoutBox = previousRenderLayoutBox;
} else {
// RenderRepaintBoundaryFlowLayout --> RenderFlowLayout
nextRenderLayoutBox = previousRenderLayoutBox.toFlowLayout();
}
} else {
if (isRepaintBoundary) {
// RenderFlowLayout --> RenderRepaintBoundaryFlowLayout
nextRenderLayoutBox = previousRenderLayoutBox.toRepaintBoundaryFlowLayout();
} else {
// RenderFlowLayout --> RenderFlowLayout
nextRenderLayoutBox = previousRenderLayoutBox;
}
}
} else if (previousRenderLayoutBox is RenderFlexLayout) {
if (previousRenderLayoutBox is RenderRepaintBoundaryFlexLayout) {
if (isRepaintBoundary) {
// RenderRepaintBoundaryFlexLayout --> RenderRepaintBoundaryFlowLayout
nextRenderLayoutBox = previousRenderLayoutBox.toRepaintBoundaryFlowLayout();
} else {
// RenderRepaintBoundaryFlexLayout --> RenderFlowLayout
nextRenderLayoutBox = previousRenderLayoutBox.toFlowLayout();
}
} else {
if (isRepaintBoundary) {
// RenderFlexLayout --> RenderRepaintBoundaryFlowLayout
nextRenderLayoutBox = previousRenderLayoutBox.toRepaintBoundaryFlowLayout();
} else {
// RenderFlexLayout --> RenderFlowLayout
nextRenderLayoutBox = previousRenderLayoutBox.toFlowLayout();
}
}
} else if (previousRenderLayoutBox is RenderSliverListLayout) {
// RenderSliverListLayout --> RenderFlowLayout
nextRenderLayoutBox = previousRenderLayoutBox.toFlowLayout();
}
} else if (display == CSSDisplay.sliver) {
if (previousRenderLayoutBox == null) {
nextRenderLayoutBox = RenderSliverListLayout(
renderStyle: renderStyle,
manager: RenderSliverElementChildManager(this),
onScroll: _handleScroll,
);
} else if (previousRenderLayoutBox is RenderFlowLayout || previousRenderLayoutBox is RenderFlexLayout) {
// RenderFlow/FlexLayout --> RenderSliverListLayout
nextRenderLayoutBox = previousRenderLayoutBox.toSliverLayout(RenderSliverElementChildManager(this), _handleScroll);
} else if (previousRenderLayoutBox is RenderSliverListLayout) {
nextRenderLayoutBox = previousRenderLayoutBox;
}
} else {
throw FlutterError('Not supported display type $display');
}
// Update scrolling content layout type.
if (previousRenderLayoutBox != nextRenderLayoutBox && previousRenderLayoutBox?.renderScrollingContent != null) {
updateScrollingContentBox();
}
return nextRenderLayoutBox!;
}
@override
void willAttachRenderer() {
// Init render box model.
createRenderer();
}
@override
void didAttachRenderer() {
// Ensure that the child is attached.
ensureChildAttached();
}
@override
void willDetachRenderer() {
// Cancel running transition.
renderStyle.cancelRunningTransiton();
// Remove all intersection change listeners.
renderBoxModel!.clearIntersectionChangeListeners();
// Remove fixed children from root when element disposed.
_removeFixedChild(renderBoxModel!, elementManager.viewportElement._renderLayoutBox!);
// Remove renderBox.
_removeRenderBoxModel(renderBoxModel!);
// Remove pointer listener
removeEventResponder(renderBoxModel!);
}
@override
void didDetachRenderer() {
style.reset();
}
bool _shouldConsumeScrollTicker = false;
void _consumeScrollTicker(_) {
if (_shouldConsumeScrollTicker && eventHandlers.containsKey(EVENT_SCROLL)) {
_dispatchScrollEvent();
_shouldConsumeScrollTicker = false;
}
}
void _handleScroll(double scrollOffset, AxisDirection axisDirection) {
applyStickyChildrenOffset();
paintFixedChildren(scrollOffset, axisDirection);
if (!_shouldConsumeScrollTicker) {
// Make sure scroll listener trigger most to 1 time each frame.
SchedulerBinding.instance!.addPostFrameCallback(_consumeScrollTicker);
SchedulerBinding.instance!.scheduleFrame();
}
_shouldConsumeScrollTicker = true;
}
/// https://drafts.csswg.org/cssom-view/#scrolling-events
void _dispatchScrollEvent() {
dispatchEvent(Event(EVENT_SCROLL));
}
/// Normally element in scroll box will not repaint on scroll because of repaint boundary optimization
/// So it needs to manually mark element needs paint and add scroll offset in paint stage
void paintFixedChildren(double scrollOffset, AxisDirection axisDirection) {
// Only root element has fixed children
if (this == elementManager.viewportElement && renderBoxModel != null) {
RenderBoxModel layoutBox = (renderBoxModel as RenderLayoutBox).renderScrollingContent ?? renderBoxModel!;
for (RenderBoxModel child in layoutBox.fixedChildren) {
// Save scrolling offset for paint
if (axisDirection == AxisDirection.down) {
child.scrollingOffsetY = scrollOffset;
} else if (axisDirection == AxisDirection.right) {
child.scrollingOffsetX = scrollOffset;
}
}
}
}
// Calculate sticky status according to scroll offset and scroll direction
void applyStickyChildrenOffset() {
RenderLayoutBox? scrollContainer = (renderBoxModel as RenderLayoutBox?)!;
for (RenderBoxModel stickyChild in scrollContainer.stickyChildren) {
CSSPositionedLayout.applyStickyChildOffset(scrollContainer, stickyChild);
}
}
void _updateRenderBoxModelWithPosition() {
RenderBoxModel _renderBoxModel = renderBoxModel!;
CSSPositionType currentPosition = renderStyle.position;
// Remove fixed children before convert to non repaint boundary renderObject
if (currentPosition != CSSPositionType.fixed) {
_removeFixedChild(_renderBoxModel, elementManager.viewportElement._renderLayoutBox!);
}
RenderBox? previousSibling;
RenderPositionPlaceholder? renderPositionPlaceholder = _renderBoxModel.renderPositionPlaceholder;
// It needs to find the previous sibling of the previous sibling if the placeholder of
// positioned element exists and follows renderObject at the same time, eg.
// <div style="position: relative"><div style="position: absolute" /></div>
if (renderPositionPlaceholder != null) {
previousSibling = (renderPositionPlaceholder.parentData as ContainerParentDataMixin<RenderBox>).previousSibling;
// The placeholder's previousSibling maybe the origin renderBox.
if (previousSibling == _renderBoxModel) {
previousSibling = (_renderBoxModel.parentData as ContainerParentDataMixin<RenderBox>).previousSibling;
}
_detachRenderBoxModel(renderPositionPlaceholder);
_renderBoxModel.renderPositionPlaceholder = null;
} else {
previousSibling = (_renderBoxModel.parentData as ContainerParentDataMixin<RenderBox>).previousSibling;
}
// Detach renderBoxModel from original parent.
_detachRenderBoxModel(_renderBoxModel);
_updateRenderBoxModel();
_addToContainingBlock(after: previousSibling);
// Add fixed children after convert to repaint boundary renderObject.
if (currentPosition == CSSPositionType.fixed) {
_addFixedChild(renderBoxModel!, elementManager.viewportElement._renderLayoutBox!);
}
}
Element? getElementById(Element parentElement, int targetId) {
Element? result;
List childNodes = parentElement.childNodes;
for (int i = 0; i < childNodes.length; i++) {
Element element = childNodes[i];
if (element.targetId == targetId) {
result = element;
break;
}
}
return result;
}
void addChild(RenderBox child) {
if (_renderLayoutBox != null) {
RenderLayoutBox? scrollingContentBox = _renderLayoutBox!.renderScrollingContent;
if (scrollingContentBox != null) {
scrollingContentBox.add(child);
} else {
_renderLayoutBox!.add(child);
}
} else if (_renderIntrinsic != null) {
_renderIntrinsic!.child = child;
}
}
@override
void dispose() {
if (isRendererAttached) {
disposeRenderObject();
}
RenderBoxModel? _renderBoxModel = renderBoxModel;
Element? _parentElement = parentElement;
// Call dispose method of renderBoxModel when GC auto dispose element
if (_renderBoxModel != null) {
_renderBoxModel.dispose();
}
if (_parentElement != null) {
_parentElement.removeChild(this);
}
renderStyle.detach();
style.dispose();
properties.clear();
disposeScrolling();
super.dispose();
}
// Used for force update layout.
void flushLayout() {
if (isRendererAttached) {
renderer!.owner!.flushLayout();
}
}
// Attach renderObject of current node to parent
@override
void attachTo(Node parent, {RenderBox? after}) {
_applyStyle(style);
if (renderStyle.display != CSSDisplay.none) {
willAttachRenderer();
// HTML element override attachTo method to attach renderObject to viewportBox.
if (parent is Element) {
RenderLayoutBox? parentRenderLayoutBox = parentElement?._renderLayoutBox?.renderScrollingContent ?? parentElement?._renderLayoutBox;
parentRenderLayoutBox!.insert(renderBoxModel!, after: after);
} else if (parent is Document) {
parent.appendChild(this);
}
// Flush pending style before child attached.
style.flushPendingProperties();
didAttachRenderer();
}
}
/// Release any resources held by [renderBoxModel].
@override
void disposeRenderObject() {
if (renderBoxModel == null) return;
willDetachRenderer();
for (Node child in childNodes) {
child.disposeRenderObject();
}
didDetachRenderer();
// Call dispose method of renderBoxModel when it is detached from tree.
renderBoxModel!.dispose();
renderBoxModel = null;
}
@override
void ensureChildAttached() {
if (isRendererAttached) {
for (Node child in childNodes) {
if (_renderLayoutBox != null && !child.isRendererAttached) {
RenderBox? after;
RenderLayoutBox? scrollingContentBox = _renderLayoutBox!.renderScrollingContent;
if (scrollingContentBox != null) {
after = scrollingContentBox.lastChild;
} else {
after = _renderLayoutBox!.lastChild;
}
child.attachTo(this, after: after);
child.ensureChildAttached();
}
}
}
}
@override
@mustCallSuper
Node appendChild(Node child) {
super.appendChild(child);
// Update renderStyle tree.
if (child is Element) {
child.renderStyle.parent = renderStyle;
}
if (isRendererAttached) {
// Only append child renderer when which is not attached.
if (!child.isRendererAttached && _renderLayoutBox != null) {
RenderBox? after;
RenderLayoutBox? scrollingContentBox = _renderLayoutBox!.renderScrollingContent;
if (scrollingContentBox != null) {
after = scrollingContentBox.lastChild;
} else {
after = _renderLayoutBox!.lastChild;
}
child.attachTo(this, after: after);
}
}
return child;
}
@override
@mustCallSuper
Node removeChild(Node child) {
// Not remove node type which is not present in RenderObject tree such as Comment
// Only append node types which is visible in RenderObject tree
// Only remove childNode when it has parent
if (child.isRendererAttached) {
child.disposeRenderObject();
}
// Update renderStyle tree.
if (child is Element) {
child.renderStyle.detach();
}
super.removeChild(child);
return child;
}
@override
@mustCallSuper
Node insertBefore(Node child, Node referenceNode) {
// Node.insertBefore will change element tree structure,
// so get the referenceIndex before calling it.
int referenceIndex = childNodes.indexOf(referenceNode);
Node node = super.insertBefore(child, referenceNode);
// Update renderStyle tree.
if (child is Element) {
child.renderStyle.parent = renderStyle;
}
if (isRendererAttached) {
// Only append child renderer when which is not attached.
if (!child.isRendererAttached) {
RenderBox? afterRenderObject;
// `referenceNode` should not be null, or `referenceIndex` can only be -1.
if (referenceIndex != -1 && referenceNode.isRendererAttached) {
afterRenderObject = (referenceNode.renderer!.parentData as ContainerParentDataMixin<RenderBox>).previousSibling;
}
child.attachTo(this, after: afterRenderObject);
}
}
return node;
}
@override
@mustCallSuper
Node? replaceChild(Node newNode, Node oldNode) {
// Update renderStyle tree.
if (newNode is Element) {
newNode.renderStyle.parent = renderStyle;
}
if (oldNode is Element) {
oldNode.renderStyle.parent = null;
}
return super.replaceChild(newNode, oldNode);
}
// The position and size of an element's box(es) are sometimes calculated relative to a certain rectangle,
// called the containing block of the element.
// Definition of "containing block": https://www.w3.org/TR/CSS21/visudet.html#containing-block-details
void _addToContainingBlock({RenderBox? after}) {
assert(parentNode != null);
CSSPositionType positionType = renderStyle.position;
RenderBoxModel _renderBoxModel = renderBoxModel!;
// HTML element's parentNode is viewportBox.
RenderBox parentRenderBox = parentNode!.renderer!;
// The containing block of an element is defined as follows:
if (positionType == CSSPositionType.relative || positionType == CSSPositionType.static || positionType == CSSPositionType.sticky) {
// If the element's position is 'relative' or 'static',
// the containing block is formed by the content edge of the nearest block container ancestor box.
_attachRenderBoxModel(parentRenderBox, _renderBoxModel, after: after);
if (positionType == CSSPositionType.sticky) {
// Placeholder of sticky renderBox need to inherit offset from original renderBox,
// so it needs to layout before original renderBox.
_addPositionPlaceholder(parentRenderBox, _renderBoxModel, after: after);
}
} else {
RenderLayoutBox? containingBlockRenderBox;
if (positionType == CSSPositionType.absolute) {
// If the element has 'position: absolute', the containing block is established by the nearest ancestor with
// a 'position' of 'absolute', 'relative' or 'fixed', in the following way:
// 1. In the case that the ancestor is an inline element, the containing block is the bounding box around
// the padding boxes of the first and the last inline boxes generated for that element.
// In CSS 2.1, if the inline element is split across multiple lines, the containing block is undefined.
// 2. Otherwise, the containing block is formed by the padding edge of the ancestor.
containingBlockRenderBox = _findContainingBlock(this, elementManager.viewportElement)?._renderLayoutBox;
} else if (positionType == CSSPositionType.fixed) {
// If the element has 'position: fixed', the containing block is established by the viewport
// in the case of continuous media or the page area in the case of paged media.
containingBlockRenderBox = elementManager.viewportElement._renderLayoutBox;
}
if (containingBlockRenderBox == null) return;
// If container block is same as origin parent, the placeholder must after the origin renderBox
// because placeholder depends the constraints in layout stage.
if (containingBlockRenderBox == parentRenderBox) {
after = _renderBoxModel;
}
// Set custom positioned parentData.
RenderLayoutParentData parentData = RenderLayoutParentData();
_renderBoxModel.parentData = CSSPositionedLayout.getPositionParentData(_renderBoxModel, parentData);
// Add child to containing block parent.
_attachRenderBoxModel(containingBlockRenderBox, _renderBoxModel, isLast: true);
// Add position holder to origin position parent.
_addPositionPlaceholder(parentRenderBox, _renderBoxModel, after: after);
}
}
void _addPositionPlaceholder(RenderBox parentRenderBox, RenderBoxModel renderBoxModel, {RenderBox? after}) {
// Position holder size will be updated on layout.
RenderPositionPlaceholder renderPositionPlaceholder = RenderPositionPlaceholder(preferredSize: Size.zero);
renderBoxModel.renderPositionPlaceholder = renderPositionPlaceholder;
renderPositionPlaceholder.positioned = renderBoxModel;
_attachRenderBoxModel(parentRenderBox, renderPositionPlaceholder, after: after);
}
// FIXME: only compatible with kraken plugins
@deprecated
void setStyle(String property, dynamic value) {
setRenderStyle(property, value);
}
void _updateRenderBoxModelWithDisplay() {
CSSDisplay presentDisplay = renderStyle.display;
if (parentElement == null || !parentElement!.isConnected) return;
// Destroy renderer of element when display is changed to none.
if (presentDisplay == CSSDisplay.none) {
disposeRenderObject();
return;
}
// Update renderBoxModel.
_updateRenderBoxModel();
// Attach renderBoxModel to parent if change from `display: none` to other values.
if (renderBoxModel!.parent == null) {
_addToContainingBlock(after: previousSibling?.renderer);
ensureChildAttached();
}
}
void _attachRenderBoxModel(RenderBox parentRenderBox, RenderBox renderBox, {RenderObject? after, bool isLast = false}) {
if (isLast) {
assert(after == null);
}
if (parentRenderBox is RenderObjectWithChildMixin) { // RenderViewportBox
(parentRenderBox as RenderObjectWithChildMixin).child = renderBox;
} else if (parentRenderBox is ContainerRenderObjectMixin) { // RenderLayoutBox or RenderSliverList
// Should attach to renderScrollingContent if it is scrollable.
if (parentRenderBox is RenderLayoutBox) {
parentRenderBox = parentRenderBox.renderScrollingContent ?? parentRenderBox;
}
if (isLast) {
after = (parentRenderBox as ContainerRenderObjectMixin).lastChild;
}
(parentRenderBox as ContainerRenderObjectMixin).insert(renderBox, after: after);
}
}
void setRenderStyleProperty(String name, dynamic value) {
switch (name) {
case DISPLAY:
renderStyle.display = value;
_updateRenderBoxModelWithDisplay();
break;
case Z_INDEX:
renderStyle.zIndex = value;
_updateRenderBoxModelWithZIndex();
break;
case OVERFLOW_X:
CSSOverflowType oldEffectiveOverflowY = renderStyle.effectiveOverflowY;
renderStyle.overflowX = value;
_updateRenderBoxModel();
updateRenderBoxModelWithOverflowX(_handleScroll);
// Change overflowX may affect effectiveOverflowY.
// https://drafts.csswg.org/css-overflow/#overflow-properties
CSSOverflowType effectiveOverflowY = renderStyle.effectiveOverflowY;
if (effectiveOverflowY != oldEffectiveOverflowY) {
updateRenderBoxModelWithOverflowY(_handleScroll);
}
break;
case OVERFLOW_Y:
CSSOverflowType oldEffectiveOverflowX = renderStyle.effectiveOverflowX;
renderStyle.overflowY = value;
_updateRenderBoxModel();
updateRenderBoxModelWithOverflowY(_handleScroll);
// Change overflowY may affect the effectiveOverflowX.
// https://drafts.csswg.org/css-overflow/#overflow-properties
CSSOverflowType effectiveOverflowX = renderStyle.effectiveOverflowX;
if (effectiveOverflowX != oldEffectiveOverflowX) {
updateRenderBoxModelWithOverflowX(_handleScroll);
}
break;
case OPACITY:
renderStyle.opacity = value;
break;
case VISIBILITY:
renderStyle.visibility = value;
break;
case CONTENT_VISIBILITY:
renderStyle.contentVisibility = value;
break;
case POSITION:
renderStyle.position = value;
_updateRenderBoxModelWithPosition();
break;
case TOP:
renderStyle.top = value;
break;
case LEFT:
renderStyle.left = value;
break;
case BOTTOM:
renderStyle.bottom = value;
break;
case RIGHT:
renderStyle.right = value;
break;
// Size
case WIDTH:
renderStyle.width = value;
break;
case MIN_WIDTH:
renderStyle.minWidth = value;
break;
case MAX_WIDTH:
renderStyle.maxWidth = value;
break;
case HEIGHT:
renderStyle.height = value;
break;
case MIN_HEIGHT:
renderStyle.minHeight = value;
break;
case MAX_HEIGHT:
renderStyle.maxHeight = value;
break;
// Flex
case FLEX_DIRECTION:
renderStyle.flexDirection = value;
break;
case FLEX_WRAP:
renderStyle.flexWrap = value;
break;
case ALIGN_CONTENT:
renderStyle.alignContent = value;
break;
case ALIGN_ITEMS:
renderStyle.alignItems = value;
break;
case JUSTIFY_CONTENT:
renderStyle.justifyContent = value;
break;
case ALIGN_SELF:
renderStyle.alignSelf = value;
break;
case FLEX_GROW:
renderStyle.flexGrow = value;
break;
case FLEX_SHRINK:
renderStyle.flexShrink = value;
break;
case FLEX_BASIS:
renderStyle.flexBasis = value;
break;
// Background
case BACKGROUND_COLOR:
renderStyle.backgroundColor = value;
break;
case BACKGROUND_ATTACHMENT:
renderStyle.backgroundAttachment = value;
break;
case BACKGROUND_IMAGE:
renderStyle.backgroundImage = value;
break;
case BACKGROUND_REPEAT:
renderStyle.backgroundRepeat = value;
break;
case BACKGROUND_POSITION_X:
renderStyle.backgroundPositionX = value;
break;
case BACKGROUND_POSITION_Y:
renderStyle.backgroundPositionY = value;
break;
case BACKGROUND_SIZE:
renderStyle.backgroundSize = value;
break;
case BACKGROUND_CLIP:
renderStyle.backgroundClip = value;
break;
case BACKGROUND_ORIGIN:
renderStyle.backgroundOrigin = value;
break;
// Padding
case PADDING_TOP:
renderStyle.paddingTop = value;
break;
case PADDING_RIGHT:
renderStyle.paddingRight = value;
break;
case PADDING_BOTTOM:
renderStyle.paddingBottom = value;
break;
case PADDING_LEFT:
renderStyle.paddingLeft = value;
break;
// Border
case BORDER_LEFT_WIDTH:
renderStyle.borderLeftWidth = value;
break;
case BORDER_TOP_WIDTH:
renderStyle.borderTopWidth = value;
break;
case BORDER_RIGHT_WIDTH:
renderStyle.borderRightWidth = value;
break;
case BORDER_BOTTOM_WIDTH:
renderStyle.borderBottomWidth = value;
break;
case BORDER_LEFT_STYLE:
renderStyle.borderLeftStyle = value;
break;
case BORDER_TOP_STYLE:
renderStyle.borderTopStyle = value;
break;
case BORDER_RIGHT_STYLE:
renderStyle.borderRightStyle = value;
break;
case BORDER_BOTTOM_STYLE:
renderStyle.borderBottomStyle = value;
break;
case BORDER_LEFT_COLOR:
renderStyle.borderLeftColor = value;
break;