- java.lang.Object
- 
- javafx.beans.binding.MapExpression<K,V>
- 
- javafx.beans.property.ReadOnlyMapProperty<K,V>
- 
- javafx.beans.property.MapProperty<K,V>
- 
- javafx.beans.property.MapPropertyBase<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:
- SimpleMapProperty
 
 public abstract class MapPropertyBase<K,V> extends MapProperty<K,V> The classMapPropertyBaseis the base class for a property wrapping anObservableMap. It provides all the functionality required for a property except for theReadOnlyProperty.getBean()andReadOnlyProperty.getName()methods, which must be implemented by extending classes.- Since:
- JavaFX 2.1
- See Also:
- ObservableMap,- MapProperty
 
- 
- 
Property SummaryProperties Type Property Description ReadOnlyBooleanPropertyemptyA boolean property that istrue, if the map is empty.ReadOnlyIntegerPropertysizeAn integer property that represents the size of the map.
 - 
Constructor SummaryConstructors Constructor Description MapPropertyBase()The Constructor ofMapPropertyBaseMapPropertyBase(ObservableMap<K,V> initialValue)The constructor of theMapPropertyBase.
 - 
Method SummaryModifier and Type Method Description voidaddListener(InvalidationListener listener)Adds anInvalidationListenerwhich will be notified whenever theObservablebecomes invalid.voidaddListener(ChangeListener<? super ObservableMap<K,V>> listener)Adds aChangeListenerwhich will be notified whenever the value of theObservableValuechanges.voidaddListener(MapChangeListener<? super K,? super V> listener)Add a listener to this observable map.voidbind(ObservableValue<? extends ObservableMap<K,V>> newObservable)Create a unidirection binding for thisProperty.ReadOnlyBooleanPropertyemptyProperty()A boolean property that istrue, if the map is empty.protected voidfireValueChangedEvent()protected voidfireValueChangedEvent(MapChangeListener.Change<? extends K,? extends V> change)ObservableMap<K,V>get()Get the wrapped value.protected voidinvalidated()The methodinvalidated()can be overridden to receive invalidation notifications.booleanisBound()Can be used to check, if aPropertyis bound.voidremoveListener(InvalidationListener listener)Removes the given listener from the list of listeners, that are notified whenever the value of theObservablebecomes invalid.voidremoveListener(ChangeListener<? super ObservableMap<K,V>> listener)Removes the given listener from the list of listeners that are notified whenever the value of theObservableValuechanges.voidremoveListener(MapChangeListener<? super K,? super V> listener)Tries to removed a listener from this observable map.voidset(ObservableMap<K,V> newValue)Set the wrapped value.ReadOnlyIntegerPropertysizeProperty()An integer property that represents the size of the map.StringtoString()Returns a string representation of thisMapPropertyBaseobject.voidunbind()Remove the unidirectional binding for thisProperty.- 
Methods inherited from class javafx.beans.property.MapPropertybindBidirectional, setValue, unbindBidirectional
 - 
Methods inherited from class javafx.beans.property.ReadOnlyMapPropertybindContent, bindContentBidirectional, equals, hashCode, unbindContent, unbindContentBidirectional
 - 
Methods inherited from class javafx.beans.binding.MapExpressionasString, 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.Objectclone, finalize, getClass, notify, notifyAll, wait, wait, wait
 - 
Methods inherited from interface java.util.Mapclear, 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.ObservableValuegetValue
 - 
Methods inherited from interface javafx.beans.property.ReadOnlyPropertygetBean, getName
 - 
Methods inherited from interface javafx.beans.value.WritableValuegetValue
 
- 
 
- 
- 
- 
Property Detail- 
sizepublic ReadOnlyIntegerProperty sizeProperty - Specified by:
- sizePropertyin class- MapExpression<K,V>
- See Also:
- MapExpression.getSize()
 
 - 
emptypublic ReadOnlyBooleanProperty emptyProperty - Specified by:
- emptyPropertyin class- MapExpression<K,V>
- See Also:
- MapExpression.isEmpty()
 
 
- 
 - 
Constructor Detail- 
MapPropertyBasepublic MapPropertyBase() The Constructor ofMapPropertyBase
 - 
MapPropertyBasepublic MapPropertyBase(ObservableMap<K,V> initialValue) The constructor of theMapPropertyBase.- Parameters:
- initialValue- the initial value of the wrapped value
 
 
- 
 - 
Method Detail- 
sizePropertypublic ReadOnlyIntegerProperty sizeProperty() Description copied from class:MapExpressionAn integer property that represents the size of the map.- Specified by:
- sizePropertyin class- MapExpression<K,V>
- See Also:
- MapExpression.getSize()
 
 - 
emptyPropertypublic ReadOnlyBooleanProperty emptyProperty() Description copied from class:MapExpressionA boolean property that istrue, if the map is empty.- Specified by:
- emptyPropertyin class- MapExpression<K,V>
- See Also:
- MapExpression.isEmpty()
 
 - 
addListenerpublic void addListener(InvalidationListener listener) Description copied from interface:ObservableAdds anInvalidationListenerwhich will be notified whenever theObservablebecomes 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 InvalidationListenerinstance may be safely registered for differentObservables.The Observablestores 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 callingremoveListenerafter use or to use an instance ofWeakInvalidationListeneravoid this situation.- Parameters:
- listener- The listener to register
- See Also:
- Observable.removeListener(InvalidationListener)
 
 - 
removeListenerpublic void removeListener(InvalidationListener listener) Description copied from interface:ObservableRemoves the given listener from the list of listeners, that are notified whenever the value of theObservablebecomes 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)
 
 - 
addListenerpublic void addListener(ChangeListener<? super ObservableMap<K,V>> listener) Description copied from interface:ObservableValueAdds aChangeListenerwhich will be notified whenever the value of theObservableValuechanges. 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 ChangeListenerinstance may be safely registered for differentObservableValues.The ObservableValuestores 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 callingremoveListenerafter use or to use an instance ofWeakChangeListeneravoid this situation.- Parameters:
- listener- The listener to register
- See Also:
- ObservableValue.removeListener(ChangeListener)
 
 - 
removeListenerpublic void removeListener(ChangeListener<? super ObservableMap<K,V>> listener) Description copied from interface:ObservableValueRemoves the given listener from the list of listeners that are notified whenever the value of theObservableValuechanges.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)
 
 - 
addListenerpublic void addListener(MapChangeListener<? super K,? super V> listener) Description copied from interface:ObservableMapAdd a listener to this observable map.- Parameters:
- listener- the listener for listening to the list changes
 
 - 
removeListenerpublic void removeListener(MapChangeListener<? super K,? super V> listener) Description copied from interface:ObservableMapTries 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
 
 - 
fireValueChangedEventprotected 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.
 - 
fireValueChangedEventprotected void fireValueChangedEvent(MapChangeListener.Change<? extends K,? extends V> change) 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
 
 - 
invalidatedprotected void invalidated() The methodinvalidated()can be overridden to receive invalidation notifications. This is the preferred option inObjectsdefining the property, because it requires less memory. The default implementation is empty.
 - 
getpublic ObservableMap<K,V> get() Description copied from interface:WritableObjectValueGet the wrapped value. This must be identical to the value returned fromWritableValue.getValue().This method exists only to align WritableObjectValue API with WritableBooleanValueand subclasses ofWritableNumberValue- Returns:
- The current value
 
 - 
setpublic void set(ObservableMap<K,V> newValue) Description copied from interface:WritableObjectValueSet the wrapped value. Should be equivalent toWritableValue.setValue(java.lang.Object)- Parameters:
- newValue- The new value
- See Also:
- WritableObjectValue.get()
 
 - 
isBoundpublic boolean isBound() Description copied from interface:PropertyCan be used to check, if aPropertyis bound.- Returns:
- trueif the- Propertyis bound,- falseotherwise
- See Also:
- Property.bind(javafx.beans.value.ObservableValue)
 
 - 
bindpublic void bind(ObservableValue<? extends ObservableMap<K,V>> newObservable) Description copied from interface:PropertyCreate 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 this- Propertyshould be bound to.
 
 - 
unbindpublic void unbind() Description copied from interface:PropertyRemove the unidirectional binding for thisProperty. If thePropertyis not bound, calling this method has no effect.
 - 
toStringpublic String toString() Returns a string representation of thisMapPropertyBaseobject.- Overrides:
- toStringin class- MapProperty<K,V>
- Returns:
- a string representation of this MapPropertyBaseobject.
 
 
- 
 
-