build method

  1. @override
Widget build(
  1. BuildContext context
)
override

Describes the part of the user interface represented by this widget.

The framework calls this method when this widget is inserted into the tree in a given BuildContext and when the dependencies of this widget change (e.g., an InheritedWidget referenced by this widget changes). This method can potentially be called in every frame and should not have any side effects beyond building a widget.

The framework replaces the subtree below this widget with the widget returned by this method, either by updating the existing subtree or by removing the subtree and inflating a new subtree, depending on whether the widget returned by this method can update the root of the existing subtree, as determined by calling Widget.canUpdate.

Typically implementations return a newly created constellation of widgets that are configured with information from this widget's constructor and from the given BuildContext.

The given BuildContext contains information about the location in the tree at which this widget is being built. For example, the context provides the set of inherited widgets for this location in the tree. A given widget might be built with multiple different BuildContext arguments over time if the widget is moved around the tree or if the widget is inserted into the tree in multiple places at once.

The implementation of this method must only depend on:

If a widget's build method is to depend on anything else, use a StatefulWidget instead.

See also:

  • StatelessWidget, which contains the discussion on performance considerations.

Implementation

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

  final ThemeData theme = Theme.of(context);
  final DataTableThemeData dataTableTheme = DataTableTheme.of(context);
  final MaterialStateProperty<Color?>? effectiveHeadingRowColor = headingRowColor
    ?? dataTableTheme.headingRowColor
    ?? theme.dataTableTheme.headingRowColor;
  final MaterialStateProperty<Color?>? effectiveDataRowColor = dataRowColor
    ?? dataTableTheme.dataRowColor
    ?? theme.dataTableTheme.dataRowColor;
  final MaterialStateProperty<Color?> defaultRowColor = MaterialStateProperty.resolveWith(
    (Set<MaterialState> states) {
      if (states.contains(MaterialState.selected)) {
        return theme.colorScheme.primary.withOpacity(0.08);
      }
      return null;
    },
  );
  final bool anyRowSelectable = rows.any((DataRow row) => row.onSelectChanged != null);
  final bool displayCheckboxColumn = showCheckboxColumn && anyRowSelectable;
  final Iterable<DataRow> rowsWithCheckbox = displayCheckboxColumn ?
    rows.where((DataRow row) => row.onSelectChanged != null) : <DataRow>[];
  final Iterable<DataRow> rowsChecked = rowsWithCheckbox.where((DataRow row) => row.selected);
  final bool allChecked = displayCheckboxColumn && rowsChecked.length == rowsWithCheckbox.length;
  final bool anyChecked = displayCheckboxColumn && rowsChecked.isNotEmpty;
  final bool someChecked = anyChecked && !allChecked;
  final double effectiveHorizontalMargin = horizontalMargin
    ?? dataTableTheme.horizontalMargin
    ?? theme.dataTableTheme.horizontalMargin
    ?? _horizontalMargin;
  final double effectiveCheckboxHorizontalMarginStart = checkboxHorizontalMargin
    ?? dataTableTheme.checkboxHorizontalMargin
    ?? theme.dataTableTheme.checkboxHorizontalMargin
    ?? effectiveHorizontalMargin;
  final double effectiveCheckboxHorizontalMarginEnd = checkboxHorizontalMargin
    ?? dataTableTheme.checkboxHorizontalMargin
    ?? theme.dataTableTheme.checkboxHorizontalMargin
    ?? effectiveHorizontalMargin / 2.0;
  final double effectiveColumnSpacing = columnSpacing
    ?? dataTableTheme.columnSpacing
    ?? theme.dataTableTheme.columnSpacing
    ?? _columnSpacing;

  final List<TableColumnWidth> tableColumns = List<TableColumnWidth>.filled(columns.length + (displayCheckboxColumn ? 1 : 0), const _NullTableColumnWidth());
  final List<TableRow> tableRows = List<TableRow>.generate(
    rows.length + 1, // the +1 is for the header row
    (int index) {
      final bool isSelected = index > 0 && rows[index - 1].selected;
      final bool isDisabled = index > 0 && anyRowSelectable && rows[index - 1].onSelectChanged == null;
      final Set<MaterialState> states = <MaterialState>{
        if (isSelected)
          MaterialState.selected,
        if (isDisabled)
          MaterialState.disabled,
      };
      final Color? resolvedDataRowColor = index > 0 ? (rows[index - 1].color ?? effectiveDataRowColor)?.resolve(states) : null;
      final Color? resolvedHeadingRowColor = effectiveHeadingRowColor?.resolve(<MaterialState>{});
      final Color? rowColor = index > 0 ? resolvedDataRowColor : resolvedHeadingRowColor;
      final BorderSide borderSide = Divider.createBorderSide(
        context,
        width: dividerThickness
          ?? dataTableTheme.dividerThickness
          ?? theme.dataTableTheme.dividerThickness
          ?? _dividerThickness,
      );
      final Border? border = showBottomBorder
        ? Border(bottom: borderSide)
        : index == 0 ? null : Border(top: borderSide);
      return TableRow(
        key: index == 0 ? _headingRowKey : rows[index - 1].key,
        decoration: BoxDecoration(
          border: border,
          color: rowColor ?? defaultRowColor.resolve(states),
        ),
        children: List<Widget>.filled(tableColumns.length, const _NullWidget()),
      );
    },
  );

  int rowIndex;

  int displayColumnIndex = 0;
  if (displayCheckboxColumn) {
    tableColumns[0] = FixedColumnWidth(effectiveCheckboxHorizontalMarginStart + Checkbox.width + effectiveCheckboxHorizontalMarginEnd);
    tableRows[0].children[0] = _buildCheckbox(
      context: context,
      checked: someChecked ? null : allChecked,
      onRowTap: null,
      onCheckboxChanged: (bool? checked) => _handleSelectAll(checked, someChecked),
      overlayColor: null,
      tristate: true,
    );
    rowIndex = 1;
    for (final DataRow row in rows) {
      final Set<MaterialState> states = <MaterialState>{
        if (row.selected)
          MaterialState.selected,
      };
      tableRows[rowIndex].children[0] = _buildCheckbox(
        context: context,
        checked: row.selected,
        onRowTap: row.onSelectChanged == null ? null : () => row.onSelectChanged?.call(!row.selected),
        onCheckboxChanged: row.onSelectChanged,
        overlayColor: row.color ?? effectiveDataRowColor,
        rowMouseCursor: row.mouseCursor?.resolve(states) ?? dataTableTheme.dataRowCursor?.resolve(states),
        tristate: false,
      );
      rowIndex += 1;
    }
    displayColumnIndex += 1;
  }

  for (int dataColumnIndex = 0; dataColumnIndex < columns.length; dataColumnIndex += 1) {
    final DataColumn column = columns[dataColumnIndex];

    final double paddingStart = switch (dataColumnIndex) {
      0 when displayCheckboxColumn && checkboxHorizontalMargin == null => effectiveHorizontalMargin / 2.0,
      0 => effectiveHorizontalMargin,
      _ => effectiveColumnSpacing / 2.0,
    };

    final double paddingEnd;
    if (dataColumnIndex == columns.length - 1) {
      paddingEnd = effectiveHorizontalMargin;
    } else {
      paddingEnd = effectiveColumnSpacing / 2.0;
    }

    final EdgeInsetsDirectional padding = EdgeInsetsDirectional.only(
      start: paddingStart,
      end: paddingEnd,
    );
    if (dataColumnIndex == _onlyTextColumn) {
      tableColumns[displayColumnIndex] = const IntrinsicColumnWidth(flex: 1.0);
    } else {
      tableColumns[displayColumnIndex] = const IntrinsicColumnWidth();
    }
    final Set<MaterialState> headerStates = <MaterialState>{
      if (column.onSort == null)
        MaterialState.disabled,
    };
    tableRows[0].children[displayColumnIndex] = _buildHeadingCell(
      context: context,
      padding: padding,
      label: column.label,
      tooltip: column.tooltip,
      numeric: column.numeric,
      onSort: column.onSort != null ? () => column.onSort!(dataColumnIndex, sortColumnIndex != dataColumnIndex || !sortAscending) : null,
      sorted: dataColumnIndex == sortColumnIndex,
      ascending: sortAscending,
      overlayColor: effectiveHeadingRowColor,
      mouseCursor: column.mouseCursor?.resolve(headerStates) ?? dataTableTheme.headingCellCursor?.resolve(headerStates),
      headingRowAlignment: column.headingRowAlignment ?? dataTableTheme.headingRowAlignment ?? MainAxisAlignment.start,
    );
    rowIndex = 1;
    for (final DataRow row in rows) {
      final Set<MaterialState> states = <MaterialState>{
        if (row.selected)
          MaterialState.selected,
      };
      final DataCell cell = row.cells[dataColumnIndex];
      tableRows[rowIndex].children[displayColumnIndex] = _buildDataCell(
        context: context,
        padding: padding,
        label: cell.child,
        numeric: column.numeric,
        placeholder: cell.placeholder,
        showEditIcon: cell.showEditIcon,
        onTap: cell.onTap,
        onDoubleTap: cell.onDoubleTap,
        onLongPress: cell.onLongPress,
        onTapCancel: cell.onTapCancel,
        onTapDown: cell.onTapDown,
        onSelectChanged: row.onSelectChanged == null ? null : () => row.onSelectChanged?.call(!row.selected),
        overlayColor: row.color ?? effectiveDataRowColor,
        onRowLongPress: row.onLongPress,
        mouseCursor: row.mouseCursor?.resolve(states) ?? dataTableTheme.dataRowCursor?.resolve(states),
      );
      rowIndex += 1;
    }
    displayColumnIndex += 1;
  }

  return Container(
    decoration: decoration ?? dataTableTheme.decoration ?? theme.dataTableTheme.decoration,
    child: Material(
      type: MaterialType.transparency,
      borderRadius: border?.borderRadius,
      clipBehavior: clipBehavior,
      child: Table(
        columnWidths: tableColumns.asMap(),
        defaultVerticalAlignment: TableCellVerticalAlignment.middle,
        children: tableRows,
        border: border,
      ),
    ),
  );
}