Package-level declarations

Types

Link copied to clipboard

ArrowOrientation determines the orientation of the arrow.

Link copied to clipboard

ArrowOrientationRules determines the orientation of the arrow depending on the aligning rules.

Link copied to clipboard

ArrowPositionRules determines the position of the arrow depending on the aligning rules.

Link copied to clipboard

Balloon implements a customizable tooltips popup with and arrow and animations.

Link copied to clipboard

BalloonAlign decides where the balloon should be placed.

Link copied to clipboard

BalloonAnimation is the collection of the popup animations.

Link copied to clipboard

BalloonCenterAlign is an aligning rule for the Balloon.showAtCenter.

Link copied to clipboard

BalloonHighlightAnimation gives repeated dynamic animations on Balloon when it's showing. The animation would work differently by the position of the arrow.

Link copied to clipboard

BalloonPreferenceManager helps to persist showing counts.

Link copied to clipboard

A specification interface for determining sizes of the Balloon materials. We can wrap some materials depending on their size of content using this interface.

Link copied to clipboard
class IconForm

IconForm is an attribute class which has TextView attributes for customizing popup icons easily.

Link copied to clipboard

IconGravity determines the orientation of the icon.

Link copied to clipboard

Interface definition for a callback to be invoked when a balloon view is clicked.

Link copied to clipboard

Interface definition for a callback to be invoked when a balloon view is dismissed.

Link copied to clipboard

Interface definition for a callback to be invoked when a balloon view is initialized.

Link copied to clipboard

Interface definition for a callback to be invoked when touched on outside of the balloon popup.

Link copied to clipboard

Interface definition for a callback to be invoked when a balloon overlay view is clicked.

Link copied to clipboard
class TextForm

TextFrom is an attribute class what has some attributes about TextView for customizing popup texts easily.

Functions

Link copied to clipboard

Returns a Lazy delegate to access the custom View's Balloon property. The balloon property will be initialized lazily.

Returns a Lazy delegate to access the ComponentActivity's Balloon property. The balloon property will be initialized lazily.

Returns a Lazy delegate to access the Fragment's Balloon property. The balloon property will be initialized lazily.

inline fun <T : Balloon.Factory> ViewBinding.balloon(): Lazy<Balloon>

Returns a Lazy delegate to access the custom ViewBinding's Balloon property. The balloon property will be initialized lazily.

Link copied to clipboard
inline fun createBalloon(context: Context, crossinline block: Balloon.Builder.() -> Unit): Balloon

Creates an instance of the Balloon by scope of the Balloon.Builder using kotlin dsl.

Link copied to clipboard
inline fun iconForm(context: Context, crossinline block: IconForm.Builder.() -> Unit): IconForm

creates an instance of IconForm from IconForm.Builder using kotlin dsl.

Link copied to clipboard
fun View.showAlign(balloon: Balloon, align: BalloonAlign, subAnchorList: List<View> = listOf(), xOff: Int = 0, yOff: Int = 0)

shows the balloon on an anchor view depending on the align alignment with x-off and y-off.

Link copied to clipboard
fun View.showAlignBottom(balloon: Balloon, xOff: Int = 0, yOff: Int = 0)

shows the balloon on an anchor view as the bottom alignment with x-off and y-off.

Link copied to clipboard
fun View.showAlignLeft(balloon: Balloon, xOff: Int = 0, yOff: Int = 0)

shows the balloon on an anchor view as the left alignment with x-off and y-off.

Link copied to clipboard
fun View.showAlignRight(balloon: Balloon, xOff: Int = 0, yOff: Int = 0)

shows the balloon on an anchor view as the right alignment with x-off and y-off.

Link copied to clipboard
fun View.showAlignTop(balloon: Balloon, xOff: Int = 0, yOff: Int = 0)

shows the balloon on an anchor view as the top alignment with x-off and y-off.

Link copied to clipboard
fun View.showAsDropDown(balloon: Balloon, xOff: Int = 0, yOff: Int = 0)

shows the balloon on an anchor view as drop down with x-off and y-off.

Link copied to clipboard
fun View.showAtCenter(balloon: Balloon, xOff: Int = 0, yOff: Int = 0, centerAlign: BalloonCenterAlign = BalloonCenterAlign.TOP)

shows the balloon on the center of an anchor view.

Link copied to clipboard
inline fun textForm(context: Context, crossinline block: TextForm.Builder.() -> Unit): TextForm

creates an instance of TextForm from TextForm.Builder using kotlin dsl.