Documentation
eKeyboard
Description
eKeyboard is a virtual keyboard displayed right after clicking on the input/text area the addon works with.
Properties
The list starts with the common properties, learn more about them by visiting the Modules description section. The other available properties are described below.
| Property name | Description |
|---|---|
| Work With | New line separated IDs of the modules that eKeyboard can work with. It is compatible with Basic Math Gaps and gaps in Table, Writing Calculations, Text and Crossword modules. |
| Layout Type | Type of the eKeyboard layout. You can choose one of the standard layouts: Numeric, QWERTY or Custom which means you can set whatever Layout you like by configuring Custom Layout field. |
| Custom Layout | Buttons should be space separated, group of buttons (rows) should be new line separated. For Action keys: Mottie Keyboard Wiki |
| Position My | Position of the addon relative to input/textarea it works with. Read more: jQuery UI Position |
| Position At | Position of the input/textarea relative to the addon. Read more: jQuery UI Position |
| Max Characters | Maximum number of characters the input/textarea can get before the focus will jump to the next input/textarea. |
| Don't Open On Focus | When this property is selected, the eKeyboard will NOT show up on input focus. You will have to open it manually. |
| Lock Standard Keyboard Input | This option locks inputs from standard keyboard. The user can input only characters available from eKeyboard keyset. |
| Custom Display | This property allows changing text on the button. For example, an equivalent of English word: Caps Lock in German is: Umschalt. It is possible to change the following buttons: a, accept, alt, bksp, c, cancel, clear, combo, dec, enter, left, next, prev, right, shift, sign, space, t, tab |
| Show Close Button | When this property is selected, the eKeyboard module will have the button to disable/enable it on this page. |
| Work with all | When this property is selected, the eKeyboard module disregard the "Work with" property and will work with all supported modules on the given page: Basic Math Gaps, Table, Writing Calculations, Text and Crossword |
Example configuration of Work With property
Basic_Math_Gaps1
Table1
Text1
It means that when a user clicks on the input within these addons, the virtual keyboard will show up.
Example configuration of Custom Layout property
{ 'default' : ['1 2 3', '4 5 6', '7 8 9', '{prev} {accept} {next}'] }
This configuration will display eKeyboard with digits 1–9 in 3 rows and in the last row there will be 3 action keys: previous, accept, next.
Example configuration of Position My and Position At property
Position My: right center
Positon At: left center
It means that the eKeyboard right side will be on the left side of the input/textarea.
Example configuration of Custom Display property
It is possible to change the button text from e.g. CapsLock to Umschalt. All you need to do is fill in the "Custom Display" property: {'shift' : 'Umschalt'}. You may change more than one button. The writing convention is: {'shift' : 'Umschalt', 'prev' : 'früher', 'weiter' : 'next' }
Supported commands
| Command name | Params | Description |
|---|---|---|
| open | moduleId, inputIndex | Shows the addon. |
| disable | --- | Disable addon on page. |
| enable | --- | Enable addon on page. |
Advanced Connector integration
This will open eKeyboard module when all answers in True False module are correct. eKeyboard will be next to input with index 1.
EVENTSTART
Source:TrueFalse
Item: all
SCRIPTSTART
var module= presenter.playerController.getModule('eKeyboard1');
module.open('Text7', 1);
SCRIPTEND
EVENTEND
CSS Classes
| Property name | Description |
|---|---|
| .ui-keyboard-button | Default button class |
| .ui-state-hover | Button in hovered state |
| .ui-keyboard-actionkey | Special/action button |
| .ui-state-default | Button in default state |
| .ui-keyboard | Whole keyboard container |
| .ui-keyboard-keyset | Container for buttons |
| .eKeyboard-close-button | Container for close button |
| .eKeyboard-open-button | Container for open button |
Demo presentation
Demo presentation contains examples of how this addon can be used.