PersianCalendarDatePicker 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 showPersianDatePicker, which will create a dialog that uses this as well as provides a text entry option.

See also:

• showPersianDatePicker, which creates a Dialog that contains a PersianCalendarDatePicker 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

• Object
• DiagnosticableTree
• Widget
• StatefulWidget
• PersianCalendarDatePicker

Constructors

PersianCalendarDatePicker({Key? key, required Jalali? initialDate, required Jalali firstDate, required Jalali lastDate, Jalali? currentDate, required ValueChanged<Jalali> onDateChanged, ValueChanged<Jalali>? onDisplayedMonthChanged, PersianDatePickerMode initialCalendarMode = PersianDatePickerMode.day, PersianSelectableDayPredicate? selectableDayPredicate})

Creates a calendar date picker.

Properties

currentDate → Jalali

The Jalali representing today. It will be highlighted in the day grid.

final

firstDate → Jalali

The earliest allowable Jalali that the user can select.

final

hashCode → int

The hash code for this object.

no setter, inherited

initialCalendarMode → PersianDatePickerMode

The initial display of the calendar picker.

final

initialDate → Jalali?

The initially selected Jalali that the picker should display.

final

key → Key?

Controls how one widget replaces another widget in the tree.

final, inherited

lastDate → Jalali

The latest allowable Jalali that the user can select.

final

onDateChanged → ValueChanged<Jalali>

Called when the user selects a date in the picker.

final

onDisplayedMonthChanged → ValueChanged<Jalali>?

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 setter, inherited

selectableDayPredicate → PersianSelectableDayPredicate?

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<PersianCalendarDatePicker>

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