universum.studios.android.setting

Class SettingTimeDialogPreference

java.lang.Object

androidx.preference.Preference

universum.studios.android.setting.SettingPreference

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

universum.studios.android.setting.SettingDateTimeDialogPreference<TimePickerDialog.TimeOptions>

universum.studios.android.setting.SettingTimeDialogPreference

All Implemented Interfaces:

Comparable<androidx.preference.Preference>

public class SettingTimeDialogPreference
extends SettingDateTimeDialogPreference<TimePickerDialog.TimeOptions>

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

This preference implementation by default displays the preferred time formatted by format specified via SettingDateTimeDialogPreference.setFormat(SimpleDateFormat) as summary text. The default format is 'hh:mm a'. If no time is specified, the standard summary text is displayed. The preferred time may be specified via setTime(Date) and obtained via getTime() or getTimeInMillis().

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

Default value

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

Xml attributes

See SettingDateTimeDialogPreference, SettingTimeDialogPreference Attributes

Default style attribute

settingTimeDialogPreferenceStyle

Since:

1.0

Author:

Martin Albedinsky

See Also:

SettingDateDialogPreference

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
SettingTimeDialogPreference(android.content.Context context) Same as SettingTimeDialogPreference(Context, AttributeSet) without attributes.
SettingTimeDialogPreference(android.content.Context context, android.util.AttributeSet attrs) Same as SettingTimeDialogPreference(Context, AttributeSet, int) with R.attr.settingTimeDialogPreferenceStyle as attribute for default style.
SettingTimeDialogPreference(android.content.Context context, android.util.AttributeSet attrs, int defStyleAttr) Same as SettingTimeDialogPreference(Context, AttributeSet, int, int) with 0 as default style.
SettingTimeDialogPreference(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
TimePickerDialog.TimeOptions	getDialogOptions() Dialog options of this preference with the preferred time specified as TimePickerDialog.TimeOptions#time(long), if it is set.
Date	getTime() Like getTimeInMillis(), but this method may be used to check whether the time value has been specified or not, as this method will return null Date object if there is no time value specified.
long	getTimeInMillis() Returns the preferred time value of this preference.
protected void	onConfigureDialogOptions(TimePickerDialog.TimeOptions 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 TimePickerDialog.TimeOptions	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	setTime(Date time) Same as setTime(long) with milliseconds value of the given date.
void	setTime(long timeInMillis) Sets a preferred time 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

SettingTimeDialogPreference

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

Same as SettingTimeDialogPreference(Context, AttributeSet) without attributes.

SettingTimeDialogPreference

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

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

SettingTimeDialogPreference

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

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

SettingTimeDialogPreference

public SettingTimeDialogPreference(@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 TimePickerDialog.TimeOptions 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<TimePickerDialog.TimeOptions>

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
                                        TimePickerDialog.TimeOptions 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<TimePickerDialog.TimeOptions>

Parameters:

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

setTime

public void setTime(@Nullable
                    Date time)

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

Parameters:

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

See Also:

getTime()

setTime

public void setTime(long timeInMillis)

Sets a preferred time value for this preference.

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

Parameters:

timeInMillis - The preferred time in milliseconds to be persisted.

See Also:

getTimeInMillis()

getTime

@Nullable
public Date getTime()

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

Returns:

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

See Also:

setTime(Date), getDialogOptions()

getTimeInMillis

public long getTimeInMillis()

Returns the preferred time value of this preference.

Returns:

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

See Also:

setTime(long), getDialogOptions()

getDialogOptions

@NonNull
public TimePickerDialog.TimeOptions getDialogOptions()

Dialog options of this preference with the preferred time specified as TimePickerDialog.TimeOptions#time(long), if it is set.

Overrides:

getDialogOptions in class SettingDialogPreference<TimePickerDialog.TimeOptions>

Returns:

This preference's dialog options.

See Also:

getTimeInMillis()

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<TimePickerDialog.TimeOptions>

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.