Class CheckBox

java.lang.Object

de.gurkenlabs.litiengine.gui.GuiComponent

de.gurkenlabs.litiengine.gui.ImageComponent

de.gurkenlabs.litiengine.gui.CheckBox

All Implemented Interfaces:

IRenderable, Tweenable, MouseListener, MouseMotionListener, MouseWheelListener, EventListener

public class CheckBox
extends ImageComponent

A GUI component representing a checkbox with an optional spritesheet.

Field Summary

Fields

Modifier and Type	Field	Description
static final FontIcon	CHECK	The icon representing a checked state.
static final FontIcon	CROSS	The icon representing an unchecked state.

Fields inherited from class de.gurkenlabs.litiengine.gui.ImageComponent

BACKGROUND_DISABLED_INDEX, BACKGROUND_HOVER_INDEX, BACKGROUND_INDEX, BACKGROUND_PRESSED_INDEX

Fields inherited from class de.gurkenlabs.litiengine.gui.GuiComponent

ICON_FONT

Constructor Summary

Constructors

Constructor	Description
CheckBox(double x, double y, double width, double height, Spritesheet spritesheet, boolean checked)	Constructs a new CheckBox.

Method Summary

Modifier and Type	Method	Description
List<Consumer<Boolean>>	getChangeConsumer()	Gets the list of consumers to be notified when the checked state changes.
boolean	isChecked()	Checks if the checkbox is currently checked.
void	onChange(Consumer<Boolean> c)	Adds a consumer to be notified when the checked state changes.
void	setChecked(boolean checked)	Sets the checked state of the checkbox.

Methods inherited from class de.gurkenlabs.litiengine.gui.ImageComponent

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

Methods inherited from class de.gurkenlabs.litiengine.gui.GuiComponent

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

Methods inherited from class java.lang.Object

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

Field Details

CHECK

public static final FontIcon CHECK

The icon representing a checked state.

CROSS

public static final FontIcon CROSS

The icon representing an unchecked state.

Constructor Details

CheckBox

public CheckBox(double x,
 double y,
 double width,
 double height,
 Spritesheet spritesheet,
 boolean checked)

Constructs a new CheckBox.

Parameters:

x - the x-coordinate of the checkbox

y - the y-coordinate of the checkbox

width - the width of the checkbox

height - the height of the checkbox

spritesheet - the spritesheet for the checkbox

checked - the initial checked state of the checkbox

Method Details

getChangeConsumer

public List<Consumer<Boolean>> getChangeConsumer()

Gets the list of consumers to be notified when the checked state changes.

Returns:

the list of change consumers

isChecked

public boolean isChecked()

Checks if the checkbox is currently checked.

Returns:

true if the checkbox is checked, false otherwise

onChange

public void onChange(Consumer<Boolean> c)

Adds a consumer to be notified when the checked state changes.

Parameters:

c - the consumer to be added

setChecked

public void setChecked(boolean checked)

Sets the checked state of the checkbox.

Parameters:

checked - the new checked state