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

SwingTerminal

class SwingTerminal @JvmOverloads constructor(settingsProvider: SwingSettingsProvider = SwingSettingsProvider { SwingSettings() }, hostServices: SwingHostServices = SwingHostServices()) : JComponent, SwingScrollbarScroller

Reusable Swing terminal component.

The component consumes published render-cache snapshots from a TerminalSession and paints terminal rows without knowing which transport produced the bytes. Hosts own session creation, process lifecycle, and connector choice outside this component.

Parameters

settingsProvider

provider for immutable settings snapshots.

hostServices

host-provided non-render services.

Constructors

constructor(settingsProvider: SwingSettingsProvider = SwingSettingsProvider { SwingSettings() }, hostServices: SwingHostServices = SwingHostServices())

Properties

accessibleContext

open val accessibleContext: AccessibleContext?

var actionMap: ActionMap?

@set:BeanProperty(description = "The preferred horizontal alignment of the component.")

open var alignmentX: Float

@set:BeanProperty(description = "The preferred vertical alignment of the component.")

open var alignmentY: Float

ancestorListeners

@get:BeanProperty(bound = false)

open val ancestorListeners: Array<out AncestorListener?>?

@set:BeanProperty(bound = false, expert = true, description = "Determines if this component automatically scrolls its contents when dragged.")

open var autoscrolls: Boolean

@set:BeanProperty(preferred = true, visualUpdate = true, description = "The background color of the component.")

open var background: Color?

baselineResizeBehavior

@get:BeanProperty(bound = false)

open val baselineResizeBehavior: Component.BaselineResizeBehavior?

@set:BeanProperty(preferred = true, visualUpdate = true, description = "The component's border.")

open var border: Border?

open var bounds: Rectangle?

open val colorModel: ColorModel?

open val componentCount: Int

componentListeners

open val componentListeners: Array<out ComponentListener?>?

componentOrientation

open var componentOrientation: ComponentOrientation?

componentPopupMenu

@set:BeanProperty(preferred = true, description = "Popup to show")

open var componentPopupMenu: JPopupMenu?

open val components: Array<out Component?>?

containerListeners

open val containerListeners: Array<out ContainerListener?>?

open var cursor: Cursor?

debugGraphicsOptions

@set:BeanProperty(bound = false, preferred = true, enumerationValues = ["DebugGraphics.NONE_OPTION", "DebugGraphics.LOG_OPTION", "DebugGraphics.FLASH_OPTION", "DebugGraphics.BUFFERED_OPTION"], description = "Diagnostic options for graphics operations.")

open var debugGraphicsOptions: Int

open var dropTarget: DropTarget?

focusCycleRootAncestor

open val focusCycleRootAncestor: Container?

open val focusListeners: Array<out FocusListener?>?

focusTraversalKeysEnabled

open var focusTraversalKeysEnabled: Boolean

focusTraversalPolicy

open var focusTraversalPolicy: FocusTraversalPolicy?

@set:BeanProperty(preferred = true, visualUpdate = true, description = "The font for the component.")

open var font: Font?

@set:BeanProperty(preferred = true, visualUpdate = true, description = "The foreground color of the component.")

open var foreground: Color?

@get:BeanProperty(bound = false)

open val graphics: Graphics?

graphicsConfiguration

open var graphicsConfiguration: GraphicsConfiguration?

@get:BeanProperty(bound = false)

open val height: Int

hierarchyBoundsListeners

open val hierarchyBoundsListeners: Array<out HierarchyBoundsListener?>?

hierarchyListeners

open val hierarchyListeners: Array<out HierarchyListener?>?

open var ignoreRepaint: Boolean

inheritsPopupMenu

@set:BeanProperty(description = "Whether or not the JPopupMenu is inherited")

open var inheritsPopupMenu: Boolean

open val inputContext: InputContext?

val inputMap: InputMap?

inputMethodListeners

open val inputMethodListeners: Array<out InputMethodListener?>?

inputMethodRequests

open val inputMethodRequests: InputMethodRequests?

@set:BeanProperty(description = "The component's input verifier.")

open var inputVerifier: InputVerifier?

@get:BeanProperty(expert = true)

open val insets: Insets?

isBackgroundSet

open val isBackgroundSet: Boolean

open val isCursorSet: Boolean

open val isDisplayable: Boolean

isDoubleBuffered

open var isDoubleBuffered: Boolean

@set:BeanProperty(expert = true, preferred = true, visualUpdate = true, description = "The enabled state of the component.")

open var isEnabled: Boolean

open var isFocusable: Boolean

isFocusCycleRoot

open var isFocusCycleRoot: Boolean

open val isFocusOwner: Boolean

isFocusTraversable

open val isFocusTraversable: Boolean

isFocusTraversalPolicyProvider

var isFocusTraversalPolicyProvider: Boolean

isFocusTraversalPolicySet

open val isFocusTraversalPolicySet: Boolean

open val isFontSet: Boolean

isForegroundSet

open val isForegroundSet: Boolean

open val isLightweight: Boolean

isManagingFocus

@get:BeanProperty(bound = false)

open val isManagingFocus: Boolean

isMaximumSizeSet

open val isMaximumSizeSet: Boolean

isMinimumSizeSet

open val isMinimumSizeSet: Boolean

@set:BeanProperty(expert = true, description = "The component's opacity")

open var isOpaque: Boolean

isOptimizedDrawingEnabled

@get:BeanProperty(bound = false)

open val isOptimizedDrawingEnabled: Boolean

isPaintingForPrint

@get:BeanProperty(bound = false)

val isPaintingForPrint: Boolean

@get:BeanProperty(bound = false)

open val isPaintingTile: Boolean

isPreferredSizeSet

open val isPreferredSizeSet: Boolean

isRequestFocusEnabled

open var isRequestFocusEnabled: Boolean

open val isShowing: Boolean

open val isValid: Boolean

open val isValidateRoot: Boolean

@set:BeanProperty(hidden = true, visualUpdate = true)

open var isVisible: Boolean

open val keyListeners: Array<out KeyListener?>?

open var layout: LayoutManager?

open var locale: Locale?

open var location: Point?

locationOnScreen

open val locationOnScreen: Point?

@set:BeanProperty(description = "The maximum size of the component.")

open var maximumSize: Dimension?

@set:BeanProperty(description = "The minimum size of the component.")

open var minimumSize: Dimension?

open val mouseListeners: Array<out MouseListener?>?

mouseMotionListeners

open val mouseMotionListeners: Array<out MouseMotionListener?>?

open val mousePosition: Point?

mouseWheelListeners

open val mouseWheelListeners: Array<out MouseWheelListener?>?

open var name: String?

nextFocusableComponent

open var nextFocusableComponent: Component?

open val parent: Container?

@set:BeanProperty(preferred = true, description = "The preferred size of the component.")

open var preferredSize: Dimension?

propertyChangeListeners

open val propertyChangeListeners: Array<out PropertyChangeListener?>?

registeredKeyStrokes

@get:BeanProperty(bound = false)

open val registeredKeyStrokes: Array<out KeyStroke?>?

@get:BeanProperty(bound = false)

open val rootPane: JRootPane?

open var size: Dimension?

open val toolkit: Toolkit?

@set:BeanProperty(bound = false, preferred = true, description = "The text to display in a tool tip.")

open var toolTipText: String?

topLevelAncestor

@get:BeanProperty(bound = false)

open val topLevelAncestor: Container?

transferHandler

@set:BeanProperty(hidden = true, description = "Mechanism for transfer of data to and from the component")

open var transferHandler: TransferHandler?

val treeLock: Any?

open var ui: ComponentUI?

@get:BeanProperty(bound = false, expert = true, description = "UIClassID")

open val uiClassID: String?

verifyInputWhenFocusTarget

@set:BeanProperty(description = "Whether the Component verifies input before accepting focus.")

open var verifyInputWhenFocusTarget: Boolean

vetoableChangeListeners

@get:BeanProperty(bound = false)

open val vetoableChangeListeners: Array<out VetoableChangeListener?>?

@get:BeanProperty(bound = false)

open val visibleRect: Rectangle?

@get:BeanProperty(bound = false)

open val width: Int

@get:BeanProperty(bound = false)

open val x: Int

@get:BeanProperty(bound = false)

open val y: Int

Functions

open fun ~~action~~(evt: Event?, what: Any?): Boolean

open fun add(popup: PopupMenu?)

open fun add(comp: Component?): Component?

open fun add(comp: Component?, constraints: Any?)

open fun add(comp: Component?, index: Int): Component?

open fun add(name: String?, comp: Component?): Component?

open fun add(comp: Component?, constraints: Any?, index: Int)

addAncestorListener

open fun addAncestorListener(listener: AncestorListener?)

addComponentListener

open fun addComponentListener(l: ComponentListener?)

addContainerListener

open fun addContainerListener(l: ContainerListener?)

addFocusListener

open fun addFocusListener(l: FocusListener?)

addHierarchyBoundsListener

open fun addHierarchyBoundsListener(l: HierarchyBoundsListener?)

addHierarchyListener

open fun addHierarchyListener(l: HierarchyListener?)

addInputMethodListener

open fun addInputMethodListener(l: InputMethodListener?)

open fun addKeyListener(l: KeyListener?)

addMouseListener

open fun addMouseListener(l: MouseListener?)

addMouseMotionListener

open fun addMouseMotionListener(l: MouseMotionListener?)

addMouseWheelListener

open fun addMouseWheelListener(l: MouseWheelListener?)

open override fun addNotify()

addPropertyChangeListener

open fun addPropertyChangeListener(listener: PropertyChangeListener?)

open fun addPropertyChangeListener(propertyName: String?, listener: PropertyChangeListener?)

addVetoableChangeListener

open fun addVetoableChangeListener(listener: VetoableChangeListener?)

applyComponentOrientation

open fun applyComponentOrientation(o: ComponentOrientation?)

areFocusTraversalKeysSet

open fun areFocusTraversalKeysSet(id: Int): Boolean

fun bind(session: TerminalSession)

Binds this component to session.

open fun ~~bounds~~(): Rectangle?

open fun checkImage(image: Image?, observer: ImageObserver?): Int

open fun checkImage(image: Image?, width: Int, height: Int, observer: ImageObserver?): Int

commandOutputText

fun commandOutputText(recordId: Int): String?

Returns all currently retained output for recordId.

commandRecordAt

fun commandRecordAt(x: Int, y: Int): Int

Returns the command record at component coordinates x, y.

computeVisibleRect

open fun computeVisibleRect(visibleRect: Rectangle?)

open operator fun contains(p: Point?): Boolean

open fun contains(x: Int, y: Int): Boolean

copyCommandOutputToClipboard

fun copyCommandOutputToClipboard(recordId: Int): Boolean

Copies all retained output for recordId through the host clipboard service.

copyCommandTextToClipboard

fun copyCommandTextToClipboard(recordId: Int): Boolean

Copies captured command text for recordId through the host clipboard service.

copySelectionToClipboard

fun copySelectionToClipboard(): Boolean

Copies the current terminal text selection to the host clipboard.

copyTextToClipboard

fun copyTextToClipboard(text: String): Boolean

Writes host-approved text to the configured clipboard service.

countComponents

open fun ~~countComponents~~(): Int

open fun createImage(producer: ImageProducer?): Image?

open fun createImage(width: Int, height: Int): Image?

open fun createToolTip(): JToolTip?

createVolatileImage

open fun createVolatileImage(width: Int, height: Int): VolatileImage?

open fun createVolatileImage(width: Int, height: Int, caps: ImageCapabilities?): VolatileImage?

currentSearchState

fun currentSearchState(): TerminalSearchState

Returns the current search UI and result snapshot.

currentSelection

fun currentSelection(): CellSelection?

Returns the current visible cell selection, or null when nothing is selected.

currentShellSuggestionState

fun currentShellSuggestionState(): SwingShellSuggestionState

Returns the current shell suggestion popup state.

open fun ~~deliverEvent~~(e: Event?)

open fun ~~disable~~()

fun dispatchEvent(e: AWTEvent?)

open override fun doLayout()

open fun ~~enable~~()

open fun ~~enable~~(b: Boolean)

enableInputMethods

open fun enableInputMethods(enable: Boolean)

findComponentAt

open fun findComponentAt(p: Point?): Component?

open fun findComponentAt(x: Int, y: Int): Component?

firePropertyChange

open fun firePropertyChange(propertyName: String?, oldValue: Boolean, newValue: Boolean)

open fun firePropertyChange(propertyName: String?, oldValue: Byte, newValue: Byte)

open fun firePropertyChange(propertyName: String?, oldValue: Char, newValue: Char)

open fun firePropertyChange(propertyName: String?, oldValue: Double, newValue: Double)

open fun firePropertyChange(propertyName: String?, oldValue: Float, newValue: Float)

open fun firePropertyChange(propertyName: String?, oldValue: Int, newValue: Int)

open fun firePropertyChange(propertyName: String?, oldValue: Long, newValue: Long)

open fun firePropertyChange(propertyName: String?, oldValue: Short, newValue: Short)

getActionForKeyStroke

open fun getActionForKeyStroke(aKeyStroke: KeyStroke?): ActionListener?

open fun getBaseline(width: Int, height: Int): Int

open fun getBounds(rv: Rectangle?): Rectangle?

getClientProperty

fun getClientProperty(key: Any?): Any?

open fun getComponent(n: Int): Component?

open fun getComponentAt(p: Point?): Component?

open fun getComponentAt(x: Int, y: Int): Component?

getComponentZOrder

open fun getComponentZOrder(comp: Component?): Int

getConditionForKeyStroke

open fun getConditionForKeyStroke(aKeyStroke: KeyStroke?): Int

getFocusTraversalKeys

open fun getFocusTraversalKeys(id: Int): Set<AWTKeyStroke?>?

open fun getFontMetrics(font: Font?): FontMetrics?

open fun <T : EventListener?> getListeners(listenerType: Class<T?>?): Array<out T?>?

open fun getLocation(rv: Point?): Point?

getMousePosition

open fun getMousePosition(allowChildren: Boolean): Point?

getPopupLocation

open fun getPopupLocation(event: MouseEvent?): Point?

open fun getSize(rv: Dimension?): Dimension?

getToolTipLocation

open fun getToolTipLocation(event: MouseEvent?): Point?

open fun ~~gotFocus~~(evt: Event?, what: Any?): Boolean

open fun grabFocus()

open fun ~~handleEvent~~(evt: Event?): Boolean

open fun hasFocus(): Boolean

open fun ~~hide~~()

hideShellSuggestions

fun hideShellSuggestions()

Hides the shell suggestion popup.

open fun imageUpdate(img: Image?, infoflags: Int, x: Int, y: Int, w: Int, h: Int): Boolean

open fun ~~insets~~(): Insets?

open fun ~~inside~~(x: Int, y: Int): Boolean

open fun invalidate()

open fun isAncestorOf(c: Component?): Boolean

open fun ~~keyDown~~(evt: Event?, key: Int): Boolean

open fun ~~keyUp~~(evt: Event?, key: Int): Boolean

open fun ~~layout~~()

open fun list()

open fun list(out: PrintStream?)

open fun list(out: PrintWriter?)

open fun list(out: PrintStream?, indent: Int)

open fun list(out: PrintWriter?, indent: Int)

open fun ~~locate~~(x: Int, y: Int): Component?

open fun ~~location~~(): Point?

open fun ~~lostFocus~~(evt: Event?, what: Any?): Boolean

open fun ~~minimumSize~~(): Dimension?

open fun ~~mouseDown~~(evt: Event?, x: Int, y: Int): Boolean

open fun ~~mouseDrag~~(evt: Event?, x: Int, y: Int): Boolean

open fun ~~mouseEnter~~(evt: Event?, x: Int, y: Int): Boolean

open fun ~~mouseExit~~(evt: Event?, x: Int, y: Int): Boolean

open fun ~~mouseMove~~(evt: Event?, x: Int, y: Int): Boolean

open fun ~~mouseUp~~(evt: Event?, x: Int, y: Int): Boolean

open fun ~~move~~(x: Int, y: Int)

open fun ~~nextFocus~~()

open fun paint(g: Graphics?)

open fun paintAll(g: Graphics?)

paintComponents

open fun paintComponents(g: Graphics?)

paintImmediately

open fun paintImmediately(r: Rectangle?)

open fun paintImmediately(x: Int, y: Int, w: Int, h: Int)

pasteClipboardText

fun pasteClipboardText(): Boolean

Pastes text from the host clipboard into the active terminal session.

open fun ~~postEvent~~(e: Event?): Boolean

preferredGridSize

fun preferredGridSize(columns: Int, rows: Int): Dimension

open fun ~~preferredSize~~(): Dimension?

open fun prepareImage(image: Image?, observer: ImageObserver?): Boolean

open fun prepareImage(image: Image?, width: Int, height: Int, observer: ImageObserver?): Boolean

open fun print(g: Graphics?)

open fun printAll(g: Graphics?)

printComponents

open fun printComponents(g: Graphics?)

putClientProperty

fun putClientProperty(key: Any?, value: Any?)

registerKeyboardAction

open fun registerKeyboardAction(anAction: ActionListener?, aKeyStroke: KeyStroke?, aCondition: Int)

open fun registerKeyboardAction(anAction: ActionListener?, aCommand: String?, aKeyStroke: KeyStroke?, aCondition: Int)

fun reloadSettings()

Rebuilds settings, metrics, preferred size, and repaint state.

open fun remove(comp: Component?)

open fun remove(index: Int)

open fun remove(popup: MenuComponent?)

open fun removeAll()

removeAncestorListener

open fun removeAncestorListener(listener: AncestorListener?)

removeComponentListener

open fun removeComponentListener(l: ComponentListener?)

removeContainerListener

open fun removeContainerListener(l: ContainerListener?)

removeFocusListener

open fun removeFocusListener(l: FocusListener?)

removeHierarchyBoundsListener

open fun removeHierarchyBoundsListener(l: HierarchyBoundsListener?)

removeHierarchyListener

open fun removeHierarchyListener(l: HierarchyListener?)

removeInputMethodListener

open fun removeInputMethodListener(l: InputMethodListener?)

removeKeyListener

open fun removeKeyListener(l: KeyListener?)

removeMouseListener

open fun removeMouseListener(l: MouseListener?)

removeMouseMotionListener

open fun removeMouseMotionListener(l: MouseMotionListener?)

removeMouseWheelListener

open fun removeMouseWheelListener(l: MouseWheelListener?)

open override fun removeNotify()

removePropertyChangeListener

open fun removePropertyChangeListener(listener: PropertyChangeListener?)

open fun removePropertyChangeListener(propertyName: String?, listener: PropertyChangeListener?)

removeVetoableChangeListener

open fun removeVetoableChangeListener(listener: VetoableChangeListener?)

open fun repaint()

open fun repaint(tm: Long)

open fun repaint(x: Int, y: Int, width: Int, height: Int)

open fun repaint(tm: Long, x: Int, y: Int, width: Int, height: Int)

open fun repaint(r: Rectangle?)

requestDefaultFocus

open fun ~~requestDefaultFocus~~(): Boolean

open fun requestFocus()

open fun requestFocus(cause: FocusEvent.Cause?)

open fun requestFocus(temporary: Boolean): Boolean

requestFocusInWindow

open fun requestFocusInWindow(): Boolean

open fun requestFocusInWindow(cause: FocusEvent.Cause?): Boolean

requestShellSuggestions

fun requestShellSuggestions(commandText: String, cursorOffset: Int, anchorColumn: Int, anchorRow: Int)

Requests shell suggestions from SwingHostServices.shellSuggestionProvider and shows the returned snapshot near a terminal-grid cell.

resetKeyboardActions

open fun resetKeyboardActions()

open fun ~~reshape~~(x: Int, y: Int, w: Int, h: Int)

open fun ~~resize~~(d: Dimension?)

open fun ~~resize~~(width: Int, height: Int)

open fun revalidate()

scrollFromScrollbar

open override fun scrollFromScrollbar(scrollbackOffset: Int, valueIsAdjusting: Boolean)

Moves the viewport to scrollbackOffset terminal rows above live output.

scrollRectToVisible

open fun scrollRectToVisible(aRect: Rectangle?)

scrollToLiveViewport

fun scrollToLiveViewport()

Returns to the live terminal viewport.

scrollToNextCommand

fun scrollToNextCommand()

Scrolls to the nearest next shell command.

scrollToPreviousCommand

fun scrollToPreviousCommand()

Scrolls to the nearest previous shell command.

scrollToScrollbackOffset

fun scrollToScrollbackOffset(scrollbackOffset: Int)

Scrolls to an absolute scrollback offset.

scrollViewportBy

fun scrollViewportBy(deltaLines: Double)

Applies a signed scrollback delta in terminal rows.

fun search(query: String)

Applies a literal terminal-buffer search query.

selectCommandOutput

fun selectCommandOutput(recordId: Int): Boolean

Selects command output for recordId.

selectCommandOutputAt

fun selectCommandOutputAt(x: Int, y: Int): Boolean

Selects command output for the command under component coordinates x, y.

setComponentZOrder

open fun setComponentZOrder(comp: Component?, index: Int)

setFocusTraversalKeys

open fun setFocusTraversalKeys(id: Int, keystrokes: Set<out AWTKeyStroke?>?)

fun setInputMap(condition: Int, map: InputMap?)

setMixingCutoutShape

open fun setMixingCutoutShape(shape: Shape?)

open fun ~~show~~()

open fun ~~show~~(b: Boolean)

showShellSuggestions

fun showShellSuggestions(suggestions: List<SwingShellSuggestion>, anchorColumn: Int, anchorRow: Int, selectedIndex: Int = 0)

Shows host-provided shell suggestions near a terminal-grid cell.

fun showVisualBell()

Triggers this component's visual bell indicator.

open fun ~~size~~(): Dimension?

open fun transferFocus()

transferFocusBackward

open fun transferFocusBackward()

transferFocusDownCycle

open fun transferFocusDownCycle()

transferFocusUpCycle

open fun transferFocusUpCycle()

fun unbind()

Removes the current session binding.

unregisterKeyboardAction

open fun unregisterKeyboardAction(aKeyStroke: KeyStroke?)

open fun update(g: Graphics?)

open fun updateUI()

open fun validate()

fun viewportState(): TerminalViewportState

Returns the latest terminal-native scrollback viewport snapshot.

visibleGridSize

fun visibleGridSize(): Dimension

Returns the grid size that fits in this component's current bounds.