InputDatePickerFormField class

A TextFormField configured to accept and validate a date entered by the user.

The text entered into this field will be constrained to only allow digits and separators. When saved or submitted, the text will be parsed into a DateTime according to the ambient locale. If the input text doesn't parse into a date, the errorFormatText message will be displayed under the field.

firstDate, lastDate, and selectableDayPredicate provide constraints on what days are valid. If the input date isn't in the date range or doesn't pass the given predicate, then the errorInvalidText message will be displayed under the field.

See also:

Inheritance

Constructors

InputDatePickerFormField({Key key, DateTime initialDate, @required DateTime firstDate, @required DateTime lastDate, ValueChanged<DateTime> onDateSubmitted, ValueChanged<DateTime> onDateSaved, SelectableDayPredicate selectableDayPredicate, String errorFormatText, String errorInvalidText, String fieldHintText, String fieldLabelText, bool autofocus: false})
Creates a TextFormField configured to accept and validate a date. [...]

Properties

autofocus bool
Whether this text field should focus itself if nothing else is already focused. [...]
final
errorFormatText String
The error text displayed if the entered date is not in the correct format.
final
errorInvalidText String
The error text displayed if the date is not valid. [...]
final
fieldHintText String
The hint text displayed in the TextField. [...]
final
fieldLabelText String
The label text displayed in the TextField. [...]
final
firstDate DateTime
The earliest allowable DateTime that the user can input.
final
initialDate DateTime
If provided, it will be used as the default value of the field.
final
lastDate DateTime
The latest allowable DateTime that the user can input.
final
onDateSaved ValueChanged<DateTime>
An optional method to call with the final date when the form is saved via FormState.save. Will only be called if the input represents a valid DateTime.
final
onDateSubmitted ValueChanged<DateTime>
An optional method to call when the user indicates they are done editing the text in the field. Will only be called if the input represents a valid DateTime.
final
selectableDayPredicate SelectableDayPredicate
Function to provide full control over which DateTime can be selected.
final
hashCode int
The hash code for this object.
@nonVirtual, read-only, inherited
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

Methods

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