de.mrapp.android.preference.activity

Class PreferenceFragment

java.lang.Object

PreferenceFragmentCompat

de.mrapp.android.preference.activity.fragment.AbstractPreferenceFragment

de.mrapp.android.preference.activity.PreferenceFragment

public abstract class PreferenceFragment
extends AbstractPreferenceFragment

A fragment, which allows to show multiple preferences. Additionally, a button, which allows to restore the preferences' default values, can be shown.

Since:

1.1.0

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	EXTRA_RESTORE_DEFAULTS_BUTTON_TEXT When attaching this fragment to an activity and using EXTRA_SHOW_RESTORE_DEFAULTS_BUTTON, this extra can also be specified to supply a custom text for the button, which allows to restore the preferences' default values.
static java.lang.String	EXTRA_SHOW_RESTORE_DEFAULTS_BUTTON When attaching this fragment to an activity, the passed bundle can contain this extra boolean to display the button, which allows to restore the preferences' default values.

Constructor Summary

Constructors

Constructor and Description
PreferenceFragment()

Method Summary

Modifier and Type	Method and Description
void	addRestoreDefaultsListener(RestoreDefaultsListener listener) Adds a new listener, which should be notified, when the preferences' default values should be restored, to the fragment.
android.view.ViewGroup	getButtonBar() Returns the view group, which contains the button, which allows to restore the preferences' default values.
android.graphics.drawable.Drawable	getButtonBarBackground() Returns the background of the view group, which contains the button, which allows to restore the preferences' default values.
int	getButtonBarElevation() Returns the elevation of the view group, which contains the button, which allows to restore the preferences' default values.
android.widget.FrameLayout	getFrameLayout() Returns the frame layout, which contains the fragment's views.
android.widget.Button	getRestoreDefaultsButton() Returns the button, which allows to restore the preferences' default values.
java.lang.CharSequence	getRestoreDefaultsButtonText() Returns the text of the button, which allows to restore the preferences' default values.
boolean	isRestoreDefaultsButtonShown() Returns, whether the button, which allows to restore the preferences' default values, is currently shown, or not.
void	onActivityCreated(android.os.Bundle savedInstanceState)
void	onCreate(android.os.Bundle savedInstanceState)
android.view.View	onCreateView(android.view.LayoutInflater inflater, android.view.ViewGroup parent, android.os.Bundle savedInstanceState)
void	removeRestoreDefaultsListener(RestoreDefaultsListener listener) Removes a specific listener, which should not be notified anymore, when the preferences' default values should be restored, from the fragment.
void	restoreDefaults() Restores the default values of all preferences, which are contained by the fragment.
void	setButtonBarBackground(android.graphics.drawable.Drawable background) Sets the background of the view group, which contains the button, which allows to restore the preferences' default values.
void	setButtonBarBackground(int resourceId) Sets the background of the view group, which contains the button, which allows to restore the preferences' default values.
void	setButtonBarBackgroundColor(int color) Sets the background color of the view group, which contains the button, which allows to restore the preferences' default values.
void	setButtonBarElevation(int elevation) Sets the elevation of the view group, which contains the button, which allows to restore the preferences' default values.
void	setRestoreDefaultsButtonText(java.lang.CharSequence text) Sets the text of the button, which allows to restore the preferences' default values.
void	setRestoreDefaultsButtonText(int resourceId) Sets the text of the button, which allows to restore the preferences' default values.
void	showRestoreDefaultsButton(boolean show) Shows or hides the button, which allows to restore the preferences' default values.

Methods inherited from class de.mrapp.android.preference.activity.fragment.AbstractPreferenceFragment

getDividerColor, onCreateAdapter, onCreatePreferenceAdapter, setDividerColor

Methods inherited from class java.lang.Object

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

Field Detail

EXTRA_SHOW_RESTORE_DEFAULTS_BUTTON

public static final java.lang.String EXTRA_SHOW_RESTORE_DEFAULTS_BUTTON

When attaching this fragment to an activity, the passed bundle can contain this extra boolean to display the button, which allows to restore the preferences' default values.

See Also:

Constant Field Values

EXTRA_RESTORE_DEFAULTS_BUTTON_TEXT

public static final java.lang.String EXTRA_RESTORE_DEFAULTS_BUTTON_TEXT

When attaching this fragment to an activity and using EXTRA_SHOW_RESTORE_DEFAULTS_BUTTON, this extra can also be specified to supply a custom text for the button, which allows to restore the preferences' default values.

See Also:

Constant Field Values

Constructor Detail

PreferenceFragment

public PreferenceFragment()

Method Detail

getFrameLayout

public final android.widget.FrameLayout getFrameLayout()

Returns the frame layout, which contains the fragment's views. It is the root view of the fragment.

Returns:

The frame layout, which contains the fragment's views, as an instance of the class FrameLayout or null, if the fragment has not been created yet

getButtonBar

public final android.view.ViewGroup getButtonBar()

Returns the view group, which contains the button, which allows to restore the preferences' default values.

Returns:

The view group, which contains the button, which allows to restore the preferences' default values, as an instance of the class ViewGroup or null, if the button is not shown or if the fragment has not been created yet

getRestoreDefaultsButton

public final android.widget.Button getRestoreDefaultsButton()

Returns the button, which allows to restore the preferences' default values.

Returns:

The button, which allows to restore the preferences' default values, as an instance of the class Button or null, if the button is not shown

addRestoreDefaultsListener

public final void addRestoreDefaultsListener(RestoreDefaultsListener listener)

Adds a new listener, which should be notified, when the preferences' default values should be restored, to the fragment.

Parameters:

listener - The listener, which should be added as an instance of the type RestoreDefaultsListener. The listener may not be null

removeRestoreDefaultsListener

public final void removeRestoreDefaultsListener(RestoreDefaultsListener listener)

Removes a specific listener, which should not be notified anymore, when the preferences' default values should be restored, from the fragment.

Parameters:

listener - The listener, which should be removed as an instance of the type RestoreDefaultsListener. The listener may not be null

restoreDefaults

public final void restoreDefaults()

Restores the default values of all preferences, which are contained by the fragment.

isRestoreDefaultsButtonShown

public final boolean isRestoreDefaultsButtonShown()

Returns, whether the button, which allows to restore the preferences' default values, is currently shown, or not.

Returns:

True, if the button, which allows to restore the preferences' default values, is currently shown, false otherwise

showRestoreDefaultsButton

public final void showRestoreDefaultsButton(boolean show)

Shows or hides the button, which allows to restore the preferences' default values.

Parameters:

show - True, if the button, which allows to restore the preferences' default values, should be shown, false otherwise

getRestoreDefaultsButtonText

public final java.lang.CharSequence getRestoreDefaultsButtonText()

Returns the text of the button, which allows to restore the preferences' default values.

Returns:

The text of the button, which allows to restore the preferences' default values, as an instance of the class CharSequence

setRestoreDefaultsButtonText

public final void setRestoreDefaultsButtonText(int resourceId)

Sets the text of the button, which allows to restore the preferences' default values. The text is only set, if the button is shown.

Parameters:

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

setRestoreDefaultsButtonText

public final void setRestoreDefaultsButtonText(java.lang.CharSequence text)

Sets the text of the button, which allows to restore the preferences' default values. The text is only set, if the button is shown.

Parameters:

text - The text, which should be set, as an instance of the class CharSequence. The text may neither be null, nor empty

getButtonBarBackground

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

Returns the background of the view group, which contains the button, which allows to restore the preferences' default values.

Returns:

The background of the view group, which contains the button, which allows to restore the preferences' default values, as an instance of the class Drawable

setButtonBarBackground

public final void setButtonBarBackground(int resourceId)

Sets the background of the view group, which contains the button, which allows to restore the preferences' default values.

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

setButtonBarBackgroundColor

public final void setButtonBarBackgroundColor(int color)

Sets the background color of the view group, which contains the button, which allows to restore the preferences' default values. shown.

Parameters:

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

setButtonBarBackground

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

Sets the background of the view group, which contains the button, which allows to restore the preferences' default values.

Parameters:

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

getButtonBarElevation

public final int getButtonBarElevation()

Returns the elevation of the view group, which contains the button, which allows to restore the preferences' default values.

Returns:

The elevation in dp as an Integer value

setButtonBarElevation

public final void setButtonBarElevation(int elevation)

Sets the elevation of the view group, which contains the button, which allows to restore the preferences' default values.

Parameters:

elevation - The elevation, which should be set, in dp as an Integer value. The elevation must be at least 1 and at maximum 16

onCreate

public void onCreate(android.os.Bundle savedInstanceState)

Overrides:

onCreate in class AbstractPreferenceFragment

onActivityCreated

public void onActivityCreated(android.os.Bundle savedInstanceState)

onCreateView

public android.view.View onCreateView(android.view.LayoutInflater inflater,
                                      android.view.ViewGroup parent,
                                      android.os.Bundle savedInstanceState)

Overrides:

onCreateView in class AbstractPreferenceFragment