com.holonplatform.vaadin.components.builders.InputBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of holon-vaadin Show documentation
Holon Vaadin integration
There is a newer version: 5.4.0
/*
 * 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.vaadin.components.builders;

import java.util.function.BiConsumer;
import java.util.function.Consumer;

import com.holonplatform.vaadin.components.Field;
import com.holonplatform.vaadin.components.Input;
import com.holonplatform.vaadin.components.ValidatableInput;
import com.vaadin.data.HasValue;
import com.vaadin.ui.AbstractComponent;
import com.vaadin.ui.dnd.DragSourceExtension;
import com.vaadin.ui.dnd.DropTargetExtension;

/**
 * Builder to create {@link Input} instances.
 * 
 * @param  Value type
 * @param  Input type
 * @param  Concrete builder type
 * 
 * @since 5.0.0
 */
public interface InputBuilder, B extends InputBuilder> extends InputConfigurator {

	/**
	 * Makes the component a drag source. The provided configurator can be used to configure the drag
	 * source using {@link DragSourceExtension}, allowing for example to set the drag effect, to set the transferred
	 * data or to register drag start/end listeners.
	 * @param configurator Consumer to configure the drag source
	 * @return this
	 * @since 5.0.6
	 */
	B dragSource(Consumer> configurator);

	/**
	 * Makes the component a drop target. The provided configurator can be used to configure the drop
	 * target behaviour using {@link DragSourceExtension}, allowing for example to control when the drop is acceptable
	 * and then react to the drop event.
	 * @param configurator BiConsumer to configure the drop target, providing also the component that will be built by
	 *        this builder
	 * @return this
	 * @since 5.0.6
	 */
	B dropTarget(BiConsumer, C> configurator);

	/**
	 * Instructs the builder to resolve any message localization (for example component caption and description) only
	 * after the component is attached to parent layout. By default, localization is performed immediately during
	 * component building.
	 * @return this
	 */
	B deferLocalization();

	/**
	 * Build and returns the {@link Input} instance.
	 * @return the {@link Input} instance
	 */
	C build();

	/**
	 * Build a {@link ValidatableInput} input component.
	 * @return {@link ValidatableInput} builder
	 */
	ValidatableInputBuilder> validatable();

	/**
	 * Build the input component as a {@link HasValue} component.
	 * @return the input {@link HasValue} instance
	 */
	Field asField();

}