Package org.codefx.libfx.control.properties

Makes using a Control's propertyMap more convenient.

See: Description

Interface Summary

Interface	Description
ControlPropertyListenerHandle	This is a handle on a ControlPropertyListener, which can be used to ControlPropertyListenerHandle.attach() and ControlPropertyListenerHandle.detach() it.

Class Summary

Class	Description
ControlProperties	Gives access to a ControlPropertyListenerBuilder.
ControlPropertyListenerBuilder<T>	A builder for a ControlPropertyListener.

Package org.codefx.libfx.control.properties Description

Makes using a Control's propertyMap more convenient.

As such its main use will be to creators of controls.

Listening to the Property Map

In order to use the property map, a control has to create a listener which does these things:

• identify the correct key
• check whether the value is of the correct type and cast it
• process the value
• remove the value so when the same value is added again, the listener notices that

While implementing such a listener is not difficult, some details have to be considered. This makes the code a little lengthy and hinders readability while at the same time repeating the same pattern over and over.

ControlPropertyListener

This package provides usability functions to create such a listener in a concise and readable way (this code would be inside a control):

 ControlProperties.on(getProperties())
        .forKey("SomeKey")
        .processValue(valueString -> System.out.println(valueString))
        .buildAndAttach();
 

It returns an instance of ControlPropertyListenerHandle which can be used to easily detach and reattach the listener.

See Also:

ControlPropertyListener, ControlPropertyListenerBuilder