com.holonplatform.vaadin7.internal.components.ValidatableInputConfigurator Maven / Gradle / Ivy

/*
 * Copyright 2000-2017 Holon TDCN.
 * 
 * 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.internal.components;

import com.holonplatform.core.Validator;
import com.holonplatform.vaadin7.components.Input;
import com.holonplatform.vaadin7.components.ValidationStatusHandler;

/**
 * Configurator API for Inputs which supports validation.
 *
 * @since 5.1.0
 */
public interface ValidatableInputConfigurator {

	/**
	 * Adds a {@link Validator} to validate the input value.
	 * @param validator The validator to add (not null)
	 */
	void addValidator(Validator validator);

	/**
	 * Sets whether to validate the value, using registered {@link Validator}s, every time the {@link Input} value
	 * changes.
	 * @param validateOnValueChange true to perform value validation every time the {@link Input} value
	 *        changes, false if not
	 */
	void setValidateOnValueChange(boolean validateOnValueChange);

	/**
	 * Set the {@link ValidationStatusHandler} to use to track validation status changes.
	 * @param validationStatusHandler the {@link ValidationStatusHandler} to set
	 */
	void setValidationStatusHandler(ValidationStatusHandler validationStatusHandler);

}