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)
Android APIs
public static final class

PreferenceActivity.Header

extends Object
implements Parcelable
java.lang.Object
   ↳ android.preference.PreferenceActivity.Header

Class Overview

Description of a single Header item that the user can select.

Summary

[Expand]
Inherited Constants
From interface android.os.Parcelable
Fields
public static final Creator < PreferenceActivity.Header > CREATOR
public CharSequence breadCrumbShortTitle Optional text to show as the short title in the bread crumb.
public int breadCrumbShortTitleRes Resource ID of optional text to show as the short title in the bread crumb.
public CharSequence breadCrumbTitle Optional text to show as the title in the bread crumb.
public int breadCrumbTitleRes Resource ID of optional text to show as the title in the bread crumb.
public Bundle extras Optional additional data for use by subclasses of PreferenceActivity.
public String fragment Full class name of the fragment to display when this header is selected.
public Bundle fragmentArguments Optional arguments to supply to the fragment when it is instantiated.
public int iconRes Optional icon resource to show for this header.
public long id Identifier for this header, to correlate with a new list when it is updated.
public Intent intent Intent to launch when the preference is selected.
public CharSequence summary Optional summary describing what this header controls.
public int summaryRes Resource ID of optional summary describing what this header controls.
public CharSequence title Title of the header that is shown to the user.
public int titleRes Resource ID of title of the header that is shown to the user.
Public Constructors
PreferenceActivity.Header ()
Public Methods
int describeContents ()
Describe the kinds of special objects contained in this Parcelable's marshalled representation.
CharSequence getBreadCrumbShortTitle ( Resources res)
Return the currently set bread crumb short title.
CharSequence getBreadCrumbTitle ( Resources res)
Return the currently set bread crumb title.
CharSequence getSummary ( Resources res)
Return the currently set summary.
CharSequence getTitle ( Resources res)
Return the currently set title.
void readFromParcel ( Parcel in)
void writeToParcel ( Parcel dest, int flags)
Flatten this object in to a Parcel.
[Expand]
Inherited Methods
From class java.lang.Object
From interface android.os.Parcelable

Fields

public static final Creator < PreferenceActivity.Header > CREATOR

public CharSequence breadCrumbShortTitle

Optional text to show as the short title in the bread crumb.

public int breadCrumbShortTitleRes

Resource ID of optional text to show as the short title in the bread crumb.

public CharSequence breadCrumbTitle

Optional text to show as the title in the bread crumb.

public int breadCrumbTitleRes

Resource ID of optional text to show as the title in the bread crumb.

public Bundle extras

Optional additional data for use by subclasses of PreferenceActivity.

public String fragment

Full class name of the fragment to display when this header is selected.

public Bundle fragmentArguments

Optional arguments to supply to the fragment when it is instantiated.

public int iconRes

Optional icon resource to show for this header.

public long id

Identifier for this header, to correlate with a new list when it is updated. The default value is HEADER_ID_UNDEFINED , meaning no id.

public Intent intent

Intent to launch when the preference is selected.

public CharSequence summary

Optional summary describing what this header controls.

public int summaryRes

Resource ID of optional summary describing what this header controls.

public CharSequence title

Title of the header that is shown to the user.

public int titleRes

Resource ID of title of the header that is shown to the user.

Public Constructors

public PreferenceActivity.Header ()

Public Methods

public int describeContents ()

Describe the kinds of special objects contained in this Parcelable's marshalled representation.

Returns
  • a bitmask indicating the set of special object types marshalled by the Parcelable.

public CharSequence getBreadCrumbShortTitle ( Resources res)

Return the currently set bread crumb short title. If breadCrumbShortTitleRes is set, this resource is loaded from res and returned. Otherwise breadCrumbShortTitle is returned.

public CharSequence getBreadCrumbTitle ( Resources res)

Return the currently set bread crumb title. If breadCrumbTitleRes is set, this resource is loaded from res and returned. Otherwise breadCrumbTitle is returned.

public CharSequence getSummary ( Resources res)

Return the currently set summary. If summaryRes is set, this resource is loaded from res and returned. Otherwise summary is returned.

public CharSequence getTitle ( Resources res)

Return the currently set title. If titleRes is set, this resource is loaded from res and returned. Otherwise title is returned.

public void readFromParcel ( Parcel in)

public void writeToParcel ( Parcel dest, int flags)

Flatten this object in to a Parcel.

Parameters
dest The Parcel in which the object should be written.
flags Additional flags about how the object should be written. May be 0 or PARCELABLE_WRITE_RETURN_VALUE .