TextField class

Inheritance

• Object
• DiagnosticableTree
• Widget
• StatefulWidget
• TextField

Available extensions

• AnimateWidgetExtensions
• DebugContainer
• IconExtension
• SkeletonExtension
• TextExtension
• WidgetExtension
• XAST
• XOnGestureWidget
• XWidget
• XWidgetArcane
• XWidgetEffect

Constructors

TextField({Key? key, ScrollController? scrollController, bool autocorrect = true, bool canRequestFocus = true, double? cursorHeight, TextCapitalization textCapitalization = TextCapitalization.none, EdgeInsets scrollPadding = EdgeInsets.zero, TextEditingController? controller, int? maxLength, MaxLengthEnforcement? maxLengthEnforcement, int? maxLines = 1, int? minLines, bool filled = false, String? placeholder, bool border = true, Widget? leading, Widget? trailing, EdgeInsetsGeometry? padding, ValueChanged<String>? onSubmitted, VoidCallback? onEditingComplete, FocusNode? focusNode, VoidCallback? onTap, bool enabled = true, bool readOnly = false, bool obscureText = false, String obscuringCharacter = '•', String? initialValue, BorderRadiusGeometry? borderRadius, TextInputType? keyboardType, TextAlign textAlign = TextAlign.start, bool expands = false, TextAlignVertical? textAlignVertical = TextAlignVertical.center, Iterable<String>? autofillHints, UndoHistoryController? undoController, ValueChanged<String>? onChanged, void onTapOutside(PointerDownEvent event)?, List<TextInputFormatter>? inputFormatters, TextStyle? style, EditableTextContextMenuBuilder? contextMenuBuilder = defaultContextMenuBuilder, bool useNativeContextMenu = false, bool? isCollapsed, TextInputAction? textInputAction, Clip clipBehavior = Clip.hardEdge, bool autofocus = false, AlignmentGeometry? placeholderAlignment, AlignmentGeometry? leadingAlignment, AlignmentGeometry? trailingAlignment, WidgetStatesController? statesController, TextStyle? placeholderStyle, EdgeInsets contentPadding = const EdgeInsets.symmetric(vertical: 4)})

const

Properties

asSliver → Widget

Available on Widget, provided by the XWidgetArcane extension

no setter

ast → Widget

Available on Widget, provided by the XAST extension

no setter

autocorrect → bool

final

autofillHints → Iterable<String>?

final

autofocus → bool

final

blurIn → Widget

Available on Widget, provided by the XWidgetEffect extension

no setter

border → bool

final

borderRadius → BorderRadiusGeometry?

final

canRequestFocus → bool

final

centered → Widget

Available on Widget, provided by the XWidget extension

no setter

clipBehavior → Clip

final

contentPadding → EdgeInsets

final

contextMenuBuilder → EditableTextContextMenuBuilder?

final

controller → TextEditingController?

final

cursorHeight → double?

final

enabled → bool

final

expand → Widget

Available on Widget, provided by the XWidget extension

no setter

expands → bool

final

filled → bool

final

flexible → Widget

Available on Widget, provided by the XWidget extension

no setter

focusNode → FocusNode?

final

hashCode → int

The hash code for this object.

no setter, inherited

ih → Widget

Available on Widget, provided by the XWidgetArcane extension

no setter

initialValue → String?

final

inputFormatters → List<TextInputFormatter>?

final

intrinsicHeight → Widget

Available on Widget, provided by the XWidget extension

no setter

intrinsicSize → Widget

Available on Widget, provided by the XWidget extension

no setter

intrinsicWidth → Widget

Available on Widget, provided by the XWidget extension

no setter

isCollapsed → bool?

final

iw → Widget

Available on Widget, provided by the XWidgetArcane extension

no setter

key → Key?

Controls how one widget replaces another widget in the tree.

final, inherited

keyboardType → TextInputType?

final

leading → Widget?

final

leadingAlignment → AlignmentGeometry?

final

maxLength → int?

final

maxLengthEnforcement → MaxLengthEnforcement?

final

maxLines → int?

final

minLines → int?

final

obscureText → bool

final

obscuringCharacter → String

final

onChanged → ValueChanged<String>?

final

onEditingComplete → VoidCallback?

final

onSubmitted → ValueChanged<String>?

final

onTap → VoidCallback?

final

onTapOutside → void Function(PointerDownEvent event)?

final

padding → EdgeInsetsGeometry?

final

placeholder → String?

final

placeholderAlignment → AlignmentGeometry?

final

placeholderStyle → TextStyle?

final

readOnly → bool

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

safeArea → Widget

Available on Widget, provided by the XWidget extension

no setter

scrollable → Widget

Available on Widget, provided by the XWidget extension

no setter

scrollableHorizontal → Widget

Available on Widget, provided by the XWidget extension

no setter

scrollController → ScrollController?

final

scrollPadding → EdgeInsets

final

statesController → WidgetStatesController?

final

style → TextStyle?

final

textAlign → TextAlign

final

textAlignVertical → TextAlignVertical?

final

textCapitalization → TextCapitalization

final

textInputAction → TextInputAction?

final

trailing → Widget?

final

trailingAlignment → AlignmentGeometry?

final

undoController → UndoHistoryController?

final

useNativeContextMenu → bool

final

Methods

animate({Key? key, List<Effect>? effects, AnimateCallback? onInit, AnimateCallback? onPlay, AnimateCallback? onComplete, bool? autoPlay, Duration? delay, AnimationController? controller, Adapter? adapter, double? target, double? value}) → Animate

Available on Widget, provided by the AnimateWidgetExtensions extension

Wraps the target Widget in an Animate instance, and returns the instance for chaining calls. Ex. myWidget.animate() is equivalent to Animate(child: myWidget).

asSkeleton({bool enabled = true, bool leaf = false, Widget? replacement, bool unite = false, AsyncSnapshot? snapshot}) → Widget

Available on Widget, provided by the SkeletonExtension extension

asSkeletonSliver({bool enabled = true}) → Widget

Available on Widget, provided by the SkeletonExtension extension

base() → Widget

Available on Widget, provided by the TextExtension extension

black() → Widget

Available on Widget, provided by the TextExtension extension

blockQuote() → Widget

Available on Widget, provided by the TextExtension extension

bold() → Widget

Available on Widget, provided by the TextExtension extension

center({Key? key}) → Widget

Available on Widget, provided by the WidgetExtension extension

clip({Clip clipBehavior = Clip.hardEdge}) → Widget

Available on Widget, provided by the WidgetExtension extension

clipOval({Clip clipBehavior = Clip.antiAlias}) → Widget

Available on Widget, provided by the WidgetExtension extension

clipPath({Clip clipBehavior = Clip.antiAlias, required CustomClipper<Path> clipper}) → Widget

Available on Widget, provided by the WidgetExtension extension

clipRRect({BorderRadiusGeometry borderRadius = BorderRadius.zero, Clip clipBehavior = Clip.antiAlias}) → Widget

Available on Widget, provided by the WidgetExtension extension

constrained({double? minWidth, double? maxWidth, double? minHeight, double? maxHeight}) → Widget

Available on Widget, provided by the WidgetExtension extension

createElement() → StatefulElement

Creates a StatefulElement to manage this widget's location in the tree.

inherited

createState() → State<TextField>

Creates the mutable state for this widget at a given location in the tree.

override

debugContainer([Color color = Colors.red]) → Widget

Available on Widget, provided by the DebugContainer extension

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

ellipsis() → Widget

Available on Widget, provided by the TextExtension extension

excludeSkeleton({bool exclude = true}) → Widget

Available on Widget, provided by the SkeletonExtension extension

expanded({int flex = 1}) → Widget

Available on Widget, provided by the WidgetExtension extension

extraBold() → Widget

Available on Widget, provided by the TextExtension extension

extraLight() → Widget

Available on Widget, provided by the TextExtension extension

foreground() → Widget

Available on Widget, provided by the TextExtension extension

h1() → Widget

Available on Widget, provided by the TextExtension extension

h2() → Widget

Available on Widget, provided by the TextExtension extension

h3() → Widget

Available on Widget, provided by the TextExtension extension

h4() → Widget

Available on Widget, provided by the TextExtension extension

iconDestructiveForeground() → Widget

Available on Widget, provided by the IconExtension extension

iconLarge() → Widget

Available on Widget, provided by the IconExtension extension

iconMedium() → Widget

Available on Widget, provided by the IconExtension extension

iconMutedForeground() → Widget

Available on Widget, provided by the IconExtension extension

iconPrimary() → Widget

Available on Widget, provided by the IconExtension extension

iconPrimaryForeground() → Widget

Available on Widget, provided by the IconExtension extension

iconSecondary() → Widget

Available on Widget, provided by the IconExtension extension

iconSecondaryForeground() → Widget

Available on Widget, provided by the IconExtension extension

iconSmall() → Widget

Available on Widget, provided by the IconExtension extension

iconX2Large() → Widget

Available on Widget, provided by the IconExtension extension

iconX2Small() → Widget

Available on Widget, provided by the IconExtension extension

iconX3Large() → Widget

Available on Widget, provided by the IconExtension extension

iconX3Small() → Widget

Available on Widget, provided by the IconExtension extension

iconX4Large() → Widget

Available on Widget, provided by the IconExtension extension

iconX4Small() → Widget

Available on Widget, provided by the IconExtension extension

iconXLarge() → Widget

Available on Widget, provided by the IconExtension extension

iconXSmall() → Widget

Available on Widget, provided by the IconExtension extension

ignoreSkeleton() → Widget

Available on Widget, provided by the SkeletonExtension extension

inlineCode() → Widget

Available on Widget, provided by the TextExtension extension

intrinsic({double? stepWidth, double? stepHeight}) → Widget

Available on Widget, provided by the WidgetExtension extension

intrinsicHeight() → Widget

Available on Widget, provided by the WidgetExtension extension

intrinsicWidth({double? stepWidth, double? stepHeight}) → Widget

Available on Widget, provided by the WidgetExtension extension

italic() → Widget

Available on Widget, provided by the TextExtension extension

large() → Widget

Available on Widget, provided by the TextExtension extension

lead() → Widget

Available on Widget, provided by the TextExtension extension

li() → Widget

Available on Widget, provided by the TextExtension extension

light() → Widget

Available on Widget, provided by the TextExtension extension

medium() → Widget

Available on Widget, provided by the TextExtension extension

mono() → Widget

Available on Widget, provided by the TextExtension extension

muted() → Widget

Available on Widget, provided by the TextExtension extension

normal() → Widget

Available on Widget, provided by the TextExtension extension

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

onDoublePressed(VoidCallback action, {HitTestBehavior? behavior, Set<PointerDeviceKind>? supportedDevices}) → Widget

Available on Widget, provided by the XOnGestureWidget extension

onHover(void action(bool hovering)) → Widget

Available on Widget, provided by the XOnGestureWidget extension

onLongPressed(VoidCallback action, {HitTestBehavior? behavior, Set<PointerDeviceKind>? supportedDevices}) → Widget

Available on Widget, provided by the XOnGestureWidget extension

onLongSecondaryPressed(VoidCallback action, {HitTestBehavior? behavior, Set<PointerDeviceKind>? supportedDevices}) → Widget

Available on Widget, provided by the XOnGestureWidget extension

onLongTertiaryPressed(VoidCallback action, {HitTestBehavior? behavior, Set<PointerDeviceKind>? supportedDevices}) → Widget

Available on Widget, provided by the XOnGestureWidget extension

onPressed(VoidCallback action, {HitTestBehavior? behavior, Set<PointerDeviceKind>? supportedDevices}) → Widget

Available on Widget, provided by the XOnGestureWidget extension

onSecondaryPressed(VoidCallback action, {HitTestBehavior? behavior, Set<PointerDeviceKind>? supportedDevices}) → Widget

Available on Widget, provided by the XOnGestureWidget extension

onTertiaryPressed(VoidCallback action, {HitTestBehavior? behavior, Set<PointerDeviceKind>? supportedDevices}) → Widget

Available on Widget, provided by the XOnGestureWidget extension

p({bool firstChild = false}) → Widget

Available on Widget, provided by the TextExtension extension

pad(double all) → Widget

Available on Widget, provided by the XWidget extension

padBottom(double value) → Widget

Available on Widget, provided by the XWidget extension

padLeft(double value) → Widget

Available on Widget, provided by the XWidget extension

padOnly({double left = 0, double top = 0, double right = 0, double bottom = 0}) → Widget

Available on Widget, provided by the XWidget extension

padRight(double value) → Widget

Available on Widget, provided by the XWidget extension

padTop(double value) → Widget

Available on Widget, provided by the XWidget extension

positioned({Key? key, double? left, double? top, double? right, double? bottom}) → Widget

Available on Widget, provided by the WidgetExtension extension

primaryForeground() → Widget

Available on Widget, provided by the TextExtension extension

sans() → Widget

Available on Widget, provided by the TextExtension extension

secondaryForeground() → Widget

Available on Widget, provided by the TextExtension extension

semiBold() → Widget

Available on Widget, provided by the TextExtension extension

singleLine() → Widget

Available on Widget, provided by the TextExtension extension

sized({double? width, double? height}) → Widget

Available on Widget, provided by the WidgetExtension extension

sized({double? width, double? height}) → Widget

Available on Widget, provided by the XWidget extension

small() → Widget

Available on Widget, provided by the TextExtension extension

textCenter() → Widget

Available on Widget, provided by the TextExtension extension

textEnd() → Widget

Available on Widget, provided by the TextExtension extension

textJustify() → Widget

Available on Widget, provided by the TextExtension extension

textLarge() → Widget

Available on Widget, provided by the TextExtension extension

textLeft() → Widget

Available on Widget, provided by the TextExtension extension

textMuted() → Widget

Available on Widget, provided by the TextExtension extension

textRight() → Widget

Available on Widget, provided by the TextExtension extension

textSmall() → Widget

Available on Widget, provided by the TextExtension extension

textStart() → Widget

Available on Widget, provided by the TextExtension extension

then(InlineSpan span) → Widget

Available on Widget, provided by the TextExtension extension

thenButton({required VoidCallback onPressed, required Widget child}) → Widget

Available on Widget, provided by the TextExtension extension

thenInlineCode(String text) → Widget

Available on Widget, provided by the TextExtension extension

thenText(String text) → Widget

Available on Widget, provided by the TextExtension extension

thin() → Widget

Available on Widget, provided by the TextExtension extension

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, int wrapWidth = 65}) → 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

transform({Key? key, required Matrix4 transform}) → Widget

Available on Widget, provided by the WidgetExtension extension

underline() → Widget

Available on Widget, provided by the TextExtension extension

withAlign(AlignmentGeometry alignment) → Widget

Available on Widget, provided by the WidgetExtension extension

withMargin({double? top, double? bottom, double? left, double? right, double? horizontal, double? vertical, double? all}) → Widget

Available on Widget, provided by the WidgetExtension extension

withOpacity(double opacity) → Widget

Available on Widget, provided by the WidgetExtension extension

withPadding({double? top, double? bottom, double? left, double? right, double? horizontal, double? vertical, double? all, EdgeInsetsGeometry? padding}) → Widget

Available on Widget, provided by the WidgetExtension extension

withTooltip(String tooltip) → Widget

Available on Widget, provided by the XWidgetArcane extension

x2Large() → Widget

Available on Widget, provided by the TextExtension extension

x3Large() → Widget

Available on Widget, provided by the TextExtension extension

x4Large() → Widget

Available on Widget, provided by the TextExtension extension

x5Large() → Widget

Available on Widget, provided by the TextExtension extension

x6Large() → Widget

Available on Widget, provided by the TextExtension extension

x7Large() → Widget

Available on Widget, provided by the TextExtension extension

x8Large() → Widget

Available on Widget, provided by the TextExtension extension

x9Large() → Widget

Available on Widget, provided by the TextExtension extension

xLarge() → Widget

Available on Widget, provided by the TextExtension extension

xSmall() → Widget

Available on Widget, provided by the TextExtension extension

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Static Methods

defaultContextMenuBuilder(BuildContext context, EditableTextState editableTextState) → Widget