de.mrapp.android.preference

Class SeekBarPreference

java.lang.Object

androidx.preference.Preference

de.mrapp.android.preference.Preference

de.mrapp.android.preference.DialogPreference

de.mrapp.android.preference.SeekBarPreference

All Implemented Interfaces:

android.content.DialogInterface.OnCancelListener, android.content.DialogInterface.OnClickListener, android.content.DialogInterface.OnDismissListener, android.content.DialogInterface.OnKeyListener, android.content.DialogInterface.OnShowListener

public class SeekBarPreference
extends DialogPreference

A preference, which allows to select a value from a continuous range via a seek bar. When interacting with the preference, the seek bar is shown within a dialog. The chosen value will only be persisted, if confirmed by the user. The preference can be used to select floating point values if a specific number of decimals or integer values. Furthermore it is possible to customize the appearance of the dialog and to set a step size, the currently chosen value is increased or decreased by, when moving the seek bar.

Since:

1.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SeekBarPreference.SavedState A data structure, which allows to save the internal state of a SeekBarPreference.

Constructor Summary

Constructors

Constructor and Description
SeekBarPreference(android.content.Context context) Creates a new preference, which allows to select a value from a continuous range via a seek bar.
SeekBarPreference(android.content.Context context, android.util.AttributeSet attributeSet) Creates a new preference, which allows to select a value from a continuous range via a seek bar.
SeekBarPreference(android.content.Context context, android.util.AttributeSet attributeSet, int defaultStyle) Creates a new preference, which allows to select a value from a continuous range via a seek bar.
SeekBarPreference(android.content.Context context, android.util.AttributeSet attributeSet, int defaultStyle, int defaultStyleResource) Creates a new preference, which allows to select a value from a continuous range via a seek bar.

Method Summary

Modifier and Type	Method and Description
protected float	getCurrentValue() Returns the current value of the seek bar.
int	getDecimals() Returns the number of decimals of the floating point numbers, the preference allows to choose.
java.lang.CharSequence	getFloatingPointSeparator() Returns the symbol, which is used to separate floating point numbers for textual representation.
int	getMaxValue() Returns the maximum value, the preference allows to choose.
int	getMinValue() Returns the minimum value, the preference allows to choose.
int	getRange() Returns the range of values, the preference allows to choose from.
int	getStepSize() Returns the step size, the value is increased or decreased by, when moving the seek bar.
java.lang.CharSequence[]	getSummaries() Returns the summaries, which are shown depending on the currently persisted value.
java.lang.CharSequence	getSummary()
java.lang.CharSequence	getUnit() Returns the unit, which is used for textual representation of the preference's value.
float	getValue() Returns the currently persisted value of the preference.
boolean	isProgressShown() Returns, whether the currently selected value of the seek bar is shown, or not.
protected void	onDialogClosed(AbstractButtonBarDialog dialog, boolean positiveResult) The method, which is invoked on subclasses when the preference's dialog has been closed.
protected java.lang.Object	onGetDefaultValue(android.content.res.TypedArray a, int index)
protected void	onPrepareDialog(<any> dialogBuilder) The method, which is invoked on subclasses when the preference's dialog is about to be created.
protected void	onRestoreInstanceState(android.os.Parcelable state)
protected android.os.Parcelable	onSaveInstanceState()
protected void	onSetInitialValue(java.lang.Object defaultValue)
void	setDecimals(int decimals) Sets the number of decimals of the floating point numbers, the preference should allow to choose.
void	setFloatingPointSeparator(java.lang.CharSequence floatingPointSeparator) Sets the symbol, which should be used to separate floating point numbers for textual representation.
void	setFloatingPointSeparator(int resourceId) Sets the symbol, which should be used to separate floating point numbers for textual representation.
void	setMaxValue(int maxValue) Sets the maximum value, the preference should allow to choose.
void	setMinValue(int minValue) Sets the minimum value, the preference should allow to choose.
void	setStepSize(int stepSize) Sets the step size, the value should be increased or decreased by, when moving the seek bar.
void	setSummaries(java.lang.CharSequence[] summaries) Sets the summaries, which should be shown depending on the currently persisted value.
void	setSummary(java.lang.CharSequence summary)
void	setSummary(int resourceId)
void	setUnit(java.lang.CharSequence unit) Sets the unit, which should be used for textual representation of the preference's value.
void	setUnit(int resourceId) Sets the unit, which should be used for textual representation of the preference's value.
void	setValue(java.lang.Float value) Sets the current value of the preference.
void	showProgress(boolean showProgress) Sets, whether the currently selected value of the seek bar should be shown, or not.

Methods inherited from class de.mrapp.android.preference.DialogPreference

areDialogDividersShownOnScroll, createDialog, createDialogBuilder, getDialog, getDialogBackground, getDialogBottomMargin, getDialogButtonTextColor, getDialogButtonTypeface, getDialogCancelAnimation, getDialogDismissAnimation, getDialogDividerColor, getDialogDividerMargin, getDialogGravity, getDialogHeaderBackground, getDialogHeaderIcon, getDialogHeaderIconTintList, getDialogHeaderIconTintMode, getDialogHeight, getDialogIcon, getDialogIconTintList, getDialogIconTintMode, getDialogLeftMargin, getDialogMaxHeight, getDialogMaxWidth, getDialogMessage, getDialogMessageColor, getDialogMessageTypeface, getDialogPaddingBottom, getDialogPaddingLeft, getDialogPaddingRight, getDialogPaddingTop, getDialogRightMargin, getDialogScrollableArea, getDialogShowAnimation, getDialogTitle, getDialogTitleColor, getDialogTitleTypeface, getDialogTopMargin, getDialogWidth, getDialogWindowBackground, getNegativeButtonText, getPositiveButtonText, isDialogButtonBarDividerShown, isDialogFitsSystemWindowsBottom, isDialogFitsSystemWindowsLeft, isDialogFitsSystemWindowsRight, isDialogFitsSystemWindowsTop, isDialogFullscreen, isDialogHeaderShown, isDialogShown, isValueShownAsSummary, needInputMethod, onCancel, onClick, onClick, onDismiss, onKey, onShow, performClick, setCustomDialogButtonBar, setCustomDialogButtonBar, setCustomDialogHeader, setCustomDialogHeader, setCustomDialogMessage, setCustomDialogMessage, setCustomDialogTitle, setCustomDialogTitle, setDialogBackground, setDialogBackground, setDialogBackgroundColor, setDialogButtonTextColor, setDialogButtonTextColor, setDialogButtonTypeface, setDialogCancelAnimation, setDialogDismissAnimation, setDialogDividerColor, setDialogDividerMargin, setDialogFitsSystemWindows, setDialogFitsSystemWindows, setDialogFullscreen, setDialogGravity, setDialogHeaderBackground, setDialogHeaderBackground, setDialogHeaderBackgroundColor, setDialogHeaderIcon, setDialogHeaderIcon, setDialogHeaderIconTint, setDialogHeaderIconTintList, setDialogHeaderIconTintMode, setDialogHeight, setDialogIcon, setDialogIcon, setDialogIconTint, setDialogIconTintList, setDialogIconTintMode, setDialogMargin, setDialogMaxHeight, setDialogMaxWidth, setDialogMessage, setDialogMessage, setDialogMessageColor, setDialogMessageTypeface, setDialogPadding, setDialogScrollableArea, setDialogScrollableArea, setDialogShowAnimation, setDialogTitle, setDialogTitle, setDialogTitleColor, setDialogTitleTypeface, setDialogWidth, setDialogWindowBackground, setDialogWindowBackground, setNegativeButtonText, setNegativeButtonText, setOnCancelListener, setOnClickListener, setOnDismissListener, setOnKeyListener, setOnShowListener, setPositiveButtonText, setPositiveButtonText, showDialogButtonBarDivider, showDialogDividersOnScroll, showDialogHeader, showValueAsSummary

Methods inherited from class de.mrapp.android.preference.Preference

getIconTintList, getIconTintMode, setIcon, setIconTint, setIconTintList, setIconTintMode

Methods inherited from class java.lang.Object

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

Constructor Detail

SeekBarPreference

public SeekBarPreference(android.content.Context context)

Creates a new preference, which allows to select a value from a continuous range via a seek bar.

Parameters:

context - The context in which to store the preference's value as an instance of the class Context. The context may not be null

SeekBarPreference

public SeekBarPreference(android.content.Context context,
                         android.util.AttributeSet attributeSet)

Creates a new preference, which allows to select a value from a continuous range via a seek bar. This constructor is called when a preference is being constructed from an XML file, supplying attributes that were specified in the XML file. This version uses a default style of 0, so the only attribute values applied are those in the context's theme and the given attribute set.

Parameters:

context - The Context this preference is associated with and through which it can access the current theme, resources, SharedPreferences, etc, as an instance of the class Context. The context may not be null

attributeSet - The attributes of the XML tag that is inflating the preference, as an instance of the type AttributeSet or null, if no attributes are available

SeekBarPreference

public SeekBarPreference(android.content.Context context,
                         android.util.AttributeSet attributeSet,
                         int defaultStyle)

Creates a new preference, which allows to select a value from a continuous range via a seek bar. This constructor allows subclasses to use their own base style when they are inflating.

Parameters:

context - The context in which to store Preference value as an instance of the class Context. The context may not be null

attributeSet - The attribute set, the preference's attributes should be obtained from, as an instance of the type AttributeSet or null, if no attributes are available

defaultStyle - The default style to apply to this preference. If 0, no style will be applied (beyond what is included in the theme). This may either be an attribute resource, whose value will be retrieved from the current theme, or an explicit style resource

SeekBarPreference

public SeekBarPreference(android.content.Context context,
                         android.util.AttributeSet attributeSet,
                         int defaultStyle,
                         int defaultStyleResource)

Creates a new preference, which allows to select a value from a continuous range via a seek bar. This constructor allows subclasses to use their own base style when they are inflating.

Parameters:

context - The context in which to store Preference value as an instance of the class Context. The context may not be null

attributeSet - The attribute set, the preference's attributes should be obtained from, as an instance of the type AttributeSet or null, if no attributes are available

defaultStyle - The default style to apply to this preference. If 0, no style will be applied (beyond what is included in the theme). This may either be an attribute resource, whose value will be retrieved from the current theme, or an explicit style resource

defaultStyleResource - A resource identifier of a style resource that supplies default values for the preference, used only if the default style is 0 or can not be found in the theme. Can be 0 to not look for defaults

Method Detail

getCurrentValue

protected final float getCurrentValue()

Returns the current value of the seek bar.

Returns:

The current value of the seek bar as a Float value

getValue

public final float getValue()

Returns the currently persisted value of the preference.

Returns:

The currently persisted value as a Float value

setValue

public final void setValue(java.lang.Float value)

Sets the current value of the preference. By setting a value, it will be persisted.

Parameters:

value - The value, which should be set, as a Float value. The value must be between the minimum and the maximum value, the preference allows to select

getMinValue

public final int getMinValue()

Returns the minimum value, the preference allows to choose.

Returns:

The minimum value, the preference allows to choose, as an Integer value

setMinValue

public final void setMinValue(int minValue)

Sets the minimum value, the preference should allow to choose.

Parameters:

minValue - The minimum value, which should be set, as an Integer value. The value must be less than the maximum value, the preference allows to choose

getMaxValue

public final int getMaxValue()

Returns the maximum value, the preference allows to choose.

Returns:

The maximum value, the preference allows to choose, as an Integer value

setMaxValue

public final void setMaxValue(int maxValue)

Sets the maximum value, the preference should allow to choose.

Parameters:

maxValue - The maximum value, which should be set, as an Integer value. The value must be greater than the minimum value, that preference allows to choose

getRange

public final int getRange()

Returns the range of values, the preference allows to choose from.

Returns:

The range of values, the preference allows to choose from, as an Integer value

getStepSize

public final int getStepSize()

Returns the step size, the value is increased or decreased by, when moving the seek bar.

Returns:

The step size, the value is increased or decreased by, when moving the seek bar, as an Integer value

setStepSize

public final void setStepSize(int stepSize)

Sets the step size, the value should be increased or decreased by, when moving the seek bar.

Parameters:

stepSize - The step size, which should be set, as an Integer value. The value must be at least 1 and at maximum the value of the method getRange():int or -1, if the preference should allow to select a value from a continuous range

getDecimals

public final int getDecimals()

Returns the number of decimals of the floating point numbers, the preference allows to choose. If the number of decimals is set to 0, the preference only allows to choose integer values.

Returns:

The number of decimals of the floating point numbers, the preference allows to choose, as an Integer value

setDecimals

public final void setDecimals(int decimals)

Sets the number of decimals of the floating point numbers, the preference should allow to choose. If the number of decimals is set to 0, the preference will only allow to choose integer values.

Parameters:

decimals - The number of decimals, which should be set, as an Integer value. The value must be at least 0. If the value is set to 0, the preference will only allow to choose integer values

getUnit

public final java.lang.CharSequence getUnit()

Returns the unit, which is used for textual representation of the preference's value.

Returns:

The unit, which is used for textual representation of the preference's value, as an instance of the type CharSequence or null, if no unit is used

setUnit

public final void setUnit(java.lang.CharSequence unit)

Sets the unit, which should be used for textual representation of the preference's value.

Parameters:

unit - The unit, which should be set, as an instance of the type CharSequence or null, if no unit should be used

setUnit

public final void setUnit(int resourceId)

Sets the unit, which should be used for textual representation of the preference's value.

Parameters:

resourceId - The resource id of the unit, which should be set, as an Integer value. The resource id must correspond to a valid string resource

getFloatingPointSeparator

public final java.lang.CharSequence getFloatingPointSeparator()

Returns the symbol, which is used to separate floating point numbers for textual representation.

Returns:

The symbol, which is used to separate floating point numbers for textual representation, as an instance of the type Character or null, if the default symbol is used

setFloatingPointSeparator

public final void setFloatingPointSeparator(java.lang.CharSequence floatingPointSeparator)

Sets the symbol, which should be used to separate floating point numbers for textual representation.

Parameters:

floatingPointSeparator - The symbol, which should be set, as an instance of the type CharSequence or null, if the default symbol should be used. The length of the symbol must be 1

setFloatingPointSeparator

public final void setFloatingPointSeparator(int resourceId)

Sets the symbol, which should be used to separate floating point numbers for textual representation.

Parameters:

resourceId - The resource id of the symbol, which should be set, as an Integer value. The resource id must correspond to a valid string resource

isProgressShown

public final boolean isProgressShown()

Returns, whether the currently selected value of the seek bar is shown, or not.

Returns:

True, if the currently selected value of the seek bar is shown, false otherwise

showProgress

public final void showProgress(boolean showProgress)

Sets, whether the currently selected value of the seek bar should be shown, or not.

Parameters:

showProgress - True, if the currently selected value of the seek bar should be shown, false otherwise

getSummaries

public final java.lang.CharSequence[] getSummaries()

Returns the summaries, which are shown depending on the currently persisted value.

Returns:

The summaries, which are shown depending on the currently persisted value, as an array of the type CharSequence or null, if no summaries are shown depending on the currently persisted value

setSummaries

public final void setSummaries(java.lang.CharSequence[] summaries)

Sets the summaries, which should be shown depending on the currently persisted value.

Parameters:

summaries - The summaries, which should be set, as an array of the type CharSequence or null, if no summaries should be shown depending on the currently persisted value

getSummary

public final java.lang.CharSequence getSummary()

setSummary

public final void setSummary(java.lang.CharSequence summary)

setSummary

public final void setSummary(int resourceId)

onGetDefaultValue

protected final java.lang.Object onGetDefaultValue(android.content.res.TypedArray a,
                                                   int index)

onSetInitialValue

protected final void onSetInitialValue(java.lang.Object defaultValue)

onPrepareDialog

protected void onPrepareDialog(<any> dialogBuilder)

Description copied from class: DialogPreference

The method, which is invoked on subclasses when the preference's dialog is about to be created. The builder, which is passed as a method parameter may be manipulated by subclasses in order to change the appearance of the dialog. When views are inflated inside this method, the context of the builder should be used in order to ensure that the dialog's theme is used.

Overrides:

onPrepareDialog in class DialogPreference

Parameters:

dialogBuilder - The builder, which is used to create the preference's dialog, as an instance of the class AbstractMaterialDialogBuilder

onDialogClosed

protected void onDialogClosed(AbstractButtonBarDialog dialog,
                              boolean positiveResult)

Description copied from class: DialogPreference

The method, which is invoked on subclasses when the preference's dialog has been closed. This method may be used within subclasses to evaluate the changes, which have been made while the dialog was shown.

Overrides:

onDialogClosed in class DialogPreference

Parameters:

dialog - The dialog, which has been closed, as an instance of the class AbstractButtonBarDialog. The dialog may not be null

positiveResult - True, if the dialog has been close affirmatively, false otherwise

onSaveInstanceState

protected android.os.Parcelable onSaveInstanceState()

Overrides:

onSaveInstanceState in class DialogPreference

onRestoreInstanceState

protected void onRestoreInstanceState(android.os.Parcelable state)

Overrides:

onRestoreInstanceState in class DialogPreference