Class GUICycler<T>

java.lang.Object

com.blackrook.gui.GUIObject

com.blackrook.gui.object.GUILabel

com.blackrook.gui.object.GUICycler<T>

Type Parameters:

T - the object type in the cycler.

All Implemented Interfaces:

GUISelectable<T>, GUIValueField<T>

public class GUICycler<T>
extends GUILabel
implements GUIValueField<T>, GUISelectable<T>

Option cycler abstract. A cycler changes its value each click. An GUIValueField.EVENT_VALUE_CHANGE event is fired each value change.

Nested Class Summary

Nested classes/interfaces inherited from class GUILabel

GUILabel.Alignment, GUILabel.Justification, GUILabel.ResizeMode, GUILabel.TextPiece

Nested classes/interfaces inherited from class GUIObject

GUIObject.ScaleType

Field Summary

Fields

Modifier and Type	Field	Description
protected static final GUIAction	BASIC_ACTION
protected int	currentIndex	The current choice index.
protected IndexedModel<T>	model	The model to use.

Fields inherited from class GUIObject

absoluteBounds, EVENT_BLUR, EVENT_CHANGE_ENABLE_STATE, EVENT_CHANGE_VISIBLE_STATE, EVENT_FOCUS, EVENT_GAMEPAD_AXIS, EVENT_GAMEPAD_PRESS, EVENT_GAMEPAD_RELEASE, EVENT_GAMEPAD_TAP_PRESS, EVENT_GAMEPAD_TAP_RELEASE, EVENT_GENERIC_INPUT, EVENT_KEY_PRESS, EVENT_KEY_RELEASE, EVENT_KEY_TYPE, EVENT_MOUSE_CLICK, EVENT_MOUSE_DRAG, EVENT_MOUSE_LEAVE, EVENT_MOUSE_MOVE, EVENT_MOUSE_OVER, EVENT_MOUSE_PRESS, EVENT_MOUSE_RELEASE, EVENT_MOUSE_WHEEL, EVENT_NAMED, EVENT_UNKNOWN

Fields inherited from interface GUISelectable

NO_SELECTION

Fields inherited from interface GUIValueField

EVENT_VALUE_CHANGE

Constructor Summary

Constructors

Constructor	Description
GUICycler(IndexedModel<T> model)	Creates a new cycler with a set of items to cycle through.

Method Summary

Modifier and Type	Method	Description
protected void	advanceSelection()	Advances the cycler's selected index.
int	getSelectedIndex()	Gets the selected index on the object.
T	getSelectedValue()
T	getValue()
protected void	reverseSelection()	Reverses the cycler's selected index.
GUICycler<T>	setSelectedIndex(int index)	Sets the selected index on the object.
GUICycler<T>	setValue(Object value)	Sets this field's value.

Methods inherited from class GUILabel

getAlignment, getFont, getJustification, getMaxWidth, getResizeMode, getSize, getStartingLine, getText, getTextPiece, getTextPieceCount, getTexture, getThemeKey, isWordWrapping, onGUIChange, setAlignment, setBounds, setFont, setJustification, setMaxWidth, setResizeMode, setSize, setStartingLine, setText, setTheme, setThemeKey, setWordWrapping, stretch

Methods inherited from class GUIObject

addChild, addChild, addName, addToRenderSet, animate, animate, animate, animateAbort, animateDelay, animateFinish, bindAction, callAction, correctPosition, fireEvent, getAbsoluteBounds, getAsQuery, getBounds, getChildrenAsQuery, getColor, getColorNotInherited, getDescendantsAsQuery, getFinalOpacity, getGeneration, getGUI, getLayout, getLayoutAttrib, getNativeBounds, getOpacity, getParent, getParentAsQuery, getRenderAlpha, getRenderBlue, getRendered, getRenderGreen, getRenderHeight, getRenderPositionX, getRenderPositionY, getRenderRadius, getRenderRed, getRenderRotationZ, getRenderTextureScaleS, getRenderTextureScaleT, getRenderWidth, getScaleType, getSiblingsAsQuery, getTheme, getVisible, hasAction, hasName, hasNamePattern, isAnimating, isConstrainedToParent, isEnabled, isFocused, isInert, isVisible, moveDown, moveToBack, moveToFront, moveUp, releaseFocus, remove, removeChild, removeName, requestFocus, resizeChildren, rotate, setBounds, setBoundsByChildren, setColor, setColor, setColorNotInherited, setConstrainToParent, setDimensions, setEnabled, setInert, setLayout, setLayoutAttrib, setOpacity, setPosition, setRendered, setRotationZ, setScaleType, setTexture, setVisible, toString, translate, unbindAction, unbindAllActions, updateDirty, updateScenePosition, useRenderRadius

Methods inherited from class Object

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

Field Details

model

protected IndexedModel<T> model

The model to use.

currentIndex

protected int currentIndex

The current choice index.

BASIC_ACTION

protected static final GUIAction BASIC_ACTION

Constructor Details

GUICycler

public GUICycler(IndexedModel<T> model)

Creates a new cycler with a set of items to cycle through.

Parameters:

model - the model that this cycler uses for values.

Method Details

setSelectedIndex

public GUICycler<T> setSelectedIndex(int index)

Description copied from interface: GUISelectable

Sets the selected index on the object. If the index is out of bounds, it should be set to -1, meaning nothing selected.

Specified by:

setSelectedIndex in interface GUISelectable<T>

Parameters:

index - the new selected index.

Returns:

this selectable.

getSelectedIndex

public int getSelectedIndex()

Description copied from interface: GUISelectable

Gets the selected index on the object.

Specified by:

getSelectedIndex in interface GUISelectable<T>

Returns:

the current selected index.

getSelectedValue

public T getSelectedValue()

Specified by:

getSelectedValue in interface GUISelectable<T>

Returns:

the current selected value, or null if no value selected.

getValue

public T getValue()

Specified by:

getValue in interface GUIValueField<T>

Returns:

this field's current value.

setValue

public GUICycler<T> setValue(Object value)

Description copied from interface: GUIValueField

Sets this field's value. This must accept any object, and attempt to set the correct value based on it. This object must fire an GUIValueField.EVENT_VALUE_CHANGE event if it changes from its current value.

Specified by:

setValue in interface GUIValueField<T>

Parameters:

value - the value to set.

Returns:

itself, to chain calls.

advanceSelection

protected void advanceSelection()

Advances the cycler's selected index.

reverseSelection

protected void reverseSelection()

Reverses the cycler's selected index.