Class BooleanProperty
- 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:
public abstract class BooleanProperty extends ReadOnlyBooleanProperty implements Property<Boolean>, WritableBooleanValue
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
-
Constructor Summary
Constructors Constructor and Description BooleanProperty()Sole constructor
-
Method Summary
All MethodsStatic MethodsInstance MethodsConcrete Methods Modifier and Type Method and Description ObjectProperty<Boolean>asObject()Creates anObjectPropertythat holds the value of thisBooleanProperty.voidbindBidirectional(Property<Boolean> other)Create a bidirectional binding between thisPropertyand another one.static BooleanPropertybooleanProperty(Property<Boolean> property)Returns aBooleanPropertythat wraps aProperty.voidsetValue(Boolean v)Set the wrapped value.StringtoString()Returns a string representation of thisBooleanPropertyobject.voidunbindBidirectional(Property<Boolean> other)Remove a bidirectional binding between thisPropertyand another one.-
Methods inherited from class javafx.beans.property.ReadOnlyBooleanProperty
readOnlyBooleanProperty
-
Methods inherited from class javafx.beans.binding.BooleanExpression
and, asString, booleanExpression, booleanExpression, getValue, isEqualTo, isNotEqualTo, not, or
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface javafx.beans.property.ReadOnlyProperty
getBean, getName
-
Methods inherited from interface javafx.beans.value.ObservableValue
addListener, getValue, removeListener
-
Methods inherited from interface javafx.beans.Observable
addListener, removeListener
-
Methods inherited from interface javafx.beans.value.WritableBooleanValue
get, set
-
Methods inherited from interface javafx.beans.value.WritableValue
getValue
-
Methods inherited from interface javafx.beans.value.ObservableBooleanValue
get
-
-
Constructor Detail
-
BooleanProperty
public BooleanProperty()
Sole constructor
-
-
Method Detail
-
setValue
public void setValue(Boolean v)
Set the wrapped value.Specified by:
setValuein interfaceWritableBooleanValueSpecified by:
setValuein interfaceWritableValue<Boolean>Parameters:
v- The new value
-
bindBidirectional
public void bindBidirectional(Property<Boolean> other)
Create a bidirectional binding between thisPropertyand 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:
bindBidirectionalin interfaceProperty<Boolean>Parameters:
other- the otherProperty
-
unbindBidirectional
public void unbindBidirectional(Property<Boolean> other)
Remove a bidirectional binding between thisPropertyand 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.bindBirectional(property2); property2.unbindBidirectional(property1);Specified by:
unbindBidirectionalin interfaceProperty<Boolean>Parameters:
other- the otherProperty
-
toString
public String toString()
Returns a string representation of thisBooleanPropertyobject.Overrides:
toStringin classReadOnlyBooleanPropertyReturns:
a string representation of this
BooleanPropertyobject.
-
booleanProperty
public static BooleanProperty booleanProperty(Property<Boolean> property)
Returns aBooleanPropertythat wraps aProperty. If thePropertyis already aBooleanProperty, it will be returned. Otherwise a newBooleanPropertyis created that is bound to theProperty. Note: null values in the source property will be interpreted as "false"Parameters:
property- The sourcePropertyReturns:
A
BooleanPropertythat wraps thePropertyif necessaryThrows:
NullPointerException- ifpropertyisnullSince:
JavaFX 8.0
-
asObject
public ObjectProperty<Boolean> asObject()
Creates anObjectPropertythat holds the value of thisBooleanProperty. If the value of thisBooleanPropertychanges, the value of theObjectPropertywill be updated automatically.Overrides:
asObjectin classReadOnlyBooleanPropertyReturns:
the new
ObjectPropertySince:
JavaFX 8.0
-
© 2008, 2025, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from JavaFX API Documentation.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Java, JavaFX and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.