io.github.douglasjunior.androidSimpleTooltip

Class SimpleTooltip.Builder

java.lang.Object

io.github.douglasjunior.androidSimpleTooltip.SimpleTooltip.Builder

Enclosing class:

SimpleTooltip

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

Classe responsável por facilitar a criação do objeto SimpleTooltip.

Class responsible for making it easier to build the object SimpleTooltip.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
SimpleTooltip.Builder	anchorView(android.view.View anchorView) Define para qual View o tooltip deve apontar.
SimpleTooltip.Builder	animated(boolean animated) Define se o tooltip será animado enquanto estiver aberto.
SimpleTooltip.Builder	animationDuration(long animationDuration)
SimpleTooltip.Builder	animationPadding(float animationPadding) Define o tamanho do deslocamento durante a animação.
SimpleTooltip.Builder	animationPadding(int animationPaddingRes) Define o tamanho do deslocamento durante a animação.
SimpleTooltip.Builder	arrowColor(int arrowColor)
SimpleTooltip.Builder	arrowDirection(int arrowDirection) Define a direção em que a seta será criada.
SimpleTooltip.Builder	arrowDrawable(android.graphics.drawable.Drawable arrowDrawable)
SimpleTooltip.Builder	arrowDrawable(int drawableRes)
SimpleTooltip.Builder	arrowHeight(float arrowHeight) Altura da seta indicativa.
SimpleTooltip.Builder	arrowWidth(float arrowWidth) Largura da seta indicativa.
SimpleTooltip.Builder	backgroundColor(int backgroundColor)
SimpleTooltip	build()
SimpleTooltip.Builder	contentView(int contentViewId) Define um novo conteúdo customizado para o tooltip.
SimpleTooltip.Builder	contentView(int contentViewId, int textViewId) Define um novo conteúdo customizado para o tooltip.
SimpleTooltip.Builder	contentView(android.widget.TextView textView) Define um novo conteúdo customizado para o tooltip.
SimpleTooltip.Builder	contentView(android.view.View contentView, int textViewId) Define um novo conteúdo customizado para o tooltip.
SimpleTooltip.Builder	dismissOnInsideTouch(boolean dismissOnInsideTouch) Define se o tooltip será fechado quando receber um clique dentro de sua área.
SimpleTooltip.Builder	dismissOnOutsideTouch(boolean dismissOnOutsideTouch) Define se o tooltip será fechado quando receber um clique fora de sua área.
SimpleTooltip.Builder	focusable(boolean focusable) Habilita o foco no conteúdo da tooltip.
SimpleTooltip.Builder	gravity(int gravity) Define a para qual lado o tooltip será posicionado em relação ao anchorView.
SimpleTooltip.Builder	highlightShape(int highlightShape) Configura o formato do Shape em destaque.
SimpleTooltip.Builder	margin(float margin) Define a margem entre o Tooltip e o anchorView.
SimpleTooltip.Builder	margin(int marginRes) Define a margem entre o Tooltip e o anchorView.
SimpleTooltip.Builder	maxWidth(float maxWidth) Define a largura máxima do Tooltip.
SimpleTooltip.Builder	maxWidth(int maxWidthRes) Define a largura máxima do Tooltip.
SimpleTooltip.Builder	modal(boolean modal) Define se a tela fiacrá bloqueada enquanto o tooltip estiver aberto.
SimpleTooltip.Builder	onDismissListener(SimpleTooltip.OnDismissListener onDismissListener)
SimpleTooltip.Builder	onShowListener(SimpleTooltip.OnShowListener onShowListener)
SimpleTooltip.Builder	overlayMatchParent(boolean overlayMatchParent) Define o comportamento do overlay.
SimpleTooltip.Builder	overlayOffset(float overlayOffset) Tamanho da margem entre anchorView(View) e a borda do Shape de destaque.
SimpleTooltip.Builder	padding(float padding) Define o padding entre a borda do Tooltip e seu conteúdo.
SimpleTooltip.Builder	padding(int paddingRes) Define o padding entre a borda do Tooltip e seu conteúdo.
SimpleTooltip.Builder	showArrow(boolean showArrow) Indica se deve ser gerada a seta indicativa.
SimpleTooltip.Builder	text(java.lang.CharSequence text) Define o texto que sera exibido no TextView dentro do tooltip.
SimpleTooltip.Builder	text(int textRes) Define o texto que sera exibido no TextView dentro do tooltip.
SimpleTooltip.Builder	textColor(int textColor)
SimpleTooltip.Builder	transparentOverlay(boolean transparentOverlay) Define se o fundo da tela será escurecido ou transparente enquanto o tooltip estiver aberto.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder(android.content.Context context)

Method Detail

build

public SimpleTooltip build()
                    throws java.lang.IllegalArgumentException

Throws:

java.lang.IllegalArgumentException

contentView

public SimpleTooltip.Builder contentView(android.widget.TextView textView)

Define um novo conteúdo customizado para o tooltip.

Parameters:

textView -

novo conteúdo para o tooltip.

Returns:

this

See Also:

contentView(int, int), contentView(View, int), contentView(int)

contentView

public SimpleTooltip.Builder contentView(android.view.View contentView,
                                         @IdRes
                                         int textViewId)

Define um novo conteúdo customizado para o tooltip.

Parameters:

contentView -

novo conteúdo para o tooltip, pode ser um ViewGroup ou qualquer componente customizado.

textViewId -

resId para o TextView existente dentro do contentView. Padrão é android.R.id.text1.

Returns:

this

See Also:

contentView(int, int), contentView(TextView), contentView(int)

contentView

public SimpleTooltip.Builder contentView(@LayoutRes
                                         int contentViewId,
                                         @IdRes
                                         int textViewId)

Define um novo conteúdo customizado para o tooltip.

Parameters:

contentViewId -

layoutId que será inflado como o novo conteúdo para o tooltip.

textViewId -

resId para o TextView existente dentro do contentView. Padrão é android.R.id.text1.

Returns:

this

See Also:

contentView(View, int), contentView(TextView), contentView(int)

contentView

public SimpleTooltip.Builder contentView(@LayoutRes
                                         int contentViewId)

Define um novo conteúdo customizado para o tooltip.

Parameters:

contentViewId -

layoutId que será inflado como o novo conteúdo para o tooltip.

Returns:

this

See Also:

contentView(View, int), contentView(TextView), contentView(int, int)

dismissOnInsideTouch

public SimpleTooltip.Builder dismissOnInsideTouch(boolean dismissOnInsideTouch)

Define se o tooltip será fechado quando receber um clique dentro de sua área. Padrão é true.

Parameters:

dismissOnInsideTouch -

true para fechar quando receber o click dentro, false caso contrário.

Returns:

this

See Also:

dismissOnOutsideTouch(boolean)

dismissOnOutsideTouch

public SimpleTooltip.Builder dismissOnOutsideTouch(boolean dismissOnOutsideTouch)

Define se o tooltip será fechado quando receber um clique fora de sua área. Padrão é true.

Parameters:

dismissOnOutsideTouch -

true para fechar quando receber o click fora, false caso contrário.

Returns:

this

See Also:

dismissOnInsideTouch(boolean)

modal

public SimpleTooltip.Builder modal(boolean modal)

Define se a tela fiacrá bloqueada enquanto o tooltip estiver aberto. Esse parâmetro deve ser combinado com dismissOnInsideTouch(boolean) e dismissOnOutsideTouch(boolean). Padrão é false.

Parameters:

modal -

true para bloquear a tela, false caso contrário.

Returns:

this

See Also:

dismissOnInsideTouch(boolean), dismissOnOutsideTouch(boolean)

text

public SimpleTooltip.Builder text(java.lang.CharSequence text)

Define o texto que sera exibido no TextView dentro do tooltip.

Parameters:

text -

texto que sera exibido.

Returns:

this

text

public SimpleTooltip.Builder text(@StringRes
                                  int textRes)

Define o texto que sera exibido no TextView dentro do tooltip.

Parameters:

textRes -

id do resource da String.

Returns:

this

anchorView

public SimpleTooltip.Builder anchorView(android.view.View anchorView)

Define para qual View o tooltip deve apontar. Importante ter certeza que esta View já esteja pronta e exibida na tela.

Set the target View that the tooltip will point. Make sure that the anchor View shold be showing in the screen.

Parameters:

anchorView -

View para qual o tooltip deve apontar

View that the tooltip will point

Returns:

this

gravity

public SimpleTooltip.Builder gravity(int gravity)

Define a para qual lado o tooltip será posicionado em relação ao anchorView. As opções existentes são Gravity.START, Gravity.END, Gravity.TOP e Gravity.BOTTOM. O padrão é Gravity.BOTTOM.

Parameters:

gravity -

lado para qual o tooltip será posicionado.

Returns:

this

arrowDirection

public SimpleTooltip.Builder arrowDirection(int arrowDirection)

Define a direção em que a seta será criada. As opções existentes são ArrowDrawable.LEFT, ArrowDrawable.TOP, ArrowDrawable.RIGHT, ArrowDrawable.BOTTOM e ArrowDrawable.AUTO. O padrão é ArrowDrawable.AUTO.
Esta opção deve ser utilizada em conjunto com Builder#showArrow(true).

Parameters:

arrowDirection -

direção em que a seta será criada.

Returns:

this

transparentOverlay

public SimpleTooltip.Builder transparentOverlay(boolean transparentOverlay)

Define se o fundo da tela será escurecido ou transparente enquanto o tooltip estiver aberto. Padrão é true.

Parameters:

transparentOverlay -

true para o fundo transparente, false para escurecido.

Returns:

this

maxWidth

public SimpleTooltip.Builder maxWidth(@DimenRes
                                      int maxWidthRes)

Define a largura máxima do Tooltip.

Parameters:

maxWidthRes -

resId da largura máxima.

Returns:

this

See Also:

maxWidth(float)

maxWidth

public SimpleTooltip.Builder maxWidth(float maxWidth)

Define a largura máxima do Tooltip. Padrão é 0 (sem limite).

Parameters:

maxWidth -

largura máxima em pixels.

Returns:

this

See Also:

maxWidth(int)

animated

public SimpleTooltip.Builder animated(boolean animated)

Define se o tooltip será animado enquanto estiver aberto. Disponível a partir do Android API 11. Padrão é false.

Parameters:

animated -

true para tooltip animado, false caso contrário.

Returns:

this

animationPadding

public SimpleTooltip.Builder animationPadding(float animationPadding)

Define o tamanho do deslocamento durante a animação. Padrão é o valor de R.dimen.simpletooltip_animation_padding.

Parameters:

animationPadding -

tamanho do deslocamento em pixels.

Returns:

this

See Also:

animationPadding(int)

animationPadding

public SimpleTooltip.Builder animationPadding(@DimenRes
                                              int animationPaddingRes)

Define o tamanho do deslocamento durante a animação. Padrão é R.dimen.simpletooltip_animation_padding.

Parameters:

animationPaddingRes -

resId do tamanho do deslocamento.

Returns:

this

See Also:

animationPadding(float)

animationDuration

public SimpleTooltip.Builder animationDuration(long animationDuration)

padding

public SimpleTooltip.Builder padding(float padding)

Define o padding entre a borda do Tooltip e seu conteúdo. Padrão é o valor R.dimen.simpletooltip_padding.

Parameters:

padding -

tamanho do padding em pixels.

Returns:

this

See Also:

padding(int)

padding

public SimpleTooltip.Builder padding(@DimenRes
                                     int paddingRes)

Define o padding entre a borda do Tooltip e seu conteúdo. Padrão é R.dimen.simpletooltip_padding.

Parameters:

paddingRes -

resId do tamanho do padding.

Returns:

this

See Also:

padding(float)

margin

public SimpleTooltip.Builder margin(float margin)

Define a margem entre o Tooltip e o anchorView. Padrão é o valor de R.dimen.simpletooltip_margin.

Parameters:

margin -

tamanho da margem em pixels.

Returns:

this

See Also:

margin(int)

margin

public SimpleTooltip.Builder margin(@DimenRes
                                    int marginRes)

Define a margem entre o Tooltip e o anchorView. Padrão é R.dimen.simpletooltip_margin.

Parameters:

marginRes -

resId do tamanho da margem.

Returns:

this

See Also:

margin(float)

textColor

public SimpleTooltip.Builder textColor(int textColor)

backgroundColor

public SimpleTooltip.Builder backgroundColor(int backgroundColor)

showArrow

public SimpleTooltip.Builder showArrow(boolean showArrow)

Indica se deve ser gerada a seta indicativa. Padrão é true.

Indicates whether to be generated indicative arrow. Default is true.

Parameters:

showArrow -

true para exibir a seta, false caso contrário.

true to show arrow, false otherwise.

Returns:

this

arrowDrawable

public SimpleTooltip.Builder arrowDrawable(android.graphics.drawable.Drawable arrowDrawable)

arrowDrawable

public SimpleTooltip.Builder arrowDrawable(@DrawableRes
                                           int drawableRes)

arrowColor

public SimpleTooltip.Builder arrowColor(int arrowColor)

arrowHeight

public SimpleTooltip.Builder arrowHeight(float arrowHeight)

Altura da seta indicativa. Esse valor é automaticamente definido em Largura ou Altura conforme a Gravity configurada. Este valor sobrescreve R.dimen.simpletooltip_arrow_height

Height of the arrow. This value is automatically set in the Width or Height as the Gravity.

Parameters:

arrowHeight -

Altura em pixels.

Height in pixels.

Returns:

this

See Also:

arrowWidth(float)

arrowWidth

public SimpleTooltip.Builder arrowWidth(float arrowWidth)

Largura da seta indicativa. Esse valor é automaticamente definido em Largura ou Altura conforme a Gravity configurada. Este valor sobrescreve R.dimen.simpletooltip_arrow_width

Width of the arrow. This value is automatically set in the Width or Height as the Gravity.

Parameters:

arrowWidth -

Largura em pixels.

Width in pixels.

Returns:

this

onDismissListener

public SimpleTooltip.Builder onDismissListener(SimpleTooltip.OnDismissListener onDismissListener)

onShowListener

public SimpleTooltip.Builder onShowListener(SimpleTooltip.OnShowListener onShowListener)

focusable

public SimpleTooltip.Builder focusable(boolean focusable)

Habilita o foco no conteúdo da tooltip. Padrão é false.

Enables focus in the tooltip content. Default is false.

Parameters:

focusable -

Pode receber o foco.

Can receive focus.

Returns:

this

highlightShape

public SimpleTooltip.Builder highlightShape(int highlightShape)

Configura o formato do Shape em destaque.
OverlayView.HIGHLIGHT_SHAPE_OVAL - Destaque oval (padrão).
OverlayView.HIGHLIGHT_SHAPE_RECTANGULAR - Destaque retangular.

Configure the the Shape type.
OverlayView.HIGHLIGHT_SHAPE_OVAL - Shape oval (default).
OverlayView.HIGHLIGHT_SHAPE_RECTANGULAR - Shape rectangular.

Parameters:

highlightShape -

Formato do Shape.

Shape type.

Returns:

this

See Also:

OverlayView.HIGHLIGHT_SHAPE_OVAL, OverlayView.HIGHLIGHT_SHAPE_RECTANGULAR, transparentOverlay(boolean)

overlayOffset

public SimpleTooltip.Builder overlayOffset(@Dimension
                                           float overlayOffset)

Tamanho da margem entre anchorView(View) e a borda do Shape de destaque. Este valor sobrescreve R.dimen.simpletooltip_overlay_offset

Margin between anchorView(View) and highlight Shape border. This value override R.dimen.simpletooltip_overlay_offset

Parameters:

overlayOffset -

Tamanho em pixels.

Size in pixels.

Returns:

this

See Also:

anchorView(View), transparentOverlay(boolean)

overlayMatchParent

public SimpleTooltip.Builder overlayMatchParent(boolean overlayMatchParent)

Define o comportamento do overlay. Utilizado para casos onde a view de Overlay não pode ser MATCH_PARENT. Como em uma Dialog ou DialogFragment.

Sets the behavior of the overlay view. Used for cases where the Overlay view can not be MATCH_PARENT. Like in a Dialog or DialogFragment.

Parameters:

overlayMatchParent -

True se o overlay deve ser MATCH_PARENT. False se ele deve obter o mesmo tamanho do pai.

True if the overlay should be MATCH_PARENT. False if it should get the same size as the parent.

Returns:

this