DatePicker

Kotlin |Java

open class DatePicker : Picker

kotlin.Any
↳	android.view.View
	↳	android.view.ViewGroup
		↳	android.widget.FrameLayout
			↳	androidx.leanback.widget.picker.Picker
				↳	androidx.leanback.widget.picker.DatePicker

DatePicker is a directly subclass of Picker. This class is a widget for selecting a date. The date can be selected by a year, month, and day Columns. The "minDate" and "maxDate" from which dates to be selected can be customized. The columns can be customized by attribute "datePickerFormat" or setDatePickerFormat(String). android.R.attr#maxDate android.R.attr#minDate R.attr#datePickerFormat

Summary

Public constructors
`<init>(context: Context!, attrs: AttributeSet!)`
`<init>(context: Context!, attrs: AttributeSet!, defStyleAttr: Int)`

Public methods
open Long	`getDate()` Gets current date value in milliseconds since January 1, 1970 00:00:00 in `TimeZone#getDefault()` time zone.
open String!	`getDatePickerFormat()` Get format of showing dates.
open Long	`getMaxDate()` Gets the maximal date supported by this `DatePicker` in milliseconds since January 1, 1970 00:00:00 in `TimeZone#getDefault()` time zone.
open Long	`getMinDate()` Gets the minimal date supported by this `DatePicker` in milliseconds since January 1, 1970 00:00:00 in `TimeZone#getDefault()` time zone.
Unit	`onColumnValueChanged(column: Int, newVal: Int)`
open Unit	`setDate(timeInMilliseconds: Long)` Update the current date in milliseconds since January 1, 1970 00:00:00 in `TimeZone#getDefault()` time zone.
open Unit	`setDate(year: Int, month: Int, dayOfMonth: Int, animation: Boolean)` Update the current date.
open Unit	`setDatePickerFormat(datePickerFormat: String!)` Changes format of showing dates.
open Unit	`setMaxDate(maxDate: Long)` Sets the maximal date supported by this `DatePicker` in milliseconds since January 1, 1970 00:00:00 in `TimeZone#getDefault()` time zone.
open Unit	`setMinDate(minDate: Long)` Sets the minimal date supported by this `DatePicker` in milliseconds since January 1, 1970 00:00:00 in `TimeZone#getDefault()` time zone.

Inherited functions

From class Picker

`Unit`	`addOnValueChangedListener(listener: Picker.PickerValueListener!)` Register a callback to be invoked when the picker's value has changed.
`Boolean`	`dispatchKeyEvent(event: KeyEvent!)`
`Float`	`getActivatedVisibleItemCount()` Returns number of visible items showing in a column when it's activated. The default value is 3.
`PickerColumn!`	`getColumnAt(colIndex: Int)` Get nth PickerColumn.
`Int`	`getColumnsCount()` Get number of PickerColumns.
`Int`	`getPickerItemHeightPixels()` Classes extending `Picker` can choose to override this method to supply the `Picker`'s column's single item height in pixels.
`Int`	`getPickerItemLayoutId()` Classes extending `Picker` can call `setPickerItemLayoutId(int)` to supply the `Picker`'s item's layout id
`Int`	`getPickerItemTextViewId()` Returns the `Picker`'s item's `TextView`'s id from within the layout provided by `Picker#getPickerItemLayoutId()` or 0 if the layout provided by `Picker#getPickerItemLayoutId()` is a {link TextView}.
`Int`	`getSelectedColumn()` Get current activated column index.
`CharSequence!`	`getSeparator()` Gets separator string between columns.
`MutableList<CharSequence!>!`	`getSeparators()` Returns the list of separators that will be populated between the picker column fields.
`Float`	`getVisibleItemCount()` Returns number of visible items showing in a column when it's not activated. The default value is 1.
`Boolean`	`onRequestFocusInDescendants(direction: Int, previouslyFocusedRect: Rect!)`
`Unit`	`removeOnValueChangedListener(listener: Picker.PickerValueListener!)` Remove a previously installed value changed callback
`Unit`	`requestChildFocus(child: View!, focused: View!)`
`Unit`	`setActivated(activated: Boolean)`
`Unit`	`setActivatedVisibleItemCount(visiblePickerItems: Float)` Changes number of visible items showing in a column when it's activated. The default value is 3.
`Unit`	`setColumnAt(columnIndex: Int, column: PickerColumn!)` When column labels change or column range changes, call this function to re-populate the selection list. Note this function cannot be called from RecyclerView layout/scroll pass.
`Unit`	`setColumnValue(columnIndex: Int, value: Int, runAnimation: Boolean)` Manually set current value of a column. The function will update UI and notify listeners.
`Unit`	`setColumns(columns: MutableList<PickerColumn!>!)` Set columns and create Views.
`Unit`	`setPickerItemLayoutId(@LayoutRes pickerItemLayoutId: Int)` Sets the layout to use for picker items.
`Unit`	`setPickerItemTextViewId(@IdRes textViewId: Int)` Sets the `Picker`'s item's `TextView`'s id from within the layout provided by `Picker#getPickerItemLayoutId()` or 0 if the layout provided by `Picker#getPickerItemLayoutId()` is a {link TextView}.
`Unit`	`setSelectedColumn(columnIndex: Int)` Change current selected column. Picker shows multiple items on selected column if Picker has focus. Picker shows multiple items on all column if Picker has no focus (e.g. a Touchscreen screen).
`Unit`	`setSeparator(separator: CharSequence!)` Sets separator String between Picker columns.
`Unit`	`setSeparators(separators: MutableList<CharSequence!>!)` Sets the list of separators that will be populated between the Picker columns. The number of the separators should be either 1 indicating the same separator used between all the columns fields (and nothing will be placed before the first and after the last column), or must be one unit larger than the number of columns passed to `setColumns(List)`. In the latter case, the list of separators corresponds to the positions before the first column all the way to the position after the last column. An empty string for a given position indicates no separators needs to be placed for that position, otherwise a TextView with the given String will be created and placed there.
`Unit`	`setVisibleItemCount(pickerItems: Float)` Changes number of visible items showing in a column when it's not activated. The default value is 1.

Public constructors

<init>

DatePicker(
    context: Context!, 
    attrs: AttributeSet!)

<init>

DatePicker(
    context: Context!, 
    attrs: AttributeSet!, 
    defStyleAttr: Int)

Public methods

getDate

open fun getDate(): Long

Gets current date value in milliseconds since January 1, 1970 00:00:00 in TimeZone#getDefault() time zone.

Return
`Long`	Current date values.

getDatePickerFormat

open fun getDatePickerFormat(): String!

Get format of showing dates. For example "YMD". Default value is from android.text.format.DateFormat#getDateFormatOrder(Context).

Return
`String!`	Format of showing dates.

getMaxDate

open fun getMaxDate(): Long

Gets the maximal date supported by this DatePicker in milliseconds since January 1, 1970 00:00:00 in TimeZone#getDefault() time zone.

Note: The default maximal date is 12/31/2100.

Return
`Long`	The maximal supported date.

getMinDate

open fun getMinDate(): Long

Gets the minimal date supported by this DatePicker in milliseconds since January 1, 1970 00:00:00 in TimeZone#getDefault() time zone.

Note: The default minimal date is 01/01/1900.

Return
`Long`	The minimal supported date.

onColumnValueChanged

fun onColumnValueChanged(
    column: Int, 
    newVal: Int
): Unit

setDate

open fun setDate(timeInMilliseconds: Long): Unit

Update the current date in milliseconds since January 1, 1970 00:00:00 in TimeZone#getDefault() time zone.

Parameters
`timeInMilliseconds`	Long: current date value in milliseconds.

setDate

open fun setDate(
    year: Int, 
    month: Int, 
    dayOfMonth: Int, 
    animation: Boolean
): Unit

Update the current date.

Parameters
`year`	Int: The year.
`month`	Int: The month which is starting from zero.
`dayOfMonth`	Int: The day of the month.
`animation`	Boolean: True to run animation to scroll the column.

setDatePickerFormat

open fun setDatePickerFormat(datePickerFormat: String!): Unit

Changes format of showing dates. For example "YMD".

Parameters
`datePickerFormat`	String!: Format of showing dates.

setMaxDate

open fun setMaxDate(maxDate: Long): Unit

Sets the maximal date supported by this DatePicker in milliseconds since January 1, 1970 00:00:00 in TimeZone#getDefault() time zone.

Parameters
`maxDate`	Long: The maximal supported date.

setMinDate

open fun setMinDate(minDate: Long): Unit

Sets the minimal date supported by this DatePicker in milliseconds since January 1, 1970 00:00:00 in TimeZone#getDefault() time zone.

Parameters
`minDate`	Long: The minimal supported date.