WIP: controller

Author: jpnurmi

lib/src/base_spin_box.dart

@@ -23,6 +23,7 @@
 import 'package:flutter/services.dart';
 import 'package:flutter/widgets.dart';
 
+import 'spin_controller.dart';
 import 'spin_formatter.dart';
 
 // ignore_for_file: public_member_api_docs
@@ -43,98 +44,86 @@ abstract class BaseSpinBox extends StatefulWidget {
   VoidCallback? get afterChange;
   bool get readOnly;
   FocusNode? get focusNode;
+  SpinController? get controller;
 }
 
 mixin SpinBoxMixin<T extends BaseSpinBox> on State<T> {
-  late double _value;
-  late double _cachedValue;
+  late final SpinController _controller;
+  late final TextEditingController _editor;
   late final FocusNode _focusNode;
-  late final TextEditingController _controller;
 
-  double get value => _value;
-  bool get hasFocus => _focusNode.hasFocus;
+  SpinController get controller => _controller;
+  TextEditingController get editor => _editor;
   FocusNode get focusNode => _focusNode;
-  TextEditingController get controller => _controller;
-  SpinFormatter get formatter => SpinFormatter(
-      min: widget.min, max: widget.max, decimals: widget.decimals);
-
-  static double _parseValue(String text) => double.tryParse(text) ?? 0;
-  String _formatText(double value) {
-    return value.toStringAsFixed(widget.decimals).padLeft(widget.digits, '0');
-  }
+  TextInputFormatter get formatter => SpinFormatter(_controller);
 
   Map<ShortcutActivator, VoidCallback> get bindings {
     return {
       // ### TODO: use SingleActivator fixed in Flutter 2.10+
       // https://github.com/flutter/flutter/issues/92717
-      LogicalKeySet(LogicalKeyboardKey.arrowUp): _stepUp,
-      LogicalKeySet(LogicalKeyboardKey.arrowDown): _stepDown,
-      LogicalKeySet(LogicalKeyboardKey.pageUp): _pageStepUp,
-      LogicalKeySet(LogicalKeyboardKey.pageDown): _pageStepDown,
+      LogicalKeySet(LogicalKeyboardKey.arrowUp): _controller.stepUp,
+      LogicalKeySet(LogicalKeyboardKey.arrowDown): _controller.stepDown,
+      LogicalKeySet(LogicalKeyboardKey.pageUp): _controller.pageStepUp,
+      LogicalKeySet(LogicalKeyboardKey.pageDown): _controller.pageStepDown,
     };
   }
 
   @override
   void initState() {
     super.initState();
-    _value = widget.value;
-    _cachedValue = widget.value;
-    _controller = TextEditingController(text: _formatText(_value));
-    _controller.addListener(_updateValue);
+    _controller = widget.controller ??
+        SpinController(
+          min: widget.min,
+          max: widget.max,
+          step: widget.step,
+          pageStep: widget.pageStep,
+          value: widget.value,
+          decimals: widget.decimals,
+          digits: widget.digits,
+          canChange: widget.canChange,
+          beforeChange: widget.beforeChange,
+          afterChange: widget.afterChange,
+        );
+    _controller.addListener(_handleValueChange);
+    _editor = TextEditingController(text: _controller.format(widget.value));
+    _editor.addListener(_handleTextChange);
     _focusNode = widget.focusNode ?? FocusNode();
-    _focusNode.addListener(_handleFocusChanged);
+    _focusNode.addListener(_handleFocusChange);
   }
 
   @override
   void dispose() {
-    _focusNode.removeListener(_handleFocusChanged);
+    _focusNode.removeListener(_handleFocusChange);
     if (widget.focusNode == null) {
       _focusNode.dispose();
     }
-    _controller.dispose();
+    _controller.removeListener(_handleValueChange);
+    if (widget.controller == null) {
+      _controller.dispose();
+    }
+    _editor.dispose();
     super.dispose();
   }
 
-  void _stepUp() => setValue(value + widget.step);
-  void _stepDown() => setValue(value - widget.step);
-
-  void _pageStepUp() => setValue(value + widget.pageStep);
-  void _pageStepDown() => setValue(value - widget.pageStep);
-
-  void _updateValue() {
-    final v = _parseValue(_controller.text);
-    if (v == _value) return;
-
-    if (widget.canChange?.call(v) == false) {
-      controller.text = _formatText(_cachedValue);
-      setState(() {
-        _value = _cachedValue;
-      });
-      return;
-    }
-
-    setState(() => _value = v);
-    widget.onChanged?.call(v);
+  void _handleValueChange() {
+    widget.onChanged?.call(_controller.value);
+    setState(() => _updateText(_controller.value));
   }
 
-  void setValue(double v) {
-    final newValue = v.clamp(widget.min, widget.max);
-    if (newValue == value) return;
-
-    if (widget.canChange?.call(newValue) == false) return;
-
-    widget.beforeChange?.call();
-    setState(() => _updateController(value, newValue));
-    widget.afterChange?.call();
+  void _handleTextChange() {
+    final value = _controller.parse(_editor.text);
+    if (value != null && value >= controller.min && value <= controller.max) {
+      _controller.value = value;
+    }
   }
 
-  void _updateController(double oldValue, double newValue) {
-    final text = _formatText(newValue);
-    final selection = _controller.selection;
-    final oldOffset = value.isNegative ? 1 : 0;
-    final newOffset = _parseValue(text).isNegative ? 1 : 0;
+  void _updateText(double newValue) {
+    final text = _controller.format(newValue);
+    final selection = _editor.selection;
+    final oldOffset = _controller.value.isNegative ? 1 : 0;
+    final newOffset = _controller.parse(text)?.isNegative == true ? 1 : 0;
 
-    _controller.value = _controller.value.copyWith(
+    _editor.value = _editor.value.copyWith(
       text: text,
       selection: selection.copyWith(
         baseOffset: selection.baseOffset - oldOffset + newOffset,
@@ -144,37 +133,36 @@ mixin SpinBoxMixin<T extends BaseSpinBox> on State<T> {
   }
 
   @protected
-  void fixupValue(String value) {
-    final v = _parseValue(value);
-    if (value.isEmpty || (v < widget.min || v > widget.max)) {
-      // will trigger notify to _updateValue()
-      _controller.text = _formatText(_cachedValue);
-    } else {
-      _cachedValue = _value;
+  void fixupValue(String text) {
+    final v = _controller.parse(text);
+    if (v == null) {
+      _editor.text = _controller.format(_controller.value);
+    } else if (v < _controller.min || v > _controller.max) {
+      _controller.value = v.clamp(_controller.min, _controller.max);
     }
   }
 
-  void _handleFocusChanged() {
-    if (hasFocus) {
+  void _handleFocusChange() {
+    if (focusNode.hasFocus) {
       setState(_selectAll);
     } else {
-      fixupValue(_controller.text);
+      fixupValue(_editor.text);
     }
   }
 
   void _selectAll() {
-    _controller.selection = _controller.selection
-        .copyWith(baseOffset: 0, extentOffset: _controller.text.length);
+    _editor.selection = _editor.selection
+        .copyWith(baseOffset: 0, extentOffset: _editor.text.length);
   }
 
   @override
   void didUpdateWidget(T oldWidget) {
     super.didUpdateWidget(oldWidget);
     if (oldWidget.value != widget.value) {
-      _controller.removeListener(_updateValue);
-      _value = _cachedValue = widget.value;
-      _updateController(oldWidget.value, widget.value);
-      _controller.addListener(_updateValue);
+      _editor.removeListener(_handleTextChange);
+      _controller.value = widget.value;
+      _updateText(widget.value);
+      _editor.addListener(_handleTextChange);
     }
   }
 }

lib/src/cupertino/spin_box.dart

@@ -23,6 +23,7 @@
 import 'package:flutter/cupertino.dart';
 
 import '../base_spin_box.dart';
+import '../spin_controller.dart';
 import 'spin_button.dart';
 
 part 'third_party/default_rounded_border.dart';
@@ -84,6 +85,7 @@ class CupertinoSpinBox extends BaseSpinBox {
     this.beforeChange,
     this.afterChange,
     this.focusNode,
+    this.controller,
   })  : assert(min <= max),
         keyboardType = keyboardType ??
             TextInputType.numberWithOptions(
@@ -199,6 +201,10 @@ class CupertinoSpinBox extends BaseSpinBox {
   @override
   final FocusNode? focusNode;
 
+  /// Controls the spinbox.
+  @override
+  final SpinController? controller;
+
   /// Called when the user has changed the value.
   @override
   final ValueChanged<double>? onChanged;
@@ -267,7 +273,7 @@ class _CupertinoSpinBoxState extends State<CupertinoSpinBox> with SpinBoxMixin {
     final textField = CallbackShortcuts(
       bindings: bindings,
       child: CupertinoTextField(
-        controller: controller,
+        controller: editor,
         style: widget.textStyle,
         textAlign: widget.textAlign,
         keyboardType: widget.keyboardType,
@@ -315,19 +321,19 @@ class _CupertinoSpinBoxState extends State<CupertinoSpinBox> with SpinBoxMixin {
     final incrementButton = CupertinoSpinButton(
       step: widget.step,
       icon: widget.incrementIcon,
-      enabled: widget.enabled && value < widget.max,
+      enabled: widget.enabled && controller.value < controller.max,
       interval: widget.interval,
       acceleration: widget.acceleration,
-      onStep: (step) => setValue(value + step),
+      onStep: (step) => controller.value += step,
     );
 
     final decrementButton = CupertinoSpinButton(
       step: widget.step,
       icon: widget.decrementIcon,
-      enabled: widget.enabled && value > widget.min,
+      enabled: widget.enabled && controller.value > controller.min,
       interval: widget.interval,
       acceleration: widget.acceleration,
-      onStep: (step) => setValue(value - step),
+      onStep: (step) => controller.value -= step,
     );
 
     if (isHorizontal) {

lib/src/material/spin_box.dart

@@ -25,6 +25,7 @@ import 'dart:math';
 import 'package:flutter/material.dart';
 
 import '../base_spin_box.dart';
+import '../spin_controller.dart';
 import 'spin_box_theme.dart';
 import 'spin_button.dart';
 
@@ -85,6 +86,7 @@ class SpinBox extends BaseSpinBox {
     this.beforeChange,
     this.afterChange,
     this.focusNode,
+    this.controller,
   })  : assert(min <= max),
         keyboardType = keyboardType ??
             TextInputType.numberWithOptions(
@@ -197,6 +199,10 @@ class SpinBox extends BaseSpinBox {
   @override
   final FocusNode? focusNode;
 
+  /// Controls the spinbox.
+  @override
+  final SpinController? controller;
+
   /// Called when the user has changed the value.
   @override
   final ValueChanged<double>? onChanged;
@@ -262,7 +268,7 @@ class SpinBox extends BaseSpinBox {
 
 class _SpinBoxState extends State<SpinBox> with SpinBoxMixin {
   Color _activeColor(ThemeData theme) {
-    if (hasFocus) {
+    if (focusNode.hasFocus) {
       switch (theme.brightness) {
         case Brightness.dark:
           return theme.colorScheme.secondary;
@@ -275,7 +281,7 @@ class _SpinBoxState extends State<SpinBox> with SpinBoxMixin {
 
   Color? _iconColor(ThemeData theme, String? errorText) {
     if (!widget.enabled) return theme.disabledColor;
-    if (hasFocus && errorText == null) return _activeColor(theme);
+    if (focusNode.hasFocus && errorText == null) return _activeColor(theme);
 
     switch (theme.brightness) {
       case Brightness.dark:
@@ -308,23 +314,27 @@ class _SpinBoxState extends State<SpinBox> with SpinBoxMixin {
         .applyDefaults(theme.inputDecorationTheme);
 
     final errorText =
-        decoration.errorText ?? widget.validator?.call(controller.text);
+        decoration.errorText ?? widget.validator?.call(editor.text);
 
     final iconColor = widget.iconColor ??
         spinBoxTheme?.iconColor ??
         MaterialStateProperty.all(_iconColor(theme, errorText));
 
     final states = <MaterialState>{
       if (!widget.enabled) MaterialState.disabled,
-      if (hasFocus) MaterialState.focused,
+      if (focusNode.hasFocus) MaterialState.focused,
       if (errorText != null) MaterialState.error,
     };
 
     final decrementStates = Set<MaterialState>.of(states);
-    if (value <= widget.min) decrementStates.add(MaterialState.disabled);
+    if (controller.value <= controller.min) {
+      decrementStates.add(MaterialState.disabled);
+    }
 
     final incrementStates = Set<MaterialState>.of(states);
-    if (value >= widget.max) incrementStates.add(MaterialState.disabled);
+    if (controller.value >= controller.max) {
+      incrementStates.add(MaterialState.disabled);
+    }
 
     var bottom = 0.0;
     final isHorizontal = widget.direction == Axis.horizontal;
@@ -385,7 +395,7 @@ class _SpinBoxState extends State<SpinBox> with SpinBoxMixin {
     final textField = CallbackShortcuts(
       bindings: bindings,
       child: TextField(
-        controller: controller,
+        controller: editor,
         style: widget.textStyle,
         textAlign: widget.textAlign,
         textDirection: widget.textDirection,
@@ -410,10 +420,10 @@ class _SpinBoxState extends State<SpinBox> with SpinBoxMixin {
       step: widget.step,
       color: iconColor.resolve(incrementStates),
       icon: widget.incrementIcon,
-      enabled: widget.enabled && value < widget.max,
+      enabled: widget.enabled && controller.value < controller.max,
       interval: widget.interval,
       acceleration: widget.acceleration,
-      onStep: (step) => setValue(value + step),
+      onStep: (step) => controller.value += step,
     );
 
     if (!widget.showButtons) return textField;
@@ -422,10 +432,10 @@ class _SpinBoxState extends State<SpinBox> with SpinBoxMixin {
       step: widget.step,
       color: iconColor.resolve(decrementStates),
       icon: widget.decrementIcon,
-      enabled: widget.enabled && value > widget.min,
+      enabled: widget.enabled && controller.value > controller.min,
       interval: widget.interval,
       acceleration: widget.acceleration,
-      onStep: (step) => setValue(value - step),
+      onStep: (step) => controller.value -= step,
     );
 
     if (isHorizontal) {