SeekBarPreference

Artifact: androidx.preference:preference

Added in 1.0.0

Kotlin |Java

class SeekBarPreference : Preference

kotlin.Any
↳	androidx.preference.Preference
	↳	androidx.preference.SeekBarPreference

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(context: Context)`
`SeekBarPreference(context: Context, attrs: AttributeSet?)`
`SeekBarPreference(context: Context, attrs: AttributeSet?, defStyleAttr: Int)`
`SeekBarPreference( context: Context, attrs: AttributeSet?, defStyleAttr: Int, defStyleRes: Int )`

Public functions
`Int`	`getMax()` Gets the upper bound set on the `SeekBar`.
`Int`	`getMin()` Gets the lower bound set on the `SeekBar`.
`Int`	`getSeekBarIncrement()` Returns the amount of increment change via each arrow key click.
`Boolean`	`getShowSeekBarValue()` Gets whether the current `SeekBar` value is displayed to the user.
`Boolean`	`getUpdatesContinuously()` Gets whether the `SeekBarPreference` should continuously save the `SeekBar` value while it is being dragged.
`Int`	`getValue()` Gets the current progress of the `SeekBar`.
`Boolean`	`isAdjustable()` Gets whether the `SeekBar` should respond to the left/right keys.
`Unit`	`onBindViewHolder(holder: PreferenceViewHolder)` Binds the created View to the data for this preference.
`Unit`	`setAdjustable(adjustable: Boolean)` Sets whether the `SeekBar` should respond to the left/right keys.
`Unit`	`setMax(max: Int)` Sets the upper bound on the `SeekBar`.
`Unit`	`setMin(min: Int)` Sets the lower bound on the `SeekBar`.
`Unit`	`setSeekBarIncrement(seekBarIncrement: Int)` Sets the increment amount on the `SeekBar` for each arrow key press.
`Unit`	`setShowSeekBarValue(showSeekBarValue: Boolean)` Sets whether the current `SeekBar` value is displayed to the user.
`Unit`	`setUpdatesContinuously(updatesContinuously: Boolean)` Sets whether the `SeekBarPreference` should continuously save the `SeekBar` value while it is being dragged.
`Unit`	`setValue(seekBarValue: Int)` Sets the current progress of the `SeekBar`.

Protected functions
`Any?`	`onGetDefaultValue(a: TypedArray, index: Int)` Called when a preference is being inflated and the default value attribute needs to be read.
`Unit`	`onRestoreInstanceState(state: Parcelable?)` Hook allowing a preference to re-apply a representation of its internal state that had previously been generated by `onSaveInstanceState`.
`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.
`Unit`	`onSetInitialValue(defaultValue: Any!)` Implement this to set the initial value of the preference.

Inherited Constants

From androidx.preference.Preference

const Int

DEFAULT_ORDER = 2147483647

Specify for setOrder if a specific order is not required.

Inherited functions

From java.lang.Comparable

abstract Int

compareTo(p: T!)

From androidx.preference.Preference

`Boolean`	`callChangeListener(newValue: Any!)` Call this method after the user changes the preference, but before the internal state is set.
`Int`	`compareTo(another: Preference)` Compares preference objects based on order (if set), otherwise alphabetically on the titles.
`T?`	`<T : Preference?> findPreferenceInHierarchy(key: String)` Finds a preference in the entire hierarchy (above or below this preference) with the given key.
`Context`	`getContext()` Returns the `Context` of this preference.
`String?`	`getDependency()` Returns the key of the dependency on this preference.
`Bundle`	`getExtras()` Return the extras Bundle object associated with this preference, creating a new Bundle if there currently isn't one.
`String?`	`getFragment()` Return the fragment class name associated with this preference.
`Drawable?`	`getIcon()` Returns the icon of this preference.
`Intent?`	`getIntent()` Return the `Intent` associated with this preference.
`String!`	`getKey()` Gets the key for this preference, which is also the key used for storing values into `SharedPreferences` or `PreferenceDataStore`.
`Int`	`getLayoutResource()` Gets the layout resource that will be shown as the `View` for this preference.
`Preference.OnPreferenceChangeListener?`	`getOnPreferenceChangeListener()` Returns the callback to be invoked when this preference is changed by the user (but before the internal state has been updated).
`Preference.OnPreferenceClickListener?`	`getOnPreferenceClickListener()` Returns the callback to be invoked when this preference is clicked.
`Int`	`getOrder()` Gets the order of this preference with respect to other preference objects on the same level.
`PreferenceGroup?`	`getParent()` 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(defaultReturnValue: Boolean)` Attempts to get a persisted `Boolean` if this preference is persistent.
`Float`	`getPersistedFloat(defaultReturnValue: Float)` Attempts to get a persisted `Float` if this preference is persistent.
`Int`	`getPersistedInt(defaultReturnValue: Int)` Attempts to get a persisted `Integer` if this preference is persistent.
`Long`	`getPersistedLong(defaultReturnValue: Long)` Attempts to get a persisted `Long` if this preference is persistent.
`String!`	`getPersistedString(defaultReturnValue: String!)` Attempts to get a persisted set of Strings if this preference is persistent.
`(Mutable)Set<String!>!`	`getPersistedStringSet(defaultReturnValue: (Mutable)Set<String!>!)` Attempts to get a persisted set of Strings if this preference is persistent.
`PreferenceDataStore?`	`getPreferenceDataStore()` Returns `PreferenceDataStore` used by this preference.
`PreferenceManager!`	`getPreferenceManager()` Gets the `PreferenceManager` that manages this preference object's tree.
`SharedPreferences?`	`getSharedPreferences()` Returns the `SharedPreferences` where this preference can read its value(s).
`Boolean`	`getShouldDisableView()` Checks whether this preference should disable its view when it's action is disabled.
`CharSequence?`	`getSummary()` Returns the summary of this preference.
`Preference.SummaryProvider?`	`getSummaryProvider()` Returns the `SummaryProvider` used to configure the summary of this preference.
`CharSequence?`	`getTitle()` Returns the title of this preference.
`Int`	`getWidgetLayoutResource()` Gets the layout resource for the controllable widget portion of this preference.
`Boolean`	`hasKey()` Checks whether this preference has a valid key.
`Boolean`	`isCopyingEnabled()` Returns whether the summary of this preference can be copied to the clipboard by long pressing on the preference.
`Boolean`	`isEnabled()` Checks whether this preference should be enabled in the list.
`Boolean`	`isIconSpaceReserved()` Returns whether the space of this preference icon view is reserved.
`Boolean`	`isPersistent()` Checks whether this preference is persistent.
`Boolean`	`isSelectable()` Checks whether this preference should be selectable in the list.
`Boolean`	`isShown()` Checks whether this preference is shown to the user in the hierarchy.
`Boolean`	`isSingleLineTitle()` Gets whether the title of this preference is constrained to a single line.
`Boolean`	`isVisible()` Checks whether this preference should be visible to the user.
`Unit`	`notifyChanged()` Should be called when the data of this `Preference` has changed.
`Unit`	`notifyDependencyChange(disableDependents: Boolean)` Notifies any listening dependents of a change that affects the dependency.
`Unit`	`notifyHierarchyChanged()` Should be called when a preference has been added/removed from this group, or the ordering should be re-evaluated.
`Unit`	`onAttached()` Called when the preference hierarchy has been attached to the list of preferences.
`Unit`	`onAttachedToHierarchy(preferenceManager: PreferenceManager)` Called when this preference has been attached to a preference hierarchy.
`Unit`	`onClick()` Processes a click on the preference.
`Unit`	`onDependencyChanged(dependency: Preference, disableDependent: Boolean)` Called when the dependency changes.
`Unit`	`onDetached()` Called when the preference hierarchy has been detached from the list of preferences.
`Unit`	`@CallSuper onInitializeAccessibilityNodeInfo(info: AccessibilityNodeInfoCompat!)` This function is deprecated. Preferences aren't views.
`Unit`	`onParentChanged(parent: Preference, disableChild: Boolean)` Called when the implicit parent dependency changes.
`Unit`	`onPrepareForRemoval()` Called when this preference is being removed from the hierarchy.
`Unit`	`onSetInitialValue(restorePersistedValue: Boolean, defaultValue: Any!)` This function is deprecated. Use `onSetInitialValue` instead.
`Bundle?`	`peekExtras()` Return the extras Bundle object associated with this preference, returning `null` if there is not currently one.
`Boolean`	`persistBoolean(value: Boolean)` Attempts to persist a `Boolean` if this preference is persistent.
`Boolean`	`persistFloat(value: Float)` Attempts to persist a `Float` if this preference is persistent.
`Boolean`	`persistInt(value: Int)` Attempts to persist an `Integer` if this preference is persistent.
`Boolean`	`persistLong(value: Long)` Attempts to persist a `Long` if this preference is persistent.
`Boolean`	`persistString(value: String!)` Attempts to persist a `String` if this preference is persistent.
`Boolean`	`persistStringSet(values: (Mutable)Set<String!>!)` Attempts to persist a set of Strings if this preference is persistent.
`Unit`	`restoreHierarchyState(container: Bundle)` Restore this preference hierarchy's previously saved state from the given container.
`Unit`	`saveHierarchyState(container: Bundle)` Store this preference hierarchy's frozen state into the given container.
`Unit`	`setCopyingEnabled(enabled: Boolean)` Sets whether the summary of this preference can be copied to the clipboard by long pressing on the preference.
`Unit`	`setDefaultValue(defaultValue: Any!)` 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.
`Unit`	`setDependency(dependencyKey: String?)` Sets the key of a preference that this preference will depend on.
`Unit`	`setEnabled(enabled: Boolean)` Sets whether this preference is enabled.
`Unit`	`setFragment(fragment: String?)` Sets the class name of a fragment to be shown when this preference is clicked.
`Unit`	`setIcon(icon: Drawable?)` Sets the icon for this preference with a Drawable.
`Unit`	`setIcon(iconResId: Int)` Sets the icon for this preference with a resource ID.
`Unit`	`setIconSpaceReserved(iconSpaceReserved: Boolean)` Sets whether to reserve the space of this preference icon view when no icon is provided.
`Unit`	`setIntent(intent: Intent?)` Sets an `Intent` to be used for `startActivity` when this preference is clicked.
`Unit`	`setKey(key: String!)` Sets the key for this preference, which is used as a key to the `SharedPreferences` or `PreferenceDataStore`.
`Unit`	`setLayoutResource(layoutResId: Int)` Sets the layout resource that is inflated as the `View` to be shown for this preference.
`Unit`	`setOnPreferenceChangeListener( onPreferenceChangeListener: Preference.OnPreferenceChangeListener? )` Sets the callback to be invoked when this preference is changed by the user (but before the internal state has been updated).
`Unit`	`setOnPreferenceClickListener( onPreferenceClickListener: Preference.OnPreferenceClickListener? )` Sets the callback to be invoked when this preference is clicked.
`Unit`	`setOrder(order: Int)` Sets the order of this preference with respect to other preference objects on the same level.
`Unit`	`setPersistent(persistent: Boolean)` Sets whether this preference is persistent.
`Unit`	`setPreferenceDataStore(dataStore: PreferenceDataStore?)` Sets a `PreferenceDataStore` to be used by this preference instead of using `SharedPreferences`.
`Unit`	`setSelectable(selectable: Boolean)` Sets whether this preference is selectable.
`Unit`	`setShouldDisableView(shouldDisableView: Boolean)` Sets whether this preference should disable its view when it gets disabled.
`Unit`	`setSingleLineTitle(singleLineTitle: Boolean)` Sets whether to constrain the title of this preference to a single line instead of letting it wrap onto multiple lines.
`Unit`	`setSummary(summary: CharSequence?)` Sets the summary for this preference with a CharSequence.
`Unit`	`setSummary(summaryResId: Int)` Sets the summary for this preference with a resource ID.
`Unit`	`setSummaryProvider(summaryProvider: Preference.SummaryProvider?)` Set a `SummaryProvider` that will be invoked whenever the summary of this preference is requested.
`Unit`	`setTitle(title: CharSequence?)` Sets the title for this preference with a CharSequence.
`Unit`	`setTitle(titleResId: Int)` Sets the title for this preference with a resource ID.
`Unit`	`setViewId(viewId: Int)` Set the ID that will be assigned to the overall View representing this preference, once bound.
`Unit`	`setVisible(visible: Boolean)` Sets whether this preference should be visible to the user.
`Unit`	`setWidgetLayoutResource(widgetLayoutResId: Int)` Sets the layout for the controllable widget portion of this preference.
`Boolean`	`shouldDisableDependents()` Checks whether this preference's dependents should currently be disabled.
`Boolean`	`shouldPersist()` 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.
`String`	`toString()`

Public constructors

SeekBarPreference

Added in 1.0.0

SeekBarPreference(context: Context)

SeekBarPreference

Added in 1.0.0

SeekBarPreference(context: Context, attrs: AttributeSet?)

SeekBarPreference

Added in 1.0.0

SeekBarPreference(context: Context, attrs: AttributeSet?, defStyleAttr: Int)

SeekBarPreference

Added in 1.0.0

SeekBarPreference(
    context: Context,
    attrs: AttributeSet?,
    defStyleAttr: Int,
    defStyleRes: Int
)

Public functions

getMax

Added in 1.0.0

fun getMax(): Int

Gets the upper bound set on the SeekBar.

Returns
`Int`	The upper bound set

getMin

Added in 1.0.0

fun getMin(): Int

Gets the lower bound set on the SeekBar.

Returns
`Int`	The lower bound set

getSeekBarIncrement

Added in 1.0.0

fun getSeekBarIncrement(): Int

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

fun getShowSeekBarValue(): Boolean

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

Returns
`Boolean`	Whether the current `SeekBar` value is displayed to the user

See also
`setShowSeekBarValue`

getUpdatesContinuously

Added in 1.1.0

fun getUpdatesContinuously(): Boolean

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

See also
`setUpdatesContinuously`

getValue

Added in 1.0.0

fun getValue(): Int

Gets the current progress of the SeekBar.

Returns
`Int`	The current progress of the `SeekBar`

isAdjustable

Added in 1.0.0

fun isAdjustable(): Boolean

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

Returns
`Boolean`	Whether the `SeekBar` should respond to the left/right keys

onBindViewHolder

fun onBindViewHolder(holder: PreferenceViewHolder): Unit

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
`holder: PreferenceViewHolder`	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

fun setAdjustable(adjustable: Boolean): Unit

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

Parameters
`adjustable: Boolean`	Whether the `SeekBar` should respond to the left/right keys

setMax

Added in 1.0.0

fun setMax(max: Int): Unit

Sets the upper bound on the SeekBar.

Parameters
`max: Int`	The upper bound to set

setMin

Added in 1.0.0

fun setMin(min: Int): Unit

Sets the lower bound on the SeekBar.

Parameters
`min: Int`	The lower bound to set

setSeekBarIncrement

Added in 1.0.0

fun setSeekBarIncrement(seekBarIncrement: Int): Unit

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

Parameters
`seekBarIncrement: Int`	The amount to increment or decrement when the user presses an arrow key.

setShowSeekBarValue

Added in 1.1.0

fun setShowSeekBarValue(showSeekBarValue: Boolean): Unit

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

Parameters
`showSeekBarValue: Boolean`	Whether the current `SeekBar` value is displayed to the user

See also
`getShowSeekBarValue`

setUpdatesContinuously

Added in 1.1.0

fun setUpdatesContinuously(updatesContinuously: Boolean): Unit

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

Parameters
`updatesContinuously: Boolean`	Whether the `SeekBarPreference` should continuously save the `SeekBar` value while it is being dragged

See also
`getUpdatesContinuously`

setValue

Added in 1.0.0

fun setValue(seekBarValue: Int): Unit

Sets the current progress of the SeekBar.

Parameters
`seekBarValue: Int`	The current progress of the `SeekBar`

Protected functions

onGetDefaultValue

protected fun onGetDefaultValue(a: TypedArray, index: Int): Any?

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
`a: TypedArray`	The set of attributes
`index: Int`	The index of the default value attribute

Returns
`Any?`	The default value of this preference type

onRestoreInstanceState

protected fun onRestoreInstanceState(state: Parcelable?): Unit

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
`state: Parcelable?`	The saved state that had previously been returned by `onSaveInstanceState`.

See also
`onSaveInstanceState`
`restoreHierarchyState`

onSaveInstanceState

protected fun onSaveInstanceState(): 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. This state should only contain information that is not persistent or can be reconstructed later.

Returns
`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`.

See also
`onRestoreInstanceState`
`saveHierarchyState`

onSetInitialValue

protected fun onSetInitialValue(defaultValue: Any!): Unit

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
`defaultValue: Any!`	The default value for the preference if set, otherwise `null`.