data_table.dart 26.4 KB
Newer Older
1 2 3 4 5 6
// Copyright 2016 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.

import 'dart:math' as math;

7
import 'package:flutter/foundation.dart';
8 9 10 11 12 13
import 'package:flutter/rendering.dart';
import 'package:flutter/widgets.dart';

import 'checkbox.dart';
import 'colors.dart';
import 'debug.dart';
14
import 'dropdown.dart';
15 16 17 18 19 20 21
import 'icons.dart';
import 'ink_well.dart';
import 'material.dart';
import 'theme.dart';
import 'theme_data.dart';
import 'tooltip.dart';

22
/// Signature for [DataColumn.onSort] callback.
23 24 25 26 27 28 29
typedef void DataColumnSortCallback(int columnIndex, bool ascending);

/// Column configuration for a [DataTable].
///
/// One column configuration must be provided for each column to
/// display in the table. The list of [DataColumn] objects is passed
/// as the `columns` argument to the [new DataTable] constructor.
30
@immutable
31 32 33 34 35
class DataColumn {
  /// Creates the configuration for a column of a [DataTable].
  ///
  /// The [label] argument must not be null.
  const DataColumn({
36
    @required this.label,
37 38 39
    this.tooltip,
    this.numeric: false,
    this.onSort
40
  }) : assert(label != null);
41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63

  /// The column heading.
  ///
  /// Typically, this will be a [Text] widget. It could also be an
  /// [Icon] (typically using size 18), or a [Row] with an icon and
  /// some text.
  ///
  /// The label should not include the sort indicator.
  final Widget label;

  /// The column heading's tooltip.
  ///
  /// This is a longer description of the column heading, for cases
  /// where the heading might have been abbreviated to keep the column
  /// width to a reasonable size.
  final String tooltip;

  /// Whether this column represents numeric data or not.
  ///
  /// The contents of cells of columns containing numeric data are
  /// right-aligned.
  final bool numeric;

64
  /// Called when the user asks to sort the table using this column.
65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81
  ///
  /// If null, the column will not be considered sortable.
  ///
  /// See [DataTable.sortColumnIndex] and [DataTable.sortAscending].
  final DataColumnSortCallback onSort;

  bool get _debugInteractive => onSort != null;
}

/// Row configuration and cell data for a [DataTable].
///
/// One row configuration must be provided for each row to
/// display in the table. The list of [DataRow] objects is passed
/// as the `rows` argument to the [new DataTable] constructor.
///
/// The data for this row of the table is provided in the [cells]
/// property of the [DataRow] object.
82
@immutable
83 84 85 86 87 88 89 90
class DataRow {
  /// Creates the configuration for a row of a [DataTable].
  ///
  /// The [cells] argument must not be null.
  const DataRow({
    this.key,
    this.selected: false,
    this.onSelectChanged,
91
    @required this.cells
92
  }) : assert(cells != null);
93

94 95 96 97 98 99 100 101
  /// Creates the configuration for a row of a [DataTable], deriving
  /// the key from a row index.
  ///
  /// The [cells] argument must not be null.
  DataRow.byIndex({
    int index,
    this.selected: false,
    this.onSelectChanged,
102
    @required this.cells
103 104
  }) : assert(cells != null),
       key = new ValueKey<int>(index);
105

106 107 108 109 110 111 112 113
  /// A [Key] that uniquely identifies this row. This is used to
  /// ensure that if a row is added or removed, any stateful widgets
  /// related to this row (e.g. an in-progress checkbox animation)
  /// remain on the right row visually.
  ///
  /// If the table never changes once created, no key is necessary.
  final LocalKey key;

114
  /// Called when the user selects or unselects a selectable row.
115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152
  ///
  /// If this is not null, then the row is selectable. The current
  /// selection state of the row is given by [selected].
  ///
  /// If any row is selectable, then the table's heading row will have
  /// a checkbox that can be checked to select all selectable rows
  /// (and which is checked if all the rows are selected), and each
  /// subsequent row will have a checkbox to toggle just that row.
  ///
  /// A row whose [onSelectChanged] callback is null is ignored for
  /// the purposes of determining the state of the "all" checkbox,
  /// and its checkbox is disabled.
  final ValueChanged<bool> onSelectChanged;

  /// Whether the row is selected.
  ///
  /// If [onSelectChanged] is non-null for any row in the table, then
  /// a checkbox is shown at the start of each row. If the row is
  /// selected (true), the checkbox will be checked and the row will
  /// be highlighted.
  ///
  /// Otherwise, the checkbox, if present, will not be checked.
  final bool selected;

  /// The data for this row.
  ///
  /// There must be exactly as many cells as there are columns in the
  /// table.
  final List<DataCell> cells;

  bool get _debugInteractive => onSelectChanged != null || cells.any((DataCell cell) => cell._debugInteractive);
}

/// The data for a cell of a [DataTable].
///
/// One list of [DataCell] objects must be provided for each [DataRow]
/// in the [DataTable], in the [new DataRow] constructor's `cells`
/// argument.
153
@immutable
154 155 156 157
class DataCell {
  /// Creates an object to hold the data for a cell in a [DataTable].
  ///
  /// The first argument is the widget to show for the cell, typically
158
  /// a [Text] or [DropdownButton] widget; this becomes the [child]
159 160 161 162 163
  /// property and must not be null.
  ///
  /// If the cell has no data, then a [Text] widget with placeholder
  /// text should be provided instead, and then the [placeholder]
  /// argument should be set to true.
164
  const DataCell(this.child, {
165 166
    this.placeholder: false,
    this.showEditIcon: false,
167
    this.onTap,
168
  }) : assert(child != null);
169

170
  /// A cell that has no content and has zero width and height.
171 172
  static final DataCell empty = new DataCell(new Container(width: 0.0, height: 0.0));

173 174
  /// The data for the row.
  ///
175
  /// Typically a [Text] widget or a [DropdownButton] widget.
176 177 178 179
  ///
  /// If the cell has no data, then a [Text] widget with placeholder
  /// text should be provided instead, and [placeholder] should be set
  /// to true.
180
  final Widget child;
181

182
  /// Whether the [child] is actually a placeholder.
183 184 185 186 187 188 189 190 191 192 193 194 195 196 197
  ///
  /// If this is true, the default text style for the cell is changed
  /// to be appropriate for placeholder text.
  final bool placeholder;

  /// Whether to show an edit icon at the end of the cell.
  ///
  /// This does not make the cell actually editable; the caller must
  /// implement editing behavior if desired (initiated from the
  /// [onTap] callback).
  ///
  /// If this is set, [onTap] should also be set, otherwise tapping
  /// the icon will have no effect.
  final bool showEditIcon;

198
  /// Called if the cell is tapped.
199
  ///
200
  /// If non-null, tapping the cell will call this callback. If
201
  /// null, tapping the cell will attempt to select the row (if
202
  /// [DataRow.onSelectChanged] is provided).
203 204 205 206 207 208 209 210 211 212 213 214
  final VoidCallback onTap;

  bool get _debugInteractive => onTap != null;
}

/// A material design data table.
///
/// Displaying data in a table is expensive, because to lay out the
/// table all the data must be measured twice, once to negotiate the
/// dimensions to use for each column, and once to actually lay out
/// the table given the results of the negotiation.
///
215 216 217 218 219 220 221
/// For this reason, if you have a lot of data (say, more than a dozen
/// rows with a dozen columns, though the precise limits depend on the
/// target device), it is suggested that you use a
/// [PaginatedDataTable] which automatically splits the data into
/// multiple pages.
// TODO(ianh): Also suggest [ScrollingDataTable] once we have it.
///
222 223
/// See also:
///
Adam Barth's avatar
Adam Barth committed
224 225 226 227 228
///  * [DataColumn], which describes a column in the data table.
///  * [DataRow], which contains the data for a row in the data table.
///  * [DataCell], which contains the data for a single cell in the data table.
///  * [PaginatedDataTable], which shows part of the data in a data table and
///    provides controls for paging through the remainder of the data.
229
///  * <https://material.google.com/components/data-tables.html>
230 231 232 233 234 235
class DataTable extends StatelessWidget {
  /// Creates a widget describing a data table.
  ///
  /// The [columns] argument must be a list of as many [DataColumn]
  /// objects as the table is to have columns, ignoring the leading
  /// checkbox column if any. The [columns] argument must have a
236
  /// length greater than zero and must not be null.
237
  ///
238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256
  /// The [rows] argument must be a list of as many [DataRow] objects
  /// as the table is to have rows, ignoring the leading heading row
  /// that contains the column headings (derived from the [columns]
  /// argument). There may be zero rows, but the rows argument must
  /// not be null.
  ///
  /// Each [DataRow] object in [rows] must have as many [DataCell]
  /// objects in the [DataRow.cells] list as the table has columns.
  ///
  /// If the table is sorted, the column that provides the current
  /// primary key should be specified by index in [sortColumnIndex], 0
  /// meaning the first column in [columns], 1 being the next one, and
  /// so forth.
  ///
  /// The actual sort order can be specified using [sortAscending]; if
  /// the sort order is ascending, this should be true (the default),
  /// otherwise it should be false.
  DataTable({
    Key key,
257
    @required this.columns,
258 259
    this.sortColumnIndex,
    this.sortAscending: true,
260
    this.onSelectAll,
261
    @required this.rows
262 263 264 265 266 267 268 269
  }) : assert(columns != null),
       assert(columns.isNotEmpty),
       assert(sortColumnIndex == null || (sortColumnIndex >= 0 && sortColumnIndex < columns.length)),
       assert(sortAscending != null),
       assert(rows != null),
       assert(!rows.any((DataRow row) => row.cells.length != columns.length)),
       _onlyTextColumn = _initOnlyTextColumn(columns),
       super(key: key);
270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298

  /// The configuration and labels for the columns in the table.
  final List<DataColumn> columns;

  /// The current primary sort key's column.
  ///
  /// If non-null, indicates that the indicated column is the column
  /// by which the data is sorted. The number must correspond to the
  /// index of the relevant column in [columns].
  ///
  /// Setting this will cause the relevant column to have a sort
  /// indicator displayed.
  ///
  /// When this is null, it implies that the table's sort order does
  /// not correspond to any of the columns.
  final int sortColumnIndex;

  /// Whether the column mentioned in [sortColumnIndex], if any, is sorted
  /// in ascending order.
  ///
  /// If true, the order is ascending (meaning the rows with the
  /// smallest values for the current sort column are first in the
  /// table).
  ///
  /// If false, the order is descending (meaning the rows with the
  /// smallest values for the current sort column are last in the
  /// table).
  final bool sortAscending;

299 300 301 302 303 304 305 306 307 308 309
  /// Invoked when the user selects or unselects every row, using the
  /// checkbox in the heading row.
  ///
  /// If this is null, then the [DataRow.onSelectChanged] callback of
  /// every row in the table is invoked appropriately instead.
  ///
  /// To control whether a particular row is selectable or not, see
  /// [DataRow.onSelectChanged]. This callback is only relevant if any
  /// row is selectable.
  final ValueSetter<bool> onSelectAll;

310 311 312 313 314 315 316 317 318 319
  /// The data to show in each row (excluding the row that contains
  /// the column headings). Must be non-null, but may be empty.
  final List<DataRow> rows;

  // Set by the constructor to the index of the only Column that is
  // non-numeric, if there is exactly one, otherwise null.
  final int _onlyTextColumn;
  static int _initOnlyTextColumn(List<DataColumn> columns) {
    int result;
    for (int index = 0; index < columns.length; index += 1) {
320
      final DataColumn column = columns[index];
321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337
      if (!column.numeric) {
        if (result != null)
          return null;
        result = index;
      }
    }
    return result;
  }

  bool get _debugInteractive {
    return columns.any((DataColumn column) => column._debugInteractive)
        || rows.any((DataRow row) => row._debugInteractive);
  }

  static final LocalKey _headingRowKey = new UniqueKey();

  void _handleSelectAll(bool checked) {
338 339 340 341 342 343 344
    if (onSelectAll != null) {
      onSelectAll(checked);
    } else {
      for (DataRow row in rows) {
        if ((row.onSelectChanged != null) && (row.selected != checked))
          row.onSelectChanged(checked);
      }
345 346 347 348 349 350 351 352 353 354 355
    }
  }

  static const double _kHeadingRowHeight = 56.0;
  static const double _kDataRowHeight = 48.0;
  static const double _kTablePadding = 24.0;
  static const double _kColumnSpacing = 56.0;
  static const double _kSortArrowPadding = 2.0;
  static const double _kHeadingFontSize = 12.0;
  static const Duration _kSortArrowAnimationDuration = const Duration(milliseconds: 150);
  static const Color _kGrey100Opacity = const Color(0x0A000000); // Grey 100 as opacity instead of solid color
356
  static const Color _kGrey300Opacity = const Color(0x1E000000); // Dark theme variant is just a guess.
357 358 359 360 361 362 363 364

  Widget _buildCheckbox({
    Color color,
    bool checked,
    VoidCallback onRowTap,
    ValueChanged<bool> onCheckboxChanged
  }) {
    Widget contents = new Padding(
365
      padding: const EdgeInsetsDirectional.only(start: _kTablePadding, end: _kTablePadding / 2.0),
366 367 368 369 370 371 372 373 374
      child: new Center(
        child: new Checkbox(
          activeColor: color,
          value: checked,
          onChanged: onCheckboxChanged
        )
      )
    );
    if (onRowTap != null) {
375
      contents = new TableRowInkWell(
376 377 378 379 380 381 382 383 384 385 386
        onTap: onRowTap,
        child: contents
      );
    }
    return new TableCell(
      verticalAlignment: TableCellVerticalAlignment.fill,
      child: contents
    );
  }

  Widget _buildHeadingCell({
387
    BuildContext context,
388
    EdgeInsetsGeometry padding,
389 390 391 392 393 394 395 396 397 398 399 400 401
    Widget label,
    String tooltip,
    bool numeric,
    VoidCallback onSort,
    bool sorted,
    bool ascending
  }) {
    if (onSort != null) {
      final Widget arrow = new _SortArrow(
        visible: sorted,
        down: sorted ? ascending : null,
        duration: _kSortArrowAnimationDuration
      );
402
      final Widget arrowPadding = const SizedBox(width: _kSortArrowPadding);
403 404 405 406 407 408 409 410
      label = new Row(
        children: numeric ? <Widget>[ arrow, arrowPadding, label ]
                          : <Widget>[ label, arrowPadding, arrow ]
      );
    }
    label = new Container(
      padding: padding,
      height: _kHeadingRowHeight,
411
      alignment: numeric ? FractionalOffset.centerRight : FractionalOffsetDirectional.centerStart,
412 413 414 415 416 417 418 419 420 421 422 423
      child: new AnimatedDefaultTextStyle(
        style: new TextStyle(
          // TODO(ianh): font family should be Roboto; see https://github.com/flutter/flutter/issues/3116
          fontWeight: FontWeight.w500,
          fontSize: _kHeadingFontSize,
          height: _kHeadingRowHeight / _kHeadingFontSize,
          color: (Theme.of(context).brightness == Brightness.light)
            ? ((onSort != null && sorted) ? Colors.black87 : Colors.black54)
            : ((onSort != null && sorted) ? Colors.white : Colors.white70)
        ),
        duration: _kSortArrowAnimationDuration,
        child: label
424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442
      )
    );
    if (tooltip != null) {
      label = new Tooltip(
        message: tooltip,
        child: label
      );
    }
    if (onSort != null) {
      label = new InkWell(
        onTap: onSort,
        // TODO(ianh): When we do RTL, we need to use 'end' ordering for the non-numeric case
        child: label
      );
    }
    return label;
  }

  Widget _buildDataCell({
Ian Hickson's avatar
Ian Hickson committed
443
    BuildContext context,
444
    EdgeInsetsGeometry padding,
445 446 447 448 449 450 451
    Widget label,
    bool numeric,
    bool placeholder,
    bool showEditIcon,
    VoidCallback onTap,
    VoidCallback onSelectChanged
  }) {
452
    final bool isLightTheme = Theme.of(context).brightness == Brightness.light;
453
    if (showEditIcon) {
454
      final Widget icon = const Icon(Icons.edit, size: 18.0);
455
      label = new Expanded(child: label);
456 457 458 459 460
      label = new Row(children: numeric ? <Widget>[ icon, label ] : <Widget>[ label, icon ]);
    }
    label = new Container(
      padding: padding,
      height: _kDataRowHeight,
461
      alignment: numeric ? FractionalOffset.centerRight : FractionalOffsetDirectional.centerStart,
462 463 464 465 466 467 468 469
      child: new DefaultTextStyle(
        style: new TextStyle(
          // TODO(ianh): font family should be Roboto; see https://github.com/flutter/flutter/issues/3116
          fontSize: 13.0,
          color: isLightTheme
            ? (placeholder ? Colors.black38 : Colors.black87)
            : (placeholder ? Colors.white30 : Colors.white70)
        ),
470
        child: IconTheme.merge(
471 472
          data: new IconThemeData(
            color: isLightTheme ? Colors.black54 : Colors.white70
473
          ),
474
          child: new DropdownButtonHideUnderline(child: label)
475 476 477 478 479 480 481 482 483
        )
      )
    );
    if (onTap != null) {
      label = new InkWell(
        onTap: onTap,
        child: label
      );
    } else if (onSelectChanged != null) {
484
      label = new TableRowInkWell(
485 486 487 488 489 490 491 492 493 494 495 496 497
        onTap: onSelectChanged,
        child: label
      );
    }
    return label;
  }

  @override
  Widget build(BuildContext context) {
    assert(!_debugInteractive || debugCheckHasMaterial(context));

    final ThemeData theme = Theme.of(context);
    final BoxDecoration _kSelectedDecoration = new BoxDecoration(
498 499
      border: new Border(bottom: new BorderSide(color: theme.dividerColor)),
      // The backgroundColor has to be transparent so you can see the ink on the material
500
      color: (Theme.of(context).brightness == Brightness.light) ? _kGrey100Opacity : _kGrey300Opacity
501 502 503 504 505 506 507 508
    );
    final BoxDecoration _kUnselectedDecoration = new BoxDecoration(
      border: new Border(bottom: new BorderSide(color: theme.dividerColor))
    );

    final bool showCheckboxColumn = rows.any((DataRow row) => row.onSelectChanged != null);
    final bool allChecked = showCheckboxColumn && !rows.any((DataRow row) => row.onSelectChanged != null && !row.selected);

509 510
    final List<TableColumnWidth> tableColumns = new List<TableColumnWidth>(columns.length + (showCheckboxColumn ? 1 : 0));
    final List<TableRow> tableRows = new List<TableRow>.generate(
511 512 513 514 515 516 517 518 519 520 521 522 523 524 525
      rows.length + 1, // the +1 is for the header row
      (int index) {
        return new TableRow(
          key: index == 0 ? _headingRowKey : rows[index - 1].key,
          decoration: index > 0 && rows[index - 1].selected ? _kSelectedDecoration
                                                            : _kUnselectedDecoration,
          children: new List<Widget>(tableColumns.length)
        );
      }
    );

    int rowIndex;

    int displayColumnIndex = 0;
    if (showCheckboxColumn) {
526
      tableColumns[0] = const FixedColumnWidth(_kTablePadding + Checkbox.width + _kTablePadding / 2.0);
527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545
      tableRows[0].children[0] = _buildCheckbox(
        color: theme.accentColor,
        checked: allChecked,
        onCheckboxChanged: _handleSelectAll
      );
      rowIndex = 1;
      for (DataRow row in rows) {
        tableRows[rowIndex].children[0] = _buildCheckbox(
          color: theme.accentColor,
          checked: row.selected,
          onRowTap: () => row.onSelectChanged(!row.selected),
          onCheckboxChanged: row.onSelectChanged
        );
        rowIndex += 1;
      }
      displayColumnIndex += 1;
    }

    for (int dataColumnIndex = 0; dataColumnIndex < columns.length; dataColumnIndex += 1) {
546
      final DataColumn column = columns[dataColumnIndex];
547 548 549
      final EdgeInsetsDirectional padding = new EdgeInsetsDirectional.only(
        start: dataColumnIndex == 0 ? showCheckboxColumn ? _kTablePadding / 2.0 : _kTablePadding : _kColumnSpacing / 2.0,
        end: dataColumnIndex == columns.length - 1 ? _kTablePadding : _kColumnSpacing / 2.0,
550 551 552 553 554 555 556
      );
      if (dataColumnIndex == _onlyTextColumn) {
        tableColumns[displayColumnIndex] = const IntrinsicColumnWidth(flex: 1.0);
      } else {
        tableColumns[displayColumnIndex] = const IntrinsicColumnWidth();
      }
      tableRows[0].children[displayColumnIndex] = _buildHeadingCell(
557
        context: context,
558 559 560 561 562 563 564 565 566 567
        padding: padding,
        label: column.label,
        tooltip: column.tooltip,
        numeric: column.numeric,
        onSort: () => column.onSort(dataColumnIndex, sortColumnIndex == dataColumnIndex ? !sortAscending : true),
        sorted: dataColumnIndex == sortColumnIndex,
        ascending: sortAscending
      );
      rowIndex = 1;
      for (DataRow row in rows) {
568
        final DataCell cell = row.cells[dataColumnIndex];
569
        tableRows[rowIndex].children[displayColumnIndex] = _buildDataCell(
Ian Hickson's avatar
Ian Hickson committed
570
          context: context,
571
          padding: padding,
572
          label: cell.child,
573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596
          numeric: column.numeric,
          placeholder: cell.placeholder,
          showEditIcon: cell.showEditIcon,
          onTap: cell.onTap,
          onSelectChanged: () => row.onSelectChanged(!row.selected)
        );
        rowIndex += 1;
      }
      displayColumnIndex += 1;
    }

    return new Table(
      columnWidths: tableColumns.asMap(),
      children: tableRows
    );
  }
}

/// A rectangular area of a Material that responds to touch but clips
/// its ink splashes to the current table row of the nearest table.
///
/// Must have an ancestor [Material] widget in which to cause ink
/// reactions and an ancestor [Table] widget to establish a row.
///
597
/// The [TableRowInkWell] must be in the same coordinate space (modulo
598 599 600 601
/// translations) as the [Table]. If it's rotated or scaled or
/// otherwise transformed, it will not be able to describe the
/// rectangle of the row in its own coordinate system as a [Rect], and
/// thus the splash will not occur. (In general, this is easy to
602
/// achieve: just put the [TableRowInkWell] as the direct child of the
603
/// [Table], and put the other contents of the cell inside it.)
604
class TableRowInkWell extends InkResponse {
605
  /// Creates an ink well for a table row.
606
  const TableRowInkWell({
607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628
    Key key,
    Widget child,
    GestureTapCallback onTap,
    GestureTapCallback onDoubleTap,
    GestureLongPressCallback onLongPress,
    ValueChanged<bool> onHighlightChanged
  }) : super(
    key: key,
    child: child,
    onTap: onTap,
    onDoubleTap: onDoubleTap,
    onLongPress: onLongPress,
    onHighlightChanged: onHighlightChanged,
    containedInkWell: true,
    highlightShape: BoxShape.rectangle
  );

  @override
  RectCallback getRectCallback(RenderBox referenceBox) {
    return () {
      RenderObject cell = referenceBox;
      AbstractNode table = cell.parent;
629
      final Matrix4 transform = new Matrix4.identity();
630
      while (table is RenderObject && table is! RenderTable) {
631
        final RenderTable parentBox = table;
632 633 634 635 636 637
        parentBox.applyPaintTransform(cell, transform);
        assert(table == cell.parent);
        cell = table;
        table = table.parent;
      }
      if (table is RenderTable) {
638
        final TableCellParentData cellParentData = cell.parentData;
639
        assert(cellParentData.y != null);
640
        final Rect rect = table.getRowBox(cellParentData.y);
641
        // The rect is in the table's coordinate space. We need to change it to the
642
        // TableRowInkWell's coordinate space.
643
        table.applyPaintTransform(cell, transform);
644
        final Offset offset = MatrixUtils.getAsTranslation(transform);
645 646 647 648 649 650 651 652 653 654 655 656 657 658 659
        if (offset != null)
          return rect.shift(-offset);
      }
      return Rect.zero;
    };
  }

  @override
  bool debugCheckContext(BuildContext context) {
    assert(debugCheckHasTable(context));
    return super.debugCheckContext(context);
  }
}

class _SortArrow extends StatefulWidget {
660
  const _SortArrow({
661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676
    Key key,
    this.visible,
    this.down,
    this.duration
  }) : super(key: key);

  final bool visible;

  final bool down;

  final Duration duration;

  @override
  _SortArrowState createState() => new _SortArrowState();
}

677
class _SortArrowState extends State<_SortArrow> with TickerProviderStateMixin {
678 679 680 681 682 683 684 685 686 687 688 689 690 691 692

  AnimationController _opacityController;
  Animation<double> _opacityAnimation;

  AnimationController _orientationController;
  Animation<double> _orientationAnimation;
  double _orientationOffset = 0.0;

  bool _down;

  @override
  void initState() {
    super.initState();
    _opacityAnimation = new CurvedAnimation(
      parent: _opacityController = new AnimationController(
693
        duration: widget.duration,
694
        vsync: this,
695
      ),
696
      curve: Curves.fastOutSlowIn
697 698
    )
    ..addListener(_rebuild);
699
    _opacityController.value = widget.visible ? 1.0 : 0.0;
700 701 702 703 704
    _orientationAnimation = new Tween<double>(
      begin: 0.0,
      end: math.PI
    ).animate(new CurvedAnimation(
      parent: _orientationController = new AnimationController(
705
        duration: widget.duration,
706
        vsync: this,
707 708 709 710 711
      ),
      curve: Curves.easeIn
    ))
    ..addListener(_rebuild)
    ..addStatusListener(_resetOrientationAnimation);
712 713
    if (widget.visible)
      _orientationOffset = widget.down ? 0.0 : math.PI;
714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730
  }

  void _rebuild() {
    setState(() {
      // The animations changed, so we need to rebuild.
    });
  }

  void _resetOrientationAnimation(AnimationStatus status) {
    if (status == AnimationStatus.completed) {
      assert(_orientationAnimation.value == math.PI);
      _orientationOffset += math.PI;
      _orientationController.value = 0.0; // TODO(ianh): This triggers a pointless rebuild.
    }
  }

  @override
731 732
  void didUpdateWidget(_SortArrow oldWidget) {
    super.didUpdateWidget(oldWidget);
733
    bool skipArrow = false;
734 735 736
    final bool newDown = widget.down != null ? widget.down : _down;
    if (oldWidget.visible != widget.visible) {
      if (widget.visible && (_opacityController.status == AnimationStatus.dismissed)) {
737 738 739 740 741
        _orientationController.stop();
        _orientationController.value = 0.0;
        _orientationOffset = newDown ? 0.0 : math.PI;
        skipArrow = true;
      }
742
      if (widget.visible) {
743 744
        _opacityController.forward();
      } else {
745
        _opacityController.reverse();
746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776
      }
    }
    if ((_down != newDown) && !skipArrow) {
      if (_orientationController.status == AnimationStatus.dismissed) {
        _orientationController.forward();
      } else {
        _orientationController.reverse();
      }
    }
    _down = newDown;
  }

  @override
  void dispose() {
    _opacityController.dispose();
    _orientationController.dispose();
    super.dispose();
  }

  static const double _kArrowIconBaselineOffset = -1.5;
  static const double _kArrowIconSize = 16.0;

  @override
  Widget build(BuildContext context) {
    return new Opacity(
      opacity: _opacityAnimation.value,
      child: new Transform(
        transform: new Matrix4.rotationZ(_orientationOffset + _orientationAnimation.value)
                             ..setTranslationRaw(0.0, _kArrowIconBaselineOffset, 0.0),
        alignment: FractionalOffset.center,
        child: new Icon(
Ian Hickson's avatar
Ian Hickson committed
777
          Icons.arrow_downward,
778
          size: _kArrowIconSize,
779
          color: (Theme.of(context).brightness == Brightness.light) ? Colors.black87 : Colors.white70
780 781 782 783 784 785
        )
      )
    );
  }

}