viewer_keyboard

Summary
Constructs a new embedded Keyboard Object for switching character sets.
Handles character set selection.
Deletes all buttons from the keyboard
Renders a set of keys into the keyboard
Handles key highlighting
maps key codes to viewer_keyboard_keys

Functions

constructor

host.kernel.constructors.viewer_keyboard = function(params_o)

Constructs a new embedded Keyboard Object for switching character sets.

Parameters

params_o{Object} This single argument is a Object object of parameters containing the name/value pairs listed below.

params_o

jsParent_ref(String) Reference to JavaScript parent of instance created by this constructor.  Not currently used.
DOMParent_ref(HTMLDOMElement)(optional) if defined, this panel will be appended to DOMParent
keyActive_className(String) CSS className for active key
keyInactive_className(String) CSS className for inactive key
scalingFactor_int(Int) scaling factor, scales up keyboard geometry definition such as <layout_us101>

Constructors Used

handleSelect

host.kernel.constructors.viewer_keyboard.prototype.handleSelect=function(e)

Handles character set selection.

Parameters

e(Event Object) Select box change event

clear

host.kernel.constructors.viewer_keyboard.prototype.clear=function()

Deletes all buttons from the keyboard

render

host.kernel.constructors.viewer_keyboard.prototype.render=function(charSet_str)

Renders a set of keys into the keyboard

highlight

host.kernel.constructors.viewer_keyboard.prototype.highlight=function(
   keyCode_int,
   character,
   altKey,
   ctrlKey,
   shiftKey
)

Handles key highlighting

Parameters

code_intcharacter code
charactercharacter string
altKeyboolean
ctrlKeyboolean
shiftKeyboolean

keyMap_us101

host.kernel.constructors.viewer_keyboard.prototype.keyMap_us101=function(
   keyCode_int
)

maps key codes to viewer_keyboard_keys

Parameters

keyCode_int(Int) key code from keyboard

Returns

An array of 1 or 2 references to viewer_keyboard_keys

host.kernel.constructors.viewer_keyboard = function(params_o)
Constructs a new embedded Keyboard Object for switching character sets.
host.kernel.constructors.viewer_keyboard.prototype.handleSelect=function(e)
Handles character set selection.
host.kernel.constructors.viewer_keyboard.prototype.clear=function()
Deletes all buttons from the keyboard
host.kernel.constructors.viewer_keyboard.prototype.render=function(charSet_str)
Renders a set of keys into the keyboard
host.kernel.constructors.viewer_keyboard.prototype.highlight=function(
   keyCode_int,
   character,
   altKey,
   ctrlKey,
   shiftKey
)
Handles key highlighting
host.kernel.constructors.viewer_keyboard.prototype.keyMap_us101=function(
   keyCode_int
)
maps key codes to viewer_keyboard_keys