ktvn/com.github.benpollarduk.ktvn.layout/Layout

Layout

open class Layout

Provides a layout for positioning characters.

Types

Companion

object Companion

Properties

characters

val characters: Int

Get the number of characters in this layout.

Functions

add

fun add(character: Character, position: Position)

Add a character to this Layout at a position.

addAbove

infix fun addAbove(character: Character)

Add a character at the above position.

addBelow

infix fun addBelow(character: Character)

Add a character at the below position.

addCenter

infix fun addCenter(character: Character)

Add a character at the center position.

addHidden

infix fun addHidden(character: Character)

Add a character in a hidden position.

addLeft

infix fun addLeft(character: Character)

Add a character at the left position.

addLeftOf

infix fun addLeftOf(character: Character)

Add a character at the left of position.

addRight

infix fun addRight(character: Character)

Add a character at the right position.

addRightOf

infix fun addRightOf(character: Character)

Add a character at the right of position.

clear

fun clear()

Clear this layout.

configure

infix fun configure(adapter: LayoutAdapter)

Specify the adapter.

disappear

infix fun disappear(character: Character)

Make a character disappear.

exitBottom

infix fun exitBottom(character: Character)

Exit a character to the bottom.

exitLeft

infix fun exitLeft(character: Character)

Exit a character to the left.

exitRight

infix fun exitRight(character: Character)

Exit a character to the right.

exitTop

infix fun exitTop(character: Character)

Exit a character to the top.

move

fun move(character: Character, position: Position, transition: LayoutTransition)

Move a character to a position with a specified transition.

moveCenter

infix fun moveCenter(character: Character)

Move a character to the center position.

moveLeft

infix fun moveLeft(character: Character)

Move a character to the left position.

moveRight

infix fun moveRight(character: Character)

Move a character to the right position.

toArrayOfCharacterPosition

fun toArrayOfCharacterPosition(): Array<CharacterPosition>

Get an array of all CharacterPosition in this Layout.

transition

infix fun transition(transition: LayoutTransition)

Specify the transition to apply when moving characters.