balloon/com.skydoves.balloon/Balloon

Balloon

class Balloon : DefaultLifecycleObserver

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

Parameters

context

A context for creating and accessing internal resources.

builder

A Balloon.Builder for creating an instance of the Balloon.

See also

(https://github.com/skydoves/balloon)

Types

Link copied to clipboard
class Builder(context: Context)

Builder class for creating Balloon.

Link copied to clipboard
object Companion
Link copied to clipboard
abstract class Factory

An abstract factory class for creating Balloon instance. A factory implementation class must have a default (non-argument) constructor. This class is used to initialize an instance of the Balloon lazily in Activities and Fragments.

Properties

Link copied to clipboard
val bodyWindow: PopupWindow

A main content window of the popup.

Link copied to clipboard
var currentAlign: BalloonAlign?

Denotes the align of the currently displaying balloon.

Link copied to clipboard
var isShowing: Boolean

Denotes the popup is showing or not.

Link copied to clipboard
@JvmField
var onBalloonInitializedListener: OnBalloonInitializedListener?

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

Link copied to clipboard
val overlayWindow: PopupWindow

An overlay window of the background popup.

Functions

Link copied to clipboard
suspend fun awaitAlign(align: BalloonAlign, mainAnchor: View, subAnchorList: List<View> = listOf(), xOff: Int = 0, yOff: Int = 0)

Coroutine alternative for showAlign. This method suspends until the popup is displayed. Can be used to show popups sequentially without using relay methods.

Link copied to clipboard
suspend fun awaitAlignBottom(anchor: View, xOff: Int = 0, yOff: Int = 0)

Coroutine alternative for showAlignBottom. This method suspends until the popup is displayed. Can be used to show popups sequentially without using relay methods.

Link copied to clipboard
suspend fun awaitAlignEnd(anchor: View, xOff: Int = 0, yOff: Int = 0)

Coroutine alternative for showAlignEnd. This method suspends until the popup is displayed. Can be used to show popups sequentially without using relay methods.

Link copied to clipboard
suspend fun awaitAlignStart(anchor: View, xOff: Int = 0, yOff: Int = 0)

Coroutine alternative for showAlignLeft. This method suspends until the popup is displayed. Can be used to show popups sequentially without using relay methods.

Link copied to clipboard
suspend fun awaitAlignTop(anchor: View, xOff: Int = 0, yOff: Int = 0)

Coroutine alternative for showAlignTop. This method suspends until the popup is displayed. Can be used to show popups sequentially without using relay methods.

Link copied to clipboard
suspend fun awaitAsDropDown(anchor: View, xOff: Int = 0, yOff: Int = 0)

Coroutine alternative for showAsDropDown. This method suspends until the popup is displayed. Can be used to show popups sequentially without using relay methods.

Link copied to clipboard
suspend fun awaitAtCenter(anchor: View, xOff: Int = 0, yOff: Int = 0, centerAlign: BalloonCenterAlign = BalloonCenterAlign.TOP)

Coroutine alternative for showAtCenter. This method suspends until the popup is displayed. Can be used to show popups sequentially without using relay methods.

Link copied to clipboard
fun clearAllPreferences()

clears all persisted preferences.

Link copied to clipboard
fun dismiss()

dismiss the popup menu.

Link copied to clipboard
fun dismissWithDelay(delay: Long): Boolean

dismiss the popup menu with milliseconds delay.

Link copied to clipboard
fun getBalloonArrowView(): View

gets a arrow view of the balloon popup window.

Link copied to clipboard
fun getContentView(): ViewGroup

gets a content view of the balloon popup window.

Link copied to clipboard
fun getMeasuredHeight(): Int

gets measured height size of the balloon popup.

Link copied to clipboard
fun getMeasuredWidth(): Int

gets measured width size of the balloon popup.

Link copied to clipboard
open fun onCreate(owner: LifecycleOwner)
Link copied to clipboard
open override fun onDestroy(owner: LifecycleOwner)

dismiss automatically when lifecycle owner is destroyed.

Link copied to clipboard
open override fun onPause(owner: LifecycleOwner)

dismiss when the LifecycleOwner be on paused.

Link copied to clipboard
open fun onResume(owner: LifecycleOwner)
Link copied to clipboard
open fun onStart(owner: LifecycleOwner)
Link copied to clipboard
open fun onStop(owner: LifecycleOwner)
Link copied to clipboard
@JvmOverloads
fun relayShowAlign(align: BalloonAlign, balloon: Balloon, anchor: View, xOff: Int = 0, yOff: Int = 0): Balloon

Shows the balloon on an anchor view depending on the align alignment with x-off and y-off and shows the next balloon sequentially. This function returns the next balloon.

Link copied to clipboard
@JvmOverloads
fun relayShowAlignBottom(balloon: Balloon, anchor: View, xOff: Int = 0, yOff: Int = 0): Balloon

Shows the balloon on an anchor view as the bottom alignment with x-off and y-off and shows the next balloon sequentially. This function returns the next balloon.

Link copied to clipboard
@JvmOverloads
fun relayShowAlignEnd(balloon: Balloon, anchor: View, xOff: Int = 0, yOff: Int = 0): Balloon

Shows the balloon on an anchor view as the end alignment with x-off and y-off and shows the next balloon sequentially. This function returns the next balloon.

Link copied to clipboard
@JvmOverloads
fun relayShowAlignLeft(balloon: Balloon, anchor: View, xOff: Int = 0, yOff: Int = 0): Balloon

Shows the balloon on an anchor view as the left alignment with x-off and y-off and shows the next balloon sequentially. This function returns the next balloon.

Link copied to clipboard
@JvmOverloads
fun relayShowAlignRight(balloon: Balloon, anchor: View, xOff: Int = 0, yOff: Int = 0): Balloon

Shows the balloon on an anchor view as the right alignment with x-off and y-off and shows the next balloon sequentially. This function returns the next balloon.

Link copied to clipboard
@JvmOverloads
fun relayShowAlignStart(balloon: Balloon, anchor: View, xOff: Int = 0, yOff: Int = 0): Balloon

Shows the balloon on an anchor view as the start alignment with x-off and y-off and shows the next balloon sequentially. This function returns the next balloon.

Link copied to clipboard
@JvmOverloads
fun relayShowAlignTop(balloon: Balloon, anchor: View, xOff: Int = 0, yOff: Int = 0): Balloon

Shows the balloon on an anchor view as the top alignment with x-off and y-off and shows the next balloon sequentially. This function returns the next balloon.

Link copied to clipboard
@JvmOverloads
fun relayShowAsDropDown(balloon: Balloon, anchor: View, xOff: Int = 0, yOff: Int = 0): Balloon

Shows the balloon on an anchor view as drop down with x-off and y-off and shows the next balloon sequentially. This function returns the next balloon.

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

Shows the balloon on an anchor view as the center alignment with x-off and y-off and shows the next balloon sequentially. This function returns the next balloon.

Link copied to clipboard
fun setIsAttachedInDecor(value: Boolean): Balloon

sets whether the popup window will be attached in the decor frame of its parent window. If you want to show up balloon on your DialogFragment, it's recommended to use with true. (#131)

Link copied to clipboard
fun setOnBalloonClickListener(onBalloonClickListener: OnBalloonClickListener?)

sets a OnBalloonClickListener to the popup.

fun setOnBalloonClickListener(block: (View) -> Unit)

sets a OnBalloonClickListener to the popup using lambda.

Link copied to clipboard
fun setOnBalloonDismissListener(onBalloonDismissListener: OnBalloonDismissListener?)

sets a OnBalloonDismissListener to the popup.

fun setOnBalloonDismissListener(block: () -> Unit)

sets a OnBalloonDismissListener to the popup using lambda.

Link copied to clipboard
fun setOnBalloonInitializedListener(onBalloonInitializedListener: OnBalloonInitializedListener?)

sets a OnBalloonInitializedListener to the popup. The OnBalloonInitializedListener.onBalloonInitialized will be invoked when inflating the body content of the balloon is finished.

fun setOnBalloonInitializedListener(block: (View) -> Unit)

sets a OnBalloonInitializedListener to the popup using a lambda. The OnBalloonInitializedListener.onBalloonInitialized will be invoked when inflating the body content of the balloon is finished.

Link copied to clipboard
fun setOnBalloonOutsideTouchListener(onBalloonOutsideTouchListener: OnBalloonOutsideTouchListener?)

sets a OnBalloonOutsideTouchListener to the popup.

fun setOnBalloonOutsideTouchListener(block: (View, MotionEvent) -> Unit)

sets a OnBalloonOutsideTouchListener to the popup using lambda.

Link copied to clipboard
fun setOnBalloonOverlayClickListener(onBalloonOverlayClickListener: OnBalloonOverlayClickListener?)

sets a OnBalloonOverlayClickListener to the overlay popup.

fun setOnBalloonOverlayClickListener(block: () -> Unit)

sets a OnBalloonOverlayClickListener to the overlay popup using lambda.

Link copied to clipboard
fun setOnBalloonOverlayTouchListener(onTouchListener: View.OnTouchListener?)

sets a View.OnTouchListener to the overlay popup

fun setOnBalloonOverlayTouchListener(block: (View, MotionEvent) -> Boolean)

sets a View.OnTouchListener to the overlay popup using lambda.

Link copied to clipboard
fun setOnBalloonTouchListener(onTouchListener: View.OnTouchListener?)

sets a View.OnTouchListener to the popup.

Link copied to clipboard
fun shouldShowUp(): Boolean

Checks if the balloon should show up.

Link copied to clipboard
@JvmOverloads
fun showAlign(align: BalloonAlign, mainAnchor: View, 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
@JvmOverloads
fun showAlignBottom(anchor: View, 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
@JvmOverloads
fun showAlignEnd(anchor: View, xOff: Int = 0, yOff: Int = 0)

Shows the balloon on an anchor view as the end alignment with x-off and y-off.

Link copied to clipboard
@JvmOverloads
fun showAlignLeft(anchor: View, 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
@JvmOverloads
fun showAlignRight(anchor: View, 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
@JvmOverloads
fun showAlignStart(anchor: View, xOff: Int = 0, yOff: Int = 0)

Shows the balloon on an anchor view as the start alignment with x-off and y-off.

Link copied to clipboard
@JvmOverloads
fun showAlignTop(anchor: View, 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
@JvmOverloads
fun showAsDropDown(anchor: View, 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
@JvmOverloads
fun showAtCenter(anchor: View, xOff: Int = 0, yOff: Int = 0, centerAlign: BalloonCenterAlign = BalloonCenterAlign.TOP)

Shows the balloon over the anchor view (overlap) as the center aligns. Even if you use with the ArrowOrientationRules.ALIGN_ANCHOR, the alignment will not be guaranteed. So if you use the function, use with ArrowOrientationRules.ALIGN_FIXED and fixed ArrowOrientation.

Link copied to clipboard
fun update(anchor: View, xOff: Int = 0, yOff: Int = 0, width: Int = getMeasuredWidth(), height: Int = getMeasuredHeight())

updates popup and arrow position of the popup based on a new target anchor view with additional x-off and y-off.

Link copied to clipboard
@JvmOverloads
fun updateAlign(align: BalloonAlign, anchor: View, xOff: Int = 0, yOff: Int = 0, width: Int = getMeasuredWidth(), height: Int = getMeasuredHeight())

Update the balloon on a given new anchor as the bottom alignment with x-off and y-off.

Link copied to clipboard
@JvmOverloads
fun updateAlignBottom(anchor: View, xOff: Int = 0, yOff: Int = 0, width: Int = getMeasuredWidth(), height: Int = getMeasuredHeight())

Update the balloon on a given new anchor as the bottom alignment with x-off and y-off.

Link copied to clipboard
@JvmOverloads
fun updateAlignEnd(anchor: View, xOff: Int = 0, yOff: Int = 0, width: Int = getMeasuredWidth(), height: Int = getMeasuredHeight())

Update the balloon on a given new anchor as the end alignment with x-off and y-off.

Link copied to clipboard
@JvmOverloads
fun updateAlignStart(anchor: View, xOff: Int = 0, yOff: Int = 0, width: Int = getMeasuredWidth(), height: Int = getMeasuredHeight())

Update the balloon on a given new anchor as the start alignment with x-off and y-off.

Link copied to clipboard
@JvmOverloads
fun updateAlignTop(anchor: View, xOff: Int = 0, yOff: Int = 0, width: Int = getMeasuredWidth(), height: Int = getMeasuredHeight())

Update the balloon on a given new anchor as the top alignment with x-off and y-off.

Link copied to clipboard
fun updateSizeOfBalloonCard(width: Int, height: Int)