api_uicontrols/com.tomtom.tools.android.api.uicontrols.banner/TtBanner

TtBanner

open class TtBanner @JvmOverloads constructor(context: Context, attrs: AttributeSet?, defStyleAttr: Int) : FrameLayout

The banner UI control is used for in-place informational message. It can be placed next to other content to provide the user with contextual information.

A schematic overview of the banner:

 ______________________________________________________
|   ______  |                        |                |
|  |     |  |  Primary text          | Action label   |
|  |____ |  |  Secondary text        |                |
|___________|________________________|________________|

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. The default value is R.attr.tt_banner_style.

Constructors

TtBanner

@JvmOverloads

fun TtBanner(context: Context, attrs: AttributeSet? = null, defStyleAttr: Int = R.attr.tt_banner_style)

Properties

maximumWidth

@Px

var maximumWidth: Int? = null

The maximum amount of pixels that the banner will be wide.

onActionLabelClicked

var onActionLabelClicked: () -> Unit?

The action to perform while clicking on ttActionLabel.

ttActionLabel

var ttActionLabel: String? = null

A clickable label shown at the end of the banner. When clicked, onActionLabelClicked will be called.

ttActionLabelColor

@ColorInt

var ttActionLabelColor: Int

The color of the action label text.

ttDrawableImageType

var ttDrawableImageType: ImageType?

The ImageType of the drawable displayed in front of the banner. The default value is ImageType.DEFAULT.

ttPrimaryText

var ttPrimaryText: String? = null

The primary text displayed in the banner.

ttPrimaryTextColor

@ColorInt

var ttPrimaryTextColor: Int

The color of the primary text.

ttSecondaryText

var ttSecondaryText: String? = null

The secondary text displayed in the banner.

ttSecondaryTextColor

@ColorInt

var ttSecondaryTextColor: Int

The color of the secondary text.

Functions

setTtActionLabel

fun setTtActionLabel(stringResolver: StringResolver?)

Sets the given StringResolver which applies to ttActionLabel. When set to null, ttActionLabel is cleared.

setTtDrawable

fun setTtDrawable(drawableResolver: DrawableResolver?)

Sets a drawable to be displayed in front of the banner. When set to null, no drawable is shown.

fun setTtDrawable(@DrawableRes resId: Int?)

Sets a drawable resource to be displayed in front of the banner. When set to null, no drawable is shown.

setTtPrimaryText

fun setTtPrimaryText(stringResolver: StringResolver?)

Sets the given StringResolver which applies to ttPrimaryText. When set to null, ttPrimaryText is cleared.

setTtSecondaryText

fun setTtSecondaryText(stringResolver: StringResolver?)

Sets the given StringResolver which applies to ttSecondaryText. When set to null, ttSecondaryText is cleared.

setTtTintableIcon

fun setTtTintableIcon(drawableResolver: DrawableResolver?)

Sets an icon to be displayed in front of the banner. And the icon will be tinted by the text color of ttPrimaryText. It's suggested to choose the icon carefully, usually with the white background color, to make the drawable look good. When set to null, no drawable is shown.

fun setTtTintableIcon(@DrawableRes resId: Int?)

Sets an icon resource to be displayed in front of the banner. And the icon will be tinted by the text color of ttPrimaryText. It's suggested to choose the icon carefully, usually with the white background color, to make the drawable look good. When set to null, no drawable is shown.