SubheaderListItem

public class SubheaderListItem
extends ListItem<SubheaderListItem.ViewHolder>

java.lang.Object
↳	androidx.car.widget.ListItem<androidx.car.widget.SubheaderListItem.ViewHolder>
	↳	androidx.car.widget.SubheaderListItem

Class to build a sub-header list item.

A sub-header list item consists of a one-line text. Its margin can be adjusted to match the rest of ListItem through setTextStartMarginType(int).

Summary

Nested classes
`@interface`	`SubheaderListItem.TextStartMarginType`
`class`	`SubheaderListItem.ViewHolder` Holds views of SubHeaderListItem.

Constants
`int`	`TEXT_START_MARGIN_TYPE_LARGE` A large starting margin before the subheader text.
`int`	`TEXT_START_MARGIN_TYPE_NONE` No starting margin before the subheader text.
`int`	`TEXT_START_MARGIN_TYPE_SMALL` A small starting margin before the subheader text.

Public constructors
`SubheaderListItem(Context context, CharSequence text)`

Public methods
`static SubheaderListItem.ViewHolder`	`createViewHolder(View itemView)` Creates a `SubheaderListItem.ViewHolder`.
`int`	`getViewType()` Used by `ListItemAdapter` to choose layout to inflate for view holder.
`void`	`setEnabled(boolean enabled)` Sets the enabled state of the bound `ListItem.ViewHolder`.
`void`	`setText(CharSequence text)` Sets the text to be displayed; cannot be null or empty string.
`void`	`setTextStartMarginType(int type)` Sets the start margin of text.

Protected methods
`Context`	`getContext()`
`void`	`onBind(SubheaderListItem.ViewHolder viewHolder)` Applies ViewBinders to adjust view layout params.
`void`	`resolveDirtyState()` Calculates layout params for views in `SubheaderListItem.ViewHolder`.

Inherited methods

From class


        
          androidx.car.widget.ListItem

`final void`	`addViewBinder(ViewBinder<SubheaderListItem.ViewHolder> binder, ViewBinder<SubheaderListItem.ViewHolder> cleanUp)` Adds `ListItem.ViewBinder` to interact with sub-views in `ListItem.ViewHolder`.
`final void`	`addViewBinder(ViewBinder<SubheaderListItem.ViewHolder> binder)` Same as `addViewBinder(ViewBinder, ViewBinder)` when `cleanUp` ViewBinder is null.
`boolean`	`getShowDivider()` Returns whether or not the divider that comes after this ListItem should be shown.
`abstract int`	`getViewType()` Classes that extends `ListItem` should register its view type in `ListItemAdapter.registerListItemViewType(int, int, Function)`.
`boolean`	`isDirty()`
`void`	`markClean()` Marks this item as not dirty.
`void`	`markDirty()` Marks this item as dirty so `resolveDirtyState()` is required in next bind() call.
`abstract void`	`onBind(SubheaderListItem.ViewHolder viewHolder)` Binds this ListItem to `viewHolder` by applying data in ListItem to sub-views.
`boolean`	`removeViewBinder(ViewBinder<SubheaderListItem.ViewHolder> binder)` Removes the first occurrence of the specified item.
`abstract void`	`resolveDirtyState()` Does the work that moves the ListItem from dirty state to clean state, i.e.
`abstract void`	`setEnabled(boolean enabled)` Sets the enabled state of the bound `ListItem.ViewHolder`.
`void`	`setShowDivider(boolean showDivider)` Whether to show the item divider coming after this `ListItem`.

From class


        
          java.lang.Object

`Object`	`clone()`
`boolean`	`equals(Object arg0)`
`void`	`finalize()`
`final Class<?>`	`getClass()`
`int`	`hashCode()`
`final void`	`notify()`
`final void`	`notifyAll()`
`String`	`toString()`
`final void`	`wait(long arg0, int arg1)`
`final void`	`wait(long arg0)`
`final void`	`wait()`

Constants

TEXT_START_MARGIN_TYPE_LARGE

public static final int TEXT_START_MARGIN_TYPE_LARGE

A large starting margin before the subheader text.

Constant Value: 2 (0x00000002)

TEXT_START_MARGIN_TYPE_NONE

public static final int TEXT_START_MARGIN_TYPE_NONE

No starting margin before the subheader text.

Constant Value: 0 (0x00000000)

TEXT_START_MARGIN_TYPE_SMALL

public static final int TEXT_START_MARGIN_TYPE_SMALL

A small starting margin before the subheader text.

Constant Value: 1 (0x00000001)

Public constructors

SubheaderListItem

public SubheaderListItem (Context context, 
                CharSequence text)

Parameters
`context`	`Context`
`text`	`CharSequence`

Public methods

createViewHolder

public static SubheaderListItem.ViewHolder createViewHolder (View itemView)

Creates a SubheaderListItem.ViewHolder.

Parameters
`itemView`	`View`

Returns
`SubheaderListItem.ViewHolder`

getViewType

public int getViewType ()

Used by ListItemAdapter to choose layout to inflate for view holder.

Returns
`int`	type of this ListItem.

setEnabled

public void setEnabled (boolean enabled)

Sets the enabled state of the bound ListItem.ViewHolder.

All visible children views of ViewHolder should be set to enabled. Caller is responsible for notifying ListItemAdapter about data change.

Disabled items are usually styled at 50% opacity. Consider similar styling for consistency.

Parameters
`enabled`	`boolean`

setText

public void setText (CharSequence text)

Sets the text to be displayed; cannot be null or empty string.

Parameters
`text`	`CharSequence`

setTextStartMarginType

public void setTextStartMarginType (int type)

Sets the start margin of text. Defaults to TEXT_START_MARGIN_TYPE_NONE.

Parameters
`type`	`int`

Protected methods

getContext

protected Context getContext ()

Returns
`Context`

protected void onBind (SubheaderListItem.ViewHolder viewHolder)

Applies ViewBinders to adjust view layout params.

Parameters
`viewHolder`	`SubheaderListItem.ViewHolder`

resolveDirtyState

protected void resolveDirtyState ()

Calculates layout params for views in SubheaderListItem.ViewHolder.

SubheaderListItem

Summary

Nested classes

Constants

Public constructors

Public methods

Protected methods

Inherited methods

Constants

TEXT_START_MARGIN_TYPE_LARGE

TEXT_START_MARGIN_TYPE_NONE

TEXT_START_MARGIN_TYPE_SMALL

Public constructors

SubheaderListItem

Public methods

createViewHolder

getViewType

setEnabled

setText

setTextStartMarginType

Protected methods

getContext

onBind

resolveDirtyState

Annotations

Interfaces

Classes

Enums