Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
/*
* Copyright (C) 2000-2024 Vaadin Ltd
*
* This program is available under Vaadin Commercial License and Service Terms.
*
* See for the full
* license.
*/
package com.vaadin.ui;
import java.util.Collection;
import java.util.Objects;
import java.util.Set;
import org.jsoup.nodes.Element;
import com.vaadin.data.HasDataProvider;
import com.vaadin.data.provider.DataProvider;
import com.vaadin.event.FieldEvents.BlurEvent;
import com.vaadin.event.FieldEvents.BlurListener;
import com.vaadin.event.FieldEvents.BlurNotifier;
import com.vaadin.event.FieldEvents.FocusAndBlurServerRpcDecorator;
import com.vaadin.event.FieldEvents.FocusEvent;
import com.vaadin.event.FieldEvents.FocusListener;
import com.vaadin.event.FieldEvents.FocusNotifier;
import com.vaadin.server.SerializablePredicate;
import com.vaadin.shared.Registration;
import com.vaadin.shared.ui.ListingJsonConstants;
import com.vaadin.shared.ui.optiongroup.CheckBoxGroupState;
import com.vaadin.ui.declarative.DesignContext;
import com.vaadin.ui.declarative.DesignFormatter;
/**
* A group of Checkboxes. Individual checkboxes are made from items supplied by
* a {@link DataProvider}. Checkboxes may have captions and icons.
*
* @param
* item type
* @author Vaadin Ltd
* @since 8.0
*/
public class CheckBoxGroup extends AbstractMultiSelect
implements FocusNotifier, BlurNotifier, HasDataProvider {
private DescriptionGenerator descriptionGenerator = item -> null;
/**
* Constructs a new CheckBoxGroup with caption.
*
* @param caption
* caption text
*/
public CheckBoxGroup(String caption) {
this();
setCaption(caption);
}
/**
* Constructs a new CheckBoxGroup with caption and DataProvider.
*
* @param caption
* the caption text
* @param dataProvider
* the data provider, not null
* @see HasDataProvider#setDataProvider(DataProvider)
*/
public CheckBoxGroup(String caption, DataProvider dataProvider) {
this(caption);
setDataProvider(dataProvider);
}
/**
* Constructs a new CheckBoxGroup with caption and DataProvider containing
* given items.
*
* @param caption
* the caption text
* @param items
* the data items to use, not null
* @see #setItems(Collection)
*/
public CheckBoxGroup(String caption, Collection items) {
this(caption, DataProvider.ofCollection(items));
}
/**
* Constructs a new CheckBoxGroup.
*/
public CheckBoxGroup() {
registerRpc(new FocusAndBlurServerRpcDecorator(this, this::fireEvent));
addDataGenerator((item, jsonObject) -> {
String description = getItemDescriptionGenerator().apply(item);
if (description != null) {
jsonObject.put(ListingJsonConstants.JSONKEY_ITEM_DESCRIPTION,
description);
}
});
}
/**
* Sets whether html is allowed in the item captions. If set to true, the
* captions are passed to the browser as html and the developer is
* responsible for ensuring no harmful html is used. If set to false, the
* content is passed to the browser as plain text.
*
* @param htmlContentAllowed
* true if the captions are used as html, false if used as plain
* text
*/
public void setHtmlContentAllowed(boolean htmlContentAllowed) {
getState().htmlContentAllowed = htmlContentAllowed;
}
/**
* Checks whether captions are interpreted as html or plain text.
*
* @return true if the captions are used as html, false if used as plain
* text
* @see #setHtmlContentAllowed(boolean)
*/
public boolean isHtmlContentAllowed() {
return getState(false).htmlContentAllowed;
}
@Override
protected CheckBoxGroupState getState() {
return (CheckBoxGroupState) super.getState();
}
@Override
protected CheckBoxGroupState getState(boolean markAsDirty) {
return (CheckBoxGroupState) super.getState(markAsDirty);
}
@Override
public IconGenerator getItemIconGenerator() {
return super.getItemIconGenerator();
}
@Override
public void setItemIconGenerator(IconGenerator itemIconGenerator) {
super.setItemIconGenerator(itemIconGenerator);
}
@Override
public SerializablePredicate getItemEnabledProvider() {
return super.getItemEnabledProvider();
}
@Override
public void setItemEnabledProvider(
SerializablePredicate itemEnabledProvider) {
super.setItemEnabledProvider(itemEnabledProvider);
}
@Override
public Registration addFocusListener(FocusListener listener) {
return addListener(FocusEvent.EVENT_ID, FocusEvent.class, listener,
FocusListener.focusMethod);
}
@Override
public Registration addBlurListener(BlurListener listener) {
return addListener(BlurEvent.EVENT_ID, BlurEvent.class, listener,
BlurListener.blurMethod);
}
/**
* Sets the description generator that is used for generating descriptions
* for items. Description is shown as a tooltip when hovering on
* corresponding element. If the generator returns {@code null}, no tooltip
* is shown.
*
*
* @param descriptionGenerator
* the item description generator to set, not {@code null}
*
* @since 8.2
*/
public void setItemDescriptionGenerator(
DescriptionGenerator descriptionGenerator) {
Objects.requireNonNull(descriptionGenerator);
if (this.descriptionGenerator != descriptionGenerator) {
this.descriptionGenerator = descriptionGenerator;
getDataProvider().refreshAll();
}
}
/**
* Gets the item description generator.
*
* @return the item description generator
*
* @since 8.2
*/
public DescriptionGenerator getItemDescriptionGenerator() {
return descriptionGenerator;
}
@Override
protected void readItems(Element design, DesignContext context) {
setItemEnabledProvider(new DeclarativeItemEnabledProvider<>());
super.readItems(design, context);
}
@SuppressWarnings({ "unchecked", "rawtypes" })
@Override
protected T readItem(Element child, Set selected,
DesignContext context) {
T item = super.readItem(child, selected, context);
SerializablePredicate provider = getItemEnabledProvider();
if (provider instanceof DeclarativeItemEnabledProvider) {
if (child.hasAttr("disabled")) {
((DeclarativeItemEnabledProvider) provider).addDisabled(item);
}
} else {
throw new IllegalStateException(String.format("Don't know how "
+ "to disable item using current item enabled provider '%s'",
provider.getClass().getName()));
}
return item;
}
@Override
protected Element writeItem(Element design, T item, DesignContext context) {
Element elem = super.writeItem(design, item, context);
if (!getItemEnabledProvider().test(item)) {
elem.attr("disabled", true);
}
if (isHtmlContentAllowed()) {
// need to unencode HTML entities. AbstractMultiSelect.writeDesign
// can't check if HTML content is allowed, so it always encodes
// entities like '>', '<' and '&'; in case HTML content is allowed
// this is undesirable so we need to unencode entities. Entities
// other than '<' and '>' will be taken care by Jsoup.
elem.html(DesignFormatter.decodeFromTextNode(elem.html()));
}
return elem;
}
@Override
public DataProvider getDataProvider() {
return internalGetDataProvider();
}
@Override
public void setDataProvider(DataProvider dataProvider) {
internalSetDataProvider(dataProvider);
}
}
