FSelectSearchFieldProperties class

The search field's properties.

Mixed-in types

Constructors

FSelectSearchFieldProperties({FTextFieldSizeVariant size = FTextFieldSizeVariant.md, FTextFieldControl control = const .managed(), String? hint, TextMagnifierConfiguration? magnifierConfiguration, TextInputType? keyboardType, TextInputAction? textInputAction, TextCapitalization textCapitalization = .none, TextAlign textAlign = .start, TextAlignVertical? textAlignVertical, TextDirection? textDirection, bool? autofocus, bool autocorrect = true, SmartDashesType? smartDashesType, SmartQuotesType? smartQuotesType, bool enableSuggestions = true, int? minLines, int? maxLines = 1, bool readOnly = false, bool? showCursor, int? maxLength, MaxLengthEnforcement? maxLengthEnforcement, ValueChanged<TextEditingValue>? onChange, GestureTapCallback? onTap, bool onTapAlwaysCalled = false, VoidCallback? onEditingComplete, ValueChanged<String>? onSubmit, List<TextInputFormatter>? inputFormatters, bool enabled = true, bool? ignorePointers, bool enableInteractiveSelection = true, TextSelectionControls? selectionControls, DragStartBehavior dragStartBehavior = .start, MouseCursor? mouseCursor, ScrollPhysics? scrollPhysics, ScrollController? scrollController, Iterable<String>? autofillHints, String? restorationId, bool stylusHandwritingEnabled = true, bool enableIMEPersonalizedLearning = true, ContentInsertionConfiguration? contentInsertionConfiguration, EditableTextContextMenuBuilder? contextMenuBuilder, UndoHistoryController? undoController, SpellCheckConfiguration? spellCheckConfiguration, FFieldIconBuilder<FTextFieldStyle>? prefixBuilder = defaultIconBuilder, FFieldIconBuilder<FTextFieldStyle>? suffixBuilder, bool clearable(TextEditingValue value) = FTextField.defaultClearable, FFieldClearIconBuilder<FTextFieldStyle> clearIconBuilder = FTextField.defaultClearIconBuilder})
Creates a FSelectSearchFieldProperties.
const

Properties

autocorrect → bool
Whether to enable autocorrection. Defaults to true.
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. Defaults to true on desktop and false on touch devices.
final
clearable → bool Function(TextEditingValue value)
A predicate that returns true if a clear icon should be shown at the end when the text field is not empty.
final
clearIconBuilder → FFieldClearIconBuilder<FTextFieldStyle>
The builder used to build the clear icon when clearable returns true.
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
control → FTextFieldControl
The search field's control.
final
dragStartBehavior → DragStartBehavior
Determines the way that drag start behavior is handled. By default, the drag start behavior is DragStartBehavior.start.
final
enabled → bool
If false the text field is "disabled": it ignores taps. Defaults to true.
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. Defaults to true.
final
enableSuggestions → bool
Whether to show input suggestions as the user types. Defaults to true.
final
hashCode → int
The hash code for this object.
no setterinherited
hint → String?
The text to display when the text field is empty.
final
ignorePointers → bool?
Determines whether this widget ignores pointer events. Defaults to null, and when null, does nothing.
final
inputFormatters → List<TextInputFormatter>?
Optional input validation and formatting overrides.
final
keyboardType → TextInputType?
The type of keyboard to use for editing the text. Defaults to TextInputType.text if maxLines is one and TextInputType.multiline otherwise.
final
magnifierConfiguration → TextMagnifierConfiguration?
The configuration for the magnifier of this text field.
final
maxLength → int?
The maximum number of characters (Unicode grapheme clusters) to allow in the text field.
final
maxLengthEnforcement → MaxLengthEnforcement?
Determines how the maxLength limit should be enforced.
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
onChange → ValueChanged<TextEditingValue>?
Called when the text field's value changes.
final
onEditingComplete → VoidCallback?
Called when the user submits editable content (e.g., user presses the "done" button on the keyboard).
final
onSubmit → ValueChanged<String>?
Called when the user indicates that they are done editing the text in the field.
final
onTap → VoidCallback?
Called for the first tap in a series of taps.
final
onTapAlwaysCalled → bool
Whether onTap should be called for every tap.
final
prefixBuilder → FFieldIconBuilder<FTextFieldStyle>?
The prefix builder. Defaults to a search icon.
final
readOnly → bool
Whether the text can be changed. Defaults to false.
final
restorationId → String?
Restoration ID to save and restore the state of the text field.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
scrollController → ScrollController?
The ScrollController to use when vertically scrolling the input. If null, it will instantiate a new ScrollController.
final
scrollPhysics → ScrollPhysics?
The ScrollPhysics to use when vertically scrolling the input. If not specified, it will behave according to the current platform.
final
selectionControls → TextSelectionControls?
Optional delegate for building the text selection handles.
final
showCursor → bool?
Whether to show cursor.
final
size → FTextFieldSizeVariant
The search field's size. Defaults to FTextFieldSizeVariant.md.
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
stylusHandwritingEnabled → bool
Whether this input supports stylus handwriting, where the user can write directly on top of a field.
final
suffixBuilder → FFieldIconBuilder<FTextFieldStyle>?
The suffix's builder.
final
textAlign → TextAlign
How the text should be aligned horizontally.
final
textAlignVertical → TextAlignVertical?
How the text should be aligned vertically.
final
textCapitalization → TextCapitalization
Configures how the platform keyboard will select an uppercase or lowercase keyboard. Defaults to TextCapitalization.none.
final
textDirection → TextDirection?
The directionality of the text. Defaults to the ambient Directionality, if any.
final
textInputAction → TextInputAction?
The type of action button to use for the keyboard.
final
undoController → UndoHistoryController?
Controls the undo state.
final

Methods

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
toStringShort() → String
A brief description of this object, usually just the runtimeType and the hashCode.
inherited

Operators

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

Static Methods

defaultIconBuilder(BuildContext context, FTextFieldStyle style, Set<FTextFieldVariant> variants) → Widget
The search field's default prefix builder that displays a search icon.