Class ObjectProperty<T>

java.lang.Object

javafx.beans.binding.ObjectExpression<T>

javafx.beans.property.ReadOnlyObjectProperty<T>

javafx.beans.property.ObjectProperty<T>

Type Parameters:

T - the type of the wrapped Object

All Implemented Interfaces:

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

Direct Known Subclasses:

JavaBeanObjectProperty, ObjectPropertyBase

public abstract class ObjectProperty<T>
extends ReadOnlyObjectProperty<T>
implements Property<T>, WritableObjectValue<T>

This class provides a full implementation of a Property wrapping an arbitrary Object. The value of a ObjectProperty can be get and set with ObservableObjectValue.get(), ObjectExpression.getValue(), WritableObjectValue.set(Object), and setValue(Object). A property can be bound and unbound unidirectional with Property.bind(ObservableValue) and Property.unbind(). Bidirectional bindings can be created and removed with bindBidirectional(Property) and unbindBidirectional(Property). The context of a ObjectProperty can be read with ReadOnlyProperty.getBean() and ReadOnlyProperty.getName(). For specialized implementations for ObservableList, ObservableSet and ObservableMap that also report changes inside the collections, see ListProperty, SetProperty and MapProperty, respectively.

Since:

JavaFX 2.0

See Also:

• ObservableObjectValue
• WritableObjectValue
• ReadOnlyObjectProperty
• Property

Constructor Summary

Constructors

Constructor	Description
ObjectProperty()	Creates a default ObjectProperty.

Method Summary

Modifier and Type	Method	Description
void	bindBidirectional(Property<T> other)	Create a bidirectional binding between this Property and another one.
void	setValue(T v)	Set the wrapped value.
String	toString()	Returns a string representation of this ObjectProperty object.
void	unbindBidirectional(Property<T> other)	Removes a bidirectional binding between this Property and another one.

Methods declared in class ObjectExpression

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

Modifier and Type	Method	Description
StringBinding	asString()	Creates a StringBinding that holds the value of this ObjectExpression turned into a String.
StringBinding	asString(String format)	Creates a StringBinding that holds the value of the ObjectExpression turned into a String.
StringBinding	asString(Locale locale, String format)	Creates a StringBinding that holds the value of the NumberExpression turned into a String.
T	getValue()	Returns the current value of this ObservableValue
BooleanBinding	isEqualTo(Object other)	Creates a new BooleanExpression that holds true if this ObjectExpression is equal to a constant value.
BooleanBinding	isEqualTo(ObservableObjectValue<?> other)	Creates a new BooleanExpression that holds true if this and another ObservableObjectValue are equal.
BooleanBinding	isNotEqualTo(Object other)	Creates a new BooleanExpression that holds true if this ObjectExpression is not equal to a constant value.
BooleanBinding	isNotEqualTo(ObservableObjectValue<?> other)	Creates a new BooleanExpression that holds true if this and another ObservableObjectValue are not equal.
BooleanBinding	isNotNull()	Creates a new BooleanBinding that holds true if this ObjectExpression is not null.
BooleanBinding	isNull()	Creates a new BooleanBinding that holds true if this ObjectExpression is null.
static <T> ObjectExpression<T>	objectExpression(ObservableObjectValue<T> value)	Returns an ObjectExpression that wraps an ObservableObjectValue.

Methods declared in class Object

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

Methods declared in interface Observable

addListener, removeListener, subscribe

Modifier and Type	Method	Description
void	addListener(InvalidationListener listener)	Adds an InvalidationListener which will be notified whenever the Observable becomes invalid.
void	removeListener(InvalidationListener listener)	Removes the given listener from the list of listeners, that are notified whenever the value of the Observable becomes invalid.
default Subscription	subscribe(Runnable invalidationSubscriber)	Creates a Subscription on this Observable which calls invalidationSubscriber whenever it becomes invalid.

Methods declared in interface ObservableObjectValue

get

Modifier and Type	Method	Description
T	get()	Returns the current value of this ObservableObjectValue<T>.

Methods declared in interface ObservableValue

addListener, flatMap, map, orElse, removeListener, subscribe, subscribe, when

Modifier and Type	Method	Description
void	addListener(ChangeListener<? super T> listener)	Adds a ChangeListener which will be notified whenever the value of the ObservableValue changes.
default <U> ObservableValue<U>	flatMap(Function<? super T, ? extends ObservableValue<? extends U>> mapper)	Returns an ObservableValue that holds the value of an ObservableValue produced by applying the given mapping function on this value.
default <U> ObservableValue<U>	map(Function<? super T, ? extends U> mapper)	Returns an ObservableValue that holds the result of applying the given mapping function on this value.
default ObservableValue<T>	orElse(T constant)	Returns an ObservableValue that holds this value, or the given constant if it is null.
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.
default Subscription	subscribe(BiConsumer<? super T, ? super T> changeSubscriber)	Creates a Subscription on this ObservableValue which calls the given changeSubscriber with the old and new value whenever its value changes.
default Subscription	subscribe(Consumer<? super T> valueSubscriber)	Creates a Subscription on this ObservableValue which immediately provides the current value to the given valueSubscriber, followed by any subsequent values whenever its value changes.
default ObservableValue<T>	when(ObservableValue<Boolean> condition)	Returns an ObservableValue that holds this value and is updated only when condition holds true.

Methods declared in interface Property

bind, isBound, unbind

Modifier and Type	Method	Description
void	bind(ObservableValue<? extends T> observable)	Create a unidirection binding for this Property.
boolean	isBound()	Can be used to check, if a Property is bound.
void	unbind()	Remove the unidirectional binding for this Property.

Methods declared in interface ReadOnlyProperty

getBean, getName

Modifier and Type	Method	Description
Object	getBean()	Returns the Object that contains this property.
String	getName()	Returns the name of this property.

Methods declared in interface WritableObjectValue

get, set

Modifier and Type	Method	Description
T	get()	Get the wrapped value.
void	set(T value)	Set the wrapped value.

Methods declared in interface WritableValue

getValue

Modifier and Type	Method	Description
T	getValue()	Get the wrapped value.

Constructor Details

ObjectProperty

public ObjectProperty()

Creates a default ObjectProperty.

Method Details

setValue

public void setValue(T v)

Set the wrapped value.

Specified by:

setValue in interface WritableValue<T>

Parameters:

v - The new value

bindBidirectional

public void bindBidirectional(Property<T> other)

Create a bidirectional binding between this Property and another one. Bidirectional bindings exists independently of unidirectional bindings. So it is possible to add unidirectional binding to a property with bidirectional binding and vice-versa. However, this practice is discouraged.

It is possible to have multiple bidirectional bindings of one Property.

JavaFX bidirectional binding implementation use weak listeners. This means bidirectional binding does not prevent properties from being garbage collected.

Specified by:

bindBidirectional in interface Property<T>

Parameters:

other - the other Property

unbindBidirectional

public void unbindBidirectional(Property<T> other)

Removes a bidirectional binding between this Property and another one. If no bidirectional binding between the properties exists, calling this method has no effect. It is possible to unbind by a call on the second property. This code will work:

    property1.bindBidirectional(property2);
    property2.unbindBidirectional(property1);

Specified by:

unbindBidirectional in interface Property<T>

Parameters:

other - the other Property

toString

public String toString()

Returns a string representation of this ObjectProperty object.

Overrides:

toString in class ReadOnlyObjectProperty<T>

Returns:

a string representation of this ObjectProperty object.