universum.studios.android.setting

Class SettingColorDialogPreference

java.lang.Object

androidx.preference.Preference

universum.studios.android.setting.SettingPreference

universum.studios.android.setting.SettingDialogPreference<ColorPickerDialog.ColorOptions>

universum.studios.android.setting.SettingColorDialogPreference

All Implemented Interfaces:

Comparable<androidx.preference.Preference>

public final class SettingColorDialogPreference
extends SettingDialogPreference<ColorPickerDialog.ColorOptions>

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

This preference implementation by default displays the preferred color via SettingColorView widget in the widget area (at the end of layout hierarchy). The preferred color may be specified via setColor(int) and obtained via getColor().

When SettingDialogPreference.handleDialogButtonClick(Dialog, int) is called, this preference implementation handles only ColorPickerDialog type of dialog. If its Dialog.BUTTON_POSITIVE button has been clicked, the color provided via ColorPickerDialog.getColor() is set as color for this preference via setColor(int).

Default value

Default value for this preference is parsed as color Integer. See TypedArray.getColor(int, int).

Xml attributes

See SettingDialogPreference, SettingColorDialogPreference Attributes

Default style attribute

settingColorDialogPreferenceStyle

Since:

1.0

Author:

Martin Albedinsky

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
SettingColorDialogPreference(android.content.Context context) Same as SettingColorDialogPreference(Context, AttributeSet) without attributes.
SettingColorDialogPreference(android.content.Context context, android.util.AttributeSet attrs) Same as SettingColorDialogPreference(Context, AttributeSet, int) with R.attr.settingColorDialogPreferenceStyle as attribute for default style.
SettingColorDialogPreference(android.content.Context context, android.util.AttributeSet attrs, int defStyleAttr) Same as SettingColorDialogPreference(Context, AttributeSet, int, int) with 0 as default style.
SettingColorDialogPreference(android.content.Context context, android.util.AttributeSet attrs, int defStyleAttr, int defStyleRes) Creates a new instance of SettingColorDialogPreference for the given context.

Method Summary

Modifier and Type	Method and Description
int	getColor() Returns the preferred color value of this preference.
ColorPickerDialog.ColorOptions	getDialogOptions() Dialog options of this preference with the preferred color specified as ColorPickerDialog.ColorOptions#color(int), if it is set.
void	onBindViewHolder(androidx.preference.PreferenceViewHolder holder)
protected void	onConfigureDialogOptions(ColorPickerDialog.ColorOptions 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 ColorPickerDialog.ColorOptions	onCreateDialogOptions(android.content.res.Resources resources) Called to create instance of dialog options specific for this dialog preference.
protected Object	onGetDefaultValue(android.content.res.TypedArray attributes, int index)
protected boolean	onHandleDialogButtonClick(Dialog dialog, int button) Called from SettingDialogPreference.handleDialogButtonClick(Dialog, int) if the given dialog has id associated with this dialog preference.
protected void	onSetInitialValue(Object defaultValue)
void	setColor(int color) Sets a preferred color value for this preference.

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

getDialogId, handleDialogButtonClick, onGetSummaryText, 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

SettingColorDialogPreference

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

Same as SettingColorDialogPreference(Context, AttributeSet) without attributes.

SettingColorDialogPreference

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

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

SettingColorDialogPreference

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

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

SettingColorDialogPreference

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

Creates a new instance of SettingColorDialogPreference 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 ColorPickerDialog.ColorOptions 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<ColorPickerDialog.ColorOptions>

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
                                        ColorPickerDialog.ColorOptions 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<ColorPickerDialog.ColorOptions>

Parameters:

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

onGetDefaultValue

protected Object onGetDefaultValue(@NonNull
                                   android.content.res.TypedArray attributes,
                                   int index)

Overrides:

onGetDefaultValue in class androidx.preference.Preference

onSetInitialValue

protected void onSetInitialValue(@Nullable
                                 Object defaultValue)

Overrides:

onSetInitialValue in class androidx.preference.Preference

setColor

public void setColor(int color)

Sets a preferred color value for this preference.

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

Parameters:

color - The preferred color to be persisted as Integer.

See Also:

getColor()

getColor

public int getColor()

Returns the preferred color value of this preference.

Returns:

Color integer either specified by the user, as default value or the persisted one.

See Also:

setColor(int), getDialogOptions()

onBindViewHolder

public void onBindViewHolder(@NonNull
                             androidx.preference.PreferenceViewHolder holder)

Overrides:

onBindViewHolder in class SettingPreference

getDialogOptions

@NonNull
public ColorPickerDialog.ColorOptions getDialogOptions()

Dialog options of this preference with the preferred color specified as ColorPickerDialog.ColorOptions#color(int), if it is set.

Overrides:

getDialogOptions in class SettingDialogPreference<ColorPickerDialog.ColorOptions>

Returns:

This preference's dialog options.

See Also:

getColor()

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<ColorPickerDialog.ColorOptions>

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.