org.xwiki.gwt.user.client.ui.rta.cmd

Interface CommandListener

public interface CommandListener

Interface that must be implemented in order to be notified of executed commands.

Version:

$Id: 31ee455af529e38bc897397a036bde30b3c0f400 $

Method Summary

Methods

Modifier and Type	Method and Description
boolean	onBeforeCommand(CommandManager sender, Command command, String param) Notifies that the given command is about to be executed with the given parameter by the specified command manager.
void	onCommand(CommandManager sender, Command command, String param) Notifies that the given command has been executed with the given parameter by the specified command manager.

Method Detail

onBeforeCommand

boolean onBeforeCommand(CommandManager sender,
                      Command command,
                      String param)

Notifies that the given command is about to be executed with the given parameter by the specified command manager.

Parameters:

sender - The command manager that is about to execute the specified command.

command - The command that will be executed.

param - The parameter that will be passed to the command.

Returns:

true to prevent the execution of the command, false to allow it.

onCommand

void onCommand(CommandManager sender,
             Command command,
             String param)

Notifies that the given command has been executed with the given parameter by the specified command manager.

Parameters:

sender - The command manager that executed the command.

command - The command executed.

param - The parameter used when the command was executed.