org.xwiki.gwt.user.client

Class ShortcutKeyCommand

java.lang.Object

org.xwiki.gwt.user.client.ShortcutKeyCommand

All Implemented Interfaces:

com.google.gwt.core.client.Scheduler.ScheduledCommand, com.google.gwt.user.client.Command

public class ShortcutKeyCommand
extends Object
implements com.google.gwt.user.client.Command

A Command that can be triggered by a shortcut key.

Version:

$Id: dbb998e7bb9e391aeb32d8fa4f9901357098aa1b $

Constructor Summary

Constructors

Constructor and Description
ShortcutKeyCommand(com.google.gwt.user.client.Command command) Creates a new shortcut key command by wrapping the given command.
ShortcutKeyCommand(com.google.gwt.user.client.Command command, boolean repeatable) Creates a new shortcut key command by wrapping the given command.

Method Summary

Modifier and Type	Method and Description
void	execute()
com.google.gwt.user.client.Command	getCommand()
boolean	isRepeatable()

Methods inherited from class java.lang.Object

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

Constructor Detail

ShortcutKeyCommand

public ShortcutKeyCommand(com.google.gwt.user.client.Command command)

Creates a new shortcut key command by wrapping the given command.

Parameters:

command - the command to be wrapped

ShortcutKeyCommand

public ShortcutKeyCommand(com.google.gwt.user.client.Command command,
                          boolean repeatable)

Creates a new shortcut key command by wrapping the given command.

Parameters:

command - the command to be wrapped

repeatable - true if the given command can be executed multiple times while the shortcut key is held down, false otherwise

Method Detail

execute

public void execute()

Specified by:

execute in interface com.google.gwt.core.client.Scheduler.ScheduledCommand

Specified by:

execute in interface com.google.gwt.user.client.Command

isRepeatable

public boolean isRepeatable()

Returns:

true is this command can be executed while the shortcut key is held down, false otherwise

getCommand

public com.google.gwt.user.client.Command getCommand()

Returns:

the underlying command triggered by the associated shortcut key