guiSET.core

Class Checkbox

java.lang.Object

guiSET.core.Control

guiSET.core.TextBased

guiSET.core.Checkbox

Direct Known Subclasses:

Switch

public class Checkbox
extends TextBased

Standard checkbox that allows to display some text to the right of the checkbox. Can be checked/unchecked by clicking. If readToEntireField is activated, then the state of the checkbox can be changed not only by clicking on the box itself but also on the entire element including text. All colors can be set individually. Use the checkedChangedListener to subscribe to any changed in the checked state (happens also when setting the state programatically).

Author:

Mc-Zen

Nested Class Summary

Nested classes/interfaces inherited from class guiSET.core.Control

Control.Constants, Control.ImageMode, Control.Predicate, Control.Predicate1<T>, Control.Predicate2<T,U>, Control.RenderingMethod, Control.Setter<T>

Field Summary

Fields inherited from class guiSET.core.TextBased

FONT_SIZE, LINE_HEIGHT, TEXT_ALIGN, TEXT_ALIGN_Y, TEXT_COLOR

Fields inherited from class guiSET.core.Control

ALL, ANCHOR_INACTIVE, AUTOSIZE_BOTH, AUTOSIZE_HEIGHT, AUTOSIZE_NONE, AUTOSIZE_WIDTH, BACKGROUND_COLOR, BACKGROUND_COLORS, BORDER, BORDER_COLOR, BORDER_RADIUS, BORDER_WIDTH, BUFFERED_RENDERING, COLORS, defaultRenderingMethod, FILL, FIT, FIT_INSIDE, FOREGROUND_COLOR, HOVER_COLOR, MARGIN, MARGIN_BOTTOM, MARGIN_LEFT, MARGIN_RIGHT, MARGIN_TOP, name, OPACITY, PADDING, PADDING_BOTTOM, PADDING_LEFT, PADDING_RIGHT, PADDING_TOP, PERCENTAGE_MODE, PIXEL_MODE, PRESSED_COLOR, SPACING, TEXT_PROPERTIES, UNBUFFERED_RENDERING

Constructor Summary

Constructors

Constructor and Description
Checkbox()
Checkbox(boolean checked) Initialize checkbox with checked state.
Checkbox(java.lang.String text) Initalize checkbox with text.
Checkbox(java.lang.String text, boolean checked) Initalize checkbox with text and set checked.
Checkbox(java.lang.String text, Control.Predicate toggleCallback)
Checkbox(java.lang.String text, Control.Predicate toggleCallback, boolean checked)
Checkbox(java.lang.String text, java.lang.String toggleEventMethodName)
Checkbox(java.lang.String text, java.lang.String toggleEventMethodName, boolean checked)

Method Summary

Modifier and Type	Method and Description
int	getCheckboxSize()
int	getCheckedBackgroundColor()
int	getCheckmarkColor()
int	getUncheckedBackgroundColor()
boolean	isChecked()
boolean	isReactToEntireComponent()
void	removeToggleListener()
void	setCheckboxSize(int checkboxSize) Set scale factor for the checkbox.
void	setChecked(boolean checked) Set checked state.
void	setCheckedBackgroundColor(int clr) Set back color of checkbox when checked.
void	setCheckmarkColor(int clr) Set color of the check mark.
void	setReactToEntireField(boolean reactToEntireField) If set to true, pressing anywhere on the element toggles the checkbox, else only the box itself reacts to clicking.
void	setToggleListener(Control.Predicate lambda) Set a listener lambda for when the checkbox has been checked/unchecked.
void	setToggleListener(Control.Predicate1<Checkbox> lambda) Set a listener lambda for when the checkbox has been checked/unchecked.
void	setToggleListener(java.lang.String methodName)
void	setToggleListener(java.lang.String methodName, java.lang.Object target) Set a listener for when the checkbox has been checked/unchecked.
void	setUncheckedBackgroundColor(int clr) Set back color of checkbox when not checked.

Methods inherited from class guiSET.core.TextBased

copyStyle, getFont, getFontSize, getLineHeight, getText, getTextAlign, getTextAlignY, getTextColor, isBold, isItalic, isStrikethrough, isUnderlined, setBold, setFont, setFontSize, setForegroundColor, setItalic, setLineHeight, setLineHeightPercent, setStrikethrough, setText, setText, setTextAlign, setTextAlignY, setTextColor, setUnderlined

Methods inherited from class guiSET.core.Control

addAutoAnchors, animate, blur, copyStyle, doForAll, fillParent, fillParent, fillParent, fillParentHeight, fillParentHeight, fillParentWidth, fillParentWidth, focus, forceRepaint, getAnchorMode, getAnchorValue, getAvailableHeight, getAvailableWidth, getBackgroundColor, getBorderColor, getBorderRadius, getBorderWidth, getCursor, getForegroundColor, getHeight, getHoverColor, getImage, getMarginBottom, getMarginLeft, getMarginRight, getMarginTop, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getOffsetXToParent, getOffsetXToWindow, getOffsetYToParent, getOffsetYToWindow, getOpacity, getPaddingBottom, getPaddingLeft, getPaddingRight, getPaddingTop, getParent, getPressedColor, getVersionString, getWidth, getX, getY, getZ, isEnabled, isFocusable, isFocused, isPropagationStopped, isVisible, noAutosize, relativeCoordsAreWithin, removeAnchor, removeBoxShadow, removeFocusListener, removeMouseListener, removeResizeListener, setAnchor, setAnchors, setAutosizing, setBackgroundColor, setBorder, setBorder, setBorderColor, setBorderRadius, setBorderWidth, setBoxShadow, setCursor, setEnabled, setFixedSize, setFocusListener, setFocusListener, setFocusListener, setFocusListener, setGradient, setHeight, setHeight, setHoverColor, setImage, setImageMode, setMargin, setMargin, setMargin, setMarginBottom, setMarginLeft, setMarginRight, setMarginTop, setMaxHeight, setMaxWidth, setMinHeight, setMinWidth, setMouseListener, setMouseListener, setMouseListener, setMouseListener, setOpacity, setOpacity, setPadding, setPadding, setPadding, setPaddingBottom, setPaddingLeft, setPaddingRight, setPaddingTop, setPercentageAnchor, setPercentageAnchors, setPixelAnchor, setPixelAnchors, setPosition, setPressedColor, setResizeListener, setResizeListener, setResizeListener, setResizeListener, setSize, setVisibility, setVisible, setWidth, setWidth, setX, setY, setZ, stopPropagation, unfocus

Methods inherited from class java.lang.Object

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

Constructor Detail

Checkbox

public Checkbox()

Checkbox

public Checkbox(java.lang.String text)

Initalize checkbox with text.

Parameters:

text - text to display

Checkbox

public Checkbox(boolean checked)

Initialize checkbox with checked state.

Parameters:

checked - checked state

Checkbox

public Checkbox(java.lang.String text,
                boolean checked)

Initalize checkbox with text and set checked.

Parameters:

text - text

checked - checked

Checkbox

public Checkbox(java.lang.String text,
                java.lang.String toggleEventMethodName)

Checkbox

public Checkbox(java.lang.String text,
                Control.Predicate toggleCallback)

Checkbox

public Checkbox(java.lang.String text,
                java.lang.String toggleEventMethodName,
                boolean checked)

Checkbox

public Checkbox(java.lang.String text,
                Control.Predicate toggleCallback,
                boolean checked)

Method Detail

setUncheckedBackgroundColor

public void setUncheckedBackgroundColor(int clr)

Set back color of checkbox when not checked.

Parameters:

clr - unchecked background color

setCheckedBackgroundColor

public void setCheckedBackgroundColor(int clr)

Set back color of checkbox when checked.

Parameters:

clr - checked background color

setCheckmarkColor

public void setCheckmarkColor(int clr)

Set color of the check mark.

Parameters:

clr - check mark color

setCheckboxSize

public void setCheckboxSize(int checkboxSize)

Set scale factor for the checkbox.

Parameters:

checkboxSize - checkbox scale factor

setChecked

public void setChecked(boolean checked)

Set checked state.

Parameters:

checked - checked state

setReactToEntireField

public void setReactToEntireField(boolean reactToEntireField)

If set to true, pressing anywhere on the element toggles the checkbox, else only the box itself reacts to clicking.

Parameters:

reactToEntireField - reactToEntireField

getUncheckedBackgroundColor

public int getUncheckedBackgroundColor()

getCheckedBackgroundColor

public int getCheckedBackgroundColor()

getCheckmarkColor

public int getCheckmarkColor()

getCheckboxSize

public int getCheckboxSize()

isChecked

public boolean isChecked()

isReactToEntireComponent

public boolean isReactToEntireComponent()

setToggleListener

public void setToggleListener(java.lang.String methodName,
                              java.lang.Object target)

Set a listener for when the checkbox has been checked/unchecked. Only triggered when the user presses the checkbox and not if set programatically.

Parameters:

methodName - method name

target - object

setToggleListener

public void setToggleListener(java.lang.String methodName)

setToggleListener

public void setToggleListener(Control.Predicate1<Checkbox> lambda)

Set a listener lambda for when the checkbox has been checked/unchecked. Only triggered when the user presses the Checkbox and not if set programatically. Event arguments: the Checkbox whose state has changed

Parameters:

lambda - lambda expression with Checkbox parameter

setToggleListener

public void setToggleListener(Control.Predicate lambda)

Set a listener lambda for when the checkbox has been checked/unchecked. Only triggered when the user presses the Checkbox and not if set programatically. Event arguments: none

Parameters:

lambda - lambda expression

removeToggleListener

public void removeToggleListener()