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)

Added in API level 1

public class

RingtonePreference

extends Preference
implements PreferenceManager.OnActivityResultListener

java.lang.Object
↳	android.preference.Preference
	↳	android.preference.RingtonePreference

Class Overview

A Preference that allows the user to choose a ringtone from those on the device. The chosen ringtone's URI will be persisted as a string.

If the user chooses the "Default" item, the saved string will be one of DEFAULT_RINGTONE_URI , DEFAULT_NOTIFICATION_URI , or DEFAULT_ALARM_ALERT_URI . If the user chooses the "Silent" item, the saved string will be an empty string.

Summary

XML Attributes
Attribute Name	Related Method	Description
android:ringtoneType		Which ringtone type(s) to show in the picker.
android:showDefault		Whether to show an item for a default sound.
android:showSilent		Whether to show an item for 'Silent'.

[Expand]

Inherited XML Attributes

From class android.preference.Preference

Attribute Name	Related Method	Description
android:defaultValue		The default value for the preference, which will be set either if persistence is off or persistence is on and the preference is not found in the persistent storage.
android:dependency		The key of another Preference that this Preference will depend on.
android:enabled		Whether the Preference is enabled.
android:fragment		When used inside of a modern PreferenceActivity, this declares a new PreferenceFragment to be shown when the user selects this item.
android:icon		The optional icon for the preference Must be a reference to another resource, in the form " `@[+][ package :] type : name` " or to a theme attribute in the form " `?[ package :][ type :] name` ".
android:key		The key to store the Preference value.
android:layout		The layout for the Preference in a PreferenceActivity screen.
android:order		The order for the Preference (lower values are to be ordered first).
android:persistent		Whether the Preference stores its value to the shared preferences.
android:selectable		Whether the Preference is selectable.
android:shouldDisableView		Whether the view of this Preference should be disabled when this Preference is disabled.
android:summary		The summary for the Preference in a PreferenceActivity screen.
android:title		The title for the Preference in a PreferenceActivity screen.
android:widgetLayout		The layout for the controllable widget portion of a Preference.

[Expand]

Inherited Constants

From class android.preference.Preference

Public Constructors
	RingtonePreference ( Context context, AttributeSet attrs, int defStyle)
	RingtonePreference ( Context context, AttributeSet attrs)
	RingtonePreference ( Context context)

Public Methods
int	getRingtoneType () Returns the sound type(s) that are shown in the picker.
boolean	getShowDefault () Returns whether to a show an item for the default sound/ringtone.
boolean	getShowSilent () Returns whether to a show an item for 'Silent'.
boolean	onActivityResult (int requestCode, int resultCode, Intent data) See Activity's onActivityResult.
void	setRingtoneType (int type) Sets the sound type(s) that are shown in the picker.
void	setShowDefault (boolean showDefault) Sets whether to show an item for the default sound/ringtone.
void	setShowSilent (boolean showSilent) Sets whether to show an item for 'Silent'.

Protected Methods
void	onAttachedToHierarchy ( PreferenceManager preferenceManager) Called when this Preference has been attached to a Preference hierarchy.
void	onClick () Processes a click on the preference.
Object	onGetDefaultValue ( TypedArray a, int index) Called when a Preference is being inflated and the default value attribute needs to be read.
void	onPrepareRingtonePickerIntent ( Intent ringtonePickerIntent) Prepares the intent to launch the ringtone picker.
Uri	onRestoreRingtone () Called when the chooser is about to be shown and the current ringtone should be marked.
void	onSaveRingtone ( Uri ringtoneUri) Called when a ringtone is chosen.
void	onSetInitialValue (boolean restorePersistedValue, Object defaultValueObj) Implement this to set the initial value of the Preference.

[Expand]

Inherited Methods

From class android.preference.Preference

boolean	callChangeListener ( Object newValue) Call this method after the user changes the preference, but before the internal state is set.
int	compareTo ( Preference another) Compares Preference objects based on order (if set), otherwise alphabetically on the titles.
Preference	findPreferenceInHierarchy ( String key) Finds a Preference in this hierarchy (the whole thing, even above/below your `PreferenceScreen` screen break) with the given key.
Context	getContext () Returns the `Context` of this Preference.
String	getDependency () Returns the key of the dependency on this Preference.
SharedPreferences.Editor	getEditor () Returns an `SharedPreferences.Editor` where this Preference can save its value(s).
Bundle	getExtras () Return the extras Bundle object associated with this preference, creating a new Bundle if there currently isn't one.
String	getFragment () Return the fragment class name associated with this Preference.
Drawable	getIcon () Returns the icon of this Preference.
Intent	getIntent () Return the `Intent` associated with this Preference.
String	getKey () Gets the key for this Preference, which is also the key used for storing values into SharedPreferences.
int	getLayoutResource () Gets the layout resource that will be shown as the `View` for this Preference.
Preference.OnPreferenceChangeListener	getOnPreferenceChangeListener () Returns the callback to be invoked when this Preference is changed by the user (but before the internal state has been updated).
Preference.OnPreferenceClickListener	getOnPreferenceClickListener () Returns the callback to be invoked when this Preference is clicked.
int	getOrder () Gets the order of this Preference with respect to other Preference objects on the same level.
boolean	getPersistedBoolean (boolean defaultReturnValue) Attempts to get a persisted boolean from the `SharedPreferences` .
float	getPersistedFloat (float defaultReturnValue) Attempts to get a persisted float from the `SharedPreferences` .
int	getPersistedInt (int defaultReturnValue) Attempts to get a persisted int from the `SharedPreferences` .
long	getPersistedLong (long defaultReturnValue) Attempts to get a persisted long from the `SharedPreferences` .
String	getPersistedString ( String defaultReturnValue) Attempts to get a persisted String from the `SharedPreferences` .
PreferenceManager	getPreferenceManager () Gets the `PreferenceManager` that manages this Preference object's tree.
SharedPreferences	getSharedPreferences () Returns the `SharedPreferences` where this Preference can read its value(s).
boolean	getShouldDisableView () Checks whether this Preference should disable its view when it's action is disabled.
CharSequence	getSummary () Returns the summary of this Preference.
CharSequence	getTitle () Returns the title of this Preference.
int	getTitleRes () Returns the title resource ID of this Preference.
View	getView ( View convertView, ViewGroup parent) Gets the View that will be shown in the `PreferenceActivity` .
int	getWidgetLayoutResource () Gets the layout resource for the controllable widget portion of this Preference.
boolean	hasKey () Checks whether this Preference has a valid key.
boolean	isEnabled () Checks whether this Preference should be enabled in the list.
boolean	isPersistent () Checks whether this Preference is persistent.
boolean	isSelectable () Checks whether this Preference should be selectable in the list.
void	notifyChanged () Should be called when the data of this `Preference` has changed.
void	notifyDependencyChange (boolean disableDependents) Notifies any listening dependents of a change that affects the dependency.
void	notifyHierarchyChanged () Should be called when a Preference has been added/removed from this group, or the ordering should be re-evaluated.
void	onAttachedToActivity () Called when the Preference hierarchy has been attached to the `PreferenceActivity` .
void	onAttachedToHierarchy ( PreferenceManager preferenceManager) Called when this Preference has been attached to a Preference hierarchy.
void	onBindView ( View view) Binds the created View to the data for this Preference.
void	onClick () Processes a click on the preference.
View	onCreateView ( ViewGroup parent) Creates the View to be shown for this Preference in the `PreferenceActivity` .
void	onDependencyChanged ( Preference dependency, boolean disableDependent) Called when the dependency changes.
Object	onGetDefaultValue ( TypedArray a, int index) Called when a Preference is being inflated and the default value attribute needs to be read.
void	onParentChanged ( Preference parent, boolean disableChild) Called when the implicit parent dependency changes.
void	onPrepareForRemoval () Called when this Preference is being removed from the hierarchy.
void	onRestoreInstanceState ( Parcelable state) Hook allowing a Preference to re-apply a representation of its internal state that had previously been generated by `onSaveInstanceState()` .
Parcelable	onSaveInstanceState () Hook allowing a Preference to generate a representation of its internal state that can later be used to create a new instance with that same state.
void	onSetInitialValue (boolean restorePersistedValue, Object defaultValue) Implement this to set the initial value of the Preference.
Bundle	peekExtras () Return the extras Bundle object associated with this preference, returning null if there is not currently one.
boolean	persistBoolean (boolean value) Attempts to persist a boolean to the `SharedPreferences` .
boolean	persistFloat (float value) Attempts to persist a float to the `SharedPreferences` .
boolean	persistInt (int value) Attempts to persist an int to the `SharedPreferences` .
boolean	persistLong (long value) Attempts to persist a long to the `SharedPreferences` .
boolean	persistString ( String value) Attempts to persist a String to the `SharedPreferences` .
void	restoreHierarchyState ( Bundle container) Restore this Preference hierarchy's previously saved state from the given container.
void	saveHierarchyState ( Bundle container) Store this Preference hierarchy's frozen state into the given container.
void	setDefaultValue ( Object defaultValue) Sets the default value for this Preference, which will be set either if persistence is off or persistence is on and the preference is not found in the persistent storage.
void	setDependency ( String dependencyKey) Sets the key of a Preference that this Preference will depend on.
void	setEnabled (boolean enabled) Sets whether this Preference is enabled.
void	setFragment ( String fragment) Sets the class name of a fragment to be shown when this Preference is clicked.
void	setIcon ( Drawable icon) Sets the icon for this Preference with a Drawable.
void	setIcon (int iconResId) Sets the icon for this Preference with a resource ID.
void	setIntent ( Intent intent) Sets an `Intent` to be used for `startActivity(Intent)` when this Preference is clicked.
void	setKey ( String key) Sets the key for this Preference, which is used as a key to the `SharedPreferences` .
void	setLayoutResource (int layoutResId) Sets the layout resource that is inflated as the `View` to be shown for this Preference.
void	setOnPreferenceChangeListener ( Preference.OnPreferenceChangeListener onPreferenceChangeListener) Sets the callback to be invoked when this Preference is changed by the user (but before the internal state has been updated).
void	setOnPreferenceClickListener ( Preference.OnPreferenceClickListener onPreferenceClickListener) Sets the callback to be invoked when this Preference is clicked.
void	setOrder (int order) Sets the order of this Preference with respect to other Preference objects on the same level.
void	setPersistent (boolean persistent) Sets whether this Preference is persistent.
void	setSelectable (boolean selectable) Sets whether this Preference is selectable.
void	setShouldDisableView (boolean shouldDisableView) Sets whether this Preference should disable its view when it gets disabled.
void	setSummary (int summaryResId) Sets the summary for this Preference with a resource ID.
void	setSummary ( CharSequence summary) Sets the summary for this Preference with a CharSequence.
void	setTitle (int titleResId) Sets the title for this Preference with a resource ID.
void	setTitle ( CharSequence title) Sets the title for this Preference with a CharSequence.
void	setWidgetLayoutResource (int widgetLayoutResId) Sets the layout for the controllable widget portion of this Preference.
boolean	shouldCommit () Returns whether the `Preference` should commit its saved value(s) in `getEditor()` .
boolean	shouldDisableDependents () Checks whether this preference's dependents should currently be disabled.
boolean	shouldPersist () Checks whether, at the given time this method is called, this Preference should store/restore its value(s) into the `SharedPreferences` .
String	toString () Returns a string containing a concise, human-readable description of this object.

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.

From interface android.preference.PreferenceManager.OnActivityResultListener

From interface java.lang.Comparable

XML Attributes

android:ringtoneType

Which ringtone type(s) to show in the picker.

Must be one or more (separated by '|') of the following constant values.

Constant	Value	Description
`ringtone`	1	Ringtones.
`notification`	2	Notification sounds.
`alarm`	4	Alarm sounds.
`all`	7	All available ringtone sounds.

This corresponds to the global attribute resource symbol ringtoneType .

Related Methods

android:showDefault

Whether to show an item for a default sound.

Must be a boolean value, either " true " or " false ".

This may also be a reference to a resource (in the form " @[ package :] type : name ") or theme attribute (in the form " ?[ package :][ type :] name ") containing a value of this type.

This corresponds to the global attribute resource symbol showDefault .

Related Methods

android:showSilent

Whether to show an item for 'Silent'.

Must be a boolean value, either " true " or " false ".

This may also be a reference to a resource (in the form " @[ package :] type : name ") or theme attribute (in the form " ?[ package :][ type :] name ") containing a value of this type.

This corresponds to the global attribute resource symbol showSilent .

Related Methods

Public Constructors

public RingtonePreference ( Context context, AttributeSet attrs, int defStyle)

Added in API level 1

public RingtonePreference ( Context context, AttributeSet attrs)

Added in API level 1

public RingtonePreference ( Context context)

Added in API level 1

Public Methods

public int getRingtoneType ()

Added in API level 1

Returns the sound type(s) that are shown in the picker.

Returns

The sound type(s) that are shown in the picker.

public boolean getShowDefault ()

Added in API level 1

Returns whether to a show an item for the default sound/ringtone.

Returns

Whether to show an item for the default sound/ringtone.

public boolean getShowSilent ()

Added in API level 1

Returns whether to a show an item for 'Silent'.

Returns

Whether to show an item for 'Silent'.

public boolean onActivityResult (int requestCode, int resultCode, Intent data)

Added in API level 1

See Activity's onActivityResult.

Returns

Whether the request code was handled (in which case subsequent listeners will not be called.

public void setRingtoneType (int type)

Added in API level 1

Sets the sound type(s) that are shown in the picker.

Parameters

type	The sound type(s) that are shown in the picker.

public void setShowDefault (boolean showDefault)

Added in API level 1

Sets whether to show an item for the default sound/ringtone. The default to use will be deduced from the sound type(s) being shown.

Parameters

showDefault	Whether to show the default or not.

public void setShowSilent (boolean showSilent)

Added in API level 1

Sets whether to show an item for 'Silent'.

Parameters

showSilent	Whether to show 'Silent'.

Protected Methods

protected void onAttachedToHierarchy ( PreferenceManager preferenceManager)

Added in API level 1

Called when this Preference has been attached to a Preference hierarchy. Make sure to call the super implementation.

Parameters

preferenceManager	The PreferenceManager of the hierarchy.

protected void onClick ()

Added in API level 1

Processes a click on the preference. This includes saving the value to the SharedPreferences . However, the overridden method should call callChangeListener(Object) to make sure the client wants to update the preference's state with the new value.

protected Object onGetDefaultValue ( TypedArray a, int index)

Added in API level 1

Called when a Preference is being inflated and the default value attribute needs to be read. Since different Preference types have different value types, the subclass should get and return the default value which will be its value type.

For example, if the value type is String, the body of the method would proxy to getString(int) .

Parameters

a	The set of attributes.
index	The index of the default value attribute.

Returns

The default value of this preference type.

protected void onPrepareRingtonePickerIntent ( Intent ringtonePickerIntent)

Added in API level 1

Prepares the intent to launch the ringtone picker. This can be modified to adjust the parameters of the ringtone picker.

Parameters

ringtonePickerIntent	The ringtone picker intent that can be modified by putting extras.

protected Uri onRestoreRingtone ()

Added in API level 1

Called when the chooser is about to be shown and the current ringtone should be marked. Can return null to not mark any ringtone.

By default, this restores the previous ringtone URI from the persistent storage.

Returns

The ringtone to be marked as the current ringtone.

protected void onSaveRingtone ( Uri ringtoneUri)

Added in API level 1

Called when a ringtone is chosen.

By default, this saves the ringtone URI to the persistent storage as a string.

Parameters

ringtoneUri	The chosen ringtone's `Uri` . Can be null.

protected void onSetInitialValue (boolean restorePersistedValue, Object defaultValueObj)

Added in API level 1

Implement this to set the initial value of the Preference.

If restorePersistedValue is true, you should restore the Preference value from the SharedPreferences . If restorePersistedValue is false, you should set the Preference value to defaultValue that is given (and possibly store to SharedPreferences if shouldPersist() is true).

This may not always be called. One example is if it should not persist but there is no default value given.

Parameters

restorePersistedValue	True to restore the persisted value; false to use the given `defaultValue` .
defaultValueObj	The default value for this Preference. Only use this if `restorePersistedValue` is false.

Results

Interfaces

Classes

RingtonePreference

Class Overview

Summary

XML Attributes

android:ringtoneType

Related Methods

android:showDefault

Related Methods

android:showSilent

Related Methods

Public Constructors

public RingtonePreference ( Context context, AttributeSet attrs, int defStyle)

public RingtonePreference ( Context context, AttributeSet attrs)

public RingtonePreference ( Context context)

Public Methods

public int getRingtoneType ()

Returns

See Also

public boolean getShowDefault ()

Returns

public boolean getShowSilent ()

Returns

public boolean onActivityResult (int requestCode, int resultCode, Intent data)

Returns

public void setRingtoneType (int type)

Parameters

See Also

public void setShowDefault (boolean showDefault)

Parameters

See Also

public void setShowSilent (boolean showSilent)

Parameters

See Also

Protected Methods

protected void onAttachedToHierarchy ( PreferenceManager preferenceManager)

Parameters

protected void onClick ()

protected Object onGetDefaultValue ( TypedArray a, int index)

Parameters

Returns

protected void onPrepareRingtonePickerIntent ( Intent ringtonePickerIntent)

Parameters

protected Uri onRestoreRingtone ()

Returns

protected void onSaveRingtone ( Uri ringtoneUri)

Parameters

protected void onSetInitialValue (boolean restorePersistedValue, Object defaultValueObj)

Parameters