A basic text input control.

This control is not intended to be used directly. Instead, consider using Input, which provides focus management and material design.

Inheritance

Constructors

RawInput({Key key, @required InputValue value, GlobalKey focusKey, bool hideText: false, TextStyle style, Color cursorColor, double textScaleFactor, int maxLines: 1, bool autofocus: false, Color selectionColor, TextSelectionControls selectionControls, @required TargetPlatform platform, TextInputType keyboardType, ValueChanged<InputValue> onChanged, ValueChanged<InputValue> onSubmitted })

Creates a basic text input control.

Properties

autofocus bool

Whether this input field should focus itself if nothing else is already focused. If true, the keyboard will open as soon as this input obtains focus. Otherwise, the keyboard is only shown after the user taps the text field.

read-only
cursorColor Color

The color to use when painting the cursor.

read-only
focusKey GlobalKey

Key of the enclosing widget that holds the focus.

read-only
hideText bool

Whether to hide the text being edited (e.g., for passwords).

read-only
keyboardType TextInputType

The type of keyboard to use for editing the text.

read-only
maxLines int

The maximum number of lines for the text to span, wrapping if necessary. If this is 1 (the default), the text will not wrap, but will scroll horizontally instead.

read-only
onChanged ValueChanged<InputValue>

Called when the text being edited changes.

read-only
onSubmitted ValueChanged<InputValue>

Called when the user indicates that they are done editing the text in the field.

read-only
platform TargetPlatform

The platform whose behavior should be approximated, in particular for scroll physics. (See ScrollBehavior.platform.)

read-only
selectionColor Color

The color to use when painting the selection.

read-only
selectionControls TextSelectionControls

Optional delegate for building the text selection handles and toolbar.

read-only
style TextStyle

The text style to use for the editable text.

read-only
textScaleFactor double

The number of font pixels for each logical pixel.

read-only
value InputValue

The string being displayed in this widget.

read-only
builder ScrollBuilder

Using to build the content of this widget.

read-only, inherited
hashCode int

Get a hash code for this object.

read-only, inherited
initialScrollOffset double

The scroll offset this widget should use when first created.

read-only, inherited
key Key

Controls how one widget replaces another widget in the tree.

read-only, inherited
onScroll ScrollListener

Called whenever this widget's scroll offset changes.

read-only, inherited
onScrollEnd ScrollListener

Called whenever this widget stops scrolling.

read-only, inherited
onScrollStart ScrollListener

Called whenever this widget starts to scroll.

read-only, inherited
runtimeType Type

A representation of the runtime type of the object.

read-only, inherited
scrollAnchor ViewportAnchor

Whether to place first child at the start of the container or the last child at the end of the container, when the scrollable has not been scrolled and has no initial scroll offset.

read-only, inherited
scrollDirection Axis

The axis along which this widget should scroll.

read-only, inherited
snapOffsetCallback SnapOffsetCallback

Called to determine the offset to which scrolling should snap, when handling a fling.

read-only, inherited

Operators

operator ==(other) bool

The equality operator.

inherited

Methods

createState() RawInputState

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

createElement() StatefulElement

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

inherited
debugFillDescription(List<String> description) → void

Add additional information to the given description for use by toString.

inherited
noSuchMethod(Invocation invocation) → dynamic

Invoked when a non-existent method or property is accessed.

inherited
toString() String

Returns a string representation of this object.

inherited
toStringShort() String

A short, textual description of this widget.

inherited