org.controlsfx.control

Interface PropertySheet.Item

All Known Implementing Classes:

BeanProperty

Enclosing class:

PropertySheet

public static interface PropertySheet.Item

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
String	getCategory() Returns a String representation of the category of the property.
String	getDescription() A String that will be shown to the user as a tooltip.
String	getName() Returns the display name of the property, which should be short (i.e.
Class<?>	getType() Returns the class type of the property.
Object	getValue() Returns the current value of the property.
void	setValue(Object value) Sets the current value of the property.

Method Detail

getType

Class<?> getType()

Returns the class type of the property.

getCategory

String getCategory()

Returns a String representation of the category of the property. This is relevant when the PropertySheet mode property is set to PropertySheet.Mode.CATEGORY - as then all properties with the same category will be grouped together visually.

getName

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().

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 getName() method.

getValue

Object getValue()

Returns the current value of the property.

setValue

void setValue(Object value)

Sets the current value of the property.