de.saxsys.mvvmfx.utils.commands

Interface Command

All Known Implementing Classes:

CommandBase, CompositeCommand, DelegateCommand

@Beta
public interface Command

The Command encapsulates logic in the execute() method which will be called later. This can be used for example to provide an execute()-action which should perform on a button click.

In addition it is possible to add the information on whether the Command can be executed at the moment or not (isExecutable()).

Author:

alexander.casall

Property Summary

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

Method Summary

Modifier and Type	Method and Description
javafx.beans.property.ReadOnlyBooleanProperty	executableProperty()
void	execute() This method will be called when the command is invoked.
double	getProgress() Gets a double between 0.0 and 1.0 which represents the progress.
boolean	isExecutable() Determines whether the command can be executed in it's current state.
boolean	isNotExecutable() Determines whether the command can not execute in it's current state.
boolean	isNotRunning() Signals whether the command is currently not executing.
boolean	isRunning() Signals whether the command is currently executing.
javafx.beans.property.ReadOnlyBooleanProperty	notExecutableProperty()
javafx.beans.property.ReadOnlyBooleanProperty	notRunningProperty()
javafx.beans.property.ReadOnlyDoubleProperty	progressProperty()
javafx.beans.property.ReadOnlyBooleanProperty	runningProperty()

Property Detail

executable

javafx.beans.property.ReadOnlyBooleanProperty executableProperty

See Also:

isExecutable()

notExecutable

javafx.beans.property.ReadOnlyBooleanProperty notExecutableProperty

See Also:

isNotExecutable()

running

javafx.beans.property.ReadOnlyBooleanProperty runningProperty

See Also:

isRunning()

notRunning

javafx.beans.property.ReadOnlyBooleanProperty notRunningProperty

See Also:

isNotRunning()

progress

javafx.beans.property.ReadOnlyDoubleProperty progressProperty

See Also:

getProgress()

Method Detail

execute

void execute()

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

isExecutable

boolean isExecutable()

Determines whether the command can be executed in it's current state.

Returns:

true if the Command can executed, otherwise false.

executableProperty

javafx.beans.property.ReadOnlyBooleanProperty executableProperty()

See Also:

isExecutable()

isNotExecutable

boolean isNotExecutable()

Determines whether the command can not execute in it's current state.

Returns:

true if the Command can not execute, otherwise false.

notExecutableProperty

javafx.beans.property.ReadOnlyBooleanProperty notExecutableProperty()

See Also:

isNotExecutable()

isRunning

boolean isRunning()

Signals whether the command is currently executing. This can be useful especially for commands that are executed asynchronously.

Returns:

true if the Command is running, otherwise false.

runningProperty

javafx.beans.property.ReadOnlyBooleanProperty runningProperty()

See Also:

isRunning()

isNotRunning

boolean isNotRunning()

Signals whether the command is currently not executing. This can be useful especially for commands that are executed asynchronously.

Returns:

true if the Command is not running, otherwise false.

notRunningProperty

javafx.beans.property.ReadOnlyBooleanProperty notRunningProperty()

See Also:

isNotRunning()

getProgress

double getProgress()

Gets a double between 0.0 and 1.0 which represents the progress.

Returns:

progress

progressProperty

javafx.beans.property.ReadOnlyDoubleProperty progressProperty()

See Also:

getProgress()