packages/flutter/lib/src/cupertino/text_form_field_row.dart - external/github.com/flutter/flutter - Git at Google

 // 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 'package:flutter/services.dart';
 import 'package:flutter/widgets.dart';

 import 'colors.dart';
 import 'form_row.dart';
 import 'text_field.dart';

 /// Creates a [CupertinoFormRow] containing a [FormField] that wraps
 /// a [CupertinoTextField].
 ///
 /// A [Form] ancestor is not required. The [Form] simply makes it easier to
 /// save, reset, or validate multiple fields at once. To use without a [Form],
 /// pass a [GlobalKey] to the constructor and use [GlobalKey.currentState] to
 /// save or reset the form field.
 ///
 /// When a [controller] is specified, its [TextEditingController.text]
 /// defines the [initialValue]. If this [FormField] is part of a scrolling
 /// container that lazily constructs its children, like a [ListView] or a
 /// [CustomScrollView], then a [controller] should be specified.
 /// The controller's lifetime should be managed by a stateful widget ancestor
 /// of the scrolling container.
 ///
 /// The [prefix] parameter is displayed at the start of the row. Standard iOS
 /// guidelines encourage passing a [Text] widget to [prefix] to detail the
 /// nature of the input.
 ///
 /// The [padding] parameter is used to pad the contents of the row. It is
 /// directly passed to [CupertinoFormRow]. If the [padding]
 /// parameter is null, [CupertinoFormRow] constructs its own default
 /// padding (which is the standard form row padding in iOS.) If no edge
 /// insets are intended, explicitly pass [EdgeInsets.zero] to [padding].
 ///
 /// If a [controller] is not specified, [initialValue] can be used to give
 /// the automatically generated controller an initial value.
 ///
 /// Consider calling [TextEditingController.dispose] of the [controller], if one
 /// is specified, when it is no longer needed. This will ensure we discard any
 /// resources used by the object.
 ///
 /// For documentation about the various parameters, see the
 /// [CupertinoTextField] class and [new CupertinoTextField.borderless],
 /// the constructor.
 ///
 /// {@tool snippet}
 ///
 /// Creates a [CupertinoTextFormFieldRow] with a leading text and validator
 /// function.
 ///
 /// If the user enters valid text, the CupertinoTextField appears normally
 /// without any warnings to the user.
 ///
 /// If the user enters invalid text, the error message returned from the
 /// validator function is displayed in dark red underneath the input.
 ///
 /// ```dart
 /// CupertinoTextFormFieldRow(
 ///   prefix: const Text('Username'),
 ///   onSaved: (String? value) {
 ///     // This optional block of code can be used to run
 ///     // code when the user saves the form.
 ///   },
 ///   validator: (String? value) {
 ///     return (value != null && value.contains('@')) ? 'Do not use the @ char.' : null;
 ///   },
 /// )
 /// ```
 /// {@end-tool}
 ///
 /// {@tool dartpad}
 /// This example shows how to move the focus to the next field when the user
 /// presses the SPACE key.
 ///
 /// ** See code in examples/api/lib/cupertino/text_form_field_row/cupertino_text_form_field_row.1.dart **
 /// {@end-tool}
 class CupertinoTextFormFieldRow extends FormField<String> {
   /// Creates a [CupertinoFormRow] containing a [FormField] that wraps
   /// a [CupertinoTextField].
   ///
   /// When a [controller] is specified, [initialValue] must be null (the
   /// default). If [controller] is null, then a [TextEditingController]
   /// will be constructed automatically and its `text` will be initialized
   /// to [initialValue] or the empty string.
   ///
   /// The [prefix] parameter is displayed at the start of the row. Standard iOS
   /// guidelines encourage passing a [Text] widget to [prefix] to detail the
   /// nature of the input.
   ///
   /// The [padding] parameter is used to pad the contents of the row. It is
   /// directly passed to [CupertinoFormRow]. If the [padding]
   /// parameter is null, [CupertinoFormRow] constructs its own default
   /// padding (which is the standard form row padding in iOS.) If no edge
   /// insets are intended, explicitly pass [EdgeInsets.zero] to [padding].
   ///
   /// For documentation about the various parameters, see the
   /// [CupertinoTextField] class and [new CupertinoTextField.borderless],
   /// the constructor.
   CupertinoTextFormFieldRow({
     Key? key,
     this.prefix,
     this.padding,
     this.controller,
     String? initialValue,
     FocusNode? focusNode,
     BoxDecoration? decoration,
     TextInputType? keyboardType,
     TextCapitalization textCapitalization = TextCapitalization.none,
     TextInputAction? textInputAction,
     TextStyle? style,
     StrutStyle? strutStyle,
     TextDirection? textDirection,
     TextAlign textAlign = TextAlign.start,
     TextAlignVertical? textAlignVertical,
     bool autofocus = false,
     bool readOnly = false,
     ToolbarOptions? toolbarOptions,
     bool? showCursor,
     String obscuringCharacter = '•',
     bool obscureText = false,
     bool autocorrect = true,
     SmartDashesType? smartDashesType,
     SmartQuotesType? smartQuotesType,
     bool enableSuggestions = true,
     int? maxLines = 1,
     int? minLines,
     bool expands = false,
     int? maxLength,
     ValueChanged<String>? onChanged,
     GestureTapCallback? onTap,
     VoidCallback? onEditingComplete,
     ValueChanged<String>? onFieldSubmitted,
     FormFieldSetter<String>? onSaved,
     FormFieldValidator<String>? validator,
     List<TextInputFormatter>? inputFormatters,
     bool? enabled,
     double cursorWidth = 2.0,
     double? cursorHeight,
     Color? cursorColor,
     Brightness? keyboardAppearance,
     EdgeInsets scrollPadding = const EdgeInsets.all(20.0),
     bool enableInteractiveSelection = true,
     TextSelectionControls? selectionControls,
     ScrollPhysics? scrollPhysics,
     Iterable<String>? autofillHints,
     AutovalidateMode autovalidateMode = AutovalidateMode.disabled,
     String? placeholder,
     TextStyle? placeholderStyle = const TextStyle(
       fontWeight: FontWeight.w400,
       color: CupertinoColors.placeholderText,
     ),
   })  : assert(initialValue == null || controller == null),
         assert(textAlign != null),
         assert(autofocus != null),
         assert(readOnly != null),
         assert(obscuringCharacter != null && obscuringCharacter.length == 1),
         assert(obscureText != null),
         assert(autocorrect != null),
         assert(enableSuggestions != null),
         assert(scrollPadding != null),
         assert(maxLines == null || maxLines > 0),
         assert(minLines == null || minLines > 0),
         assert(
           (maxLines == null) || (minLines == null) || (maxLines >= minLines),
           "minLines can't be greater than maxLines",
         ),
         assert(expands != null),
         assert(
           !expands || (maxLines == null && minLines == null),
           'minLines and maxLines must be null when expands is true.',
         ),
         assert(!obscureText || maxLines == 1, 'Obscured fields cannot be multiline.'),
         assert(maxLength == null || maxLength > 0),
         assert(enableInteractiveSelection != null),
         super(
           key: key,
           initialValue: controller?.text ?? initialValue ?? '',
           onSaved: onSaved,
           validator: validator,
           autovalidateMode: autovalidateMode,
           builder: (FormFieldState<String> field) {
             final _CupertinoTextFormFieldRowState state =
                 field as _CupertinoTextFormFieldRowState;

             void onChangedHandler(String value) {
               field.didChange(value);
               if (onChanged != null) {
                 onChanged(value);
               }
             }

             return CupertinoFormRow(
               prefix: prefix,
               padding: padding,
               error: (field.errorText == null) ? null : Text(field.errorText!),
               child: CupertinoTextField.borderless(
                 controller: state._effectiveController,
                 focusNode: focusNode,
                 keyboardType: keyboardType,
                 decoration: decoration,
                 textInputAction: textInputAction,
                 style: style,
                 strutStyle: strutStyle,
                 textAlign: textAlign,
                 textAlignVertical: textAlignVertical,
                 textCapitalization: textCapitalization,
                 textDirection: textDirection,
                 autofocus: autofocus,
                 toolbarOptions: toolbarOptions,
                 readOnly: readOnly,
                 showCursor: showCursor,
                 obscuringCharacter: obscuringCharacter,
                 obscureText: obscureText,
                 autocorrect: autocorrect,
                 smartDashesType: smartDashesType,
                 smartQuotesType: smartQuotesType,
                 enableSuggestions: enableSuggestions,
                 maxLines: maxLines,
                 minLines: minLines,
                 expands: expands,
                 maxLength: maxLength,
                 onChanged: onChangedHandler,
                 onTap: onTap,
                 onEditingComplete: onEditingComplete,
                 onSubmitted: onFieldSubmitted,
                 inputFormatters: inputFormatters,
                 enabled: enabled,
                 cursorWidth: cursorWidth,
                 cursorHeight: cursorHeight,
                 cursorColor: cursorColor,
                 scrollPadding: scrollPadding,
                 scrollPhysics: scrollPhysics,
                 keyboardAppearance: keyboardAppearance,
                 enableInteractiveSelection: enableInteractiveSelection,
                 selectionControls: selectionControls,
                 autofillHints: autofillHints,
                 placeholder: placeholder,
                 placeholderStyle: placeholderStyle,
               ),
             );
           },
         );

   /// A widget that is displayed at the start of the row.
   ///
   /// The [prefix] widget is displayed at the start of the row. Standard iOS
   /// guidelines encourage passing a [Text] widget to [prefix] to detail the
   /// nature of the input.
   final Widget? prefix;

   /// Content padding for the row.
   ///
   /// The [padding] widget is passed to [CupertinoFormRow]. If the [padding]
   /// parameter is null, [CupertinoFormRow] constructs its own default
   /// padding, which is the standard form row padding in iOS.
   ///
   /// If no edge insets are intended, explicitly pass [EdgeInsets.zero] to
   /// [padding].
   final EdgeInsetsGeometry? padding;

   /// Controls the text being edited.
   ///
   /// If null, this widget will create its own [TextEditingController] and
   /// initialize its [TextEditingController.text] with [initialValue].
   final TextEditingController? controller;

   @override
   FormFieldState<String> createState() => _CupertinoTextFormFieldRowState();
 }

 class _CupertinoTextFormFieldRowState extends FormFieldState<String> {
   TextEditingController? _controller;

   TextEditingController? get _effectiveController =>
       widget.controller ?? _controller;

   @override
   CupertinoTextFormFieldRow get widget =>
       super.widget as CupertinoTextFormFieldRow;

   @override
   void initState() {
     super.initState();
     if (widget.controller == null) {
       _controller = TextEditingController(text: widget.initialValue);
     } else {
       widget.controller!.addListener(_handleControllerChanged);
     }
   }

   @override
   void didUpdateWidget(CupertinoTextFormFieldRow oldWidget) {
     super.didUpdateWidget(oldWidget);
     if (widget.controller != oldWidget.controller) {
       oldWidget.controller?.removeListener(_handleControllerChanged);
       widget.controller?.addListener(_handleControllerChanged);

       if (oldWidget.controller != null && widget.controller == null) {
         _controller =
             TextEditingController.fromValue(oldWidget.controller!.value);
       }

       if (widget.controller != null) {
         setValue(widget.controller!.text);
         if (oldWidget.controller == null) {
           _controller = null;
         }
       }
     }
   }

   @override
   void dispose() {
     widget.controller?.removeListener(_handleControllerChanged);
     super.dispose();
   }

   @override
   void didChange(String? value) {
     super.didChange(value);

     if (value != null && _effectiveController!.text != value) {
       _effectiveController!.text = value;
     }
   }

   @override
   void reset() {
     super.reset();

     if (widget.initialValue != null) {
       setState(() {
         _effectiveController!.text = widget.initialValue!;
       });
     }
   }

   void _handleControllerChanged() {
     // Suppress changes that originated from within this class.
     //
     // In the case where a controller has been passed in to this widget, we
     // register this change listener. In these cases, we'll also receive change
     // notifications for changes originating from within this class -- for
     // example, the reset() method. In such cases, the FormField value will
     // already have been set.
     if (_effectiveController!.text != value) {
       didChange(_effectiveController!.text);
     }
   }
 }
	// 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 'package:flutter/services.dart';
	import 'package:flutter/widgets.dart';

	import 'colors.dart';
	import 'form_row.dart';
	import 'text_field.dart';

	/// Creates a [CupertinoFormRow] containing a [FormField] that wraps
	/// a [CupertinoTextField].
	///
	/// A [Form] ancestor is not required. The [Form] simply makes it easier to
	/// save, reset, or validate multiple fields at once. To use without a [Form],
	/// pass a [GlobalKey] to the constructor and use [GlobalKey.currentState] to
	/// save or reset the form field.
	///
	/// When a [controller] is specified, its [TextEditingController.text]
	/// defines the [initialValue]. If this [FormField] is part of a scrolling
	/// container that lazily constructs its children, like a [ListView] or a
	/// [CustomScrollView], then a [controller] should be specified.
	/// The controller's lifetime should be managed by a stateful widget ancestor
	/// of the scrolling container.
	///
	/// The [prefix] parameter is displayed at the start of the row. Standard iOS
	/// guidelines encourage passing a [Text] widget to [prefix] to detail the
	/// nature of the input.
	///
	/// The [padding] parameter is used to pad the contents of the row. It is
	/// directly passed to [CupertinoFormRow]. If the [padding]
	/// parameter is null, [CupertinoFormRow] constructs its own default
	/// padding (which is the standard form row padding in iOS.) If no edge
	/// insets are intended, explicitly pass [EdgeInsets.zero] to [padding].
	///
	/// If a [controller] is not specified, [initialValue] can be used to give
	/// the automatically generated controller an initial value.
	///
	/// Consider calling [TextEditingController.dispose] of the [controller], if one
	/// is specified, when it is no longer needed. This will ensure we discard any
	/// resources used by the object.
	///
	/// For documentation about the various parameters, see the
	/// [CupertinoTextField] class and [new CupertinoTextField.borderless],
	/// the constructor.
	///
	/// {@tool snippet}
	///
	/// Creates a [CupertinoTextFormFieldRow] with a leading text and validator
	/// function.
	///
	/// If the user enters valid text, the CupertinoTextField appears normally
	/// without any warnings to the user.
	///
	/// If the user enters invalid text, the error message returned from the
	/// validator function is displayed in dark red underneath the input.
	///
	/// ```dart
	/// CupertinoTextFormFieldRow(
	/// prefix: const Text('Username'),
	/// onSaved: (String? value) {
	/// // This optional block of code can be used to run
	/// // code when the user saves the form.
	/// },
	/// validator: (String? value) {
	/// return (value != null && value.contains('@')) ? 'Do not use the @ char.' : null;
	/// },
	/// )
	/// ```
	/// {@end-tool}
	///
	/// {@tool dartpad}
	/// This example shows how to move the focus to the next field when the user
	/// presses the SPACE key.
	///
	/// See code in examples/api/lib/cupertino/text_form_field_row/cupertino_text_form_field_row.1.dart
	/// {@end-tool}
	class CupertinoTextFormFieldRow extends FormField<String> {
	/// Creates a [CupertinoFormRow] containing a [FormField] that wraps
	/// a [CupertinoTextField].
	///
	/// When a [controller] is specified, [initialValue] must be null (the
	/// default). If [controller] is null, then a [TextEditingController]
	/// will be constructed automatically and its `text` will be initialized
	/// to [initialValue] or the empty string.
	///
	/// The [prefix] parameter is displayed at the start of the row. Standard iOS
	/// guidelines encourage passing a [Text] widget to [prefix] to detail the
	/// nature of the input.
	///
	/// The [padding] parameter is used to pad the contents of the row. It is
	/// directly passed to [CupertinoFormRow]. If the [padding]
	/// parameter is null, [CupertinoFormRow] constructs its own default
	/// padding (which is the standard form row padding in iOS.) If no edge
	/// insets are intended, explicitly pass [EdgeInsets.zero] to [padding].
	///
	/// For documentation about the various parameters, see the
	/// [CupertinoTextField] class and [new CupertinoTextField.borderless],
	/// the constructor.
	CupertinoTextFormFieldRow({
	Key? key,
	this.prefix,
	this.padding,
	this.controller,
	String? initialValue,
	FocusNode? focusNode,
	BoxDecoration? decoration,
	TextInputType? keyboardType,
	TextCapitalization textCapitalization = TextCapitalization.none,
	TextInputAction? textInputAction,
	TextStyle? style,
	StrutStyle? strutStyle,
	TextDirection? textDirection,
	TextAlign textAlign = TextAlign.start,
	TextAlignVertical? textAlignVertical,
	bool autofocus = false,
	bool readOnly = false,
	ToolbarOptions? toolbarOptions,
	bool? showCursor,
	String obscuringCharacter = '•',
	bool obscureText = false,
	bool autocorrect = true,
	SmartDashesType? smartDashesType,
	SmartQuotesType? smartQuotesType,
	bool enableSuggestions = true,
	int? maxLines = 1,
	int? minLines,
	bool expands = false,
	int? maxLength,
	ValueChanged<String>? onChanged,
	GestureTapCallback? onTap,
	VoidCallback? onEditingComplete,
	ValueChanged<String>? onFieldSubmitted,
	FormFieldSetter<String>? onSaved,
	FormFieldValidator<String>? validator,
	List<TextInputFormatter>? inputFormatters,
	bool? enabled,
	double cursorWidth = 2.0,
	double? cursorHeight,
	Color? cursorColor,
	Brightness? keyboardAppearance,
	EdgeInsets scrollPadding = const EdgeInsets.all(20.0),
	bool enableInteractiveSelection = true,
	TextSelectionControls? selectionControls,
	ScrollPhysics? scrollPhysics,
	Iterable<String>? autofillHints,
	AutovalidateMode autovalidateMode = AutovalidateMode.disabled,
	String? placeholder,
	TextStyle? placeholderStyle = const TextStyle(
	fontWeight: FontWeight.w400,
	color: CupertinoColors.placeholderText,
	),
	}) : assert(initialValue == null \|\| controller == null),
	assert(textAlign != null),
	assert(autofocus != null),
	assert(readOnly != null),
	assert(obscuringCharacter != null && obscuringCharacter.length == 1),
	assert(obscureText != null),
	assert(autocorrect != null),
	assert(enableSuggestions != null),
	assert(scrollPadding != null),
	assert(maxLines == null \|\| maxLines > 0),
	assert(minLines == null \|\| minLines > 0),
	assert(
	(maxLines == null) \|\| (minLines == null) \|\| (maxLines >= minLines),
	"minLines can't be greater than maxLines",
	),
	assert(expands != null),
	assert(
	!expands \|\| (maxLines == null && minLines == null),
	'minLines and maxLines must be null when expands is true.',
	),
	assert(!obscureText \|\| maxLines == 1, 'Obscured fields cannot be multiline.'),
	assert(maxLength == null \|\| maxLength > 0),
	assert(enableInteractiveSelection != null),
	super(
	key: key,
	initialValue: controller?.text ?? initialValue ?? '',
	onSaved: onSaved,
	validator: validator,
	autovalidateMode: autovalidateMode,
	builder: (FormFieldState<String> field) {
	final _CupertinoTextFormFieldRowState state =
	field as _CupertinoTextFormFieldRowState;

	void onChangedHandler(String value) {
	field.didChange(value);
	if (onChanged != null) {
	onChanged(value);
	}
	}

	return CupertinoFormRow(
	prefix: prefix,
	padding: padding,
	error: (field.errorText == null) ? null : Text(field.errorText!),
	child: CupertinoTextField.borderless(
	controller: state._effectiveController,
	focusNode: focusNode,
	keyboardType: keyboardType,
	decoration: decoration,
	textInputAction: textInputAction,
	style: style,
	strutStyle: strutStyle,
	textAlign: textAlign,
	textAlignVertical: textAlignVertical,
	textCapitalization: textCapitalization,
	textDirection: textDirection,
	autofocus: autofocus,
	toolbarOptions: toolbarOptions,
	readOnly: readOnly,
	showCursor: showCursor,
	obscuringCharacter: obscuringCharacter,
	obscureText: obscureText,
	autocorrect: autocorrect,
	smartDashesType: smartDashesType,
	smartQuotesType: smartQuotesType,
	enableSuggestions: enableSuggestions,
	maxLines: maxLines,
	minLines: minLines,
	expands: expands,
	maxLength: maxLength,
	onChanged: onChangedHandler,
	onTap: onTap,
	onEditingComplete: onEditingComplete,
	onSubmitted: onFieldSubmitted,
	inputFormatters: inputFormatters,
	enabled: enabled,
	cursorWidth: cursorWidth,
	cursorHeight: cursorHeight,
	cursorColor: cursorColor,
	scrollPadding: scrollPadding,
	scrollPhysics: scrollPhysics,
	keyboardAppearance: keyboardAppearance,
	enableInteractiveSelection: enableInteractiveSelection,
	selectionControls: selectionControls,
	autofillHints: autofillHints,
	placeholder: placeholder,
	placeholderStyle: placeholderStyle,
	),
	);
	},
	);

	/// A widget that is displayed at the start of the row.
	///
	/// The [prefix] widget is displayed at the start of the row. Standard iOS
	/// guidelines encourage passing a [Text] widget to [prefix] to detail the
	/// nature of the input.
	final Widget? prefix;

	/// Content padding for the row.
	///
	/// The [padding] widget is passed to [CupertinoFormRow]. If the [padding]
	/// parameter is null, [CupertinoFormRow] constructs its own default
	/// padding, which is the standard form row padding in iOS.
	///
	/// If no edge insets are intended, explicitly pass [EdgeInsets.zero] to
	/// [padding].
	final EdgeInsetsGeometry? padding;

	/// Controls the text being edited.
	///
	/// If null, this widget will create its own [TextEditingController] and
	/// initialize its [TextEditingController.text] with [initialValue].
	final TextEditingController? controller;

	@override
	FormFieldState<String> createState() => _CupertinoTextFormFieldRowState();
	}

	class _CupertinoTextFormFieldRowState extends FormFieldState<String> {
	TextEditingController? _controller;

	TextEditingController? get _effectiveController =>
	widget.controller ?? _controller;

	@override
	CupertinoTextFormFieldRow get widget =>
	super.widget as CupertinoTextFormFieldRow;

	@override
	void initState() {
	super.initState();
	if (widget.controller == null) {
	_controller = TextEditingController(text: widget.initialValue);
	} else {
	widget.controller!.addListener(_handleControllerChanged);
	}
	}

	@override
	void didUpdateWidget(CupertinoTextFormFieldRow oldWidget) {
	super.didUpdateWidget(oldWidget);
	if (widget.controller != oldWidget.controller) {
	oldWidget.controller?.removeListener(_handleControllerChanged);
	widget.controller?.addListener(_handleControllerChanged);

	if (oldWidget.controller != null && widget.controller == null) {
	_controller =
	TextEditingController.fromValue(oldWidget.controller!.value);
	}

	if (widget.controller != null) {
	setValue(widget.controller!.text);
	if (oldWidget.controller == null) {
	_controller = null;
	}
	}
	}
	}

	@override
	void dispose() {
	widget.controller?.removeListener(_handleControllerChanged);
	super.dispose();
	}

	@override
	void didChange(String? value) {
	super.didChange(value);

	if (value != null && _effectiveController!.text != value) {
	_effectiveController!.text = value;
	}
	}

	@override
	void reset() {
	super.reset();

	if (widget.initialValue != null) {
	setState(() {
	_effectiveController!.text = widget.initialValue!;
	});
	}
	}

	void _handleControllerChanged() {
	// Suppress changes that originated from within this class.
	//
	// In the case where a controller has been passed in to this widget, we
	// register this change listener. In these cases, we'll also receive change
	// notifications for changes originating from within this class -- for
	// example, the reset() method. In such cases, the FormField value will
	// already have been set.
	if (_effectiveController!.text != value) {
	didChange(_effectiveController!.text);
	}
	}
	}