org.mini2Dx.ui.element

Interface Hoverable

All Known Subinterfaces:

Actionable

All Known Implementing Classes:

AbsoluteContainer, AbsoluteModal, AlignedContainer, AlignedModal, AnimatedImage, Button, Checkbox, Column, Container, EditorInGameView, EditorNewFileDialog, EditorOpenFileDialog, Image, ImageButton, Label, Modal, ParentUiElement, ProgressBar, RadioButton, Row, ScrollBox, Select, Slider, StyleRulesetEditor, Tab, TabButton, TabView, TextBox, TextButton, UiContainer, UiEditorContainersView, UiEditorThemeView, UiElement, UiElementEditor, UiHierarchyEditor

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	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