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

5

Ian Hickson's avatar
Ian Hickson committed
6 7
import 'package:flutter/foundation.dart';

8 9 10 11 12
import 'basic_types.dart';
import 'border_radius.dart';
import 'borders.dart';
import 'edge_insets.dart';

13 14 15
// Examples can assume:
// BuildContext context;

16
/// The shape to use when rendering a [Border] or [BoxDecoration].
17 18 19 20 21
///
/// Consider using [ShapeBorder] subclasses directly (with [ShapeDecoration]),
/// instead of using [BoxShape] and [Border], if the shapes will need to be
/// interpolated or animated. The [Border] class cannot interpolate between
/// different shapes.
22 23 24 25
enum BoxShape {
  /// An axis-aligned, 2D rectangle. May have rounded corners (described by a
  /// [BorderRadius]). The edges of the rectangle will match the edges of the box
  /// into which the [Border] or [BoxDecoration] is painted.
26 27 28 29
  ///
  /// See also:
  ///
  ///  * [RoundedRectangleBorder], the equivalent [ShapeBorder].
30 31 32 33 34 35
  rectangle,

  /// A circle centered in the middle of the box into which the [Border] or
  /// [BoxDecoration] is painted. The diameter of the circle is the shortest
  /// dimension of the box, either the width or the height, such that the circle
  /// touches the edges of the box.
36 37 38 39
  ///
  /// See also:
  ///
  ///  * [CircleBorder], the equivalent [ShapeBorder].
40
  circle,
41 42

  // Don't add more, instead create a new ShapeBorder.
43 44
}

45
/// Base class for box borders that can paint as rectangles, circles, or rounded
Ian Hickson's avatar
Ian Hickson committed
46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65
/// rectangles.
///
/// This class is extended by [Border] and [BorderDirectional] to provide
/// concrete versions of four-sided borders using different conventions for
/// specifying the sides.
///
/// The only API difference that this class introduces over [ShapeBorder] is
/// that its [paint] method takes additional arguments.
///
/// See also:
///
///  * [BorderSide], which is used to describe each side of the box.
///  * [RoundedRectangleBorder], another way of describing a box's border.
///  * [CircleBorder], another way of describing a circle border.
///  * [BoxDecoration], which uses a [BoxBorder] to describe its borders.
abstract class BoxBorder extends ShapeBorder {
  /// Abstract const constructor. This constructor enables subclasses to provide
  /// const constructors so that they can be used in const expressions.
  const BoxBorder();

66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83
  /// The top side of this border.
  ///
  /// This getter is available on both [Border] and [BorderDirectional]. If
  /// [isUniform] is true, then this is the same style as all the other sides.
  BorderSide get top;

  /// The bottom side of this border.
  BorderSide get bottom;

  /// Whether all four sides of the border are identical. Uniform borders are
  /// typically more efficient to paint.
  ///
  /// A uniform border by definition has no text direction dependency and
  /// therefore could be expressed as a [Border], even if it is currently a
  /// [BorderDirectional]. A uniform border can also be expressed as a
  /// [RoundedRectangleBorder].
  bool get isUniform;

Ian Hickson's avatar
Ian Hickson committed
84
  // We override this to tighten the return value, so that callers can assume
85
  // that we'll return a [BoxBorder].
Ian Hickson's avatar
Ian Hickson committed
86
  @override
87
  BoxBorder? add(ShapeBorder other, { bool reversed = false }) => null;
Ian Hickson's avatar
Ian Hickson committed
88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103

  /// Linearly interpolate between two borders.
  ///
  /// If a border is null, it is treated as having four [BorderSide.none]
  /// borders.
  ///
  /// This supports interpolating between [Border] and [BorderDirectional]
  /// objects. If both objects are different types but both have sides on one or
  /// both of their lateral edges (the two sides that aren't the top and bottom)
  /// other than [BorderSide.none], then the sides are interpolated by reducing
  /// `a`'s lateral edges to [BorderSide.none] over the first half of the
  /// animation, and then bringing `b`'s lateral edges _from_ [BorderSide.none]
  /// over the second half of the animation.
  ///
  /// For a more flexible approach, consider [ShapeBorder.lerp], which would
  /// instead [add] the two sets of sides and interpolate them simultaneously.
104
  ///
105
  /// {@macro dart.ui.shadow.lerp}
106
  static BoxBorder? lerp(BoxBorder? a, BoxBorder? b, double t) {
107
    assert(t != null);
108 109 110 111
    if ((a is Border?) && (b is Border?))
      return Border.lerp(a, b, t);
    if ((a is BorderDirectional?) && (b is BorderDirectional?))
      return BorderDirectional.lerp(a, b, t);
Ian Hickson's avatar
Ian Hickson committed
112 113 114 115 116 117 118 119 120 121
    if (b is Border && a is BorderDirectional) {
      final BoxBorder c = b;
      b = a;
      a = c;
      t = 1.0 - t;
      // fall through to next case
    }
    if (a is Border && b is BorderDirectional) {
      if (b.start == BorderSide.none && b.end == BorderSide.none) {
        // The fact that b is a BorderDirectional really doesn't matter, it turns out.
122
        return Border(
Ian Hickson's avatar
Ian Hickson committed
123 124 125 126 127 128 129 130
          top: BorderSide.lerp(a.top, b.top, t),
          right: BorderSide.lerp(a.right, BorderSide.none, t),
          bottom: BorderSide.lerp(a.bottom, b.bottom, t),
          left: BorderSide.lerp(a.left, BorderSide.none, t),
        );
      }
      if (a.left == BorderSide.none && a.right == BorderSide.none) {
        // The fact that a is a Border really doesn't matter, it turns out.
131
        return BorderDirectional(
Ian Hickson's avatar
Ian Hickson committed
132 133 134 135 136 137 138 139 140 141
          top: BorderSide.lerp(a.top, b.top, t),
          start: BorderSide.lerp(BorderSide.none, b.start, t),
          end: BorderSide.lerp(BorderSide.none, b.end, t),
          bottom: BorderSide.lerp(a.bottom, b.bottom, t),
        );
      }
      // Since we have to swap a visual border for a directional one,
      // we speed up the horizontal sides' transitions and switch from
      // one mode to the other at t=0.5.
      if (t < 0.5) {
142
        return Border(
Ian Hickson's avatar
Ian Hickson committed
143 144 145 146 147 148
          top: BorderSide.lerp(a.top, b.top, t),
          right: BorderSide.lerp(a.right, BorderSide.none, t * 2.0),
          bottom: BorderSide.lerp(a.bottom, b.bottom, t),
          left: BorderSide.lerp(a.left, BorderSide.none, t * 2.0),
        );
      }
149
      return BorderDirectional(
Ian Hickson's avatar
Ian Hickson committed
150 151 152 153 154 155
        top: BorderSide.lerp(a.top, b.top, t),
        start: BorderSide.lerp(BorderSide.none, b.start, (t - 0.5) * 2.0),
        end: BorderSide.lerp(BorderSide.none, b.end, (t - 0.5) * 2.0),
        bottom: BorderSide.lerp(a.bottom, b.bottom, t),
      );
    }
156 157 158 159 160 161 162 163 164 165
    throw FlutterError.fromParts(<DiagnosticsNode>[
      ErrorSummary('BoxBorder.lerp can only interpolate Border and BorderDirectional classes.'),
      ErrorDescription(
        'BoxBorder.lerp() was called with two objects of type ${a.runtimeType} and ${b.runtimeType}:\n'
        '  $a\n'
        '  $b\n'
        'However, only Border and BorderDirectional classes are supported by this method.'
      ),
      ErrorHint('For a more general interpolation method, consider using ShapeBorder.lerp instead.'),
    ]);
Ian Hickson's avatar
Ian Hickson committed
166 167 168
  }

  @override
169
  Path getInnerPath(Rect rect, { TextDirection? textDirection }) {
Ian Hickson's avatar
Ian Hickson committed
170
    assert(textDirection != null, 'The textDirection argument to $runtimeType.getInnerPath must not be null.');
171
    return Path()
Ian Hickson's avatar
Ian Hickson committed
172 173 174 175
      ..addRect(dimensions.resolve(textDirection).deflateRect(rect));
  }

  @override
176
  Path getOuterPath(Rect rect, { TextDirection? textDirection }) {
Ian Hickson's avatar
Ian Hickson committed
177
    assert(textDirection != null, 'The textDirection argument to $runtimeType.getOuterPath must not be null.');
178
    return Path()
Ian Hickson's avatar
Ian Hickson committed
179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201
      ..addRect(rect);
  }

  /// Paints the border within the given [Rect] on the given [Canvas].
  ///
  /// This is an extension of the [ShapeBorder.paint] method. It allows
  /// [BoxBorder] borders to be applied to different [BoxShape]s and with
  /// different [borderRadius] parameters, without changing the [BoxBorder]
  /// object itself.
  ///
  /// The `shape` argument specifies the [BoxShape] to draw the border on.
  ///
  /// If the `shape` is specifies a rectangular box shape
  /// ([BoxShape.rectangle]), then the `borderRadius` argument describes the
  /// corners of the rectangle.
  ///
  /// The [getInnerPath] and [getOuterPath] methods do not know about the
  /// `shape` and `borderRadius` arguments.
  ///
  /// See also:
  ///
  ///  * [paintBorder], which is used if the border is not uniform.
  @override
202 203 204
  void paint(
    Canvas canvas,
    Rect rect, {
205
    TextDirection? textDirection,
206
    BoxShape shape = BoxShape.rectangle,
207
    BorderRadius? borderRadius,
Ian Hickson's avatar
Ian Hickson committed
208 209 210 211
  });

  static void _paintUniformBorderWithRadius(Canvas canvas, Rect rect, BorderSide side, BorderRadius borderRadius) {
    assert(side.style != BorderStyle.none);
212
    final Paint paint = Paint()
Ian Hickson's avatar
Ian Hickson committed
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
      ..color = side.color;
    final RRect outer = borderRadius.toRRect(rect);
    final double width = side.width;
    if (width == 0.0) {
      paint
        ..style = PaintingStyle.stroke
        ..strokeWidth = 0.0;
      canvas.drawRRect(outer, paint);
    } else {
      final RRect inner = outer.deflate(width);
      canvas.drawDRRect(outer, inner, paint);
    }
  }

  static void _paintUniformBorderWithCircle(Canvas canvas, Rect rect, BorderSide side) {
    assert(side.style != BorderStyle.none);
    final double width = side.width;
    final Paint paint = side.toPaint();
    final double radius = (rect.shortestSide - width) / 2.0;
    canvas.drawCircle(rect.center, radius, paint);
  }

  static void _paintUniformBorderWithRectangle(Canvas canvas, Rect rect, BorderSide side) {
    assert(side.style != BorderStyle.none);
    final double width = side.width;
    final Paint paint = side.toPaint();
    canvas.drawRect(rect.deflate(width / 2.0), paint);
  }
}

/// A border of a box, comprised of four sides: top, right, bottom, left.
244 245 246
///
/// The sides are represented by [BorderSide] objects.
///
247
/// {@tool snippet}
248 249 250 251
///
/// All four borders the same, two-pixel wide solid white:
///
/// ```dart
252
/// Border.all(width: 2.0, color: const Color(0xFFFFFFFF))
253
/// ```
254
/// {@end-tool}
255
/// {@tool snippet}
256 257 258 259
///
/// The border for a material design divider:
///
/// ```dart
260
/// Border(bottom: BorderSide(color: Theme.of(context).dividerColor))
261
/// ```
262
/// {@end-tool}
263
/// {@tool snippet}
264 265 266 267
///
/// A 1990s-era "OK" button:
///
/// ```dart
268
/// Container(
269
///   decoration: const BoxDecoration(
270 271 272 273 274
///     border: Border(
///       top: BorderSide(width: 1.0, color: Color(0xFFFFFFFFFF)),
///       left: BorderSide(width: 1.0, color: Color(0xFFFFFFFFFF)),
///       right: BorderSide(width: 1.0, color: Color(0xFFFF000000)),
///       bottom: BorderSide(width: 1.0, color: Color(0xFFFF000000)),
275 276
///     ),
///   ),
277
///   child: Container(
278 279
///     padding: const EdgeInsets.symmetric(horizontal: 20.0, vertical: 2.0),
///     decoration: const BoxDecoration(
280 281 282 283 284
///       border: Border(
///         top: BorderSide(width: 1.0, color: Color(0xFFFFDFDFDF)),
///         left: BorderSide(width: 1.0, color: Color(0xFFFFDFDFDF)),
///         right: BorderSide(width: 1.0, color: Color(0xFFFF7F7F7F)),
///         bottom: BorderSide(width: 1.0, color: Color(0xFFFF7F7F7F)),
285
///       ),
286
///       color: Color(0xFFBFBFBF),
287 288 289 290
///     ),
///     child: const Text(
///       'OK',
///       textAlign: TextAlign.center,
291
///       style: TextStyle(color: Color(0xFF000000))
292 293 294 295
///     ),
///   ),
/// )
/// ```
296
/// {@end-tool}
297 298 299 300 301 302 303
///
/// See also:
///
///  * [BoxDecoration], which uses this class to describe its edge decoration.
///  * [BorderSide], which is used to describe each side of the box.
///  * [Theme], from the material layer, which can be queried to obtain appropriate colors
///    to use for borders in a material app, as shown in the "divider" sample above.
Ian Hickson's avatar
Ian Hickson committed
304
class Border extends BoxBorder {
305 306 307
  /// Creates a border.
  ///
  /// All the sides of the border default to [BorderSide.none].
Ian Hickson's avatar
Ian Hickson committed
308 309
  ///
  /// The arguments must not be null.
310
  const Border({
311 312 313 314
    this.top = BorderSide.none,
    this.right = BorderSide.none,
    this.bottom = BorderSide.none,
    this.left = BorderSide.none,
Ian Hickson's avatar
Ian Hickson committed
315 316 317 318
  }) : assert(top != null),
       assert(right != null),
       assert(bottom != null),
       assert(left != null);
319

320 321 322
  /// Creates a border whose sides are all the same.
  ///
  /// The `side` argument must not be null.
323
  const Border.fromBorderSide(BorderSide side)
324 325 326 327 328 329
      : assert(side != null),
        top = side,
        right = side,
        bottom = side,
        left = side;

330 331
  /// Creates a border with symmetrical vertical and horizontal sides.
  ///
332 333
  /// The `vertical` argument applies to the [left] and [right] sides, and the
  /// `horizontal` argument applies to the [top] and [bottom] sides.
334
  ///
335
  /// All arguments default to [BorderSide.none] and must not be null.
336 337 338 339 340
  const Border.symmetric({
    BorderSide vertical = BorderSide.none,
    BorderSide horizontal = BorderSide.none,
  }) : assert(vertical != null),
       assert(horizontal != null),
341 342 343 344
       left = vertical,
       top = horizontal,
       right = vertical,
       bottom = horizontal;
345

346 347 348 349
  /// A uniform border with all sides the same color and width.
  ///
  /// The sides default to black solid borders, one logical pixel wide.
  factory Border.all({
350 351 352
    Color color = const Color(0xFF000000),
    double width = 1.0,
    BorderStyle style = BorderStyle.solid,
353
  }) {
354
    final BorderSide side = BorderSide(color: color, width: width, style: style);
355
    return Border.fromBorderSide(side);
356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371
  }

  /// Creates a [Border] that represents the addition of the two given
  /// [Border]s.
  ///
  /// It is only valid to call this if [BorderSide.canMerge] returns true for
  /// the pairwise combination of each side on both [Border]s.
  ///
  /// The arguments must not be null.
  static Border merge(Border a, Border b) {
    assert(a != null);
    assert(b != null);
    assert(BorderSide.canMerge(a.top, b.top));
    assert(BorderSide.canMerge(a.right, b.right));
    assert(BorderSide.canMerge(a.bottom, b.bottom));
    assert(BorderSide.canMerge(a.left, b.left));
372
    return Border(
373 374 375 376 377 378 379
      top: BorderSide.merge(a.top, b.top),
      right: BorderSide.merge(a.right, b.right),
      bottom: BorderSide.merge(a.bottom, b.bottom),
      left: BorderSide.merge(a.left, b.left),
    );
  }

380
  @override
381 382 383 384 385
  final BorderSide top;

  /// The right side of this border.
  final BorderSide right;

386
  @override
387 388 389 390 391 392 393
  final BorderSide bottom;

  /// The left side of this border.
  final BorderSide left;

  @override
  EdgeInsetsGeometry get dimensions {
394
    return EdgeInsets.fromLTRB(left.width, top.width, right.width, bottom.width);
395 396
  }

397
  @override
398 399 400
  bool get isUniform => _colorIsUniform && _widthIsUniform && _styleIsUniform;

  bool get _colorIsUniform {
401
    final Color topColor = top.color;
402 403
    return right.color == topColor && bottom.color == topColor && left.color == topColor;
  }
404

405
  bool get _widthIsUniform {
406
    final double topWidth = top.width;
407 408
    return right.width == topWidth && bottom.width == topWidth && left.width == topWidth;
  }
409

410
  bool get _styleIsUniform {
411
    final BorderStyle topStyle = top.style;
412
    return right.style == topStyle && bottom.style == topStyle && left.style == topStyle;
413 414 415
  }

  @override
416
  Border? add(ShapeBorder other, { bool reversed = false }) {
417 418 419 420 421 422
    if (other is Border &&
        BorderSide.canMerge(top, other.top) &&
        BorderSide.canMerge(right, other.right) &&
        BorderSide.canMerge(bottom, other.bottom) &&
        BorderSide.canMerge(left, other.left)) {
      return Border.merge(this, other);
423 424 425 426 427 428
    }
    return null;
  }

  @override
  Border scale(double t) {
429
    return Border(
430 431 432 433 434 435 436 437
      top: top.scale(t),
      right: right.scale(t),
      bottom: bottom.scale(t),
      left: left.scale(t),
    );
  }

  @override
438
  ShapeBorder? lerpFrom(ShapeBorder? a, double t) {
439 440 441 442 443 444
    if (a is Border)
      return Border.lerp(a, this, t);
    return super.lerpFrom(a, t);
  }

  @override
445
  ShapeBorder? lerpTo(ShapeBorder? b, double t) {
446 447 448 449 450 451 452 453 454
    if (b is Border)
      return Border.lerp(this, b, t);
    return super.lerpTo(b, t);
  }

  /// Linearly interpolate between two borders.
  ///
  /// If a border is null, it is treated as having four [BorderSide.none]
  /// borders.
455
  ///
456
  /// {@macro dart.ui.shadow.lerp}
457
  static Border? lerp(Border? a, Border? b, double t) {
458
    assert(t != null);
459 460 461
    if (a == null && b == null)
      return null;
    if (a == null)
462
      return b!.scale(t);
463 464
    if (b == null)
      return a.scale(1.0 - t);
465
    return Border(
466 467 468
      top: BorderSide.lerp(a.top, b.top, t),
      right: BorderSide.lerp(a.right, b.right, t),
      bottom: BorderSide.lerp(a.bottom, b.bottom, t),
469
      left: BorderSide.lerp(a.left, b.left, t),
470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492
    );
  }

  /// Paints the border within the given [Rect] on the given [Canvas].
  ///
  /// Uniform borders are more efficient to paint than more complex borders.
  ///
  /// You can provide a [BoxShape] to draw the border on. If the `shape` in
  /// [BoxShape.circle], there is the requirement that the border [isUniform].
  ///
  /// If you specify a rectangular box shape ([BoxShape.rectangle]), then you
  /// may specify a [BorderRadius]. If a `borderRadius` is specified, there is
  /// the requirement that the border [isUniform].
  ///
  /// The [getInnerPath] and [getOuterPath] methods do not know about the
  /// `shape` and `borderRadius` arguments.
  ///
  /// The `textDirection` argument is not used by this paint method.
  ///
  /// See also:
  ///
  ///  * [paintBorder], which is used if the border is not uniform.
  @override
493 494 495
  void paint(
    Canvas canvas,
    Rect rect, {
496
    TextDirection? textDirection,
497
    BoxShape shape = BoxShape.rectangle,
498
    BorderRadius? borderRadius,
499 500 501 502 503 504
  }) {
    if (isUniform) {
      switch (top.style) {
        case BorderStyle.none:
          return;
        case BorderStyle.solid:
505 506 507 508 509 510 511 512 513 514 515 516
          switch (shape) {
            case BoxShape.circle:
              assert(borderRadius == null, 'A borderRadius can only be given for rectangular boxes.');
              BoxBorder._paintUniformBorderWithCircle(canvas, rect, top);
              break;
            case BoxShape.rectangle:
              if (borderRadius != null) {
                BoxBorder._paintUniformBorderWithRadius(canvas, rect, top, borderRadius);
                return;
              }
              BoxBorder._paintUniformBorderWithRectangle(canvas, rect, top);
              break;
517 518 519 520 521
          }
          return;
      }
    }

522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545
    assert(() {
      if (borderRadius != null) {
        throw FlutterError.fromParts(<DiagnosticsNode>[
          ErrorSummary('A borderRadius can only be given for a uniform Border.'),
          ErrorDescription('The following is not uniform:'),
          if (!_colorIsUniform) ErrorDescription('BorderSide.color'),
          if (!_widthIsUniform) ErrorDescription('BorderSide.width'),
          if (!_styleIsUniform) ErrorDescription('BorderSide.style'),
        ]);
      }
      return true;
    }());
    assert(() {
      if (shape != BoxShape.rectangle) {
        throw FlutterError.fromParts(<DiagnosticsNode>[
          ErrorSummary('A Border can only be drawn as a circle if it is uniform'),
          ErrorDescription('The following is not uniform:'),
          if (!_colorIsUniform) ErrorDescription('BorderSide.color'),
          if (!_widthIsUniform) ErrorDescription('BorderSide.width'),
          if (!_styleIsUniform) ErrorDescription('BorderSide.style'),
        ]);
      }
      return true;
    }());
546 547 548 549 550

    paintBorder(canvas, rect, top: top, right: right, bottom: bottom, left: left);
  }

  @override
551
  bool operator ==(Object other) {
552 553
    if (identical(this, other))
      return true;
554
    if (other.runtimeType != runtimeType)
555
      return false;
556 557 558 559 560
    return other is Border
        && other.top == top
        && other.right == right
        && other.bottom == bottom
        && other.left == left;
561 562 563 564 565 566 567 568
  }

  @override
  int get hashCode => hashValues(top, right, bottom, left);

  @override
  String toString() {
    if (isUniform)
569
      return '${objectRuntimeType(this, 'Border')}.all($top)';
570 571 572 573 574 575
    final List<String> arguments = <String>[
      if (top != BorderSide.none) 'top: $top',
      if (right != BorderSide.none) 'right: $right',
      if (bottom != BorderSide.none) 'bottom: $bottom',
      if (left != BorderSide.none) 'left: $left',
    ];
576
    return '${objectRuntimeType(this, 'Border')}(${arguments.join(", ")})';
Ian Hickson's avatar
Ian Hickson committed
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
  }
}

/// A border of a box, comprised of four sides, the lateral sides of which
/// flip over based on the reading direction.
///
/// The lateral sides are called [start] and [end]. When painted in
/// left-to-right environments, the [start] side will be painted on the left and
/// the [end] side on the right; in right-to-left environments, it is the
/// reverse. The other two sides are [top] and [bottom].
///
/// The sides are represented by [BorderSide] objects.
///
/// If the [start] and [end] sides are the same, then it is slightly more
/// efficient to use a [Border] object rather than a [BorderDirectional] object.
///
/// See also:
///
///  * [BoxDecoration], which uses this class to describe its edge decoration.
///  * [BorderSide], which is used to describe each side of the box.
///  * [Theme], from the material layer, which can be queried to obtain appropriate colors
///    to use for borders in a material app, as shown in the "divider" sample above.
class BorderDirectional extends BoxBorder {
  /// Creates a border.
  ///
  /// The [start] and [end] sides represent the horizontal sides; the start side
  /// is on the leading edge given the reading direction, and the end side is on
  /// the trailing edge. They are resolved during [paint].
  ///
  /// All the sides of the border default to [BorderSide.none].
  ///
  /// The arguments must not be null.
  const BorderDirectional({
610 611 612 613
    this.top = BorderSide.none,
    this.start = BorderSide.none,
    this.end = BorderSide.none,
    this.bottom = BorderSide.none,
Ian Hickson's avatar
Ian Hickson committed
614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632
  }) : assert(top != null),
       assert(start != null),
       assert(end != null),
       assert(bottom != null);

  /// Creates a [BorderDirectional] that represents the addition of the two
  /// given [BorderDirectional]s.
  ///
  /// It is only valid to call this if [BorderSide.canMerge] returns true for
  /// the pairwise combination of each side on both [BorderDirectional]s.
  ///
  /// The arguments must not be null.
  static BorderDirectional merge(BorderDirectional a, BorderDirectional b) {
    assert(a != null);
    assert(b != null);
    assert(BorderSide.canMerge(a.top, b.top));
    assert(BorderSide.canMerge(a.start, b.start));
    assert(BorderSide.canMerge(a.end, b.end));
    assert(BorderSide.canMerge(a.bottom, b.bottom));
633
    return BorderDirectional(
Ian Hickson's avatar
Ian Hickson committed
634 635 636 637 638 639 640
      top: BorderSide.merge(a.top, b.top),
      start: BorderSide.merge(a.start, b.start),
      end: BorderSide.merge(a.end, b.end),
      bottom: BorderSide.merge(a.bottom, b.bottom),
    );
  }

641
  @override
Ian Hickson's avatar
Ian Hickson committed
642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663
  final BorderSide top;

  /// The start side of this border.
  ///
  /// This is the side on the left in left-to-right text and on the right in
  /// right-to-left text.
  ///
  /// See also:
  ///
  ///  * [TextDirection], which is used to describe the reading direction.
  final BorderSide start;

  /// The end side of this border.
  ///
  /// This is the side on the right in left-to-right text and on the left in
  /// right-to-left text.
  ///
  /// See also:
  ///
  ///  * [TextDirection], which is used to describe the reading direction.
  final BorderSide end;

664
  @override
Ian Hickson's avatar
Ian Hickson committed
665 666 667 668
  final BorderSide bottom;

  @override
  EdgeInsetsGeometry get dimensions {
669
    return EdgeInsetsDirectional.fromSTEB(start.width, top.width, end.width, bottom.width);
Ian Hickson's avatar
Ian Hickson committed
670 671
  }

672
  @override
Ian Hickson's avatar
Ian Hickson committed
673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695
  bool get isUniform {
    final Color topColor = top.color;
    if (start.color != topColor ||
        end.color != topColor ||
        bottom.color != topColor)
      return false;

    final double topWidth = top.width;
    if (start.width != topWidth ||
        end.width != topWidth ||
        bottom.width != topWidth)
      return false;

    final BorderStyle topStyle = top.style;
    if (start.style != topStyle ||
        end.style != topStyle ||
        bottom.style != topStyle)
      return false;

    return true;
  }

  @override
696
  BoxBorder? add(ShapeBorder other, { bool reversed = false }) {
Ian Hickson's avatar
Ian Hickson committed
697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718
    if (other is BorderDirectional) {
      final BorderDirectional typedOther = other;
      if (BorderSide.canMerge(top, typedOther.top) &&
          BorderSide.canMerge(start, typedOther.start) &&
          BorderSide.canMerge(end, typedOther.end) &&
          BorderSide.canMerge(bottom, typedOther.bottom)) {
        return BorderDirectional.merge(this, typedOther);
      }
      return null;
    }
    if (other is Border) {
      final Border typedOther = other;
      if (!BorderSide.canMerge(typedOther.top, top) ||
          !BorderSide.canMerge(typedOther.bottom, bottom))
        return null;
      if (start != BorderSide.none ||
          end != BorderSide.none) {
        if (typedOther.left != BorderSide.none ||
            typedOther.right != BorderSide.none)
          return null;
        assert(typedOther.left == BorderSide.none);
        assert(typedOther.right == BorderSide.none);
719
        return BorderDirectional(
Ian Hickson's avatar
Ian Hickson committed
720 721 722 723 724 725 726 727
          top: BorderSide.merge(typedOther.top, top),
          start: start,
          end: end,
          bottom: BorderSide.merge(typedOther.bottom, bottom),
        );
      }
      assert(start == BorderSide.none);
      assert(end == BorderSide.none);
728
      return Border(
Ian Hickson's avatar
Ian Hickson committed
729 730 731 732 733 734 735 736 737 738 739
        top: BorderSide.merge(typedOther.top, top),
        right: typedOther.right,
        bottom: BorderSide.merge(typedOther.bottom, bottom),
        left: typedOther.left,
      );
    }
    return null;
  }

  @override
  BorderDirectional scale(double t) {
740
    return BorderDirectional(
Ian Hickson's avatar
Ian Hickson committed
741 742 743 744 745 746 747 748
      top: top.scale(t),
      start: start.scale(t),
      end: end.scale(t),
      bottom: bottom.scale(t),
    );
  }

  @override
749
  ShapeBorder? lerpFrom(ShapeBorder? a, double t) {
Ian Hickson's avatar
Ian Hickson committed
750 751 752 753 754 755
    if (a is BorderDirectional)
      return BorderDirectional.lerp(a, this, t);
    return super.lerpFrom(a, t);
  }

  @override
756
  ShapeBorder? lerpTo(ShapeBorder? b, double t) {
Ian Hickson's avatar
Ian Hickson committed
757 758 759 760 761 762 763 764 765
    if (b is BorderDirectional)
      return BorderDirectional.lerp(this, b, t);
    return super.lerpTo(b, t);
  }

  /// Linearly interpolate between two borders.
  ///
  /// If a border is null, it is treated as having four [BorderSide.none]
  /// borders.
766
  ///
767
  /// {@macro dart.ui.shadow.lerp}
768
  static BorderDirectional? lerp(BorderDirectional? a, BorderDirectional? b, double t) {
769
    assert(t != null);
Ian Hickson's avatar
Ian Hickson committed
770 771 772
    if (a == null && b == null)
      return null;
    if (a == null)
773
      return b!.scale(t);
Ian Hickson's avatar
Ian Hickson committed
774 775
    if (b == null)
      return a.scale(1.0 - t);
776
    return BorderDirectional(
Ian Hickson's avatar
Ian Hickson committed
777 778 779
      top: BorderSide.lerp(a.top, b.top, t),
      end: BorderSide.lerp(a.end, b.end, t),
      bottom: BorderSide.lerp(a.bottom, b.bottom, t),
780
      start: BorderSide.lerp(a.start, b.start, t),
Ian Hickson's avatar
Ian Hickson committed
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
    );
  }

  /// Paints the border within the given [Rect] on the given [Canvas].
  ///
  /// Uniform borders are more efficient to paint than more complex borders.
  ///
  /// You can provide a [BoxShape] to draw the border on. If the `shape` in
  /// [BoxShape.circle], there is the requirement that the border [isUniform].
  ///
  /// If you specify a rectangular box shape ([BoxShape.rectangle]), then you
  /// may specify a [BorderRadius]. If a `borderRadius` is specified, there is
  /// the requirement that the border [isUniform].
  ///
  /// The [getInnerPath] and [getOuterPath] methods do not know about the
  /// `shape` and `borderRadius` arguments.
  ///
  /// The `textDirection` argument is used to determine which of [start] and
  /// [end] map to the left and right. For [TextDirection.ltr], the [start] is
  /// the left and the [end] is the right; for [TextDirection.rtl], it is the
  /// reverse.
  ///
  /// See also:
  ///
  ///  * [paintBorder], which is used if the border is not uniform.
  @override
807 808 809
  void paint(
    Canvas canvas,
    Rect rect, {
810
    TextDirection? textDirection,
811
    BoxShape shape = BoxShape.rectangle,
812
    BorderRadius? borderRadius,
Ian Hickson's avatar
Ian Hickson committed
813 814 815 816 817 818
  }) {
    if (isUniform) {
      switch (top.style) {
        case BorderStyle.none:
          return;
        case BorderStyle.solid:
819 820 821 822 823 824 825 826 827 828 829 830
          switch (shape) {
            case BoxShape.circle:
              assert(borderRadius == null, 'A borderRadius can only be given for rectangular boxes.');
              BoxBorder._paintUniformBorderWithCircle(canvas, rect, top);
              break;
            case BoxShape.rectangle:
              if (borderRadius != null) {
                BoxBorder._paintUniformBorderWithRadius(canvas, rect, top, borderRadius);
                return;
              }
              BoxBorder._paintUniformBorderWithRectangle(canvas, rect, top);
              break;
Ian Hickson's avatar
Ian Hickson committed
831 832 833 834 835 836 837 838 839 840
          }
          return;
      }
    }

    assert(borderRadius == null, 'A borderRadius can only be given for uniform borders.');
    assert(shape == BoxShape.rectangle, 'A border can only be drawn as a circle if it is uniform.');

    BorderSide left, right;
    assert(textDirection != null, 'Non-uniform BorderDirectional objects require a TextDirection when painting.');
841
    switch (textDirection!) {
Ian Hickson's avatar
Ian Hickson committed
842 843 844 845 846 847 848 849 850 851 852 853 854
      case TextDirection.rtl:
        left = end;
        right = start;
        break;
      case TextDirection.ltr:
        left = start;
        right = end;
        break;
    }
    paintBorder(canvas, rect, top: top, left: left, bottom: bottom, right: right);
  }

  @override
855
  bool operator ==(Object other) {
Ian Hickson's avatar
Ian Hickson committed
856 857
    if (identical(this, other))
      return true;
858
    if (other.runtimeType != runtimeType)
Ian Hickson's avatar
Ian Hickson committed
859
      return false;
860 861 862 863 864
    return other is BorderDirectional
        && other.top == top
        && other.start == start
        && other.end == end
        && other.bottom == bottom;
Ian Hickson's avatar
Ian Hickson committed
865 866 867 868 869 870 871
  }

  @override
  int get hashCode => hashValues(top, start, end, bottom);

  @override
  String toString() {
872 873 874 875 876 877
    final List<String> arguments = <String>[
      if (top != BorderSide.none) 'top: $top',
      if (start != BorderSide.none) 'start: $start',
      if (end != BorderSide.none) 'end: $end',
      if (bottom != BorderSide.none) 'bottom: $bottom',
    ];
878
    return '${objectRuntimeType(this, 'BorderDirectional')}(${arguments.join(", ")})';
879 880
  }
}