Class GUICheckbox

java.lang.Object

com.blackrook.gui.GUIObject

com.blackrook.gui.object.GUITogglePanel

com.blackrook.gui.object.GUICheckbox

All Implemented Interfaces:

GUIToggleable, GUIValueField<Boolean>

public class GUICheckbox
extends GUITogglePanel

A toggle panel that has its own theme keys depending on its state, checkbox style.

Checkbox Themes

Checked, Enabled	THEME_KEY_CHECKBOX_ON
Unchecked, Enabled	THEME_KEY_CHECKBOX_OFF
Checked, Focused	THEME_KEY_CHECKBOX_ON_FOCUSED
Unchecked, Focused	THEME_KEY_CHECKBOX_OFF_FOCUSED
Checked, Disabled	THEME_KEY_CHECKBOX_ON_DISABLED
Unchecked, Disabled	THEME_KEY_CHECKBOX_OFF_DISABLED
Checked, Enabled, Pressed	THEME_KEY_CHECKBOX_ON_PRESSED
Unchecked, Enabled, Pressed	THEME_KEY_CHECKBOX_OFF_PRESSED
Checked, Focused, Pressed	THEME_KEY_CHECKBOX_ON_FOCUSED_PRESSED
Unchecked, Focused, Pressed	THEME_KEY_CHECKBOX_OFF_FOCUSED_PRESSED

Author:

Matthew Tropiano

Nested Class Summary

Nested classes/interfaces inherited from class GUIObject

GUIObject.ScaleType

Field Summary

Fields

Modifier and Type	Field	Description
protected static final GUIAction	CLICK_ACTION	Click action for the checkbox - calls GUITogglePanel.toggle()
protected static final GUIAction	KEY_TYPE_ACTION
static final String	THEME_KEY_CHECKBOX_OFF	Theme key for an unchecked checkbox.
static final String	THEME_KEY_CHECKBOX_OFF_DISABLED	Theme key for an unchecked, disabled checkbox.
static final String	THEME_KEY_CHECKBOX_OFF_FOCUSED	Theme key for an unchecked, focused checkbox.
static final String	THEME_KEY_CHECKBOX_OFF_FOCUSED_PRESSED	Theme key for an unchecked, focused checkbox, during press.
static final String	THEME_KEY_CHECKBOX_OFF_PRESSED	Theme key for an unchecked checkbox, during press.
static final String	THEME_KEY_CHECKBOX_ON	Theme key for a checked checkbox.
static final String	THEME_KEY_CHECKBOX_ON_DISABLED	Theme key for a checked, disabled checkbox.
static final String	THEME_KEY_CHECKBOX_ON_FOCUSED	Theme key for a checked, focused checkbox.
static final String	THEME_KEY_CHECKBOX_ON_FOCUSED_PRESSED	Theme key for a checked, focused checkbox, during press.
static final String	THEME_KEY_CHECKBOX_ON_PRESSED	Theme key for a checked checkbox, during press.

Fields inherited from class GUITogglePanel

PRESS_ACTION, RELEASE_ACTION

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 GUIValueField

EVENT_VALUE_CHANGE

Constructor Summary

Constructors

Constructor	Description
GUICheckbox()	Creates a new checkbox in the unset, false state.
GUICheckbox(boolean startState)	Creates a new checkbox.

Method Summary

Modifier and Type	Method	Description
String	getThemeKey()	Returns this object's theme key.

Methods inherited from class GUITogglePanel

getValue, isBeingClicked, isSet, setState, setValue, toggle

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, getTexture, getTheme, getVisible, hasAction, hasName, hasNamePattern, isAnimating, isConstrainedToParent, isEnabled, isFocused, isInert, isVisible, moveDown, moveToBack, moveToFront, moveUp, onGUIChange, releaseFocus, remove, removeChild, removeName, requestFocus, resizeChildren, rotate, setBounds, setBounds, setBoundsByChildren, setColor, setColor, setColorNotInherited, setConstrainToParent, setDimensions, setEnabled, setInert, setLayout, setLayoutAttrib, setOpacity, setPosition, setRendered, setRotationZ, setScaleType, setTexture, setTheme, setVisible, stretch, toString, translate, unbindAction, unbindAllActions, updateDirty, updateScenePosition, useRenderRadius

Methods inherited from class Object

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

Field Details

THEME_KEY_CHECKBOX_ON

public static final String THEME_KEY_CHECKBOX_ON

Theme key for a checked checkbox.

See Also:

• Constant Field Values

THEME_KEY_CHECKBOX_OFF

public static final String THEME_KEY_CHECKBOX_OFF

Theme key for an unchecked checkbox.

See Also:

• Constant Field Values

THEME_KEY_CHECKBOX_ON_FOCUSED

public static final String THEME_KEY_CHECKBOX_ON_FOCUSED

Theme key for a checked, focused checkbox.

See Also:

• Constant Field Values

THEME_KEY_CHECKBOX_OFF_FOCUSED

public static final String THEME_KEY_CHECKBOX_OFF_FOCUSED

Theme key for an unchecked, focused checkbox.

See Also:

• Constant Field Values

THEME_KEY_CHECKBOX_ON_DISABLED

public static final String THEME_KEY_CHECKBOX_ON_DISABLED

Theme key for a checked, disabled checkbox.

See Also:

• Constant Field Values

THEME_KEY_CHECKBOX_OFF_DISABLED

public static final String THEME_KEY_CHECKBOX_OFF_DISABLED

Theme key for an unchecked, disabled checkbox.

See Also:

• Constant Field Values

THEME_KEY_CHECKBOX_ON_PRESSED

public static final String THEME_KEY_CHECKBOX_ON_PRESSED

Theme key for a checked checkbox, during press.

See Also:

• Constant Field Values

THEME_KEY_CHECKBOX_OFF_PRESSED

public static final String THEME_KEY_CHECKBOX_OFF_PRESSED

Theme key for an unchecked checkbox, during press.

See Also:

• Constant Field Values

THEME_KEY_CHECKBOX_ON_FOCUSED_PRESSED

public static final String THEME_KEY_CHECKBOX_ON_FOCUSED_PRESSED

Theme key for a checked, focused checkbox, during press.

See Also:

• Constant Field Values

THEME_KEY_CHECKBOX_OFF_FOCUSED_PRESSED

public static final String THEME_KEY_CHECKBOX_OFF_FOCUSED_PRESSED

Theme key for an unchecked, focused checkbox, during press.

See Also:

• Constant Field Values

CLICK_ACTION

protected static final GUIAction CLICK_ACTION

Click action for the checkbox - calls GUITogglePanel.toggle()

KEY_TYPE_ACTION

protected static final GUIAction KEY_TYPE_ACTION

Constructor Details

GUICheckbox

public GUICheckbox()

Creates a new checkbox in the unset, false state.

GUICheckbox

public GUICheckbox(boolean startState)

Creates a new checkbox.

Parameters:

startState - the starting state (true or false).

Method Details

getThemeKey

public String getThemeKey()

Description copied from class: GUIObject

Returns this object's theme key. This is the key that is used to look up the texture used to render this object. This may return null, indicating that this object does not have a default texture.

Specified by:

getThemeKey in class GUIObject

Returns:

the theme key.