PreferenceActivity.Header | Android Developers

Added in API level 11
Deprecated in API level 29

Summary: Inherited Constants | Fields | Ctors | Methods | Inherited Methods

Kotlin |Java

public static final class PreferenceActivity.Header
extends Object implements Parcelable

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

This class was deprecated in API level 29.
Use the AndroidX Preference Library for consistent behavior across all devices. For more information on using the AndroidX Preference Library see Settings.

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

Summary

Inherited constants

From interface android.os.Parcelable

`int`	`CONTENTS_FILE_DESCRIPTOR` Descriptor bit used with `describeContents()`: indicates that the Parcelable object's flattened representation includes a file descriptor.
`int`	`PARCELABLE_WRITE_RETURN_VALUE` Flag for use with `writeToParcel(Parcel, int)`: the object being written is a return value, that is the result of a function such as "`Parcelable someFunction()`", "`void someFunction(out Parcelable)`", or "`void someFunction(inout 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
`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

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 timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

From interface


        
          android.os.Parcelable

`abstract int`	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
`abstract void`	`writeToParcel(Parcel dest, int flags)` Flatten this object in to a Parcel.

Fields

CREATOR

Added in API level 11

public static final Creator<PreferenceActivity.Header> CREATOR

breadCrumbShortTitle

Added in API level 11

public CharSequence breadCrumbShortTitle

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

breadCrumbShortTitleRes

Added in API level 11

public int breadCrumbShortTitleRes

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

breadCrumbTitle

Added in API level 11

public CharSequence breadCrumbTitle

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

breadCrumbTitleRes

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

Added in API level 11

public 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(android.os.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. Value is either `0` or `CONTENTS_FILE_DESCRIPTOR`

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. This value cannot be `null`.
`flags`	`int`: Additional flags about how the object should be written. May be 0 or `Parcelable.PARCELABLE_WRITE_RETURN_VALUE`. Value is either `0` or a combination of `Parcelable.PARCELABLE_WRITE_RETURN_VALUE`, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES