javafx.beans.property

Class ReadOnlyMapWrapper<K,V>

java.lang.Object

javafx.beans.binding.MapExpression<K,V>

javafx.beans.property.ReadOnlyMapProperty<K,V>

javafx.beans.property.MapProperty<K,V>

javafx.beans.property.MapPropertyBase<K,V>

javafx.beans.property.SimpleMapProperty<K,V>

javafx.beans.property.ReadOnlyMapWrapper<K,V>

All Implemented Interfaces:

Map<K,V>, Observable, Property<ObservableMap<K,V>>, ReadOnlyProperty<ObservableMap<K,V>>, ObservableMapValue<K,V>, ObservableObjectValue<ObservableMap<K,V>>, ObservableValue<ObservableMap<K,V>>, WritableMapValue<K,V>, WritableObjectValue<ObservableMap<K,V>>, WritableValue<ObservableMap<K,V>>, ObservableMap<K,V>

public class ReadOnlyMapWrapper<K,V>
extends SimpleMapProperty<K,V>

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.

Since:

JavaFX 2.1

Property Summary

Properties inherited from class javafx.beans.property.MapPropertyBase

empty, size

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
ReadOnlyMapWrapper() The constructor of ReadOnlyMapWrapper
ReadOnlyMapWrapper(Object bean, String name) The constructor of ReadOnlyMapWrapper
ReadOnlyMapWrapper(Object bean, String name, ObservableMap<K,V> initialValue) The constructor of ReadOnlyMapWrapper
ReadOnlyMapWrapper(ObservableMap<K,V> initialValue) The constructor of ReadOnlyMapWrapper

Method Summary

Modifier and Type	Method and Description
void	addListener(ChangeListener<? super ObservableMap<K,V>> 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(MapChangeListener<? super K,? super V> listener) Add a listener to this observable map.
protected void	fireValueChangedEvent() Sends notifications to all attached InvalidationListeners, ChangeListeners, and MapChangeListener.
protected void	fireValueChangedEvent(MapChangeListener.Change<? extends K,? extends V> change) Sends notifications to all attached InvalidationListeners, ChangeListeners, and MapChangeListener.
ReadOnlyMapProperty<K,V>	getReadOnlyProperty() Returns the readonly property, that is synchronized with this ReadOnlyMapWrapper.
void	removeListener(ChangeListener<? super ObservableMap<K,V>> 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(MapChangeListener<? super K,? super V> listener) Tries to removed a listener from this observable list.

Methods inherited from class javafx.beans.property.SimpleMapProperty

getBean, getName

Methods inherited from class javafx.beans.property.MapPropertyBase

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

Methods inherited from class javafx.beans.property.MapProperty

bindBidirectional, setValue, unbindBidirectional

Methods inherited from class javafx.beans.property.ReadOnlyMapProperty

bindContent, bindContentBidirectional, equals, hashCode, unbindContent, unbindContentBidirectional

Methods inherited from class javafx.beans.binding.MapExpression

asString, clear, containsKey, containsValue, entrySet, get, getSize, getValue, isEmpty, isEqualTo, isNotEqualTo, isNotNull, isNull, keySet, mapExpression, put, putAll, remove, size, valueAt, valueAt, values

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

clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, equals, forEach, get, getOrDefault, hashCode, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Constructor Detail

ReadOnlyMapWrapper

public ReadOnlyMapWrapper()

The constructor of ReadOnlyMapWrapper

ReadOnlyMapWrapper

public ReadOnlyMapWrapper(ObservableMap<K,V> initialValue)

The constructor of ReadOnlyMapWrapper

Parameters:

initialValue - the initial value of the wrapped value

ReadOnlyMapWrapper

public ReadOnlyMapWrapper(Object bean,
                          String name)

The constructor of ReadOnlyMapWrapper

Parameters:

bean - the bean of this ReadOnlyMapWrapper

name - the name of this ReadOnlyMapWrapper

ReadOnlyMapWrapper

public ReadOnlyMapWrapper(Object bean,
                          String name,
                          ObservableMap<K,V> initialValue)

The constructor of ReadOnlyMapWrapper

Parameters:

bean - the bean of this ReadOnlyMapWrapper

name - the name of this ReadOnlyMapWrapper

initialValue - the initial value of the wrapped value

Method Detail

getReadOnlyProperty

public ReadOnlyMapProperty<K,V> getReadOnlyProperty()

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

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 MapPropertyBase<K,V>

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 MapPropertyBase<K,V>

Parameters:

listener - The listener to remove

See Also:

Observable.addListener(InvalidationListener)

addListener

public void addListener(ChangeListener<? super ObservableMap<K,V>> 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<ObservableMap<K,V>>

Overrides:

addListener in class MapPropertyBase<K,V>

Parameters:

listener - The listener to register

See Also:

ObservableValue.removeListener(ChangeListener)

removeListener

public void removeListener(ChangeListener<? super ObservableMap<K,V>> 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<ObservableMap<K,V>>

Overrides:

removeListener in class MapPropertyBase<K,V>

Parameters:

listener - The listener to remove

See Also:

ObservableValue.addListener(ChangeListener)

addListener

public void addListener(MapChangeListener<? super K,? super V> listener)

Add a listener to this observable map.

Specified by:

addListener in interface ObservableMap<K,V>

Overrides:

addListener in class MapPropertyBase<K,V>

Parameters:

listener - the listener for listening to the list changes

removeListener

public void removeListener(MapChangeListener<? super K,? super V> listener)

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

Specified by:

removeListener in interface ObservableMap<K,V>

Overrides:

removeListener in class MapPropertyBase<K,V>

Parameters:

listener - a listener to remove

fireValueChangedEvent

protected void fireValueChangedEvent()

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

Overrides:

fireValueChangedEvent in class MapPropertyBase<K,V>

fireValueChangedEvent

protected void fireValueChangedEvent(MapChangeListener.Change<? extends K,? extends V> change)

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

Overrides:

fireValueChangedEvent in class MapPropertyBase<K,V>

Parameters:

change - the change that needs to be propagated