android.preference.PreferenceManager
Summary
Constants
Public Methods
clone,
equals,
finalize,
getClass,
hashCode,
notify,
notifyAll,
toString,
wait,
wait,
wait
Details
Constants
public
static
final
String
KEY_HAS_SET_DEFAULT_VALUES
Constant Value:
"_has_set_default_values"
public
static
final
String
METADATA_KEY_PREFERENCES
The Activity meta-data key for its XML preference hierarchy.
Constant Value:
"android.preference"
Public Methods
Finds a
Preference based on its key.
Parameters
key
| The key of the preference to retrieve. |
public
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.
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.
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()
Returns the current mode of the SharedPreferences file that preferences managed by
this will use.
public
String
getSharedPreferencesName()
Returns the current name of the SharedPreferences file that preferences managed by
this will use.
public
static
void
setDefaultValues(Context context, int resId, boolean readAgain)
Sets the default values from a preference hierarchy in XML. This should
be called by the application's main activity.
If readAgain
is false, this will only set the default values if this
method has never been called in the past (or 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.
Parameters
context
| The context of the shared preferences. |
resId
| The resource ID of the preference hierarchy XML file. |
readAgain
| Whether to re-read the default values.
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, String sharedPreferencesName, int sharedPreferencesMode, int resId, boolean readAgain)
public
void
setSharedPreferencesMode(int sharedPreferencesMode)
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)
Sets the name of the SharedPreferences file that preferences managed by this
will use.
Parameters
sharedPreferencesName
| The name of the SharedPreferences file. |