Gradle dependencies
compile group: 'androidx.preference', name: 'preference', version: '1.2.0'
- groupId: androidx.preference
- artifactId: preference
- version: 1.2.0
Artifact androidx.preference:preference:1.2.0 it located at Google repository (https://maven.google.com/)
Androidx artifact mapping:
androidx.preference:preference com.android.support:preference-v7
Androidx class mapping:
androidx.preference.SeekBarPreference android.support.v7.preference.SeekBarPreference
Overview
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
Methods |
---|
public int | getMax()
Gets the upper bound set on the SeekBar . |
public int | getMin()
Gets the lower bound set on the SeekBar . |
public final int | getSeekBarIncrement()
Returns the amount of increment change via each arrow key click. |
public boolean | getShowSeekBarValue()
Gets whether the current SeekBar value is displayed to the user. |
public boolean | getUpdatesContinuously()
Gets whether the SeekBarPreference should continuously save the SeekBar value
while it is being dragged. |
public int | getValue()
Gets the current progress of the SeekBar . |
public boolean | isAdjustable()
Gets whether the SeekBar should respond to the left/right keys. |
public void | onBindViewHolder(PreferenceViewHolder holder)
Binds the created View to the data for this preference. |
protected java.lang.Object | onGetDefaultValue(TypedArray a, int index)
Called when a preference is being inflated and the default value attribute needs to be
read. |
protected void | onRestoreInstanceState(Parcelable state)
Hook allowing a preference to re-apply a representation of its internal state that had
previously been generated by Preference.onSaveInstanceState(). |
protected 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. |
protected void | onSetInitialValue(java.lang.Object defaultValue)
Implement this to set the initial value of the preference. |
public void | setAdjustable(boolean adjustable)
Sets whether the SeekBar should respond to the left/right keys. |
public final void | setMax(int max)
Sets the upper bound on the SeekBar . |
public void | setMin(int min)
Sets the lower bound on the SeekBar . |
public final void | setSeekBarIncrement(int seekBarIncrement)
Sets the increment amount on the SeekBar for each arrow key press. |
public void | setShowSeekBarValue(boolean showSeekBarValue)
Sets whether the current SeekBar value is displayed to the user. |
public void | setUpdatesContinuously(boolean updatesContinuously)
Sets whether the SeekBarPreference should continuously save the SeekBar value
while it is being dragged. |
public void | setValue(int seekBarValue)
Sets the current progress of the SeekBar . |
from Preference | callChangeListener, compareTo, findPreferenceInHierarchy, getContext, getDependency, getExtras, getFragment, getIcon, getIntent, getKey, getLayoutResource, getOnPreferenceChangeListener, getOnPreferenceClickListener, getOrder, getParent, getPersistedBoolean, getPersistedFloat, getPersistedInt, getPersistedLong, getPersistedString, getPersistedStringSet, getPreferenceDataStore, getPreferenceManager, getSharedPreferences, getShouldDisableView, getSummary, getSummaryProvider, getTitle, getWidgetLayoutResource, hasKey, isCopyingEnabled, isEnabled, isIconSpaceReserved, isPersistent, isSelectable, isShown, isSingleLineTitle, isVisible, notifyChanged, notifyDependencyChange, notifyHierarchyChanged, onAttached, onAttachedToHierarchy, onAttachedToHierarchy, onClick, onDependencyChanged, onDetached, onInitializeAccessibilityNodeInfo, onParentChanged, onPrepareForRemoval, onSetInitialValue, peekExtras, performClick, performClick, persistBoolean, persistFloat, persistInt, persistLong, persistString, persistStringSet, restoreHierarchyState, saveHierarchyState, setCopyingEnabled, setDefaultValue, setDependency, setEnabled, setFragment, setIcon, setIconSpaceReserved, setIntent, setKey, setLayoutResource, setOnPreferenceChangeListener, setOnPreferenceClickListener, setOrder, setPersistent, setPreferenceDataStore, setSelectable, setShouldDisableView, setSingleLineTitle, setSummary, setSummary, setSummaryProvider, setTitle, setTitle, setViewId, setVisible, setWidgetLayoutResource, shouldDisableDependents, shouldPersist, toString |
from java.lang.Object | clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructors
public
SeekBarPreference(Context context, AttributeSet attrs, int defStyleAttr, int defStyleRes)
public
SeekBarPreference(Context context, AttributeSet attrs, int defStyleAttr)
public
SeekBarPreference(Context context, AttributeSet attrs)
public
SeekBarPreference(Context context)
Methods
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: 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.
protected void
onSetInitialValue(java.lang.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:
defaultValue: The default value for the preference if set, otherwise null.
protected java.lang.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
.
Parameters:
a: The set of attributes
index: The index of the default value attribute
Returns:
The default value of this preference type
Gets the lower bound set on the SeekBar
.
Returns:
The lower bound set
public void
setMin(int min)
Sets the lower bound on the SeekBar
.
Parameters:
min: The lower bound to set
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 .
Returns:
The amount of increment on the SeekBar
performed after each user's arrow
key press
public final void
setSeekBarIncrement(int seekBarIncrement)
Sets the increment amount on the SeekBar
for each arrow key press.
Parameters:
seekBarIncrement: The amount to increment or decrement when the user presses an
arrow key.
Gets the upper bound set on the SeekBar
.
Returns:
The upper bound set
public final void
setMax(int max)
Sets the upper bound on the SeekBar
.
Parameters:
max: The upper bound to set
public boolean
isAdjustable()
Gets whether the SeekBar
should respond to the left/right keys.
Returns:
Whether the SeekBar
should respond to the left/right keys
public void
setAdjustable(boolean adjustable)
Sets whether the SeekBar
should respond to the left/right keys.
Parameters:
adjustable: Whether the SeekBar
should respond to the left/right keys
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:
Whether the SeekBarPreference should continuously save the SeekBar
value while it is being dragged
See also: SeekBarPreference.setUpdatesContinuously(boolean)
public void
setUpdatesContinuously(boolean updatesContinuously)
Sets whether the SeekBarPreference should continuously save the SeekBar
value
while it is being dragged.
Parameters:
updatesContinuously: Whether the SeekBarPreference should continuously save
the SeekBar
value while it is being dragged
See also: SeekBarPreference.getUpdatesContinuously()
public boolean
getShowSeekBarValue()
Gets whether the current SeekBar
value is displayed to the user.
Returns:
Whether the current SeekBar
value is displayed to the user
See also: SeekBarPreference.setShowSeekBarValue(boolean)
public void
setShowSeekBarValue(boolean showSeekBarValue)
Sets whether the current SeekBar
value is displayed to the user.
Parameters:
showSeekBarValue: Whether the current SeekBar
value is displayed to the user
See also: SeekBarPreference.getShowSeekBarValue()
Gets the current progress of the SeekBar
.
Returns:
The current progress of the SeekBar
public void
setValue(int seekBarValue)
Sets the current progress of the SeekBar
.
Parameters:
seekBarValue: The current progress of the SeekBar
protected 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:
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: Preference.onRestoreInstanceState(Parcelable), Preference.saveHierarchyState(Bundle)
protected void
onRestoreInstanceState(Parcelable state)
Hook allowing a preference to re-apply a representation of its internal state that had
previously been generated by Preference.onSaveInstanceState(). This function will never be
called with a null state.
Parameters:
state: The saved state that had previously been returned by
Preference.onSaveInstanceState().
See also: Preference.onSaveInstanceState(), Preference.restoreHierarchyState(Bundle)
Source
/*
* Copyright 2018 The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package androidx.preference;
import android.content.Context;
import android.content.res.TypedArray;
import android.os.Parcel;
import android.os.Parcelable;
import android.util.AttributeSet;
import android.util.Log;
import android.view.KeyEvent;
import android.view.View;
import android.widget.SeekBar;
import android.widget.SeekBar.OnSeekBarChangeListener;
import android.widget.TextView;
import androidx.annotation.NonNull;
import androidx.annotation.Nullable;
/**
* Preference based on android.preference.SeekBarPreference but uses support preference as a base
* . It contains a title and a {@link SeekBar} and an optional SeekBar value {@link TextView}.
* The actual preference layout is customizable by setting {@code android:layout} on the
* preference widget layout or {@code seekBarPreferenceStyle} attribute.
*
* <p>The {@link SeekBar} within the preference can be defined adjustable or not by setting {@code
* adjustable} attribute. If adjustable, the preference will be responsive to DPAD left/right keys.
* Otherwise, it skips those keys.
*
* <p>The {@link SeekBar} value view can be shown or disabled by setting {@code showSeekBarValue}
* attribute to true or false, respectively.
*
* <p>Other {@link SeekBar} specific attributes (e.g. {@code title, summary, defaultValue, min,
* max})
* can be set directly on the preference widget layout.
*/
public class SeekBarPreference extends Preference {
private static final String TAG = "SeekBarPreference";
@SuppressWarnings("WeakerAccess") /* synthetic access */
int mSeekBarValue;
@SuppressWarnings("WeakerAccess") /* synthetic access */
int mMin;
private int mMax;
private int mSeekBarIncrement;
@SuppressWarnings("WeakerAccess") /* synthetic access */
boolean mTrackingTouch;
@SuppressWarnings("WeakerAccess") /* synthetic access */
SeekBar mSeekBar;
private TextView mSeekBarValueTextView;
// Whether the SeekBar should respond to the left/right keys
@SuppressWarnings("WeakerAccess") /* synthetic access */
boolean mAdjustable;
// Whether to show the SeekBar value TextView next to the bar
private boolean mShowSeekBarValue;
// Whether the SeekBarPreference should continuously save the Seekbar value while it is being
// dragged.
@SuppressWarnings("WeakerAccess") /* synthetic access */
boolean mUpdatesContinuously;
/**
* Listener reacting to the {@link SeekBar} changing value by the user
*/
private final OnSeekBarChangeListener mSeekBarChangeListener = new OnSeekBarChangeListener() {
@Override
public void onProgressChanged(SeekBar seekBar, int progress, boolean fromUser) {
if (fromUser && (mUpdatesContinuously || !mTrackingTouch)) {
syncValueInternal(seekBar);
} else {
// We always want to update the text while the seekbar is being dragged
updateLabelValue(progress + mMin);
}
}
@Override
public void onStartTrackingTouch(SeekBar seekBar) {
mTrackingTouch = true;
}
@Override
public void onStopTrackingTouch(SeekBar seekBar) {
mTrackingTouch = false;
if (seekBar.getProgress() + mMin != mSeekBarValue) {
syncValueInternal(seekBar);
}
}
};
/**
* Listener reacting to the user pressing DPAD left/right keys if {@code
* adjustable} attribute is set to true; it transfers the key presses to the {@link SeekBar}
* to be handled accordingly.
*/
private final View.OnKeyListener mSeekBarKeyListener = new View.OnKeyListener() {
@Override
public boolean onKey(View v, int keyCode, KeyEvent event) {
if (event.getAction() != KeyEvent.ACTION_DOWN) {
return false;
}
if (!mAdjustable && (keyCode == KeyEvent.KEYCODE_DPAD_LEFT
|| keyCode == KeyEvent.KEYCODE_DPAD_RIGHT)) {
// Right or left keys are pressed when in non-adjustable mode; Skip the keys.
return false;
}
// We don't want to propagate the click keys down to the SeekBar view since it will
// create the ripple effect for the thumb.
if (keyCode == KeyEvent.KEYCODE_DPAD_CENTER || keyCode == KeyEvent.KEYCODE_ENTER) {
return false;
}
if (mSeekBar == null) {
Log.e(TAG, "SeekBar view is null and hence cannot be adjusted.");
return false;
}
return mSeekBar.onKeyDown(keyCode, event);
}
};
public SeekBarPreference(
@NonNull Context context, @Nullable AttributeSet attrs, int defStyleAttr,
int defStyleRes) {
super(context, attrs, defStyleAttr, defStyleRes);
TypedArray a = context.obtainStyledAttributes(
attrs, R.styleable.SeekBarPreference, defStyleAttr, defStyleRes);
// The ordering of these two statements are important. If we want to set max first, we need
// to perform the same steps by changing min/max to max/min as following:
// mMax = a.getInt(...) and setMin(...).
mMin = a.getInt(R.styleable.SeekBarPreference_min, 0);
setMax(a.getInt(R.styleable.SeekBarPreference_android_max, 100));
setSeekBarIncrement(a.getInt(R.styleable.SeekBarPreference_seekBarIncrement, 0));
mAdjustable = a.getBoolean(R.styleable.SeekBarPreference_adjustable, true);
mShowSeekBarValue = a.getBoolean(R.styleable.SeekBarPreference_showSeekBarValue, false);
mUpdatesContinuously = a.getBoolean(R.styleable.SeekBarPreference_updatesContinuously,
false);
a.recycle();
}
public SeekBarPreference(@NonNull Context context, @Nullable AttributeSet attrs,
int defStyleAttr) {
this(context, attrs, defStyleAttr, 0);
}
public SeekBarPreference(@NonNull Context context, @Nullable AttributeSet attrs) {
this(context, attrs, R.attr.seekBarPreferenceStyle);
}
public SeekBarPreference(@NonNull Context context) {
this(context, null);
}
@Override
public void onBindViewHolder(@NonNull PreferenceViewHolder holder) {
super.onBindViewHolder(holder);
holder.itemView.setOnKeyListener(mSeekBarKeyListener);
mSeekBar = (SeekBar) holder.findViewById(R.id.seekbar);
mSeekBarValueTextView = (TextView) holder.findViewById(R.id.seekbar_value);
if (mShowSeekBarValue) {
mSeekBarValueTextView.setVisibility(View.VISIBLE);
} else {
mSeekBarValueTextView.setVisibility(View.GONE);
mSeekBarValueTextView = null;
}
if (mSeekBar == null) {
Log.e(TAG, "SeekBar view is null in onBindViewHolder.");
return;
}
mSeekBar.setOnSeekBarChangeListener(mSeekBarChangeListener);
mSeekBar.setMax(mMax - mMin);
// If the increment is not zero, use that. Otherwise, use the default mKeyProgressIncrement
// in AbsSeekBar when it's zero. This default increment value is set by AbsSeekBar
// after calling setMax. That's why it's important to call setKeyProgressIncrement after
// calling setMax() since setMax() can change the increment value.
if (mSeekBarIncrement != 0) {
mSeekBar.setKeyProgressIncrement(mSeekBarIncrement);
} else {
mSeekBarIncrement = mSeekBar.getKeyProgressIncrement();
}
mSeekBar.setProgress(mSeekBarValue - mMin);
updateLabelValue(mSeekBarValue);
mSeekBar.setEnabled(isEnabled());
}
@Override
protected void onSetInitialValue(Object defaultValue) {
if (defaultValue == null) {
defaultValue = 0;
}
setValue(getPersistedInt((Integer) defaultValue));
}
@Override
protected @Nullable Object onGetDefaultValue(@NonNull TypedArray a, int index) {
return a.getInt(index, 0);
}
/**
* Gets the lower bound set on the {@link SeekBar}.
*
* @return The lower bound set
*/
public int getMin() {
return mMin;
}
/**
* Sets the lower bound on the {@link SeekBar}.
*
* @param min The lower bound to set
*/
public void setMin(int min) {
if (min > mMax) {
min = mMax;
}
if (min != mMin) {
mMin = min;
notifyChanged();
}
}
/**
* 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 {@link android.widget.AbsSeekBar}.
*
* @return The amount of increment on the {@link SeekBar} performed after each user's arrow
* key press
*/
public final int getSeekBarIncrement() {
return mSeekBarIncrement;
}
/**
* Sets the increment amount on the {@link SeekBar} for each arrow key press.
*
* @param seekBarIncrement The amount to increment or decrement when the user presses an
* arrow key.
*/
public final void setSeekBarIncrement(int seekBarIncrement) {
if (seekBarIncrement != mSeekBarIncrement) {
mSeekBarIncrement = Math.min(mMax - mMin, Math.abs(seekBarIncrement));
notifyChanged();
}
}
/**
* Gets the upper bound set on the {@link SeekBar}.
*
* @return The upper bound set
*/
public int getMax() {
return mMax;
}
/**
* Sets the upper bound on the {@link SeekBar}.
*
* @param max The upper bound to set
*/
public final void setMax(int max) {
if (max < mMin) {
max = mMin;
}
if (max != mMax) {
mMax = max;
notifyChanged();
}
}
/**
* Gets whether the {@link SeekBar} should respond to the left/right keys.
*
* @return Whether the {@link SeekBar} should respond to the left/right keys
*/
public boolean isAdjustable() {
return mAdjustable;
}
/**
* Sets whether the {@link SeekBar} should respond to the left/right keys.
*
* @param adjustable Whether the {@link SeekBar} should respond to the left/right keys
*/
public void setAdjustable(boolean adjustable) {
mAdjustable = adjustable;
}
/**
* Gets whether the {@link SeekBarPreference} should continuously save the {@link SeekBar} value
* while it is being dragged. Note that when the value is true,
* {@link Preference.OnPreferenceChangeListener} will be called continuously as well.
*
* @return Whether the {@link SeekBarPreference} should continuously save the {@link SeekBar}
* value while it is being dragged
* @see #setUpdatesContinuously(boolean)
*/
public boolean getUpdatesContinuously() {
return mUpdatesContinuously;
}
/**
* Sets whether the {@link SeekBarPreference} should continuously save the {@link SeekBar} value
* while it is being dragged.
*
* @param updatesContinuously Whether the {@link SeekBarPreference} should continuously save
* the {@link SeekBar} value while it is being dragged
* @see #getUpdatesContinuously()
*/
public void setUpdatesContinuously(boolean updatesContinuously) {
mUpdatesContinuously = updatesContinuously;
}
/**
* Gets whether the current {@link SeekBar} value is displayed to the user.
*
* @return Whether the current {@link SeekBar} value is displayed to the user
* @see #setShowSeekBarValue(boolean)
*/
public boolean getShowSeekBarValue() {
return mShowSeekBarValue;
}
/**
* Sets whether the current {@link SeekBar} value is displayed to the user.
*
* @param showSeekBarValue Whether the current {@link SeekBar} value is displayed to the user
* @see #getShowSeekBarValue()
*/
public void setShowSeekBarValue(boolean showSeekBarValue) {
mShowSeekBarValue = showSeekBarValue;
notifyChanged();
}
private void setValueInternal(int seekBarValue, boolean notifyChanged) {
if (seekBarValue < mMin) {
seekBarValue = mMin;
}
if (seekBarValue > mMax) {
seekBarValue = mMax;
}
if (seekBarValue != mSeekBarValue) {
mSeekBarValue = seekBarValue;
updateLabelValue(mSeekBarValue);
persistInt(seekBarValue);
if (notifyChanged) {
notifyChanged();
}
}
}
/**
* Gets the current progress of the {@link SeekBar}.
*
* @return The current progress of the {@link SeekBar}
*/
public int getValue() {
return mSeekBarValue;
}
/**
* Sets the current progress of the {@link SeekBar}.
*
* @param seekBarValue The current progress of the {@link SeekBar}
*/
public void setValue(int seekBarValue) {
setValueInternal(seekBarValue, true);
}
/**
* Persist the {@link SeekBar}'s SeekBar value if callChangeListener returns true, otherwise
* set the {@link SeekBar}'s value to the stored value.
*/
@SuppressWarnings("WeakerAccess") /* synthetic access */
void syncValueInternal(@NonNull SeekBar seekBar) {
int seekBarValue = mMin + seekBar.getProgress();
if (seekBarValue != mSeekBarValue) {
if (callChangeListener(seekBarValue)) {
setValueInternal(seekBarValue, false);
} else {
seekBar.setProgress(mSeekBarValue - mMin);
updateLabelValue(mSeekBarValue);
}
}
}
/**
* Attempts to update the TextView label that displays the current value.
*
* @param value the value to display next to the {@link SeekBar}
*/
@SuppressWarnings("WeakerAccess") /* synthetic access */
void updateLabelValue(int value) {
if (mSeekBarValueTextView != null) {
mSeekBarValueTextView.setText(String.valueOf(value));
}
}
@Nullable
@Override
protected Parcelable onSaveInstanceState() {
final Parcelable superState = super.onSaveInstanceState();
if (isPersistent()) {
// No need to save instance state since it's persistent
return superState;
}
// Save the instance state
final SavedState myState = new SavedState(superState);
myState.mSeekBarValue = mSeekBarValue;
myState.mMin = mMin;
myState.mMax = mMax;
return myState;
}
@Override
protected void onRestoreInstanceState(@Nullable Parcelable state) {
if (state == null || !state.getClass().equals(SavedState.class)) {
// Didn't save state for us in onSaveInstanceState
super.onRestoreInstanceState(state);
return;
}
// Restore the instance state
SavedState myState = (SavedState) state;
super.onRestoreInstanceState(myState.getSuperState());
mSeekBarValue = myState.mSeekBarValue;
mMin = myState.mMin;
mMax = myState.mMax;
notifyChanged();
}
/**
* SavedState, a subclass of {@link BaseSavedState}, will store the state of this preference.
*
* <p>It is important to always call through to super methods.
*/
private static class SavedState extends BaseSavedState {
public static final Parcelable.Creator<SavedState> CREATOR =
new Parcelable.Creator<SavedState>() {
@Override
public SavedState createFromParcel(Parcel in) {
return new SavedState(in);
}
@Override
public SavedState[] newArray(int size) {
return new SavedState[size];
}
};
int mSeekBarValue;
int mMin;
int mMax;
SavedState(Parcel source) {
super(source);
// Restore the click counter
mSeekBarValue = source.readInt();
mMin = source.readInt();
mMax = source.readInt();
}
SavedState(Parcelable superState) {
super(superState);
}
@Override
public void writeToParcel(Parcel dest, int flags) {
super.writeToParcel(dest, flags);
// Save the click counter
dest.writeInt(mSeekBarValue);
dest.writeInt(mMin);
dest.writeInt(mMax);
}
}
}