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

import 'dart:math' as math;

import 'box.dart';
8
import 'object.dart';
9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25
import 'sliver.dart';
import 'sliver_fixed_extent_list.dart';

/// A sliver that contains multiple box children that each fill the viewport.
///
/// [RenderSliverFillViewport] places its children in a linear array along the
/// main axis. Each child is sized to fill the viewport, both in the main and
/// cross axis. A [viewportFraction] factor can be provided to size the children
/// to a multiple of the viewport's main axis dimension (typically a fraction
/// less than 1.0).
///
/// See also:
///
///  * [RenderSliverFillRemaining], which sizes the children based on the
///    remaining space rather than the viewport itself.
///  * [RenderSliverFixedExtentList], which has a configurable [itemExtent].
///  * [RenderSliverList], which does not require its children to have the same
26
///    extent in the main axis.
27 28 29 30 31 32
class RenderSliverFillViewport extends RenderSliverFixedExtentBoxAdaptor {
  /// Creates a sliver that contains multiple box children that each fill the
  /// viewport.
  ///
  /// The [childManager] argument must not be null.
  RenderSliverFillViewport({
33
    required super.childManager,
34
    double viewportFraction = 1.0,
35
  }) : assert(viewportFraction > 0.0),
36
       _viewportFraction = viewportFraction;
37 38 39 40 41 42 43 44 45 46 47 48

  @override
  double get itemExtent => constraints.viewportMainAxisExtent * viewportFraction;

  /// The fraction of the viewport that each child should fill in the main axis.
  ///
  /// If this fraction is less than 1.0, more than one child will be visible at
  /// once. If this fraction is greater than 1.0, each child will be larger than
  /// the viewport in the main axis.
  double get viewportFraction => _viewportFraction;
  double _viewportFraction;
  set viewportFraction(double value) {
49
    if (_viewportFraction == value) {
50
      return;
51
    }
52 53 54 55 56
    _viewportFraction = value;
    markNeedsLayout();
  }
}

57 58
/// A sliver that contains a single box child that contains a scrollable and
/// fills the viewport.
59
///
60 61 62
/// [RenderSliverFillRemainingWithScrollable] sizes its child to fill the
/// viewport in the cross axis and to fill the remaining space in the viewport
/// in the main axis.
63 64 65 66 67 68
///
/// Typically this will be the last sliver in a viewport, since (by definition)
/// there is never any room for anything beyond this sliver.
///
/// See also:
///
69 70 71 72 73 74 75 76 77 78 79 80
///  * [NestedScrollView], which uses this sliver for the inner scrollable.
///  * [RenderSliverFillRemaining], which lays out its
///    non-scrollable child slightly different than this widget.
///  * [RenderSliverFillRemainingAndOverscroll], which incorporates the
///    overscroll into the remaining space to fill.
///  * [RenderSliverFillViewport], which sizes its children based on the
///    size of the viewport, regardless of what else is in the scroll view.
///  * [RenderSliverList], which shows a list of variable-sized children in a
///    viewport.
class RenderSliverFillRemainingWithScrollable extends RenderSliverSingleBoxAdapter {
  /// Creates a [RenderSliver] that wraps a scrollable [RenderBox] which is
  /// sized to fit the remaining space in the viewport.
81
  RenderSliverFillRemainingWithScrollable({ super.child });
82 83 84

  @override
  void performLayout() {
85
    final SliverConstraints constraints = this.constraints;
86 87
    final double extent = constraints.remainingPaintExtent - math.min(constraints.overlap, 0.0);

88
    if (child != null) {
89
      child!.layout(constraints.asBoxConstraints(
90 91 92
        minExtent: extent,
        maxExtent: extent,
      ));
93
    }
94 95 96 97 98 99 100 101 102 103

    final double paintedChildSize = calculatePaintOffset(constraints, from: 0.0, to: extent);
    assert(paintedChildSize.isFinite);
    assert(paintedChildSize >= 0.0);
    geometry = SliverGeometry(
      scrollExtent: constraints.viewportMainAxisExtent,
      paintExtent: paintedChildSize,
      maxPaintExtent: paintedChildSize,
      hasVisualOverflow: extent > constraints.remainingPaintExtent || constraints.scrollOffset > 0.0,
    );
104
    if (child != null) {
105
      setChildParentData(child!, constraints, geometry!);
106
    }
107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125
  }
}

/// A sliver that contains a single box child that is non-scrollable and fills
/// the remaining space in the viewport.
///
/// [RenderSliverFillRemaining] sizes its child to fill the
/// viewport in the cross axis and to fill the remaining space in the viewport
/// in the main axis.
///
/// Typically this will be the last sliver in a viewport, since (by definition)
/// there is never any room for anything beyond this sliver.
///
/// See also:
///
///  * [RenderSliverFillRemainingWithScrollable], which lays out its scrollable
///    child slightly different than this widget.
///  * [RenderSliverFillRemainingAndOverscroll], which incorporates the
///    overscroll into the remaining space to fill.
126 127
///  * [RenderSliverFillViewport], which sizes its children based on the
///    size of the viewport, regardless of what else is in the scroll view.
128 129 130
///  * [RenderSliverList], which shows a list of variable-sized children in a
///    viewport.
class RenderSliverFillRemaining extends RenderSliverSingleBoxAdapter {
131 132
  /// Creates a [RenderSliver] that wraps a non-scrollable [RenderBox] which is
  /// sized to fit the remaining space in the viewport.
133
  RenderSliverFillRemaining({ super.child });
134

135 136
  @override
  void performLayout() {
137
    final SliverConstraints constraints = this.constraints;
138 139
    // The remaining space in the viewportMainAxisExtent. Can be <= 0 if we have
    // scrolled beyond the extent of the screen.
140 141
    double extent = constraints.viewportMainAxisExtent - constraints.precedingScrollExtent;

142
    if (child != null) {
143
      final double childExtent;
144 145
      switch (constraints.axis) {
        case Axis.horizontal:
146
          childExtent = child!.getMaxIntrinsicWidth(constraints.crossAxisExtent);
147
        case Axis.vertical:
148
          childExtent = child!.getMaxIntrinsicHeight(constraints.crossAxisExtent);
149
      }
150

151 152 153 154
      // If the childExtent is greater than the computed extent, we want to use
      // that instead of potentially cutting off the child. This allows us to
      // safely specify a maxExtent.
      extent = math.max(extent, childExtent);
155
      child!.layout(constraints.asBoxConstraints(
156 157 158
        minExtent: extent,
        maxExtent: extent,
      ));
159 160 161
    }

    assert(extent.isFinite,
162 163 164
      'The calculated extent for the child of SliverFillRemaining is not finite. '
      'This can happen if the child is a scrollable, in which case, the '
      'hasScrollBody property of SliverFillRemaining should not be set to '
165
      'false.',
166
    );
167
    final double paintedChildSize = calculatePaintOffset(constraints, from: 0.0, to: extent);
168 169
    assert(paintedChildSize.isFinite);
    assert(paintedChildSize >= 0.0);
170
    geometry = SliverGeometry(
171
      scrollExtent: extent,
172 173
      paintExtent: paintedChildSize,
      maxPaintExtent: paintedChildSize,
174
      hasVisualOverflow: extent > constraints.remainingPaintExtent || constraints.scrollOffset > 0.0,
175
    );
176
    if (child != null) {
177
      setChildParentData(child!, constraints, geometry!);
178
    }
179 180
  }
}
181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204

/// A sliver that contains a single box child that is non-scrollable and fills
/// the remaining space in the viewport including any overscrolled area.
///
/// [RenderSliverFillRemainingAndOverscroll] sizes its child to fill the
/// viewport in the cross axis and to fill the remaining space in the viewport
/// in the main axis with the overscroll area included.
///
/// Typically this will be the last sliver in a viewport, since (by definition)
/// there is never any room for anything beyond this sliver.
///
/// See also:
///
///  * [RenderSliverFillRemainingWithScrollable], which lays out its scrollable
///    child without overscroll.
///  * [RenderSliverFillRemaining], which lays out its
///    non-scrollable child without overscroll.
///  * [RenderSliverFillViewport], which sizes its children based on the
///    size of the viewport, regardless of what else is in the scroll view.
///  * [RenderSliverList], which shows a list of variable-sized children in a
///    viewport.
class RenderSliverFillRemainingAndOverscroll extends RenderSliverSingleBoxAdapter {
  /// Creates a [RenderSliver] that wraps a non-scrollable [RenderBox] which is
  /// sized to fit the remaining space plus any overscroll in the viewport.
205
  RenderSliverFillRemainingAndOverscroll({ super.child });
206 207 208

  @override
  void performLayout() {
209
    final SliverConstraints constraints = this.constraints;
210 211 212 213 214 215 216 217
    // The remaining space in the viewportMainAxisExtent. Can be <= 0 if we have
    // scrolled beyond the extent of the screen.
    double extent = constraints.viewportMainAxisExtent - constraints.precedingScrollExtent;
    // The maxExtent includes any overscrolled area. Can be < 0 if we have
    // overscroll in the opposite direction, away from the end of the list.
    double maxExtent = constraints.remainingPaintExtent - math.min(constraints.overlap, 0.0);

    if (child != null) {
218
      final double childExtent;
219 220
      switch (constraints.axis) {
        case Axis.horizontal:
221
          childExtent = child!.getMaxIntrinsicWidth(constraints.crossAxisExtent);
222
        case Axis.vertical:
223
          childExtent = child!.getMaxIntrinsicHeight(constraints.crossAxisExtent);
224 225 226 227 228 229 230 231 232 233
      }

      // If the childExtent is greater than the computed extent, we want to use
      // that instead of potentially cutting off the child. This allows us to
      // safely specify a maxExtent.
      extent = math.max(extent, childExtent);
      // The extent could be larger than the maxExtent due to a larger child
      // size or overscrolling at the top of the scrollable (rather than at the
      // end where this sliver is).
      maxExtent = math.max(extent, maxExtent);
234
      child!.layout(constraints.asBoxConstraints(minExtent: extent, maxExtent: maxExtent));
235 236 237
    }

    assert(extent.isFinite,
238 239 240
      'The calculated extent for the child of SliverFillRemaining is not finite. '
      'This can happen if the child is a scrollable, in which case, the '
      'hasScrollBody property of SliverFillRemaining should not be set to '
241 242 243 244 245 246 247 248 249 250 251
      'false.',
    );
    final double paintedChildSize = calculatePaintOffset(constraints, from: 0.0, to: extent);
    assert(paintedChildSize.isFinite);
    assert(paintedChildSize >= 0.0);
    geometry = SliverGeometry(
      scrollExtent: extent,
      paintExtent: math.min(maxExtent, constraints.remainingPaintExtent),
      maxPaintExtent: maxExtent,
      hasVisualOverflow: extent > constraints.remainingPaintExtent || constraints.scrollOffset > 0.0,
    );
252
    if (child != null) {
253
      setChildParentData(child!, constraints, geometry!);
254
    }
255 256
  }
}