-
- All Superinterfaces:
StyleSet<TextGraphics>
- All Known Subinterfaces:
TextGUIGraphics
,ThemedTextGraphics
- All Known Implementing Classes:
AbstractTextGraphics
,DefaultTextGUIGraphics
,DoublePrintingTextGraphics
,NullTextGraphics
,ScreenTextGraphics
,SubTextGraphics
,TerminalTextGraphics
,VirtualTerminalTextGraphics
public interface TextGraphics extends StyleSet<TextGraphics>
This interface exposes functionality to 'draw' text graphics on a section of the terminal. It has several implementation for the different levels, including one for Terminal, one for Screen and one which is used by the TextGUI system to draw components. They are all very similar and has a lot of graphics functionality in AbstractTextGraphics.The basic concept behind a TextGraphics implementation is that it keeps a state on four things:
- Foreground color
- Background color
- Modifiers
- Tab-expanding behaviour
Don't hold on to your TextGraphics objects for too long; ideally create them and let them be GC:ed when you are done with them. The reason is that not all implementations will handle the underlying terminal changing size.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface com.googlecode.lanterna.graphics.StyleSet
StyleSet.Set
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description TextGraphics
drawImage(TerminalPosition topLeft, TextImage image)
Takes a TextImage and draws it on the surface this TextGraphics is targeting, given the coordinates on the target that is specifying where the top-left corner of the image should be drawn.TextGraphics
drawImage(TerminalPosition topLeft, TextImage image, TerminalPosition sourceImageTopLeft, TerminalSize sourceImageSize)
Takes a TextImage and draws it on the surface this TextGraphics is targeting, given the coordinates on the target that is specifying where the top-left corner of the image should be drawn.TextGraphics
drawLine(int fromX, int fromY, int toX, int toY, char character)
Draws a line from a specified position to a specified position, using a supplied character.TextGraphics
drawLine(int fromX, int fromY, int toX, int toY, TextCharacter character)
Draws a line from a specified position to a specified position, using a supplied character.TextGraphics
drawLine(TerminalPosition fromPoint, TerminalPosition toPoint, char character)
Draws a line from a specified position to a specified position, using a supplied character.TextGraphics
drawLine(TerminalPosition fromPoint, TerminalPosition toPoint, TextCharacter character)
Draws a line from a specified position to a specified position, using a supplied TextCharacter.TextGraphics
drawRectangle(TerminalPosition topLeft, TerminalSize size, char character)
Draws the outline of a rectangle with a particular character (and the currently active colors and modifiers).TextGraphics
drawRectangle(TerminalPosition topLeft, TerminalSize size, TextCharacter character)
Draws the outline of a rectangle with a particular TextCharacter, ignoring the current colors and modifiers of this TextGraphics.TextGraphics
drawTriangle(TerminalPosition p1, TerminalPosition p2, TerminalPosition p3, char character)
Draws the outline of a triangle on the screen, using a supplied character.TextGraphics
drawTriangle(TerminalPosition p1, TerminalPosition p2, TerminalPosition p3, TextCharacter character)
Draws the outline of a triangle on the screen, using a supplied character.TextGraphics
fill(char c)
Fills the entire writable area with a single character, using current foreground color, background color and modifiers.TextGraphics
fillRectangle(TerminalPosition topLeft, TerminalSize size, char character)
Takes a rectangle and fills it with a particular character (and the currently active colors and modifiers).TextGraphics
fillRectangle(TerminalPosition topLeft, TerminalSize size, TextCharacter character)
Takes a rectangle and fills it using a particular TextCharacter, ignoring the current colors and modifiers of this TextGraphics.TextGraphics
fillTriangle(TerminalPosition p1, TerminalPosition p2, TerminalPosition p3, char character)
Draws a filled triangle, using a supplied character.TextGraphics
fillTriangle(TerminalPosition p1, TerminalPosition p2, TerminalPosition p3, TextCharacter character)
Draws a filled triangle, using a supplied character.TextCharacter
getCharacter(int column, int row)
Returns the character at the specific position in the terminal.TextCharacter
getCharacter(TerminalPosition position)
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.TabBehaviour
getTabBehaviour()
Retrieves the current tab behaviour, which is what the TextGraphics will use when expanding \t characters to spaces.TextGraphics
newTextGraphics(TerminalPosition topLeftCorner, TerminalSize size)
Creates a new TextGraphics of the same type as this one, using the same underlying subsystem.TextGraphics
putCSIStyledString(int column, int row, java.lang.String string)
Puts a string on the screen at the specified position with the current colors and modifiers.TextGraphics
putCSIStyledString(TerminalPosition position, java.lang.String string)
Puts a string on the screen at the specified position with the current colors and modifiers.TextGraphics
putString(int column, int row, java.lang.String string)
Puts a string on the screen at the specified position with the current colors and modifiers.TextGraphics
putString(int column, int row, java.lang.String string, SGR extraModifier, SGR... optionalExtraModifiers)
Puts a string on the screen at the specified position with the current colors and modifiers.TextGraphics
putString(int column, int row, java.lang.String string, java.util.Collection<SGR> extraModifiers)
Puts a string on the screen at the specified position with the current colors and modifiers.TextGraphics
putString(TerminalPosition position, java.lang.String string)
Shortcut to calling:TextGraphics
putString(TerminalPosition position, java.lang.String string, SGR extraModifier, SGR... optionalExtraModifiers)
Shortcut to calling:TextGraphics
setCharacter(int column, int row, char character)
Sets the character at the current position to the specified valueTextGraphics
setCharacter(int column, int row, TextCharacter character)
Sets the character at the current position to the specified value, without using the current colors and modifiers of this TextGraphics.TextGraphics
setCharacter(TerminalPosition position, char character)
Sets the character at the current position to the specified valueTextGraphics
setCharacter(TerminalPosition position, TextCharacter character)
Sets the character at the current position to the specified value, without using the current colors and modifiers of this TextGraphics.TextGraphics
setTabBehaviour(TabBehaviour tabBehaviour)
Sets the behaviour to use when expanding tab characters (\t) to spaces-
Methods inherited from interface com.googlecode.lanterna.graphics.StyleSet
clearModifiers, disableModifiers, enableModifiers, getActiveModifiers, getBackgroundColor, getForegroundColor, setBackgroundColor, setForegroundColor, setModifiers, setStyleFrom
-
-
-
-
Method Detail
-
getSize
TerminalSize getSize()
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
-
newTextGraphics
TextGraphics newTextGraphics(TerminalPosition topLeftCorner, TerminalSize size) throws java.lang.IllegalArgumentException
Creates a new TextGraphics of the same type as this one, using the same underlying subsystem. Using this method, you need to specify a section of the current TextGraphics valid area that this new TextGraphic shall be restricted to. If you callnewTextGraphics(TerminalPosition.TOP_LEFT_CORNER, textGraphics.getSize())
then the resulting object will be identical to this one, but having a separated state for colors, position and modifiers.- Parameters:
topLeftCorner
- Position of this TextGraphics's writable area that is to become the top-left corner (0x0) of the new TextGraphicssize
- How large area, counted from the topLeftCorner, the new TextGraphics can write to. This cannot be larger than the current TextGraphics's writable area (adjusted by topLeftCorner)- Returns:
- A new TextGraphics with the same underlying subsystem, that can write to only the specified area
- Throws:
java.lang.IllegalArgumentException
- If the size the of new TextGraphics exceeds the dimensions of this TextGraphics in any way.
-
getTabBehaviour
TabBehaviour getTabBehaviour()
Retrieves the current tab behaviour, which is what the TextGraphics will use when expanding \t characters to spaces.- Returns:
- Current behaviour in use for expanding tab to spaces
-
setTabBehaviour
TextGraphics setTabBehaviour(TabBehaviour tabBehaviour)
Sets the behaviour to use when expanding tab characters (\t) to spaces- Parameters:
tabBehaviour
- Behaviour to use when expanding tabs to spaces- Returns:
- Itself
-
fill
TextGraphics fill(char c)
Fills the entire writable area with a single character, using current foreground color, background color and modifiers.- Parameters:
c
- Character to fill the writable area with- Returns:
- Itself
-
setCharacter
TextGraphics setCharacter(int column, int row, char character)
Sets the character at the current position to the specified value- Parameters:
column
- column of the location to set the characterrow
- row of the location to set the charactercharacter
- Character to set at the current position- Returns:
- Itself
-
setCharacter
TextGraphics setCharacter(int column, int row, TextCharacter character)
Sets the character at the current position to the specified value, without using the current colors and modifiers of this TextGraphics.- Parameters:
column
- column of the location to set the characterrow
- row of the location to set the charactercharacter
- Character data to set at the current position- Returns:
- Itself
-
setCharacter
TextGraphics setCharacter(TerminalPosition position, char character)
Sets the character at the current position to the specified value- Parameters:
position
- position of the location to set the charactercharacter
- Character to set at the current position- Returns:
- Itself
-
setCharacter
TextGraphics setCharacter(TerminalPosition position, TextCharacter character)
Sets the character at the current position to the specified value, without using the current colors and modifiers of this TextGraphics.- Parameters:
position
- position of the location to set the charactercharacter
- Character data to set at the current position- Returns:
- Itself
-
drawLine
TextGraphics drawLine(TerminalPosition fromPoint, TerminalPosition toPoint, char character)
Draws a line from a specified position to a specified position, using a supplied character. The current foreground color, background color and modifiers will be applied.- Parameters:
fromPoint
- From where to draw the linetoPoint
- Where to draw the linecharacter
- Character to use for the line- Returns:
- Itself
-
drawLine
TextGraphics drawLine(TerminalPosition fromPoint, TerminalPosition toPoint, TextCharacter character)
Draws a line from a specified position to a specified position, using a supplied TextCharacter. The current foreground color, background color and modifiers of this TextGraphics will not be used and will not be modified by this call.- Parameters:
fromPoint
- From where to draw the linetoPoint
- Where to draw the linecharacter
- Character data to use for the line, including character, colors and modifiers- Returns:
- Itself
-
drawLine
TextGraphics drawLine(int fromX, int fromY, int toX, int toY, char character)
Draws a line from a specified position to a specified position, using a supplied character. The current foreground color, background color and modifiers will be applied.- Parameters:
fromX
- Column of the starting position to draw the line from (inclusive)fromY
- Row of the starting position to draw the line from (inclusive)toX
- Column of the end position to draw the line to (inclusive)toY
- Row of the end position to draw the line to (inclusive)character
- Character to use for the line- Returns:
- Itself
-
drawLine
TextGraphics drawLine(int fromX, int fromY, int toX, int toY, TextCharacter character)
Draws a line from a specified position to a specified position, using a supplied character. The current foreground color, background color and modifiers of this TextGraphics will not be used and will not be modified by this call.- Parameters:
fromX
- Column of the starting position to draw the line from (inclusive)fromY
- Row of the starting position to draw the line from (inclusive)toX
- Column of the end position to draw the line to (inclusive)toY
- Row of the end position to draw the line to (inclusive)character
- Character data to use for the line, including character, colors and modifiers- Returns:
- Itself
-
drawTriangle
TextGraphics drawTriangle(TerminalPosition p1, TerminalPosition p2, TerminalPosition p3, char character)
Draws the outline of a triangle on the screen, using a supplied character. The triangle will begin at p1, go through p2 and then p3 and then back to p1. The current foreground color, background color and modifiers will be applied.- Parameters:
p1
- First point on the screen of the trianglep2
- Second point on the screen of the trianglep3
- Third point on the screen of the trianglecharacter
- What character to use when drawing the lines of the triangle- Returns:
- Itself
-
drawTriangle
TextGraphics drawTriangle(TerminalPosition p1, TerminalPosition p2, TerminalPosition p3, TextCharacter character)
Draws the outline of a triangle on the screen, using a supplied character. The triangle will begin at p1, go through p2 and then p3 and then back to p1. The current foreground color, background color and modifiers of this TextGraphics will not be used and will not be modified by this call.- Parameters:
p1
- First point on the screen of the trianglep2
- Second point on the screen of the trianglep3
- Third point on the screen of the trianglecharacter
- What character data to use when drawing the lines of the triangle- Returns:
- Itself
-
fillTriangle
TextGraphics fillTriangle(TerminalPosition p1, TerminalPosition p2, TerminalPosition p3, char character)
Draws a filled triangle, using a supplied character. The triangle will begin at p1, go through p2 and then p3 and then back to p1. The current foreground color, background color and modifiers will be applied.- Parameters:
p1
- First point on the screen of the trianglep2
- Second point on the screen of the trianglep3
- Third point on the screen of the trianglecharacter
- What character to use when drawing the triangle- Returns:
- Itself
-
fillTriangle
TextGraphics fillTriangle(TerminalPosition p1, TerminalPosition p2, TerminalPosition p3, TextCharacter character)
Draws a filled triangle, using a supplied character. The triangle will begin at p1, go through p2 and then p3 and then back to p1. The current foreground color, background color and modifiers of this TextGraphics will not be used and will not be modified by this call.- Parameters:
p1
- First point on the screen of the trianglep2
- Second point on the screen of the trianglep3
- Third point on the screen of the trianglecharacter
- What character data to use when drawing the triangle- Returns:
- Itself
-
drawRectangle
TextGraphics drawRectangle(TerminalPosition topLeft, TerminalSize size, char character)
Draws the outline of a rectangle with a particular character (and the currently active colors and modifiers). The topLeft coordinate is inclusive.For example, calling drawRectangle with size being the size of the terminal and top-left value being the terminal's top-left (0x0) corner will draw a border around the terminal.
The current foreground color, background color and modifiers will be applied.
- Parameters:
topLeft
- Coordinates of the top-left position of the rectanglesize
- Size (in columns and rows) of the area to drawcharacter
- What character to use when drawing the outline of the rectangle- Returns:
- Itself
-
drawRectangle
TextGraphics drawRectangle(TerminalPosition topLeft, TerminalSize size, TextCharacter character)
Draws the outline of a rectangle with a particular TextCharacter, ignoring the current colors and modifiers of this TextGraphics.For example, calling drawRectangle with size being the size of the terminal and top-left value being the terminal's top-left (0x0) corner will draw a border around the terminal.
The current foreground color, background color and modifiers will not be modified by this call.
- Parameters:
topLeft
- Coordinates of the top-left position of the rectanglesize
- Size (in columns and rows) of the area to drawcharacter
- What character data to use when drawing the outline of the rectangle- Returns:
- Itself
-
fillRectangle
TextGraphics fillRectangle(TerminalPosition topLeft, TerminalSize size, char character)
Takes a rectangle and fills it with a particular character (and the currently active colors and modifiers). The topLeft coordinate is inclusive.For example, calling fillRectangle with size being the size of the terminal and top-left value being the terminal's top-left (0x0) corner will fill the entire terminal with this character.
The current foreground color, background color and modifiers will be applied.
- Parameters:
topLeft
- Coordinates of the top-left position of the rectanglesize
- Size (in columns and rows) of the area to drawcharacter
- What character to use when filling the rectangle- Returns:
- Itself
-
fillRectangle
TextGraphics fillRectangle(TerminalPosition topLeft, TerminalSize size, TextCharacter character)
Takes a rectangle and fills it using a particular TextCharacter, ignoring the current colors and modifiers of this TextGraphics. The topLeft coordinate is inclusive.For example, calling fillRectangle with size being the size of the terminal and top-left value being the terminal's top-left (0x0) corner will fill the entire terminal with this character.
The current foreground color, background color and modifiers will not be modified by this call.
- Parameters:
topLeft
- Coordinates of the top-left position of the rectanglesize
- Size (in columns and rows) of the area to drawcharacter
- What character data to use when filling the rectangle- Returns:
- Itself
-
drawImage
TextGraphics drawImage(TerminalPosition topLeft, TextImage image)
Takes a TextImage and draws it on the surface this TextGraphics is targeting, given the coordinates on the target that is specifying where the top-left corner of the image should be drawn. This is equivalent of callingdrawImage(topLeft, image, TerminalPosition.TOP_LEFT_CORNER, image.getSize()
.- Parameters:
topLeft
- Position of the top-left corner of the image on the targetimage
- Image to draw- Returns:
- Itself
-
drawImage
TextGraphics drawImage(TerminalPosition topLeft, TextImage image, TerminalPosition sourceImageTopLeft, TerminalSize sourceImageSize)
Takes a TextImage and draws it on the surface this TextGraphics is targeting, given the coordinates on the target that is specifying where the top-left corner of the image should be drawn. This overload will only draw a portion of the image to the target, as specified by the two last parameters.- Parameters:
topLeft
- Position of the top-left corner of the image on the targetimage
- Image to drawsourceImageTopLeft
- Position of the top-left corner in the source image to draw at the topLeft position on the targetsourceImageSize
- How much of the source image to draw on the target, counted from the sourceImageTopLeft position- Returns:
- Itself
-
putString
TextGraphics putString(int column, int row, java.lang.String string)
Puts a string on the screen at the specified position with the current colors and modifiers. If the string contains newlines (\r and/or \n), the method will stop at the character before that; you have to manage multi-line strings yourself! The current foreground color, background color and modifiers will be applied.- Parameters:
column
- What column to put the string atrow
- What row to put the string atstring
- String to put on the screen- Returns:
- Itself
-
putString
TextGraphics putString(TerminalPosition position, java.lang.String string)
Shortcut to calling:putString(position.getColumn(), position.getRow(), string);
- Parameters:
position
- Position to put the string atstring
- String to put on the screen- Returns:
- Itself
-
putString
TextGraphics putString(int column, int row, java.lang.String string, SGR extraModifier, SGR... optionalExtraModifiers)
Puts a string on the screen at the specified position with the current colors and modifiers. If the string contains newlines (\r and/or \n), the method will stop at the character before that; you have to manage multi-line strings yourself! If you supplied any extra modifiers, they will be applied when writing the string as well but not recorded into the state of the TextGraphics object.- Parameters:
column
- What column to put the string atrow
- What row to put the string atstring
- String to put on the screenextraModifier
- Modifier to apply to the stringoptionalExtraModifiers
- Optional extra modifiers to apply to the string- Returns:
- Itself
-
putString
TextGraphics putString(TerminalPosition position, java.lang.String string, SGR extraModifier, SGR... optionalExtraModifiers)
Shortcut to calling:putString(position.getColumn(), position.getRow(), string, modifiers, optionalExtraModifiers);
- Parameters:
position
- Position to put the string atstring
- String to put on the screenextraModifier
- Modifier to apply to the stringoptionalExtraModifiers
- Optional extra modifiers to apply to the string- Returns:
- Itself
-
putString
TextGraphics putString(int column, int row, java.lang.String string, java.util.Collection<SGR> extraModifiers)
Puts a string on the screen at the specified position with the current colors and modifiers. If the string contains newlines (\r and/or \n), the method will stop at the character before that; you have to manage multi-line strings yourself! If you supplied any extra modifiers, they will be applied when writing the string as well but not recorded into the state of the TextGraphics object.- Parameters:
column
- What column to put the string atrow
- What row to put the string atstring
- String to put on the screenextraModifiers
- Modifier to apply to the string- Returns:
- Itself
-
putCSIStyledString
TextGraphics putCSIStyledString(int column, int row, java.lang.String string)
Puts a string on the screen at the specified position with the current colors and modifiers. If the string contains newlines (\r and/or \n), the method will stop at the character before that; you have to manage multi-line strings yourself!This method has an additional functionality to the regular
putString(int, int, String)
; if you embed ANSI CSI-style control sequences (like modifying text color or controlling SGR status), they will be interpreted as the string is printed and mutates theTextGraphics
object. In this version of Lanterna, the following sequences are supported:- Set foreground color
- Set background color
- Set/Clear bold style
- Set/Clear underline style
- Set/Clear blink style
- Set/Clear reverse style
- Clear all styles and colors (notice that this will return the state to what it was at the start of the method)
TextGraphics
object will return to the color/style state it was in at the start of the call.- Parameters:
column
- What column to put the string atrow
- What row to put the string atstring
- String to put on the screen- Returns:
- Itself
-
putCSIStyledString
TextGraphics putCSIStyledString(TerminalPosition position, java.lang.String string)
Puts a string on the screen at the specified position with the current colors and modifiers. If the string contains newlines (\r and/or \n), the method will stop at the character before that; you have to manage multi-line strings yourself!This method has an additional functionality to the regular
putString(int, int, String)
; if you embed ANSI CSI-style control sequences (like modifying text color or controlling SGR status), they will be interpreted as the string is printed and mutates theTextGraphics
object. In this version of Lanterna, the following sequences are supported:- Set foreground color
- Set background color
- Set/Clear bold style
- Set/Clear underline style
- Set/Clear blink style
- Set/Clear reverse style
- Clear all styles and colors (notice that this will return the state to what it was at the start of the method)
TextGraphics
object will return to the color/style state it was in at the start of the call.- Parameters:
position
- Position to put the string atstring
- String to put on the screen- Returns:
- Itself
-
getCharacter
TextCharacter getCharacter(TerminalPosition position)
Returns the character at the specific position in the terminal. May returnnull
if the TextGraphics implementation doesn't support it or doesn't know what the character is.- Parameters:
position
- Position to return the character for- Returns:
- The text character at the specified position or
null
if not available
-
getCharacter
TextCharacter getCharacter(int column, int row)
Returns the character at the specific position in the terminal. May returnnull
if the TextGraphics implementation doesn't support it or doesn't know what the character is.- Parameters:
column
- Column to return the character forrow
- Row to return the character for- Returns:
- The text character at the specified position or
null
if not available
-
-