de.mrapp.android.preference

Class AbstractNumberPickerPreference

java.lang.Object

androidx.preference.Preference

de.mrapp.android.preference.Preference

de.mrapp.android.preference.DialogPreference

de.mrapp.android.preference.AbstractNumberPickerPreference

All Implemented Interfaces:

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

Direct Known Subclasses:

DigitPickerPreference, NumberPickerPreference

public abstract class AbstractNumberPickerPreference
extends DialogPreference

An abstract base class for all preferences, which allow to choose decimal numbers via NumberPicker widgets.

Since:

1.1.0

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
AbstractNumberPickerPreference(android.content.Context context) Creates a new preference, which allows to choose a decimal number via a NumberPicker widget.
AbstractNumberPickerPreference(android.content.Context context, android.util.AttributeSet attributeSet) Creates a new preference, which allows to choose a decimal number via a NumberPicker widget.
AbstractNumberPickerPreference(android.content.Context context, android.util.AttributeSet attributeSet, int defaultStyle) Creates a new preference, which allows to choose a decimal number via a NumberPicker widget.
AbstractNumberPickerPreference(android.content.Context context, android.util.AttributeSet attributeSet, int defaultStyle, int defaultStyleResource) Creates a new preference, which allows to choose a decimal number via a NumberPicker widget.

Method Summary

Modifier and Type	Method and Description
int	getNumber() Returns the currently persisted number of the preference.
java.lang.CharSequence	getSummary()
java.lang.CharSequence	getUnit() Returns the unit, which is used for textual representation of the preference's number.
boolean	isInputMethodUsed() Returns, whether an input method is used by the preference, false otherwise.
boolean	isSelectorWheelWrapped() Returns, whether the selector wheel of the preference's NumberPicker is wrapped, or not.
protected boolean	needInputMethod() The method, which is invoked on subclasses to determine, whether the soft input mode should be requested when the preference's dialog becomes shown, or not.
protected java.lang.Object	onGetDefaultValue(android.content.res.TypedArray typedArray, int index)
protected void	onRestoreInstanceState(android.os.Parcelable state)
protected android.os.Parcelable	onSaveInstanceState()
protected void	onSetInitialValue(java.lang.Object defaultValue)
void	setNumber(int number) Sets the current number of the preference.
void	setUnit(java.lang.CharSequence unit) Sets the unit, which should be used for textual representation of the preference's number.
void	setUnit(int resourceId) Sets the unit, which should be used for textual representation of the preference's number.
void	useInputMethod(boolean useInputMethod) Sets, whether an input method should be used by the preference, or not.
void	wrapSelectorWheel(boolean wrapSelectorWheel) Sets, whether the selector wheel of the preference's NumberPicker should be wrapped, 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, onCancel, onClick, onClick, onDialogClosed, onDismiss, onKey, onPrepareDialog, 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

AbstractNumberPickerPreference

public AbstractNumberPickerPreference(android.content.Context context)

Creates a new preference, which allows to choose a decimal number via a NumberPicker widget.

Parameters:

context - The context, which should be used by the preference, as an instance of the class Context. The context may not be null

AbstractNumberPickerPreference

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

Creates a new preference, which allows to choose a decimal number via a NumberPicker widget.

Parameters:

context - The context, which should be used by the preference, 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

AbstractNumberPickerPreference

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

Creates a new preference, which allows to choose a decimal number via a NumberPicker widget.

Parameters:

context - The context, which should be used by the preference, 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

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

AbstractNumberPickerPreference

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

Creates a new preference, which allows to choose a decimal number via a NumberPicker widget.

Parameters:

context - The context, which should be used by the preference, 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

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

getNumber

public final int getNumber()

Returns the currently persisted number of the preference.

Returns:

The currently persisted number as an Integer value

setNumber

public void setNumber(int number)

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

Parameters:

number - The number, which should be set, as an Integer value

isInputMethodUsed

public final boolean isInputMethodUsed()

Returns, whether an input method is used by the preference, false otherwise.

Returns:

True, if an input method is used, false otherwise

useInputMethod

public void useInputMethod(boolean useInputMethod)

Sets, whether an input method should be used by the preference, or not.

Parameters:

useInputMethod - True, if an input method should be used, false otherwise

isSelectorWheelWrapped

public final boolean isSelectorWheelWrapped()

Returns, whether the selector wheel of the preference's NumberPicker is wrapped, or not.

Returns:

True, if the selector wheel of the preference's NumberPicker is wrapped, false otherwise

wrapSelectorWheel

public void wrapSelectorWheel(boolean wrapSelectorWheel)

Sets, whether the selector wheel of the preference's NumberPicker should be wrapped, or not.

Parameters:

wrapSelectorWheel - True, if the selector wheel of the preference's NumberPicker should be wrapped, false otherwise

getUnit

public final java.lang.CharSequence getUnit()

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

Returns:

The unit, which is used for textual representation or the preference's number, 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 number.

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 number.

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

getSummary

public final java.lang.CharSequence getSummary()

needInputMethod

protected final boolean needInputMethod()

Description copied from class: DialogPreference

The method, which is invoked on subclasses to determine, whether the soft input mode should be requested when the preference's dialog becomes shown, or not.

Overrides:

needInputMethod in class DialogPreference

Returns:

True, if the soft input mode should be requested when the preference's dialog becomes shown, false otherwise

onGetDefaultValue

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

onSetInitialValue

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

onSaveInstanceState

protected android.os.Parcelable onSaveInstanceState()

Overrides:

onSaveInstanceState in class DialogPreference

onRestoreInstanceState

protected void onRestoreInstanceState(android.os.Parcelable state)

Overrides:

onRestoreInstanceState in class DialogPreference