de.mrapp.android.preference

Class ResolutionPreference

java.lang.Object

androidx.preference.Preference

de.mrapp.android.preference.Preference

de.mrapp.android.preference.DialogPreference

de.mrapp.android.preference.AbstractValidateableDialogPreference<java.lang.CharSequence>

de.mrapp.android.preference.ResolutionPreference

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 ResolutionPreference
extends AbstractValidateableDialogPreference<java.lang.CharSequence>

A preference, which allows to enter a two-dimensional image or video resulution via two EditText widgets. The entered resolution will only be persisted, if confirmed by the user.

Since:

1.3.0

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
ResolutionPreference(android.content.Context context) Creates a new preference, which allows to enter a two-dimensional image or video resolution via two EditText widgets.
ResolutionPreference(android.content.Context context, android.util.AttributeSet attributeSet) Creates a new preference, which allows to enter a two-dimensional image or video resolution via two EditText widgets.
ResolutionPreference(android.content.Context context, android.util.AttributeSet attributeSet, int defaultStyle) Creates a new preference, which allows to enter a two-dimensional image or video resolution via two EditText widgets.
ResolutionPreference(android.content.Context context, android.util.AttributeSet attributeSet, int defaultStyle, int defaultStyleResource) Creates a new preference, which allows to enter a two-dimensional image or video resolution via two EditText widgets.

Method Summary

Modifier and Type	Method and Description
static java.lang.String	formatResolution(android.content.Context context, int width, int height) Creates and returns the textual representation of a specific resolution.
int	getHeight() Returns the height of the currently persisted resolution of the preference.
java.lang.CharSequence	getHeightHint() Returns the hint of the edit text widget, which allows to enter the height of the resolution.
java.lang.CharSequence	getSummary()
java.lang.CharSequence	getUnit() Returns the unit, which is used for textual representation of the preference's resolution.
int	getWidth() Returns the width of the currently persisted resolution of the preference.
java.lang.CharSequence	getWidthHint() Returns the hint of the edit text widget, which allows to enter the width of the resolution.
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 void	onDialogClosed(AbstractButtonBarDialog dialog, boolean positiveResult) The method, which is invoked on subclasses when the preference's dialog has been closed.
protected java.lang.Object	onGetDefaultValue(android.content.res.TypedArray typedArray, int index)
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()
protected void	onSetInitialValue(java.lang.Object defaultValue)
static android.util.Pair<java.lang.Integer,java.lang.Integer>	parseResolution(android.content.Context context, java.lang.String resolution) Parses a specific textual representation of a resolution and returns its dimensions.
void	setHeightHint(java.lang.CharSequence hint) Sets the hint of the edit text widget, which allows to enter the height of the resolution.
void	setHeightHint(int resourceId) Sets the hint of the edit text widget, which allows to enter the height of the resolution.
void	setResolution(int width, int height) Sets the current resolution of the preference.
void	setUnit(java.lang.CharSequence unit) Sets the unit, which should be used for textual representation of the preference's resolution.
void	setUnit(int resourceId) Sets the unit, which should be used for textual representation of the preference's resolution.
void	setWidthHint(java.lang.CharSequence hint) Sets the hint of the edit text widget, which allows to enter the width of the resolution.
void	setWidthHint(int resourceId) Sets the hint of the edit text widget, which allows to enter the width of the resolution.
boolean	validate()

Methods inherited from class de.mrapp.android.preference.AbstractValidateableDialogPreference

addAllValidators, addAllValidators, addValidationListener, addValidator, getErrorColor, getHelperText, getHelperTextColor, getValidationListeners, getValidators, isValidatedOnFocusLost, isValidatedOnValueChange, removeAllValidators, removeAllValidators, removeAllValidators, removeValidationListener, removeValidator, setErrorColor, setHelperText, setHelperText, setHelperTextColor, validate, validateOnFocusLost, validateOnValueChange

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

ResolutionPreference

public ResolutionPreference(android.content.Context context)

Creates a new preference, which allows to enter a two-dimensional image or video resolution via two EditText 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

ResolutionPreference

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

Creates a new preference, which allows to enter a two-dimensional image or video resolution via two EditText 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

ResolutionPreference

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

Creates a new preference, which allows to enter a two-dimensional image or video resolution via two EditText 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

ResolutionPreference

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

Creates a new preference, which allows to enter a two-dimensional image or video resolution via two EditText 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

parseResolution

public static android.util.Pair<java.lang.Integer,java.lang.Integer> parseResolution(android.content.Context context,
                                                                                     java.lang.String resolution)

Parses a specific textual representation of a resolution and returns its dimensions.

Parameters:

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

resolution - The textual representation of the resolution, which should be parsed, as a String. The resolution may neither be null, nor empty

Returns:

A pair, which contains the width and height of the given resolution, as an instance of the class Pair

formatResolution

public static java.lang.String formatResolution(android.content.Context context,
                                                int width,
                                                int height)

Creates and returns the textual representation of a specific resolution.

Parameters:

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

width - The width of the resolution as an Integer value. The width must be at least 1

height - The height of the resolution as an Integer value. The height must be at least 1

Returns:

The textual representation of the given resolution as a String

getWidth

public final int getWidth()

Returns the width of the currently persisted resolution of the preference.

Returns:

The width of the currently persisted resolution as an Integer value

getHeight

public final int getHeight()

Returns the height of the currently persisted resolution of the preference.

Returns:

The height of the currently persisted resolution as an Integer value

setResolution

public final void setResolution(int width,
                                int height)

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

Parameters:

width - The width, which should be set, as an Integer value. The width must be at least 1

height - The height, which should be set, as an Integer value. The height must be at least 1

getUnit

public final java.lang.CharSequence getUnit()

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

Returns:

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

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

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

getWidthHint

public final java.lang.CharSequence getWidthHint()

Returns the hint of the edit text widget, which allows to enter the width of the resolution.

Returns:

The hint of the edit text widget, which allows to enter the width of the resolution, as an instance of the type CharSequence or null, if no hint is set

setWidthHint

public final void setWidthHint(java.lang.CharSequence hint)

Sets the hint of the edit text widget, which allows to enter the width of the resolution.

Parameters:

hint - The hint, which should be set, as an instance of the type CharSequence or null, if no hint should be set

setWidthHint

public final void setWidthHint(int resourceId)

Sets the hint of the edit text widget, which allows to enter the width of the resolution.

Parameters:

resourceId - The resource id of the hint, which should be set, as an Integer value. The resource id must correspond to a valid string resource

getHeightHint

public final java.lang.CharSequence getHeightHint()

Returns the hint of the edit text widget, which allows to enter the height of the resolution.

Returns:

The hint of the edit text widget, which allows to enter the height of the resolution, as an instance of the type CharSequence or null, if no hint is set

setHeightHint

public final void setHeightHint(java.lang.CharSequence hint)

Sets the hint of the edit text widget, which allows to enter the height of the resolution.

Parameters:

hint - The hint, which should be set, as an instance of the type CharSequence or null, if no hint should be set

setHeightHint

public final void setHeightHint(int resourceId)

Sets the hint of the edit text widget, which allows to enter the height of the resolution.

Parameters:

resourceId - The resource id of the hint, 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()

validate

public final boolean validate()

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 AbstractValidateableDialogPreference<java.lang.CharSequence>

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

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