Package arc.scene.ui

Class Tooltip

java.lang.Object

arc.scene.event.InputListener

arc.scene.ui.Tooltip

All Implemented Interfaces:

EventListener

public class Tooltip
extends InputListener

A listener that shows a tooltip element when another element is hovered over with the mouse.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Tooltip.Tooltips	Keeps track of an application's tooltips.

Field Summary

Fields

Modifier and Type	Field	Description
boolean	allowMobile
boolean	always
final Table	container
boolean	instant
final Tooltip.Tooltips	manager
protected Runnable	show
protected Element	targetActor

Constructor Summary

Constructors

Constructor	Description
Tooltip(Cons<Table> contents)
Tooltip(Cons<Table> contents, Tooltip.Tooltips manager)
Tooltip(Cons<Table> contents, Runnable show)

Method Summary

Modifier and Type	Method	Description
void	enter(InputEvent event, float x, float y, int pointer, Element fromActor)	Called any time the mouse cursor or a finger touch is moved over an element.
void	exit(InputEvent event, float x, float y, int pointer, Element toActor)	Called any time the mouse cursor or a finger touch is moved out of an element.
Table	getContainer()
Tooltip.Tooltips	getManager()
void	hide()
boolean	mouseMoved(InputEvent event, float x, float y)	Called any time the mouse is moved when a button is not down.
void	setAlways(boolean always)	If true, this tooltip is shown even when tooltips are not Tooltip.Tooltips.enabled.
protected void	setContainerPosition(Element element, float x, float y)
void	setInstant(boolean instant)	If true, this tooltip is shown without delay when hovered.
void	show(Element element, float x, float y)
boolean	touchDown(InputEvent event, float x, float y, int pointer, KeyCode button)	Called when a mouse button or a finger touch goes down on the element.
void	touchUp(InputEvent event, float x, float y, int pointer, KeyCode button)	Called when a mouse button or a finger touch goes up anywhere, but only if touchDown previously returned true for the mouse button or touch.

Methods inherited from class arc.scene.event.InputListener

handle, keyDown, keyTyped, keyUp, scrolled, touchDragged

Methods inherited from class java.lang.Object

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

Field Details

manager

public final Tooltip.Tooltips manager

container

public final Table container

allowMobile

public boolean allowMobile

instant

public boolean instant

always

public boolean always

targetActor

protected Element targetActor

show

protected Runnable show

Constructor Details

Tooltip

public Tooltip(Cons<Table> contents)

Tooltip

public Tooltip(Cons<Table> contents,
 Runnable show)

Tooltip

public Tooltip(Cons<Table> contents,
 Tooltip.Tooltips manager)

Method Details

getManager

public Tooltip.Tooltips getManager()

getContainer

public Table getContainer()

setInstant

public void setInstant(boolean instant)

If true, this tooltip is shown without delay when hovered.

setAlways

public void setAlways(boolean always)

If true, this tooltip is shown even when tooltips are not Tooltip.Tooltips.enabled.

touchDown

public boolean touchDown(InputEvent event,
 float x,
 float y,
 int pointer,
 KeyCode button)

Description copied from class: InputListener

Called when a mouse button or a finger touch goes down on the element. If true is returned, this listener will receive all touchDragged and touchUp events, even those not over this element, until touchUp is received. Also when true is returned, the event is handled.

Overrides:

touchDown in class InputListener

See Also:

• InputEvent

touchUp

public void touchUp(InputEvent event,
 float x,
 float y,
 int pointer,
 KeyCode button)

Description copied from class: InputListener

Called when a mouse button or a finger touch goes up anywhere, but only if touchDown previously returned true for the mouse button or touch. The touchUp event is always handled.

Overrides:

touchUp in class InputListener

See Also:

• InputEvent

mouseMoved

public boolean mouseMoved(InputEvent event,
 float x,
 float y)

Description copied from class: InputListener

Called any time the mouse is moved when a button is not down. This event only occurs on the desktop. When true is returned, the event is handled.

Overrides:

mouseMoved in class InputListener

See Also:

• InputEvent

setContainerPosition

protected void setContainerPosition(Element element,
 float x,
 float y)

enter

public void enter(InputEvent event,
 float x,
 float y,
 int pointer,
 Element fromActor)

Description copied from class: InputListener

Called any time the mouse cursor or a finger touch is moved over an element. On the desktop, this event occurs even when no mouse buttons are pressed (pointer will be -1).

Overrides:

enter in class InputListener

fromActor - May be null.

See Also:

• InputEvent

exit

public void exit(InputEvent event,
 float x,
 float y,
 int pointer,
 Element toActor)

Description copied from class: InputListener

Called any time the mouse cursor or a finger touch is moved out of an element. On the desktop, this event occurs even when no mouse buttons are pressed (pointer will be -1).

Overrides:

exit in class InputListener

toActor - May be null.

See Also:

• InputEvent

show

public void show(Element element,
 float x,
 float y)

hide

public void hide()