Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/parubok/swing-fx-properties
Adaptation of JavaFX properties for Swing.
https://github.com/parubok/swing-fx-properties
java javafx property-binding swing swing-gui
Last synced: about 2 hours ago
JSON representation
Adaptation of JavaFX properties for Swing.
- Host: GitHub
- URL: https://github.com/parubok/swing-fx-properties
- Owner: parubok
- Created: 2020-06-16T11:18:50.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-01-04T20:01:17.000Z (11 months ago)
- Last Synced: 2024-01-05T20:56:35.597Z (10 months ago)
- Topics: java, javafx, property-binding, swing, swing-gui
- Language: Java
- Homepage:
- Size: 1.75 MB
- Stars: 17
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
[](https://search.maven.org/search?q=a:swing-fx-properties)
[](https://javadoc.io/doc/io.github.parubok/swing-fx-properties)
# swing-fx-properties
Adaptation of [JavaFX properties](https://docs.oracle.com/javafx/2/binding/jfxpub-binding.htm) for [Swing](https://en.wikipedia.org/wiki/Swing_(Java)).
JavaFX introduced an improved approach to component properties handling.
In JavaFX, component properties are type safe, referenced by method (and not via string name like in Swing) and, what is probably the most significant improvement, support [binding](https://docs.oracle.com/javase/8/javafx/properties-binding-tutorial/binding.htm).
The JavaFX properties implementation, in fact, is not JavaFX specific - it is a generic property mechanism which can be used for any JavaBean (see [`JavaBeanObjectPropertyBuilder`](https://javadoc.io/doc/io.github.parubok/swing-fx-properties/latest/io/github/parubok/swingfx/beans/property/adapter/JavaBeanObjectPropertyBuilder.html)).
This project took the relevant pieces of JavaFX properties code and added support for Swing - to allow usage of JavaFX-style properties and related functionality with Swing components.
**Note:** The default JavaFX handling of binding evaluation errors was changed from logging the error and returning some default value to throwing [`BindingEvaluationException`](https://javadoc.io/doc/io.github.parubok/swing-fx-properties/latest/io/github/parubok/swingfx/beans/binding/BindingEvaluationException.html). For some cases, this library also provides alternative methods which allow to specify a default value which is returned instead of throwing `BindingEvaluationException`.
Example:
- `Bindings.valueAt(ObservableList op, int index)` - throws [`BindingEvaluationException`](https://javadoc.io/doc/io.github.parubok/swing-fx-properties/latest/io/github/parubok/swingfx/beans/binding/BindingEvaluationException.html) in case of invalid index.
- `Bindings.valueAt(ObservableList op, int index, E defaultValue)` - returns the specified default value in case of invalid index.
The Swing properties are obtained via static methods of class [`SwingPropertySupport`](https://javadoc.io/doc/io.github.parubok/swing-fx-properties/latest/io/github/parubok/fxprop/SwingPropertySupport.html).
Example 1 (bind 'enabled' property of a label to 'selected' property of a checkbox, so the label is disabled when the checkbox is unselected and vice versa):
```java
import static io.github.parubok.fxprop.SwingPropertySupport.enabledProperty;
import static io.github.parubok.fxprop.SwingPropertySupport.selectedProperty;
JCheckBox checkBox = new JCheckBox(); // unselected checkbox
JLabel label = new JLabel();
enabledProperty(label).bind(selectedProperty(checkBox));
// label is now disabled since the checkbox is not selected
checkBox.setSelected(true);
// label is now enabled
```
Example 2 (bind 'enabled' property of an action to 'selectedRowCount' property of a table, so the action is disabled when the table has no selected rows and vice versa):
```java
import static io.github.parubok.fxprop.SwingPropertySupport.enabledProperty;
import static io.github.parubok.fxprop.SwingPropertySupport.selectedProperty;
Action action = ...; // for example, 'delete table rows' action
JTable table = ...;
enabledProperty(action).bind(selectedRowCountProperty(table).greaterThanOrEqualTo(1));
```
The following APIs were added to the original APIs of JavaFX:
- `Bindings.createObjectBinding(ObservableValue value1, ObservableValue value2, BiFunction func)`
- `Bindings.createObjectBinding(ObservableValue value1, ObservableValue value2, ObservableValue value3, TriFunction func)`
- `Bindings.stringValueAt(ObservableMap op, K key, String defaultValue)`
- `Bindings.valueAt(ObservableMap op, K key, V defaultValue)`
- `Bindings.valueAt(ObservableList op, int index, E defaultValue)`
- `Bindings.valueAt(ObservableList op, ObservableIntegerValue index, E defaultValue)`
- `ObservableMap.valueAt(K key, V defaultValue)`
- `ObservableList.valueAt(int index, E defaultValue)`
- `ObservableValue.asObject(Function func)`
- `ObservableValue.asBoolean(Predicate predicate)`
- `ObservableValue.asStringExpression(String format)`
**Note:** As specified in `bind` [method JavaDoc](https://docs.oracle.com/javase/8/javafx/api/javafx/beans/property/Property.html#bind-javafx.beans.value.ObservableValue-), JavaFX has all the bind calls implemented through weak listeners. This means the bound property can be garbage collected and stopped from being updated unless there is a strong reference pointing to it.
Includes a stand-alone demo `io.github.parubok.fxprop.demo.Demo` under `test` source sub-root.
Since [JavaFX](https://github.com/openjdk/jfx) is licensed under [GPL v2 with the Classpath exception](http://openjdk.java.net/legal/gplv2+ce.html), the same license applies to this project.
This project has no dependencies (except JUnit 5, for testing).
Requires Java 8 or later.
### Installation
Releases are available in [Maven Central](https://repo1.maven.org/maven2/io/github/parubok/swing-fx-properties/)
#### Maven
Add this snippet to the pom.xml `dependencies` section:
```xml
io.github.parubok
swing-fx-properties
1.25
```