/
FloatBinding.java
202 lines (182 loc) · 6.37 KB
/
FloatBinding.java
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
/*
* Copyright (c) 2010, 2020, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation. Oracle designates this
* particular file as subject to the "Classpath" exception as provided
* by Oracle in the LICENSE file that accompanied this code.
*
* This code is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* version 2 for more details (a copy is included in the LICENSE file that
* accompanied this code).
*
* You should have received a copy of the GNU General Public License version
* 2 along with this work; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
* or visit www.oracle.com if you need additional information or have any
* questions.
*/
package javafx.beans.binding;
import javafx.beans.InvalidationListener;
import javafx.beans.Observable;
import javafx.beans.value.ChangeListener;
import javafx.collections.FXCollections;
import javafx.collections.ObservableList;
import com.sun.javafx.binding.BindingHelperObserver;
import com.sun.javafx.binding.ExpressionHelper;
/**
* Base class that provides most of the functionality needed to implement a
* {@link Binding} of a {@code float} value.
* <p>
* {@code FloatBinding} provides a simple invalidation-scheme. An extending
* class can register dependencies by calling {@link #bind(Observable...)}.
* If One of the registered dependencies becomes invalid, this
* {@code FloatBinding} is marked as invalid. With
* {@link #unbind(Observable...)} listening to dependencies can be stopped.
* <p>
* To provide a concrete implementation of this class, the method
* {@link #computeValue()} has to be implemented to calculate the value of this
* binding based on the current state of the dependencies. It is called when
* {@link #get()} is called for an invalid binding.
* <p>
* See {@link DoubleBinding} for an example how this base class can be extended.
*
* @see Binding
* @see NumberBinding
* @see javafx.beans.binding.FloatExpression
*
*
* @since JavaFX 2.0
*/
public abstract class FloatBinding extends FloatExpression implements
NumberBinding {
private float value;
private boolean valid;
private BindingHelperObserver observer;
private ExpressionHelper<Number> helper = null;
/**
* Creates a default {@code FloatBinding}.
*/
public FloatBinding() {
}
@Override
public void addListener(InvalidationListener listener) {
helper = ExpressionHelper.addListener(helper, this, listener);
}
@Override
public void removeListener(InvalidationListener listener) {
helper = ExpressionHelper.removeListener(helper, listener);
}
@Override
public void addListener(ChangeListener<? super Number> listener) {
helper = ExpressionHelper.addListener(helper, this, listener);
}
@Override
public void removeListener(ChangeListener<? super Number> listener) {
helper = ExpressionHelper.removeListener(helper, listener);
}
/**
* Start observing the dependencies for changes. If the value of one of the
* dependencies changes, the binding is marked as invalid.
*
* @param dependencies
* the dependencies to observe
*/
protected final void bind(Observable... dependencies) {
if ((dependencies != null) && (dependencies.length > 0)) {
if (observer == null) {
observer = new BindingHelperObserver(this);
}
for (final Observable dep : dependencies) {
dep.addListener(observer);
}
}
}
/**
* Stop observing the dependencies for changes.
*
* @param dependencies
* the dependencies to stop observing
*/
protected final void unbind(Observable... dependencies) {
if (observer != null) {
for (final Observable dep : dependencies) {
dep.removeListener(observer);
}
observer = null;
}
}
/**
* A default implementation of {@code dispose()} that is empty.
*/
@Override
public void dispose() {
}
/**
* A default implementation of {@code getDependencies()} that returns an
* empty {@link javafx.collections.ObservableList}.
*
* @return an empty {@code ObservableList}
*/
@Override
public ObservableList<?> getDependencies() {
return FXCollections.emptyObservableList();
}
/**
* Returns the result of {@link #computeValue()}. The method
* {@code computeValue()} is only called if the binding is invalid. The
* result is cached and returned if the binding did not become invalid since
* the last call of {@code getValue}.
*/
@Override
public final float get() {
if (!valid) {
value = computeValue();
valid = true;
}
return value;
}
/**
* The method onInvalidating() can be overridden by extending classes to
* react, if this binding becomes invalid. The default implementation is
* empty.
*/
protected void onInvalidating() {
}
@Override
public final void invalidate() {
if (valid) {
valid = false;
onInvalidating();
ExpressionHelper.fireValueChangedEvent(helper);
}
}
@Override
public final boolean isValid() {
return valid;
}
/**
* Calculates the current value of this binding.
* <p>
* Classes extending {@code FloatBinding} have to provide an implementation
* of {@code computeValue}.
*
* @return the current value
*/
protected abstract float computeValue();
/**
* Returns a string representation of this {@code FloatBinding} object.
* @return a string representation of this {@code FloatBinding} object.
*/
@Override
public String toString() {
return valid ? "FloatBinding [value: " + get() + "]"
: "FloatBinding [invalid]";
}
}