ensemble.samples.controls.text.TextValidatorSample Maven / Gradle / Ivy

Go to download
/*
 * Copyright (c) 2008, 2012 Oracle and/or its affiliates.
 * All rights reserved. Use is subject to license terms.
 *
 * This file is available and licensed under the following license:
 *
 * 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 Oracle Corporation 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 ensemble.samples.controls.text;

import ensemble.Sample;
import javafx.beans.InvalidationListener;
import javafx.beans.Observable;
import javafx.beans.property.ObjectProperty;
import javafx.beans.property.ReadOnlyObjectProperty;
import javafx.beans.property.ReadOnlyObjectWrapper;
import javafx.beans.property.SimpleObjectProperty;
import javafx.beans.value.ChangeListener;
import javafx.beans.value.ObservableValue;
import javafx.event.Event;
import javafx.event.EventHandler;
import javafx.event.EventType;
import javafx.geometry.Insets;
import javafx.scene.control.Control;
import javafx.scene.control.TextField;
import javafx.scene.control.TextInputControl;
import javafx.scene.layout.Region;
import javafx.scene.layout.StackPane;

/**
 * Demonstrates a TextField control that allows you to enter text.
 *
 * @see javafx.scene.control.TextField
 * @resource Validators.css
 */
public class TextValidatorSample extends Sample {
    public TextValidatorSample() {
        String validatorCss = TextValidatorSample.class.getResource("Validators.css").toExternalForm();
        
        TextField dateField = new TextField();
        dateField.setPromptText("Enter a Large Number");
        dateField.setMaxHeight(TextField.USE_PREF_SIZE);

        TextInputValidatorPane pane = new TextInputValidatorPane();
        pane.setContent(dateField);
        pane.setValidator(new Validator() {
            public ValidationResult validate(TextField control) {
                try {
                    String text = control.getText();
                    if (text == null || text.trim().equals("")) return null;
                    double d = Double.parseDouble(text);
                    if (d < 1000) {
                        return new ValidationResult("Should be > 1000", ValidationResult.Type.WARNING);
                    }
                    return null; // succeeded
                } catch (Exception e) {
                    // failed
                    return new ValidationResult("Bad number", ValidationResult.Type.ERROR);
                }
            }
        });

        StackPane rootSP = new StackPane();
        rootSP.setPadding(new Insets(12));
        rootSP.getChildren().add(pane);
        pane.getStylesheets().add(validatorCss);
        getChildren().add(rootSP);
    }
 
public static class ValidationResult {
    public enum Type { ERROR, WARNING, SUCCESS }
    private final String message;
    private final Type type;

    public ValidationResult(String message, Type type) {
        this.message = message;
        this.type = type;
    }

    public final String getMessage() {
        return message;
    }

    public final Type getType() {
        return type;
    }
}    

private static interface Validator {
    public ValidationResult validate(C control);
}

public static class ValidationEvent extends Event {
    public static final EventType ANY =
            new EventType(Event.ANY, "VALIDATION");

    private final ValidationResult result;

    public ValidationEvent(ValidationResult result) {
        super(ANY);
        this.result = result;
    }

    public final ValidationResult getResult() { return result; }
}

private abstract class ValidatorPane extends Region {
    /**
     * The content for the validator pane is the control it should work with.
     */
    private ObjectProperty content = new SimpleObjectProperty(this, "content", null);
    public final C getContent() { return content.get(); }
    public final void setContent(C value) { content.set(value); }
    public final ObjectProperty contentProperty() { return content; }

    /**
     * The validator
     */
    private ObjectProperty> validator = new SimpleObjectProperty>(this, "validator");
    public final Validator getValidator() { return validator.get(); }
    public final void setValidator(Validator value) { validator.set(value); }
    public final ObjectProperty> validatorProperty() { return validator; }

    /**
     * The validation result
     */
    private ReadOnlyObjectWrapper validationResult = new ReadOnlyObjectWrapper(this, "validationResult");
    public final ValidationResult getValidationResult() { return validationResult.get(); }
    public final ReadOnlyObjectProperty validationResultProperty() { return validationResult.getReadOnlyProperty(); }

    /**
     *  The event handler
     */
    private ObjectProperty> onValidation =
            new SimpleObjectProperty>(this, "onValidation");
    public final EventHandler getOnValidation() { return onValidation.get(); }
    public final void setOnValidation(EventHandler value) { onValidation.set(value); }
    public final ObjectProperty> onValidationProperty() { return onValidation; }

    public ValidatorPane() {
        content.addListener(new ChangeListener() {
            public void changed(ObservableValue ov, Control oldValue, Control newValue) {
                if (oldValue != null) getChildren().remove(oldValue);
                if (newValue != null) getChildren().add(0, newValue);
            }
        });
    }

    protected void handleValidationResult(ValidationResult result) {
        getStyleClass().removeAll("validation-error", "validation-warning");
        if (result != null) {
            if (result.getType() == ValidationResult.Type.ERROR) {
                getStyleClass().add("validation-error");
            } else if (result.getType() == ValidationResult.Type.WARNING) {
                getStyleClass().add("validation-warning");
            }
        }
        validationResult.set(result);
        fireEvent(new ValidationEvent(result));
    }

    @Override
    protected void layoutChildren() {
        Control c = content.get();
        if (c != null) {
            c.resizeRelocate(0, 0, getWidth(), getHeight());
        }
    }

    @Override
    protected double computeMaxHeight(double d) {
        Control c = content.get();
        return c == null ? super.computeMaxHeight(d) : c.maxHeight(d);
    }

    @Override
    protected double computeMinHeight(double d) {
        Control c = content.get();
        return c == null ? super.computeMinHeight(d) : c.minHeight(d);
    }

    @Override
    protected double computePrefHeight(double d) {
        Control c = content.get();
        return c == null ? super.computePrefHeight(d) : c.prefHeight(d);
    }

    @Override
    protected double computePrefWidth(double d) {
        Control c = content.get();
        return c == null ? super.computePrefWidth(d) : c.prefWidth(d);
    }

    @Override
    protected double computeMaxWidth(double d) {
        Control c = content.get();
        return c == null ? super.computeMaxWidth(d) : c.maxWidth(d);
    }

    @Override
    protected double computeMinWidth(double d) {
        Control c = content.get();
        return c == null ? super.computeMinWidth(d) : c.minWidth(d);
    }
}


private class TextInputValidatorPane extends ValidatorPane {

    private InvalidationListener textListener = new InvalidationListener() {           
        @Override public void invalidated(Observable o) {
            final Validator v = getValidator();
            final ValidationResult result = v != null ?
                v.validate(getContent()) :
                new ValidationResult("", ValidationResult.Type.SUCCESS);

            handleValidationResult(result);
        }
    };

    public TextInputValidatorPane() {
        contentProperty().addListener(new ChangeListener() {                
            @Override public void changed(ObservableValue ov, C oldValue, C newValue) {
                if (oldValue != null) oldValue.textProperty().removeListener(textListener);
                if (newValue != null) newValue.textProperty().addListener(textListener);
            }
        });
    }

    public TextInputValidatorPane(C field) {
        this();
        setContent(field);
    }

}    
}