CupertinoColorPickerFormFieldRow class

Creates a CupertinoFormRow containing a FormField that wraps a CupertinoColorPickerField.

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 ColorPickerFieldController.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 ColorPickerFieldController.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 CupertinoColorPickerField class and CupertinoColorPickerField.borderless, the constructor.

{@tool snippet}

Creates a CupertinoColorPickerFormFieldRow with a leading text and validator function.

If the user enters valid text, the CupertinoColorPickerField 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.

CupertinoColorPickerFormFieldRow(
  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 --template=stateful_widget_material} This example shows how to move the focus to the next field when the user presses the SPACE key.

import 'package:flutter/cupertino.dart';

@override
Widget build(BuildContext context) {
  return CupertinoPageScaffold(
    child: Center(
      child: Form(
        autovalidateMode: AutovalidateMode.always,
        onChanged: () {
          Form.of(primaryFocus!.context!)?.save();
        },
        child: CupertinoFormSection.insetGrouped(
          header: const Text('SECTION 1'),
          children: List<Widget>.generate(5, (int index) {
            return CupertinoColorPickerFormFieldRow(
              prefix: const Text('Enter text'),
              placeholder: 'Enter text',
              validator: (String? value) {
                if (value == null || value.isEmpty) {
                  return 'Please enter a value';
                }
                return null;
              },
            );
         }),
        ),
      ),
    ),
  );
}

{@end-tool}

Inheritance

Constructors

CupertinoColorPickerFormFieldRow({Key? key, Widget? prefix, EdgeInsetsGeometry? padding, ColorPickerFieldController? controller, required Color defaultColor, List<Color>? initialValue, FocusNode? focusNode, BoxDecoration? decoration, TextStyle? style, ClearButtonVisibilityMode clearButtonMode = ClearButtonVisibilityMode.never, TextAlign textAlign = TextAlign.start, bool readOnly = false, int? maxLength, ValueChanged<List<Color>>? onChanged, VoidCallback? onEditingComplete, ValueChanged<List<Color>>? onFieldSubmitted, FormFieldSetter<List<Color>>? onSaved, FormFieldValidator<List<Color>>? validator, bool? enabled, ScrollPhysics? scrollPhysics, AutovalidateMode autovalidateMode = AutovalidateMode.disabled, bool colorListReversed = false, String? placeholder, TextStyle? placeholderStyle = const TextStyle(fontWeight: FontWeight.w400, color: CupertinoColors.placeholderText), bool enableLightness = false, bool enableSaturation = false})
Creates a CupertinoFormRow containing a FormField that wraps a CupertinoColorPickerField.

Properties

autovalidateMode → AutovalidateMode
Used to enable/disable this form field auto validation and update its error text.
finalinherited
builder → FormFieldBuilder<List<Color>>
Function that returns the widget representing this form field. It is passed the form field state as input, containing the current value and validation state of this field.
finalinherited
controller → ColorPickerFieldController?
Controls the text being edited.
final
defaultColor → Color
final
enabled → bool
Whether the form is able to receive user input.
finalinherited
enableLightness → bool
Enable the lightness control for the color value.
final
enableSaturation → bool
Enable the saturation control for the color value.
final
hashCode → int
The hash code for this object.
no setterinherited
initialValue → List<Color>?
An optional value to initialize the form field to, or null otherwise.
finalinherited
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
onSaved → FormFieldSetter<List<Color>>?
An optional method to call with the final value when the form is saved via FormState.save.
finalinherited
padding → EdgeInsetsGeometry?
Content padding for the row.
final
prefix → Widget?
A widget that is displayed at the start of the row.
final
restorationId → String?
Restoration ID to save and restore the state of the form field.
finalinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
validator → FormFieldValidator<List<Color>>?
An optional method that validates an input. Returns an error string to display if the input is invalid, or null otherwise.
finalinherited

Methods

createElement() → StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() → FormFieldState<List<Color>>
Creates the mutable state for this widget at a given location in the tree.
override
debugDescribeChildren() → List<DiagnosticsNode>
Returns a list of DiagnosticsNode objects describing this node's children.
inherited
debugFillProperties(DiagnosticPropertiesBuilder properties) → void
Add additional properties associated with the node.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toDiagnosticsNode({String? name, DiagnosticsTreeStyle? style}) → DiagnosticsNode
Returns a debug representation of the object that is used by debugging tools and by DiagnosticsNode.toStringDeep.
inherited
toString({DiagnosticLevel minLevel = DiagnosticLevel.info}) → String
A string representation of this object.
inherited
toStringDeep({String prefixLineOne = '', String? prefixOtherLines, DiagnosticLevel minLevel = DiagnosticLevel.debug}) → String
Returns a string representation of this node and its descendants.
inherited
toStringShallow({String joiner = ', ', DiagnosticLevel minLevel = DiagnosticLevel.debug}) → String
Returns a one-line detailed description of the object.
inherited
toStringShort() → String
A short, textual description of this widget.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited