org.mini2Dx.ui.element

Interface MultiToggle

All Superinterfaces:

Actionable, Hoverable

All Known Implementing Classes:

Select

public interface MultiToggle
extends Actionable

Interface for toggle elements that have multiple options (e.g. left/right selectors)

Method Summary

Modifier and Type	Method and Description
int	getSelectedIndex() Returns the index of the currently selected option
int	getTotalOptions() Returns the total amount of options
void	nextOption() Changes the current selection to the next available option
void	previousOption() Changes the current selection to the option before the currently selected option.
void	setSelectedIndex(int index) Sets the currently selected option

Methods inherited from interface org.mini2Dx.ui.element.Actionable

addActionListener, isEnabled, notifyActionListenersOfBeginEvent, notifyActionListenersOfEndEvent, removeActionListener, setEnabled

Methods inherited from interface org.mini2Dx.ui.element.Hoverable

addHoverListener, getId, invokeBeginHover, invokeEndHover, isHoverEnabled, notifyHoverListenersOnBeginHover, notifyHoverListenersOnEndHover, removeHoverListener, setHoverEnabled

Method Detail

getSelectedIndex

int getSelectedIndex()

Returns the index of the currently selected option

Returns:

0 by default

setSelectedIndex

void setSelectedIndex(int index)

Sets the currently selected option

Parameters:

index - The index to set as selected

getTotalOptions

int getTotalOptions()

Returns the total amount of options

Returns:

0 if no options have been added

nextOption

void nextOption()

Changes the current selection to the next available option

previousOption

void previousOption()

Changes the current selection to the option before the currently selected option.