Package com.gluonhq.charm.glisten.control.settings

Class DefaultOption<T>

java.lang.Object

com.gluonhq.charm.glisten.control.settings.OptionBase<T>

com.gluonhq.charm.glisten.control.settings.DefaultOption<T>

Type Parameters:

T - The type of the property of the OptionBase value

All Implemented Interfaces:

Option<T>

public class DefaultOption<T>
extends OptionBase<T>

A convenience class for creating an OptionBase for use in the SettingsPane control based on the given property. When an T value is passed, based on the type of that value, a Property is created and based on it, a proper editor will be selected. Developers can override this, and provide their own editor

Since:

2.0.0

See Also:

OptionBase, SettingsPane

Property Summary

Properties

Type	Property	Description
javafx.beans.property.Property<T>	value	Returns the underlying Property, where one exists, that the editor can monitor for changes.

Properties inherited from class com.gluonhq.charm.glisten.control.settings.OptionBase

editorFactory, id

Field Summary

Fields inherited from interface com.gluonhq.charm.glisten.control.settings.Option

SEPARATOR

Fields inherited from class com.gluonhq.charm.glisten.control.settings.OptionBase

caption, category, children, description, editorFactory, extendedDescription, graphic, isEditable, layout, stringConverter, value

Constructor Summary

Constructors

Constructor	Description
DefaultOption(java.lang.String caption)	Creates an option instance, without graphic and without editor.
DefaultOption(java.lang.String caption, java.lang.String description, java.lang.String category)	Creates an option instance, without graphic and without editor, intended to open a new view with a new group of sub-options, that are set calling Option.getChildren()
DefaultOption(java.lang.String caption, java.lang.String description, java.lang.String category, T value, boolean isEditable)	Creates an option instance, without graphic and with default editor, based on the values set for the option
DefaultOption(java.lang.String caption, java.lang.String description, java.lang.String category, T value, boolean isEditable, java.util.function.Function<Option<T>,OptionEditor<T>> editorFactory)	Creates an option instance, without graphic and with custom editor, based on the values set for the option
DefaultOption(javafx.scene.Node graphic, java.lang.String caption, java.lang.String description, java.lang.String category)	Creates an option instance, with graphic and without editor, intended to open a new view with a new group of sub-options, that are set calling Option.getChildren()
DefaultOption(javafx.scene.Node graphic, java.lang.String caption, java.lang.String description, java.lang.String category, T value, boolean isEditable)	Creates an option instance, with graphic and with default editor, based on the values set for the option
DefaultOption(javafx.scene.Node graphic, java.lang.String caption, java.lang.String description, java.lang.String category, T value, boolean isEditable, java.util.function.Function<Option<T>,OptionEditor<T>> editorFactory)	Creates an option instance, with graphic and with custom editor, based on the values set for the option

Method Summary

Modifier and Type	Method	Description
javafx.beans.property.Property<T>	valueProperty()	Returns the underlying Property, where one exists, that the editor can monitor for changes.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from class com.gluonhq.charm.glisten.control.settings.OptionBase

editorFactoryProperty, getCaption, getCategory, getChildren, getDescription, getExtendedDescription, getGraphic, getId, getLayout, getStringConverter, idProperty, isEditable, setExtendedDescription, setId, setLayout, setStringConverter, valueProperty

Property Detail

value

public javafx.beans.property.Property<T> valueProperty

Returns the underlying Property, where one exists, that the editor can monitor for changes.

Specified by:

valueProperty in interface Option<T>

Specified by:

valueProperty in class OptionBase<T>

Returns:

a Property of type T

Constructor Detail

DefaultOption

public DefaultOption(java.lang.String caption)

Creates an option instance, without graphic and without editor. Using the caption Option.SEPARATOR will create a Separator. Otherwise it will create an empty option

Parameters:

caption - a String, usually Option.SEPARATOR

DefaultOption

public DefaultOption(java.lang.String caption,
                     java.lang.String description,
                     java.lang.String category)

Creates an option instance, without graphic and without editor, intended to open a new view with a new group of sub-options, that are set calling Option.getChildren()

Parameters:

caption - a String a short name

description - a String more descriptive

category - a String indicating the category, in case the option belongs to a group

DefaultOption

public DefaultOption(javafx.scene.Node graphic,
                     java.lang.String caption,
                     java.lang.String description,
                     java.lang.String category)

Creates an option instance, with graphic and without editor, intended to open a new view with a new group of sub-options, that are set calling Option.getChildren()

Parameters:

graphic - a Node with a graphic

caption - a String a short name

description - a String more descriptive

category - a String indicating the category, in case the option belongs to a group

DefaultOption

public DefaultOption(java.lang.String caption,
                     java.lang.String description,
                     java.lang.String category,
                     T value,
                     boolean isEditable)

Creates an option instance, without graphic and with default editor, based on the values set for the option

Parameters:

caption - a String a short name

description - a String more descriptive

category - a String indicating the category, in case the option belongs to a group

value - the underlying Property that the editor can monitor for changes

isEditable - if the option is editable or read-only

DefaultOption

public DefaultOption(java.lang.String caption,
                     java.lang.String description,
                     java.lang.String category,
                     T value,
                     boolean isEditable,
                     java.util.function.Function<Option<T>,OptionEditor<T>> editorFactory)

Creates an option instance, without graphic and with custom editor, based on the values set for the option

Parameters:

caption - a String a short name

description - a String more descriptive

category - a String indicating the category, in case the option belongs to a group

value - the underlying Property that the editor can monitor for changes

isEditable - if the option is editable or read-only

editorFactory - a Function that returns a valid OptionEditor for editing this Option

DefaultOption

public DefaultOption(javafx.scene.Node graphic,
                     java.lang.String caption,
                     java.lang.String description,
                     java.lang.String category,
                     T value,
                     boolean isEditable)

Creates an option instance, with graphic and with default editor, based on the values set for the option

Parameters:

graphic - a Node with a graphic

caption - a String a short name

description - a String more descriptive

category - a String indicating the category, in case the option belongs to a group

value - the underlying Property that the editor can monitor for changes

isEditable - if the option is editable or read-only

DefaultOption

public DefaultOption(javafx.scene.Node graphic,
                     java.lang.String caption,
                     java.lang.String description,
                     java.lang.String category,
                     T value,
                     boolean isEditable,
                     java.util.function.Function<Option<T>,OptionEditor<T>> editorFactory)

Creates an option instance, with graphic and with custom editor, based on the values set for the option

Parameters:

graphic - a Node with a graphic

caption - a String a short name

description - a String more descriptive

category - a String indicating the category, in case the option belongs to a group

value - the underlying Property that the editor can monitor for changes

isEditable - if the option is editable or read-only

editorFactory - a Function that returns a valid OptionEditor for editing this Option

Method Detail

valueProperty

public javafx.beans.property.Property<T> valueProperty()

Returns the underlying Property, where one exists, that the editor can monitor for changes.

Specified by:

valueProperty in interface Option<T>

Specified by:

valueProperty in class OptionBase<T>

Returns:

a Property of type T