javafx.beans.property

Class MapPropertyBase<K,V>

java.lang.Object

<any>

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:

Property<<any>>, ReadOnlyProperty<<any>>

Direct Known Subclasses:

SimpleMapProperty

public abstract class MapPropertyBase<K,V>
extends MapProperty<K,V>

The class MapPropertyBase is the base class for a property wrapping an javafx.collections.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:

javafx.collections.ObservableMap, MapProperty

Property Summary

Type	Property and Description
ReadOnlyBooleanProperty	empty
ReadOnlyIntegerProperty	size

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private class	MapPropertyBase.EmptyProperty
private static class	MapPropertyBase.Listener<K,V>
private class	MapPropertyBase.SizeProperty

Field Summary

Fields

Modifier and Type	Field and Description
private MapPropertyBase.EmptyProperty	empty0
private <any>	helper
private InvalidationListener	listener
private <any>	mapChangeListener
private <any>	observable
private MapPropertyBase.SizeProperty	size0
private boolean	valid
private <any>	value

Constructor Summary

Constructors

Constructor and Description
MapPropertyBase() The Constructor of MapPropertyBase
MapPropertyBase(<any> initialValue) The constructor of the MapPropertyBase.

Method Summary

Modifier and Type	Method and Description
void	addListener(<any> listener)
void	addListener(<any> listener)
void	addListener(InvalidationListener listener)
void	bind(<any> newObservable) Create a unidirection binding for this Property.
ReadOnlyBooleanProperty	emptyProperty()
protected void	fireValueChangedEvent() Sends notifications to all attached InvalidationListeners, ChangeListeners, and javafx.collections.MapChangeListener.
protected void	fireValueChangedEvent(<any> change) Sends notifications to all attached InvalidationListeners, ChangeListeners, and javafx.collections.MapChangeListener.
<any>	get()
protected void	invalidated() The method invalidated() can be overridden to receive invalidation notifications.
private void	invalidateProperties()
boolean	isBound() Can be used to check, if a Property is bound.
private void	markInvalid(<any> oldValue)
void	removeListener(<any> listener)
void	removeListener(<any> listener)
void	removeListener(InvalidationListener listener)
void	set(<any> newValue)
ReadOnlyIntegerProperty	sizeProperty()
java.lang.String	toString() Returns a string representation of this MapPropertyBase object.
void	unbind() Remove the unidirectional binding for this Property.

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 java.lang.Object

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

Methods inherited from interface javafx.beans.property.ReadOnlyProperty

getBean, getName

Property Detail

size

public ReadOnlyIntegerProperty sizeProperty

empty

public ReadOnlyBooleanProperty emptyProperty

Field Detail

mapChangeListener

private final <any> mapChangeListener

value

private <any> value

observable

private <any> observable

listener

private InvalidationListener listener

valid

private boolean valid

helper

private <any> helper

size0

private MapPropertyBase.SizeProperty size0

empty0

private MapPropertyBase.EmptyProperty empty0

Constructor Detail

MapPropertyBase

public MapPropertyBase()

The Constructor of MapPropertyBase

MapPropertyBase

public MapPropertyBase(<any> initialValue)

The constructor of the MapPropertyBase.

Parameters:

initialValue - the initial value of the wrapped value

Method Detail

sizeProperty

public ReadOnlyIntegerProperty sizeProperty()

emptyProperty

public ReadOnlyBooleanProperty emptyProperty()

addListener

public void addListener(InvalidationListener listener)

removeListener

public void removeListener(InvalidationListener listener)

addListener

public void addListener(<any> listener)

removeListener

public void removeListener(<any> listener)

addListener

public void addListener(<any> listener)

removeListener

public void removeListener(<any> listener)

fireValueChangedEvent

protected void fireValueChangedEvent()

Sends notifications to all attached InvalidationListeners, ChangeListeners, and javafx.collections.MapChangeListener. This method is called when the value is changed, either manually by calling #set(javafx.collections.ObservableMap) or in case of a bound property, if the binding becomes invalid.

fireValueChangedEvent

protected void fireValueChangedEvent(<any> change)

Sends notifications to all attached InvalidationListeners, ChangeListeners, and javafx.collections.MapChangeListener. This method is called when the content of the list changes.

Parameters:

change - the change that needs to be propagated

invalidateProperties

private void invalidateProperties()

markInvalid

private void markInvalid(<any> oldValue)

invalidated

protected void invalidated()

The method invalidated() can be overridden to receive invalidation notifications. This is the preferred option in Objects defining the property, because it requires less memory. The default implementation is empty.

get

public <any> get()

set

public void set(<any> newValue)

isBound

public boolean isBound()

Description copied from interface: Property

Can be used to check, if a Property is bound.

Returns:

true if the Property is bound, false otherwise

See Also:

#bind(javafx.beans.value.ObservableValue)

bind

public void bind(<any> newObservable)

Description copied from interface: Property

Create a unidirection binding for this Property.

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 Property should be bound to.

unbind

public void unbind()

Description copied from interface: Property

Remove the unidirectional binding for this Property. If the Property is not bound, calling this method has no effect.

See Also:

#bind(javafx.beans.value.ObservableValue)

toString

public java.lang.String toString()

Returns a string representation of this MapPropertyBase object.

Overrides:

toString in class MapProperty<K,V>

Returns:

a string representation of this MapPropertyBase object.