1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231
|
EasyBind
========
EasyBind leverages lambdas to reduce boilerplate when creating custom bindings, provides a type-safe alternative to `Bindings.select*` methods (inspired by Anton Nashatyrev's [feature request](https://javafx-jira.kenai.com/browse/RT-35923), planned for JavaFX 9) and adds _monadic_ operations to `ObservableValue`.
Binding factory methods
-----------------------
### map
Creates a binding whose value is a mapping of some observable value.
```java
ObservableStringValue str = ...;
Binding<Integer> strLen = EasyBind.map(str, String::length);
```
Compare to plain JavaFX:
```java
ObservableStringValue str = ...;
IntegerBinding strLen = Bindings.createIntegerBinding(() -> str.get().length(), str);
```
The difference is subtle, but important: In the latter version, `str` is repeated twice — once in the function to compute binding's value and once as binding's dependency. This opens the possibility that a wrong dependency is specified by mistake.
### combine
Creates a binding whose value is a combination of two or more (currently up to six) observable values.
```java
ObservableStringValue str = ...;
ObservableValue<Integer> start = ...;
ObservableValue<Integer> end = ...;
Binding<String> subStr = EasyBind.combine(str, start, end, String::substring);
```
Compare to plain JavaFX:
```java
ObservableStringValue str = ...;
ObservableIntegerValue start = ...;
ObservableIntegerValue end = ...;
StringBinding subStr = Bindings.createStringBinding(() -> str.get().substring(start.get(), end.get()), str, start, end);
```
Same difference as before — in the latter version, `str`, `start` and `end` are repeated twice, once in the function to compute binding's value and once as binding's dependencies, which opens the possibility of specifying wrong set of dependencies. Plus, the latter is getting less readable.
### select
Type-safe alternative to `Bindings.select*` methods. The following example is borrowed from [RT-35923](https://javafx-jira.kenai.com/browse/RT-35923).
```java
Binding<Boolean> bb = EasyBind.select(control.sceneProperty())
.select(s -> s.windowProperty())
.selectObject(w -> w.showingProperty());
```
Compare to plain JavaFX:
```java
BooleanBinding bb = Bindings.selectBoolean(control.sceneProperty(), "window", "isShowing");
```
The latter version is not type-safe, which means it may cause runtime errors.
### map list
Returns a mapped view of an ObservableList.
```java
ObservableList<String> tabIds = EasyBind.map(tabPane.getTabs(), Tab::getId);
```
In the above example, `tabIds` is updated as tabs are added and removed from `tabPane`.
An equivalent feature has been requested in [RT-35741](https://javafx-jira.kenai.com/browse/RT-35741) and is scheduled for JavaFX 9.
### combine list
Turns an _observable list_ of _observable values_ into a single observable value. The resulting observable value is updated when elements are added or removed to or from the list, as well as when element values change.
```java
Property<Integer> a = new SimpleObjectProperty<>(5);
Property<Integer> b = new SimpleObjectProperty<>(10);
ObservableList<Property<Integer>> list = FXCollections.observableArrayList();
Binding<Integer> sum = EasyBind.combine(
list,
stream -> stream.reduce((a, b) -> a + b).orElse(0));
assert sum.getValue() == 0;
// sum responds to element additions
list.add(a);
list.add(b);
assert sum.getValue() == 15;
// sum responds to element value changes
a.setValue(20);
assert sum.getValue() == 30;
// sum responds to element removals
list.remove(a);
assert sum.getValue() == 10;
```
You don't usually have an observable list of _observable_ values, but you often have an observable list of something that _contains_ an observable value. In that case, use the above `map` methods to get an observable list of observable values, as in the example below.
#### Example: Disable "Save All" button on no unsaved changes
Assume a tab pane that contains a text editor in every tab. The set of open tabs (i.e. open files) is changing. Let's further assume we use a custom Tab subclass `EditorTab` that has a boolean `savedProperty()` that indicates whether changes in its editor have been saved.
**Task:** Keep the _"Save All"_ button disabled when there are no unsaved changes in any of the editors.
```java
ObservableList<ObservableValue<Boolean>> individualTabsSaved =
EasyBind.map(tabPane.getTabs(), t -> ((EditorTab) t).savedProperty());
ObservableValue<Boolean> allTabsSaved = EasyBind.combine(
individualTabsSaved,
stream -> stream.allMatch(saved -> saved));
Button saveAllButton = new Button(...);
saveAllButton.disableProperty().bind(allTabsSaved);
```
Monadic observable values
-------------------------
[MonadicObservableValue](http://www.fxmisc.org/easybind/javadoc/org/fxmisc/easybind/monadic/MonadicObservableValue.html) interface adds monadic operations to `ObservableValue`.
```java
interface MonadicObservableValue<T> extends ObservableValue<T> {
boolean isPresent();
boolean isEmpty();
void ifPresent(Consumer<? super T> f);
T getOrThrow();
T getOrElse(T other);
Optional<T> getOpt();
MonadicBinding<T> orElse(T other);
MonadicBinding<T> orElse(ObservableValue<T> other);
MonadicBinding<T> filter(Predicate<? super T> p);
<U> MonadicBinding<U> map(Function<? super T, ? extends U> f);
<U> MonadicBinding<U> flatMap(Function<? super T, ObservableValue<U>> f);
<U> SelectBuilder<U> select(Function<? super T, ObservableValue<U>> f);
}
```
Read more about monadic operations in [this blog post](http://tomasmikula.github.io/blog/2014/03/26/monadic-operations-on-observablevalue.html).
Use EasyBind in your project
----------------------------
### Stable release
Current stable release is 1.0.2.
#### Maven coordinates
| Group ID | Artifact ID | Version |
| :-----------------: | :---------: | :-----: |
| org.fxmisc.easybind | easybind | 1.0.2 |
#### Gradle example
```groovy
dependencies {
compile group: 'org.fxmisc.easybind', name: 'easybind', version: '1.0.2'
}
```
#### Sbt example
```scala
libraryDependencies += "org.fxmisc.easybind" % "easybind" % "1.0.2"
```
#### Manual download
[Download](https://github.com/TomasMikula/EasyBind/releases/download/v1.0.2/easybind-1.0.2.jar) the JAR file and place it on your classpath.
### Snapshot releases
Snapshot releases are deployed to Sonatype snapshot repository.
#### Maven coordinates
| Group ID | Artifact ID | Version |
| :-----------------: | :---------: | :------------: |
| org.fxmisc.easybind | easybind | 1.0.3-SNAPSHOT |
#### Gradle example
```groovy
repositories {
maven {
url 'https://oss.sonatype.org/content/repositories/snapshots/'
}
}
dependencies {
compile group: 'org.fxmisc.easybind', name: 'easybind', version: '1.0.3-SNAPSHOT'
}
```
#### Sbt example
```scala
resolvers += "Sonatype OSS Snapshots" at "https://oss.sonatype.org/content/repositories/snapshots"
libraryDependencies += "org.fxmisc.easybind" % "easybind" % "1.0.3-SNAPSHOT"
```
#### Manual download
[Download](https://oss.sonatype.org/content/repositories/snapshots/org/fxmisc/easybind/easybind/1.0.3-SNAPSHOT/) the latest JAR file and place it on your classpath.
Links
-----
[Javadoc](http://www.fxmisc.org/easybind/javadoc/overview-summary.html)
|