RoundedBackgroundTextField class
A wrapper around RoundedBackgroundText and TextField
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatefulWidget
- RoundedBackgroundTextField
Constructors
-
RoundedBackgroundTextField({Key? key, TextEditingController? controller, TextStyle? style, Color? backgroundColor, TextAlign textAlign = TextAlign.start, TextDirection? textDirection, TextScaler? textScaler, TextCapitalization textCapitalization = TextCapitalization.none, int? maxLines, double cursorWidth = 2.0, Color? cursorColor, double? cursorHeight, Radius? cursorRadius, TextInputType? keyboardType, String? hint, TextStyle? hintStyle, double innerRadius = kDefaultInnerRadius, double outerRadius = kDefaultOuterRadius, bool autofocus = false, FocusNode? focusNode, Brightness keyboardAppearance = Brightness.light, bool enableInteractiveSelection = true, TextSelectionControls? selectionControls, bool autocorrect = true, AutofillClient? autofillClient, Iterable<
String> ? autofillHints, Clip clipBehavior = Clip.hardEdge, bool enableIMEPersonalizedLearning = true, bool enableSuggestions = true, bool forceLine = true, TextHeightBehavior? textHeightBehavior, TextWidthBasis textWidthBasis = TextWidthBasis.parent, BoxHeightStyle selectionHeightStyle = ui.BoxHeightStyle.tight, BoxWidthStyle selectionWidthStyle = ui.BoxWidthStyle.tight, StrutStyle? strutStyle, List<TextInputFormatter> ? inputFormatters, MouseCursor? mouseCursor, bool obscureText = false, String obscuringCharacter = '*', bool readOnly = false, bool rendererIgnoresPointer = false, String? restorationId, bool showCursor = true, bool showSelectionHandles = true, SmartDashesType smartDashesType = SmartDashesType.enabled, SmartQuotesType smartQuotesType = SmartQuotesType.enabled, TextInputAction? textInputAction, SelectionChangedCallback? onSelectionChanged, ScrollController? scrollController, ScrollPhysics? scrollPhysics, ScrollBehavior? scrollBehavior, EdgeInsets scrollPadding = EdgeInsets.zero, DragStartBehavior dragStartBehavior = DragStartBehavior.start, ContentInsertionConfiguration? contentInsertionConfiguration, EditableTextContextMenuBuilder? contextMenuBuilder, SpellCheckConfiguration? spellCheckConfiguration, TextMagnifierConfiguration magnifierConfiguration = const TextMagnifierConfiguration(), UndoHistoryController? undoController, bool scribbleEnabled = true, Locale? locale, ValueChanged<String> ? onChanged, VoidCallback? onEditingComplete, ValueChanged<String> ? onSubmitted, AppPrivateCommandCallback? onAppPrivateCommand, VoidCallback? onSelectionHandleTapped, TapRegionCallback? onTapOutside, String? heroTag}) -
const
Properties
- autocorrect → bool
-
Whether to enable autocorrection.
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
- backgroundColor → Color?
-
The text background color.
final
- clipBehavior → Clip
-
The content will be clipped (or not) according to this option.
final
- contentInsertionConfiguration → ContentInsertionConfiguration?
-
Configuration of handler for media content inserted via the system input
method.
final
- contextMenuBuilder → EditableTextContextMenuBuilder?
-
Builds the text selection toolbar when requested by the user.
final
- controller → TextEditingController?
-
final
- cursorColor → Color?
-
The color of the cursor.
final
- cursorHeight → double?
-
How tall the cursor will be.
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
- focusNode → FocusNode?
-
Defines the keyboard focus for this widget.
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
- heroTag → String?
-
final
- hint → String?
-
The text hint
final
- hintStyle → TextStyle?
-
The text style for hint
final
- innerRadius → double
-
The radius of the inner corners.
final
-
inputFormatters
→ List<
TextInputFormatter> ? -
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
- magnifierConfiguration → TextMagnifierConfiguration
-
This magnifying glass is useful for scenarios on mobile devices where
the user's finger may be covering part of the screen where a granular
action is being performed, such as navigating a small cursor with a drag
gesture, on an image or text.
final
- maxLines → int?
-
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?
-
A callback that's optionally invoked when a selection handle is tapped.
final
-
onSubmitted
→ ValueChanged<
String> ? -
Called when the user indicates that they are done editing the text in the
field.
final
- onTapOutside → TapRegionCallback?
-
Called for each tap that occurs outside of theTextFieldTapRegion group
when the text field is focused.
final
- outerRadius → double
-
The radius of the inner corners.
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
- scribbleEnabled → bool
-
{macro flutter.widgets.editableText.scribbleEnabled}
final
- 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
- 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
- spellCheckConfiguration → SpellCheckConfiguration?
-
Configuration that details how spell check should be performed.
final
- strutStyle → StrutStyle?
-
The strut style to use. Strut style defines the strut, which sets minimum
vertical layout metrics.
final
- style → TextStyle?
-
The final text style
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
- textScaler → TextScaler?
-
The font scaling strategy to use when laying out and rendering the text.
final
- textWidthBasis → TextWidthBasis
-
Defines how to measure the width of the rendered text.
final
- undoController → UndoHistoryController?
-
Controls the undo state of the current editable text.
final
Methods
-
createElement(
) → StatefulElement -
Creates a StatefulElement to manage this widget's location in the tree.
inherited
-
createState(
) → State< RoundedBackgroundTextField> -
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