Class FloatBinding

java.lang.Object

javafx.beans.binding.NumberExpressionBase

javafx.beans.binding.FloatExpression

javafx.beans.binding.FloatBinding

All Implemented Interfaces:

Binding<Number>, NumberBinding, NumberExpression, Observable, ObservableFloatValue, ObservableNumberValue, ObservableValue<Number>

public abstract class FloatBinding
extends FloatExpression
implements NumberBinding

Base class that provides most of the functionality needed to implement a Binding of a float value.

FloatBinding provides a simple invalidation-scheme. An extending class can register dependencies by calling bind(Observable...). If One of the registered dependencies becomes invalid, this FloatBinding is marked as invalid. With unbind(Observable...) listening to dependencies can be stopped.

To provide a concrete implementation of this class, the method computeValue() has to be implemented to calculate the value of this binding based on the current state of the dependencies. It is called when get() is called for an invalid binding.

See DoubleBinding for an example how this base class can be extended.

Since:

JavaFX 2.0

See Also:

• Binding
• NumberBinding
• FloatExpression

Constructor Summary

Constructors

Constructor	Description
FloatBinding()	Creates a default FloatBinding.

Method Summary

Modifier and Type	Method	Description
void	addListener(InvalidationListener listener)	Adds an InvalidationListener which will be notified whenever the Observable becomes invalid.
void	addListener(ChangeListener<? super Number> listener)	Adds a ChangeListener which will be notified whenever the value of the ObservableValue changes.
protected final void	bind(Observable... dependencies)	Start observing the dependencies for changes.
protected abstract float	computeValue()	Calculates the current value of this binding.
void	dispose()	A default implementation of dispose() that is empty.
final float	get()	Returns the result of computeValue().
ObservableList<?>	getDependencies()	A default implementation of getDependencies() that returns an empty ObservableList.
final void	invalidate()	Mark a binding as invalid.
final boolean	isValid()	Checks if a binding is valid.
protected void	onInvalidating()	The method onInvalidating() can be overridden by extending classes to react, if this binding 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.
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.
String	toString()	Returns a string representation of this FloatBinding object.
protected final void	unbind(Observable... dependencies)	Stop observing the dependencies for changes.

Methods declared in class FloatExpression

add, add, add, add, asObject, 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.
ObjectExpression<Float>	asObject()	Creates an ObjectExpression that holds the value of this FloatExpression.
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

subscribe

Modifier and Type	Method	Description
default Subscription	subscribe(Runnable invalidationSubscriber)	Creates a Subscription on this Observable which calls invalidationSubscriber whenever it becomes invalid.

Methods declared in interface ObservableValue

flatMap, map, orElse, subscribe, subscribe, when

Modifier and Type	Method	Description
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.
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.

Constructor Details

FloatBinding

public FloatBinding()

Creates a default FloatBinding.

Method Details

addListener

public void addListener(InvalidationListener listener)

Description copied from interface: Observable

Adds an InvalidationListener which will be notified whenever the Observable becomes invalid. If the same listener is added more than once, then it will be notified more than once. That is, no check is made to ensure uniqueness.

Note that the same actual InvalidationListener instance may be safely registered for different Observables.

The Observable stores a strong reference to the listener which will prevent the listener from being garbage collected and may result in a memory leak. It is recommended to either unregister a listener by calling removeListener after use or to use an instance of WeakInvalidationListener avoid this situation.

Specified by:

addListener in interface Observable

Parameters:

listener - The listener to register

See Also:

• Observable.removeListener(InvalidationListener)

removeListener

public void removeListener(InvalidationListener listener)

Description copied from interface: Observable

Removes the given listener from the list of listeners, that are notified whenever the value of the Observable becomes invalid.

If the given listener has not been previously registered (i.e. it was never added) then this method call is a no-op. If it had been previously added then it will be removed. If it had been added more than once, then only the first occurrence will be removed.

Specified by:

removeListener in interface Observable

Parameters:

listener - The listener to remove

See Also:

• Observable.addListener(InvalidationListener)

addListener

public void addListener(ChangeListener<? super Number> listener)

Description copied from interface: ObservableValue

Adds a ChangeListener which will be notified whenever the value of the ObservableValue changes. If the same listener is added more than once, then it will be notified more than once. That is, no check is made to ensure uniqueness.

Note that the same actual ChangeListener instance may be safely registered for different ObservableValues.

The ObservableValue stores a strong reference to the listener which will prevent the listener from being garbage collected and may result in a memory leak. It is recommended to either unregister a listener by calling removeListener after use or to use an instance of WeakChangeListener avoid this situation.

Specified by:

addListener in interface ObservableValue<Number>

Parameters:

listener - The listener to register

See Also:

• ObservableValue.removeListener(ChangeListener)

removeListener

public void removeListener(ChangeListener<? super Number> listener)

Description copied from interface: ObservableValue

Removes the given listener from the list of listeners that are notified whenever the value of the ObservableValue changes.

If the given listener has not been previously registered (i.e. it was never added) then this method call is a no-op. If it had been previously added then it will be removed. If it had been added more than once, then only the first occurrence will be removed.

Specified by:

removeListener in interface ObservableValue<Number>

Parameters:

listener - The listener to remove

See Also:

• ObservableValue.addListener(ChangeListener)

bind

protected final void bind(Observable... dependencies)

Start observing the dependencies for changes. If the value of one of the dependencies changes, the binding is marked as invalid.

Parameters:

dependencies - the dependencies to observe

unbind

protected final void unbind(Observable... dependencies)

Stop observing the dependencies for changes.

Parameters:

dependencies - the dependencies to stop observing

dispose

public void dispose()

A default implementation of dispose() that is empty.

Specified by:

dispose in interface Binding<Number>

getDependencies

public ObservableList<?> getDependencies()

A default implementation of getDependencies() that returns an empty ObservableList.

Specified by:

getDependencies in interface Binding<Number>

Returns:

an empty ObservableList

get

public final float get()

Returns the result of computeValue(). The method computeValue() is only called if the binding is invalid. The result is cached and returned if the binding did not become invalid since the last call of getValue.

Specified by:

get in interface ObservableFloatValue

Returns:

The current value

onInvalidating

protected void onInvalidating()

The method onInvalidating() can be overridden by extending classes to react, if this binding becomes invalid. The default implementation is empty.

invalidate

public final void invalidate()

Description copied from interface: Binding

Mark a binding as invalid. This forces the recalculation of the value of the Binding next time it is request.

Specified by:

invalidate in interface Binding<Number>

isValid

public final boolean isValid()

Description copied from interface: Binding

Checks if a binding is valid.

Specified by:

isValid in interface Binding<Number>

Returns:

true if the Binding is valid, false otherwise

computeValue

protected abstract float computeValue()

Calculates the current value of this binding.

Classes extending FloatBinding have to provide an implementation of computeValue.

Returns:

the current value

toString

public String toString()

Returns a string representation of this FloatBinding object.

Overrides:

toString in class Object

Returns:

a string representation of this FloatBinding object.