StandardDialog

Base node for standard and custom Roku dialog layouts

Extends Group

The StandardDialog node is the base for Roku's pre-built standard message, keyboard, pinpad, and progress dialogs. It can also be used directly with a custom dialog structure built with the StdDialogItem nodes.

Fields

Field	Type	Default	Access Permission	Description
width	float	0.0f	READ_WRITE	Sets the width of the dialog: If set to 0, the standard system dialog width is used (1038 for FHD, 692 for HD). If the title or any button text is too wide to fit within the standard width, the dialog width will be automatically increased to show the full title or button text up to a preset maximum (1380 for FHD and 920 for HD). If set to greater than 0, the specified width is used as the overall width of the dialog.
height	float	0.0f	READ_WRITE	Sets the height of the dialog. If this field is set to greater than 0, and the layout of the dialog for the specified width results in a dialog with a height less than the value of this field, the dialog layout is increased so that the dialog height matches the value of this field. In this case, the button area is moved to the bottom of the dialog and a blank region exists between the content area and the button area.
buttonSelected	int	0	READ_ONLY	Indicates the index of the selected button when the user selects one of the buttons in the button area.
buttonFocused	int	0	READ_ONLY	Indicates the index of the button that gained focus when the user moved the focus onto one of the buttons in the button area.
palette	RSGPalette node	not set	READ_WRITE	Sets the color palette for the dialog's background, text, buttons, and other elements. By default, no palette is specified; therefore, the dialog inherits the color palette from the nodes higher in the scene graph (typically, from the dialog's Scene node, which has a palette field that can be used to consistently color the standard dialogs and keyboards in the app). The RSGPalette color values used by the StandardDialog node are listed in the RSGPalette color node fields section.
close	boolean	false	WRITE_ONLY	Dismisses the dialog. The dialog is dismissed whenever the close field is set, regardless of whether the field is set to true or false.
wasClosed	event	N/A	READ_ONLY	An event that indicates the dialog was dismissed. This event is triggered when one of the following occurs: The close field is set. The Back, Home, or Options key is pressed. Another dialog is displayed.

RSG Palette Color Node fields

Palette Color Name	Usages
DialogBackgroundColor	Blend color for dialog's background bitmap.
DialogItemColor	Blend color for the following items: StdDlgProgressItem's spinner bitmap StdDlgDeterminateProgressItem's graphic
DialogTextColor	Color for the text in the following items: StdDlgTextItem and StdDlgGraphicItem if the namedTextStyle field is set to "normal" or "bold". All content area items, except for StdDlgTextItem and StdDlgGraphicItem. Title area. Unfocused button.
DialogFocusColor	Blend color for the following: The button area focus bitmap. The focused scrollbar thumb.
DialogFocusItemColor	Color for the text of the focused button.
DialogSecondaryTextColor	Color for the text in the following items: StdDlgTextItem and StdDlgGraphicItem if the namedTextStyle field is set to "secondary". Disabled button.
DialogSecondaryItemColor	Color for the following items: The divider displayed below the title area. The unfilled portion of the StdDlgDeterminateProgressItem's graphic.
DialogInputFieldColor	The blend color for the text edit box background bitmap for keyboards used inside dialogs.
DialogKeyboardColor	The blend color for the keyboard background bitmap for keyboards used inside dialogs
DialogFootprintColor	The blend color for the following items: The button focus footprint bitmap that is displayed when the button area does not have focus. Unfocused scrollbar thumb and scrollbar track.

Updated 2 months ago

Did this page help you?