BannerXIndicator

abstract class BannerXIndicator(val params: IndicatorParams?) : Parcelable

This class represents an animated indicator anchored at the bottom of BannerX to indicate the current Banner object.

The IndicatorParams data class stores data for generally setting up BannerXIndicator classes to share and use the same properties. This is to aid in prompt setup if these data are available for uniformity when switching BannerXIndicator implementations.

Although not required, it is recommended that each implementation of this abstract class should have properties with the same signature name as properties in the IndicatorParams which perform similar functions.

Author

IODevBlue

Since

1.0.0

Constructors

Link copied to clipboard

Functions

Link copied to clipboard
abstract fun applyFadeOnIdle()

Apply a fade animation when the BannerXIndicator is idle to hide it.

Link copied to clipboard
abstract fun getIndicatorView(): View?

Get the View representation of the BannerXIndicator.

Link copied to clipboard
abstract fun onBannerScrolled(position: Int, positionOffset: Float, positionOffsetPixels: Int)

This is invoked by BannerX when the current Banner is being scrolled.

Link copied to clipboard
abstract fun onBannerSelected(position: Int)

This is invoked when a new Banner is selected by BannerX.

Link copied to clipboard
abstract fun removeFadeOnIdle()

Apply an animation to gradually display the BannerXIndicator when hidden.

Link copied to clipboard
abstract infix fun resetUsingParams(params: IndicatorParams)

Reset an existing BannerXIndicator instance to use the properties from the provided params object.

Link copied to clipboard
abstract fun setContext(context: Context): BannerXIndicator

The Context object to be used internally by the BannerXIndicator implementation.

Link copied to clipboard
abstract fun supportsBannerTitles(): Boolean

Validates if this BannerXIndicator supports displaying Banner titles.

Properties

Link copied to clipboard

Use the properties stored in this IndicatorParams object to setup the BannerXIndicator instance.

Inheritors

Link copied to clipboard