belongs to Maven artifact com.android.support:preference-v7:28.0.0-alpha1
SeekBarPreference
public
class
SeekBarPreference
extends Preference
java.lang.Object | ||
↳ | android.support.v7.preference.Preference | |
↳ | android.support.v7.preference.SeekBarPreference |
Preference based on android.preference.SeekBarPreference but uses support v7 preference as 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
Inherited XML attributes | |
---|---|
From
class
android.support.v7.preference.Preference
|
Inherited constants |
---|
From
class
android.support.v7.preference.Preference
|
Public constructors | |
---|---|
SeekBarPreference(Context context, AttributeSet attrs, int defStyleAttr, int defStyleRes)
|
|
SeekBarPreference(Context context, AttributeSet attrs, int defStyleAttr)
|
|
SeekBarPreference(Context context, AttributeSet attrs)
|
|
SeekBarPreference(Context context)
|
Public methods | |
---|---|
int
|
getMax()
|
int
|
getMin()
|
final
int
|
getSeekBarIncrement()
Returns the amount of increment change via each arrow key click. |
int
|
getValue()
|
boolean
|
isAdjustable()
|
void
|
onBindViewHolder(PreferenceViewHolder view)
Binds the created View to the data for this Preference. |
void
|
setAdjustable(boolean adjustable)
|
final
void
|
setMax(int max)
|
void
|
setMin(int min)
|
final
void
|
setSeekBarIncrement(int seekBarIncrement)
Sets the increment amount on the SeekBar for each arrow key press. |
void
|
setValue(int seekBarValue)
|
Protected methods | |
---|---|
Object
|
onGetDefaultValue(TypedArray a, int index)
Called when a Preference is being inflated and the default value attribute needs to be read. |
void
|
onRestoreInstanceState(Parcelable state)
Hook allowing a Preference to re-apply a representation of its internal
state that had previously been generated by |
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. |
void
|
onSetInitialValue(boolean restoreValue, Object defaultValue)
Implement this to set the initial value of the Preference. |
Inherited methods | |
---|---|
From
class
android.support.v7.preference.Preference
| |
From
class
java.lang.Object
| |
From
interface
java.lang.Comparable
|
Public constructors
SeekBarPreference
SeekBarPreference (Context context, AttributeSet attrs, int defStyleAttr, int defStyleRes)
Parameters | |
---|---|
context |
Context |
attrs |
AttributeSet |
defStyleAttr |
int |
defStyleRes |
int |
SeekBarPreference
SeekBarPreference (Context context, AttributeSet attrs, int defStyleAttr)
Parameters | |
---|---|
context |
Context |
attrs |
AttributeSet |
defStyleAttr |
int |
SeekBarPreference
SeekBarPreference (Context context, AttributeSet attrs)
Parameters | |
---|---|
context |
Context |
attrs |
AttributeSet |
SeekBarPreference
SeekBarPreference (Context context)
Parameters | |
---|---|
context |
Context |
Public methods
getSeekBarIncrement
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 AbsSeekBar
.
Returns | |
---|---|
int |
The amount of increment on the SeekBar performed after each user's arrow key press. |
onBindViewHolder
void onBindViewHolder (PreferenceViewHolder view)
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 | |
---|---|
view |
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
void setAdjustable (boolean adjustable)
Parameters | |
---|---|
adjustable |
boolean |
setSeekBarIncrement
void setSeekBarIncrement (int seekBarIncrement)
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.
|
Protected methods
onGetDefaultValue
Object onGetDefaultValue (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(int)
.
Parameters | |
---|---|
a |
TypedArray : The set of attributes. |
index |
int : The index of the default value attribute. |
Returns | |
---|---|
Object |
The default value of this preference type. |
onRestoreInstanceState
void onRestoreInstanceState (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 | |
---|---|
state |
Parcelable : The saved state that had previously been returned by
onSaveInstanceState() . |
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. 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. |
onSetInitialValue
void onSetInitialValue (boolean restoreValue, Object defaultValue)
Implement this to set the initial value of the Preference.
If restorePersistedValue is true, you should restore the
Preference value from the SharedPreferences
. If
restorePersistedValue is false, you should set the Preference
value to defaultValue that is given (and possibly store to SharedPreferences
if shouldPersist()
is true).
In case of using PreferenceDataStore
, the restorePersistedValue is
always true
but the default value (if provided) is set.
This may not always be called. One example is if it should not persist but there is no default value given.
Parameters | |
---|---|
restoreValue |
boolean : True to restore the persisted value;
false to use the given defaultValue. |
defaultValue |
Object : The default value for this Preference. Only use this
if restorePersistedValue is false.
|
Interfaces
- DialogPreference.TargetFragment
- Preference.OnPreferenceChangeListener
- Preference.OnPreferenceClickListener
- PreferenceFragmentCompat.OnPreferenceDisplayDialogCallback
- PreferenceFragmentCompat.OnPreferenceStartFragmentCallback
- PreferenceFragmentCompat.OnPreferenceStartScreenCallback
- PreferenceGroup.PreferencePositionCallback
- PreferenceManager.OnDisplayPreferenceDialogListener
- PreferenceManager.OnNavigateToScreenListener
- PreferenceManager.OnPreferenceTreeClickListener
Classes
- CheckBoxPreference
- DialogPreference
- DropDownPreference
- EditTextPreference
- EditTextPreferenceDialogFragmentCompat
- ListPreference
- ListPreferenceDialogFragmentCompat
- MultiSelectListPreferenceDialogFragmentCompat
- Preference
- Preference.BaseSavedState
- PreferenceCategory
- PreferenceDataStore
- PreferenceDialogFragmentCompat
- PreferenceFragmentCompat
- PreferenceGroup
- PreferenceManager
- PreferenceManager.PreferenceComparisonCallback
- PreferenceManager.SimplePreferenceComparisonCallback
- PreferenceScreen
- PreferenceViewHolder
- R
- R.anim
- R.attr
- R.bool
- R.color
- R.dimen
- R.drawable
- R.id
- R.integer
- R.layout
- R.string
- R.style
- R.styleable
- SeekBarPreference
- SwitchPreferenceCompat
- TwoStatePreference