Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
|Open Bugzilla tickets|
|Open Gerrit reviews|
Keyboard Layouts in SWTBot
SWTBot can send keyboard events using different strategies:
- AWTKeyboardStrategy uses the AWT Robot class, which works independently from the widget toolkit.
- SWTKeyboardStrategy uses SWT Display#post, see 273624: Provide native keyboard support for use with Display.post.
- MockKeyboardStrategy uses Widget#notifyListeners.
These different strategies are made available because the keyboard handling is very different depending on the native widget toolkit, keyboard layout and operating system / JRE / SWT version. Not all strategies work in all cases, see KeyboardTest & non EN keyboards to learn more about the reasons why different strategies are provided.
The Keyboard strategies need to send events with key codes, not with characters. For example, for a QWERTY/Z keyboard layout, to type the character '!', you need to press "SHIFT+1" and these events will be generated:
- KeyDown Shift
- KeyDown 1
- KeyUp 1
- KeyUp Shift
This effectively closely simulates a normal human being typing at a keyboard. In order to configure SWTBot to work with various keyboard layouts, SWTBot contains '.keyboard' files which define a mapping from characters to keys combinations, for example the character '!' maps to the keystrokes 'SHIFT+1' (on a US keyboard). This mapping is different depending on the keyboard layout of the system executing the tests. SWTBot includes some keyboard layouts, but the layout for your keyboard may be not available as of now. Please read further in case your layout is unavailable.
By default, SWTBot uses the AWT keyboard strategy. This can be configured using the system property "org.eclipse.swtbot.keyboard.strategy" or the variable SWTBotPreferences#KEYBOARD_STRATEGY.
Creating keyboard layouts
If your keyboard is missing, please file a bug for SWTBot in Bugzilla. Please mention the country code and operation system.
The keyboard layout is automatically detected from the system. To define the keyboard layout explicitly, you can set the system property "org.eclipse.swtbot.keyboard.layout" or set the variable SWTBotPreferences#KEYBOARD_LAYOUT.
The value of the keyboard layout property should be of the form [package.name.][MAC.][upper-case-two-character-country-code]. For e.g. com.foo.bar.DE (for a German keyboard) or com.foo.bar.MAC.FR (for a French keyboard on a mac). If the package name is omitted, the layout is loaded from the SWTBot package org.eclipse.swtbot.swt.finder.keyboard. The prefix "MAC." marks keyboard layouts for Mac keyboards.
Keyboard layouts can be created using the KeyboardLayoutGenerator class in the 'org.eclipse.swtbot.swt.finder.test' bundle. This class is not packaged with SWTBot, you will need to download this from the SWTBot source repository.
To create keyboard mappings for your keyboard:
- Checkout the bundle 'org.eclipse.swtbot.swt.finder.test'
- Change method Keys#specialChars() for your keyboard.
- Execute KeyboardLayoutGenerator, this will generate a file 'keyboard.layout' containing keyboard mappings.
- Execute KeyboardLayoutFilter, this will generate a file keyboard.layout.filtered containing filtered keyboard mappings.
- Ensure that keyboard.layout.filtered is correct and not missing anything obvious, edit if necessary.
- Rename keyboard.layout.filtered to [COUNTRY_CODE].keyboard.
- You should execute the SWTKeyboardTest and/or AWTKeyboardTest test classes to check if your .keyboard file is working properly.
- Please file a bug and a Gerrit review to contribute the keyboard layout once you got it working or attach it to your bug for the missing keyboard layout!
.keyboard file format
.keyboard files are simple text files with the following format:
The <CHARACTER> is the complex character that needs to be typed, and the <KEY_COMBINATION> is the combination that types the <CHARACTER>. Valid <KEY_COMBINATION>s are: CTRL, SHIFT, ALT, COMMAND and all other keys on the keyboard, capitalized ( 'T' is valid, 't' is not). Similarly '3' on a US keyboard is valid, '#' is not.
! shift + 1 @ shift + 2 # shift + 3 $ shift + 4