Modifier and Type	Class and Description
public static interface	PropertySheet.Item A wrapper interface for a single property to be displayed in a `PropertySheet` control.
public static enum	PropertySheet.Mode Specifies how the `PropertySheet` should be laid out.

Modifier and Type	Field and Description
private final SimpleObjectProperty<Comparator<String>>	categoryComparatorProperty
private static final String	DEFAULT_STYLE_CLASS * Stylesheet Handling * *
private final ObservableList<PropertySheet.Item>	items Private fields
private final SimpleObjectProperty<PropertySheet.Mode>	modeProperty Properties
private final SimpleBooleanProperty	modeSwitcherVisible
private final SimpleObjectProperty<Callback<PropertySheet.Item, PropertyEditor<?>>>	propertyEditorFactory
private final SimpleBooleanProperty	searchBoxVisible
private final SimpleStringProperty	titleFilterProperty

Access	Constructor and Description
public	PropertySheet() Creates a default PropertySheet instance with no properties to edit.
public	PropertySheet(ObservableList<PropertySheet.Item> The items that should appear within the PropertySheet. items) Creates a PropertySheet instance prepopulated with the items provided in the items `ObservableList`.

Method Summary

Modifier and Type	Method and Description
public final SimpleObjectProperty<Comparator<String>>	Returns: A SimpleObjectproperty. categoryComparatorProperty() Used to represent how the categories should be laid out in the PropertySheet when using the Category mode (see `Mode`).
protected Skin<?>	createDefaultSkin() Overrides javafx.scene.control.Control.createDefaultSkin. Create a new instance of the default skin for this control.
public final Comparator<String>	getCategoryComparator() Returns: how the categories should be laid out in the PropertySheet.
public ObservableList<PropertySheet.Item>	getItems() Returns: An ObservableList of properties that will be displayed to the user to allow for them to be edited.
public final PropertySheet.Mode	getMode() Returns: how the properties should be laid out in the PropertySheet.
public final Callback<PropertySheet.Item, PropertyEditor<?>>	getPropertyEditorFactory() Returns: The editor factory used by the PropertySheet to determine which `PropertyEditor` to use for a given `Item`.
public final String	getTitleFilter() Returns: the filter for filtering the options shown on screen
public String	getUserAgentStylesheet() Overrides javafx.scene.layout.Region.getUserAgentStylesheet. An implementation may specify its own user-agent styles for this Region, and its children, by overriding this method.
public final boolean	isModeSwitcherVisible() Returns: whether a visual option is presented to users to switch between the various `modes` available.
public final boolean	isSearchBoxVisible() Returns: whether a text field should be presented to users to allow for them to filter the properties in the property sheet to only show ones matching the typed input.
public final SimpleObjectProperty<PropertySheet.Mode>	Returns: A SimpleObjectproperty. modeProperty() Used to represent how the properties should be laid out in the PropertySheet.
public final SimpleBooleanProperty	Returns: A SimpleBooleanproperty. modeSwitcherVisibleProperty() This property represents whether a visual option should be presented to users to switch between the various `modes` available.
public final SimpleObjectProperty<Callback<PropertySheet.Item, PropertyEditor<?>>>	Returns: A SimpleObjectproperty. propertyEditorFactory() The property editor factory is used by the PropertySheet to determine which `PropertyEditor` to use for a given `Item`.
public final SimpleBooleanProperty	Returns: A SimpleBooleanProperty. searchBoxVisibleProperty() This property represents whether a text field should be presented to users to allow for them to filter the properties in the property sheet to only show ones matching the typed input.
public final void	setCategoryComparator(Comparator<String> categoryComparator) Set how the categories should be laid out in the PropertySheet.
public final void	setMode(PropertySheet.Mode mode) Set how the properties should be laid out in the PropertySheet.
public final void	setModeSwitcherVisible(boolean visible) Set whether a visual option should be presented to users to switch between the various `modes` available.
public final void	setPropertyEditorFactory(Callback<PropertySheet.Item, PropertyEditor<?>> factory) Sets a new editor factory used by the PropertySheet to determine which `PropertyEditor` to use for a given `Item`.
public final void	setSearchBoxVisible(boolean visible) Sets whether a text field should be presented to users to allow for them to filter the properties in the property sheet to only show ones matching the typed input.
public final void	setTitleFilter(String filter) Sets the filter for filtering the options shown on screen.
public final SimpleStringProperty	Returns: A SimpleStringProperty. titleFilter() Regardless of whether the `search box` is visible or not, it is possible to filter the options shown on screen using this title filter property.

Inherited from org.controlsfx.control.ControlsFXControl:: getUserAgentStylesheet

Field Detail

categoryComparatorProperty	back to summary
private final SimpleObjectProperty<Comparator<String>> categoryComparatorProperty

DEFAULT_STYLE_CLASS	back to summary
private static final String DEFAULT_STYLE_CLASS * Stylesheet Handling * *

items	back to summary
private final ObservableList<PropertySheet.Item> items Private fields

modeProperty	back to summary
private final SimpleObjectProperty<PropertySheet.Mode> modeProperty Properties

modeSwitcherVisible	back to summary
private final SimpleBooleanProperty modeSwitcherVisible

propertyEditorFactory	back to summary
private final SimpleObjectProperty<Callback<PropertySheet.Item, PropertyEditor<?>>> propertyEditorFactory

searchBoxVisible	back to summary
private final SimpleBooleanProperty searchBoxVisible

titleFilterProperty	back to summary
private final SimpleStringProperty titleFilterProperty

Constructor Detail

PropertySheet	back to summary
public PropertySheet() Creates a default PropertySheet instance with no properties to edit.

PropertySheet back to summary

PropertySheet	back to summary
public PropertySheet(ObservableList<PropertySheet.Item> items) Creates a PropertySheet instance prepopulated with the items provided in the items `ObservableList`. Parameters items:ObservableList<PropertySheet.Item> The items that should appear within the PropertySheet.

public PropertySheet(ObservableList<PropertySheet.Item> items)

Creates a PropertySheet instance prepopulated with the items provided in the items ObservableList.

Parameters

items:ObservableList<PropertySheet.Item>: The items that should appear within the PropertySheet.

Method Detail

categoryComparatorProperty back to summary

categoryComparatorProperty	back to summary
public final SimpleObjectProperty<Comparator<String>> categoryComparatorProperty() Used to represent how the categories should be laid out in the PropertySheet when using the Category mode (see `Mode`). Thus allowing user to sort categories by other ways than alphabetical or numerical order. Returns:SimpleObjectProperty<Comparator<String>> A SimpleObjectproperty.

public final SimpleObjectProperty<Comparator<String>> categoryComparatorProperty()

Used to represent how the categories should be laid out in the PropertySheet when using the Category mode (see Mode). Thus allowing user to sort categories by other ways than alphabetical or numerical order.

Returns:SimpleObjectProperty<Comparator<String>>: A SimpleObjectproperty.

createDefaultSkin back to summary

createDefaultSkin	back to summary
protected Skin<?> createDefaultSkin() Overrides javafx.scene.control.Control.createDefaultSkin. Doc from javafx.scene.control.Control.createDefaultSkin. Create a new instance of the default skin for this control. This is called to create a skin for the control if no skin is provided via CSS `-fx-skin` or set explicitly in a sub-class with `setSkin(...)`. Annotations @Override

protected Skin<?> createDefaultSkin()

Overrides javafx.scene.control.Control.createDefaultSkin.

Doc from javafx.scene.control.Control.createDefaultSkin.

Create a new instance of the default skin for this control. This is called to create a skin for the control if no skin is provided via CSS -fx-skin or set explicitly in a sub-class with setSkin(...).

Annotations

@Override

getCategoryComparator	back to summary
public final Comparator<String> getCategoryComparator() Returns:Comparator<String> how the categories should be laid out in the PropertySheet. See Also `Mode`

getItems	back to summary
public ObservableList<PropertySheet.Item> getItems() Returns:ObservableList<PropertySheet.Item> An ObservableList of properties that will be displayed to the user to allow for them to be edited.

getMode	back to summary
public final PropertySheet.Mode getMode() Returns:PropertySheet.Mode how the properties should be laid out in the PropertySheet. See Also `Mode`

getPropertyEditorFactory	back to summary
public final Callback<PropertySheet.Item, PropertyEditor<?>> getPropertyEditorFactory() Returns:Callback<PropertySheet.Item, PropertyEditor<?>> The editor factory used by the PropertySheet to determine which `PropertyEditor` to use for a given `Item`.

getTitleFilter	back to summary
public final String getTitleFilter() Returns:String the filter for filtering the options shown on screen See Also `titleFilter()`

getUserAgentStylesheet back to summary

getUserAgentStylesheet	back to summary
public String getUserAgentStylesheet() Overrides javafx.scene.layout.Region.getUserAgentStylesheet. Doc from javafx.scene.layout.Region.getUserAgentStylesheet. An implementation may specify its own user-agent styles for this Region, and its children, by overriding this method. These styles are used in addition to whatever user-agent stylesheets are in use. This provides a mechanism for third parties to introduce styles for custom controls. The URL is a hierarchical URI of the form [scheme:][//authority][path]. If the URL does not have a [scheme:] component, the URL is considered to be the [path] component only. Any leading '/' character of the [path] is ignored and the [path] is treated as a path relative to the root of the application's classpath. Subclasses overriding this method should not assume any particular implementation approach as to the number and frequency with which it is called. For this reason, attempting any kind of dynamic implementation (i.e. returning different user agent stylesheet values) based on some state change is highly discouraged, as there is no guarantee when, or even if, this method will be called. Some JavaFX CSS implementations may choose to cache this response for an indefinite period of time, and therefore there should be no expectation around when this method is called. `package com.example.javafx.app; import javafx.application.Application; import javafx.scene.Group; import javafx.scene.Scene; import javafx.stage.Stage; public class MyApp extends Application { @Override public void start(Stage stage) { Scene scene = new Scene(new Group()); scene.getStylesheets().add("/com/example/javafx/app/mystyles.css"); stage.setScene(scene); stage.show(); } public static void main(String[] args) { launch(args); } }` For additional information about using CSS with the scene graph, see the CSS Reference Guide. Annotations @Override

public String getUserAgentStylesheet()

Overrides javafx.scene.layout.Region.getUserAgentStylesheet.

Doc from javafx.scene.layout.Region.getUserAgentStylesheet.

An implementation may specify its own user-agent styles for this Region, and its children, by overriding this method. These styles are used in addition to whatever user-agent stylesheets are in use. This provides a mechanism for third parties to introduce styles for custom controls.

The URL is a hierarchical URI of the form [scheme:][//authority][path]. If the URL does not have a [scheme:] component, the URL is considered to be the [path] component only. Any leading '/' character of the [path] is ignored and the [path] is treated as a path relative to the root of the application's classpath.

Subclasses overriding this method should not assume any particular implementation approach as to the number and frequency with which it is called. For this reason, attempting any kind of dynamic implementation (i.e. returning different user agent stylesheet values) based on some state change is highly discouraged, as there is no guarantee when, or even if, this method will be called. Some JavaFX CSS implementations may choose to cache this response for an indefinite period of time, and therefore there should be no expectation around when this method is called.



package com.example.javafx.app;

import javafx.application.Application;
import javafx.scene.Group;
import javafx.scene.Scene;
import javafx.stage.Stage;

public class MyApp extends Application {

    @Override public void start(Stage stage) {
        Scene scene = new Scene(new Group());
        scene.getStylesheets().add("/com/example/javafx/app/mystyles.css");
        stage.setScene(scene);
        stage.show();
    }

    public static void main(String[] args) {
        launch(args);
    }
}

For additional information about using CSS with the scene graph, see the CSS Reference Guide.

Annotations

@Override

isModeSwitcherVisible	back to summary
public final boolean isModeSwitcherVisible() Returns:boolean whether a visual option is presented to users to switch between the various `modes` available.

isSearchBoxVisible	back to summary
public final boolean isSearchBoxVisible() Returns:boolean whether a text field should be presented to users to allow for them to filter the properties in the property sheet to only show ones matching the typed input.

modeProperty back to summary

modeProperty	back to summary
public final SimpleObjectProperty<PropertySheet.Mode> modeProperty() Used to represent how the properties should be laid out in the PropertySheet. Refer to the `Mode` enumeration to better understand the available options. Returns:SimpleObjectProperty<PropertySheet.Mode> A SimpleObjectproperty.

public final SimpleObjectProperty<PropertySheet.Mode> modeProperty()

Used to represent how the properties should be laid out in the PropertySheet. Refer to the Mode enumeration to better understand the available options.

Returns:SimpleObjectProperty<PropertySheet.Mode>: A SimpleObjectproperty.

modeSwitcherVisibleProperty back to summary

modeSwitcherVisibleProperty	back to summary
public final SimpleBooleanProperty modeSwitcherVisibleProperty() This property represents whether a visual option should be presented to users to switch between the various `modes` available. By default this is true, so setting it to false will hide these buttons. Returns:SimpleBooleanProperty A SimpleBooleanproperty.

public final SimpleBooleanProperty modeSwitcherVisibleProperty()

This property represents whether a visual option should be presented to users to switch between the various modes available. By default this is true, so setting it to false will hide these buttons.

Returns:SimpleBooleanProperty: A SimpleBooleanproperty.

propertyEditorFactory back to summary

propertyEditorFactory	back to summary
public final SimpleObjectProperty<Callback<PropertySheet.Item, PropertyEditor<?>>> propertyEditorFactory() The property editor factory is used by the PropertySheet to determine which `PropertyEditor` to use for a given `Item`. By default the `DefaultPropertyEditorFactory` is used, but this may be replaced or extended by developers wishing to add in (or substitute) their own property editors. Returns:SimpleObjectProperty<Callback<PropertySheet.Item, PropertyEditor<?>>> A SimpleObjectproperty.

public final SimpleObjectProperty<Callback<PropertySheet.Item, PropertyEditor<?>>> propertyEditorFactory()

The property editor factory is used by the PropertySheet to determine which PropertyEditor to use for a given Item. By default the DefaultPropertyEditorFactory is used, but this may be replaced or extended by developers wishing to add in (or substitute) their own property editors.

Returns:SimpleObjectProperty<Callback<PropertySheet.Item, PropertyEditor<?>>>: A SimpleObjectproperty.

searchBoxVisibleProperty	back to summary
public final SimpleBooleanProperty searchBoxVisibleProperty() This property represents whether a text field should be presented to users to allow for them to filter the properties in the property sheet to only show ones matching the typed input. By default this is true, so setting it to false will hide this search field. Returns:SimpleBooleanProperty A SimpleBooleanProperty.

searchBoxVisibleProperty

back to summary

public final SimpleBooleanProperty searchBoxVisibleProperty()

This property represents whether a text field should be presented to users to allow for them to filter the properties in the property sheet to only show ones matching the typed input. By default this is true, so setting it to false will hide this search field.

Returns:SimpleBooleanProperty: A SimpleBooleanProperty.

setCategoryComparator	back to summary
public final void setCategoryComparator(Comparator<String> categoryComparator) Set how the categories should be laid out in the PropertySheet.

setMode	back to summary
public final void setMode(PropertySheet.Mode mode) Set how the properties should be laid out in the PropertySheet.

setModeSwitcherVisible	back to summary
public final void setModeSwitcherVisible(boolean visible) Set whether a visual option should be presented to users to switch between the various `modes` available.

setPropertyEditorFactory	back to summary
public final void setPropertyEditorFactory(Callback<PropertySheet.Item, PropertyEditor<?>> factory) Sets a new editor factory used by the PropertySheet to determine which `PropertyEditor` to use for a given `Item`.

setSearchBoxVisible	back to summary
public final void setSearchBoxVisible(boolean visible) Sets whether a text field should be presented to users to allow for them to filter the properties in the property sheet to only show ones matching the typed input.

setTitleFilter back to summary

setTitleFilter	back to summary
public final void setTitleFilter(String filter) Sets the filter for filtering the options shown on screen. See Also `titleFilter()`

public final void setTitleFilter(String filter)

Sets the filter for filtering the options shown on screen.

See Also: titleFilter()

titleFilter back to summary

titleFilter	back to summary
public final SimpleStringProperty titleFilter() Regardless of whether the `search box` is visible or not, it is possible to filter the options shown on screen using this title filter property. If the search box is visible, it will manipulate this property to contain whatever the user types. Returns:SimpleStringProperty A SimpleStringProperty.

public final SimpleStringProperty titleFilter()

Regardless of whether the search box is visible or not, it is possible to filter the options shown on screen using this title filter property. If the search box is visible, it will manipulate this property to contain whatever the user types.

Returns:SimpleStringProperty: A SimpleStringProperty.

org.controlsfx.control back to summary

public Interface PropertySheet.Item

Known Direct Implementers: org.controlsfx.property.BeanProperty

A wrapper interface for a single property to be displayed in a PropertySheet control.

See Also: PropertySheet

Method Summary

Modifier and Type	Method and Description
public String	getCategory() Returns a String representation of the category of the property.
public String	getDescription() A String that will be shown to the user as a tooltip.
public String	getName() Returns the display name of the property, which should be short (i.e. less than two words).
public Optional<ObservableValue<? extends Object>>	getObservableValue() Returns the underlying ObservableValue, where one exists, that the editor can monitor for changes.
public default Optional<Class<? extends PropertyEditor<?>>>	getPropertyEditorClass() Returns an Optional wrapping the class of the PropertyEditor that should be used for editing this item.
public Class<?>	getType() Returns the class type of the property.
public Object	getValue() Returns the current value of the property.
public default boolean	isEditable() Indicates whether the PropertySheet should allow editing of this property, or whether it is read-only.
public void	setValue(Object value) Sets the current value of the property.

Method Detail

getCategory	back to summary
public String getCategory() Returns a String representation of the category of the property. This is relevant when the `PropertySheet` `mode property` is set to `Mode#CATEGORY` - as then all properties with the same category will be grouped together visually.

getDescription	back to summary
public 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 `getName()` method.

getName	back to summary
public String getName() Returns the display name of the property, which should be short (i.e. less than two words). This is used to explain to the end user what the property represents and is displayed beside the `PropertyEditor`. If you need to explain more detail to the user, consider placing it in the `getDescription()`.

getObservableValue	back to summary
public Optional<ObservableValue<? extends Object>> getObservableValue() Returns the underlying ObservableValue, where one exists, that the editor can monitor for changes.

getPropertyEditorClass	back to summary
public default Optional<Class<? extends PropertyEditor<?>>> getPropertyEditorClass() Returns an Optional wrapping the class of the PropertyEditor that should be used for editing this item. The default implementation returns Optional.empty() The class must have a constructor that can accept a single argument of type PropertySheet.Item

getType	back to summary
public Class<?> getType() Returns the class type of the property.

getValue	back to summary
public Object getValue() Returns the current value of the property.

isEditable	back to summary
public default boolean isEditable() Indicates whether the PropertySheet should allow editing of this property, or whether it is read-only. The default implementation returns true.

setValue	back to summary
public void setValue(Object value) Sets the current value of the property.

org.controlsfx.control back to summary

public final Enum PropertySheet.Mode

Class Inheritance

extends Enum<PropertySheet.Mode>

java.lang.Object
java.lang.Enum
org.controlsfx.control.PropertySheet.Mode

Specifies how the PropertySheet should be laid out. Refer to the enumeration values to learn what each one means.

Field Summary

Modifier and Type	Field and Description
public static final PropertySheet.Mode	CATEGORY Groups the properties in the `items list` based on their `category`.
public static final PropertySheet.Mode	NAME Simply displays the properties in the `items list` in the order they are in the list.

Constructor Summary

Access	Constructor and Description
private	Mode()

Method Summary

Modifier and Type	Method and Description
public static PropertySheet.Mode	valueOf(String name)
public static PropertySheet.Mode[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

CATEGORY	back to summary
public static final PropertySheet.Mode CATEGORY Groups the properties in the `items list` based on their `category`.

NAME	back to summary
public static final PropertySheet.Mode NAME Simply displays the properties in the `items list` in the order they are in the list.

Constructor Detail

Mode	back to summary
private Mode()

Method Detail

valueOf	back to summary
public static PropertySheet.Mode valueOf(String name)

values	back to summary
public static PropertySheet.Mode[] values()

public Class PropertySheet

Working with JavaBeans

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Interface PropertySheet.Item

Method Summary

Method Detail

public final Enum PropertySheet.Mode

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail