Class SetPropertyBase<E>
- javafx.beans.binding.SetExpression<E>
-
- javafx.beans.property.ReadOnlySetProperty<E>
-
- javafx.beans.property.SetProperty<E>
-
- javafx.beans.property.SetPropertyBase<E>
Type Parameters:
E - the type of the Set elements
All Implemented Interfaces:
Iterable<E>, Collection<E>, Set<E>, Observable, Property<ObservableSet<E>>, ReadOnlyProperty<ObservableSet<E>>, ObservableObjectValue<ObservableSet<E>>, ObservableSetValue<E>, ObservableValue<ObservableSet<E>>, WritableObjectValue<ObservableSet<E>>, WritableSetValue<E>, WritableValue<ObservableSet<E>>, ObservableSet<E>
Direct Known Subclasses:
public 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.Since:
JavaFX 2.1
See Also:
-
Property Summary
All MethodsInstance MethodsConcrete Methods Type Property and Description ReadOnlyBooleanPropertyemptyA boolean property that istrue, if the set is empty.ReadOnlyIntegerPropertysizeAn integer property that represents the size of the set.
-
Constructor Summary
Constructors Constructor and Description SetPropertyBase()The Constructor ofSetPropertyBaseSetPropertyBase(ObservableSet<E> initialValue)The constructor of theSetPropertyBase.
-
Method Summary
All MethodsInstance MethodsConcrete Methods Modifier and Type Method and Description voidaddListener(ChangeListener<? super ObservableSet<E>> listener)Adds aChangeListenerwhich will be notified whenever the value of theObservableValuechanges.voidaddListener(InvalidationListener listener)Adds anInvalidationListenerwhich will be notified whenever theObservablebecomes invalid.voidaddListener(SetChangeListener<? super E> listener)Add a listener to this observable set.voidbind(ObservableValue<? extends ObservableSet<E>> newObservable)Create a unidirection binding for thisProperty.ReadOnlyBooleanPropertyemptyProperty()A boolean property that istrue, if the set is empty.protected voidfireValueChangedEvent()protected voidfireValueChangedEvent(SetChangeListener.Change<? extends E> change)ObservableSet<E>get()Get the wrapped value.protected voidinvalidated()The methodinvalidated()can be overridden to receive invalidation notifications.booleanisBound()Can be used to check, if aPropertyis bound.voidremoveListener(ChangeListener<? super ObservableSet<E>> listener)Removes the given listener from the list of listeners, that are notified whenever the value of theObservableValuechanges.voidremoveListener(InvalidationListener listener)Removes the given listener from the list of listeners, that are notified whenever the value of theObservablebecomes invalid.voidremoveListener(SetChangeListener<? super E> listener)Tries to removed a listener from this observable set.voidset(ObservableSet<E> newValue)Set the wrapped value.ReadOnlyIntegerPropertysizeProperty()An integer property that represents the size of the set.StringtoString()Returns a string representation of thisSetPropertyBaseobject.voidunbind()Remove the unidirectional binding for thisProperty.-
Methods inherited from class javafx.beans.property.SetProperty
bindBidirectional, setValue, unbindBidirectional
-
Methods inherited from class javafx.beans.property.ReadOnlySetProperty
bindContent, bindContentBidirectional, equals, hashCode, unbindContent, unbindContentBidirectional
-
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, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface javafx.beans.property.ReadOnlyProperty
getBean, getName
-
Methods inherited from interface javafx.beans.value.ObservableValue
getValue
-
Methods inherited from interface javafx.beans.value.WritableValue
getValue
-
Methods inherited from interface java.util.Set
add, addAll, clear, contains, containsAll, equals, hashCode, isEmpty, iterator, remove, removeAll, retainAll, size, spliterator, toArray, toArray
-
Methods inherited from interface java.util.Collection
parallelStream, removeIf, stream
-
-
Property Detail
-
size
public ReadOnlyIntegerProperty sizeProperty
Specified by:
sizePropertyin classSetExpression<E>See Also:
-
empty
public ReadOnlyBooleanProperty emptyProperty
Specified by:
emptyPropertyin classSetExpression<E>See Also:
-
-
Constructor Detail
-
SetPropertyBase
public SetPropertyBase()
The Constructor ofSetPropertyBase
-
SetPropertyBase
public SetPropertyBase(ObservableSet<E> initialValue)
The constructor of theSetPropertyBase.Parameters:
initialValue- the initial value of the wrapped value
-
-
Method Detail
-
sizeProperty
public ReadOnlyIntegerProperty sizeProperty()
Description copied from class:SetExpressionAn integer property that represents the size of the set.Specified by:
sizePropertyin classSetExpression<E>See Also:
-
emptyProperty
public ReadOnlyBooleanProperty emptyProperty()
Description copied from class:SetExpressionA boolean property that istrue, if the set is empty.Specified by:
emptyPropertyin classSetExpression<E>See Also:
-
addListener
public void addListener(InvalidationListener listener)
Description copied from interface:ObservableAdds anInvalidationListenerwhich will be notified whenever theObservablebecomes 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
InvalidationListenerinstance may be safely registered for differentObservables.The
Observablestores 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 callingremoveListenerafter use or to use an instance ofWeakInvalidationListeneravoid this situation.Parameters:
listener- The listener to register
-
removeListener
public void removeListener(InvalidationListener listener)
Description copied from interface:ObservableRemoves the given listener from the list of listeners, that are notified whenever the value of theObservablebecomes 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.
Parameters:
listener- The listener to remove
-
addListener
public void addListener(ChangeListener<? super ObservableSet<E>> listener)
Description copied from interface:ObservableValueAdds aChangeListenerwhich will be notified whenever the value of theObservableValuechanges. 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
ChangeListenerinstance may be safely registered for differentObservableValues.The
ObservableValuestores 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 callingremoveListenerafter use or to use an instance ofWeakChangeListeneravoid this situation.Parameters:
listener- The listener to register
-
removeListener
public void removeListener(ChangeListener<? super ObservableSet<E>> listener)
Description copied from interface:ObservableValueRemoves the given listener from the list of listeners, that are notified whenever the value of theObservableValuechanges.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.
Parameters:
listener- The listener to remove
-
addListener
public void addListener(SetChangeListener<? super E> listener)
Description copied from interface:ObservableSetAdd a listener to this observable set.Parameters:
listener- the listener for listening to the set changes
-
removeListener
public void removeListener(SetChangeListener<? super E> listener)
Description copied from interface:ObservableSetTries to removed a listener from this observable set. If the listener is not attached to this list, nothing happens.Parameters:
listener- a listener to remove
-
fireValueChangedEvent
protected void fireValueChangedEvent()
Sends notifications to all attachedInvalidationListeners,ChangeListeners, andSetChangeListener. This method is called when the value is changed, either manually by callingset(javafx.collections.ObservableSet)or in case of a bound property, if the binding becomes invalid.
-
fireValueChangedEvent
protected void fireValueChangedEvent(SetChangeListener.Change<? extends E> change)
Sends notifications to all attachedInvalidationListeners,ChangeListeners, andSetChangeListener. This method is called when the content of the list changes.Parameters:
change- the change that needs to be propagated
-
invalidated
protected void invalidated()
The methodinvalidated()can be overridden to receive invalidation notifications. This is the preferred option inObjectsdefining the property, because it requires less memory. The default implementation is empty.
-
get
public ObservableSet<E> get()
Description copied from interface:WritableObjectValueGet the wrapped value. This must be identical to the value returned fromWritableValue.getValue().This method exists only to align WritableObjectValue API with
WritableBooleanValueand subclasses ofWritableNumberValueReturns:
The current value
-
set
public void set(ObservableSet<E> newValue)
Description copied from interface:WritableObjectValueSet the wrapped value. Should be equivalent toWritableValue.setValue(java.lang.Object)Parameters:
newValue- The new valueSee Also:
-
isBound
public boolean isBound()
Description copied from interface:PropertyCan be used to check, if aPropertyis bound.Returns:
trueif thePropertyis bound,falseotherwise
-
bind
public void bind(ObservableValue<? extends ObservableSet<E>> newObservable)
Description copied from interface:PropertyCreate a unidirection binding for thisProperty.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.
Parameters:
newObservable- The observable thisPropertyshould be bound to.
-
unbind
public void unbind()
Description copied from interface:PropertyRemove the unidirectional binding for thisProperty. If thePropertyis not bound, calling this method has no effect.
-
toString
public String toString()
Returns a string representation of thisSetPropertyBaseobject.Overrides:
toStringin classSetProperty<E>Returns:
a string representation of this
SetPropertyBaseobject.
-
© 2008, 2025, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from JavaFX API Documentation.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Java, JavaFX and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.