Module com.googlecode.lanterna

Package com.googlecode.lanterna.graphics

Class AbstractTheme

java.lang.Object

com.googlecode.lanterna.graphics.AbstractTheme

All Implemented Interfaces:

Theme

Direct Known Subclasses:

PropertyTheme

public abstract class AbstractTheme
extends java.lang.Object
implements Theme

Abstract Theme implementation that manages a hierarchical tree of theme nodes ties to Class objects. Sub-classes will inherit their theme properties from super-class definitions, the java.lang.Object class is considered the root of the tree and as such is the fallback for all other classes.

You normally use this class through PropertyTheme, which is the default implementation bundled with Lanterna.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private class	AbstractTheme.DefinitionImpl
private class	AbstractTheme.StyleImpl
private static class	AbstractTheme.ThemeTreeNode

Field Summary

Fields

Modifier and Type	Field	Description
private AbstractTheme.ThemeTreeNode	rootNode
private static java.lang.String	STYLE_ACTIVE
private static java.util.regex.Pattern	STYLE_FORMAT
private static java.lang.String	STYLE_INSENSITIVE
private static java.lang.String	STYLE_NORMAL
private static java.lang.String	STYLE_PRELIGHT
private static java.lang.String	STYLE_SELECTED
private WindowDecorationRenderer	windowDecorationRenderer
private WindowPostRenderer	windowPostRenderer

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractTheme(WindowPostRenderer postRenderer, WindowDecorationRenderer decorationRenderer)

Method Summary

Modifier and Type	Method	Description
protected boolean	addStyle(java.lang.String definition, java.lang.String style, java.lang.String value)
private void	classloadStandardRenderersForGraal()
java.util.List<java.lang.String>	findRedundantDeclarations()	Returns a list of redundant theme entries in this theme.
private void	findRedundantDeclarations(java.util.List<java.lang.String> result, AbstractTheme.ThemeTreeNode node)
ThemeDefinition	getDefaultDefinition()	Returns what this theme considers to be the default definition
ThemeDefinition	getDefinition(java.lang.Class<?> clazz)	Returns the theme definition associated with this class.
private AbstractTheme.ThemeTreeNode	getNode(java.lang.Class<?> definition)
private AbstractTheme.ThemeTreeNode	getNode(java.lang.String definition)
WindowDecorationRenderer	getWindowDecorationRenderer()	Returns the WindowDecorationRenderer to use for windows drawn in this theme.
WindowPostRenderer	getWindowPostRenderer()	Returns a post-renderer to invoke after drawing each window, unless the GUI system or individual windows has their own renderers set.
protected static java.lang.Object	instanceByClassName(java.lang.String className)

Methods inherited from class java.lang.Object

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

Field Detail

STYLE_NORMAL

private static final java.lang.String STYLE_NORMAL

See Also:

Constant Field Values

STYLE_PRELIGHT

private static final java.lang.String STYLE_PRELIGHT

See Also:

Constant Field Values

STYLE_SELECTED

private static final java.lang.String STYLE_SELECTED

See Also:

Constant Field Values

STYLE_ACTIVE

private static final java.lang.String STYLE_ACTIVE

See Also:

Constant Field Values

STYLE_INSENSITIVE

private static final java.lang.String STYLE_INSENSITIVE

See Also:

Constant Field Values

STYLE_FORMAT

private static final java.util.regex.Pattern STYLE_FORMAT

rootNode

private final AbstractTheme.ThemeTreeNode rootNode

windowPostRenderer

private final WindowPostRenderer windowPostRenderer

windowDecorationRenderer

private final WindowDecorationRenderer windowDecorationRenderer

Constructor Detail

AbstractTheme

protected AbstractTheme(WindowPostRenderer postRenderer,
                        WindowDecorationRenderer decorationRenderer)

Method Detail

classloadStandardRenderersForGraal

private void classloadStandardRenderersForGraal()

addStyle

protected boolean addStyle(java.lang.String definition,
                           java.lang.String style,
                           java.lang.String value)

getNode

private AbstractTheme.ThemeTreeNode getNode(java.lang.String definition)

getNode

private AbstractTheme.ThemeTreeNode getNode(java.lang.Class<?> definition)

getDefaultDefinition

public ThemeDefinition getDefaultDefinition()

Description copied from interface: Theme

Returns what this theme considers to be the default definition

Specified by:

getDefaultDefinition in interface Theme

Returns:

The default theme definition

getDefinition

public ThemeDefinition getDefinition(java.lang.Class<?> clazz)

Description copied from interface: Theme

Returns the theme definition associated with this class. The implementation of Theme should ensure that this call never returns null, it should always give back a valid value (falling back to the default is nothing else can be used).

Specified by:

getDefinition in interface Theme

Parameters:

clazz - Class to get the theme definition for

Returns:

The ThemeDefinition for the class passed in

getWindowPostRenderer

public WindowPostRenderer getWindowPostRenderer()

Description copied from interface: Theme

Returns a post-renderer to invoke after drawing each window, unless the GUI system or individual windows has their own renderers set. If null, no post-renderer will be done (unless the GUI system or the windows has a post-renderer).

Specified by:

getWindowPostRenderer in interface Theme

Returns:

A WindowPostRenderer to invoke after drawing each window unless overridden, or null if none

getWindowDecorationRenderer

public WindowDecorationRenderer getWindowDecorationRenderer()

Description copied from interface: Theme

Returns the WindowDecorationRenderer to use for windows drawn in this theme. If null then lanterna will fall back to use DefaultWindowDecorationRenderer.

Specified by:

getWindowDecorationRenderer in interface Theme

Returns:

The decoration renderer to use for this theme, or null to use system default

instanceByClassName

protected static java.lang.Object instanceByClassName(java.lang.String className)

findRedundantDeclarations

public java.util.List<java.lang.String> findRedundantDeclarations()

Returns a list of redundant theme entries in this theme. A redundant entry means that it doesn't need to be specified because there is a parent node in the hierarchy which has the same property so if the redundant entry wasn't there, the parent node would be picked up and the end result would be the same.

Returns:

List of redundant theme entries

findRedundantDeclarations

private void findRedundantDeclarations(java.util.List<java.lang.String> result,
                                       AbstractTheme.ThemeTreeNode node)