com.holonplatform.vaadin7.components.MultiSelect Maven / Gradle / Ivy
/*
* Copyright 2016-2017 Axioma srl.
*
* 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 com.holonplatform.vaadin7.components;
import java.util.Collections;
import java.util.Optional;
import java.util.Set;
import java.util.stream.Collectors;
import java.util.stream.Stream;
import com.holonplatform.core.internal.utils.ObjectUtils;
import com.holonplatform.core.property.Property;
import com.holonplatform.core.property.PropertyBox;
import com.holonplatform.vaadin7.components.builders.MultiPropertySelectInputBuilder;
import com.holonplatform.vaadin7.components.builders.MultiSelectInputBuilder;
import com.holonplatform.vaadin7.components.builders.BaseSelectInputBuilder.RenderingMode;
import com.holonplatform.vaadin7.internal.components.MultiSelectField;
/**
* A {@link Selectable} component in which multiple items can be selected at the same time. Selecting an item adds it to
* the selection.
*
* @param Selection item type
*
* @since 5.0.0
*/
public interface MultiSelect extends Selectable, Input>, ItemSet {
/**
* Adds the given item to the set of currently selected items.
*
* By default this does not clear any previous selection. To do that, use {@link #deselectAll()}.
*
* @param items Items to select (not null)
*/
void select(Iterable items);
/**
* Adds the given item to the set of currently selected items.
*
* By default this does not clear any previous selection. To do that, use {@link #deselectAll()}.
*
* @param items Items to select (not null)
*/
@SuppressWarnings("unchecked")
default void select(T... items) {
ObjectUtils.argumentNotNull(items, "Items to select must be not null");
select(Stream.of(items).map(i -> {
ObjectUtils.argumentNotNull(i, "Items to select must be not null");
return i;
}).collect(Collectors.toSet()));
}
/**
* Removes the given items from the set of currently selected items.
* @param items Items to deselect (not null)
*/
void deselect(Iterable items);
/**
* Removes the given items from the set of currently selected items.
* @param items Items to deselect (not null)
*/
@SuppressWarnings("unchecked")
default void deselect(T... items) {
ObjectUtils.argumentNotNull(items, "Items to deselect must be not null");
deselect(Stream.of(items).map(i -> {
ObjectUtils.argumentNotNull(i, "Items to deselect must be not null");
return i;
}).collect(Collectors.toSet()));
}
/**
* Selects all available the items.
*/
void selectAll();
/*
* (non-Javadoc)
* @see com.holonplatform.vaadin.components.Selectable#getSelectionMode()
*/
@Override
default SelectionMode getSelectionMode() {
return SelectionMode.MULTI;
}
/*
* (non-Javadoc)
* @see com.holonplatform.vaadin.components.Selectable#getFirstSelectedItem()
*/
@Override
default Optional getFirstSelectedItem() {
return getSelectedItems().stream().findFirst();
}
/*
* (non-Javadoc)
* @see com.holonplatform.vaadin.components.Selectable#select(java.lang.Object)
*/
@Override
default void select(T item) {
ObjectUtils.argumentNotNull(item, "Item to select must be not null");
select(Collections.singleton(item));
}
/*
* (non-Javadoc)
* @see com.holonplatform.vaadin.components.Selectable#deselect(java.lang.Object)
*/
@Override
default void deselect(T item) {
ObjectUtils.argumentNotNull(item, "Item to deselect must be not null");
deselect(Collections.singleton(item));
}
// Builders
/**
* Gets a builder to create a {@link MultiSelect}.
* @param Selection value type
* @param type Selection value type
* @param renderingMode Rendering mode
* @return {@link MultiSelect} builder
*/
static MultiSelectInputBuilder builder(Class type, RenderingMode renderingMode) {
return new MultiSelectField.Builder<>(type, renderingMode);
}
/**
* Gets a builder to create a {@link MultiSelect}.
* @param Selection value type
* @param type Selection value type
* @return {@link MultiSelect} builder
*/
static MultiSelectInputBuilder builder(Class type) {
return new MultiSelectField.Builder<>(type, RenderingMode.OPTIONS);
}
/**
* Gets a builder to create a {@link MultiSelect} with a {@link PropertyBox} items data source with {@link Property}
* as item properties.
* @param Selection value type
* @param selectProperty Property to select (not null)
* @param renderingMode Rendering mode
* @return {@link MultiSelect} builder
*/
static MultiPropertySelectInputBuilder property(Property selectProperty, RenderingMode renderingMode) {
ObjectUtils.argumentNotNull(selectProperty, "Selection property must be not null");
return new MultiSelectField.PropertyBuilder<>(selectProperty, renderingMode);
}
/**
* Gets a builder to create a {@link MultiSelect} with a {@link PropertyBox} items data source with {@link Property}
* as item properties. Default {@link RenderingMode#SELECT} is assumed.
* @param Selection value type
* @param selectProperty Property to select (not null)
* @return {@link MultiSelect} builder
*/
static MultiPropertySelectInputBuilder property(Property selectProperty) {
ObjectUtils.argumentNotNull(selectProperty, "Selection property must be not null");
return new MultiSelectField.PropertyBuilder<>(selectProperty, RenderingMode.OPTIONS);
}
}