Package org.jline.utils

Class AttributedStyle

java.lang.Object

org.jline.utils.AttributedStyle

public class AttributedStyle
extends java.lang.Object

Text styling.

Field Summary

Fields

Modifier and Type	Field	Description
(package private) static long	BG_COLOR
(package private) static int	BG_COLOR_EXP
static int	BLACK
static int	BLUE
static AttributedStyle	BOLD
static AttributedStyle	BOLD_OFF
static int	BRIGHT
static int	CYAN
static AttributedStyle	DEFAULT
(package private) static long	F_BACKGROUND
(package private) static long	F_BACKGROUND_IND
(package private) static long	F_BACKGROUND_RGB
(package private) static long	F_BLINK
(package private) static long	F_BOLD
(package private) static long	F_CONCEAL
(package private) static long	F_CROSSED_OUT
(package private) static long	F_FAINT
(package private) static long	F_FOREGROUND
(package private) static long	F_FOREGROUND_IND
(package private) static long	F_FOREGROUND_RGB
(package private) static long	F_HIDDEN
(package private) static long	F_INVERSE
(package private) static long	F_ITALIC
(package private) static long	F_UNDERLINE
(package private) static long	FG_COLOR
(package private) static int	FG_COLOR_EXP
static int	GREEN
static AttributedStyle	HIDDEN
static AttributedStyle	HIDDEN_OFF
static AttributedStyle	INVERSE
static AttributedStyle	INVERSE_OFF
static int	MAGENTA
(package private) long	mask
(package private) static long	MASK
static int	RED
(package private) long	style
static int	WHITE
static 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(java.lang.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()
java.lang.String	toAnsi()
java.lang.String	toString()
AttributedStyle	underline()
AttributedStyle	underlineDefault()
AttributedStyle	underlineOff()

Methods inherited from class java.lang.Object

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

Field Detail

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

F_BOLD

static final long F_BOLD

See Also:

Constant Field Values

F_FAINT

static final long F_FAINT

See Also:

Constant Field Values

F_ITALIC

static final long F_ITALIC

See Also:

Constant Field Values

F_UNDERLINE

static final long F_UNDERLINE

See Also:

Constant Field Values

F_BLINK

static final long F_BLINK

See Also:

Constant Field Values

F_INVERSE

static final long F_INVERSE

See Also:

Constant Field Values

F_CONCEAL

static final long F_CONCEAL

See Also:

Constant Field Values

F_CROSSED_OUT

static final long F_CROSSED_OUT

See Also:

Constant Field Values

F_FOREGROUND_IND

static final long F_FOREGROUND_IND

See Also:

Constant Field Values

F_FOREGROUND_RGB

static final long F_FOREGROUND_RGB

See Also:

Constant Field Values

F_FOREGROUND

static final long F_FOREGROUND

See Also:

Constant Field Values

F_BACKGROUND_IND

static final long F_BACKGROUND_IND

See Also:

Constant Field Values

F_BACKGROUND_RGB

static final long F_BACKGROUND_RGB

See Also:

Constant Field Values

F_BACKGROUND

static final long F_BACKGROUND

See Also:

Constant Field Values

F_HIDDEN

static final long F_HIDDEN

See Also:

Constant Field Values

MASK

static final long MASK

See Also:

Constant Field Values

FG_COLOR_EXP

static final int FG_COLOR_EXP

See Also:

Constant Field Values

BG_COLOR_EXP

static final int BG_COLOR_EXP

See Also:

Constant Field Values

FG_COLOR

static final long FG_COLOR

See Also:

Constant Field Values

BG_COLOR

static final long BG_COLOR

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

style

final long style

mask

final long mask

Constructor Detail

AttributedStyle

public AttributedStyle()

AttributedStyle

public AttributedStyle(AttributedStyle s)

AttributedStyle

public AttributedStyle(long style,
                       long mask)

Method Detail

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(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toAnsi

public java.lang.String toAnsi()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object