ktaf/com.github.benpollarduk.ktaf.rendering.frames/GridStringBuilder

GridStringBuilder

class GridStringBuilder(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

GridStringBuilder

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

drawWrapped

fun drawWrapped(value: String, startX: Int, startY: Int, maxWidth: Int): 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.

getCharacter

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

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

resize

fun resize(displaySize: Size)

Resize the display area.

setCell

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

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

toString

open override fun toString(): String