api_uicontrols/com.tomtom.tools.android.api.uicontrols.informationcontrol/TtInformationControlViewModel

TtInformationControlViewModel

data class TtInformationControlViewModel(headImage: ImageDescriptor?, primaryTextArea: TtInformationControlViewModel.TextAreaViewModel, secondaryTextArea: TtInformationControlViewModel.TextAreaViewModel, tertiaryTextArea: TtInformationControlViewModel.TextAreaViewModel, onClick: () -> Unit?, ratingBarValue: Float?, ratingBarMaximumValue: Int, ratingBarText: StringResolver?, tailText: StringResolver?, tailIcon: DrawableResolver?, onTailSectionClick: () -> Unit?)

The ViewModel used to populate TtInformationControl.

A schematic overview of the information control:

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

Constructors

TtInformationControlViewModel

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

Types

TextAreaViewModel

data class TextAreaViewModel(text: StringResolver?, icon: DrawableResolver?)

ViewModel used to populate primaryTextArea, secondaryTextArea and tertiaryTextArea.

Properties

headImage

val headImage: ImageDescriptor? = null

The image shown in the Head section. This can be a layered image, e.g. an image with the text on top of it.

onClick

val onClick: () -> Unit? = null

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

onTailSectionClick

val onTailSectionClick: () -> Unit? = null

The callback function for when the Tail section is clicked.

primaryTextArea

val primaryTextArea: TtInformationControlViewModel.TextAreaViewModel

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

ratingBarMaximumValue

val ratingBarMaximumValue: Int

The maximum allowable value of ratingBarValue. The default value is DEFAULT_RATING_BAR_MAXIMUM_VALUE.

ratingBarText

val ratingBarText: StringResolver? = null

The additional text displayed together with the rating bar. If the value is null the text will not be displayed.

ratingBarValue

val ratingBarValue: Float? = null

The value represents the current rating. This value should be between 0 and ratingBarMaximumValue. If the value is null, then the entire rating bar will be hidden.

secondaryTextArea

val secondaryTextArea: TtInformationControlViewModel.TextAreaViewModel

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

tailIcon

val tailIcon: DrawableResolver? = null

The icon shown within the Tail section.

tailText

val tailText: StringResolver? = null

The text shown within the Tail section.

tertiaryTextArea

val tertiaryTextArea: TtInformationControlViewModel.TextAreaViewModel

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