jidefx.scene.control.editor

Interface Editor<T>

Type Parameters:

T - the value data type

All Known Implementing Classes:

BoundingBoxComboBox, BoundingBoxField, CalendarComboBox, CalendarField, CheckBoxEditor, ChoiceBoxEditor, ColorComboBox, ColorField, ComboBoxEditor, DateComboBox, DateField, Dimension2DComboBox, Dimension2DField, DoubleField, EnumChoiceBoxEditor, EnumComboBoxEditor, FontComboBox, FontField, FormattedComboBox, FormattedTextField, InsetsComboBox, InsetsField, IntegerComboBox, IntegerField, LocalDateComboBox, LocalDateField, LocalDateTimeComboBox, LocalDateTimeField, LocalTimeField, NumberField, Point2DComboBox, Point2DField, Point3DComboBox, Point3DField, PopupField, Rectangle2DComboBox, Rectangle2DField, TextFieldEditor, ValuesComboBox

public interface Editor<T>

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 EditorManager to provide a consistent way to retrieve an editor to edit any data types.

See Also:

EditorManager

Method Summary

Modifier and Type	Method and Description
default javafx.scene.Node	createEditor() Creates the editor node.
default T	getValue() Gets the value from the editor.
javafx.beans.value.ObservableValue<T>	observableValue() An observable value of the editor so that one can listen to the value change.
void	setValue(T value) Sets the value to the editor.

Method Detail

observableValue

javafx.beans.value.ObservableValue<T> observableValue()

An observable value of the editor so that one can listen to the value change.

Returns:

An observable value.

getValue

default T getValue()

Gets the value from the editor. For example, if the editor is a ComboBox, this method should return comboBox.getValue().

Returns:

the value.

setValue

void setValue(T value)

Sets the value to the editor. For example, if the editor is a ComboBox, this method should call comboBox.setValue(value).

Parameters:

value - the new value.

createEditor

default javafx.scene.Node createEditor()

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.

Returns:

the editor node.