Class Guacamole.OnScreenKeyboard.Layout
Defined in: OnScreenKeyboard.js.
| Constructor Attributes | Constructor Name and Description |
|---|---|
|
Guacamole.OnScreenKeyboard.Layout(template)
Represents an entire on-screen keyboard layout, including all available
keys, their behaviors, and their relative position and sizing.
|
| Field Attributes | Field Name and Description |
|---|---|
|
Map of key name to corresponding keysym, title, or key object.
|
|
|
The width of each key, in arbitrary units, relative to other keys in
this layout.
|
|
|
The language of keyboard layout, such as "en_US".
|
|
|
Arbitrarily nested, arbitrarily grouped key names.
|
|
|
The type of keyboard layout, such as "qwerty".
|
|
|
The width of the entire keyboard, in arbitrary units.
|
Class Detail
Guacamole.OnScreenKeyboard.Layout(template)
Represents an entire on-screen keyboard layout, including all available
keys, their behaviors, and their relative position and sizing.
- Parameters:
- {Guacamole.OnScreenKeyboard.Layout|Object} template
- The object whose identically-named properties will be used to initialize the properties of this layout.
Field Detail
{Object.}
keys
Map of key name to corresponding keysym, title, or key object. If only
the keysym or title is provided, the key object will be created
implicitly. In all cases, the name property of the key object will be
taken from the name given in the mapping.
{Object.}
keyWidths
The width of each key, in arbitrary units, relative to other keys in
this layout. The true pixel size of each key will be determined by the
overall size of the keyboard. If not defined here, the width of each
key will default to 1.
{String}
language
The language of keyboard layout, such as "en_US". This property is for
informational purposes only, but it is recommend to conform to the
[language code]_[country code] format.
{Object}
layout
Arbitrarily nested, arbitrarily grouped key names. The contents of the
layout will be traversed to produce an identically-nested grouping of
keys in the DOM tree. All strings will be transformed into their
corresponding sets of keys, while all objects and arrays will be
transformed into named groups and anonymous groups respectively. Any
numbers present will be transformed into gaps of that size, scaled
according to the same units as each key.
{String}
type
The type of keyboard layout, such as "qwerty". This property is for
informational purposes only, and does not conform to any standard.
{Number}
width
The width of the entire keyboard, in arbitrary units. The width of each
key is relative to this width, as both width values are assumed to be in
the same units. The conversion factor between these units and pixels is
derived later via a call to resize() on the Guacamole.OnScreenKeyboard.