- Type Parameters:
E
- the type of theSet
elements
- All Implemented Interfaces:
Iterable<E>
,Collection<E>
,Set<E>
,Binding<ObservableSet<E>>
,Observable
,ObservableObjectValue<ObservableSet<E>>
,ObservableSetValue<E>
,ObservableValue<ObservableSet<E>>
,ObservableSet<E>
public abstract class SetBinding<E> extends SetExpression<E> implements Binding<ObservableSet<E>>
Binding
of an ObservableSet
.
SetBinding
provides a simple invalidation-scheme. An extending
class can register dependencies by calling bind(Observable...)
.
If one of the registered dependencies becomes invalid, this
SetBinding
is marked as invalid. With
unbind(Observable...)
listening to dependencies can be stopped.
To provide a concrete implementation of this class, the method
computeValue()
has to be implemented to calculate the value of this
binding based on the current state of the dependencies. It is called when
get()
is called for an invalid binding.
See DoubleBinding
for an example how this base class can be extended.
- Since:
- JavaFX 2.1
- See Also:
Binding
,SetExpression
-
Property Summary
Properties Type Property Description ReadOnlyBooleanProperty
empty
A boolean property that istrue
, if the set is empty.ReadOnlyIntegerProperty
size
An integer property that represents the size of the set. -
Constructor Summary
Constructors Constructor Description SetBinding()
Creates a defaultSetBinding
. -
Method Summary
Modifier and Type Method Description void
addListener(InvalidationListener listener)
Adds anInvalidationListener
which will be notified whenever theObservable
becomes invalid.void
addListener(ChangeListener<? super ObservableSet<E>> listener)
Adds aChangeListener
which will be notified whenever the value of theObservableValue
changes.void
addListener(SetChangeListener<? super E> listener)
Add a listener to this observable set.protected void
bind(Observable... dependencies)
Start observing the dependencies for changes.protected abstract ObservableSet<E>
computeValue()
Calculates the current value of this binding.void
dispose()
A default implementation ofdispose()
that is empty.ReadOnlyBooleanProperty
emptyProperty()
A boolean property that istrue
, if the set is empty.ObservableSet<E>
get()
Returns the result ofcomputeValue()
.ObservableList<?>
getDependencies()
A default implementation ofgetDependencies()
that returns an emptyObservableList
.void
invalidate()
Mark a binding as invalid.boolean
isValid()
Checks if a binding is valid.protected void
onInvalidating()
The method onInvalidating() can be overridden by extending classes to react, if this binding becomes invalid.void
removeListener(InvalidationListener listener)
Removes the given listener from the list of listeners, that are notified whenever the value of theObservable
becomes invalid.void
removeListener(ChangeListener<? super ObservableSet<E>> listener)
Removes the given listener from the list of listeners that are notified whenever the value of theObservableValue
changes.void
removeListener(SetChangeListener<? super E> listener)
Tries to removed a listener from this observable set.ReadOnlyIntegerProperty
sizeProperty()
An integer property that represents the size of the set.String
toString()
Returns a string representation of thisSetBinding
object.protected void
unbind(Observable... dependencies)
Stop observing the dependencies for changes.Methods inherited from class javafx.beans.binding.SetExpression
add, addAll, asString, clear, contains, containsAll, getSize, getValue, isEmpty, isEqualTo, isNotEqualTo, isNotNull, isNull, iterator, remove, removeAll, retainAll, setExpression, size, toArray, toArray
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface java.util.Collection
parallelStream, removeIf, stream, toArray
Methods inherited from interface javafx.beans.value.ObservableValue
getValue
Methods inherited from interface java.util.Set
equals, hashCode, spliterator
-
Property Details
-
size
- Specified by:
sizeProperty
in classSetExpression<E>
- See Also:
SetExpression.getSize()
-
empty
- Specified by:
emptyProperty
in classSetExpression<E>
- See Also:
SetExpression.isEmpty()
-
-
Constructor Details
-
SetBinding
public SetBinding()Creates a defaultSetBinding
.
-
-
Method Details
-
sizeProperty
Description copied from class:SetExpression
An integer property that represents the size of the set.- Specified by:
sizeProperty
in classSetExpression<E>
- See Also:
SetExpression.getSize()
-
emptyProperty
Description copied from class:SetExpression
A boolean property that istrue
, if the set is empty.- Specified by:
emptyProperty
in classSetExpression<E>
- See Also:
SetExpression.isEmpty()
-
addListener
Description copied from interface:Observable
Adds anInvalidationListener
which will be notified whenever theObservable
becomes invalid. If the same listener is added more than once, then it will be notified more than once. That is, no check is made to ensure uniqueness.Note that the same actual
InvalidationListener
instance may be safely registered for differentObservables
.The
Observable
stores a strong reference to the listener which will prevent the listener from being garbage collected and may result in a memory leak. It is recommended to either unregister a listener by callingremoveListener
after use or to use an instance ofWeakInvalidationListener
avoid this situation.- Specified by:
addListener
in interfaceObservable
- Parameters:
listener
- The listener to register- See Also:
Observable.removeListener(InvalidationListener)
-
removeListener
Description copied from interface:Observable
Removes the given listener from the list of listeners, that are notified whenever the value of theObservable
becomes invalid.If the given listener has not been previously registered (i.e. it was never added) then this method call is a no-op. If it had been previously added then it will be removed. If it had been added more than once, then only the first occurrence will be removed.
- Specified by:
removeListener
in interfaceObservable
- Parameters:
listener
- The listener to remove- See Also:
Observable.addListener(InvalidationListener)
-
addListener
Description copied from interface:ObservableValue
Adds aChangeListener
which will be notified whenever the value of theObservableValue
changes. If the same listener is added more than once, then it will be notified more than once. That is, no check is made to ensure uniqueness.Note that the same actual
ChangeListener
instance may be safely registered for differentObservableValues
.The
ObservableValue
stores a strong reference to the listener which will prevent the listener from being garbage collected and may result in a memory leak. It is recommended to either unregister a listener by callingremoveListener
after use or to use an instance ofWeakChangeListener
avoid this situation.- Specified by:
addListener
in interfaceObservableValue<E>
- Parameters:
listener
- The listener to register- See Also:
ObservableValue.removeListener(ChangeListener)
-
removeListener
Description copied from interface:ObservableValue
Removes the given listener from the list of listeners that are notified whenever the value of theObservableValue
changes.If the given listener has not been previously registered (i.e. it was never added) then this method call is a no-op. If it had been previously added then it will be removed. If it had been added more than once, then only the first occurrence will be removed.
- Specified by:
removeListener
in interfaceObservableValue<E>
- Parameters:
listener
- The listener to remove- See Also:
ObservableValue.addListener(ChangeListener)
-
addListener
Description copied from interface:ObservableSet
Add a listener to this observable set.- Specified by:
addListener
in interfaceObservableSet<E>
- Parameters:
listener
- the listener for listening to the set changes
-
removeListener
Description copied from interface:ObservableSet
Tries to removed a listener from this observable set. If the listener is not attached to this list, nothing happens.- Specified by:
removeListener
in interfaceObservableSet<E>
- Parameters:
listener
- a listener to remove
-
bind
Start observing the dependencies for changes. If the value of one of the dependencies changes, the binding is marked as invalid.- Parameters:
dependencies
- the dependencies to observe
-
unbind
Stop observing the dependencies for changes.- Parameters:
dependencies
- the dependencies to stop observing
-
dispose
public void dispose()A default implementation ofdispose()
that is empty. -
getDependencies
A default implementation ofgetDependencies()
that returns an emptyObservableList
.- Specified by:
getDependencies
in interfaceBinding<E>
- Returns:
- an empty
ObservableList
-
get
Returns the result ofcomputeValue()
. The methodcomputeValue()
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 ofget()
.- Specified by:
get
in interfaceObservableObjectValue<E>
- Returns:
- the current value
-
onInvalidating
protected void onInvalidating()The method onInvalidating() can be overridden by extending classes to react, if this binding becomes invalid. The default implementation is empty. -
invalidate
public final void invalidate()Description copied from interface:Binding
Mark a binding as invalid. This forces the recalculation of the value of theBinding
next time it is request.- Specified by:
invalidate
in interfaceBinding<E>
-
isValid
public final boolean isValid()Description copied from interface:Binding
Checks if a binding is valid. -
computeValue
Calculates the current value of this binding.Classes extending
SetBinding
have to provide an implementation ofcomputeValue
.- Returns:
- the current value
-
toString
Returns a string representation of thisSetBinding
object.
-