APIdia Launch Partner
Top Description Fields Constructors Methods
javafx.beans.property

public abstract Class ReadOnlyMapPropertyBase<K, V>

extends ReadOnlyMapProperty<K, V>
Class Inheritance
Known Direct Subclasses
javafx.beans.property.ReadOnlyMapWrapper.ReadOnlyPropertyImpl
Type Parameters
<K>
the map key type
<V>
the map value type
Imports
com.sun.javafx.binding.MapExpressionHelper, javafx.beans.InvalidationListener, javafx.beans.value.ChangeListener, javafx.collections.MapChangeListener, .ObservableMap
Base class for all readonly properties wrapping an javafx.collections.ObservableMap. This class provides a default implementation to attach listener.
Since
JavaFX 2.1
See Also
ReadOnlyMapProperty

Field Summary

Modifier and TypeField and Description
private MapExpressionHelper<K, V>
helper

Constructor Summary

AccessConstructor and Description
public
ReadOnlyMapPropertyBase()

Creates a default ReadOnlyMapPropertyBase.

Method Summary

Modifier and TypeMethod and Description
public void
addListener(InvalidationListener listener)

Implements javafx.beans.Observable.addListener.

Adds an InvalidationListener which will be notified whenever the Observable becomes invalid.

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

Implements javafx.beans.value.ObservableValue.addListener.

Adds a ChangeListener which will be notified whenever the value of the ObservableValue changes.

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

Implements javafx.collections.ObservableMap.addListener.

Add a listener to this observable map.

protected void
fireValueChangedEvent()

This method needs to be called if the reference to the javafx.collections.ObservableList changes.

protected void
fireValueChangedEvent(MapChangeListener.Change<? extends K, ? extends V>
the change that needs to be propagated
change)

This method needs to be called if the content of the referenced javafx.collections.ObservableList changes.

public void
removeListener(InvalidationListener listener)

Implements javafx.beans.Observable.removeListener.

Removes the given listener from the list of listeners, that are notified whenever the value of the Observable becomes invalid.

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

Implements javafx.beans.value.ObservableValue.removeListener.

Removes the given listener from the list of listeners that are notified whenever the value of the ObservableValue changes.

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

Implements javafx.collections.ObservableMap.removeListener.

Tries to removed a listener from this observable map.

Inherited from javafx.beans.property.ReadOnlyMapProperty:
bindContentbindContentBidirectionalequalshashCodetoStringunbindContentunbindContentBidirectional

Field Detail

helperback to summary
private MapExpressionHelper<K, V> helper

Constructor Detail

ReadOnlyMapPropertyBaseback to summary
public ReadOnlyMapPropertyBase()

Creates a default ReadOnlyMapPropertyBase.

Method Detail

addListenerback to summary
public void addListener(InvalidationListener listener)

Implements javafx.beans.Observable.addListener.

Doc from javafx.beans.Observable.addListener.

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.

Annotations
@Override
addListenerback to summary
public void addListener(ChangeListener<? super ObservableMap<K, V>> listener)

Implements javafx.beans.value.ObservableValue.addListener.

Doc from javafx.beans.value.ObservableValue.addListener.

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.

Annotations
@Override
addListenerback to summary
public void addListener(MapChangeListener<? super K, ? super V> listener)

Implements javafx.collections.ObservableMap.addListener.

Doc from javafx.collections.ObservableMap.addListener.

Add a listener to this observable map.

Annotations
@Override
fireValueChangedEventback to summary
protected void fireValueChangedEvent()

This method needs to be called if the reference to the javafx.collections.ObservableList changes. It sends notifications to all attached InvalidationListeners, ChangeListeners, and javafx.collections.ListChangeListener. This method needs to be called, if the value of this property changes.

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

This method needs to be called if the content of the referenced javafx.collections.ObservableList changes. Sends notifications to all attached InvalidationListeners, ChangeListeners, and javafx.collections.ListChangeListener. This method is called when the content of the list changes.

Parameters
change:MapChangeListener.Change<? extends K, ? extends V>

the change that needs to be propagated

removeListenerback to summary
public void removeListener(InvalidationListener listener)

Implements javafx.beans.Observable.removeListener.

Doc from javafx.beans.Observable.removeListener.

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.

Annotations
@Override
removeListenerback to summary
public void removeListener(ChangeListener<? super ObservableMap<K, V>> listener)

Implements javafx.beans.value.ObservableValue.removeListener.

Doc from javafx.beans.value.ObservableValue.removeListener.

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.

Annotations
@Override
removeListenerback to summary
public void removeListener(MapChangeListener<? super K, ? super V> listener)

Implements javafx.collections.ObservableMap.removeListener.

Doc from javafx.collections.ObservableMap.removeListener.

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

Annotations
@Override