org.mini2Dx.ui.element

Interface Hoverable

All Known Subinterfaces:

Actionable

All Known Implementing Classes:

AnimatedImage, Button, Checkbox, Container, CustomUiElement, Div, FlexRow, Image, ImageButton, Label, ParentUiElement, ProgressBar, RadioButton, ScrollBox, Select, Slider, Tab, TabButton, TabView, TextBox, TextButton, UiContainer, UiElement

public interface Hoverable

Common interface for hoverable UiElements

Method Summary

Modifier and Type	Method and Description
void	addHoverListener(HoverListener listener) Adds a HoverListener to listen for hover events
java.lang.String	getId() Returns the unique id
void	invokeBeginHover() Triggers the begin hover event
void	invokeEndHover() Triggers the end hover event
void	notifyHoverListenersOnBeginHover() Notifies all HoverListeners of a begin hover event
void	notifyHoverListenersOnEndHover() Notifies all HoverListeners of an end hover event
void	removeHoverListener(HoverListener listener) Removes a HoverListener from this Hoverable

Method Detail

getId

java.lang.String getId()

Returns the unique id

Returns:

addHoverListener

void addHoverListener(HoverListener listener)

Adds a HoverListener to listen for hover events

Parameters:

listener - The HoverListener to add

removeHoverListener

void removeHoverListener(HoverListener listener)

Removes a HoverListener from this Hoverable

Parameters:

listener - The HoverListener to remove

notifyHoverListenersOnBeginHover

void notifyHoverListenersOnBeginHover()

Notifies all HoverListeners of a begin hover event

notifyHoverListenersOnEndHover

void notifyHoverListenersOnEndHover()

Notifies all HoverListeners of an end hover event

invokeBeginHover

void invokeBeginHover()

Triggers the begin hover event

invokeEndHover

void invokeEndHover()

Triggers the end hover event