universum.studios.android.setting

Class SettingEditDialogPreference

java.lang.Object

androidx.preference.Preference

universum.studios.android.setting.SettingPreference

universum.studios.android.setting.SettingDialogPreference<EditDialog.EditOptions>

universum.studios.android.setting.SettingEditDialogPreference

All Implemented Interfaces:

Comparable<androidx.preference.Preference>

public class SettingEditDialogPreference
extends SettingDialogPreference<EditDialog.EditOptions>

A SettingDialogPreference implementation that may be used to allow to a user to specify its preferred input text for a specific setting preference.

This preference implementation by default displays the preferred input text as its summary text if it is specified, or the standard summary text if there is no input text persisted. The preferred input text may be specified via setInput(String) and obtained via getInput().

When SettingDialogPreference.handleDialogButtonClick(Dialog, int) is called, this preference implementation handles only EditDialog type of dialog. If its Dialog.BUTTON_POSITIVE button has been clicked, the input provided via EditDialog.getInput() is set as input for this preference via setInput(String).

Default value

Default value for this preference is parsed as String. See TypedArray.getString(int).

Xml attributes

See SettingDialogPreference, SettingEditDialogPreference Attributes

Default style attribute

settingEditDialogPreferenceStyle

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

Method Summary

Modifier and Type	Method and Description
EditDialog.EditOptions	getDialogOptions() Dialog options of this preference with the preferred input specified as EditDialog.EditOptions#content(CharSequence), if it is set.
String	getInput() Returns the preferred input value of this preference.
void	onBindViewHolder(androidx.preference.PreferenceViewHolder holder)
protected void	onConfigureDialogOptions(EditDialog.EditOptions 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 EditDialog.EditOptions	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 typedArray, int index)
protected CharSequence	onGetSummaryText() Called from SettingDialogPreference.synchronizeSummaryView(PreferenceViewHolder) to retrieve the current summary text 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.
protected void	onSetInitialValue(Object defaultValue)
void	setInput(String input) Sets a preferred input value for this preference.

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

SettingEditDialogPreference

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

Same as SettingEditDialogPreference(Context, AttributeSet) without attributes.

SettingEditDialogPreference

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

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

SettingEditDialogPreference

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

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

SettingEditDialogPreference

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

Creates a new instance of SettingEditDialogPreference 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
                                        EditDialog.EditOptions 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<EditDialog.EditOptions>

Parameters:

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

onCreateDialogOptions

@NonNull
protected EditDialog.EditOptions 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<EditDialog.EditOptions>

Parameters:

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

Returns:

New instance of dialog options.

onGetDefaultValue

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

Overrides:

onGetDefaultValue in class androidx.preference.Preference

onSetInitialValue

protected void onSetInitialValue(@Nullable
                                 Object defaultValue)

Overrides:

onSetInitialValue in class androidx.preference.Preference

setInput

public void setInput(@Nullable
                     String input)

Sets a preferred input value for this preference.

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

Parameters:

input - The preferred input to be persisted.

See Also:

getInput()

getInput

@Nullable
public String getInput()

Returns the preferred input value of this preference.

Returns:

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

See Also:

setInput(String), getDialogOptions()

onBindViewHolder

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

Overrides:

onBindViewHolder in class SettingPreference

onGetSummaryText

@Nullable
protected CharSequence onGetSummaryText()

Description copied from class: SettingDialogPreference

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

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

Overrides:

onGetSummaryText in class SettingDialogPreference<EditDialog.EditOptions>

Returns:

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

getDialogOptions

@NonNull
public EditDialog.EditOptions getDialogOptions()

Dialog options of this preference with the preferred input specified as EditDialog.EditOptions#content(CharSequence), if it is set.

Overrides:

getDialogOptions in class SettingDialogPreference<EditDialog.EditOptions>

Returns:

This preference's dialog options.

See Also:

getInput()

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<EditDialog.EditOptions>

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.