box_border.dart 31.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.

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

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

12
// Examples can assume:
13
// late BuildContext context;
14

15
/// The shape to use when rendering a [Border] or [BoxDecoration].
16 17 18 19 20
///
/// 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.
21 22 23 24
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.
25 26 27 28
  ///
  /// See also:
  ///
  ///  * [RoundedRectangleBorder], the equivalent [ShapeBorder].
29 30 31 32 33 34
  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.
35 36 37 38
  ///
  /// See also:
  ///
  ///  * [CircleBorder], the equivalent [ShapeBorder].
39
  circle,
40 41

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

44
/// Base class for box borders that can paint as rectangles, circles, or rounded
Ian Hickson's avatar
Ian Hickson committed
45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64
/// 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();

65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82
  /// 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
83
  // We override this to tighten the return value, so that callers can assume
84
  // that we'll return a [BoxBorder].
Ian Hickson's avatar
Ian Hickson committed
85
  @override
86
  BoxBorder? add(ShapeBorder other, { bool reversed = false }) => null;
Ian Hickson's avatar
Ian Hickson committed
87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102

  /// 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.
103
  ///
104
  /// {@macro dart.ui.shadow.lerp}
105
  static BoxBorder? lerp(BoxBorder? a, BoxBorder? b, double t) {
106
    assert(t != null);
107
    if ((a is Border?) && (b is Border?)) {
108
      return Border.lerp(a, b, t);
109 110
    }
    if ((a is BorderDirectional?) && (b is BorderDirectional?)) {
111
      return BorderDirectional.lerp(a, b, t);
112
    }
Ian Hickson's avatar
Ian Hickson committed
113 114 115 116 117 118 119 120 121 122
    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.
123
        return Border(
Ian Hickson's avatar
Ian Hickson committed
124 125 126 127 128 129 130 131
          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.
132
        return BorderDirectional(
Ian Hickson's avatar
Ian Hickson committed
133 134 135 136 137 138 139 140 141 142
          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) {
143
        return Border(
Ian Hickson's avatar
Ian Hickson committed
144 145 146 147 148 149
          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),
        );
      }
150
      return BorderDirectional(
Ian Hickson's avatar
Ian Hickson committed
151 152 153 154 155 156
        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),
      );
    }
157 158 159 160 161 162
    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'
163
        'However, only Border and BorderDirectional classes are supported by this method.',
164 165 166
      ),
      ErrorHint('For a more general interpolation method, consider using ShapeBorder.lerp instead.'),
    ]);
Ian Hickson's avatar
Ian Hickson committed
167 168 169
  }

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

  @override
177
  Path getOuterPath(Rect rect, { TextDirection? textDirection }) {
Ian Hickson's avatar
Ian Hickson committed
178
    assert(textDirection != null, 'The textDirection argument to $runtimeType.getOuterPath must not be null.');
179
    return Path()
Ian Hickson's avatar
Ian Hickson committed
180 181 182
      ..addRect(rect);
  }

183 184 185 186 187 188 189 190 191 192 193 194
  @override
  void paintInterior(Canvas canvas, Rect rect, Paint paint, { TextDirection? textDirection }) {
    // For `ShapeDecoration(shape: Border.all())`, a rectangle with sharp edges
    // is always painted. There is no borderRadius parameter for
    // ShapeDecoration or Border, only for BoxDecoration, which doesn't call
    // this method.
    canvas.drawRect(rect, paint);
  }

  @override
  bool get preferPaintInterior => true;

Ian Hickson's avatar
Ian Hickson committed
195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214
  /// 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
215 216 217
  void paint(
    Canvas canvas,
    Rect rect, {
218
    TextDirection? textDirection,
219
    BoxShape shape = BoxShape.rectangle,
220
    BorderRadius? borderRadius,
Ian Hickson's avatar
Ian Hickson committed
221 222 223 224
  });

  static void _paintUniformBorderWithRadius(Canvas canvas, Rect rect, BorderSide side, BorderRadius borderRadius) {
    assert(side.style != BorderStyle.none);
225
    final Paint paint = Paint()
Ian Hickson's avatar
Ian Hickson committed
226 227 228 229 230 231
      ..color = side.color;
    final double width = side.width;
    if (width == 0.0) {
      paint
        ..style = PaintingStyle.stroke
        ..strokeWidth = 0.0;
232
      canvas.drawRRect(borderRadius.toRRect(rect), paint);
Ian Hickson's avatar
Ian Hickson committed
233
    } else {
234
      final RRect borderRect = borderRadius.toRRect(rect);
235
      final RRect inner = borderRect.deflate(side.strokeInset);
236 237
      final RRect outer = borderRect.inflate(side.strokeOutset);
      canvas.drawDRRect(outer, inner, paint);
Ian Hickson's avatar
Ian Hickson committed
238 239 240 241 242
    }
  }

  static void _paintUniformBorderWithCircle(Canvas canvas, Rect rect, BorderSide side) {
    assert(side.style != BorderStyle.none);
243 244
    final double radius = (rect.shortestSide + side.strokeOffset) / 2;
    canvas.drawCircle(rect.center, radius, side.toPaint());
Ian Hickson's avatar
Ian Hickson committed
245 246 247 248
  }

  static void _paintUniformBorderWithRectangle(Canvas canvas, Rect rect, BorderSide side) {
    assert(side.style != BorderStyle.none);
249
    canvas.drawRect(rect.inflate(side.strokeOffset / 2), side.toPaint());
Ian Hickson's avatar
Ian Hickson committed
250 251 252 253
  }
}

/// A border of a box, comprised of four sides: top, right, bottom, left.
254 255 256
///
/// The sides are represented by [BorderSide] objects.
///
257
/// {@tool snippet}
258 259 260 261
///
/// All four borders the same, two-pixel wide solid white:
///
/// ```dart
262
/// Border.all(width: 2.0, color: const Color(0xFFFFFFFF))
263
/// ```
264
/// {@end-tool}
265
/// {@tool snippet}
266
///
267
/// The border for a Material Design divider:
268 269
///
/// ```dart
270
/// Border(bottom: BorderSide(color: Theme.of(context).dividerColor))
271
/// ```
272
/// {@end-tool}
273
/// {@tool snippet}
274 275 276 277
///
/// A 1990s-era "OK" button:
///
/// ```dart
278
/// Container(
279
///   decoration: const BoxDecoration(
280
///     border: Border(
281 282 283 284
///       top: BorderSide(color: Color(0xFFFFFFFF)),
///       left: BorderSide(color: Color(0xFFFFFFFF)),
///       right: BorderSide(),
///       bottom: BorderSide(),
285 286
///     ),
///   ),
287
///   child: Container(
288 289
///     padding: const EdgeInsets.symmetric(horizontal: 20.0, vertical: 2.0),
///     decoration: const BoxDecoration(
290
///       border: Border(
291 292 293 294
///         top: BorderSide(color: Color(0xFFDFDFDF)),
///         left: BorderSide(color: Color(0xFFDFDFDF)),
///         right: BorderSide(color: Color(0xFF7F7F7F)),
///         bottom: BorderSide(color: Color(0xFF7F7F7F)),
295
///       ),
296
///       color: Color(0xFFBFBFBF),
297 298 299 300
///     ),
///     child: const Text(
///       'OK',
///       textAlign: TextAlign.center,
301
///       style: TextStyle(color: Color(0xFF000000))
302 303 304 305
///     ),
///   ),
/// )
/// ```
306
/// {@end-tool}
307 308 309 310 311 312
///
/// 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
313
///    to use for borders in a [MaterialApp], as shown in the "divider" sample above.
Ian Hickson's avatar
Ian Hickson committed
314
class Border extends BoxBorder {
315 316 317
  /// Creates a border.
  ///
  /// All the sides of the border default to [BorderSide.none].
Ian Hickson's avatar
Ian Hickson committed
318 319
  ///
  /// The arguments must not be null.
320
  const Border({
321 322 323 324
    this.top = BorderSide.none,
    this.right = BorderSide.none,
    this.bottom = BorderSide.none,
    this.left = BorderSide.none,
Ian Hickson's avatar
Ian Hickson committed
325 326 327 328
  }) : assert(top != null),
       assert(right != null),
       assert(bottom != null),
       assert(left != null);
329

330 331 332
  /// Creates a border whose sides are all the same.
  ///
  /// The `side` argument must not be null.
333
  const Border.fromBorderSide(BorderSide side)
334 335 336 337 338 339
      : assert(side != null),
        top = side,
        right = side,
        bottom = side,
        left = side;

340 341
  /// Creates a border with symmetrical vertical and horizontal sides.
  ///
342 343
  /// The `vertical` argument applies to the [left] and [right] sides, and the
  /// `horizontal` argument applies to the [top] and [bottom] sides.
344
  ///
345
  /// All arguments default to [BorderSide.none] and must not be null.
346 347 348 349 350
  const Border.symmetric({
    BorderSide vertical = BorderSide.none,
    BorderSide horizontal = BorderSide.none,
  }) : assert(vertical != null),
       assert(horizontal != null),
351 352 353 354
       left = vertical,
       top = horizontal,
       right = vertical,
       bottom = horizontal;
355

356 357 358 359
  /// 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({
360 361 362
    Color color = const Color(0xFF000000),
    double width = 1.0,
    BorderStyle style = BorderStyle.solid,
363
    double strokeAlign = BorderSide.strokeAlignInside,
364
  }) {
365
    final BorderSide side = BorderSide(color: color, width: width, style: style, strokeAlign: strokeAlign);
366
    return Border.fromBorderSide(side);
367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382
  }

  /// 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));
383
    return Border(
384 385 386 387 388 389 390
      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),
    );
  }

391
  @override
392 393 394 395 396
  final BorderSide top;

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

397
  @override
398 399 400 401 402 403 404
  final BorderSide bottom;

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

  @override
  EdgeInsetsGeometry get dimensions {
405 406
    if (_widthIsUniform) {
      return EdgeInsets.all(top.strokeInset);
407
    }
408
    return EdgeInsets.fromLTRB(left.strokeInset, top.strokeInset, right.strokeInset, bottom.strokeInset);
409 410
  }

411
  @override
412
  bool get isUniform => _colorIsUniform && _widthIsUniform && _styleIsUniform && _strokeAlignIsUniform;
413 414

  bool get _colorIsUniform {
415
    final Color topColor = top.color;
416 417
    return right.color == topColor && bottom.color == topColor && left.color == topColor;
  }
418

419
  bool get _widthIsUniform {
420
    final double topWidth = top.width;
421 422
    return right.width == topWidth && bottom.width == topWidth && left.width == topWidth;
  }
423

424
  bool get _styleIsUniform {
425
    final BorderStyle topStyle = top.style;
426
    return right.style == topStyle && bottom.style == topStyle && left.style == topStyle;
427 428
  }

429
  bool get _strokeAlignIsUniform {
430
    final double topStrokeAlign = top.strokeAlign;
431 432 433 434 435
    return right.strokeAlign == topStrokeAlign
        && bottom.strokeAlign == topStrokeAlign
        && left.strokeAlign == topStrokeAlign;
  }

436
  @override
437
  Border? add(ShapeBorder other, { bool reversed = false }) {
438 439 440 441 442 443
    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);
444 445 446 447 448 449
    }
    return null;
  }

  @override
  Border scale(double t) {
450
    return Border(
451 452 453 454 455 456 457 458
      top: top.scale(t),
      right: right.scale(t),
      bottom: bottom.scale(t),
      left: left.scale(t),
    );
  }

  @override
459
  ShapeBorder? lerpFrom(ShapeBorder? a, double t) {
460
    if (a is Border) {
461
      return Border.lerp(a, this, t);
462
    }
463 464 465 466
    return super.lerpFrom(a, t);
  }

  @override
467
  ShapeBorder? lerpTo(ShapeBorder? b, double t) {
468
    if (b is Border) {
469
      return Border.lerp(this, b, t);
470
    }
471 472 473 474 475 476 477
    return super.lerpTo(b, t);
  }

  /// Linearly interpolate between two borders.
  ///
  /// If a border is null, it is treated as having four [BorderSide.none]
  /// borders.
478
  ///
479
  /// {@macro dart.ui.shadow.lerp}
480
  static Border? lerp(Border? a, Border? b, double t) {
481
    assert(t != null);
482
    if (a == null && b == null) {
483
      return null;
484 485
    }
    if (a == null) {
486
      return b!.scale(t);
487 488
    }
    if (b == null) {
489
      return a.scale(1.0 - t);
490
    }
491
    return Border(
492 493 494
      top: BorderSide.lerp(a.top, b.top, t),
      right: BorderSide.lerp(a.right, b.right, t),
      bottom: BorderSide.lerp(a.bottom, b.bottom, t),
495
      left: BorderSide.lerp(a.left, b.left, t),
496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518
    );
  }

  /// 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
519 520 521
  void paint(
    Canvas canvas,
    Rect rect, {
522
    TextDirection? textDirection,
523
    BoxShape shape = BoxShape.rectangle,
524
    BorderRadius? borderRadius,
525 526 527 528 529 530
  }) {
    if (isUniform) {
      switch (top.style) {
        case BorderStyle.none:
          return;
        case BorderStyle.solid:
531 532 533 534 535 536
          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:
537
              if (borderRadius != null && borderRadius != BorderRadius.zero) {
538 539 540 541 542
                BoxBorder._paintUniformBorderWithRadius(canvas, rect, top, borderRadius);
                return;
              }
              BoxBorder._paintUniformBorderWithRectangle(canvas, rect, top);
              break;
543 544 545 546 547
          }
          return;
      }
    }

548 549 550 551 552 553 554 555
    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'),
556
          if (!_strokeAlignIsUniform) ErrorDescription('BorderSide.strokeAlign'),
557 558 559 560 561 562 563
        ]);
      }
      return true;
    }());
    assert(() {
      if (shape != BoxShape.rectangle) {
        throw FlutterError.fromParts(<DiagnosticsNode>[
564
          ErrorSummary('A Border can only be drawn as a circle if it is uniform.'),
565 566 567 568
          ErrorDescription('The following is not uniform:'),
          if (!_colorIsUniform) ErrorDescription('BorderSide.color'),
          if (!_widthIsUniform) ErrorDescription('BorderSide.width'),
          if (!_styleIsUniform) ErrorDescription('BorderSide.style'),
569 570 571 572 573 574
          if (!_strokeAlignIsUniform) ErrorDescription('BorderSide.strokeAlign'),
        ]);
      }
      return true;
    }());
    assert(() {
575
      if (!_strokeAlignIsUniform || top.strokeAlign != BorderSide.strokeAlignInside) {
576
        throw FlutterError.fromParts(<DiagnosticsNode>[
577
          ErrorSummary('A Border can only draw strokeAlign different than BorderSide.strokeAlignInside on uniform borders.'),
578 579 580 581
        ]);
      }
      return true;
    }());
582 583 584 585 586

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

  @override
587
  bool operator ==(Object other) {
588
    if (identical(this, other)) {
589
      return true;
590 591
    }
    if (other.runtimeType != runtimeType) {
592
      return false;
593
    }
594 595 596 597 598
    return other is Border
        && other.top == top
        && other.right == right
        && other.bottom == bottom
        && other.left == left;
599 600 601
  }

  @override
602
  int get hashCode => Object.hash(top, right, bottom, left);
603 604 605

  @override
  String toString() {
606
    if (isUniform) {
607
      return '${objectRuntimeType(this, 'Border')}.all($top)';
608
    }
609 610 611 612 613 614
    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',
    ];
615
    return '${objectRuntimeType(this, 'Border')}(${arguments.join(", ")})';
Ian Hickson's avatar
Ian Hickson committed
616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636
  }
}

/// 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
637
///    to use for borders in a [MaterialApp], as shown in the "divider" sample above.
Ian Hickson's avatar
Ian Hickson committed
638 639 640 641 642 643 644 645 646 647 648
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({
649 650 651 652
    this.top = BorderSide.none,
    this.start = BorderSide.none,
    this.end = BorderSide.none,
    this.bottom = BorderSide.none,
Ian Hickson's avatar
Ian Hickson committed
653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671
  }) : 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));
672
    return BorderDirectional(
Ian Hickson's avatar
Ian Hickson committed
673 674 675 676 677 678 679
      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),
    );
  }

680
  @override
Ian Hickson's avatar
Ian Hickson committed
681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702
  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;

703
  @override
Ian Hickson's avatar
Ian Hickson committed
704 705 706 707
  final BorderSide bottom;

  @override
  EdgeInsetsGeometry get dimensions {
708
    if (isUniform) {
709
      return EdgeInsetsDirectional.all(top.strokeInset);
710
    }
711
    return EdgeInsetsDirectional.fromSTEB(start.strokeInset, top.strokeInset, end.strokeInset, bottom.strokeInset);
Ian Hickson's avatar
Ian Hickson committed
712 713
  }

714
  @override
Ian Hickson's avatar
Ian Hickson committed
715 716 717 718
  bool get isUniform {
    final Color topColor = top.color;
    if (start.color != topColor ||
        end.color != topColor ||
719
        bottom.color != topColor) {
Ian Hickson's avatar
Ian Hickson committed
720
      return false;
721
    }
Ian Hickson's avatar
Ian Hickson committed
722 723 724 725

    final double topWidth = top.width;
    if (start.width != topWidth ||
        end.width != topWidth ||
726
        bottom.width != topWidth) {
Ian Hickson's avatar
Ian Hickson committed
727
      return false;
728
    }
Ian Hickson's avatar
Ian Hickson committed
729 730 731 732

    final BorderStyle topStyle = top.style;
    if (start.style != topStyle ||
        end.style != topStyle ||
733
        bottom.style != topStyle) {
Ian Hickson's avatar
Ian Hickson committed
734
      return false;
735
    }
Ian Hickson's avatar
Ian Hickson committed
736

737
    if (_strokeAlignIsUniform == false) {
738
      return false;
739
    }
740

Ian Hickson's avatar
Ian Hickson committed
741 742 743
    return true;
  }

744
  bool get _strokeAlignIsUniform {
745
    final double topStrokeAlign = top.strokeAlign;
746 747 748 749 750
    return start.strokeAlign == topStrokeAlign
        && bottom.strokeAlign == topStrokeAlign
        && end.strokeAlign == topStrokeAlign;
  }

Ian Hickson's avatar
Ian Hickson committed
751
  @override
752
  BoxBorder? add(ShapeBorder other, { bool reversed = false }) {
Ian Hickson's avatar
Ian Hickson committed
753 754 755 756 757 758 759 760 761 762 763 764 765
    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) ||
766
          !BorderSide.canMerge(typedOther.bottom, bottom)) {
Ian Hickson's avatar
Ian Hickson committed
767
        return null;
768
      }
Ian Hickson's avatar
Ian Hickson committed
769 770 771
      if (start != BorderSide.none ||
          end != BorderSide.none) {
        if (typedOther.left != BorderSide.none ||
772
            typedOther.right != BorderSide.none) {
Ian Hickson's avatar
Ian Hickson committed
773
          return null;
774
        }
Ian Hickson's avatar
Ian Hickson committed
775 776
        assert(typedOther.left == BorderSide.none);
        assert(typedOther.right == BorderSide.none);
777
        return BorderDirectional(
Ian Hickson's avatar
Ian Hickson committed
778 779 780 781 782 783 784 785
          top: BorderSide.merge(typedOther.top, top),
          start: start,
          end: end,
          bottom: BorderSide.merge(typedOther.bottom, bottom),
        );
      }
      assert(start == BorderSide.none);
      assert(end == BorderSide.none);
786
      return Border(
Ian Hickson's avatar
Ian Hickson committed
787 788 789 790 791 792 793 794 795 796 797
        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) {
798
    return BorderDirectional(
Ian Hickson's avatar
Ian Hickson committed
799 800 801 802 803 804 805 806
      top: top.scale(t),
      start: start.scale(t),
      end: end.scale(t),
      bottom: bottom.scale(t),
    );
  }

  @override
807
  ShapeBorder? lerpFrom(ShapeBorder? a, double t) {
808
    if (a is BorderDirectional) {
Ian Hickson's avatar
Ian Hickson committed
809
      return BorderDirectional.lerp(a, this, t);
810
    }
Ian Hickson's avatar
Ian Hickson committed
811 812 813 814
    return super.lerpFrom(a, t);
  }

  @override
815
  ShapeBorder? lerpTo(ShapeBorder? b, double t) {
816
    if (b is BorderDirectional) {
Ian Hickson's avatar
Ian Hickson committed
817
      return BorderDirectional.lerp(this, b, t);
818
    }
Ian Hickson's avatar
Ian Hickson committed
819 820 821 822 823 824 825
    return super.lerpTo(b, t);
  }

  /// Linearly interpolate between two borders.
  ///
  /// If a border is null, it is treated as having four [BorderSide.none]
  /// borders.
826
  ///
827
  /// {@macro dart.ui.shadow.lerp}
828
  static BorderDirectional? lerp(BorderDirectional? a, BorderDirectional? b, double t) {
829
    assert(t != null);
830
    if (a == null && b == null) {
Ian Hickson's avatar
Ian Hickson committed
831
      return null;
832 833
    }
    if (a == null) {
834
      return b!.scale(t);
835 836
    }
    if (b == null) {
Ian Hickson's avatar
Ian Hickson committed
837
      return a.scale(1.0 - t);
838
    }
839
    return BorderDirectional(
Ian Hickson's avatar
Ian Hickson committed
840 841 842
      top: BorderSide.lerp(a.top, b.top, t),
      end: BorderSide.lerp(a.end, b.end, t),
      bottom: BorderSide.lerp(a.bottom, b.bottom, t),
843
      start: BorderSide.lerp(a.start, b.start, t),
Ian Hickson's avatar
Ian Hickson committed
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
    );
  }

  /// 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
870 871 872
  void paint(
    Canvas canvas,
    Rect rect, {
873
    TextDirection? textDirection,
874
    BoxShape shape = BoxShape.rectangle,
875
    BorderRadius? borderRadius,
Ian Hickson's avatar
Ian Hickson committed
876 877 878 879 880 881
  }) {
    if (isUniform) {
      switch (top.style) {
        case BorderStyle.none:
          return;
        case BorderStyle.solid:
882 883 884 885 886 887
          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:
888
              if (borderRadius != null && borderRadius != BorderRadius.zero) {
889 890 891 892 893
                BoxBorder._paintUniformBorderWithRadius(canvas, rect, top, borderRadius);
                return;
              }
              BoxBorder._paintUniformBorderWithRectangle(canvas, rect, top);
              break;
Ian Hickson's avatar
Ian Hickson committed
894 895 896 897 898 899 900
          }
          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.');
901
    assert(_strokeAlignIsUniform && top.strokeAlign == BorderSide.strokeAlignInside, 'A Border can only draw strokeAlign different than strokeAlignInside on uniform borders.');
Ian Hickson's avatar
Ian Hickson committed
902

903
    final BorderSide left, right;
Ian Hickson's avatar
Ian Hickson committed
904
    assert(textDirection != null, 'Non-uniform BorderDirectional objects require a TextDirection when painting.');
905
    switch (textDirection!) {
Ian Hickson's avatar
Ian Hickson committed
906 907 908 909 910 911 912 913 914 915 916 917 918
      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
919
  bool operator ==(Object other) {
920
    if (identical(this, other)) {
Ian Hickson's avatar
Ian Hickson committed
921
      return true;
922 923
    }
    if (other.runtimeType != runtimeType) {
Ian Hickson's avatar
Ian Hickson committed
924
      return false;
925
    }
926 927 928 929 930
    return other is BorderDirectional
        && other.top == top
        && other.start == start
        && other.end == end
        && other.bottom == bottom;
Ian Hickson's avatar
Ian Hickson committed
931 932 933
  }

  @override
934
  int get hashCode => Object.hash(top, start, end, bottom);
Ian Hickson's avatar
Ian Hickson committed
935 936 937

  @override
  String toString() {
938 939 940 941 942 943
    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',
    ];
944
    return '${objectRuntimeType(this, 'BorderDirectional')}(${arguments.join(", ")})';
945 946
  }
}