org.dominokit.domino.ui.forms

Class Radio<T>

java.lang.Object

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

org.dominokit.domino.ui.forms.Radio<T>

Type Parameters:

T - The type fo the radio value

All Implemented Interfaces:

HasInputElement, DominoStyle<elemental2.dom.HTMLDivElement,Radio<T>,Radio<T>>, Checkable<Radio<T>>, HasChangeHandlers<Radio<T>,Boolean>, HasChildren<Radio<T>>, HasHelperText<Radio<T>>, HasLabel<Radio<T>>, HasName<Radio<T>>, HasValue<Radio<T>,T>, HasWavesElement, IsCollapsible<Radio<T>>, IsReadOnly<Radio<T>>, Switchable<Radio<T>>, org.gwtproject.editor.client.TakesValue<T>, org.jboss.elemento.IsElement<elemental2.dom.HTMLDivElement>

public class Radio<T>
extends BaseDominoElement<elemental2.dom.HTMLDivElement,Radio<T>>
implements HasName<Radio<T>>, HasValue<Radio<T>,T>, HasLabel<Radio<T>>, Switchable<Radio<T>>, Checkable<Radio<T>>, org.gwtproject.editor.client.TakesValue<T>, HasHelperText<Radio<T>>, HasInputElement

A component that represent a single option in a RadioGroup

Nested Class Summary

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>

Field Summary

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

element

Constructor Summary

Constructors

Constructor and Description
Radio(T value) Creates an instance for the specified value without a label, the label will be the String.valueOf(value)
Radio(T value, String label) Creates an instance for the specified value with a label

Method Summary

Modifier and Type	Method and Description
Radio<T>	addChangeHandler(HasChangeHandlers.ChangeHandler<? super Boolean> changeHandler)
Radio<T>	check() Change the component to its checked state
Radio<T>	check(boolean silent) Change the component to its checked state without triggering change handlers
static <E> Radio<E>	create(E value) Creates an instance for the specified value without a label, the label will be the String.valueOf(value)
static <E> Radio<E>	create(E value, String label) Creates an instance for the specified value with a label
Radio<T>	disable()
elemental2.dom.HTMLDivElement	element()
Radio<T>	enable()
String	getHelperText()
DominoElement<elemental2.dom.HTMLInputElement>	getInputElement()
Optional<String>	getLabel()
String	getName()
String	getStringValue()
T	getValue()
boolean	hasChangeHandler(HasChangeHandlers.ChangeHandler<? super Boolean> changeHandler) Checks if a component has the specified ChangeHandler
boolean	isChecked()
boolean	isEnabled()
Radio<T>	removeChangeHandler(HasChangeHandlers.ChangeHandler<? super Boolean> changeHandler)
Radio<T>	setColor(Color color) Sets the color of the radio border and filling
Radio<T>	setHelperText(String text)
Radio<T>	setLabel(org.jboss.elemento.IsElement<?> element)
Radio<T>	setLabel(elemental2.dom.Node node)
Radio<T>	setLabel(org.gwtproject.safehtml.shared.SafeHtml safeHtml)
Radio<T>	setLabel(String label)
Radio<T>	setName(String name)
void	setValue(T value)
Radio<T>	uncheck() Change the component to its unchecked state
Radio<T>	uncheck(boolean silent) Change the component to its unchecked state without triggering change handlers
Radio<T>	value(T value)
Radio<T>	value(T value, boolean silent)
Radio<T>	withGap() Introduce a small white gap between the radio border and its check mark filling
Radio<T>	withoutGap() Removesthe small white gap between the radio border and its check mark filling

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, isDisabled, isEmptyElement, isEqualNode, isForceHidden, isHidden, isReadOnly, 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, setReadOnly, 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.IsCollapsible

isExpanded

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

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

Constructor Detail

Radio

public Radio(T value,
             String label)

Creates an instance for the specified value with a label

Parameters:

value - T

label - String

Radio

public Radio(T value)

Creates an instance for the specified value without a label, the label will be the String.valueOf(value)

Parameters:

value - T

Method Detail

create

public static <E> Radio<E> create(E value,
                                  String label)

Creates an instance for the specified value with a label

Type Parameters:

E - the type of the value

Parameters:

value - T

label - String

Returns:

new Radio instance

create

public static <E> Radio<E> create(E value)

Creates an instance for the specified value without a label, the label will be the String.valueOf(value)

Type Parameters:

E - the type of value

Parameters:

value - T

Returns:

new Radio instance

check

public Radio<T> check()

Change the component to its checked state

Specified by:

check in interface Checkable<Radio<T>>

Returns:

same component instance

uncheck

public Radio<T> uncheck()

Change the component to its unchecked state

Specified by:

uncheck in interface Checkable<Radio<T>>

Returns:

same component instance

check

public Radio<T> check(boolean silent)

Change the component to its checked state without triggering change handlers

Specified by:

check in interface Checkable<Radio<T>>

Parameters:

silent - boolean, if true dont trigger change handlers

Returns:

same component instance

uncheck

public Radio<T> uncheck(boolean silent)

Change the component to its unchecked state without triggering change handlers

Specified by:

uncheck in interface Checkable<Radio<T>>

Parameters:

silent - boolean, if true dont trigger change handlers

Returns:

same component instance

addChangeHandler

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

Specified by:

addChangeHandler in interface HasChangeHandlers<Radio<T>,Boolean>

Parameters:

changeHandler - HasChangeHandlers.ChangeHandler

Returns:

same implementing class instance

removeChangeHandler

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

Specified by:

removeChangeHandler in interface HasChangeHandlers<Radio<T>,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<Radio<T>,Boolean>

Parameters:

changeHandler - HasChangeHandlers.ChangeHandler

Returns:

same implementing class instance

isChecked

public boolean isChecked()

Specified by:

isChecked in interface Checkable<Radio<T>>

Returns:

boolean, true if the component is checked, otherwise false

withGap

public Radio<T> withGap()

Introduce a small white gap between the radio border and its check mark filling

Returns:

same Radio instance

withoutGap

public Radio<T> withoutGap()

Removesthe small white gap between the radio border and its check mark filling

Returns:

same Radio instance

setColor

public Radio<T> setColor(Color color)

Sets the color of the radio border and filling

Parameters:

color - Color

Returns:

same Radio instance

element

public elemental2.dom.HTMLDivElement element()

Specified by:

element in interface org.jboss.elemento.IsElement<elemental2.dom.HTMLDivElement>

Specified by:

element in class BaseDominoElement<elemental2.dom.HTMLDivElement,Radio<T>>

Returns:

the HTML element of type E which is the root element of the component

getName

public String getName()

Specified by:

getName in interface HasName<Radio<T>>

Returns:

String component name

setName

public Radio<T> setName(String name)

Specified by:

setName in interface HasName<Radio<T>>

Parameters:

name - String component name

Returns:

same implementing class

value

public Radio<T> value(T value)

Specified by:

value in interface HasValue<Radio<T>,T>

Parameters:

value - V to set as a value of the component

Returns:

same implementing component instance

value

public Radio<T> value(T value,
                      boolean silent)

Specified by:

value in interface HasValue<Radio<T>,T>

Parameters:

value - V to set as a value of the component

silent - boolean if true set the value without triggering change handlers

Returns:

same implementing component instance

setValue

public void setValue(T value)

Specified by:

setValue in interface org.gwtproject.editor.client.TakesValue<T>

getValue

public T getValue()

Specified by:

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

setLabel

public Radio<T> setLabel(String label)

Specified by:

setLabel in interface HasLabel<Radio<T>>

Parameters:

label - String component label

Returns:

same implementing class instance

setLabel

public Radio<T> setLabel(org.gwtproject.safehtml.shared.SafeHtml safeHtml)

Parameters:

safeHtml - SafeHtml to be used as a label

setLabel

public Radio<T> setLabel(elemental2.dom.Node node)

Parameters:

node - Node to be used as a label

setLabel

public Radio<T> setLabel(org.jboss.elemento.IsElement<?> element)

Parameters:

element - IsElement to be used as a label

getLabel

public Optional<String> getLabel()

Specified by:

getLabel in interface HasLabel<Radio<T>>

Returns:

String component label

enable

public Radio<T> enable()

Specified by:

enable in interface Switchable<Radio<T>>

Overrides:

enable in class BaseDominoElement<elemental2.dom.HTMLDivElement,Radio<T>>

Returns:

same implementing component

disable

public Radio<T> disable()

Specified by:

disable in interface Switchable<Radio<T>>

Overrides:

disable in class BaseDominoElement<elemental2.dom.HTMLDivElement,Radio<T>>

Returns:

same implementing component

getHelperText

public String getHelperText()

Specified by:

getHelperText in interface HasHelperText<Radio<T>>

Returns:

String helper text of the component

setHelperText

public Radio<T> setHelperText(String text)

Specified by:

setHelperText in interface HasHelperText<Radio<T>>

Parameters:

text - String

Returns:

same implementing class instance

isEnabled

public boolean isEnabled()

Specified by:

isEnabled in interface Switchable<Radio<T>>

Returns:

boolean, true if component is enabled else false

getInputElement

public DominoElement<elemental2.dom.HTMLInputElement> getInputElement()

Specified by:

getInputElement in interface HasInputElement

Returns:

E the input element wrapped as DominoElement

getStringValue

public String getStringValue()

Specified by:

getStringValue in interface HasInputElement

Returns:

String value of the input element