T
- The type of the property of the Option valuepublic interface Option<T>
SettingsPane
control.Type | Property and Description |
---|---|
java.util.Optional<java.util.function.Function<Option<T>,OptionEditor<T>>> |
editorFactory
Returns an
Optional of a Function
that returns an instance of the OptionEditor that should be used for
editing this option. |
javafx.beans.property.Property<T> |
value
Returns the underlying
Property , where one exists,
that the editor can monitor for changes. |
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
SEPARATOR
|
Modifier and Type | Method and Description |
---|---|
java.util.Optional<java.util.function.Function<Option<T>,OptionEditor<T>>> |
editorFactoryProperty()
Returns an
Optional of a Function
that returns an instance of the OptionEditor that should be used for
editing this option. |
java.lang.String |
getCaption()
Returns the display name of the property associated to the
Option
or the name associated to the group of options. |
java.lang.String |
getCategory()
Returns a
String representation of the category of the property. |
javafx.collections.ObservableList<Option> |
getChildren()
Returns the
ObservableList of sub-options
that a given option contains. |
java.lang.String |
getDescription()
A
String that will be shown to the user as a tooltip. |
java.util.Optional<java.lang.String> |
getExtendedDescription()
A long
String that will be shown to the user in an extended view. |
java.util.Optional<javafx.scene.Node> |
getGraphic()
Returns an
Optional with the node that will be displayed as a graphic on
the left side of the option if not empty |
javafx.geometry.Orientation |
getLayout()
Returns the
Orientation of the Option , that
defines its layout:
Orientation.HORIZONTAL sets an horizontal layout, with an optional
graphic on the left, caption and description on the center, and editor on the
right. |
java.util.Optional<javafx.util.StringConverter<T>> |
getStringConverter()
Returns an
Optional of a StringConverter
that can be applied to the value |
boolean |
isEditable()
Indicates whether the
SettingsPane
control should allow editing this option, or whether it is read-only. |
javafx.beans.property.Property<T> |
valueProperty()
Returns the underlying
Property , where one exists,
that the editor can monitor for changes. |
javafx.beans.property.Property<T> valueProperty
Property
, where one exists,
that the editor can monitor for changes.java.util.Optional<java.util.function.Function<Option<T>,OptionEditor<T>>> editorFactoryProperty
Optional
of a Function
that returns an instance of the OptionEditor
that should be used for
editing this option.static final java.lang.String SEPARATOR
java.util.Optional<javafx.scene.Node> getGraphic()
Optional
with the node that will be displayed as a graphic on
the left side of the option if not emptyOptional
with a Node
if not emptyjava.lang.String getCaption()
Option
or the name associated to the group of options.
It should be short (i.e. less than two words). This is used to explain to the
end user what the option represents.String
with the name or caption of the Option
java.lang.String getDescription()
String
that will be shown to the user as a tooltip. This allows for
a longer form of detail than what is possible with the getCaption()
method.String
with the description of the Option
java.util.Optional<java.lang.String> getExtendedDescription()
String
that will be shown to the user in an extended view. This allows for
a longer form of detail than what is possible with the getCaption()
method.String
with an extended description of the Option
if
not emptyjava.lang.String getCategory()
String
representation of the category of the property. This
is relevant when properties with the same category can be grouped together
visually.String
with the category of the Option
javafx.beans.property.Property<T> valueProperty()
Property
, where one exists,
that the editor can monitor for changes.boolean isEditable()
SettingsPane
control should allow editing this option, or whether it is read-only.java.util.Optional<java.util.function.Function<Option<T>,OptionEditor<T>>> editorFactoryProperty()
Optional
of a Function
that returns an instance of the OptionEditor
that should be used for
editing this option.javafx.collections.ObservableList<Option> getChildren()
ObservableList
of sub-options
that a given option contains.ObservableList
with options
java.util.Optional<javafx.util.StringConverter<T>> getStringConverter()
Optional
of a StringConverter
that can be applied to the valueOptional
with a StringConverter
if not emptyjavafx.geometry.Orientation getLayout()
Orientation
of the Option
, that
defines its layout:
Orientation.HORIZONTAL
sets an horizontal layout, with an optional
graphic on the left, caption and description on the center, and editor on the
right.
Orientation.VERTICAL
sets a vertical layout, with an optional
graphic on the left, caption on top and editor on bottom.
Orientation.HORIZONTAL
Orientation
that indicates the layout of the
Option