Class FloatProperty

java.lang.Object

javafx.beans.binding.NumberExpressionBase

javafx.beans.binding.FloatExpression

javafx.beans.property.ReadOnlyFloatProperty

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:

• ObservableFloatValue
• WritableFloatValue
• ReadOnlyFloatProperty
• Property

Constructor Summary

Constructors

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 ReadOnlyFloatProperty

readOnlyFloatProperty

Modifier and Type	Method	Description
static <T extends Number> ReadOnlyFloatProperty	readOnlyFloatProperty(ReadOnlyProperty<T> property)	Returns a ReadOnlyFloatProperty that wraps a ReadOnlyProperty.

Methods declared in class 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

Modifier and Type	Method	Description
DoubleBinding	add(double other)	Creates a new NumberBinding that calculates the sum of this NumberExpression and a constant value.
FloatBinding	add(float other)	Creates a new NumberBinding that calculates the sum of this NumberExpression and a constant value.
FloatBinding	add(int other)	Creates a new NumberBinding that calculates the sum of this NumberExpression and a constant value.
FloatBinding	add(long other)	Creates a new NumberBinding that calculates the sum of this NumberExpression and a constant value.
DoubleBinding	divide(double other)	Creates a new NumberBinding that calculates the division of this NumberExpression and a constant value.
FloatBinding	divide(float other)	Creates a new NumberBinding that calculates the division of this NumberExpression and a constant value.
FloatBinding	divide(int other)	Creates a new NumberBinding that calculates the division of this NumberExpression and a constant value.
FloatBinding	divide(long other)	Creates a new NumberBinding that calculates the division of this NumberExpression and a constant value.
double	doubleValue()	Returns the value of this ObservableNumberValue as a double.
static FloatExpression	floatExpression(ObservableFloatValue value)	Returns a FloatExpression that wraps a ObservableFloatValue.
static <T extends Number> FloatExpression	floatExpression(ObservableValue<T> value)	Returns a FloatExpression that wraps an ObservableValue.
float	floatValue()	Returns the value of this ObservableNumberValue as a float.
Float	getValue()	Returns the current value of this ObservableValue
int	intValue()	Returns the value of this ObservableNumberValue as an int .
long	longValue()	Returns the value of this ObservableNumberValue as a long .
DoubleBinding	multiply(double other)	Creates a new NumberBinding that calculates the product of this NumberExpression and a constant value.
FloatBinding	multiply(float other)	Creates a new NumberBinding that calculates the product of this NumberExpression and a constant value.
FloatBinding	multiply(int other)	Creates a new NumberBinding that calculates the product of this NumberExpression and a constant value.
FloatBinding	multiply(long other)	Creates a new NumberBinding that calculates the product of this NumberExpression and a constant value.
FloatBinding	negate()	Creates a new NumberBinding that calculates the negation of NumberExpression.
DoubleBinding	subtract(double other)	Creates a new NumberBinding that calculates the difference of this NumberExpression and a constant value.
FloatBinding	subtract(float other)	Creates a new NumberBinding that calculates the difference of this NumberExpression and a constant value.
FloatBinding	subtract(int other)	Creates a new NumberBinding that calculates the difference of this NumberExpression and a constant value.
FloatBinding	subtract(long other)	Creates a new NumberBinding that calculates the difference of this NumberExpression and a constant value.

Methods declared in class 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

Modifier and Type	Method	Description
NumberBinding	add(ObservableNumberValue other)	Creates a new NumberBinding that calculates the sum of this NumberExpression and another ObservableNumberValue.
StringBinding	asString()	Creates a StringBinding that holds the value of the NumberExpression turned into a String.
StringBinding	asString(String format)	Creates a StringBinding that holds the value of the NumberExpression turned into a String.
StringBinding	asString(Locale locale, String format)	Creates a StringBinding that holds the value of the NumberExpression turned into a String.
NumberBinding	divide(ObservableNumberValue other)	Creates a new NumberBinding that calculates the division of this NumberExpression and another ObservableNumberValue.
BooleanBinding	greaterThan(double other)	Creates a new BooleanBinding that holds true if this NumberExpression is greater than a constant value.
BooleanBinding	greaterThan(float other)	Creates a new BooleanBinding that holds true if this NumberExpression is greater than a constant value.
BooleanBinding	greaterThan(int other)	Creates a new BooleanBinding that holds true if this NumberExpression is greater than a constant value.
BooleanBinding	greaterThan(long other)	Creates a new BooleanBinding that holds true if this NumberExpression is greater than a constant value.
BooleanBinding	greaterThan(ObservableNumberValue other)	Creates a new BooleanBinding that holds true if this NumberExpression is greater than another ObservableNumberValue.
BooleanBinding	greaterThanOrEqualTo(double other)	Creates a new BooleanBinding that holds true if this NumberExpression is greater than or equal to a constant value.
BooleanBinding	greaterThanOrEqualTo(float other)	Creates a new BooleanBinding that holds true if this NumberExpression is greater than or equal to a constant value.
BooleanBinding	greaterThanOrEqualTo(int other)	Creates a new BooleanBinding that holds true if this NumberExpression is greater than or equal to a constant value.
BooleanBinding	greaterThanOrEqualTo(long other)	Creates a new BooleanBinding that holds true if this NumberExpression is greater than or equal to a constant value.
BooleanBinding	greaterThanOrEqualTo(ObservableNumberValue other)	Creates a new BooleanBinding that holds true if this NumberExpression is greater than or equal to another ObservableNumberValue.
BooleanBinding	isEqualTo(double other, double epsilon)	Creates a new BooleanBinding that holds true if this NumberExpression is equal to a constant value (with a tolerance).
BooleanBinding	isEqualTo(float other, double epsilon)	Creates a new BooleanBinding that holds true if this NumberExpression is equal to a constant value (with a tolerance).
BooleanBinding	isEqualTo(int other)	Creates a new BooleanBinding that holds true if this NumberExpression is equal to a constant value.
BooleanBinding	isEqualTo(int other, double epsilon)	Creates a new BooleanBinding that holds true if this NumberExpression is equal to a constant value (with a tolerance).
BooleanBinding	isEqualTo(long other)	Creates a new BooleanBinding that holds true if this NumberExpression is equal to a constant value.
BooleanBinding	isEqualTo(long other, double epsilon)	Creates a new BooleanBinding that holds true if this NumberExpression is equal to a constant value (with a tolerance).
BooleanBinding	isEqualTo(ObservableNumberValue other)	Creates a new BooleanBinding that holds true if this and another ObservableNumberValue are equal.
BooleanBinding	isEqualTo(ObservableNumberValue other, double epsilon)	Creates a new BooleanBinding that holds true if this and another ObservableNumberValue are equal (with a tolerance).
BooleanBinding	isNotEqualTo(double other, double epsilon)	Creates a new BooleanBinding that holds true if this NumberExpression is not equal to a constant value (with a tolerance).
BooleanBinding	isNotEqualTo(float other, double epsilon)	Creates a new BooleanBinding that holds true if this NumberExpression is not equal to a constant value (with a tolerance).
BooleanBinding	isNotEqualTo(int other)	Creates a new BooleanBinding that holds true if this NumberExpression is not equal to a constant value.
BooleanBinding	isNotEqualTo(int other, double epsilon)	Creates a new BooleanBinding that holds true if this NumberExpression is not equal to a constant value (with a tolerance).
BooleanBinding	isNotEqualTo(long other)	Creates a new BooleanBinding that holds true if this NumberExpression is not equal to a constant value.
BooleanBinding	isNotEqualTo(long other, double epsilon)	Creates a new BooleanBinding that holds true if this NumberExpression is not equal to a constant value (with a tolerance).
BooleanBinding	isNotEqualTo(ObservableNumberValue other)	Creates a new BooleanBinding that holds true if this and another ObservableNumberValue are not equal.
BooleanBinding	isNotEqualTo(ObservableNumberValue other, double epsilon)	Creates a new BooleanBinding that holds true if this and another ObservableNumberValue are not equal (with a tolerance).
BooleanBinding	lessThan(double other)	Creates a new BooleanBinding that holds true if this NumberExpression is lesser than a constant value.
BooleanBinding	lessThan(float other)	Creates a new BooleanBinding that holds true if this NumberExpression is lesser than a constant value.
BooleanBinding	lessThan(int other)	Creates a new BooleanBinding that holds true if this NumberExpression is lesser than a constant value.
BooleanBinding	lessThan(long other)	Creates a new BooleanBinding that holds true if this NumberExpression is lesser than a constant value.
BooleanBinding	lessThan(ObservableNumberValue other)	Creates a new BooleanBinding that holds true if this NumberExpression is lesser than another ObservableNumberValue.
BooleanBinding	lessThanOrEqualTo(double other)	Creates a new BooleanBinding that holds true if this NumberExpression is less than or equal to a constant value.
BooleanBinding	lessThanOrEqualTo(float other)	Creates a new BooleanBinding that holds true if this NumberExpression is less than or equal to a constant value.
BooleanBinding	lessThanOrEqualTo(int other)	Creates a new BooleanBinding that holds true if this NumberExpression is less than or equal to a constant value.
BooleanBinding	lessThanOrEqualTo(long other)	Creates a new BooleanBinding that holds true if this NumberExpression is less than or equal to a constant value.
BooleanBinding	lessThanOrEqualTo(ObservableNumberValue other)	Creates a new BooleanBinding that holds true if this NumberExpression is less than or equal to another ObservableNumberValue.
NumberBinding	multiply(ObservableNumberValue other)	Creates a new NumberBinding that calculates the product of this NumberExpression and another ObservableNumberValue.
static <S extends Number> NumberExpressionBase	numberExpression(ObservableNumberValue value)	Returns an NumberExpressionBase that wraps a ObservableNumberValue.
NumberBinding	subtract(ObservableNumberValue other)	Creates a new NumberBinding that calculates the difference of this NumberExpression and another ObservableNumberValue.

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 ObservableFloatValue

get

Modifier and Type	Method	Description
float	get()	Returns the current value of this ObservableFloatValue.

Methods declared in interface ObservableValue

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

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

get, set

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

Methods declared in interface WritableValue

getValue

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

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

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