E - the type of the Set elementspublic abstract class SetPropertyBase<E> extends SetProperty<E>
SetPropertyBase is the base class for a property
wrapping an ObservableSet.
It provides all the functionality required for a property except for the
ReadOnlyProperty.getBean() and ReadOnlyProperty.getName() methods, which must be implemented
by extending classes.ObservableSet,
SetProperty| Type | Property and Description |
|---|---|
ReadOnlyBooleanProperty |
empty
A boolean property that is
true, if the set is empty. |
ReadOnlyIntegerProperty |
size
An integer property that represents the size of the set.
|
| Constructor and Description |
|---|
SetPropertyBase()
The Constructor of
SetPropertyBase |
SetPropertyBase(ObservableSet<E> initialValue)
The constructor of the
SetPropertyBase. |
| Modifier and Type | Method and Description |
|---|---|
void |
addListener(ChangeListener<? super ObservableSet<E>> listener)
Adds a
ChangeListener which will be notified whenever the value
of the ObservableValue changes. |
void |
addListener(InvalidationListener listener)
Adds an
InvalidationListener which will be notified whenever the
Observable becomes invalid. |
void |
addListener(SetChangeListener<? super E> listener)
Add a listener to this observable set.
|
void |
bind(ObservableValue<? extends ObservableSet<E>> newObservable)
Create a unidirection binding for this
Property. |
ReadOnlyBooleanProperty |
emptyProperty()
A boolean property that is
true, if the set is empty. |
protected void |
fireValueChangedEvent()
|
protected void |
fireValueChangedEvent(SetChangeListener.Change<? extends E> change)
|
ObservableSet<E> |
get()
Get the wrapped value.
|
protected void |
invalidated()
The method
invalidated() can be overridden to receive
invalidation notifications. |
boolean |
isBound()
Can be used to check, if a
Property is bound. |
void |
removeListener(ChangeListener<? super ObservableSet<E>> listener)
Removes the given listener from the list of listeners, that are notified
whenever the value of the
ObservableValue changes. |
void |
removeListener(InvalidationListener listener)
Removes the given listener from the list of listeners, that are notified
whenever the value of the
Observable becomes invalid. |
void |
removeListener(SetChangeListener<? super E> listener)
Tries to removed a listener from this observable set.
|
void |
set(ObservableSet<E> newValue)
Set the wrapped value.
|
ReadOnlyIntegerProperty |
sizeProperty()
An integer property that represents the size of the set.
|
String |
toString()
Returns a string representation of this
SetPropertyBase object. |
void |
unbind()
Remove the unidirectional binding for this
Property. |
bindBidirectional, setValue, unbindBidirectionalbindContent, bindContentBidirectional, equals, hashCode, unbindContent, unbindContentBidirectionaladd, addAll, asString, clear, contains, containsAll, getSize, getValue, isEmpty, isEqualTo, isNotEqualTo, isNotNull, isNull, iterator, remove, removeAll, retainAll, setExpression, size, toArray, toArrayclone, finalize, getClass, notify, notifyAll, wait, wait, waitgetBean, getNamegetValuegetValueadd, addAll, clear, contains, containsAll, equals, hashCode, isEmpty, iterator, remove, removeAll, retainAll, size, spliterator, toArray, toArrayparallelStream, removeIf, streampublic ReadOnlyIntegerProperty sizeProperty
sizeProperty in class SetExpression<E>SetExpression.getSize()public ReadOnlyBooleanProperty emptyProperty
emptyProperty in class SetExpression<E>SetExpression.isEmpty()public SetPropertyBase()
SetPropertyBasepublic SetPropertyBase(ObservableSet<E> initialValue)
SetPropertyBase.initialValue - the initial value of the wrapped valuepublic ReadOnlyIntegerProperty sizeProperty()
SetExpressionsizeProperty in class SetExpression<E>SetExpression.getSize()public ReadOnlyBooleanProperty emptyProperty()
SetExpressiontrue, if the set is empty.emptyProperty in class SetExpression<E>SetExpression.isEmpty()public void addListener(InvalidationListener listener)
ObservableInvalidationListener which will be notified whenever the
Observable 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 different Observables.
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 calling removeListener after use or to use an instance of
WeakInvalidationListener avoid this situation.
listener - The listener to registerObservable.removeListener(InvalidationListener)public void removeListener(InvalidationListener listener)
ObservableObservable 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.
listener - The listener to removeObservable.addListener(InvalidationListener)public void addListener(ChangeListener<? super ObservableSet<E>> listener)
ObservableValueChangeListener which will be notified whenever the value
of the ObservableValue 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 different ObservableValues.
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 calling removeListener after use or to use an instance of
WeakChangeListener avoid this situation.
listener - The listener to registerObservableValue.removeListener(ChangeListener)public void removeListener(ChangeListener<? super ObservableSet<E>> listener)
ObservableValueObservableValue 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.
listener - The listener to removeObservableValue.addListener(ChangeListener)public void addListener(SetChangeListener<? super E> listener)
ObservableSetlistener - the listener for listening to the set changespublic void removeListener(SetChangeListener<? super E> listener)
ObservableSetlistener - a listener to removeprotected void fireValueChangedEvent()
InvalidationListeners,
ChangeListeners, and
SetChangeListener.
This method is called when the value is changed, either manually by
calling set(javafx.collections.ObservableSet) or in case of a bound property, if the
binding becomes invalid.protected void fireValueChangedEvent(SetChangeListener.Change<? extends E> change)
InvalidationListeners,
ChangeListeners, and
SetChangeListener.
This method is called when the content of the list changes.change - the change that needs to be propagatedprotected void invalidated()
invalidated() can be overridden to receive
invalidation notifications. This is the preferred option in
Objects defining the property, because it requires less memory.
The default implementation is empty.public ObservableSet<E> get()
WritableObjectValueWritableValue.getValue().
This method exists only to align WritableObjectValue API with
WritableBooleanValue and subclasses of WritableNumberValue
public void set(ObservableSet<E> newValue)
WritableObjectValueWritableValue.setValue(java.lang.Object)newValue - The new valueWritableObjectValue.get()public boolean isBound()
PropertyProperty is bound.true if the Property is bound, false
otherwiseProperty.bind(javafx.beans.value.ObservableValue)public void bind(ObservableValue<? extends ObservableSet<E>> newObservable)
PropertyProperty.
Note that JavaFX has all the bind calls implemented through weak listeners. This means the bound property can be garbage collected and stopped from being updated.
newObservable - The observable this Property should be bound to.public void unbind()
PropertyProperty.
If the Property is not bound, calling this method has no effect.public String toString()
SetPropertyBase object.toString in class SetProperty<E>SetPropertyBase object.Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 2008, 2017, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.