Module javafx.base
Package javafx.beans.property

Class MapProperty<K,​V>

java.lang.Object
javafx.beans.binding.MapExpression<K,​V>
javafx.beans.property.ReadOnlyMapProperty<K,​V>
javafx.beans.property.MapProperty<K,​V>
Type Parameters:
K - the type of the key elements of the Map
V - the type of the value elements of the Map
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>
Direct Known Subclasses:
MapPropertyBase
public abstract class MapProperty<K,​V>
extends ReadOnlyMapProperty<K,​V>
implements Property<ObservableMap<K,​V>>, WritableMapValue<K,​V>
This class provides a full implementation of a Property wrapping an ObservableMap. The value of a MapProperty can be get and set with ObservableObjectValue.get(), MapExpression.getValue(), WritableObjectValue.set(Object), and setValue(javafx.collections.ObservableMap). A property can be bound and unbound unidirectional with Property.bind(javafx.beans.value.ObservableValue) and Property.unbind(). Bidirectional bindings can be created and removed with bindBidirectional(Property) and unbindBidirectional(Property). The context of a MapProperty can be read with ReadOnlyProperty.getBean() and ReadOnlyProperty.getName().
Since:
JavaFX 2.1
See Also:
ObservableMap, ObservableMapValue, WritableMapValue, ReadOnlyMapProperty, Property

  • Constructor Details

    • MapProperty

      public MapProperty()
      Creates a default MapProperty.

  • Method Details

    • setValue

      public void setValue​(ObservableMap<K,​V> v)
      Set the wrapped value.
      Specified by:
      setValue in interface WritableValue<K>
      Parameters:
      v - The new value

    • bindBidirectional

      public void bindBidirectional​(Property<ObservableMap<K,​V>> other)
      Create a bidirectional binding between this Property and another one. Bidirectional bindings exists independently of unidirectional bindings. So it is possible to add unidirectional binding to a property with bidirectional binding and vice-versa. However, this practice is discouraged.

      It is possible to have multiple bidirectional bindings of one Property.

      JavaFX bidirectional binding implementation use weak listeners. This means bidirectional binding does not prevent properties from being garbage collected.

      Specified by:
      bindBidirectional in interface Property<K>
      Parameters:
      other - the other Property

    • unbindBidirectional

      public void unbindBidirectional​(Property<ObservableMap<K,​V>> other)
      Remove a bidirectional binding between this Property and another one. If no bidirectional binding between the properties exists, calling this method has no effect. It is possible to unbind by a call on the second property. This code will work: 
           property1.bindBirectional(property2);
     property2.unbindBidirectional(property1);
      Specified by:
      unbindBidirectional in interface Property<K>
      Parameters:
      other - the other Property

    • toString

      public String toString()
      Returns a string representation of this MapProperty object.
      Overrides:
      toString in class ReadOnlyMapProperty<K,​V>
      Returns:
      a string representation of this MapProperty object.