jidefx.scene.control.editor.Editor Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jidefx-fields Show documentation

JideFX Common Layer is a collection of several extend feature for JavaFX

The newest version!

/*
 * @(#)CellEditor.java 5/19/2013
 *
 * Copyright 2002 - 2013 JIDE Software Inc. All rights reserved.
 */

package jidefx.scene.control.editor;

import javafx.beans.value.ObservableValue;
import javafx.scene.Node;

/**
 * An interface for an editor of a certain data type. This editor can be used to set a value and to get a value. User
 * can adjust the value using the editor itself. There are many different editors that are all unified under this common
 * interface. It works with {@link EditorManager} to provide a consistent way to retrieve an editor to edit any data types.
 *
 * @param  the value data type
 * @see EditorManager
 */
public interface Editor {

    /**
     * An observable value of the editor so that one can listen to the value change.
     *
     * @return An observable value.
     */
    ObservableValue observableValue();

    /**
     * Gets the value from the editor. For example, if the editor is a ComboBox, this method should return {@code
     * comboBox.getValue()}.
     *
     * @return the value.
     */
    default T getValue() {
        return observableValue().getValue();
    }

    /**
     * Sets the value to the editor. For example, if the editor is a ComboBox, this method should call {@code
     * comboBox.setValue(value)}.
     *
     * @param value the new value.
     */
    void setValue(final T value);

    /**
     * Creates the editor node. The default implementation of this method return the Editor itself as in most cases, we
     * implement the Editor interface directly on the control itself.
     *
     * @return the editor node.
     */
    default Node createEditor() {
        return this instanceof Node ? (Node) this : null;
    }
}