Module com.googlecode.lanterna

Package com.googlecode.lanterna.graphics

Class SubTextGraphics

java.lang.Object

com.googlecode.lanterna.graphics.AbstractTextGraphics

com.googlecode.lanterna.graphics.SubTextGraphics

All Implemented Interfaces:

StyleSet<TextGraphics>, TextGraphics

class SubTextGraphics
extends AbstractTextGraphics

This implementation of TextGraphics will take a 'proper' object and composite a view on top of it, by using a top-left position and a size. Any attempts to put text outside of this area will be dropped.

Nested Class Summary

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

StyleSet.Set

Field Summary

Fields

Modifier and Type	Field	Description
private TerminalPosition	topLeft
private TextGraphics	underlyingTextGraphics
private TerminalSize	writableAreaSize

Fields inherited from class com.googlecode.lanterna.graphics.AbstractTextGraphics

activeModifiers, backgroundColor, foregroundColor, tabBehaviour

Constructor Summary

Constructors

Constructor	Description
SubTextGraphics(TextGraphics underlyingTextGraphics, TerminalPosition topLeft, TerminalSize writableAreaSize)

Method Summary

Modifier and Type	Method	Description
TextCharacter	getCharacter(int column, int row)	Returns the character at the specific position in the terminal.
TerminalSize	getSize()	Returns the size of the area that this text graphic can write to.
private TerminalPosition	project(int column, int row)
TextGraphics	setCharacter(int columnIndex, int rowIndex, TextCharacter textCharacter)	Sets the character at the current position to the specified value, without using the current colors and modifiers of this TextGraphics.

Methods inherited from class com.googlecode.lanterna.graphics.AbstractTextGraphics

clearModifiers, disableModifiers, drawImage, drawImage, drawLine, drawLine, drawLine, drawLine, drawRectangle, drawRectangle, drawTriangle, drawTriangle, enableModifiers, fill, fillRectangle, fillRectangle, fillTriangle, fillTriangle, getActiveModifiers, getBackgroundColor, getCharacter, getForegroundColor, getTabBehaviour, newTextGraphics, putCSIStyledString, putCSIStyledString, putString, putString, putString, putString, putString, setBackgroundColor, setCharacter, setCharacter, setCharacter, setForegroundColor, setModifiers, setStyleFrom, setTabBehaviour

Methods inherited from class java.lang.Object

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

Field Detail

underlyingTextGraphics

private final TextGraphics underlyingTextGraphics

topLeft

private final TerminalPosition topLeft

writableAreaSize

private final TerminalSize writableAreaSize

Constructor Detail

SubTextGraphics

SubTextGraphics(TextGraphics underlyingTextGraphics,
                TerminalPosition topLeft,
                TerminalSize writableAreaSize)

Method Detail

project

private TerminalPosition project(int column,
                                 int row)

setCharacter

public TextGraphics setCharacter(int columnIndex,
                                 int rowIndex,
                                 TextCharacter textCharacter)

Description copied from interface: TextGraphics

Sets the character at the current position to the specified value, without using the current colors and modifiers of this TextGraphics.

Parameters:

columnIndex - column of the location to set the character

rowIndex - row of the location to set the character

textCharacter - Character data to set at the current position

Returns:

Itself

getSize

public TerminalSize getSize()

Description copied from interface: TextGraphics

Returns the size of the area that this text graphic can write to. Any attempts of placing characters outside of this area will be silently ignored.

Returns:

Size of the writable area that this TextGraphics can write too

getCharacter

public TextCharacter getCharacter(int column,
                                  int row)

Description copied from interface: TextGraphics

Returns the character at the specific position in the terminal. May return null if the TextGraphics implementation doesn't support it or doesn't know what the character is.

Parameters:

column - Column to return the character for

row - Row to return the character for

Returns:

The text character at the specified position or null if not available