FormBuilderTextField constructor

Implementation

FormBuilderTextField({
  super.key,
  required super.name,
  super.validator,
  super.decoration,
  super.onChanged,
  super.valueTransformer,
  super.enabled,
  super.onSaved,
  super.autovalidateMode = AutovalidateMode.disabled,
  super.onReset,
  super.focusNode,
  super.restorationId,
  String? initialValue,
  super.errorBuilder,
  this.readOnly = false,
  this.maxLines = 1,
  this.obscureText = false,
  this.textCapitalization = TextCapitalization.none,
  this.scrollPadding = const EdgeInsets.all(20.0),
  this.enableInteractiveSelection = true,
  this.maxLengthEnforcement,
  this.textAlign = TextAlign.start,
  this.autofocus = false,
  this.autocorrect = true,
  this.cursorWidth = 2.0,
  this.cursorHeight,
  this.keyboardType,
  this.style,
  this.controller,
  this.textInputAction,
  this.strutStyle,
  this.textDirection,
  this.maxLength,
  this.onEditingComplete,
  this.onSubmitted,
  this.inputFormatters,
  this.cursorRadius,
  this.cursorColor,
  this.keyboardAppearance,
  this.buildCounter,
  this.expands = false,
  this.minLines,
  this.showCursor,
  this.onTap,
  this.onTapOutside,
  this.enableSuggestions = true,
  this.textAlignVertical,
  this.dragStartBehavior = DragStartBehavior.start,
  this.scrollController,
  this.scrollPhysics,
  this.selectionWidthStyle = ui.BoxWidthStyle.tight,
  this.smartDashesType,
  this.smartQuotesType,
  this.selectionHeightStyle = ui.BoxHeightStyle.tight,
  this.autofillHints,
  this.obscuringCharacter = '•',
  this.mouseCursor,
  this.contextMenuBuilder = _defaultContextMenuBuilder,
  this.magnifierConfiguration,
  this.contentInsertionConfiguration,
  this.spellCheckConfiguration,
  this.clipBehavior = Clip.hardEdge,
  @Deprecated(
    'This property will be removed in the next Flutter stable versions. '
    'Use FocusNode.canRequestFocus instead. '
    'Ref: https://docs.flutter.dev/release/breaking-changes/can-request-focus',
  )
  this.canRequestFocus = true,
  this.cursorErrorColor,
  this.cursorOpacityAnimates,
  this.enableIMEPersonalizedLearning = true,
  this.groupId = EditableText,
  this.onAppPrivateCommand,
  this.onTapAlwaysCalled = false,
  @Deprecated(
    'Use `stylusHandwritingEnabled` instead. '
    'This feature was deprecated after v3.27.0-0.2.pre.',
  )
  this.scribbleEnabled = true,
  this.stylusHandwritingEnabled =
      EditableText.defaultStylusHandwritingEnabled,
  this.selectionControls,
  this.statesController,
  this.undoController,
}) : assert(initialValue == null || controller == null),
     assert(minLines == null || minLines > 0),
     assert(maxLines == null || maxLines > 0),
     assert(
       (minLines == null) || (maxLines == null) || (maxLines >= minLines),
       'minLines can\'t be greater than maxLines',
     ),
     assert(
       !expands || (minLines == null && maxLines == 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),
     super(
       initialValue: controller != null ? controller.text : initialValue,
       builder: (FormFieldState<String?> field) {
         final state = field as _FormBuilderTextFieldState;

         return TextField(
           restorationId: restorationId,
           controller: state._effectiveController,
           focusNode: state.effectiveFocusNode,
           decoration: state.decoration,
           keyboardType: keyboardType,
           textInputAction: textInputAction,
           style: style,
           strutStyle: strutStyle,
           textAlign: textAlign,
           textAlignVertical: textAlignVertical,
           textDirection: textDirection,
           textCapitalization: textCapitalization,
           autofocus: autofocus,
           readOnly: readOnly,
           showCursor: showCursor,
           obscureText: obscureText,
           autocorrect: autocorrect,
           enableSuggestions: enableSuggestions,
           maxLengthEnforcement: maxLengthEnforcement,
           maxLines: maxLines,
           minLines: minLines,
           expands: expands,
           maxLength: maxLength,
           onTap: onTap,
           onTapOutside: onTapOutside,
           onEditingComplete: onEditingComplete,
           onSubmitted: onSubmitted,
           inputFormatters: inputFormatters,
           enabled: state.enabled,
           cursorWidth: cursorWidth,
           cursorHeight: cursorHeight,
           cursorRadius: cursorRadius,
           cursorColor: cursorColor,
           scrollPadding: scrollPadding,
           keyboardAppearance: keyboardAppearance,
           enableInteractiveSelection: enableInteractiveSelection,
           buildCounter: buildCounter,
           dragStartBehavior: dragStartBehavior,
           scrollController: scrollController,
           scrollPhysics: scrollPhysics,
           selectionHeightStyle: selectionHeightStyle,
           selectionWidthStyle: selectionWidthStyle,
           smartDashesType: smartDashesType,
           smartQuotesType: smartQuotesType,
           mouseCursor: mouseCursor,
           contextMenuBuilder: contextMenuBuilder,
           obscuringCharacter: obscuringCharacter,
           autofillHints: autofillHints,
           magnifierConfiguration: magnifierConfiguration,
           contentInsertionConfiguration: contentInsertionConfiguration,
           spellCheckConfiguration: spellCheckConfiguration,
           clipBehavior: clipBehavior,
           canRequestFocus: canRequestFocus,
           cursorErrorColor: cursorErrorColor,
           cursorOpacityAnimates: cursorOpacityAnimates,
           enableIMEPersonalizedLearning: enableIMEPersonalizedLearning,
           groupId: groupId,
           onAppPrivateCommand: onAppPrivateCommand,
           onTapAlwaysCalled: onTapAlwaysCalled,
           stylusHandwritingEnabled: stylusHandwritingEnabled,
           selectionControls: selectionControls,
           statesController: statesController,
           undoController: undoController,
         );
       },
     );