com.dukescript.api.javafx.beans

Class FXBeanInfo

java.lang.Object

com.dukescript.api.javafx.beans.FXBeanInfo

public final class FXBeanInfo
extends Object

Data with information about properties and actions of a JavaFX bean. Beans supporting this protocol should implement FXBeanInfo.Provider - use its FXBeanInfo.Provider.getFXBeanInfo() method to obtain instance of the info for given bean.

If you have a bean willing to provide the info, use FXBeanInfo.newBuilder(java.lang.Object) and FXBeanInfo.Builder to create it. Then return it from your FXBeanInfo.Provider.getFXBeanInfo() method. Here is an example defining one string property and one action:

public class HTMLController implements FXBeanInfo.Provider {
    private final StringProperty labelText =
            new SimpleStringProperty(this, "labelText", "");
    
    private void handleButtonAction(ActionEvent event) {
        System.out.println("You clicked me!");
        labelText.set("Hello World!");
    }

    private final FXBeanInfo info = FXBeanInfo
            .newBuilder(this)
            .action("action", this::handleButtonAction)
            .property(labelText)
            .build();
    
    @Override
    public FXBeanInfo getFXBeanInfo() {
        return info;
    }
}

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	FXBeanInfo.Builder Builder (obtained via FXBeanInfo.newBuilder(java.lang.Object) method) to create a description of a JavaFX bean and represent it as FXBeanInfo.
static interface	FXBeanInfo.Generate Generate FXBeanInfo.Provider and its FXBeanInfo rather than constructing it manually.
static interface	FXBeanInfo.Provider Single method interface for JavaFX beans that can provide FXBeanInfo.

Method Summary

Modifier and Type	Method and Description
Map<String,EventHandlerProperty>	getActions() EventHandler properties for this bean.
Object	getBean() The associated bean.
Map<String,ObservableValue<?>>	getProperties() Properties of this bean.
<T> T	lookup(Class<T> type) Extra information associated with this bean info.
static FXBeanInfo.Builder	newBuilder(Object bean) Start creating new FXBeanInfo for provided bean.

Methods inherited from class java.lang.Object

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

Method Detail

getBean

public Object getBean()

The associated bean.

Returns:

object this info was created for

getProperties

public Map<String,ObservableValue<?>> getProperties()

Properties of this bean. Properties can depend on each other via so called Bindings:

class Multiply implements FXBeanInfo.Provider {
    final IntegerProperty a = new SimpleIntegerProperty(this, "a", 0);
    final IntegerProperty b = new SimpleIntegerProperty(this, "b", 0);

    /** function to multiply two properties */
    int mul() {
        return a.get() * b.get();
    }
    /** property that depends on a and b and uses {@link #mul()} */
    final IntegerBinding mul = Bindings.createIntegerBinding(this::mul, a, b);

    final FXBeanInfo info = FXBeanInfo.newBuilder(this).
        property(a).
        property(b).
        property("mul", mul).
        property("add", Bindings.createIntegerBinding(
            // defining derived property as lamda function
            () -> a.get() + b.get(), a, b
        )).
        build();

    @Override
    public FXBeanInfo getFXBeanInfo() {
        return info;
    }
}

Multiply m = new Multiply();
m.a.set(13);
m.b.set(7);

final FXBeanInfo mInfo = m.getFXBeanInfo();
ObservableValue<?> add = mInfo.getProperties().get("add");
ObservableValue<?> mul = mInfo.getProperties().get("mul");

assertEquals(20, add.getValue());
assertEquals(91, mul.getValue());

Returns:

immutable map of available properties

getActions

public Map<String,EventHandlerProperty> getActions()

EventHandler properties for this bean. Use following code to invoke them:

private static void dispatchEvent(FXBeanInfo.Provider bean, String name) {
    final FXBeanInfo info = bean.getFXBeanInfo();
    final Map<String, EventHandlerProperty> actions = info.getActions();
    EventHandlerProperty property = actions.get(name);
    final EventHandler<? super ActionDataEvent> handler = property.getValue();
    handler.handle(new ActionDataEvent(bean, 7, 13));
}

Returns:

immutable map of available event handlers

Since:

0.4

See Also:

ActionDataEvent

lookup

public <T> T lookup(Class<T> type)

Extra information associated with this bean info.

Type Parameters:

T - type of the information

Parameters:

type - class describing the requested type

Returns:

{code null} or an instance of requested type

See Also:

FXBeanInfoProvider

newBuilder

public static FXBeanInfo.Builder newBuilder(Object bean)

Start creating new FXBeanInfo for provided bean. Use FXBeanInfo.Builder methods like FXBeanInfo.Builder.property(javafx.beans.property.ReadOnlyProperty) or FXBeanInfo.Builder.action(javafx.beans.property.ReadOnlyProperty) followed by final FXBeanInfo.Builder.build() to create the info.

Parameters:

bean - the bean to create the info for

Returns:

builder to create the info with

Since:

0.3