KeyboardProperties Class Reference
Constructors
Instance Methods
- getAutoCompleteList() ⇒
Array.<String> - getAutoCompleteText() ⇒
String - getCustomKeys() ⇒
Array.<String> - getKeyboardLayout() ⇒
KeyboardLayout - getKeypressMode() ⇒
KeypressMode - getLanguage() ⇒
Language - getLimitedCharacterList() ⇒
Array.<String> - getMaskInputCharacters() ⇒
KeyboardInputMask - setAutoCompleteList(list) ⇒
KeyboardProperties - setAutoCompleteText(text) ⇒
KeyboardProperties - setCustomKeys(keys) ⇒
KeyboardProperties - setKeyboardLayout(layout) ⇒
KeyboardProperties - setKeypressMode(mode) ⇒
KeyboardProperties - setLanguage(language) ⇒
KeyboardProperties - setLimitedCharacterList(list) ⇒
KeyboardProperties - setMaskInputCharacters(characters) ⇒
KeyboardProperties
Instance Methods
keyboardProperties.getAutoCompleteList() ⇒ Array.<String>
Get the AutoCompleteList
Kind: Instance method of KeyboardProperties
Returns: Array.<String> - the KEY_AUTO_COMPLETE_LIST value
keyboardProperties.getAutoCompleteText() ⇒ String
Get the AutoCompleteText
Kind: Instance method of KeyboardProperties
Returns: String - the KEY_AUTO_COMPLETE_TEXT value
keyboardProperties.getCustomKeys() ⇒ Array.<String>
Get the CustomKeys
Kind: Instance method of KeyboardProperties
Returns: Array.<String> - the KEY_CUSTOM_KEYS value
keyboardProperties.getKeyboardLayout() ⇒ KeyboardLayout
Get the KeyboardLayout
Kind: Instance method of KeyboardProperties
Returns: KeyboardLayout - the KEY_KEYBOARD_LAYOUT value
keyboardProperties.getKeypressMode() ⇒ KeypressMode
Get the KeypressMode
Kind: Instance method of KeyboardProperties
Returns: KeypressMode - the KEY_KEYPRESS_MODE value
keyboardProperties.getLanguage() ⇒ Language
Get the Language
Kind: Instance method of KeyboardProperties
Returns: Language - the KEY_LANGUAGE value
keyboardProperties.getLimitedCharacterList() ⇒ Array.<String>
Get the LimitedCharacterList
Kind: Instance method of KeyboardProperties
Returns: Array.<String> - the KEY_LIMITED_CHARACTER_LIST value
keyboardProperties.getMaskInputCharacters() ⇒ KeyboardInputMask
Get the MaskInputCharacters
Kind: Instance method of KeyboardProperties
Returns: KeyboardInputMask - the KEY_MASK_INPUT_CHARACTERS value
keyboardProperties.setAutoCompleteList(list) ⇒ KeyboardProperties
Set the AutoCompleteList
Kind: Instance method of KeyboardProperties
Returns: KeyboardProperties - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| list | Array.<String> |
Allows an app to pre-populate the text field with a list of suggested or completed entries as the user types. If empty, the auto-complete list will be removed from the screen. - The desired AutoCompleteList. {'array_min_size': 0, 'array_max_size': 100, 'string_min_length': 1, 'string_max_length': 1000} |
keyboardProperties.setAutoCompleteText(text) ⇒ KeyboardProperties
Set the AutoCompleteText
Kind: Instance method of KeyboardProperties
Returns: KeyboardProperties - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| text | String |
Deprecated, use autoCompleteList instead. - The desired AutoCompleteText. {'string_min_length': 1, 'string_max_length': 1000} |
keyboardProperties.setCustomKeys(keys) ⇒ KeyboardProperties
Set the CustomKeys
Kind: Instance method of KeyboardProperties
Returns: KeyboardProperties - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| keys | Array.<String> |
Array of special characters to show in customizable keys. If omitted, keyboard will show default special characters - The desired CustomKeys. {'array_min_size': 1, 'array_max_size': 10, 'string_min_length': 1, 'string_max_length': 1} |
keyboardProperties.setKeyboardLayout(layout) ⇒ KeyboardProperties
Set the KeyboardLayout
Kind: Instance method of KeyboardProperties
Returns: KeyboardProperties - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| layout | KeyboardLayout |
Desired keyboard layout. - The desired KeyboardLayout. |
keyboardProperties.setKeypressMode(mode) ⇒ KeyboardProperties
Set the KeypressMode
Kind: Instance method of KeyboardProperties
Returns: KeyboardProperties - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| mode | KeypressMode |
Desired keypress mode. If omitted, this value will be set to RESEND_CURRENT_ENTRY. - The desired KeypressMode. |
keyboardProperties.setLanguage(language) ⇒ KeyboardProperties
Set the Language
Kind: Instance method of KeyboardProperties
Returns: KeyboardProperties - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| language | Language |
The keyboard language. - The desired Language. |
keyboardProperties.setLimitedCharacterList(list) ⇒ KeyboardProperties
Set the LimitedCharacterList
Kind: Instance method of KeyboardProperties
Returns: KeyboardProperties - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| list | Array.<String> |
Array of keyboard characters to enable. All omitted characters will be greyed out (disabled) on the keyboard. If omitted, the entire keyboard will be enabled. - The desired LimitedCharacterList. {'array_min_size': 1, 'array_max_size': 100, 'string_min_length': 1, 'string_max_length': 1} |
keyboardProperties.setMaskInputCharacters(characters) ⇒ KeyboardProperties
Set the MaskInputCharacters
Kind: Instance method of KeyboardProperties
Returns: KeyboardProperties - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| characters | KeyboardInputMask |
Allows an app to mask entered characters on HMI - The desired MaskInputCharacters. |