com.fenchtose.tooltip

Class Tooltip.Builder

java.lang.Object

com.fenchtose.tooltip.Tooltip.Builder

Enclosing class:

Tooltip

public static class Tooltip.Builder
extends java.lang.Object

Builder class for Tooltip. Builder has the responsibility of creating the Tooltip and adding/displaying it in the rootView.

Constructor Summary

Constructors

Constructor and Description
Builder(android.content.Context context)

Method Summary

Modifier and Type	Method and Description
Tooltip.Builder	anchor(android.view.View view) set tooltip's anchor with position Tooltip.TOP
Tooltip.Builder	anchor(android.view.View view, int position) Set tooltip's anchor with tooltip's relative position
Tooltip.Builder	animate(TooltipAnimation animation) Set show and dismiss animation for the tooltip
Tooltip.Builder	autoAdjust(boolean autoAdjust) Automatically adjust tooltip layout if it's going out of screen.
Tooltip.Builder	autoCancel(int timeInMilli) If you want the tooltip to dismiss automatically after a certain amount of time, set it in milliseconds.
Tooltip	build() Create a new instance of Tooltip.
Tooltip.Builder	cancelable(boolean cancelable) Whether the tooltip should be dismissed or not if clicked outside.
Tooltip.Builder	checkForPreDraw(boolean check) If the anchor is anchored to some view in CoordinatorLayout, we get incorrect data about its position in the window.
Tooltip.Builder	content(android.view.View view) set tooltip's content view
Tooltip.Builder	debug(boolean debug) Show logs
Tooltip.Builder	into(android.view.ViewGroup viewGroup) Add Tooltip in this view
Tooltip	show() Creates a new instance of Tooltip by calling build() and adds tooltip to rootView.
Tooltip.Builder	withListener(Tooltip.Listener listener) Attach dismiss listener
Tooltip.Builder	withPadding(int padding) Margin from the anchor and screen boundaries
Tooltip.Builder	withTip(Tooltip.Tip tip) Show Tip.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder(@NonNull
               android.content.Context context)

Method Detail

content

public Tooltip.Builder content(@NonNull
                               android.view.View view)

set tooltip's content view

Parameters:

view - Content of the tooltip

Returns:

Builder

anchor

public Tooltip.Builder anchor(@NonNull
                              android.view.View view)

set tooltip's anchor with position Tooltip.TOP

Parameters:

view - Anchor view

Returns:

Builder

anchor

public Tooltip.Builder anchor(@NonNull
                              android.view.View view,
                              int position)

Set tooltip's anchor with tooltip's relative position

Parameters:

view - Anchor view

position - position of tooltip relative to the anchor. Tooltip.TOP, Tooltip.RIGHT, Tooltip.BOTTOM, Tooltip.LEFT

Returns:

Builder

into

public Tooltip.Builder into(@NonNull
                            android.view.ViewGroup viewGroup)

Add Tooltip in this view

Parameters:

viewGroup - ViewGroup root view (parent view) for the tooltip

Returns:

Builder

cancelable

public Tooltip.Builder cancelable(boolean cancelable)

Whether the tooltip should be dismissed or not if clicked outside. Default it true

Parameters:

cancelable - boolean

Returns:

Builder

autoAdjust

public Tooltip.Builder autoAdjust(boolean autoAdjust)

Automatically adjust tooltip layout if it's going out of screen. Scenario: If tooltip is anchored with position Tooltip.TOP, it will try to position itself within the bounds of the view in right and left direction. It will not try to adjust itself in top bottom direction.

Parameters:

autoAdjust - boolean

Returns:

Builder

withPadding

public Tooltip.Builder withPadding(int padding)

Margin from the anchor and screen boundaries

Parameters:

padding - - margin from the screen edge (in pixels).

Returns:

Builder

withListener

public Tooltip.Builder withListener(@NonNull
                                    Tooltip.Listener listener)

Attach dismiss listener

Parameters:

listener - dismiss listener

Returns:

Builder

withTip

public Tooltip.Builder withTip(@NonNull
                               Tooltip.Tip tip)

Show Tip. If null, it doesn't show the tip.

Parameters:

tip - Tooltip.Tip

Returns:

Builder

autoCancel

public Tooltip.Builder autoCancel(int timeInMilli)

If you want the tooltip to dismiss automatically after a certain amount of time, set it in milliseconds. Values <= 0 are considered invalid and auto dismiss is turned off. Default is 0.

Parameters:

timeInMilli - dismiss time

Returns:

Builder

animate

public Tooltip.Builder animate(@NonNull
                               TooltipAnimation animation)

Set show and dismiss animation for the tooltip

Parameters:

animation - TooltipAnimation to be performed while showing and dismissing

Returns:

Builder

checkForPreDraw

public Tooltip.Builder checkForPreDraw(boolean check)

If the anchor is anchored to some view in CoordinatorLayout, we get incorrect data about its position in the window. So we need to wait for a preDraw event and then draw tooltip.

Parameters:

check - - boolean

Returns:

Builder

debug

public Tooltip.Builder debug(boolean debug)

Show logs

Parameters:

debug - boolean

Returns:

Builder

build

public Tooltip build()

Create a new instance of Tooltip. This method will throw NullPointerException if anchorView or rootView or contentView is not assigned.

Returns:

Tooltip

show

public Tooltip show()

Creates a new instance of Tooltip by calling build() and adds tooltip to rootView.

Tooltip is added to the rootView with MATCH_PARENT for width and height constraints. contentView is drawn based on its LayoutParams. If it does not contain any LayoutParams, new LayoutParams are generated with WRAP_CONTENT for width and height and added to the Tooltip view.

Returns:

Generated Tooltip