ExtendedEditableText class

Inheritance

Constructors

ExtendedEditableText({Key? key, required TextEditingController controller, required FocusNode focusNode, bool readOnly = false, String obscuringCharacter = '•', bool obscureText = false, bool autocorrect = true, SmartDashesType? smartDashesType, SmartQuotesType? smartQuotesType, bool enableSuggestions = true, required TextStyle style, StrutStyle? strutStyle, required Color cursorColor, required Color backgroundCursorColor, TextAlign textAlign = TextAlign.start, TextDirection? textDirection, Locale? locale, double? textScaleFactor, int? maxLines = 1, int? minLines, bool expands = false, bool forceLine = true, TextHeightBehavior? textHeightBehavior, TextWidthBasis textWidthBasis = TextWidthBasis.parent, bool autofocus = false, bool? showCursor, bool showSelectionHandles = false, Color? selectionColor, TextSelectionControls? selectionControls, TextInputType? keyboardType, TextInputAction? textInputAction, TextCapitalization textCapitalization = TextCapitalization.none, ValueChanged<String>? onChanged, VoidCallback? onEditingComplete, ValueChanged<String>? onSubmitted, AppPrivateCommandCallback? onAppPrivateCommand, SelectionChangedCallback? onSelectionChanged, VoidCallback? onSelectionHandleTapped, List<TextInputFormatter>? inputFormatters, MouseCursor? mouseCursor, bool rendererIgnoresPointer = false, double cursorWidth = 2.0, double? cursorHeight, Radius? cursorRadius, bool cursorOpacityAnimates = false, Offset? cursorOffset, bool paintCursorAboveText = false, BoxHeightStyle selectionHeightStyle = ui.BoxHeightStyle.tight, BoxWidthStyle selectionWidthStyle = ui.BoxWidthStyle.tight, EdgeInsets scrollPadding = const EdgeInsets.all(20.0), Brightness keyboardAppearance = Brightness.light, DragStartBehavior dragStartBehavior = DragStartBehavior.start, bool enableInteractiveSelection = true, ScrollController? scrollController, ScrollPhysics? scrollPhysics, Color? autocorrectionTextRectColor, ToolbarOptions toolbarOptions = const ToolbarOptions(copy: true, cut: true, paste: true, selectAll: true), Iterable<String>? autofillHints = const <String>[], AutofillClient? autofillClient, Clip clipBehavior = Clip.hardEdge, String? restorationId, ScrollBehavior? scrollBehavior, bool enableIMEPersonalizedLearning = true})
Creates a basic text input control.

Properties

autocorrect → bool
Whether to enable autocorrection.
final
autocorrectionTextRectColor → Color?
The color to use when painting the autocorrection Rect.
final
autofillClient → AutofillClient?
The AutofillClient that controls this input field's autofill behavior.
final
autofillHints → Iterable<String>?
A list of strings that helps the autofill service identify the type of this text input.
final
autofocus → bool
Whether this text field should focus itself if nothing else is already focused.
final
backgroundCursorColor → Color
The color to use when painting the background cursor aligned with the text while rendering the floating cursor.
final
clipBehavior → Clip
The content will be clipped (or not) according to this option.
final
controller → TextEditingController
Controls the text being edited.
final
cursorColor → Color
The color to use when painting the cursor.
final
cursorHeight → double?
How tall the cursor will be.
final
cursorOffset → Offset?
The offset that is used, in pixels, when painting the cursor on screen.
final
cursorOpacityAnimates → bool
Whether the cursor will animate from fully transparent to fully opaque during each cursor blink.
final
cursorRadius → Radius?
How rounded the corners of the cursor should be.
final
cursorWidth → double
How thick the cursor will be.
final
dragStartBehavior → DragStartBehavior
Determines the way that drag start behavior is handled.
final
enableIMEPersonalizedLearning → bool
Whether to enable that the IME update personalized data such as typing history and user dictionary data.
final
enableInteractiveSelection → bool
Whether to enable user interface affordances for changing the text selection.
final
enableSuggestions → bool
Whether to show input suggestions as the user types.
final
expands → bool
Whether this widget's height will be sized to fill its parent.
final
focusNode → FocusNode
Controls whether this widget has keyboard focus.
final
forceLine → bool
Whether the text will take the full width regardless of the text width.
final
hashCode → int
The hash code for this object.
no setterinherited
inputFormatters → List<TextInputFormatter>?
Optional input validation and formatting overrides.
final
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
keyboardAppearance → Brightness
The appearance of the keyboard.
final
keyboardType → TextInputType
The type of keyboard to use for editing the text.
final
locale → Locale?
Used to select a font when the same Unicode character can be rendered differently, depending on the locale.
final
maxLines → int?
The maximum number of lines to show at one time, wrapping if necessary.
final
minLines → int?
The minimum number of lines to occupy when the content spans fewer lines.
final
mouseCursor → MouseCursor?
The cursor for a mouse pointer when it enters or is hovering over the widget.
final
obscureText → bool
Whether to hide the text being edited (e.g., for passwords).
final
obscuringCharacter → String
Character used for obscuring text if obscureText is true.
final
onAppPrivateCommand → AppPrivateCommandCallback?
This is used to receive a private command from the input method.
final
onChanged → ValueChanged<String>?
Called when the user initiates a change to the TextField's value: when they have inserted or deleted text.
final
onEditingComplete → VoidCallback?
Called when the user submits editable content (e.g., user presses the "done" button on the keyboard).
final
onSelectionChanged → SelectionChangedCallback?
Called when the user changes the selection of text (including the cursor location).
final
onSelectionHandleTapped → VoidCallback?
final
onSubmitted → ValueChanged<String>?
Called when the user indicates that they are done editing the text in the field.
final
paintCursorAboveText → bool
If the cursor should be painted on top of the text or underneath it.
final
readOnly → bool
Whether the text can be changed.
final
rendererIgnoresPointer → bool
If true, the RenderEditable created by this widget will not handle pointer events, see RenderEditable and RenderEditable.ignorePointer.
final
restorationId → String?
Restoration ID to save and restore the scroll offset of the EditableText.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
scrollBehavior → ScrollBehavior?
A ScrollBehavior that will be applied to this widget individually.
final
scrollController → ScrollController?
The ScrollController to use when vertically scrolling the input.
final
scrollPadding → EdgeInsets
Configures padding to edges surrounding a Scrollable when the Textfield scrolls into view.
final
scrollPhysics → ScrollPhysics?
The ScrollPhysics to use when vertically scrolling the input.
final
selectionColor → Color?
The color to use when painting the selection.
final
selectionControls → TextSelectionControls?
Optional delegate for building the text selection handles.
final
selectionEnabled → bool
Same as enableInteractiveSelection.
no setter
selectionHeightStyle → BoxHeightStyle
Controls how tall the selection highlight boxes are computed to be.
final
selectionWidthStyle → BoxWidthStyle
Controls how wide the selection highlight boxes are computed to be.
final
showCursor → bool
Whether to show cursor.
final
showSelectionHandles → bool
Whether to show selection handles.
final
smartDashesType → SmartDashesType
Whether to allow the platform to automatically format dashes.
final
smartQuotesType → SmartQuotesType
Whether to allow the platform to automatically format quotes.
final
strutStyle → StrutStyle
The strut style used for the vertical layout.
no setter
style → TextStyle
The text style to use for the editable text.
final
textAlign → TextAlign
How the text should be aligned horizontally.
final
textCapitalization → TextCapitalization
Configures how the platform keyboard will select an uppercase or lowercase keyboard.
final
textDirection → TextDirection?
The directionality of the text.
final
textHeightBehavior → TextHeightBehavior?
Defines how to apply TextStyle.height over and under text.
final
textInputAction → TextInputAction?
The type of action button to use with the soft keyboard.
final
textScaleFactor → double?
Deprecated. Will be removed in a future version of Flutter. Use textScaler instead.
final
textWidthBasis → TextWidthBasis
Defines how to measure the width of the rendered text.
final
toolbarOptions → ToolbarOptions
Configuration of toolbar options.
final

Methods

createElement() → StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() → ExtendedEditableTextState
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.
override
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

Static Properties

debugDeterministicCursor ↔ bool
Setting this property to true makes the cursor stop blinking or fading on and off once the cursor appears on focus. This property is useful for testing purposes.
getter/setter pair