universum.studios.android.setting

Class SettingDialogPreference<O extends DialogOptions<O>>

java.lang.Object

androidx.preference.Preference

universum.studios.android.setting.SettingPreference

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

Type Parameters:

O - Type of the dialog options specific for type of the dialog associated with this preference.

All Implemented Interfaces:

Comparable<androidx.preference.Preference>

Direct Known Subclasses:

SettingColorDialogPreference, SettingDateTimeDialogPreference, SettingEditDialogPreference, SettingSelectionDialogPreference

public class SettingDialogPreference<O extends DialogOptions<O>>
extends SettingPreference

A SettingPreference implementation that may be used to show a preference dialog. Each dialog preference has specified id of the associated dialog, via dialog:dialogId attribute, that may be obtained via getDialogId(). Dialog preference also provides an options for its associated dialog that may be obtained via getDialogOptions(). Default values for the dialog options are parsed from the Xml for the attributes specified in the section below.

Subclasses should override onCreateDialogOptions(Resources) to create type of options that are specific for theirs associated type of dialog along with onConfigureDialogOptions(DialogOptions, Context, AttributeSet, int, int) where these options should be configured from the provided AttributeSet. Also onHandleDialogButtonClick(Dialog, int) should be override to provide default handling of dialog button click event.

Default value

This preference implementation does not parse any default value. However parsing of default value may be performed by the subclasses of this preference.

Dialog Xml attributes

See SettingPreference, SettingDialogPreference Attributes

Default style attribute

android:dialogPreferenceStyle

Since:

1.0

Author:

Martin Albedinsky

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SettingDialogPreference.OnClickListener Listener that may be used to receive a callback that a specific dialog preference has been clicked.

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

Modifier and Type	Field and Description
static int	NO_DIALOG_ID Constant identifying no dialog id.

Fields inherited from class androidx.preference.Preference

DEFAULT_ORDER

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
int	getDialogId() Returns id of the dialog associated with this dialog preference.
O	getDialogOptions() Returns the dialog options specific for the dialog associated with this dialog preference.
boolean	handleDialogButtonClick(Dialog dialog, int button) Handles click event for the specified button occurred in the given dialog.
protected void	onConfigureDialogOptions(O 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 O	onCreateDialogOptions(android.content.res.Resources resources) Called to create instance of dialog options specific for this dialog preference.
protected CharSequence	onGetSummaryText() Called from synchronizeSummaryView(PreferenceViewHolder) to retrieve the current summary text for this dialog preference.
protected boolean	onHandleDialogButtonClick(Dialog dialog, int button) Called from handleDialogButtonClick(Dialog, int) if the given dialog has id associated with this dialog preference.
void	setDialogId(int dialogId) Specifies id of a dialog that is associated with this preference.
void	setOnClickListener(SettingDialogPreference.OnClickListener listener) Registers a callback to be invoked whenever this dialog preference is clicked.
protected void	synchronizeSummaryView(androidx.preference.PreferenceViewHolder holder) Performs synchronization of the summary view of this dialog preference.

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

onBindViewHolder, 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, onGetDefaultValue, onInitializeAccessibilityNodeInfo, onParentChanged, onPrepareForRemoval, onRestoreInstanceState, onSaveInstanceState, onSetInitialValue, 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

Field Detail

NO_DIALOG_ID

public static final int NO_DIALOG_ID

Constant identifying no dialog id.

See Also:

getDialogId(), Constant Field Values

Constructor Detail

SettingDialogPreference

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

Same as SettingDialogPreference(Context, AttributeSet) without attributes.

SettingDialogPreference

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

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

SettingDialogPreference

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

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

SettingDialogPreference

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

Creates a new instance of SettingDialogPreference 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

onConfigureDialogOptions

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

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

Parameters:

options - The options created via onCreateDialogOptions(Resources).

onCreateDialogOptions

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

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

Default implementation creates instance of DialogOptions.

Parameters:

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

Returns:

New instance of dialog options.

setOnClickListener

public void setOnClickListener(@Nullable
                               SettingDialogPreference.OnClickListener listener)

Registers a callback to be invoked whenever this dialog preference is clicked.

Note, that this method uses Preference.setOnPreferenceClickListener(OnPreferenceClickListener) to register the requested callback. Any previously registered OnPreferenceClickListener will be replaced.

Parameters:

listener - The desired callback. May be null to clear the current one.

synchronizeSummaryView

protected void synchronizeSummaryView(@NonNull
                                      androidx.preference.PreferenceViewHolder holder)

Performs synchronization of the summary view of this dialog preference.

Default implementation takes the summary text provided by onGetSummaryText() method and sets is text for the summary view, changing its visibility so the summary view is visible if there is some summary text available or gone if there is no summary text available.

This method may be called from {@link #onBindViewHolder(PreferenceViewHolder).

Parameters:

holder - The view holder of this preference.

onGetSummaryText

@Nullable
protected CharSequence onGetSummaryText()

Called from synchronizeSummaryView(PreferenceViewHolder) to retrieve the current summary text for this dialog preference.

Default implementation returns the text provided by Preference.getSummary() method.

Returns:

The actual summary text that should be presented in the summary view of this preference.

setDialogId

public void setDialogId(int dialogId)

Specifies id of a dialog that is associated with this preference.

Parameters:

dialogId - Id of the desired dialog.

See Also:

getDialogId()

getDialogId

public int getDialogId()

Returns id of the dialog associated with this dialog preference.

Default value: NO_DIALOG_ID

Returns:

This preference's associated dialog id.

See Also:

setDialogId(int), dialog:dialogId

getDialogOptions

@NonNull
public O getDialogOptions()

Returns the dialog options specific for the dialog associated with this dialog preference.

Subclasses may override this method and provide the dialog options with the current preferred value so it may be properly displayed in the associated dialog.

Returns:

This preference's dialog options.

handleDialogButtonClick

public boolean handleDialogButtonClick(@NonNull
                                       Dialog dialog,
                                       int button)

Handles click event for the specified button occurred in the given dialog.

Parameters:

dialog - The dialog where the button has been clicked.

button - The clicked dialog button.

Returns:

True if the dialog has id associated with this preference and the button click event has been successfully handled by this preference, false otherwise so it should be handled by the caller.

onHandleDialogButtonClick

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

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

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.