com.badlogic.gdx.scenes.scene2d.ui

Class CheckBox

java.lang.Object

com.badlogic.gdx.scenes.scene2d.Actor

com.badlogic.gdx.scenes.scene2d.Group

com.badlogic.gdx.scenes.scene2d.ui.WidgetGroup

com.badlogic.gdx.scenes.scene2d.ui.Table

com.badlogic.gdx.scenes.scene2d.ui.Button

com.badlogic.gdx.scenes.scene2d.ui.TextButton

com.badlogic.gdx.scenes.scene2d.ui.CheckBox

All Implemented Interfaces:

Cullable, Disableable, Layout

public class CheckBox
extends TextButton

A checkbox is a button that contains an image indicating the checked or unchecked state and a label.

Author:

Nathan Sweet

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CheckBox.CheckBoxStyle The style for a select box, see CheckBox.

Nested classes/interfaces inherited from class com.badlogic.gdx.scenes.scene2d.ui.TextButton

TextButton.TextButtonStyle

Nested classes/interfaces inherited from class com.badlogic.gdx.scenes.scene2d.ui.Button

Button.ButtonStyle

Nested classes/interfaces inherited from class com.badlogic.gdx.scenes.scene2d.ui.Table

Table.Debug, Table.DebugRect

Field Summary

Fields inherited from class com.badlogic.gdx.scenes.scene2d.ui.Table

backgroundBottom, backgroundLeft, backgroundRight, backgroundTop, debugActorColor, debugCellColor, debugTableColor

Constructor Summary

Constructors

Constructor and Description
CheckBox(java.lang.String text, CheckBox.CheckBoxStyle style)
CheckBox(java.lang.String text, Skin skin)
CheckBox(java.lang.String text, Skin skin, java.lang.String styleName)

Method Summary

Modifier and Type	Method and Description
void	draw(Batch batch, float parentAlpha) If this method is overridden, the super method or WidgetGroup.validate() should be called to ensure the widget group is laid out.
Image	getImage()
Cell	getImageCell()
CheckBox.CheckBoxStyle	getStyle() Returns the checkbox's style.
void	setStyle(Button.ButtonStyle style)

Methods inherited from class com.badlogic.gdx.scenes.scene2d.ui.TextButton

getLabel, getLabelCell, getText, setText

Methods inherited from class com.badlogic.gdx.scenes.scene2d.ui.Button

getButtonGroup, getClickListener, getMinHeight, getMinWidth, getPrefHeight, getPrefWidth, isChecked, isDisabled, isOver, isPressed, setChecked, setDisabled, setProgrammaticChangeEvents, toggle

Methods inherited from class com.badlogic.gdx.scenes.scene2d.ui.Table

add, add, add, add, add, add, add, align, background, background, bottom, center, clearChildren, columnDefaults, debug, debug, debugActor, debugAll, debugCell, debugTable, defaults, drawBackground, drawDebug, drawDebugBounds, getAlign, getBackground, getCell, getCells, getClip, getColumnMinWidth, getColumnPrefWidth, getColumns, getColumnWidth, getPadBottom, getPadBottomValue, getPadLeft, getPadLeftValue, getPadRight, getPadRightValue, getPadTop, getPadTopValue, getPadX, getPadY, getRow, getRowHeight, getRowMinHeight, getRowPrefHeight, getRows, getSkin, getTableDebug, hit, invalidate, layout, left, pad, pad, pad, pad, padBottom, padBottom, padLeft, padLeft, padRight, padRight, padTop, padTop, removeActor, removeActor, reset, right, row, setBackground, setBackground, setClip, setDebug, setRound, setSkin, stack, top

Methods inherited from class com.badlogic.gdx.scenes.scene2d.ui.WidgetGroup

childrenChanged, getMaxHeight, getMaxWidth, invalidateHierarchy, needsLayout, pack, setFillParent, setLayoutEnabled, sizeChanged, validate

Methods inherited from class com.badlogic.gdx.scenes.scene2d.Group

act, addActor, addActorAfter, addActorAt, addActorBefore, applyTransform, applyTransform, clear, computeTransform, drawChildren, drawDebugChildren, findActor, getChildren, getCullingArea, hasChildren, isTransform, localToDescendantCoordinates, resetTransform, resetTransform, setCullingArea, setDebug, setStage, setTransform, swapActor, swapActor, toString

Methods inherited from class com.badlogic.gdx.scenes.scene2d.Actor

addAction, addCaptureListener, addListener, clearActions, clearListeners, clipBegin, clipBegin, clipEnd, fire, firstAscendant, getActions, getCaptureListeners, getColor, getDebug, getHeight, getListeners, getName, getOriginX, getOriginY, getParent, getRight, getRotation, getScaleX, getScaleY, getStage, getTop, getTouchable, getUserObject, getWidth, getX, getX, getY, getY, getZIndex, hasActions, hasParent, isAscendantOf, isDescendantOf, isTouchable, isVisible, localToAscendantCoordinates, localToParentCoordinates, localToStageCoordinates, moveBy, notify, parentToLocalCoordinates, positionChanged, remove, removeAction, removeCaptureListener, removeListener, rotateBy, rotationChanged, scaleBy, scaleBy, screenToLocalCoordinates, setBounds, setColor, setColor, setHeight, setName, setOrigin, setOrigin, setOriginX, setOriginY, setParent, setPosition, setPosition, setRotation, setScale, setScale, setScaleX, setScaleY, setSize, setTouchable, setUserObject, setVisible, setWidth, setX, setY, setZIndex, sizeBy, sizeBy, stageToLocalCoordinates, toBack, toFront

Methods inherited from class java.lang.Object

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

Constructor Detail

CheckBox

public CheckBox(java.lang.String text,
                Skin skin)

CheckBox

public CheckBox(java.lang.String text,
                Skin skin,
                java.lang.String styleName)

CheckBox

public CheckBox(java.lang.String text,
                CheckBox.CheckBoxStyle style)

Method Detail

setStyle

public void setStyle(Button.ButtonStyle style)

Overrides:

setStyle in class TextButton

getStyle

public CheckBox.CheckBoxStyle getStyle()

Returns the checkbox's style. Modifying the returned style may not have an effect until Button.setStyle(ButtonStyle) is called.

Overrides:

getStyle in class TextButton

draw

public void draw(Batch batch,
                 float parentAlpha)

Description copied from class: WidgetGroup

If this method is overridden, the super method or WidgetGroup.validate() should be called to ensure the widget group is laid out.

Overrides:

draw in class TextButton

parentAlpha - Should be multiplied with the actor's alpha, allowing a parent's alpha to affect all children.

getImage

public Image getImage()

getImageCell

public Cell getImageCell()