Interface Option<T>

  • 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 Detail

      • value

        Property<T> valueProperty
        Returns the underlying Property, where one exists, that the editor can monitor for changes.
    • 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