Class Spinner

java.lang.Object

de.gurkenlabs.litiengine.gui.GuiComponent

de.gurkenlabs.litiengine.gui.ImageComponent

de.gurkenlabs.litiengine.gui.TextFieldComponent

de.gurkenlabs.litiengine.gui.Spinner

All Implemented Interfaces:

IRenderable, Tweenable, MouseListener, MouseMotionListener, MouseWheelListener, EventListener

public class Spinner
extends TextFieldComponent

A numeric text-field component with attached up/down arrow buttons that adjust the current value by a configurable step size within a bounded range. The value can also be edited directly via the text field or adjusted using the up/down arrow keys.

Field Summary

Fields

Modifier and Type	Field	Description
static final FontIcon	ARROW_DOWN	Down-arrow icon shown on the decrement button.
static final FontIcon	ARROW_UP	Up-arrow icon shown on the increment button.

Fields inherited from class TextFieldComponent

DOUBLE_FORMAT, INTEGER_FORMAT

Fields inherited from class ImageComponent

BACKGROUND_DISABLED_INDEX, BACKGROUND_HOVER_INDEX, BACKGROUND_INDEX, BACKGROUND_PRESSED_INDEX

Fields inherited from class GuiComponent

ICON_FONT

Constructor Summary

Constructors

Constructor	Description
Spinner(double x, double y, double width, double height, double lowerBound, double upperBound, double startValue, double stepSize)	Constructs a new spinner.

Method Summary

Modifier and Type	Method	Description
void	decrement()	Decreases the current value by one step, clamping to the lower bound.
BigDecimal	getCurrentValue()	Gets the current value of the spinner.
BigDecimal	getLowerBound()	Gets the lowest allowed value of the spinner.
BigDecimal	getStepSize()	Gets the step size between adjacent spinner values.
BigDecimal	getUpperBound()	Gets the highest allowed value of the spinner.
void	increment()	Increases the current value by one step, clamping to the upper bound.
void	onValueChange(Consumer<BigDecimal> cons)	Registers a callback invoked whenever the spinner value changes.
void	prepare()	Prepare the GuiComponent and all its child Components (Makes the GuiComponent visible and adds mouse listeners.).
void	setCurrentValue(BigDecimal newValue)	Sets the current value, clamped to the configured range, and notifies registered change listeners.
void	setLowerBound(BigDecimal lowerBound)	Sets the lowest allowed value.
void	setStepSize(BigDecimal stepSize)	Sets the step size between adjacent spinner values.
void	setUpperBound(BigDecimal upperBound)	Sets the highest allowed value.

Methods inherited from class TextFieldComponent

canHandleInput, getCursor, getFormat, getMaxLength, getText, getTextToRender, handleTypedKey, onChangeConfirmed, render, setCursor, setFlickerDelay, setFormat, setMaxLength, setText

Methods inherited from class ImageComponent

getBackground, getHorizontalImagePadding, getImage, getImageAlign, getImageScaleInterpolation, getImageScaleMode, getImageValign, getSpritesheet, getSpritesheetScaleFactor, getSpritesheetScaleInterpolation, getSpritesheetScaleMode, getVerticalImagePadding, rescaleImage, setHeight, setHorizontalImagePadding, setImage, setImageAlign, setImageScaleInterpolation, setImageScaleMode, setImageValign, setSpritesheet, setSpritesheet, setSpritesheet, setSpritesheetScaleFactor, setSpritesheetScaleInterpolation, setSpritesheetScaleMode, setVerticalImagePadding, setWidth

Methods inherited from class GuiComponent

addRenderedListener, addRenderListener, getAppearance, getAppearanceDisabled, getAppearanceHovered, getBoundingBox, getCenterX, getCenterY, getClickConsumer, getComponentId, getComponents, getCurrentAppearance, getFocusedComponent, getFont, getHeight, getHoverConsumer, getHoverSound, getLocation, getMouseDraggedConsumer, getMouseEnterConsumer, getMouseLeaveConsumer, getMouseMovedConsumer, getMousePressedConsumer, getMouseReleasedConsumer, getMouseWheelConsumer, getName, getShape, getTag, getTextAlign, getTextAngle, getTextShadowColor, getTextShadowRadius, getTextValign, getTextX, getTextY, getTweenValues, getWidth, getX, getY, hasAutomaticLineBreaks, hasInputFocus, hasTextAntialiasing, hasTextShadow, initializeComponents, isAutoScaling, isEnabled, isFocusable, isForwardMouseEvents, isHovered, isPressed, isSelected, isSuspended, isVisible, mouseClicked, mouseDragged, mouseEntered, mouseEventShouldBeForwarded, mouseExited, mouseMoved, mousePressed, mouseReleased, mouseWheelMoved, onClicked, onHovered, onMouseDragged, onMouseEnter, onMouseLeave, onMouseMoved, onMousePressed, onMouseReleased, onMouseWheelScrolled, onResolutionChanged, onTextChanged, removeListener, removeListener, setAutomaticLineBreaks, setAutoScaling, setDimension, setEnabled, setFocusable, setFont, setFontSize, setForwardMouseEvents, setHovered, setHoverSound, setLocation, setLocation, setName, setSelected, setTag, setTextAlign, setTextAngle, setTextAntialiasing, setTextShadow, setTextShadowColor, setTextShadowRadius, setTextValign, setTextX, setTextY, setTweenValues, setVisible, setX, setY, suspend, toggleSelection, toggleSuspension

Methods inherited from class Object

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

Field Details

ARROW_DOWN

public static final FontIcon ARROW_DOWN

Down-arrow icon shown on the decrement button.

ARROW_UP

public static final FontIcon ARROW_UP

Up-arrow icon shown on the increment button.

Constructor Details

Spinner

public Spinner(double x,
 double y,
 double width,
 double height,
 double lowerBound,
 double upperBound,
 double startValue,
 double stepSize)

Constructs a new spinner.

Parameters:

x - the x coordinate of the component

y - the y coordinate of the component

width - the width of the component

height - the height of the component

lowerBound - the lowest allowed value

upperBound - the highest allowed value

startValue - the initial value

stepSize - the step size between adjacent values

Method Details

decrement

public void decrement()

Decreases the current value by one step, clamping to the lower bound.

getCurrentValue

public BigDecimal getCurrentValue()

Gets the current value of the spinner.

Returns:

the current value

getLowerBound

public BigDecimal getLowerBound()

Gets the lowest allowed value of the spinner.

Returns:

the lower bound

getStepSize

public BigDecimal getStepSize()

Gets the step size between adjacent spinner values.

Returns:

the step size

getUpperBound

public BigDecimal getUpperBound()

Gets the highest allowed value of the spinner.

Returns:

the upper bound

increment

public void increment()

Increases the current value by one step, clamping to the upper bound.

onValueChange

public void onValueChange(Consumer<BigDecimal> cons)

Registers a callback invoked whenever the spinner value changes.

Parameters:

cons - the change consumer

prepare

public void prepare()

Description copied from class: GuiComponent

Prepare the GuiComponent and all its child Components (Makes the GuiComponent visible and adds mouse listeners.). This is, for example, done right before switching to a new screen.

Overrides:

prepare in class GuiComponent

setCurrentValue

public void setCurrentValue(BigDecimal newValue)

Sets the current value, clamped to the configured range, and notifies registered change listeners.

Parameters:

newValue - the new value

setLowerBound

public void setLowerBound(BigDecimal lowerBound)

Sets the lowest allowed value. If the current value is below the new bound, the current value is clamped to the new bound.

Parameters:

lowerBound - the new lower bound

setStepSize

public void setStepSize(BigDecimal stepSize)

Sets the step size between adjacent spinner values.

Parameters:

stepSize - the step size

setUpperBound

public void setUpperBound(BigDecimal upperBound)

Sets the highest allowed value. If the current value is above the new bound, the current value is clamped to the new bound.

Parameters:

upperBound - the new upper bound

classguiapijava