Class: OnScreenKeyboard

Guacamole.OnScreenKeyboard

new OnScreenKeyboard(layout)

Dynamic on-screen keyboard. Given the layout object for an on-screen keyboard, this object will construct a clickable on-screen keyboard with its own key events.
Parameters:
Name Type Description
layout Guacamole.OnScreenKeyboard.Layout The layout of the on-screen keyboard to display.
Source:

Classes

Key
Layout

Members

keys :Object.<String, Array.<Guacamole.OnScreenKeyboard.Key>>

Map of all key names to their corresponding set of keys. Each key name may correspond to multiple keys due to the effect of modifiers.
Type:
Source:

layout :Guacamole.OnScreenKeyboard.Layout

The keyboard layout provided at time of construction.
Type:
Source:

touchMouseThreshold :Number

The number of mousemove events to require before re-enabling mouse event handling after receiving a touch event.
Type:
  • Number
Source:

Methods

getElement() → {Element}

Returns the element containing the entire on-screen keyboard.
Source:
Returns:
The element containing the entire on-screen keyboard.
Type
Element

resize(width)

Resizes all elements within this Guacamole.OnScreenKeyboard such that the width is close to but does not exceed the specified width. The height of the keyboard is determined based on the width.
Parameters:
Name Type Description
width Number The width to resize this Guacamole.OnScreenKeyboard to, in pixels.
Source:

Events

onkeydown

Fired whenever the user presses a key on this Guacamole.OnScreenKeyboard.
Parameters:
Name Type Description
keysym Number The keysym of the key being pressed.
Source:

onkeyup

Fired whenever the user releases a key on this Guacamole.OnScreenKeyboard.
Parameters:
Name Type Description
keysym Number The keysym of the key being released.
Source: