Package com.tonic.vellum.style

Class Style

java.lang.Object

com.tonic.vellum.style.Style

public final class Style
extends java.lang.Object

An immutable text styling value; setters return new instances and instances compare by value.

Field Summary

Fields

Modifier and Type	Field	Description
static Style	BOLD	Bold attribute.
static Style	DIM	Dim attribute.
static Style	DIM_REVERSE	Dimmed inverse.
static Style	NORMAL	Default foreground and background with no attributes.
static Style	REVERSE	Inverted foreground and background.
static Style	UNDERLINE	Underline attribute.

Method Summary

Modifier and Type	Method	Description
Color	background()
Style	bg(Color c)	Sets the background color.
Style	bold(boolean b)	Sets the bold attribute.
Style	dim(boolean b)	Sets the dim attribute.
boolean	equals(java.lang.Object o)
Style	fg(Color c)	Sets the foreground color.
Color	foreground()
int	hashCode()
boolean	isBold()
boolean	isDim()
boolean	isReverse()
boolean	isUnderline()
Style	reverse(boolean b)	Sets the reverse attribute.
java.lang.String	toString()
Style	underline(boolean b)	Sets the underline attribute.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

NORMAL

public static final Style NORMAL

Default foreground and background with no attributes.

REVERSE

public static final Style REVERSE

Inverted foreground and background.

DIM_REVERSE

public static final Style DIM_REVERSE

Dimmed inverse.

BOLD

public static final Style BOLD

Bold attribute.

DIM

public static final Style DIM

Dim attribute.

UNDERLINE

public static final Style UNDERLINE

Underline attribute.

Method Detail

foreground

public Color foreground()

Returns:

the foreground color

background

public Color background()

Returns:

the background color

isBold

public boolean isBold()

Returns:

true when the bold attribute is set

isReverse

public boolean isReverse()

Returns:

true when the reverse attribute is set

isDim

public boolean isDim()

Returns:

true when the dim attribute is set

isUnderline

public boolean isUnderline()

Returns:

true when the underline attribute is set

fg

public Style fg(Color c)

Sets the foreground color.

Parameters:

c - the foreground color

Returns:

a new style with the foreground changed

bg

public Style bg(Color c)

Sets the background color.

Parameters:

c - the background color

Returns:

a new style with the background changed

bold

public Style bold(boolean b)

Sets the bold attribute.

Parameters:

b - whether bold is enabled

Returns:

a new style with the bold attribute changed

reverse

public Style reverse(boolean b)

Sets the reverse attribute.

Parameters:

b - whether reverse is enabled

Returns:

a new style with the reverse attribute changed

dim

public Style dim(boolean b)

Sets the dim attribute.

Parameters:

b - whether dim is enabled

Returns:

a new style with the dim attribute changed

underline

public Style underline(boolean b)

Sets the underline attribute.

Parameters:

b - whether underline is enabled

Returns:

a new style with the underline attribute changed

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object