javafx.beans.property

Class ReadOnlyMapProperty<K,V>

java.lang.Object

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

javafx.beans.property.ReadOnlyMapProperty<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:

java.util.Map<K,V>, Observable, ReadOnlyProperty<ObservableMap<K,V>>, ObservableMapValue<K,V>, ObservableObjectValue<ObservableMap<K,V>>, ObservableValue<ObservableMap<K,V>>, ObservableMap<K,V>

Direct Known Subclasses:

MapProperty, ReadOnlyMapPropertyBase

public abstract class ReadOnlyMapProperty<K,V>
extends MapExpression<K,V>
implements ReadOnlyProperty<ObservableMap<K,V>>

Super class for all readonly properties wrapping an ObservableMap.

See Also:

ObservableMap, ObservableMapValue, MapExpression, ReadOnlyProperty

Property Summary

Properties inherited from class javafx.beans.binding.MapExpression

empty, size

Nested Class Summary

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

java.util.Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
ReadOnlyMapProperty() The constructor of ReadOnlyMapProperty.

Method Summary

Methods

Modifier and Type	Method and Description
void	bindContent(ObservableMap<K,V> map) Creates a content binding between the ObservableMap, that is wrapped in this ReadOnlyMapProperty, and another ObservableMap.
void	bindContentBidirectional(ObservableMap<K,V> map) Creates a bidirectional content binding of the ObservableMap, that is wrapped in this ReadOnlyMapProperty, and another ObservableMap.
boolean	equals(java.lang.Object obj) Indicates whether some other object is "equal to" this one.
int	hashCode() Returns a hash code for this ReadOnlyMapProperty object.
java.lang.String	toString() Returns a string representation of this ReadOnlyMapProperty object.
void	unbindContent(java.lang.Object object) Deletes a content binding between the ObservableMap, that is wrapped in this ReadOnlyMapProperty, and another Object.
void	unbindContentBidirectional(java.lang.Object object) Deletes a bidirectional content binding between the ObservableMap, that is wrapped in this ReadOnlyMapProperty, and another Object.

Methods inherited from class javafx.beans.binding.MapExpression

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

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface javafx.beans.property.ReadOnlyProperty

getBean, getName

Methods inherited from interface javafx.beans.value.ObservableValue

addListener, getValue, removeListener

Methods inherited from interface javafx.beans.Observable

addListener, removeListener

Methods inherited from interface javafx.beans.value.ObservableObjectValue

get

Methods inherited from interface javafx.collections.ObservableMap

addListener, removeListener

Constructor Detail

ReadOnlyMapProperty

public ReadOnlyMapProperty()

The constructor of ReadOnlyMapProperty.

Method Detail

bindContentBidirectional

public void bindContentBidirectional(ObservableMap<K,V> map)

Creates a bidirectional content binding of the ObservableMap, that is wrapped in this ReadOnlyMapProperty, and another ObservableMap.

A bidirectional content binding ensures that the content of two ObservableMaps is the same. If the content of one of the maps changes, the other one will be updated automatically.

Parameters:

map - the ObservableMap this property should be bound to

Throws:

java.lang.NullPointerException - if map is null

java.lang.IllegalArgumentException - if map is the same map that this ReadOnlyMapProperty points to

unbindContentBidirectional

public void unbindContentBidirectional(java.lang.Object object)

Deletes a bidirectional content binding between the ObservableMap, that is wrapped in this ReadOnlyMapProperty, and another Object.

Parameters:

object - the Object to which the bidirectional binding should be removed

Throws:

java.lang.NullPointerException - if object is null

java.lang.IllegalArgumentException - if object is the same map that this ReadOnlyMapProperty points to

bindContent

public void bindContent(ObservableMap<K,V> map)

Creates a content binding between the ObservableMap, that is wrapped in this ReadOnlyMapProperty, and another ObservableMap.

A content binding ensures that the content of the wrapped ObservableMaps is the same as that of the other map. If the content of the other map changes, the wrapped map will be updated automatically. Once the wrapped list is bound to another map, you must not change it directly.

Parameters:

map - the ObservableMap this property should be bound to

Throws:

java.lang.NullPointerException - if map is null

java.lang.IllegalArgumentException - if map is the same map that this ReadOnlyMapProperty points to

unbindContent

public void unbindContent(java.lang.Object object)

Deletes a content binding between the ObservableMap, that is wrapped in this ReadOnlyMapProperty, and another Object.

Parameters:

object - the Object to which the binding should be removed

Throws:

java.lang.NullPointerException - if object is null

java.lang.IllegalArgumentException - if object is the same map that this ReadOnlyMapProperty points to

equals

public boolean equals(java.lang.Object obj)

Indicates whether some other object is "equal to" this one.

Specified by:

equals in interface java.util.Map<K,V>

Overrides:

equals in class java.lang.Object

Parameters:

obj - the reference object with which to compare.

Returns:

true if this object is equal to the obj argument; false otherwise.

hashCode

public int hashCode()

Returns a hash code for this ReadOnlyMapProperty object.

Specified by:

hashCode in interface java.util.Map<K,V>

Overrides:

hashCode in class java.lang.Object

Returns:

a hash code for this ReadOnlyMapProperty object.

toString

public java.lang.String toString()

Returns a string representation of this ReadOnlyMapProperty object.

Overrides:

toString in class java.lang.Object

Returns:

a string representation of this ReadOnlyMapProperty object.