Skip to content

Most visited

Recently visited

navigation
Added in API level 1

RingtonePreference

public class RingtonePreference
extends Preference implements PreferenceManager.OnActivityResultListener

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


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

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'. 

Inherited XML attributes

From class android.preference.Preference

Inherited constants

From class android.preference.Preference

Public constructors

RingtonePreference(Context context, AttributeSet attrs, int defStyleAttr, int defStyleRes)
RingtonePreference(Context context, AttributeSet attrs, int defStyleAttr)
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.

Inherited methods

From class android.preference.Preference
From class java.lang.Object
From interface java.lang.Comparable
From interface android.preference.PreferenceManager.OnActivityResultListener

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.

ConstantValueDescription
ringtone1 Ringtones.
notification2 Notification sounds.
alarm4 Alarm sounds.
all7 All available ringtone sounds.

This corresponds to the global attribute resource symbol ringtoneType.

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.

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.

Public constructors

RingtonePreference

Added in API level 21
RingtonePreference (Context context, 
                AttributeSet attrs, 
                int defStyleAttr, 
                int defStyleRes)

Parameters
context Context
attrs AttributeSet
defStyleAttr int
defStyleRes int

RingtonePreference

Added in API level 1
RingtonePreference (Context context, 
                AttributeSet attrs, 
                int defStyleAttr)

Parameters
context Context
attrs AttributeSet
defStyleAttr int

RingtonePreference

Added in API level 1
RingtonePreference (Context context, 
                AttributeSet attrs)

Parameters
context Context
attrs AttributeSet

RingtonePreference

Added in API level 1
RingtonePreference (Context context)

Parameters
context Context

Public methods

getRingtoneType

Added in API level 1
int getRingtoneType ()

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

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

See also:

getShowDefault

Added in API level 1
boolean getShowDefault ()

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

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

getShowSilent

Added in API level 1
boolean getShowSilent ()

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

Returns
boolean Whether to show an item for 'Silent'.

onActivityResult

Added in API level 1
boolean onActivityResult (int requestCode, 
                int resultCode, 
                Intent data)

See Activity's onActivityResult.

Parameters
requestCode int
resultCode int
data Intent
Returns
boolean Whether the request code was handled (in which case subsequent listeners will not be called.

setRingtoneType

Added in API level 1
void setRingtoneType (int type)

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

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

See also:

setShowDefault

Added in API level 1
void setShowDefault (boolean showDefault)

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 boolean: Whether to show the default or not.

See also:

setShowSilent

Added in API level 1
void setShowSilent (boolean showSilent)

Sets whether to show an item for 'Silent'.

Parameters
showSilent boolean: Whether to show 'Silent'.

See also:

Protected methods

onAttachedToHierarchy

Added in API level 1
void onAttachedToHierarchy (PreferenceManager preferenceManager)

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

Parameters
preferenceManager PreferenceManager: The PreferenceManager of the hierarchy.

onClick

Added in API level 1
void onClick ()

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.

onGetDefaultValue

Added in API level 1
Object onGetDefaultValue (TypedArray a, 
                int index)

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 TypedArray: The set of attributes.
index int: The index of the default value attribute.
Returns
Object The default value of this preference type.

onPrepareRingtonePickerIntent

Added in API level 1
void onPrepareRingtonePickerIntent (Intent ringtonePickerIntent)

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

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

onRestoreRingtone

Added in API level 1
Uri onRestoreRingtone ()

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
Uri The ringtone to be marked as the current ringtone.

onSaveRingtone

Added in API level 1
void onSaveRingtone (Uri ringtoneUri)

Called when a ringtone is chosen.

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

Parameters
ringtoneUri Uri: The chosen ringtone's Uri. Can be null.

onSetInitialValue

Added in API level 1
void onSetInitialValue (boolean restorePersistedValue, 
                Object defaultValueObj)

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 boolean: True to restore the persisted value; false to use the given defaultValue.
defaultValueObj Object: The default value for this Preference. Only use this if restorePersistedValue is false.
This site uses cookies to store your preferences for site-specific language and display options.

Hooray!

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.