BannerX/com.blueiobase.api.android.bannerx.base/IndicatorParams

IndicatorParams

data class IndicatorParams(var numberOfIndicatorPanels: Int = 0)

This class holds data and properties that can be shared among different BannerXIndicator implementations.

Author

IODevBlue

Since

1.0.0

Constructors

IndicatorParams

fun IndicatorParams(numberOfIndicatorPanels: Int = 0)

Properties

allowNumberIndicator

var allowNumberIndicator: Boolean = false

Enable or disable displaying number of banners on the indicator widget if there are any. Default: false.

applyMarqueeOnIndicatorText

var applyMarqueeOnIndicatorText: Boolean = false

Append a '...' at the end of any long text to truncate it on the indicator's TextView if present.

indicatorBackgroundDrawable

var indicatorBackgroundDrawable: Drawable? = null

The background Drawable for a BannerX indicator.

indicatorFadeOnIdle

var indicatorFadeOnIdle: Boolean = false

Apply a fade animation when the indicator widget is idle. Default: false.

indicatorFadeOnIdleDuration

var indicatorFadeOnIdleDuration: Long = 0

The time it takes for the indicator to be visible when idle before it fades away.

indicatorHorizontalArrangement

var indicatorHorizontalArrangement: IndicatorHorizontalArrangement

The horizontal position of the indicator widget. Default: IndicatorHorizontalArrangement.CENTER.

indicatorSelectedDrawable

var indicatorSelectedDrawable: Drawable? = null

The drawable for an indicator panel representing the currently selected Banner object.

indicatorStartEndMargin

@Dimension

var indicatorStartEndMargin: Int = 0

The uniform margin value applied to the outer horizontal bounds at the Start and End positions of the BannerX indicator.

indicatorStartEndPadding

@Dimension

var indicatorStartEndPadding: Int = 0

The uniform padding value applied to the inner horizontal bounds at the Start and End positions of the BannerX indicator.

indicatorTextColor

@ColorInt

var indicatorTextColor: Int = 0

Color of the text used by the indicator's TextView if present.

indicatorTextSize

@Dimension

var indicatorTextSize: Float = 0.0f

Text size used by the indicator's TextView if present.

indicatorTextTypeface

var indicatorTextTypeface: Typeface? = null

The Typeface applied on the text in the indicator's TextView if present.

indicatorTopBottomPadding

@Dimension

var indicatorTopBottomPadding: Int = 0

The uniform padding value applied to the inner vertical bounds at the Top and Bottom positions of the BannerX indicator.

indicatorUnselectedDrawable

var indicatorUnselectedDrawable: Drawable? = null

The drawable for an indicator panel representing an unselected Banner object.

numberIndicatorBackgroundDrawable

var numberIndicatorBackgroundDrawable: Drawable? = null

The background Drawable for the BannerX number indicator if there are any.

numberOfIndicatorPanels

var numberOfIndicatorPanels: Int = 0

The number of indicator panels that should be displayed.

showIndicatorText

var showIndicatorText: Boolean = false

Enable or disable the indicator widget's TextView if there are any. Default: false.