org.controlsfx.property

Class BeanProperty

java.lang.Object

org.controlsfx.property.BeanProperty

All Implemented Interfaces:

PropertySheet.Item

public class BeanProperty
extends Object
implements PropertySheet.Item

A convenience class for creating a PropertySheet.Item for use in the PropertySheet control based on a property belonging to a JavaBean - simply provide a PropertyDescriptor and the rest will be taken care of automatically.

See Also:

PropertySheet.Item, PropertySheet, PropertyDescriptor

Constructor Summary

Constructors

Constructor and Description
BeanProperty(Object bean, PropertyDescriptor propertyDescriptor)

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.

Methods inherited from class java.lang.Object

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

Constructor Detail

BeanProperty

public BeanProperty(Object bean,
                    PropertyDescriptor propertyDescriptor)

Method Detail

getName

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 PropertySheet.Item.getDescription().

Specified by:

getName in interface PropertySheet.Item

getDescription

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

Specified by:

getDescription in interface PropertySheet.Item

getType

public Class<?> getType()

Returns the class type of the property.

Specified by:

getType in interface PropertySheet.Item

getValue

public Object getValue()

Returns the current value of the property.

Specified by:

getValue in interface PropertySheet.Item

setValue

public void setValue(Object value)

Sets the current value of the property.

Specified by:

setValue in interface PropertySheet.Item

getCategory

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

Specified by:

getCategory in interface PropertySheet.Item