universum.studios.android.setting

Class SettingSelectionDialogPreference

java.lang.Object

android.preference.Preference

universum.studios.android.setting.SettingPreference

universum.studios.android.setting.SettingDialogPreference<SelectionDialog.SelectionOptions>

universum.studios.android.setting.SettingSelectionDialogPreference

All Implemented Interfaces:

Comparable<android.preference.Preference>

public class SettingSelectionDialogPreference
extends SettingDialogPreference<SelectionDialog.SelectionOptions>

A SettingDialogPreference implementation that may be used to allow to a user to select its preferred values, either in single or multiple choice mode, for a specific setting preference. Entries that should be available for selection may be specified via setEntries(CharSequence[]) along with theirs corresponding entry values that should be specified via setEntryValues(CharSequence[]).

This preference implementation by default displays the preferred entry values as its summary text, using SettingSelectionDialogPreference.SummaryTextBuilder, that may be specified via setSummaryTextBuilder(SummaryTextBuilder), to build the summary text from the selected entry values. If there are no preferred entry values selected yet, the standard summary text is displayed. The selected entry values are persisted as String in Json Array format. The preferred entry values may be specified via setSelection(long[]) where the passed array should contain indexes of entry values specified via setEntryValues(CharSequence[]) to be persisted. The current selection array may be obtained via getSelection(). Array of persisted entry values may be obtained via getSelecedEntryValues(). Outside of context of the selection preference it may be obtained via selectedEntryValuesFromPersistedValues(String) method which accepts String containing persisted entry values in Json Array format.

When SettingDialogPreference.handleOnDialogButtonClick(Dialog, int) is called, this preference implementation handles only SelectionDialog type of dialog. If its Dialog#BUTTON_POSITIVE button has been clicked, the selection array provided via SelectionDialog#getSelection() is set as selection for this preference via setSelection(long[]).

Default value

Default value for this preference is parsed as String which should contain entry values that should be by default selected, in Json Array format like "["entry_value_1", "entry_value_2"]". See TypedArray.getString(int).

Xml attributes

See SettingDialogPreference, SettingSelectionDialogPreference Attributes

Default style attribute

uiSettingSelectionDialogPreferenceStyle

Author:

Martin Albedinsky

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SettingSelectionDialogPreference.SummaryTextBuilder Interface for builder that is used by SettingSelectionDialogPreference to build its summary text from the current selection of entry items.

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

SettingDialogPreference.OnClickListener

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

android.preference.Preference.BaseSavedState, android.preference.Preference.OnPreferenceChangeListener, android.preference.Preference.OnPreferenceClickListener

Field Summary

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

NO_DIALOG_ID

Fields inherited from class android.preference.Preference

DEFAULT_ORDER

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
SelectionDialog.SelectionOptions	getDialogOptions() Returns the dialog options specific for the dialog associated with this dialog preference.
CharSequence[]	getEntries() Returns the array of entries specified for this preference.
CharSequence[]	getEntryValues() Returns the array of entry values associated with the entries specified for this preference.
CharSequence[]	getSelecedEntryValues() Returns the array of preferred entry values of this preference.
long[]	getSelection() Returns the array of indexes of the preferred entry values of this preference.
void	onBindView(android.view.View view)
protected void	onConfigureDialogOptions(SelectionDialog.SelectionOptions 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 SelectionDialog.SelectionOptions	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(View) to retrieve the current summary text for this dialog preference.
protected boolean	onHandleDialogButtonClick(Dialog dialog, int button) Called from SettingDialogPreference.handleOnDialogButtonClick(Dialog, int) if the given dialog has id associated with this dialog preference.
protected void	onSetInitialValue(boolean restorePersistedValue, Object defaultValue)
static String[]	selectedEntryValuesFromPersistedValues(String persistedValues) Creates an array of selected entry values from the given persistedValues String.
void	setEntries(CharSequence[] entries) Specifies an array of entries that should be displayed in the associated selection dialog.
void	setEntries(int resId) Same as setEntries(CharSequence[]) for resource id.
void	setEntryValues(CharSequence[] entryValues) Specifies an array of entry values where each value should be associated with corresponding entry from the entries array specified via setEntries(CharSequence[]).
void	setEntryValues(int resId) Same as setEntryValues(CharSequence[]) for resource id.
void	setSelection(long[] selection) Sets a selection array containing indexes of preferred entry values that have been specified via setEntryValues(CharSequence[]) for this preference.
void	setSummaryTextBuilder(SettingSelectionDialogPreference.SummaryTextBuilder textBuilder) Sets a builder that should be used by this preference to build its summary text for the current selected entry items.

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

getDialogId, handleOnDialogButtonClick, setOnClickListener, synchronizeSummaryView

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

setKey

Methods inherited from class android.preference.Preference

callChangeListener, compareTo, findPreferenceInHierarchy, getContext, getDependency, getEditor, getExtras, getFragment, getIcon, getIntent, getKey, getLayoutResource, getOnPreferenceChangeListener, getOnPreferenceClickListener, getOrder, getPersistedBoolean, getPersistedFloat, getPersistedInt, getPersistedLong, getPersistedString, getPersistedStringSet, getPreferenceManager, getSharedPreferences, getShouldDisableView, getSummary, getTitle, getTitleRes, getView, getWidgetLayoutResource, hasKey, isEnabled, isPersistent, isSelectable, notifyChanged, notifyDependencyChange, notifyHierarchyChanged, onAttachedToActivity, onAttachedToHierarchy, onClick, onCreateView, onDependencyChanged, onParentChanged, onPrepareForRemoval, onRestoreInstanceState, onSaveInstanceState, peekExtras, persistBoolean, persistFloat, persistInt, persistLong, persistString, persistStringSet, restoreHierarchyState, saveHierarchyState, setDefaultValue, setDependency, setEnabled, setFragment, setIcon, setIcon, setIntent, setLayoutResource, setOnPreferenceChangeListener, setOnPreferenceClickListener, setOrder, setPersistent, setSelectable, setShouldDisableView, setSummary, setSummary, setTitle, setTitle, setWidgetLayoutResource, shouldCommit, shouldDisableDependents, shouldPersist, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

SettingSelectionDialogPreference

public SettingSelectionDialogPreference(android.content.Context context)

Same as SettingSelectionDialogPreference(Context, AttributeSet) without attributes.

SettingSelectionDialogPreference

public SettingSelectionDialogPreference(android.content.Context context,
                                        android.util.AttributeSet attrs)

Same as SettingSelectionDialogPreference(Context, AttributeSet, int) with R.attr#uiSettingSelectionDialogPreferenceStyle as attribute for default style.

SettingSelectionDialogPreference

public SettingSelectionDialogPreference(android.content.Context context,
                                        android.util.AttributeSet attrs,
                                        int defStyleAttr)

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

SettingSelectionDialogPreference

public SettingSelectionDialogPreference(android.content.Context context,
                                        android.util.AttributeSet attrs,
                                        int defStyleAttr,
                                        int defStyleRes)

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

protected SelectionDialog.SelectionOptions onCreateDialogOptions(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<SelectionDialog.SelectionOptions>

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(SelectionDialog.SelectionOptions options,
                                        android.content.Context context,
                                        android.util.AttributeSet attrs,
                                        int defStyleAttr,
                                        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<SelectionDialog.SelectionOptions>

Parameters:

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

setEntries

public void setEntries(int resId)

Same as setEntries(CharSequence[]) for resource id.

Parameters:

resId - Resource id of the desired text array with entries.

setEntries

public void setEntries(CharSequence[] entries)

Specifies an array of entries that should be displayed in the associated selection dialog.

Parameters:

entries - The desired array of entries. May be null to clear the current ones.

See Also:

R.attr.entries, setEntryValues(CharSequence[])

getEntries

public CharSequence[] getEntries()

Returns the array of entries specified for this preference.

Returns:

Array with entries. May be null if no entries have been specified.

See Also:

setEntries(CharSequence[]), getEntryValues()

setEntryValues

public void setEntryValues(int resId)

Same as setEntryValues(CharSequence[]) for resource id.

Parameters:

resId - Resource id of the desired text array with values for entries.

setEntryValues

public void setEntryValues(CharSequence[] entryValues)

Specifies an array of entry values where each value should be associated with corresponding entry from the entries array specified via setEntries(CharSequence[]).

Note, that this method does not check if the entries and entry values arrays are consistent, that is that they are equal in length.

Parameters:

entryValues - The desired array of values associated with entries. May be null to clear the current ones.

See Also:

R.attr.entryValues

getEntryValues

public CharSequence[] getEntryValues()

Returns the array of entry values associated with the entries specified for this preference.

Returns:

Array with entry values. May be null if no entry values have been specified.

See Also:

setEntryValues(CharSequence[]), getEntries()

setSummaryTextBuilder

public void setSummaryTextBuilder(SettingSelectionDialogPreference.SummaryTextBuilder textBuilder)

Sets a builder that should be used by this preference to build its summary text for the current selected entry items.

By default, this preference uses internal implementation of the summary builder which separates the entry items in the summary text by ', '.

Parameters:

textBuilder - The desired builder for the summary text. May be null to use the default one.

onGetDefaultValue

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

Overrides:

onGetDefaultValue in class android.preference.Preference

onSetInitialValue

protected void onSetInitialValue(boolean restorePersistedValue,
                                 Object defaultValue)

Overrides:

onSetInitialValue in class android.preference.Preference

selectedEntryValuesFromPersistedValues

public static String[] selectedEntryValuesFromPersistedValues(String persistedValues)

Creates an array of selected entry values from the given persistedValues String.

Parameters:

persistedValues - The string with entry values in Json Array format persisted for a particular SettingSelectionDialogPreference.

Returns:

Array of entry values that have been persisted or null if no preferred values have been selected/persisted yet.

setSelection

public void setSelection(long[] selection)

Sets a selection array containing indexes of preferred entry values that have been specified via setEntryValues(CharSequence[]) for this preference.

Parameters:

selection - The desired selection array with indexes of the preferred entry values to be persisted as String in Json Array format.

See Also:

getSelection()

getSelection

public long[] getSelection()

Returns the array of indexes of the preferred entry values of this preference.

Returns:

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

See Also:

setSelection(long[]), getSelecedEntryValues(), getDialogOptions()

getSelecedEntryValues

public CharSequence[] getSelecedEntryValues()

Returns the array of preferred entry values of this preference.

Returns:

Array containing entry values that have been selected either by user, as default value or the persisted one.

See Also:

getSelection()

onBindView

public void onBindView(android.view.View view)

Overrides:

onBindView in class SettingPreference

onGetSummaryText

protected CharSequence onGetSummaryText()

Description copied from class: SettingDialogPreference

Called from SettingDialogPreference.synchronizeSummaryView(View) 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<SelectionDialog.SelectionOptions>

Returns:

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

getDialogOptions

public SelectionDialog.SelectionOptions getDialogOptions()

Description copied from class: SettingDialogPreference

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.

Overrides:

getDialogOptions in class SettingDialogPreference<SelectionDialog.SelectionOptions>

Returns:

This preference's dialog options.

onHandleDialogButtonClick

protected boolean onHandleDialogButtonClick(Dialog dialog,
                                            int button)

Description copied from class: SettingDialogPreference

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

Overrides:

onHandleDialogButtonClick in class SettingDialogPreference<SelectionDialog.SelectionOptions>

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.