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

public interface Executable

The code associated with a Command.

Version:

$Id: Executable.java 24900 2009-11-06 16:53:01Z sdumitriu $

Method Summary

boolean	execute(RichTextArea rta, java.lang.String param) Executes the associated Command on the specified rich text area with the given parameter.
java.lang.String	getParameter(RichTextArea rta)
boolean	isEnabled(RichTextArea rta)
boolean	isExecuted(RichTextArea rta)
boolean	isSupported(RichTextArea rta)

Method Detail

execute

boolean execute(RichTextArea rta,
                java.lang.String param)

Executes the associated Command on the specified rich text area with the given parameter.

Parameters:

rta - Execution target.

param - Execution parameter.

Returns:

true if execution succeeds.

See Also:

CommandManager.execute(Command, String)

isSupported

boolean isSupported(RichTextArea rta)

Parameters:

rta - Execution target.

Returns:

true if the associated Command is supported by the specified rich text area.

See Also:

CommandManager.isSupported(Command)

isEnabled

boolean isEnabled(RichTextArea rta)

Parameters:

rta - Execution target.

Returns:

true if the associated Command can be executed on the current state of the given rich text area.

See Also:

CommandManager.isEnabled(Command)

isExecuted

boolean isExecuted(RichTextArea rta)

Parameters:

rta - Execution target.

Returns:

true if the associated Command has been executed on the current state of the given rich text area.

See Also:

CommandManager.isExecuted(Command)

getParameter

java.lang.String getParameter(RichTextArea rta)

Parameters:

rta - Execution target.

Returns:

the previous execution parameter, if isExecuted(RichTextArea) returns true, null otherwise.