Skip to content

Most visited

Recently visited

navigation
Added in API level 11

PreferenceActivity.Header

public static final class PreferenceActivity.Header
extends Object implements Parcelable

java.lang.Object
   ↳ android.preference.PreferenceActivity.Header


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

Summary

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.

Inherited methods

From class java.lang.Object
From interface android.os.Parcelable

Fields

CREATOR

Added in API level 11
Creator<PreferenceActivity.Header> CREATOR

breadCrumbShortTitle

Added in API level 11
CharSequence breadCrumbShortTitle

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

breadCrumbShortTitleRes

Added in API level 11
int breadCrumbShortTitleRes

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

breadCrumbTitle

Added in API level 11
CharSequence breadCrumbTitle

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

breadCrumbTitleRes

Added in API level 11
int breadCrumbTitleRes

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

extras

Added in API level 11
Bundle extras

Optional additional data for use by subclasses of PreferenceActivity.

fragment

Added in API level 11
String fragment

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

fragmentArguments

Added in API level 11
Bundle fragmentArguments

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

iconRes

Added in API level 11
int iconRes

Optional icon resource to show for this header.

id

Added in API level 11
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.

intent

Added in API level 11
Intent intent

Intent to launch when the preference is selected.

summary

Added in API level 11
CharSequence summary

Optional summary describing what this header controls.

summaryRes

Added in API level 11
int summaryRes

Resource ID of optional summary describing what this header controls.

title

Added in API level 11
CharSequence title

Title of the header that is shown to the user.

titleRes

Added in API level 11
int titleRes

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

Public constructors

PreferenceActivity.Header

Added in API level 11
PreferenceActivity.Header ()

Public methods

describeContents

Added in API level 11
int describeContents ()

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

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

getBreadCrumbShortTitle

Added in API level 11
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.

Parameters
res Resources
Returns
CharSequence

getBreadCrumbTitle

Added in API level 11
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.

Parameters
res Resources
Returns
CharSequence

getSummary

Added in API level 11
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.

Parameters
res Resources
Returns
CharSequence

getTitle

Added in API level 11
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.

Parameters
res Resources
Returns
CharSequence

readFromParcel

Added in API level 11
void readFromParcel (Parcel in)

Parameters
in Parcel

writeToParcel

Added in API level 11
void writeToParcel (Parcel dest, 
                int flags)

Flatten this object in to a Parcel.

Parameters
dest Parcel: The Parcel in which the object should be written.
flags int: Additional flags about how the object should be written. May be 0 or PARCELABLE_WRITE_RETURN_VALUE.
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.