Class Index | File Index

Classes


Class Guacamole.OnScreenKeyboard


Defined in: OnScreenKeyboard.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
Dynamic on-screen keyboard.
Field Summary
Field Attributes Field Name and Description
 
Map of all key names to their corresponding set of keys.
 
The keyboard layout provided at time of construction.
<inner>  
osk
Reference to this Guacamole.OnScreenKeyboard.
<inner>  
Map of all key names to their current pressed states.
 
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
<inner>  
getActiveKey(keyName)
Returns the single matching Key object associated with the key of the given name, where that Key object's requirements (such as pressed modifiers) are all currently satisfied.
 
Returns the element containing the entire on-screen keyboard.
<inner>  
Returns whether all modifiers having the given names are currently active.
<inner>  
press(keyName, keyElement)
Presses the key having the given name, updating the associated key element with the "guac-keyboard-pressed" CSS class.
<inner>  
release(keyName, keyElement)
Releases the key having the given name, removing the "guac-keyboard-pressed" CSS class from the associated element.
 
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(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:
{Guacamole.OnScreenKeyboard.Layout} layout
The layout of the on-screen keyboard to display.
Field Detail
{Object.} keys
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.

{Guacamole.OnScreenKeyboard.Layout} layout
The keyboard layout provided at time of construction.

<inner> {Guacamole.OnScreenKeyboard} osk
Reference to this Guacamole.OnScreenKeyboard.

<inner> {Object.} pressed
Map of all key names to their current pressed states. If a key is not pressed, it may not be in this map at all, but all pressed keys will have a corresponding mapping to true.

{Number} touchMouseThreshold
The number of mousemove events to require before re-enabling mouse event handling after receiving a touch event.
Method Detail
<inner> {Guacamole.OnScreenKeyboard.Key} getActiveKey(keyName)
Returns the single matching Key object associated with the key of the given name, where that Key object's requirements (such as pressed modifiers) are all currently satisfied.
Parameters:
{String} keyName
The name of the key to retrieve.
Returns:
{Guacamole.OnScreenKeyboard.Key} The Key object associated with the given name, where that object's requirements are all currently satisfied, or null if no such Key can be found.

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

<inner> {Boolean} modifiersPressed(names)
Returns whether all modifiers having the given names are currently active.
Parameters:
{String[]} names
The names of all modifiers to test.
Returns:
{Boolean} true if all specified modifiers are pressed, false otherwise.

<inner> press(keyName, keyElement)
Presses the key having the given name, updating the associated key element with the "guac-keyboard-pressed" CSS class. If the key is already pressed, this function has no effect.
Parameters:
{String} keyName
The name of the key to press.
{String} keyElement
The element associated with the given key.

<inner> release(keyName, keyElement)
Releases the key having the given name, removing the "guac-keyboard-pressed" CSS class from the associated element. If the key is already released, this function has no effect.
Parameters:
{String} keyName
The name of the key to release.
{String} keyElement
The element associated with the given key.

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.

Documentation generated by JsDoc Toolkit 2.4.0 on Wed Jun 10 2015 21:35:44 GMT-0700 (PDT)