api_uicontrols/com.tomtom.tools.android.api.uicontrols.recyclerview/ListItemContentViewModel

ListItemContentViewModel

open class ListItemContentViewModel(val itemId: Any, val headImage: ImageDescriptor? = null, val primaryTextArea: ListItemContentViewModel.TextAreaViewModel = TextAreaViewModel(), val secondaryTextArea: ListItemContentViewModel.TextAreaViewModel = TextAreaViewModel(), val tertiaryTextArea: ListItemContentViewModel.TextAreaViewModel = TextAreaViewModel(), val onClick: () -> Unit? = null, val ratingBarValue: Float? = null, val ratingBarMaximumValue: Int = RATING_BAR_MAXIMUM_VALUE, val ratingBarText: StringResolver? = null, val tailText: StringResolver? = null, val tailIcon: DrawableResolver? = null, val onTailSectionClick: () -> Unit? = null) : ListItemViewModel

The ViewModel for populating the content of a non-header item in a TtListRecyclerView.

An item consists of a Head section, a Main section and a Tail section. The schematic overview of the item looks as below:

 _____________________________________________________________
|   ______  |  O Primary text            |                   |
|  |     |  |  O Secondary text          |            ____   |
|  |     |  |  O Tertiary text           | Tail text |   |   |
|  |_____|  |  ***** Rating bar text     |           |___|   |
|___________|____________________________|___________________|
    Head             Main                         Tail
   section          section                      section

Clients can inherit this ViewModel to provide more controls for the item, e.g. additional properties can be used to change the appearances of sections dynamically through the layout data-binding.

Parameters

itemId

A unique stable ID for the content item. See ListItemViewModel.itemId.

headImage

The image shown in the Head section. This can be a layered image with a radius.

primaryTextArea

The text area showing the Primary icon and the Primary text within the Main section.

secondaryTextArea

The text area showing the Secondary icon and the Secondary text within the Main section.

tertiaryTextArea

The text area showing the Tertiary icon and the Tertiary text within the Main section.

onClick

The callback function for when the Head section or Main section is clicked.

ratingBarValue

The value represents the current rating.

ratingBarMaximumValue

The maximum number to ratingBarValue.

ratingBarText

The additional text displayed together with the rating bar.

tailText

The text shown within the Tail section.

tailIcon

The image shown within the Tail section.

onTailSectionClick

The callback function for when specifically the Tail section is clicked.

Constructors

ListItemContentViewModel

fun ListItemContentViewModel(itemId: Any, headImage: DrawableResolver? = null, primaryIcon: DrawableResolver? = null, primaryText: StringResolver? = null, secondaryIcon: DrawableResolver? = null, secondaryText: StringResolver? = null, tertiaryIcon: DrawableResolver? = null, tertiaryText: StringResolver? = null, onClick: () -> Unit? = null, ratingBarValue: Float? = null, ratingBarMaximumValue: Int = RATING_BAR_MAXIMUM_VALUE, ratingBarText: StringResolver? = null, tailText: StringResolver? = null, tailIcon: DrawableResolver? = null, onTailSectionClick: () -> Unit? = null)

A convenience constructor to populate the ViewModel where its headImage's ImageDescriptor.image is the headImage and the ImageType is ImageType.TINTABLE_ICON.

ListItemContentViewModel

fun ListItemContentViewModel(itemId: Any, headImage: ImageDescriptor? = null, primaryTextArea: ListItemContentViewModel.TextAreaViewModel = TextAreaViewModel(), secondaryTextArea: ListItemContentViewModel.TextAreaViewModel = TextAreaViewModel(), tertiaryTextArea: ListItemContentViewModel.TextAreaViewModel = TextAreaViewModel(), onClick: () -> Unit? = null, ratingBarValue: Float? = null, ratingBarMaximumValue: Int = RATING_BAR_MAXIMUM_VALUE, ratingBarText: StringResolver? = null, tailText: StringResolver? = null, tailIcon: DrawableResolver? = null, onTailSectionClick: () -> Unit? = null)