InputDecorationTextField class

Inheritance

• Object
• InputDecoration
• InputDecorationTextField

Constructors

InputDecorationTextField({String? counterTxt, TextStyle? counterTxtStyle, Widget? counterWidget, String? semanticCounterTxt, EdgeInsetsGeometry? contentEdgePadding, String? helperTxt, TextStyle? helperTxtStyle, int? helperTxtMaxLines, Color? onHoverColor, Color? onFocusColor, TextDirection? hintTxtDirection, TextStyle? hintTxtStyle, int? hintTxtMaxLines, TextStyle? errorTxtStyle, int? errorTxtMaxLines, Widget? iconImage, Color? iconImageColor, bool? dense, bool? collapsed, InputBorder? inputBorder, String? prefixTxt, String? suffixTxt, Widget? prefixIconImage, Widget? suffixIconImage, BoxConstraints? prefixConstraints, BoxConstraints? suffixConstraints, Color? suffixColor, Color? prefixColor, InputBorder? focusedErrorInputBorder, String? hint, String? errorMsg, bool? isFilled, bool? isEnabled, InputBorder? focusedInputBorder, InputBorder? errorInputBorder, InputBorder? enabledInputBorder, InputBorder? disabledInputBorder, Color? filledColor, TextStyle? prefixTextStyling, TextStyle? suffixTextStyling})

const

Properties

alignLabelWithHint → bool?

Typically set to true when the InputDecorator contains a multiline TextField (TextField.maxLines is null or > 1) to override the default behavior of aligning the label with the center of the TextField.

final, inherited

border → InputBorder?

The shape of the border to draw around the decoration's container.

no setter, override

collapsed → bool?

final

constraints → BoxConstraints?

Defines minimum and maximum sizes for the InputDecorator.

final, inherited

contentEdgePadding → EdgeInsetsGeometry?

final

contentPadding → EdgeInsetsGeometry?

The padding for the input decoration's container.

no setter, override

counter → Widget?

Optional custom counter widget to go in the place otherwise occupied by counterText. If this property is non null, then counterText is ignored.

no setter, override

counterStyle → TextStyle?

The style to use for the counterText.

no setter, override

counterText → String?

Optional text to place below the line as a character count.

no setter, override

counterTxt → String?

final

counterTxtStyle → TextStyle?

final

counterWidget → Widget?

final

dense → bool?

final

disabledBorder → InputBorder?

The border to display when the InputDecorator is disabled and is not showing an error.

no setter, override

disabledInputBorder → InputBorder?

final

enabled → bool

If false the opacity of the visual elements is reduced, including helperText,errorText, and counterText.

no setter, override

enabledBorder → InputBorder?

The border to display when the InputDecorator is enabled and is not showing an error.

no setter, override

enabledInputBorder → InputBorder?

final

error → Widget?

Optional widget that appears below the InputDecorator.child and the border.

final, inherited

errorBorder → InputBorder?

The border to display when the InputDecorator does not have the focus and is showing an error.

no setter, override

errorInputBorder → InputBorder?

final

errorMaxLines → int?

The maximum number of lines the errorText can occupy.

no setter, override

errorMsg → String?

final

errorStyle → TextStyle?

The style to use for the InputDecoration.errorText.

no setter, override

errorText → String?

Text that appears below the InputDecorator.child and the border.

no setter, override

errorTxtMaxLines → int?

final

errorTxtStyle → TextStyle?

final

fillColor → Color?

The base fill color of the decoration's container color.

no setter, override

filled → bool?

If true the decoration's container is filled with fillColor.

no setter, override

filledColor → Color?

final

floatingLabelAlignment → FloatingLabelAlignment?

Defines where the floating label should be displayed.

final, inherited

floatingLabelBehavior → FloatingLabelBehavior?

Defines how the floating label should behave.

final, inherited

floatingLabelStyle → TextStyle?

The style to use for InputDecoration.labelText when the label is above (i.e., vertically adjacent to) the input field.

final, inherited

focusColor → Color?

The fill color of the decoration's container when it has the input focus.

no setter, override

focusedBorder → InputBorder?

The border to display when the InputDecorator has the focus and is not showing an error.

no setter, override

focusedErrorBorder → InputBorder?

The border to display when the InputDecorator has the focus and is showing an error.

no setter, override

focusedErrorInputBorder → InputBorder?

final

focusedInputBorder → InputBorder?

final

hashCode → int

The hash code for this object.

no setter, inherited

helper → Widget?

Optional widget that appears below the InputDecorator.child.

final, inherited

helperMaxLines → int?

The maximum number of lines the helperText can occupy.

no setter, override

helperStyle → TextStyle?

The style to use for the helperText.

no setter, override

helperText → String?

Text that provides context about the InputDecorator.child's value, such as how the value will be used.

no setter, override

helperTxt → String?

final

helperTxtMaxLines → int?

final

helperTxtStyle → TextStyle?

final

hint → String?

The widget to use in place of the hintText.

final

hintFadeDuration → Duration?

The duration of the hintText fade in and fade out animations.

final, inherited

hintMaxLines → int?

The maximum number of lines the hintText can occupy.

no setter, override

hintStyle → TextStyle?

The style to use for the hintText.

no setter, override

hintText → String?

Text that suggests what sort of input the field accepts.

no setter, override

hintTextDirection → TextDirection?

The direction to use for the hintText.

no setter, override

hintTxtDirection → TextDirection?

final

hintTxtMaxLines → int?

final

hintTxtStyle → TextStyle?

final

hoverColor → Color?

The color of the highlight for the decoration shown if the container is being hovered over by a mouse.

no setter, override

icon → Widget?

An icon to show before the input field and outside of the decoration's container.

no setter, override

iconColor → Color?

The color of the icon.

no setter, override

iconImage → Widget?

final

iconImageColor → Color?

final

inputBorder → InputBorder?

final

isCollapsed → bool

Whether the decoration is the same size as the input field.

no setter, override

isDense → bool?

Whether the InputDecorator.child is part of a dense form (i.e., uses less vertical space).

no setter, override

isEnabled → bool?

final

isFilled → bool?

final

label → Widget?

Optional widget that describes the input field.

final, inherited

labelStyle → TextStyle?

The style to use for InputDecoration.labelText when the label is on top of the input field.

final, inherited

labelText → String?

Optional text that describes the input field.

final, inherited

maintainHintHeight → bool

Whether the input field's height should always be greater than or equal to the height of the hintText, even if the hintText is not visible.

final, inherited

maintainHintSize → bool

Whether the input field's size should always be greater than or equal to the size of the hintText, even if the hintText is not visible.

final, inherited

onFocusColor → Color?

final

onHoverColor → Color?

final

prefix → Widget?

Optional widget to place on the line before the input.

final, inherited

prefixColor → Color?

final

prefixConstraints → BoxConstraints?

final

prefixIcon → Widget?

An icon that appears before the prefix or prefixText and before the editable part of the text field, within the decoration's container.

no setter, override

prefixIconColor → Color?

Optional color of the prefixIcon

no setter, override

prefixIconConstraints → BoxConstraints?

The constraints for the prefix icon.

no setter, override

prefixIconImage → Widget?

final

prefixStyle → TextStyle?

The style to use for the prefixText.

no setter, override

prefixText → String?

Optional text prefix to place on the line before the input.

no setter, override

prefixTextStyling → TextStyle?

final

prefixTxt → String?

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

semanticCounterText → String?

A semantic label for the counterText.

no setter, override

semanticCounterTxt → String?

final

suffix → Widget?

Optional widget to place on the line after the input.

final, inherited

suffixColor → Color?

final

suffixConstraints → BoxConstraints?

final

suffixIcon → Widget?

An icon that appears after the editable part of the text field and after the suffix or suffixText, within the decoration's container.

no setter, override

suffixIconColor → Color?

Optional color of the suffixIcon.

no setter, override

suffixIconConstraints → BoxConstraints?

The constraints for the suffix icon.

no setter, override

suffixIconImage → Widget?

final

suffixStyle → TextStyle?

The style to use for the suffixText.

no setter, override

suffixText → String?

Optional text suffix to place on the line after the input.

no setter, override

suffixTextStyling → TextStyle?

final

suffixTxt → String?

final

visualDensity → VisualDensity?

Defines how compact the decoration's layout will be.

final, inherited

Methods

applyDefaults(Object inputDecorationTheme) → InputDecoration

Used by widgets like TextField and InputDecorator to create a new InputDecoration with default values taken from the inputDecorationTheme.

inherited

copyWith({Widget? icon, Color? iconColor, Widget? label, String? labelText, TextStyle? labelStyle, TextStyle? floatingLabelStyle, Widget? helper, String? helperText, TextStyle? helperStyle, int? helperMaxLines, String? hintText, Widget? hint, TextStyle? hintStyle, TextDirection? hintTextDirection, Duration? hintFadeDuration, int? hintMaxLines, bool? maintainHintHeight, bool? maintainHintSize, Widget? error, String? errorText, TextStyle? errorStyle, int? errorMaxLines, FloatingLabelBehavior? floatingLabelBehavior, FloatingLabelAlignment? floatingLabelAlignment, bool? isCollapsed, bool? isDense, EdgeInsetsGeometry? contentPadding, Widget? prefixIcon, Widget? prefix, String? prefixText, BoxConstraints? prefixIconConstraints, TextStyle? prefixStyle, Color? prefixIconColor, Widget? suffixIcon, Widget? suffix, String? suffixText, TextStyle? suffixStyle, Color? suffixIconColor, BoxConstraints? suffixIconConstraints, Widget? counter, String? counterText, TextStyle? counterStyle, bool? filled, Color? fillColor, Color? focusColor, Color? hoverColor, InputBorder? errorBorder, InputBorder? focusedBorder, InputBorder? focusedErrorBorder, InputBorder? disabledBorder, InputBorder? enabledBorder, InputBorder? border, bool? enabled, String? semanticCounterText, bool? alignLabelWithHint, BoxConstraints? constraints, VisualDensity? visualDensity, SemanticsService? semanticsService}) → InputDecoration

Creates a copy of this input decoration with the given fields replaced by the new values.

inherited

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited