Most visited

Recently visited

Results for

Added in API level 1

PreferenceActivity

public abstract class PreferenceActivity
extends ListActivity implements PreferenceFragment.OnPreferenceStartFragmentCallback

java.lang.Object
↳	android.content.Context
	↳	android.content.ContextWrapper
		↳	android.view.ContextThemeWrapper
			↳	android.app.Activity
				↳	android.app.ListActivity
					↳	android.preference.PreferenceActivity

This is the base class for an activity to show a hierarchy of preferences to the user. Prior to HONEYCOMB this class only allowed the display of a single set of preference; this functionality should now be found in the new PreferenceFragment class. If you are using PreferenceActivity in its old mode, the documentation there applies to the deprecated APIs here.

This activity shows one or more headers of preferences, each of which is associated with a PreferenceFragment to display the preferences of that header. The actual layout and display of these associations can however vary; currently there are two major approaches it may take:

On a small screen it may display only the headers as a single list when first launched. Selecting one of the header items will re-launch the activity with it only showing the PreferenceFragment of that header.
On a large screen in may display both the headers and current PreferenceFragment together as panes. Selecting a header item switches to showing the correct PreferenceFragment for that item.

Subclasses of PreferenceActivity should implement onBuildHeaders(List) to populate the header list with the desired items. Doing this implicitly switches the class into its new "headers + fragments" mode rather than the old style of just showing a single preferences list.

Developer Guides

For information about using PreferenceActivity, read the Settings guide.

Sample Code

The following sample code shows a simple preference activity that has two different sets of preferences. The implementation, consisting of the activity itself as well as its two preference fragments is:

public class PreferenceWithHeaders extends PreferenceActivity {
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);

        // Add a button to the header list.
        if (hasHeaders()) {
            Button button = new Button(this);
            button.setText("Some action");
            setListFooter(button);
        }
    }

    /**
     * Populate the activity with the top-level headers.
     */
    @Override
    public void onBuildHeaders(List<Header> target) {
        loadHeadersFromResource(R.xml.preference_headers, target);
    }

    /**
     * This fragment shows the preferences for the first header.
     */
    public static class Prefs1Fragment extends PreferenceFragment {
        @Override
        public void onCreate(Bundle savedInstanceState) {
            super.onCreate(savedInstanceState);

            // Make sure default values are applied.  In a real app, you would
            // want this in a shared function that is used to retrieve the
            // SharedPreferences wherever they are needed.
            PreferenceManager.setDefaultValues(getActivity(),
                    R.xml.advanced_preferences, false);

            // Load the preferences from an XML resource
            addPreferencesFromResource(R.xml.fragmented_preferences);
        }
    }

    /**
     * This fragment contains a second-level set of preference that you
     * can get to by tapping an item in the first preferences fragment.
     */
    public static class Prefs1FragmentInner extends PreferenceFragment {
        @Override
        public void onCreate(Bundle savedInstanceState) {
            super.onCreate(savedInstanceState);

            // Can retrieve arguments from preference XML.
            Log.i("args", "Arguments: " + getArguments());

            // Load the preferences from an XML resource
            addPreferencesFromResource(R.xml.fragmented_preferences_inner);
        }
    }

    /**
     * This fragment shows the preferences for the second header.
     */
    public static class Prefs2Fragment extends PreferenceFragment {
        @Override
        public void onCreate(Bundle savedInstanceState) {
            super.onCreate(savedInstanceState);

            // Can retrieve arguments from headers XML.
            Log.i("args", "Arguments: " + getArguments());

            // Load the preferences from an XML resource
            addPreferencesFromResource(R.xml.preference_dependencies);
        }
    }
}

The preference_headers resource describes the headers to be displayed and the fragments associated with them. It is:

<preference-headers
        xmlns:android="http://schemas.android.com/apk/res/android">

    <header android:fragment="com.example.android.apis.preference.PreferenceWithHeaders$Prefs1Fragment"
            android:icon="@drawable/ic_settings_applications"
            android:title="Prefs 1"
            android:summary="An example of some preferences." />

    <header android:fragment="com.example.android.apis.preference.PreferenceWithHeaders$Prefs2Fragment"
            android:icon="@drawable/ic_settings_display"
            android:title="Prefs 2"
            android:summary="Some other preferences you can see.">
        <!-- Arbitrary key/value pairs can be included with a header as
             arguments to its fragment. -->
        <extra android:name="someKey" android:value="someHeaderValue" />
    </header>

    <header android:icon="@drawable/ic_settings_display"
            android:title="Intent"
            android:summary="Launches an Intent.">
        <intent android:action="android.intent.action.VIEW"
                android:data="http://www.android.com" />
    </header>

</preference-headers>

The first header is shown by Prefs1Fragment, which populates itself from the following XML resource:

<PreferenceScreen
        xmlns:android="http://schemas.android.com/apk/res/android">

    <PreferenceCategory
            android:title="@string/inline_preferences">

        <CheckBoxPreference
                android:key="checkbox_preference"
                android:title="@string/title_checkbox_preference"
                android:summary="@string/summary_checkbox_preference" />

    </PreferenceCategory>

    <PreferenceCategory
            android:title="@string/dialog_based_preferences">

        <EditTextPreference
                android:key="edittext_preference"
                android:title="@string/title_edittext_preference"
                android:summary="@string/summary_edittext_preference"
                android:dialogTitle="@string/dialog_title_edittext_preference" />

        <ListPreference
                android:key="list_preference"
                android:title="@string/title_list_preference"
                android:summary="@string/summary_list_preference"
                android:entries="@array/entries_list_preference"
                android:entryValues="@array/entryvalues_list_preference"
                android:dialogTitle="@string/dialog_title_list_preference" />

    </PreferenceCategory>

    <PreferenceCategory
            android:title="@string/launch_preferences">

        <!-- This PreferenceScreen tag sends the user to a new fragment of
             preferences.  If running in a large screen, they can be embedded
             inside of the overall preferences UI. -->
        <PreferenceScreen
                android:fragment="com.example.android.apis.preference.PreferenceWithHeaders$Prefs1FragmentInner"
                android:title="@string/title_fragment_preference"
                android:summary="@string/summary_fragment_preference">
            <!-- Arbitrary key/value pairs can be included for fragment arguments -->
            <extra android:name="someKey" android:value="somePrefValue" />
        </PreferenceScreen>

        <!-- This PreferenceScreen tag sends the user to a completely different
             activity, switching out of the current preferences UI. -->
        <PreferenceScreen
                android:title="@string/title_intent_preference"
                android:summary="@string/summary_intent_preference">

            <intent android:action="android.intent.action.VIEW"
                    android:data="http://www.android.com" />

        </PreferenceScreen>

    </PreferenceCategory>

    <PreferenceCategory
            android:title="@string/preference_attributes">

        <CheckBoxPreference
                android:key="parent_checkbox_preference"
                android:title="@string/title_parent_preference"
                android:summary="@string/summary_parent_preference" />

        <!-- The visual style of a child is defined by this styled theme attribute. -->
        <CheckBoxPreference
                android:key="child_checkbox_preference"
                android:dependency="parent_checkbox_preference"
                android:layout="?android:attr/preferenceLayoutChild"
                android:title="@string/title_child_preference"
                android:summary="@string/summary_child_preference" />

    </PreferenceCategory>

</PreferenceScreen>

Note that this XML resource contains a preference screen holding another fragment, the Prefs1FragmentInner implemented here. This allows the user to traverse down a hierarchy of preferences; pressing back will pop each fragment off the stack to return to the previous preferences.

See PreferenceFragment for information on implementing the fragments themselves.

Summary

Nested classes
`class`	`PreferenceActivity.Header` Description of a single Header item that the user can select.

Constants
`String`	`EXTRA_NO_HEADERS` When starting this activity, the invoking Intent can contain this extra boolean that the header list should not be displayed.
`String`	`EXTRA_SHOW_FRAGMENT` When starting this activity, the invoking Intent can contain this extra string to specify which fragment should be initially displayed.
`String`	`EXTRA_SHOW_FRAGMENT_ARGUMENTS` When starting this activity and using `EXTRA_SHOW_FRAGMENT`, this extra can also be specified to supply a Bundle of arguments to pass to that fragment when it is instantiated during the initial creation of PreferenceActivity.
`String`	`EXTRA_SHOW_FRAGMENT_SHORT_TITLE` When starting this activity and using `EXTRA_SHOW_FRAGMENT`, this extra can also be specify to supply the short title to be shown for that fragment.
`String`	`EXTRA_SHOW_FRAGMENT_TITLE` When starting this activity and using `EXTRA_SHOW_FRAGMENT`, this extra can also be specify to supply the title to be shown for that fragment.
`long`	`HEADER_ID_UNDEFINED` Default value for `Header.id` indicating that no identifier value is set.

Inherited constants

From class


    android.app.Activity

From class


    android.content.Context

From interface


    android.content.ComponentCallbacks2

Inherited fields

From class


    android.app.Activity

Public constructors
`PreferenceActivity()`

Public methods
`void`	`addPreferencesFromIntent(Intent intent)` This method was deprecated in API level 11. This function is not relevant for a modern fragment-based PreferenceActivity.
`void`	`addPreferencesFromResource(int preferencesResId)` This method was deprecated in API level 11. This function is not relevant for a modern fragment-based PreferenceActivity.
`Preference`	`findPreference(CharSequence key)` This method was deprecated in API level 11. This function is not relevant for a modern fragment-based PreferenceActivity.
`void`	`finishPreferencePanel(Fragment caller, int resultCode, Intent resultData)` Called by a preference panel fragment to finish itself.
`PreferenceManager`	`getPreferenceManager()` This method was deprecated in API level 11. This function is not relevant for a modern fragment-based PreferenceActivity.
`PreferenceScreen`	`getPreferenceScreen()` This method was deprecated in API level 11. This function is not relevant for a modern fragment-based PreferenceActivity.
`boolean`	`hasHeaders()` Returns true if this activity is currently showing the header list.
`void`	`invalidateHeaders()` Call when you need to change the headers being displayed.
`boolean`	`isMultiPane()` Returns true if this activity is showing multiple panes -- the headers and a preference fragment.
`void`	`loadHeadersFromResource(int resid, List<PreferenceActivity.Header> target)` Parse the given XML file as a header description, adding each parsed Header into the target list.
`void`	`onBuildHeaders(List<PreferenceActivity.Header> target)` Called when the activity needs its list of headers build.
`Intent`	`onBuildStartFragmentIntent(String fragmentName, Bundle args, int titleRes, int shortTitleRes)` Called by `startWithFragment(String, Bundle, Fragment, int, int, int)` when in single-pane mode, to build an Intent to launch a new activity showing the selected fragment.
`void`	`onContentChanged()` Updates the screen state (current list and other views) when the content changes.
`PreferenceActivity.Header`	`onGetInitialHeader()` Called to determine the initial header to be shown.
`PreferenceActivity.Header`	`onGetNewHeader()` Called after the header list has been updated (`onBuildHeaders(List)` has been called and returned due to `invalidateHeaders()`) to specify the header that should now be selected.
`void`	`onHeaderClick(PreferenceActivity.Header header, int position)` Called when the user selects an item in the header list.
`boolean`	`onIsHidingHeaders()` Called to determine whether the header list should be hidden.
`boolean`	`onIsMultiPane()` Called to determine if the activity should run in multi-pane mode.
`boolean`	`onPreferenceStartFragment(PreferenceFragment caller, Preference pref)` Called when the user has clicked on a Preference that has a fragment class name associated with it.
`boolean`	`onPreferenceTreeClick(PreferenceScreen preferenceScreen, Preference preference)` This method was deprecated in API level 11. This function is not relevant for a modern fragment-based PreferenceActivity.
`void`	`setListFooter(View view)` Set a footer that should be shown at the bottom of the header list.
`void`	`setParentTitle(CharSequence title, CharSequence shortTitle, View.OnClickListener listener)` Should be called after onCreate to ensure that the breadcrumbs, if any, were created.
`void`	`setPreferenceScreen(PreferenceScreen preferenceScreen)` This method was deprecated in API level 11. This function is not relevant for a modern fragment-based PreferenceActivity.
`void`	`showBreadCrumbs(CharSequence title, CharSequence shortTitle)` Change the base title of the bread crumbs for the current preferences.
`void`	`startPreferenceFragment(Fragment fragment, boolean push)` Start a new fragment.
`void`	`startPreferencePanel(String fragmentClass, Bundle args, int titleRes, CharSequence titleText, Fragment resultTo, int resultRequestCode)` Start a new fragment containing a preference panel.
`void`	`startWithFragment(String fragmentName, Bundle args, Fragment resultTo, int resultRequestCode, int titleRes, int shortTitleRes)` Start a new instance of this activity, showing only the given preference fragment.
`void`	`startWithFragment(String fragmentName, Bundle args, Fragment resultTo, int resultRequestCode)` Like `startWithFragment(String, Bundle, Fragment, int, int, int)` but uses a 0 titleRes.
`void`	`switchToHeader(String fragmentName, Bundle args)` When in two-pane mode, switch the fragment pane to show the given preference fragment.
`void`	`switchToHeader(PreferenceActivity.Header header)` When in two-pane mode, switch to the fragment pane to show the given preference fragment.

Protected methods
`boolean`	`isValidFragment(String fragmentName)` Subclasses should override this method and verify that the given fragment is a valid type to be attached to this activity.
`void`	`onActivityResult(int requestCode, int resultCode, Intent data)` Called when an activity you launched exits, giving you the requestCode you started it with, the resultCode it returned, and any additional data from it.
`void`	`onCreate(Bundle savedInstanceState)` Called when the activity is starting.
`void`	`onDestroy()` Perform any final cleanup before an activity is destroyed.
`void`	`onListItemClick(ListView l, View v, int position, long id)` This method will be called when an item in the list is selected.
`void`	`onNewIntent(Intent intent)` This is called for activities that set launchMode to "singleTop" in their package, or if a client used the `FLAG_ACTIVITY_SINGLE_TOP` flag when calling `startActivity(Intent)`.
`void`	`onRestoreInstanceState(Bundle state)` Ensures the list view has been created before Activity restores all of the view states.
`void`	`onSaveInstanceState(Bundle outState)` Called to retrieve per-instance state from an activity before being killed so that the state can be restored in `onCreate(Bundle)` or `onRestoreInstanceState(Bundle)` (the `Bundle` populated by this method will be passed to both).
`void`	`onStop()` Called when you are no longer visible to the user.

Inherited methods

From class


  
    android.app.ListActivity

`ListAdapter`	`getListAdapter()` Get the ListAdapter associated with this activity's ListView.
`ListView`	`getListView()` Get the activity's list view widget.
`long`	`getSelectedItemId()` Get the cursor row ID of the currently selected list item.
`int`	`getSelectedItemPosition()` Get the position of the currently selected list item.
`void`	`onContentChanged()` Updates the screen state (current list and other views) when the content changes.
`void`	`onDestroy()` Perform any final cleanup before an activity is destroyed.
`void`	`onListItemClick(ListView l, View v, int position, long id)` This method will be called when an item in the list is selected.
`void`	`onRestoreInstanceState(Bundle state)` Ensures the list view has been created before Activity restores all of the view states.
`void`	`setListAdapter(ListAdapter adapter)` Provide the cursor for the list view.
`void`	`setSelection(int position)` Set the currently selected list item to the specified position with the adapter's data

From class


  
    android.app.Activity

From class


  
    android.view.ContextThemeWrapper

`void`	`applyOverrideConfiguration(Configuration overrideConfiguration)` Call to set an "override configuration" on this context -- this is a configuration that replies one or more values of the standard configuration that is applied to the context.
`void`	`attachBaseContext(Context newBase)` Set the base context for this ContextWrapper.
`AssetManager`	`getAssets()` Returns an AssetManager instance for the application's package.
`Resources`	`getResources()` Returns a Resources instance for the application's package.
`Object`	`getSystemService(String name)` Return the handle to a system-level service by name.
`Resources.Theme`	`getTheme()` Return the Theme object associated with this Context.
`void`	`onApplyThemeResource(Resources.Theme theme, int resId, boolean first)` Called by `setTheme(int)` and `getTheme()` to apply a theme resource to the current Theme object.
`void`	`setTheme(int resid)` Set the base theme for this context.

From class


  
    android.content.ContextWrapper

`void`	`attachBaseContext(Context base)` Set the base context for this ContextWrapper.
`boolean`	`bindService(Intent service, ServiceConnection conn, int flags)` Connect to an application service, creating it if needed.
`int`	`checkCallingOrSelfPermission(String permission)` Determine whether the calling process of an IPC or you have been granted a particular permission.
`int`	`checkCallingOrSelfUriPermission(Uri uri, int modeFlags)` Determine whether the calling process of an IPC or you has been granted permission to access a specific URI.
`int`	`checkCallingPermission(String permission)` Determine whether the calling process of an IPC you are handling has been granted a particular permission.
`int`	`checkCallingUriPermission(Uri uri, int modeFlags)` Determine whether the calling process and user ID has been granted permission to access a specific URI.
`int`	`checkPermission(String permission, int pid, int uid)` Determine whether the given permission is allowed for a particular process and user ID running in the system.
`int`	`checkSelfPermission(String permission)` Determine whether you have been granted a particular permission.
`int`	`checkUriPermission(Uri uri, String readPermission, String writePermission, int pid, int uid, int modeFlags)` Check both a Uri and normal permission.
`int`	`checkUriPermission(Uri uri, int pid, int uid, int modeFlags)` Determine whether a particular process and user ID has been granted permission to access a specific URI.
`void`	`clearWallpaper()` This method was deprecated in API level 23. Use `WallpaperManager.clear()` instead. This method requires the caller to hold the permission `SET_WALLPAPER`.
`Context`	`createConfigurationContext(Configuration overrideConfiguration)` Return a new Context object for the current Context but whose resources are adjusted to match the given Configuration.
`Context`	`createDeviceProtectedStorageContext()` Return a new Context object for the current Context but whose storage APIs are backed by device-protected storage.
`Context`	`createDisplayContext(Display display)` Return a new Context object for the current Context but whose resources are adjusted to match the metrics of the given Display.
`Context`	`createPackageContext(String packageName, int flags)` Return a new Context object for the given application name.
`String[]`	`databaseList()` Returns an array of strings naming the private databases associated with this Context's application package.
`boolean`	`deleteDatabase(String name)` Delete an existing private SQLiteDatabase associated with this Context's application package.
`boolean`	`deleteFile(String name)` Delete the given private file associated with this Context's application package.
`boolean`	`deleteSharedPreferences(String name)` Delete an existing shared preferences file.
`void`	`enforceCallingOrSelfPermission(String permission, String message)` If neither you nor the calling process of an IPC you are handling has been granted a particular permission, throw a `SecurityException`.
`void`	`enforceCallingOrSelfUriPermission(Uri uri, int modeFlags, String message)` If the calling process of an IPC or you has not been granted permission to access a specific URI, throw `SecurityException`.
`void`	`enforceCallingPermission(String permission, String message)` If the calling process of an IPC you are handling has not been granted a particular permission, throw a `SecurityException`.
`void`	`enforceCallingUriPermission(Uri uri, int modeFlags, String message)` If the calling process and user ID has not been granted permission to access a specific URI, throw `SecurityException`.
`void`	`enforcePermission(String permission, int pid, int uid, String message)` If the given permission is not allowed for a particular process and user ID running in the system, throw a `SecurityException`.
`void`	`enforceUriPermission(Uri uri, String readPermission, String writePermission, int pid, int uid, int modeFlags, String message)` Enforce both a Uri and normal permission.
`void`	`enforceUriPermission(Uri uri, int pid, int uid, int modeFlags, String message)` If a particular process and user ID has not been granted permission to access a specific URI, throw `SecurityException`.
`String[]`	`fileList()` Returns an array of strings naming the private files associated with this Context's application package.
`Context`	`getApplicationContext()` Return the context of the single, global Application object of the current process.
`ApplicationInfo`	`getApplicationInfo()` Return the full application info for this context's package.
`AssetManager`	`getAssets()` Returns an AssetManager instance for the application's package.
`Context`	`getBaseContext()`
`File`	`getCacheDir()` Returns the absolute path to the application specific cache directory on the filesystem.
`ClassLoader`	`getClassLoader()` Return a class loader you can use to retrieve classes in this package.
`File`	`getCodeCacheDir()` Returns the absolute path to the application specific cache directory on the filesystem designed for storing cached code.
`ContentResolver`	`getContentResolver()` Return a ContentResolver instance for your application's package.
`File`	`getDataDir()` Returns the absolute path to the directory on the filesystem where all private files belonging to this app are stored.
`File`	`getDatabasePath(String name)` Returns the absolute path on the filesystem where a database created with `openOrCreateDatabase(String, int, SQLiteDatabase.CursorFactory)` is stored.
`File`	`getDir(String name, int mode)` Retrieve, creating if needed, a new directory in which the application can place its own custom data files.
`File`	`getExternalCacheDir()` Returns absolute path to application-specific directory on the primary shared/external storage device where the application can place cache files it owns.
`File[]`	`getExternalCacheDirs()` Returns absolute paths to application-specific directories on all shared/external storage devices where the application can place cache files it owns.
`File`	`getExternalFilesDir(String type)` Returns the absolute path to the directory on the primary shared/external storage device where the application can place persistent files it owns.
`File[]`	`getExternalFilesDirs(String type)` Returns absolute paths to application-specific directories on all shared/external storage devices where the application can place persistent files it owns.
`File[]`	`getExternalMediaDirs()` Returns absolute paths to application-specific directories on all shared/external storage devices where the application can place media files.
`File`	`getFileStreamPath(String name)` Returns the absolute path on the filesystem where a file created with `openFileOutput(String, int)` is stored.
`File`	`getFilesDir()` Returns the absolute path to the directory on the filesystem where files created with `openFileOutput(String, int)` are stored.
`Looper`	`getMainLooper()` Return the Looper for the main thread of the current process.
`File`	`getNoBackupFilesDir()` Returns the absolute path to the directory on the filesystem similar to `getFilesDir()`.
`File`	`getObbDir()` Return the primary shared/external storage directory where this application's OBB files (if there are any) can be found.
`File[]`	`getObbDirs()` Returns absolute paths to application-specific directories on all shared/external storage devices where the application's OBB files (if there are any) can be found.
`String`	`getPackageCodePath()` Return the full path to this context's primary Android package.
`PackageManager`	`getPackageManager()` Return PackageManager instance to find global package information.
`String`	`getPackageName()` Return the name of this application's package.
`String`	`getPackageResourcePath()` Return the full path to this context's primary Android package.
`Resources`	`getResources()` Returns a Resources instance for the application's package.
`SharedPreferences`	`getSharedPreferences(String name, int mode)` Retrieve and hold the contents of the preferences file 'name', returning a SharedPreferences through which you can retrieve and modify its values.
`Object`	`getSystemService(String name)` Return the handle to a system-level service by name.
`String`	`getSystemServiceName(Class<?> serviceClass)` Gets the name of the system-level service that is represented by the specified class.
`Resources.Theme`	`getTheme()` Return the Theme object associated with this Context.
`Drawable`	`getWallpaper()` This method was deprecated in API level 23. Use `WallpaperManager.get()` instead.
`int`	`getWallpaperDesiredMinimumHeight()` This method was deprecated in API level 23. Use `WallpaperManager.getDesiredMinimumHeight()` instead.
`int`	`getWallpaperDesiredMinimumWidth()` This method was deprecated in API level 23. Use `WallpaperManager.getDesiredMinimumWidth()` instead.
`void`	`grantUriPermission(String toPackage, Uri uri, int modeFlags)` Grant permission to access a specific Uri to another package, regardless of whether that package has general permission to access the Uri's content provider.
`boolean`	`isDeviceProtectedStorage()` Indicates if the storage APIs of this Context are backed by device-protected storage.
`boolean`	`isRestricted()` Indicates whether this Context is restricted.
`boolean`	`moveDatabaseFrom(Context sourceContext, String name)` Move an existing database file from the given source storage context to this context.
`boolean`	`moveSharedPreferencesFrom(Context sourceContext, String name)` Move an existing shared preferences file from the given source storage context to this context.
`FileInputStream`	`openFileInput(String name)` Open a private file associated with this Context's application package for reading.
`FileOutputStream`	`openFileOutput(String name, int mode)` Open a private file associated with this Context's application package for writing.
`SQLiteDatabase`	`openOrCreateDatabase(String name, int mode, SQLiteDatabase.CursorFactory factory, DatabaseErrorHandler errorHandler)` Open a new private SQLiteDatabase associated with this Context's application package.
`SQLiteDatabase`	`openOrCreateDatabase(String name, int mode, SQLiteDatabase.CursorFactory factory)` Open a new private SQLiteDatabase associated with this Context's application package.
`Drawable`	`peekWallpaper()` This method was deprecated in API level 23. Use `WallpaperManager.peek()` instead.
`Intent`	`registerReceiver(BroadcastReceiver receiver, IntentFilter filter)` Register a BroadcastReceiver to be run in the main activity thread.
`Intent`	`registerReceiver(BroadcastReceiver receiver, IntentFilter filter, String broadcastPermission, Handler scheduler)` Register to receive intent broadcasts, to run in the context of `scheduler`.
`void`	`removeStickyBroadcast(Intent intent)` This method was deprecated in API level 23. Sticky broadcasts should not be used. They provide no security (anyone can access them), no protection (anyone can modify them), and many other problems. The recommended pattern is to use a non-sticky broadcast to report that something has changed, with another mechanism for apps to retrieve the current value whenever desired.
`void`	`removeStickyBroadcastAsUser(Intent intent, UserHandle user)` This method was deprecated in API level 23. Sticky broadcasts should not be used. They provide no security (anyone can access them), no protection (anyone can modify them), and many other problems. The recommended pattern is to use a non-sticky broadcast to report that something has changed, with another mechanism for apps to retrieve the current value whenever desired.
`void`	`revokeUriPermission(Uri uri, int modeFlags)` Remove all permissions to access a particular content provider Uri that were previously added with `grantUriPermission(String, Uri, int)`.
`void`	`sendBroadcast(Intent intent, String receiverPermission)` Broadcast the given intent to all interested BroadcastReceivers, allowing an optional required permission to be enforced.
`void`	`sendBroadcast(Intent intent)` Broadcast the given intent to all interested BroadcastReceivers.
`void`	`sendBroadcastAsUser(Intent intent, UserHandle user)` Version of `sendBroadcast(Intent)` that allows you to specify the user the broadcast will be sent to.
`void`	`sendBroadcastAsUser(Intent intent, UserHandle user, String receiverPermission)` Version of `sendBroadcast(Intent, String)` that allows you to specify the user the broadcast will be sent to.
`void`	`sendOrderedBroadcast(Intent intent, String receiverPermission, BroadcastReceiver resultReceiver, Handler scheduler, int initialCode, String initialData, Bundle initialExtras)` Version of `sendBroadcast(Intent)` that allows you to receive data back from the broadcast.
`void`	`sendOrderedBroadcast(Intent intent, String receiverPermission)` Broadcast the given intent to all interested BroadcastReceivers, delivering them one at a time to allow more preferred receivers to consume the broadcast before it is delivered to less preferred receivers.
`void`	`sendOrderedBroadcastAsUser(Intent intent, UserHandle user, String receiverPermission, BroadcastReceiver resultReceiver, Handler scheduler, int initialCode, String initialData, Bundle initialExtras)` Version of `sendOrderedBroadcast(Intent, String, BroadcastReceiver, Handler, int, String, Bundle)` that allows you to specify the user the broadcast will be sent to.
`void`	`sendStickyBroadcast(Intent intent)` This method was deprecated in API level 23. Sticky broadcasts should not be used. They provide no security (anyone can access them), no protection (anyone can modify them), and many other problems. The recommended pattern is to use a non-sticky broadcast to report that something has changed, with another mechanism for apps to retrieve the current value whenever desired.
`void`	`sendStickyBroadcastAsUser(Intent intent, UserHandle user)` This method was deprecated in API level 23. Sticky broadcasts should not be used. They provide no security (anyone can access them), no protection (anyone can modify them), and many other problems. The recommended pattern is to use a non-sticky broadcast to report that something has changed, with another mechanism for apps to retrieve the current value whenever desired.
`void`	`sendStickyOrderedBroadcast(Intent intent, BroadcastReceiver resultReceiver, Handler scheduler, int initialCode, String initialData, Bundle initialExtras)` This method was deprecated in API level 23. Sticky broadcasts should not be used. They provide no security (anyone can access them), no protection (anyone can modify them), and many other problems. The recommended pattern is to use a non-sticky broadcast to report that something has changed, with another mechanism for apps to retrieve the current value whenever desired.
`void`	`sendStickyOrderedBroadcastAsUser(Intent intent, UserHandle user, BroadcastReceiver resultReceiver, Handler scheduler, int initialCode, String initialData, Bundle initialExtras)` This method was deprecated in API level 23. Sticky broadcasts should not be used. They provide no security (anyone can access them), no protection (anyone can modify them), and many other problems. The recommended pattern is to use a non-sticky broadcast to report that something has changed, with another mechanism for apps to retrieve the current value whenever desired.
`void`	`setTheme(int resid)` Set the base theme for this context.
`void`	`setWallpaper(Bitmap bitmap)` This method was deprecated in API level 23. Use `WallpaperManager.set()` instead. This method requires the caller to hold the permission `SET_WALLPAPER`.
`void`	`setWallpaper(InputStream data)` This method was deprecated in API level 23. Use `WallpaperManager.set()` instead. This method requires the caller to hold the permission `SET_WALLPAPER`.
`void`	`startActivities(Intent[] intents, Bundle options)` Launch multiple new activities.
`void`	`startActivities(Intent[] intents)` Same as `startActivities(Intent[], Bundle)` with no options specified.
`void`	`startActivity(Intent intent)` Same as `startActivity(Intent, Bundle)` with no options specified.
`void`	`startActivity(Intent intent, Bundle options)` Launch a new activity.
`boolean`	`startInstrumentation(ComponentName className, String profileFile, Bundle arguments)` Start executing an `Instrumentation` class.
`void`	`startIntentSender(IntentSender intent, Intent fillInIntent, int flagsMask, int flagsValues, int extraFlags)` Same as `startIntentSender(IntentSender, Intent, int, int, int, Bundle)` with no options specified.
`void`	`startIntentSender(IntentSender intent, Intent fillInIntent, int flagsMask, int flagsValues, int extraFlags, Bundle options)` Like `startActivity(Intent, Bundle)`, but taking a IntentSender to start.
`ComponentName`	`startService(Intent service)` Request that a given application service be started.
`boolean`	`stopService(Intent name)` Request that a given application service be stopped.
`void`	`unbindService(ServiceConnection conn)` Disconnect from an application service.
`void`	`unregisterReceiver(BroadcastReceiver receiver)` Unregister a previously registered BroadcastReceiver.

From class


  
    android.content.Context

`abstract boolean`	`bindService(Intent service, ServiceConnection conn, int flags)` Connect to an application service, creating it if needed.
`abstract int`	`checkCallingOrSelfPermission(String permission)` Determine whether the calling process of an IPC or you have been granted a particular permission.
`abstract int`	`checkCallingOrSelfUriPermission(Uri uri, int modeFlags)` Determine whether the calling process of an IPC or you has been granted permission to access a specific URI.
`abstract int`	`checkCallingPermission(String permission)` Determine whether the calling process of an IPC you are handling has been granted a particular permission.
`abstract int`	`checkCallingUriPermission(Uri uri, int modeFlags)` Determine whether the calling process and user ID has been granted permission to access a specific URI.
`abstract int`	`checkPermission(String permission, int pid, int uid)` Determine whether the given permission is allowed for a particular process and user ID running in the system.
`abstract int`	`checkSelfPermission(String permission)` Determine whether you have been granted a particular permission.
`abstract int`	`checkUriPermission(Uri uri, String readPermission, String writePermission, int pid, int uid, int modeFlags)` Check both a Uri and normal permission.
`abstract int`	`checkUriPermission(Uri uri, int pid, int uid, int modeFlags)` Determine whether a particular process and user ID has been granted permission to access a specific URI.
`abstract void`	`clearWallpaper()` This method was deprecated in API level 5. Use `WallpaperManager.clear()` instead. This method requires the caller to hold the permission `SET_WALLPAPER`.
`abstract Context`	`createConfigurationContext(Configuration overrideConfiguration)` Return a new Context object for the current Context but whose resources are adjusted to match the given Configuration.
`abstract Context`	`createDeviceProtectedStorageContext()` Return a new Context object for the current Context but whose storage APIs are backed by device-protected storage.
`abstract Context`	`createDisplayContext(Display display)` Return a new Context object for the current Context but whose resources are adjusted to match the metrics of the given Display.
`abstract Context`	`createPackageContext(String packageName, int flags)` Return a new Context object for the given application name.
`abstract String[]`	`databaseList()` Returns an array of strings naming the private databases associated with this Context's application package.
`abstract boolean`	`deleteDatabase(String name)` Delete an existing private SQLiteDatabase associated with this Context's application package.
`abstract boolean`	`deleteFile(String name)` Delete the given private file associated with this Context's application package.
`abstract boolean`	`deleteSharedPreferences(String name)` Delete an existing shared preferences file.
`abstract void`	`enforceCallingOrSelfPermission(String permission, String message)` If neither you nor the calling process of an IPC you are handling has been granted a particular permission, throw a `SecurityException`.
`abstract void`	`enforceCallingOrSelfUriPermission(Uri uri, int modeFlags, String message)` If the calling process of an IPC or you has not been granted permission to access a specific URI, throw `SecurityException`.
`abstract void`	`enforceCallingPermission(String permission, String message)` If the calling process of an IPC you are handling has not been granted a particular permission, throw a `SecurityException`.
`abstract void`	`enforceCallingUriPermission(Uri uri, int modeFlags, String message)` If the calling process and user ID has not been granted permission to access a specific URI, throw `SecurityException`.
`abstract void`	`enforcePermission(String permission, int pid, int uid, String message)` If the given permission is not allowed for a particular process and user ID running in the system, throw a `SecurityException`.
`abstract void`	`enforceUriPermission(Uri uri, String readPermission, String writePermission, int pid, int uid, int modeFlags, String message)` Enforce both a Uri and normal permission.
`abstract void`	`enforceUriPermission(Uri uri, int pid, int uid, int modeFlags, String message)` If a particular process and user ID has not been granted permission to access a specific URI, throw `SecurityException`.
`abstract String[]`	`fileList()` Returns an array of strings naming the private files associated with this Context's application package.
`abstract Context`	`getApplicationContext()` Return the context of the single, global Application object of the current process.
`abstract ApplicationInfo`	`getApplicationInfo()` Return the full application info for this context's package.
`abstract AssetManager`	`getAssets()` Returns an AssetManager instance for the application's package.
`abstract File`	`getCacheDir()` Returns the absolute path to the application specific cache directory on the filesystem.
`abstract ClassLoader`	`getClassLoader()` Return a class loader you can use to retrieve classes in this package.
`abstract File`	`getCodeCacheDir()` Returns the absolute path to the application specific cache directory on the filesystem designed for storing cached code.
`final int`	`getColor(int id)` Returns a color associated with a particular resource ID and styled for the current theme.
`final ColorStateList`	`getColorStateList(int id)` Returns a color state list associated with a particular resource ID and styled for the current theme.
`abstract ContentResolver`	`getContentResolver()` Return a ContentResolver instance for your application's package.
`abstract File`	`getDataDir()` Returns the absolute path to the directory on the filesystem where all private files belonging to this app are stored.
`abstract File`	`getDatabasePath(String name)` Returns the absolute path on the filesystem where a database created with `openOrCreateDatabase(String, int, SQLiteDatabase.CursorFactory)` is stored.
`abstract File`	`getDir(String name, int mode)` Retrieve, creating if needed, a new directory in which the application can place its own custom data files.
`final Drawable`	`getDrawable(int id)` Returns a drawable object associated with a particular resource ID and styled for the current theme.
`abstract File`	`getExternalCacheDir()` Returns absolute path to application-specific directory on the primary shared/external storage device where the application can place cache files it owns.
`abstract File[]`	`getExternalCacheDirs()` Returns absolute paths to application-specific directories on all shared/external storage devices where the application can place cache files it owns.
`abstract File`	`getExternalFilesDir(String type)` Returns the absolute path to the directory on the primary shared/external storage device where the application can place persistent files it owns.
`abstract File[]`	`getExternalFilesDirs(String type)` Returns absolute paths to application-specific directories on all shared/external storage devices where the application can place persistent files it owns.
`abstract File[]`	`getExternalMediaDirs()` Returns absolute paths to application-specific directories on all shared/external storage devices where the application can place media files.
`abstract File`	`getFileStreamPath(String name)` Returns the absolute path on the filesystem where a file created with `openFileOutput(String, int)` is stored.
`abstract File`	`getFilesDir()` Returns the absolute path to the directory on the filesystem where files created with `openFileOutput(String, int)` are stored.
`abstract Looper`	`getMainLooper()` Return the Looper for the main thread of the current process.
`abstract File`	`getNoBackupFilesDir()` Returns the absolute path to the directory on the filesystem similar to `getFilesDir()`.
`abstract File`	`getObbDir()` Return the primary shared/external storage directory where this application's OBB files (if there are any) can be found.
`abstract File[]`	`getObbDirs()` Returns absolute paths to application-specific directories on all shared/external storage devices where the application's OBB files (if there are any) can be found.
`abstract String`	`getPackageCodePath()` Return the full path to this context's primary Android package.
`abstract PackageManager`	`getPackageManager()` Return PackageManager instance to find global package information.
`abstract String`	`getPackageName()` Return the name of this application's package.
`abstract String`	`getPackageResourcePath()` Return the full path to this context's primary Android package.
`abstract Resources`	`getResources()` Returns a Resources instance for the application's package.
`abstract SharedPreferences`	`getSharedPreferences(String name, int mode)` Retrieve and hold the contents of the preferences file 'name', returning a SharedPreferences through which you can retrieve and modify its values.
`final String`	`getString(int resId, Object... formatArgs)` Returns a localized formatted string from the application's package's default string table, substituting the format arguments as defined in `Formatter` and `format(String, Object...)`.
`final String`	`getString(int resId)` Returns a localized string from the application's package's default string table.
`final <T> T`	`getSystemService(Class<T> serviceClass)` Return the handle to a system-level service by class.
`abstract Object`	`getSystemService(String name)` Return the handle to a system-level service by name.
`abstract String`	`getSystemServiceName(Class<?> serviceClass)` Gets the name of the system-level service that is represented by the specified class.
`final CharSequence`	`getText(int resId)` Return a localized, styled CharSequence from the application's package's default string table.
`abstract Resources.Theme`	`getTheme()` Return the Theme object associated with this Context.
`abstract Drawable`	`getWallpaper()` This method was deprecated in API level 5. Use `WallpaperManager.get()` instead.
`abstract int`	`getWallpaperDesiredMinimumHeight()` This method was deprecated in API level 5. Use `WallpaperManager.getDesiredMinimumHeight()` instead.
`abstract int`	`getWallpaperDesiredMinimumWidth()` This method was deprecated in API level 5. Use `WallpaperManager.getDesiredMinimumWidth()` instead.
`abstract void`	`grantUriPermission(String toPackage, Uri uri, int modeFlags)` Grant permission to access a specific Uri to another package, regardless of whether that package has general permission to access the Uri's content provider.
`abstract boolean`	`isDeviceProtectedStorage()` Indicates if the storage APIs of this Context are backed by device-protected storage.
`boolean`	`isRestricted()` Indicates whether this Context is restricted.
`abstract boolean`	`moveDatabaseFrom(Context sourceContext, String name)` Move an existing database file from the given source storage context to this context.
`abstract boolean`	`moveSharedPreferencesFrom(Context sourceContext, String name)` Move an existing shared preferences file from the given source storage context to this context.
`final TypedArray`	`obtainStyledAttributes(AttributeSet set, int[] attrs)` Retrieve styled attribute information in this Context's theme.
`final TypedArray`	`obtainStyledAttributes(AttributeSet set, int[] attrs, int defStyleAttr, int defStyleRes)` Retrieve styled attribute information in this Context's theme.
`final TypedArray`	`obtainStyledAttributes(int resid, int[] attrs)` Retrieve styled attribute information in this Context's theme.
`final TypedArray`	`obtainStyledAttributes(int[] attrs)` Retrieve styled attribute information in this Context's theme.
`abstract FileInputStream`	`openFileInput(String name)` Open a private file associated with this Context's application package for reading.
`abstract FileOutputStream`	`openFileOutput(String name, int mode)` Open a private file associated with this Context's application package for writing.
`abstract SQLiteDatabase`	`openOrCreateDatabase(String name, int mode, SQLiteDatabase.CursorFactory factory, DatabaseErrorHandler errorHandler)` Open a new private SQLiteDatabase associated with this Context's application package.
`abstract SQLiteDatabase`	`openOrCreateDatabase(String name, int mode, SQLiteDatabase.CursorFactory factory)` Open a new private SQLiteDatabase associated with this Context's application package.
`abstract Drawable`	`peekWallpaper()` This method was deprecated in API level 5. Use `WallpaperManager.peek()` instead.
`void`	`registerComponentCallbacks(ComponentCallbacks callback)` Add a new `ComponentCallbacks` to the base application of the Context, which will be called at the same times as the ComponentCallbacks methods of activities and other components are called.
`abstract Intent`	`registerReceiver(BroadcastReceiver receiver, IntentFilter filter)` Register a BroadcastReceiver to be run in the main activity thread.
`abstract Intent`	`registerReceiver(BroadcastReceiver receiver, IntentFilter filter, String broadcastPermission, Handler scheduler)` Register to receive intent broadcasts, to run in the context of `scheduler`.
`abstract void`	`removeStickyBroadcast(Intent intent)` This method was deprecated in API level 21. Sticky broadcasts should not be used. They provide no security (anyone can access them), no protection (anyone can modify them), and many other problems. The recommended pattern is to use a non-sticky broadcast to report that something has changed, with another mechanism for apps to retrieve the current value whenever desired.
`abstract void`	`removeStickyBroadcastAsUser(Intent intent, UserHandle user)` This method was deprecated in API level 21. Sticky broadcasts should not be used. They provide no security (anyone can access them), no protection (anyone can modify them), and many other problems. The recommended pattern is to use a non-sticky broadcast to report that something has changed, with another mechanism for apps to retrieve the current value whenever desired.
`abstract void`	`revokeUriPermission(Uri uri, int modeFlags)` Remove all permissions to access a particular content provider Uri that were previously added with `grantUriPermission(String, Uri, int)`.
`abstract void`	`sendBroadcast(Intent intent, String receiverPermission)` Broadcast the given intent to all interested BroadcastReceivers, allowing an optional required permission to be enforced.
`abstract void`	`sendBroadcast(Intent intent)` Broadcast the given intent to all interested BroadcastReceivers.
`abstract void`	`sendBroadcastAsUser(Intent intent, UserHandle user)` Version of `sendBroadcast(Intent)` that allows you to specify the user the broadcast will be sent to.
`abstract void`	`sendBroadcastAsUser(Intent intent, UserHandle user, String receiverPermission)` Version of `sendBroadcast(Intent, String)` that allows you to specify the user the broadcast will be sent to.
`abstract void`	`sendOrderedBroadcast(Intent intent, String receiverPermission, BroadcastReceiver resultReceiver, Handler scheduler, int initialCode, String initialData, Bundle initialExtras)` Version of `sendBroadcast(Intent)` that allows you to receive data back from the broadcast.
`abstract void`	`sendOrderedBroadcast(Intent intent, String receiverPermission)` Broadcast the given intent to all interested BroadcastReceivers, delivering them one at a time to allow more preferred receivers to consume the broadcast before it is delivered to less preferred receivers.
`abstract void`	`sendOrderedBroadcastAsUser(Intent intent, UserHandle user, String receiverPermission, BroadcastReceiver resultReceiver, Handler scheduler, int initialCode, String initialData, Bundle initialExtras)` Version of `sendOrderedBroadcast(Intent, String, BroadcastReceiver, Handler, int, String, Bundle)` that allows you to specify the user the broadcast will be sent to.
`abstract void`	`sendStickyBroadcast(Intent intent)` This method was deprecated in API level 21. Sticky broadcasts should not be used. They provide no security (anyone can access them), no protection (anyone can modify them), and many other problems. The recommended pattern is to use a non-sticky broadcast to report that something has changed, with another mechanism for apps to retrieve the current value whenever desired.
`abstract void`	`sendStickyBroadcastAsUser(Intent intent, UserHandle user)` This method was deprecated in API level 21. Sticky broadcasts should not be used. They provide no security (anyone can access them), no protection (anyone can modify them), and many other problems. The recommended pattern is to use a non-sticky broadcast to report that something has changed, with another mechanism for apps to retrieve the current value whenever desired.
`abstract void`	`sendStickyOrderedBroadcast(Intent intent, BroadcastReceiver resultReceiver, Handler scheduler, int initialCode, String initialData, Bundle initialExtras)` This method was deprecated in API level 21. Sticky broadcasts should not be used. They provide no security (anyone can access them), no protection (anyone can modify them), and many other problems. The recommended pattern is to use a non-sticky broadcast to report that something has changed, with another mechanism for apps to retrieve the current value whenever desired.
`abstract void`	`sendStickyOrderedBroadcastAsUser(Intent intent, UserHandle user, BroadcastReceiver resultReceiver, Handler scheduler, int initialCode, String initialData, Bundle initialExtras)` This method was deprecated in API level 21. Sticky broadcasts should not be used. They provide no security (anyone can access them), no protection (anyone can modify them), and many other problems. The recommended pattern is to use a non-sticky broadcast to report that something has changed, with another mechanism for apps to retrieve the current value whenever desired.
`abstract void`	`setTheme(int resid)` Set the base theme for this context.
`abstract void`	`setWallpaper(Bitmap bitmap)` This method was deprecated in API level 5. Use `WallpaperManager.set()` instead. This method requires the caller to hold the permission `SET_WALLPAPER`.
`abstract void`	`setWallpaper(InputStream data)` This method was deprecated in API level 5. Use `WallpaperManager.set()` instead. This method requires the caller to hold the permission `SET_WALLPAPER`.
`abstract void`	`startActivities(Intent[] intents, Bundle options)` Launch multiple new activities.
`abstract void`	`startActivities(Intent[] intents)` Same as `startActivities(Intent[], Bundle)` with no options specified.
`abstract void`	`startActivity(Intent intent)` Same as `startActivity(Intent, Bundle)` with no options specified.
`abstract void`	`startActivity(Intent intent, Bundle options)` Launch a new activity.
`abstract boolean`	`startInstrumentation(ComponentName className, String profileFile, Bundle arguments)` Start executing an `Instrumentation` class.
`abstract void`	`startIntentSender(IntentSender intent, Intent fillInIntent, int flagsMask, int flagsValues, int extraFlags)` Same as `startIntentSender(IntentSender, Intent, int, int, int, Bundle)` with no options specified.
`abstract void`	`startIntentSender(IntentSender intent, Intent fillInIntent, int flagsMask, int flagsValues, int extraFlags, Bundle options)` Like `startActivity(Intent, Bundle)`, but taking a IntentSender to start.
`abstract ComponentName`	`startService(Intent service)` Request that a given application service be started.
`abstract boolean`	`stopService(Intent service)` Request that a given application service be stopped.
`abstract void`	`unbindService(ServiceConnection conn)` Disconnect from an application service.
`void`	`unregisterComponentCallbacks(ComponentCallbacks callback)` Remove a `ComponentCallbacks` object that was previously registered with `registerComponentCallbacks(ComponentCallbacks)`.
`abstract void`	`unregisterReceiver(BroadcastReceiver receiver)` Unregister a previously registered BroadcastReceiver.

From class


  
    java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long millis, int nanos)` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.
`final void`	`wait(long millis)` Causes the current thread to wait until either another thread invokes the `notify()` method or the `notifyAll()` method for this object, or a specified amount of time has elapsed.
`final void`	`wait()` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object.

From interface


  
    android.view.LayoutInflater.Factory2

From interface


  
    android.view.Window.Callback

From interface


  
    android.view.KeyEvent.Callback

From interface


  
    android.view.View.OnCreateContextMenuListener

From interface


  
    android.content.ComponentCallbacks2

From interface


  
    android.preference.PreferenceFragment.OnPreferenceStartFragmentCallback

From interface


  
    android.view.LayoutInflater.Factory

From interface


  
    android.content.ComponentCallbacks

Constants

EXTRA_NO_HEADERS

Added in API level 11

String EXTRA_NO_HEADERS

When starting this activity, the invoking Intent can contain this extra boolean that the header list should not be displayed. This is most often used in conjunction with EXTRA_SHOW_FRAGMENT to launch the activity to display a specific fragment that the user has navigated to.

Constant Value: ":android:no_headers"

EXTRA_SHOW_FRAGMENT

Added in API level 11

String EXTRA_SHOW_FRAGMENT

When starting this activity, the invoking Intent can contain this extra string to specify which fragment should be initially displayed.

Starting from Key Lime Pie, when this argument is passed in, the PreferenceActivity will call isValidFragment() to confirm that the fragment class name is valid for this activity.

Constant Value: ":android:show_fragment"

EXTRA_SHOW_FRAGMENT_ARGUMENTS

Added in API level 11

String EXTRA_SHOW_FRAGMENT_ARGUMENTS

When starting this activity and using EXTRA_SHOW_FRAGMENT, this extra can also be specified to supply a Bundle of arguments to pass to that fragment when it is instantiated during the initial creation of PreferenceActivity.

Constant Value: ":android:show_fragment_args"

EXTRA_SHOW_FRAGMENT_SHORT_TITLE

Added in API level 14

String EXTRA_SHOW_FRAGMENT_SHORT_TITLE

When starting this activity and using EXTRA_SHOW_FRAGMENT, this extra can also be specify to supply the short title to be shown for that fragment.

Constant Value: ":android:show_fragment_short_title"

EXTRA_SHOW_FRAGMENT_TITLE

Added in API level 14

String EXTRA_SHOW_FRAGMENT_TITLE

When starting this activity and using EXTRA_SHOW_FRAGMENT, this extra can also be specify to supply the title to be shown for that fragment.

Constant Value: ":android:show_fragment_title"

HEADER_ID_UNDEFINED

Added in API level 11

long HEADER_ID_UNDEFINED

Default value for Header.id indicating that no identifier value is set. All other values (including those below -1) are valid.

Constant Value: -1 (0xffffffffffffffff)

Public constructors

PreferenceActivity

Added in API level 1

PreferenceActivity ()

Public methods

addPreferencesFromIntent

Added in API level 1

void addPreferencesFromIntent (Intent intent)

This method was deprecated in API level 11.
This function is not relevant for a modern fragment-based PreferenceActivity.

Adds preferences from activities that match the given Intent.

Parameters
`intent`	`Intent`: The `Intent` to query activities.

addPreferencesFromResource

Added in API level 1

void addPreferencesFromResource (int preferencesResId)

This method was deprecated in API level 11.
This function is not relevant for a modern fragment-based PreferenceActivity.

Inflates the given XML resource and adds the preference hierarchy to the current preference hierarchy.

Parameters
`preferencesResId`	`int`: The XML resource ID to inflate.

findPreference

Added in API level 1

Preference findPreference (CharSequence key)

This method was deprecated in API level 11.
This function is not relevant for a modern fragment-based PreferenceActivity.

Finds a Preference based on its key.

Parameters
`key`	`CharSequence`: The key of the preference to retrieve.

Returns
`Preference`	The `Preference` with the key, or null.

See also:

findPreference(CharSequence)

finishPreferencePanel

Added in API level 11

void finishPreferencePanel (Fragment caller, 
                int resultCode, 
                Intent resultData)

Called by a preference panel fragment to finish itself.

Parameters
`caller`	`Fragment`: The fragment that is asking to be finished.
`resultCode`	`int`: Optional result code to send back to the original launching fragment.
`resultData`	`Intent`: Optional result data to send back to the original launching fragment.

getPreferenceManager

Added in API level 1

PreferenceManager getPreferenceManager ()

This method was deprecated in API level 11.
This function is not relevant for a modern fragment-based PreferenceActivity.

Returns the PreferenceManager used by this activity.

Returns
`PreferenceManager`	The `PreferenceManager`.

getPreferenceScreen

Added in API level 1

PreferenceScreen getPreferenceScreen ()

This method was deprecated in API level 11.
This function is not relevant for a modern fragment-based PreferenceActivity.

Gets the root of the preference hierarchy that this activity is showing.

Returns
`PreferenceScreen`	The `PreferenceScreen` that is the root of the preference hierarchy.

hasHeaders

Added in API level 11

boolean hasHeaders ()

Returns true if this activity is currently showing the header list.

Returns
`boolean`

invalidateHeaders

Added in API level 11

void invalidateHeaders ()

Call when you need to change the headers being displayed. Will result in onBuildHeaders() later being called to retrieve the new list.

isMultiPane

Added in API level 11

boolean isMultiPane ()

Returns true if this activity is showing multiple panes -- the headers and a preference fragment.

Returns
`boolean`

loadHeadersFromResource

Added in API level 11

void loadHeadersFromResource (int resid, 
                List<PreferenceActivity.Header> target)

Parse the given XML file as a header description, adding each parsed Header into the target list.

Parameters
`resid`	`int`: The XML resource to load and parse.
`target`	`List`: The list in which the parsed headers should be placed.

onBuildHeaders

Added in API level 11

void onBuildHeaders (List<PreferenceActivity.Header> target)

Called when the activity needs its list of headers build. By implementing this and adding at least one item to the list, you will cause the activity to run in its modern fragment mode. Note that this function may not always be called; for example, if the activity has been asked to display a particular fragment without the header list, there is no need to build the headers.

Typical implementations will use loadHeadersFromResource(int, List) to fill in the list from a resource.

Parameters
`target`	`List`: The list in which to place the headers.

onBuildStartFragmentIntent

Added in API level 14

Intent onBuildStartFragmentIntent (String fragmentName, 
                Bundle args, 
                int titleRes, 
                int shortTitleRes)

Called by startWithFragment(String, Bundle, Fragment, int, int, int) when in single-pane mode, to build an Intent to launch a new activity showing the selected fragment. The default implementation constructs an Intent that re-launches the current activity with the appropriate arguments to display the fragment.

Parameters
`fragmentName`	`String`: The name of the fragment to display.
`args`	`Bundle`: Optional arguments to supply to the fragment.
`titleRes`	`int`: Optional resource ID of title to show for this item.
`shortTitleRes`	`int`: Optional resource ID of short title to show for this item.

Returns
`Intent`	Returns an Intent that can be launched to display the given fragment.

onContentChanged

Added in API level 1

void onContentChanged ()

Updates the screen state (current list and other views) when the content changes.

onGetInitialHeader

Added in API level 11

PreferenceActivity.Header onGetInitialHeader ()

Called to determine the initial header to be shown. The default implementation simply returns the fragment of the first header. Note that the returned Header object does not actually need to exist in your header list -- whatever its fragment is will simply be used to show for the initial UI.

Returns
`PreferenceActivity.Header`

onGetNewHeader

Added in API level 11

PreferenceActivity.Header onGetNewHeader ()

Called after the header list has been updated (onBuildHeaders(List) has been called and returned due to invalidateHeaders()) to specify the header that should now be selected. The default implementation returns null to keep whatever header is currently selected.

Returns
`PreferenceActivity.Header`

onHeaderClick

Added in API level 11

void onHeaderClick (PreferenceActivity.Header header, 
                int position)

Called when the user selects an item in the header list. The default implementation will call either startWithFragment(String, Bundle, Fragment, int, int, int) or switchToHeader(Header) as appropriate.

Parameters
`header`	`PreferenceActivity.Header`: The header that was selected.
`position`	`int`: The header's position in the list.

onIsHidingHeaders

Added in API level 11

boolean onIsHidingHeaders ()

Called to determine whether the header list should be hidden. The default implementation returns the value given in EXTRA_NO_HEADERS or false if it is not supplied. This is set to false, for example, when the activity is being re-launched to show a particular preference activity.

Returns
`boolean`

onIsMultiPane

Added in API level 11

boolean onIsMultiPane ()

Called to determine if the activity should run in multi-pane mode. The default implementation returns true if the screen is large enough.

Returns
`boolean`

onPreferenceStartFragment

Added in API level 11

boolean onPreferenceStartFragment (PreferenceFragment caller, 
                Preference pref)

Called when the user has clicked on a Preference that has a fragment class name associated with it. The implementation to should instantiate and switch to an instance of the given fragment.

Parameters
`caller`	`PreferenceFragment`
`pref`	`Preference`

Returns
`boolean`

onPreferenceTreeClick

Added in API level 1

boolean onPreferenceTreeClick (PreferenceScreen preferenceScreen, 
                Preference preference)

This method was deprecated in API level 11.
This function is not relevant for a modern fragment-based PreferenceActivity.

Parameters
`preferenceScreen`	`PreferenceScreen`
`preference`	`Preference`

Returns
`boolean`

setListFooter

Added in API level 11

void setListFooter (View view)

Set a footer that should be shown at the bottom of the header list.

Parameters
`view`	`View`

setParentTitle

Added in API level 11

void setParentTitle (CharSequence title, 
                CharSequence shortTitle, 
                View.OnClickListener listener)

Should be called after onCreate to ensure that the breadcrumbs, if any, were created. This prepends a title to the fragment breadcrumbs and attaches a listener to any clicks on the parent entry.

Parameters
`title`	`CharSequence`: the title for the breadcrumb
`shortTitle`	`CharSequence`: the short title for the breadcrumb
`listener`	`View.OnClickListener`

setPreferenceScreen

Added in API level 1

void setPreferenceScreen (PreferenceScreen preferenceScreen)

This method was deprecated in API level 11.
This function is not relevant for a modern fragment-based PreferenceActivity.

Sets the root of the preference hierarchy that this activity is showing.

Parameters
`preferenceScreen`	`PreferenceScreen`: The root `PreferenceScreen` of the preference hierarchy.

showBreadCrumbs

Added in API level 11

void showBreadCrumbs (CharSequence title, 
                CharSequence shortTitle)

Change the base title of the bread crumbs for the current preferences. This will normally be called for you. See FragmentBreadCrumbs for more information.

Parameters
`title`	`CharSequence`
`shortTitle`	`CharSequence`

startPreferenceFragment

Added in API level 11

void startPreferenceFragment (Fragment fragment, 
                boolean push)

Start a new fragment.

Parameters
`fragment`	`Fragment`: The fragment to start
`push`	`boolean`: If true, the current fragment will be pushed onto the back stack. If false, the current fragment will be replaced.

startPreferencePanel

Added in API level 11

void startPreferencePanel (String fragmentClass, 
                Bundle args, 
                int titleRes, 
                CharSequence titleText, 
                Fragment resultTo, 
                int resultRequestCode)

Start a new fragment containing a preference panel. If the preferences are being displayed in multi-pane mode, the given fragment class will be instantiated and placed in the appropriate pane. If running in single-pane mode, a new activity will be launched in which to show the fragment.

Parameters
`fragmentClass`	`String`: Full name of the class implementing the fragment.
`args`	`Bundle`: Any desired arguments to supply to the fragment.
`titleRes`	`int`: Optional resource identifier of the title of this fragment.
`titleText`	`CharSequence`: Optional text of the title of this fragment.
`resultTo`	`Fragment`: Optional fragment that result data should be sent to. If non-null, resultTo.onActivityResult() will be called when this preference panel is done. The launched panel must use `finishPreferencePanel(Fragment, int, Intent)` when done.
`resultRequestCode`	`int`: If resultTo is non-null, this is the caller's request code to be received with the result.

startWithFragment

Added in API level 14

void startWithFragment (String fragmentName, 
                Bundle args, 
                Fragment resultTo, 
                int resultRequestCode, 
                int titleRes, 
                int shortTitleRes)

Start a new instance of this activity, showing only the given preference fragment. When launched in this mode, the header list will be hidden and the given preference fragment will be instantiated and fill the entire activity.

Parameters
`fragmentName`	`String`: The name of the fragment to display.
`args`	`Bundle`: Optional arguments to supply to the fragment.
`resultTo`	`Fragment`: Option fragment that should receive the result of the activity launch.
`resultRequestCode`	`int`: If resultTo is non-null, this is the request code in which to report the result.
`titleRes`	`int`: Resource ID of string to display for the title of this set of preferences.
`shortTitleRes`	`int`: Resource ID of string to display for the short title of this set of preferences.

startWithFragment

Added in API level 11

void startWithFragment (String fragmentName, 
                Bundle args, 
                Fragment resultTo, 
                int resultRequestCode)

Like startWithFragment(String, Bundle, Fragment, int, int, int) but uses a 0 titleRes.

Parameters
`fragmentName`	`String`
`args`	`Bundle`
`resultTo`	`Fragment`
`resultRequestCode`	`int`

switchToHeader

Added in API level 11

void switchToHeader (String fragmentName, 
                Bundle args)

When in two-pane mode, switch the fragment pane to show the given preference fragment.

Parameters
`fragmentName`	`String`: The name of the fragment to display.
`args`	`Bundle`: Optional arguments to supply to the fragment.

switchToHeader

Added in API level 11

void switchToHeader (PreferenceActivity.Header header)

When in two-pane mode, switch to the fragment pane to show the given preference fragment.

Parameters
`header`	`PreferenceActivity.Header`: The new header to display.

Protected methods

isValidFragment

Added in API level 19

boolean isValidFragment (String fragmentName)

Subclasses should override this method and verify that the given fragment is a valid type to be attached to this activity. The default implementation returns true for apps built for android:targetSdkVersion older than KITKAT. For later versions, it will throw an exception.

Parameters
`fragmentName`	`String`: the class name of the Fragment about to be attached to this activity.

Returns
`boolean`	true if the fragment class name is valid for this Activity and false otherwise.

onActivityResult

Added in API level 1

void onActivityResult (int requestCode, 
                int resultCode, 
                Intent data)

Called when an activity you launched exits, giving you the requestCode you started it with, the resultCode it returned, and any additional data from it. The resultCode will be RESULT_CANCELED if the activity explicitly returned that, didn't return any result, or crashed during its operation.

You will receive this call immediately before onResume() when your activity is re-starting.

This method is never invoked if your activity sets noHistory to true.

Parameters
`requestCode`	`int`: The integer request code originally supplied to startActivityForResult(), allowing you to identify who this result came from.
`resultCode`	`int`: The integer result code returned by the child activity through its setResult().
`data`	`Intent`: An Intent, which can return result data to the caller (various data can be attached to Intent "extras").

onCreate

Added in API level 1

void onCreate (Bundle savedInstanceState)

Called when the activity is starting. This is where most initialization should go: calling setContentView(int) to inflate the activity's UI, using findViewById(int) to programmatically interact with widgets in the UI, calling managedQuery(android.net.Uri, String[], String, String[], String) to retrieve cursors for data being displayed, etc.

You can call finish() from within this function, in which case onDestroy() will be immediately called without any of the rest of the activity lifecycle (onStart(), onResume(), onPause(), etc) executing.

Derived classes must call through to the super class's implementation of this method. If they do not, an exception will be thrown.

Parameters
`savedInstanceState`	`Bundle`: If the activity is being re-initialized after previously being shut down then this Bundle contains the data it most recently supplied in `onSaveInstanceState(Bundle)`. *Note: Otherwise it is null.*

onDestroy

Added in API level 1

void onDestroy ()

Perform any final cleanup before an activity is destroyed. This can happen either because the activity is finishing (someone called finish() on it, or because the system is temporarily destroying this instance of the activity to save space. You can distinguish between these two scenarios with the isFinishing() method.

Note: do not count on this method being called as a place for saving data! For example, if an activity is editing data in a content provider, those edits should be committed in either onPause() or onSaveInstanceState(Bundle), not here. This method is usually implemented to free resources like threads that are associated with an activity, so that a destroyed activity does not leave such things around while the rest of its application is still running. There are situations where the system will simply kill the activity's hosting process without calling this method (or any others) in it, so it should not be used to do things that are intended to remain around after the process goes away.

Derived classes must call through to the super class's implementation of this method. If they do not, an exception will be thrown.

onListItemClick

Added in API level 1

void onListItemClick (ListView l, 
                View v, 
                int position, 
                long id)

This method will be called when an item in the list is selected. Subclasses should override. Subclasses can call getListView().getItemAtPosition(position) if they need to access the data associated with the selected item.

Parameters
`l`	`ListView`: The ListView where the click happened
`v`	`View`: The view that was clicked within the ListView
`position`	`int`: The position of the view in the list
`id`	`long`: The row id of the item that was clicked

onNewIntent

Added in API level 1

void onNewIntent (Intent intent)

This is called for activities that set launchMode to "singleTop" in their package, or if a client used the FLAG_ACTIVITY_SINGLE_TOP flag when calling startActivity(Intent). In either case, when the activity is re-launched while at the top of the activity stack instead of a new instance of the activity being started, onNewIntent() will be called on the existing instance with the Intent that was used to re-launch it.

An activity will always be paused before receiving a new intent, so you can count on onResume() being called after this method.

Note that getIntent() still returns the original Intent. You can use setIntent(Intent) to update it to this new Intent.

Parameters
`intent`	`Intent`: The new intent that was started for the activity.

onRestoreInstanceState

Added in API level 1

void onRestoreInstanceState (Bundle state)

Ensures the list view has been created before Activity restores all of the view states.

Parameters
`state`	`Bundle`: the data most recently supplied in `onSaveInstanceState(Bundle)`.

onSaveInstanceState

Added in API level 1

void onSaveInstanceState (Bundle outState)

Called to retrieve per-instance state from an activity before being killed so that the state can be restored in onCreate(Bundle) or onRestoreInstanceState(Bundle) (the Bundle populated by this method will be passed to both).

This method is called before an activity may be killed so that when it comes back some time in the future it can restore its state. For example, if activity B is launched in front of activity A, and at some point activity A is killed to reclaim resources, activity A will have a chance to save the current state of its user interface via this method so that when the user returns to activity A, the state of the user interface can be restored via onCreate(Bundle) or onRestoreInstanceState(Bundle).

Do not confuse this method with activity lifecycle callbacks such as onPause(), which is always called when an activity is being placed in the background or on its way to destruction, or onStop() which is called before destruction. One example of when onPause() and onStop() is called and not this method is when a user navigates back from activity B to activity A: there is no need to call onSaveInstanceState(Bundle) on B because that particular instance will never be restored, so the system avoids calling it. An example when onPause() is called and not onSaveInstanceState(Bundle) is when activity B is launched in front of activity A: the system may avoid calling onSaveInstanceState(Bundle) on activity A if it isn't killed during the lifetime of B since the state of the user interface of A will stay intact.

The default implementation takes care of most of the UI per-instance state for you by calling onSaveInstanceState() on each view in the hierarchy that has an id, and by saving the id of the currently focused view (all of which is restored by the default implementation of onRestoreInstanceState(Bundle)). If you override this method to save additional information not captured by each individual view, you will likely want to call through to the default implementation, otherwise be prepared to save all of the state of each view yourself.

If called, this method will occur before onStop(). There are no guarantees about whether it will occur before or after onPause().

Parameters
`outState`	`Bundle`: Bundle in which to place your saved state.

onStop

Added in API level 1

void onStop ()

Called when you are no longer visible to the user. You will next receive either onRestart(), onDestroy(), or nothing, depending on later user activity.

Derived classes must call through to the super class's implementation of this method. If they do not, an exception will be thrown.

Most visited

Recently visited

Results for

PreferenceActivity

Developer Guides

Sample Code

Summary

Nested classes

Constants

Inherited constants

Inherited fields

Public constructors

Public methods

Protected methods

Inherited methods

Constants

EXTRA_NO_HEADERS

EXTRA_SHOW_FRAGMENT

EXTRA_SHOW_FRAGMENT_ARGUMENTS

EXTRA_SHOW_FRAGMENT_SHORT_TITLE

EXTRA_SHOW_FRAGMENT_TITLE

HEADER_ID_UNDEFINED

Public constructors

PreferenceActivity

Public methods

addPreferencesFromIntent

addPreferencesFromResource

findPreference

finishPreferencePanel

getPreferenceManager

getPreferenceScreen

hasHeaders

invalidateHeaders

isMultiPane

loadHeadersFromResource

onBuildHeaders

onBuildStartFragmentIntent

onContentChanged

onGetInitialHeader

onGetNewHeader

onHeaderClick

onIsHidingHeaders

onIsMultiPane

onPreferenceStartFragment

onPreferenceTreeClick

setListFooter

setParentTitle

setPreferenceScreen

showBreadCrumbs

startPreferenceFragment

startPreferencePanel

startWithFragment

startWithFragment

switchToHeader

switchToHeader

Protected methods

isValidFragment

onActivityResult

onCreate

onDestroy

onListItemClick

onNewIntent

onRestoreInstanceState

onSaveInstanceState

onStop