BoardDateTimeOptions class

Class for defining options related to the UI used by BoardDateTimeBuilder

Constructors

BoardDateTimeOptions.new({Color? backgroundColor, Color? foregroundColor, Color? textColor, Color? activeColor, Color? activeTextColor, BoxDecoration? backgroundDecoration, BoardPickerLanguages languages = const BoardPickerLanguages.en(), BoardPickerCustomOptions? customOptions, int startDayOfWeek = DateTime.sunday, BoardDateTimePickerFormat pickerFormat = PickerFormat.ymd, PickerMonthFormat pickerMonthFormat = PickerMonthFormat.number, bool showDateButton = true, String? boardTitle, Widget boardTitleBuilder(BuildContext context, TextStyle? textStyle, DateTime currentDateTime)?, TextStyle? boardTitleTextStyle, BoardDateTimeItemTitles? pickerSubTitles, BoardPickerWeekendOptions? weekend, bool inputable = true, bool withSecond = false, double topMargin = 20, double? calendarSelectionRadius, List<BoardDateButtonType> actionButtonTypes = const [BoardDateButtonType.today, BoardDateButtonType.tomorrow], CalendarSelectionBuilder? calendarSelectionBuilder, CalendarItemBuilder? calendarItemBuilder, CalendarItemDecorationBuilder? calendarItemDecoration, bool useResetButton = false, bool useAmpm = false, BoardDateTimePickerSeparators? separators, bool allowRetroactiveTime = false, BoardDateTimeViewMode viewMode = BoardDateTimeViewMode.pickerToCalendar, BoardDateTimeOrientation viewModeOrientation = BoardDateTimeOrientation.normal, BoardDateTimePaddingSettings paddingSettings = const BoardDateTimePaddingSettings()})
const

Properties

actionButtonTypes → List<BoardDateButtonType>
List of buttons to select dates. Set the enum you want to display with a choice of yesterday, today, or tomorrow. The order in which the buttons are displayed must match the order of the list, and if empty, they will not be displayed.
final
activeColor → Color?
Active Color
final
activeTextColor → Color?
Active Text Color
final
allowRetroactiveTime → bool
Flag to allow retroactive time. If true, allows DateTimePickerType.time to reverse start and end times in multi-selection
final
backgroundColor → Color?
Picker Background Color
final
backgroundDecoration → BoxDecoration?
BoxDecoration of the widget displayed on the backmost side of the picker. If not specified, it will be a standard BoxDecoration with the color specified in the normal backgroundColor (default).
final
boardTitle → String?
Title to be displayed at the top of the picker
final
boardTitleBuilder → Widget Function(BuildContext context, TextStyle? textStyle, DateTime currentDateTime)?
Title to be displayed at the top of the picker textStyle parameter is boardTitleTextStyle if declared, defaults if not specified. currentDateTime is the current selected DateTime of the picker.
final
boardTitleTextStyle → TextStyle?
BoardTitle text style
final
calendarItemBuilder → CalendarItemBuilder?
Callback to build a Widget that displays the selected item in the calendar. The date and text style to be displayed as parameters.
final
calendarItemDecoration → CalendarItemDecorationBuilder?
BoxDecoration for the date selected in the calendar. If not specified, it will be a standard BoxDecoration with the color specified in the normal activeColor (default).
final
calendarSelectionBuilder → CalendarSelectionBuilder?
Callback to build a Widget that displays the selected item in the calendar. The date and text style to be displayed as parameters.
final
calendarSelectionRadius → double?
Background radius for the date selected in the calendar. If not specified, display as a circle
final
customOptions → BoardPickerCustomOptions?
Option to specify items to be displayed in the picker by date and time. Only time can be specified.
final
foregroundColor → Color?
Picket Foreground Color
final
hashCode → int
The hash code for this object.
no setterinherited
inputable → bool
Flag whether the date to be selected should be text-enabled or not. If true, text can be entered by tapping on the selected area of the Picker. If false, text input is not possible, only scrolling picker. Default is true.
final
languages → BoardPickerLanguages
Class for specifying language information to be used in the picker
final
paddingSettings → BoardDateTimePaddingSettings
Option to configure settings related to widgets padding
final
pickerFormat → BoardDateTimePickerFormat
Date format for pickers. Specify if you want to change the display order of year, month, date.
final
pickerMonthFormat → PickerMonthFormat
Month format to be displayed on the picker.
final
pickerSubTitles → BoardDateTimeItemTitles?
You can specify a subtitle for each item in the picker. Default is unspecified and no subtitle is displayed.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
separators → BoardDateTimePickerSeparators?
Specify the separator between items displayed in the Picker. If not specified, no separator will be displayed. By default, nothing is specified.
final
showDateButton → bool
Flag whether or not the button to set the date should be displayed. If false, do not display buttons such as "today", "tomorrow", etc. at the top of the picker, only the action buttons. Default is true.
final
startDayOfWeek → int
First day of the week in the calendar. Defailt is DateTime.sunday.
final
textColor → Color?
Picker Text Color
final
topMargin → double
Set the margins above the top menu bar (calendar button, etc.). Default is 20
final
useAmpm → bool
Set if the time is to be displayed as AM/PM. This value is valid only for DateTimePickerType.time
final
useResetButton → bool
If you want to use the reset button, please set it to true. The reset button will be displayed on the right side of the header section.
final
viewMode → BoardDateTimeViewMode
Specify the view mode for the BoardDateTimePicker. The default value is BoardDateTimeViewMode.pickerToCalendar. Note: This setting has no effect when the picker is in wide mode.
final
viewModeOrientation → BoardDateTimeOrientation
Specify the view mode orientation for the BoardDateTimePicker. The default value is BoardDateTimeOrientation.normal. Note: This setting has no effect when the picker is in wide mode.
final
weekend → BoardPickerWeekendOptions?
Option to configure settings related to weekends Used to set the text color to be displayed
final
withSecond → bool
Flag to allow seconds to be specified. This parameter is only valid if DateTimePickerType is time. The datetime case is not supported at this time due to width issues.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited