Drombler FX v0.11: modular StatusBar and ProgressMonitor

I recently released v0.11 of Drombler FX - the modular application framework for JavaFX.

This release comes with the integration of two new JavaFX controls.

StatusBar

The first is a rather simple one: a StatusBar. It maintains three lists of elements: leftElements, centerElements and rightElements. The elements are layed out accordingly.
The control is Skinnable and Styleable and can also be used in non-OSGi JavaFX applications. As you might guess, the main intention of this control is to show the user additional information at the bottom of your application.

Drombler FX provides declarative, modular integration of this StatusBar:

view plainprint?

1. @StatusBarElement(horizontalAlignment = HorizontalAlignment.CENTER, position = 20)  
2. public class SampleStatusBarElement extends BorderPane {  
3.   
4. }  

@StatusBarElement(horizontalAlignment = HorizontalAlignment.CENTER, position = 20) public class SampleStatusBarElement extends BorderPane { }
The annotated Node sub-class will be added to the according StatusBar elements list at the specified position.

If two adjacent StatusBar elements are positioned in different thousand groups (e.g. position = 910 and position = 1120), a Separator gets automatically registered between them.

For more information see the new StatusBar tutorial trail.

ProgressMonitor

The second new JavaFX control is ProgressMonitor.
This control allows to monitor any number of running, cancelable Workers.

[1] a label bound to Worker#titleProperty
[2] a label bound to Worker#messageProperty
[3] a progress bar bound to Worker#progressProperty
[4] a button to execute Worker#cancel
[5] an indicator if there are additional workers being monitored
[6] a popup showing all monitored workers

The control is Skinnable and Styleable and can also be used in non-OSGi JavaFX applications. The main intention of this control is to be added to a StatusBar.

Here is a small sample application showing the ProgressMonitor and the StatusBar in action:

view plainprint?

1. package test;  
2.   
3. import java.nio.file.Files;  
4. import java.nio.file.Path;  
5. import java.nio.file.Paths;  
6. import java.util.ArrayList;  
7. import java.util.List;  
8. import java.util.Locale;  
9. import java.util.concurrent.ExecutorService;  
10. import java.util.concurrent.Executors;  
11. import javafx.application.Application;  
12. import javafx.concurrent.Task;  
13. import javafx.concurrent.Worker;  
14. import javafx.geometry.HPos;  
15. import javafx.scene.Scene;  
16. import javafx.scene.control.Button;  
17. import javafx.scene.layout.ColumnConstraints;  
18. import javafx.scene.layout.GridPane;  
19. import javafx.scene.layout.Priority;  
20. import javafx.scene.layout.RowConstraints;  
21. import javafx.stage.Stage;  
22. import org.drombler.commons.fx.concurrent.WorkerUtils;  
23. import org.drombler.commons.fx.scene.control.ProgressMonitor;  
24. import org.drombler.commons.fx.scene.control.StatusBar;  
25.   
26. public class ProgressMonitorSampleApplication extends Application {  
27.   
28.     private final List<Worker<?>> workers = new ArrayList<>();  
29.     private final ExecutorService executorService = Executors.newCachedThreadPool(runnable -> {  
30.         Thread thread = new Thread(runnable);  
31.         thread.setDaemon(true);  
32.         return thread;  
33.     });  
34.     private long counter = 1;  
35.   
36.     @Override  
37.     public void start(Stage primaryStage) throws InterruptedException {  
38.         StatusBar statusBar = new StatusBar();  
39.         ProgressMonitor progressMonitor = new ProgressMonitor();  
40.         statusBar.getRightElements().add(progressMonitor);  
41.   
42.         addTestWorker(counter++, progressMonitor);  
43.         Thread.sleep(2000l);  
44.         addTestWorker(counter++, progressMonitor);  
45.   
46.         Button createButton = new Button("Create Task");  
47.         createButton.setOnAction(event -> addTestWorker(counter++, progressMonitor));  
48.   
49.         GridPane root = new GridPane();  
50.         root.add(createButton, 0, 0);  
51.         root.add(statusBar, 0, 1);  
52.         ColumnConstraints columnConstraints = new ColumnConstraints();  
53.         columnConstraints.setHgrow(Priority.ALWAYS);  
54.         columnConstraints.setHalignment(HPos.CENTER);  
55.         root.getColumnConstraints().add(columnConstraints);  
56.   
57.         RowConstraints rowConstraints1 = new RowConstraints();  
58.         rowConstraints1.setVgrow(Priority.ALWAYS);  
59.         rowConstraints1.setFillHeight(false);  
60.         RowConstraints rowConstraints2 = new RowConstraints();  
61.         rowConstraints2.setVgrow(Priority.NEVER);  
62.         rowConstraints2.setFillHeight(false);  
63.         root.getRowConstraints().addAll(rowConstraints1, rowConstraints2);  
64.   
65.         GridPane.setFillWidth(createButton, Boolean.FALSE);  
66.         GridPane.setFillWidth(statusBar, Boolean.TRUE);  
67.   
68.         Scene scene = new Scene(root, 800, 200);  
69.   
70.         primaryStage.setTitle("ProgressMonitorSampleApplication");  
71.         primaryStage.setScene(scene);  
72.         primaryStage.show();  
73.     }  
74.   
75.     private void addTestWorker(long id, ProgressMonitor progressMonitor) {  
76.         final TestWorker testWorker = new TestWorker(id);  
77.         testWorker.stateProperty().addListener((observable, oldValue, newValue) -> {  
78.             if (WorkerUtils.getFinishedStates().contains(newValue)) {  
79.                 workers.remove(testWorker);  
80.             }  
81.         });  
82.         workers.add(testWorker);  
83.         executorService.execute(testWorker);  
84.         progressMonitor.getWorkers().add(testWorker);  
85.     }  
86.   
87.     public static void main(String[] args) {  
88.         configureLogging();  
89.         launch(args);  
90.     }  
91.   
92.     private static void configureLogging() {  
93.         Locale.setDefault(Locale.ENGLISH);  
94.         Path loggingPropertiesPath = Paths.get("src", "test", "resources", "test", "logging.properties");  
95.         System.out.println("Logging configuration file: " + loggingPropertiesPath + " exists: " + Files.exists(loggingPropertiesPath));  
96.         if (Files.exists(loggingPropertiesPath)) {  
97.             System.setProperty("java.util.logging.config.file", loggingPropertiesPath.toString());  
98.         }  
99.     }  
100.   
101.     private static class TestWorker extends Task<Long> {  
102.   
103.         private final long id;  
104.         private long counter = 0;  
105.   
106.         public TestWorker(long id) {  
107.             this.id = id;  
108.             updateTitle("Test Worker " + id);  
109.             updateMessage("Iteration " + counter);  
110.             updateProgress(-1, 1);  
111.         }  
112.   
113.         @Override  
114.         protected Long call() throws Exception {  
115.             while (!isCancelled()) {  
116.                 counter++;  
117.                 updateMessage("Iteration " + counter);  
118.                 Thread.sleep(1000l);  
119.             }  
120.             return counter;  
121.         }  
122.   
123.         @Override  
124.         public String toString() {  
125.             return getTitle();  
126.         }  
127.   
128.     }  
129. }  

package test; import java.nio.file.Files; import java.nio.file.Path; import java.nio.file.Paths; import java.util.ArrayList; import java.util.List; import java.util.Locale; import java.util.concurrent.ExecutorService; import java.util.concurrent.Executors; import javafx.application.Application; import javafx.concurrent.Task; import javafx.concurrent.Worker; import javafx.geometry.HPos; import javafx.scene.Scene; import javafx.scene.control.Button; import javafx.scene.layout.ColumnConstraints; import javafx.scene.layout.GridPane; import javafx.scene.layout.Priority; import javafx.scene.layout.RowConstraints; import javafx.stage.Stage; import org.drombler.commons.fx.concurrent.WorkerUtils; import org.drombler.commons.fx.scene.control.ProgressMonitor; import org.drombler.commons.fx.scene.control.StatusBar; public class ProgressMonitorSampleApplication extends Application { private final List<Worker<?>> workers = new ArrayList<>(); private final ExecutorService executorService = Executors.newCachedThreadPool(runnable -> { Thread thread = new Thread(runnable); thread.setDaemon(true); return thread; }); private long counter = 1; @Override public void start(Stage primaryStage) throws InterruptedException { StatusBar statusBar = new StatusBar(); ProgressMonitor progressMonitor = new ProgressMonitor(); statusBar.getRightElements().add(progressMonitor); addTestWorker(counter++, progressMonitor); Thread.sleep(2000l); addTestWorker(counter++, progressMonitor); Button createButton = new Button("Create Task"); createButton.setOnAction(event -> addTestWorker(counter++, progressMonitor)); GridPane root = new GridPane(); root.add(createButton, 0, 0); root.add(statusBar, 0, 1); ColumnConstraints columnConstraints = new ColumnConstraints(); columnConstraints.setHgrow(Priority.ALWAYS); columnConstraints.setHalignment(HPos.CENTER); root.getColumnConstraints().add(columnConstraints); RowConstraints rowConstraints1 = new RowConstraints(); rowConstraints1.setVgrow(Priority.ALWAYS); rowConstraints1.setFillHeight(false); RowConstraints rowConstraints2 = new RowConstraints(); rowConstraints2.setVgrow(Priority.NEVER); rowConstraints2.setFillHeight(false); root.getRowConstraints().addAll(rowConstraints1, rowConstraints2); GridPane.setFillWidth(createButton, Boolean.FALSE); GridPane.setFillWidth(statusBar, Boolean.TRUE); Scene scene = new Scene(root, 800, 200); primaryStage.setTitle("ProgressMonitorSampleApplication"); primaryStage.setScene(scene); primaryStage.show(); } private void addTestWorker(long id, ProgressMonitor progressMonitor) { final TestWorker testWorker = new TestWorker(id); testWorker.stateProperty().addListener((observable, oldValue, newValue) -> { if (WorkerUtils.getFinishedStates().contains(newValue)) { workers.remove(testWorker); } }); workers.add(testWorker); executorService.execute(testWorker); progressMonitor.getWorkers().add(testWorker); } public static void main(String[] args) { configureLogging(); launch(args); } private static void configureLogging() { Locale.setDefault(Locale.ENGLISH); Path loggingPropertiesPath = Paths.get("src", "test", "resources", "test", "logging.properties"); System.out.println("Logging configuration file: " + loggingPropertiesPath + " exists: " + Files.exists(loggingPropertiesPath)); if (Files.exists(loggingPropertiesPath)) { System.setProperty("java.util.logging.config.file", loggingPropertiesPath.toString()); } } private static class TestWorker extends Task<Long> { private final long id; private long counter = 0; public TestWorker(long id) { this.id = id; updateTitle("Test Worker " + id); updateMessage("Iteration " + counter); updateProgress(-1, 1); } @Override protected Long call() throws Exception { while (!isCancelled()) { counter++; updateMessage("Iteration " + counter); Thread.sleep(1000l); } return counter; } @Override public String toString() { return getTitle(); } } }

You can find the sample application also here.

Drombler FX provides out-of-the-box support for ProgressMonitor (as an optional feature). It registers a StatusBar element and provides a loosely-coupled notification mechanism via the Context Framework.

For more information see the new ProgressBar tutorial trail.

Application Layout

As there is no one-size-fits-all solution, the application layout of a Drombler FX application is pluggable so you can provide your own implementation tailored to your needs. This allows you to get the most out of Drombler FX and JavaFX.

While this feature is available for some time, there is now a new tutorial trail explaining it in more detail.

API Changes

Please note that some APIs have changed, especially the following ones:

• OnExitRequestHandler: this class has been moved from Dromber FX to Drombler Commons. 
• The package changed accordingly:
  org.drombler.fx.core.application -> org.drombler.commons.fx.stage
• Dromber FX provides the following new interface for integration:
  org.drombler.fx.core.application.OnExitRequestHandlerProvider 
• In the package org.drombler.commons.docking.fx.context:
  WindowOnCloseRequestHandler has been replaced with DockingOnExitRequestHandler 
• The two service provider interfaces ApplicationContentProvider, MainSceneRootProvider have moved module/ package:
  org.drombler.fx.startup.main -> org.drombler.fx.core.application
• The service provider interface org.drombler.fx.core.application.WindowOnCloseRequestHandlerProvider: has been replaced with org.drombler.commons.fx.stage.OnExitRequestHandler#createOnWindowCloseRequestEventHandler 
• The service provider interface org.drombler.acp.startup.main.ApplicationExecutorProvider has been moved and renamed to org.drombler.acp.core.commons.util.concurrent.ApplicationThreadExecutorProvider

Additional Information

Projects like this one need to be build by a community working together to be really successful. There are several ways how you can contribute to this project. Contributions are highly welcome! See the "How to Contribute"-page for more information.

You can find the complete list of fixed issues here: https://github.com/Drombler/drombler-fx/issues?q=milestone%3A0.11


There's a Getting Started page which explains how to create, build and run a Drombler FX sample application with a few simple steps.


The following table provides you an overview of the different Drombler components, links to the modules, which are available from Maven Central, and links to the Javadocs.
  

Name	Modules (incl. Maven Coordinates)	Javadoc	Description
Drombler FX	Modules	Javadoc	Drombler FX, the modular application framework for JavaFX based on: OSGi Maven (POM-first) a declarative programming model Drombler ACP  Drombler Commons.
Drombler ACP	Modules	Javadoc	Drombler Abstract Client Platform (ACP) is an abstract, GUI-toolkit agnostic, modular Rich Client Platform based on: OSGi Maven (POM-first) a declarative programming model Drombler Commons.
Drombler Commons	Modules	Javadoc	Drombler Commons is a collection of reusable libraries and frameworks. They ship with OSGi meta data but don't require an OSGi environment.

If you find issues or have enhancement requests, you can file a ticket here: https://github.com/Drombler/drombler-fx/issues.