com.shakelang.util.colorlib/com.shakelang.util.colorlib.functional/FormattedString

FormattedString

class FormattedString(val contents: List<FormattedStringObject>, isBold: Boolean? = null, isItalic: Boolean? = null, isUnderlined: Boolean? = null, isStrikethrough: Boolean? = null, isInverted: Boolean? = null, val color: Formatting.FGColor? = null, val backgroundColor: Formatting.BGColor? = null) : FormattedStringObject(source)

A formatted String that can be used to format Strings with colors and styles

Since

0.1.1

Parameters

contents

the FormattedStringObjects that are wrapped in this FormattedString

isBold

if the FormattedString is bold

isItalic

if the FormattedString is italic

isUnderlined

if the FormattedString is underlined

isStrikethrough

if the FormattedString is strikethrough

isInverted

if the FormattedString is inverted

color

the Formatting.FGColor of the FormattedString

backgroundColor

the Formatting.BGColor of the FormattedString

Constructors

FormattedString

constructor(contents: FormattedString, strings: List<FormattedStringObject> = contents.contents, isBold: Boolean? = contents.isBold, isItalic: Boolean? = contents.isItalic, isUnderlined: Boolean? = contents.isUnderlined, isStrikethrough: Boolean? = contents.isStrikethrough, isInverted: Boolean? = contents.isInverted, color: Formatting.FGColor? = contents.color, backgroundColor: Formatting.BGColor? = contents.backgroundColor)

constructor(contents: List<FormattedStringObject>, isBold: Boolean? = null, isItalic: Boolean? = null, isUnderlined: Boolean? = null, isStrikethrough: Boolean? = null, isInverted: Boolean? = null, color: Formatting.FGColor? = null, backgroundColor: Formatting.BGColor? = null)

Creates a FormattedString with the given contents, isBold, isItalic, isUnderlined, isStrikethrough, isInverted, color and backgroundColor

Types

object Companion

Properties

backgroundColor

val backgroundColor: Formatting.BGColor? = null

The Formatting.BGColor of the FormattedString

val color: Formatting.FGColor? = null

The Formatting.FGColor of the FormattedString

val contents: List<FormattedStringObject>

The FormattedStringObjects that are wrapped in this FormattedString

open override val formatsItself: Boolean

val isBold: Boolean

If the FormattedString is bold

val isFormatted: Boolean

Is the FormattedString formatted in any way? (Used to determine if the generated String should be formatted and if the Formatting.RESET should be added)

val isInverted: Boolean

If the FormattedString is inverted

val isItalic: Boolean

If the FormattedString is italic

isStrikethrough

val isStrikethrough: Boolean

If the FormattedString is strikethrough

val isUnderlined: Boolean

If the FormattedString is underlined

Functions

backgroundColor

fun backgroundColor(color: Formatting.BGColor): FormattedString

Set the Formatting.BGColor of this FormattedString

fun bg(color: Formatting.BGColor): FormattedString

Set the Formatting.BGColor of this FormattedString

fun bgBlack(): FormattedString

Set the Formatting.BGColor of this FormattedString to Formatting.BGColor.BLACK

fun bgBlue(): FormattedString

Set the Formatting.BGColor of this FormattedString to Formatting.BGColor.BLUE

fun bgBrightBlack(): FormattedString

Set the Formatting.BGColor of this FormattedString to Formatting.BGColor.BRIGHT_BLACK

fun bgBrightBlue(): FormattedString

Set the Formatting.BGColor of this FormattedString to Formatting.BGColor.BRIGHT_BLUE

fun bgBrightCyan(): FormattedString

Set the Formatting.BGColor of this FormattedString to Formatting.BGColor.BRIGHT_CYAN

fun bgBrightGreen(): FormattedString

Set the Formatting.BGColor of this FormattedString to Formatting.BGColor.BRIGHT_GREEN

fun bgBrightPurple(): FormattedString

Set the Formatting.BGColor of this FormattedString to Formatting.BGColor.BRIGHT_PURPLE

fun bgBrightRed(): FormattedString

Set the Formatting.BGColor of this FormattedString to Formatting.BGColor.BRIGHT_RED

fun bgBrightWhite(): FormattedString

Set the Formatting.BGColor of this FormattedString to Formatting.BGColor.WHITE

fun bgBrightYellow(): FormattedString

Set the Formatting.BGColor of this FormattedString to Formatting.BGColor.BRIGHT_YELLOW

fun bgColor(color: Formatting.BGColor): FormattedString

Set the Formatting.BGColor of this FormattedString

fun bgCyan(): FormattedString

Set the Formatting.BGColor of this FormattedString to Formatting.BGColor.CYAN

fun bgGreen(): FormattedString

Set the Formatting.BGColor of this FormattedString to Formatting.BGColor.GREEN

fun bgGrey(): FormattedString

Set the Formatting.BGColor of this FormattedString to Formatting.BGColor.BRIGHT_BLACK

fun bgPurple(): FormattedString

Set the Formatting.BGColor of this FormattedString to Formatting.BGColor.PURPLE

fun bgRed(): FormattedString

Set the Formatting.BGColor of this FormattedString to Formatting.BGColor.RED

fun bgWhite(): FormattedString

Set the Formatting.BGColor of this FormattedString to Formatting.BGColor.WHITE

fun bgYellow(): FormattedString

Set the Formatting.BGColor of this FormattedString to Formatting.BGColor.YELLOW

fun black(): FormattedString

Set the Formatting.FGColor of this FormattedString to Formatting.FGColor.BLACK

fun blue(): FormattedString

Set the Formatting.FGColor of this FormattedString to Formatting.FGColor.BLUE

fun bold(): FormattedString

Make this FormattedString bold

fun brightBlack(): FormattedString

Set the Formatting.FGColor of this FormattedString to Formatting.FGColor.BRIGHT_BLACK

fun brightBlue(): FormattedString

Set the Formatting.FGColor of this FormattedString to Formatting.FGColor.BRIGHT_BLUE

fun brightCyan(): FormattedString

Set the Formatting.FGColor of this FormattedString to Formatting.FGColor.BRIGHT_CYAN

fun brightGreen(): FormattedString

Set the Formatting.FGColor of this FormattedString to Formatting.FGColor.BRIGHT_GREEN

fun brightPurple(): FormattedString

Set the Formatting.FGColor of this FormattedString to Formatting.FGColor.BRIGHT_PURPLE

fun brightRed(): FormattedString

Set the Formatting.FGColor of this FormattedString to Formatting.FGColor.BRIGHT_RED

fun brightWhite(): FormattedString

Set the Formatting.FGColor of this FormattedString to Formatting.FGColor.BRIGHT_WHITE

fun brightYellow(): FormattedString

Set the Formatting.FGColor of this FormattedString to Formatting.FGColor.BRIGHT_YELLOW

fun color(color: Formatting.FGColor): FormattedString

Set the Formatting.FGColor of this FormattedString

fun cyan(): FormattedString

Set the Formatting.FGColor of this FormattedString to Formatting.FGColor.CYAN

open override fun extends(format: FormattedString): FormattedString

Extend this FormattedString with the given format

fun fg(color: Formatting.FGColor): FormattedString

Set the Formatting.BGColor of this FormattedString

fun fgBlack(): FormattedString

Set the Formatting.BGColor of this FormattedString to Formatting.BGColor.BLACK

fun fgBlue(): FormattedString

Set the Formatting.BGColor of this FormattedString to Formatting.BGColor.BLUE

fun fgBrightBlack(): FormattedString

Set the Formatting.BGColor of this FormattedString to Formatting.BGColor.BRIGHT_BLACK

fun fgBrightBlue(): FormattedString

Set the Formatting.BGColor of this FormattedString to Formatting.BGColor.BRIGHT_BLUE

fun fgBrightCyan(): FormattedString

Set the Formatting.BGColor of this FormattedString to Formatting.BGColor.BRIGHT_CYAN

fun fgBrightGreen(): FormattedString

Set the Formatting.BGColor of this FormattedString to Formatting.BGColor.BRIGHT_GREEN

fun fgBrightPurple(): FormattedString

Set the Formatting.BGColor of this FormattedString to Formatting.BGColor.BRIGHT_PURPLE

fun fgBrightRed(): FormattedString

Set the Formatting.BGColor of this FormattedString to Formatting.BGColor.BRIGHT_RED

fun fgBrightWhite(): FormattedString

Set the Formatting.BGColor of this FormattedString to Formatting.BGColor.BRIGHT_WHITE

fun fgBrightYellow(): FormattedString

Set the Formatting.BGColor of this FormattedString to Formatting.BGColor.BRIGHT_YELLOW

fun fgColor(color: Formatting.FGColor): FormattedString

Set the Formatting.BGColor of this FormattedString

fun fgCyan(): FormattedString

Set the Formatting.BGColor of this FormattedString to Formatting.BGColor.CYAN

fun fgGreen(): FormattedString

Set the Formatting.BGColor of this FormattedString to Formatting.BGColor.GREEN

fun fgGrey(): FormattedString

Set the Formatting.BGColor of this FormattedString to Formatting.BGColor.BRIGHT_BLACK

fun fgPurple(): FormattedString

Set the Formatting.BGColor of this FormattedString to Formatting.BGColor.PURPLE

fun fgRed(): FormattedString

Set the Formatting.BGColor of this FormattedString to Formatting.BGColor.RED

fun fgWhite(): FormattedString

Set the Formatting.BGColor of this FormattedString to Formatting.BGColor.WHITE

fun fgYellow(): FormattedString

Set the Formatting.BGColor of this FormattedString to Formatting.BGColor.YELLOW

fun green(): FormattedString

Set the Formatting.FGColor of this FormattedString to Formatting.FGColor.GREEN

fun grey(): FormattedString

Set the Formatting.FGColor of this FormattedString to Formatting.FGColor.BRIGHT_BLACK

fun invert(): FormattedString

Make this FormattedString inverted

fun italic(): FormattedString

Make this FormattedString italic

operator fun plus(other: FormattedStringObject): FormattedString

operator fun plus(other: String): FormattedString

fun purple(): FormattedString

Set the Formatting.FGColor of this FormattedString to Formatting.FGColor.PURPLE

fun red(): FormattedString

Set the Formatting.FGColor of this FormattedString to Formatting.FGColor.RED

fun reset(): FormattedString

Extend this FormattedString with the given format

fun strikethrough(): FormattedString

Make this FormattedString strikethrough

open fun string(): String

Get the String representation of this FormattedStringObject (Basically a shortcut for toString) Not needed to be overridden

open override fun toString(): String

Get the String representation of this FormattedString

fun underline(): FormattedString

Make this FormattedString underlined

fun white(): FormattedString

Set the Formatting.FGColor of this FormattedString to Formatting.FGColor.WHITE

fun yellow(): FormattedString

Set the Formatting.FGColor of this FormattedString to Formatting.FGColor.YELLOW