universum.studios.android.setting

Class SettingDateDialogPreference

java.lang.Object

androidx.preference.Preference

universum.studios.android.setting.SettingPreference

universum.studios.android.setting.SettingDialogPreference<O>

universum.studios.android.setting.SettingDateTimeDialogPreference<DatePickerDialog.DateOptions>

universum.studios.android.setting.SettingDateDialogPreference

All Implemented Interfaces:

Comparable<androidx.preference.Preference>

public final class SettingDateDialogPreference
extends SettingDateTimeDialogPreference<DatePickerDialog.DateOptions>

A SettingDateTimeDialogPreference implementation that may be used to allow to a user to pick its preferred date for a specific setting preference.

This preference implementation by default displays the preferred date formatted by format specified via SettingDateTimeDialogPreference.setFormat(SimpleDateFormat) as summary text. The default format is 'MMM dd, yyyy'. If no date is specified, the standard summary text is displayed. The preferred date may be specified via setDate(long) and obtained via getDate() or getDateInMillis().

When SettingDialogPreference.handleDialogButtonClick(Dialog, int) is called, this preference implementation handles only DatePickerDialog type of dialog. If its Dialog.BUTTON_POSITIVE button has been clicked, the date provided via DatePickerDialog.getDate() is set as date for this preference via setDate(long).

Default value

Default value for this preference is parsed as String into milliseconds value using DatePickerDialog.DateParser#parse(String). See TypedArray.getString(int).

Xml attributes

See SettingDateTimeDialogPreference, SettingDateDialogPreference Attributes

Default style attribute

settingDateDialogPreferenceStyle

Since:

1.0

Author:

Martin Albedinsky

See Also:

SettingTimeDialogPreference

Nested Class Summary

Nested classes/interfaces inherited from class universum.studios.android.setting.SettingDialogPreference

SettingDialogPreference.OnClickListener

Nested classes/interfaces inherited from class androidx.preference.Preference

androidx.preference.Preference.BaseSavedState, androidx.preference.Preference.OnPreferenceChangeListener, androidx.preference.Preference.OnPreferenceClickListener, androidx.preference.Preference.SummaryProvider<T extends androidx.preference.Preference>

Field Summary

Fields inherited from class universum.studios.android.setting.SettingDialogPreference

NO_DIALOG_ID

Fields inherited from class androidx.preference.Preference

DEFAULT_ORDER

Constructor Summary

Constructors

Constructor and Description
SettingDateDialogPreference(android.content.Context context) Same as SettingDateDialogPreference(Context, AttributeSet) without attributes.
SettingDateDialogPreference(android.content.Context context, android.util.AttributeSet attrs) Same as SettingDateDialogPreference(Context, AttributeSet, int) with R.attr.settingDateDialogPreferenceStyle as attribute for default style.
SettingDateDialogPreference(android.content.Context context, android.util.AttributeSet attrs, int defStyleAttr) Same as SettingDateDialogPreference(Context, AttributeSet, int, int) with 0 as default style.
SettingDateDialogPreference(android.content.Context context, android.util.AttributeSet attrs, int defStyleAttr, int defStyleRes) Creates a new instance of SettingInputPreference for the given context.

Method Summary

Modifier and Type	Method and Description
Date	getDate() Like getDateInMillis(), but this method may be used to check whether the date value has been specified or not, as this method will return null Date object if there is no date value specified.
long	getDateInMillis() Returns the preferred date value of this preference.
DatePickerDialog.DateOptions	getDialogOptions() Dialog options of this preference with the preferred date specified as DatePickerDialog.DateOptions#date(long), if it is set.
protected void	onConfigureDialogOptions(DatePickerDialog.DateOptions options, android.content.Context context, android.util.AttributeSet attrs, int defStyleAttr, int defStyleRes) Called from one of constructors to configure dialog options specific for this dialog preference.
protected DatePickerDialog.DateOptions	onCreateDialogOptions(android.content.res.Resources resources) Called to create instance of dialog options specific for this dialog preference.
protected boolean	onHandleDialogButtonClick(Dialog dialog, int button) Called from SettingDialogPreference.handleDialogButtonClick(Dialog, int) if the given dialog has id associated with this dialog preference.
void	setDate(Date date) Same as setDate(long) with milliseconds value of the given date.
void	setDate(long dateInMillis) Sets a preferred date value for this preference.

Methods inherited from class universum.studios.android.setting.SettingDateTimeDialogPreference

onBindViewHolder, onGetDefaultValue, onGetSummaryText, onSetInitialValue, setFormat

Methods inherited from class universum.studios.android.setting.SettingDialogPreference

getDialogId, handleDialogButtonClick, setDialogId, setOnClickListener, synchronizeSummaryView

Methods inherited from class universum.studios.android.setting.SettingPreference

setKey

Methods inherited from class androidx.preference.Preference

callChangeListener, compareTo, findPreferenceInHierarchy, getContext, getDependency, getExtras, getFragment, getIcon, getIntent, getKey, getLayoutResource, getOnPreferenceChangeListener, getOnPreferenceClickListener, getOrder, getParent, getPersistedBoolean, getPersistedFloat, getPersistedInt, getPersistedLong, getPersistedString, getPersistedStringSet, getPreferenceDataStore, getPreferenceManager, getSharedPreferences, getShouldDisableView, getSummary, getSummaryProvider, getTitle, getWidgetLayoutResource, hasKey, isCopyingEnabled, isEnabled, isIconSpaceReserved, isPersistent, isSelectable, isShown, isSingleLineTitle, isVisible, notifyChanged, notifyDependencyChange, notifyHierarchyChanged, onAttached, onAttachedToHierarchy, onAttachedToHierarchy, onClick, onDependencyChanged, onDetached, onInitializeAccessibilityNodeInfo, onParentChanged, onPrepareForRemoval, onRestoreInstanceState, onSaveInstanceState, onSetInitialValue, peekExtras, performClick, performClick, persistBoolean, persistFloat, persistInt, persistLong, persistString, persistStringSet, restoreHierarchyState, saveHierarchyState, setCopyingEnabled, setDefaultValue, setDependency, setEnabled, setFragment, setIcon, setIcon, setIconSpaceReserved, setIntent, setLayoutResource, setOnPreferenceChangeListener, setOnPreferenceClickListener, setOrder, setPersistent, setPreferenceDataStore, setSelectable, setShouldDisableView, setSingleLineTitle, setSummary, setSummary, setSummaryProvider, setTitle, setTitle, setViewId, setVisible, setWidgetLayoutResource, shouldDisableDependents, shouldPersist, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

SettingDateDialogPreference

public SettingDateDialogPreference(@NonNull
                                   android.content.Context context)

Same as SettingDateDialogPreference(Context, AttributeSet) without attributes.

SettingDateDialogPreference

public SettingDateDialogPreference(@NonNull
                                   android.content.Context context,
                                   @Nullable
                                   android.util.AttributeSet attrs)

Same as SettingDateDialogPreference(Context, AttributeSet, int) with R.attr.settingDateDialogPreferenceStyle as attribute for default style.

SettingDateDialogPreference

public SettingDateDialogPreference(@NonNull
                                   android.content.Context context,
                                   @Nullable
                                   android.util.AttributeSet attrs,
                                   @AttrRes
                                   int defStyleAttr)

Same as SettingDateDialogPreference(Context, AttributeSet, int, int) with 0 as default style.

SettingDateDialogPreference

public SettingDateDialogPreference(@NonNull
                                   android.content.Context context,
                                   @Nullable
                                   android.util.AttributeSet attrs,
                                   @AttrRes
                                   int defStyleAttr,
                                   @StyleRes
                                   int defStyleRes)

Creates a new instance of SettingInputPreference for the given context.

Parameters:

context - Context in which will be the new setting preference presented.

attrs - Set of Xml attributes used to configure the new instance of this preference.

defStyleAttr - An attribute which contains a reference to a default style resource for this preference within a theme of the given context.

defStyleRes - Resource id of the default style for the new preference.

Method Detail

onCreateDialogOptions

@NonNull
protected DatePickerDialog.DateOptions onCreateDialogOptions(@NonNull
                                                                      android.content.res.Resources resources)

Description copied from class: SettingDialogPreference

Called to create instance of dialog options specific for this dialog preference.

Default implementation creates instance of DialogOptions.

Overrides:

onCreateDialogOptions in class SettingDialogPreference<DatePickerDialog.DateOptions>

Parameters:

resources - Application resources that may be used supply default values from resources for the options.

Returns:

New instance of dialog options.

onConfigureDialogOptions

protected void onConfigureDialogOptions(@NonNull
                                        DatePickerDialog.DateOptions options,
                                        @NonNull
                                        android.content.Context context,
                                        @Nullable
                                        android.util.AttributeSet attrs,
                                        @AttrRes
                                        int defStyleAttr,
                                        @StyleRes
                                        int defStyleRes)

Description copied from class: SettingDialogPreference

Called from one of constructors to configure dialog options specific for this dialog preference.

Overrides:

onConfigureDialogOptions in class SettingDialogPreference<DatePickerDialog.DateOptions>

Parameters:

options - The options created via SettingDialogPreference.onCreateDialogOptions(Resources).

setDate

public void setDate(@Nullable
                    Date date)

Same as setDate(long) with milliseconds value of the given date.

Parameters:

date - The desired date with milliseconds value. May be null which corresponds to 0.

See Also:

getDate()

setDate

public void setDate(long dateInMillis)

Sets a preferred date value for this preference.

If value of this preference changes, it is persisted and the change listener is notified about the change.

Parameters:

dateInMillis - The preferred date in milliseconds to be persisted.

See Also:

getDateInMillis()

getDate

@Nullable
public Date getDate()

Like getDateInMillis(), but this method may be used to check whether the date value has been specified or not, as this method will return null Date object if there is no date value specified.

Returns:

Date as date object. May be null if no date value has been specified yet.

See Also:

setDate(Date), getDialogOptions()

getDateInMillis

public long getDateInMillis()

Returns the preferred date value of this preference.

Returns:

Date in milliseconds either specified by the user, as default value or the persisted one.

See Also:

setDate(long), getDialogOptions()

getDialogOptions

@NonNull
public DatePickerDialog.DateOptions getDialogOptions()

Dialog options of this preference with the preferred date specified as DatePickerDialog.DateOptions#date(long), if it is set.

Overrides:

getDialogOptions in class SettingDialogPreference<DatePickerDialog.DateOptions>

Returns:

This preference's dialog options.

See Also:

getDateInMillis()

onHandleDialogButtonClick

protected boolean onHandleDialogButtonClick(@NonNull
                                            Dialog dialog,
                                            int button)

Description copied from class: SettingDialogPreference

Called from SettingDialogPreference.handleDialogButtonClick(Dialog, int) if the given dialog has id associated with this dialog preference.

Overrides:

onHandleDialogButtonClick in class SettingDialogPreference<DatePickerDialog.DateOptions>

Parameters:

dialog - The dialog where the button has been clicked.

button - The clicked dialog button.

Returns:

True if the button click event has been successfully handled, false otherwise.