Core Module
The KeymanWeb core module is exposed to the developer as window.keyman
.
build
PropertyThe release build of KeymanWeb.
version
PropertyThe version of KeymanWeb.
initialized
PropertyKeymanweb core module initialization state.
activatingUI
FunctionSet an internal flag to notify KeymanWeb of change in UI activation state.
addEventListener
FunctionAdds an event listener for user-handling of keymanweb events.
addHotKey
FunctionAdd hot key handler to array of document-level hotkeys triggered by key-up event.
addKeyboards
FunctionAdds keyboards to keymanweb.
addKeyboardsForLanguage
FunctionAdds default or all keyboards for a given language to keymanweb.
attachToControl
FunctionAttach KeymanWeb to HTML element (or IFrame).
-
BuildVisualKeyboard
Function Create a copy of the OSK for embedding in documentation or help page.
detachFromControl
FunctionDetach KeymanWeb from HTML element (or IFrame).
disableControl
FunctionDisables KeymanWeb input handling for the specified control.
enableControl
FunctionEnables KeymanWeb input handling for the specified control.
focusLastActiveElement
FunctionRestore the focus to the element active before input was moved to KeymanWeb.
getActiveKeyboard
FunctionGet the ID (internal name) of the currently active keyboard.
getActiveLanguage
FunctionGet the language code for the currently selected language.
getKeyboard
FunctionGet keyboard meta data for the selected keyboard and language.
getKeyboardForControl
FunctionObtain the keyboard set for a specific control, if it exists.
getKeyboards
FunctionGet details of currently installed keyboards.
getLastActiveElement
FunctionReturn the last element activated before input was moved to KeymanWeb.
getSavedKeyboard
FunctionGet the (internal) keyboard name and language code of the most recently active keyboard.
getUIState
FunctionGet the KeymanWeb user interface activation state.
init
FunctionSets license key, selects user interface, and other KeymanWeb Options.
isChiral
FunctionTest if a given keyboard recognizes chiral modifier data, such as left-control vs right-control.
isCJK
FunctionTest if a given keyboard or keyboard stub (or the current keyboard) is for Chinese, Japanese, or Korean.
moveToElement
FunctionMove input focus to user specified element.
removeEventListener
FunctionRemoves a user-defined event handler.
removeHotKey
FunctionRemove hotkey handler from document's list of hotkey handlers.
removeKeyboards
FunctionRemoves keyboards (by ID) from KeymanWeb.
resetContext
FunctionRevert OSK to default layer and clear any deadkeys and modifiers
setActiveKeyboard
FunctionChange the currently active keyboard.
setKeyboardForControl
FunctionAssociate control with independent keyboard settings initialized to a specific keyboard.