JavaFX 24 · javafx.beans.property.FloatProperty · APIdia, the JavaDoc alternative

This class defines a Property wrapping a float value.

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

A property can be bound and unbound unidirectional with bind(ObservableValue) and unbind(). Bidirectional bindings can be created and removed with bindBidirectional(Property) and unbindBidirectional(Property).

The context of a FloatProperty can be read with getBean() and getName().

Note

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

Constructor Summary

Access	Constructor and Description
public	FloatProperty() Creates a default `FloatProperty`.

Method Summary

Modifier and Type	Method and Description
public ObjectProperty<Float>	Returns: the new `ObjectProperty` asObject() Overrides javafx.beans.property.ReadOnlyFloatProperty.asObject. Creates an `javafx.beans.property.ObjectProperty` that bidirectionally bound to this `FloatProperty`.
public void	bindBidirectional(Property<Number> the other `Property` other) Implements javafx.beans.property.Property.bindBidirectional. Create a bidirectional binding between this `Property` and another one.
public static FloatProperty	Returns: A `FloatProperty` that wraps the `Property` floatProperty(final Property<Float> The source `Property` property) Returns a `FloatProperty` that wraps a `javafx.beans.property.Property` and is bidirectionally bound to it.
public void	setValue(Number The new value v) Implements javafx.beans.value.WritableValue.setValue, javafx.beans.value.WritableFloatValue.setValue. Set the wrapped value.
public String	Returns: a string representation of this `FloatProperty` object. toString() Overrides javafx.beans.property.ReadOnlyFloatProperty.toString. Returns a string representation of this `FloatProperty` object.
public void	unbindBidirectional(Property<Number> the other `Property` other) Implements javafx.beans.property.Property.unbindBidirectional. Removes a bidirectional binding between this `Property` and another one.

Inherited from javafx.beans.property.ReadOnlyFloatProperty:: readOnlyFloatProperty

Constructor Detail

FloatProperty	back to summary
public FloatProperty() Creates a default `FloatProperty`.

Method Detail

asObject back to summary

asObject	back to summary
public ObjectProperty<Float> asObject() Overrides javafx.beans.property.ReadOnlyFloatProperty.asObject. Creates an `javafx.beans.property.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()); Returns:ObjectProperty<Float> the new `ObjectProperty` Annotations @Override Since JavaFX 8.0

public ObjectProperty<Float> asObject()

Overrides javafx.beans.property.ReadOnlyFloatProperty.asObject.

Creates an javafx.beans.property.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());

Returns:ObjectProperty<Float>

the new ObjectProperty

Annotations

@Override

Since

JavaFX 8.0

bindBidirectional back to summary

bindBidirectional	back to summary
public void bindBidirectional(Property<Number> other) Implements javafx.beans.property.Property.bindBidirectional. Doc from javafx.beans.property.Property.bindBidirectional. 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. Parameters other:Property<Number> the other `Property` Annotations @Override

public void bindBidirectional(Property<Number> other)

Implements javafx.beans.property.Property.bindBidirectional.

Doc from javafx.beans.property.Property.bindBidirectional.

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.

Parameters

other:Property<Number>: the other Property

Annotations

@Override

floatProperty back to summary

floatProperty	back to summary
public static FloatProperty floatProperty(final Property<Float> property) Returns a `FloatProperty` that wraps a `javafx.beans.property.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:Property<Float> The source `Property` Returns:FloatProperty A `FloatProperty` that wraps the `Property` Exceptions NullPointerException: if `property` is `null` Since JavaFX 8.0 See Also `asObject()`

public static FloatProperty floatProperty(final Property<Float> property)

Returns a FloatProperty that wraps a javafx.beans.property.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:Property<Float>: The source Property

Returns:FloatProperty

A FloatProperty that wraps the Property

Exceptions

NullPointerException:: if property is null

Since

JavaFX 8.0

See Also

asObject()

setValue	back to summary
public void setValue(Number v) Implements javafx.beans.value.WritableValue.setValue, javafx.beans.value.WritableFloatValue.setValue. Doc from javafx.beans.value.WritableFloatValue.setValue. Set the wrapped value. Note this method should accept null without throwing an exception, setting "0.0" instead. Parameters v:Number The new value Annotations @Override

setValue

back to summary

public void setValue(Number v)

Implements javafx.beans.value.WritableValue.setValue, javafx.beans.value.WritableFloatValue.setValue.

Doc from javafx.beans.value.WritableFloatValue.setValue.

Set the wrapped value.

Note

this method should accept null without throwing an exception, setting "0.0" instead.

Parameters

v:Number: The new value

Annotations

@Override

toString back to summary

toString	back to summary
public String toString() Overrides javafx.beans.property.ReadOnlyFloatProperty.toString. Returns a string representation of this `FloatProperty` object. Returns:String a string representation of this `FloatProperty` object. Annotations @Override

public String toString()

Overrides javafx.beans.property.ReadOnlyFloatProperty.toString.

Returns a string representation of this FloatProperty object.

Returns:String

a string representation of this FloatProperty object.

Annotations

@Override

unbindBidirectional back to summary

unbindBidirectional	back to summary
public void unbindBidirectional(Property<Number> other) Implements javafx.beans.property.Property.unbindBidirectional. Doc from javafx.beans.property.Property.unbindBidirectional. 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); Parameters other:Property<Number> the other `Property` Annotations @Override

public void unbindBidirectional(Property<Number> other)

Implements javafx.beans.property.Property.unbindBidirectional.

Doc from javafx.beans.property.Property.unbindBidirectional.

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);

Parameters

other:Property<Number>: the other Property

Annotations

@Override

public abstract Class FloatProperty

Constructor Summary

Method Summary

Constructor Detail

Method Detail