org.dominokit.domino.ui.forms

Class SwitchButton

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<SwitchButton,elemental2.dom.HTMLElement,Boolean>

org.dominokit.domino.ui.forms.SwitchButton

All Implemented Interfaces:

FormElement<SwitchButton,Boolean>, HasGrouping<SwitchButton>, HasInputElement, DominoStyle<elemental2.dom.HTMLElement,SwitchButton,SwitchButton>, Checkable<SwitchButton>, Focusable<SwitchButton>, HasAutoValidation<SwitchButton>, HasChangeHandlers<SwitchButton,Boolean>, HasChildren<SwitchButton>, HasHelperText<SwitchButton>, HasLabel<SwitchButton>, HasLength<SwitchButton>, HasName<SwitchButton>, HasPlaceHolder<SwitchButton>, HasValidation<SwitchButton>, HasValue<SwitchButton,Boolean>, HasWavesElement, IsCollapsible<SwitchButton>, IsReadOnly<SwitchButton>, IsRequired<SwitchButton>, Switchable<SwitchButton>, 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 SwitchButton
extends AbstractValueBox<SwitchButton,elemental2.dom.HTMLElement,Boolean>
implements Checkable<SwitchButton>

A component that can switch between two boolean values with different labels

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
SwitchButton() Creates a switch without a label
SwitchButton(String label)
SwitchButton(String label, String onOffTitle)
SwitchButton(String label, String offTitle, String onTitle)

Method Summary

Modifier and Type	Method and Description
SwitchButton	addChangeHandler(HasChangeHandlers.ChangeHandler<? super Boolean> changeHandler)
SwitchButton	check() Change the component to its checked state
SwitchButton	check(boolean silent) Change the component to its checked state without triggering change handlers
SwitchButton	clear() Clears the field value and trigger the change handlers
protected void	clearValue(boolean silent) clear the field value
static SwitchButton	create()
static SwitchButton	create(String label, String onOffTitle)
static SwitchButton	create(String label, String offTitle, String onTitle)
protected ValueBox.AutoValidator	createAutoValidator(ValueBox.AutoValidate autoValidate) Create an AutoValidator that will automatically validate the component when it loses focus
protected elemental2.dom.HTMLElement	createInputElement(String type) Creates an input element with the specified type
protected void	doSetValue(Boolean value)
DominoElement<elemental2.dom.HTMLElement>	getLever()
DominoElement<elemental2.dom.HTMLLabelElement>	getOnOffLabelElement()
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()
SwitchButton	removeChangeHandler(HasChangeHandlers.ChangeHandler<? super Boolean> changeHandler)
SwitchButton	setCheckedReadonlyLabel(String checkedReadonlyLabel) Set the label when the state is ON but the switch is readonly
SwitchButton	setColor(Color color) Sets the color of the Switch when it is ON
SwitchButton	setOffTitle(String offTitle)
SwitchButton	setOnTitle(String onTitle)
SwitchButton	setReadOnly(boolean readOnly) set the readonly attribute value
SwitchButton	setUnCheckedReadonlyLabel(String unCheckedReadonlyLabel) Set the label when the state is OFF but the switch is readonly
SwitchButton	uncheck() Change the component to its unchecked state
SwitchButton	uncheck(boolean silent) Change the component to its unchecked state without triggering change handlers
protected void	updateCharacterCount() Updates the character count based on field string value
SwitchButton	value(Boolean value) set the filed value

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

getMaxLength, getMinLength, getMinLengthErrorMessage, setMaxLength, setMinLength, setMinLengthErrorMessage

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

addLeftAddOn, addLeftAddOn, addLeftAddOn, addOnClearHandler, addRightAddOn, addRightAddOn, addRightAddOn, allowEmptyLabel, asTableField, autoValidate, callChangeHandlers, changeLabelFloating, 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, 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

SwitchButton

public SwitchButton(String label,
                    String offTitle,
                    String onTitle)

Parameters:

label - String label describing the switch

offTitle - String label for the OFF state

onTitle - String label for the ON state

SwitchButton

public SwitchButton(String label,
                    String onOffTitle)

Parameters:

label - String label describing the switch

onOffTitle - String label for the ON/OFF state

SwitchButton

public SwitchButton(String label)

Parameters:

label - String label describing the switch

SwitchButton

public SwitchButton()

Creates a switch without a label

Method Detail

create

public static SwitchButton create(String label,
                                  String offTitle,
                                  String onTitle)

Parameters:

label - String label describing the switch

offTitle - String label for the OFF state

onTitle - String label for the ON state

Returns:

new SwitchButton instance

create

public static SwitchButton create(String label,
                                  String onOffTitle)

Parameters:

label - String label describing the switch

onOffTitle - String label for the OFF state

Returns:

new SwitchButton instance

create

public static SwitchButton create()

getLever

public DominoElement<elemental2.dom.HTMLElement> getLever()

Returns:

the lever HTMLElement

value

public SwitchButton value(Boolean value)

set the filed value

Specified by:

value in interface HasValue<SwitchButton,Boolean>

Overrides:

value in class AbstractValueBox<SwitchButton,elemental2.dom.HTMLElement,Boolean>

Parameters:

value - V

Returns:

same component instance

updateCharacterCount

protected void updateCharacterCount()

Description copied from class: AbstractValueBox

Updates the character count based on field string value

Overrides:

updateCharacterCount in class AbstractValueBox<SwitchButton,elemental2.dom.HTMLElement,Boolean>

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<SwitchButton,elemental2.dom.HTMLElement,Boolean>

Returns:

boolean, true if ON false if OFF

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface HasGrouping<SwitchButton>

Overrides:

isEmpty in class AbstractValueBox<SwitchButton,elemental2.dom.HTMLElement,Boolean>

Returns:

boolean, true if the component value is empty

isEmptyIgnoreSpaces

public boolean isEmptyIgnoreSpaces()

Specified by:

isEmptyIgnoreSpaces in interface HasGrouping<SwitchButton>

Overrides:

isEmptyIgnoreSpaces in class AbstractValueBox<SwitchButton,elemental2.dom.HTMLElement,Boolean>

Returns:

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

clear

public SwitchButton clear()

Clears the field value and trigger the change handlers

Specified by:

clear in interface HasGrouping<SwitchButton>

Overrides:

clear in class ValueBox<SwitchButton,elemental2.dom.HTMLElement,Boolean>

Returns:

same implementing component instance

check

public SwitchButton check()

Change the component to its checked state

Specified by:

check in interface Checkable<SwitchButton>

Returns:

same component instance

uncheck

public SwitchButton uncheck()

Change the component to its unchecked state

Specified by:

uncheck in interface Checkable<SwitchButton>

Returns:

same component instance

check

public SwitchButton check(boolean silent)

Change the component to its checked state without triggering change handlers

Specified by:

check in interface Checkable<SwitchButton>

Parameters:

silent - boolean, if true dont trigger change handlers

Returns:

same component instance

uncheck

public SwitchButton uncheck(boolean silent)

Change the component to its unchecked state without triggering change handlers

Specified by:

uncheck in interface Checkable<SwitchButton>

Parameters:

silent - boolean, if true dont trigger change handlers

Returns:

same component instance

isChecked

public boolean isChecked()

Specified by:

isChecked in interface Checkable<SwitchButton>

Returns:

boolean, true if the component is checked, otherwise false

addChangeHandler

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

Specified by:

addChangeHandler in interface HasChangeHandlers<SwitchButton,Boolean>

Overrides:

addChangeHandler in class ValueBox<SwitchButton,elemental2.dom.HTMLElement,Boolean>

Parameters:

changeHandler - HasChangeHandlers.ChangeHandler

Returns:

same implementing class instance

removeChangeHandler

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

Specified by:

removeChangeHandler in interface HasChangeHandlers<SwitchButton,Boolean>

Overrides:

removeChangeHandler in class ValueBox<SwitchButton,elemental2.dom.HTMLElement,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<SwitchButton,Boolean>

Overrides:

hasChangeHandler in class ValueBox<SwitchButton,elemental2.dom.HTMLElement,Boolean>

Parameters:

changeHandler - HasChangeHandlers.ChangeHandler

Returns:

same implementing class instance

setColor

public SwitchButton setColor(Color color)

Sets the color of the Switch when it is ON

Parameters:

color - Color

Returns:

same Switch instance

setOnTitle

public SwitchButton setOnTitle(String onTitle)

Parameters:

onTitle - String title for the ON switch state

Returns:

same SwitchButton instance

setOffTitle

public SwitchButton setOffTitle(String offTitle)

Parameters:

offTitle - String title for the OFF switch state

Returns:

same SwitchButton instance

getOnOffLabelElement

public DominoElement<elemental2.dom.HTMLLabelElement> getOnOffLabelElement()

Returns:

HTMLLabelElement

setReadOnly

public SwitchButton setReadOnly(boolean readOnly)

set the readonly attribute value

Specified by:

setReadOnly in interface IsReadOnly<SwitchButton>

Overrides:

setReadOnly in class AbstractValueBox<SwitchButton,elemental2.dom.HTMLElement,Boolean>

Parameters:

readOnly - boolean, if true switch the component to readonly mode, otherwise switch out off readonly mode

Returns:

same instance of the implementing class

setCheckedReadonlyLabel

public SwitchButton setCheckedReadonlyLabel(String checkedReadonlyLabel)

Set the label when the state is ON but the switch is readonly

Parameters:

checkedReadonlyLabel - String

Returns:

same SwitchButton instance

setUnCheckedReadonlyLabel

public SwitchButton setUnCheckedReadonlyLabel(String unCheckedReadonlyLabel)

Set the label when the state is OFF but the switch is readonly

Parameters:

unCheckedReadonlyLabel - String

Returns:

same SwitchButton instance

createInputElement

protected elemental2.dom.HTMLElement createInputElement(String type)

Creates an input element with the specified type

Specified by:

createInputElement in class ValueBox<SwitchButton,elemental2.dom.HTMLElement,Boolean>

Parameters:

type - String the input element type

Returns:

E the input html element

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<SwitchButton,elemental2.dom.HTMLElement,Boolean>

Parameters:

autoValidate - ValueBox.AutoValidate

Returns:

same component instance

clearValue

protected void clearValue(boolean silent)

clear the field value

Specified by:

clearValue in class ValueBox<SwitchButton,elemental2.dom.HTMLElement,Boolean>

doSetValue

protected void doSetValue(Boolean value)

Specified by:

doSetValue in class ValueBox<SwitchButton,elemental2.dom.HTMLElement,Boolean>

Parameters:

value - V the value to set for this field

getStringValue

public String getStringValue()

Specified by:

getStringValue in interface HasInputElement

Overrides:

getStringValue in class ValueBox<SwitchButton,elemental2.dom.HTMLElement,Boolean>

Returns:

String value of the input element

isAddFocusColor

protected boolean isAddFocusColor()

Overrides:

isAddFocusColor in class ValueBox<SwitchButton,elemental2.dom.HTMLElement,Boolean>

Returns:

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