TimePickerDialog class
A Material Design time picker designed to appear inside a popup dialog.
Pass this widget to showDialog. The value returned by showDialog is the selected TimeOfDay if the user taps the "OK" button, or null if the user taps the "CANCEL" button. The selected time is reported by calling Navigator.pop.
Use showTimePicker to show a dialog already containing a TimePickerDialog.
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatefulWidget
- TimePickerDialog
Constructors
- TimePickerDialog({Key? key, required TimeOfDay initialTime, String? cancelText, String? confirmText, String? helpText, String? errorInvalidText, String? hourLabelText, String? minuteLabelText, String? restorationId, TimePickerEntryMode initialEntryMode = TimePickerEntryMode.dial, Orientation? orientation, EntryModeChangeCallback? onEntryModeChanged, Icon? switchToInputEntryModeIcon, Icon? switchToTimerEntryModeIcon, bool emptyInitialInput = false})
-
Creates a Material Design time picker.
const
Properties
- cancelText → String?
-
Optionally provide your own text for the cancel button.
final
- confirmText → String?
-
Optionally provide your own text for the confirm button.
final
- emptyInitialInput → bool
-
If true and entry mode is TimePickerEntryMode.input, the hour and minute
fields will be empty on start instead of pre-filled with initialTime.
final
- errorInvalidText → String?
-
Optionally provide your own validation error text.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- helpText → String?
-
Optionally provide your own help text to the header of the time picker.
final
- hourLabelText → String?
-
Optionally provide your own hour label text.
final
- initialEntryMode → TimePickerEntryMode
-
The entry mode for the picker. Whether it's text input or a dial.
final
- initialTime → TimeOfDay
-
The time initially selected when the dialog is shown.
final
- key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
- minuteLabelText → String?
-
Optionally provide your own minute label text.
final
- onEntryModeChanged → EntryModeChangeCallback?
-
Callback called when the selected entry mode is changed.
final
- orientation → Orientation?
-
The optional orientation parameter sets the Orientation to use when
displaying the dialog.
final
- restorationId → String?
-
Restoration ID to save and restore the state of the TimePickerDialog.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- switchToInputEntryModeIcon → Icon?
-
The optional switchToInputEntryModeIcon argument can be used to customize
the input method icon that is shown when the TimePickerEntryMode
is TimePickerEntryMode.dial.
final
- switchToTimerEntryModeIcon → Icon?
-
The optional switchToTimerEntryModeIcon argument can be used to customize
the input method icon that is shown when the TimePickerEntryMode
is TimePickerEntryMode.input.
final
Methods
-
createElement(
) → StatefulElement -
Creates a StatefulElement to manage this widget's location in the tree.
inherited
-
createState(
) → State< TimePickerDialog> -
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.
inherited
-
debugFillProperties(
DiagnosticPropertiesBuilder properties) → void -
Add additional properties associated with the node.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent 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, int wrapWidth = 65}) → 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.
inherited
