Class FloatProperty

javafx.beans.property.FloatProperty

All Implemented Interfaces:: NumberExpression, Observable, Property<Number>, ReadOnlyProperty<Number>, ObservableFloatValue, ObservableNumberValue, ObservableValue<Number>, WritableFloatValue, WritableNumberValue, WritableValue<Number>

Direct Known Subclasses:: FloatPropertyBase, JavaBeanFloatProperty

public abstract class FloatProperty extends ReadOnlyFloatProperty implements Property<Number>, WritableFloatValue

This class defines a Property wrapping a float value.

The value of a FloatProperty can be get and set with ObservableFloatValue.get(), FloatExpression.getValue(), WritableFloatValue.set(float), and setValue(Number).

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

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

Since:

JavaFX 2.0

See Also:

Constructor Summary

Constructor	Description
`FloatProperty()`	Creates a default `FloatProperty`.

Method Summary

Modifier and Type	Method	Description
`ObjectProperty<Float>`	`asObject()`	Creates an `ObjectProperty` that bidirectionally bound to this `FloatProperty`.
`void`	`bindBidirectional(Property<Number> other)`	Create a bidirectional binding between this `Property` and another one.
`static FloatProperty`	`floatProperty(Property<Float> property)`	Returns a `FloatProperty` that wraps a `Property` and is bidirectionally bound to it.
`void`	`setValue(Number v)`	Set the wrapped value.
`String`	`toString()`	Returns a string representation of this `FloatProperty` object.
`void`	`unbindBidirectional(Property<Number> other)`	Removes a bidirectional binding between this `Property` and another one.

Methods declared in class javafx.beans.property.ReadOnlyFloatProperty

readOnlyFloatProperty

Methods declared in class javafx.beans.binding.FloatExpression

add, add, add, add, divide, divide, divide, divide, doubleValue, floatExpression, floatExpression, floatValue, getValue, intValue, longValue, multiply, multiply, multiply, multiply, negate, subtract, subtract, subtract, subtract

Methods declared in class javafx.beans.binding.NumberExpressionBase

add, asString, asString, asString, divide, greaterThan, greaterThan, greaterThan, greaterThan, greaterThan, greaterThanOrEqualTo, greaterThanOrEqualTo, greaterThanOrEqualTo, greaterThanOrEqualTo, greaterThanOrEqualTo, isEqualTo, isEqualTo, isEqualTo, isEqualTo, isEqualTo, isEqualTo, isEqualTo, isEqualTo, isNotEqualTo, isNotEqualTo, isNotEqualTo, isNotEqualTo, isNotEqualTo, isNotEqualTo, isNotEqualTo, isNotEqualTo, lessThan, lessThan, lessThan, lessThan, lessThan, lessThanOrEqualTo, lessThanOrEqualTo, lessThanOrEqualTo, lessThanOrEqualTo, lessThanOrEqualTo, multiply, numberExpression, subtract

Methods declared in class java.lang.Object

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

Methods declared in interface javafx.beans.Observable

addListener, removeListener, subscribe

Methods declared in interface javafx.beans.value.ObservableFloatValue

get

Methods declared in interface javafx.beans.value.ObservableValue

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

Methods declared in interface javafx.beans.property.Property

bind, isBound, unbind

Methods declared in interface javafx.beans.property.ReadOnlyProperty

getBean, getName

Methods declared in interface javafx.beans.value.WritableFloatValue

get, set

Methods declared in interface javafx.beans.value.WritableValue

getValue

Constructor Details

FloatProperty

public FloatProperty()

Creates a default FloatProperty.

Method Details

setValue

public void setValue(Number v)

Set the wrapped value.

Specified by:: setValue in interface WritableFloatValue
Specified by:: setValue in interface WritableValue<Number>
Parameters:: v - The new value

bindBidirectional

public void bindBidirectional(Property<Number> 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<Number>
Parameters:: other - the other Property

unbindBidirectional

public void unbindBidirectional(Property<Number> 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<Number>
Parameters:: other - the other Property

toString

public String toString()

Returns a string representation of this FloatProperty object.

Overrides:: toString in class ReadOnlyFloatProperty
Returns:: a string representation of this FloatProperty object.

floatProperty

public static FloatProperty floatProperty(Property<Float> property)

Returns a FloatProperty that wraps a Property and is bidirectionally bound to it. Changing this property will result in a change of the original property.

This is very useful when bidirectionally binding an ObjectProperty<Float> and a FloatProperty.

   FloatProperty floatProperty = new SimpleFloatProperty(1.0f);
   ObjectProperty<Float> objectProperty = new SimpleObjectProperty<>(2.0f);

   // Need to keep the reference as bidirectional binding uses weak references
   FloatProperty objectAsFloat = FloatProperty.floatProperty(objectProperty);

   floatProperty.bindBidirectional(objectAsFloat);

Another approach is to convert the FloatProperty to ObjectProperty using asObject() method.

Note: null values in the source property will be interpreted as 0f

Parameters:

property - The source Property

Returns:

A FloatProperty that wraps the Property

Throws:

NullPointerException - if property is null

Since:

JavaFX 8.0

See Also:

asObject

public ObjectProperty<Float> asObject()

Creates an ObjectProperty that bidirectionally bound to this FloatProperty. If the value of this FloatProperty changes, the value of the ObjectProperty will be updated automatically and vice-versa.

Can be used for binding an ObjectProperty to FloatProperty.

   FloatProperty floatProperty = new SimpleFloatProperty(1.0f);
   ObjectProperty<Float> objectProperty = new SimpleObjectProperty<>(2.0f);

   objectProperty.bind(floatProperty.asObject());

Overrides:: asObject in class ReadOnlyFloatProperty
Returns:: the new ObjectProperty
Since:: 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.