org.assertj.swing.core

Class KeyPressInfo

java.lang.Object

org.assertj.swing.core.KeyPressInfo

public final class KeyPressInfo
extends Object

Information about a key (from the keyboard) to press.

Examples:

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

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

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

 // import static org.assertj.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()
static KeyPressInfo	keyCode(int keyCode) Specifies the code of the key to press, without any modifiers (e.g.
int[]	modifiers()
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

@Nonnull
public static KeyPressInfo keyCode(int keyCode)

Specifies the code of the key to press, without any modifiers (e.g. java.awt.event.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.

modifiers

@Nonnull
public int[] modifiers()

Returns:

the modifiers to use when pressing the specified key.

modifiers

@Nonnull
public KeyPressInfo modifiers(@Nonnull
                             int... newModifiers)

Specifies the modifiers to use when pressing the specified key (e.g. java.awt.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.