de.saxsys.mvvmfx.utils.commands

Class DelegateCommand

java.lang.Object

javafx.concurrent.Service<Void>

de.saxsys.mvvmfx.utils.commands.DelegateCommand

All Implemented Interfaces:

Command, javafx.concurrent.Worker<Void>, javafx.event.EventTarget

@Beta
public class DelegateCommand
extends javafx.concurrent.Service<Void>
implements Command

A Command implementation of a Service that encapsulates an Action (Task) which can be called from the UI - for example after a button click. If the Action is a long running operation, which would block your UI, you can pass a parameter to perform the Action in a background thread. You can bind to the Service.isRunning() property while the action is executing. This can be used for a loading indication in the UI.

Author:

alexander.casall

Property Summary

Type	Property and Description
javafx.beans.property.ReadOnlyBooleanProperty	executable
javafx.beans.property.ReadOnlyBooleanProperty	notExecutable
javafx.beans.property.ReadOnlyBooleanProperty	notRunning

Properties inherited from class javafx.concurrent.Service

exceptionProperty, executorProperty, messageProperty, onCancelledProperty, onFailedProperty, onReadyProperty, onRunningProperty, onScheduledProperty, onSucceededProperty, progressProperty, runningProperty, stateProperty, titleProperty, totalWorkProperty, valueProperty, workDoneProperty

Properties inherited from interface de.saxsys.mvvmfx.utils.commands.Command

progressProperty, runningProperty

Nested Class Summary

Nested classes/interfaces inherited from interface javafx.concurrent.Worker

javafx.concurrent.Worker.State

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.function.Supplier<Action>	actionSupplier
protected javafx.beans.property.ReadOnlyBooleanWrapper	executable
protected boolean	inBackground
protected javafx.beans.property.ReadOnlyBooleanWrapper	notExecutable
protected javafx.beans.property.ReadOnlyBooleanWrapper	notRunning

Constructor Summary

Constructors

Constructor and Description
DelegateCommand(java.util.function.Supplier<Action> actionSupplier) Creates a command without a condition about the executability.
DelegateCommand(java.util.function.Supplier<Action> actionSupplier, boolean inBackground) Creates a command without an condition about the executability.
DelegateCommand(java.util.function.Supplier<Action> actionSupplier, javafx.beans.value.ObservableValue<Boolean> executableObservable) Creates a command with a condition about the executability by using the 'executableObservable' parameter.
DelegateCommand(java.util.function.Supplier<Action> actionSupplier, javafx.beans.value.ObservableValue<Boolean> executableObservable, boolean inBackground) Creates a command with a condition about the executability by using the 'executableObservable' parameter.

Method Summary

Modifier and Type	Method and Description
protected void	callActionAndSynthesizeServiceRun()
protected static javafx.beans.property.Property<Throwable>	checkExceptionProperty(javafx.beans.property.ReadOnlyObjectProperty<Throwable> exceptionProperty)
protected javafx.concurrent.Task<Void>	createTask()
javafx.beans.property.ReadOnlyBooleanProperty	executableProperty()
void	execute() This method will be called when the command is invoked.
java.util.function.Supplier<Action>	getActionSupplier()
boolean	isExecutable() Gets the value of the property executable.
boolean	isNotExecutable() Gets the value of the property notExecutable.
boolean	isNotRunning() Gets the value of the property notRunning.
javafx.beans.property.ReadOnlyBooleanProperty	notExecutableProperty()
javafx.beans.property.ReadOnlyBooleanProperty	notRunningProperty()

Methods inherited from class javafx.concurrent.Service

addEventFilter, addEventHandler, buildEventDispatchChain, cancel, cancelled, exceptionProperty, executeTask, executorProperty, failed, fireEvent, getException, getExecutor, getMessage, getOnCancelled, getOnFailed, getOnReady, getOnRunning, getOnScheduled, getOnSucceeded, getProgress, getState, getTitle, getTotalWork, getValue, getWorkDone, isRunning, messageProperty, onCancelledProperty, onFailedProperty, onReadyProperty, onRunningProperty, onScheduledProperty, onSucceededProperty, progressProperty, ready, removeEventFilter, removeEventHandler, reset, restart, running, runningProperty, scheduled, setEventHandler, setExecutor, setOnCancelled, setOnFailed, setOnReady, setOnRunning, setOnScheduled, setOnSucceeded, start, stateProperty, succeeded, titleProperty, totalWorkProperty, valueProperty, workDoneProperty

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.saxsys.mvvmfx.utils.commands.Command

getProgress, isRunning, progressProperty, runningProperty

Property Detail

executable

public javafx.beans.property.ReadOnlyBooleanProperty executableProperty

Specified by:

executableProperty in interface Command

See Also:

isExecutable()

notExecutable

public final javafx.beans.property.ReadOnlyBooleanProperty notExecutableProperty

Specified by:

notExecutableProperty in interface Command

See Also:

isNotExecutable()

notRunning

public final javafx.beans.property.ReadOnlyBooleanProperty notRunningProperty

Specified by:

notRunningProperty in interface Command

See Also:

isNotRunning()

Field Detail

actionSupplier

protected final java.util.function.Supplier<Action> actionSupplier

inBackground

protected boolean inBackground

executable

protected final javafx.beans.property.ReadOnlyBooleanWrapper executable

notExecutable

protected javafx.beans.property.ReadOnlyBooleanWrapper notExecutable

notRunning

protected javafx.beans.property.ReadOnlyBooleanWrapper notRunning

Constructor Detail

DelegateCommand

public DelegateCommand(java.util.function.Supplier<Action> actionSupplier)

Creates a command without a condition about the executability.

Parameters:

actionSupplier - a function that returns a new Action which should be executed

DelegateCommand

public DelegateCommand(java.util.function.Supplier<Action> actionSupplier,
                       boolean inBackground)

Creates a command without an condition about the executability. Pass a true to the inBackground parameter to run the Command in a background thread. IF YOU USE THE BACKGROUND THREAD: Your provided action will perform in a background thread. If you manipulate data in your action, which will be propagated to the UI, use Platform.runLater(Runnable) for this manipulation, otherwise you get an Exception by JavaFX.

Parameters:

actionSupplier - a function that returns a new Action which should be executed

inBackground - defines whether the execution execute() is performed in a background thread or not

DelegateCommand

public DelegateCommand(java.util.function.Supplier<Action> actionSupplier,
                       javafx.beans.value.ObservableValue<Boolean> executableObservable)

Creates a command with a condition about the executability by using the 'executableObservable' parameter.

Parameters:

actionSupplier - a function that returns a new Action which should be executed

executableObservable - which defines whether the Command can execute

DelegateCommand

public DelegateCommand(java.util.function.Supplier<Action> actionSupplier,
                       javafx.beans.value.ObservableValue<Boolean> executableObservable,
                       boolean inBackground)

Creates a command with a condition about the executability by using the 'executableObservable' parameter. Pass a true to the #inBackground parameter to run the Command in a background thread. IF YOU USE THE BACKGROUND THREAD: don't forget to return to the UI-thread by using Platform.runLater(Runnable), otherwise you get an Exception.

Parameters:

actionSupplier - a function that returns a new Action which should be executed

executableObservable - which defines whether the Command can execute

inBackground - defines whether the execution execute() is performed in a background thread or not

Method Detail

execute

public void execute()

Description copied from interface: Command

This method will be called when the command is invoked. This has to get called from FX Thread

Specified by:

execute in interface Command

See Also:

Command.execute()

callActionAndSynthesizeServiceRun

protected void callActionAndSynthesizeServiceRun()

createTask

protected javafx.concurrent.Task<Void> createTask()

Specified by:

createTask in class javafx.concurrent.Service<Void>

executableProperty

public javafx.beans.property.ReadOnlyBooleanProperty executableProperty()

Specified by:

executableProperty in interface Command

See Also:

isExecutable()

isExecutable

public boolean isExecutable()

Gets the value of the property executable.

Specified by:

isExecutable in interface Command

Returns:

true if the Command can executed, otherwise false.

notExecutableProperty

public final javafx.beans.property.ReadOnlyBooleanProperty notExecutableProperty()

Specified by:

notExecutableProperty in interface Command

See Also:

isNotExecutable()

isNotExecutable

public final boolean isNotExecutable()

Gets the value of the property notExecutable.

Specified by:

isNotExecutable in interface Command

Returns:

true if the Command can not execute, otherwise false.

notRunningProperty

public final javafx.beans.property.ReadOnlyBooleanProperty notRunningProperty()

Specified by:

notRunningProperty in interface Command

See Also:

isNotRunning()

isNotRunning

public final boolean isNotRunning()

Gets the value of the property notRunning.

Specified by:

isNotRunning in interface Command

Returns:

true if the Command is not running, otherwise false.

checkExceptionProperty

protected static javafx.beans.property.Property<Throwable> checkExceptionProperty(javafx.beans.property.ReadOnlyObjectProperty<Throwable> exceptionProperty)

getActionSupplier

public java.util.function.Supplier<Action> getActionSupplier()