Class BooleanProperty

java.lang.Object

javafx.beans.binding.BooleanExpression

javafx.beans.property.ReadOnlyBooleanProperty

javafx.beans.property.BooleanProperty

All Implemented Interfaces:

Observable, Property<Boolean>, ReadOnlyProperty<Boolean>, ObservableBooleanValue, ObservableValue<Boolean>, WritableBooleanValue, WritableValue<Boolean>

Direct Known Subclasses:

BooleanPropertyBase, JavaBeanBooleanProperty

public abstract class BooleanProperty
extends ReadOnlyBooleanProperty
implements Property<Boolean>, WritableBooleanValue

This class provides a full implementation of a Property wrapping a boolean value.

The value of a BooleanProperty can be get and set with ObservableBooleanValue.get(), BooleanExpression.getValue(), WritableBooleanValue.set(boolean), and setValue(Boolean).

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 BooleanProperty can be read with ReadOnlyProperty.getBean() and ReadOnlyProperty.getName().

Note: setting or binding this property to a null value will set the property to "false". See setValue(java.lang.Boolean).

Since:

JavaFX 2.0

See Also:

• ObservableBooleanValue
• WritableBooleanValue
• ReadOnlyBooleanProperty
• Property

Constructor Summary

Constructors

Constructor	Description
BooleanProperty()	Sole constructor

Method Summary

Modifier and Type	Method	Description
ObjectProperty<Boolean>	asObject()	Creates an ObjectProperty that holds the value of this BooleanProperty.
void	bindBidirectional(Property<Boolean> other)	Create a bidirectional binding between this Property and another one.
static BooleanProperty	booleanProperty(Property<Boolean> property)	Returns a BooleanProperty that wraps a Property.
void	setValue(Boolean v)	Set the wrapped value.
String	toString()	Returns a string representation of this BooleanProperty object.
void	unbindBidirectional(Property<Boolean> other)	Removes a bidirectional binding between this Property and another one.

Methods declared in class ReadOnlyBooleanProperty

readOnlyBooleanProperty

Modifier and Type	Method	Description
static ReadOnlyBooleanProperty	readOnlyBooleanProperty(ReadOnlyProperty<Boolean> property)	Returns a ReadOnlyBooleanProperty that wraps a ReadOnlyProperty.

Methods declared in class BooleanExpression

and, asString, booleanExpression, booleanExpression, getValue, isEqualTo, isNotEqualTo, not, or

Modifier and Type	Method	Description
BooleanBinding	and(ObservableBooleanValue other)	Creates a new BooleanExpression that performs the conditional AND-operation on this BooleanExpression and a ObservableBooleanValue.
StringBinding	asString()	Creates a StringBinding that holds the value of this BooleanExpression turned into a String.
static BooleanExpression	booleanExpression(ObservableBooleanValue value)	Returns a BooleanExpression that wraps a ObservableBooleanValue.
static BooleanExpression	booleanExpression(ObservableValue<Boolean> value)	Returns a BooleanExpression that wraps an ObservableValue.
Boolean	getValue()	Returns the current value of this ObservableValue
BooleanBinding	isEqualTo(ObservableBooleanValue other)	Creates a new BooleanExpression that holds true if this and another ObservableBooleanValue are equal.
BooleanBinding	isNotEqualTo(ObservableBooleanValue other)	Creates a new BooleanExpression that holds true if this and another ObservableBooleanValue are equal.
BooleanBinding	not()	Creates a new BooleanExpression that calculates the negation of this BooleanExpression.
BooleanBinding	or(ObservableBooleanValue other)	Creates a new BooleanExpression that performs the conditional OR-operation on this BooleanExpression and a ObservableBooleanValue.

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 ObservableBooleanValue

get

Modifier and Type	Method	Description
boolean	get()	Returns the current value of this ObservableBooleanValue.

Methods declared in interface ObservableValue

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

Modifier and Type	Method	Description
void	addListener(ChangeListener<? super Boolean> listener)	Adds a ChangeListener which will be notified whenever the value of the ObservableValue changes.
default <U> ObservableValue<U>	flatMap(Function<? super Boolean, ? 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 Boolean, ? extends U> mapper)	Returns an ObservableValue that holds the result of applying the given mapping function on this value.
default ObservableValue<Boolean>	orElse(Boolean constant)	Returns an ObservableValue that holds this value, or the given constant if it is null.
void	removeListener(ChangeListener<? super Boolean> 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 Boolean, ? super Boolean> 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 Boolean> 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<Boolean>	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 Boolean> 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 WritableBooleanValue

get, set

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

Methods declared in interface WritableValue

getValue

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

Constructor Details

BooleanProperty

public BooleanProperty()

Sole constructor

Method Details

setValue

public void setValue(Boolean v)

Set the wrapped value.

Specified by:

setValue in interface WritableBooleanValue

Specified by:

setValue in interface WritableValue<Boolean>

Parameters:

v - The new value

bindBidirectional

public void bindBidirectional(Property<Boolean> 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<Boolean>

Parameters:

other - the other Property

unbindBidirectional

public void unbindBidirectional(Property<Boolean> 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<Boolean>

Parameters:

other - the other Property

toString

public String toString()

Returns a string representation of this BooleanProperty object.

Overrides:

toString in class ReadOnlyBooleanProperty

Returns:

a string representation of this BooleanProperty object.

booleanProperty

public static BooleanProperty booleanProperty(Property<Boolean> property)

Returns a BooleanProperty that wraps a Property. If the Property is already a BooleanProperty, it will be returned. Otherwise a new BooleanProperty is created that is bound to the Property. Note: null values in the source property will be interpreted as "false"

Parameters:

property - The source Property

Returns:

A BooleanProperty that wraps the Property if necessary

Throws:

NullPointerException - if property is null

Since:

JavaFX 8.0

asObject

public ObjectProperty<Boolean> asObject()

Creates an ObjectProperty that holds the value of this BooleanProperty. If the value of this BooleanProperty changes, the value of the ObjectProperty will be updated automatically.

Overrides:

asObject in class ReadOnlyBooleanProperty

Returns:

the new ObjectProperty

Since:

JavaFX 8.0