ketraterm-ui-swing/io.github.ketraterm.ui.swing.api/TerminalViewportState

TerminalViewportState

data class TerminalViewportState(val historySize: Int, val scrollbackOffset: Double, val renderOffset: Int, val visibleRows: Int, val requestedRows: Int, val visualScrollOffsetPixels: Double = scrollbackOffset, val visualScrollRangePixels: Int = historySize, val viewportHeightPixels: Int = visibleRows, val contentHeightPixels: Int = requestedRows, val cellHeightPixels: Int = 1)

Host-facing snapshot of the terminal viewport's scrollback position.

The reusable Swing component uses terminal-native scrollback coordinates: 0.0 means the live viewport, and larger values move farther back into scrollback history. Hosts that use top-origin scrollbars can invert this value in their adapter without changing terminal rendering policy.

Constructors

constructor(historySize: Int, scrollbackOffset: Double, renderOffset: Int, visibleRows: Int, requestedRows: Int, visualScrollOffsetPixels: Double = scrollbackOffset, visualScrollRangePixels: Int = historySize, viewportHeightPixels: Int = visibleRows, contentHeightPixels: Int = requestedRows, cellHeightPixels: Int = 1)

Properties

cellHeightPixels

val cellHeightPixels: Int

fixed terminal row height in pixels.

contentHeightPixels

val contentHeightPixels: Int

visual content height for the current render cache in pixels.

historySize

val historySize: Int

number of rows available above the live viewport.

isAtLiveViewport

val isAtLiveViewport: Boolean

Whether the viewport is following live terminal output.

renderOffset

val renderOffset: Int

whole-row offset requested from the render cache. This is the integer overscan anchor for scrollbackOffset.

requestedRows

val requestedRows: Int

number of rows requested from the render cache, including smooth-scroll overscan when required.

scrollbackOffset

val scrollbackOffset: Double

precise visual offset from the live viewport. Fractional values exist only during smooth animation between integer row destinations; completed viewports are row-aligned.

viewportHeightPixels

val viewportHeightPixels: Int

visual viewport height in pixels.

visibleRows

val visibleRows: Int

number of terminal rows that fit in the component.

visualScrollOffsetPixels

val visualScrollOffsetPixels: Double

precise pixel offset from the live bottom.

visualScrollRangePixels

val visualScrollRangePixels: Int

maximum row-native pixel offset from the live bottom.