FormeTextField class

Inheritance

Constructors

FormeTextField({Key? key, String? name, String initialValue = '', FormeAsyncValidator<String>? asyncValidator, Duration? asyncValidatorDebounce, AutovalidateMode? autovalidateMode, FormeFieldDecorator<String>? decorator, bool enabled = true, FocusNode? focusNode, FormeFieldInitialized<String>? onInitialized, FormeFieldSetter<String>? onSaved, FormeFieldStatusChanged<String>? onStatusChanged, int? order, bool quietlyValidate = false, bool readOnly = false, bool requestFocusOnUserInteraction = true, FormeFieldValidationFilter<String>? validationFilter, FormeValidator<String>? validator, bool updateValueWhenComposing = false, bool selectAllOnFocus = false, InputDecoration? decoration = const InputDecoration(), int? maxLines = 1, TextInputType? keyboardType, bool autofocus = false, int? minLines, int? maxLength, TextStyle? style, TextInputAction? textInputAction, TextCapitalization textCapitalization = TextCapitalization.none, bool obscureText = false, StrutStyle? strutStyle, TextAlign textAlign = TextAlign.start, TextAlignVertical? textAlignVertical, TextDirection? textDirection, bool? showCursor, String obscuringCharacter = '•', bool autocorrect = true, SmartDashesType? smartDashesType, SmartQuotesType? smartQuotesType, bool enableSuggestions = true, bool expands = false, MaxLengthEnforcement? maxLengthEnforcement, double cursorWidth = 2.0, double? cursorHeight, Radius? cursorRadius, Color? cursorColor, BoxHeightStyle selectionHeightStyle = BoxHeightStyle.tight, BoxWidthStyle selectionWidthStyle = BoxWidthStyle.tight, Brightness? keyboardAppearance, EdgeInsets scrollPadding = const EdgeInsets.all(20), DragStartBehavior dragStartBehavior = DragStartBehavior.start, MouseCursor? mouseCursor, ScrollPhysics? scrollPhysics, Iterable<String>? autofillHints, bool enableInteractiveSelection = true, VoidCallback? onEditingComplete, List<TextInputFormatter>? inputFormatters, AppPrivateCommandCallback? appPrivateCommandCallback, InputCounterWidgetBuilder? buildCounter, GestureTapCallback? onTap, ValueChanged<String>? onSubmitted, ScrollController? scrollController, TextSelectionControls? textSelectionControls, bool enableIMEPersonalizedLearning = true, TapRegionCallback? onTapOutside, Clip? clipBehavior, bool? scribbleEnabled, EditableTextContextMenuBuilder? contextMenuBuilder = _defaultContextMenuBuilder, SpellCheckConfiguration? spellCheckConfiguration, TextMagnifierConfiguration? magnifierConfiguration})

Properties

appPrivateCommandCallback AppPrivateCommandCallback?
final
asyncValidator → FormeAsyncValidator<String>?
used to perform an async validation
finalinherited
asyncValidatorDebounce Duration?
not worked when validate manually
finalinherited
autocorrect bool
final
autofillHints Iterable<String>?
final
autofocus bool
final
autovalidateMode AutovalidateMode
finalinherited
buildCounter InputCounterWidgetBuilder?
final
builder → FormeFieldBuilder<String>
finalinherited
clipBehavior Clip?
final
contextMenuBuilder EditableTextContextMenuBuilder?
final
cursorColor Color?
final
cursorHeight double?
final
cursorRadius Radius?
final
cursorWidth double
final
decoration InputDecoration?
final
decorator → FormeFieldDecorator<String>?
used to decorate field
finalinherited
dragStartBehavior DragStartBehavior
final
enabled bool
whether field is enabled,
finalinherited
enableIMEPersonalizedLearning bool
final
enableInteractiveSelection bool
final
enableSuggestions bool
final
expands bool
final
fieldType Type
no setterinherited
focusNode FocusNode?
finalinherited
hashCode int
The hash code for this object.
no setterinherited
initialValue String
initial value
finalinherited
inputFormatters List<TextInputFormatter>?
final
key Key?
Controls how one widget replaces another widget in the tree.
finalinherited
keyboardAppearance Brightness?
final
keyboardType TextInputType?
final
magnifierConfiguration TextMagnifierConfiguration?
final
maxLength int?
final
maxLengthEnforcement MaxLengthEnforcement?
final
maxLines int?
final
minLines int?
final
mouseCursor MouseCursor?
final
name String?
field name
finalinherited
obscureText bool
final
obscuringCharacter String
final
onEditingComplete VoidCallback?
final
onInitialized → FormeFieldInitialized<String>?
called immediately after FormeFieldState.initStatus
finalinherited
onSaved → FormeFieldSetter<String>?
finalinherited
onStatusChanged → FormeFieldStatusChanged<String>?
listen field status change
finalinherited
onSubmitted ValueChanged<String>?
final
onTap GestureTapCallback?
final
onTapOutside TapRegionCallback?
final
order int?
used to support Forme.autovalidateByOrder
finalinherited
quietlyValidate bool
quietlyValidate
finalinherited
readOnly bool
finalinherited
requestFocusOnUserInteraction bool
whether request focus when field value changed
finalinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
scribbleEnabled bool?
final
scrollController ScrollController?
final
scrollPadding EdgeInsets
final
scrollPhysics ScrollPhysics?
final
selectAllOnFocus bool
final
selectionHeightStyle BoxHeightStyle
final
selectionWidthStyle BoxWidthStyle
final
showCursor bool?
final
smartDashesType SmartDashesType?
final
smartQuotesType SmartQuotesType?
final
spellCheckConfiguration SpellCheckConfiguration?
final
strutStyle StrutStyle?
final
style TextStyle?
final
textAlign TextAlign
final
textAlignVertical TextAlignVertical?
final
textCapitalization TextCapitalization
final
textDirection TextDirection?
final
textInputAction TextInputAction?
final
textSelectionControls TextSelectionControls?
final
updateValueWhenComposing bool
whether update value when text input is composing
final
validationFilter → FormeFieldValidationFilter<String>?
used to determine whether perform a validation
finalinherited
validator → FormeValidator<String>?
sync validator
finalinherited

Methods

createElement() StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() FormeTextFieldState
Creates the mutable state for this widget at a given location in the tree.
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