wrap.dart 28.1 KB
Newer Older
Ian Hickson's avatar
Ian Hickson committed
1
// Copyright 2014 The Flutter Authors. All rights reserved.
Adam Barth's avatar
Adam Barth committed
2 3 4 5 6 7
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

import 'dart:math' as math;

import 'box.dart';
8
import 'layer.dart';
9
import 'layout_helper.dart';
Adam Barth's avatar
Adam Barth committed
10 11 12 13 14 15 16 17
import 'object.dart';

/// How [Wrap] should align objects.
///
/// Used both to align children within a run in the main axis as well as to
/// align the runs themselves in the cross axis.
enum WrapAlignment {
  /// Place the objects as close to the start of the axis as possible.
18 19 20 21 22 23
  ///
  /// If this value is used in a horizontal direction, a [TextDirection] must be
  /// available to determine if the start is the left or the right.
  ///
  /// If this value is used in a vertical direction, a [VerticalDirection] must be
  /// available to determine if the start is the top or the bottom.
Adam Barth's avatar
Adam Barth committed
24 25 26
  start,

  /// Place the objects as close to the end of the axis as possible.
27 28 29 30 31 32
  ///
  /// If this value is used in a horizontal direction, a [TextDirection] must be
  /// available to determine if the end is the left or the right.
  ///
  /// If this value is used in a vertical direction, a [VerticalDirection] must be
  /// available to determine if the end is the top or the bottom.
Adam Barth's avatar
Adam Barth committed
33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53
  end,

  /// Place the objects as close to the middle of the axis as possible.
  center,

  /// Place the free space evenly between the objects.
  spaceBetween,

  /// Place the free space evenly between the objects as well as half of that
  /// space before and after the first and last objects.
  spaceAround,

  /// Place the free space evenly between the objects as well as before and
  /// after the first and last objects.
  spaceEvenly,
}

/// Who [Wrap] should align children within a run in the cross axis.
enum WrapCrossAlignment {
  /// Place the children as close to the start of the run in the cross axis as
  /// possible.
54 55 56 57 58 59
  ///
  /// If this value is used in a horizontal direction, a [TextDirection] must be
  /// available to determine if the start is the left or the right.
  ///
  /// If this value is used in a vertical direction, a [VerticalDirection] must be
  /// available to determine if the start is the top or the bottom.
Adam Barth's avatar
Adam Barth committed
60 61 62 63
  start,

  /// Place the children as close to the end of the run in the cross axis as
  /// possible.
64 65 66 67 68 69
  ///
  /// If this value is used in a horizontal direction, a [TextDirection] must be
  /// available to determine if the end is the left or the right.
  ///
  /// If this value is used in a vertical direction, a [VerticalDirection] must be
  /// available to determine if the end is the top or the bottom.
Adam Barth's avatar
Adam Barth committed
70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87
  end,

  /// Place the children as close to the middle of the run in the cross axis as
  /// possible.
  center,

  // TODO(ianh): baseline.
}

class _RunMetrics {
  _RunMetrics(this.mainAxisExtent, this.crossAxisExtent, this.childCount);

  final double mainAxisExtent;
  final double crossAxisExtent;
  final int childCount;
}

/// Parent data for use with [RenderWrap].
88
class WrapParentData extends ContainerBoxParentData<RenderBox> {
Adam Barth's avatar
Adam Barth committed
89 90 91
  int _runIndex = 0;
}

92 93 94 95 96 97 98 99 100 101 102 103 104 105
/// Displays its children in multiple horizontal or vertical runs.
///
/// A [RenderWrap] lays out each child and attempts to place the child adjacent
/// to the previous child in the main axis, given by [direction], leaving
/// [spacing] space in between. If there is not enough space to fit the child,
/// [RenderWrap] creates a new _run_ adjacent to the existing children in the
/// cross axis.
///
/// After all the children have been allocated to runs, the children within the
/// runs are positioned according to the [alignment] in the main axis and
/// according to the [crossAxisAlignment] in the cross axis.
///
/// The runs themselves are then positioned in the cross axis according to the
/// [runSpacing] and [runAlignment].
106 107 108
class RenderWrap extends RenderBox
    with ContainerRenderObjectMixin<RenderBox, WrapParentData>,
         RenderBoxContainerDefaultsMixin<RenderBox, WrapParentData> {
109 110 111 112
  /// Creates a wrap render object.
  ///
  /// By default, the wrap layout is horizontal and both the children and the
  /// runs are aligned to the start.
Adam Barth's avatar
Adam Barth committed
113
  RenderWrap({
114
    List<RenderBox>? children,
115 116 117 118 119 120
    Axis direction = Axis.horizontal,
    WrapAlignment alignment = WrapAlignment.start,
    double spacing = 0.0,
    WrapAlignment runAlignment = WrapAlignment.start,
    double runSpacing = 0.0,
    WrapCrossAlignment crossAxisAlignment = WrapCrossAlignment.start,
121
    TextDirection? textDirection,
122
    VerticalDirection verticalDirection = VerticalDirection.down,
123
    Clip clipBehavior = Clip.none,
124
  }) : _direction = direction,
Adam Barth's avatar
Adam Barth committed
125 126 127 128
       _alignment = alignment,
       _spacing = spacing,
       _runAlignment = runAlignment,
       _runSpacing = runSpacing,
129 130
       _crossAxisAlignment = crossAxisAlignment,
       _textDirection = textDirection,
131 132
       _verticalDirection = verticalDirection,
       _clipBehavior = clipBehavior {
Adam Barth's avatar
Adam Barth committed
133 134 135 136 137 138 139 140 141 142 143 144
    addAll(children);
  }

  /// The direction to use as the main axis.
  ///
  /// For example, if [direction] is [Axis.horizontal], the default, the
  /// children are placed adjacent to one another in a horizontal run until the
  /// available horizontal space is consumed, at which point a subsequent
  /// children are placed in a new run vertically adjacent to the previous run.
  Axis get direction => _direction;
  Axis _direction;
  set direction (Axis value) {
145
    if (_direction == value) {
Adam Barth's avatar
Adam Barth committed
146
      return;
147
    }
Adam Barth's avatar
Adam Barth committed
148 149 150 151
    _direction = value;
    markNeedsLayout();
  }

152
  /// How the children within a run should be placed in the main axis.
Adam Barth's avatar
Adam Barth committed
153 154
  ///
  /// For example, if [alignment] is [WrapAlignment.center], the children in
155
  /// each run are grouped together in the center of their run in the main axis.
Adam Barth's avatar
Adam Barth committed
156 157 158 159 160 161 162 163 164 165 166 167
  ///
  /// Defaults to [WrapAlignment.start].
  ///
  /// See also:
  ///
  ///  * [runAlignment], which controls how the runs are placed relative to each
  ///    other in the cross axis.
  ///  * [crossAxisAlignment], which controls how the children within each run
  ///    are placed relative to each other in the cross axis.
  WrapAlignment get alignment => _alignment;
  WrapAlignment _alignment;
  set alignment (WrapAlignment value) {
168
    if (_alignment == value) {
Adam Barth's avatar
Adam Barth committed
169
      return;
170
    }
Adam Barth's avatar
Adam Barth committed
171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188
    _alignment = value;
    markNeedsLayout();
  }

  /// How much space to place between children in a run in the main axis.
  ///
  /// For example, if [spacing] is 10.0, the children will be spaced at least
  /// 10.0 logical pixels apart in the main axis.
  ///
  /// If there is additional free space in a run (e.g., because the wrap has a
  /// minimum size that is not filled or because some runs are longer than
  /// others), the additional free space will be allocated according to the
  /// [alignment].
  ///
  /// Defaults to 0.0.
  double get spacing => _spacing;
  double _spacing;
  set spacing (double value) {
189
    if (_spacing == value) {
Adam Barth's avatar
Adam Barth committed
190
      return;
191
    }
Adam Barth's avatar
Adam Barth committed
192 193 194 195 196 197 198
    _spacing = value;
    markNeedsLayout();
  }

  /// How the runs themselves should be placed in the cross axis.
  ///
  /// For example, if [runAlignment] is [WrapAlignment.center], the runs are
199
  /// grouped together in the center of the overall [RenderWrap] in the cross
Adam Barth's avatar
Adam Barth committed
200 201 202 203 204 205 206 207 208 209 210 211 212
  /// axis.
  ///
  /// Defaults to [WrapAlignment.start].
  ///
  /// See also:
  ///
  ///  * [alignment], which controls how the children within each run are placed
  ///    relative to each other in the main axis.
  ///  * [crossAxisAlignment], which controls how the children within each run
  ///    are placed relative to each other in the cross axis.
  WrapAlignment get runAlignment => _runAlignment;
  WrapAlignment _runAlignment;
  set runAlignment (WrapAlignment value) {
213
    if (_runAlignment == value) {
Adam Barth's avatar
Adam Barth committed
214
      return;
215
    }
Adam Barth's avatar
Adam Barth committed
216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232
    _runAlignment = value;
    markNeedsLayout();
  }

  /// How much space to place between the runs themselves in the cross axis.
  ///
  /// For example, if [runSpacing] is 10.0, the runs will be spaced at least
  /// 10.0 logical pixels apart in the cross axis.
  ///
  /// If there is additional free space in the overall [RenderWrap] (e.g.,
  /// because the wrap has a minimum size that is not filled), the additional
  /// free space will be allocated according to the [runAlignment].
  ///
  /// Defaults to 0.0.
  double get runSpacing => _runSpacing;
  double _runSpacing;
  set runSpacing (double value) {
233
    if (_runSpacing == value) {
Adam Barth's avatar
Adam Barth committed
234
      return;
235
    }
Adam Barth's avatar
Adam Barth committed
236 237 238 239 240 241 242 243
    _runSpacing = value;
    markNeedsLayout();
  }

  /// How the children within a run should be aligned relative to each other in
  /// the cross axis.
  ///
  /// For example, if this is set to [WrapCrossAlignment.end], and the
244
  /// [direction] is [Axis.horizontal], then the children within each
Adam Barth's avatar
Adam Barth committed
245 246 247 248 249 250 251 252 253 254 255 256 257
  /// run will have their bottom edges aligned to the bottom edge of the run.
  ///
  /// Defaults to [WrapCrossAlignment.start].
  ///
  /// See also:
  ///
  ///  * [alignment], which controls how the children within each run are placed
  ///    relative to each other in the main axis.
  ///  * [runAlignment], which controls how the runs are placed relative to each
  ///    other in the cross axis.
  WrapCrossAlignment get crossAxisAlignment => _crossAxisAlignment;
  WrapCrossAlignment _crossAxisAlignment;
  set crossAxisAlignment (WrapCrossAlignment value) {
258
    if (_crossAxisAlignment == value) {
Adam Barth's avatar
Adam Barth committed
259
      return;
260
    }
Adam Barth's avatar
Adam Barth committed
261 262 263 264
    _crossAxisAlignment = value;
    markNeedsLayout();
  }

265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287
  /// Determines the order to lay children out horizontally and how to interpret
  /// `start` and `end` in the horizontal direction.
  ///
  /// If the [direction] is [Axis.horizontal], this controls the order in which
  /// children are positioned (left-to-right or right-to-left), and the meaning
  /// of the [alignment] property's [WrapAlignment.start] and
  /// [WrapAlignment.end] values.
  ///
  /// If the [direction] is [Axis.horizontal], and either the
  /// [alignment] is either [WrapAlignment.start] or [WrapAlignment.end], or
  /// there's more than one child, then the [textDirection] must not be null.
  ///
  /// If the [direction] is [Axis.vertical], this controls the order in
  /// which runs are positioned, the meaning of the [runAlignment] property's
  /// [WrapAlignment.start] and [WrapAlignment.end] values, as well as the
  /// [crossAxisAlignment] property's [WrapCrossAlignment.start] and
  /// [WrapCrossAlignment.end] values.
  ///
  /// If the [direction] is [Axis.vertical], and either the
  /// [runAlignment] is either [WrapAlignment.start] or [WrapAlignment.end], the
  /// [crossAxisAlignment] is either [WrapCrossAlignment.start] or
  /// [WrapCrossAlignment.end], or there's more than one child, then the
  /// [textDirection] must not be null.
288 289 290
  TextDirection? get textDirection => _textDirection;
  TextDirection? _textDirection;
  set textDirection(TextDirection? value) {
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
    if (_textDirection != value) {
      _textDirection = value;
      markNeedsLayout();
    }
  }

  /// Determines the order to lay children out vertically and how to interpret
  /// `start` and `end` in the vertical direction.
  ///
  /// If the [direction] is [Axis.vertical], this controls which order children
  /// are painted in (down or up), the meaning of the [alignment] property's
  /// [WrapAlignment.start] and [WrapAlignment.end] values.
  ///
  /// If the [direction] is [Axis.vertical], and either the [alignment]
  /// is either [WrapAlignment.start] or [WrapAlignment.end], or there's
  /// more than one child, then the [verticalDirection] must not be null.
  ///
  /// If the [direction] is [Axis.horizontal], this controls the order in which
  /// runs are positioned, the meaning of the [runAlignment] property's
  /// [WrapAlignment.start] and [WrapAlignment.end] values, as well as the
  /// [crossAxisAlignment] property's [WrapCrossAlignment.start] and
  /// [WrapCrossAlignment.end] values.
  ///
  /// If the [direction] is [Axis.horizontal], and either the
  /// [runAlignment] is either [WrapAlignment.start] or [WrapAlignment.end], the
  /// [crossAxisAlignment] is either [WrapCrossAlignment.start] or
  /// [WrapCrossAlignment.end], or there's more than one child, then the
  /// [verticalDirection] must not be null.
  VerticalDirection get verticalDirection => _verticalDirection;
  VerticalDirection _verticalDirection;
  set verticalDirection(VerticalDirection value) {
    if (_verticalDirection != value) {
      _verticalDirection = value;
      markNeedsLayout();
    }
  }

328
  /// {@macro flutter.material.Material.clipBehavior}
329 330 331 332 333 334 335 336 337 338 339 340
  ///
  /// Defaults to [Clip.none], and must not be null.
  Clip get clipBehavior => _clipBehavior;
  Clip _clipBehavior = Clip.none;
  set clipBehavior(Clip value) {
    if (value != _clipBehavior) {
      _clipBehavior = value;
      markNeedsPaint();
      markNeedsSemanticsUpdate();
    }
  }

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
  bool get _debugHasNecessaryDirections {
    if (firstChild != null && lastChild != firstChild) {
      // i.e. there's more than one child
      switch (direction) {
        case Axis.horizontal:
          assert(textDirection != null, 'Horizontal $runtimeType with multiple children has a null textDirection, so the layout order is undefined.');
          break;
        case Axis.vertical:
          break;
      }
    }
    if (alignment == WrapAlignment.start || alignment == WrapAlignment.end) {
      switch (direction) {
        case Axis.horizontal:
          assert(textDirection != null, 'Horizontal $runtimeType with alignment $alignment has a null textDirection, so the alignment cannot be resolved.');
          break;
        case Axis.vertical:
          break;
      }
    }
    if (runAlignment == WrapAlignment.start || runAlignment == WrapAlignment.end) {
      switch (direction) {
        case Axis.horizontal:
          break;
        case Axis.vertical:
          assert(textDirection != null, 'Vertical $runtimeType with runAlignment $runAlignment has a null textDirection, so the alignment cannot be resolved.');
          break;
      }
    }
    if (crossAxisAlignment == WrapCrossAlignment.start || crossAxisAlignment == WrapCrossAlignment.end) {
      switch (direction) {
        case Axis.horizontal:
          break;
        case Axis.vertical:
          assert(textDirection != null, 'Vertical $runtimeType with crossAxisAlignment $crossAxisAlignment has a null textDirection, so the alignment cannot be resolved.');
          break;
      }
    }
    return true;
  }

Adam Barth's avatar
Adam Barth committed
382 383
  @override
  void setupParentData(RenderBox child) {
384
    if (child.parentData is! WrapParentData) {
385
      child.parentData = WrapParentData();
386
    }
Adam Barth's avatar
Adam Barth committed
387 388 389 390 391 392 393
  }

  @override
  double computeMinIntrinsicWidth(double height) {
    switch (direction) {
      case Axis.horizontal:
        double width = 0.0;
394
        RenderBox? child = firstChild;
Adam Barth's avatar
Adam Barth committed
395
        while (child != null) {
396
          width = math.max(width, child.getMinIntrinsicWidth(double.infinity));
Adam Barth's avatar
Adam Barth committed
397 398 399 400
          child = childAfter(child);
        }
        return width;
      case Axis.vertical:
401
        return computeDryLayout(BoxConstraints(maxHeight: height)).width;
Adam Barth's avatar
Adam Barth committed
402 403 404 405 406 407 408
    }
  }

  @override
  double computeMaxIntrinsicWidth(double height) {
    switch (direction) {
      case Axis.horizontal:
409
        double width = 0.0;
410
        RenderBox? child = firstChild;
Adam Barth's avatar
Adam Barth committed
411
        while (child != null) {
412
          width += child.getMaxIntrinsicWidth(double.infinity);
Adam Barth's avatar
Adam Barth committed
413 414 415 416
          child = childAfter(child);
        }
        return width;
      case Axis.vertical:
417
        return computeDryLayout(BoxConstraints(maxHeight: height)).width;
Adam Barth's avatar
Adam Barth committed
418 419 420 421 422 423 424
    }
  }

  @override
  double computeMinIntrinsicHeight(double width) {
    switch (direction) {
      case Axis.horizontal:
425
        return computeDryLayout(BoxConstraints(maxWidth: width)).height;
Adam Barth's avatar
Adam Barth committed
426 427
      case Axis.vertical:
        double height = 0.0;
428
        RenderBox? child = firstChild;
Adam Barth's avatar
Adam Barth committed
429
        while (child != null) {
430
          height = math.max(height, child.getMinIntrinsicHeight(double.infinity));
Adam Barth's avatar
Adam Barth committed
431 432 433 434 435 436 437 438 439 440
          child = childAfter(child);
        }
        return height;
    }
  }

  @override
  double computeMaxIntrinsicHeight(double width) {
    switch (direction) {
      case Axis.horizontal:
441
        return computeDryLayout(BoxConstraints(maxWidth: width)).height;
Adam Barth's avatar
Adam Barth committed
442
      case Axis.vertical:
443
        double height = 0.0;
444
        RenderBox? child = firstChild;
Adam Barth's avatar
Adam Barth committed
445
        while (child != null) {
446
          height += child.getMaxIntrinsicHeight(double.infinity);
Adam Barth's avatar
Adam Barth committed
447 448 449 450 451 452 453
          child = childAfter(child);
        }
        return height;
    }
  }

  @override
454
  double? computeDistanceToActualBaseline(TextBaseline baseline) {
Adam Barth's avatar
Adam Barth committed
455 456 457
    return defaultComputeDistanceToHighestActualBaseline(baseline);
  }

458
  double _getMainAxisExtent(Size childSize) {
Adam Barth's avatar
Adam Barth committed
459 460
    switch (direction) {
      case Axis.horizontal:
461
        return childSize.width;
Adam Barth's avatar
Adam Barth committed
462
      case Axis.vertical:
463
        return childSize.height;
Adam Barth's avatar
Adam Barth committed
464 465 466
    }
  }

467
  double _getCrossAxisExtent(Size childSize) {
Adam Barth's avatar
Adam Barth committed
468 469
    switch (direction) {
      case Axis.horizontal:
470
        return childSize.height;
Adam Barth's avatar
Adam Barth committed
471
      case Axis.vertical:
472
        return childSize.width;
Adam Barth's avatar
Adam Barth committed
473 474 475 476 477 478
    }
  }

  Offset _getOffset(double mainAxisOffset, double crossAxisOffset) {
    switch (direction) {
      case Axis.horizontal:
479
        return Offset(mainAxisOffset, crossAxisOffset);
Adam Barth's avatar
Adam Barth committed
480
      case Axis.vertical:
481
        return Offset(crossAxisOffset, mainAxisOffset);
Adam Barth's avatar
Adam Barth committed
482 483 484
    }
  }

485 486
  double _getChildCrossAxisOffset(bool flipCrossAxis, double runCrossAxisExtent, double childCrossAxisExtent) {
    final double freeSpace = runCrossAxisExtent - childCrossAxisExtent;
Adam Barth's avatar
Adam Barth committed
487 488
    switch (crossAxisAlignment) {
      case WrapCrossAlignment.start:
489
        return flipCrossAxis ? freeSpace : 0.0;
Adam Barth's avatar
Adam Barth committed
490
      case WrapCrossAlignment.end:
491 492 493
        return flipCrossAxis ? 0.0 : freeSpace;
      case WrapCrossAlignment.center:
        return freeSpace / 2.0;
Adam Barth's avatar
Adam Barth committed
494 495 496 497 498
    }
  }

  bool _hasVisualOverflow = false;

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
  @override
  Size computeDryLayout(BoxConstraints constraints) {
    return _computeDryLayout(constraints);
  }

  Size _computeDryLayout(BoxConstraints constraints, [ChildLayouter layoutChild = ChildLayoutHelper.dryLayoutChild]) {
    final BoxConstraints childConstraints;
    double mainAxisLimit = 0.0;
    switch (direction) {
      case Axis.horizontal:
        childConstraints = BoxConstraints(maxWidth: constraints.maxWidth);
        mainAxisLimit = constraints.maxWidth;
        break;
      case Axis.vertical:
        childConstraints = BoxConstraints(maxHeight: constraints.maxHeight);
        mainAxisLimit = constraints.maxHeight;
        break;
    }

    double mainAxisExtent = 0.0;
    double crossAxisExtent = 0.0;
    double runMainAxisExtent = 0.0;
    double runCrossAxisExtent = 0.0;
    int childCount = 0;
    RenderBox? child = firstChild;
    while (child != null) {
      final Size childSize = layoutChild(child, childConstraints);
      final double childMainAxisExtent = _getMainAxisExtent(childSize);
      final double childCrossAxisExtent = _getCrossAxisExtent(childSize);
      // There must be at least one child before we move on to the next run.
      if (childCount > 0 && runMainAxisExtent + childMainAxisExtent + spacing > mainAxisLimit) {
        mainAxisExtent = math.max(mainAxisExtent, runMainAxisExtent);
        crossAxisExtent += runCrossAxisExtent + runSpacing;
        runMainAxisExtent = 0.0;
        runCrossAxisExtent = 0.0;
        childCount = 0;
      }
      runMainAxisExtent += childMainAxisExtent;
      runCrossAxisExtent = math.max(runCrossAxisExtent, childCrossAxisExtent);
538
      if (childCount > 0) {
539
        runMainAxisExtent += spacing;
540
      }
541 542 543 544 545 546 547 548 549 550 551 552 553 554
      childCount += 1;
      child = childAfter(child);
    }
    crossAxisExtent += runCrossAxisExtent;
    mainAxisExtent = math.max(mainAxisExtent, runMainAxisExtent);

    switch (direction) {
      case Axis.horizontal:
        return constraints.constrain(Size(mainAxisExtent, crossAxisExtent));
      case Axis.vertical:
        return constraints.constrain(Size(crossAxisExtent, mainAxisExtent));
    }
  }

Adam Barth's avatar
Adam Barth committed
555 556
  @override
  void performLayout() {
557
    final BoxConstraints constraints = this.constraints;
558
    assert(_debugHasNecessaryDirections);
Adam Barth's avatar
Adam Barth committed
559
    _hasVisualOverflow = false;
560
    RenderBox? child = firstChild;
Adam Barth's avatar
Adam Barth committed
561 562 563 564
    if (child == null) {
      size = constraints.smallest;
      return;
    }
565
    final BoxConstraints childConstraints;
Adam Barth's avatar
Adam Barth committed
566
    double mainAxisLimit = 0.0;
567 568
    bool flipMainAxis = false;
    bool flipCrossAxis = false;
Adam Barth's avatar
Adam Barth committed
569 570
    switch (direction) {
      case Axis.horizontal:
571
        childConstraints = BoxConstraints(maxWidth: constraints.maxWidth);
Adam Barth's avatar
Adam Barth committed
572
        mainAxisLimit = constraints.maxWidth;
573
        if (textDirection == TextDirection.rtl) {
574
          flipMainAxis = true;
575 576
        }
        if (verticalDirection == VerticalDirection.up) {
577
          flipCrossAxis = true;
578
        }
Adam Barth's avatar
Adam Barth committed
579 580
        break;
      case Axis.vertical:
581
        childConstraints = BoxConstraints(maxHeight: constraints.maxHeight);
Adam Barth's avatar
Adam Barth committed
582
        mainAxisLimit = constraints.maxHeight;
583
        if (verticalDirection == VerticalDirection.up) {
584
          flipMainAxis = true;
585 586
        }
        if (textDirection == TextDirection.rtl) {
587
          flipCrossAxis = true;
588
        }
Adam Barth's avatar
Adam Barth committed
589 590
        break;
    }
591 592
    final double spacing = this.spacing;
    final double runSpacing = this.runSpacing;
Adam Barth's avatar
Adam Barth committed
593 594 595 596 597 598 599 600
    final List<_RunMetrics> runMetrics = <_RunMetrics>[];
    double mainAxisExtent = 0.0;
    double crossAxisExtent = 0.0;
    double runMainAxisExtent = 0.0;
    double runCrossAxisExtent = 0.0;
    int childCount = 0;
    while (child != null) {
      child.layout(childConstraints, parentUsesSize: true);
601 602
      final double childMainAxisExtent = _getMainAxisExtent(child.size);
      final double childCrossAxisExtent = _getCrossAxisExtent(child.size);
603
      if (childCount > 0 && runMainAxisExtent + spacing + childMainAxisExtent > mainAxisLimit) {
Adam Barth's avatar
Adam Barth committed
604 605
        mainAxisExtent = math.max(mainAxisExtent, runMainAxisExtent);
        crossAxisExtent += runCrossAxisExtent;
606
        if (runMetrics.isNotEmpty) {
Adam Barth's avatar
Adam Barth committed
607
          crossAxisExtent += runSpacing;
608
        }
609
        runMetrics.add(_RunMetrics(runMainAxisExtent, runCrossAxisExtent, childCount));
Adam Barth's avatar
Adam Barth committed
610 611 612 613 614
        runMainAxisExtent = 0.0;
        runCrossAxisExtent = 0.0;
        childCount = 0;
      }
      runMainAxisExtent += childMainAxisExtent;
615
      if (childCount > 0) {
Adam Barth's avatar
Adam Barth committed
616
        runMainAxisExtent += spacing;
617
      }
Adam Barth's avatar
Adam Barth committed
618 619
      runCrossAxisExtent = math.max(runCrossAxisExtent, childCrossAxisExtent);
      childCount += 1;
620
      final WrapParentData childParentData = child.parentData! as WrapParentData;
Adam Barth's avatar
Adam Barth committed
621 622 623 624 625
      childParentData._runIndex = runMetrics.length;
      child = childParentData.nextSibling;
    }
    if (childCount > 0) {
      mainAxisExtent = math.max(mainAxisExtent, runMainAxisExtent);
626
      crossAxisExtent += runCrossAxisExtent;
627
      if (runMetrics.isNotEmpty) {
628
        crossAxisExtent += runSpacing;
629
      }
630
      runMetrics.add(_RunMetrics(runMainAxisExtent, runCrossAxisExtent, childCount));
Adam Barth's avatar
Adam Barth committed
631 632 633 634 635 636 637 638 639 640
    }

    final int runCount = runMetrics.length;
    assert(runCount > 0);

    double containerMainAxisExtent = 0.0;
    double containerCrossAxisExtent = 0.0;

    switch (direction) {
      case Axis.horizontal:
641
        size = constraints.constrain(Size(mainAxisExtent, crossAxisExtent));
Adam Barth's avatar
Adam Barth committed
642 643 644 645
        containerMainAxisExtent = size.width;
        containerCrossAxisExtent = size.height;
        break;
      case Axis.vertical:
646
        size = constraints.constrain(Size(crossAxisExtent, mainAxisExtent));
Adam Barth's avatar
Adam Barth committed
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
        containerMainAxisExtent = size.height;
        containerCrossAxisExtent = size.width;
        break;
    }

    _hasVisualOverflow = containerMainAxisExtent < mainAxisExtent || containerCrossAxisExtent < crossAxisExtent;

    final double crossAxisFreeSpace = math.max(0.0, containerCrossAxisExtent - crossAxisExtent);
    double runLeadingSpace = 0.0;
    double runBetweenSpace = 0.0;
    switch (runAlignment) {
      case WrapAlignment.start:
        break;
      case WrapAlignment.end:
        runLeadingSpace = crossAxisFreeSpace;
        break;
      case WrapAlignment.center:
        runLeadingSpace = crossAxisFreeSpace / 2.0;
        break;
      case WrapAlignment.spaceBetween:
        runBetweenSpace = runCount > 1 ? crossAxisFreeSpace / (runCount - 1) : 0.0;
        break;
      case WrapAlignment.spaceAround:
        runBetweenSpace = crossAxisFreeSpace / runCount;
        runLeadingSpace = runBetweenSpace / 2.0;
        break;
      case WrapAlignment.spaceEvenly:
        runBetweenSpace = crossAxisFreeSpace / (runCount + 1);
        runLeadingSpace = runBetweenSpace;
        break;
    }

679 680 681
    runBetweenSpace += runSpacing;
    double crossAxisOffset = flipCrossAxis ? containerCrossAxisExtent - runLeadingSpace : runLeadingSpace;

Adam Barth's avatar
Adam Barth committed
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
    child = firstChild;
    for (int i = 0; i < runCount; ++i) {
      final _RunMetrics metrics = runMetrics[i];
      final double runMainAxisExtent = metrics.mainAxisExtent;
      final double runCrossAxisExtent = metrics.crossAxisExtent;
      final int childCount = metrics.childCount;

      final double mainAxisFreeSpace = math.max(0.0, containerMainAxisExtent - runMainAxisExtent);
      double childLeadingSpace = 0.0;
      double childBetweenSpace = 0.0;

      switch (alignment) {
        case WrapAlignment.start:
          break;
        case WrapAlignment.end:
          childLeadingSpace = mainAxisFreeSpace;
          break;
        case WrapAlignment.center:
          childLeadingSpace = mainAxisFreeSpace / 2.0;
          break;
        case WrapAlignment.spaceBetween:
          childBetweenSpace = childCount > 1 ? mainAxisFreeSpace / (childCount - 1) : 0.0;
          break;
        case WrapAlignment.spaceAround:
          childBetweenSpace = mainAxisFreeSpace / childCount;
          childLeadingSpace = childBetweenSpace / 2.0;
          break;
        case WrapAlignment.spaceEvenly:
          childBetweenSpace = mainAxisFreeSpace / (childCount + 1);
          childLeadingSpace = childBetweenSpace;
          break;
      }

715 716 717
      childBetweenSpace += spacing;
      double childMainPosition = flipMainAxis ? containerMainAxisExtent - childLeadingSpace : childLeadingSpace;

718
      if (flipCrossAxis) {
719
        crossAxisOffset -= runCrossAxisExtent;
720
      }
721

Adam Barth's avatar
Adam Barth committed
722
      while (child != null) {
723
        final WrapParentData childParentData = child.parentData! as WrapParentData;
724
        if (childParentData._runIndex != i) {
Adam Barth's avatar
Adam Barth committed
725
          break;
726
        }
727 728
        final double childMainAxisExtent = _getMainAxisExtent(child.size);
        final double childCrossAxisExtent = _getCrossAxisExtent(child.size);
729
        final double childCrossAxisOffset = _getChildCrossAxisOffset(flipCrossAxis, runCrossAxisExtent, childCrossAxisExtent);
730
        if (flipMainAxis) {
731
          childMainPosition -= childMainAxisExtent;
732
        }
733
        childParentData.offset = _getOffset(childMainPosition, crossAxisOffset + childCrossAxisOffset);
734
        if (flipMainAxis) {
735
          childMainPosition -= childBetweenSpace;
736
        } else {
737
          childMainPosition += childMainAxisExtent + childBetweenSpace;
738
        }
Adam Barth's avatar
Adam Barth committed
739 740 741
        child = childParentData.nextSibling;
      }

742
      if (flipCrossAxis) {
743
        crossAxisOffset -= runBetweenSpace;
744
      } else {
745
        crossAxisOffset += runCrossAxisExtent + runBetweenSpace;
746
      }
Adam Barth's avatar
Adam Barth committed
747 748 749 750
    }
  }

  @override
751
  bool hitTestChildren(BoxHitTestResult result, { required Offset position }) {
Adam Barth's avatar
Adam Barth committed
752 753 754 755 756 757 758
    return defaultHitTestChildren(result, position: position);
  }

  @override
  void paint(PaintingContext context, Offset offset) {
    // TODO(ianh): move the debug flex overflow paint logic somewhere common so
    // it can be reused here
759
    if (_hasVisualOverflow && clipBehavior != Clip.none) {
760
      _clipRectLayer.layer = context.pushClipRect(
761 762 763 764 765
        needsCompositing,
        offset,
        Offset.zero & size,
        defaultPaint,
        clipBehavior: clipBehavior,
766
        oldLayer: _clipRectLayer.layer,
767
      );
768
    } else {
769
      _clipRectLayer.layer = null;
Adam Barth's avatar
Adam Barth committed
770
      defaultPaint(context, offset);
771
    }
Adam Barth's avatar
Adam Barth committed
772 773
  }

774 775 776 777 778 779 780
  final LayerHandle<ClipRectLayer> _clipRectLayer = LayerHandle<ClipRectLayer>();

  @override
  void dispose() {
    _clipRectLayer.layer = null;
    super.dispose();
  }
781

Adam Barth's avatar
Adam Barth committed
782
  @override
783 784
  void debugFillProperties(DiagnosticPropertiesBuilder properties) {
    super.debugFillProperties(properties);
785 786 787 788 789 790 791 792
    properties.add(EnumProperty<Axis>('direction', direction));
    properties.add(EnumProperty<WrapAlignment>('alignment', alignment));
    properties.add(DoubleProperty('spacing', spacing));
    properties.add(EnumProperty<WrapAlignment>('runAlignment', runAlignment));
    properties.add(DoubleProperty('runSpacing', runSpacing));
    properties.add(DoubleProperty('crossAxisAlignment', runSpacing));
    properties.add(EnumProperty<TextDirection>('textDirection', textDirection, defaultValue: null));
    properties.add(EnumProperty<VerticalDirection>('verticalDirection', verticalDirection, defaultValue: VerticalDirection.down));
Adam Barth's avatar
Adam Barth committed
793 794
  }
}