FluentField.java

/*
 * Copyright 2016 Matti Tahvonen.
 *
 * 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 org.vaadin.viritin.v7.fluency.ui;

import org.vaadin.viritin.fluency.ui.FluentComponent;
import org.vaadin.viritin.v7.fluency.data.FluentBufferedValidatable;
import org.vaadin.viritin.v7.fluency.data.FluentProperty;

import com.vaadin.v7.ui.Field;

/**
 * A {@link Field} complemented by fluent setters.
 * 
 * @author Max Schuster
 * @param <S> Fluent component type
 * @param <T> The type of values in the field, which might not be the same type
 * as that of the data source if converters are used
 * @see Field
 */
public interface FluentField<S extends FluentField<S, T>, T> extends Field<T>,
        FluentComponent<S>, FluentBufferedValidatable<S>, 
        FluentComponent.FluentFocusable<S>, 
        FluentProperty<S, T>, FluentProperty.FluentValueChangeNotifier<S>,
        FluentProperty.FluentEditor<S> {

    // Javadoc copied form Vaadin Framework
    /**
     * Sets the field required. Required fields must filled by the user.
     *
     * @param required Is the field required.
     * @return this (for method chaining)
     * @see #setRequired(boolean)
     */
    public default S withRequired(boolean required) {
        ((Field) this).setRequired(required);
        return (S) this;
    }

    // Javadoc copied form Vaadin Framework
    /**
     * Sets the error message to be displayed if a required field is empty.
     *
     * @param requiredMessage Error message.
     * @return this (for method chaining)
     * @see #setRequiredError(java.lang.String)
     */
    public default S withRequiredError(String requiredMessage) {
        ((Field) this).setRequiredError(requiredMessage);
        return (S) this;
    }

}