Type Parameters:

T - The type of the property of the Option value

All Known Implementing Classes:

DefaultOption, OptionBase
```
public interface Option<T>
```
A wrapper interface for a single option to be displayed in a SettingsPane control.

Since:

2.0.0

Property Summary

Properties
Type Property Description

Property<T> value
Returns the underlying Property, where one exists, that the editor can monitor for changes.

Field Summary

Fields
Modifier and Type Field Description

static String SEPARATOR
A String used to create horizontal separators between other options in the SettingsPane control

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`Optional<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.
`String`	`getCaption()`	Returns the display name of the property associated to the `Option` or the name associated to the group of options.
`String`	`getCategory()`	Returns a `String` representation of the category of the property.
`ObservableList<Option>`	`getChildren()`	Returns the `ObservableList` of `sub-options` that a given option contains.
`String`	`getDescription()`	A `String` that will be shown to the user as a tooltip.
`Optional<String>`	`getExtendedDescription()`	A long `String` that will be shown to the user in an extended view.
`Optional<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
`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.
`Optional<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.
`Property<T>`	`valueProperty()`	Returns the underlying `Property`, where one exists, that the editor can monitor for changes.

- Property Detail
  - value
```
Property<T> valueProperty
```
    Returns the underlying Property, where one exists, that the editor can monitor for changes.
- Field Detail
  - SEPARATOR
```
static final String SEPARATOR
```
    A String used to create horizontal separators between other options in the SettingsPane control
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getGraphic
```
Optional<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
    
    Returns:
    
    Optional with a Node if not empty
  - getCaption
```
String getCaption()
```
    Returns the display name of the property associated to the 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.
    
    Returns:
    
    String with the name or caption of the Option
  - getDescription
```
String getDescription()
```
    A 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.
    
    Returns:
    
    String with the description of the Option
  - getExtendedDescription
```
Optional<String> getExtendedDescription()
```
    A long 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.
    
    Returns:
    
    String with an extended description of the Option if not empty
  - getCategory
```
String getCategory()
```
    Returns a String representation of the category of the property. This is relevant when properties with the same category can be grouped together visually.
    
    Returns:
    
    String with the category of the Option
  - valueProperty
```
Property<T> valueProperty()
```
    Returns the underlying Property, where one exists, that the editor can monitor for changes.
  - isEditable
```
boolean isEditable()
```
    Indicates whether the SettingsPane control should allow editing this option, or whether it is read-only.
    
    Returns:
    
    boolean if the control is editable or not
  - editorFactoryProperty
```
Optional<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.
    
    Returns:
    
    Optional with a Function if not empty
  - getChildren
```
ObservableList<Option> getChildren()
```
    Returns the ObservableList of sub-options that a given option contains.
    
    Returns:
    
    ObservableList with options
  - getStringConverter
```
Optional<StringConverter<T>> getStringConverter()
```
    Returns an Optional of a StringConverter that can be applied to the value
    
    Returns:
    
    Optional with a StringConverter if not empty
  - getLayout
```
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.
    
    Orientation.VERTICAL sets a vertical layout, with an optional graphic on the left, caption on top and editor on bottom.
    
    Default is Orientation.HORIZONTAL
    Returns:
    
    Orientation that indicates the layout of the Option

Interface Option<T>

Property Summary

Field Summary

Method Summary

Property Detail

value

Field Detail

SEPARATOR

Method Detail

getGraphic

getCaption

getDescription

getExtendedDescription

getCategory

valueProperty

isEditable

editorFactoryProperty

getChildren

getStringConverter

getLayout