Package org.jline.utils

Class AttributedStyle

java.lang.Object

org.jline.utils.AttributedStyle

public class AttributedStyle
extends Object

Text styling.

Author:

Guillaume Nodet

Field Summary

Fields

Modifier and Type	Field	Description
static final int	BLACK
static final int	BLUE
static final AttributedStyle	BOLD
static final AttributedStyle	BOLD_OFF
static final int	BRIGHT
static final int	CYAN
static final AttributedStyle	DEFAULT
static final int	GREEN
static final AttributedStyle	HIDDEN
static final AttributedStyle	HIDDEN_OFF
static final AttributedStyle	INVERSE
static final AttributedStyle	INVERSE_OFF
static final int	MAGENTA
static final int	RED
static final int	WHITE
static final int	YELLOW

Constructor Summary

Constructors

Constructor	Description
AttributedStyle()
AttributedStyle(long style, long mask)
AttributedStyle(AttributedStyle s)

Method Summary

Modifier and Type	Method	Description
AttributedStyle	background(int color)
AttributedStyle	background(int r, int g, int b)
AttributedStyle	backgroundDefault()
AttributedStyle	backgroundOff()
AttributedStyle	backgroundRgb(int color)
AttributedStyle	blink()
AttributedStyle	blinkDefault()
AttributedStyle	blinkOff()
AttributedStyle	bold()
AttributedStyle	boldDefault()
AttributedStyle	boldOff()
AttributedStyle	conceal()
AttributedStyle	concealDefault()
AttributedStyle	concealOff()
AttributedStyle	crossedOut()
AttributedStyle	crossedOutDefault()
AttributedStyle	crossedOutOff()
boolean	equals(Object o)
AttributedStyle	faint()
AttributedStyle	faintDefault()
AttributedStyle	faintOff()
AttributedStyle	foreground(int color)
AttributedStyle	foreground(int r, int g, int b)
AttributedStyle	foregroundDefault()
AttributedStyle	foregroundOff()
AttributedStyle	foregroundRgb(int color)
long	getMask()
long	getStyle()
int	hashCode()
AttributedStyle	hidden()	The hidden flag can be used to embed custom escape sequences.
AttributedStyle	hiddenDefault()
AttributedStyle	hiddenOff()
AttributedStyle	inverse()
AttributedStyle	inverseDefault()
AttributedStyle	inverseNeg()
AttributedStyle	inverseOff()
AttributedStyle	italic()
AttributedStyle	italicDefault()
AttributedStyle	italicOff()
String	toAnsi()
String	toString()
AttributedStyle	underline()
AttributedStyle	underlineDefault()
AttributedStyle	underlineOff()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

BLACK

public static final int BLACK

See Also:

• Constant Field Values

RED

public static final int RED

See Also:

• Constant Field Values

GREEN

public static final int GREEN

See Also:

• Constant Field Values

YELLOW

public static final int YELLOW

See Also:

• Constant Field Values

BLUE

public static final int BLUE

See Also:

• Constant Field Values

MAGENTA

public static final int MAGENTA

See Also:

• Constant Field Values

CYAN

public static final int CYAN

See Also:

• Constant Field Values

WHITE

public static final int WHITE

See Also:

• Constant Field Values

BRIGHT

public static final int BRIGHT

See Also:

• Constant Field Values

DEFAULT

public static final AttributedStyle DEFAULT

BOLD

public static final AttributedStyle BOLD

BOLD_OFF

public static final AttributedStyle BOLD_OFF

INVERSE

public static final AttributedStyle INVERSE

INVERSE_OFF

public static final AttributedStyle INVERSE_OFF

HIDDEN

public static final AttributedStyle HIDDEN

HIDDEN_OFF

public static final AttributedStyle HIDDEN_OFF

Constructor Details

AttributedStyle

public AttributedStyle()

AttributedStyle

public AttributedStyle(AttributedStyle s)

AttributedStyle

public AttributedStyle(long style,
 long mask)

Method Details

bold

public AttributedStyle bold()

boldOff

public AttributedStyle boldOff()

boldDefault

public AttributedStyle boldDefault()

faint

public AttributedStyle faint()

faintOff

public AttributedStyle faintOff()

faintDefault

public AttributedStyle faintDefault()

italic

public AttributedStyle italic()

italicOff

public AttributedStyle italicOff()

italicDefault

public AttributedStyle italicDefault()

underline

public AttributedStyle underline()

underlineOff

public AttributedStyle underlineOff()

underlineDefault

public AttributedStyle underlineDefault()

blink

public AttributedStyle blink()

blinkOff

public AttributedStyle blinkOff()

blinkDefault

public AttributedStyle blinkDefault()

inverse

public AttributedStyle inverse()

inverseNeg

public AttributedStyle inverseNeg()

inverseOff

public AttributedStyle inverseOff()

inverseDefault

public AttributedStyle inverseDefault()

conceal

public AttributedStyle conceal()

concealOff

public AttributedStyle concealOff()

concealDefault

public AttributedStyle concealDefault()

crossedOut

public AttributedStyle crossedOut()

crossedOutOff

public AttributedStyle crossedOutOff()

crossedOutDefault

public AttributedStyle crossedOutDefault()

foreground

public AttributedStyle foreground(int color)

foreground

public AttributedStyle foreground(int r,
 int g,
 int b)

foregroundRgb

public AttributedStyle foregroundRgb(int color)

foregroundOff

public AttributedStyle foregroundOff()

foregroundDefault

public AttributedStyle foregroundDefault()

background

public AttributedStyle background(int color)

background

public AttributedStyle background(int r,
 int g,
 int b)

backgroundRgb

public AttributedStyle backgroundRgb(int color)

backgroundOff

public AttributedStyle backgroundOff()

backgroundDefault

public AttributedStyle backgroundDefault()

hidden

public AttributedStyle hidden()

The hidden flag can be used to embed custom escape sequences. The characters are considered being 0-column long and will be printed as-is. The user is responsible for ensuring that those sequences do not move the cursor.

Returns:

the new style

hiddenOff

public AttributedStyle hiddenOff()

hiddenDefault

public AttributedStyle hiddenDefault()

getStyle

public long getStyle()

getMask

public long getMask()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toAnsi

public String toAnsi()

toString

public String toString()

Overrides:

toString in class Object