Class Guacamole.OnScreenKeyboard

Defined in: OnScreenKeyboard.js.

Class Summary
Constructor Attributes	Constructor Name and Description
	Guacamole.OnScreenKeyboard(url) Dynamic on-screen keyboard.

Field Summary
Field Attributes	Field Name and Description
<inner>	modifier_keysyms Map of currently-set modifiers to the keysym associated with their original press.
	touchMouseThreshold The number of mousemove events to require before re-enabling mouse event handling after receiving a touch event.

Method Summary
Method Attributes	Method Name and Description
	getElement() Returns the element containing the entire on-screen keyboard.
	resize(width) Resizes all elements within this Guacamole.OnScreenKeyboard such that the width is close to but does not exceed the specified width.

Event Summary
Event Attributes	Event Name and Description
	onkeydown(keysym) Fired whenever the user presses a key on this Guacamole.OnScreenKeyboard.
	onkeyup(keysym) Fired whenever the user releases a key on this Guacamole.OnScreenKeyboard.

Class Detail

Guacamole.OnScreenKeyboard(url)

Dynamic on-screen keyboard. Given the URL to an XML keyboard layout file, this object will download and use the XML to construct a clickable on-screen keyboard with its own key events.

Parameters:
{String} url: The URL of an XML keyboard layout file.

Field Detail

<inner> {Object.} modifier_keysyms

Map of currently-set modifiers to the keysym associated with their original press. When the modifier is cleared, this keysym must be released.

touchMouseThreshold

The number of mousemove events to require before re-enabling mouse event handling after receiving a touch event.

Method Detail

{Element} getElement()

Returns the element containing the entire on-screen keyboard.

Returns:: {Element} The element containing the entire on-screen keyboard.

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:
{Number} width: The width to resize this Guacamole.OnScreenKeyboard to, in pixels.

Event Detail

onkeydown(keysym)

Fired whenever the user presses a key on this Guacamole.OnScreenKeyboard.

Parameters:
{Number} keysym: The keysym of the key being pressed.

onkeyup(keysym)

Fired whenever the user releases a key on this Guacamole.OnScreenKeyboard.

Parameters:
{Number} keysym: The keysym of the key being released.

Classes

Class Guacamole.OnScreenKeyboard