org.fest.swing.core

Class KeyPressInfo

java.lang.Object

org.fest.swing.core.KeyPressInfo

public final class KeyPressInfo
extends Object

Understands information about pressing a keyboard key.

Examples:

Specify that 'CTRL' + 'C' should be pressed:

 // import static org.fest.swing.fixture.KeyPressInfo.*;
 KeyPressInfo i = key(VK_C).modifiers(CTRL_MASK);
 

Specify that 'SHIFT' + 'R' should be pressed:

 // import static org.fest.swing.fixture.KeyPressInfo.*;
 KeyPressInfo i = key(VK_R).modifiers(SHIFT_MASK);
 

For platform-safe mask pressing (e.g. 'Control' in Windows or 'Command' in MacOS) use Platform.controlOrCommandMask().

Author:

Alex Ruiz, Yvonne Wang

Method Summary

Methods

Modifier and Type	Method and Description
int	keyCode() Returns the code of the key to press.
static KeyPressInfo	keyCode(int keyCode) Specifies the code of the key to press, without any modifiers (e.g.
int[]	modifiers() Returns the modifiers to use when pressing the specified key.
KeyPressInfo	modifiers(int... newModifiers) Specifies the modifiers to use when pressing the specified key (e.g.

Methods inherited from class java.lang.Object

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

Method Detail

keyCode

public static KeyPressInfo keyCode(int keyCode)

Specifies the code of the key to press, without any modifiers (e.g. KeyEvent.VK_C.)

Parameters:

keyCode - the code of the key to press.

Returns:

the created KeyPressInfo.

keyCode

public int keyCode()

Returns the code of the key to press.

Returns:

the code of the key to press.

modifiers

public int[] modifiers()

Returns the modifiers to use when pressing the specified key.

Returns:

the modifiers to use.

modifiers

public KeyPressInfo modifiers(int... newModifiers)

Specifies the modifiers to use when pressing the specified key (e.g. Event.CTRL_MASK.)

For platform-safe mask pressing (e.g. 'Control' in Windows or 'Command' in MacOS) use Platform.controlOrCommandMask().

Parameters:

newModifiers - the new modifiers to use.

Returns:

this object.

Throws:

NullPointerException - if newModifiers is null.