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.

Types

Builder

class Builder(context: Context)

Builder class for creating Balloon.

Factory

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

bodyWindow

val bodyWindow: PopupWindow

A main content window of the popup.

isShowing

var isShowing: Boolean = false

Denotes the popup is showing or not.

onBalloonInitializedListener

@JvmField

var onBalloonInitializedListener: OnBalloonInitializedListener?

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

overlayWindow

val overlayWindow: PopupWindow

An overlay window of the background popup.

Functions

clearAllPreferences

fun clearAllPreferences()

clears all persisted preferences.

dismiss

fun dismiss()

dismiss the popup menu.

dismissWithDelay

fun dismissWithDelay(delay: Long): Boolean

dismiss the popup menu with milliseconds delay.

getBalloonArrowView

fun getBalloonArrowView(): View

gets a arrow view of the balloon popup window.

getContentView

fun getContentView(): ViewGroup

gets a content view of the balloon popup window.

getMeasuredHeight

fun getMeasuredHeight(): Int

gets measured height size of the balloon popup.

getMeasuredWidth

fun getMeasuredWidth(): Int

gets measured width size of the balloon popup.

onDestroy

open override fun onDestroy(owner: LifecycleOwner)

dismiss automatically when lifecycle owner is destroyed.

onPause

open override fun onPause(owner: LifecycleOwner)

dismiss when the LifecycleOwner be on paused.

relayShowAlign

@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.

relayShowAlignBottom

@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.

relayShowAlignLeft

@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.

relayShowAlignRight

@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.

relayShowAlignTop

@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.

relayShowAsDropDown

@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.

relayShowAtCenter

@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.

setIsAttachedInDecor

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)

setOnBalloonClickListener

fun setOnBalloonClickListener(onBalloonClickListener: OnBalloonClickListener?)

sets a OnBalloonClickListener to the popup.

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

sets a OnBalloonClickListener to the popup using lambda.

setOnBalloonDismissListener

fun setOnBalloonDismissListener(onBalloonDismissListener: OnBalloonDismissListener?)

sets a OnBalloonDismissListener to the popup.

fun setOnBalloonDismissListener(block: () -> Unit)

sets a OnBalloonDismissListener to the popup using lambda.

setOnBalloonInitializedListener

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.

setOnBalloonOutsideTouchListener

fun setOnBalloonOutsideTouchListener(onBalloonOutsideTouchListener: OnBalloonOutsideTouchListener?)

sets a OnBalloonOutsideTouchListener to the popup.

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

sets a OnBalloonOutsideTouchListener to the popup using lambda.

setOnBalloonOverlayClickListener

fun setOnBalloonOverlayClickListener(onBalloonOverlayClickListener: OnBalloonOverlayClickListener?)

sets a OnBalloonOverlayClickListener to the overlay popup.

fun setOnBalloonOverlayClickListener(block: () -> Unit)

sets a OnBalloonOverlayClickListener to the overlay popup using lambda.

setOnBalloonOverlayTouchListener

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.

setOnBalloonTouchListener

fun setOnBalloonTouchListener(onTouchListener: View.OnTouchListener?)

sets a View.OnTouchListener to the popup.

shouldShowUp

fun shouldShowUp(): Boolean

Checks if the balloon should show up.

showAlign

@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.

showAlignBottom

@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.

showAlignLeft

@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.

showAlignRight

@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.

showAlignTop

@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.

showAsDropDown

@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.

showAtCenter

@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.

update

@JvmOverloads