APIdia Launch Partner

Top Description Fields Constructors Methods

com.badlogic.gdx.scenes.scene2d.ui

public Class TooltipManager

Class Inheritance

extends Object

java.lang.Object
com.badlogic.gdx.scenes.scene2d.ui.TooltipManager

Static Imports

com.badlogic.gdx.math.Interpolation.*, com.badlogic.gdx.scenes.scene2d.actions.Actions.*

Keeps track of an application's tooltips.

Author: Nathan Sweet

Field Summary

Modifier and Type	Field and Description
public boolean	animations If false, tooltips will be shown without animations.
public float	edgeDistance The distance from the tooltip actor position to the edge of the screen where the actor will be shown on the other side of the mouse cursor.
public boolean	enabled If false, tooltips will not be shown.
private static Files	files
public float	initialTime Seconds from when an actor is hovered to when the tooltip is shown.
private static TooltipManager	instance
public float	maxWidth The maximum width of a `TextTooltip`.
public float	offsetX The distance from the mouse position to offset the tooltip actor.
public float	offsetY The distance from the mouse position to offset the tooltip actor.
pack-priv final Timer.Task	resetTask
public float	resetTime Seconds to use `subsequentTime`.
pack-priv final Array<Tooltip<T extends Actor>>	shown
pack-priv final Timer.Task	showTask
pack-priv Tooltip<T extends Actor>	showTooltip
public float	subsequentTime Once a tooltip is shown, this is used instead of `initialTime`.
pack-priv float	time

Constructor Summary

Access	Constructor and Description
public	TooltipManager()

Method Summary

Modifier and Type	Method and Description
public void	enter(Tooltip<T extends Actor> tooltip)
public static TooltipManager	getInstance()
public void	hide(Tooltip<T extends Actor> tooltip)
protected void	hideAction(Tooltip<T extends Actor> tooltip) Called when tooltip is hidden.
public void	hideAll()
public void	instant() Shows all tooltips on hover without a delay for `resetTime` seconds.
protected void	showAction(Tooltip<T extends Actor> tooltip) Called when tooltip is shown.
public void	touchDown(Tooltip<T extends Actor> tooltip)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

animations	back to summary
public boolean animations If false, tooltips will be shown without animations. Default is true.

edgeDistance	back to summary
public float edgeDistance The distance from the tooltip actor position to the edge of the screen where the actor will be shown on the other side of the mouse cursor. Default is 7.

enabled	back to summary
public boolean enabled If false, tooltips will not be shown. Default is true.

files	back to summary
private static Files files

initialTime	back to summary
public float initialTime Seconds from when an actor is hovered to when the tooltip is shown. Default is 2. Call `hideAll()` after changing to reset internal state.

instance	back to summary
private static TooltipManager instance

maxWidth	back to summary
public float maxWidth The maximum width of a `TextTooltip`. The label will wrap if needed. Default is Integer.MAX_VALUE.

offsetX	back to summary
public float offsetX The distance from the mouse position to offset the tooltip actor. Default is 15,19.

offsetY	back to summary
public float offsetY The distance from the mouse position to offset the tooltip actor. Default is 15,19.

resetTask	back to summary
pack-priv final Timer.Task resetTask

resetTime	back to summary
public float resetTime Seconds to use `subsequentTime`. Default is 1.5.

shown	back to summary
pack-priv final Array<Tooltip<T extends Actor>> shown

showTask	back to summary
pack-priv final Timer.Task showTask

showTooltip	back to summary
pack-priv Tooltip<T extends Actor> showTooltip

subsequentTime	back to summary
public float subsequentTime Once a tooltip is shown, this is used instead of `initialTime`. Default is 0.

time	back to summary
pack-priv float time

Constructor Detail

TooltipManager	back to summary
public TooltipManager()

Method Detail

enter	back to summary
public void enter(Tooltip<T extends Actor> tooltip)

getInstance	back to summary
public static TooltipManager getInstance()

hide	back to summary
public void hide(Tooltip<T extends Actor> tooltip)

hideAction	back to summary
protected void hideAction(Tooltip<T extends Actor> tooltip) Called when tooltip is hidden. Default implementation sets actions to animate hiding and to remove the actor from the stage when the actions are complete. A subclass must at least remove the actor.

hideAll	back to summary
public void hideAll()

instant	back to summary
public void instant() Shows all tooltips on hover without a delay for `resetTime` seconds.

showAction	back to summary
protected void showAction(Tooltip<T extends Actor> tooltip) Called when tooltip is shown. Default implementation sets actions to animate showing.

touchDown	back to summary
public void touchDown(Tooltip<T extends Actor> tooltip)