DateTimeField class

A FormField<DateTime> that integrates a text input with time-chooser UIs.

It borrows many of it's parameters from TextFormField.

When a controller is specified, initialValue must be null (the default).

Inheritance

Constructors

DateTimeField({@required DateFormat format, @required Future<DateTime> onShowPicker(BuildContext context, DateTime currentValue), Key key, FormFieldSetter<DateTime> onSaved, FormFieldValidator<DateTime> validator, DateTime initialValue, bool autovalidate: false, bool enabled: true, Icon resetIcon: const Icon(Icons.close), void onChanged(DateTime value), TextEditingController controller, FocusNode focusNode, InputDecoration decoration: const InputDecoration(), TextInputType keyboardType, TextCapitalization textCapitalization: TextCapitalization.none, TextInputAction textInputAction, TextStyle style, StrutStyle strutStyle, TextDirection textDirection, TextAlign textAlign: TextAlign.start, bool autofocus: false, bool readOnly: false, bool showCursor, bool obscureText: false, bool autocorrect: true, bool maxLengthEnforced: true, int maxLines: 1, int minLines, bool expands: false, int maxLength, VoidCallback onEditingComplete, ValueChanged<DateTime> onFieldSubmitted, List<TextInputFormatter> inputFormatters, double cursorWidth: 2.0, Radius cursorRadius, Color cursorColor, Brightness keyboardAppearance, EdgeInsets scrollPadding: const EdgeInsets.all(20.0), bool enableInteractiveSelection: true, InputCounterWidgetBuilder buildCounter })

Properties

controller TextEditingController
final
focusNode FocusNode
final
format DateFormat
For representing the date as a string e.g. DateFormat("EEEE, MMMM d, yyyy 'at' h:mma") (Sunday, June 3, 2018 at 9:24pm)
final
onChanged → void Function(DateTime value)
final
onShowPicker → Future<DateTime> Function(BuildContext context, DateTime currentValue)
Called when the date chooser dialog should be shown.
final
readOnly → bool
final
resetIcon Icon
The InputDecoration.suffixIcon to show when the field has text. Tapping the icon will clear the text field. Set this to null to disable that behavior. Also, setting the suffix icon yourself will override this option.
final
autovalidate → bool
If true, this form field will validate and update its error text immediately after every change. Otherwise, you must call FormFieldState.validate to validate. If part of a Form that auto-validates, this value will be ignored.
final, inherited
builder FormFieldBuilder<DateTime>
Function that returns the widget representing this form field. It is passed the form field state as input, containing the current value and validation state of this field.
final, inherited
enabled → bool
Whether the form is able to receive user input. [...]
final, inherited
hashCode → int
The hash code for this object.
read-only, inherited
initialValue → DateTime
An optional value to initialize the form field to, or null otherwise.
final, inherited
key Key
Controls how one widget replaces another widget in the tree. [...]
final, inherited
onSaved FormFieldSetter<DateTime>
An optional method to call with the final value when the form is saved via FormState.save.
final, inherited
runtimeType → Type
A representation of the runtime type of the object.
read-only, inherited
validator FormFieldValidator<DateTime>
An optional method that validates an input. Returns an error string to display if the input is invalid, or null otherwise. [...]
final, inherited

Methods

createState() → _DateTimeFieldState
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.debug }) → 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 ==(dynamic other) → bool
The equality operator.
inherited

Static Methods

combine(DateTime date, TimeOfDay time) → DateTime
Sets the hour and minute of a DateTime from a TimeOfDay.
convert(TimeOfDay time) → DateTime
tryFormat(DateTime date, DateFormat format) → String
Returns an empty string if DateFormat.format() throws or date is null.
tryParse(String string, DateFormat format) → DateTime
Returns null if format.parse() throws.