ketraterm-ui-swing-host/io.github.ketraterm.ui.swing.host/SwingClipboardReadPrompt

SwingClipboardReadPrompt

class SwingClipboardReadPrompt(messages: SwingHostMessages, showDialog: (request: SwingDialogRequest, decide: (Int?) -> Unit) -> AutoCloseable) : AutoCloseable

Cancellable read consent owned by one terminal pane. All operations belong to the EDT. The product presents its standard dialog and returns a handle that closes it. No clipboard content is passed to the dialog.

Cancellation, expiry and pane disposal close the dialog. Blocking persists for this pane's lifetime, including later requests admitted with Allow.

Parameters

showDialog

opens product UI, delivers a decision on the EDT, and returns its disposal handle.

messages

host message bundle; choices keep their stable decision indices.

Constructors

SwingClipboardReadPrompt

constructor(messages: SwingHostMessages, showDialog: (request: SwingDialogRequest, decide: (Int?) -> Unit) -> AutoCloseable)

constructor(showDialog: (request: SwingDialogRequest, decide: (Int?) -> Unit) -> AutoCloseable)

Creates a prompt using the JVM display locale and bundled messages.

Types

Decision

enum Decision : Enum<SwingClipboardReadPrompt.Decision>

Choices shared by both products' standard clipboard dialogs.

Properties

isBlocked

val isBlocked: Boolean

Whether this pane has been blocked or closed.

Functions

open override fun close()

Cancels consent when the owning pane is disposed.

dismiss

fun dismiss(): Boolean

Denies a pending request, returning whether terminal Escape was consumed.

request

suspend fun request(message: String): Boolean

Suspends for one decision; concurrent requests cannot replace the current dialog.