de.mrapp.android.preference.activity

Class NavigationPreference

java.lang.Object

Preference

de.mrapp.android.preference.activity.NavigationPreference

public class NavigationPreference
extends Preference

A preference, which allows to show a fragment within a PreferenceActivity when clicked.

Since:

5.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	NavigationPreference.Callback Defines the callback, a class, which should be notified, when the fragment, which is associated with a navigation preference, should be shown, must implement.
static class	NavigationPreference.SavedState A data structure, which allows to save the internal state of a NavigationPreference.

Constructor Summary

Constructors

Constructor and Description
NavigationPreference(android.content.Context context) Creates a new preference, which allows to show a preference screen within a PreferenceActivity when clicked.
NavigationPreference(android.content.Context context, android.util.AttributeSet attributeSet) Creates a new preference, which allows to show a preference screen within a PreferenceActivity when clicked.
NavigationPreference(android.content.Context context, android.util.AttributeSet attributeSet, int defaultStyle) Creates a new preference, which allows to show a preference screen within a PreferenceActivity when clicked.
NavigationPreference(android.content.Context context, android.util.AttributeSet attributeSet, int defaultStyle, int defaultStyleResource) Creates a new preference, which allows to show a preference screen within a PreferenceActivity when clicked.

Method Summary

Modifier and Type	Method and Description
java.lang.CharSequence	getBreadCrumbTitle() Returns the breadcrumb title, which is shown, when showing the fragment, which is associated with the preference.
android.os.Bundle	getExtras() Returns the arguments, which are passed to the fragment, which is associated with the preference.
java.lang.String	getFragment() Returns the fully classified class name of the fragment, which is associated with the preference.
android.content.res.ColorStateList	getIconTintList() Returns the color state list, which is used to tint the preference's icon.
android.graphics.PorterDuff.Mode	getIconTintMode() Returns the mode, which is used to tint the preference's icon.
protected void	onRestoreInstanceState(android.os.Parcelable state)
protected android.os.Parcelable	onSaveInstanceState()
void	performClick() Performs a click on the preference.
void	setBreadCrumbTitle(java.lang.CharSequence breadCrumbTitle) Sets the breadcrumb title, which should be shown, when showing the fragment, which is associated with the preference.
void	setBreadCrumbTitle(int resourceId) Sets the breadcrumb title, which should be shown, when showing the fragment, which is associated with the preference.
void	setCallback(NavigationPreference.Callback callback) Sets the callback, which should be notified, when the fragment, which is associated with the preference, should be shown.
void	setExtras(android.os.Bundle extras) Sets the argument, which should be passed to the fragment, which is associated with the preference.
void	setFragment(java.lang.String fragment) Sets the fully classified class name of the fragment, which should be associated with the preference.
void	setIcon(android.graphics.drawable.Drawable icon)
void	setIconTint(int color) Sets the color, which should be used to tint the preference's icon.
void	setIconTintList(android.content.res.ColorStateList tintList) Sets the color state list, which should be used to tint the preference's icon.
void	setIconTintMode(android.graphics.PorterDuff.Mode tintMode) Sets the mode, which should be used to tint the preference's icon.
void	setOnPreferenceClickListener(OnPreferenceClickListener listener)

Methods inherited from class java.lang.Object

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

Constructor Detail

NavigationPreference

public NavigationPreference(android.content.Context context)

Creates a new preference, which allows to show a preference screen within a PreferenceActivity when clicked.

Parameters:

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

NavigationPreference

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

Creates a new preference, which allows to show a preference screen within a PreferenceActivity when clicked.

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

NavigationPreference

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

Creates a new preference, which allows to show a preference screen within a PreferenceActivity when clicked.

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

NavigationPreference

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

Creates a new preference, which allows to show a preference screen within a PreferenceActivity when clicked.

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

setCallback

public final void setCallback(NavigationPreference.Callback callback)

Sets the callback, which should be notified, when the fragment, which is associated with the preference, should be shown.

Parameters:

callback - The callback, which should be set, as an instance of the type NavigationPreference.Callback or null, if no callback should be notified

getBreadCrumbTitle

public final java.lang.CharSequence getBreadCrumbTitle()

Returns the breadcrumb title, which is shown, when showing the fragment, which is associated with the preference.

Returns:

The breadcrumb title, which is shown, when showing the fragment, which is associated with the preference, as an instance of the type CharSequence or null, if no breadcrumb title is available

setBreadCrumbTitle

public final void setBreadCrumbTitle(int resourceId)

Sets the breadcrumb title, which should be shown, when showing the fragment, which is associated with the preference.

Parameters:

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

setBreadCrumbTitle

public final void setBreadCrumbTitle(java.lang.CharSequence breadCrumbTitle)

Sets the breadcrumb title, which should be shown, when showing the fragment, which is associated with the preference.

Parameters:

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

getFragment

public final java.lang.String getFragment()

Returns the fully classified class name of the fragment, which is associated with the preference.

Returns:

The fully classified class name of the fragment, which is associated with the preference, as a String or null, if no fragment is associated with the preference

setFragment

public final void setFragment(java.lang.String fragment)

Sets the fully classified class name of the fragment, which should be associated with the preference.

Parameters:

fragment - The fully classified class name of the fragment, which should be set, as a String or null, if no fragment should be set

getExtras

public final android.os.Bundle getExtras()

Returns the arguments, which are passed to the fragment, which is associated with the preference.

Returns:

The arguments, which are passed to the fragment, which is associated with the preference, as an instance of the class Bundle or null, if no arguments are passed to the fragment

setExtras

public final void setExtras(android.os.Bundle extras)

Sets the argument, which should be passed to the fragment, which is associated with the preference.

Parameters:

extras - The arguments, which should be set, as an instance of the class Bundle or null, if no arguments should be passed to the fragment

getIconTintList

public final android.content.res.ColorStateList getIconTintList()

Returns the color state list, which is used to tint the preference's icon.

Returns:

The color state list, which is used to tint the preference's icon as an instance of the class ColorStateList or null, if no color state list has been set

setIconTint

public final void setIconTint(int color)

Sets the color, which should be used to tint the preference's icon.

Parameters:

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

setIconTintList

public final void setIconTintList(android.content.res.ColorStateList tintList)

Sets the color state list, which should be used to tint the preference's icon.

Parameters:

tintList - The color state list, which should be set, as an instance of the class ColorStateList or null, if no color state list should be set

getIconTintMode

public final android.graphics.PorterDuff.Mode getIconTintMode()

Returns the mode, which is used to tint the preference's icon.

Returns:

The mode, which is used to tint the preference's icon, as a value of the enum PorterDuff.Mode. The mode may not be null

setIconTintMode

public final void setIconTintMode(android.graphics.PorterDuff.Mode tintMode)

Sets the mode, which should be used to tint the preference's icon.

Parameters:

tintMode - The mode, which should be set, as a value of the enum PorterDuff.Mode. The mode may not be null

setIcon

public void setIcon(android.graphics.drawable.Drawable icon)

setOnPreferenceClickListener

public final void setOnPreferenceClickListener(OnPreferenceClickListener listener)

performClick

public final void performClick()

Performs a click on the preference.

onSaveInstanceState

protected final android.os.Parcelable onSaveInstanceState()

onRestoreInstanceState

protected final void onRestoreInstanceState(android.os.Parcelable state)