Home » Java » Desktop Java » FXML: Custom components using BuilderFactory

About Toni Epple

Toni Epple
Anton is a consultant worldwide for a wide variety of companies, ranging from startups to Fortune 500 companies, in many areas, including finance institutions and aerospace. His main interest is Client side development, and he has authored books and numerous articles on this topic. He is a member of the NetBeans Dream Team and a Oracle Java Champion. In 2013 he was elected as a JavaONE Rockstar, in 2014 he received a Duke’s Choice Award for his work on DukeScript.

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;

 public ColorPicker build() {
 ColorPicker picker = new ColorPicker(color);
 return picker;
 private JavaFXBuilderFactory defaultBuilderFactory = new JavaFXBuilderFactory();

 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

Your email address will not be published. Required fields are marked *


Want to take your Java Skills to the next level?
Grab our programming books for FREE!
  • Save time by leveraging our field-tested solutions to common problems.
  • The books cover a wide range of topics, from JPA and JUnit, to JMeter and Android.
  • Each book comes as a standalone guide (with source code provided), so that you use it as reference.
Last Step ...

Where should we send the free eBooks?

Good Work!
To download the books, please verify your email address by following the instructions found on the email we just sent you.