Module com.googlecode.lanterna

Package com.googlecode.lanterna.graphics

Class TextGraphicsWriter

java.lang.Object

com.googlecode.lanterna.graphics.TextGraphicsWriter

All Implemented Interfaces:

StyleSet<TextGraphicsWriter>

public class TextGraphicsWriter
extends Object
implements StyleSet<TextGraphicsWriter>

Nested Class Summary

Nested classes/interfaces inherited from interface com.googlecode.lanterna.graphics.StyleSet

StyleSet.Set

Constructor Summary

Constructors

Constructor	Description
TextGraphicsWriter(TextGraphics backend)

Method Summary

Modifier and Type	Method	Description
TextGraphicsWriter	clearModifiers()	Removes all active modifiers
TextGraphicsWriter	disableModifiers(SGR... modifiers)	Removes zero or more modifiers from the set of currently active modifiers
TextGraphicsWriter	enableModifiers(SGR... modifiers)	Adds zero or more modifiers to the set of currently active modifiers
EnumSet<SGR>	getActiveModifiers()	Returns all the SGR codes that are currently active
TextColor	getBackgroundColor()	Returns the current background color
TerminalPosition	getCursorPosition()
TextColor	getForegroundColor()	Returns the current foreground color
WrapBehaviour	getWrapBehaviour()
boolean	isStyleable()
void	putControlChar(char ch)
TextGraphicsWriter	putString(String string)
TextGraphicsWriter	setBackgroundColor(TextColor background)	Updates the current background color
void	setCursorPosition(TerminalPosition cursorPosition)
TextGraphicsWriter	setForegroundColor(TextColor foreground)	Updates the current foreground color
TextGraphicsWriter	setModifiers(EnumSet<SGR> modifiers)	Sets the active modifiers to exactly the set passed in to this method.
void	setStyleable(boolean styleable)
TextGraphicsWriter	setStyleFrom(StyleSet<?> source)	copy colors and set of SGR codes
void	setWrapBehaviour(WrapBehaviour wrapBehaviour)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

TextGraphicsWriter

public TextGraphicsWriter(TextGraphics backend)

Method Details

putString

public TextGraphicsWriter putString(String string)

putControlChar

public void putControlChar(char ch)

getCursorPosition

public TerminalPosition getCursorPosition()

Returns:

the cursor position

setCursorPosition

public void setCursorPosition(TerminalPosition cursorPosition)

Parameters:

cursorPosition - the cursor position to set

getForegroundColor

public TextColor getForegroundColor()

Description copied from interface: StyleSet

Returns the current foreground color

Specified by:

getForegroundColor in interface StyleSet<TextGraphicsWriter>

Returns:

the foreground color

setForegroundColor

public TextGraphicsWriter setForegroundColor(TextColor foreground)

Description copied from interface: StyleSet

Updates the current foreground color

Specified by:

setForegroundColor in interface StyleSet<TextGraphicsWriter>

Parameters:

foreground - the foreground color to set

Returns:

Itself

getBackgroundColor

public TextColor getBackgroundColor()

Description copied from interface: StyleSet

Returns the current background color

Specified by:

getBackgroundColor in interface StyleSet<TextGraphicsWriter>

Returns:

the background color

setBackgroundColor

public TextGraphicsWriter setBackgroundColor(TextColor background)

Description copied from interface: StyleSet

Updates the current background color

Specified by:

setBackgroundColor in interface StyleSet<TextGraphicsWriter>

Parameters:

background - the background color to set

Returns:

Itself

enableModifiers

public TextGraphicsWriter enableModifiers(SGR... modifiers)

Description copied from interface: StyleSet

Adds zero or more modifiers to the set of currently active modifiers

Specified by:

enableModifiers in interface StyleSet<TextGraphicsWriter>

Parameters:

modifiers - Modifiers to add to the set of currently active modifiers

Returns:

Itself

disableModifiers

public TextGraphicsWriter disableModifiers(SGR... modifiers)

Description copied from interface: StyleSet

Removes zero or more modifiers from the set of currently active modifiers

Specified by:

disableModifiers in interface StyleSet<TextGraphicsWriter>

Parameters:

modifiers - Modifiers to remove from the set of currently active modifiers

Returns:

Itself

setModifiers

public TextGraphicsWriter setModifiers(EnumSet<SGR> modifiers)

Description copied from interface: StyleSet

Sets the active modifiers to exactly the set passed in to this method. Any previous state of which modifiers are enabled doesn't matter.

Specified by:

setModifiers in interface StyleSet<TextGraphicsWriter>

Parameters:

modifiers - Modifiers to set as active

Returns:

Itself

clearModifiers

public TextGraphicsWriter clearModifiers()

Description copied from interface: StyleSet

Removes all active modifiers

Specified by:

clearModifiers in interface StyleSet<TextGraphicsWriter>

Returns:

Itself

getActiveModifiers

public EnumSet<SGR> getActiveModifiers()

Description copied from interface: StyleSet

Returns all the SGR codes that are currently active

Specified by:

getActiveModifiers in interface StyleSet<TextGraphicsWriter>

Returns:

Currently active SGR modifiers

setStyleFrom

public TextGraphicsWriter setStyleFrom(StyleSet<?> source)

Description copied from interface: StyleSet

copy colors and set of SGR codes

Specified by:

setStyleFrom in interface StyleSet<TextGraphicsWriter>

Parameters:

source - Modifiers to set as active

Returns:

Itself

getWrapBehaviour

public WrapBehaviour getWrapBehaviour()

Returns:

the wrapBehaviour

setWrapBehaviour

public void setWrapBehaviour(WrapBehaviour wrapBehaviour)

Parameters:

wrapBehaviour - the wrapBehaviour to set

isStyleable

public boolean isStyleable()

Returns:

whether styles in strings are handled.

setStyleable

public void setStyleable(boolean styleable)

Parameters:

styleable - whether styles in strings should be handled.