Class KeyboardDialogUtil

Utility class for managing standard keyboard dialogs.

Index

Constructors

Properties

callback? dialog scene

Methods

onDialogClose onKeyboardDialogButtonSelected showKeyboardDialog

Constructors

constructor

new KeyboardDialogUtil(): KeyboardDialogUtil
Returns KeyboardDialogUtil

Properties

`Private` `Optional`callback

callback?: KeyboardDialogCallback

The callback to invoke when the dialog is closed or a button is selected.

dialog

dialog: null | ISGNStandardKeyboardDialog = null

The current keyboard dialog instance, or null if none is open.

`Private`scene

scene: any = ...

Reference to the global scene object.

Methods

`Private`onDialogClose

onDialogClose(event: IROSGNodeEvent<number>): void
Handles the dialog close event.
Parameters
- event: IROSGNodeEvent<number>
  The event object.
Returns void
- Defined in hosanna-ui/src/hosanna-ui/lib/keyboard-utils.ts:141

`Private`onKeyboardDialogButtonSelected

onKeyboardDialogButtonSelected(event: IROSGNodeEvent<number>): void
Handles the button selected event in the keyboard dialog.
Parameters
- event: IROSGNodeEvent<number>
  The event object containing the selected button index.
Returns void
- Defined in hosanna-ui/src/hosanna-ui/lib/keyboard-utils.ts:149

showKeyboardDialog

showKeyboardDialog(
    title: string,
    message: string[],
    text: string,
    callback?: KeyboardDialogCallback,
    isSecure?: boolean,
    buttons?: undefined | string[],
    buttonRoles?: ButtonRoleMap,
): null | ISGNStandardKeyboardDialog
Shows a standard keyboard dialog with the specified options.
Parameters
- title: string
  The title of the dialog.
- message: string[]
  The message or instructions to display.
- text: string
  The initial text in the input box.
- Optionalcallback: KeyboardDialogCallback
  Callback to invoke when the dialog is closed or a button is selected.
- isSecure: boolean = false
  If true, enables secure (password) input mode.
- buttons: undefined | string[] = undefined
  Optional array of button labels.
- OptionalbuttonRoles: ButtonRoleMap
  Optional mapping of button labels to their roles.
Returns null | ISGNStandardKeyboardDialog
The created keyboard dialog instance.
- Defined in hosanna-ui/src/hosanna-ui/lib/keyboard-utils.ts:71