Added in API level 11
Deprecated in API level 29

Header

class Header : Parcelable
kotlin.Any
   ↳ android.preference.PreferenceActivity.Header

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

Summary

Inherited constants
Public constructors

Public methods
Int

CharSequence!

Return the currently set bread crumb short title.
CharSequence!

Return the currently set bread crumb title.
CharSequence!

Return the currently set summary.
CharSequence!

Return the currently set title.
Unit

Unit
writeToParcel(dest: Parcel, flags: Int)
Properties
static Parcelable.Creator<PreferenceActivity.Header!>

CharSequence!

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

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

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

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

Optional additional data for use by subclasses of PreferenceActivity.
String!

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

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

Optional icon resource to show for this header.
Long

Identifier for this header, to correlate with a new list when it is updated.
Intent!

Intent to launch when the preference is selected.
CharSequence!

Optional summary describing what this header controls.
Int

Resource ID of optional summary describing what this header controls.
CharSequence!

Title of the header that is shown to the user.
Int

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

Public constructors

Header

Added in API level 11
Header()

Public methods

describeContents

Added in API level 11
fun describeContents(): Int

Deprecated: Deprecated in Java.

Return
Int a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or android.os.Parcelable#CONTENTS_FILE_DESCRIPTOR

getBreadCrumbShortTitle

Added in API level 11
fun getBreadCrumbShortTitle(res: Resources!): CharSequence!

Deprecated: Deprecated in Java.

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

getBreadCrumbTitle

Added in API level 11
fun getBreadCrumbTitle(res: Resources!): CharSequence!

Deprecated: Deprecated in Java.

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

getSummary

Added in API level 11
fun getSummary(res: Resources!): CharSequence!

Deprecated: Deprecated in Java.

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

getTitle

Added in API level 11
fun getTitle(res: Resources!): CharSequence!

Deprecated: Deprecated in Java.

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

readFromParcel

Added in API level 11
fun readFromParcel(in: Parcel!): Unit

Deprecated: Deprecated in Java.

writeToParcel

Added in API level 11
fun writeToParcel(
    dest: Parcel, 
    flags: Int
): Unit

Deprecated: Deprecated in Java.

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_WRITE_RETURN_VALUE. Value is either 0 or a combination of android.os.Parcelable#PARCELABLE_WRITE_RETURN_VALUE, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES

Properties

CREATOR

Added in API level 11
static val CREATOR: Parcelable.Creator<PreferenceActivity.Header!>

Deprecated: Deprecated in Java.

Added in API level 11
var breadCrumbShortTitle: CharSequence!

Deprecated: Deprecated in Java.

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

Added in API level 11
var breadCrumbShortTitleRes: Int

Deprecated: Deprecated in Java.

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

Added in API level 11
var breadCrumbTitle: CharSequence!

Deprecated: Deprecated in Java.

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

Added in API level 11
var breadCrumbTitleRes: Int

Deprecated: Deprecated in Java.

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

extras

Added in API level 11
var extras: Bundle!

Deprecated: Deprecated in Java.

Optional additional data for use by subclasses of PreferenceActivity.

fragment

Added in API level 11
var fragment: String!

Deprecated: Deprecated in Java.

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

fragmentArguments

Added in API level 11
var fragmentArguments: Bundle!

Deprecated: Deprecated in Java.

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

iconRes

Added in API level 11
var iconRes: Int

Deprecated: Deprecated in Java.

Optional icon resource to show for this header.

id

Added in API level 11
var id: Long

Deprecated: Deprecated in Java.

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
var intent: Intent!

Deprecated: Deprecated in Java.

Intent to launch when the preference is selected.

summary

Added in API level 11
var summary: CharSequence!

Deprecated: Deprecated in Java.

Optional summary describing what this header controls.

summaryRes

Added in API level 11
var summaryRes: Int

Deprecated: Deprecated in Java.

Resource ID of optional summary describing what this header controls.

title

Added in API level 11
var title: CharSequence!

Deprecated: Deprecated in Java.

Title of the header that is shown to the user.

titleRes

Added in API level 11
var titleRes: Int

Deprecated: Deprecated in Java.

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