de.mrapp.android.preference

Class AbstractColorPickerPreference

java.lang.Object

androidx.preference.Preference

de.mrapp.android.preference.Preference

de.mrapp.android.preference.DialogPreference

de.mrapp.android.preference.AbstractColorPickerPreference

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:

ColorPalettePreference

public abstract class AbstractColorPickerPreference
extends DialogPreference

An abstract base class for all preferences, which allow to choose a color.

Since:

1.4.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractColorPickerPreference.ColorFormat The formats, which are supported to print textual representations of colors.
static class	AbstractColorPickerPreference.PreviewShape Contains all shapes, which can be used to show previews of colors.
static class	AbstractColorPickerPreference.SavedState A data structure, which allows to save the internal state of an AbstractColorPickerPreference.

Constructor Summary

Constructors

Constructor and Description
AbstractColorPickerPreference(android.content.Context context) Creates a new preference, which allows to choose a color.
AbstractColorPickerPreference(android.content.Context context, android.util.AttributeSet attributeSet) Creates a new preference, which allows to choose a color.
AbstractColorPickerPreference(android.content.Context context, android.util.AttributeSet attributeSet, int defaultStyle) Creates a new preference, which allows to choose a color.
AbstractColorPickerPreference(android.content.Context context, android.util.AttributeSet attributeSet, int defaultStyle, int defaultStyleResource) Creates a new preference, which allows to choose a color.

Method Summary

Modifier and Type	Method and Description
int	getColor() Returns the currently persisted color of the preference.
AbstractColorPickerPreference.ColorFormat	getColorFormat() Returns the format, which is used to print a textual representation of the preference's color.
android.graphics.drawable.Drawable	getPreviewBackground() Returns the background of the preview of the preference's color.
int	getPreviewBorderColor() Returns the border color of the preview of the preference's color.
int	getPreviewBorderWidth() Returns the border width of the preview of the preference's color.
AbstractColorPickerPreference.PreviewShape	getPreviewShape() Returns the shape of the preview of the preference's color.
int	getPreviewSize() Returns the size of the preview of the preference's color.
java.lang.CharSequence	getSummary()
boolean	isPreviewShown() Returns, whether a preview of the preference's color is shown, or not.
void	onBindViewHolder(PreferenceViewHolder holder)
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	setColor(int color) Sets the current color of the preference.
void	setColorFormat(AbstractColorPickerPreference.ColorFormat colorFormat) Sets the format, which should be used to print a textual representation of the preference's color.
void	setPreviewBackground(android.graphics.drawable.Drawable background) Sets the background of the preview of the preference's color.
void	setPreviewBackground(int resourceId) Sets the background of the preview of the preference's color.
void	setPreviewBackgroundColor(int backgroundColor) Sets the background color of the preview of the preference's color.
void	setPreviewBorderColor(int borderColor) Sets the border color of the preview of the preference's color.
void	setPreviewBorderWidth(int borderWidth) Sets the border width of the preview of the preference's color.
void	setPreviewShape(AbstractColorPickerPreference.PreviewShape previewShape) Sets the shape of the preview of the preference's color.
void	setPreviewSize(int previewSize) Sets the size of the preview of the preference's color.
void	showPreview(boolean showPreview) Sets, whether a preview of the preference's color should be shown, 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, needInputMethod, 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

AbstractColorPickerPreference

public AbstractColorPickerPreference(android.content.Context context)

Creates a new preference, which allows to choose a color.

Parameters:

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

AbstractColorPickerPreference

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

Creates a new preference, which allows to choose a color.

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

AbstractColorPickerPreference

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

Creates a new preference, which allows to choose a color.

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

AbstractColorPickerPreference

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

Creates a new preference, which allows to choose a color.

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

getColor

public final int getColor()

Returns the currently persisted color of the preference.

Returns:

The currently persisted color as an Integer value

setColor

public final void setColor(int color)

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

Parameters:

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

isPreviewShown

public final boolean isPreviewShown()

Returns, whether a preview of the preference's color is shown, or not.

Returns:

True, if a preview of the preference's color is shown, false otherwise

showPreview

public final void showPreview(boolean showPreview)

Sets, whether a preview of the preference's color should be shown, or not.

Parameters:

showPreview - True, if a preview of the preference's color should be shown, false otherwise

getPreviewSize

public final int getPreviewSize()

Returns the size of the preview of the preference's color.

Returns:

The size of the preview of the preference's color as an Integer value in pixels

setPreviewSize

public final void setPreviewSize(int previewSize)

Sets the size of the preview of the preference's color.

Parameters:

previewSize - The size, which should be set, as an Integer value in pixels. The size must be at least 1

getPreviewShape

public final AbstractColorPickerPreference.PreviewShape getPreviewShape()

Returns the shape of the preview of the preference's color.

Returns:

The shape of the preview of the preference's color as a value of the enum AbstractColorPickerPreference.PreviewShape. The shape may either be CIRCLE or SQUARE

setPreviewShape

public final void setPreviewShape(AbstractColorPickerPreference.PreviewShape previewShape)

Sets the shape of the preview of the preference's color.

Parameters:

previewShape - The shape, which should be set, as a value of the enum AbstractColorPickerPreference.PreviewShape. The shape may not be null

getPreviewBorderWidth

public final int getPreviewBorderWidth()

Returns the border width of the preview of the preference's color.

Returns:

The border width of the preview of the preference's color as an Integer value in pixels

setPreviewBorderWidth

public final void setPreviewBorderWidth(int borderWidth)

Sets the border width of the preview of the preference's color.

Parameters:

borderWidth - The border width, which should be set, as an Integer value in pixels. The border width must be at least 0

getPreviewBorderColor

public final int getPreviewBorderColor()

Returns the border color of the preview of the preference's color.

Returns:

The border color of the preview of the preference's color as an Integer value

setPreviewBorderColor

public final void setPreviewBorderColor(int borderColor)

Sets the border color of the preview of the preference's color.

Parameters:

borderColor - The border color, which should be set, as an Integer value

getPreviewBackground

public final android.graphics.drawable.Drawable getPreviewBackground()

Returns the background of the preview of the preference's color.

Returns:

The background of the preview of the preference's color as an instance of the class Drawable

setPreviewBackground

public final void setPreviewBackground(android.graphics.drawable.Drawable background)

Sets the background of the preview of the preference's color.

Parameters:

background - The background, which should be set, as an instance of the class Drawable or null, if no background should be shown

setPreviewBackground

public final void setPreviewBackground(int resourceId)

Sets the background of the preview of the preference's color.

Parameters:

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

setPreviewBackgroundColor

public final void setPreviewBackgroundColor(int backgroundColor)

Sets the background color of the preview of the preference's color.

Parameters:

backgroundColor - The background color, which should be set, as an Integer value

getColorFormat

public final AbstractColorPickerPreference.ColorFormat getColorFormat()

Returns the format, which is used to print a textual representation of the preference's color.

Returns:

The format, which is used to print a textual representation of the preference's color, as a value of the enum AbstractColorPickerPreference.ColorFormat. The format may either be RGB, ARGB, HEX or AHEX

setColorFormat

public final void setColorFormat(AbstractColorPickerPreference.ColorFormat colorFormat)

Sets the format, which should be used to print a textual representation of the preference's color.

Parameters:

colorFormat - The format, which should be set, as a value of the enum AbstractColorPickerPreference.ColorFormat. The format may not be null

getSummary

public final java.lang.CharSequence getSummary()

onGetDefaultValue

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

onSetInitialValue

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

onBindViewHolder

public void onBindViewHolder(PreferenceViewHolder holder)

onSaveInstanceState

protected android.os.Parcelable onSaveInstanceState()

Overrides:

onSaveInstanceState in class DialogPreference

onRestoreInstanceState

protected void onRestoreInstanceState(android.os.Parcelable state)

Overrides:

onRestoreInstanceState in class DialogPreference