de.mrapp.android.preference

Class NumberPickerPreference

java.lang.Object

androidx.preference.Preference

de.mrapp.android.preference.Preference

de.mrapp.android.preference.DialogPreference

de.mrapp.android.preference.AbstractNumberPickerPreference

de.mrapp.android.preference.NumberPickerPreference

All Implemented Interfaces:

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

public class NumberPickerPreference
extends AbstractNumberPickerPreference

A preference, which allows to choose a decimal number via a NumberPicker widget. The chosen number will only be persisted, if confirmed by the user.

Since:

1.1.0

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
NumberPickerPreference(android.content.Context context) Creates a new preference, which allows to choose a decimal number via a NumberPicker widget.
NumberPickerPreference(android.content.Context context, android.util.AttributeSet attributeSet) Creates a new preference, which allows to choose a decimal number via a NumberPicker widget.
NumberPickerPreference(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.
NumberPickerPreference(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
protected int	getCurrentIndex() Returns the currently selected index of the NumberPicker widget.
int	getMaxNumber() Returns the maximum number, the preference allows to choose.
int	getMinNumber() Returns the minimum number, the preference allows to choose.
int	getRange() Returns the range of numbers, the preference allows to choose from.
int	getStepSize() Returns the step size, the number is increased or decreased by when moving the selector wheel.
protected void	onDialogClosed(AbstractButtonBarDialog dialog, boolean positiveResult) The method, which is invoked on subclasses when the preference's dialog has been closed.
protected void	onPrepareDialog(<any> dialogBuilder) The method, which is invoked on subclasses when the preference's dialog is about to be created.
protected void	onRestoreInstanceState(android.os.Parcelable state)
protected android.os.Parcelable	onSaveInstanceState()
void	setMaxNumber(int maxNumber) Sets the maximum number, the preference allows to choose.
void	setMinNumber(int minNumber) Sets the minimum number, the preference allows to choose.
void	setNumber(int number) Sets the current number of the preference.
void	setStepSize(int stepSize) Sets the step size, the number should be increased or decreased by when moving the selector wheel.
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.AbstractNumberPickerPreference

getNumber, getSummary, getUnit, isInputMethodUsed, isSelectorWheelWrapped, needInputMethod, onGetDefaultValue, onSetInitialValue, setUnit, setUnit

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, onDismiss, onKey, 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

NumberPickerPreference

public NumberPickerPreference(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

NumberPickerPreference

public NumberPickerPreference(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

NumberPickerPreference

public NumberPickerPreference(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

NumberPickerPreference

public NumberPickerPreference(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

getCurrentIndex

protected final int getCurrentIndex()

Returns the currently selected index of the NumberPicker widget.

Returns:

The currently selected index of the NumberPicker widget as an Integer value

getMinNumber

public final int getMinNumber()

Returns the minimum number, the preference allows to choose.

Returns:

The minimum number, the preference allows to choose, as an Integer value

setMinNumber

public final void setMinNumber(int minNumber)

Sets the minimum number, the preference allows to choose.

Parameters:

minNumber - The minimum number, which should be set, as an Integer value. The number must be less than the maximum number

getMaxNumber

public final int getMaxNumber()

Returns the maximum number, the preference allows to choose.

Returns:

The maximum number, the preference allows to choose, as an Integer value

setMaxNumber

public final void setMaxNumber(int maxNumber)

Sets the maximum number, the preference allows to choose.

Parameters:

maxNumber - The maximum number, which should be set, as an Integer value. The number must be greater than the minimum number

getRange

public final int getRange()

Returns the range of numbers, the preference allows to choose from.

Returns:

The range of numbers, the preference allows to choose from, as an Integer value

getStepSize

public final int getStepSize()

Returns the step size, the number is increased or decreased by when moving the selector wheel.

Returns:

The step size, the number is increased or decreased by when moving the selector wheel, as an Integer value

setStepSize

public final void setStepSize(int stepSize)

Sets the step size, the number should be increased or decreased by when moving the selector wheel.

Parameters:

stepSize - The step size, which should be set, as an Integer value. The value must be between at least 1 and at maximum the value of the method getRange():int

setNumber

public final void setNumber(int number)

Description copied from class: AbstractNumberPickerPreference

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

Overrides:

setNumber in class AbstractNumberPickerPreference

Parameters:

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

useInputMethod

public final void useInputMethod(boolean useInputMethod)

Description copied from class: AbstractNumberPickerPreference

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

Overrides:

useInputMethod in class AbstractNumberPickerPreference

Parameters:

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

wrapSelectorWheel

public final void wrapSelectorWheel(boolean wrapSelectorWheel)

Description copied from class: AbstractNumberPickerPreference

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

Overrides:

wrapSelectorWheel in class AbstractNumberPickerPreference

Parameters:

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

onPrepareDialog

protected void onPrepareDialog(<any> dialogBuilder)

Description copied from class: DialogPreference

The method, which is invoked on subclasses when the preference's dialog is about to be created. The builder, which is passed as a method parameter may be manipulated by subclasses in order to change the appearance of the dialog. When views are inflated inside this method, the context of the builder should be used in order to ensure that the dialog's theme is used.

Overrides:

onPrepareDialog in class DialogPreference

Parameters:

dialogBuilder - The builder, which is used to create the preference's dialog, as an instance of the class AbstractMaterialDialogBuilder

onDialogClosed

protected void onDialogClosed(AbstractButtonBarDialog dialog,
                              boolean positiveResult)

Description copied from class: DialogPreference

The method, which is invoked on subclasses when the preference's dialog has been closed. This method may be used within subclasses to evaluate the changes, which have been made while the dialog was shown.

Overrides:

onDialogClosed in class DialogPreference

Parameters:

dialog - The dialog, which has been closed, as an instance of the class AbstractButtonBarDialog. The dialog may not be null

positiveResult - True, if the dialog has been close affirmatively, false otherwise

onSaveInstanceState

protected android.os.Parcelable onSaveInstanceState()

Overrides:

onSaveInstanceState in class AbstractNumberPickerPreference

onRestoreInstanceState

protected void onRestoreInstanceState(android.os.Parcelable state)

Overrides:

onRestoreInstanceState in class AbstractNumberPickerPreference