This browser is not recommended for use with smartdevicelink.com, and may not function properly. Upgrade to a different browser to guarantee support of all features.
To Top
To Bottom
Class KeyboardProperties
Hierarchy
java.lang.Object
com.smartdevicelink.proxy.RPCStruct
- Package
- com.smartdevicelink.proxy.rpc
Overview
This mode causes the interaction to immediately display a keyboard entry through the HMI.Parameter List
| Name | Type | Mandatory | Additional | Description |
|---|---|---|---|---|
| language | Language | false | The keyboard language. | |
| keyboardLayout | KeyboardLayout | false | Desired keyboard layout. | |
| sendDynamicEntry | Boolean | false | In this mode, all key presses will be sent as they occur. If disabled, entire string of text will be returned only once submitted by user.If omitted, this value will be set to FALSE. | |
| keypressMode | KeypressMode | False | Desired keypress mode.If omitted, this value will be set to RESEND_CURRENT_ENTRY. | |
| limitedCharacterList | String | false | Array = true maxLength = 1 minsize = 1 maxsize = 100 | 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. |
| autoCompleteText | String | false | maxlength = 1000 | Allows an app to prepopulate the text field with a suggested or completed entry as the user types. |
| autoCompleteList | String | false | Array = true maxlength = 1000 minsize = 0 maxsize = 100 | Allows an app to prepopulate the text field with a list of suggested or completed entry as the user types. Set to an empty array to remove the auto-complete list from the screen |
| maskInputCharacters | KeyboardInputMask | false | SmartDeviceLink 7.1.0 | Allows an app to mask entered characters on HMI |
| customKeys | List |
false | SmartDeviceLink 7.1.0 | Array of special characters to show in customizable keys. If omitted, keyboard will show default special characters {"string_max_length": 1, "string_min_length": 1, "array_max_size": 10, "array_min_size": 1} |
Quick Jump
- Fields
- Constructors
- Methods
-
- getLanguage()
- setLanguage(Language language)
- getKeyboardLayout()
- setKeyboardLayout(KeyboardLayout keyboardLayout)
- getKeypressMode()
- setKeypressMode(KeypressMode keypressMode)
- getLimitedCharacterList()
- setLimitedCharacterList(java.util.List<java.lang.String> limitedCharacterList)
- getAutoCompleteText() Deprecated
- setAutoCompleteText(String autoCompleteText) Deprecated
- getAutoCompleteList()
- setAutoCompleteList(java.util.List<java.lang.String> autoCompleteList)
- setMaskInputCharacters(KeyboardInputMask maskInputCharacters)
- getMaskInputCharacters()
- setCustomKeys(java.util.List<java.lang.String> customKeys)
- getCustomKeys()
Fields
KEY_KEYPRESS_MODE
public static final java.lang.String KEY_KEYPRESS_MODE
- Constant Value
- "keypressMode"
KEY_KEYBOARD_LAYOUT
public static final java.lang.String KEY_KEYBOARD_LAYOUT
- Constant Value
- "keyboardLayout"
KEY_LIMITED_CHARACTER_LIST
public static final java.lang.String KEY_LIMITED_CHARACTER_LIST
- Constant Value
- "limitedCharacterList"
KEY_AUTO_COMPLETE_TEXT
public static final java.lang.String KEY_AUTO_COMPLETE_TEXT
- Constant Value
- "autoCompleteText"
KEY_AUTO_COMPLETE_LIST
public static final java.lang.String KEY_AUTO_COMPLETE_LIST
- Constant Value
- "autoCompleteList"
KEY_MASK_INPUT_CHARACTERS
public static final java.lang.String KEY_MASK_INPUT_CHARACTERS
- Constant Value
- "maskInputCharacters"
KEY_CUSTOM_KEYS
public static final java.lang.String KEY_CUSTOM_KEYS
- Constant Value
- "customKeys"
KEY_LANGUAGE
public static final java.lang.String KEY_LANGUAGE
- Constant Value
- "language"
Inherited Fields
| From Class | Fields |
|---|---|
| com.smartdevicelink.proxy.RPCStruct | KEY_BULK_DATA, KEY_PROTECTED, store |
Constructors
KeyboardProperties()
public KeyboardProperties()
KeyboardProperties( java.util.Hashtable<java.lang.String, java.lang.Object> hash )
public KeyboardProperties(java.util.Hashtable<java.lang.String, java.lang.Object> hash)
Constructor Parameters
- hash
Methods
getLanguage()
public com.smartdevicelink.proxy.rpc.enums.Language getLanguage()
setLanguage( Language language )
public com.smartdevicelink.proxy.rpc.KeyboardProperties setLanguage(Language language)
Method Parameters
- language
getKeyboardLayout()
public com.smartdevicelink.proxy.rpc.enums.KeyboardLayout getKeyboardLayout()
setKeyboardLayout( KeyboardLayout keyboardLayout )
public com.smartdevicelink.proxy.rpc.KeyboardProperties setKeyboardLayout(KeyboardLayout keyboardLayout)
Method Parameters
- keyboardLayout
getKeypressMode()
public com.smartdevicelink.proxy.rpc.enums.KeypressMode getKeypressMode()
setKeypressMode( KeypressMode keypressMode )
public com.smartdevicelink.proxy.rpc.KeyboardProperties setKeypressMode(KeypressMode keypressMode)
Method Parameters
- keypressMode
getLimitedCharacterList()
public java.util.List getLimitedCharacterList()
setLimitedCharacterList( java.util.List<java.lang.String> limitedCharacterList )
public com.smartdevicelink.proxy.rpc.KeyboardProperties setLimitedCharacterList(java.util.List<java.lang.String> limitedCharacterList)
Method Parameters
- limitedCharacterList
getAutoCompleteText()
Deprecated
Gets the text that allows an app to prepopulate the text field with a suggested entry as the user types
public java.lang.String getAutoCompleteText()
setAutoCompleteText( String autoCompleteText )
Deprecated
Sets the text that allows an app to prepopulate the text field with a suggested entry as the user types
public com.smartdevicelink.proxy.rpc.KeyboardProperties setAutoCompleteText(String autoCompleteText)
Method Parameters
- autoCompleteText
- String representing the suggestions text
getAutoCompleteList()
Gets the list that allows an app to prepopulate the text field with a list of suggested or completed entries as the user types.
public java.util.List getAutoCompleteList()
setAutoCompleteList( java.util.List<java.lang.String> autoCompleteList )
Sets the lists that allows an app to prepopulate the text field with a list of suggested or completed entries as the user types. Set to an empty array to remove the auto-complete list from the screen
public com.smartdevicelink.proxy.rpc.KeyboardProperties setAutoCompleteList(java.util.List<java.lang.String> autoCompleteList)
Method Parameters
- autoCompleteList
- List
representing the suggestions list
setMaskInputCharacters( KeyboardInputMask maskInputCharacters )
Sets the maskInputCharacters.
public com.smartdevicelink.proxy.rpc.KeyboardProperties setMaskInputCharacters(KeyboardInputMask maskInputCharacters)
Method Parameters
- maskInputCharacters
- Allows an app to mask entered characters on HMI SmartDeviceLink 7.1.0
getMaskInputCharacters()
Gets the maskInputCharacters.
public com.smartdevicelink.proxy.rpc.enums.KeyboardInputMask getMaskInputCharacters()
setCustomKeys( java.util.List<java.lang.String> customKeys )
Sets the customKeys.
public com.smartdevicelink.proxy.rpc.KeyboardProperties setCustomKeys(java.util.List<java.lang.String> customKeys)
Method Parameters
- customKeys
- Array of special characters to show in customizable keys. If omitted, keyboard will show default special characters {"string_max_length": 1, "string_min_length": 1, "array_max_size": 10, "array_min_size": 1} SmartDeviceLink 7.1.0
getCustomKeys()
Gets the customKeys.
public java.util.List getCustomKeys()
Inherited Methods
| From Class | Methods |
|---|---|
| com.smartdevicelink.proxy.RPCStruct | getStoreValue, getStore, deserializeJSON, serializeJSON, serializeJSON, format, getBulkData, setBulkData, setPayloadProtected, isPayloadProtected, getMessageTypeName, hasKey, setValue, getValue, getObject, formatObject, getValueForString, getString, getInteger, getDouble, getFloat, getBoolean, getLong, clone, equals, hashCode |
| java.lang.Object | getClass, hashCode, equals, clone, toString, notify, notifyAll, wait, wait, wait, finalize |