ktaf/com.github.benpollarduk.ktaf.rendering.frames.ansi/AnsiGridStringBuilder

AnsiGridStringBuilder

class AnsiGridStringBuilder(var leftBoundary: Char = '|', var rightBoundary: Char = '|', var horizontalDivider: Char = '-', var lineTerminator: String = NEWLINE)

Provides a class for building strings as part of a grid.

Constructors

constructor(leftBoundary: Char = '|', rightBoundary: Char = '|', horizontalDivider: Char = '-', lineTerminator: String = NEWLINE)

Properties

displaySize

var displaySize: Size

Get the size of the display area.

horizontalDivider

var horizontalDivider: Char

leftBoundary

var leftBoundary: Char

lineTerminator

var lineTerminator: String

rightBoundary

var rightBoundary: Char

Functions

drawBoundary

fun drawBoundary(color: AnsiColor)

Draw a boundary with a specified color.

drawCentralisedWrapped

fun drawCentralisedWrapped(value: String, startY: Int, maxWidth: Int, color: AnsiColor): FramePosition

Draw a centralised wrapped string at a specified startY position with a maxWidth. The end position will be returned.

drawHorizontalDivider

fun drawHorizontalDivider(y: Int, color: AnsiColor)

Draw a horizontal divider at a specified y position in a specified color.

drawUnderline

fun drawUnderline(x: Int, y: Int, length: Int, color: AnsiColor)

Draw an underline at a specified x and y location for a specified length in a specified color.

drawWrapped

fun drawWrapped(value: String, startX: Int, startY: Int, maxWidth: Int, color: AnsiColor): FramePosition

Draw a wrapped string at a specified startX and startY position with a maxWidth. The end position will be returned.

flush

fun flush()

Flush the buffer.

getCellColor

fun getCellColor(x: Int, y: Int): AnsiColor

Get a cell AnsiColor at a specified x and y location.

getCharacter

fun getCharacter(x: Int, y: Int): Char

Get a character from the buffer at a specified x and y location.

getNumberOfLines

fun getNumberOfLines(value: String, startY: Int, maxWidth: Int): Int

Get the number of lines that a string will take up in a given area.

resize

fun resize(displaySize: Size)

Resize the display area.

setCell

fun setCell(x: Int, y: Int, character: Char, color: AnsiColor)

Set the cell at a specified x and y position to a specified character and color.

toString

open override fun toString(): String