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

TtInformationControl

class TtInformationControl @JvmOverloads constructor(context: Context, attrs: AttributeSet? = null, defStyleAttr: Int = ID_NULL) : ConstraintLayout

A reusable UI control that can be used for displaying information.

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

All theme attributes used by this control are declared in com.tomtom.tools.android.core.theme. To use this control, it is mandatory to define these attribute values.

Parameters

context

The display context.

attrs

The attribute set provided in the layout XML file.

defStyleAttr

The default style attribute set.

Constructors

TtInformationControl

@JvmOverloads

constructor(context: Context, attrs: AttributeSet? = null, defStyleAttr: Int = ID_NULL)

Types

Companion

object Companion

Properties

ttHeadImage

var ttHeadImage: ImageDescriptor?

The image shown in the Head section. This can be a layered image, for example an image with the text on top of it. If set to null, the head image will not be displayed.

ttOnClick

var ttOnClick: () -> Unit?

The callback function for when the Head section or the Main section is clicked. If set to null, no callback will be triggered when a user clicks the Head section or the Main section.

ttOnTailSectionClick

var ttOnTailSectionClick: () -> Unit?

The callback function for when the Tail section is clicked. If set to null, no callback will be triggered when a user clicks the Tail section.

ttPrimaryIcon

var ttPrimaryIcon: DrawableResolver?

The Primary icon within the Main section. If set to null, the primary icon will not be displayed.

ttPrimaryText

var ttPrimaryText: StringResolver?

The Primary text within the Main section. If set to null, the primary text will not be displayed.

ttPrimaryTextAppearance

@StyleRes

var ttPrimaryTextAppearance: Int

The appearance of the primary text in the Main section. The default appearance is defined by R.attr.tt_title_text_style_m.

ttPrimaryTextColor

@ColorInt

var ttPrimaryTextColor: Int

The color of the primary text in the Main section.

ttPrimaryTextMaxLines

var ttPrimaryTextMaxLines: Int

How many lines may be presented in the primary text area in the Main section. The default maximum lines is 1.

ttRatingBarMaximumValue

var ttRatingBarMaximumValue: Int

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

ttRatingBarText

var ttRatingBarText: StringResolver?

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

ttRatingBarTextAppearance

@StyleRes

var ttRatingBarTextAppearance: Int

The appearance of the rating bar text in the Main section. The default appearance is defined by R.attr.tt_body_text_style_m.

ttRatingBarTextColor

@ColorInt

var ttRatingBarTextColor: Int

The color of the rating bar text in the Main section.

ttRatingBarValue

var ttRatingBarValue: Float?

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

TtInformationControl

Parameters

Constructors

Types

Properties

Inherited functions