Scrollable
, TextImage
public class BasicTextImage extends Object implements TextImage
Constructor | Description |
---|---|
BasicTextImage(int columns,
int rows) |
Creates a new BasicTextImage with the specified size and fills it initially with space characters using the
default foreground and background color
|
BasicTextImage(TerminalSize size) |
Creates a new BasicTextImage with the specified size and fills it initially with space characters using the
default foreground and background color
|
BasicTextImage(TerminalSize size,
TextCharacter initialContent) |
Creates a new BasicTextImage with a given size and a TextCharacter to initially fill it with
|
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.
|
BasicTextImage |
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.
|
String |
toString() |
public BasicTextImage(int columns, int rows)
columns
- Size of the image in number of columnsrows
- Size of the image in number of rowspublic BasicTextImage(TerminalSize size)
size
- Size to make the imagepublic BasicTextImage(TerminalSize size, TextCharacter initialContent)
size
- Size of the imageinitialContent
- What character to set as the initial contentpublic TerminalSize getSize()
TextImage
public void setAll(TextCharacter character)
TextImage
public BasicTextImage resize(TerminalSize newSize, TextCharacter filler)
TextImage
public void setCharacterAt(TerminalPosition position, TextCharacter character)
TextImage
setCharacterAt
in interface TextImage
position
- Coordinates of the charactercharacter
- What TextCharacter to assign at the specified positionpublic void setCharacterAt(int column, int row, TextCharacter character)
TextImage
setCharacterAt
in interface TextImage
column
- Column coordinate of the characterrow
- Row coordinate of the charactercharacter
- What TextCharacter to assign at the specified positionpublic TextCharacter getCharacterAt(TerminalPosition position)
TextImage
getCharacterAt
in interface TextImage
position
- Coordinates of the characterpublic TextCharacter getCharacterAt(int column, int row)
TextImage
getCharacterAt
in interface TextImage
column
- Column coordinate of the characterrow
- Row coordinate of the characterpublic void copyTo(TextImage destination)
TextImage
public void copyTo(TextImage destination, int startRowIndex, int rows, int startColumnIndex, int columns, int destinationRowOffset, int destinationColumnOffset)
TextImage
copyTo
in interface TextImage
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 bepublic TextGraphics newTextGraphics()
TextImage
newTextGraphics
in interface TextImage
public void scrollLines(int firstLine, int lastLine, int distance)
TextImage
scrollLines
in interface Scrollable
scrollLines
in interface TextImage
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.