SeekBarPreference


public class SeekBarPreference extends Preference


Preference based on android.preference.SeekBarPreference but uses support preference as a base . It contains a title and a SeekBar and an optional SeekBar value TextView. The actual preference layout is customizable by setting android:layout on the preference widget layout or seekBarPreferenceStyle attribute.

The SeekBar within the preference can be defined adjustable or not by setting adjustable attribute. If adjustable, the preference will be responsive to DPAD left/right keys. Otherwise, it skips those keys.

The SeekBar value view can be shown or disabled by setting showSeekBarValue attribute to true or false, respectively.

Other SeekBar specific attributes (e.g. title, summary, defaultValue, min, max) can be set directly on the preference widget layout.

Summary

Public constructors

SeekBarPreference(
    @NonNull Context context,
    @Nullable AttributeSet attrs,
    int defStyleAttr
)
SeekBarPreference(
    @NonNull Context context,
    @Nullable AttributeSet attrs,
    int defStyleAttr,
    int defStyleRes
)

Public methods

int

Gets the upper bound set on the SeekBar.

int

Gets the lower bound set on the SeekBar.

final int

Returns the amount of increment change via each arrow key click.

boolean

Gets whether the current SeekBar value is displayed to the user.

boolean

Gets whether the SeekBarPreference should continuously save the SeekBar value while it is being dragged.

int

Gets the current progress of the SeekBar.

boolean

Gets whether the SeekBar should respond to the left/right keys.

void

Binds the created View to the data for this preference.

void
setAdjustable(boolean adjustable)

Sets whether the SeekBar should respond to the left/right keys.

final void
setMax(int max)

Sets the upper bound on the SeekBar.

void
setMin(int min)

Sets the lower bound on the SeekBar.

final void
setSeekBarIncrement(int seekBarIncrement)

Sets the increment amount on the SeekBar for each arrow key press.

void
setShowSeekBarValue(boolean showSeekBarValue)

Sets whether the current SeekBar value is displayed to the user.

void
setUpdatesContinuously(boolean updatesContinuously)

Sets whether the SeekBarPreference should continuously save the SeekBar value while it is being dragged.

void
setValue(int seekBarValue)

Sets the current progress of the SeekBar.

Protected methods

@Nullable Object

Called when a preference is being inflated and the default value attribute needs to be read.

void

Hook allowing a preference to re-apply a representation of its internal state that had previously been generated by onSaveInstanceState.

@Nullable Parcelable

Hook allowing a preference to generate a representation of its internal state that can later be used to create a new instance with that same state.

void
onSetInitialValue(Object defaultValue)

Implement this to set the initial value of the preference.

Inherited Constants

From androidx.preference.Preference
static final int
DEFAULT_ORDER = 2147483647

Specify for setOrder if a specific order is not required.

Inherited methods

From java.lang.Comparable
abstract int
compareTo(T p)
From androidx.preference.Preference
boolean

Call this method after the user changes the preference, but before the internal state is set.

int

Compares preference objects based on order (if set), otherwise alphabetically on the titles.

@Nullable T

Finds a preference in the entire hierarchy (above or below this preference) with the given key.

@NonNull Context

Returns the Context of this preference.

@Nullable String

Returns the key of the dependency on this preference.

@NonNull Bundle

Return the extras Bundle object associated with this preference, creating a new Bundle if there currently isn't one.

@Nullable String

Return the fragment class name associated with this preference.

@Nullable Drawable

Returns the icon of this preference.

@Nullable Intent

Return the Intent associated with this preference.

String

Gets the key for this preference, which is also the key used for storing values into SharedPreferences or PreferenceDataStore.

final int

Gets the layout resource that will be shown as the View for this preference.

@Nullable Preference.OnPreferenceChangeListener

Returns the callback to be invoked when this preference is changed by the user (but before the internal state has been updated).

@Nullable Preference.OnPreferenceClickListener

Returns the callback to be invoked when this preference is clicked.

int

Gets the order of this preference with respect to other preference objects on the same level.

@Nullable PreferenceGroup

Returns the PreferenceGroup which is this preference assigned to or null if this preference is not assigned to any group or is a root preference.

boolean
getPersistedBoolean(boolean defaultReturnValue)

Attempts to get a persisted Boolean if this preference is persistent.

float
getPersistedFloat(float defaultReturnValue)

Attempts to get a persisted Float if this preference is persistent.

int
getPersistedInt(int defaultReturnValue)

Attempts to get a persisted Integer if this preference is persistent.

long
getPersistedLong(long defaultReturnValue)

Attempts to get a persisted Long if this preference is persistent.

String
getPersistedString(String defaultReturnValue)

Attempts to get a persisted set of Strings if this preference is persistent.

Set<String>
getPersistedStringSet(Set<String> defaultReturnValue)

Attempts to get a persisted set of Strings if this preference is persistent.

@Nullable PreferenceDataStore

Returns PreferenceDataStore used by this preference.

PreferenceManager

Gets the PreferenceManager that manages this preference object's tree.

@Nullable SharedPreferences

Returns the SharedPreferences where this preference can read its value(s).

boolean

Checks whether this preference should disable its view when it's action is disabled.

@Nullable CharSequence

Returns the summary of this preference.

final @Nullable Preference.SummaryProvider

Returns the SummaryProvider used to configure the summary of this preference.

@Nullable CharSequence

Returns the title of this preference.

final int

Gets the layout resource for the controllable widget portion of this preference.

boolean

Checks whether this preference has a valid key.

boolean

Returns whether the summary of this preference can be copied to the clipboard by long pressing on the preference.

boolean

Checks whether this preference should be enabled in the list.

boolean

Returns whether the space of this preference icon view is reserved.

boolean

Checks whether this preference is persistent.

boolean

Checks whether this preference should be selectable in the list.

final boolean

Checks whether this preference is shown to the user in the hierarchy.

boolean

Gets whether the title of this preference is constrained to a single line.

final boolean

Checks whether this preference should be visible to the user.

void

Should be called when the data of this Preference has changed.

void
notifyDependencyChange(boolean disableDependents)

Notifies any listening dependents of a change that affects the dependency.

void

Should be called when a preference has been added/removed from this group, or the ordering should be re-evaluated.

void

Called when the preference hierarchy has been attached to the list of preferences.

void

Called when this preference has been attached to a preference hierarchy.

void

Processes a click on the preference.

void
onDependencyChanged(
    @NonNull Preference dependency,
    boolean disableDependent
)

Called when the dependency changes.

void

Called when the preference hierarchy has been detached from the list of preferences.

void

This method is deprecated.

Preferences aren't views.

void
onParentChanged(@NonNull Preference parent, boolean disableChild)

Called when the implicit parent dependency changes.

void

Called when this preference is being removed from the hierarchy.

void
onSetInitialValue(boolean restorePersistedValue, Object defaultValue)

This method is deprecated.

Use onSetInitialValue instead.

@Nullable Bundle

Return the extras Bundle object associated with this preference, returning null if there is not currently one.

boolean
persistBoolean(boolean value)

Attempts to persist a Boolean if this preference is persistent.

boolean
persistFloat(float value)

Attempts to persist a Float if this preference is persistent.

boolean
persistInt(int value)

Attempts to persist an Integer if this preference is persistent.

boolean
persistLong(long value)

Attempts to persist a Long if this preference is persistent.

boolean

Attempts to persist a String if this preference is persistent.

boolean

Attempts to persist a set of Strings if this preference is persistent.

void

Restore this preference hierarchy's previously saved state from the given container.

void

Store this preference hierarchy's frozen state into the given container.

void
setCopyingEnabled(boolean enabled)

Sets whether the summary of this preference can be copied to the clipboard by long pressing on the preference.

void
setDefaultValue(Object defaultValue)

Sets the default value for this preference, which will be set either if persistence is off or persistence is on and the preference is not found in the persistent storage.

void
setDependency(@Nullable String dependencyKey)

Sets the key of a preference that this preference will depend on.

void
setEnabled(boolean enabled)

Sets whether this preference is enabled.

void

Sets the class name of a fragment to be shown when this preference is clicked.

void

Sets the icon for this preference with a Drawable.

void
setIcon(int iconResId)

Sets the icon for this preference with a resource ID.

void
setIconSpaceReserved(boolean iconSpaceReserved)

Sets whether to reserve the space of this preference icon view when no icon is provided.

void

Sets an Intent to be used for startActivity when this preference is clicked.

void

Sets the key for this preference, which is used as a key to the SharedPreferences or PreferenceDataStore.

void
setLayoutResource(int layoutResId)

Sets the layout resource that is inflated as the View to be shown for this preference.

void

Sets the callback to be invoked when this preference is changed by the user (but before the internal state has been updated).

void

Sets the callback to be invoked when this preference is clicked.

void
setOrder(int order)

Sets the order of this preference with respect to other preference objects on the same level.

void
setPersistent(boolean persistent)

Sets whether this preference is persistent.

void

Sets a PreferenceDataStore to be used by this preference instead of using SharedPreferences.

void
setSelectable(boolean selectable)

Sets whether this preference is selectable.

void
setShouldDisableView(boolean shouldDisableView)

Sets whether this preference should disable its view when it gets disabled.

void
setSingleLineTitle(boolean singleLineTitle)

Sets whether to constrain the title of this preference to a single line instead of letting it wrap onto multiple lines.

void

Sets the summary for this preference with a CharSequence.

void
setSummary(int summaryResId)

Sets the summary for this preference with a resource ID.

final void

Set a SummaryProvider that will be invoked whenever the summary of this preference is requested.

void

Sets the title for this preference with a CharSequence.

void
setTitle(int titleResId)

Sets the title for this preference with a resource ID.

void
setViewId(int viewId)

Set the ID that will be assigned to the overall View representing this preference, once bound.

final void
setVisible(boolean visible)

Sets whether this preference should be visible to the user.

void
setWidgetLayoutResource(int widgetLayoutResId)

Sets the layout for the controllable widget portion of this preference.

boolean

Checks whether this preference's dependents should currently be disabled.

boolean

Checks whether, at the given time this method is called, this preference should store/restore its value(s) into the SharedPreferences or into PreferenceDataStore if assigned.

@NonNull String

Public constructors

SeekBarPreference

Added in 1.0.0
public SeekBarPreference(@NonNull Context context)

SeekBarPreference

Added in 1.0.0
public SeekBarPreference(@NonNull Context context, @Nullable AttributeSet attrs)

SeekBarPreference

Added in 1.0.0
public SeekBarPreference(
    @NonNull Context context,
    @Nullable AttributeSet attrs,
    int defStyleAttr
)

SeekBarPreference

Added in 1.0.0
public SeekBarPreference(
    @NonNull Context context,
    @Nullable AttributeSet attrs,
    int defStyleAttr,
    int defStyleRes
)

Public methods

getMax

Added in 1.0.0
public int getMax()

Gets the upper bound set on the SeekBar.

Returns
int

The upper bound set

getMin

Added in 1.0.0
public int getMin()

Gets the lower bound set on the SeekBar.

Returns
int

The lower bound set

getSeekBarIncrement

Added in 1.0.0
public final int getSeekBarIncrement()

Returns the amount of increment change via each arrow key click. This value is derived from user's specified increment value if it's not zero. Otherwise, the default value is picked from the default mKeyProgressIncrement value in android.widget.AbsSeekBar.

Returns
int

The amount of increment on the SeekBar performed after each user's arrow key press

getShowSeekBarValue

Added in 1.1.0
public boolean getShowSeekBarValue()

Gets whether the current SeekBar value is displayed to the user.

Returns
boolean

Whether the current SeekBar value is displayed to the user

getUpdatesContinuously

Added in 1.1.0
public boolean getUpdatesContinuously()

Gets whether the SeekBarPreference should continuously save the SeekBar value while it is being dragged. Note that when the value is true, Preference.OnPreferenceChangeListener will be called continuously as well.

Returns
boolean

Whether the SeekBarPreference should continuously save the SeekBar value while it is being dragged

getValue

Added in 1.0.0
public int getValue()

Gets the current progress of the SeekBar.

Returns
int

The current progress of the SeekBar

isAdjustable

Added in 1.0.0
public boolean isAdjustable()

Gets whether the SeekBar should respond to the left/right keys.

Returns
boolean

Whether the SeekBar should respond to the left/right keys

onBindViewHolder

public void onBindViewHolder(@NonNull PreferenceViewHolder holder)

Binds the created View to the data for this preference.

This is a good place to grab references to custom Views in the layout and set properties on them.

Make sure to call through to the superclass's implementation.

Parameters
@NonNull PreferenceViewHolder holder

The ViewHolder that provides references to the views to fill in. These views will be recycled, so you should not hold a reference to them after this method returns.

setAdjustable

Added in 1.0.0
public void setAdjustable(boolean adjustable)

Sets whether the SeekBar should respond to the left/right keys.

Parameters
boolean adjustable

Whether the SeekBar should respond to the left/right keys

setMax

Added in 1.0.0
public final void setMax(int max)

Sets the upper bound on the SeekBar.

Parameters
int max

The upper bound to set

setMin

Added in 1.0.0
public void setMin(int min)

Sets the lower bound on the SeekBar.

Parameters
int min

The lower bound to set

setSeekBarIncrement

Added in 1.0.0
public final void setSeekBarIncrement(int seekBarIncrement)

Sets the increment amount on the SeekBar for each arrow key press.

Parameters
int seekBarIncrement

The amount to increment or decrement when the user presses an arrow key.

setShowSeekBarValue

Added in 1.1.0
public void setShowSeekBarValue(boolean showSeekBarValue)

Sets whether the current SeekBar value is displayed to the user.

Parameters
boolean showSeekBarValue

Whether the current SeekBar value is displayed to the user

setUpdatesContinuously

Added in 1.1.0
public void setUpdatesContinuously(boolean updatesContinuously)

Sets whether the SeekBarPreference should continuously save the SeekBar value while it is being dragged.

Parameters
boolean updatesContinuously

Whether the SeekBarPreference should continuously save the SeekBar value while it is being dragged

setValue

Added in 1.0.0
public void setValue(int seekBarValue)

Sets the current progress of the SeekBar.

Parameters
int seekBarValue

The current progress of the SeekBar

Protected methods

onGetDefaultValue

protected @Nullable Object onGetDefaultValue(@NonNull TypedArray a, int index)

Called when a preference is being inflated and the default value attribute needs to be read. Since different preference types have different value types, the subclass should get and return the default value which will be its value type.

For example, if the value type is String, the body of the method would proxy to getString.

Parameters
@NonNull TypedArray a

The set of attributes

int index

The index of the default value attribute

Returns
@Nullable Object

The default value of this preference type

onRestoreInstanceState

protected void onRestoreInstanceState(@Nullable Parcelable state)

Hook allowing a preference to re-apply a representation of its internal state that had previously been generated by onSaveInstanceState. This function will never be called with a null state.

Parameters
@Nullable Parcelable state

The saved state that had previously been returned by onSaveInstanceState.

onSaveInstanceState

protected @Nullable Parcelable onSaveInstanceState()

Hook allowing a preference to generate a representation of its internal state that can later be used to create a new instance with that same state. This state should only contain information that is not persistent or can be reconstructed later.

Returns
@Nullable Parcelable

A Parcelable object containing the current dynamic state of this preference, or null if there is nothing interesting to save. The default implementation returns null.

onSetInitialValue

protected void onSetInitialValue(Object defaultValue)

Implement this to set the initial value of the preference.

If you are persisting values to SharedPreferences or a PreferenceDataStore you should restore the saved value for the preference.

If you are not persisting values, or there is no value saved for the preference, you should set the value of the preference to defaultValue.

Parameters
Object defaultValue

The default value for the preference if set, otherwise null.