org.dominokit.domino.ui.forms

Class CheckBox

java.lang.Object

org.dominokit.domino.ui.utils.BaseDominoElement<elemental2.dom.HTMLElement,T>

org.dominokit.domino.ui.forms.BasicFormElement<T,V>

org.dominokit.domino.ui.forms.ValueBox<T,E,V>

org.dominokit.domino.ui.forms.AbstractValueBox<CheckBox,elemental2.dom.HTMLInputElement,Boolean>

org.dominokit.domino.ui.forms.CheckBox

All Implemented Interfaces:

FormElement<CheckBox,Boolean>, HasGrouping<CheckBox>, HasInputElement, DominoStyle<elemental2.dom.HTMLElement,CheckBox,CheckBox>, Checkable<CheckBox>, Focusable<CheckBox>, HasAutoValidation<CheckBox>, HasChangeHandlers<CheckBox,Boolean>, HasChildren<CheckBox>, HasHelperText<CheckBox>, HasLabel<CheckBox>, HasLength<CheckBox>, HasName<CheckBox>, HasPlaceHolder<CheckBox>, HasValidation<CheckBox>, HasValue<CheckBox,Boolean>, HasWavesElement, IsCollapsible<CheckBox>, IsReadOnly<CheckBox>, IsRequired<CheckBox>, Switchable<CheckBox>, org.gwtproject.editor.client.Editor<Boolean>, org.gwtproject.editor.client.HasEditorErrors<Boolean>, org.gwtproject.editor.client.LeafValueEditor<Boolean>, org.gwtproject.editor.client.TakesValue<Boolean>, org.jboss.elemento.IsElement<elemental2.dom.HTMLElement>

public class CheckBox
extends AbstractValueBox<CheckBox,elemental2.dom.HTMLInputElement,Boolean>
implements Checkable<CheckBox>

A checkbox component that takes/provide a boolean value

Nested Class Summary

Nested classes/interfaces inherited from class org.dominokit.domino.ui.forms.ValueBox

ValueBox.AutoValidate, ValueBox.AutoValidator

Nested classes/interfaces inherited from class org.dominokit.domino.ui.forms.BasicFormElement

BasicFormElement.FieldHandler<T>

Nested classes/interfaces inherited from class org.dominokit.domino.ui.utils.BaseDominoElement

BaseDominoElement.ElementHandler<T>, BaseDominoElement.ResizeHandler<T>, BaseDominoElement.StyleEditor<E extends elemental2.dom.HTMLElement,T extends org.jboss.elemento.IsElement<E>>, BaseDominoElement.WavesStyler

Nested classes/interfaces inherited from interface org.dominokit.domino.ui.utils.HasChangeHandlers

HasChangeHandlers.ChangeHandler<V>

Nested classes/interfaces inherited from interface org.dominokit.domino.ui.utils.HasValidation

HasValidation.Validator

Nested classes/interfaces inherited from interface org.gwtproject.editor.client.Editor

org.gwtproject.editor.client.Editor.Ignore, org.gwtproject.editor.client.Editor.Path

Field Summary

Fields inherited from class org.dominokit.domino.ui.forms.ValueBox

changeHandlers, changeListener, DISABLED, fieldContainer, fieldGroup, FLOATING, FOCUSED, inputContainer, inputListener

Fields inherited from class org.dominokit.domino.ui.utils.BaseDominoElement

element

Constructor Summary

Constructors

Constructor and Description
CheckBox() Creates a checkbox without a label
CheckBox(String label) Creates a checkbox with a label

Method Summary

Modifier and Type	Method and Description
CheckBox	addChangeHandler(HasChangeHandlers.ChangeHandler<? super Boolean> changeHandler)
protected boolean	allowEmptyLabel()
CheckBox	check() Change the component to its checked state
CheckBox	check(boolean silent) Change the component to its checked state without triggering change handlers
protected void	clearValue(boolean silent) clear the field value
static CheckBox	create() Creates a CheckBox without a label
static CheckBox	create(DominoElement<elemental2.dom.HTMLAnchorElement> link) Creates a CheckBox with a clickable link as a label
static CheckBox	create(elemental2.dom.HTMLAnchorElement link) Creates a CheckBox with a clickable link as a label
static CheckBox	create(org.jboss.elemento.IsElement<elemental2.dom.HTMLAnchorElement> link) Creates a CheckBox with a clickable link as a label
static CheckBox	create(String label) Creates a checkbox with a label
protected ValueBox.AutoValidator	createAutoValidator(ValueBox.AutoValidate autoValidate) Create an AutoValidator that will automatically validate the component when it loses focus
protected elemental2.dom.HTMLInputElement	createInputElement(String type) Creates an input element with the specified type
protected void	doSetValue(Boolean value)
CheckBox	filledIn() The CheckBox will be filled with its color instead of a white background
CheckBox	filledOut() The CheckBox will be filled with a white background, this is the default
String	getStringValue()
Boolean	getValue()
boolean	hasChangeHandler(HasChangeHandlers.ChangeHandler<? super Boolean> changeHandler) Checks if a component has the specified ChangeHandler
protected boolean	isAddFocusColor()
boolean	isChecked()
boolean	isEmpty()
boolean	isEmptyIgnoreSpaces()
CheckBox	removeChangeHandler(HasChangeHandlers.ChangeHandler<? super Boolean> changeHandler)
CheckBox	setCheckedReadonlyLabel(String checkedReadonlyLabel)
CheckBox	setColor(Color color) This color will be used for the check mark in the CheckBox or the background for a filledIn() CheckBox
CheckBox	setLabel(String label)
CheckBox	setReadOnly(boolean readOnly) This should render the checkbox as a label based on setCheckedReadonlyLabel(String) and setUnCheckedReadonlyLabel(String)
CheckBox	setUnCheckedReadonlyLabel(String unCheckedReadonlyLabel)
CheckBox	toggle() Toggle the current state of the CheckBox, if it is checked it will be unchecked, and if it is unchecked it will be checked
CheckBox	uncheck() Change the component to its unchecked state
CheckBox	uncheck(boolean silent) Change the component to its unchecked state without triggering change handlers
CheckBox	value(Boolean value) set the filed value

Methods inherited from class org.dominokit.domino.ui.forms.AbstractValueBox

getMaxLength, getMinLength, getMinLengthErrorMessage, setMaxLength, setMinLength, setMinLengthErrorMessage, updateCharacterCount

Methods inherited from class org.dominokit.domino.ui.forms.ValueBox

addLeftAddOn, addLeftAddOn, addLeftAddOn, addOnClearHandler, addRightAddOn, addRightAddOn, addRightAddOn, asTableField, autoValidate, callChangeHandlers, changeLabelFloating, clear, clear, clearInvalid, clearValue, condense, createLabelElement, createMandatoryAddOn, disable, doFocus, doUnfocus, element, enable, floating, floatLabel, focus, getAdditionalInfoContainer, getCountItem, getErrorItem, getErrorsContainer, getFieldContainer, getFieldGroup, getFieldInputContainer, getFieldStyle, getFocusColor, getHelperContainer, getHelpItem, getInputContainer, getInputElement, getLabelElement, getLabelTextElement, getLeftAddonContainer, getLeftAddOnsContainer, getMandatoryAddOn, getNotesContainer, getOnClearHandlers, getPlaceholder, getPostfix, getPostFixItem, getPrefix, getPrefixItem, getRightAddonContainer, getRightAddOnsContainer, hideLabelText, hidePlaceholder, invalidate, invalidate, isAutoValidation, isFloating, isFocused, isReadOnly, linkLabelToField, nonfloating, onEnterKey, pauseChangeHandlers, pauseFocusValidation, removeLeftAddOn, removeLeftAddOn, removeLeftAddOn, removeLeftAddOn, removeLeftAddOns, removeOnClearHandler, removeRightAddOn, removeRightAddOn, removeRightAddOn, removeRightAddOn, removeRightAddOns, resumeChangeHandlers, resumeFocusValidation, setAutoValidation, setFieldStyle, setFixErrorsPosition, setFloating, setFocusColor, setLabel, setLabel, setLabel, setLabelTextVisible, setPauseChangeHandlers, setPlaceholder, setPostFix, setPrefix, setSpellCheck, setTableField, shouldShowPlaceholder, showLabelText, showPlaceholder, spread, unfloatLabel, unfocus, updateLabel, value

Methods inherited from class org.dominokit.domino.ui.forms.BasicFormElement

addValidator, getErrorLabels, getErrors, getHelperText, getLabel, getName, getRequiredErrorMessage, groupBy, hasValidator, isDisabled, isEnabled, isFixErrorsPosition, isRequired, isShowRequiredIndicator, isValidationDisabled, makeErrorLabel, removeValidator, setHelperText, setName, setRequired, setRequired, setRequiredErrorMessage, setShowRequiredIndicator, setValidationDisabled, setValue, showErrors, ungroup, validate, withValidationDisabled

Methods inherited from class org.dominokit.domino.ui.utils.BaseDominoElement

add, add, addClickListener, addCss, addCss, addEventListener, addEventListener, addEventsListener, addHideListener, addShowListener, alignCenter, alignRight, appendChild, appendChild, apply, attr, blur, childNodes, clearElement, contains, contains, contains, containsCss, css, css, cssClassByIndex, cssClassesCount, cssText, elevate, elevate, firstChild, getAttachObserver, getAttribute, getBoundingClientRect, getChildElementCount, getClickableElement, getCollapsible, getCollapsibleElement, getDetachObserver, getDominoId, getElementsCount, getElevation, getFirstChild, getId, getTextContent, getTooltip, getWavesElement, hasAttribute, hasChildNodes, hasDirectChild, hide, hideOn, id, init, insertAfter, insertAfter, insertAfter, insertAfter, insertBefore, insertBefore, insertBefore, insertBefore, insertFirst, insertFirst, insertFirst, isAttached, isCollapsed, isEmptyElement, isEqualNode, isForceHidden, isHidden, item, lastChild, length, onAttached, onDetached, onResize, pullLeft, pullRight, querySelector, querySelectorAll, remove, removeAttachObserver, removeAttribute, removeChild, removeChild, removeCss, removeCss, removeCssProperty, removeDetachObserver, removeEventListener, removeEventListener, removeHideListener, removeHideOn, removeShowListener, removeShowOn, removeTooltip, removeWaves, replaceCss, setAlignItems, setAttribute, setAttribute, setAttribute, setBackgroundColor, setBackgroundColor, setBorder, setBorderColor, setBottom, setBottom, setBoxShadow, setCollapseStrategy, setColor, setColor, setContent, setContent, setCssProperty, setCssProperty, setCursor, setCursor, setDisabled, setDisplay, setDisplay, setDropMenu, setFlex, setFloat, setFloat, setFontSize, setFontSize, setForceHidden, setHeight, setHeight, setId, setInnerHtml, setLeft, setLeft, setLineHeight, setLineHeight, setMargin, setMargin, setMarginBottom, setMarginBottom, setMarginLeft, setMarginLeft, setMarginRight, setMarginRight, setMarginTop, setMarginTop, setMaxHeight, setMaxHeight, setMaxWidth, setMaxWidth, setMinHeight, setMinHeight, setMinWidth, setMinWidth, setOpacity, setOpacity, setOverFlow, setOverFlow, setOverFlowY, setPadding, setPadding, setPaddingBottom, setPaddingBottom, setPaddingLeft, setPaddingLeft, setPaddingRight, setPaddingRight, setPaddingTop, setPaddingTop, setPointerEvents, setPosition, setPosition, setRight, setRight, setTabIndex, setTextAlign, setTextAlign, setTextContent, setTooltip, setTooltip, setTooltip, setTooltip, setTop, setTop, setTransitionDuration, setWidth, setWidth, setZIndex, show, showOn, style, style, styler, textContent, toggleDisplay, toggleDisplay, withWaves, withWaves

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.dominokit.domino.ui.utils.HasValidation

validateAll

Methods inherited from interface org.dominokit.domino.ui.utils.IsCollapsible

isExpanded

Methods inherited from interface org.dominokit.domino.ui.style.DominoStyle

add, add, remove, remove, removeProperty, replace, setProperty, setProperty

Constructor Detail

CheckBox

public CheckBox()

Creates a checkbox without a label

CheckBox

public CheckBox(String label)

Creates a checkbox with a label

Parameters:

label - String

Method Detail

create

public static CheckBox create(String label)

Creates a checkbox with a label

Parameters:

label - String

Returns:

new CheckBox instance

create

public static CheckBox create()

Creates a CheckBox without a label

Returns:

new CheckBox instance

create

public static CheckBox create(org.jboss.elemento.IsElement<elemental2.dom.HTMLAnchorElement> link)

Creates a CheckBox with a clickable link as a label

Parameters:

link - HTMLAnchorElement wrapped as IsElement

Returns:

new CheckBox instance

create

public static CheckBox create(elemental2.dom.HTMLAnchorElement link)

Creates a CheckBox with a clickable link as a label

Parameters:

link - HTMLAnchorElement

Returns:

new CheckBox instance

create

public static CheckBox create(DominoElement<elemental2.dom.HTMLAnchorElement> link)

Creates a CheckBox with a clickable link as a label

Parameters:

link - HTMLAnchorElement wrapped as DominoElement

Returns:

new CheckBox instance

toggle

public CheckBox toggle()

Toggle the current state of the CheckBox, if it is checked it will be unchecked, and if it is unchecked it will be checked

Returns:

same CheckBox instance

check

public CheckBox check()

Change the component to its checked state

Specified by:

check in interface Checkable<CheckBox>

Returns:

same component instance

uncheck

public CheckBox uncheck()

Change the component to its unchecked state

Specified by:

uncheck in interface Checkable<CheckBox>

Returns:

same component instance

check

public CheckBox check(boolean silent)

Change the component to its checked state without triggering change handlers

Specified by:

check in interface Checkable<CheckBox>

Parameters:

silent - boolean, if true dont trigger change handlers

Returns:

same component instance

uncheck

public CheckBox uncheck(boolean silent)

Change the component to its unchecked state without triggering change handlers

Specified by:

uncheck in interface Checkable<CheckBox>

Parameters:

silent - boolean, if true dont trigger change handlers

Returns:

same component instance

isChecked

public boolean isChecked()

Specified by:

isChecked in interface Checkable<CheckBox>

Returns:

boolean, true if the component is checked, otherwise false

setLabel

public CheckBox setLabel(String label)

Specified by:

setLabel in interface HasLabel<CheckBox>

Overrides:

setLabel in class ValueBox<CheckBox,elemental2.dom.HTMLInputElement,Boolean>

Parameters:

label - String component label

Returns:

same implementing class instance

addChangeHandler

public CheckBox addChangeHandler(HasChangeHandlers.ChangeHandler<? super Boolean> changeHandler)

Specified by:

addChangeHandler in interface HasChangeHandlers<CheckBox,Boolean>

Overrides:

addChangeHandler in class ValueBox<CheckBox,elemental2.dom.HTMLInputElement,Boolean>

Parameters:

changeHandler - HasChangeHandlers.ChangeHandler

Returns:

same implementing class instance

removeChangeHandler

public CheckBox removeChangeHandler(HasChangeHandlers.ChangeHandler<? super Boolean> changeHandler)

Specified by:

removeChangeHandler in interface HasChangeHandlers<CheckBox,Boolean>

Overrides:

removeChangeHandler in class ValueBox<CheckBox,elemental2.dom.HTMLInputElement,Boolean>

Parameters:

changeHandler - HasChangeHandlers.ChangeHandler

Returns:

same implementing class instance

hasChangeHandler

public boolean hasChangeHandler(HasChangeHandlers.ChangeHandler<? super Boolean> changeHandler)

Checks if a component has the specified ChangeHandler

Specified by:

hasChangeHandler in interface HasChangeHandlers<CheckBox,Boolean>

Overrides:

hasChangeHandler in class ValueBox<CheckBox,elemental2.dom.HTMLInputElement,Boolean>

Parameters:

changeHandler - HasChangeHandlers.ChangeHandler

Returns:

same implementing class instance

filledIn

public CheckBox filledIn()

The CheckBox will be filled with its color instead of a white background

Returns:

same CheckBox instance

filledOut

public CheckBox filledOut()

The CheckBox will be filled with a white background, this is the default

Returns:

same CheckBox instance

setColor

public CheckBox setColor(Color color)

This color will be used for the check mark in the CheckBox or the background for a filledIn() CheckBox

Parameters:

color - Color

Returns:

same CheckBox instance

value

public CheckBox value(Boolean value)

set the filed value This will check/uncheck the CheckBox based on the boolean value

Specified by:

value in interface HasValue<CheckBox,Boolean>

Overrides:

value in class AbstractValueBox<CheckBox,elemental2.dom.HTMLInputElement,Boolean>

Parameters:

value - V

Returns:

same component instance

getValue

public Boolean getValue()

Specified by:

getValue in interface org.gwtproject.editor.client.LeafValueEditor<Boolean>

Specified by:

getValue in interface org.gwtproject.editor.client.TakesValue<Boolean>

Overrides:

getValue in class ValueBox<CheckBox,elemental2.dom.HTMLInputElement,Boolean>

Returns:

boolean, true if checked, false if unchecked

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface HasGrouping<CheckBox>

Overrides:

isEmpty in class AbstractValueBox<CheckBox,elemental2.dom.HTMLInputElement,Boolean>

Returns:

boolean, CheckBox cant be empty so this actually is true if the CheckBox is unchecked.

isEmptyIgnoreSpaces

public boolean isEmptyIgnoreSpaces()

Description copied from class: AbstractValueBox

Specified by:

isEmptyIgnoreSpaces in interface HasGrouping<CheckBox>

Overrides:

isEmptyIgnoreSpaces in class AbstractValueBox<CheckBox,elemental2.dom.HTMLInputElement,Boolean>

Returns:

boolean, true if the component value is empty after trimming spaces

setReadOnly

public CheckBox setReadOnly(boolean readOnly)

This should render the checkbox as a label based on setCheckedReadonlyLabel(String) and setUnCheckedReadonlyLabel(String)

Specified by:

setReadOnly in interface IsReadOnly<CheckBox>

Overrides:

setReadOnly in class AbstractValueBox<CheckBox,elemental2.dom.HTMLInputElement,Boolean>

Parameters:

readOnly - boolean

Returns:

same CheckBox instance

setCheckedReadonlyLabel

public CheckBox setCheckedReadonlyLabel(String checkedReadonlyLabel)

Parameters:

checkedReadonlyLabel - String label to be used in checked readonly mode

Returns:

same CheckBox instance

setUnCheckedReadonlyLabel

public CheckBox setUnCheckedReadonlyLabel(String unCheckedReadonlyLabel)

Parameters:

unCheckedReadonlyLabel - String label to be used in unchecked readonly mode

Returns:

same CheckBox instance

getStringValue

public String getStringValue()

Specified by:

getStringValue in interface HasInputElement

Overrides:

getStringValue in class ValueBox<CheckBox,elemental2.dom.HTMLInputElement,Boolean>

Returns:

String boolean value

createInputElement

protected elemental2.dom.HTMLInputElement createInputElement(String type)

Creates an input element with the specified type creates a checkbox input element

Specified by:

createInputElement in class ValueBox<CheckBox,elemental2.dom.HTMLInputElement,Boolean>

Parameters:

type - String the input element type

Returns:

E the input html element

clearValue

protected void clearValue(boolean silent)

clear the field value this will uncheck the CheckBox if it is checked

Specified by:

clearValue in class ValueBox<CheckBox,elemental2.dom.HTMLInputElement,Boolean>

doSetValue

protected void doSetValue(Boolean value)

Specified by:

doSetValue in class ValueBox<CheckBox,elemental2.dom.HTMLInputElement,Boolean>

Parameters:

value - V the value to set for this field

isAddFocusColor

protected boolean isAddFocusColor()

Overrides:

isAddFocusColor in class ValueBox<CheckBox,elemental2.dom.HTMLInputElement,Boolean>

Returns:

boolean, true if the field will add a focus color when focused, default to true

createAutoValidator

protected ValueBox.AutoValidator createAutoValidator(ValueBox.AutoValidate autoValidate)

Create an AutoValidator that will automatically validate the component when it loses focus

Specified by:

createAutoValidator in class ValueBox<CheckBox,elemental2.dom.HTMLInputElement,Boolean>

Parameters:

autoValidate - ValueBox.AutoValidate

Returns:

same component instance

allowEmptyLabel

protected boolean allowEmptyLabel()

Overrides:

allowEmptyLabel in class ValueBox<CheckBox,elemental2.dom.HTMLInputElement,Boolean>