button_style_button.dart 20.2 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25
// Copyright 2014 The Flutter 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;

import 'package:flutter/foundation.dart';
import 'package:flutter/rendering.dart';
import 'package:flutter/widgets.dart';

import 'button_style.dart';
import 'colors.dart';
import 'constants.dart';
import 'ink_well.dart';
import 'material.dart';
import 'material_state.dart';
import 'theme_data.dart';

/// The base [StatefulWidget] class for buttons whose style is defined by a [ButtonStyle] object.
///
/// Concrete subclasses must override [defaultStyleOf] and [themeStyleOf].
///
/// See also:
///
///  * [TextButton], a simple ButtonStyleButton without a shadow.
26
///  * [ElevatedButton], a filled ButtonStyleButton whose material elevates when pressed.
27 28
///  * [OutlinedButton], similar to [TextButton], but with an outline.
abstract class ButtonStyleButton extends StatefulWidget {
29 30
  /// Abstract const constructor. This constructor enables subclasses to provide
  /// const constructors so that they can be used in const expressions.
31
  const ButtonStyleButton({
32
    super.key,
33 34
    required this.onPressed,
    required this.onLongPress,
35 36
    required this.onHover,
    required this.onFocusChange,
37 38 39 40
    required this.style,
    required this.focusNode,
    required this.autofocus,
    required this.clipBehavior,
41
    this.statesController,
42
    required this.child,
43
  }) : assert(autofocus != null),
44
       assert(clipBehavior != null);
45 46 47 48 49 50 51 52

  /// Called when the button is tapped or otherwise activated.
  ///
  /// If this callback and [onLongPress] are null, then the button will be disabled.
  ///
  /// See also:
  ///
  ///  * [enabled], which is true if the button is enabled.
53
  final VoidCallback? onPressed;
54 55 56 57 58 59 60 61

  /// Called when the button is long-pressed.
  ///
  /// If this callback and [onPressed] are null, then the button will be disabled.
  ///
  /// See also:
  ///
  ///  * [enabled], which is true if the button is enabled.
62
  final VoidCallback? onLongPress;
63

64 65 66 67 68 69 70 71 72 73 74 75 76
  /// Called when a pointer enters or exits the button response area.
  ///
  /// The value passed to the callback is true if a pointer has entered this
  /// part of the material and false if a pointer has exited this part of the
  /// material.
  final ValueChanged<bool>? onHover;

  /// Handler called when the focus changes.
  ///
  /// Called with true if this widget's node gains focus, and false if it loses
  /// focus.
  final ValueChanged<bool>? onFocusChange;

77 78 79 80 81 82 83 84
  /// Customizes this button's appearance.
  ///
  /// Non-null properties of this style override the corresponding
  /// properties in [themeStyleOf] and [defaultStyleOf]. [MaterialStateProperty]s
  /// that resolve to non-null values will similarly override the corresponding
  /// [MaterialStateProperty]s in [themeStyleOf] and [defaultStyleOf].
  ///
  /// Null by default.
85
  final ButtonStyle? style;
86

87
  /// {@macro flutter.material.Material.clipBehavior}
88 89 90 91 92
  ///
  /// Defaults to [Clip.none], and must not be null.
  final Clip clipBehavior;

  /// {@macro flutter.widgets.Focus.focusNode}
93
  final FocusNode? focusNode;
94 95 96 97

  /// {@macro flutter.widgets.Focus.autofocus}
  final bool autofocus;

98 99 100
  /// {@macro flutter.material.inkwell.statesController}
  final MaterialStatesController? statesController;

101
  /// Typically the button's label.
102
  final Widget? child;
103 104 105 106

  /// Returns a non-null [ButtonStyle] that's based primarily on the [Theme]'s
  /// [ThemeData.textTheme] and [ThemeData.colorScheme].
  ///
107
  /// The returned style can be overridden by the [style] parameter and
108
  /// by the style returned by [themeStyleOf]. For example the default
109
  /// style of the [TextButton] subclass can be overridden with its
110 111 112 113 114 115 116 117 118 119 120 121 122 123 124
  /// [TextButton.style] constructor parameter, or with a
  /// [TextButtonTheme].
  ///
  /// Concrete button subclasses should return a ButtonStyle that
  /// has no null properties, and where all of the [MaterialStateProperty]
  /// properties resolve to non-null values.
  ///
  /// See also:
  ///
  ///  * [themeStyleOf], Returns the ButtonStyle of this button's component theme.
  @protected
  ButtonStyle defaultStyleOf(BuildContext context);

  /// Returns the ButtonStyle that belongs to the button's component theme.
  ///
125
  /// The returned style can be overridden by the [style] parameter.
126 127 128 129 130 131 132 133 134
  ///
  /// Concrete button subclasses should return the ButtonStyle for the
  /// nearest subclass-specific inherited theme, and if no such theme
  /// exists, then the same value from the overall [Theme].
  ///
  /// See also:
  ///
  ///  * [defaultStyleOf], Returns the default [ButtonStyle] for this button.
  @protected
135
  ButtonStyle? themeStyleOf(BuildContext context);
136 137 138 139 140 141 142 143

  /// Whether the button is enabled or disabled.
  ///
  /// Buttons are disabled by default. To enable a button, set its [onPressed]
  /// or [onLongPress] properties to a non-null value.
  bool get enabled => onPressed != null || onLongPress != null;

  @override
144
  State<ButtonStyleButton> createState() => _ButtonStyleState();
145 146 147 148 149 150 151 152 153

  @override
  void debugFillProperties(DiagnosticPropertiesBuilder properties) {
    super.debugFillProperties(properties);
    properties.add(FlagProperty('enabled', value: enabled, ifFalse: 'disabled'));
    properties.add(DiagnosticsProperty<ButtonStyle>('style', style, defaultValue: null));
    properties.add(DiagnosticsProperty<FocusNode>('focusNode', focusNode, defaultValue: null));
  }

154
  /// Returns null if [value] is null, otherwise `MaterialStatePropertyAll<T>(value)`.
155 156
  ///
  /// A convenience method for subclasses.
157
  static MaterialStateProperty<T>? allOrNull<T>(T? value) => value == null ? null : MaterialStatePropertyAll<T>(value);
158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182

  /// Returns an interpolated value based on the [textScaleFactor] parameter:
  ///
  ///  * 0 - 1 [geometry1x]
  ///  * 1 - 2 lerp([geometry1x], [geometry2x], [textScaleFactor] - 1)
  ///  * 2 - 3 lerp([geometry2x], [geometry3x], [textScaleFactor] - 2)
  ///  * otherwise [geometry3x]
  ///
  /// A convenience method for subclasses.
  static EdgeInsetsGeometry scaledPadding(
    EdgeInsetsGeometry geometry1x,
    EdgeInsetsGeometry geometry2x,
    EdgeInsetsGeometry geometry3x,
    double textScaleFactor,
  ) {
    assert(geometry1x != null);
    assert(geometry2x != null);
    assert(geometry3x != null);
    assert(textScaleFactor != null);

    if (textScaleFactor <= 1) {
      return geometry1x;
    } else if (textScaleFactor >= 3) {
      return geometry3x;
    } else if (textScaleFactor <= 2) {
183
      return EdgeInsetsGeometry.lerp(geometry1x, geometry2x, textScaleFactor - 1)!;
184
    }
185
    return EdgeInsetsGeometry.lerp(geometry2x, geometry3x, textScaleFactor - 2)!;
186 187 188 189 190 191 192 193 194
  }
}

/// The base [State] class for buttons whose style is defined by a [ButtonStyle] object.
///
/// See also:
///
///  * [ButtonStyleButton], the [StatefulWidget] subclass for which this class is the [State].
///  * [TextButton], a simple button without a shadow.
195
///  * [ElevatedButton], a filled button whose material elevates when pressed.
196
///  * [OutlinedButton], similar to [TextButton], but with an outline.
197 198 199 200 201 202 203 204 205 206
class _ButtonStyleState extends State<ButtonStyleButton> with TickerProviderStateMixin {
  AnimationController? controller;
  double? elevation;
  Color? backgroundColor;
  MaterialStatesController? internalStatesController;

  void handleStatesControllerChange() {
    // Force a rebuild to resolve MaterialStateProperty properties
    setState(() { });
  }
207

208 209 210 211 212 213 214 215
  MaterialStatesController get statesController => widget.statesController ?? internalStatesController!;

  void initStatesController() {
    if (widget.statesController == null) {
      internalStatesController = MaterialStatesController();
    }
    statesController.update(MaterialState.disabled, !widget.enabled);
    statesController.addListener(handleStatesControllerChange);
216 217
  }

218
  @override
219 220 221
  void initState() {
    super.initState();
    initStatesController();
222 223
  }

224 225 226
  @override
  void didUpdateWidget(ButtonStyleButton oldWidget) {
    super.didUpdateWidget(oldWidget);
227 228 229 230 231 232 233 234 235 236 237 238 239 240
    if (widget.statesController != oldWidget.statesController) {
      oldWidget.statesController?.removeListener(handleStatesControllerChange);
      if (widget.statesController != null) {
        internalStatesController?.dispose();
        internalStatesController = null;
      }
      initStatesController();
    }
    if (widget.enabled != oldWidget.enabled) {
      statesController.update(MaterialState.disabled, !widget.enabled);
      if (!widget.enabled) {
        // The button may have been disabled while a press gesture is currently underway.
        statesController.update(MaterialState.pressed, false);
      }
241 242 243
    }
  }

244 245 246 247 248 249 250 251
  @override
  void dispose() {
    statesController.removeListener(handleStatesControllerChange);
    internalStatesController?.dispose();
    controller?.dispose();
    super.dispose();
  }

252 253
  @override
  Widget build(BuildContext context) {
254 255
    final ButtonStyle? widgetStyle = widget.style;
    final ButtonStyle? themeStyle = widget.themeStyleOf(context);
256 257 258
    final ButtonStyle defaultStyle = widget.defaultStyleOf(context);
    assert(defaultStyle != null);

259 260 261 262
    T? effectiveValue<T>(T? Function(ButtonStyle? style) getProperty) {
      final T? widgetValue  = getProperty(widgetStyle);
      final T? themeValue   = getProperty(themeStyle);
      final T? defaultValue = getProperty(defaultStyle);
263 264 265
      return widgetValue ?? themeValue ?? defaultValue;
    }

266
    T? resolve<T>(MaterialStateProperty<T>? Function(ButtonStyle? style) getProperty) {
267
      return effectiveValue(
268 269 270
        (ButtonStyle? style) {
          return getProperty(style)?.resolve(statesController.value);
        },
271 272 273
      );
    }

274 275 276 277 278
    final double? resolvedElevation = resolve<double?>((ButtonStyle? style) => style?.elevation);
    final TextStyle? resolvedTextStyle = resolve<TextStyle?>((ButtonStyle? style) => style?.textStyle);
    Color? resolvedBackgroundColor = resolve<Color?>((ButtonStyle? style) => style?.backgroundColor);
    final Color? resolvedForegroundColor = resolve<Color?>((ButtonStyle? style) => style?.foregroundColor);
    final Color? resolvedShadowColor = resolve<Color?>((ButtonStyle? style) => style?.shadowColor);
279
    final Color? resolvedSurfaceTintColor = resolve<Color?>((ButtonStyle? style) => style?.surfaceTintColor);
280 281
    final EdgeInsetsGeometry? resolvedPadding = resolve<EdgeInsetsGeometry?>((ButtonStyle? style) => style?.padding);
    final Size? resolvedMinimumSize = resolve<Size?>((ButtonStyle? style) => style?.minimumSize);
282
    final Size? resolvedFixedSize = resolve<Size?>((ButtonStyle? style) => style?.fixedSize);
283
    final Size? resolvedMaximumSize = resolve<Size?>((ButtonStyle? style) => style?.maximumSize);
284 285
    final BorderSide? resolvedSide = resolve<BorderSide?>((ButtonStyle? style) => style?.side);
    final OutlinedBorder? resolvedShape = resolve<OutlinedBorder?>((ButtonStyle? style) => style?.shape);
286

287
    final MaterialStateMouseCursor mouseCursor = _MouseCursor(
288
      (Set<MaterialState> states) => effectiveValue((ButtonStyle? style) => style?.mouseCursor?.resolve(states)),
289 290
    );

291
    final MaterialStateProperty<Color?> overlayColor = MaterialStateProperty.resolveWith<Color?>(
292
      (Set<MaterialState> states) => effectiveValue((ButtonStyle? style) => style?.overlayColor?.resolve(states)),
293 294
    );

295 296 297 298
    final VisualDensity? resolvedVisualDensity = effectiveValue((ButtonStyle? style) => style?.visualDensity);
    final MaterialTapTargetSize? resolvedTapTargetSize = effectiveValue((ButtonStyle? style) => style?.tapTargetSize);
    final Duration? resolvedAnimationDuration = effectiveValue((ButtonStyle? style) => style?.animationDuration);
    final bool? resolvedEnableFeedback = effectiveValue((ButtonStyle? style) => style?.enableFeedback);
299
    final AlignmentGeometry? resolvedAlignment = effectiveValue((ButtonStyle? style) => style?.alignment);
300
    final Offset densityAdjustment = resolvedVisualDensity!.baseSizeAdjustment;
301
    final InteractiveInkFeatureFactory? resolvedSplashFactory = effectiveValue((ButtonStyle? style) => style?.splashFactory);
302 303

    BoxConstraints effectiveConstraints = resolvedVisualDensity.effectiveConstraints(
304
      BoxConstraints(
305
        minWidth: resolvedMinimumSize!.width,
306
        minHeight: resolvedMinimumSize.height,
307 308
        maxWidth: resolvedMaximumSize!.width,
        maxHeight: resolvedMaximumSize.height,
309 310
      ),
    );
311 312 313 314 315 316 317 318 319 320 321
    if (resolvedFixedSize != null) {
      final Size size = effectiveConstraints.constrain(resolvedFixedSize);
      if (size.width.isFinite) {
        effectiveConstraints = effectiveConstraints.copyWith(
          minWidth: size.width,
          maxWidth: size.width,
        );
      }
      if (size.height.isFinite) {
        effectiveConstraints = effectiveConstraints.copyWith(
          minHeight: size.height,
322
          maxHeight: size.height,
323 324 325 326
        );
      }
    }

327 328 329 330 331 332 333 334
    // Per the Material Design team: don't allow the VisualDensity
    // adjustment to reduce the width of the left/right padding. If we
    // did, VisualDensity.compact, the default for desktop/web, would
    // reduce the horizontal padding to zero.
    final double dy = densityAdjustment.dy;
    final double dx = math.max(0, densityAdjustment.dx);
    final EdgeInsetsGeometry padding = resolvedPadding!
      .add(EdgeInsets.fromLTRB(dx, dy, dx, dy))
335
      .clamp(EdgeInsets.zero, EdgeInsetsGeometry.infinity); // ignore_clamp_double_lint
336

337 338 339 340
    // If an opaque button's background is becoming translucent while its
    // elevation is changing, change the elevation first. Material implicitly
    // animates its elevation but not its color. SKIA renders non-zero
    // elevations as a shadow colored fill behind the Material's background.
341
    if (resolvedAnimationDuration! > Duration.zero
342 343 344 345 346
        && elevation != null
        && backgroundColor != null
        && elevation != resolvedElevation
        && backgroundColor!.value != resolvedBackgroundColor!.value
        && backgroundColor!.opacity == 1
347 348
        && resolvedBackgroundColor.opacity < 1
        && resolvedElevation == 0) {
349 350 351
      if (controller?.duration != resolvedAnimationDuration) {
        controller?.dispose();
        controller = AnimationController(
352 353 354 355 356 357 358 359 360
          duration: resolvedAnimationDuration,
          vsync: this,
        )
        ..addStatusListener((AnimationStatus status) {
          if (status == AnimationStatus.completed) {
            setState(() { }); // Rebuild with the final background color.
          }
        });
      }
361 362 363
      resolvedBackgroundColor = backgroundColor; // Defer changing the background color.
      controller!.value = 0;
      controller!.forward();
364
    }
365 366
    elevation = resolvedElevation;
    backgroundColor = resolvedBackgroundColor;
367

368 369 370
    final Widget result = ConstrainedBox(
      constraints: effectiveConstraints,
      child: Material(
371
        elevation: resolvedElevation!,
372
        textStyle: resolvedTextStyle?.copyWith(color: resolvedForegroundColor),
373
        shape: resolvedShape!.copyWith(side: resolvedSide),
374 375
        color: resolvedBackgroundColor,
        shadowColor: resolvedShadowColor,
376
        surfaceTintColor: resolvedSurfaceTintColor,
377 378 379 380 381 382
        type: resolvedBackgroundColor == null ? MaterialType.transparency : MaterialType.button,
        animationDuration: resolvedAnimationDuration,
        clipBehavior: widget.clipBehavior,
        child: InkWell(
          onTap: widget.onPressed,
          onLongPress: widget.onLongPress,
383 384
          onHover: widget.onHover,
          mouseCursor: mouseCursor,
385 386 387
          enableFeedback: resolvedEnableFeedback,
          focusNode: widget.focusNode,
          canRequestFocus: widget.enabled,
388
          onFocusChange: widget.onFocusChange,
389
          autofocus: widget.autofocus,
390
          splashFactory: resolvedSplashFactory,
391 392 393
          overlayColor: overlayColor,
          highlightColor: Colors.transparent,
          customBorder: resolvedShape,
394
          statesController: statesController,
395 396 397 398
          child: IconTheme.merge(
            data: IconThemeData(color: resolvedForegroundColor),
            child: Padding(
              padding: padding,
399 400
              child: Align(
                alignment: resolvedAlignment!,
401 402 403 404 405 406 407 408 409 410
                widthFactor: 1.0,
                heightFactor: 1.0,
                child: widget.child,
              ),
            ),
          ),
        ),
      ),
    );

411
    final Size minSize;
412
    switch (resolvedTapTargetSize!) {
413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440
      case MaterialTapTargetSize.padded:
        minSize = Size(
          kMinInteractiveDimension + densityAdjustment.dx,
          kMinInteractiveDimension + densityAdjustment.dy,
        );
        assert(minSize.width >= 0.0);
        assert(minSize.height >= 0.0);
        break;
      case MaterialTapTargetSize.shrinkWrap:
        minSize = Size.zero;
        break;
    }

    return Semantics(
      container: true,
      button: true,
      enabled: widget.enabled,
      child: _InputPadding(
        minSize: minSize,
        child: result,
      ),
    );
  }
}

class _MouseCursor extends MaterialStateMouseCursor {
  const _MouseCursor(this.resolveCallback);

441
  final MaterialPropertyResolver<MouseCursor?> resolveCallback;
442 443

  @override
444
  MouseCursor resolve(Set<MaterialState> states) => resolveCallback(states)!;
445 446 447 448 449

  @override
  String get debugDescription => 'ButtonStyleButton_MouseCursor';
}

450
/// A widget to pad the area around a [ButtonStyleButton]'s inner [Material].
451 452 453 454 455 456
///
/// Redirect taps that occur in the padded area around the child to the center
/// of the child. This increases the size of the button and the button's
/// "tap target", but not its material or its ink splashes.
class _InputPadding extends SingleChildRenderObjectWidget {
  const _InputPadding({
457
    super.child,
458
    required this.minSize,
459
  });
460 461 462 463 464 465 466 467 468 469 470 471 472 473 474

  final Size minSize;

  @override
  RenderObject createRenderObject(BuildContext context) {
    return _RenderInputPadding(minSize);
  }

  @override
  void updateRenderObject(BuildContext context, covariant _RenderInputPadding renderObject) {
    renderObject.minSize = minSize;
  }
}

class _RenderInputPadding extends RenderShiftedBox {
475
  _RenderInputPadding(this._minSize, [RenderBox? child]) : super(child);
476 477 478 479

  Size get minSize => _minSize;
  Size _minSize;
  set minSize(Size value) {
480
    if (_minSize == value) {
481
      return;
482
    }
483 484 485 486 487 488
    _minSize = value;
    markNeedsLayout();
  }

  @override
  double computeMinIntrinsicWidth(double height) {
489
    if (child != null) {
490
      return math.max(child!.getMinIntrinsicWidth(height), minSize.width);
491
    }
492 493 494 495 496
    return 0.0;
  }

  @override
  double computeMinIntrinsicHeight(double width) {
497
    if (child != null) {
498
      return math.max(child!.getMinIntrinsicHeight(width), minSize.height);
499
    }
500 501 502 503 504
    return 0.0;
  }

  @override
  double computeMaxIntrinsicWidth(double height) {
505
    if (child != null) {
506
      return math.max(child!.getMaxIntrinsicWidth(height), minSize.width);
507
    }
508 509 510 511 512
    return 0.0;
  }

  @override
  double computeMaxIntrinsicHeight(double width) {
513
    if (child != null) {
514
      return math.max(child!.getMaxIntrinsicHeight(width), minSize.height);
515
    }
516 517 518
    return 0.0;
  }

519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536
  Size _computeSize({required BoxConstraints constraints, required ChildLayouter layoutChild}) {
    if (child != null) {
      final Size childSize = layoutChild(child!, constraints);
      final double height = math.max(childSize.width, minSize.width);
      final double width = math.max(childSize.height, minSize.height);
      return constraints.constrain(Size(height, width));
    }
    return Size.zero;
  }

  @override
  Size computeDryLayout(BoxConstraints constraints) {
    return _computeSize(
      constraints: constraints,
      layoutChild: ChildLayoutHelper.dryLayoutChild,
    );
  }

537 538
  @override
  void performLayout() {
539 540 541 542
    size = _computeSize(
      constraints: constraints,
      layoutChild: ChildLayoutHelper.layoutChild,
    );
543
    if (child != null) {
544
      final BoxParentData childParentData = child!.parentData! as BoxParentData;
545
      childParentData.offset = Alignment.center.alongOffset(size - child!.size as Offset);
546 547 548 549
    }
  }

  @override
550
  bool hitTest(BoxHitTestResult result, { required Offset position }) {
551 552 553
    if (super.hitTest(result, position: position)) {
      return true;
    }
554
    final Offset center = child!.size.center(Offset.zero);
555 556 557
    return result.addWithRawTransform(
      transform: MatrixUtils.forceToPoint(center),
      position: center,
558
      hitTest: (BoxHitTestResult result, Offset position) {
559
        assert(position == center);
560
        return child!.hitTest(result, position: center);
561 562 563 564
      },
    );
  }
}