javafx.scene.input.InputNode Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of javafx-graphics Show documentation

The newest version!

/*
 * Copyright (c) 2022, JFXcore. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.  JFXcore designates this
 * particular file as subject to the "Classpath" exception as provided
 * in the LICENSE file that accompanied this code.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 */

package javafx.scene.input;

import javafx.beans.property.BooleanProperty;
import javafx.util.Incubating;

/**
 * Identifies a node that supports data input.
 *
 * @since JFXcore 18
 */
@Incubating
public interface InputNode {

    /**
     * Returns the {@code userModified} property, which indicates whether the
     * value represented by the node was changed as a result of user input.
     */
    BooleanProperty userModifiedProperty();

    /**
     * Returns the value of the {@link #userModifiedProperty() userModified} property.
     */
    boolean isUserModified();

    /**
     * Sets the value of the {@link #userModifiedProperty() userModified} property.
     */
    void setUserModified(boolean value);

}