de.mrapp.android.preference

Class ColorPalettePreference

java.lang.Object

android.preference.Preference

de.mrapp.android.preference.AbstractDialogPreference

de.mrapp.android.preference.AbstractColorPickerPreference

de.mrapp.android.preference.ColorPalettePreference

All Implemented Interfaces:

android.content.DialogInterface.OnClickListener, android.content.DialogInterface.OnDismissListener, java.lang.Comparable<android.preference.Preference>

public class ColorPalettePreference
extends AbstractColorPickerPreference

A preference, which allows to choose a color from a pre-defined color palette. The chosen color will only be persisted, if confirmed by the user.

Since:

1.4.0

Nested Class Summary

Nested classes/interfaces inherited from class de.mrapp.android.preference.AbstractColorPickerPreference

AbstractColorPickerPreference.ColorFormat, AbstractColorPickerPreference.PreviewShape, AbstractColorPickerPreference.SavedState

Nested classes/interfaces inherited from class android.preference.Preference

android.preference.Preference.BaseSavedState, android.preference.Preference.OnPreferenceChangeListener, android.preference.Preference.OnPreferenceClickListener

Field Summary

Fields inherited from class android.preference.Preference

DEFAULT_ORDER

Constructor Summary

Constructors

Constructor and Description
ColorPalettePreference(android.content.Context context) Creates a new preference, which allows to choose a color from a pre-defined color palette.
ColorPalettePreference(android.content.Context context, android.util.AttributeSet attributeSet) Creates a new preference, which allows to choose a color from a pre-defined color palette.
ColorPalettePreference(android.content.Context context, android.util.AttributeSet attributeSet, int defaultStyle) Creates a new preference, which allows to choose a color from a pre-defined color palette.
ColorPalettePreference(android.content.Context context, android.util.AttributeSet attributeSet, int defaultStyle, int defaultStyleResource) Creates a new preference, which allows to choose a color from a pre-defined color palette.

Method Summary

Modifier and Type	Method and Description
int[]	getColorPalette() Returns the colors, the preference allows to choose.
android.graphics.drawable.Drawable	getDialogPreviewBackground() Returns the background, which is used to preview colors in the preference's dialog.
int	getDialogPreviewBorderColor() Returns the border color, which is used to preview colors in the preference's dialog.
int	getDialogPreviewBorderWidth() Returns the border width, which is used to preview colors in the preference's dialog.
AbstractColorPickerPreference.PreviewShape	getDialogPreviewShape() Returns the shape, which is used to preview colors in the preference's dialog.
int	getDialogPreviewSize() Returns the size, which is used to preview colors in the preference's dialog.
int	getNumberOfColumns() Returns the number of columns, which are used to preview colors in the preference's dialog.
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(boolean positiveResult) The method, which is invoked on subclasses when the preference's dialog has been closed.
protected void	onPrepareDialog(MaterialDialog.Builder dialogBuilder) The method, which is invoked on subclasses when the preference's dialog is about to be created.
void	setColorPalette(int resourceId) Sets the colors, the preference should allow to choose.
void	setColorPalette(int[] colorPalette) Sets the colors, the preference should allow to choose.
void	setDialogPreviewBackground(android.graphics.drawable.Drawable background) Sets the background, which should be used to preview colors in the preference's dialog.
void	setDialogPreviewBackground(int resourceId) Sets the background, which should be used to preview colors in the preference's dialog.
void	setDialogPreviewBackgroundColor(int color) Sets the background color, which should be used to preview colors in the preference's dialog.
void	setDialogPreviewBorderColor(int borderColor) Sets the border color, which should be used to preview colors in the preference's dialog.
void	setDialogPreviewBorderWidth(int borderWidth) Sets the border width, which should be used to preview colors in the preference's dialog.
void	setDialogPreviewShape(AbstractColorPickerPreference.PreviewShape previewShape) Sets the shape, which should be used to preview colors in the preference's dialog.
void	setDialogPreviewSize(int previewSize) Sets the size, which should be used to preview colors in the preference's dialog.
void	setNumberOfColumns(int numberOfColumns) Sets the number of columns, which should be used to preview colors in the preference's dialog.

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

getColor, getColorFormat, getPreviewBackground, getPreviewBorderColor, getPreviewBorderWidth, getPreviewShape, getPreviewSize, getSummary, isPreviewShown, onCreateView, onGetDefaultValue, onRestoreInstanceState, onSaveInstanceState, onSetInitialValue, setColor, setColorFormat, setPreviewBackground, setPreviewBackground, setPreviewBackgroundColor, setPreviewBorderColor, setPreviewBorderWidth, setPreviewShape, setPreviewSize, showPreview

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

getDialog, getDialogBackground, getDialogButtonBarDividerColor, getDialogButtonTextColor, getDialogContentDividerColor, getDialogHeaderBackground, getDialogHeaderIcon, getDialogIcon, getDialogMessage, getDialogMessageColor, getDialogTitle, getDialogTitleColor, getNegativeButtonText, getPositiveButtonText, isDialogButtonBarDividerShown, isDialogContentDividerShown, isDialogHeaderShown, isDialogShown, isValueShownAsSummary, onClick, onClick, onDismiss, setDialogBackground, setDialogBackground, setDialogBackgroundColor, setDialogButtonBarDividerColor, setDialogButtonTextColor, setDialogContentDividerColor, setDialogHeaderBackground, setDialogHeaderBackground, setDialogHeaderBackgroundColor, setDialogHeaderIcon, setDialogHeaderIcon, setDialogIcon, setDialogIcon, setDialogMessage, setDialogMessage, setDialogMessageColor, setDialogTitle, setDialogTitle, setDialogTitleColor, setNegativeButtonText, setNegativeButtonText, setPositiveButtonText, setPositiveButtonText, showDialogButtonBarDivider, showDialogContentDivider, showDialogHeader, showValueAsSummary

Methods inherited from class android.preference.Preference

callChangeListener, compareTo, findPreferenceInHierarchy, getContext, getDependency, getEditor, getExtras, getFragment, getIcon, getIntent, getKey, getLayoutResource, getOnPreferenceChangeListener, getOnPreferenceClickListener, getOrder, getPersistedBoolean, getPersistedFloat, getPersistedInt, getPersistedLong, getPersistedString, getPreferenceManager, getSharedPreferences, getShouldDisableView, getTitle, getTitleRes, getView, getWidgetLayoutResource, hasKey, isEnabled, isPersistent, isSelectable, notifyChanged, notifyDependencyChange, notifyHierarchyChanged, onAttachedToActivity, onAttachedToHierarchy, onBindView, onDependencyChanged, onParentChanged, onPrepareForRemoval, peekExtras, persistBoolean, persistFloat, persistInt, persistLong, persistString, restoreHierarchyState, saveHierarchyState, setDefaultValue, setDependency, setEnabled, setFragment, setIcon, setIcon, setIntent, setKey, setLayoutResource, setOnPreferenceChangeListener, setOnPreferenceClickListener, setOrder, setPersistent, setSelectable, setShouldDisableView, setSummary, setSummary, setTitle, setTitle, setWidgetLayoutResource, shouldCommit, shouldDisableDependents, shouldPersist, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ColorPalettePreference

public ColorPalettePreference(android.content.Context context)

Creates a new preference, which allows to choose a color from a pre-defined color palette.

Parameters:

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

ColorPalettePreference

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

Creates a new preference, which allows to choose a color from a pre-defined color palette.

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

ColorPalettePreference

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

Creates a new preference, which allows to choose a color from a pre-defined color palette.

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

ColorPalettePreference

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

Creates a new preference, which allows to choose a color from a pre-defined color palette.

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

getColorPalette

public final int[] getColorPalette()

Returns the colors, the preference allows to choose.

Returns:

The colors, the preference allows to choose, as an Integer array

setColorPalette

public final void setColorPalette(int[] colorPalette)

Sets the colors, the preference should allow to choose.

Parameters:

colorPalette - The colors, which should be set, as an Integer array

setColorPalette

public final void setColorPalette(int resourceId)

Sets the colors, the preference should allow to choose.

Parameters:

resourceId - The resource id of the color palette, which should be set, as an Integer value. The resource id must correspond to a valid integer array resource

getDialogPreviewSize

public final int getDialogPreviewSize()

Returns the size, which is used to preview colors in the preference's dialog.

Returns:

The size, which is used to preview colors in the preference's dialog, as an Integer value in pixels

setDialogPreviewSize

public final void setDialogPreviewSize(int previewSize)

Sets the size, which should be used to preview colors in the preference's dialog.

Parameters:

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

getDialogPreviewShape

public final AbstractColorPickerPreference.PreviewShape getDialogPreviewShape()

Returns the shape, which is used to preview colors in the preference's dialog.

Returns:

The shape, which is used to preview colors in the preference's dialog, as a value of the enum PreviewShape. The shape may either be CIRCLE or SQUARE

setDialogPreviewShape

public final void setDialogPreviewShape(AbstractColorPickerPreference.PreviewShape previewShape)

Sets the shape, which should be used to preview colors in the preference's dialog.

Parameters:

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

getDialogPreviewBorderWidth

public final int getDialogPreviewBorderWidth()

Returns the border width, which is used to preview colors in the preference's dialog.

Returns:

The border width, which is used to preview colors in the preference's dialog, as an Integer value in pixels

setDialogPreviewBorderWidth

public final void setDialogPreviewBorderWidth(int borderWidth)

Sets the border width, which should be used to preview colors in the preference's dialog.

Parameters:

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

getDialogPreviewBorderColor

public final int getDialogPreviewBorderColor()

Returns the border color, which is used to preview colors in the preference's dialog.

Returns:

The border color, which is used to preview colors in the preference's dialog, as an Integer value

setDialogPreviewBorderColor

public final void setDialogPreviewBorderColor(int borderColor)

Sets the border color, which should be used to preview colors in the preference's dialog.

Parameters:

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

getDialogPreviewBackground

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

Returns the background, which is used to preview colors in the preference's dialog.

Returns:

The background, which is used to preview colors in the preference's dialog, as an instance of the class Drawable

setDialogPreviewBackground

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

Sets the background, which should be used to preview colors in the preference's dialog.

Parameters:

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

setDialogPreviewBackground

public final void setDialogPreviewBackground(int resourceId)

Sets the background, which should be used to preview colors in the preference's dialog.

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

setDialogPreviewBackgroundColor

public final void setDialogPreviewBackgroundColor(int color)

Sets the background color, which should be used to preview colors in the preference's dialog.

Parameters:

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

getNumberOfColumns

public final int getNumberOfColumns()

Returns the number of columns, which are used to preview colors in the preference's dialog.

Returns:

The number of columns, which are used to preview colors in the preference's dialog, as an Integer value

setNumberOfColumns

public final void setNumberOfColumns(int numberOfColumns)

Sets the number of columns, which should be used to preview colors in the preference's dialog.

Parameters:

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

needInputMethod

protected final boolean needInputMethod()

Description copied from class: AbstractDialogPreference

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.

Specified by:

needInputMethod in class AbstractDialogPreference

Returns:

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

onPrepareDialog

protected final void onPrepareDialog(MaterialDialog.Builder dialogBuilder)

Description copied from class: AbstractDialogPreference

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.

Specified by:

onPrepareDialog in class AbstractDialogPreference

Parameters:

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

onDialogClosed

protected final void onDialogClosed(boolean positiveResult)

Description copied from class: AbstractDialogPreference

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.

Specified by:

onDialogClosed in class AbstractDialogPreference

Parameters:

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