mordant/com.github.ajalt.mordant.rendering/Whitespace

Whitespace

enum Whitespace : Enum<Whitespace>

Settings for handling of whitespace and line wrapping.

These values correspond to the values of the CSS white-space property.

See also

Entries

Wrap text and collapse all whitespaces and line breaks

Collapse spaces and line breaks, but don't wrap lines. This will effectively put all text on a single line.

Make no changes to the input text

Like PRE, but will break long lines

Like NORMAL, but preserves any line breaks from the input

Properties

collapseNewlines

val collapseNewlines: Boolean

If true, line breaks in the text will be replaced with spaces.

val collapseSpaces: Boolean

If true, consecutive spaces will be replaced with a single space.

val entries: EnumEntries<Whitespace>

Returns a representation of an immutable list of all enum entries, in the order they're declared.

val name: String

val ordinal: Int

val trimEol: Boolean

If true, whitespace at the end of lines will be removed.

val wrap: Boolean

If true, lines will be broken by replacing spaces with line breaks where necessary to keep lines under the configured width.

Functions

fun valueOf(value: String): Whitespace

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

fun values(): Array<Whitespace>

Returns an array containing the constants of this enum type, in the order they're declared.