- Type Parameters:
K
- the type of the key elements of theMap
V
- the type of the value elements of theMap
- 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:
SimpleMapProperty
public abstract class MapPropertyBase<K,V> extends MapProperty<K,V>
MapPropertyBase
is the base class for a property
wrapping an ObservableMap
.
It provides all the functionality required for a property except for the
ReadOnlyProperty.getBean()
and ReadOnlyProperty.getName()
methods, which must be implemented
by extending classes.- Since:
- JavaFX 2.1
- See Also:
ObservableMap
,MapProperty
-
Property Summary
Properties Type Property Description ReadOnlyBooleanProperty
empty
A boolean property that istrue
, if the map is empty.ReadOnlyIntegerProperty
size
An integer property that represents the size of the map. -
Nested Class Summary
-
Constructor Summary
Constructors Constructor Description MapPropertyBase()
The Constructor ofMapPropertyBase
MapPropertyBase(ObservableMap<K,V> initialValue)
The constructor of theMapPropertyBase
. -
Method Summary
Modifier and Type Method Description void
addListener(InvalidationListener listener)
Adds anInvalidationListener
which will be notified whenever theObservable
becomes invalid.void
addListener(ChangeListener<? super ObservableMap<K,V>> listener)
Adds aChangeListener
which will be notified whenever the value of theObservableValue
changes.void
addListener(MapChangeListener<? super K,? super V> listener)
Add a listener to this observable map.void
bind(ObservableValue<? extends ObservableMap<K,V>> newObservable)
Create a unidirection binding for thisProperty
.ReadOnlyBooleanProperty
emptyProperty()
A boolean property that istrue
, if the map is empty.protected void
fireValueChangedEvent()
protected void
fireValueChangedEvent(MapChangeListener.Change<? extends K,? extends V> change)
ObservableMap<K,V>
get()
Get the wrapped value.protected void
invalidated()
The methodinvalidated()
can be overridden to receive invalidation notifications.boolean
isBound()
Can be used to check, if aProperty
is bound.void
removeListener(InvalidationListener listener)
Removes the given listener from the list of listeners, that are notified whenever the value of theObservable
becomes invalid.void
removeListener(ChangeListener<? super ObservableMap<K,V>> listener)
Removes the given listener from the list of listeners that are notified whenever the value of theObservableValue
changes.void
removeListener(MapChangeListener<? super K,? super V> listener)
Tries to removed a listener from this observable map.void
set(ObservableMap<K,V> newValue)
Set the wrapped value.ReadOnlyIntegerProperty
sizeProperty()
An integer property that represents the size of the map.String
toString()
Returns a string representation of thisMapPropertyBase
object.void
unbind()
Remove the unidirectional binding for thisProperty
.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 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
Methods inherited from interface javafx.beans.value.ObservableValue
getValue
Methods inherited from interface javafx.beans.property.ReadOnlyProperty
getBean, getName
Methods inherited from interface javafx.beans.value.WritableValue
getValue
-
Property Details
-
size
- Specified by:
sizeProperty
in classMapExpression<K,V>
- See Also:
MapExpression.getSize()
-
empty
- Specified by:
emptyProperty
in classMapExpression<K,V>
- See Also:
MapExpression.isEmpty()
-
-
Constructor Details
-
MapPropertyBase
public MapPropertyBase()The Constructor ofMapPropertyBase
-
MapPropertyBase
The constructor of theMapPropertyBase
.- Parameters:
initialValue
- the initial value of the wrapped value
-
-
Method Details
-
sizeProperty
Description copied from class:MapExpression
An integer property that represents the size of the map.- Specified by:
sizeProperty
in classMapExpression<K,V>
- See Also:
MapExpression.getSize()
-
emptyProperty
Description copied from class:MapExpression
A boolean property that istrue
, if the map is empty.- Specified by:
emptyProperty
in classMapExpression<K,V>
- See Also:
MapExpression.isEmpty()
-
addListener
Description copied from interface:Observable
Adds anInvalidationListener
which will be notified whenever theObservable
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 differentObservables
.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 callingremoveListener
after use or to use an instance ofWeakInvalidationListener
avoid this situation.- Parameters:
listener
- The listener to register- See Also:
Observable.removeListener(InvalidationListener)
-
removeListener
Description copied from interface:Observable
Removes the given listener from the list of listeners, that are notified whenever the value of theObservable
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.
- Parameters:
listener
- The listener to remove- See Also:
Observable.addListener(InvalidationListener)
-
addListener
Description copied from interface:ObservableValue
Adds aChangeListener
which will be notified whenever the value of theObservableValue
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 differentObservableValues
.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 callingremoveListener
after use or to use an instance ofWeakChangeListener
avoid this situation.- Parameters:
listener
- The listener to register- See Also:
ObservableValue.removeListener(ChangeListener)
-
removeListener
Description copied from interface:ObservableValue
Removes the given listener from the list of listeners that are notified whenever the value of theObservableValue
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.
- Parameters:
listener
- The listener to remove- See Also:
ObservableValue.addListener(ChangeListener)
-
addListener
Description copied from interface:ObservableMap
Add a listener to this observable map.- Parameters:
listener
- the listener for listening to the list changes
-
removeListener
Description copied from interface:ObservableMap
Tries to removed a listener from this observable map. If the listener is not attached to this map, nothing happens.- Parameters:
listener
- a listener to remove
-
fireValueChangedEvent
protected void fireValueChangedEvent()Sends notifications to all attachedInvalidationListeners
,ChangeListeners
, andMapChangeListener
. This method is called when the value is changed, either manually by callingset(javafx.collections.ObservableMap)
or in case of a bound property, if the binding becomes invalid. -
fireValueChangedEvent
Sends notifications to all attachedInvalidationListeners
,ChangeListeners
, andMapChangeListener
. This method is called when the content of the list changes.- Parameters:
change
- the change that needs to be propagated
-
invalidated
protected void invalidated()The methodinvalidated()
can be overridden to receive invalidation notifications. This is the preferred option inObjects
defining the property, because it requires less memory. The default implementation is empty. -
get
Description copied from interface:WritableObjectValue
Get the wrapped value. This must be identical to the value returned fromWritableValue.getValue()
.This method exists only to align WritableObjectValue API with
WritableBooleanValue
and subclasses ofWritableNumberValue
- Returns:
- The current value
-
set
Description copied from interface:WritableObjectValue
Set the wrapped value. Should be equivalent toWritableValue.setValue(java.lang.Object)
- Parameters:
newValue
- The new value- See Also:
WritableObjectValue.get()
-
isBound
public boolean isBound()Description copied from interface:Property
Can be used to check, if aProperty
is bound.- Returns:
true
if theProperty
is bound,false
otherwise- See Also:
Property.bind(javafx.beans.value.ObservableValue)
-
bind
Description copied from interface:Property
Create a unidirection binding for thisProperty
.Note that JavaFX has all the bind calls implemented through weak listeners. This means the bound property can be garbage collected and stopped from being updated.
- Parameters:
newObservable
- The observable thisProperty
should be bound to.
-
unbind
public void unbind()Description copied from interface:Property
Remove the unidirectional binding for thisProperty
. If theProperty
is not bound, calling this method has no effect. -
toString
Returns a string representation of thisMapPropertyBase
object.- Overrides:
toString
in classMapProperty<K,V>
- Returns:
- a string representation of this
MapPropertyBase
object.
-