com.googlecode.lanterna.gui

Interface TextGraphics

public interface TextGraphics

Author:

Martin

Method Summary

Methods

Modifier and Type	Method and Description
void	applyTheme(Theme.Category category) Applies theme-specific settings according to the category supplied.
void	applyTheme(Theme.Definition themeItem) Applies theme-specific settings according to the definition supplied.
void	drawString(int column, int row, String string, ScreenCharacterStyle... styles) Draws a string to the terminal, with the first character starting at specified coordinates and which an option list of styles applied.
void	fillArea(char character) Replaces the content of the entire TextGraphic object with one character
void	fillRectangle(char character, TerminalPosition topLeft, TerminalSize rectangleSize) Replaces the content of a rectangle within the TextGraphic drawing area with a specified character
Terminal.Color	getBackgroundColor()
Terminal.Color	getForegroundColor()
int	getHeight() Height, in rows, of the TextGraphics drawing area.
TerminalSize	getSize() Size of the area the TextGraphics can edit, as a TerminalSize object, any attempts to draw outside of this area will be ignored.
Theme	getTheme()
int	getWidth() Width, in columns, of the TextGraphics drawing area.
void	setBackgroundColor(Terminal.Color backgroundColor)
void	setBoldMask(boolean enabledBoldMask)
void	setForegroundColor(Terminal.Color foregroundColor)
TextGraphics	subAreaGraphics(TerminalPosition terminalPosition) Creates a new TextGraphics object using the same area or smaller.
TextGraphics	subAreaGraphics(TerminalPosition topLeft, TerminalSize subAreaSize) Creates a new TextGraphics object using the same area or smaller.
TerminalPosition	translateToGlobalCoordinates(TerminalPosition pointInArea) Translates local coordinates of this TextGraphics object to global

Method Detail

applyTheme

void applyTheme(Theme.Category category)

Applies theme-specific settings according to the category supplied. This may modify the foreground color, background color and/or styles. Any string drawn after this call will have these settings applied

Parameters:

category - Category to use

applyTheme

void applyTheme(Theme.Definition themeItem)

Applies theme-specific settings according to the definition supplied. This may modify the foreground color, background color and/or styles. Any string drawn after this call will have these settings applied

Parameters:

themeItem - Definition to use

drawString

void drawString(int column,
              int row,
              String string,
              ScreenCharacterStyle... styles)

Draws a string to the terminal, with the first character starting at specified coordinates and which an option list of styles applied. All coordinates are local to the top-left corner of the TextGraphics object

Parameters:

column - Column of the first character in the string

row - Row of the first character in the string

string - String to print to terminal

styles - Which styles to apply to the string

fillArea

void fillArea(char character)

Replaces the content of the entire TextGraphic object with one character

Parameters:

character - Character to fill the area with

fillRectangle

void fillRectangle(char character,
                 TerminalPosition topLeft,
                 TerminalSize rectangleSize)

Replaces the content of a rectangle within the TextGraphic drawing area with a specified character

Parameters:

character - Character to fill the area with

getBackgroundColor

Terminal.Color getBackgroundColor()

getForegroundColor

Terminal.Color getForegroundColor()

getHeight

int getHeight()

Height, in rows, of the TextGraphics drawing area. Attemps to draw outside of this will be ignored

Returns:

Size of the TextGraphics area, in rows

getSize

TerminalSize getSize()

Size of the area the TextGraphics can edit, as a TerminalSize object, any attempts to draw outside of this area will be ignored.

Returns:

Size of the area the TextGraphics can edit, as a TerminalSize object

getTheme

Theme getTheme()

getWidth

int getWidth()

Width, in columns, of the TextGraphics drawing area. Attemps to draw outside of this will be ignored

Returns:

Size of the TextGraphics area, in columns

setBackgroundColor

void setBackgroundColor(Terminal.Color backgroundColor)

setBoldMask

void setBoldMask(boolean enabledBoldMask)

setForegroundColor

void setForegroundColor(Terminal.Color foregroundColor)

subAreaGraphics

TextGraphics subAreaGraphics(TerminalPosition terminalPosition)

Creates a new TextGraphics object using the same area or smaller. Use the terminalPosition variable to determine what the new TextGraphics object will cover.

Parameters:

terminalPosition - In local coordinates of the current TextGraphics, the left-left coordinates of the new TextGraphics

Returns:

A new TextGraphics object covering the same or smaller area as this

subAreaGraphics

TextGraphics subAreaGraphics(TerminalPosition topLeft,
                           TerminalSize subAreaSize)

Creates a new TextGraphics object using the same area or smaller. Use the topLeft and subAreaSize variable to determine what the new TextGraphics object will cover.

Parameters:

topLeft - In local coordinates of the current TextGraphics, the left-left coordinates of the new TextGraphics

subAreaSize - Size of the area the new TextGraphics will cover

Returns:

A new TextGraphics object covering the same or smaller area as this

translateToGlobalCoordinates

TerminalPosition translateToGlobalCoordinates(TerminalPosition pointInArea)

Translates local coordinates of this TextGraphics object to global

Parameters:

pointInArea - Point in local coordinates

Returns:

The point in global coordinates