Dockable PropertiesΒΆ

The @DockingProperty attribute is used to dynamically add properties to dockable components and was inspired by the excellent Java command line parsing library Picocli.

For example, say we have a simple JCheckBox on our Dockable component and wish to persist it together with the Docking layout. We could create a boolean member variable in our Dockable component class and tie it to a property.

public class Example implements Dockable {
    @DockingProperty(name = "enabled", defaultValue = "false")
    private boolean enabled;

    @Override
    public void updateProperties() {
        // enabled value is now usable
    }
}

These dockable properties can be done for the following Java types:

  • byte

  • short

  • int

  • long

  • float

  • double

  • char

  • boolean

  • String