Header

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

Description of a single Header item that the user can select.
Requires API level 11 (Android 3.0, Honeycomb)

Summary

Inherited constants
Public constructors

Public methods
Unit
writeToParcel(dest: Parcel!, flags: Int)

Flatten this object in to a Parcel.

Unit

Requires API level 11 (Android 3.0, Honeycomb)

CharSequence!

Return the currently set summary.

CharSequence!

Return the currently set title.

CharSequence!

Return the currently set bread crumb title.

Int

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

CharSequence!

Return the currently set bread crumb short title.

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

static Parcelable.Creator<PreferenceActivity.Header!>!

Requires API level 11 (Android 3.0, Honeycomb)

Public constructors

<init>

Header()

Public methods

writeToParcel

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

Flatten this object in to a Parcel. Requires API level 11 (Android 3.0, Honeycomb)

Parameters
dest Parcel!: The Parcel in which the object should be written.
flags Parcel!: 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

readFromParcel

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

Requires API level 11 (Android 3.0, Honeycomb)

getSummary

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

Return the currently set summary. If #summaryRes is set, this resource is loaded from res and returned. Otherwise #summary is returned.
Requires API level 11 (Android 3.0, Honeycomb)

getTitle

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

Return the currently set title. If #titleRes is set, this resource is loaded from res and returned. Otherwise #title is returned.
Requires API level 11 (Android 3.0, Honeycomb)

getBreadCrumbTitle

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

Return the currently set bread crumb title. If #breadCrumbTitleRes is set, this resource is loaded from res and returned. Otherwise #breadCrumbTitle is returned.
Requires API level 11 (Android 3.0, Honeycomb)

describeContents

added in API level 11
fun describeContents(): Int

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. Requires API level 11 (Android 3.0, Honeycomb)

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!

Return the currently set bread crumb short title. If #breadCrumbShortTitleRes is set, this resource is loaded from res and returned. Otherwise #breadCrumbShortTitle is returned.
Requires API level 11 (Android 3.0, Honeycomb)

Properties

breadCrumbShortTitle

added in API level 11
var breadCrumbShortTitle: CharSequence!

Optional text to show as the short title in the bread crumb.
Requires API level 11 (Android 3.0, Honeycomb)

breadCrumbShortTitleRes

added in API level 11
var breadCrumbShortTitleRes: Int

Resource ID of optional text to show as the short title in the bread crumb.
Requires API level 11 (Android 3.0, Honeycomb)

breadCrumbTitle

added in API level 11
var breadCrumbTitle: CharSequence!

Optional text to show as the title in the bread crumb.
Requires API level 11 (Android 3.0, Honeycomb)

breadCrumbTitleRes

added in API level 11
var breadCrumbTitleRes: Int

Resource ID of optional text to show as the title in the bread crumb.
Requires API level 11 (Android 3.0, Honeycomb)

extras

added in API level 11
var extras: Bundle!

Optional additional data for use by subclasses of PreferenceActivity.
Requires API level 11 (Android 3.0, Honeycomb)

fragment

added in API level 11
var fragment: String!

Full class name of the fragment to display when this header is selected.
Requires API level 11 (Android 3.0, Honeycomb)

fragmentArguments

added in API level 11
var fragmentArguments: Bundle!

Optional arguments to supply to the fragment when it is instantiated.
Requires API level 11 (Android 3.0, Honeycomb)

iconRes

added in API level 11
var iconRes: Int

Optional icon resource to show for this header.
Requires API level 11 (Android 3.0, Honeycomb)

id

added in API level 11
var id: Long

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.
Requires API level 11 (Android 3.0, Honeycomb)

intent

added in API level 11
var intent: Intent!

Intent to launch when the preference is selected.
Requires API level 11 (Android 3.0, Honeycomb)

summary

added in API level 11
var summary: CharSequence!

Optional summary describing what this header controls.
Requires API level 11 (Android 3.0, Honeycomb)

summaryRes

added in API level 11
var summaryRes: Int

Resource ID of optional summary describing what this header controls.
Requires API level 11 (Android 3.0, Honeycomb)

title

added in API level 11
var title: CharSequence!

Title of the header that is shown to the user.
Requires API level 11 (Android 3.0, Honeycomb)

titleRes

added in API level 11
var titleRes: Int

Resource ID of title of the header that is shown to the user.
Requires API level 11 (Android 3.0, Honeycomb)

CREATOR

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

Requires API level 11 (Android 3.0, Honeycomb)