DatePickerDialog class

A Material-style date picker dialog.

It is used internally by showPersianDatePicker or can be directly pushed onto the Navigator stack to enable state restoration. See showPersianDatePicker for a state restoration app example.

See also:

Inheritance

Constructors

DatePickerDialog({Key? key, Jalali? initialDate, required Jalali firstDate, required Jalali lastDate, Jalali? currentDate, PersianDatePickerEntryMode initialEntryMode = PersianDatePickerEntryMode.calendar, PersianSelectableDayPredicate? selectableDayPredicate, String? cancelText, String? confirmText, String? helpText, PersianDatePickerMode initialCalendarMode = PersianDatePickerMode.day, String? errorFormatText, String? errorInvalidText, String? fieldHintText, String? fieldLabelText, TextInputType? keyboardType, String? restorationId, ValueChanged<PersianDatePickerEntryMode>? onDatePickerModeChange, Icon? switchToInputEntryModeIcon, Icon? switchToCalendarEntryModeIcon})
A Material-style date picker dialog.

Properties

cancelText String?
The text that is displayed on the cancel button.
final
confirmText String?
The text that is displayed on the confirm button.
final
currentDate Jalali
The Jalali representing today. It will be highlighted in the day grid.
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 Jalali
The earliest allowable Jalali that the user can select.
final
hashCode int
The hash code for this object.
no setterinherited
helpText String?
The text that is displayed at the top of the header.
final
initialCalendarMode PersianDatePickerMode
The initial display of the calendar picker.
final
initialDate Jalali?
The initially selected Jalali that the picker should display.
final
initialEntryMode PersianDatePickerEntryMode
The initial mode of date entry method for the date picker dialog.
final
key Key?
Controls how one widget replaces another widget in the tree.
finalinherited
keyboardType TextInputType?
The keyboard type of the TextField.
final
lastDate Jalali
The latest allowable Jalali that the user can select.
final
onDatePickerModeChange ValueChanged<PersianDatePickerEntryMode>?
Called when the DatePickerDialog is toggled between PersianDatePickerEntryMode.calendar,PersianDatePickerEntryMode.input.
final
restorationId String?
Restoration ID to save and restore the state of the DatePickerDialog.
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
selectableDayPredicate PersianSelectableDayPredicate?
Function to provide full control over which Jalali can be selected.
final
switchToCalendarEntryModeIcon Icon?
An optional switchToCalendarEntryModeIcon argument can be used to display a custom Icon in the corner of the dialog when DatePickerEntryMode is DatePickerEntryMode.input. Clicking on icon changes the DatePickerEntryMode to DatePickerEntryMode.calendar. If null, Icon(Icons.calendar_today) is used.
final
switchToInputEntryModeIcon Icon?
An optional switchToInputEntryModeIcon argument can be used to display a custom Icon in the corner of the dialog when DatePickerEntryMode is DatePickerEntryMode.calendar. Clicking on icon changes the DatePickerEntryMode to DatePickerEntryMode.input. If null, Icon(useMaterial3 ? Icons.edit_outlined : Icons.edit) is used.
final

Methods

createElement() StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() State<DatePickerDialog>
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