PreferenceActivity.Header - Android SDK

Added in API level 11

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

Object	clone() Creates and returns a copy of this `Object`.
boolean	equals(Object o) Compares this instance with the specified object and indicates if they are equal.
void	finalize() Invoked when the garbage collector has detected that this instance is no longer reachable.
final Class<?>	getClass() Returns the unique instance of `Class` that represents this object's class.
int	hashCode() Returns an integer hash code for this object.
final void	notify() Causes a thread which is waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
final void	notifyAll() Causes all threads which are waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
String	toString() Returns a string containing a concise, human-readable description of this object.
final void	wait() Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object.
final void	wait(long millis, int nanos) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.
final void	wait(long millis) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.

From interface android.os.Parcelable

Fields

public static final Creator<PreferenceActivity.Header> CREATOR

Added in API level 11

public CharSequence breadCrumbShortTitle

Added in API level 11

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

public int breadCrumbShortTitleRes

Added in API level 11

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

public CharSequence breadCrumbTitle

Added in API level 11

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

public int breadCrumbTitleRes

Added in API level 11

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

public Bundle extras

Added in API level 11

Optional additional data for use by subclasses of PreferenceActivity.

public String fragment

Added in API level 11

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

public Bundle fragmentArguments

Added in API level 11

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

public int iconRes

Added in API level 11

Optional icon resource to show for this header.

public long id

Added in API level 11

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

Added in API level 11

Intent to launch when the preference is selected.

public CharSequence summary

Added in API level 11

Optional summary describing what this header controls.

public int summaryRes

Added in API level 11

Resource ID of optional summary describing what this header controls.

public CharSequence title

Added in API level 11

Title of the header that is shown to the user.

public int titleRes

Added in API level 11

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

Public Constructors

public PreferenceActivity.Header ()

Added in API level 11

Public Methods

public int describeContents ()

Added in API level 11

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)

Added in API level 11

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)

Added in API level 11

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)

Added in API level 11

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)

Added in API level 11

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)

Added in API level 11

public void writeToParcel (Parcel dest, int flags)

Added in API level 11

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

Results

Interfaces

Classes

PreferenceActivity.Header

Class Overview

Summary

Fields

public static final Creator<PreferenceActivity.Header> CREATOR

public CharSequence breadCrumbShortTitle

public int breadCrumbShortTitleRes

public CharSequence breadCrumbTitle

public int breadCrumbTitleRes

public Bundle extras

public String fragment

public Bundle fragmentArguments

public int iconRes

public long id

public Intent intent

public CharSequence summary

public int summaryRes

public CharSequence title

public int titleRes

Public Constructors

public PreferenceActivity.Header ()

Public Methods

public int describeContents ()

Returns

public CharSequence getBreadCrumbShortTitle (Resources res)

public CharSequence getBreadCrumbTitle (Resources res)

public CharSequence getSummary (Resources res)

public CharSequence getTitle (Resources res)

public void readFromParcel (Parcel in)

public void writeToParcel (Parcel dest, int flags)

Parameters