GuidedDatePickerAction

Added in 1.1.0

Kotlin |Java

class GuidedDatePickerAction : GuidedAction

kotlin.Any
↳	androidx.leanback.widget.Action
	↳	androidx.leanback.widget.GuidedAction
		↳	androidx.leanback.widget.GuidedDatePickerAction

Subclass of GuidedAction that can choose a date. The Action is editable by default; to make it read only, call hasEditableActivatorView(false) on the Builder.

Summary

Nested types
`class GuidedDatePickerAction.Builder : GuidedDatePickerAction.BuilderBase` Builder class to build a GuidedDatePickerAction.
`abstract class GuidedDatePickerAction.BuilderBase<B : GuidedDatePickerAction.BuilderBase?> : GuidedAction.BuilderBase` Base Builder class to build GuidedDatePickerAction.

Public constructors
`GuidedDatePickerAction()`

Public functions
`Long`	`getDate()` Get current value of DatePicker in milliseconds since January 1, 1970 00:00:00 in `getDefault` time zone.
`String?`	`getDatePickerFormat()` Returns format of date Picker or null if not specified.
`Long`	`getMaxDate()` Get maximum value of DatePicker in milliseconds since January 1, 1970 00:00:00 in `getDefault` time zone.
`Long`	`getMinDate()` Get minimal value of DatePicker in milliseconds since January 1, 1970 00:00:00 in `getDefault` time zone. -1 if not set.
`Unit`	`onRestoreInstanceState(bundle: Bundle, key: String?)` Restore action from a bundle using a given key.
`Unit`	`onSaveInstanceState(bundle: Bundle, key: String?)` Save action into a bundle using a given key.
`Unit`	`setDate(date: Long)` Sets current value of DatePicker in milliseconds since January 1, 1970 00:00:00 in `getDefault` time zone.

Inherited Constants

From androidx.leanback.widget.Action

const Long

NO_ID = -1

Indicates that an id has not been set.

From androidx.leanback.widget.GuidedAction

`const Long`	`ACTION_ID_CANCEL = -5` Id of standard Cancel action.
`const Long`	`ACTION_ID_CONTINUE = -7` Id of standard Finish action.
`const Long`	`ACTION_ID_CURRENT = -3` When finishing editing, stay on current action.
`const Long`	`ACTION_ID_FINISH = -6` Id of standard Finish action.
`const Long`	`ACTION_ID_NEXT = -2` When finishing editing, goes to next action.
`const Long`	`ACTION_ID_NO = -9` Id of standard No action.
`const Long`	`ACTION_ID_OK = -4` Id of standard OK action.
`const Long`	`ACTION_ID_YES = -8` Id of standard Yes action.
`const Int`	`CHECKBOX_CHECK_SET_ID = -1` Checkset Id for checkbox.
`const Int`	`DEFAULT_CHECK_SET_ID = 1` Default checkset Id for radio.
`const Int`	`NO_CHECK_SET = 0` Special check set Id that is neither checkbox nor radio.

Inherited functions

From androidx.leanback.widget.Action

`Unit`	`addKeyCode(keyCode: Int)` Adds a keycode used to invoke this Action.
`Drawable?`	`getIcon()` Returns the icon drawable for this Action.
`Long`	`getId()` Returns the id for this Action.
`CharSequence?`	`getLabel1()` Returns the first line label for this Action.
`CharSequence?`	`getLabel2()` Returns the second line label for this Action.
`Unit`	`removeKeyCode(keyCode: Int)` Removes a keycode used to invoke this Action.
`Boolean`	`respondsToKeyCode(keyCode: Int)` Returns true if the Action should respond to the given keycode.
`Unit`	`setIcon(icon: Drawable?)` Sets the icon drawable for this Action.
`Unit`	`setId(id: Long)` Sets the id for this Action.
`Unit`	`setLabel1(label: CharSequence?)` Sets the first line label for this Action.
`Unit`	`setLabel2(label: CharSequence?)` Sets the second line label for this Action.
`String`	`toString()`

From androidx.leanback.widget.GuidedAction

`Array<String!>!`	`getAutofillHints()` Returns autofill hints, see `setAutofillHints`.
`Int`	`getCheckSetId()` Returns the check set id this action is a part of.
`CharSequence?`	`getDescription()` Returns the description of this action.
`Int`	`getDescriptionEditInputType()` Returns InputType of action description in editing; only valid when `isDescriptionEditable` is true.
`Int`	`getDescriptionInputType()` Returns InputType of action description not in editing.
`CharSequence?`	`getEditDescription()` Returns the optional description text to edit.
`Int`	`getEditInputType()` Returns InputType of action title in editing; only valid when `isEditable` is true.
`CharSequence?`	`getEditTitle()` Returns the optional title text to edit.
`Int`	`getInputType()` Returns InputType of action title not in editing.
`Intent?`	`getIntent()` Returns the intent associated with this action.
`(Mutable)List<GuidedAction!>?`	`getSubActions()`
`CharSequence?`	`getTitle()` Returns the title of this action.
`Boolean`	`hasEditableActivatorView()` Returns whether this action can be activated to edit, e.g. a DatePicker.
`Boolean`	`hasMultilineDescription()` Returns whether this action is has a multiline description.
`Boolean`	`hasNext()` Returns whether this action will request further user input when selected, such as showing another GuidedStepFragment or launching a new activity.
`Boolean`	`hasSubActions()`
`Boolean`	`hasTextEditable()` Returns if this action has editable title or editable description.
`Boolean`	`infoOnly()` Returns whether the action will only display information and is thus not clickable.
`Boolean`	`isAutoSaveRestoreEnabled()` Returns true if Action will be saved to instanceState and restored later, false otherwise.
`Boolean`	`isChecked()` Returns whether this action is checked.
`Boolean`	`isDescriptionEditable()` Returns whether this action description is editable.
`Boolean`	`isEditTitleUsed()` Returns true if `getEditTitle` is not null.
`Boolean`	`isEditable()` Returns whether this action title is editable.
`Boolean`	`isEnabled()` Returns whether this action is enabled.
`Boolean`	`isFocusable()` Returns whether this action is focusable.
`Unit`	`setChecked(checked: Boolean)` Sets whether this action is checked.
`Unit`	`setDescription(description: CharSequence?)` Sets the description of this action.
`Unit`	`setEditDescription(editDescription: CharSequence?)` Sets the optional description text to edit instead of `setDescription`.
`Unit`	`setEditTitle(editTitle: CharSequence?)` Sets the optional title text to edit instead of `setTitle`.
`Unit`	`setEnabled(enabled: Boolean)` Sets whether this action is enabled.
`Unit`	`setFocusable(focusable: Boolean)` Sets whether this action is focusable.
`Unit`	`setIntent(intent: Intent?)` Sets the intent of this action.
`Unit`	`setSubActions(actions: (Mutable)List<GuidedAction!>?)` Change sub actions list.
`Unit`	`setTitle(title: CharSequence?)` Sets the title of this action.

Public constructors

GuidedDatePickerAction

Added in 1.1.0

GuidedDatePickerAction()

Public functions

getDate

Added in 1.1.0

fun getDate(): Long

Get current value of DatePicker in milliseconds since January 1, 1970 00:00:00 in getDefault time zone.

Returns
`Long`	Current value of DatePicker Action.

getDatePickerFormat

Added in 1.1.0

fun getDatePickerFormat(): String?

Returns format of date Picker or null if not specified. The format is a case insensitive String containing the * day ('d'), month ('m'), and year ('y'). When the format is not specified, a default format of current locale will be used.

Returns
`String?`	Format of showing Date, e.g. "YMD". Returns null if using current locale's default.

getMaxDate

Added in 1.1.0

fun getMaxDate(): Long

Get maximum value of DatePicker in milliseconds since January 1, 1970 00:00:00 in getDefault time zone.

Returns
`Long`	Maximum value of DatePicker Action or Long.MAX_VALUE if not set.

getMinDate

Added in 1.1.0

fun getMinDate(): Long

Get minimal value of DatePicker in milliseconds since January 1, 1970 00:00:00 in getDefault time zone. -1 if not set.

Returns
`Long`	Minimal value of DatePicker Action or Long.MIN_VALUE if not set.

onRestoreInstanceState

fun onRestoreInstanceState(bundle: Bundle, key: String?): Unit

Restore action from a bundle using a given key. When isAutoRestore() is true:

isEditable is true: save text of getTitle
isDescriptionEditable is true: save text of getDescription
getCheckSetId is not NO_CHECK_SET: save isChecked}
GuidedDatePickerAction will be saved

Subclass may override this method.

Parameters
`bundle: Bundle`	Bundle to restore the Action from.
`key: String?`	Key used to restore the Action.

onSaveInstanceState

fun onSaveInstanceState(bundle: Bundle, key: String?): Unit

Save action into a bundle using a given key. When isAutoRestoreEna() is true:

isEditable is true: save text of getTitle
isDescriptionEditable is true: save text of getDescription
getCheckSetId is not NO_CHECK_SET: save isChecked}
GuidedDatePickerAction will be saved

Subclass may override this method.

Parameters
`bundle: Bundle`	Bundle to save the Action.
`key: String?`	Key used to save the Action.

setDate

Added in 1.1.0

fun setDate(date: Long): Unit

Sets current value of DatePicker in milliseconds since January 1, 1970 00:00:00 in getDefault time zone.

Parameters
`date: Long`	New value to update current value of DatePicker Action.

GuidedDatePickerAction

Summary

Nested types

Public constructors

Public functions

Inherited Constants

Inherited functions

Public constructors

GuidedDatePickerAction

Public functions

getDate

getDatePickerFormat

getMaxDate

getMinDate

onRestoreInstanceState

onSaveInstanceState

setDate