ketraterm-ui-swing/io.github.ketraterm.ui.swing.suggestion/SwingShellSuggestion

SwingShellSuggestion

data class SwingShellSuggestion @JvmOverloads constructor(val replacementText: String, val replacementStartOffset: Int, val replacementEndOffset: Int, val source: String, val kind: String, val displayText: String = replacementText, val detail: String = "", val accentRole: SwingShellSuggestionAccentRole = SwingShellSuggestionAccentRole.from(kind, source), val matchedRanges: SwingShellSuggestionMatchRanges = SwingShellSuggestionMatchRanges.EMPTY, val sourceDisplayText: String = source, val interactionContext: Any? = null)

Host-provided shell suggestion shown by the reusable Swing terminal popup.

The Swing layer only presents and selects suggestions. The host/provider owns choosing the replacement text, range, source, and semantic kind; Swing validates that contract before applying the default command-line edit.

Throws

IllegalArgumentException

if text/source/kind fields are invalid, replacement offsets are unordered, or matchedRanges do not address displayText.

Constructors

SwingShellSuggestion

@JvmOverloads

constructor(replacementText: String, replacementStartOffset: Int, replacementEndOffset: Int, source: String, kind: String, displayText: String = replacementText, detail: String = "", accentRole: SwingShellSuggestionAccentRole = SwingShellSuggestionAccentRole.from(kind, source), matchedRanges: SwingShellSuggestionMatchRanges = SwingShellSuggestionMatchRanges.EMPTY, sourceDisplayText: String = source, interactionContext: Any? = null)

Properties

accentRole

val accentRole: SwingShellSuggestionAccentRole

stable visual category supplied by the host or derived from kind for generic providers.

detail

val detail: String

secondary contextual text shown with displayText, such as flags, path context, or a short description.

displayText

val displayText: String

primary text shown in the popup.

interactionContext

val interactionContext: Any?

opaque host-owned request context preserved by Swing and returned unchanged with acceptance or dismissal feedback.

kind

val kind: String

compact semantic candidate kind label supplied by the host.

matchedRanges

val matchedRanges: SwingShellSuggestionMatchRanges

immutable ordered UTF-16 intervals relative to displayText used to visually highlight matching fragments.

replacementEndOffset

val replacementEndOffset: Int

exclusive UTF-16 end offset in the request command text.

replacementStartOffset

val replacementStartOffset: Int

inclusive UTF-16 start offset in the request command text.

replacementText

val replacementText: String

text the provider intends to insert or use for command-line replacement after acceptance.

source

val source: String

stable provider identifier used for feedback and learning, such as history, path, or intellij-git-branch.

sourceDisplayText

val sourceDisplayText: String

compact user-facing source label. This is kept separate from source so renderers never need to infer presentation from a provider identifier.

Functions

commandTextAfterReplacement

fun SwingShellSuggestion.commandTextAfterReplacement(request: SwingShellSuggestionRequest): String?

Returns the command text that would result from accepting this suggestion.

replacementFor

fun SwingShellSuggestion.replacementFor(request: SwingShellSuggestionRequest): SwingShellSuggestionReplacement?

Returns the validated replacement plan for this suggestion and request.