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

Class OptionBase<T>

java.lang.Object

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

Type Parameters:

T - The type of the property of the OptionBase value

All Implemented Interfaces:

Option<T>

Direct Known Subclasses:

DefaultOption

public abstract class OptionBase<T>
extends java.lang.Object
implements Option<T>

A wrapper interface for a single option to be displayed in a SettingsPane control.

Typically it contains:

• An optional graphic icon on the left
• A caption
• By default, an editor for viewing and modifying the Property associated to this Option

But this can be modified:

• If getExtendedDescription() returns a non empty extended description, the editor and this description will be shown in a secondary View
• If getChildren() is not empty, the observable list of options will be shown in a secondary View

Since:

2.0.0

Property Summary

Properties

Type	Property	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.StringProperty	id	The id of this Option.
abstract javafx.beans.property.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
protected java.lang.String	caption	Private fields
protected java.lang.String	category
protected javafx.collections.ObservableList<Option>	children
protected java.lang.String	description
protected java.util.function.Function<Option<T>,OptionEditor<T>>	editorFactory
protected java.lang.String	extendedDescription
protected javafx.scene.Node	graphic
protected boolean	isEditable
protected javafx.geometry.Orientation	layout
protected javafx.util.StringConverter<T>	stringConverter
protected javafx.beans.property.Property<T>	value

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

SEPARATOR

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	OptionBase(java.lang.String caption)	Creates an option instance, without graphic and without editor.
protected	OptionBase(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()
protected	OptionBase(java.lang.String caption, java.lang.String description, java.lang.String category, javafx.beans.property.Property<T> value, boolean isEditable)	Creates an option instance, without graphic and with default editor, based on the values set for the option
protected	OptionBase(java.lang.String caption, java.lang.String description, java.lang.String category, javafx.beans.property.Property<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
protected	OptionBase(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()
protected	OptionBase(javafx.scene.Node graphic, java.lang.String caption, java.lang.String description, java.lang.String category, javafx.beans.property.Property<T> value, boolean isEditable)	Creates an option instance, with graphic and with default editor, based on the values set for the option
protected	OptionBase(javafx.scene.Node graphic, java.lang.String caption, java.lang.String description, java.lang.String category, javafx.beans.property.Property<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
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
java.lang.String	getId()	Gets the value of the property id.
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
javafx.beans.property.StringProperty	idProperty()	The id of this Option.
boolean	isEditable()	Indicates whether the SettingsPane control should allow editing this option, or whether it is read-only.
void	setExtendedDescription(java.lang.String value)	Sets the long String description that will be shown to the user in an extended View
void	setId(java.lang.String id)	Sets the value of the property id.
void	setLayout(javafx.geometry.Orientation layout)	Defines the type of layout to apply to the Option
void	setStringConverter(javafx.util.StringConverter value)	Sets the StringConverter that can be applied to the used to convert the value of the underlaying Property of this option
abstract javafx.beans.property.Property<T>	valueProperty()	Returns the underlying Property, where one exists, that the editor can monitor for changes.
static <T> javafx.beans.property.Property<T>	valueProperty(T value)	Allows wrapping primitives into a read-only Property

Methods inherited from class java.lang.Object

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

Property Detail

value

public abstract 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>

editorFactory

public 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

Specified by:

editorFactoryProperty in interface Option<T>

id

public final javafx.beans.property.StringProperty idProperty

The id of this Option. This simple string identifier is useful for finding a specific Option within the scene graph. While the id of a Option should be unique within the scene graph, this uniqueness is not enforced. This is analogous to the "id" attribute on an HTML element (CSS ID Specification).

For example, if a Option is given the id of "myId", then the lookup method can be used to find this option as follows: scene.lookup("#myId");.

Default value:

null

Since:

4.2.0

See Also:

getId(), setId(String)

Field Detail

caption

protected java.lang.String caption

Private fields

description

protected java.lang.String description

category

protected java.lang.String category

graphic

protected javafx.scene.Node graphic

value

protected javafx.beans.property.Property<T> value

isEditable

protected boolean isEditable

editorFactory

protected java.util.function.Function<Option<T>,OptionEditor<T>> editorFactory

extendedDescription

protected java.lang.String extendedDescription

children

protected javafx.collections.ObservableList<Option> children

stringConverter

protected javafx.util.StringConverter<T> stringConverter

layout

protected javafx.geometry.Orientation layout

Constructor Detail

OptionBase

protected OptionBase(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

OptionBase

protected OptionBase(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

OptionBase

protected OptionBase(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

OptionBase

protected OptionBase(java.lang.String caption,
                     java.lang.String description,
                     java.lang.String category,
                     javafx.beans.property.Property<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

OptionBase

protected OptionBase(java.lang.String caption,
                     java.lang.String description,
                     java.lang.String category,
                     javafx.beans.property.Property<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

OptionBase

protected OptionBase(javafx.scene.Node graphic,
                     java.lang.String caption,
                     java.lang.String description,
                     java.lang.String category,
                     javafx.beans.property.Property<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

OptionBase

protected OptionBase(javafx.scene.Node graphic,
                     java.lang.String caption,
                     java.lang.String description,
                     java.lang.String category,
                     javafx.beans.property.Property<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

getGraphic

public 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

Specified by:

getGraphic in interface Option<T>

Returns:

Optional with a Node if not empty

getCaption

public java.lang.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.

Specified by:

getCaption in interface Option<T>

Returns:

String with the name or caption of the Option

getDescription

public java.lang.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 Option.getCaption() method.

Specified by:

getDescription in interface Option<T>

Returns:

String with the description of the Option

getExtendedDescription

public java.util.Optional<java.lang.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 Option.getCaption() method.

Specified by:

getExtendedDescription in interface Option<T>

Returns:

String with an extended description of the Option if not empty

setExtendedDescription

public void setExtendedDescription(java.lang.String value)

Sets the long String description that will be shown to the user in an extended View

Parameters:

value - a String with a long description

getCategory

public java.lang.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.

Specified by:

getCategory in interface Option<T>

Returns:

String with the category of the Option

valueProperty

public abstract 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>

editorFactoryProperty

public 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

Specified by:

editorFactoryProperty in interface Option<T>

isEditable

public boolean isEditable()

Indicates whether the SettingsPane control should allow editing this option, or whether it is read-only.

Specified by:

isEditable in interface Option<T>

Returns:

boolean if the control is editable or not

getChildren

public javafx.collections.ObservableList<Option> getChildren()

Returns the ObservableList of sub-options that a given option contains.

Specified by:

getChildren in interface Option<T>

Returns:

ObservableList with options

setStringConverter

public void setStringConverter(javafx.util.StringConverter value)

Sets the StringConverter that can be applied to the used to convert the value of the underlaying Property of this option

Parameters:

value - the StringConverter

getStringConverter

public java.util.Optional<javafx.util.StringConverter<T>> getStringConverter()

Returns an Optional of a StringConverter that can be applied to the value

Specified by:

getStringConverter in interface Option<T>

Returns:

Optional with a StringConverter if not empty

valueProperty

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

Allows wrapping primitives into a read-only Property

Type Parameters:

T - The primitive type

Parameters:

value - The value to be set

Returns:

the wrapper read-only Property

getLayout

public 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.
• Orientation.VERTICAL sets a vertical layout, with an optional graphic on the left, caption on top and editor on bottom.

Default is Orientation.HORIZONTAL

Specified by:

getLayout in interface Option<T>

Returns:

Orientation that indicates the layout of the Option

setLayout

public void setLayout(javafx.geometry.Orientation layout)

Defines the type of layout to apply to the Option

Parameters:

layout - the Orientation type

idProperty

public final javafx.beans.property.StringProperty idProperty()

The id of this Option. This simple string identifier is useful for finding a specific Option within the scene graph. While the id of a Option should be unique within the scene graph, this uniqueness is not enforced. This is analogous to the "id" attribute on an HTML element (CSS ID Specification).

For example, if a Option is given the id of "myId", then the lookup method can be used to find this option as follows: scene.lookup("#myId");.

Default value:

null

Since:

4.2.0

See Also:

getId(), setId(String)

setId

public final void setId(java.lang.String id)

Sets the value of the property id.

Property description:

The id of this Option. This simple string identifier is useful for finding a specific Option within the scene graph. While the id of a Option should be unique within the scene graph, this uniqueness is not enforced. This is analogous to the "id" attribute on an HTML element (CSS ID Specification).

For example, if a Option is given the id of "myId", then the lookup method can be used to find this option as follows: scene.lookup("#myId");.

Default value:

null

Since:

4.2.0

getId

public final java.lang.String getId()

Gets the value of the property id.

Property description:

The id of this Option. This simple string identifier is useful for finding a specific Option within the scene graph. While the id of a Option should be unique within the scene graph, this uniqueness is not enforced. This is analogous to the "id" attribute on an HTML element (CSS ID Specification).

For example, if a Option is given the id of "myId", then the lookup method can be used to find this option as follows: scene.lookup("#myId");.

Default value:

null

Since:

4.2.0