javafx.beans.property

Class ReadOnlyObjectWrapper<T>

java.lang.Object

javafx.beans.binding.ObjectExpression<T>

javafx.beans.property.ReadOnlyObjectProperty<T>

javafx.beans.property.ObjectProperty<T>

javafx.beans.property.ObjectPropertyBase<T>

javafx.beans.property.SimpleObjectProperty<T>

javafx.beans.property.ReadOnlyObjectWrapper<T>

All Implemented Interfaces:

Observable, Property<T>, ReadOnlyProperty<T>, ObservableObjectValue<T>, ObservableValue<T>, WritableObjectValue<T>, WritableValue<T>

public class ReadOnlyObjectWrapper<T>
extends SimpleObjectProperty<T>

This class provides a convenient class to define read-only properties. It creates two properties that are synchronized. One property is read-only and can be passed to external users. The other property is read- and writable and should be used internally only.

Since:

JavaFX 2.0

Constructor Summary

Constructors

Constructor and Description
ReadOnlyObjectWrapper() The constructor of ReadOnlyObjectWrapper
ReadOnlyObjectWrapper(Object bean, String name) The constructor of ReadOnlyObjectWrapper
ReadOnlyObjectWrapper(Object bean, String name, T initialValue) The constructor of ReadOnlyObjectWrapper
ReadOnlyObjectWrapper(T initialValue) The constructor of ReadOnlyObjectWrapper

Method Summary

Modifier and Type	Method and Description
void	addListener(ChangeListener<? super T> listener) Adds a ChangeListener which will be notified whenever the value of the ObservableValue changes.
void	addListener(InvalidationListener listener) Adds an InvalidationListener which will be notified whenever the Observable becomes invalid.
protected void	fireValueChangedEvent() Sends notifications to all attached InvalidationListeners and ChangeListeners.
ReadOnlyObjectProperty<T>	getReadOnlyProperty() Returns the readonly property, that is synchronized with this ReadOnlyObjectWrapper.
void	removeListener(ChangeListener<? super T> listener) Removes the given listener from the list of listeners, that are notified whenever the value of the ObservableValue changes.
void	removeListener(InvalidationListener listener) Removes the given listener from the list of listeners, that are notified whenever the value of the Observable becomes invalid.

Methods inherited from class javafx.beans.property.SimpleObjectProperty

getBean, getName

Methods inherited from class javafx.beans.property.ObjectPropertyBase

bind, get, invalidated, isBound, set, toString, unbind

Methods inherited from class javafx.beans.property.ObjectProperty

bindBidirectional, setValue, unbindBidirectional

Methods inherited from class javafx.beans.binding.ObjectExpression

asString, asString, asString, getValue, isEqualTo, isEqualTo, isNotEqualTo, isNotEqualTo, isNotNull, isNull, objectExpression

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface javafx.beans.value.ObservableValue

getValue

Methods inherited from interface javafx.beans.value.WritableValue

getValue

Constructor Detail

ReadOnlyObjectWrapper

public ReadOnlyObjectWrapper()

The constructor of ReadOnlyObjectWrapper

ReadOnlyObjectWrapper

public ReadOnlyObjectWrapper(T initialValue)

The constructor of ReadOnlyObjectWrapper

Parameters:

initialValue - the initial value of the wrapped value

ReadOnlyObjectWrapper

public ReadOnlyObjectWrapper(Object bean,
                             String name)

The constructor of ReadOnlyObjectWrapper

Parameters:

bean - the bean of this ReadOnlyObjectProperty

name - the name of this ReadOnlyObjectProperty

ReadOnlyObjectWrapper

public ReadOnlyObjectWrapper(Object bean,
                             String name,
                             T initialValue)

The constructor of ReadOnlyObjectWrapper

Parameters:

bean - the bean of this ReadOnlyObjectProperty

name - the name of this ReadOnlyObjectProperty

initialValue - the initial value of the wrapped value

Method Detail

getReadOnlyProperty

public ReadOnlyObjectProperty<T> getReadOnlyProperty()

Returns the readonly property, that is synchronized with this ReadOnlyObjectWrapper.

Returns:

the readonly property

addListener

public void addListener(InvalidationListener listener)

Adds an InvalidationListener which will be notified whenever the Observable 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 different Observables.

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 calling removeListener after use or to use an instance of WeakInvalidationListener avoid this situation.

Specified by:

addListener in interface Observable

Overrides:

addListener in class ObjectPropertyBase<T>

Parameters:

listener - The listener to register

See Also:

Observable.removeListener(InvalidationListener)

removeListener

public void removeListener(InvalidationListener listener)

Removes the given listener from the list of listeners, that are notified whenever the value of the Observable 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.

Specified by:

removeListener in interface Observable

Overrides:

removeListener in class ObjectPropertyBase<T>

Parameters:

listener - The listener to remove

See Also:

Observable.addListener(InvalidationListener)

addListener

public void addListener(ChangeListener<? super T> listener)

Adds a ChangeListener which will be notified whenever the value of the ObservableValue 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 different ObservableValues.

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 calling removeListener after use or to use an instance of WeakChangeListener avoid this situation.

Specified by:

addListener in interface ObservableValue<T>

Overrides:

addListener in class ObjectPropertyBase<T>

Parameters:

listener - The listener to register

See Also:

ObservableValue.removeListener(ChangeListener)

removeListener

public void removeListener(ChangeListener<? super T> listener)

Removes the given listener from the list of listeners, that are notified whenever the value of the ObservableValue 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.

Specified by:

removeListener in interface ObservableValue<T>

Overrides:

removeListener in class ObjectPropertyBase<T>

Parameters:

listener - The listener to remove

See Also:

ObservableValue.addListener(ChangeListener)

fireValueChangedEvent

protected void fireValueChangedEvent()

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

Overrides:

fireValueChangedEvent in class ObjectPropertyBase<T>