FXML: Custom components using BuilderFactory

When you want to use FXML, you will need to be able to add your own components. That’s fairly easy, you simply need to add an import statement. Elements in your FXML-file that start with a capital letter will be interpreted as instances, and if they’re Java Beans, most important: if they have a parameterless standard constructor, everything is fine.

If not, it’s a bit more complicated. You will need to provide a Builder and a BuilderFactory to the loader. As an example, in FXExperience Tools a nice ColorPicker control is used, that needs a Color passed to it’s constructor. So in FXML we want to write something like this:

<?import com.fxexperience.javafx.scene.control.colorpicker.ColorPicker?><!-- ... --><ColorPicker fx:id="colorPicker" id="colorPicker" color="GREEN" />

Now we need to create a BuilderFactory and a Builder:

import com.fxexperience.javafx.scene.control.colorpicker.ColorPicker;
import javafx.fxml.JavaFXBuilderFactory;
import javafx.scene.paint.Color;
import javafx.util.Builder;
import javafx.util.BuilderFactory;

/**
 *
 * @author eppleton
 */
public class ColorPickerBuilderFactory implements BuilderFactory {

public static class ColorPickerBuilder implements Builder<ColorPicker> {
 private Color color = Color.WHITE;
 private String id="colorPicker";

public String getId() {
 return id;
 }

public void setId(String id) {
 this.id = id;
 }

public Color getColor() {
 return color;
 }

public void setColor(Color color) {
 this.color = color;
 }

@Override
 public ColorPicker build() {
 ColorPicker picker = new ColorPicker(color);
 picker.setId(id);
 return picker;
 }
 }
 private JavaFXBuilderFactory defaultBuilderFactory = new JavaFXBuilderFactory();

@Override
 public Builder<?> getBuilder(Class<?> type) {
 return (type == ColorPicker.class) ? new ColorPickerBuilder() : defaultBuilderFactory.getBuilder(type);
 }
}

And finally when loading the FXML you need to pass the factory to your loader:

(Parent) FXMLLoader.load(
 TestTool.class.getResource("GradientEditorControl.fxml"), null,
 new ColorPickerBuilderFactory())

That’s it, would be cool if I could make SceneBuilder understand that as well.

Reference: Add custom components to FXML using BuilderFactoryfrom our JCG partner Toni Epple at the Eppleton blog.

Do you want to know how to develop your skillset to become a Java Rockstar?

Subscribe to our newsletter to start Rocking right now!

To get you started we give you our best selling eBooks for FREE!

1. JPA Mini Book

2. JVM Troubleshooting Guide

3. JUnit Tutorial for Unit Testing

4. Java Annotations Tutorial

5. Java Interview Questions

6. Spring Interview Questions

7. Android UI Design

and many more ....

Leave a Reply


+ eight = 13



Java Code Geeks and all content copyright © 2010-2015, Exelixis Media Ltd | Terms of Use | Privacy Policy | Contact
All trademarks and registered trademarks appearing on Java Code Geeks are the property of their respective owners.
Java is a trademark or registered trademark of Oracle Corporation in the United States and other countries.
Java Code Geeks is not connected to Oracle Corporation and is not sponsored by Oracle Corporation.
Do you want to know how to develop your skillset and become a ...
Java Rockstar?

Subscribe to our newsletter to start Rocking right now!

To get you started we give you our best selling eBooks for FREE!

Get ready to Rock!
To download the books, please verify your email address by following the instructions found on the email we just sent you.

THANK YOU!

Close