InputFieldImpl.java example

Explorer
jo-widgets-master
/*
 * Copyright (c) 2010, Michael Grossmann
 * All rights reserved.
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 * * Redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer.
 * * Redistributions in binary form must reproduce the above copyright
 * notice, this list of conditions and the following disclaimer in the
 * documentation and/or other materials provided with the distribution.
 * * Neither the name of the jo-widgets.org nor the
 * names of its contributors may be used to endorse or promote products
 * derived from this software without specific prior written permission.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
 * DAMAGE.
 */
package org.jowidgets.impl.widgets.composed;

import org.jowidgets.api.convert.IConverter;
import org.jowidgets.api.convert.IObjectStringConverter;
import org.jowidgets.api.dnd.IDragSource;
import org.jowidgets.api.dnd.IDropTarget;
import org.jowidgets.api.widgets.IInputField;
import org.jowidgets.api.widgets.ITextControl;
import org.jowidgets.api.widgets.descriptor.setup.IInputFieldSetup;
import org.jowidgets.common.widgets.controller.IInputListener;
import org.jowidgets.tools.controller.InputObservable;
import org.jowidgets.tools.validation.ValidationCache;
import org.jowidgets.tools.validation.ValidationCache.IValidationResultCreator;
import org.jowidgets.tools.value.InputComponentBind;
import org.jowidgets.tools.widgets.invoker.ColorSettingsInvoker;
import org.jowidgets.tools.widgets.invoker.VisibiliySettingsInvoker;
import org.jowidgets.tools.widgets.wrapper.ControlWrapper;
import org.jowidgets.util.Assert;
import org.jowidgets.util.EmptyCompatibleEquivalence;
import org.jowidgets.util.IObservableValue;
import org.jowidgets.util.ObservableValue;
import org.jowidgets.validation.IValidationConditionListener;
import org.jowidgets.validation.IValidationResult;
import org.jowidgets.validation.IValidator;
import org.jowidgets.validation.Validator;
import org.jowidgets.validation.tools.CompoundValidator;

public class InputFieldImpl<VALUE_TYPE> extends ControlWrapper implements IInputField<VALUE_TYPE> {

    private final IConverter<VALUE_TYPE> converter;
    private final IObjectStringConverter<VALUE_TYPE> objectStringConverter;
    private final CompoundValidator<VALUE_TYPE> compoundValidator;
    private final IValidator<String> stringValidator;
    private final ValidationCache validationCache;
    private final InputObservable inputObservable;
    private final IObservableValue<VALUE_TYPE> observableValue;

    private VALUE_TYPE value;
    private String lastUnmodifiedTextValue;
    private boolean editable;

    @SuppressWarnings("unchecked")
    public InputFieldImpl(final ITextControl textField, final IInputFieldSetup<VALUE_TYPE> setup) {

        super(textField);

        this.inputObservable = new InputObservable();
        this.compoundValidator = new CompoundValidator<VALUE_TYPE>();

        Assert.paramNotNull(setup.getConverter(), "setup.getConverter()");
        if (setup.getConverter() instanceof IConverter<?>) {
            this.converter = (IConverter<VALUE_TYPE>) setup.getConverter();
            this.objectStringConverter = converter;
        }
        else if (setup.getConverter() instanceof IObjectStringConverter<?>) {
            this.converter = null;
            this.objectStringConverter = (IObjectStringConverter<VALUE_TYPE>) setup.getConverter();
            getWidget().setEditable(false);
        }
        else {
            throw new IllegalArgumentException("Converter type'" + setup.getConverter().getClass() + "' is not supported.");
        }
        this.observableValue = setup.getObservableValue() != null
                ? setup.getObservableValue() : new ObservableValue<VALUE_TYPE>();

        if (converter != null && converter.getStringValidator() != null) {
            this.stringValidator = converter.getStringValidator();
        }
        else {
            this.stringValidator = Validator.okValidator();
        }

        compoundValidator.addValidator(setup.getValidator());

        this.validationCache = new ValidationCache(new IValidationResultCreator() {
            @Override
            public IValidationResult createValidationResult() {
                final IValidationResult result = stringValidator.validate(getText());
                //if the converter could not parse the input, do not make more validation
                if (!result.isValid()) {
                    return result;
                }
                else {
                    return result.withResult(compoundValidator.validate(getValue()));
                }
            }
        });

        textField.addInputListener(new IInputListener() {
            @Override
            public void inputChanged() {
                inputObservable.fireInputChanged();
                validationCache.setDirty();
            }
        });

        this.editable = setup.isEditable();
        if (!setup.isEditable()) {
            setEditable(false);
        }

        VisibiliySettingsInvoker.setVisibility(setup, this);
        ColorSettingsInvoker.setColors(setup, this);

        if (setup.getValue() != null && observableValue.getValue() == null) {
            setValue(setup.getValue());
        }

        InputComponentBind.bind(observableValue, this);

        resetModificationState();
    }

    @Override
    protected ITextControl getWidget() {
        return (ITextControl) super.getWidget();
    }

    @Override
    public IObservableValue<VALUE_TYPE> getObservableValue() {
        return observableValue;
    }

    @Override
    public boolean hasModifications() {
        return !EmptyCompatibleEquivalence.equals(lastUnmodifiedTextValue, getText());
    }

    @Override
    public void resetModificationState() {
        this.lastUnmodifiedTextValue = getText();
    }

    @Override
    public VALUE_TYPE getValue() {
        if (converter != null) {
            return converter.convertToObject(getWidget().getText());
        }
        else {
            return value;
        }
    }

    @Override
    public void setValue(final VALUE_TYPE value) {
        this.value = value;
        if (value == null) {
            getWidget().setText(null);
        }
        else {
            getWidget().setText(objectStringConverter.convertToString(value));
        }
    }

    @Override
    public void selectAll() {
        getWidget().selectAll();
    }

    @Override
    public void setSelection(final int start, final int end) {
        getWidget().setSelection(start, end);
    }

    @Override
    public void select() {
        getWidget().selectAll();
    }

    @Override
    public void setCaretPosition(final int pos) {
        getWidget().setCaretPosition(pos);
    }

    @Override
    public int getCaretPosition() {
        return getWidget().getCaretPosition();
    }

    @Override
    public String getText() {
        return getWidget().getText();
    }

    @Override
    public void addValidator(final IValidator<VALUE_TYPE> validator) {
        compoundValidator.addValidator(validator);
    }

    @Override
    public IValidationResult validate() {
        return validationCache.validate();
    }

    @Override
    public void addValidationConditionListener(final IValidationConditionListener listener) {
        validationCache.addValidationConditionListener(listener);
    }

    @Override
    public void removeValidationConditionListener(final IValidationConditionListener listener) {
        validationCache.removeValidationConditionListener(listener);
    }

    @Override
    public void setEditable(final boolean editable) {
        if (converter != null) {
            this.editable = editable;
            getWidget().setEditable(editable);
        }
    }

    @Override
    public boolean isEditable() {
        if (converter != null) {
            return editable;
        }
        else {
            return false;
        }
    }

    @Override
    public void addInputListener(final IInputListener listener) {
        inputObservable.addInputListener(listener);
    }

    @Override
    public void removeInputListener(final IInputListener listener) {
        inputObservable.removeInputListener(listener);
    }

    @Override
    public IDragSource getDragSource() {
        return getWidget().getDragSource();
    }

    @Override
    public IDropTarget getDropTarget() {
        return getWidget().getDropTarget();
    }

}