de.mrapp.android.preference

Class DigitPickerPreference

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

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 DigitPickerPreference
extends AbstractNumberPickerPreference

A preference, which allows to choose a decimal number via multiple NumberPicker widgets. Each widget allows to choose one digit of the number individually. 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	DigitPickerPreference.SavedState A data structure, which allows to save the internal state of an DigitPickerPreference.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected int	getCurrentNumber() Returns the current number of the NumberPicker widget.
int	getNumberOfDigits() Returns the number of digits of the numbers, the preference allows to choose.
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	setNumber(int number) Sets the current number of the preference.
void	setNumberOfDigits(int numberOfDigits) Sets the number of digits of the numbers, the preference should allow to choose.
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

DigitPickerPreference

public DigitPickerPreference(android.content.Context context)

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

Parameters:

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

DigitPickerPreference

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

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

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

DigitPickerPreference

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

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

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

DigitPickerPreference

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

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

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

getCurrentNumber

protected final int getCurrentNumber()

Returns the current number of the NumberPicker widget.

Returns:

The current number of the NumberPicker widget as an Integer value

getNumberOfDigits

public final int getNumberOfDigits()

Returns the number of digits of the numbers, the preference allows to choose.

Returns:

The number of digits of the numbers, the preference allows to choose, as an Integer value

setNumberOfDigits

public final void setNumberOfDigits(int numberOfDigits)

Sets the number of digits of the numbers, the preference should allow to choose.

Parameters:

numberOfDigits - The number of digits, which should be set, as an Integer value. The number of digits must be at least 1

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