Please note that the contents of this offline web site may be out of date. To access the most recent documentation visit the online version .
Note that links that point to online resources are green in color and will open in a new window.
We would love it if you could give us feedback about this material by filling this form (You have to be online to fill it)

Summary: Nested Classes | Constants | Methods | Inherited Methods | [Expand All]

Added in API level 1

public class

PreferenceManager

extends Object

java.lang.Object
↳	android.preference.PreferenceManager

Class Overview

Used to help create Preference hierarchies from activities or XML.

In most cases, clients should use addPreferencesFromIntent(Intent) or addPreferencesFromResource(int) .

Summary

Nested Classes
interface	PreferenceManager.OnActivityDestroyListener	Interface definition for a class that will be called when the container's activity is destroyed.
interface	PreferenceManager.OnActivityResultListener	Interface definition for a class that will be called when the container's activity receives an activity result.
interface	PreferenceManager.OnActivityStopListener	Interface definition for a class that will be called when the container's activity is stopped.

Constants
String	KEY_HAS_SET_DEFAULT_VALUES
String	METADATA_KEY_PREFERENCES	The Activity meta-data key for its XML preference hierarchy.

Public Methods
PreferenceScreen	createPreferenceScreen ( Context context)
Preference	findPreference ( CharSequence key) Finds a `Preference` based on its key.
static SharedPreferences	getDefaultSharedPreferences ( Context context) Gets a SharedPreferences instance that points to the default file that is used by the preference framework in the given context.
SharedPreferences	getSharedPreferences () Gets a SharedPreferences instance that preferences managed by this will use.
int	getSharedPreferencesMode () Returns the current mode of the SharedPreferences file that preferences managed by this will use.
String	getSharedPreferencesName () Returns the current name of the SharedPreferences file that preferences managed by this will use.
static void	setDefaultValues ( Context context, String sharedPreferencesName, int sharedPreferencesMode, int resId, boolean readAgain) Similar to `setDefaultValues(Context, int, boolean)` but allows the client to provide the filename and mode of the shared preferences file.
static void	setDefaultValues ( Context context, int resId, boolean readAgain) Sets the default values from an XML preference file by reading the values defined by each `Preference` item's `android:defaultValue` attribute.
void	setSharedPreferencesMode (int sharedPreferencesMode) Sets the mode of the SharedPreferences file that preferences managed by this will use.
void	setSharedPreferencesName ( String sharedPreferencesName) Sets the name of the SharedPreferences file that preferences managed by this will use.

[Expand]

Inherited Methods

From class java.lang.Object

Object	clone () Creates and returns a copy of this `Object` .
boolean	equals ( Object o) Compares this instance with the specified object and indicates if they are equal.
void	finalize () Invoked when the garbage collector has detected that this instance is no longer reachable.
final Class <?>	getClass () Returns the unique instance of `Class` that represents this object's class.
int	hashCode () Returns an integer hash code for this object.
final void	notify () Causes a thread which is waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
final void	notifyAll () Causes all threads which are waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
String	toString () Returns a string containing a concise, human-readable description of this object.
final void	wait () Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object.
final void	wait (long millis, int nanos) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.
final void	wait (long millis) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.

Constants

public static final String KEY_HAS_SET_DEFAULT_VALUES

Added in API level 1

Constant Value: "_has_set_default_values"

public static final String METADATA_KEY_PREFERENCES

Added in API level 1

The Activity meta-data key for its XML preference hierarchy.

Constant Value: "android.preference"

Public Methods

public PreferenceScreen createPreferenceScreen ( Context context)

Added in API level 1

public Preference findPreference ( CharSequence key)

Added in API level 1

Finds a Preference based on its key.

Parameters

key	The key of the preference to retrieve.

Returns

The Preference with the key, or null.

public static SharedPreferences getDefaultSharedPreferences ( Context context)

Added in API level 1

Gets a SharedPreferences instance that points to the default file that is used by the preference framework in the given context.

Parameters

context	The context of the preferences whose values are wanted.

Returns

A SharedPreferences instance that can be used to retrieve and listen to values of the preferences.

public SharedPreferences getSharedPreferences ()

Added in API level 1

Gets a SharedPreferences instance that preferences managed by this will use.

Returns

A SharedPreferences instance pointing to the file that contains the values of preferences that are managed by this.

public int getSharedPreferencesMode ()

Added in API level 1

Returns the current mode of the SharedPreferences file that preferences managed by this will use.

Returns

The mode that can be passed to getSharedPreferences(String, int) .

public String getSharedPreferencesName ()

Added in API level 1

Returns the current name of the SharedPreferences file that preferences managed by this will use.

Returns

The name that can be passed to getSharedPreferences(String, int) .

public static void setDefaultValues ( Context context, String sharedPreferencesName, int sharedPreferencesMode, int resId, boolean readAgain)

Added in API level 1

Similar to setDefaultValues(Context, int, boolean) but allows the client to provide the filename and mode of the shared preferences file.

Parameters

context	The context of the shared preferences.
sharedPreferencesName	A custom name for the shared preferences file.
sharedPreferencesMode	The file creation mode for the shared preferences file, such as `MODE_PRIVATE` or `MODE_PRIVATE`
resId	The resource ID of the preference XML file.
readAgain	Whether to re-read the default values. If false, this method will set the default values only if this method has never been called in the past (or if the `KEY_HAS_SET_DEFAULT_VALUES` in the default value shared preferences file is false). To attempt to set the default values again bypassing this check, set `readAgain` to true. Note: this will NOT reset preferences back to their default values. For that functionality, use `getDefaultSharedPreferences(Context)` and clear it followed by a call to this method with this parameter set to true.

public static void setDefaultValues ( Context context, int resId, boolean readAgain)

Added in API level 1

Sets the default values from an XML preference file by reading the values defined by each Preference item's android:defaultValue attribute. This should be called by the application's main activity.

Parameters

context	The context of the shared preferences.
resId	The resource ID of the preference XML file.
readAgain	Whether to re-read the default values. If false, this method sets the default values only if this method has never been called in the past (or if the `KEY_HAS_SET_DEFAULT_VALUES` in the default value shared preferences file is false). To attempt to set the default values again bypassing this check, set `readAgain` to true. Note: this will NOT reset preferences back to their default values. For that functionality, use `getDefaultSharedPreferences(Context)` and clear it followed by a call to this method with this parameter set to true.

public void setSharedPreferencesMode (int sharedPreferencesMode)

Added in API level 1

Sets the mode of the SharedPreferences file that preferences managed by this will use.

Parameters

sharedPreferencesMode	The mode of the SharedPreferences file.

public void setSharedPreferencesName ( String sharedPreferencesName)

Added in API level 1

Sets the name of the SharedPreferences file that preferences managed by this will use.

Parameters

sharedPreferencesName	The name of the SharedPreferences file.

Results

Interfaces

Classes

PreferenceManager

Class Overview

See Also

Summary

Constants

public static final String KEY_HAS_SET_DEFAULT_VALUES

public static final String METADATA_KEY_PREFERENCES

Public Methods

public PreferenceScreen createPreferenceScreen ( Context context)

public Preference findPreference ( CharSequence key)

Parameters

Returns

See Also

public static SharedPreferences getDefaultSharedPreferences ( Context context)

Parameters

Returns

public SharedPreferences getSharedPreferences ()

Returns

public int getSharedPreferencesMode ()

Returns

See Also

public String getSharedPreferencesName ()

Returns

See Also

public static void setDefaultValues ( Context context, String sharedPreferencesName, int sharedPreferencesMode, int resId, boolean readAgain)

Parameters

See Also

public static void setDefaultValues ( Context context, int resId, boolean readAgain)

Parameters

public void setSharedPreferencesMode (int sharedPreferencesMode)

Parameters

See Also

public void setSharedPreferencesName ( String sharedPreferencesName)

Parameters

See Also