belongs to Maven artifact androidx.car:car:1.0.0-alpha5

TextListItem

public class TextListItem
extends ListItem<TextListItem.ViewHolder>

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

Class to build a list item of text.

An item supports primary action and supplemental action(s).

An item visually composes of 3 parts; each part may contain multiple views.

Primary Action: represented by an icon of following types.
- Primary Icon - icon size could be large or small.
- No Icon - no icon is shown.
- Empty Icon - Text offsets start space as if there was an icon.
Text: supports any combination of the following text views.
- Title
- Body
Supplemental Action: represented by one of the following types; aligned toward the end of item.
- Supplemental Icon
- One Action Button
- Two Action Buttons
- Switch

TextListItem binds data to TextListItem.ViewHolder based on components selected.

When conflicting setter methods are called (e.g. setting primary action to both primary icon and no icon), the last called method wins.

Summary

Nested classes
`class`	`TextListItem.ViewHolder` Holds views of TextListItem.

Constants
`int`	`PRIMARY_ACTION_ICON_SIZE_LARGE` Large sized icon is as tall as a list item with only `title` text.
`int`	`PRIMARY_ACTION_ICON_SIZE_MEDIUM` Medium sized icon is slightly bigger than `SMALL` ones.
`int`	`PRIMARY_ACTION_ICON_SIZE_SMALL` Small sized icon is the mostly commonly used size.

Public constructors
`TextListItem(Context context)`

Public methods
`static TextListItem.ViewHolder`	`createViewHolder(View itemView)` Creates a `TextListItem.ViewHolder`.
`int`	`getViewType()` Used by `ListItemAdapter` to choose layout to inflate for view holder.
`void`	`onBind(TextListItem.ViewHolder viewHolder)` Hides all views in `TextListItem.ViewHolder` then applies ViewBinders to adjust view layout params.
`void`	`setAction(String text, boolean showDivider, View.OnClickListener listener)` Sets `Supplemental Action` to be represented by an `Action Button`.
`void`	`setActions(String action1Text, boolean showAction1Divider, View.OnClickListener action1OnClickListener, String action2Text, boolean showAction2Divider, View.OnClickListener action2OnClickListener)` Sets `Supplemental Action` to be represented by two `Action Button`s.
`void`	`setBody(String body, boolean asPrimary)` Sets the body text of item.
`void`	`setBody(String body)` Sets the body text of item.
`void`	`setEnabled(boolean enabled)` Sets the enabled state of the bound `ListItem.ViewHolder`.
`void`	`setOnClickListener(View.OnClickListener listener)` Sets `View.OnClickListener` of `TextListItem`.
`void`	`setPrimaryActionEmptyIcon()` Sets `Primary Action` to be empty icon.
`void`	`setPrimaryActionIcon(Drawable drawable, boolean useLargeIcon)` This method is deprecated. use `setPrimaryActionIconSize(int)` instead.
`void`	`setPrimaryActionIcon(Drawable drawable)` Sets `Primary Action` to be represented by an icon.
`void`	`setPrimaryActionIcon(int iconResId, boolean useLargeIcon)` This method is deprecated. use `setPrimaryActionIconSize(int)` instead.
`void`	`setPrimaryActionIcon(int iconResId)` Sets `Primary Action` to be represented by an icon.
`void`	`setPrimaryActionIconSize(int size)` Sets the size of `Primary Action Icon`.
`void`	`setPrimaryActionNoIcon()` Sets `Primary Action` to have no icon.
`void`	`setSupplementalIcon(int iconResId, boolean showDivider)` Sets `Supplemental Action` to be represented by an `Supplemental Icon`.
`void`	`setSupplementalIcon(Drawable drawable, boolean showDivider)` Sets `Supplemental Action` to be represented by an `Supplemental Icon`.
`void`	`setSupplementalIcon(Drawable drawable, boolean showDivider, View.OnClickListener listener)` Sets `Supplemental Action` to be represented by an `Supplemental Icon`.
`void`	`setSupplementalIcon(int iconResId, boolean showDivider, View.OnClickListener listener)` Sets `Supplemental Action` to be represented by an `Supplemental Icon`.
`void`	`setSwitch(boolean checked, boolean showDivider, CompoundButton.OnCheckedChangeListener listener)` Sets `Supplemental Action` to be represented by a `Switch`.
`void`	`setSwitchState(boolean isChecked)` Sets the state of `Switch`.
`void`	`setTitle(String title)` Sets the title of item.

Protected methods
`void`	`resolveDirtyState()` Calculates the layout params for views in `TextListItem.ViewHolder`.

Inherited methods

From class


        
          androidx.car.widget.ListItem

`final void`	`addViewBinder(ViewBinder<TextListItem.ViewHolder> binder, ViewBinder<TextListItem.ViewHolder> cleanUp)` Adds `ListItem.ViewBinder` to interact with sub-views in `ListItem.ViewHolder`.
`final void`	`addViewBinder(ViewBinder<TextListItem.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(TextListItem.ViewHolder viewHolder)` Binds this ListItem to `viewHolder` by applying data in ListItem to sub-views.
`boolean`	`removeViewBinder(ViewBinder<TextListItem.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`	`setHideDivider(boolean hideDivider)` This method is deprecated. Use `setShowDivider(boolean)`.
`void`	`setShowDivider(boolean showDivider)` Whether to show the item divider coming after this `ListItem`.
`boolean`	`shouldHideDivider()` This method is deprecated. Use `getShowDivider()`.

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

PRIMARY_ACTION_ICON_SIZE_LARGE

public static final int PRIMARY_ACTION_ICON_SIZE_LARGE

Large sized icon is as tall as a list item with only title text. It is intended for album art.

Constant Value: 2 (0x00000002)

PRIMARY_ACTION_ICON_SIZE_MEDIUM

public static final int PRIMARY_ACTION_ICON_SIZE_MEDIUM

Medium sized icon is slightly bigger than SMALL ones. It is intended for profile pictures (avatar), in which case caller is responsible for passing in a circular image.

Constant Value: 1 (0x00000001)

PRIMARY_ACTION_ICON_SIZE_SMALL

public static final int PRIMARY_ACTION_ICON_SIZE_SMALL

Small sized icon is the mostly commonly used size. It's the same as supplemental action icon.

Constant Value: 0 (0x00000000)

Public constructors

TextListItem

public TextListItem (Context context)

Parameters
`context`	`Context`

Public methods

createViewHolder

public static TextListItem.ViewHolder createViewHolder (View itemView)

Creates a TextListItem.ViewHolder.

Parameters
`itemView`	`View`

Returns
`TextListItem.ViewHolder`

getViewType

public int getViewType ()

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

Returns
`int`	type of this ListItem.

public void onBind (TextListItem.ViewHolder viewHolder)

Hides all views in TextListItem.ViewHolder then applies ViewBinders to adjust view layout params.

Parameters
`viewHolder`	`TextListItem.ViewHolder`

setAction

public void setAction (String text, 
                boolean showDivider, 
                View.OnClickListener listener)

Sets Supplemental Action to be represented by an Action Button.

Parameters
`text`	`String`: button text to display.
`showDivider`	`boolean`: whether to display a vertical bar that separates `Text` and `Action Button`.
`listener`	`View.OnClickListener`: the callback that will run when action button is clicked.

setActions

public void setActions (String action1Text, 
                boolean showAction1Divider, 
                View.OnClickListener action1OnClickListener, 
                String action2Text, 
                boolean showAction2Divider, 
                View.OnClickListener action2OnClickListener)

Sets Supplemental Action to be represented by two Action Buttons.

These two action buttons will be aligned towards item end.

Parameters
`action1Text`	`String`: button text to display - this button will be closer to item end.
`showAction1Divider`	`boolean`
`action1OnClickListener`	`View.OnClickListener`
`action2Text`	`String`: button text to display.
`showAction2Divider`	`boolean`
`action2OnClickListener`	`View.OnClickListener`

setBody

public void setBody (String body, 
                boolean asPrimary)

Sets the body text of item.

Parameters
`body`	`String`: text to be displayed.
`asPrimary`	`boolean`: sets `Body Text` as primary text of item.

setBody

public void setBody (String body)

Sets the body text of item.

Text beyond length required by regulation will be truncated. Defaults Title text as the primary.

Parameters
`body`	`String`: text to be displayed.

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`

setOnClickListener

public void setOnClickListener (View.OnClickListener listener)

Sets View.OnClickListener of TextListItem.

Parameters
`listener`	`View.OnClickListener`

setPrimaryActionEmptyIcon

public void setPrimaryActionEmptyIcon ()

Sets Primary Action to be empty icon.

Text would have a start margin as if Primary Action were set to primary icon.

setPrimaryActionIcon

public void setPrimaryActionIcon (Drawable drawable, 
                boolean useLargeIcon)

This method is deprecated.
use setPrimaryActionIconSize(int) instead.

Sets Primary Action to be represented by an icon.

Parameters
`drawable`	`Drawable`: the Drawable to set, or null to clear the content.
`useLargeIcon`	`boolean`: the size of primary icon. Large Icon is a square as tall as an item.

setPrimaryActionIcon

public void setPrimaryActionIcon (Drawable drawable)

Sets Primary Action to be represented by an icon.

Parameters
`drawable`	`Drawable`: the Drawable to set, or null to clear the content.

setPrimaryActionIcon

public void setPrimaryActionIcon (int iconResId, 
                boolean useLargeIcon)

This method is deprecated.
use setPrimaryActionIconSize(int) instead.

Sets Primary Action to be represented by an icon.

Parameters
`iconResId`	`int`: the resource identifier of the drawable.
`useLargeIcon`	`boolean`: the size of primary icon. Large Icon is a square as tall as an item.

setPrimaryActionIcon

public void setPrimaryActionIcon (int iconResId)

Sets Primary Action to be represented by an icon.

Parameters
`iconResId`	`int`: the resource identifier of the drawable.

setPrimaryActionIconSize

public void setPrimaryActionIconSize (int size)

Sets the size of Primary Action Icon.

Parameters
`size`	`int`: small/medium/large. Available as `PRIMARY_ACTION_ICON_SIZE_SMALL`, `PRIMARY_ACTION_ICON_SIZE_MEDIUM`, `PRIMARY_ACTION_ICON_SIZE_LARGE`.

setPrimaryActionNoIcon

public void setPrimaryActionNoIcon ()

Sets Primary Action to have no icon. Text would align to the start of item.

setSupplementalIcon

public void setSupplementalIcon (int iconResId, 
                boolean showDivider)

Sets Supplemental Action to be represented by an Supplemental Icon.

Parameters
`iconResId`	`int`: drawable resource id.
`showDivider`	`boolean`: whether to display a vertical bar that separates `text` and `Supplemental Icon`.

setSupplementalIcon

public void setSupplementalIcon (Drawable drawable, 
                boolean showDivider)

Sets Supplemental Action to be represented by an Supplemental Icon.

Parameters
`drawable`	`Drawable`: the Drawable to set, or null to clear the content.
`showDivider`	`boolean`: whether to display a vertical bar that separates `text` and `Supplemental Icon`.

setSupplementalIcon

public void setSupplementalIcon (Drawable drawable, 
                boolean showDivider, 
                View.OnClickListener listener)

Sets Supplemental Action to be represented by an Supplemental Icon.

Parameters
`drawable`	`Drawable`: the Drawable to set, or null to clear the content.
`showDivider`	`boolean`: whether to display a vertical bar that separates `text` and `Supplemental Icon`.
`listener`	`View.OnClickListener`: the callback that will run when icon is clicked.

setSupplementalIcon

public void setSupplementalIcon (int iconResId, 
                boolean showDivider, 
                View.OnClickListener listener)

Sets Supplemental Action to be represented by an Supplemental Icon.

Parameters
`iconResId`	`int`: drawable resource id.
`showDivider`	`boolean`: whether to display a vertical bar that separates `text` and `Supplemental Icon`.
`listener`	`View.OnClickListener`: the callback that will run when icon is clicked.

public void setSwitch (boolean checked, 
                boolean showDivider, 
                CompoundButton.OnCheckedChangeListener listener)

Sets Supplemental Action to be represented by a Switch.

Parameters
`checked`	`boolean`: initial value for switched.
`showDivider`	`boolean`: whether to display a vertical bar between switch and text.
`listener`	`CompoundButton.OnCheckedChangeListener`: callback to be invoked when the checked state is markDirty.

setSwitchState

public void setSwitchState (boolean isChecked)

Sets the state of Switch. For this method to take effect, setSwitch(boolean, boolean, CompoundButton.OnCheckedChangeListener) must be called first to set Supplemental Action as a Switch.

Parameters
`isChecked`	`boolean`: sets the "checked/unchecked, namely on/off" state of switch.

setTitle

public void setTitle (String title)

Sets the title of item.

Primary text is Title by default. It can be set by setBody(String, boolean)

Title text is limited to one line, and ellipses at the end.

Parameters
`title`	`String`: text to display as title.

Protected methods

resolveDirtyState

protected void resolveDirtyState ()

Calculates the layout params for views in TextListItem.ViewHolder.

TextListItem

Summary

Nested classes

Constants

Public constructors

Public methods

Protected methods

Inherited methods

Constants

PRIMARY_ACTION_ICON_SIZE_LARGE

PRIMARY_ACTION_ICON_SIZE_MEDIUM

PRIMARY_ACTION_ICON_SIZE_SMALL

Public constructors

TextListItem

Public methods

createViewHolder

getViewType

onBind

setAction

setActions

setBody

setBody

setEnabled

setOnClickListener

setPrimaryActionEmptyIcon

setPrimaryActionIcon

setPrimaryActionIcon

setPrimaryActionIcon

setPrimaryActionIcon

setPrimaryActionIconSize

setPrimaryActionNoIcon

setSupplementalIcon

setSupplementalIcon

setSupplementalIcon

setSupplementalIcon

setSwitch

setSwitchState

setTitle

Protected methods

resolveDirtyState