de.saxsys.mvvmfx.utils.commands

Class CommandBase

java.lang.Object

de.saxsys.mvvmfx.utils.commands.CommandBase

All Implemented Interfaces:

Command

Direct Known Subclasses:

CompositeCommand

@Beta
public abstract class CommandBase
extends Object
implements Command

Basic implementation of a Command. It provides the executableProperty() and runningProperty() implementations.

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.ReadOnlyBooleanProperty	running

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

progressProperty

Field Summary

Fields

Modifier and Type	Field and Description
protected javafx.beans.property.ReadOnlyBooleanWrapper	executable
protected javafx.beans.property.ReadOnlyBooleanWrapper	notExecutable
protected javafx.beans.property.ReadOnlyBooleanWrapper	notRunning
protected javafx.beans.property.ReadOnlyBooleanWrapper	running

Constructor Summary

Constructors

Constructor and Description
CommandBase()

Method Summary

Modifier and Type	Method and Description
javafx.beans.property.ReadOnlyBooleanProperty	executableProperty()
abstract void	execute() This method will be called when the command is invoked.
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.
boolean	isRunning() Gets the value of the property running.
javafx.beans.property.ReadOnlyBooleanProperty	notExecutableProperty()
javafx.beans.property.ReadOnlyBooleanProperty	notRunningProperty()
javafx.beans.property.ReadOnlyBooleanProperty	runningProperty()

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, progressProperty

Property Detail

executable

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

running

public final javafx.beans.property.ReadOnlyBooleanProperty runningProperty

Specified by:

runningProperty in interface Command

See Also:

isRunning()

notRunning

public final javafx.beans.property.ReadOnlyBooleanProperty notRunningProperty

Specified by:

notRunningProperty in interface Command

See Also:

isNotRunning()

Field Detail

executable

protected final javafx.beans.property.ReadOnlyBooleanWrapper executable

running

protected final javafx.beans.property.ReadOnlyBooleanWrapper running

notExecutable

protected javafx.beans.property.ReadOnlyBooleanWrapper notExecutable

notRunning

protected javafx.beans.property.ReadOnlyBooleanWrapper notRunning

Constructor Detail

CommandBase

public CommandBase()

Method Detail

executableProperty

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

Specified by:

executableProperty in interface Command

See Also:

isExecutable()

isExecutable

public final 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.

runningProperty

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

Specified by:

runningProperty in interface Command

See Also:

isRunning()

isRunning

public final boolean isRunning()

Gets the value of the property running.

Specified by:

isRunning in interface Command

Returns:

true if the Command is running, 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.

execute

public abstract 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