Skip to end of metadata
Go to start of metadata

Table of Contents


Extends: Group 

Description

The Keyboard node class allows a user to enter a string of alphanumeric characters. The string entered is displayed in a TextEditBox node that is part of the Keyboard node.

The Keyboard node must have the key focus in order to work properly. By default, a Keyboard node toggles between uppercase and lowercase letters when the Options remote key is pressed, to speed the entry of mixed-case strings by the user. It is important not to override this behavior, particularly if a Keyboard node is used as an internal node for a KeyboardDialog node.

The default appearance of a Keyboard node is very transparent, allowing the keyboard to pick up most of its color from what is rendered underneath it. The appearance can be customized by changing the keyboardBitmapUri and other fields.

Fields

FieldTypeDefaultUse
textstring""Contains the string of characters that has been entered
keyColorcolor

0xffffffff

Specifies the color of the key labels and icons when the Keyboard node does not have the focus
focusedKeyColorcolor

0xffffffff

Specifies the color of the key labels and icons when the Keyboard node has the focus
keyboardBitmapUristring

""

Specifies the URI of an image file to be loaded to replace the default keyboard image drawn underneath the key label and icons.

Note that this image must be carefully designed so that the key positions match the default image. Template images for SD, HD and FHD resolutions are provided below.

focusBitmapUristring

""

Specifies the URI of an image file to be loaded to replace the keyboard focus indicator. This should be a 9-patch image so that it can be stretched to the appropriate size for the double width keys.
textEditBoxTextEditBox node

system default

Read-Only
This provides access to the Keyboard node internal TextEditBox node so that its appearance can be modified. You should not set this field, but you can set the fields of the TextEditBox node (such as, myKeyboard.textEditBox.textColor = "0xFF0000FF").

showTextEditBoxboolean

true

Specifies whether or not the Keyboard node internal TextEditBox node is displayed. In most cases, it is desirable to display the TextEditBox node so that the user can see the string as it is entered.

In some cases though, you might want to show only the keyboard part of the Keyboard node. In those cases, the text field of the node will still contain the string entered by the user, so it can displayed in some different manner.

Keyboard Bitmap Templates

  • Use the links below to download the template files.
  • The files have opaque white lines that show the key outlines with the rest of the images fully transparent. Looking at the files in some image viewers that do not support transparency will result in the images looking all white.
  • When creating your own keyboard background artwork, you must maintain the size of the image and the position of the keys in order for it to align properly with the rendered key labels and icons.

SD Keyboard Template

HD Keyboard Template

FHD Keyboard Template

 

  • No labels