Home
Guides
  1. REFERENCES
  2. SceneGraph
  3. Standard dialog framework

StandardPinPadDialog

Extends StandardDialog

The StandardPinPadDialog node enables text and voice entry of numeric characters—typically, short numeric PIN codes. It is similar to the legacy PinDialog node, but includes additional voice entry of the numeric digits. This additional functionality is provided through the node's internal DynamicPinPad and VoiceTextEditBox nodes.

roku815px - pin-pad-dialog

Structure

The StandardKeyboardDialog is comprised of the following areas and building block nodes:

  • StdDlgTitleArea.
  • StdDlgContentArea, which may contain the following items:
    • Zero or more StdDlgTextItem nodes.
    • One StdDlgKeyboardItem containing a DynamicPinPad node
  • StdDlgButtonArea, which may contain zero or more StdDlgButton nodes.

Fields

FieldTypeDefaultAccess PermissionDescription
titlestring""READ_WRITEThe title to be displayed at the top of the dialog.
messagearray of strings[ ]READ_WRITEOne or more blocks of text, which are typically used to describe information about the data to be entered. Each string in the array is displayed as a separate block of text with the standard amount of space left between the blocks.

Minimize the message length to avoid having a scrollbar automatically added to the content area. If multiple strings are specified or any string is too long, the dialog may not be able to fit within the height of the display.

buttonsarray of strings[ ]READ_WRITEList of buttons to be displayed in the button area at the bottom of the dialog. Each string in the buttons array adds a new button to the button area.

Minimize the number of buttons in the dialog to ensure that all buttons are visible without the user having to scroll up and down.

textEditBoxVoiceTextEditBox nodeThe keyboard item's VoiceTextEditBox nodeREADThe internal VoiceTextEditBox node used by this dialog's internal keyboard. This field should be used only to access the fields of this internal node

Use the textEditBox.maxTextLength field to limit the length of the pin to be entered.

pinstring""READ_WRITEDisplays the entered PIN number in the text edit box. As the user enters each numeric digit, this field is updated with the currently entered value.

Sample app

You can download and install a sample app that demonstrates how to create a standard PINPad dialog.

Updated 3 months ago