CalendarDatePicker class

Displays a grid of days for a given month and allows the user to select a date.

Days are arranged in a rectangular grid with one column for each day of the week. Controls are provided to change the year and month that the grid is showing.

The calendar picker widget is rarely used directly. Instead, consider using showDatePicker, which will create a dialog that uses this as well as provides a text entry option.

See also:

  • showDatePicker, which creates a Dialog that contains a CalendarDatePicker and provides an optional compact view where the user can enter a date as a line of text.
  • showTimePicker, which shows a dialog that contains a Material Design time picker.
Inheritance

Constructors

CalendarDatePicker({Key? key, required DateTime? initialDate, required DateTime firstDate, required DateTime lastDate, DateTime? currentDate, required ValueChanged<DateTime> onDateChanged, ValueChanged<DateTime>? onDisplayedMonthChanged, DatePickerMode initialCalendarMode = DatePickerMode.day, SelectableDayPredicate? selectableDayPredicate})
Creates a calendar date picker.

Properties

currentDate → DateTime
The DateTime representing today. It will be highlighted in the day grid.
final
firstDate → DateTime
The earliest allowable DateTime that the user can select.
final
hashCode → int
The hash code for this object.
no setterinherited
initialCalendarMode → DatePickerMode
The initial display of the calendar picker.
final
initialDate → DateTime?
The initially selected DateTime that the picker should display.
final
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
lastDate → DateTime
The latest allowable DateTime that the user can select.
final
onDateChanged → ValueChanged<DateTime>
Called when the user selects a date in the picker.
final
onDisplayedMonthChanged → ValueChanged<DateTime>?
Called when the user navigates to a new month/year in the picker.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
selectableDayPredicate → SelectableDayPredicate?
Function to provide full control over which dates in the calendar can be selected.
final

Methods

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