basic.dart 206 KB
Newer Older
1 2 3 4
// Copyright 2015 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

5
import 'dart:ui' as ui show Image, ImageFilter;
6

7
import 'package:flutter/foundation.dart';
8 9
import 'package:flutter/rendering.dart';
import 'package:flutter/services.dart';
10

11
import 'debug.dart';
12
import 'framework.dart';
13
import 'localizations.dart';
14

15
export 'package:flutter/animation.dart';
16 17
export 'package:flutter/foundation.dart' show
  ChangeNotifier,
18
  FlutterErrorDetails,
19 20 21
  Listenable,
  TargetPlatform,
  ValueNotifier;
22
export 'package:flutter/painting.dart';
23
export 'package:flutter/rendering.dart' show
24 25
  AlignmentTween,
  AlignmentGeometryTween,
26 27 28 29 30
  Axis,
  BoxConstraints,
  CrossAxisAlignment,
  CustomClipper,
  CustomPainter,
31
  CustomPainterSemantics,
32
  DecorationPosition,
33 34 35 36 37
  FlexFit,
  FlowDelegate,
  FlowPaintingContext,
  FractionalOffsetTween,
  HitTestBehavior,
38
  LayerLink,
39 40 41 42 43 44 45 46 47 48 49 50 51 52 53
  MainAxisAlignment,
  MainAxisSize,
  MultiChildLayoutDelegate,
  Overflow,
  PaintingContext,
  PointerCancelEvent,
  PointerCancelEventListener,
  PointerDownEvent,
  PointerDownEventListener,
  PointerEvent,
  PointerMoveEvent,
  PointerMoveEventListener,
  PointerUpEvent,
  PointerUpEventListener,
  RelativeRect,
54
  SemanticsBuilderCallback,
55
  ShaderCallback,
56
  ShapeBorderClipper,
57
  SingleChildLayoutDelegate,
58
  StackFit,
59 60
  TextOverflow,
  ValueChanged,
Adam Barth's avatar
Adam Barth committed
61 62 63
  ValueGetter,
  WrapAlignment,
  WrapCrossAlignment;
64

65 66 67 68
// Examples can assume:
// class TestWidget extends StatelessWidget { @override Widget build(BuildContext context) => const Placeholder(); }
// WidgetTester tester;

69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108
// BIDIRECTIONAL TEXT SUPPORT

/// A widget that determines the ambient directionality of text and
/// text-direction-sensitive render objects.
///
/// For example, [Padding] depends on the [Directionality] to resolve
/// [EdgeInsetsDirectional] objects into absolute [EdgeInsets] objects.
class Directionality extends InheritedWidget {
  /// Creates a widget that determines the directionality of text and
  /// text-direction-sensitive render objects.
  ///
  /// The [textDirection] and [child] arguments must not be null.
  const Directionality({
    Key key,
    @required this.textDirection,
    @required Widget child
  }) : assert(textDirection != null),
       assert(child != null),
       super(key: key, child: child);

  /// The text direction for this subtree.
  final TextDirection textDirection;

  /// The text direction from the closest instance of this class that encloses
  /// the given context.
  ///
  /// If there is no [Directionality] ancestor widget in the tree at the given
  /// context, then this will return null.
  ///
  /// Typical usage is as follows:
  ///
  /// ```dart
  /// TextDirection textDirection = Directionality.of(context);
  /// ```
  static TextDirection of(BuildContext context) {
    final Directionality widget = context.inheritFromWidgetOfExactType(Directionality);
    return widget?.textDirection;
  }

  @override
109
  bool updateShouldNotify(Directionality oldWidget) => textDirection != oldWidget.textDirection;
110 111

  @override
112 113 114
  void debugFillProperties(DiagnosticPropertiesBuilder properties) {
    super.debugFillProperties(properties);
    properties.add(new EnumProperty<TextDirection>('textDirection', textDirection));
115 116 117 118
  }
}


119 120
// PAINTING NODES

121
/// A widget that makes its child partially transparent.
122 123 124 125
///
/// This class paints its child into an intermediate buffer and then blends the
/// child back into the scene partially transparent.
///
Ian Hickson's avatar
Ian Hickson committed
126 127 128 129
/// For values of opacity other than 0.0 and 1.0, this class is relatively
/// expensive because it requires painting the child into an intermediate
/// buffer. For the value 0.0, the child is simply not painted at all. For the
/// value 1.0, the child is painted immediately without an intermediate buffer.
130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145
///
/// ## Sample code
///
/// This example shows some [Text] when the `_visible` member field is true, and
/// hides it when it is false:
///
/// ```dart
/// new Opacity(
///   opacity: _visible ? 1.0 : 0.0,
///   child: const Text('Now you see me, now you don\'t!'),
/// )
/// ```
///
/// This is more efficient than adding and removing the child widget from the
/// tree on demand.
///
146 147 148 149 150 151 152 153 154
/// ## Opacity Animation
///
/// [Opacity] animations should be built using [AnimatedOpacity] rather than
/// manually rebuilding the [Opacity] widget.
///
/// Animating an [Opacity] widget directly causes the widget (and possibly its
/// subtree) to rebuild each frame, which is not very efficient. Consider using
/// an [AnimatedOpacity] instead.
///
155 156 157
/// See also:
///
///  * [ShaderMask], which can apply more elaborate effects to its child.
158 159
///  * [Transform], which applies an arbitrary transform to its child widget at
///    paint time.
160 161 162 163
///  * [AnimatedOpacity], which uses an animation internally to efficiently
///    animate opacity.
///  * [FadeTransition], which uses a provided animation to efficiently animate
///    opacity.
164
class Opacity extends SingleChildRenderObjectWidget {
165 166 167 168
  /// Creates a widget that makes its child partially transparent.
  ///
  /// The [opacity] argument must not be null and must be between 0.0 and 1.0
  /// (inclusive).
169
  const Opacity({
170 171
    Key key,
    @required this.opacity,
172
    Widget child,
173 174
  }) : assert(opacity != null && opacity >= 0.0 && opacity <= 1.0),
       super(key: key, child: child);
175

176 177 178 179
  /// The fraction to scale the child's alpha value.
  ///
  /// An opacity of 1.0 is fully opaque. An opacity of 0.0 is fully transparent
  /// (i.e., invisible).
Ian Hickson's avatar
Ian Hickson committed
180 181 182 183 184 185
  ///
  /// The opacity must not be null.
  ///
  /// Values 1.0 and 0.0 are painted with a fast path. Other values
  /// require painting the child into an intermediate buffer, which is
  /// expensive.
186 187
  final double opacity;

188
  @override
189
  RenderOpacity createRenderObject(BuildContext context) => new RenderOpacity(opacity: opacity);
190

191
  @override
192
  void updateRenderObject(BuildContext context, RenderOpacity renderObject) {
193
    renderObject.opacity = opacity;
194
  }
195

196
  @override
197 198 199
  void debugFillProperties(DiagnosticPropertiesBuilder properties) {
    super.debugFillProperties(properties);
    properties.add(new DoubleProperty('opacity', opacity));
200
  }
201 202
}

203
/// A widget that applies a mask generated by a [Shader] to its child.
204 205
///
/// For example, [ShaderMask] can be used to gradually fade out the edge
206
/// of a child by using a [new ui.Gradient.linear] mask.
207 208 209 210 211 212 213 214 215
///
/// ## Sample code
///
/// This example makes the text look like it is on fire:
///
/// ```dart
/// new ShaderMask(
///   shaderCallback: (Rect bounds) {
///     return new RadialGradient(
216
///       center: Alignment.topLeft,
217 218 219 220 221 222 223 224 225 226 227 228 229 230
///       radius: 1.0,
///       colors: <Color>[Colors.yellow, Colors.deepOrange.shade900],
///       tileMode: TileMode.mirror,
///     ).createShader(bounds);
///   },
///   child: const Text('I’m burning the memories'),
/// )
/// ```
///
/// See also:
///
///  * [Opacity], which can apply a uniform alpha effect to its child.
///  * [CustomPaint], which lets you draw directly on the canvas.
///  * [DecoratedBox], for another approach at decorating child widgets.
231
///  * [BackdropFilter], which applies an image filter to the background.
232
class ShaderMask extends SingleChildRenderObjectWidget {
233 234
  /// Creates a widget that applies a mask generated by a [Shader] to its child.
  ///
235
  /// The [shaderCallback] and [blendMode] arguments must not be null.
236
  const ShaderMask({
Hans Muller's avatar
Hans Muller committed
237
    Key key,
238
    @required this.shaderCallback,
239
    this.blendMode = BlendMode.modulate,
Hans Muller's avatar
Hans Muller committed
240
    Widget child
241 242 243
  }) : assert(shaderCallback != null),
       assert(blendMode != null),
       super(key: key, child: child);
Hans Muller's avatar
Hans Muller committed
244

245
  /// Called to create the [dart:ui.Shader] that generates the mask.
246 247 248
  ///
  /// The shader callback is called with the current size of the child so that
  /// it can customize the shader to the size and location of the child.
249
  ///
250
  /// Typically this will use a [LinearGradient], [RadialGradient], or
251
  /// [SweepGradient] to create the [dart:ui.Shader], though the
252
  /// [dart:ui.ImageShader] class could also be used.
Hans Muller's avatar
Hans Muller committed
253
  final ShaderCallback shaderCallback;
254

255
  /// The [BlendMode] to use when applying the shader to the child.
256
  ///
257 258 259
  /// The default, [BlendMode.modulate], is useful for applying an alpha blend
  /// to the child. Other blend modes can be used to create other effects.
  final BlendMode blendMode;
Hans Muller's avatar
Hans Muller committed
260

261
  @override
262
  RenderShaderMask createRenderObject(BuildContext context) {
Hans Muller's avatar
Hans Muller committed
263 264
    return new RenderShaderMask(
      shaderCallback: shaderCallback,
265
      blendMode: blendMode,
Hans Muller's avatar
Hans Muller committed
266 267 268
    );
  }

269
  @override
270
  void updateRenderObject(BuildContext context, RenderShaderMask renderObject) {
271 272
    renderObject
      ..shaderCallback = shaderCallback
273
      ..blendMode = blendMode;
Hans Muller's avatar
Hans Muller committed
274 275 276
  }
}

277
/// A widget that applies a filter to the existing painted content and then paints [child].
278 279 280
///
/// This effect is relatively expensive, especially if the filter is non-local,
/// such as a blur.
281 282 283 284 285
///
/// See also:
///
///  * [DecoratedBox], which draws a background under (or over) a widget.
///  * [Opacity], which changes the opacity of the widget itself.
286
class BackdropFilter extends SingleChildRenderObjectWidget {
287 288 289
  /// Creates a backdrop filter.
  ///
  /// The [filter] argument must not be null.
290
  const BackdropFilter({
291
    Key key,
292
    @required this.filter,
293
    Widget child
294 295
  }) : assert(filter != null),
       super(key: key, child: child);
296

297 298
  /// The image filter to apply to the existing painted content before painting the child.
  ///
299
  /// For example, consider using [ImageFilter.blur] to create a backdrop
300
  /// blur effect
301 302 303 304 305 306 307 308 309 310 311 312 313
  final ui.ImageFilter filter;

  @override
  RenderBackdropFilter createRenderObject(BuildContext context) {
    return new RenderBackdropFilter(filter: filter);
  }

  @override
  void updateRenderObject(BuildContext context, RenderBackdropFilter renderObject) {
    renderObject.filter = filter;
  }
}

314
/// A widget that provides a canvas on which to draw during the paint phase.
315
///
316
/// When asked to paint, [CustomPaint] first asks its [painter] to paint on the
317
/// current canvas, then it paints its child, and then, after painting its
318
/// child, it asks its [foregroundPainter] to paint. The coordinate system of the
319 320
/// canvas matches the coordinate system of the [CustomPaint] object. The
/// painters are expected to paint within a rectangle starting at the origin and
321
/// encompassing a region of the given size. (If the painters paint outside
322 323
/// those bounds, there might be insufficient memory allocated to rasterize the
/// painting commands and the resulting behavior is undefined.)
324
///
325 326
/// Painters are implemented by subclassing [CustomPainter].
///
Ian Hickson's avatar
Ian Hickson committed
327 328 329 330 331 332
/// Because custom paint calls its painters during paint, you cannot call
/// `setState` or `markNeedsLayout` during the callback (the layout for this
/// frame has already happened).
///
/// Custom painters normally size themselves to their child. If they do not have
/// a child, they attempt to size themselves to the [size], which defaults to
333
/// [Size.zero]. [size] must not be null.
334 335 336
///
/// [isComplex] and [willChange] are hints to the compositor's raster cache
/// and must not be null.
337
///
338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356
/// ## Sample code
///
/// This example shows how the sample custom painter shown at [CustomPainter]
/// could be used in a [CustomPaint] widget to display a background to some
/// text.
///
/// ```dart
/// new CustomPaint(
///   painter: new Sky(),
///   child: new Center(
///     child: new Text(
///       'Once upon a time...',
///       style: const TextStyle(
///         fontSize: 40.0,
///         fontWeight: FontWeight.w900,
///         color: const Color(0xFFFFFFFF),
///       ),
///     ),
///   ),
357
/// )
358 359
/// ```
///
360 361
/// See also:
///
362 363
///  * [CustomPainter], the class to extend when creating custom painters.
///  * [Canvas], the class that a custom painter uses to paint.
364
class CustomPaint extends SingleChildRenderObjectWidget {
365
  /// Creates a widget that delegates its painting.
366 367 368 369
  const CustomPaint({
    Key key,
    this.painter,
    this.foregroundPainter,
370 371 372
    this.size = Size.zero,
    this.isComplex = false,
    this.willChange = false,
373
    Widget child,
374 375 376 377
  }) : assert(size != null),
       assert(isComplex != null),
       assert(willChange != null),
       super(key: key, child: child);
378

379
  /// The painter that paints before the children.
380
  final CustomPainter painter;
381 382

  /// The painter that paints after the children.
383
  final CustomPainter foregroundPainter;
Adam Barth's avatar
Adam Barth committed
384

Ian Hickson's avatar
Ian Hickson committed
385 386 387 388 389 390 391 392 393
  /// The size that this [CustomPaint] should aim for, given the layout
  /// constraints, if there is no child.
  ///
  /// Defaults to [Size.zero].
  ///
  /// If there's a child, this is ignored, and the size of the child is used
  /// instead.
  final Size size;

394 395 396 397
  /// Whether the painting is complex enough to benefit from caching.
  ///
  /// The compositor contains a raster cache that holds bitmaps of layers in
  /// order to avoid the cost of repeatedly rendering those layers on each
398
  /// frame. If this flag is not set, then the compositor will apply its own
399 400 401 402 403 404 405 406
  /// heuristics to decide whether the this layer is complex enough to benefit
  /// from caching.
  final bool isComplex;

  /// Whether the raster cache should be told that this painting is likely
  /// to change in the next frame.
  final bool willChange;

407
  @override
408 409 410 411 412
  RenderCustomPaint createRenderObject(BuildContext context) {
    return new RenderCustomPaint(
      painter: painter,
      foregroundPainter: foregroundPainter,
      preferredSize: size,
413 414
      isComplex: isComplex,
      willChange: willChange,
415 416
    );
  }
417

418
  @override
419
  void updateRenderObject(BuildContext context, RenderCustomPaint renderObject) {
420 421
    renderObject
      ..painter = painter
Ian Hickson's avatar
Ian Hickson committed
422
      ..foregroundPainter = foregroundPainter
423 424 425
      ..preferredSize = size
      ..isComplex = isComplex
      ..willChange = willChange;
426 427
  }

428
  @override
429
  void didUnmountRenderObject(RenderCustomPaint renderObject) {
430 431 432
    renderObject
      ..painter = null
      ..foregroundPainter = null;
433 434 435
  }
}

436
/// A widget that clips its child using a rectangle.
437
///
438
/// By default, [ClipRect] prevents its child from painting outside its
439 440
/// bounds, but the size and location of the clip rect can be customized using a
/// custom [clipper].
441 442
///
/// [ClipRect] is commonly used with these widgets, which commonly paint outside
443
/// their bounds:
444 445 446 447 448 449 450 451 452
///
///  * [CustomPaint]
///  * [CustomSingleChildLayout]
///  * [CustomMultiChildLayout]
///  * [Align] and [Center] (e.g., if [Align.widthFactor] or
///    [Align.heightFactor] is less than 1.0).
///  * [OverflowBox]
///  * [SizedOverflowBox]
///
453
/// ## Sample code
454
///
455 456
/// For example, by combining a [ClipRect] with an [Align], one can show just
/// the top half of an [Image]:
457 458 459 460
///
/// ```dart
/// new ClipRect(
///   child: new Align(
461
///     alignment: Alignment.topCenter,
462
///     heightFactor: 0.5,
463
///     child: new Image.network(userAvatarUrl),
464
///   ),
465
/// )
466 467 468 469 470 471 472 473
/// ```
///
/// See also:
///
///  * [CustomClipper], for information about creating custom clips.
///  * [ClipRRect], for a clip with rounded corners.
///  * [ClipOval], for an elliptical clip.
///  * [ClipPath], for an arbitrarily shaped clip.
474
class ClipRect extends SingleChildRenderObjectWidget {
475 476 477 478
  /// Creates a rectangular clip.
  ///
  /// If [clipper] is null, the clip will match the layout size and position of
  /// the child.
479
  const ClipRect({ Key key, this.clipper, Widget child }) : super(key: key, child: child);
480

481
  /// If non-null, determines which clip to use.
482 483
  final CustomClipper<Rect> clipper;

484
  @override
485
  RenderClipRect createRenderObject(BuildContext context) => new RenderClipRect(clipper: clipper);
486

487
  @override
488
  void updateRenderObject(BuildContext context, RenderClipRect renderObject) {
489 490 491
    renderObject.clipper = clipper;
  }

492
  @override
493 494 495
  void didUnmountRenderObject(RenderClipRect renderObject) {
    renderObject.clipper = null;
  }
496 497

  @override
498 499 500
  void debugFillProperties(DiagnosticPropertiesBuilder properties) {
    super.debugFillProperties(properties);
    properties.add(new DiagnosticsProperty<CustomClipper<Rect>>('clipper', clipper, defaultValue: null));
501
  }
502 503
}

504
/// A widget that clips its child using a rounded rectangle.
505
///
506 507 508
/// By default, [ClipRRect] uses its own bounds as the base rectangle for the
/// clip, but the size and location of the clip can be customized using a custom
/// [clipper].
509 510 511 512 513 514 515
///
/// See also:
///
///  * [CustomClipper], for information about creating custom clips.
///  * [ClipRect], for more efficient clips without rounded corners.
///  * [ClipOval], for an elliptical clip.
///  * [ClipPath], for an arbitrarily shaped clip.
516
class ClipRRect extends SingleChildRenderObjectWidget {
517
  /// Creates a rounded-rectangular clip.
518 519 520 521 522
  ///
  /// The [borderRadius] defaults to [BorderRadius.zero], i.e. a rectangle with
  /// right-angled corners.
  ///
  /// If [clipper] is non-null, then [borderRadius] is ignored.
523
  const ClipRRect({
524
    Key key,
525 526 527
    this.borderRadius,
    this.clipper,
    Widget child,
528 529
  }) : assert(borderRadius != null || clipper != null),
       super(key: key, child: child);
530

531
  /// The border radius of the rounded corners.
532
  ///
533 534 535 536
  /// Values are clamped so that horizontal and vertical radii sums do not
  /// exceed width/height.
  ///
  /// This value is ignored if [clipper] is non-null.
537
  final BorderRadius borderRadius;
538

539 540 541
  /// If non-null, determines which clip to use.
  final CustomClipper<RRect> clipper;

542
  @override
543
  RenderClipRRect createRenderObject(BuildContext context) => new RenderClipRRect(borderRadius: borderRadius, clipper: clipper);
544

545
  @override
546
  void updateRenderObject(BuildContext context, RenderClipRRect renderObject) {
547
    renderObject
548 549
      ..borderRadius = borderRadius
      ..clipper = clipper;
550
  }
551 552

  @override
553 554 555 556
  void debugFillProperties(DiagnosticPropertiesBuilder properties) {
    super.debugFillProperties(properties);
    properties.add(new DiagnosticsProperty<BorderRadius>('borderRadius', borderRadius, showName: false, defaultValue: null));
    properties.add(new DiagnosticsProperty<CustomClipper<RRect>>('clipper', clipper, defaultValue: null));
557
  }
558 559
}

560
/// A widget that clips its child using an oval.
561
///
562 563 564
/// By default, inscribes an axis-aligned oval into its layout dimensions and
/// prevents its child from painting outside that oval, but the size and
/// location of the clip oval can be customized using a custom [clipper].
565 566 567 568 569 570 571 572
/// See also:
///
/// See also:
///
///  * [CustomClipper], for information about creating custom clips.
///  * [ClipRect], for more efficient clips without rounded corners.
///  * [ClipRRect], for a clip with rounded corners.
///  * [ClipPath], for an arbitrarily shaped clip.
573
class ClipOval extends SingleChildRenderObjectWidget {
574 575 576 577
  /// Creates an oval-shaped clip.
  ///
  /// If [clipper] is null, the oval will be inscribed into the layout size and
  /// position of the child.
578
  const ClipOval({ Key key, this.clipper, Widget child }) : super(key: key, child: child);
579

580
  /// If non-null, determines which clip to use.
Ian Hickson's avatar
Ian Hickson committed
581 582 583 584 585 586 587 588
  ///
  /// The delegate returns a rectangle that describes the axis-aligned
  /// bounding box of the oval. The oval's axes will themselves also
  /// be axis-aligned.
  ///
  /// If the [clipper] delegate is null, then the oval uses the
  /// widget's bounding box (the layout dimensions of the render
  /// object) instead.
589 590
  final CustomClipper<Rect> clipper;

591
  @override
592
  RenderClipOval createRenderObject(BuildContext context) => new RenderClipOval(clipper: clipper);
593

594
  @override
595
  void updateRenderObject(BuildContext context, RenderClipOval renderObject) {
596 597 598
    renderObject.clipper = clipper;
  }

599
  @override
600 601 602
  void didUnmountRenderObject(RenderClipOval renderObject) {
    renderObject.clipper = null;
  }
603 604

  @override
605 606 607
  void debugFillProperties(DiagnosticPropertiesBuilder properties) {
    super.debugFillProperties(properties);
    properties.add(new DiagnosticsProperty<CustomClipper<Rect>>('clipper', clipper, defaultValue: null));
608
  }
609 610
}

611
/// A widget that clips its child using a path.
Ian Hickson's avatar
Ian Hickson committed
612
///
613
/// Calls a callback on a delegate whenever the widget is to be
Ian Hickson's avatar
Ian Hickson committed
614 615 616 617 618 619 620 621 622 623
/// painted. The callback returns a path and the widget prevents the
/// child from painting outside the path.
///
/// Clipping to a path is expensive. Certain shapes have more
/// optimized widgets:
///
///  * To clip to a rectangle, consider [ClipRect].
///  * To clip to an oval or circle, consider [ClipOval].
///  * To clip to a rounded rectangle, consider [ClipRRect].
class ClipPath extends SingleChildRenderObjectWidget {
624 625 626 627 628 629
  /// Creates a path clip.
  ///
  /// If [clipper] is null, the clip will be a rectangle that matches the layout
  /// size and location of the child. However, rather than use this default,
  /// consider using a [ClipRect], which can achieve the same effect more
  /// efficiently.
630
  const ClipPath({ Key key, this.clipper, Widget child }) : super(key: key, child: child);
Ian Hickson's avatar
Ian Hickson committed
631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650

  /// If non-null, determines which clip to use.
  ///
  /// The default clip, which is used if this property is null, is the
  /// bounding box rectangle of the widget. [ClipRect] is a more
  /// efficient way of obtaining that effect.
  final CustomClipper<Path> clipper;

  @override
  RenderClipPath createRenderObject(BuildContext context) => new RenderClipPath(clipper: clipper);

  @override
  void updateRenderObject(BuildContext context, RenderClipPath renderObject) {
    renderObject.clipper = clipper;
  }

  @override
  void didUnmountRenderObject(RenderClipPath renderObject) {
    renderObject.clipper = null;
  }
651 652

  @override
653 654 655
  void debugFillProperties(DiagnosticPropertiesBuilder properties) {
    super.debugFillProperties(properties);
    properties.add(new DiagnosticsProperty<CustomClipper<Path>>('clipper', clipper, defaultValue: null));
656
  }
Ian Hickson's avatar
Ian Hickson committed
657 658
}

659
/// A widget representing a physical layer that clips its children to a shape.
660 661 662
///
/// Physical layers cast shadows based on an [elevation] which is nominally in
/// logical pixels, coming vertically out of the rendering surface.
663
///
664 665 666
/// For shapes that cannot be expressed as a rectangle with rounded corners use
/// [PhysicalShape].
///
667 668 669 670
/// See also:
///
///  * [DecoratedBox], which can apply more arbitrary shadow effects.
///  * [ClipRect], which applies a clip to its child.
671 672
class PhysicalModel extends SingleChildRenderObjectWidget {
  /// Creates a physical model with a rounded-rectangular clip.
673 674 675
  ///
  /// The [color] is required; physical things have a color.
  ///
676
  /// The [shape], [elevation], [color], and [shadowColor] must not be null.
677
  const PhysicalModel({
678
    Key key,
679
    this.shape = BoxShape.rectangle,
680
    this.borderRadius,
681
    this.elevation = 0.0,
682
    @required this.color,
683
    this.shadowColor = const Color(0xFF000000),
684
    Widget child,
685 686 687
  }) : assert(shape != null),
       assert(elevation != null),
       assert(color != null),
688
       assert(shadowColor != null),
689
       super(key: key, child: child);
690 691 692 693 694 695 696 697

  /// The type of shape.
  final BoxShape shape;

  /// The border radius of the rounded corners.
  ///
  /// Values are clamped so that horizontal and vertical radii sums do not
  /// exceed width/height.
698 699
  ///
  /// This is ignored if the [shape] is not [BoxShape.rectangle].
700 701 702
  final BorderRadius borderRadius;

  /// The z-coordinate at which to place this physical object.
703
  final double elevation;
704 705 706 707

  /// The background color.
  final Color color;

708 709 710
  /// The shadow color.
  final Color shadowColor;

711
  @override
712 713 714 715 716 717 718 719
  RenderPhysicalModel createRenderObject(BuildContext context) {
    return new RenderPhysicalModel(
      shape: shape,
      borderRadius: borderRadius,
      elevation: elevation, color: color,
      shadowColor: shadowColor,
    );
  }
720 721 722 723 724 725 726

  @override
  void updateRenderObject(BuildContext context, RenderPhysicalModel renderObject) {
    renderObject
      ..shape = shape
      ..borderRadius = borderRadius
      ..elevation = elevation
727 728
      ..color = color
      ..shadowColor = shadowColor;
729
  }
730 731

  @override
732 733 734 735 736 737 738
  void debugFillProperties(DiagnosticPropertiesBuilder properties) {
    super.debugFillProperties(properties);
    properties.add(new EnumProperty<BoxShape>('shape', shape));
    properties.add(new DiagnosticsProperty<BorderRadius>('borderRadius', borderRadius));
    properties.add(new DoubleProperty('elevation', elevation));
    properties.add(new DiagnosticsProperty<Color>('color', color));
    properties.add(new DiagnosticsProperty<Color>('shadowColor', shadowColor));
739
  }
740
}
741

742 743 744 745 746 747 748
/// A widget representing a physical layer that clips its children to a path.
///
/// Physical layers cast shadows based on an [elevation] which is nominally in
/// logical pixels, coming vertically out of the rendering surface.
///
/// [PhysicalModel] does the same but only supports shapes that can be expressed
/// as rectangles with rounded corners.
749 750 751 752 753
///
/// See also:
///
///  * [ShapeBorderClipper], which converts a [ShapeBorder] to a [CustomerClipper], as
///    needed by this widget.
754 755 756 757 758 759 760 761 762
class PhysicalShape extends SingleChildRenderObjectWidget {
  /// Creates a physical model with an arbitrary shape clip.
  ///
  /// The [color] is required; physical things have a color.
  ///
  /// The [clipper], [elevation], [color], and [shadowColor] must not be null.
  const PhysicalShape({
    Key key,
    @required this.clipper,
763
    this.elevation = 0.0,
764
    @required this.color,
765
    this.shadowColor = const Color(0xFF000000),
766 767 768 769 770 771 772 773
    Widget child,
  }) : assert(clipper != null),
       assert(elevation != null),
       assert(color != null),
       assert(shadowColor != null),
       super(key: key, child: child);

  /// Determines which clip to use.
774 775 776 777
  ///
  /// If the path in question is expressed as a [ShapeBorder] subclass,
  /// consider using the [ShapeBorderClipper] delegate class to adapt the
  /// shape for use with this widget.
778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808
  final CustomClipper<Path> clipper;

  /// The z-coordinate at which to place this physical object.
  final double elevation;

  /// The background color.
  final Color color;

  /// When elevation is non zero the color to use for the shadow color.
  final Color shadowColor;

  @override
  RenderPhysicalShape createRenderObject(BuildContext context) {
    return new RenderPhysicalShape(
      clipper: clipper,
      elevation: elevation,
      color: color,
      shadowColor: shadowColor
    );
  }

  @override
  void updateRenderObject(BuildContext context, RenderPhysicalShape renderObject) {
    renderObject
      ..clipper = clipper
      ..elevation = elevation
      ..color = color
      ..shadowColor = shadowColor;
  }

  @override
809 810 811 812 813 814
  void debugFillProperties(DiagnosticPropertiesBuilder properties) {
    super.debugFillProperties(properties);
    properties.add(new DiagnosticsProperty<CustomClipper<Path>>('clipper', clipper));
    properties.add(new DoubleProperty('elevation', elevation));
    properties.add(new DiagnosticsProperty<Color>('color', color));
    properties.add(new DiagnosticsProperty<Color>('shadowColor', shadowColor));
815 816 817
  }
}

818 819
// POSITIONING AND SIZING NODES

820
/// A widget that applies a transformation before painting its child.
821 822 823 824 825 826 827 828 829 830
///
/// ## Sample code
///
/// This example rotates and skews an orange box containing text, keeping the
/// top right corner pinned to its original position.
///
/// ```dart
/// new Container(
///   color: Colors.black,
///   child: new Transform(
831
///     alignment: Alignment.topRight,
832
///     transform: new Matrix4.skewY(0.3)..rotateZ(-math.pi / 12.0),
833 834 835 836 837 838 839 840 841 842
///     child: new Container(
///       padding: const EdgeInsets.all(8.0),
///       color: const Color(0xFFE8581C),
///       child: const Text('Apartment for rent!'),
///     ),
///   ),
/// )
/// ```
///
/// See also:
843
///
844 845
///  * [RotatedBox], which rotates the child widget during layout, not just
///    during painting.
846 847
///  * [FractionalTranslation], which applies a translation to the child
///    that is relative to the child's size.
848 849
///  * [FittedBox], which sizes and positions its child widget to fit the parent
///    according to a given [BoxFit] discipline.
850
class Transform extends SingleChildRenderObjectWidget {
851 852 853
  /// Creates a widget that transforms its child.
  ///
  /// The [transform] argument must not be null.
854
  const Transform({
855
    Key key,
856
    @required this.transform,
857 858
    this.origin,
    this.alignment,
859
    this.transformHitTests = true,
860
    Widget child,
861 862
  }) : assert(transform != null),
       super(key: key, child: child);
863

864 865 866 867 868 869 870 871 872 873 874 875 876
  /// Creates a widget that transforms its child using a rotation around the
  /// center.
  ///
  /// The `angle` argument must not be null. It gives the rotation in clockwise
  /// radians.
  ///
  /// ## Sample code
  ///
  /// This example rotates an orange box containing text around its center by
  /// fifteen degrees.
  ///
  /// ```dart
  /// new Transform.rotate(
877
  ///   angle: -math.pi / 12.0,
878 879 880 881 882 883 884 885 886 887 888
  ///   child: new Container(
  ///     padding: const EdgeInsets.all(8.0),
  ///     color: const Color(0xFFE8581C),
  ///     child: const Text('Apartment for rent!'),
  ///   ),
  /// )
  /// ```
  Transform.rotate({
    Key key,
    @required double angle,
    this.origin,
889 890
    this.alignment = Alignment.center,
    this.transformHitTests = true,
891 892 893 894
    Widget child,
  }) : transform = new Matrix4.rotationZ(angle),
       super(key: key, child: child);

895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915
  /// Creates a widget that transforms its child using a translation.
  ///
  /// The `offset` argument must not be null. It specifies the translation.
  ///
  /// ## Sample code
  ///
  /// This example shifts the silver-colored child down by fifteen pixels.
  ///
  /// ```dart
  /// new Transform.translate(
  ///   offset: const Offset(0.0, 15.0),
  ///   child: new Container(
  ///     padding: const EdgeInsets.all(8.0),
  ///     color: const Color(0xFF7F7F7F),
  ///     child: const Text('Quarter'),
  ///   ),
  /// )
  /// ```
  Transform.translate({
    Key key,
    @required Offset offset,
916
    this.transformHitTests = true,
917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949
    Widget child,
  }) : transform = new Matrix4.translationValues(offset.dx, offset.dy, 0.0),
       origin = null,
       alignment = null,
       super(key: key, child: child);

  /// Creates a widget that scales its child uniformly.
  ///
  /// The `scale` argument must not be null. It gives the scalar by which
  /// to multiply the `x` and `y` axes.
  ///
  /// The [alignment] controls the origin of the scale; by default, this is
  /// the center of the box.
  ///
  /// ## Sample code
  ///
  /// This example shrinks an orange box containing text such that each dimension
  /// is half the size it would otherwise be.
  ///
  /// ```dart
  /// new Transform.scale(
  ///   scale: 0.5,
  ///   child: new Container(
  ///     padding: const EdgeInsets.all(8.0),
  ///     color: const Color(0xFFE8581C),
  ///     child: const Text('Bad Ideas'),
  ///   ),
  /// )
  /// ```
  Transform.scale({
    Key key,
    @required double scale,
    this.origin,
950 951
    this.alignment = Alignment.center,
    this.transformHitTests = true,
952 953 954 955
    Widget child,
  }) : transform = new Matrix4.diagonal3Values(scale, scale, 1.0),
       super(key: key, child: child);

956
  /// The matrix to transform the child by during painting.
957
  final Matrix4 transform;
958 959 960 961 962 963

  /// The origin of the coordinate system (relative to the upper left corder of
  /// this render object) in which to apply the matrix.
  ///
  /// Setting an origin is equivalent to conjugating the transform matrix by a
  /// translation. This property is provided just for convenience.
964
  final Offset origin;
965 966 967 968

  /// The alignment of the origin, relative to the size of the box.
  ///
  /// This is equivalent to setting an origin based on the size of the box.
969 970 971 972 973 974 975 976 977
  /// If it is specified at the same time as the [origin], both are applied.
  ///
  /// An [AlignmentDirectional.start] value is the same as an [Alignment]
  /// whose [Alignment.x] value is `-1.0` if [textDirection] is
  /// [TextDirection.ltr], and `1.0` if [textDirection] is [TextDirection.rtl].
  /// Similarly [AlignmentDirectional.end] is the same as an [Alignment]
  /// whose [Alignment.x] value is `1.0` if [textDirection] is
  /// [TextDirection.ltr], and `-1.0` if [textDirection] is [TextDirection.rtl].
  final AlignmentGeometry alignment;
978

979
  /// Whether to apply the transformation when performing hit tests.
980 981
  final bool transformHitTests;

982
  @override
983 984 985 986 987
  RenderTransform createRenderObject(BuildContext context) {
    return new RenderTransform(
      transform: transform,
      origin: origin,
      alignment: alignment,
988
      textDirection: Directionality.of(context),
989 990 991
      transformHitTests: transformHitTests
    );
  }
992

993
  @override
994
  void updateRenderObject(BuildContext context, RenderTransform renderObject) {
995 996 997 998
    renderObject
      ..transform = transform
      ..origin = origin
      ..alignment = alignment
999
      ..textDirection = Directionality.of(context)
1000
      ..transformHitTests = transformHitTests;
1001 1002 1003
  }
}

1004
/// A widget that can be targeted by a [CompositedTransformFollower].
1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090
///
/// When this widget is composited during the compositing phase (which comes
/// after the paint phase, as described in [WidgetsBinding.drawFrame]), it
/// updates the [link] object so that any [CompositedTransformFollower] widgets
/// that are subsequently composited in the same frame and were given the same
/// [LayerLink] can position themselves at the same screen location.
///
/// A single [CompositedTransformTarget] can be followed by multiple
/// [CompositedTransformFollower] widgets.
///
/// The [CompositedTransformTarget] must come earlier in the paint order than
/// any linked [CompositedTransformFollower]s.
///
/// See also:
///
///  * [CompositedTransformFollower], the widget that can target this one.
///  * [LeaderLayer], the layer that implements this widget's logic.
class CompositedTransformTarget extends SingleChildRenderObjectWidget {
  /// Creates a composited transform target widget.
  ///
  /// The [link] property must not be null, and must not be currently being used
  /// by any other [CompositedTransformTarget] object that is in the tree.
  const CompositedTransformTarget({
    Key key,
    @required this.link,
    Widget child,
  }) : assert(link != null),
       super(key: key, child: child);

  /// The link object that connects this [CompositedTransformTarget] with one or
  /// more [CompositedTransformFollower]s.
  ///
  /// This property must not be null. The object must not be associated with
  /// another [CompositedTransformTarget] that is also being painted.
  final LayerLink link;

  @override
  RenderLeaderLayer createRenderObject(BuildContext context) {
    return new RenderLeaderLayer(
      link: link,
    );
  }

  @override
  void updateRenderObject(BuildContext context, RenderLeaderLayer renderObject) {
    renderObject
      ..link = link;
  }
}

/// A widget that follows a [CompositedTransformTarget].
///
/// When this widget is composited during the compositing phase (which comes
/// after the paint phase, as described in [WidgetsBinding.drawFrame]), it
/// applies a transformation that causes it to provide its child with a
/// coordinate space that matches that of the linked [CompositedTransformTarget]
/// widget, offset by [offset].
///
/// The [LayerLink] object used as the [link] must be the same object as that
/// provided to the matching [CompositedTransformTarget].
///
/// The [CompositedTransformTarget] must come earlier in the paint order than
/// this [CompositedTransformFollower].
///
/// Hit testing on descendants of this widget will only work if the target
/// position is within the box that this widget's parent considers to be
/// hitable. If the parent covers the screen, this is trivially achievable, so
/// this widget is usually used as the root of an [OverlayEntry] in an app-wide
/// [Overlay] (e.g. as created by the [MaterialApp] widget's [Navigator]).
///
/// See also:
///
///  * [CompositedTransformTarget], the widget that this widget can target.
///  * [FollowerLayer], the layer that implements this widget's logic.
///  * [Transform], which applies an arbitrary transform to a child.
class CompositedTransformFollower extends SingleChildRenderObjectWidget {
  /// Creates a composited transform target widget.
  ///
  /// The [link] property must not be null. If it was also provided to a
  /// [CompositedTransformTarget], that widget must come earlier in the paint
  /// order.
  ///
  /// The [showWhenUnlinked] and [offset] properties must also not be null.
  const CompositedTransformFollower({
    Key key,
    @required this.link,
1091 1092
    this.showWhenUnlinked = true,
    this.offset = Offset.zero,
1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137
    Widget child,
  }) : assert(link != null),
       assert(showWhenUnlinked != null),
       assert(offset != null),
       super(key: key, child: child);

  /// The link object that connects this [CompositedTransformFollower] with a
  /// [CompositedTransformTarget].
  ///
  /// This property must not be null.
  final LayerLink link;

  /// Whether to show the widget's contents when there is no corresponding
  /// [CompositedTransformTarget] with the same [link].
  ///
  /// When the widget is linked, the child is positioned such that it has the
  /// same global position as the linked [CompositedTransformTarget].
  ///
  /// When the widget is not linked, then: if [showWhenUnlinked] is true, the
  /// child is visible and not repositioned; if it is false, then child is
  /// hidden.
  final bool showWhenUnlinked;

  /// The offset to apply to the origin of the linked
  /// [CompositedTransformTarget] to obtain this widget's origin.
  final Offset offset;

  @override
  RenderFollowerLayer createRenderObject(BuildContext context) {
    return new RenderFollowerLayer(
      link: link,
      showWhenUnlinked: showWhenUnlinked,
      offset: offset,
    );
  }

  @override
  void updateRenderObject(BuildContext context, RenderFollowerLayer renderObject) {
    renderObject
      ..link = link
      ..showWhenUnlinked = showWhenUnlinked
      ..offset = offset;
  }
}

Adam Barth's avatar
Adam Barth committed
1138
/// Scales and positions its child within itself according to [fit].
1139 1140 1141 1142 1143
///
/// See also:
///
///  * [Transform], which applies an arbitrary transform to its child widget at
///    paint time.
1144
///  * The [catalog of layout widgets](https://flutter.io/widgets/layout/).
Adam Barth's avatar
Adam Barth committed
1145 1146 1147 1148
class FittedBox extends SingleChildRenderObjectWidget {
  /// Creates a widget that scales and positions its child within itself according to [fit].
  ///
  /// The [fit] and [alignment] arguments must not be null.
1149
  const FittedBox({
Adam Barth's avatar
Adam Barth committed
1150
    Key key,
1151 1152
    this.fit = BoxFit.contain,
    this.alignment = Alignment.center,
Ian Hickson's avatar
Ian Hickson committed
1153
    Widget child,
1154 1155 1156
  }) : assert(fit != null),
       assert(alignment != null),
       super(key: key, child: child);
Adam Barth's avatar
Adam Barth committed
1157 1158

  /// How to inscribe the child into the space allocated during layout.
1159
  final BoxFit fit;
Adam Barth's avatar
Adam Barth committed
1160 1161 1162

  /// How to align the child within its parent's bounds.
  ///
1163
  /// An alignment of (-1.0, -1.0) aligns the child to the top-left corner of its
1164
  /// parent's bounds. An alignment of (1.0, 0.0) aligns the child to the middle
Adam Barth's avatar
Adam Barth committed
1165
  /// of the right edge of its parent's bounds.
1166 1167 1168 1169 1170 1171 1172 1173 1174
  ///
  /// Defaults to [Alignment.center].
  ///
  /// See also:
  ///
  ///  * [Alignment], a class with convenient constants typically used to
  ///    specify an [AlignmentGeometry].
  ///  * [AlignmentDirectional], like [Alignment] for specifying alignments
  ///    relative to text direction.
Ian Hickson's avatar
Ian Hickson committed
1175
  final AlignmentGeometry alignment;
Adam Barth's avatar
Adam Barth committed
1176 1177

  @override
Ian Hickson's avatar
Ian Hickson committed
1178 1179 1180 1181 1182 1183 1184
  RenderFittedBox createRenderObject(BuildContext context) {
    return new RenderFittedBox(
      fit: fit,
      alignment: alignment,
      textDirection: Directionality.of(context),
    );
  }
Adam Barth's avatar
Adam Barth committed
1185 1186 1187 1188 1189

  @override
  void updateRenderObject(BuildContext context, RenderFittedBox renderObject) {
    renderObject
      ..fit = fit
Ian Hickson's avatar
Ian Hickson committed
1190 1191 1192 1193 1194
      ..alignment = alignment
      ..textDirection = Directionality.of(context);
  }

  @override
1195 1196 1197 1198
  void debugFillProperties(DiagnosticPropertiesBuilder properties) {
    super.debugFillProperties(properties);
    properties.add(new EnumProperty<BoxFit>('fit', fit));
    properties.add(new DiagnosticsProperty<AlignmentGeometry>('alignment', alignment));
Adam Barth's avatar
Adam Barth committed
1199 1200 1201
  }
}

1202 1203 1204 1205 1206 1207 1208 1209 1210
/// Applies a translation transformation before painting its child.
///
/// The translation is expressed as a [Offset] scaled to the child's size. For
/// example, an [Offset] with a `dx` of 0.25 will result in a horizontal
/// translation of one quarter the width of the child.
///
/// Hit tests will only be detected inside the bounds of the
/// [FractionalTranslation], even if the contents are offset such that
/// they overflow.
1211 1212 1213
///
/// See also:
///
1214 1215 1216 1217
///  * [Transform], which applies an arbitrary transform to its child widget at
///    paint time.
///  * [new Transform.translate], which applies an absolute offset translation
///    transformation instead of an offset scaled to the child.
1218
///  * The [catalog of layout widgets](https://flutter.io/widgets/layout/).
1219
class FractionalTranslation extends SingleChildRenderObjectWidget {
1220 1221 1222
  /// Creates a widget that translates its child's painting.
  ///
  /// The [translation] argument must not be null.
1223
  const FractionalTranslation({
1224
    Key key,
1225
    @required this.translation,
1226
    this.transformHitTests = true,
1227
    Widget child,
1228 1229
  }) : assert(translation != null),
       super(key: key, child: child);
1230

1231 1232 1233 1234 1235
  /// The translation to apply to the child, scaled to the child's size.
  ///
  /// For example, an [Offset] with a `dx` of 0.25 will result in a horizontal
  /// translation of one quarter the width of the child.
  final Offset translation;
1236 1237 1238 1239

  /// Whether to apply the translation when performing hit tests.
  final bool transformHitTests;

1240
  @override
1241 1242 1243 1244 1245 1246
  RenderFractionalTranslation createRenderObject(BuildContext context) {
    return new RenderFractionalTranslation(
      translation: translation,
      transformHitTests: transformHitTests,
    );
  }
1247

1248
  @override
1249
  void updateRenderObject(BuildContext context, RenderFractionalTranslation renderObject) {
1250 1251 1252
    renderObject
      ..translation = translation
      ..transformHitTests = transformHitTests;
1253 1254 1255
  }
}

1256
/// A widget that rotates its child by a integral number of quarter turns.
1257 1258 1259 1260
///
/// Unlike [Transform], which applies a transform just prior to painting,
/// this object applies its rotation prior to layout, which means the entire
/// rotated box consumes only as much space as required by the rotated child.
1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277
///
/// ## Sample code
///
/// This snippet rotates the child (some [Text]) so that it renders from bottom
/// to top, like an axis label on a graph:
///
/// ```dart
/// new RotatedBox(
///   quarterTurns: 3,
///   child: const Text('Hello World!'),
/// )
/// ```
///
/// See also:
///
///  * [Transform], which is a paint effect that allows you to apply an
///    arbitrary transform to a child.
1278
///  * [new Transform.rotate], which applies a rotation paint effect.
1279
///  * The [catalog of layout widgets](https://flutter.io/widgets/layout/).
1280
class RotatedBox extends SingleChildRenderObjectWidget {
1281 1282 1283
  /// A widget that rotates its child.
  ///
  /// The [quarterTurns] argument must not be null.
1284
  const RotatedBox({
1285 1286
    Key key,
    @required this.quarterTurns,
1287
    Widget child,
1288 1289
  }) : assert(quarterTurns != null),
       super(key: key, child: child);
1290 1291 1292 1293

  /// The number of clockwise quarter turns the child should be rotated.
  final int quarterTurns;

1294
  @override
1295 1296
  RenderRotatedBox createRenderObject(BuildContext context) => new RenderRotatedBox(quarterTurns: quarterTurns);

1297
  @override
1298 1299 1300 1301 1302
  void updateRenderObject(BuildContext context, RenderRotatedBox renderObject) {
    renderObject.quarterTurns = quarterTurns;
  }
}

1303
/// A widget that insets its child by the given padding.
1304 1305 1306 1307 1308
///
/// When passing layout constraints to its child, padding shrinks the
/// constraints by the given padding, causing the child to layout at a smaller
/// size. Padding then sizes itself to its child's size, inflated by the
/// padding, effectively creating empty space around the child.
1309
///
1310 1311
/// ## Sample code
///
1312 1313
/// This snippet indents the child (a [Card] with some [Text]) by eight pixels
/// in each direction:
1314 1315 1316 1317 1318 1319 1320 1321
///
/// ```dart
/// new Padding(
///   padding: new EdgeInsets.all(8.0),
///   child: const Card(child: const Text('Hello World!')),
/// )
/// ```
///
1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339
/// ## Design discussion
///
/// ### Why use a [Padding] widget rather than a [Container] with a [Container.padding] property?
///
/// There isn't really any difference between the two. If you supply a
/// [Container.padding] argument, [Container] simply builds a [Padding] widget
/// for you.
///
/// [Container] doesn't implement its properties directly. Instead, [Container]
/// combines a number of simpler widgets together into a convenient package. For
/// example, the [Container.padding] property causes the container to build a
/// [Padding] widget and the [Container.decoration] property causes the
/// container to build a [DecoratedBox] widget. If you find [Container]
/// convenient, feel free to use it. If not, feel free to build these simpler
/// widgets in whatever combination meets your needs.
///
/// In fact, the majority of widgets in Flutter are simply combinations of other
/// simpler widgets. Composition, rather than inheritance, is the primary
1340
/// mechanism for building up widgets.
1341 1342 1343 1344
///
/// See also:
///
///  * [EdgeInsets], the class that is used to describe the padding dimensions.
1345
///  * The [catalog of layout widgets](https://flutter.io/widgets/layout/).
1346
class Padding extends SingleChildRenderObjectWidget {
1347 1348 1349
  /// Creates a widget that insets its child.
  ///
  /// The [padding] argument must not be null.
1350
  const Padding({
1351 1352
    Key key,
    @required this.padding,
1353
    Widget child,
1354 1355
  }) : assert(padding != null),
       super(key: key, child: child);
1356

1357
  /// The amount of space by which to inset the child.
1358
  final EdgeInsetsGeometry padding;
1359

1360
  @override
1361 1362 1363 1364 1365 1366
  RenderPadding createRenderObject(BuildContext context) {
    return new RenderPadding(
      padding: padding,
      textDirection: Directionality.of(context),
    );
  }
1367

1368
  @override
1369
  void updateRenderObject(BuildContext context, RenderPadding renderObject) {
1370 1371 1372
    renderObject
      ..padding = padding
      ..textDirection = Directionality.of(context);
1373
  }
1374 1375

  @override
1376 1377 1378
  void debugFillProperties(DiagnosticPropertiesBuilder properties) {
    super.debugFillProperties(properties);
    properties.add(new DiagnosticsProperty<EdgeInsetsGeometry>('padding', padding));
1379
  }
1380 1381
}

1382 1383
/// A widget that aligns its child within itself and optionally sizes itself
/// based on the child's size.
1384 1385 1386
///
/// For example, to align a box at the bottom right, you would pass this box a
/// tight constraint that is bigger than the child's natural size,
1387
/// with an alignment of [Alignment.bottomRight].
Adam Barth's avatar
Adam Barth committed
1388
///
1389 1390 1391 1392 1393
/// This widget will be as big as possible if its dimensions are constrained and
/// [widthFactor] and [heightFactor] are null. If a dimension is unconstrained
/// and the corresponding size factor is null then the widget will match its
/// child's size in that dimension. If a size factor is non-null then the
/// corresponding dimension of this widget will be the product of the child's
Hans Muller's avatar
Hans Muller committed
1394 1395
/// dimension and the size factor. For example if widthFactor is 2.0 then
/// the width of this widget will always be twice its child's width.
Adam Barth's avatar
Adam Barth committed
1396 1397 1398
///
/// See also:
///
1399 1400
///  * [CustomSingleChildLayout], which uses a delegate to control the layout of
///    a single child.
1401
///  * [Center], which is the same as [Align] but with the [alignment] always
1402
///    set to [Alignment.center].
1403 1404 1405
///  * [FractionallySizedBox], which sizes its child based on a fraction of its
///    own size and positions the child according to an [Alignment] value.
///  * The [catalog of layout widgets](https://flutter.io/widgets/layout/).
1406
class Align extends SingleChildRenderObjectWidget {
Adam Barth's avatar
Adam Barth committed
1407 1408
  /// Creates an alignment widget.
  ///
1409
  /// The alignment defaults to [Alignment.center].
1410
  const Align({
1411
    Key key,
1412
    this.alignment = Alignment.center,
1413 1414
    this.widthFactor,
    this.heightFactor,
1415
    Widget child
1416 1417 1418 1419
  }) : assert(alignment != null),
       assert(widthFactor == null || widthFactor >= 0.0),
       assert(heightFactor == null || heightFactor >= 0.0),
       super(key: key, child: child);
1420

1421 1422
  /// How to align the child.
  ///
Ian Hickson's avatar
Ian Hickson committed
1423
  /// The x and y values of the [Alignment] control the horizontal and vertical
1424
  /// alignment, respectively. An x value of -1.0 means that the left edge of
1425 1426 1427
  /// the child is aligned with the left edge of the parent whereas an x value
  /// of 1.0 means that the right edge of the child is aligned with the right
  /// edge of the parent. Other values interpolate (and extrapolate) linearly.
1428
  /// For example, a value of 0.0 means that the center of the child is aligned
1429
  /// with the center of the parent.
Ian Hickson's avatar
Ian Hickson committed
1430 1431 1432 1433 1434 1435 1436
  ///
  /// See also:
  ///
  ///  * [Alignment], which has more details and some convenience constants for
  ///    common positions.
  ///  * [AlignmentDirectional], which has a horizontal coordinate orientation
  ///    that depends on the [TextDirection].
1437
  final AlignmentGeometry alignment;
1438

1439
  /// If non-null, sets its width to the child's width multiplied by this factor.
1440 1441
  ///
  /// Can be both greater and less than 1.0 but must be positive.
1442
  final double widthFactor;
1443

1444
  /// If non-null, sets its height to the child's height multiplied by this factor.
1445 1446
  ///
  /// Can be both greater and less than 1.0 but must be positive.
1447
  final double heightFactor;
1448

1449
  @override
1450 1451 1452 1453 1454 1455 1456 1457
  RenderPositionedBox createRenderObject(BuildContext context) {
    return new RenderPositionedBox(
      alignment: alignment,
      widthFactor: widthFactor,
      heightFactor: heightFactor,
      textDirection: Directionality.of(context),
    );
  }
1458

1459
  @override
1460
  void updateRenderObject(BuildContext context, RenderPositionedBox renderObject) {
1461 1462 1463
    renderObject
      ..alignment = alignment
      ..widthFactor = widthFactor
1464 1465
      ..heightFactor = heightFactor
      ..textDirection = Directionality.of(context);
1466
  }
1467 1468

  @override
1469 1470 1471 1472 1473
  void debugFillProperties(DiagnosticPropertiesBuilder properties) {
    super.debugFillProperties(properties);
    properties.add(new DiagnosticsProperty<AlignmentGeometry>('alignment', alignment));
    properties.add(new DoubleProperty('widthFactor', widthFactor, defaultValue: null));
    properties.add(new DoubleProperty('heightFactor', heightFactor, defaultValue: null));
1474
  }
1475 1476
}

1477
/// A widget that centers its child within itself.
Adam Barth's avatar
Adam Barth committed
1478
///
1479 1480 1481 1482 1483 1484 1485 1486
/// This widget will be as big as possible if its dimensions are constrained and
/// [widthFactor] and [heightFactor] are null. If a dimension is unconstrained
/// and the corresponding size factor is null then the widget will match its
/// child's size in that dimension. If a size factor is non-null then the
/// corresponding dimension of this widget will be the product of the child's
/// dimension and the size factor. For example if widthFactor is 2.0 then
/// the width of this widget will always be twice its child's width.
///
Adam Barth's avatar
Adam Barth committed
1487 1488
/// See also:
///
1489 1490
///  * [Align], which lets you arbitrarily position a child within itself,
///    rather than just centering it.
1491 1492 1493 1494 1495
///  * [Row], a widget that displays its children in a horizontal array.
///  * [Column], a widget that displays its children in a vertical array.
///  * [Container], a convenience widget that combines common painting,
///    positioning, and sizing widgets.
///  * The [catalog of layout widgets](https://flutter.io/widgets/layout/).
1496
class Center extends Align {
1497
  /// Creates a widget that centers its child.
1498
  const Center({ Key key, double widthFactor, double heightFactor, Widget child })
1499
    : super(key: key, widthFactor: widthFactor, heightFactor: heightFactor, child: child);
1500 1501
}

1502
/// A widget that defers the layout of its single child to a delegate.
1503 1504 1505 1506 1507
///
/// The delegate can determine the layout constraints for the child and can
/// decide where to position the child. The delegate can also determine the size
/// of the parent, but the size of the parent cannot depend on the size of the
/// child.
Adam Barth's avatar
Adam Barth committed
1508 1509 1510
///
/// See also:
///
1511 1512
///  * [SingleChildLayoutDelegate], which controls the layout of the child.
///  * [Align], which sizes itself based on its child's size and positions
1513
///    the child according to an [Alignment] value.
1514
///  * [FractionallySizedBox], which sizes its child based on a fraction of its own
1515
///    size and positions the child according to an [Alignment] value.
1516 1517
///  * [CustomMultiChildLayout], which uses a delegate to position multiple
///    children.
1518
class CustomSingleChildLayout extends SingleChildRenderObjectWidget {
Adam Barth's avatar
Adam Barth committed
1519 1520
  /// Creates a custom single child layout.
  ///
1521
  /// The [delegate] argument must not be null.
1522
  const CustomSingleChildLayout({
Adam Barth's avatar
Adam Barth committed
1523
    Key key,
1524
    @required this.delegate,
Adam Barth's avatar
Adam Barth committed
1525
    Widget child
1526 1527
  }) : assert(delegate != null),
       super(key: key, child: child);
Adam Barth's avatar
Adam Barth committed
1528

Adam Barth's avatar
Adam Barth committed
1529
  /// The delegate that controls the layout of the child.
1530
  final SingleChildLayoutDelegate delegate;
Adam Barth's avatar
Adam Barth committed
1531

1532
  @override
1533 1534 1535
  RenderCustomSingleChildLayoutBox createRenderObject(BuildContext context) {
    return new RenderCustomSingleChildLayoutBox(delegate: delegate);
  }
Adam Barth's avatar
Adam Barth committed
1536

1537
  @override
1538
  void updateRenderObject(BuildContext context, RenderCustomSingleChildLayoutBox renderObject) {
1539 1540 1541 1542
    renderObject.delegate = delegate;
  }
}

1543
/// Metadata for identifying children in a [CustomMultiChildLayout].
1544
///
1545 1546 1547
/// The [MultiChildLayoutDelegate.hasChild],
/// [MultiChildLayoutDelegate.layoutChild], and
/// [MultiChildLayoutDelegate.positionChild] methods use these identifiers.
1548
class LayoutId extends ParentDataWidget<CustomMultiChildLayout> {
Adam Barth's avatar
Adam Barth committed
1549 1550 1551
  /// Marks a child with a layout identifier.
  ///
  /// Both the child and the id arguments must not be null.
1552 1553
  LayoutId({
    Key key,
1554
    @required this.id,
1555
    @required Widget child
1556 1557 1558
  }) : assert(child != null),
       assert(id != null),
       super(key: key ?? new ValueKey<Object>(id), child: child);
1559

1560
  /// An object representing the identity of this child.
1561 1562 1563
  ///
  /// The [id] needs to be unique among the children that the
  /// [CustomMultiChildLayout] manages.
1564 1565
  final Object id;

1566
  @override
1567 1568 1569 1570 1571
  void applyParentData(RenderObject renderObject) {
    assert(renderObject.parentData is MultiChildLayoutParentData);
    final MultiChildLayoutParentData parentData = renderObject.parentData;
    if (parentData.id != id) {
      parentData.id = id;
1572
      final AbstractNode targetParent = renderObject.parent;
1573 1574 1575 1576 1577
      if (targetParent is RenderObject)
        targetParent.markNeedsLayout();
    }
  }

1578
  @override
1579 1580 1581
  void debugFillProperties(DiagnosticPropertiesBuilder properties) {
    super.debugFillProperties(properties);
    properties.add(new DiagnosticsProperty<Object>('id', id));
1582 1583 1584
  }
}

1585
/// A widget that uses a delegate to size and position multiple children.
1586 1587 1588 1589 1590
///
/// The delegate can determine the layout constraints for each child and can
/// decide where to position each child. The delegate can also determine the
/// size of the parent, but the size of the parent cannot depend on the sizes of
/// the children.
Adam Barth's avatar
Adam Barth committed
1591
///
1592 1593 1594 1595 1596 1597 1598 1599 1600
/// [CustomMultiChildLayout] is appropriate when there are complex relationships
/// between the size and positioning of a multiple widgets. To control the
/// layout of a single child, [CustomSingleChildLayout] is more appropriate. For
/// simple cases, such as aligning a widget to one or another edge, the [Stack]
/// widget is more appropriate.
///
/// Each child must be wrapped in a [LayoutId] widget to identify the widget for
/// the delegate.
///
Adam Barth's avatar
Adam Barth committed
1601 1602
/// See also:
///
1603 1604 1605 1606 1607 1608 1609
/// * [MultiChildLayoutDelegate], for details about how to control the layout of
///   the children.
/// * [CustomSingleChildLayout], which uses a delegate to control the layout of
///   a single child.
/// * [Stack], which arranges children relative to the edges of the container.
/// * [Flow], which provides paint-time control of its children using transform
///   matrices.
1610
class CustomMultiChildLayout extends MultiChildRenderObjectWidget {
Adam Barth's avatar
Adam Barth committed
1611 1612
  /// Creates a custom multi-child layout.
  ///
1613
  /// The [delegate] argument must not be null.
1614
  CustomMultiChildLayout({
1615
    Key key,
1616
    @required this.delegate,
1617
    List<Widget> children = const <Widget>[],
1618 1619
  }) : assert(delegate != null),
       super(key: key, children: children);
1620

1621
  /// The delegate that controls the layout of the children.
1622 1623
  final MultiChildLayoutDelegate delegate;

1624
  @override
1625
  RenderCustomMultiChildLayoutBox createRenderObject(BuildContext context) {
1626 1627 1628
    return new RenderCustomMultiChildLayoutBox(delegate: delegate);
  }

1629
  @override
1630
  void updateRenderObject(BuildContext context, RenderCustomMultiChildLayoutBox renderObject) {
Adam Barth's avatar
Adam Barth committed
1631 1632 1633 1634
    renderObject.delegate = delegate;
  }
}

1635 1636
/// A box with a specified size.
///
Adam Barth's avatar
Adam Barth committed
1637 1638 1639 1640 1641 1642 1643
/// If given a child, this widget forces its child to have a specific width
/// and/or height (assuming values are permitted by this widget's parent). If
/// either the width or height is null, this widget will size itself to match
/// the child's size in that dimension.
///
/// If not given a child, this widget will size itself to the given width and
/// height, treating nulls as zero.
Ian Hickson's avatar
Ian Hickson committed
1644 1645 1646
///
/// The [new SizedBox.expand] constructor can be used to make a [SizedBox] that
/// sizes itself to fit the parent. It is equivalent to setting [width] and
1647
/// [height] to [double.infinity].
1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665
///
/// ## Sample code
///
/// This snippet makes the child widget (a [Card] with some [Text]) have the
/// exact size 200x300, parental constraints permitting:
///
/// ```dart
/// new SizedBox(
///   width: 200.0,
///   height: 300.0,
///   child: const Card(child: const Text('Hello World!')),
/// )
/// ```
///
/// See also:
///
///  * [ConstrainedBox], a more generic version of this class that takes
///    arbitrary [BoxConstraints] instead of an explicit width and height.
1666 1667
///  * [UnconstrainedBox], a container that tries to let its child draw without
///    constraints.
1668 1669 1670
///  * [FractionallySizedBox], a widget that sizes its child to a fraction of
///    the total available space.
///  * [AspectRatio], a widget that attempts to fit within the parent's
1671
///    constraints while also sizing its child to match a given aspect ratio.
1672 1673
///  * [FittedBox], which sizes and positions its child widget to fit the parent
///    according to a given [BoxFit] discipline.
1674
///  * The [catalog of layout widgets](https://flutter.io/widgets/layout/).
1675
class SizedBox extends SingleChildRenderObjectWidget {
1676 1677 1678
  /// Creates a fixed size box. The [width] and [height] parameters can be null
  /// to indicate that the size of the box should not be constrained in
  /// the corresponding dimension.
1679
  const SizedBox({ Key key, this.width, this.height, Widget child })
1680 1681
    : super(key: key, child: child);

1682
  /// Creates a box that will become as large as its parent allows.
Ian Hickson's avatar
Ian Hickson committed
1683
  const SizedBox.expand({ Key key, Widget child })
1684 1685
    : width = double.infinity,
      height = double.infinity,
Ian Hickson's avatar
Ian Hickson committed
1686 1687
      super(key: key, child: child);

1688 1689 1690 1691 1692 1693
  /// Creates a box with the specified size.
  SizedBox.fromSize({ Key key, Widget child, Size size })
    : width = size?.width,
      height = size?.height,
      super(key: key, child: child);

1694
  /// If non-null, requires the child to have exactly this width.
1695
  final double width;
1696 1697

  /// If non-null, requires the child to have exactly this height.
1698 1699
  final double height;

1700
  @override
1701 1702 1703 1704 1705
  RenderConstrainedBox createRenderObject(BuildContext context) {
    return new RenderConstrainedBox(
      additionalConstraints: _additionalConstraints,
    );
  }
1706

1707
  BoxConstraints get _additionalConstraints {
1708
    return new BoxConstraints.tightFor(width: width, height: height);
1709 1710
  }

1711
  @override
1712
  void updateRenderObject(BuildContext context, RenderConstrainedBox renderObject) {
1713
    renderObject.additionalConstraints = _additionalConstraints;
1714
  }
1715

Ian Hickson's avatar
Ian Hickson committed
1716 1717
  @override
  String toStringShort() {
1718
    final String type = (width == double.infinity && height == double.infinity) ?
Ian Hickson's avatar
Ian Hickson committed
1719 1720 1721 1722
                  '$runtimeType.expand' : '$runtimeType';
    return key == null ? '$type' : '$type-$key';
  }

1723
  @override
1724 1725
  void debugFillProperties(DiagnosticPropertiesBuilder properties) {
    super.debugFillProperties(properties);
1726
    final DiagnosticLevel level = (width == double.infinity && height == double.infinity)
1727 1728
        ? DiagnosticLevel.hidden
        : DiagnosticLevel.info;
1729 1730
    properties.add(new DoubleProperty('width', width, defaultValue: null, level: level));
    properties.add(new DoubleProperty('height', height, defaultValue: null, level: level));
1731
  }
1732 1733
}

1734
/// A widget that imposes additional constraints on its child.
1735 1736
///
/// For example, if you wanted [child] to have a minimum height of 50.0 logical
1737
/// pixels, you could use `const BoxConstraints(minHeight: 50.0)` as the
1738
/// [constraints].
1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751
///
/// ## Sample code
///
/// This snippet makes the child widget (a [Card] with some [Text]) fill the
/// parent, by applying [BoxConstraints.expand] constraints:
///
/// ```dart
/// new ConstrainedBox(
///   constraints: const BoxConstraints.expand(),
///   child: const Card(child: const Text('Hello World!')),
/// )
/// ```
///
Ian Hickson's avatar
Ian Hickson committed
1752
/// The same behavior can be obtained using the [new SizedBox.expand] widget.
1753 1754 1755 1756
///
/// See also:
///
///  * [BoxConstraints], the class that describes constraints.
1757 1758
///  * [UnconstrainedBox], a container that tries to let its child draw without
///    constraints.
1759 1760
///  * [SizedBox], which lets you specify tight constraints by explicitly
///    specifying the height or width.
1761 1762
///  * [FractionallySizedBox], which sizes its child based on a fraction of its
///    own size and positions the child according to an [Alignment] value.
1763
///  * [AspectRatio], a widget that attempts to fit within the parent's
1764 1765
///    constraints while also sizing its child to match a given aspect ratio.
///  * The [catalog of layout widgets](https://flutter.io/widgets/layout/).
1766
class ConstrainedBox extends SingleChildRenderObjectWidget {
1767 1768 1769 1770 1771 1772 1773
  /// Creates a widget that imposes additional constraints on its child.
  ///
  /// The [constraints] argument must not be null.
  ConstrainedBox({
    Key key,
    @required this.constraints,
    Widget child
1774
  }) : assert(constraints != null),
1775 1776
       assert(constraints.debugAssertIsValid()),
       super(key: key, child: child);
1777

1778
  /// The additional constraints to impose on the child.
1779 1780
  final BoxConstraints constraints;

1781
  @override
1782 1783 1784
  RenderConstrainedBox createRenderObject(BuildContext context) {
    return new RenderConstrainedBox(additionalConstraints: constraints);
  }
1785

1786
  @override
1787
  void updateRenderObject(BuildContext context, RenderConstrainedBox renderObject) {
1788
    renderObject.additionalConstraints = constraints;
1789
  }
1790

1791
  @override
1792 1793 1794
  void debugFillProperties(DiagnosticPropertiesBuilder properties) {
    super.debugFillProperties(properties);
    properties.add(new DiagnosticsProperty<BoxConstraints>('constraints', constraints, showName: false));
1795
  }
1796 1797
}

1798 1799 1800 1801
/// A widget that imposes no constraints on its child, allowing it to render
/// at its "natural" size.
///
/// This allows a child to render at the size it would render if it were alone
1802 1803 1804 1805 1806
/// on an infinite canvas with no constraints. This container will then attempt
/// to adopt the same size, within the limits of its own constraints. If it ends
/// up with a different size, it will align the child based on [alignment].
/// If the box cannot expand enough to accommodate the entire child, the
/// child will be clipped.
1807 1808 1809 1810 1811 1812 1813
///
/// In debug mode, if the child overflows the container, a warning will be
/// printed on the console, and black and yellow striped areas will appear where
/// the overflow occurs.
///
/// See also:
///
1814 1815 1816
///  * [ConstrainedBox], for a box which imposes constraints on its child.
///  * [Align], which loosens the constraints given to the child rather than
///    removing them entirely.
1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829
///  * [Container], a convenience widget that combines common painting,
///    positioning, and sizing widgets.
///  * [OverflowBox], a widget that imposes different constraints on its child
///    than it gets from its parent, possibly allowing the child to overflow
///    the parent.
class UnconstrainedBox extends SingleChildRenderObjectWidget {
  /// Creates a widget that imposes no constraints on its child, allowing it to
  /// render at its "natural" size. If the child overflows the parents
  /// constraints, a warning will be given in debug mode.
  const UnconstrainedBox({
    Key key,
    Widget child,
    this.textDirection,
1830
    this.alignment = Alignment.center,
1831
    this.constrainedAxis,
1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849
  }) : assert(alignment != null),
       super(key: key, child: child);

  /// The text direction to use when interpreting the [alignment] if it is an
  /// [AlignmentDirectional].
  final TextDirection textDirection;

  /// The alignment to use when laying out the child.
  ///
  /// If this is an [AlignmentDirectional], then [textDirection] must not be
  /// null.
  ///
  /// See also:
  ///
  ///  * [Alignment] for non-[Directionality]-aware alignments.
  ///  * [AlignmentDirectional] for [Directionality]-aware alignments.
  final AlignmentGeometry alignment;

1850 1851 1852
  /// The axis to retain constraints on, if any.
  ///
  /// If not set, or set to null (the default), neither axis will retain its
1853
  /// constraints. If set to [Axis.vertical], then vertical constraints will
1854 1855 1856
  /// be retained, and if set to [Axis.horizontal], then horizontal constraints
  /// will be retained.
  final Axis constrainedAxis;
1857

1858 1859 1860 1861
  @override
  void updateRenderObject(BuildContext context, covariant RenderUnconstrainedBox renderObject) {
    renderObject
      ..textDirection = textDirection ?? Directionality.of(context)
1862 1863
      ..alignment = alignment
      ..constrainedAxis = constrainedAxis;
1864 1865 1866 1867 1868 1869
  }

  @override
  RenderUnconstrainedBox createRenderObject(BuildContext context) => new RenderUnconstrainedBox(
    textDirection: textDirection ?? Directionality.of(context),
    alignment: alignment,
1870
    constrainedAxis: constrainedAxis,
1871 1872 1873
  );

  @override
1874 1875 1876 1877 1878
  void debugFillProperties(DiagnosticPropertiesBuilder properties) {
    super.debugFillProperties(properties);
    properties.add(new DiagnosticsProperty<AlignmentGeometry>('alignment', alignment));
    properties.add(new DiagnosticsProperty<Axis>('constrainedAxis', null));
    properties.add(new DiagnosticsProperty<TextDirection>('textDirection', textDirection, defaultValue: null));
1879 1880 1881
  }
}

1882
/// A widget that sizes its child to a fraction of the total available space.
1883 1884
/// For more details about the layout algorithm, see
/// [RenderFractionallySizedOverflowBox].
1885
///
1886
/// See also:
1887
///
1888 1889 1890 1891 1892 1893
///  * [Align], which sizes itself based on its child's size and positions
///    the child according to an [Alignment] value.
///  * [OverflowBox], a widget that imposes different constraints on its child
///    than it gets from its parent, possibly allowing the child to overflow the
///    parent.
///  * The [catalog of layout widgets](https://flutter.io/widgets/layout/).
1894
class FractionallySizedBox extends SingleChildRenderObjectWidget {
1895 1896 1897 1898
  /// Creates a widget that sizes its child to a fraction of the total available space.
  ///
  /// If non-null, the [widthFactor] and [heightFactor] arguments must be
  /// non-negative.
1899
  const FractionallySizedBox({
1900
    Key key,
1901
    this.alignment = Alignment.center,
1902 1903
    this.widthFactor,
    this.heightFactor,
1904
    Widget child,
1905 1906 1907 1908
  }) : assert(alignment != null),
       assert(widthFactor == null || widthFactor >= 0.0),
       assert(heightFactor == null || heightFactor >= 0.0),
       super(key: key, child: child);
Hixie's avatar
Hixie committed
1909

1910
  /// If non-null, the fraction of the incoming width given to the child.
1911 1912
  ///
  /// If non-null, the child is given a tight width constraint that is the max
1913
  /// incoming width constraint multiplied by this factor.
1914 1915 1916
  ///
  /// If null, the incoming width constraints are passed to the child
  /// unmodified.
1917
  final double widthFactor;
1918

Hans Muller's avatar
Hans Muller committed
1919
  /// If non-null, the fraction of the incoming height given to the child.
1920 1921
  ///
  /// If non-null, the child is given a tight height constraint that is the max
1922
  /// incoming height constraint multiplied by this factor.
1923 1924 1925
  ///
  /// If null, the incoming height constraints are passed to the child
  /// unmodified.
1926
  final double heightFactor;
Hixie's avatar
Hixie committed
1927

1928 1929 1930
  /// How to align the child.
  ///
  /// The x and y values of the alignment control the horizontal and vertical
1931
  /// alignment, respectively. An x value of -1.0 means that the left edge of
1932 1933 1934
  /// the child is aligned with the left edge of the parent whereas an x value
  /// of 1.0 means that the right edge of the child is aligned with the right
  /// edge of the parent. Other values interpolate (and extrapolate) linearly.
1935
  /// For example, a value of 0.0 means that the center of the child is aligned
1936
  /// with the center of the parent.
1937 1938 1939 1940 1941 1942 1943 1944 1945
  ///
  /// Defaults to [Alignment.center].
  ///
  /// See also:
  ///
  ///  * [Alignment], a class with convenient constants typically used to
  ///    specify an [AlignmentGeometry].
  ///  * [AlignmentDirectional], like [Alignment] for specifying alignments
  ///    relative to text direction.
1946
  final AlignmentGeometry alignment;
1947

1948
  @override
1949 1950 1951 1952
  RenderFractionallySizedOverflowBox createRenderObject(BuildContext context) {
    return new RenderFractionallySizedOverflowBox(
      alignment: alignment,
      widthFactor: widthFactor,
1953 1954
      heightFactor: heightFactor,
      textDirection: Directionality.of(context),
1955 1956
    );
  }
Hixie's avatar
Hixie committed
1957

1958
  @override
1959
  void updateRenderObject(BuildContext context, RenderFractionallySizedOverflowBox renderObject) {
1960
    renderObject
1961
      ..alignment = alignment
1962
      ..widthFactor = widthFactor
1963 1964
      ..heightFactor = heightFactor
      ..textDirection = Directionality.of(context);
Hixie's avatar
Hixie committed
1965
  }
1966

1967
  @override
1968 1969 1970 1971 1972
  void debugFillProperties(DiagnosticPropertiesBuilder properties) {
    super.debugFillProperties(properties);
    properties.add(new DiagnosticsProperty<AlignmentGeometry>('alignment', alignment));
    properties.add(new DoubleProperty('widthFactor', widthFactor, defaultValue: null));
    properties.add(new DoubleProperty('heightFactor', heightFactor, defaultValue: null));
1973
  }
Hixie's avatar
Hixie committed
1974 1975
}

1976 1977 1978
/// A box that limits its size only when it's unconstrained.
///
/// If this widget's maximum width is unconstrained then its child's width is
Ian Hickson's avatar
Ian Hickson committed
1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990
/// limited to [maxWidth]. Similarly, if this widget's maximum height is
/// unconstrained then its child's height is limited to [maxHeight].
///
/// This has the effect of giving the child a natural dimension in unbounded
/// environments. For example, by providing a [maxHeight] to a widget that
/// normally tries to be as big as possible, the widget will normally size
/// itself to fit its parent, but when placed in a vertical list, it will take
/// on the given height.
///
/// This is useful when composing widgets that normally try to match their
/// parents' size, so that they behave reasonably in lists (which are
/// unbounded).
1991 1992 1993 1994 1995 1996 1997
///
/// See also:
///
///  * [ConstrainedBox], which applies its constraints in all cases, not just
///    when the incoming constraints are unbounded.
///  * [SizedBox], which lets you specify tight constraints by explicitly
///    specifying the height or width.
1998
///  * The [catalog of layout widgets](https://flutter.io/widgets/layout/).
1999
class LimitedBox extends SingleChildRenderObjectWidget {
2000 2001 2002 2003
  /// Creates a box that limits its size only when it's unconstrained.
  ///
  /// The [maxWidth] and [maxHeight] arguments must not be null and must not be
  /// negative.
2004
  const LimitedBox({
2005
    Key key,
2006 2007
    this.maxWidth = double.infinity,
    this.maxHeight = double.infinity,
2008
    Widget child,
2009 2010 2011
  }) : assert(maxWidth != null && maxWidth >= 0.0),
       assert(maxHeight != null && maxHeight >= 0.0),
       super(key: key, child: child);
2012

Ian Hickson's avatar
Ian Hickson committed
2013 2014
  /// The maximum width limit to apply in the absence of a
  /// [BoxConstraints.maxWidth] constraint.
2015 2016
  final double maxWidth;

Ian Hickson's avatar
Ian Hickson committed
2017 2018
  /// The maximum height limit to apply in the absence of a
  /// [BoxConstraints.maxHeight] constraint.
2019 2020 2021
  final double maxHeight;

  @override
2022 2023 2024 2025 2026 2027
  RenderLimitedBox createRenderObject(BuildContext context) {
    return new RenderLimitedBox(
      maxWidth: maxWidth,
      maxHeight: maxHeight
    );
  }
2028 2029 2030 2031 2032 2033 2034 2035 2036

  @override
  void updateRenderObject(BuildContext context, RenderLimitedBox renderObject) {
    renderObject
      ..maxWidth = maxWidth
      ..maxHeight = maxHeight;
  }

  @override
2037 2038 2039 2040
  void debugFillProperties(DiagnosticPropertiesBuilder properties) {
    super.debugFillProperties(properties);
    properties.add(new DoubleProperty('maxWidth', maxWidth, defaultValue: double.infinity));
    properties.add(new DoubleProperty('maxHeight', maxHeight, defaultValue: double.infinity));
2041 2042 2043
  }
}

2044
/// A widget that imposes different constraints on its child than it gets
2045 2046
/// from its parent, possibly allowing the child to overflow the parent.
///
2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058
/// See also:
///
///  * [RenderConstrainedOverflowBox] for details about how [OverflowBox] is
///    rendered.
///  * [SizedOverflowBox], a widget that is a specific size but passes its
///    original constraints through to its child, which may then overflow.
///  * [ConstrainedBox], a widget that imposes additional constraints on its
///    child.
///  * [UnconstrainedBox], a container that tries to let its child draw without
///    constraints.
///  * [SizedBox], a box with a specified size.
///  * The [catalog of layout widgets](https://flutter.io/widgets/layout/).
2059
class OverflowBox extends SingleChildRenderObjectWidget {
2060
  /// Creates a widget that lets its child overflow itself.
2061
  const OverflowBox({
2062
    Key key,
2063
    this.alignment = Alignment.center,
2064 2065 2066 2067
    this.minWidth,
    this.maxWidth,
    this.minHeight,
    this.maxHeight,
2068
    Widget child,
2069
  }) : super(key: key, child: child);
2070

2071 2072 2073
  /// How to align the child.
  ///
  /// The x and y values of the alignment control the horizontal and vertical
2074
  /// alignment, respectively. An x value of -1.0 means that the left edge of
2075 2076 2077
  /// the child is aligned with the left edge of the parent whereas an x value
  /// of 1.0 means that the right edge of the child is aligned with the right
  /// edge of the parent. Other values interpolate (and extrapolate) linearly.
2078
  /// For example, a value of 0.0 means that the center of the child is aligned
2079
  /// with the center of the parent.
2080 2081 2082 2083 2084 2085 2086 2087 2088
  ///
  /// Defaults to [Alignment.center].
  ///
  /// See also:
  ///
  ///  * [Alignment], a class with convenient constants typically used to
  ///    specify an [AlignmentGeometry].
  ///  * [AlignmentDirectional], like [Alignment] for specifying alignments
  ///    relative to text direction.
2089
  final AlignmentGeometry alignment;
2090

2091 2092
  /// The minimum width constraint to give the child. Set this to null (the
  /// default) to use the constraint from the parent instead.
2093
  final double minWidth;
2094 2095 2096

  /// The maximum width constraint to give the child. Set this to null (the
  /// default) to use the constraint from the parent instead.
2097
  final double maxWidth;
2098 2099 2100

  /// The minimum height constraint to give the child. Set this to null (the
  /// default) to use the constraint from the parent instead.
2101
  final double minHeight;
2102 2103 2104

  /// The maximum height constraint to give the child. Set this to null (the
  /// default) to use the constraint from the parent instead.
2105 2106
  final double maxHeight;

2107
  @override
2108 2109 2110 2111 2112 2113
  RenderConstrainedOverflowBox createRenderObject(BuildContext context) {
    return new RenderConstrainedOverflowBox(
      alignment: alignment,
      minWidth: minWidth,
      maxWidth: maxWidth,
      minHeight: minHeight,
2114 2115
      maxHeight: maxHeight,
      textDirection: Directionality.of(context),
2116 2117
    );
  }
2118

2119
  @override
2120
  void updateRenderObject(BuildContext context, RenderConstrainedOverflowBox renderObject) {
2121
    renderObject
2122
      ..alignment = alignment
2123 2124 2125
      ..minWidth = minWidth
      ..maxWidth = maxWidth
      ..minHeight = minHeight
2126 2127
      ..maxHeight = maxHeight
      ..textDirection = Directionality.of(context);
2128
  }
2129

2130
  @override
2131 2132 2133 2134 2135 2136 2137
  void debugFillProperties(DiagnosticPropertiesBuilder properties) {
    super.debugFillProperties(properties);
    properties.add(new DiagnosticsProperty<AlignmentGeometry>('alignment', alignment));
    properties.add(new DoubleProperty('minWidth', minWidth, defaultValue: null));
    properties.add(new DoubleProperty('maxWidth', maxWidth, defaultValue: null));
    properties.add(new DoubleProperty('minHeight', minHeight, defaultValue: null));
    properties.add(new DoubleProperty('maxHeight', maxHeight, defaultValue: null));
2138
  }
2139 2140
}

2141
/// A widget that is a specific size but passes its original constraints
2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153
/// through to its child, which may then overflow.
///
/// See also:
///
///  * [OverflowBox], A widget that imposes different constraints on its child
///    than it gets from its parent, possibly allowing the child to overflow the
///    parent.
///  * [ConstrainedBox], a widget that imposes additional constraints on its
///    child.
///  * [UnconstrainedBox], a container that tries to let its child draw without
///    constraints.
///  * The [catalog of layout widgets](https://flutter.io/widgets/layout/).
2154
class SizedOverflowBox extends SingleChildRenderObjectWidget {
2155 2156
  /// Creates a widget of a given size that lets its child overflow.
  ///
2157
  /// The [size] argument must not be null.
2158
  const SizedOverflowBox({
2159
    Key key,
2160
    @required this.size,
2161
    this.alignment = Alignment.center,
2162
    Widget child,
2163 2164 2165
  }) : assert(size != null),
       assert(alignment != null),
       super(key: key, child: child);
2166 2167 2168 2169

  /// How to align the child.
  ///
  /// The x and y values of the alignment control the horizontal and vertical
2170
  /// alignment, respectively. An x value of -1.0 means that the left edge of
2171 2172 2173
  /// the child is aligned with the left edge of the parent whereas an x value
  /// of 1.0 means that the right edge of the child is aligned with the right
  /// edge of the parent. Other values interpolate (and extrapolate) linearly.
2174
  /// For example, a value of 0.0 means that the center of the child is aligned
2175
  /// with the center of the parent.
2176 2177 2178 2179 2180 2181 2182 2183 2184
  ///
  /// Defaults to [Alignment.center].
  ///
  /// See also:
  ///
  ///  * [Alignment], a class with convenient constants typically used to
  ///    specify an [AlignmentGeometry].
  ///  * [AlignmentDirectional], like [Alignment] for specifying alignments
  ///    relative to text direction.
2185
  final AlignmentGeometry alignment;
2186

2187
  /// The size this widget should attempt to be.
2188 2189
  final Size size;

2190
  @override
2191 2192 2193
  RenderSizedOverflowBox createRenderObject(BuildContext context) {
    return new RenderSizedOverflowBox(
      alignment: alignment,
2194 2195
      requestedSize: size,
      textDirection: Directionality.of(context),
2196 2197
    );
  }
2198

2199
  @override
2200
  void updateRenderObject(BuildContext context, RenderSizedOverflowBox renderObject) {
2201 2202
    renderObject
      ..alignment = alignment
2203 2204
      ..requestedSize = size
      ..textDirection = Directionality.of(context);
2205 2206 2207
  }

  @override
2208 2209 2210 2211
  void debugFillProperties(DiagnosticPropertiesBuilder properties) {
    super.debugFillProperties(properties);
    properties.add(new DiagnosticsProperty<AlignmentGeometry>('alignment', alignment));
    properties.add(new DiagnosticsProperty<Size>('size', size, defaultValue: null));
2212 2213 2214
  }
}

2215
/// A widget that lays the child out as if it was in the tree, but without painting anything,
2216 2217
/// without making the child available for hit testing, and without taking any
/// room in the parent.
2218
///
2219 2220 2221 2222 2223 2224 2225 2226
/// Animations continue to run in offstage children, and therefore use battery
/// and CPU time, regardless of whether the animations end up being visible.
///
/// [Offstage] can be used to measure the dimensions of a widget without
/// bringing it on screen (yet). To hide a widget from view while it is not
/// needed, prefer removing the widget from the tree entirely rather than
/// keeping it alive in an [Offstage] subtree.
///
2227 2228 2229
/// See also:
///
///  * The [catalog of layout widgets](https://flutter.io/widgets/layout/).
2230
///  * [TickerMode], which can be used to disable animations in a subtree.
2231
class Offstage extends SingleChildRenderObjectWidget {
2232
  /// Creates a widget that visually hides its child.
2233
  const Offstage({ Key key, this.offstage = true, Widget child })
2234 2235
    : assert(offstage != null),
      super(key: key, child: child);
2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246

  /// Whether the child is hidden from the rest of the tree.
  ///
  /// If true, the child is laid out as if it was in the tree, but without
  /// painting anything, without making the child available for hit testing, and
  /// without taking any room in the parent.
  ///
  /// If false, the child is included in the tree as normal.
  final bool offstage;

  @override
2247
  RenderOffstage createRenderObject(BuildContext context) => new RenderOffstage(offstage: offstage);
Hixie's avatar
Hixie committed
2248

2249
  @override
2250
  void updateRenderObject(BuildContext context, RenderOffstage renderObject) {
2251 2252 2253 2254
    renderObject.offstage = offstage;
  }

  @override
2255 2256 2257
  void debugFillProperties(DiagnosticPropertiesBuilder properties) {
    super.debugFillProperties(properties);
    properties.add(new DiagnosticsProperty<bool>('offstage', offstage));
2258
  }
2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270

  @override
  _OffstageElement createElement() => new _OffstageElement(this);
}

class _OffstageElement extends SingleChildRenderObjectElement {
  _OffstageElement(Offstage widget) : super(widget);

  @override
  Offstage get widget => super.widget;

  @override
2271
  void debugVisitOnstageChildren(ElementVisitor visitor) {
2272
    if (!widget.offstage)
2273
      super.debugVisitOnstageChildren(visitor);
2274
  }
Hixie's avatar
Hixie committed
2275 2276
}

2277
/// A widget that attempts to size the child to a specific aspect ratio.
2278
///
2279
/// The widget first tries the largest width permitted by the layout
2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302
/// constraints. The height of the widget is determined by applying the
/// given aspect ratio to the width, expressed as a ratio of width to height.
///
/// For example, a 16:9 width:height aspect ratio would have a value of
/// 16.0/9.0. If the maximum width is infinite, the initial width is determined
/// by applying the aspect ratio to the maximum height.
///
/// Now consider a second example, this time with an aspect ratio of 2.0 and
/// layout constraints that require the width to be between 0.0 and 100.0 and
/// the height to be between 0.0 and 100.0. We'll select a width of 100.0 (the
/// biggest allowed) and a height of 50.0 (to match the aspect ratio).
///
/// In that same situation, if the aspect ratio is 0.5, we'll also select a
/// width of 100.0 (still the biggest allowed) and we'll attempt to use a height
/// of 200.0. Unfortunately, that violates the constraints because the child can
/// be at most 100.0 pixels tall. The widget will then take that value
/// and apply the aspect ratio again to obtain a width of 50.0. That width is
/// permitted by the constraints and the child receives a width of 50.0 and a
/// height of 100.0. If the width were not permitted, the widget would
/// continue iterating through the constraints. If the widget does not
/// find a feasible size after consulting each constraint, the widget
/// will eventually select a size for the child that meets the layout
/// constraints but fails to meet the aspect ratio constraints.
2303 2304 2305 2306 2307 2308 2309 2310 2311 2312
///
/// See also:
///
///  * [Align], a widget that aligns its child within itself and optionally
///    sizes itself based on the child's size.
///  * [ConstrainedBox], a widget that imposes additional constraints on its
///    child.
///  * [UnconstrainedBox], a container that tries to let its child draw without
///    constraints.
///  * The [catalog of layout widgets](https://flutter.io/widgets/layout/).
2313
class AspectRatio extends SingleChildRenderObjectWidget {
2314 2315 2316
  /// Creates a widget with a specific aspect ratio.
  ///
  /// The [aspectRatio] argument must not be null.
2317
  const AspectRatio({
2318 2319 2320
    Key key,
    @required this.aspectRatio,
    Widget child
2321 2322
  }) : assert(aspectRatio != null),
       super(key: key, child: child);
2323

2324
  /// The aspect ratio to attempt to use.
2325 2326 2327
  ///
  /// The aspect ratio is expressed as a ratio of width to height. For example,
  /// a 16:9 width:height aspect ratio would have a value of 16.0/9.0.
2328 2329
  final double aspectRatio;

2330
  @override
2331
  RenderAspectRatio createRenderObject(BuildContext context) => new RenderAspectRatio(aspectRatio: aspectRatio);
2332

2333
  @override
2334
  void updateRenderObject(BuildContext context, RenderAspectRatio renderObject) {
2335
    renderObject.aspectRatio = aspectRatio;
2336
  }
2337

2338
  @override
2339 2340 2341
  void debugFillProperties(DiagnosticPropertiesBuilder properties) {
    super.debugFillProperties(properties);
    properties.add(new DoubleProperty('aspectRatio', aspectRatio));
2342
  }
2343 2344
}

2345
/// A widget that sizes its child to the child's intrinsic width.
2346 2347 2348 2349 2350 2351 2352 2353 2354 2355
///
/// Sizes its child's width to the child's maximum intrinsic width. If
/// [stepWidth] is non-null, the child's width will be snapped to a multiple of
/// the [stepWidth]. Similarly, if [stepHeight] is non-null, the child's height
/// will be snapped to a multiple of the [stepHeight].
///
/// This class is useful, for example, when unlimited width is available and
/// you would like a child that would otherwise attempt to expand infinitely to
/// instead size itself to a more reasonable width.
///
2356 2357 2358 2359
/// This class is relatively expensive, because it adds a speculative layout
/// pass before the final layout phase. Avoid using it where possible. In the
/// worst case, this widget can result in a layout that is O(N²) in the depth of
/// the tree.
2360 2361 2362 2363
///
/// See also:
///
///  * The [catalog of layout widgets](https://flutter.io/widgets/layout/).
2364
class IntrinsicWidth extends SingleChildRenderObjectWidget {
2365 2366 2367
  /// Creates a widget that sizes its child to the child's intrinsic width.
  ///
  /// This class is relatively expensive. Avoid using it where possible.
2368
  const IntrinsicWidth({ Key key, this.stepWidth, this.stepHeight, Widget child })
2369 2370
    : super(key: key, child: child);

2371
  /// If non-null, force the child's width to be a multiple of this value.
2372
  final double stepWidth;
2373 2374

  /// If non-null, force the child's height to be a multiple of this value.
2375 2376
  final double stepHeight;

2377
  @override
2378 2379 2380
  RenderIntrinsicWidth createRenderObject(BuildContext context) {
    return new RenderIntrinsicWidth(stepWidth: stepWidth, stepHeight: stepHeight);
  }
2381

2382
  @override
2383
  void updateRenderObject(BuildContext context, RenderIntrinsicWidth renderObject) {
2384 2385 2386
    renderObject
      ..stepWidth = stepWidth
      ..stepHeight = stepHeight;
2387 2388 2389
  }
}

2390
/// A widget that sizes its child to the child's intrinsic height.
2391 2392 2393 2394 2395
///
/// This class is useful, for example, when unlimited height is available and
/// you would like a child that would otherwise attempt to expand infinitely to
/// instead size itself to a more reasonable height.
///
2396 2397 2398 2399
/// This class is relatively expensive, because it adds a speculative layout
/// pass before the final layout phase. Avoid using it where possible. In the
/// worst case, this widget can result in a layout that is O(N²) in the depth of
/// the tree.
2400 2401 2402 2403
///
/// See also:
///
///  * The [catalog of layout widgets](https://flutter.io/widgets/layout/).
2404
class IntrinsicHeight extends SingleChildRenderObjectWidget {
2405 2406 2407
  /// Creates a widget that sizes its child to the child's intrinsic height.
  ///
  /// This class is relatively expensive. Avoid using it where possible.
2408
  const IntrinsicHeight({ Key key, Widget child }) : super(key: key, child: child);
2409 2410

  @override
2411
  RenderIntrinsicHeight createRenderObject(BuildContext context) => new RenderIntrinsicHeight();
Hixie's avatar
Hixie committed
2412 2413
}

2414 2415 2416
/// A widget that positions its child according to the child's baseline.
///
/// This widget shifts the child down such that the child's baseline (or the
2417 2418 2419 2420 2421
/// bottom of the child, if the child has no baseline) is [baseline]
/// logical pixels below the top of this box, then sizes this box to
/// contain the child. If [baseline] is less than the distance from
/// the top of the child to the baseline of the child, then the child
/// is top-aligned instead.
2422 2423 2424 2425 2426 2427 2428
///
/// See also:
///
///  * [Align], a widget that aligns its child within itself and optionally
///    sizes itself based on the child's size.
///  * [Center], a widget that centers its child within itself.
///  * The [catalog of layout widgets](https://flutter.io/widgets/layout/).
2429
class Baseline extends SingleChildRenderObjectWidget {
2430
  /// Creates a widget that positions its child according to the child's baseline.
2431
  ///
2432
  /// The [baseline] and [baselineType] arguments must not be null.
2433
  const Baseline({
2434 2435 2436 2437
    Key key,
    @required this.baseline,
    @required this.baselineType,
    Widget child
2438 2439 2440
  }) : assert(baseline != null),
       assert(baselineType != null),
       super(key: key, child: child);
2441

2442 2443 2444 2445 2446
  /// The number of logical pixels from the top of this box at which to position
  /// the child's baseline.
  final double baseline;

  /// The type of baseline to use for positioning the child.
2447 2448
  final TextBaseline baselineType;

2449
  @override
2450 2451 2452
  RenderBaseline createRenderObject(BuildContext context) {
    return new RenderBaseline(baseline: baseline, baselineType: baselineType);
  }
2453

2454
  @override
2455
  void updateRenderObject(BuildContext context, RenderBaseline renderObject) {
2456 2457 2458
    renderObject
      ..baseline = baseline
      ..baselineType = baselineType;
2459 2460 2461 2462
  }
}


Ian Hickson's avatar
Ian Hickson committed
2463 2464
// SLIVERS

2465 2466 2467 2468 2469 2470 2471 2472 2473
/// A sliver that contains a single box widget.
///
/// Slivers are special-purpose widgets that can be combined using a
/// [CustomScrollView] to create custom scroll effects. A [SliverToBoxAdapter]
/// is a basic sliver that creates a bridge back to one of the usual box-based
/// widgets.
///
/// Rather than using multiple [SliverToBoxAdapter] widgets to display multiple
/// box widgets in a [CustomScrollView], consider using [SliverList],
2474 2475 2476
/// [SliverFixedExtentList], [SliverPrototypeExtentList], or [SliverGrid],
/// which are more efficient because they instantiate only those children that
/// are actually visible through the scroll view's viewport.
2477 2478 2479 2480 2481 2482 2483
///
/// See also:
///
///  * [CustomScrollView], which displays a scrollable list of slivers.
///  * [SliverList], which displays multiple box widgets in a linear array.
///  * [SliverFixedExtentList], which displays multiple box widgets with the
///    same main-axis extent in a linear array.
2484 2485
///  * [SliverPrototypeExtentList], which displays multiple box widgets with the
///    same main-axis extent as a prototype item, in a linear array.
2486
///  * [SliverGrid], which displays multiple box widgets in arbitrary positions.
Ian Hickson's avatar
Ian Hickson committed
2487
class SliverToBoxAdapter extends SingleChildRenderObjectWidget {
2488
  /// Creates a sliver that contains a single box widget.
2489
  const SliverToBoxAdapter({
Ian Hickson's avatar
Ian Hickson committed
2490 2491 2492 2493 2494 2495 2496 2497
    Key key,
    Widget child,
  }) : super(key: key, child: child);

  @override
  RenderSliverToBoxAdapter createRenderObject(BuildContext context) => new RenderSliverToBoxAdapter();
}

2498 2499 2500 2501 2502 2503 2504 2505
/// A sliver that applies padding on each side of another sliver.
///
/// Slivers are special-purpose widgets that can be combined using a
/// [CustomScrollView] to create custom scroll effects. A [SliverPadding]
/// is a basic sliver that insets another sliver by applying padding on each
/// side.
///
/// Applying padding to anything but the most mundane sliver is likely to have
2506 2507 2508 2509
/// undesired effects. For example, wrapping a [SliverPersistentHeader] with
/// `pinned:true` will cause the app bar to overlap earlier slivers (contrary to
/// the normal behavior of pinned app bars), and while the app bar is pinned,
/// the padding will scroll away.
2510 2511 2512 2513
///
/// See also:
///
///  * [CustomScrollView], which displays a scrollable list of slivers.
Ian Hickson's avatar
Ian Hickson committed
2514
class SliverPadding extends SingleChildRenderObjectWidget {
2515 2516 2517
  /// Creates a sliver that applies padding on each side of another sliver.
  ///
  /// The [padding] argument must not be null.
2518
  const SliverPadding({
Ian Hickson's avatar
Ian Hickson committed
2519 2520
    Key key,
    @required this.padding,
2521
    Widget sliver,
2522 2523
  }) : assert(padding != null),
       super(key: key, child: sliver);
Ian Hickson's avatar
Ian Hickson committed
2524

2525
  /// The amount of space by which to inset the child sliver.
2526
  final EdgeInsetsGeometry padding;
2527

Ian Hickson's avatar
Ian Hickson committed
2528
  @override
2529 2530 2531 2532 2533 2534
  RenderSliverPadding createRenderObject(BuildContext context) {
    return new RenderSliverPadding(
      padding: padding,
      textDirection: Directionality.of(context),
    );
  }
Ian Hickson's avatar
Ian Hickson committed
2535 2536 2537

  @override
  void updateRenderObject(BuildContext context, RenderSliverPadding renderObject) {
2538 2539 2540
    renderObject
      ..padding = padding
      ..textDirection = Directionality.of(context);
Ian Hickson's avatar
Ian Hickson committed
2541 2542 2543
  }

  @override
2544 2545 2546
  void debugFillProperties(DiagnosticPropertiesBuilder properties) {
    super.debugFillProperties(properties);
    properties.add(new DiagnosticsProperty<EdgeInsetsGeometry>('padding', padding));
Ian Hickson's avatar
Ian Hickson committed
2547 2548 2549 2550
  }
}


2551 2552
// LAYOUT NODES

2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588
/// Returns the [AxisDirection] in the given [Axis] in the current
/// [Directionality] (or the reverse if `reverse` is true).
///
/// If `axis` is [Axis.vertical], this function returns [AxisDirection.down]
/// unless `reverse` is true, in which case this function returns
/// [AxisDirection.up].
///
/// If `axis` is [Axis.horizontal], this function checks the current
/// [Directionality]. If the current [Directionality] is right-to-left, then
/// this function returns [AxisDirection.left] (unless `reverse` is true, in
/// which case it returns [AxisDirection.right]). Similarly, if the current
/// [Directionality] is left-to-right, then this function returns
/// [AxisDirection.right] (unless `reverse` is true, in which case it returns
/// [AxisDirection.left]).
///
/// This function is used by a number of scrolling widgets (e.g., [ListView],
/// [GridView], [PageView], and [SingleChildScrollView]) as well as [ListBody]
/// to translate their [Axis] and `reverse` properties into a concrete
/// [AxisDirection].
AxisDirection getAxisDirectionFromAxisReverseAndDirectionality(
  BuildContext context,
  Axis axis,
  bool reverse,
) {
  switch (axis) {
    case Axis.horizontal:
      assert(debugCheckHasDirectionality(context));
      final TextDirection textDirection = Directionality.of(context);
      final AxisDirection axisDirection = textDirectionToAxisDirection(textDirection);
      return reverse ? flipAxisDirection(axisDirection) : axisDirection;
    case Axis.vertical:
      return reverse ? AxisDirection.up : AxisDirection.down;
  }
  return null;
}

2589 2590
/// A widget that arranges its children sequentially along a given axis, forcing
/// them to the dimension of the parent in the other axis.
2591
///
2592
/// This widget is rarely used directly. Instead, consider using [ListView],
2593 2594 2595
/// which combines a similar layout algorithm with scrolling behavior, or
/// [Column], which gives you more flexible control over the layout of a
/// vertical set of boxes.
2596
///
2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609
/// See also:
///
///  * [RenderListBody], which implements this layout algorithm and the
///    documentation for which describes some of its subtleties.
///  * [SingleChildScrollView], which is sometimes used with [ListBody] to
///    make the contents scrollable.
///  * [Column] and [Row], which implement a more elaborate version of
///    this layout algorithm (at the cost of being slightly less efficient).
///  * [ListView], which implements an efficient scrolling version of this
///    layout algorithm.
class ListBody extends MultiChildRenderObjectWidget {
  /// Creates a layout widget that arranges its children sequentially along a
  /// given axis.
2610 2611
  ///
  /// By default, the [mainAxis] is [Axis.vertical].
2612
  ListBody({
2613
    Key key,
2614 2615 2616
    this.mainAxis = Axis.vertical,
    this.reverse = false,
    List<Widget> children = const <Widget>[],
2617 2618
  }) : assert(mainAxis != null),
       super(key: key, children: children);
2619

2620
  /// The direction to use as the main axis.
2621
  final Axis mainAxis;
2622

2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640
  /// Whether the list body positions children in the reading direction.
  ///
  /// For example, if the reading direction is left-to-right and
  /// [mainAxis] is [Axis.horizontal], then the list body positions children
  /// from left to right when [reverse] is false and from right to left when
  /// [reverse] is true.
  ///
  /// Similarly, if [mainAxis] is [Axis.vertical], then the list body positions
  /// from top to bottom when [reverse] is false and from bottom to top when
  /// [reverse] is true.
  ///
  /// Defaults to false.
  final bool reverse;

  AxisDirection _getDirection(BuildContext context) {
    return getAxisDirectionFromAxisReverseAndDirectionality(context, mainAxis, reverse);
  }

2641
  @override
2642 2643 2644
  RenderListBody createRenderObject(BuildContext context) {
    return new RenderListBody(axisDirection: _getDirection(context));
  }
2645

2646
  @override
2647
  void updateRenderObject(BuildContext context, RenderListBody renderObject) {
2648
    renderObject.axisDirection = _getDirection(context);
2649
  }
2650 2651
}

Ian Hickson's avatar
Ian Hickson committed
2652
/// A widget that positions its children relative to the edges of its box.
Adam Barth's avatar
Adam Barth committed
2653
///
2654 2655 2656
/// This class is useful if you want to overlap several children in a simple
/// way, for example having some text and an image, overlaid with a gradient and
/// a button attached to the bottom.
2657
///
2658 2659 2660 2661
/// Each child of a [Stack] widget is either _positioned_ or _non-positioned_.
/// Positioned children are those wrapped in a [Positioned] widget that has at
/// least one non-null property. The stack sizes itself to contain all the
/// non-positioned children, which are positioned according to [alignment]
2662 2663 2664 2665
/// (which defaults to the top-left corner in left-to-right environments and the
/// top-right corner in right-to-left environments). The positioned children are
/// then placed relative to the stack according to their top, right, bottom, and
/// left properties.
2666
///
2667 2668 2669 2670 2671 2672 2673
/// The stack paints its children in order with the first child being at the
/// bottom. If you want to change the order in which the children paint, you
/// can rebuild the stack with the children in the new order. If you reorder
/// the children in this way, consider giving the children non-null keys.
/// These keys will cause the framework to move the underlying objects for
/// the children to their new locations rather than recreate them at their
/// new location.
2674
///
2675 2676 2677 2678 2679 2680
/// For more details about the stack layout algorithm, see [RenderStack].
///
/// If you want to lay a number of children out in a particular pattern, or if
/// you want to make a custom layout manager, you probably want to use
/// [CustomMultiChildLayout] instead. In particular, when using a [Stack] you
/// can't position children relative to their size or the stack's own size.
Adam Barth's avatar
Adam Barth committed
2681 2682 2683
///
/// See also:
///
2684
///  * [Align], which sizes itself based on its child's size and positions
2685
///    the child according to an [Alignment] value.
2686 2687 2688 2689 2690 2691
///  * [CustomSingleChildLayout], which uses a delegate to control the layout of
///    a single child.
///  * [CustomMultiChildLayout], which uses a delegate to position multiple
///    children.
///  * [Flow], which provides paint-time control of its children using transform
///    matrices.
2692
///  * The [catalog of layout widgets](https://flutter.io/widgets/layout/).
2693
class Stack extends MultiChildRenderObjectWidget {
2694
  /// Creates a stack layout widget.
2695 2696 2697
  ///
  /// By default, the non-positioned children of the stack are aligned by their
  /// top left corners.
2698
  Stack({
Hans Muller's avatar
Hans Muller committed
2699
    Key key,
2700
    this.alignment = AlignmentDirectional.topStart,
2701
    this.textDirection,
2702 2703 2704
    this.fit = StackFit.loose,
    this.overflow = Overflow.clip,
    List<Widget> children = const <Widget>[],
2705
  }) : super(key: key, children: children);
Hans Muller's avatar
Hans Muller committed
2706

2707 2708
  /// How to align the non-positioned and partially-positioned children in the
  /// stack.
2709 2710 2711
  ///
  /// The non-positioned children are placed relative to each other such that
  /// the points determined by [alignment] are co-located. For example, if the
2712
  /// [alignment] is [Alignment.topLeft], then the top left corner of
2713
  /// each non-positioned child will be located at the same global coordinate.
2714 2715 2716 2717 2718
  ///
  /// Partially-positioned children, those that do not specify an alignment in a
  /// particular axis (e.g. that have neither `top` nor `bottom` set), use the
  /// alignment to determine how they should be positioned in that
  /// under-specified axis.
2719 2720 2721 2722 2723 2724 2725 2726 2727
  ///
  /// Defaults to [AlignmentDirectional.topStart].
  ///
  /// See also:
  ///
  ///  * [Alignment], a class with convenient constants typically used to
  ///    specify an [AlignmentGeometry].
  ///  * [AlignmentDirectional], like [Alignment] for specifying alignments
  ///    relative to text direction.
2728
  final AlignmentGeometry alignment;
2729 2730 2731 2732 2733

  /// The text direction with which to resolve [alignment].
  ///
  /// Defaults to the ambient [Directionality].
  final TextDirection textDirection;
Hans Muller's avatar
Hans Muller committed
2734

2735 2736 2737 2738 2739
  /// How to size the non-positioned children in the stack.
  ///
  /// The constraints passed into the [Stack] from its parent are either
  /// loosened ([StackFit.loose]) or tightened to their biggest size
  /// ([StackFit.expand]).
2740
  final StackFit fit;
2741

2742 2743 2744
  /// Whether overflowing children should be clipped. See [Overflow].
  ///
  /// Some children in a stack might overflow its box. When this flag is set to
2745
  /// [Overflow.clip], children cannot paint outside of the stack's box.
2746 2747
  final Overflow overflow;

2748
  @override
2749 2750 2751
  RenderStack createRenderObject(BuildContext context) {
    return new RenderStack(
      alignment: alignment,
2752
      textDirection: textDirection ?? Directionality.of(context),
2753
      fit: fit,
2754
      overflow: overflow,
2755 2756
    );
  }
Hans Muller's avatar
Hans Muller committed
2757

2758
  @override
2759
  void updateRenderObject(BuildContext context, RenderStack renderObject) {
2760 2761
    renderObject
      ..alignment = alignment
2762
      ..textDirection = textDirection ?? Directionality.of(context)
2763
      ..fit = fit
2764
      ..overflow = overflow;
Hans Muller's avatar
Hans Muller committed
2765
  }
2766 2767

  @override
2768 2769 2770 2771 2772 2773
  void debugFillProperties(DiagnosticPropertiesBuilder properties) {
    super.debugFillProperties(properties);
    properties.add(new DiagnosticsProperty<AlignmentGeometry>('alignment', alignment));
    properties.add(new EnumProperty<TextDirection>('textDirection', textDirection, defaultValue: null));
    properties.add(new EnumProperty<StackFit>('fit', fit));
    properties.add(new EnumProperty<Overflow>('overflow', overflow));
2774
  }
Hans Muller's avatar
Hans Muller committed
2775 2776
}

2777
/// A [Stack] that shows a single child from a list of children.
2778
///
2779 2780 2781 2782
/// The displayed child is the one with the given [index]. The stack is
/// always as big as the largest child.
///
/// If value is null, then nothing is displayed.
2783
///
2784 2785 2786 2787
/// See also:
///
///  * [Stack], for more details about stacks.
///  * The [catalog of layout widgets](https://flutter.io/widgets/layout/).
2788
class IndexedStack extends Stack {
2789
  /// Creates a [Stack] widget that paints a single child.
2790 2791
  ///
  /// The [index] argument must not be null.
2792
  IndexedStack({
Hans Muller's avatar
Hans Muller committed
2793
    Key key,
2794
    AlignmentGeometry alignment = AlignmentDirectional.topStart,
2795
    TextDirection textDirection,
2796 2797 2798
    StackFit sizing = StackFit.loose,
    this.index = 0,
    List<Widget> children = const <Widget>[],
2799
  }) : super(key: key, alignment: alignment, textDirection: textDirection, fit: sizing, children: children);
Hans Muller's avatar
Hans Muller committed
2800

Adam Barth's avatar
Adam Barth committed
2801
  /// The index of the child to show.
Hans Muller's avatar
Hans Muller committed
2802
  final int index;
Adam Barth's avatar
Adam Barth committed
2803

2804
  @override
2805 2806 2807 2808 2809 2810 2811
  RenderIndexedStack createRenderObject(BuildContext context) {
    return new RenderIndexedStack(
      index: index,
      alignment: alignment,
      textDirection: textDirection ?? Directionality.of(context),
    );
  }
Hans Muller's avatar
Hans Muller committed
2812

2813
  @override
2814
  void updateRenderObject(BuildContext context, RenderIndexedStack renderObject) {
2815 2816
    renderObject
      ..index = index
2817 2818
      ..alignment = alignment
      ..textDirection = textDirection ?? Directionality.of(context);
Hans Muller's avatar
Hans Muller committed
2819
  }
2820 2821
}

2822
/// A widget that controls where a child of a [Stack] is positioned.
Adam Barth's avatar
Adam Barth committed
2823
///
2824 2825 2826 2827
/// A [Positioned] widget must be a descendant of a [Stack], and the path from
/// the [Positioned] widget to its enclosing [Stack] must contain only
/// [StatelessWidget]s or [StatefulWidget]s (not other kinds of widgets, like
/// [RenderObjectWidget]s).
2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839
///
/// If a widget is wrapped in a [Positioned], then it is a _positioned_ widget
/// in its [Stack]. If the [top] property is non-null, the top edge of this child
/// will be positioned [top] layout units from the top of the stack widget. The
/// [right], [bottom], and [left] properties work analogously.
///
/// If both the [top] and [bottom] properties are non-null, then the child will
/// be forced to have exactly the height required to satisfy both constraints.
/// Similarly, setting the [right] and [left] properties to non-null values will
/// force the child to have a particular width. Alternatively the [width] and
/// [height] properties can be used to give the dimensions, with one
/// corresponding position property (e.g. [top] and [height]).
2840
///
2841 2842 2843 2844 2845 2846
/// If all three values on a particular axis are null, then the
/// [Stack.alignment] property is used to position the child.
///
/// If all six values are null, the child is a non-positioned child. The [Stack]
/// uses only the non-positioned children to size itself.
///
2847 2848 2849
/// See also:
///
///  * [PositionedDirectional], which adapts to the ambient [Directionality].
2850
class Positioned extends ParentDataWidget<Stack> {
2851
  /// Creates a widget that controls where a child of a [Stack] is positioned.
Hixie's avatar
Hixie committed
2852 2853 2854 2855 2856
  ///
  /// Only two out of the three horizontal values ([left], [right],
  /// [width]), and only two out of the three vertical values ([top],
  /// [bottom], [height]), can be set. In each case, at least one of
  /// the three must be null.
2857 2858 2859 2860
  ///
  /// See also:
  ///
  ///  * [Positioned.directional], which specifies the widget's horizontal
2861
  ///    position using `start` and `end` rather than `left` and `right`.
2862 2863
  ///  * [PositionedDirectional], which is similar to [Positioned.directional]
  ///    but adapts to the ambient [Directionality].
2864
  const Positioned({
2865
    Key key,
2866
    this.left,
2867 2868 2869
    this.top,
    this.right,
    this.bottom,
2870
    this.width,
2871
    this.height,
2872
    @required Widget child,
2873 2874 2875
  }) : assert(left == null || right == null || width == null),
       assert(top == null || bottom == null || height == null),
       super(key: key, child: child);
2876

Hixie's avatar
Hixie committed
2877 2878 2879 2880 2881
  /// Creates a Positioned object with the values from the given [Rect].
  ///
  /// This sets the [left], [top], [width], and [height] properties
  /// from the given [Rect]. The [right] and [bottom] properties are
  /// set to null.
2882 2883
  Positioned.fromRect({
    Key key,
2884 2885
    Rect rect,
    @required Widget child,
2886 2887 2888 2889
  }) : left = rect.left,
       top = rect.top,
       width = rect.width,
       height = rect.height,
2890 2891
       right = null,
       bottom = null,
2892
       super(key: key, child: child);
2893

2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909
  /// Creates a Positioned object with the values from the given [RelativeRect].
  ///
  /// This sets the [left], [top], [right], and [bottom] properties from the
  /// given [RelativeRect]. The [height] and [width] properties are set to null.
  Positioned.fromRelativeRect({
    Key key,
    RelativeRect rect,
    @required Widget child,
  }) : left = rect.left,
       top = rect.top,
       right = rect.right,
       bottom = rect.bottom,
       width = null,
       height = null,
       super(key: key, child: child);

2910 2911
  /// Creates a Positioned object with [left], [top], [right], and [bottom] set
  /// to 0.0 unless a value for them is passed.
2912
  const Positioned.fill({
2913
    Key key,
2914 2915 2916 2917
    this.left = 0.0,
    this.top = 0.0,
    this.right = 0.0,
    this.bottom = 0.0,
2918
    @required Widget child,
2919 2920 2921 2922
  }) : width = null,
       height = null,
       super(key: key, child: child);

2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976
  /// Creates a widget that controls where a child of a [Stack] is positioned.
  ///
  /// Only two out of the three horizontal values (`start`, `end`,
  /// [width]), and only two out of the three vertical values ([top],
  /// [bottom], [height]), can be set. In each case, at least one of
  /// the three must be null.
  ///
  /// If `textDirection` is [TextDirection.rtl], then the `start` argument is
  /// used for the [right] property and the `end` argument is used for the
  /// [left] property. Otherwise, if `textDirection` is [TextDirection.ltr],
  /// then the `start` argument is used for the [left] property and the `end`
  /// argument is used for the [right] property.
  ///
  /// The `textDirection` argument must not be null.
  ///
  /// See also:
  ///
  ///  * [PositionedDirectional], which adapts to the ambient [Directionality].
  factory Positioned.directional({
    Key key,
    @required TextDirection textDirection,
    double start,
    double top,
    double end,
    double bottom,
    double width,
    double height,
    @required Widget child,
  }) {
    assert(textDirection != null);
    double left;
    double right;
    switch (textDirection) {
      case TextDirection.rtl:
        left = end;
        right = start;
        break;
      case TextDirection.ltr:
        left = start;
        right = end;
        break;
    }
    return new Positioned(
      key: key,
      left: left,
      top: top,
      right: right,
      bottom: bottom,
      width: width,
      height: height,
      child: child,
    );
  }

Hixie's avatar
Hixie committed
2977 2978 2979 2980
  /// The distance that the child's left edge is inset from the left of the stack.
  ///
  /// Only two out of the three horizontal values ([left], [right], [width]) can be
  /// set. The third must be null.
2981 2982 2983
  ///
  /// If all three are null, the [Stack.alignment] is used to position the child
  /// horizontally.
2984 2985
  final double left;

Hixie's avatar
Hixie committed
2986 2987 2988 2989
  /// The distance that the child's top edge is inset from the top of the stack.
  ///
  /// Only two out of the three vertical values ([top], [bottom], [height]) can be
  /// set. The third must be null.
2990 2991 2992
  ///
  /// If all three are null, the [Stack.alignment] is used to position the child
  /// vertically.
2993
  final double top;
Adam Barth's avatar
Adam Barth committed
2994

Hixie's avatar
Hixie committed
2995 2996 2997 2998
  /// The distance that the child's right edge is inset from the right of the stack.
  ///
  /// Only two out of the three horizontal values ([left], [right], [width]) can be
  /// set. The third must be null.
2999 3000 3001
  ///
  /// If all three are null, the [Stack.alignment] is used to position the child
  /// horizontally.
3002
  final double right;
Adam Barth's avatar
Adam Barth committed
3003

Hixie's avatar
Hixie committed
3004 3005 3006 3007
  /// The distance that the child's bottom edge is inset from the bottom of the stack.
  ///
  /// Only two out of the three vertical values ([top], [bottom], [height]) can be
  /// set. The third must be null.
3008 3009 3010
  ///
  /// If all three are null, the [Stack.alignment] is used to position the child
  /// vertically.
3011
  final double bottom;
Adam Barth's avatar
Adam Barth committed
3012 3013 3014

  /// The child's width.
  ///
Hixie's avatar
Hixie committed
3015
  /// Only two out of the three horizontal values ([left], [right], [width]) can be
3016
  /// set. The third must be null.
3017 3018 3019
  ///
  /// If all three are null, the [Stack.alignment] is used to position the child
  /// horizontally.
3020
  final double width;
Adam Barth's avatar
Adam Barth committed
3021 3022 3023

  /// The child's height.
  ///
Hixie's avatar
Hixie committed
3024
  /// Only two out of the three vertical values ([top], [bottom], [height]) can be
3025
  /// set. The third must be null.
3026 3027 3028
  ///
  /// If all three are null, the [Stack.alignment] is used to position the child
  /// vertically.
3029 3030
  final double height;

3031
  @override
3032 3033 3034
  void applyParentData(RenderObject renderObject) {
    assert(renderObject.parentData is StackParentData);
    final StackParentData parentData = renderObject.parentData;
3035
    bool needsLayout = false;
3036

3037 3038 3039 3040 3041
    if (parentData.left != left) {
      parentData.left = left;
      needsLayout = true;
    }

3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056
    if (parentData.top != top) {
      parentData.top = top;
      needsLayout = true;
    }

    if (parentData.right != right) {
      parentData.right = right;
      needsLayout = true;
    }

    if (parentData.bottom != bottom) {
      parentData.bottom = bottom;
      needsLayout = true;
    }

3057 3058 3059 3060 3061 3062 3063 3064 3065 3066
    if (parentData.width != width) {
      parentData.width = width;
      needsLayout = true;
    }

    if (parentData.height != height) {
      parentData.height = height;
      needsLayout = true;
    }

3067
    if (needsLayout) {
3068
      final AbstractNode targetParent = renderObject.parent;
3069 3070 3071
      if (targetParent is RenderObject)
        targetParent.markNeedsLayout();
    }
3072
  }
3073

3074
  @override
3075 3076 3077 3078 3079 3080 3081 3082
  void debugFillProperties(DiagnosticPropertiesBuilder properties) {
    super.debugFillProperties(properties);
    properties.add(new DoubleProperty('left', left, defaultValue: null));
    properties.add(new DoubleProperty('top', top, defaultValue: null));
    properties.add(new DoubleProperty('right', right, defaultValue: null));
    properties.add(new DoubleProperty('bottom', bottom, defaultValue: null));
    properties.add(new DoubleProperty('width', width, defaultValue: null));
    properties.add(new DoubleProperty('height', height, defaultValue: null));
3083
  }
3084 3085
}

3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176
/// A widget that controls where a child of a [Stack] is positioned without
/// committing to a specific [TextDirection].
///
/// The ambient [Directionality] is used to determine whether [start] is to the
/// left or to the right.
///
/// A [PositionedDirectional] widget must be a descendant of a [Stack], and the
/// path from the [PositionedDirectional] widget to its enclosing [Stack] must
/// contain only [StatelessWidget]s or [StatefulWidget]s (not other kinds of
/// widgets, like [RenderObjectWidget]s).
///
/// If a widget is wrapped in a [PositionedDirectional], then it is a
/// _positioned_ widget in its [Stack]. If the [top] property is non-null, the
/// top edge of this child/ will be positioned [top] layout units from the top
/// of the stack widget. The [start], [bottom], and [end] properties work
/// analogously.
///
/// If both the [top] and [bottom] properties are non-null, then the child will
/// be forced to have exactly the height required to satisfy both constraints.
/// Similarly, setting the [start] and [end] properties to non-null values will
/// force the child to have a particular width. Alternatively the [width] and
/// [height] properties can be used to give the dimensions, with one
/// corresponding position property (e.g. [top] and [height]).
///
/// See also:
///
///  * [Positioned], which specifies the widget's position visually.
///  * [Positioned.directional], which also specifies the widget's horizontal
///    position using [start] and [end] but has an explicit [TextDirection].
class PositionedDirectional extends StatelessWidget {
  /// Creates a widget that controls where a child of a [Stack] is positioned.
  ///
  /// Only two out of the three horizontal values (`start`, `end`,
  /// [width]), and only two out of the three vertical values ([top],
  /// [bottom], [height]), can be set. In each case, at least one of
  /// the three must be null.
  ///
  /// See also:
  ///
  ///  * [Positioned.directional], which also specifies the widget's horizontal
  ///    position using [start] and [end] but has an explicit [TextDirection].
  const PositionedDirectional({
    Key key,
    this.start,
    this.top,
    this.end,
    this.bottom,
    this.width,
    this.height,
    @required this.child,
  }) : super(key: key);

  /// The distance that the child's leading edge is inset from the leading edge
  /// of the stack.
  ///
  /// Only two out of the three horizontal values ([start], [end], [width]) can be
  /// set. The third must be null.
  final double start;

  /// The distance that the child's top edge is inset from the top of the stack.
  ///
  /// Only two out of the three vertical values ([top], [bottom], [height]) can be
  /// set. The third must be null.
  final double top;

  /// The distance that the child's trailing edge is inset from the trailing
  /// edge of the stack.
  ///
  /// Only two out of the three horizontal values ([start], [end], [width]) can be
  /// set. The third must be null.
  final double end;

  /// The distance that the child's bottom edge is inset from the bottom of the stack.
  ///
  /// Only two out of the three vertical values ([top], [bottom], [height]) can be
  /// set. The third must be null.
  final double bottom;

  /// The child's width.
  ///
  /// Only two out of the three horizontal values ([start], [end], [width]) can be
  /// set. The third must be null.
  final double width;

  /// The child's height.
  ///
  /// Only two out of the three vertical values ([top], [bottom], [height]) can be
  /// set. The third must be null.
  final double height;

  /// The widget below this widget in the tree.
3177 3178
  ///
  /// {@macro flutter.widgets.child}
3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195
  final Widget child;

  @override
  Widget build(BuildContext context) {
    return new Positioned.directional(
      textDirection: Directionality.of(context),
      start: start,
      top: top,
      end: end,
      bottom: bottom,
      width: width,
      height: height,
      child: child,
    );
  }
}

3196
/// A widget that displays its children in a one-dimensional array.
Adam Barth's avatar
Adam Barth committed
3197
///
3198 3199 3200
/// The [Flex] widget allows you to control the axis along which the children are
/// placed (horizontal or vertical). This is referred to as the _main axis_. If
/// you know the main axis in advance, then consider using a [Row] (if it's
3201
/// horizontal) or [Column] (if it's vertical) instead, because that will be less
3202 3203
/// verbose.
///
3204 3205
/// To cause a child to expand to fill the available vertical space, wrap the
/// child in an [Expanded] widget.
3206 3207 3208 3209
///
/// The [Flex] widget does not scroll (and in general it is considered an error
/// to have more children in a [Flex] than will fit in the available room). If
/// you have some widgets and want them to be able to scroll if there is
3210
/// insufficient room, consider using a [ListView].
3211 3212 3213
///
/// If you only have one child, then rather than using [Flex], [Row], or
/// [Column], consider using [Align] or [Center] to position the child.
3214 3215 3216
///
/// ## Layout algorithm
///
3217
/// _This section describes how a [Flex] is rendered by the framework._
3218
/// _See [BoxConstraints] for an introduction to box layout models._
3219
///
3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250 3251
/// Layout for a [Flex] proceeds in six steps:
///
/// 1. Layout each child a null or zero flex factor (e.g., those that are not
///    [Expanded]) with unbounded main axis constraints and the incoming
///    cross axis constraints. If the [crossAxisAlignment] is
///    [CrossAxisAlignment.stretch], instead use tight cross axis constraints
///    that match the incoming max extent in the cross axis.
/// 2. Divide the remaining main axis space among the children with non-zero
///    flex factors (e.g., those that are [Expanded]) according to their flex
///    factor. For example, a child with a flex factor of 2.0 will receive twice
///    the amount of main axis space as a child with a flex factor of 1.0.
/// 3. Layout each of the remaining children with the same cross axis
///    constraints as in step 1, but instead of using unbounded main axis
///    constraints, use max axis constraints based on the amount of space
///    allocated in step 2. Children with [Flexible.fit] properties that are
///    [FlexFit.tight] are given tight constraints (i.e., forced to fill the
///    allocated space), and children with [Flexible.fit] properties that are
///    [FlexFit.loose] are given loose constraints (i.e., not forced to fill the
///    allocated space).
/// 4. The cross axis extent of the [Flex] is the maximum cross axis extent of
///    the children (which will always satisfy the incoming constraints).
/// 5. The main axis extent of the [Flex] is determined by the [mainAxisSize]
///    property. If the [mainAxisSize] property is [MainAxisSize.max], then the
///    main axis extent of the [Flex] is the max extent of the incoming main
///    axis constraints. If the [mainAxisSize] property is [MainAxisSize.min],
///    then the main axis extent of the [Flex] is the sum of the main axis
///    extents of the children (subject to the incoming constraints).
/// 6. Determine the position for each child according to the
///    [mainAxisAlignment] and the [crossAxisAlignment]. For example, if the
///    [mainAxisAlignment] is [MainAxisAlignment.spaceBetween], any main axis
///    space that has not been allocated to children is divided evenly and
///    placed between the children.
3252 3253 3254 3255 3256 3257 3258
///
/// See also:
///
///  * [Row], for a version of this widget that is always horizontal.
///  * [Column], for a version of this widget that is always vertical.
///  * [Expanded], to indicate children that should take all the remaining room.
///  * [Flexible], to indicate children that should share the remaining room but
3259
///  * [Spacer], a widget that takes up space proportional to it's flex value.
3260
///    that may be sized smaller (leaving some remaining room unused).
3261
///  * The [catalog of layout widgets](https://flutter.io/widgets/layout/).
3262
class Flex extends MultiChildRenderObjectWidget {
3263 3264
  /// Creates a flex layout.
  ///
3265 3266
  /// The [direction] is required.
  ///
3267 3268
  /// The [direction], [mainAxisAlignment], [crossAxisAlignment], and
  /// [verticalDirection] arguments must not be null. If [crossAxisAlignment] is
3269
  /// [CrossAxisAlignment.baseline], then [textBaseline] must not be null.
3270 3271 3272 3273 3274 3275
  ///
  /// The [textDirection] argument defaults to the ambient [Directionality], if
  /// any. If there is no ambient directionality, and a text direction is going
  /// to be necessary to decide which direction to lay the children in or to
  /// disambiguate `start` or `end` values for the main or cross axis
  /// directions, the [textDirection] must not be null.
3276
  Flex({
3277
    Key key,
3278
    @required this.direction,
3279 3280 3281
    this.mainAxisAlignment = MainAxisAlignment.start,
    this.mainAxisSize = MainAxisSize.max,
    this.crossAxisAlignment = CrossAxisAlignment.center,
3282
    this.textDirection,
3283
    this.verticalDirection = VerticalDirection.down,
3284
    this.textBaseline,
3285
    List<Widget> children = const <Widget>[],
3286 3287 3288 3289
  }) : assert(direction != null),
       assert(mainAxisAlignment != null),
       assert(mainAxisSize != null),
       assert(crossAxisAlignment != null),
3290 3291
       assert(verticalDirection != null),
       assert(crossAxisAlignment != CrossAxisAlignment.baseline || textBaseline != null),
3292
       super(key: key, children: children);
3293

3294
  /// The direction to use as the main axis.
3295 3296 3297 3298 3299
  ///
  /// If you know the axis in advance, then consider using a [Row] (if it's
  /// horizontal) or [Column] (if it's vertical) instead of a [Flex], since that
  /// will be less verbose. (For [Row] and [Column] this property is fixed to
  /// the appropriate axis.)
3300
  final Axis direction;
3301 3302

  /// How the children should be placed along the main axis.
3303 3304 3305 3306
  ///
  /// For example, [MainAxisAlignment.start], the default, places the children
  /// at the start (i.e., the left for a [Row] or the top for a [Column]) of the
  /// main axis.
3307
  final MainAxisAlignment mainAxisAlignment;
3308

3309
  /// How much space should be occupied in the main axis.
3310 3311 3312
  ///
  /// After allocating space to children, there might be some remaining free
  /// space. This value controls whether to maximize or minimize the amount of
3313
  /// free space, subject to the incoming layout constraints.
3314 3315 3316 3317 3318
  ///
  /// If some children have a non-zero flex factors (and none have a fit of
  /// [FlexFit.loose]), they will expand to consume all the available space and
  /// there will be no remaining free space to maximize or minimize, making this
  /// value irrelevant to the final layout.
3319 3320
  final MainAxisSize mainAxisSize;

3321
  /// How the children should be placed along the cross axis.
3322 3323 3324
  ///
  /// For example, [CrossAxisAlignment.center], the default, centers the
  /// children in the cross axis (e.g., horizontally for a [Column]).
3325
  final CrossAxisAlignment crossAxisAlignment;
3326

3327 3328 3329 3330 3331
  /// Determines the order to lay children out horizontally and how to interpret
  /// `start` and `end` in the horizontal direction.
  ///
  /// Defaults to the ambient [Directionality].
  ///
3332 3333 3334
  /// If the [direction] is [Axis.horizontal], this controls the order in which
  /// the children are positioned (left-to-right or right-to-left), and the
  /// meaning of the [mainAxisAlignment] property's [MainAxisAlignment.start] and
3335 3336 3337 3338 3339 3340 3341 3342 3343 3344 3345 3346 3347 3348 3349 3350 3351 3352 3353 3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 3369 3370 3371 3372
  /// [MainAxisAlignment.end] values.
  ///
  /// If the [direction] is [Axis.horizontal], and either the
  /// [mainAxisAlignment] is either [MainAxisAlignment.start] or
  /// [MainAxisAlignment.end], or there's more than one child, then the
  /// [textDirection] (or the ambient [Directionality]) must not be null.
  ///
  /// If the [direction] is [Axis.vertical], this controls the meaning of the
  /// [crossAxisAlignment] property's [CrossAxisAlignment.start] and
  /// [CrossAxisAlignment.end] values.
  ///
  /// If the [direction] is [Axis.vertical], and the [crossAxisAlignment] is
  /// either [CrossAxisAlignment.start] or [CrossAxisAlignment.end], then the
  /// [textDirection] (or the ambient [Directionality]) must not be null.
  final TextDirection textDirection;

  /// Determines the order to lay children out vertically and how to interpret
  /// `start` and `end` in the vertical direction.
  ///
  /// Defaults to [VerticalDirection.down].
  ///
  /// If the [direction] is [Axis.vertical], this controls which order children
  /// are painted in (down or up), the meaning of the [mainAxisAlignment]
  /// property's [MainAxisAlignment.start] and [MainAxisAlignment.end] values.
  ///
  /// If the [direction] is [Axis.vertical], and either the [mainAxisAlignment]
  /// is either [MainAxisAlignment.start] or [MainAxisAlignment.end], or there's
  /// more than one child, then the [verticalDirection] must not be null.
  ///
  /// If the [direction] is [Axis.horizontal], this controls the meaning of the
  /// [crossAxisAlignment] property's [CrossAxisAlignment.start] and
  /// [CrossAxisAlignment.end] values.
  ///
  /// If the [direction] is [Axis.horizontal], and the [crossAxisAlignment] is
  /// either [CrossAxisAlignment.start] or [CrossAxisAlignment.end], then the
  /// [verticalDirection] must not be null.
  final VerticalDirection verticalDirection;

3373
  /// If aligning items according to their baseline, which baseline to use.
3374
  final TextBaseline textBaseline;
3375

3376 3377 3378 3379 3380 3381 3382 3383 3384 3385 3386 3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405 3406 3407 3408
  bool get _needTextDirection {
    assert(direction != null);
    switch (direction) {
      case Axis.horizontal:
        return true; // because it affects the layout order.
      case Axis.vertical:
        assert(crossAxisAlignment != null);
        return crossAxisAlignment == CrossAxisAlignment.start
            || crossAxisAlignment == CrossAxisAlignment.end;
    }
    return null;
  }

  /// The value to pass to [RenderFlex.textDirection].
  ///
  /// This value is derived from the [textDirection] property and the ambient
  /// [Directionality]. The value is null if there is no need to specify the
  /// text direction. In practice there's always a need to specify the direction
  /// except for vertical flexes (e.g. [Column]s) whose [crossAxisAlignment] is
  /// not dependent on the text direction (not `start` or `end`). In particular,
  /// a [Row] always needs a text direction because the text direction controls
  /// its layout order. (For [Column]s, the layout order is controlled by
  /// [verticalDirection], which is always specified as it does not depend on an
  /// inherited widget and defaults to [VerticalDirection.down].)
  ///
  /// This method exists so that subclasses of [Flex] that create their own
  /// render objects that are derived from [RenderFlex] can do so and still use
  /// the logic for providing a text direction only when it is necessary.
  @protected
  TextDirection getEffectiveTextDirection(BuildContext context) {
    return textDirection ?? (_needTextDirection ? Directionality.of(context) : null);
  }

3409
  @override
3410 3411 3412 3413 3414 3415
  RenderFlex createRenderObject(BuildContext context) {
    return new RenderFlex(
      direction: direction,
      mainAxisAlignment: mainAxisAlignment,
      mainAxisSize: mainAxisSize,
      crossAxisAlignment: crossAxisAlignment,
3416 3417 3418
      textDirection: getEffectiveTextDirection(context),
      verticalDirection: verticalDirection,
      textBaseline: textBaseline,
3419 3420
    );
  }
3421

3422
  @override
3423
  void updateRenderObject(BuildContext context, covariant RenderFlex renderObject) {
3424 3425
    renderObject
      ..direction = direction
3426
      ..mainAxisAlignment = mainAxisAlignment
3427
      ..mainAxisSize = mainAxisSize
3428
      ..crossAxisAlignment = crossAxisAlignment
3429 3430
      ..textDirection = getEffectiveTextDirection(context)
      ..verticalDirection = verticalDirection
3431
      ..textBaseline = textBaseline;
3432
  }
3433 3434

  @override
3435 3436 3437 3438 3439 3440 3441 3442 3443
  void debugFillProperties(DiagnosticPropertiesBuilder properties) {
    super.debugFillProperties(properties);
    properties.add(new EnumProperty<Axis>('direction', direction));
    properties.add(new EnumProperty<MainAxisAlignment>('mainAxisAlignment', mainAxisAlignment));
    properties.add(new EnumProperty<MainAxisSize>('mainAxisSize', mainAxisSize, defaultValue: MainAxisSize.max));
    properties.add(new EnumProperty<CrossAxisAlignment>('crossAxisAlignment', crossAxisAlignment));
    properties.add(new EnumProperty<TextDirection>('textDirection', textDirection, defaultValue: null));
    properties.add(new EnumProperty<VerticalDirection>('verticalDirection', verticalDirection, defaultValue: VerticalDirection.down));
    properties.add(new EnumProperty<TextBaseline>('textBaseline', textBaseline, defaultValue: null));
3444
  }
3445 3446
}

3447
/// A widget that displays its children in a horizontal array.
3448
///
3449 3450
/// To cause a child to expand to fill the available horizontal space, wrap the
/// child in an [Expanded] widget.
3451 3452 3453 3454
///
/// The [Row] widget does not scroll (and in general it is considered an error
/// to have more children in a [Row] than will fit in the available room). If
/// you have a line of widgets and want them to be able to scroll if there is
3455
/// insufficient room, consider using a [ListView].
3456 3457
///
/// For a vertical variant, see [Column].
3458 3459 3460
///
/// If you only have one child, then consider using [Align] or [Center] to
/// position the child.
3461
///
3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486
/// ## Sample code
///
/// This example divides the available space into three (horizontally), and
/// places text centered in the first two cells and the Flutter logo centered in
/// the third:
///
/// ```dart
/// new Row(
///   children: <Widget>[
///     new Expanded(
///       child: new Text('Deliver features faster', textAlign: TextAlign.center),
///     ),
///     new Expanded(
///       child: new Text('Craft beautiful UIs', textAlign: TextAlign.center),
///     ),
///     new Expanded(
///       child: new FittedBox(
///         fit: BoxFit.contain, // otherwise the logo will be tiny
///         child: const FlutterLogo(),
///       ),
///     ),
///   ],
/// )
/// ```
///
3487 3488
/// ## Troubleshooting
///
3489
/// ### Why does my row have a yellow and black warning stripe?
3490
///
3491 3492 3493 3494 3495 3496 3497
/// If the non-flexible contents of the row (those that are not wrapped in
/// [Expanded] or [Flexible] widgets) are together wider than the row itself,
/// then the row is said to have overflowed. When a row overflows, the row does
/// not have any remaining space to share between its [Expanded] and [Flexible]
/// children. The row reports this by drawing a yellow and black striped
/// warning box on the edge that is overflowing. If there is room on the outside
/// of the row, the amount of overflow is printed in red lettering.
3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522
///
/// #### Story time
///
/// Suppose, for instance, that you had this code:
///
/// ```dart
/// new Row(
///   children: <Widget>[
///     const FlutterLogo(),
///     const Text('Flutter\'s hot reload helps you quickly and easily experiment, build UIs, add features, and fix bug faster. Experience sub-second reload times, without losing state, on emulators, simulators, and hardware for iOS and Android.'),
///     const Icon(Icons.sentiment_very_satisfied),
///   ],
/// )
/// ```
///
/// The row first asks its first child, the [FlutterLogo], to lay out, at
/// whatever size the logo would like. The logo is friendly and happily decides
/// to be 24 pixels to a side. This leaves lots of room for the next child. The
/// row then asks that next child, the text, to lay out, at whatever size it
/// thinks is best.
///
/// At this point, the text, not knowing how wide is too wide, says "Ok, I will
/// be thiiiiiiiiiiiiiiiiiiiis wide.", and goes well beyond the space that the
/// row has available, not wrapping. The row responds, "That's not fair, now I
/// have no more room available for my other children!", and gets angry and
3523
/// sprouts a yellow and black strip.
3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547
///
/// The fix is to wrap the second child in an [Expanded] widget, which tells the
/// row that the child should be given the remaining room:
///
/// ```dart
/// new Row(
///   children: <Widget>[
///     const FlutterLogo(),
///     const Expanded(
///       child: const Text('Flutter\'s hot reload helps you quickly and easily experiment, build UIs, add features, and fix bug faster. Experience sub-second reload times, without losing state, on emulators, simulators, and hardware for iOS and Android.'),
///     ),
///     const Icon(Icons.sentiment_very_satisfied),
///   ],
/// )
/// ```
///
/// Now, the row first asks the logo to lay out, and then asks the _icon_ to lay
/// out. The [Icon], like the logo, is happy to take on a reasonable size (also
/// 24 pixels, not coincidentally, since both [FlutterLogo] and [Icon] honor the
/// ambient [IconTheme]). This leaves some room left over, and now the row tells
/// the text exactly how wide to be: the exact width of the remaining space. The
/// text, now happy to comply to a reasonable request, wraps the text within
/// that width, and you end up with a paragraph split over several lines.
///
3548 3549
/// ## Layout algorithm
///
3550
/// _This section describes how a [Row] is rendered by the framework._
3551
/// _See [BoxConstraints] for an introduction to box layout models._
3552
///
3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582
/// Layout for a [Row] proceeds in six steps:
///
/// 1. Layout each child a null or zero flex factor (e.g., those that are not
///    [Expanded]) with unbounded horizontal constraints and the incoming
///    vertical constraints. If the [crossAxisAlignment] is
///    [CrossAxisAlignment.stretch], instead use tight vertical constraints that
///    match the incoming max height.
/// 2. Divide the remaining horizontal space among the children with non-zero
///    flex factors (e.g., those that are [Expanded]) according to their flex
///    factor. For example, a child with a flex factor of 2.0 will receive twice
///    the amount of horizontal space as a child with a flex factor of 1.0.
/// 3. Layout each of the remaining children with the same vertical constraints
///    as in step 1, but instead of using unbounded horizontal constraints, use
///    horizontal constraints based on the amount of space allocated in step 2.
///    Children with [Flexible.fit] properties that are [FlexFit.tight] are
///    given tight constraints (i.e., forced to fill the allocated space), and
///    children with [Flexible.fit] properties that are [FlexFit.loose] are
///    given loose constraints (i.e., not forced to fill the allocated space).
/// 4. The height of the [Row] is the maximum height of the children (which will
///    always satisfy the incoming vertical constraints).
/// 5. The width of the [Row] is determined by the [mainAxisSize] property. If
///    the [mainAxisSize] property is [MainAxisSize.max], then the width of the
///    [Row] is the max width of the incoming constraints. If the [mainAxisSize]
///    property is [MainAxisSize.min], then the width of the [Row] is the sum
///    of widths of the children (subject to the incoming constraints).
/// 6. Determine the position for each child according to the
///    [mainAxisAlignment] and the [crossAxisAlignment]. For example, if the
///    [mainAxisAlignment] is [MainAxisAlignment.spaceBetween], any horizontal
///    space that has not been allocated to children is divided evenly and
///    placed between the children.
3583 3584 3585 3586 3587 3588 3589 3590 3591
///
/// See also:
///
///  * [Column], for a vertical equivalent.
///  * [Flex], if you don't know in advance if you want a horizontal or vertical
///    arrangement.
///  * [Expanded], to indicate children that should take all the remaining room.
///  * [Flexible], to indicate children that should share the remaining room but
///    that may by sized smaller (leaving some remaining room unused).
3592
///  * [Spacer], a widget that takes up space proportional to it's flex value.
3593
///  * The [catalog of layout widgets](https://flutter.io/widgets/layout/).
3594
class Row extends Flex {
3595 3596
  /// Creates a horizontal array of children.
  ///
3597 3598 3599 3600 3601 3602 3603 3604 3605
  /// The [direction], [mainAxisAlignment], [mainAxisSize],
  /// [crossAxisAlignment], and [verticalDirection] arguments must not be null.
  /// If [crossAxisAlignment] is [CrossAxisAlignment.baseline], then
  /// [textBaseline] must not be null.
  ///
  /// The [textDirection] argument defaults to the ambient [Directionality], if
  /// any. If there is no ambient directionality, and a text direction is going
  /// to be necessary to determine the layout order (which is always the case
  /// unless the row has no children or only one child) or to disambiguate
3606
  /// `start` or `end` values for the [mainAxisAlignment], the [textDirection]
3607
  /// must not be null.
3608
  Row({
3609
    Key key,
3610 3611 3612
    MainAxisAlignment mainAxisAlignment = MainAxisAlignment.start,
    MainAxisSize mainAxisSize = MainAxisSize.max,
    CrossAxisAlignment crossAxisAlignment = CrossAxisAlignment.center,
3613
    TextDirection textDirection,
3614
    VerticalDirection verticalDirection = VerticalDirection.down,
3615
    TextBaseline textBaseline,
3616
    List<Widget> children = const <Widget>[],
3617 3618 3619
  }) : super(
    children: children,
    key: key,
3620
    direction: Axis.horizontal,
3621
    mainAxisAlignment: mainAxisAlignment,
3622
    mainAxisSize: mainAxisSize,
3623
    crossAxisAlignment: crossAxisAlignment,
3624 3625 3626
    textDirection: textDirection,
    verticalDirection: verticalDirection,
    textBaseline: textBaseline,
3627
  );
3628 3629
}

3630
/// A widget that displays its children in a vertical array.
3631
///
3632 3633
/// To cause a child to expand to fill the available vertical space, wrap the
/// child in an [Expanded] widget.
3634
///
3635 3636 3637
/// The [Column] widget does not scroll (and in general it is considered an error
/// to have more children in a [Column] than will fit in the available room). If
/// you have a line of widgets and want them to be able to scroll if there is
3638
/// insufficient room, consider using a [ListView].
3639 3640
///
/// For a horizontal variant, see [Row].
3641 3642 3643
///
/// If you only have one child, then consider using [Align] or [Center] to
/// position the child.
3644
///
3645 3646 3647 3648 3649 3650 3651 3652 3653 3654 3655 3656
/// ## Sample code
///
/// This example uses a [Column] to arrange three widgets vertically, the last
/// being made to fill all the remaining space.
///
/// ```dart
/// new Column(
///   children: <Widget>[
///     new Text('Deliver features faster'),
///     new Text('Craft beautiful UIs'),
///     new Expanded(
///       child: new FittedBox(
3657
///         fit: BoxFit.contain, // otherwise the logo will be tiny
3658 3659 3660 3661 3662 3663 3664 3665 3666 3667 3668 3669 3670 3671 3672 3673 3674 3675 3676 3677 3678 3679 3680 3681 3682 3683 3684 3685 3686
///         child: const FlutterLogo(),
///       ),
///     ),
///   ],
/// )
/// ```
///
/// In the sample above, the text and the logo are centered on each line. In the
/// following example, the [crossAxisAlignment] is set to
/// [CrossAxisAlignment.start], so that the children are left-aligned. The
/// [mainAxisSize] is set to [MainAxisSize.min], so that the column shrinks to
/// fit the children.
///
/// ```dart
/// new Column(
///   crossAxisAlignment: CrossAxisAlignment.start,
///   mainAxisSize: MainAxisSize.min,
///   children: <Widget>[
///     new Text('We move under cover and we move as one'),
///     new Text('Through the night, we have one shot to live another day'),
///     new Text('We cannot let a stray gunshot give us away'),
///     new Text('We will fight up close, seize the moment and stay in it'),
///     new Text('It’s either that or meet the business end of a bayonet'),
///     new Text('The code word is ‘Rochambeau,’ dig me?'),
///     new Text('Rochambeau!', style: DefaultTextStyle.of(context).style.apply(fontSizeFactor: 2.0)),
///   ],
/// )
/// ```
///
3687 3688 3689 3690 3691 3692 3693 3694 3695 3696 3697 3698 3699 3700 3701 3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 3727 3728 3729 3730 3731 3732 3733 3734 3735 3736 3737 3738
/// ## Troubleshooting
///
/// ### When the incoming vertical constraints are unbounded
///
/// When a [Column] has one or more [Expanded] or [Flexible] children, and is
/// placed in another [Column], or in a [ListView], or in some other context
/// that does not provide a maximum height constraint for the [Column], you will
/// get an exception at runtime saying that there are children with non-zero
/// flex but the vertical constraints are unbounded.
///
/// The problem, as described in the details that accompany that exception, is
/// that using [Flexible] or [Expanded] means that the remaining space after
/// laying out all the other children must be shared equally, but if the
/// incoming vertical constraints are unbounded, there is infinite remaining
/// space.
///
/// The key to solving this problem is usually to determine why the [Column] is
/// receiving unbounded vertical constraints.
///
/// One common reason for this to happen is that the [Column] has been placed in
/// another [Column] (without using [Expanded] or [Flexible] around the inner
/// nested [Column]). When a [Column] lays out its non-flex children (those that
/// have neither [Expanded] or [Flexible] around them), it gives them unbounded
/// constraints so that they can determine their own dimensions (passing
/// unbounded constraints usually signals to the child that it should
/// shrink-wrap its contents). The solution in this case is typically to just
/// wrap the inner column in an [Expanded] to indicate that it should take the
/// remaining space of the outer column, rather than being allowed to take any
/// amount of room it desires.
///
/// Another reason for this message to be displayed is nesting a [Column] inside
/// a [ListView] or other vertical scrollable. In that scenario, there really is
/// infinite vertical space (the whole point of a vertical scrolling list is to
/// allow infinite space vertically). In such scenarios, it is usually worth
/// examining why the inner [Column] should have an [Expanded] or [Flexible]
/// child: what size should the inner children really be? The solution in this
/// case is typically to remove the [Expanded] or [Flexible] widgets from around
/// the inner children.
///
/// For more discussion about constraints, see [BoxConstraints].
///
/// ### The yellow and black striped banner
///
/// When the contents of a [Column] exceed the amount of space available, the
/// [Column] overflows, and the contents are clipped. In debug mode, a yellow
/// and black striped bar is rendered at the overflowing edge to indicate the
/// problem, and a message is printed below the [Column] saying how much
/// overflow was detected.
///
/// The usual solution is to use a [ListView] rather than a [Column], to enable
/// the contents to scroll when vertical space is limited.
///
3739 3740
/// ## Layout algorithm
///
3741
/// _This section describes how a [Column] is rendered by the framework._
3742
/// _See [BoxConstraints] for an introduction to box layout models._
3743
///
3744 3745 3746 3747 3748 3749 3750 3751 3752 3753 3754 3755 3756 3757 3758 3759 3760 3761 3762 3763 3764 3765 3766 3767 3768 3769 3770 3771 3772 3773 3774 3775
/// Layout for a [Column] proceeds in six steps:
///
/// 1. Layout each child a null or zero flex factor (e.g., those that are not
///    [Expanded]) with unbounded vertical constraints and the incoming
///    horizontal constraints. If the [crossAxisAlignment] is
///    [CrossAxisAlignment.stretch], instead use tight horizontal constraints
///    that match the incoming max width.
/// 2. Divide the remaining vertical space among the children with non-zero
///    flex factors (e.g., those that are [Expanded]) according to their flex
///    factor. For example, a child with a flex factor of 2.0 will receive twice
///    the amount of vertical space as a child with a flex factor of 1.0.
/// 3. Layout each of the remaining children with the same horizontal
///    constraints as in step 1, but instead of using unbounded vertical
///    constraints, use vertical constraints based on the amount of space
///    allocated in step 2. Children with [Flexible.fit] properties that are
///    [FlexFit.tight] are given tight constraints (i.e., forced to fill the
///    allocated space), and children with [Flexible.fit] properties that are
///    [FlexFit.loose] are given loose constraints (i.e., not forced to fill the
///    allocated space).
/// 4. The width of the [Column] is the maximum width of the children (which
///    will always satisfy the incoming horizontal constraints).
/// 5. The height of the [Column] is determined by the [mainAxisSize] property.
///    If the [mainAxisSize] property is [MainAxisSize.max], then the height of
///    the [Column] is the max height of the incoming constraints. If the
///    [mainAxisSize] property is [MainAxisSize.min], then the height of the
///    [Column] is the sum of heights of the children (subject to the incoming
///    constraints).
/// 6. Determine the position for each child according to the
///    [mainAxisAlignment] and the [crossAxisAlignment]. For example, if the
///    [mainAxisAlignment] is [MainAxisAlignment.spaceBetween], any vertical
///    space that has not been allocated to children is divided evenly and
///    placed between the children.
3776 3777 3778 3779 3780 3781 3782 3783 3784
///
/// See also:
///
///  * [Row], for a horizontal equivalent.
///  * [Flex], if you don't know in advance if you want a horizontal or vertical
///    arrangement.
///  * [Expanded], to indicate children that should take all the remaining room.
///  * [Flexible], to indicate children that should share the remaining room but
///    that may size smaller (leaving some remaining room unused).
3785 3786
///  * [SingleChildScrollView], whose documentation discusses some ways to
///    use a [Column] inside a scrolling container.
3787
///  * [Spacer], a widget that takes up space proportional to it's flex value.
3788
///  * The [catalog of layout widgets](https://flutter.io/widgets/layout/).
3789
class Column extends Flex {
3790 3791
  /// Creates a vertical array of children.
  ///
3792 3793 3794 3795 3796 3797 3798 3799
  /// The [direction], [mainAxisAlignment], [mainAxisSize],
  /// [crossAxisAlignment], and [verticalDirection] arguments must not be null.
  /// If [crossAxisAlignment] is [CrossAxisAlignment.baseline], then
  /// [textBaseline] must not be null.
  ///
  /// The [textDirection] argument defaults to the ambient [Directionality], if
  /// any. If there is no ambient directionality, and a text direction is going
  /// to be necessary to disambiguate `start` or `end` values for the
3800
  /// [crossAxisAlignment], the [textDirection] must not be null.
3801
  Column({
3802
    Key key,
3803 3804 3805
    MainAxisAlignment mainAxisAlignment = MainAxisAlignment.start,
    MainAxisSize mainAxisSize = MainAxisSize.max,
    CrossAxisAlignment crossAxisAlignment = CrossAxisAlignment.center,
3806
    TextDirection textDirection,
3807
    VerticalDirection verticalDirection = VerticalDirection.down,
3808
    TextBaseline textBaseline,
3809
    List<Widget> children = const <Widget>[],
3810 3811 3812
  }) : super(
    children: children,
    key: key,
3813
    direction: Axis.vertical,
3814
    mainAxisAlignment: mainAxisAlignment,
3815
    mainAxisSize: mainAxisSize,
3816
    crossAxisAlignment: crossAxisAlignment,
3817 3818 3819
    textDirection: textDirection,
    verticalDirection: verticalDirection,
    textBaseline: textBaseline,
3820
  );
3821 3822
}

3823
/// A widget that controls how a child of a [Row], [Column], or [Flex] flexes.
Adam Barth's avatar
Adam Barth committed
3824
///
3825 3826 3827 3828 3829 3830
/// Using a [Flexible] widget gives a child of a [Row], [Column], or [Flex]
/// the flexibility to expand to fill the available space in the main axis
/// (e.g., horizontally for a [Row] or vertically for a [Column]), but, unlike
/// [Expanded], [Flexible] does not require the child to fill the available
/// space.
///
3831 3832 3833 3834
/// A [Flexible] widget must be a descendant of a [Row], [Column], or [Flex],
/// and the path from the [Flexible] widget to its enclosing [Row], [Column], or
/// [Flex] must contain only [StatelessWidget]s or [StatefulWidget]s (not other
/// kinds of widgets, like [RenderObjectWidget]s).
3835 3836 3837 3838
///
/// See also:
///
///  * [Expanded], which forces the child to expand to fill the available space.
3839
///  * [Spacer], a widget that takes up space proportional to it's flex value.
3840
///  * The [catalog of layout widgets](https://flutter.io/widgets/layout/).
3841
class Flexible extends ParentDataWidget<Flex> {
3842 3843
  /// Creates a widget that controls how a child of a [Row], [Column], or [Flex]
  /// flexes.
3844
  const Flexible({
3845
    Key key,
3846 3847
    this.flex = 1,
    this.fit = FlexFit.loose,
3848
    @required Widget child,
3849
  }) : super(key: key, child: child);
3850

Adam Barth's avatar
Adam Barth committed
3851 3852
  /// The flex factor to use for this child
  ///
Adam Barth's avatar
Adam Barth committed
3853 3854 3855 3856
  /// If null or zero, the child is inflexible and determines its own size. If
  /// non-zero, the amount of space the child's can occupy in the main axis is
  /// determined by dividing the free space (after placing the inflexible
  /// children) according to the flex factors of the flexible children.
3857 3858
  final int flex;

Adam Barth's avatar
Adam Barth committed
3859 3860 3861 3862 3863 3864 3865 3866 3867
  /// How a flexible child is inscribed into the available space.
  ///
  /// If [flex] is non-zero, the [fit] determines whether the child fills the
  /// space the parent makes available during layout. If the fit is
  /// [FlexFit.tight], the child is required to fill the available space. If the
  /// fit is [FlexFit.loose], the child can be at most as large as the available
  /// space (but is allowed to be smaller).
  final FlexFit fit;

3868
  @override
3869 3870 3871
  void applyParentData(RenderObject renderObject) {
    assert(renderObject.parentData is FlexParentData);
    final FlexParentData parentData = renderObject.parentData;
Adam Barth's avatar
Adam Barth committed
3872 3873
    bool needsLayout = false;

3874 3875
    if (parentData.flex != flex) {
      parentData.flex = flex;
Adam Barth's avatar
Adam Barth committed
3876 3877 3878 3879 3880 3881 3882 3883 3884
      needsLayout = true;
    }

    if (parentData.fit != fit) {
      parentData.fit = fit;
      needsLayout = true;
    }

    if (needsLayout) {
3885
      final AbstractNode targetParent = renderObject.parent;
3886 3887
      if (targetParent is RenderObject)
        targetParent.markNeedsLayout();
3888 3889
    }
  }
3890

3891
  @override
3892 3893 3894
  void debugFillProperties(DiagnosticPropertiesBuilder properties) {
    super.debugFillProperties(properties);
    properties.add(new IntProperty('flex', flex));
3895
  }
3896 3897
}

3898 3899
/// A widget that expands a child of a [Row], [Column], or [Flex].
///
3900
/// Using an [Expanded] widget makes a child of a [Row], [Column], or [Flex]
3901 3902
/// expand to fill the available space in the main axis (e.g., horizontally for
/// a [Row] or vertically for a [Column]). If multiple children are expanded,
3903
/// the available space is divided among them according to the [flex] factor.
3904 3905
///
/// An [Expanded] widget must be a descendant of a [Row], [Column], or [Flex],
3906
/// and the path from the [Expanded] widget to its enclosing [Row], [Column], or
3907 3908
/// [Flex] must contain only [StatelessWidget]s or [StatefulWidget]s (not other
/// kinds of widgets, like [RenderObjectWidget]s).
3909 3910 3911 3912
///
/// See also:
///
///  * [Flexible], which does not force the child to fill the available space.
3913
///  * [Spacer], a widget that takes up space proportional to it's flex value.
3914
///  * The [catalog of layout widgets](https://flutter.io/widgets/layout/).
3915 3916 3917
class Expanded extends Flexible {
  /// Creates a widget that expands a child of a [Row], [Column], or [Flex]
  /// expand to fill the available space in the main axis.
3918
  const Expanded({
3919
    Key key,
3920
    int flex = 1,
3921
    @required Widget child,
3922
  }) : super(key: key, flex: flex, fit: FlexFit.tight, child: child);
3923 3924
}

3925 3926 3927 3928 3929 3930 3931 3932 3933 3934 3935 3936 3937
/// A widget that displays its children in multiple horizontal or vertical runs.
///
/// A [Wrap] 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, [Wrap]
/// 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].
Ian Hickson's avatar
Ian Hickson committed
3938 3939 3940 3941 3942 3943 3944 3945 3946 3947 3948 3949 3950 3951 3952 3953 3954 3955 3956 3957 3958 3959 3960 3961 3962 3963 3964 3965 3966 3967 3968 3969 3970 3971 3972
///
/// ## Sample code
///
/// This example renders some [Chip]s representing four contacts in a [Wrap] so
/// that they flow across lines as necessary.
///
/// ```dart
/// new Wrap(
///   spacing: 8.0, // gap between adjacent chips
///   runSpacing: 4.0, // gap between lines
///   children: <Widget>[
///     new Chip(
///       avatar: new CircleAvatar(backgroundColor: Colors.blue.shade900, child: new Text('AH')),
///       label: new Text('Hamilton'),
///     ),
///     new Chip(
///       avatar: new CircleAvatar(backgroundColor: Colors.blue.shade900, child: new Text('ML')),
///       label: new Text('Lafayette'),
///     ),
///     new Chip(
///       avatar: new CircleAvatar(backgroundColor: Colors.blue.shade900, child: new Text('HM')),
///       label: new Text('Mulligan'),
///     ),
///     new Chip(
///       avatar: new CircleAvatar(backgroundColor: Colors.blue.shade900, child: new Text('JL')),
///       label: new Text('Laurens'),
///     ),
///   ],
/// )
/// ```
///
/// See also:
///
///  * [Row], which places children in one line, and gives control over their
///    alignment and spacing.
3973
///  * The [catalog of layout widgets](https://flutter.io/widgets/layout/).
Adam Barth's avatar
Adam Barth committed
3974
class Wrap extends MultiChildRenderObjectWidget {
3975 3976 3977 3978
  /// Creates a wrap layout.
  ///
  /// By default, the wrap layout is horizontal and both the children and the
  /// runs are aligned to the start.
3979 3980 3981 3982 3983 3984
  ///
  /// The [textDirection] argument defaults to the ambient [Directionality], if
  /// any. If there is no ambient directionality, and a text direction is going
  /// to be necessary to decide which direction to lay the children in or to
  /// disambiguate `start` or `end` values for the main or cross axis
  /// directions, the [textDirection] must not be null.
Adam Barth's avatar
Adam Barth committed
3985 3986
  Wrap({
    Key key,
3987 3988 3989 3990 3991 3992
    this.direction = Axis.horizontal,
    this.alignment = WrapAlignment.start,
    this.spacing = 0.0,
    this.runAlignment = WrapAlignment.start,
    this.runSpacing = 0.0,
    this.crossAxisAlignment = WrapCrossAlignment.start,
3993
    this.textDirection,
3994 3995
    this.verticalDirection = VerticalDirection.down,
    List<Widget> children = const <Widget>[],
Adam Barth's avatar
Adam Barth committed
3996 3997 3998 3999 4000 4001 4002 4003 4004 4005 4006 4007 4008
  }) : super(key: key, children: 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.
  final Axis direction;

  /// How the children within a run should be places in the main axis.
  ///
  /// For example, if [alignment] is [WrapAlignment.center], the children in
4009
  /// each run are grouped together in the center of their run in the main axis.
Adam Barth's avatar
Adam Barth committed
4010 4011 4012 4013 4014 4015 4016 4017 4018 4019 4020 4021 4022 4023 4024 4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 4036
  ///
  /// 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.
  final WrapAlignment alignment;

  /// 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.
  final double spacing;

  /// How the runs themselves should be placed in the cross axis.
  ///
  /// For example, if [runAlignment] is [WrapAlignment.center], the runs are
4037
  /// grouped together in the center of the overall [Wrap] in the cross axis.
Adam Barth's avatar
Adam Barth committed
4038 4039 4040 4041 4042 4043 4044 4045 4046 4047 4048 4049 4050 4051 4052 4053 4054 4055 4056 4057 4058 4059 4060 4061 4062 4063 4064
  ///
  /// 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.
  final WrapAlignment runAlignment;

  /// 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 [Wrap] (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.
  final double runSpacing;

  /// 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
4065
  /// [direction] is [Axis.horizontal], then the children within each
Adam Barth's avatar
Adam Barth committed
4066 4067 4068 4069 4070 4071 4072 4073 4074 4075 4076 4077
  /// 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.
  final WrapCrossAlignment crossAxisAlignment;

4078 4079 4080 4081 4082 4083 4084 4085 4086 4087 4088 4089 4090 4091 4092 4093 4094 4095 4096 4097 4098 4099 4100 4101 4102 4103 4104 4105 4106 4107 4108 4109 4110 4111 4112 4113 4114 4115 4116 4117 4118 4119 4120 4121 4122 4123 4124 4125 4126 4127 4128 4129
  /// Determines the order to lay children out horizontally and how to interpret
  /// `start` and `end` in the horizontal direction.
  ///
  /// Defaults to the ambient [Directionality].
  ///
  /// If the [direction] is [Axis.horizontal], this controls order in which the
  /// 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] (or the ambient
  /// [Directionality]) 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] (or the ambient [Directionality]) must not be null.
  final TextDirection textDirection;

  /// 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.
  final VerticalDirection verticalDirection;

Adam Barth's avatar
Adam Barth committed
4130 4131 4132 4133 4134 4135 4136 4137 4138
  @override
  RenderWrap createRenderObject(BuildContext context) {
    return new RenderWrap(
      direction: direction,
      alignment: alignment,
      spacing: spacing,
      runAlignment: runAlignment,
      runSpacing: runSpacing,
      crossAxisAlignment: crossAxisAlignment,
4139 4140
      textDirection: textDirection ?? Directionality.of(context),
      verticalDirection: verticalDirection,
Adam Barth's avatar
Adam Barth committed
4141 4142 4143 4144 4145 4146 4147 4148 4149 4150 4151
    );
  }

  @override
  void updateRenderObject(BuildContext context, RenderWrap renderObject) {
    renderObject
      ..direction = direction
      ..alignment = alignment
      ..spacing = spacing
      ..runAlignment = runAlignment
      ..runSpacing = runSpacing
4152 4153 4154 4155 4156 4157
      ..crossAxisAlignment = crossAxisAlignment
      ..textDirection = textDirection ?? Directionality.of(context)
      ..verticalDirection = verticalDirection;
  }

  @override
4158 4159 4160 4161 4162 4163 4164 4165 4166 4167
  void debugFillProperties(DiagnosticPropertiesBuilder properties) {
    super.debugFillProperties(properties);
    properties.add(new EnumProperty<Axis>('direction', direction));
    properties.add(new EnumProperty<WrapAlignment>('alignment', alignment));
    properties.add(new DoubleProperty('spacing', spacing));
    properties.add(new EnumProperty<WrapAlignment>('runAlignment', runAlignment));
    properties.add(new DoubleProperty('runSpacing', runSpacing));
    properties.add(new DoubleProperty('crossAxisAlignment', runSpacing));
    properties.add(new EnumProperty<TextDirection>('textDirection', textDirection, defaultValue: null));
    properties.add(new EnumProperty<VerticalDirection>('verticalDirection', verticalDirection, defaultValue: VerticalDirection.down));
Adam Barth's avatar
Adam Barth committed
4168 4169 4170
  }
}

Ian Hickson's avatar
Ian Hickson committed
4171 4172
/// A widget that sizes and positions children efficiently, according to the
/// logic in a [FlowDelegate].
Adam Barth's avatar
Adam Barth committed
4173 4174 4175 4176 4177 4178 4179 4180 4181 4182 4183 4184
///
/// Flow layouts are optimized for repositioning children using transformation
/// matrices.
///
/// The flow container is sized independently from the children by the
/// [FlowDelegate.getSize] function of the delegate. The children are then sized
/// independently given the constraints from the
/// [FlowDelegate.getConstraintsForChild] function.
///
/// Rather than positioning the children during layout, the children are
/// positioned using transformation matrices during the paint phase using the
/// matrices from the [FlowDelegate.paintChildren] function. The children can be
Ian Hickson's avatar
Ian Hickson committed
4185 4186 4187
/// repositioned efficiently by simply repainting the flow, which happens
/// without the children being laid out again (contrast this with a [Stack],
/// which does the sizing and positioning together during layout).
Adam Barth's avatar
Adam Barth committed
4188
///
Ian Hickson's avatar
Ian Hickson committed
4189 4190 4191 4192
/// The most efficient way to trigger a repaint of the flow is to supply an
/// animation to the constructor of the [FlowDelegate]. The flow will listen to
/// this animation and repaint whenever the animation ticks, avoiding both the
/// build and layout phases of the pipeline.
Adam Barth's avatar
Adam Barth committed
4193 4194 4195
///
/// See also:
///
Ian Hickson's avatar
Ian Hickson committed
4196 4197
///  * [Wrap], which provides the layout model that some other frameworks call
///    "flow", and is otherwise unrelated to [Flow].
4198 4199 4200 4201 4202 4203
///  * [FlowDelegate], which controls the visual presentation of the children.
///  * [Stack], which arranges children relative to the edges of the container.
///  * [CustomSingleChildLayout], which uses a delegate to control the layout of
///    a single child.
///  * [CustomMultiChildLayout], which uses a delegate to position multiple
///    children.
4204
///  * The [catalog of layout widgets](https://flutter.io/widgets/layout/).
Adam Barth's avatar
Adam Barth committed
4205 4206 4207 4208 4209
class Flow extends MultiChildRenderObjectWidget {
  /// Creates a flow layout.
  ///
  /// Wraps each of the given children in a [RepaintBoundary] to avoid
  /// repainting the children when the flow repaints.
4210 4211
  ///
  /// The [delegate] argument must not be null.
Adam Barth's avatar
Adam Barth committed
4212 4213
  Flow({
    Key key,
4214
    @required this.delegate,
4215
    List<Widget> children = const <Widget>[],
4216 4217 4218
  }) : assert(delegate != null),
       super(key: key, children: RepaintBoundary.wrapAll(children));
       // https://github.com/dart-lang/sdk/issues/29277
Adam Barth's avatar
Adam Barth committed
4219 4220 4221 4222 4223 4224

  /// Creates a flow layout.
  ///
  /// Does not wrap the given children in repaint boundaries, unlike the default
  /// constructor. Useful when the child is trivial to paint or already contains
  /// a repaint boundary.
4225 4226
  ///
  /// The [delegate] argument must not be null.
Adam Barth's avatar
Adam Barth committed
4227 4228
  Flow.unwrapped({
    Key key,
4229
    @required this.delegate,
4230
    List<Widget> children = const <Widget>[],
4231 4232
  }) : assert(delegate != null),
       super(key: key, children: children);
Adam Barth's avatar
Adam Barth committed
4233 4234 4235 4236 4237 4238 4239 4240 4241 4242 4243 4244 4245 4246

  /// The delegate that controls the transformation matrices of the children.
  final FlowDelegate delegate;

  @override
  RenderFlow createRenderObject(BuildContext context) => new RenderFlow(delegate: delegate);

  @override
  void updateRenderObject(BuildContext context, RenderFlow renderObject) {
    renderObject
      ..delegate = delegate;
  }
}

Adam Barth's avatar
Adam Barth committed
4247
/// A paragraph of rich text.
4248
///
4249
/// The [RichText] widget displays text that uses multiple different styles. The
4250
/// text to display is described using a tree of [TextSpan] objects, each of
4251 4252 4253
/// which has an associated style that is used for that subtree. The text might
/// break across multiple lines or might all be displayed on the same line
/// depending on the layout constraints.
4254 4255
///
/// Text displayed in a [RichText] widget must be explicitly styled. When
4256
/// picking which style to use, consider using [DefaultTextStyle.of] the current
4257 4258
/// [BuildContext] to provide defaults. For more details on how to style text in
/// a [RichText] widget, see the documentation for [TextStyle].
4259
///
4260 4261 4262 4263 4264
/// Consider using the [Text] widget to integrate with the [DefaultTextStyle]
/// automatically. When all the text uses the same style, the default constructor
/// is less verbose. The [Text.rich] constructor allows you to style multiple 
/// spans with the default text style while still allowing specified styles per 
/// span.
4265
///
4266
/// ## Sample code
4267 4268 4269 4270 4271 4272 4273 4274 4275 4276 4277
///
/// ```dart
/// new RichText(
///   text: new TextSpan(
///     text: 'Hello ',
///     style: DefaultTextStyle.of(context).style,
///     children: <TextSpan>[
///       new TextSpan(text: 'bold', style: new TextStyle(fontWeight: FontWeight.bold)),
///       new TextSpan(text: ' world!'),
///     ],
///   ),
4278
/// )
4279 4280
/// ```
///
4281 4282
/// See also:
///
4283
///  * [TextStyle], which discusses how to style text.
4284 4285 4286
///  * [TextSpan], which is used to describe the text in a paragraph.
///  * [Text], which automatically applies the ambient styles described by a
///    [DefaultTextStyle] to a single string.
Adam Barth's avatar
Adam Barth committed
4287
class RichText extends LeafRenderObjectWidget {
4288 4289
  /// Creates a paragraph of rich text.
  ///
4290
  /// The [text], [textAlign], [softWrap], [overflow], and [textScaleFactor]
Ian Hickson's avatar
Ian Hickson committed
4291
  /// arguments must not be null.
4292 4293 4294
  ///
  /// The [maxLines] property may be null (and indeed defaults to null), but if
  /// it is not null, it must be greater than zero.
Ian Hickson's avatar
Ian Hickson committed
4295 4296 4297
  ///
  /// The [textDirection], if null, defaults to the ambient [Directionality],
  /// which in that case must not be null.
4298
  const RichText({
4299
    Key key,
4300
    @required this.text,
4301
    this.textAlign = TextAlign.start,
Ian Hickson's avatar
Ian Hickson committed
4302
    this.textDirection,
4303 4304 4305
    this.softWrap = true,
    this.overflow = TextOverflow.clip,
    this.textScaleFactor = 1.0,
4306
    this.maxLines,
4307
    this.locale,
4308
  }) : assert(text != null),
Ian Hickson's avatar
Ian Hickson committed
4309
       assert(textAlign != null),
4310 4311 4312
       assert(softWrap != null),
       assert(overflow != null),
       assert(textScaleFactor != null),
4313
       assert(maxLines == null || maxLines > 0),
4314
       super(key: key);
4315

4316
  /// The text to display in this widget.
4317
  final TextSpan text;
4318

4319 4320 4321
  /// How the text should be aligned horizontally.
  final TextAlign textAlign;

Ian Hickson's avatar
Ian Hickson committed
4322 4323 4324 4325 4326 4327 4328 4329 4330
  /// The directionality of the text.
  ///
  /// This decides how [textAlign] values like [TextAlign.start] and
  /// [TextAlign.end] are interpreted.
  ///
  /// This is also used to disambiguate how to render bidirectional text. For
  /// example, if the [text] is an English phrase followed by a Hebrew phrase,
  /// in a [TextDirection.ltr] context the English phrase will be on the left
  /// and the Hebrew phrase to its right, while in a [TextDirection.rtl]
4331
  /// context, the English phrase will be on the right and the Hebrew phrase on
Ian Hickson's avatar
Ian Hickson committed
4332 4333 4334 4335 4336 4337
  /// its left.
  ///
  /// Defaults to the ambient [Directionality], if any. If there is no ambient
  /// [Directionality], then this must not be null.
  final TextDirection textDirection;

4338 4339 4340 4341 4342 4343 4344 4345
  /// Whether the text should break at soft line breaks.
  ///
  /// If false, the glyphs in the text will be positioned as if there was unlimited horizontal space.
  final bool softWrap;

  /// How visual overflow should be handled.
  final TextOverflow overflow;

4346 4347 4348 4349 4350 4351
  /// The number of font pixels for each logical pixel.
  ///
  /// For example, if the text scale factor is 1.5, text will be 50% larger than
  /// the specified font size.
  final double textScaleFactor;

4352 4353 4354
  /// An optional maximum number of lines for the text to span, wrapping if necessary.
  /// If the text exceeds the given number of lines, it will be truncated according
  /// to [overflow].
4355 4356 4357
  ///
  /// If this is 1, text will not wrap. Otherwise, text will be wrapped at the
  /// edge of the box.
4358 4359
  final int maxLines;

4360 4361 4362 4363 4364 4365 4366 4367 4368
  /// Used to select a font when the same Unicode character can
  /// be rendered differently, depending on the locale.
  ///
  /// It's rarely necessary to set this property. By default its value
  /// is inherited from the enclosing app with `Localizations.localeOf(context)`.
  ///
  /// See [RenderParagraph.locale] for more information.
  final Locale locale;

4369
  @override
4370
  RenderParagraph createRenderObject(BuildContext context) {
4371
    assert(textDirection != null || debugCheckHasDirectionality(context));
4372 4373
    return new RenderParagraph(text,
      textAlign: textAlign,
4374
      textDirection: textDirection ?? Directionality.of(context),
4375
      softWrap: softWrap,
4376
      overflow: overflow,
4377 4378
      textScaleFactor: textScaleFactor,
      maxLines: maxLines,
4379
      locale: locale ?? Localizations.localeOf(context, nullOk: true),
4380
    );
4381
  }
4382

4383
  @override
4384
  void updateRenderObject(BuildContext context, RenderParagraph renderObject) {
4385
    assert(textDirection != null || debugCheckHasDirectionality(context));
4386 4387
    renderObject
      ..text = text
4388
      ..textAlign = textAlign
Ian Hickson's avatar
Ian Hickson committed
4389
      ..textDirection = textDirection ?? Directionality.of(context)
4390
      ..softWrap = softWrap
4391
      ..overflow = overflow
4392
      ..textScaleFactor = textScaleFactor
4393
      ..maxLines = maxLines
4394
      ..locale = locale ?? Localizations.localeOf(context, nullOk: true);
4395
  }
4396 4397

  @override
4398 4399 4400 4401 4402 4403 4404 4405 4406
  void debugFillProperties(DiagnosticPropertiesBuilder properties) {
    super.debugFillProperties(properties);
    properties.add(new EnumProperty<TextAlign>('textAlign', textAlign, defaultValue: TextAlign.start));
    properties.add(new EnumProperty<TextDirection>('textDirection', textDirection, defaultValue: null));
    properties.add(new FlagProperty('softWrap', value: softWrap, ifTrue: 'wrapping at box width', ifFalse: 'no wrapping except at line break characters', showName: true));
    properties.add(new EnumProperty<TextOverflow>('overflow', overflow, defaultValue: TextOverflow.clip));
    properties.add(new DoubleProperty('textScaleFactor', textScaleFactor, defaultValue: 1.0));
    properties.add(new IntProperty('maxLines', maxLines, ifNull: 'unlimited'));
    properties.add(new StringProperty('text', text.toPlainText()));
4407
  }
4408 4409
}

4410
/// A widget that displays a [dart:ui.Image] directly.
4411
///
4412 4413
/// The image is painted using [paintImage], which describes the meanings of the
/// various fields on this class in more detail.
4414
///
4415
/// This widget is rarely used directly. Instead, consider using [Image].
4416
class RawImage extends LeafRenderObjectWidget {
4417 4418
  /// Creates a widget that displays an image.
  ///
Ian Hickson's avatar
Ian Hickson committed
4419 4420
  /// The [scale], [alignment], [repeat], and [matchTextDirection] arguments must
  /// not be null.
4421
  const RawImage({
4422 4423 4424 4425
    Key key,
    this.image,
    this.width,
    this.height,
4426
    this.scale = 1.0,
Adam Barth's avatar
Adam Barth committed
4427
    this.color,
4428
    this.colorBlendMode,
4429
    this.fit,
4430 4431
    this.alignment = Alignment.center,
    this.repeat = ImageRepeat.noRepeat,
Ian Hickson's avatar
Ian Hickson committed
4432
    this.centerSlice,
4433
    this.matchTextDirection = false,
4434
  }) : assert(scale != null),
Ian Hickson's avatar
Ian Hickson committed
4435
       assert(alignment != null),
4436
       assert(repeat != null),
Ian Hickson's avatar
Ian Hickson committed
4437
       assert(matchTextDirection != null),
4438
       super(key: key);
4439

4440
  /// The image to display.
4441
  final ui.Image image;
4442 4443 4444 4445 4446

  /// If non-null, require the image to have this width.
  ///
  /// If null, the image will pick a size that best preserves its intrinsic
  /// aspect ratio.
4447
  final double width;
4448 4449 4450 4451 4452

  /// If non-null, require the image to have this height.
  ///
  /// If null, the image will pick a size that best preserves its intrinsic
  /// aspect ratio.
4453
  final double height;
4454

4455
  /// Specifies the image's scale.
4456 4457 4458 4459
  ///
  /// Used when determining the best display size for the image.
  final double scale;

4460
  /// If non-null, this color is blended with each image pixel using [colorBlendMode].
Adam Barth's avatar
Adam Barth committed
4461
  final Color color;
4462

4463 4464 4465 4466 4467 4468 4469 4470 4471 4472
  /// Used to combine [color] with this image.
  ///
  /// The default is [BlendMode.srcIn]. In terms of the blend mode, [color] is
  /// the source and this image is the destination.
  ///
  /// See also:
  ///
  ///  * [BlendMode], which includes an illustration of the effect of each blend mode.
  final BlendMode colorBlendMode;

Adam Barth's avatar
Adam Barth committed
4473
  /// How to inscribe the image into the space allocated during layout.
4474 4475 4476
  ///
  /// The default varies based on the other fields. See the discussion at
  /// [paintImage].
4477
  final BoxFit fit;
4478 4479 4480

  /// How to align the image within its bounds.
  ///
Ian Hickson's avatar
Ian Hickson committed
4481
  /// The alignment aligns the given position in the image to the given position
4482
  /// in the layout bounds. For example, an [Alignment] alignment of (-1.0,
4483 4484
  /// -1.0) aligns the image to the top-left corner of its layout bounds, while a
  /// [Alignment] alignment of (1.0, 1.0) aligns the bottom right of the
Ian Hickson's avatar
Ian Hickson committed
4485
  /// image with the bottom right corner of its layout bounds. Similarly, an
4486
  /// alignment of (0.0, 1.0) aligns the bottom middle of the image with the
Ian Hickson's avatar
Ian Hickson committed
4487 4488 4489 4490 4491 4492
  /// middle of the bottom edge of its layout bounds.
  ///
  /// To display a subpart of an image, consider using a [CustomPainter] and
  /// [Canvas.drawImageRect].
  ///
  /// If the [alignment] is [TextDirection]-dependent (i.e. if it is a
4493
  /// [AlignmentDirectional]), then an ambient [Directionality] widget
Ian Hickson's avatar
Ian Hickson committed
4494 4495
  /// must be in scope.
  ///
4496
  /// Defaults to [Alignment.center].
4497 4498 4499 4500 4501 4502 4503
  ///
  /// See also:
  ///
  ///  * [Alignment], a class with convenient constants typically used to
  ///    specify an [AlignmentGeometry].
  ///  * [AlignmentDirectional], like [Alignment] for specifying alignments
  ///    relative to text direction.
4504
  final AlignmentGeometry alignment;
4505 4506

  /// How to paint any portions of the layout bounds not covered by the image.
4507
  final ImageRepeat repeat;
4508 4509 4510 4511 4512 4513 4514 4515

  /// The center slice for a nine-patch image.
  ///
  /// The region of the image inside the center slice will be stretched both
  /// horizontally and vertically to fit the image into its destination. The
  /// region of the image above and below the center slice will be stretched
  /// only horizontally and the region of the image to the left and right of
  /// the center slice will be stretched only vertically.
4516
  final Rect centerSlice;
4517

Ian Hickson's avatar
Ian Hickson committed
4518 4519 4520 4521 4522 4523 4524 4525 4526 4527 4528 4529 4530 4531 4532 4533 4534
  /// Whether to paint the image in the direction of the [TextDirection].
  ///
  /// If this is true, then in [TextDirection.ltr] contexts, the image will be
  /// drawn with its origin in the top left (the "normal" painting direction for
  /// images); and in [TextDirection.rtl] contexts, the image will be drawn with
  /// a scaling factor of -1 in the horizontal direction so that the origin is
  /// in the top right.
  ///
  /// This is occasionally used with images in right-to-left environments, for
  /// images that were designed for left-to-right locales. Be careful, when
  /// using this, to not flip images with integral shadows, text, or other
  /// effects that will look incorrect when flipped.
  ///
  /// If this is true, there must be an ambient [Directionality] widget in
  /// scope.
  final bool matchTextDirection;

4535
  @override
4536
  RenderImage createRenderObject(BuildContext context) {
4537
    assert((!matchTextDirection && alignment is Alignment) || debugCheckHasDirectionality(context));
4538 4539 4540 4541 4542 4543 4544 4545 4546 4547
    return new RenderImage(
      image: image,
      width: width,
      height: height,
      scale: scale,
      color: color,
      colorBlendMode: colorBlendMode,
      fit: fit,
      alignment: alignment,
      repeat: repeat,
Ian Hickson's avatar
Ian Hickson committed
4548 4549
      centerSlice: centerSlice,
      matchTextDirection: matchTextDirection,
4550
      textDirection: matchTextDirection || alignment is! Alignment ? Directionality.of(context) : null,
4551 4552
    );
  }
4553

4554
  @override
4555
  void updateRenderObject(BuildContext context, RenderImage renderObject) {
4556 4557 4558 4559 4560 4561
    renderObject
      ..image = image
      ..width = width
      ..height = height
      ..scale = scale
      ..color = color
4562
      ..colorBlendMode = colorBlendMode
4563 4564 4565
      ..alignment = alignment
      ..fit = fit
      ..repeat = repeat
Ian Hickson's avatar
Ian Hickson committed
4566 4567
      ..centerSlice = centerSlice
      ..matchTextDirection = matchTextDirection
4568
      ..textDirection = matchTextDirection || alignment is! Alignment ? Directionality.of(context) : null;
4569
  }
4570

4571
  @override
4572 4573 4574 4575 4576 4577 4578 4579 4580 4581 4582 4583 4584
  void debugFillProperties(DiagnosticPropertiesBuilder properties) {
    super.debugFillProperties(properties);
    properties.add(new DiagnosticsProperty<ui.Image>('image', image));
    properties.add(new DoubleProperty('width', width, defaultValue: null));
    properties.add(new DoubleProperty('height', height, defaultValue: null));
    properties.add(new DoubleProperty('scale', scale, defaultValue: 1.0));
    properties.add(new DiagnosticsProperty<Color>('color', color, defaultValue: null));
    properties.add(new EnumProperty<BlendMode>('colorBlendMode', colorBlendMode, defaultValue: null));
    properties.add(new EnumProperty<BoxFit>('fit', fit, defaultValue: null));
    properties.add(new DiagnosticsProperty<AlignmentGeometry>('alignment', alignment, defaultValue: null));
    properties.add(new EnumProperty<ImageRepeat>('repeat', repeat, defaultValue: ImageRepeat.noRepeat));
    properties.add(new DiagnosticsProperty<Rect>('centerSlice', centerSlice, defaultValue: null));
    properties.add(new FlagProperty('matchTextDirection', value: matchTextDirection, ifTrue: 'match text direction'));
4585
  }
4586 4587
}

4588
/// A widget that determines the default asset bundle for its descendants.
4589
///
4590 4591
/// For example, used by [Image] to determine which bundle to use for
/// [AssetImage]s if no bundle is specified explicitly.
4592 4593 4594 4595 4596 4597 4598 4599 4600 4601 4602 4603 4604 4605 4606 4607 4608 4609 4610 4611 4612 4613 4614 4615 4616 4617 4618 4619 4620 4621 4622 4623 4624 4625 4626 4627 4628 4629 4630 4631 4632
///
/// ## Sample code
///
/// This can be used in tests to override what the current asset bundle is, thus
/// allowing specific resources to be injected into the widget under test.
///
/// For example, a test could create a test asset bundle like this:
///
/// ```dart
/// class TestAssetBundle extends CachingAssetBundle {
///   @override
///   Future<ByteData> load(String key) async {
///     if (key == 'resources/test')
///       return new ByteData.view(new Uint8List.fromList(utf8.encode('Hello World!')).buffer);
///     return null;
///   }
/// }
/// ```
///
/// ...then wrap the widget under test with a [DefaultAssetBundle] using this
/// bundle implementation:
///
/// ```dart
/// await tester.pumpWidget(
///   new MaterialApp(
///     home: new DefaultAssetBundle(
///       bundle: new TestAssetBundle(),
///       child: new TestWidget(),
///     ),
///   ),
/// );
/// ```
///
/// Assuming that `TestWidget` uses [DefaultAssetBundle.of] to obtain its
/// [AssetBundle], it will now see the [TestAssetBundle]'s "Hello World!" data
/// when requesting the "resources/test" asset.
///
/// See also:
///
///  * [AssetBundle], the interface for asset bundles.
///  * [rootBundle], the default default asset bundle.
Adam Barth's avatar
Adam Barth committed
4633
class DefaultAssetBundle extends InheritedWidget {
4634 4635 4636
  /// Creates a widget that determines the default asset bundle for its descendants.
  ///
  /// The [bundle] and [child] arguments must not be null.
4637
  const DefaultAssetBundle({
Adam Barth's avatar
Adam Barth committed
4638
    Key key,
4639 4640
    @required this.bundle,
    @required Widget child
4641 4642 4643
  }) : assert(bundle != null),
       assert(child != null),
       super(key: key, child: child);
Adam Barth's avatar
Adam Barth committed
4644

4645
  /// The bundle to use as a default.
Adam Barth's avatar
Adam Barth committed
4646 4647
  final AssetBundle bundle;

4648 4649 4650 4651 4652
  /// The bundle from the closest instance of this class that encloses
  /// the given context.
  ///
  /// If there is no [DefaultAssetBundle] ancestor widget in the tree
  /// at the given context, then this will return the [rootBundle].
4653 4654 4655 4656 4657 4658
  ///
  /// Typical usage is as follows:
  ///
  /// ```dart
  /// AssetBundle bundle = DefaultAssetBundle.of(context);
  /// ```
Adam Barth's avatar
Adam Barth committed
4659
  static AssetBundle of(BuildContext context) {
4660
    final DefaultAssetBundle result = context.inheritFromWidgetOfExactType(DefaultAssetBundle);
4661
    return result?.bundle ?? rootBundle;
Adam Barth's avatar
Adam Barth committed
4662 4663
  }

4664
  @override
4665
  bool updateShouldNotify(DefaultAssetBundle oldWidget) => bundle != oldWidget.bundle;
Adam Barth's avatar
Adam Barth committed
4666 4667
}

4668 4669 4670 4671 4672
/// An adapter for placing a specific [RenderBox] in the widget tree.
///
/// A given render object can be placed at most once in the widget tree. This
/// widget enforces that restriction by keying itself using a [GlobalObjectKey]
/// for the given render object.
Hixie's avatar
Hixie committed
4673
class WidgetToRenderBoxAdapter extends LeafRenderObjectWidget {
4674 4675 4676 4677
  /// Creates an adapter for placing a specific [RenderBox] in the widget tree.
  ///
  /// The [renderBox] argument must not be null.
  WidgetToRenderBoxAdapter({
4678
    @required this.renderBox,
4679 4680
    this.onBuild,
  }) : assert(renderBox != null),
4681 4682 4683 4684
       // WidgetToRenderBoxAdapter objects are keyed to their render box. This
       // prevents the widget being used in the widget hierarchy in two different
       // places, which would cause the RenderBox to get inserted in multiple
       // places in the RenderObject tree.
4685
       super(key: new GlobalObjectKey(renderBox));
Hixie's avatar
Hixie committed
4686

4687
  /// The render box to place in the widget tree.
Hixie's avatar
Hixie committed
4688 4689
  final RenderBox renderBox;

4690 4691 4692 4693 4694 4695
  /// Called when it is safe to update the render box and its descendants. If
  /// you update the RenderObject subtree under this widget outside of
  /// invocations of this callback, features like hit-testing will fail as the
  /// tree will be dirty.
  final VoidCallback onBuild;

4696
  @override
4697
  RenderBox createRenderObject(BuildContext context) => renderBox;
4698

4699
  @override
4700
  void updateRenderObject(BuildContext context, RenderBox renderObject) {
4701 4702 4703
    if (onBuild != null)
      onBuild();
  }
Hixie's avatar
Hixie committed
4704 4705
}

4706

4707
// EVENT HANDLING
4708

4709
/// A widget that calls callbacks in response to pointer events.
4710 4711 4712
///
/// Rather than listening for raw pointer events, consider listening for
/// higher-level gestures using [GestureDetector].
4713
///
4714 4715 4716 4717
/// ## Layout behavior
///
/// _See [BoxConstraints] for an introduction to box layout models._
///
4718 4719
/// If it has a child, this widget defers to the child for sizing behavior. If
/// it does not have a child, it grows to fit the parent instead.
4720
class Listener extends SingleChildRenderObjectWidget {
4721 4722 4723
  /// Creates a widget that forwards point events to callbacks.
  ///
  /// The [behavior] argument defaults to [HitTestBehavior.deferToChild].
4724
  const Listener({
4725 4726 4727 4728
    Key key,
    this.onPointerDown,
    this.onPointerMove,
    this.onPointerUp,
4729
    this.onPointerCancel,
4730
    this.behavior = HitTestBehavior.deferToChild,
4731
    Widget child
4732 4733
  }) : assert(behavior != null),
       super(key: key, child: child);
4734

4735
  /// Called when a pointer comes into contact with the screen at this object.
Ian Hickson's avatar
Ian Hickson committed
4736
  final PointerDownEventListener onPointerDown;
4737 4738

  /// Called when a pointer that triggered an [onPointerDown] changes position.
Ian Hickson's avatar
Ian Hickson committed
4739
  final PointerMoveEventListener onPointerMove;
4740 4741

  /// Called when a pointer that triggered an [onPointerDown] is no longer in contact with the screen.
Ian Hickson's avatar
Ian Hickson committed
4742
  final PointerUpEventListener onPointerUp;
4743 4744

  /// Called when the input from a pointer that triggered an [onPointerDown] is no longer directed towards this receiver.
Ian Hickson's avatar
Ian Hickson committed
4745
  final PointerCancelEventListener onPointerCancel;
4746 4747

  /// How to behave during hit testing.
4748
  final HitTestBehavior behavior;
4749

4750
  @override
4751 4752 4753 4754 4755 4756 4757 4758 4759
  RenderPointerListener createRenderObject(BuildContext context) {
    return new RenderPointerListener(
      onPointerDown: onPointerDown,
      onPointerMove: onPointerMove,
      onPointerUp: onPointerUp,
      onPointerCancel: onPointerCancel,
      behavior: behavior
    );
  }
4760

4761
  @override
4762
  void updateRenderObject(BuildContext context, RenderPointerListener renderObject) {
4763 4764 4765 4766 4767 4768
    renderObject
      ..onPointerDown = onPointerDown
      ..onPointerMove = onPointerMove
      ..onPointerUp = onPointerUp
      ..onPointerCancel = onPointerCancel
      ..behavior = behavior;
4769
  }
4770

4771
  @override
4772 4773
  void debugFillProperties(DiagnosticPropertiesBuilder properties) {
    super.debugFillProperties(properties);
4774
    final List<String> listeners = <String>[];
4775 4776 4777 4778 4779 4780 4781 4782
    if (onPointerDown != null)
      listeners.add('down');
    if (onPointerMove != null)
      listeners.add('move');
    if (onPointerUp != null)
      listeners.add('up');
    if (onPointerCancel != null)
      listeners.add('cancel');
4783 4784
    properties.add(new IterableProperty<String>('listeners', listeners, ifEmpty: '<none>'));
    properties.add(new EnumProperty<HitTestBehavior>('behavior', behavior));
4785
  }
4786
}
4787

4788
/// A widget that creates a separate display list for its child.
4789 4790 4791
///
/// This widget creates a separate display list for its child, which
/// can improve performance if the subtree repaints at different times than
4792 4793 4794 4795 4796 4797 4798 4799 4800 4801 4802 4803 4804 4805 4806 4807 4808 4809 4810 4811 4812 4813 4814 4815 4816 4817 4818 4819 4820 4821 4822 4823 4824 4825 4826 4827 4828 4829 4830 4831 4832 4833 4834 4835 4836 4837 4838
/// the surrounding parts of the tree.
///
/// This is useful since [RenderObject.paint] may be triggered even if its
/// associated [Widget] instances did not change or rebuild. A [RenderObject]
/// will repaint whenever any [RenderObject] that shares the same [Layer] is
/// marked as being dirty and needing paint (see [RenderObject.markNeedsPaint]),
/// such as when an ancestor scrolls or when an ancestor or descendant animates.
///
/// Containing [RenderObject.paint] to parts of the render subtree that are
/// actually visually changing using [RepaintBoundary] explicitly or implicitly
/// is therefore critical to minimizing redundant work and improving the app's
/// performance.
///
/// When a [RenderObject] is flagged as needing to paint via
/// [RenderObject.markNeedsPaint], the nearest ancestor [RenderObject] with
/// [RenderObject.isRepaintBoundary], up to possibly the root of the application,
/// is requested to repaint. That nearest ancestor's [RenderObject.paint] method
/// will cause _all_ of its descendant [RenderObject]s to repaint in the same
/// layer.
///
/// [RepaintBoundary] is therefore used, both while propagating the
/// `markNeedsPaint` flag up the render tree and while traversing down the
/// render tree via [RenderObject.paintChild], to strategically contain repaints
/// to the render subtree that visually changed for performance. This is done
/// because the [RepaintBoundary] widget creates a [RenderObject] that always
/// has a [Layer], decoupling ancestor render objects from the descendant
/// render objects.
///
/// [RepaintBoundary] has the further side-effect of possibly hinting to the
/// engine that it should further optimize animation performance if the render
/// subtree behind the [RepaintBoundary] is sufficiently complex and is static
/// while the surrounding tree changes frequently. In those cases, the engine
/// may choose to pay a one time cost of rasterizing and caching the pixel
/// values of the subtree for faster future GPU re-rendering speed.
///
/// Several framework widgets insert [RepaintBoundary] widgets to mark natural
/// separation points in applications. For instance, contents in Material Design
/// drawers typically don't change while the drawer opens and closes, so
/// repaints are automatically contained to regions inside or outside the drawer
/// when using the [Drawer] widget during transitions.
///
/// See also:
///
///  * [debugRepaintRainbowEnabled], a debugging flag to help visually monitor
///    render tree repaints in a running app.
///  * [debugProfilePaintsEnabled], a debugging flag to show render tree
///    repaints in the observatory's timeline view.
4839
class RepaintBoundary extends SingleChildRenderObjectWidget {
4840
  /// Creates a widget that isolates repaints.
4841
  const RepaintBoundary({ Key key, Widget child }) : super(key: key, child: child);
4842

4843 4844 4845 4846
  /// Wraps the given child in a [RepaintBoundary].
  ///
  /// The key for the [RepaintBoundary] is derived either from the child's key
  /// (if the child has a non-null key) or from the given `childIndex`.
4847
  factory RepaintBoundary.wrap(Widget child, int childIndex) {
4848
    assert(child != null);
4849
    final Key key = child.key != null ? new ValueKey<Key>(child.key) : new ValueKey<int>(childIndex);
4850 4851 4852
    return new RepaintBoundary(key: key, child: child);
  }

4853 4854 4855 4856 4857
  /// Wraps each of the given children in [RepaintBoundary]s.
  ///
  /// The key for each [RepaintBoundary] is derived either from the wrapped
  /// child's key (if the wrapped child has a non-null key) or from the wrapped
  /// child's index in the list.
Adam Barth's avatar
Adam Barth committed
4858
  static List<RepaintBoundary> wrapAll(List<Widget> widgets) {
4859
    final List<RepaintBoundary> result = new List<RepaintBoundary>(widgets.length);
Adam Barth's avatar
Adam Barth committed
4860 4861 4862 4863 4864
    for (int i = 0; i < result.length; ++i)
      result[i] = new RepaintBoundary.wrap(widgets[i], i);
    return result;
  }

4865
  @override
4866
  RenderRepaintBoundary createRenderObject(BuildContext context) => new RenderRepaintBoundary();
4867 4868
}

4869
/// A widget that is invisible during hit testing.
4870
///
4871
/// When [ignoring] is true, this widget (and its subtree) is invisible
4872
/// to hit testing. It still consumes space during layout and paints its child
4873
/// as usual. It just cannot be the target of located events, because it returns
4874
/// false from [RenderBox.hitTest].
4875
///
4876
/// When [ignoringSemantics] is true, the subtree will be invisible to
4877 4878
/// the semantics layer (and thus e.g. accessibility tools). If
/// [ignoringSemantics] is null, it uses the value of [ignoring].
4879 4880 4881 4882 4883
///
/// See also:
///
///  * [AbsorbPointer], which also prevents its children from receiving pointer
///    events but is itself visible to hit testing.
4884
class IgnorePointer extends SingleChildRenderObjectWidget {
4885
  /// Creates a widget that is invisible to hit testing.
4886 4887 4888
  ///
  /// The [ignoring] argument must not be null. If [ignoringSemantics], this
  /// render object will be ignored for semantics if [ignoring] is true.
4889
  const IgnorePointer({
4890
    Key key,
4891
    this.ignoring = true,
4892 4893
    this.ignoringSemantics,
    Widget child
4894 4895
  }) : assert(ignoring != null),
       super(key: key, child: child);
4896

4897 4898 4899 4900
  /// Whether this widget is ignored during hit testing.
  ///
  /// Regardless of whether this widget is ignored during hit testing, it will
  /// still consume space during layout and be visible during painting.
4901
  final bool ignoring;
4902 4903 4904 4905 4906 4907 4908

  /// Whether the semantics of this widget is ignored when compiling the semantics tree.
  ///
  /// If null, defaults to value of [ignoring].
  ///
  /// See [SemanticsNode] for additional information about the semantics tree.
  final bool ignoringSemantics;
4909

4910
  @override
4911 4912 4913 4914 4915 4916
  RenderIgnorePointer createRenderObject(BuildContext context) {
    return new RenderIgnorePointer(
      ignoring: ignoring,
      ignoringSemantics: ignoringSemantics
    );
  }
4917

4918
  @override
4919
  void updateRenderObject(BuildContext context, RenderIgnorePointer renderObject) {
4920 4921 4922
    renderObject
      ..ignoring = ignoring
      ..ignoringSemantics = ignoringSemantics;
4923
  }
4924 4925

  @override
4926 4927 4928 4929
  void debugFillProperties(DiagnosticPropertiesBuilder properties) {
    super.debugFillProperties(properties);
    properties.add(new DiagnosticsProperty<bool>('ignoring', ignoring));
    properties.add(new DiagnosticsProperty<bool>('ignoringSemantics', ignoringSemantics, defaultValue: null));
4930
  }
4931
}
4932

4933 4934
/// A widget that absorbs pointers during hit testing.
///
4935
/// When [absorbing] is true, this widget prevents its subtree from receiving
4936 4937
/// pointer events by terminating hit testing at itself. It still consumes space
/// during layout and paints its child as usual. It just prevents its children
4938
/// from being the target of located events, because it returns true from
4939
/// [RenderBox.hitTest].
4940 4941 4942 4943 4944
///
/// See also:
///
///  * [IgnorePointer], which also prevents its children from receiving pointer
///    events but is itself invisible to hit testing.
4945 4946 4947 4948
class AbsorbPointer extends SingleChildRenderObjectWidget {
  /// Creates a widget that absorbs pointers during hit testing.
  ///
  /// The [absorbing] argument must not be null
4949
  const AbsorbPointer({
4950
    Key key,
4951
    this.absorbing = true,
4952
    Widget child
4953 4954
  }) : assert(absorbing != null),
       super(key: key, child: child);
4955 4956 4957 4958 4959 4960 4961 4962 4963 4964 4965 4966 4967 4968 4969 4970 4971

  /// Whether this widget absorbs pointers during hit testing.
  ///
  /// Regardless of whether this render object absorbs pointers during hit
  /// testing, it will still consume space during layout and be visible during
  /// painting.
  final bool absorbing;

  @override
  RenderAbsorbPointer createRenderObject(BuildContext context) => new RenderAbsorbPointer(absorbing: absorbing);

  @override
  void updateRenderObject(BuildContext context, RenderAbsorbPointer renderObject) {
    renderObject.absorbing = absorbing;
  }
}

4972
/// Holds opaque meta data in the render tree.
4973 4974 4975 4976 4977
///
/// Useful for decorating the render tree with information that will be consumed
/// later. For example, you could store information in the render tree that will
/// be used when the user interacts with the render tree but has no visual
/// impact prior to the interaction.
4978
class MetaData extends SingleChildRenderObjectWidget {
4979
  /// Creates a widget that hold opaque meta data.
4980 4981
  ///
  /// The [behavior] argument defaults to [HitTestBehavior.deferToChild].
4982
  const MetaData({
4983 4984
    Key key,
    this.metaData,
4985
    this.behavior = HitTestBehavior.deferToChild,
4986
    Widget child
4987 4988 4989 4990 4991 4992 4993 4994 4995
  }) : super(key: key, child: child);

  /// Opaque meta data ignored by the render tree
  final dynamic metaData;

  /// How to behave during hit testing.
  final HitTestBehavior behavior;

  @override
4996 4997 4998 4999 5000 5001
  RenderMetaData createRenderObject(BuildContext context) {
    return new RenderMetaData(
      metaData: metaData,
      behavior: behavior
    );
  }
5002 5003 5004 5005 5006 5007 5008 5009 5010

  @override
  void updateRenderObject(BuildContext context, RenderMetaData renderObject) {
    renderObject
      ..metaData = metaData
      ..behavior = behavior;
  }

  @override
5011 5012 5013 5014
  void debugFillProperties(DiagnosticPropertiesBuilder properties) {
    super.debugFillProperties(properties);
    properties.add(new EnumProperty<HitTestBehavior>('behavior', behavior));
    properties.add(new DiagnosticsProperty<dynamic>('metaData', metaData));
5015 5016 5017
  }
}

5018 5019 5020

// UTILITY NODES

5021 5022
/// A widget that annotates the widget tree with a description of the meaning of
/// the widgets.
5023 5024 5025
///
/// Used by accessibility tools, search engines, and other semantic analysis
/// software to determine the meaning of the application.
5026 5027 5028 5029 5030 5031 5032 5033 5034 5035 5036 5037 5038 5039 5040
///
/// See also:
///
/// * [MergeSemantics], which marks a subtree as being a single node for
///   accessibility purposes.
/// * [ExcludeSemantics], which excludes a subtree from the semantics tree
///   (which might be useful if it is, e.g., totally decorative and not
///   important to the user).
/// * [RenderObject.semanticsAnnotator], the rendering library API through which
///   the [Semantics] widget is actually implemented.
/// * [SemanticsNode], the object used by the rendering library to represent
///   semantics in the semantics tree.
/// * [SemanticsDebugger], an overlay to help visualize the semantics tree. Can
///   be enabled using [WidgetsApp.showSemanticsDebugger] or
///   [MaterialApp.showSemanticsDebugger].
5041
@immutable
5042
class Semantics extends SingleChildRenderObjectWidget {
5043 5044
  /// Creates a semantic annotation.
  ///
5045
  /// The [container] argument must not be null. To create a `const` instance
5046 5047 5048 5049
  /// of [Semantics], use the [Semantics.fromProperties] constructor.
  ///
  /// See also:
  ///
5050
  ///  * [SemanticsSortKey] for a class that determines accessibility traversal
5051
  ///    order.
5052 5053 5054
  Semantics({
    Key key,
    Widget child,
5055 5056
    bool container = false,
    bool explicitChildNodes = false,
5057
    bool enabled,
5058 5059 5060
    bool checked,
    bool selected,
    bool button,
5061 5062 5063 5064
    bool header,
    bool textField,
    bool focused,
    bool inMutuallyExclusiveGroup,
5065
    bool obscured,
5066 5067
    bool scopesRoute,
    bool namesRoute,
5068
    bool hidden,
5069 5070 5071 5072 5073 5074
    String label,
    String value,
    String increasedValue,
    String decreasedValue,
    String hint,
    TextDirection textDirection,
5075
    SemanticsSortKey sortKey,
5076 5077 5078 5079 5080 5081 5082 5083
    VoidCallback onTap,
    VoidCallback onLongPress,
    VoidCallback onScrollLeft,
    VoidCallback onScrollRight,
    VoidCallback onScrollUp,
    VoidCallback onScrollDown,
    VoidCallback onIncrease,
    VoidCallback onDecrease,
5084 5085 5086
    VoidCallback onCopy,
    VoidCallback onCut,
    VoidCallback onPaste,
5087 5088
    MoveCursorHandler onMoveCursorForwardByCharacter,
    MoveCursorHandler onMoveCursorBackwardByCharacter,
5089
    SetSelectionHandler onSetSelection,
5090 5091
    VoidCallback onDidGainAccessibilityFocus,
    VoidCallback onDidLoseAccessibilityFocus,
5092 5093 5094 5095 5096 5097
  }) : this.fromProperties(
    key: key,
    child: child,
    container: container,
    explicitChildNodes: explicitChildNodes,
    properties: new SemanticsProperties(
5098
      enabled: enabled,
5099 5100 5101
      checked: checked,
      selected: selected,
      button: button,
5102 5103 5104 5105
      header: header,
      textField: textField,
      focused: focused,
      inMutuallyExclusiveGroup: inMutuallyExclusiveGroup,
5106
      obscured: obscured,
5107 5108
      scopesRoute: scopesRoute,
      namesRoute: namesRoute,
5109
      hidden: hidden,
5110 5111 5112 5113 5114 5115
      label: label,
      value: value,
      increasedValue: increasedValue,
      decreasedValue: decreasedValue,
      hint: hint,
      textDirection: textDirection,
5116
      sortKey: sortKey,
5117 5118 5119 5120 5121 5122 5123 5124
      onTap: onTap,
      onLongPress: onLongPress,
      onScrollLeft: onScrollLeft,
      onScrollRight: onScrollRight,
      onScrollUp: onScrollUp,
      onScrollDown: onScrollDown,
      onIncrease: onIncrease,
      onDecrease: onDecrease,
5125 5126 5127
      onCopy: onCopy,
      onCut: onCut,
      onPaste: onPaste,
5128 5129
      onMoveCursorForwardByCharacter: onMoveCursorForwardByCharacter,
      onMoveCursorBackwardByCharacter: onMoveCursorBackwardByCharacter,
5130 5131
      onDidGainAccessibilityFocus: onDidGainAccessibilityFocus,
      onDidLoseAccessibilityFocus: onDidLoseAccessibilityFocus,
5132
    onSetSelection: onSetSelection,),
5133 5134 5135 5136 5137 5138
  );

  /// Creates a semantic annotation using [SemanticsProperties].
  ///
  /// The [container] and [properties] arguments must not be null.
  const Semantics.fromProperties({
Hixie's avatar
Hixie committed
5139 5140
    Key key,
    Widget child,
5141 5142
    this.container = false,
    this.explicitChildNodes = false,
5143
    @required this.properties,
5144
  }) : assert(container != null),
5145
       assert(properties != null),
5146
       super(key: key, child: child);
Hixie's avatar
Hixie committed
5147

5148 5149 5150 5151
  /// Contains properties used by assistive technologies to make the application
  /// more accessible.
  final SemanticsProperties properties;

5152
  /// If [container] is true, this widget will introduce a new
5153 5154
  /// node in the semantics tree. Otherwise, the semantics will be
  /// merged with the semantics of any ancestors (if the ancestor allows that).
5155
  ///
5156 5157 5158
  /// Whether descendants of this widget can add their semantic information to the
  /// [SemanticsNode] introduced by this configuration is controlled by
  /// [explicitChildNodes].
Hixie's avatar
Hixie committed
5159 5160
  final bool container;

5161 5162 5163 5164 5165 5166 5167 5168 5169 5170
  /// Whether descendants of this widget are allowed to add semantic information
  /// to the [SemanticsNode] annotated by this widget.
  ///
  /// When set to false descendants are allowed to annotate [SemanticNode]s of
  /// their parent with the semantic information they want to contribute to the
  /// semantic tree.
  /// When set to true the only way for descendants to contribute semantic
  /// information to the semantic tree is to introduce new explicit
  /// [SemanticNode]s to the tree.
  ///
5171 5172 5173 5174
  /// If the semantics properties of this node include
  /// [SemanticsProperties.scopesRoute] set to true, then [explicitChildNodes]
  /// must be true also.
  ///
5175 5176
  /// This setting is often used in combination with [SemanticsConfiguration.isSemanticBoundary]
  /// to create semantic boundaries that are either writable or not for children.
5177 5178
  final bool explicitChildNodes;

5179
  @override
5180 5181 5182
  RenderSemanticsAnnotations createRenderObject(BuildContext context) {
    return new RenderSemanticsAnnotations(
      container: container,
5183
      explicitChildNodes: explicitChildNodes,
5184
      enabled: properties.enabled,
5185 5186 5187
      checked: properties.checked,
      selected: properties.selected,
      button: properties.button,
5188 5189 5190 5191
      header: properties.header,
      textField: properties.textField,
      focused: properties.focused,
      inMutuallyExclusiveGroup: properties.inMutuallyExclusiveGroup,
5192
      obscured: properties.obscured,
5193 5194
      scopesRoute: properties.scopesRoute,
      namesRoute: properties.namesRoute,
5195
      hidden: properties.hidden,
5196 5197 5198 5199 5200
      label: properties.label,
      value: properties.value,
      increasedValue: properties.increasedValue,
      decreasedValue: properties.decreasedValue,
      hint: properties.hint,
Ian Hickson's avatar
Ian Hickson committed
5201
      textDirection: _getTextDirection(context),
5202
      sortKey: properties.sortKey,
5203 5204 5205 5206 5207 5208 5209 5210
      onTap: properties.onTap,
      onLongPress: properties.onLongPress,
      onScrollLeft: properties.onScrollLeft,
      onScrollRight: properties.onScrollRight,
      onScrollUp: properties.onScrollUp,
      onScrollDown: properties.onScrollDown,
      onIncrease: properties.onIncrease,
      onDecrease: properties.onDecrease,
5211 5212 5213
      onCopy: properties.onCopy,
      onCut: properties.onCut,
      onPaste: properties.onPaste,
5214 5215
      onMoveCursorForwardByCharacter: properties.onMoveCursorForwardByCharacter,
      onMoveCursorBackwardByCharacter: properties.onMoveCursorBackwardByCharacter,
5216
      onSetSelection: properties.onSetSelection,
5217 5218
      onDidGainAccessibilityFocus: properties.onDidGainAccessibilityFocus,
      onDidLoseAccessibilityFocus: properties.onDidLoseAccessibilityFocus,
5219 5220
    );
  }
Hixie's avatar
Hixie committed
5221

5222 5223 5224 5225 5226 5227 5228 5229 5230 5231 5232 5233
  TextDirection _getTextDirection(BuildContext context) {
    if (properties.textDirection != null)
      return properties.textDirection;

    final bool containsText = properties.label != null || properties.value != null || properties.hint != null;

    if (!containsText)
      return null;

    return Directionality.of(context);
  }

5234
  @override
5235
  void updateRenderObject(BuildContext context, RenderSemanticsAnnotations renderObject) {
5236 5237
    renderObject
      ..container = container
5238
      ..scopesRoute = properties.scopesRoute
5239
      ..explicitChildNodes = explicitChildNodes
5240
      ..enabled = properties.enabled
5241 5242
      ..checked = properties.checked
      ..selected = properties.selected
5243 5244 5245 5246 5247 5248 5249
      ..button = properties.button
      ..header = properties.header
      ..textField = properties.textField
      ..focused = properties.focused
      ..inMutuallyExclusiveGroup = properties.inMutuallyExclusiveGroup
      ..obscured = properties.obscured
      ..hidden = properties.hidden
5250 5251 5252 5253 5254
      ..label = properties.label
      ..value = properties.value
      ..increasedValue = properties.increasedValue
      ..decreasedValue = properties.decreasedValue
      ..hint = properties.hint
5255
      ..namesRoute = properties.namesRoute
5256
      ..textDirection = _getTextDirection(context)
5257
      ..sortKey = properties.sortKey
5258 5259 5260 5261 5262 5263 5264
      ..onTap = properties.onTap
      ..onLongPress = properties.onLongPress
      ..onScrollLeft = properties.onScrollLeft
      ..onScrollRight = properties.onScrollRight
      ..onScrollUp = properties.onScrollUp
      ..onScrollDown = properties.onScrollDown
      ..onIncrease = properties.onIncrease
5265
      ..onDecrease = properties.onDecrease
5266 5267 5268
      ..onCopy = properties.onCopy
      ..onCut = properties.onCut
      ..onPaste = properties.onPaste
5269
      ..onMoveCursorForwardByCharacter = properties.onMoveCursorForwardByCharacter
5270
      ..onMoveCursorBackwardByCharacter = properties.onMoveCursorForwardByCharacter
5271 5272 5273
      ..onSetSelection = properties.onSetSelection
      ..onDidGainAccessibilityFocus = properties.onDidGainAccessibilityFocus
      ..onDidLoseAccessibilityFocus = properties.onDidLoseAccessibilityFocus;
Hixie's avatar
Hixie committed
5274 5275
  }

5276
  @override
5277 5278 5279 5280 5281
  void debugFillProperties(DiagnosticPropertiesBuilder properties) {
    super.debugFillProperties(properties);
    properties.add(new DiagnosticsProperty<bool>('container', container));
    properties.add(new DiagnosticsProperty<SemanticsProperties>('properties', this.properties));
    this.properties.debugFillProperties(properties);
Hixie's avatar
Hixie committed
5282 5283 5284
  }
}

5285 5286
/// A widget that merges the semantics of its descendants.
///
Hixie's avatar
Hixie committed
5287 5288
/// Causes all the semantics of the subtree rooted at this node to be
/// merged into one node in the semantics tree. For example, if you
5289
/// have a widget with a Text node next to a checkbox widget, this
Hixie's avatar
Hixie committed
5290 5291 5292 5293 5294 5295 5296 5297 5298 5299 5300 5301 5302 5303
/// could be used to merge the label from the Text node with the
/// "checked" semantic state of the checkbox into a single node that
/// had both the label and the checked state. Otherwise, the label
/// would be presented as a separate feature than the checkbox, and
/// the user would not be able to be sure that they were related.
///
/// Be aware that if two nodes in the subtree have conflicting
/// semantics, the result may be nonsensical. For example, a subtree
/// with a checked checkbox and an unchecked checkbox will be
/// presented as checked. All the labels will be merged into a single
/// string (with newlines separating each label from the other). If
/// multiple nodes in the merged subtree can handle semantic gestures,
/// the first one in tree order will be the one to receive the
/// callbacks.
5304
class MergeSemantics extends SingleChildRenderObjectWidget {
5305
  /// Creates a widget that merges the semantics of its descendants.
5306
  const MergeSemantics({ Key key, Widget child }) : super(key: key, child: child);
5307 5308

  @override
5309
  RenderMergeSemantics createRenderObject(BuildContext context) => new RenderMergeSemantics();
Hixie's avatar
Hixie committed
5310 5311
}

5312 5313 5314 5315 5316 5317 5318 5319 5320 5321 5322 5323 5324 5325 5326
/// A widget that drops the semantics of all widget that were painted before it
/// in the same semantic container.
///
/// This is useful to hide widgets from accessibility tools that are painted
/// behind a certain widget, e.g. an alert should usually disallow interaction
/// with any widget located "behind" the alert (even when they are still
/// partially visible). Similarly, an open [Drawer] blocks interactions with
/// any widget outside the drawer.
///
/// See also:
///
/// * [ExcludeSemantics] which drops all semantics of its descendants.
class BlockSemantics extends SingleChildRenderObjectWidget {
  /// Creates a widget that excludes the semantics of all widgets painted before
  /// it in the same semantic container.
5327
  const BlockSemantics({ Key key, this.blocking = true, Widget child }) : super(key: key, child: child);
5328 5329 5330 5331 5332 5333 5334

  /// Whether this widget is blocking semantics of all widget that were painted
  /// before it in the same semantic container.
  final bool blocking;

  @override
  RenderBlockSemantics createRenderObject(BuildContext context) => new RenderBlockSemantics(blocking: blocking);
5335 5336

  @override
5337 5338 5339 5340 5341
  void updateRenderObject(BuildContext context, RenderBlockSemantics renderObject) {
    renderObject.blocking = blocking;
  }

  @override
5342 5343 5344
  void debugFillProperties(DiagnosticPropertiesBuilder properties) {
    super.debugFillProperties(properties);
    properties.add(new DiagnosticsProperty<bool>('blocking', blocking));
5345
  }
5346 5347
}

5348
/// A widget that drops all the semantics of its descendants.
Hixie's avatar
Hixie committed
5349
///
5350 5351 5352
/// When [excluding] is true, this widget (and its subtree) is excluded from
/// the semantics tree.
///
5353
/// This can be used to hide descendant widgets that would otherwise be
Hixie's avatar
Hixie committed
5354 5355 5356
/// reported but that would only be confusing. For example, the
/// material library's [Chip] widget hides the avatar since it is
/// redundant with the chip label.
5357 5358 5359 5360
///
/// See also:
///
/// * [BlockSemantics] which drops semantics of widgets earlier in the tree.
5361
class ExcludeSemantics extends SingleChildRenderObjectWidget {
5362
  /// Creates a widget that drops all the semantics of its descendants.
5363 5364
  const ExcludeSemantics({
    Key key,
5365
    this.excluding = true,
5366 5367 5368 5369 5370 5371 5372 5373 5374
    Widget child,
  }) : assert(excluding != null),
        super(key: key, child: child);

  /// Whether this widget is excluded in the semantics tree.
  final bool excluding;

  @override
  RenderExcludeSemantics createRenderObject(BuildContext context) => new RenderExcludeSemantics(excluding: excluding);
5375 5376

  @override
5377 5378 5379 5380 5381
  void updateRenderObject(BuildContext context, RenderExcludeSemantics renderObject) {
    renderObject.excluding = excluding;
  }

  @override
5382 5383 5384
  void debugFillProperties(DiagnosticPropertiesBuilder properties) {
    super.debugFillProperties(properties);
    properties.add(new DiagnosticsProperty<bool>('excluding', excluding));
5385
  }
Hixie's avatar
Hixie committed
5386 5387
}

5388
/// A widget that builds its child.
Adam Barth's avatar
Adam Barth committed
5389 5390
///
/// Useful for attaching a key to an existing widget.
5391
class KeyedSubtree extends StatelessWidget {
5392
  /// Creates a widget that builds its child.
5393
  const KeyedSubtree({
5394 5395
    Key key,
    @required this.child
5396 5397
  }) : assert(child != null),
       super(key: key);
5398

5399
  /// The widget below this widget in the tree.
5400 5401
  ///
  /// {@macro flutter.widgets.child}
5402 5403
  final Widget child;

Adam Barth's avatar
Adam Barth committed
5404 5405
  /// Creates a KeyedSubtree for child with a key that's based on the child's existing key or childIndex.
  factory KeyedSubtree.wrap(Widget child, int childIndex) {
5406
    final Key key = child.key != null ? new ValueKey<Key>(child.key) : new ValueKey<int>(childIndex);
Adam Barth's avatar
Adam Barth committed
5407 5408 5409
    return new KeyedSubtree(key: key, child: child);
  }

5410
  /// Wrap each item in a KeyedSubtree whose key is based on the item's existing key or
5411
  /// the sum of its list index and `baseIndex`.
5412
  static List<Widget> ensureUniqueKeysForList(Iterable<Widget> items, { int baseIndex = 0 }) {
5413 5414 5415
    if (items == null || items.isEmpty)
      return items;

5416
    final List<Widget> itemsWithUniqueKeys = <Widget>[];
5417
    int itemIndex = baseIndex;
Adam Barth's avatar
Adam Barth committed
5418 5419
    for (Widget item in items) {
      itemsWithUniqueKeys.add(new KeyedSubtree.wrap(item, itemIndex));
5420 5421 5422 5423
      itemIndex += 1;
    }

    assert(!debugItemsHaveDuplicateKeys(itemsWithUniqueKeys));
Hans Muller's avatar
Hans Muller committed
5424
    return itemsWithUniqueKeys;
5425 5426
  }

5427
  @override
5428
  Widget build(BuildContext context) => child;
Adam Barth's avatar
Adam Barth committed
5429
}
5430

5431
/// A platonic widget that calls a closure to obtain its child widget.
5432 5433 5434
///
/// See also:
///
5435
///  * [StatefulBuilder], a platonic widget which also has state.
5436
class Builder extends StatelessWidget {
5437 5438 5439
  /// Creates a widget that delegates its build to a callback.
  ///
  /// The [builder] argument must not be null.
5440
  const Builder({
5441 5442
    Key key,
    @required this.builder
5443 5444
  }) : assert(builder != null),
       super(key: key);
5445 5446 5447

  /// Called to obtain the child widget.
  ///
5448
  /// This function is called whenever this widget is included in its parent's
5449
  /// build and the old widget (if any) that it synchronizes with has a distinct
5450 5451 5452
  /// object identity. Typically the parent's build method will construct
  /// a new tree of widgets and so a new Builder child will not be [identical]
  /// to the corresponding old one.
5453
  final WidgetBuilder builder;
5454

5455
  @override
5456 5457 5458
  Widget build(BuildContext context) => builder(context);
}

5459 5460 5461
/// Signature for the builder callback used by [StatefulBuilder].
///
/// Call [setState] to schedule the [StatefulBuilder] to rebuild.
5462
typedef Widget StatefulWidgetBuilder(BuildContext context, StateSetter setState);
5463 5464 5465 5466 5467

/// A platonic widget that both has state and calls a closure to obtain its child widget.
///
/// See also:
///
5468
///  * [Builder], the platonic stateless widget.
5469
class StatefulBuilder extends StatefulWidget {
5470 5471 5472
  /// Creates a widget that both has state and delegates its build to a callback.
  ///
  /// The [builder] argument must not be null.
5473
  const StatefulBuilder({
5474 5475
    Key key,
    @required this.builder
5476 5477
  }) : assert(builder != null),
       super(key: key);
5478

5479 5480 5481 5482 5483 5484 5485
  /// Called to obtain the child widget.
  ///
  /// This function is called whenever this widget is included in its parent's
  /// build and the old widget (if any) that it synchronizes with has a distinct
  /// object identity. Typically the parent's build method will construct
  /// a new tree of widgets and so a new Builder child will not be [identical]
  /// to the corresponding old one.
5486
  final StatefulWidgetBuilder builder;
5487 5488

  @override
5489 5490
  _StatefulBuilderState createState() => new _StatefulBuilderState();
}
5491

5492
class _StatefulBuilderState extends State<StatefulBuilder> {
5493
  @override
5494
  Widget build(BuildContext context) => widget.builder(context, setState);
5495
}