Scrollable
BasicTextImage
, ScreenBuffer
public interface TextImage extends Scrollable
Modifier and Type | Method | Description |
---|---|---|
void |
copyTo(TextImage destination) |
Copies this TextImage's content to another TextImage.
|
void |
copyTo(TextImage destination,
int startRowIndex,
int rows,
int startColumnIndex,
int columns,
int destinationRowOffset,
int destinationColumnOffset) |
Copies this TextImage's content to another TextImage.
|
TextCharacter |
getCharacterAt(int column,
int row) |
Returns the character stored at a particular position in this image
|
TextCharacter |
getCharacterAt(TerminalPosition position) |
Returns the character stored at a particular position in this image
|
TerminalSize |
getSize() |
Returns the dimensions of this TextImage, in columns and rows
|
TextGraphics |
newTextGraphics() |
Creates a TextGraphics object that targets this TextImage for all its drawing operations.
|
TextImage |
resize(TerminalSize newSize,
TextCharacter filler) |
Returns a copy of this image resized to a new size and using a specified filler character if the new size is
larger than the old and we need to fill in empty areas.
|
void |
scrollLines(int firstLine,
int lastLine,
int distance) |
Scroll a range of lines of this TextImage according to given distance.
|
void |
setAll(TextCharacter character) |
Sets the text image content to one specified character (including color and style)
|
void |
setCharacterAt(int column,
int row,
TextCharacter character) |
Sets the character at a specific position in the image to a particular TextCharacter.
|
void |
setCharacterAt(TerminalPosition position,
TextCharacter character) |
Sets the character at a specific position in the image to a particular TextCharacter.
|
TerminalSize getSize()
TextCharacter getCharacterAt(TerminalPosition position)
position
- Coordinates of the characterTextCharacter getCharacterAt(int column, int row)
column
- Column coordinate of the characterrow
- Row coordinate of the charactervoid setCharacterAt(TerminalPosition position, TextCharacter character)
position
- Coordinates of the charactercharacter
- What TextCharacter to assign at the specified positionvoid setCharacterAt(int column, int row, TextCharacter character)
column
- Column coordinate of the characterrow
- Row coordinate of the charactercharacter
- What TextCharacter to assign at the specified positionvoid setAll(TextCharacter character)
character
- The character to fill the image withTextGraphics newTextGraphics()
TextImage resize(TerminalSize newSize, TextCharacter filler)
newSize
- Size of the new imagefiller
- Filler character to use on the new areas when enlarging the image (is not used when shrinking)void copyTo(TextImage destination)
destination
- TextImage to copy tovoid copyTo(TextImage destination, int startRowIndex, int rows, int startColumnIndex, int columns, int destinationRowOffset, int destinationColumnOffset)
destination
- TextImage to copy tostartRowIndex
- Which row in this image to copy fromrows
- How many rows to copystartColumnIndex
- Which column in this image to copy fromcolumns
- How many columns to copydestinationRowOffset
- Offset (in number of rows) in the target image where we want to first copied row to bedestinationColumnOffset
- Offset (in number of columns) in the target image where we want to first copied column to bevoid scrollLines(int firstLine, int lastLine, int distance)
scrollLines
in interface Scrollable
firstLine
- first line of the range to be scrolled (top line is 0)lastLine
- last (inclusive) line of the range to be scrolleddistance
- if > 0: move lines up, else if < 0: move lines down.Copyright © 2020. All rights reserved.