Added in [API level 11](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)   
Deprecated in [API level 29](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) Summary: [Inherited Constants](https://developer.android.com/reference/android/preference/PreferenceActivity.Header#inhconstants) \| [Fields](https://developer.android.com/reference/android/preference/PreferenceActivity.Header#lfields) \| [Ctors](https://developer.android.com/reference/android/preference/PreferenceActivity.Header#pubctors) \| [Methods](https://developer.android.com/reference/android/preference/PreferenceActivity.Header#pubmethods) \| [Inherited Methods](https://developer.android.com/reference/android/preference/PreferenceActivity.Header#inhmethods)

# PreferenceActivity.Header

*** ** * ** ***

` public static final class PreferenceActivity.Header `   
` extends https://developer.android.com/reference/java/lang/Object ` ` implements https://developer.android.com/reference/android/os/Parcelable `

|---|---|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object) ||
| ↳ | android.preference.PreferenceActivity.Header |

<br />

*** ** * ** ***

<br />

**This class was deprecated in API level 29.**   

Use the [AndroidX](https://developer.android.com/jetpack/androidx) [Preference Library](https://developer.android.com/reference/androidx/preference/package-summary) for consistent behavior across all devices. For more information on using the AndroidX Preference Library see [Settings](https://developer.android.com/guide/topics/ui/settings).

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

## Summary

### Inherited constants

From interface `https://developer.android.com/reference/android/os/Parcelable` `int` `https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR`

Descriptor bit used with `https://developer.android.com/reference/android/os/Parcelable#describeContents()`: indicates that the Parcelable object's flattened representation includes a file descriptor.
`int` `https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE`

Flag for use with `https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int)`: 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 https://developer.android.com/reference/android/os/Parcelable.Creator<https://developer.android.com/reference/android/preference/PreferenceActivity.Header>` | `https://developer.android.com/reference/android/preference/PreferenceActivity.Header#CREATOR` <br /> |
| ` public https://developer.android.com/reference/java/lang/CharSequence` | `https://developer.android.com/reference/android/preference/PreferenceActivity.Header#breadCrumbShortTitle` Optional text to show as the short title in the bread crumb. |
| ` public int` | `https://developer.android.com/reference/android/preference/PreferenceActivity.Header#breadCrumbShortTitleRes` Resource ID of optional text to show as the short title in the bread crumb. |
| ` public https://developer.android.com/reference/java/lang/CharSequence` | `https://developer.android.com/reference/android/preference/PreferenceActivity.Header#breadCrumbTitle` Optional text to show as the title in the bread crumb. |
| ` public int` | `https://developer.android.com/reference/android/preference/PreferenceActivity.Header#breadCrumbTitleRes` Resource ID of optional text to show as the title in the bread crumb. |
| ` public https://developer.android.com/reference/android/os/Bundle` | `https://developer.android.com/reference/android/preference/PreferenceActivity.Header#extras` Optional additional data for use by subclasses of PreferenceActivity. |
| ` public https://developer.android.com/reference/java/lang/String` | `https://developer.android.com/reference/android/preference/PreferenceActivity.Header#fragment` Full class name of the fragment to display when this header is selected. |
| ` public https://developer.android.com/reference/android/os/Bundle` | `https://developer.android.com/reference/android/preference/PreferenceActivity.Header#fragmentArguments` Optional arguments to supply to the fragment when it is instantiated. |
| ` public int` | `https://developer.android.com/reference/android/preference/PreferenceActivity.Header#iconRes` Optional icon resource to show for this header. |
| ` public long` | `https://developer.android.com/reference/android/preference/PreferenceActivity.Header#id` Identifier for this header, to correlate with a new list when it is updated. |
| ` public https://developer.android.com/reference/android/content/Intent` | `https://developer.android.com/reference/android/preference/PreferenceActivity.Header#intent` Intent to launch when the preference is selected. |
| ` public https://developer.android.com/reference/java/lang/CharSequence` | `https://developer.android.com/reference/android/preference/PreferenceActivity.Header#summary` Optional summary describing what this header controls. |
| ` public int` | `https://developer.android.com/reference/android/preference/PreferenceActivity.Header#summaryRes` Resource ID of optional summary describing what this header controls. |
| ` public https://developer.android.com/reference/java/lang/CharSequence` | `https://developer.android.com/reference/android/preference/PreferenceActivity.Header#title` Title of the header that is shown to the user. |
| ` public int` | `https://developer.android.com/reference/android/preference/PreferenceActivity.Header#titleRes` Resource ID of title of the header that is shown to the user. |

| ### Public constructors ||
|---|---|
| ` https://developer.android.com/reference/android/preference/PreferenceActivity.Header#Header()() ` |

| ### Public methods ||
|---|---|
| ` int` | ` https://developer.android.com/reference/android/preference/PreferenceActivity.Header#describeContents()() ` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. |
| ` https://developer.android.com/reference/java/lang/CharSequence` | ` https://developer.android.com/reference/android/preference/PreferenceActivity.Header#getBreadCrumbShortTitle(android.content.res.Resources)(https://developer.android.com/reference/android/content/res/Resources res) ` Return the currently set bread crumb short title. |
| ` https://developer.android.com/reference/java/lang/CharSequence` | ` https://developer.android.com/reference/android/preference/PreferenceActivity.Header#getBreadCrumbTitle(android.content.res.Resources)(https://developer.android.com/reference/android/content/res/Resources res) ` Return the currently set bread crumb title. |
| ` https://developer.android.com/reference/java/lang/CharSequence` | ` https://developer.android.com/reference/android/preference/PreferenceActivity.Header#getSummary(android.content.res.Resources)(https://developer.android.com/reference/android/content/res/Resources res) ` Return the currently set summary. |
| ` https://developer.android.com/reference/java/lang/CharSequence` | ` https://developer.android.com/reference/android/preference/PreferenceActivity.Header#getTitle(android.content.res.Resources)(https://developer.android.com/reference/android/content/res/Resources res) ` Return the currently set title. |
| ` void` | ` https://developer.android.com/reference/android/preference/PreferenceActivity.Header#readFromParcel(android.os.Parcel)(https://developer.android.com/reference/android/os/Parcel in) ` |
| ` void` | ` https://developer.android.com/reference/android/preference/PreferenceActivity.Header#writeToParcel(android.os.Parcel,%20int)(https://developer.android.com/reference/android/os/Parcel dest, int flags) ` Flatten this object in to a Parcel. |

### Inherited methods

From class ` https://developer.android.com/reference/java/lang/Object ` ` https://developer.android.com/reference/java/lang/Object` ` https://developer.android.com/reference/java/lang/Object#clone()() `

Creates and returns a copy of this object.
` boolean` ` https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object)(https://developer.android.com/reference/java/lang/Object obj) `

Indicates whether some other object is "equal to" this one.
` void` ` https://developer.android.com/reference/java/lang/Object#finalize()() `

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
` final https://developer.android.com/reference/java/lang/Class<?>` ` https://developer.android.com/reference/java/lang/Object#getClass()() `

Returns the runtime class of this `Object`.
` int` ` https://developer.android.com/reference/java/lang/Object#hashCode()() `

Returns a hash code value for the object.
` final void` ` https://developer.android.com/reference/java/lang/Object#notify()() `

Wakes up a single thread that is waiting on this object's monitor.
` final void` ` https://developer.android.com/reference/java/lang/Object#notifyAll()() `

Wakes up all threads that are waiting on this object's monitor.
` https://developer.android.com/reference/java/lang/String` ` https://developer.android.com/reference/java/lang/Object#toString()() `

Returns a string representation of the object.
` final void` ` https://developer.android.com/reference/java/lang/Object#wait(long,%20int)(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` ` https://developer.android.com/reference/java/lang/Object#wait(long)(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` ` https://developer.android.com/reference/java/lang/Object#wait()() `

Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*.
From interface ` https://developer.android.com/reference/android/os/Parcelable ` ` abstract int` ` https://developer.android.com/reference/android/os/Parcelable#describeContents()() `

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
` abstract void` ` https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int)(https://developer.android.com/reference/android/os/Parcel dest, int flags) `

Flatten this object in to a Parcel.

## Fields

### CREATOR

Added in [API level 11](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final Creator<PreferenceActivity.Header> CREATOR
```

<br />

<br />

### breadCrumbShortTitle

Added in [API level 11](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public CharSequence breadCrumbShortTitle
```

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

<br />

### breadCrumbShortTitleRes

Added in [API level 11](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public int breadCrumbShortTitleRes
```

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

<br />

### breadCrumbTitle

Added in [API level 11](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public CharSequence breadCrumbTitle
```

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

<br />

### breadCrumbTitleRes

Added in [API level 11](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public int breadCrumbTitleRes
```

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

<br />

### extras

Added in [API level 11](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public Bundle extras
```

Optional additional data for use by subclasses of PreferenceActivity.

<br />

### fragment

Added in [API level 11](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public String fragment
```

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

<br />

### fragmentArguments

Added in [API level 11](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public Bundle fragmentArguments
```

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

<br />

### iconRes

Added in [API level 11](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public int iconRes
```

Optional icon resource to show for this header.

<br />

### id

Added in [API level 11](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public long id
```

Identifier for this header, to correlate with a new list when it is updated. The default value is `https://developer.android.com/reference/android/preference/PreferenceActivity#HEADER_ID_UNDEFINED`, meaning no id.

<br />

### intent

Added in [API level 11](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public Intent intent
```

Intent to launch when the preference is selected.

<br />

### summary

Added in [API level 11](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public CharSequence summary
```

Optional summary describing what this header controls.

<br />

### summaryRes

Added in [API level 11](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public int summaryRes
```

Resource ID of optional summary describing what this header controls.

<br />

### title

Added in [API level 11](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public CharSequence title
```

Title of the header that is shown to the user.

<br />

### titleRes

Added in [API level 11](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public int titleRes
```

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

<br />

## Public constructors

### Header

Added in [API level 11](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public Header ()
```

<br />

<br />

## Public methods

### describeContents

Added in [API level 11](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
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 `https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int)`, the return value of this method must include the `https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR` bit.

<br />

| Returns ||
|---|---|
| `int` | a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either `0` or - `https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR` |

### getBreadCrumbShortTitle

Added in [API level 11](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public CharSequence getBreadCrumbShortTitle (Resources res)
```

Return the currently set bread crumb short title. If `https://developer.android.com/reference/android/preference/PreferenceActivity.Header#breadCrumbShortTitleRes` is set, this resource is loaded from <var translate="no">res</var> and returned. Otherwise `https://developer.android.com/reference/android/preference/PreferenceActivity.Header#breadCrumbShortTitle` is returned.

<br />

| Parameters ||
|---|---|
| `res` | `Resources` <br /> |

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/CharSequence` | <br /> |

### getBreadCrumbTitle

Added in [API level 11](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public CharSequence getBreadCrumbTitle (Resources res)
```

Return the currently set bread crumb title. If `https://developer.android.com/reference/android/preference/PreferenceActivity.Header#breadCrumbTitleRes` is set, this resource is loaded from <var translate="no">res</var> and returned. Otherwise `https://developer.android.com/reference/android/preference/PreferenceActivity.Header#breadCrumbTitle` is returned.

<br />

| Parameters ||
|---|---|
| `res` | `Resources` <br /> |

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/CharSequence` | <br /> |

### getSummary

Added in [API level 11](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public CharSequence getSummary (Resources res)
```

Return the currently set summary. If `https://developer.android.com/reference/android/preference/PreferenceActivity.Header#summaryRes` is set, this resource is loaded from <var translate="no">res</var> and returned. Otherwise `https://developer.android.com/reference/android/preference/PreferenceActivity.Header#summary` is returned.

<br />

| Parameters ||
|---|---|
| `res` | `Resources` <br /> |

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/CharSequence` | <br /> |

### getTitle

Added in [API level 11](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public CharSequence getTitle (Resources res)
```

Return the currently set title. If `https://developer.android.com/reference/android/preference/PreferenceActivity.Header#titleRes` is set, this resource is loaded from <var translate="no">res</var> and returned. Otherwise `https://developer.android.com/reference/android/preference/PreferenceActivity.Header#title` is returned.

<br />

| Parameters ||
|---|---|
| `res` | `Resources` <br /> |

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/CharSequence` | <br /> |

### readFromParcel

Added in [API level 11](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public void readFromParcel (Parcel in)
```

<br />

<br />

| Parameters ||
|---|---|
| `in` | `Parcel` <br /> |

### writeToParcel

Added in [API level 11](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public void writeToParcel (Parcel dest, 
                int flags)
```

Flatten this object in to a Parcel.

<br />

| Parameters ||
|---|---|
| `dest` | `Parcel`: The Parcel in which the object should be written. This value cannot be `null`. <br /> |
| `flags` | `int`: Additional flags about how the object should be written. May be 0 or `https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE`. Value is either `0` or a combination of the following: - `https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE` |