InputDecorator class Null safety

Defines the appearance of a Material Design text field.

InputDecorator displays the visual elements of a Material Design text field around its input child. The visual elements themselves are defined by an InputDecoration object and their layout and appearance depend on the baseStyle, textAlign, isFocused, and isEmpty parameters.

TextField uses this widget to decorate its EditableText child.

InputDecorator can be used to create widgets that look and behave like a TextField but support other kinds of input.

Requires one of its ancestors to be a Material widget. The child widget, as well as the decorative widgets specified in decoration, must have non-negative baselines.

See also:

Inheritance

Constructors

InputDecorator({Key? key, required InputDecoration decoration, TextStyle? baseStyle, TextAlign? textAlign, TextAlignVertical? textAlignVertical, bool isFocused, bool isHovering, bool expands, bool isEmpty, Widget? child})
Creates a widget that displays a border, labels, and icons, for a TextField. [...]
const

Properties

baseStyle TextStyle?
The style on which to base the label, hint, counter, and error styles if the decoration does not provide explicit styles. [...]
final
child Widget?
The widget below this widget in the tree. [...]
final
decoration InputDecoration
The text and styles to use when decorating the child. [...]
final
expands bool
If true, the height of the input field will be as large as possible. [...]
final
hashCode int
The hash code for this object. [...]
@nonVirtual, read-only, inherited
isEmpty bool
Whether the input field is empty. [...]
final
isFocused bool
Whether the input field has focus. [...]
final
isHovering bool
Whether the input field is being hovered over by a mouse pointer. [...]
final
key Key?
Controls how one widget replaces another widget in the tree. [...]
final, inherited
runtimeType Type
A representation of the runtime type of the object.
read-only, inherited
textAlign TextAlign?
How the text in the decoration should be aligned horizontally.
final
textAlignVertical TextAlignVertical?
How the text should be aligned vertically. [...]
final

Methods

createElement() StatefulElement
Creates a StatefulElement to manage this widget's location in the tree. [...]
inherited
createState() → _InputDecoratorState
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. [...]
@protected, inherited
debugFillProperties(DiagnosticPropertiesBuilder properties) → void
Add additional properties associated with the node. [...]
override
noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent 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. [...]
@nonVirtual, inherited

Static Methods

containerOf(BuildContext context) RenderBox?
The RenderBox that defines this decorator's "container". That's the area which is filled if InputDecoration.filled is true. It's the area adjacent to InputDecoration.icon and above the widgets that contain InputDecoration.helperText, InputDecoration.errorText, and InputDecoration.counterText. [...]