Class DefaultMutableThemeStyle

java.lang.Object

com.googlecode.lanterna.graphics.DefaultMutableThemeStyle

All Implemented Interfaces:

ThemeStyle

public class DefaultMutableThemeStyle
extends Object
implements ThemeStyle

This basic implementation of ThemeStyle keeps the styles in its internal state and allows you to mutate them. It can be used to more easily override an existing theme and make small changes programmatically to it, see Issue409 in the test section for an example of how to do this.

See Also:

• DelegatingThemeDefinition
• DelegatingTheme
• Theme

Field Summary

Fields

Modifier and Type	Field	Description
private TextColor	background
private TextColor	foreground
private EnumSet<SGR>	sgrs

Constructor Summary

Constructors

Modifier	Constructor	Description
	DefaultMutableThemeStyle(ThemeStyle themeStyleToCopy)	Creates a new DefaultMutableThemeStyle based on an existing ThemeStyle.
	DefaultMutableThemeStyle(TextColor foreground, TextColor background, SGR... sgrs)	Creates a new DefaultMutableThemeStyle with a specified style (foreground, background and SGR state)
private	DefaultMutableThemeStyle(TextColor foreground, TextColor background, EnumSet<SGR> sgrs)

Method Summary

Modifier and Type	Method	Description
TextColor	getBackground()	Returns the background color associated with this style
TextColor	getForeground()	Returns the foreground color associated with this style
EnumSet<SGR>	getSGRs()	Returns the set of SGR flags associated with this style.
DefaultMutableThemeStyle	setBackground(TextColor background)	Modifies the background color of this DefaultMutableThemeStyle to the value passed in
DefaultMutableThemeStyle	setForeground(TextColor foreground)	Modifies the foreground color of this DefaultMutableThemeStyle to the value passed in
DefaultMutableThemeStyle	setSGRs(EnumSet<SGR> sgrs)	Modifies the SGR modifiers of this DefaultMutableThemeStyle to the values passed it.

Methods inherited from class Object

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

Field Details

foreground

private TextColor foreground

background

private TextColor background

sgrs

private EnumSet<SGR> sgrs

Constructor Details

DefaultMutableThemeStyle

public DefaultMutableThemeStyle(ThemeStyle themeStyleToCopy)

Creates a new DefaultMutableThemeStyle based on an existing ThemeStyle. The values of this style that is passed in will be copied into the new object that is created.

Parameters:

themeStyleToCopy - ThemeStyle object to copy the style parameters from

DefaultMutableThemeStyle

public DefaultMutableThemeStyle(TextColor foreground,
 TextColor background,
 SGR... sgrs)

Creates a new DefaultMutableThemeStyle with a specified style (foreground, background and SGR state)

Parameters:

foreground - Foreground color of the text with this style

background - Background color of the text with this style

sgrs - Modifiers to apply to the text with this style

DefaultMutableThemeStyle

private DefaultMutableThemeStyle(TextColor foreground,
 TextColor background,
 EnumSet<SGR> sgrs)

Method Details

getForeground

public TextColor getForeground()

Description copied from interface: ThemeStyle

Returns the foreground color associated with this style

Specified by:

getForeground in interface ThemeStyle

Returns:

foreground color associated with this style

getBackground

public TextColor getBackground()

Description copied from interface: ThemeStyle

Returns the background color associated with this style

Specified by:

getBackground in interface ThemeStyle

Returns:

background color associated with this style

getSGRs

public EnumSet<SGR> getSGRs()

Description copied from interface: ThemeStyle

Returns the set of SGR flags associated with this style. This EnumSet is either unmodifiable or a copy so altering it will not change the theme in any way.

Specified by:

getSGRs in interface ThemeStyle

Returns:

SGR flags associated with this style

setForeground

public DefaultMutableThemeStyle setForeground(TextColor foreground)

Modifies the foreground color of this DefaultMutableThemeStyle to the value passed in

Parameters:

foreground - New foreground color for this theme style

Returns:

Itself

setBackground

public DefaultMutableThemeStyle setBackground(TextColor background)

Modifies the background color of this DefaultMutableThemeStyle to the value passed in

Parameters:

background - New background color for this theme style

Returns:

Itself

setSGRs

public DefaultMutableThemeStyle setSGRs(EnumSet<SGR> sgrs)

Modifies the SGR modifiers of this DefaultMutableThemeStyle to the values passed it.

Parameters:

sgrs - New SGR modifiers for this theme style, the values in this set will be copied into the internal state

Returns:

Itself