EditableText constructor

Implementation

EditableText({
  super.key,
  required this.controller,
  required this.focusNode,
  this.readOnly = false,
  this.obscuringCharacter = '•',
  this.obscureText = false,
  this.autocorrect = true,
  SmartDashesType? smartDashesType,
  SmartQuotesType? smartQuotesType,
  this.enableSuggestions = true,
  required this.style,
  StrutStyle? strutStyle,
  required this.cursorColor,
  required this.backgroundCursorColor,
  this.textAlign = TextAlign.start,
  this.textDirection,
  this.locale,
  @Deprecated(
    'Use textScaler instead. '
    'Use of textScaleFactor was deprecated in preparation for the upcoming nonlinear text scaling support. '
    'This feature was deprecated after v3.12.0-2.0.pre.',
  )
  this.textScaleFactor,
  this.textScaler,
  this.maxLines = 1,
  this.minLines,
  this.expands = false,
  this.forceLine = true,
  this.textHeightBehavior,
  this.textWidthBasis = TextWidthBasis.parent,
  this.autofocus = false,
  bool? showCursor,
  this.showSelectionHandles = false,
  this.selectionColor,
  this.selectionControls,
  TextInputType? keyboardType,
  this.textInputAction,
  this.textCapitalization = TextCapitalization.none,
  this.onChanged,
  this.onEditingComplete,
  this.onSubmitted,
  this.onAppPrivateCommand,
  this.onSelectionChanged,
  this.onSelectionHandleTapped,
  this.groupId = EditableText,
  this.onTapOutside,
  List<TextInputFormatter>? inputFormatters,
  this.mouseCursor,
  this.rendererIgnoresPointer = false,
  this.cursorWidth = 2.0,
  this.cursorHeight,
  this.cursorRadius,
  this.cursorOpacityAnimates = false,
  this.cursorOffset,
  this.paintCursorAboveText = false,
  this.selectionHeightStyle = ui.BoxHeightStyle.tight,
  this.selectionWidthStyle = ui.BoxWidthStyle.tight,
  this.scrollPadding = const EdgeInsets.all(20.0),
  this.keyboardAppearance = Brightness.light,
  this.dragStartBehavior = DragStartBehavior.start,
  bool? enableInteractiveSelection,
  this.scrollController,
  this.scrollPhysics,
  this.autocorrectionTextRectColor,
  @Deprecated(
    'Use `contextMenuBuilder` instead. '
    'This feature was deprecated after v3.3.0-0.5.pre.',
  )
  ToolbarOptions? toolbarOptions,
  this.autofillHints = const <String>[],
  this.autofillClient,
  this.clipBehavior = Clip.hardEdge,
  this.restorationId,
  this.scrollBehavior,
  this.scribbleEnabled = true,
  this.enableIMEPersonalizedLearning = true,
  this.contentInsertionConfiguration,
  this.contextMenuBuilder,
  this.spellCheckConfiguration,
  this.magnifierConfiguration = TextMagnifierConfiguration.disabled,
  this.undoController,
}) : assert(obscuringCharacter.length == 1),
     smartDashesType = smartDashesType ?? (obscureText ? SmartDashesType.disabled : SmartDashesType.enabled),
     smartQuotesType = smartQuotesType ?? (obscureText ? SmartQuotesType.disabled : SmartQuotesType.enabled),
     assert(minLines == null || minLines > 0),
     assert(
       (maxLines == null) || (minLines == null) || (maxLines >= minLines),
       "minLines can't be greater than maxLines",
     ),
     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.'),
     enableInteractiveSelection = enableInteractiveSelection ?? (!readOnly || !obscureText),
     toolbarOptions = selectionControls is TextSelectionHandleControls && toolbarOptions == null ? ToolbarOptions.empty : toolbarOptions ??
         (obscureText
             ? (readOnly
                 // No point in even offering "Select All" in a read-only obscured
                 // field.
                 ? ToolbarOptions.empty
                 // Writable, but obscured.
                 : const ToolbarOptions(
                     selectAll: true,
                     paste: true,
                   ))
             : (readOnly
                 // Read-only, not obscured.
                 ? const ToolbarOptions(
                     selectAll: true,
                     copy: true,
                   )
                 // Writable, not obscured.
                 : const ToolbarOptions(
                     copy: true,
                     cut: true,
                     selectAll: true,
                     paste: true,
                   ))),
     assert(
        spellCheckConfiguration == null ||
        spellCheckConfiguration == const SpellCheckConfiguration.disabled() ||
        spellCheckConfiguration.misspelledTextStyle != null,
        'spellCheckConfiguration must specify a misspelledTextStyle if spell check behavior is desired',
     ),
     _strutStyle = strutStyle,
     keyboardType = keyboardType ?? _inferKeyboardType(autofillHints: autofillHints, maxLines: maxLines),
     inputFormatters = maxLines == 1
         ? <TextInputFormatter>[
             FilteringTextInputFormatter.singleLineFormatter,
             ...inputFormatters ?? const Iterable<TextInputFormatter>.empty(),
           ]
         : inputFormatters,
     showCursor = showCursor ?? !readOnly;