APIdia Launch Partner
Top Description Inners Fields Constructors Methods
javafx.beans.binding

public abstract Class MapBinding<K, V>

extends MapExpression<K, V>
implements Binding<ObservableMap<K, V>>
Class Inheritance
All Implemented Interfaces
javafx.beans.binding.Binding, javafx.beans.value.ObservableValue, javafx.beans.Observable
Type Parameters
<K>
the type of the key elements
<V>
the type of the value elements
Imports
com.sun.javafx.binding.BindingHelperObserver, .MapExpressionHelper, javafx.beans.InvalidationListener, .Observable, javafx.beans.property.ReadOnlyBooleanProperty, .ReadOnlyBooleanPropertyBase, .ReadOnlyIntegerProperty, .ReadOnlyIntegerPropertyBase, javafx.beans.value.ChangeListener, javafx.collections.FXCollections, .MapChangeListener, .ObservableList, .ObservableMap
Base class that provides most of the functionality needed to implement a Binding of an javafx.collections.ObservableMap.

MapBinding provides a simple invalidation-scheme. An extending class can register dependencies by calling bind(Observable...). If one of the registered dependencies becomes invalid, this MapBinding is marked as invalid. With unbind(Observable...) listening to dependencies can be stopped.

To provide a concrete implementation of this class, the method computeValue() has to be implemented to calculate the value of this binding based on the current state of the dependencies. It is called when get() is called for an invalid binding.

See DoubleBinding for an example how this base class can be extended.

Since
JavaFX 2.1
See Also
Binding, MapExpression

Nested and Inner Type Summary

Modifier and TypeClass and Description
private class
MapBinding.EmptyProperty

private class
MapBinding.SizeProperty

Field Summary

Modifier and TypeField and Description
private MapBinding<K, V>.EmptyProperty
empty0

private MapExpressionHelper<K, V>
helper

private final MapChangeListener<K, V>
mapChangeListener

private BindingHelperObserver
observer

private MapBinding<K, V>.SizeProperty
size0

private boolean
valid

private ObservableMap<K, V>
value

Constructor Summary

AccessConstructor and Description
public
MapBinding()

Creates a default MapBinding.

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 final void
bind(Observable...
the dependencies to observe
dependencies)

Start observing the dependencies for changes.

protected abstract ObservableMap<K, V>

Returns:

the current value
computeValue()

Calculates the current value of this binding.

public void
dispose()

Implements javafx.beans.binding.Binding.dispose.

A default implementation of dispose() that is empty.

public ReadOnlyBooleanProperty
emptyProperty()

Implements abstract javafx.beans.binding.MapExpression.emptyProperty.

A boolean property that is true, if the map is empty.

public final ObservableMap<K, V>

Returns:

the current value
get()

Implements javafx.beans.value.ObservableObjectValue.get.

Returns the result of computeValue().

public ObservableList<?>

Returns:

an empty ObservableList
getDependencies()

Implements javafx.beans.binding.Binding.getDependencies.

A default implementation of getDependencies() that returns an empty javafx.collections.ObservableList.

public final void
invalidate()

Implements javafx.beans.binding.Binding.invalidate.

Mark a binding as invalid.

private void
invalidateProperties()

public final boolean
isValid()

Implements javafx.beans.binding.Binding.isValid.

Checks if a binding is valid.

protected void
onInvalidating()

The method onInvalidating() can be overridden by extending classes to react, if this binding becomes invalid.

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.

public ReadOnlyIntegerProperty
sizeProperty()

Implements abstract javafx.beans.binding.MapExpression.sizeProperty.

An integer property that represents the size of the map.

public String

Returns:

a string representation of this MapBinding object.
toString()

Overrides java.lang.Object.toString.

Returns a string representation of this MapBinding object.

protected final void
unbind(Observable...
the dependencies to stop observing
dependencies)

Stop observing the dependencies for changes.

Inherited from javafx.beans.binding.MapExpression:
asStringclearcontainsKeycontainsValueentrySetgetgetSizegetValueisEmptyisEqualToisNotEqualToisNotNullisNullkeySetmapExpressionputputAllremovesizevalueAtvalueAtvalues

Field Detail

empty0back to summary
private MapBinding<K, V>.EmptyProperty empty0
helperback to summary
private MapExpressionHelper<K, V> helper
mapChangeListenerback to summary
private final MapChangeListener<K, V> mapChangeListener
observerback to summary
private BindingHelperObserver observer
size0back to summary
private MapBinding<K, V>.SizeProperty size0
validback to summary
private boolean valid
valueback to summary
private ObservableMap<K, V> value

Constructor Detail

MapBindingback to summary
public MapBinding()

Creates a default MapBinding.

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
bindback to summary
protected final void bind(Observable... dependencies)

Start observing the dependencies for changes. If the value of one of the dependencies changes, the binding is marked as invalid.

Parameters
dependencies:Observable[]

the dependencies to observe

computeValueback to summary
protected abstract ObservableMap<K, V> computeValue()

Calculates the current value of this binding.

Classes extending MapBinding have to provide an implementation of computeValue.

Returns:ObservableMap<K, V>

the current value

disposeback to summary
public void dispose()

Implements javafx.beans.binding.Binding.dispose.

A default implementation of dispose() that is empty.

Annotations
@Override
emptyPropertyback to summary
public ReadOnlyBooleanProperty emptyProperty()

Implements abstract javafx.beans.binding.MapExpression.emptyProperty.

Doc from javafx.beans.binding.MapExpression.emptyProperty.

A boolean property that is true, if the map is empty.

Annotations
@Override
getback to summary
public final ObservableMap<K, V> get()

Implements javafx.beans.value.ObservableObjectValue.get.

Returns the result of computeValue(). The method computeValue() is only called if the binding is invalid. The result is cached and returned if the binding did not become invalid since the last call of get().

Returns:ObservableMap<K, V>

the current value

Annotations
@Override
getDependenciesback to summary
public ObservableList<?> getDependencies()

Implements javafx.beans.binding.Binding.getDependencies.

A default implementation of getDependencies() that returns an empty javafx.collections.ObservableList.

Returns:ObservableList<?>

an empty ObservableList

Annotations
@Override
invalidateback to summary
public final void invalidate()

Implements javafx.beans.binding.Binding.invalidate.

Doc from javafx.beans.binding.Binding.invalidate.

Mark a binding as invalid. This forces the recalculation of the value of the Binding next time it is request.

Annotations
@Override
invalidatePropertiesback to summary
private void invalidateProperties()
isValidback to summary
public final boolean isValid()

Implements javafx.beans.binding.Binding.isValid.

Doc from javafx.beans.binding.Binding.isValid.

Checks if a binding is valid.

Annotations
@Override
onInvalidatingback to summary
protected void onInvalidating()

The method onInvalidating() can be overridden by extending classes to react, if this binding becomes invalid. The default implementation is empty.

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
sizePropertyback to summary
public ReadOnlyIntegerProperty sizeProperty()

Implements abstract javafx.beans.binding.MapExpression.sizeProperty.

Doc from javafx.beans.binding.MapExpression.sizeProperty.

An integer property that represents the size of the map.

Annotations
@Override
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Returns a string representation of this MapBinding object.

Returns:String

a string representation of this MapBinding object.

Annotations
@Override
unbindback to summary
protected final void unbind(Observable... dependencies)

Stop observing the dependencies for changes.

Parameters
dependencies:Observable[]

the dependencies to stop observing

javafx.beans.binding back to summary

private Class MapBinding.EmptyProperty

extends ReadOnlyBooleanPropertyBase
Class Inheritance

Constructor Summary

AccessConstructor and Description
private
EmptyProperty()

Method Summary

Modifier and TypeMethod and Description
protected void
fireValueChangedEvent()

Overrides javafx.beans.property.ReadOnlyBooleanPropertyBase.fireValueChangedEvent.

Sends notifications to all attached InvalidationListeners and ChangeListeners.

public boolean
get()

Implements javafx.beans.value.ObservableBooleanValue.get.

Returns the current value of this ObservableBooleanValue.

public Object
getBean()

Implements javafx.beans.property.ReadOnlyProperty.getBean.

Returns the Object that contains this property.

public String
getName()

Implements javafx.beans.property.ReadOnlyProperty.getName.

Returns the name of this property.

Inherited from javafx.beans.property.ReadOnlyBooleanPropertyBase:
addListeneraddListenerremoveListenerremoveListener

Constructor Detail

EmptyPropertyback to summary
private EmptyProperty()

Method Detail

fireValueChangedEventback to summary
protected void fireValueChangedEvent()

Overrides javafx.beans.property.ReadOnlyBooleanPropertyBase.fireValueChangedEvent.

Doc from javafx.beans.property.ReadOnlyBooleanPropertyBase.fireValueChangedEvent.

Sends notifications to all attached InvalidationListeners and ChangeListeners. This method needs to be called, if the value of this property changes.

Annotations
@Override
getback to summary
public boolean get()

Implements javafx.beans.value.ObservableBooleanValue.get.

Doc from javafx.beans.value.ObservableBooleanValue.get.

Returns the current value of this ObservableBooleanValue.

Annotations
@Override
getBeanback to summary
public Object getBean()

Implements javafx.beans.property.ReadOnlyProperty.getBean.

Doc from javafx.beans.property.ReadOnlyProperty.getBean.

Returns the Object that contains this property. If this property is not contained in an Object, null is returned.

Annotations
@Override
getNameback to summary
public String getName()

Implements javafx.beans.property.ReadOnlyProperty.getName.

Doc from javafx.beans.property.ReadOnlyProperty.getName.

Returns the name of this property. If the property does not have a name, this method returns an empty String.

Annotations
@Override
javafx.beans.binding back to summary

private Class MapBinding.SizeProperty

extends ReadOnlyIntegerPropertyBase
Class Inheritance

Constructor Summary

AccessConstructor and Description
private
SizeProperty()

Method Summary

Modifier and TypeMethod and Description
protected void
fireValueChangedEvent()

Overrides javafx.beans.property.ReadOnlyIntegerPropertyBase.fireValueChangedEvent.

Sends notifications to all attached InvalidationListeners and ChangeListeners.

public int
get()

Implements javafx.beans.value.ObservableIntegerValue.get.

Returns the current value of this ObservableIntegerValue.

public Object
getBean()

Implements javafx.beans.property.ReadOnlyProperty.getBean.

Returns the Object that contains this property.

public String
getName()

Implements javafx.beans.property.ReadOnlyProperty.getName.

Returns the name of this property.

Inherited from javafx.beans.property.ReadOnlyIntegerPropertyBase:
addListeneraddListenerremoveListenerremoveListener

Constructor Detail

SizePropertyback to summary
private SizeProperty()

Method Detail

fireValueChangedEventback to summary
protected void fireValueChangedEvent()

Overrides javafx.beans.property.ReadOnlyIntegerPropertyBase.fireValueChangedEvent.

Doc from javafx.beans.property.ReadOnlyIntegerPropertyBase.fireValueChangedEvent.

Sends notifications to all attached InvalidationListeners and ChangeListeners. This method needs to be called, if the value of this property changes.

Annotations
@Override
getback to summary
public int get()

Implements javafx.beans.value.ObservableIntegerValue.get.

Doc from javafx.beans.value.ObservableIntegerValue.get.

Returns the current value of this ObservableIntegerValue.

Annotations
@Override
getBeanback to summary
public Object getBean()

Implements javafx.beans.property.ReadOnlyProperty.getBean.

Doc from javafx.beans.property.ReadOnlyProperty.getBean.

Returns the Object that contains this property. If this property is not contained in an Object, null is returned.

Annotations
@Override
getNameback to summary
public String getName()

Implements javafx.beans.property.ReadOnlyProperty.getName.

Doc from javafx.beans.property.ReadOnlyProperty.getName.

Returns the name of this property. If the property does not have a name, this method returns an empty String.

Annotations
@Override