TimePicker

Kotlin |Java

open class TimePicker : Picker

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

TimePicker is a direct subclass of Picker.

This class is a widget for selecting time and displays it according to the formatting for the current system locale. The time can be selected by hour, minute, and AM/PM picker columns. The AM/PM mode is determined by either explicitly setting the current mode through setIs24Hour(boolean) or the widget attribute is24HourFormat (true for 24-hour mode, false for 12-hour mode). Otherwise, TimePicker retrieves the mode based on the current context. In 24-hour mode, TimePicker displays only the hour and minute columns.

This widget can show the current time as the initial value if useCurrentTime is set to true. Each individual time picker field can be set at any time by calling setHour(int), setMinute(int) using 24-hour time format. The time format can also be changed at any time by calling setIs24Hour(boolean), and the AM/PM picker column will be activated or deactivated accordingly. R.attr#is24HourFormat R.attr#useCurrentTime

Summary

Public constructors
`<init>(context: Context!, attrs: AttributeSet!)` Constructor called when inflating a TimePicker widget.
`<init>(context: Context!, attrs: AttributeSet!, defStyleAttr: Int)` Constructor called when inflating a TimePicker widget.

Public methods
open Int	`getHour()` Returns the currently selected hour using 24-hour time.
open Int	`getMinute()` Returns the currently selected minute.
open Boolean	`is24Hour()`
open Boolean	`isPm()` Only meaningful for a 12-hour time.
open Unit	`onColumnValueChanged(columnIndex: Int, newValue: Int)`
open Unit	`setHour(@IntRange(0, 23) hour: Int)` Sets the currently selected hour using a 24-hour time.
open Unit	`setIs24Hour(is24Hour: Boolean)` Sets whether this widget displays a 24-hour mode or a 12-hour mode with an AM/PM picker.
open Unit	`setMinute(@IntRange(0, 59) minute: Int)` Sets the currently selected minute.

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>

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

Constructor called when inflating a TimePicker widget. This version uses a default style of 0, so the only attribute values applied are those in the Context's Theme and the given AttributeSet.

Parameters
`context`