Interface BalloonWindow

  • All Implemented Interfaces:

    
    public interface BalloonWindow
    
                        

    BalloonWindow is an interface that define all executable behaviors of the balloon's window.

    • Constructor Detail

    • Method Detail

      • shouldShowUp

         abstract Boolean shouldShowUp()

        Represents if the balloon should be displayed according to the internal persistence..

      • showAtCenter

         abstract Unit showAtCenter(Integer xOff, Integer yOff, BalloonCenterAlign centerAlign)

        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.

        Parameters:
        xOff - A horizontal offset from the anchor in pixels.
        yOff - A vertical offset from the anchor in pixels.
        centerAlign - A rule for deciding the alignment of the balloon.
      • relayShowAtCenter

         abstract Balloon relayShowAtCenter(Balloon balloon, Integer xOff, Integer yOff, BalloonCenterAlign centerAlign)

        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.

        Parameters:
        balloon - A next Balloon that will be shown sequentially after dismissing this popup.
        xOff - A horizontal offset from the anchor in pixels.
        yOff - A vertical offset from the anchor in pixels.
        centerAlign - A rule for deciding the align of the balloon.
      • showAsDropDown

         abstract Unit showAsDropDown(Integer xOff, Integer yOff)

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

        Parameters:
        xOff - A horizontal offset from the anchor in pixels.
        yOff - A vertical offset from the anchor in pixels.
      • relayShowAsDropDown

         abstract Balloon relayShowAsDropDown(Balloon balloon, Integer xOff, Integer yOff)

        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.

        Parameters:
        balloon - A next Balloon that will be shown sequentially after dismissing this popup.
        xOff - A horizontal offset from the anchor in pixels.
        yOff - A vertical offset from the anchor in pixels.
      • showAlignTop

         abstract Unit showAlignTop(Integer xOff, Integer yOff)

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

        Parameters:
        xOff - A horizontal offset from the anchor in pixels.
        yOff - A vertical offset from the anchor in pixels.
      • relayShowAlignTop

         abstract Balloon relayShowAlignTop(Balloon balloon, Integer xOff, Integer yOff)

        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.

        Parameters:
        balloon - A next Balloon that will be shown sequentially after dismissing this popup.
        xOff - A horizontal offset from the anchor in pixels.
        yOff - A vertical offset from the anchor in pixels.
      • showAlignBottom

         abstract Unit showAlignBottom(Integer xOff, Integer yOff)

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

        Parameters:
        xOff - A horizontal offset from the anchor in pixels.
        yOff - A vertical offset from the anchor in pixels.
      • relayShowAlignBottom

         abstract Balloon relayShowAlignBottom(Balloon balloon, Integer xOff, Integer yOff)

        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.

        Parameters:
        balloon - A next Balloon that will be shown sequentially after dismissing this popup.
        xOff - A horizontal offset from the anchor in pixels.
        yOff - A vertical offset from the anchor in pixels.
      • showAlignRight

         abstract Unit showAlignRight(Integer xOff, Integer yOff)

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

        Parameters:
        xOff - A horizontal offset from the anchor in pixels.
        yOff - A vertical offset from the anchor in pixels.
      • relayShowAlignRight

         abstract Balloon relayShowAlignRight(Balloon balloon, Integer xOff, Integer yOff)

        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.

        Parameters:
        balloon - A next Balloon that will be shown sequentially after dismissing this popup.
        xOff - A horizontal offset from the anchor in pixels.
        yOff - A vertical offset from the anchor in pixels.
      • showAlignLeft

         abstract Unit showAlignLeft(Integer xOff, Integer yOff)

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

        Parameters:
        xOff - A horizontal offset from the anchor in pixels.
        yOff - A vertical offset from the anchor in pixels.
      • relayShowAlignLeft

         abstract Balloon relayShowAlignLeft(Balloon balloon, Integer xOff, Integer yOff)

        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.

        Parameters:
        balloon - A next Balloon that will be shown sequentially after dismissing this popup.
        xOff - A horizontal offset from the anchor in pixels.
        yOff - A vertical offset from the anchor in pixels.
      • showAlign

         abstract Unit showAlign(BalloonAlign align, View mainAnchor, List<View> subAnchorList, Integer xOff, Integer yOff)

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

        Parameters:
        align - Decides where the balloon should be placed.
        mainAnchor - A target view which popup will be displayed.
        subAnchorList - A list of anchors to display focuses on the overlay view.
        xOff - A horizontal offset from the anchor in pixels.
        yOff - A vertical offset from the anchor in pixels.
      • relayShowAlign

         abstract Balloon relayShowAlign(BalloonAlign align, Balloon balloon, Integer xOff, Integer yOff)

        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.

        Parameters:
        balloon - A next Balloon that will be shown sequentially after dismissing this popup.
        xOff - A horizontal offset from the anchor in pixels.
        yOff - A vertical offset from the anchor in pixels.
      • update

         abstract Unit update(Integer xOff, Integer yOff)

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

        Parameters:
        xOff - A horizontal offset from the anchor in pixels.
        yOff - A vertical offset from the anchor in pixels.
      • dismiss

         abstract Unit dismiss()

        dismiss the popup menu.

      • setOnBalloonClickListener

         abstract Unit setOnBalloonClickListener(OnBalloonClickListener onBalloonClickListener)

        sets a OnBalloonClickListener to the popup.

      • setOnBalloonInitializedListener

         abstract Unit 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.

      • setOnBalloonDismissListener

         abstract Unit setOnBalloonDismissListener(OnBalloonDismissListener onBalloonDismissListener)

        sets a OnBalloonDismissListener to the popup.

      • setOnBalloonOutsideTouchListener

         abstract Unit setOnBalloonOutsideTouchListener(OnBalloonOutsideTouchListener onBalloonOutsideTouchListener)

        sets a OnBalloonOutsideTouchListener to the popup.

      • setOnBalloonOverlayClickListener

         abstract Unit setOnBalloonOverlayClickListener(OnBalloonOverlayClickListener onBalloonOverlayClickListener)

        sets a OnBalloonOverlayClickListener to the overlay popup.

      • setIsAttachedInDecor

         abstract Balloon setIsAttachedInDecor(Boolean value)

        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)