de.saxsys.mvvmfx.utils.commands

Class CompositeCommand

java.lang.Object

de.saxsys.mvvmfx.utils.commands.CommandBase

de.saxsys.mvvmfx.utils.commands.CompositeCommand

All Implemented Interfaces:

Command

@Beta
public class CompositeCommand
extends CommandBase

CompositeCommand is an aggregation of other commands - a list of Command references internally.

It allows you to hook up multiple command targets to a single root command that itself can be hooked up to a command source such as a button or menu item.

The CompositeCommand can hold references to any object but typically you will use it in conjunction with DelegateCommands.

When the execute() method is invoked it will invoke the Command.execute() method on each of the child commands.

When CommandBase.isExecutable() is called to determine whether the command is enabled, it polls its child commands for their result from CommandBase.isExecutable().

Author:

alexander.casall

Property Summary

Type	Property and Description
javafx.beans.property.ReadOnlyDoubleProperty	progress

Properties inherited from class de.saxsys.mvvmfx.utils.commands.CommandBase

executableProperty, notExecutableProperty, notRunningProperty, runningProperty

Field Summary

Fields inherited from class de.saxsys.mvvmfx.utils.commands.CommandBase

executable, notExecutable, notRunning, running

Constructor Summary

Constructors

Constructor and Description
CompositeCommand(Command... commands) Creates a CompositeCommand with given commands.

Method Summary

Modifier and Type	Method and Description
void	execute() This method will be called when the command is invoked.
double	getProgress() Gets the value of the property progress.
javafx.beans.property.ReadOnlyDoubleProperty	progressProperty()
void	register(Command command) Registers a new Command for aggregation.
void	unregister(Command command) Unregisters a Command from aggregation.

Methods inherited from class de.saxsys.mvvmfx.utils.commands.CommandBase

executableProperty, isExecutable, isNotExecutable, isNotRunning, isRunning, notExecutableProperty, notRunningProperty, runningProperty

Methods inherited from class java.lang.Object

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

Property Detail

progress

public javafx.beans.property.ReadOnlyDoubleProperty progressProperty

See Also:

getProgress()

Constructor Detail

CompositeCommand

public CompositeCommand(Command... commands)

Creates a CompositeCommand with given commands.

Parameters:

commands - to aggregate

Method Detail

register

public void register(Command command)

Registers a new Command for aggregation.

Parameters:

command - to register

unregister

public void unregister(Command command)

Unregisters a Command from aggregation.

Parameters:

command - to unregister

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

Specified by:

execute in class CommandBase

getProgress

public double getProgress()

Gets the value of the property progress.

Returns:

progress

progressProperty

public javafx.beans.property.ReadOnlyDoubleProperty progressProperty()

See Also:

getProgress()