Module MaterialFX

Package io.github.palexdev.materialfx.utils.others.observables

Class OnInvalidated<T>

java.lang.Object

io.github.palexdev.materialfx.utils.others.observables.When<T>

io.github.palexdev.materialfx.utils.others.observables.OnInvalidated<T>

public class OnInvalidated<T>
extends When<T>

Concrete implementation of When that uses InvalidationListeners to listen for changes for a given ObservableValue.

You can specify the action to perform when this happens using a Consumer, then(Consumer).

To activate the construct do not forget to call listen() at the end.

An example:

 
      BooleanProperty aSwitch = new SimpleBooleanProperty(false);
      When.onInvalidated(aSwitch) // You can also use... OnInvalidated.forObservable(...)
              .then(value -> System.out.println("Value switched to: " + value))
              .oneShot()
              .listen();
 
 

Field Summary

Fields inherited from class io.github.palexdev.materialfx.utils.others.observables.When

observableValue, oneShot, whens

Method Summary

Modifier and Type	Method	Description
void	dispose()	Disposes the OnInvalidated construct by removing the InvalidationListener from the ObservableValue, then sets the listener to null and finally removes the observable from the map.
static <T> OnInvalidated<T>	forObservable(ObservableValue<T> observableValue)	Creates and instance of this construct for the given ObservableValue.
OnInvalidated<T>	listen()	Activates the OnInvalidated construct with the previously specified parameters.
OnInvalidated<T>	then(Consumer<T> action)	To set the action to perform when the specified ObservableValue becomes invalid.

Methods inherited from class io.github.palexdev.materialfx.utils.others.observables.When

disposeFor, isOneShot, onChanged, oneShot, onInvalidated

Methods inherited from class java.lang.Object

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

Method Details

forObservable

public static <T> OnInvalidated<T> forObservable(ObservableValue<T> observableValue)

Creates and instance of this construct for the given ObservableValue.

then

public OnInvalidated<T> then(Consumer<T> action)

To set the action to perform when the specified ObservableValue becomes invalid. The action is a Consumer that carries the new value of the observable.

listen

public OnInvalidated<T> listen()

Activates the OnInvalidated construct with the previously specified parameters. So, builds the InvalidationListener according to the When.isOneShot() parameter, then adds the listener to the specified ObservableValue and finally puts the Observable and the OnInvalidated construct in the map.

Specified by:

listen in class When<T>

dispose

public void dispose()

Disposes the OnInvalidated construct by removing the InvalidationListener from the ObservableValue, then sets the listener to null and finally removes the observable from the map.

Specified by:

dispose in class When<T>