GuidedDatePickerAction

Added in 1.1.0

Kotlin |Java

public class GuidedDatePickerAction extends GuidedAction

java.lang.Object
↳	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
`public final class GuidedDatePickerAction.Builder extends GuidedDatePickerAction.BuilderBase` Builder class to build a GuidedDatePickerAction.
`public abstract class GuidedDatePickerAction.BuilderBase<B extends GuidedDatePickerAction.BuilderBase> extends GuidedAction.BuilderBase` Base Builder class to build GuidedDatePickerAction.

Public constructors
`GuidedDatePickerAction()`

Public methods
`long`	`getDate()` Get current value of DatePicker in milliseconds since January 1, 1970 00:00:00 in `getDefault` time zone.
`@Nullable 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.
`void`	`onRestoreInstanceState(@NonNull Bundle bundle, @Nullable String key)` Restore action from a bundle using a given key.
`void`	`onSaveInstanceState(@NonNull Bundle bundle, @Nullable String key)` Save action into a bundle using a given key.
`void`	`setDate(long date)` 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

static final long

NO_ID = -1

Indicates that an id has not been set.

From androidx.leanback.widget.GuidedAction

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

Inherited methods

From androidx.leanback.widget.Action

`final void`	`addKeyCode(int keyCode)` Adds a keycode used to invoke this Action.
`final @Nullable Drawable`	`getIcon()` Returns the icon drawable for this Action.
`final long`	`getId()` Returns the id for this Action.
`final @Nullable CharSequence`	`getLabel1()` Returns the first line label for this Action.
`final @Nullable CharSequence`	`getLabel2()` Returns the second line label for this Action.
`final void`	`removeKeyCode(int keyCode)` Removes a keycode used to invoke this Action.
`final boolean`	`respondsToKeyCode(int keyCode)` Returns true if the Action should respond to the given keycode.
`final void`	`setIcon(@Nullable Drawable icon)` Sets the icon drawable for this Action.
`final void`	`setId(long id)` Sets the id for this Action.
`final void`	`setLabel1(@Nullable CharSequence label)` Sets the first line label for this Action.
`final void`	`setLabel2(@Nullable CharSequence label)` Sets the second line label for this Action.
`@NonNull String`	`toString()`

From androidx.leanback.widget.GuidedAction

`String[]`	`getAutofillHints()` Returns autofill hints, see `setAutofillHints`.
`int`	`getCheckSetId()` Returns the check set id this action is a part of.
`@Nullable 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.
`@Nullable CharSequence`	`getEditDescription()` Returns the optional description text to edit.
`int`	`getEditInputType()` Returns InputType of action title in editing; only valid when `isEditable` is true.
`@Nullable CharSequence`	`getEditTitle()` Returns the optional title text to edit.
`int`	`getInputType()` Returns InputType of action title not in editing.
`@Nullable Intent`	`getIntent()` Returns the intent associated with this action.
`@Nullable List<GuidedAction>`	`getSubActions()`
`@Nullable 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.
`final 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.
`void`	`setChecked(boolean checked)` Sets whether this action is checked.
`void`	`setDescription(@Nullable CharSequence description)` Sets the description of this action.
`void`	`setEditDescription(@Nullable CharSequence editDescription)` Sets the optional description text to edit instead of `setDescription`.
`void`	`setEditTitle(@Nullable CharSequence editTitle)` Sets the optional title text to edit instead of `setTitle`.
`void`	`setEnabled(boolean enabled)` Sets whether this action is enabled.
`void`	`setFocusable(boolean focusable)` Sets whether this action is focusable.
`void`	`setIntent(@Nullable Intent intent)` Sets the intent of this action.
`void`	`setSubActions(@Nullable List<GuidedAction> actions)` Change sub actions list.
`void`	`setTitle(@Nullable CharSequence title)` Sets the title of this action.

Public constructors

GuidedDatePickerAction

Added in 1.1.0

public GuidedDatePickerAction()

Public methods

getDate

Added in 1.1.0

public long getDate()

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

public @Nullable String getDatePickerFormat()

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
`@Nullable String`	Format of showing Date, e.g. "YMD". Returns null if using current locale's default.

getMaxDate

Added in 1.1.0

public long getMaxDate()

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

public long getMinDate()

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

public void onRestoreInstanceState(@NonNull Bundle bundle, @Nullable String key)

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
`@NonNull Bundle bundle`	Bundle to restore the Action from.
`@Nullable String key`	Key used to restore the Action.

onSaveInstanceState

public void onSaveInstanceState(@NonNull Bundle bundle, @Nullable String key)

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
`@NonNull Bundle bundle`	Bundle to save the Action.
`@Nullable String key`	Key used to save the Action.

setDate

Added in 1.1.0

public void setDate(long date)

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

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

GuidedDatePickerAction

Summary

Nested types

Public constructors

Public methods

Inherited Constants

Inherited methods

Public constructors

GuidedDatePickerAction

Public methods

getDate

getDatePickerFormat

getMaxDate

getMinDate

onRestoreInstanceState

onSaveInstanceState

setDate