com.holonplatform.vaadin7.components.SingleSelect 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 com.holonplatform.core.internal.utils.ObjectUtils;
import com.holonplatform.core.property.Property;
import com.holonplatform.core.property.PropertyBox;
import com.holonplatform.vaadin7.components.builders.SinglePropertySelectInputBuilder;
import com.holonplatform.vaadin7.components.builders.SingleSelectInputBuilder;
import com.holonplatform.vaadin7.components.builders.BaseSelectInputBuilder.RenderingMode;
import com.holonplatform.vaadin7.internal.components.SingleSelectField;

/**
 * A {@link Selectable} component in which at most one item can be selected at a time.
 * 
 * @param  Selection item type
 * 
 * @since 5.0.0
 */
public interface SingleSelect extends Selectable, Input, ItemSet {

	/**
	 * Get the currently selected item.
	 * @return The currently selected item, empty if no item is selected
	 */
	Optional getSelectedItem();

	/*
	 * (non-Javadoc)
	 * @see com.holonplatform.vaadin.components.Selectable#getSelectionMode()
	 */
	@Override
	default SelectionMode getSelectionMode() {
		return SelectionMode.SINGLE;
	}

	/*
	 * (non-Javadoc)
	 * @see com.holonplatform.vaadin.components.Selectable#getSelectedItems()
	 */
	@Override
	default Set getSelectedItems() {
		return getSelectedItem().map(Collections::singleton).orElse(Collections.emptySet());
	}

	/*
	 * (non-Javadoc)
	 * @see com.holonplatform.vaadin.components.Selectable#getFirstSelectedItem()
	 */
	@Override
	default Optional getFirstSelectedItem() {
		return getSelectedItem();
	}

	/*
	 * (non-Javadoc)
	 * @see com.holonplatform.vaadin.components.Selectable#deselectAll()
	 */
	@Override
	default void deselectAll() {
		getSelectedItem().ifPresent(this::deselect);
	}

	// Builders

	/**
	 * Gets a builder to create a {@link SingleSelect}.
	 * @param  Selection value type
	 * @param type Selection value type
	 * @param renderingMode Rendering mode
	 * @return {@link SingleSelect} builder
	 */
	static  SingleSelectInputBuilder builder(Class type, RenderingMode renderingMode) {
		return new SingleSelectField.Builder<>(type, renderingMode);
	}

	/**
	 * Gets a builder to create a {@link SingleSelect} using default {@link RenderingMode#SELECT}.
	 * @param  Selection value type
	 * @param type Selection value type
	 * @return {@link SingleSelect} builder
	 */
	static  SingleSelectInputBuilder builder(Class type) {
		return new SingleSelectField.Builder<>(type, RenderingMode.SELECT);
	}

	/**
	 * Gets a builder to create a {@link SingleSelect} 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 SingleSelect} builder
	 */
	static  SinglePropertySelectInputBuilder property(Property selectProperty, RenderingMode renderingMode) {
		ObjectUtils.argumentNotNull(selectProperty, "Selection property must be not null");
		return new SingleSelectField.PropertyBuilder<>(selectProperty, renderingMode);
	}

	/**
	 * Gets a builder to create a {@link SingleSelect} 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 SingleSelect} builder
	 */
	static  SinglePropertySelectInputBuilder property(Property selectProperty) {
		ObjectUtils.argumentNotNull(selectProperty, "Selection property must be not null");
		return new SingleSelectField.PropertyBuilder<>(selectProperty, RenderingMode.SELECT);
	}

}