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

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 instance's marshaled 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

Fields

CREATOR

added in API level 11
public static final Creator<PreferenceActivity.Header> CREATOR

added in API level 11
public CharSequence breadCrumbShortTitle

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

added in API level 11
public int breadCrumbShortTitleRes

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

added in API level 11
public CharSequence breadCrumbTitle

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

added in API level 11
public int breadCrumbTitleRes

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

extras

added in API level 11
public Bundle extras

Optional additional data for use by subclasses of PreferenceActivity.

fragment

added in API level 11
public String fragment

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

fragmentArguments

added in API level 11
public Bundle fragmentArguments

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

iconRes

added in API level 11
public int iconRes

Optional icon resource to show for this header.

id

added in API level 11
public long id

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

intent

added in API level 11
public Intent intent

Intent to launch when the preference is selected.

summary

added in API level 11
public CharSequence summary

Optional summary describing what this header controls.

summaryRes

added in API level 11
public int summaryRes

Resource ID of optional summary describing what this header controls.

title

added in API level 11
public CharSequence title

Title of the header that is shown to the user.

titleRes

added in API level 11
public int titleRes

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

Public constructors

PreferenceActivity.Header

added in API level 11
public PreferenceActivity.Header ()

Public methods

describeContents

added in API level 11
public int describeContents ()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of writeToParcel(Parcel, int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.

Returns
int a bitmask indicating the set of special object types marshaled by this Parcelable object instance.

getBreadCrumbShortTitle

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

Parameters
res Resources

Returns
CharSequence

getBreadCrumbTitle

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

Parameters
res Resources

Returns
CharSequence

getSummary

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

Parameters
res Resources

Returns
CharSequence

getTitle

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

Parameters
res Resources

Returns
CharSequence

readFromParcel

added in API level 11
public void readFromParcel (Parcel in)

Parameters
in Parcel

writeToParcel

added in API level 11
public 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.PARCELABLE_WRITE_RETURN_VALUE.