javafx.beans.property

Class ReadOnlySetWrapper<E>

java.lang.Object

javafx.beans.binding.SetExpression<E>

javafx.beans.property.ReadOnlySetProperty<E>

javafx.beans.property.SetProperty<E>

javafx.beans.property.SetPropertyBase<E>

javafx.beans.property.SimpleSetProperty<E>

javafx.beans.property.ReadOnlySetWrapper<E>

All Implemented Interfaces:

java.lang.Iterable<E>, java.util.Collection<E>, java.util.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>

public class ReadOnlySetWrapper<E>
extends SimpleSetProperty<E>

This class provides a convenient class to define read-only properties. It creates two properties that are synchronized. One property is read-only and can be passed to external users. The other property is read- and writable and should be used internally only.

Property Summary

Properties inherited from class javafx.beans.property.SetPropertyBase

empty, size

Constructor Summary

Constructors

Constructor and Description
ReadOnlySetWrapper() The constructor of ReadOnlySetWrapper
ReadOnlySetWrapper(java.lang.Object bean, java.lang.String name) The constructor of ReadOnlySetWrapper
ReadOnlySetWrapper(java.lang.Object bean, java.lang.String name, ObservableSet<E> initialValue) The constructor of ReadOnlySetWrapper
ReadOnlySetWrapper(ObservableSet<E> initialValue) The constructor of ReadOnlySetWrapper

Method Summary

Methods

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.
protected void	fireValueChangedEvent() Sends notifications to all attached InvalidationListeners, ChangeListeners, and SetChangeListener.
protected void	fireValueChangedEvent(SetChangeListener.Change<? extends E> change) Sends notifications to all attached InvalidationListeners, ChangeListeners, and SetChangeListener.
ReadOnlySetProperty<E>	getReadOnlyProperty() Returns the readonly property, that is synchronized with this ReadOnlySetWrapper.
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.

Methods inherited from class javafx.beans.property.SimpleSetProperty

getBean, getName

Methods inherited from class javafx.beans.property.SetPropertyBase

bind, emptyProperty, get, invalidated, isBound, set, sizeProperty, toString, unbind

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.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, toArray, toArray

Constructor Detail

ReadOnlySetWrapper

public ReadOnlySetWrapper()

The constructor of ReadOnlySetWrapper

ReadOnlySetWrapper

public ReadOnlySetWrapper(ObservableSet<E> initialValue)

The constructor of ReadOnlySetWrapper

Parameters:

initialValue - the initial value of the wrapped value

ReadOnlySetWrapper

public ReadOnlySetWrapper(java.lang.Object bean,
                  java.lang.String name)

The constructor of ReadOnlySetWrapper

Parameters:

bean - the bean of this ReadOnlySetWrapper

name - the name of this ReadOnlySetWrapper

ReadOnlySetWrapper

public ReadOnlySetWrapper(java.lang.Object bean,
                  java.lang.String name,
                  ObservableSet<E> initialValue)

The constructor of ReadOnlySetWrapper

Parameters:

bean - the bean of this ReadOnlySetWrapper

name - the name of this ReadOnlySetWrapper

initialValue - the initial value of the wrapped value

Method Detail

getReadOnlyProperty

public ReadOnlySetProperty<E> getReadOnlyProperty()

Returns the readonly property, that is synchronized with this ReadOnlySetWrapper.

Returns:

the readonly property

addListener

public void addListener(InvalidationListener listener)

Adds an InvalidationListener 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.

Specified by:

addListener in interface Observable

Overrides:

addListener in class SetPropertyBase<E>

Parameters:

listener - The listener to register

See Also:

Observable.removeListener(InvalidationListener)

removeListener

public void removeListener(InvalidationListener listener)

Removes the given listener from the list of listeners, that are notified whenever the value of the Observable 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 interface Observable

Overrides:

removeListener in class SetPropertyBase<E>

Parameters:

listener - The listener to remove

See Also:

Observable.addListener(InvalidationListener)

addListener

public void addListener(ChangeListener<? super ObservableSet<E>> listener)

Adds a ChangeListener 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.

Specified by:

addListener in interface ObservableValue<ObservableSet<E>>

Overrides:

addListener in class SetPropertyBase<E>

Parameters:

listener - The listener to register

See Also:

ObservableValue.removeListener(ChangeListener)

removeListener

public 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.

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 interface ObservableValue<ObservableSet<E>>

Overrides:

removeListener in class SetPropertyBase<E>

Parameters:

listener - The listener to remove

See Also:

ObservableValue.addListener(ChangeListener)

addListener

public void addListener(SetChangeListener<? super E> listener)

Add a listener to this observable set.

Specified by:

addListener in interface ObservableSet<E>

Overrides:

addListener in class SetPropertyBase<E>

Parameters:

listener - the listener for listening to the set changes

removeListener

public void removeListener(SetChangeListener<? super E> listener)

Tries to removed a listener from this observable set. If the listener is not attached to this list, nothing happens.

Specified by:

removeListener in interface ObservableSet<E>

Overrides:

removeListener in class SetPropertyBase<E>

Parameters:

listener - a listener to remove

fireValueChangedEvent

protected void fireValueChangedEvent()

Sends notifications to all attached InvalidationListeners, ChangeListeners, and SetChangeListener. This method is called when the value is changed, either manually by calling SetPropertyBase.set(javafx.collections.ObservableSet) or in case of a bound property, if the binding becomes invalid.

Overrides:

fireValueChangedEvent in class SetPropertyBase<E>

fireValueChangedEvent

protected void fireValueChangedEvent(SetChangeListener.Change<? extends E> change)

Sends notifications to all attached InvalidationListeners, ChangeListeners, and SetChangeListener. This method is called when the content of the list changes.

Overrides:

fireValueChangedEvent in class SetPropertyBase<E>

Parameters:

change - the change that needs to be propagated