org.dominokit.domino.ui.forms.RadioGroup Maven / Gradle / Ivy
/*
* Copyright © 2019 Dominokit
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.dominokit.domino.ui.forms;
import static java.util.Objects.nonNull;
import elemental2.dom.HTMLElement;
import elemental2.dom.HTMLLabelElement;
import elemental2.dom.Node;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import java.util.Optional;
import org.dominokit.domino.ui.grid.flex.FlexDirection;
import org.dominokit.domino.ui.grid.flex.FlexLayout;
import org.dominokit.domino.ui.utils.DominoElement;
import org.jboss.elemento.Elements;
import org.jboss.elemento.IsElement;
/**
* A component to group a set of {@link Radio} component as one field, only one Radio can be checked
* from the this radio group.
*
* @param The type of the RadioGroup value
*/
public class RadioGroup extends AbstractValueBox, HTMLElement, T> {
private List> radios = new ArrayList<>();
private String name;
private FlexLayout flexLayout;
/**
* Creates a new group with a name and empty label
*
* @param name String
*/
public RadioGroup(String name) {
this(name, "");
}
/**
* Creates a new group with a name and a label
*
* @param name String
* @param label String
*/
public RadioGroup(String name, String label) {
super("RadioGroup", label);
init(this);
css("radio-group");
setLabel(label);
setName(name);
vertical();
}
/**
* Creates a new group with a name and empty label
*
* @param name String
* @param type of the RadioGroup value
* @return new RadioGroup instance
*/
public static RadioGroup create(String name) {
return new RadioGroup<>(name);
}
/**
* Creates a new group with a name and a label
*
* @param name String
* @param label String
* @param type of the RadioGroup value
* @return new RadioGroup instance
*/
public static RadioGroup create(String name, String label) {
return new RadioGroup<>(name, label);
}
/**
* @param radio {@link Radio}
* @return same RadioGroup instance
*/
public RadioGroup appendChild(Radio radio) {
return appendChild(radio, (Node) null);
}
/**
* @param radio {@link Radio}
* @param content {@link Node} to be appended to the Radio after it is appended to the RadioGroup
* @return same RadioGroup instance
*/
public RadioGroup appendChild(Radio radio, Node content) {
radio.setName(name);
radio.addChangeHandler(value -> onCheck(radio));
radio.setGroup(this);
if (radio.isChecked()) {
radios.forEach(r -> r.uncheck(true));
}
radios.add(radio);
if (nonNull(content)) {
radio.appendChild(content);
}
flexLayout.appendChild(radio);
return this;
}
/**
* @param radio {@link Radio}
* @param content {@link IsElement} to be appended to the Radio after it is appended to the
* RadioGroup
* @return same RadioGroup instance
*/
public RadioGroup appendChild(Radio radio, IsElement content) {
return appendChild(radio, content.element());
}
private void removeRadioImpl(Radio radio, boolean silent) {
radio.uncheck(silent);
flexLayout.removeChild(radio);
}
public RadioGroup removeRadio(Radio radio, boolean silent) {
if (radios.remove(radio)) {
removeRadioImpl(radio, silent);
}
return this;
}
public RadioGroup removeAllRadios(boolean silent) {
radios.forEach(radio -> removeRadioImpl(radio, silent));
radios.clear();
return this;
}
private void onCheck(Radio selectedRadio) {
for (ChangeHandler changeHandler : changeHandlers) {
changeHandler.onValueChanged(selectedRadio.isChecked() ? selectedRadio.getValue() : null);
}
}
/**
* Aligns the radios in this group horizontally
*
* @return same RadioGroup instance
*/
public RadioGroup horizontal() {
flexLayout.setDirection(FlexDirection.LEFT_TO_RIGHT);
removeCss("horizontal");
css("horizontal");
return this;
}
/**
* Aligns the radios in this group vertically
*
* @return same RadioGroup instance
*/
public RadioGroup vertical() {
flexLayout.setDirection(FlexDirection.TOP_TO_BOTTOM);
removeCss("horizontal");
return this;
}
/** {@inheritDoc} */
@Override
public RadioGroup invalidate(String errorMessage) {
invalidate(Collections.singletonList(errorMessage));
return this;
}
/** {@inheritDoc} */
protected HTMLLabelElement makeErrorLabel(String message) {
return DominoElement.of(Elements.label()).css("error").textContent(message).element();
}
/** @return List of {@link Radio} that belongs to this RadioGroup */
public List> getRadios() {
return radios;
}
/** @return boolean, true only if there is a checked radio in this RadioGroup */
public boolean isSelected() {
return getValue() != null;
}
/** @return T value of the first checked Radio in this RadioGroup */
public T getValue() {
return radios.stream().filter(Radio::isChecked).map(Radio::getValue).findFirst().orElse(null);
}
/** {@inheritDoc} */
@Override
public boolean isEmpty() {
return !isSelected();
}
/** {@inheritDoc} */
@Override
public boolean isEmptyIgnoreSpaces() {
return isEmpty();
}
/** {@inheritDoc} */
@Override
public RadioGroup clear() {
radios.forEach(Radio::uncheck);
return this;
}
/** {@inheritDoc} */
@Override
public RadioGroup groupBy(FieldsGrouping fieldsGrouping) {
fieldsGrouping.addFormElement(this);
return this;
}
/** {@inheritDoc} */
@Override
public RadioGroup ungroup(FieldsGrouping fieldsGrouping) {
fieldsGrouping.removeFormElement(this);
return this;
}
/** {@inheritDoc} */
@Override
public String getName() {
return name;
}
/** {@inheritDoc} */
@Override
public RadioGroup setName(String name) {
this.name = name;
return this;
}
/** {@inheritDoc} */
@Override
public RadioGroup enable() {
radios.forEach(Radio::enable);
return this;
}
/** {@inheritDoc} */
@Override
public RadioGroup disable() {
radios.forEach(Radio::disable);
return this;
}
/** {@inheritDoc} */
@Override
public boolean isEnabled() {
return radios.stream().allMatch(Radio::isEnabled);
}
/**
* Sets the value from the specific Radio. When the radio self is null, clearValue will be
* executed.
*
* @param value {@link Radio}
*/
public void setValue(Radio value) {
if (value == null) {
clearValue();
} else {
setValue(value.getValue());
}
}
/** {@inheritDoc} */
@Override
public void setValue(T value) {
radios.stream()
.filter(radio -> radio.getValue().equals(value))
.findFirst()
.ifPresent(Radio::check);
}
protected Optional> getSelectedRadioImpl() {
return radios.stream().filter(Radio::isChecked).findFirst();
}
/** @return the checked {@link Radio} */
public Radio getSelectedRadio() {
return getSelectedRadioImpl().orElse(null);
}
/** {@inheritDoc} */
@Override
protected HTMLElement createInputElement(String type) {
flexLayout = FlexLayout.create();
return flexLayout.element();
}
/** {@inheritDoc} */
@Override
protected AutoValidator createAutoValidator(AutoValidate autoValidate) {
return new RadioAutoValidator<>(this, autoValidate);
}
/** {@inheritDoc} */
@Override
public RadioGroup condense() {
removeCss("condensed");
css("condensed");
return this;
}
/** {@inheritDoc} */
public RadioGroup spread() {
removeCss("condensed");
return this;
}
/**
* @param condensed boolean. if true delegate to {@link #condense()}, otherwise delegate to {@link
* #spread()}
* @return same RadioGroup instance
*/
public RadioGroup setCondensed(boolean condensed) {
if (condensed) {
return condense();
} else {
return spread();
}
}
/** {@inheritDoc} */
@Override
protected void clearValue(boolean silent) {
getSelectedRadioImpl().ifPresent(radio -> radio.uncheck(silent));
}
/** {@inheritDoc} */
@Override
protected void doSetValue(T value) {
setValue(value);
}
private static class RadioAutoValidator extends AutoValidator {
private RadioGroup radioGroup;
private ChangeHandler changeHandler;
public RadioAutoValidator(RadioGroup radioGroup, AutoValidate autoValidate) {
super(autoValidate);
this.radioGroup = radioGroup;
}
@Override
public void attach() {
changeHandler = value -> autoValidate.apply();
radioGroup.getRadios().forEach(radio -> radio.addChangeHandler(changeHandler));
}
@Override
public void remove() {
radioGroup.getRadios().forEach(radio -> radio.removeChangeHandler(changeHandler));
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy