com.googlecode.lanterna.terminal.swing

Class SwingTerminal

java.lang.Object

com.googlecode.lanterna.terminal.AbstractTerminal

com.googlecode.lanterna.terminal.swing.SwingTerminal

All Implemented Interfaces:

InputProvider, Terminal

public class SwingTerminal
extends AbstractTerminal
implements InputProvider

A Swing-based text terminal emulator

Author:

Martin

Nested Class Summary

Nested classes/interfaces inherited from interface com.googlecode.lanterna.terminal.Terminal

Terminal.Color, Terminal.ResizeListener, Terminal.SGR

Constructor Summary

Constructors

Constructor and Description
SwingTerminal()
SwingTerminal(int widthInColumns, int heightInRows)
SwingTerminal(TerminalAppearance appearance)
SwingTerminal(TerminalAppearance appearance, int widthInColumns, int heightInRows)
SwingTerminal(TerminalSize terminalSize)

Method Summary

Methods

Modifier and Type	Method and Description
void	addInputProfile(KeyMappingProfile profile) Adds a KeyMappingProfile to be used when converting raw user input bytes to Key objects.
void	applyBackgroundColor(int index) Changes the background color for all the following characters put to the terminal.
void	applyBackgroundColor(int r, int g, int b) Changes the background color for all the following characters put to the terminal.
void	applyBackgroundColor(Terminal.Color color) Changes the background color for all the following characters put to the terminal.
void	applyForegroundColor(int index) Changes the foreground color for all the following characters put to the terminal.
void	applyForegroundColor(int r, int g, int b) Changes the foreground color for all the following characters put to the terminal.
void	applyForegroundColor(Terminal.Color color) Changes the foreground color for all the following characters put to the terminal.
void	applySGR(Terminal.SGR... options) Activates an SGR code for all the following characters put to the terminal.
void	clearScreen() Removes all the characters, colors and graphics from the screep and leaves you with a big empty space.
void	enterPrivateMode() Calling this method will, where supported, give your terminal a private area to use, separate from what was there before.
void	exitPrivateMode() If you have previously entered private mode, this method will exit this and, depending on implementation, maybe restore what the terminal looked like before private mode was entered.
void	flush() Calls flush() on the underlying OutputStream object, or whatever other implementation this terminal is built around.
JFrame	getJFrame() This method will give you the underlying JFrame for this terminal.
TerminalSize	getTerminalSize() Returns the size of the terminal, expressed as a TerminalSize object.
void	moveCursor(int x, int y) Moves the text cursor to a new location
void	putCharacter(char c) Prints one character to the terminal at the current cursor location.
TerminalSize	queryTerminalSize() Will ask the terminal of its current size dimensions, represented by a TerminalSize object.
Key	readInput() Returns the next Key off the input queue or null if there is none more input events available
void	setCursorVisible(boolean visible) Hides or shows the text cursor
void	setTerminalPalette(TerminalPalette palette) Changes the current color palett to a new one supplied

Methods inherited from class com.googlecode.lanterna.terminal.AbstractTerminal

addResizeListener, getLastKnownSize, onResized, removeResizeListener

Methods inherited from class java.lang.Object

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

Constructor Detail

SwingTerminal

public SwingTerminal()

SwingTerminal

public SwingTerminal(TerminalSize terminalSize)

SwingTerminal

public SwingTerminal(int widthInColumns,
             int heightInRows)

SwingTerminal

public SwingTerminal(TerminalAppearance appearance)

SwingTerminal

public SwingTerminal(TerminalAppearance appearance,
             int widthInColumns,
             int heightInRows)

Method Detail

getJFrame

public JFrame getJFrame()

This method will give you the underlying JFrame for this terminal. Please be careful when calling methods on the JFrame, especially if you modify the rendering or content pane, since that may cause the terminal rendering to malfunction.

Good uses of this method is to set the window title, window icon list and so on. If you add more logic to this JFrame, you should probably ask yourself why you are using Lanterna to begin with.

Returns:

JFrame object used by this SwingTerminal

addInputProfile

public void addInputProfile(KeyMappingProfile profile)

Description copied from interface: InputProvider

Adds a KeyMappingProfile to be used when converting raw user input bytes to Key objects.

Specified by:

addInputProfile in interface InputProvider

See Also:

KeyMappingProfile

applyBackgroundColor

public void applyBackgroundColor(Terminal.Color color)

Description copied from interface: Terminal

Changes the background color for all the following characters put to the terminal. The background color is the color surrounding the text being printed.

Specified by:

applyBackgroundColor in interface Terminal

Parameters:

color - Color to use for the background

applyBackgroundColor

public void applyBackgroundColor(int r,
                        int g,
                        int b)

Description copied from interface: Terminal

Changes the background color for all the following characters put to the terminal. The background color is the color surrounding the text being printed.
Warning: Only a few terminal support 24-bit color control codes, please avoid using this unless you know all users will have compatible terminals. For details, please see this commit log.

Specified by:

applyBackgroundColor in interface Terminal

Parameters:

r - Red intensity, from 0 to 255

g - Green intensity, from 0 to 255

b - Blue intensity, from 0 to 255

applyBackgroundColor

public void applyBackgroundColor(int index)

Description copied from interface: Terminal

Changes the background color for all the following characters put to the terminal. The background color is the color surrounding the text being printed.
Warning: This method will use the XTerm 256 color extension, it may not be supported on all terminal emulators! The index values are resolved as this:
0 .. 15 - System color, these are taken from the schema. 16 .. 231 - Forms a 6x6x6 RGB color cube.
232 .. 255 - A gray scale ramp without black and white.

For more details on this, please see this commit message to Konsole.

Specified by:

applyBackgroundColor in interface Terminal

Parameters:

index - Index of the color to use, from the XTerm 256 color extension

applyForegroundColor

public void applyForegroundColor(Terminal.Color color)

Description copied from interface: Terminal

Changes the foreground color for all the following characters put to the terminal. The foreground color is what color to draw the text in.

Specified by:

applyForegroundColor in interface Terminal

Parameters:

color - Color to use for foreground

applyForegroundColor

public void applyForegroundColor(int r,
                        int g,
                        int b)

Description copied from interface: Terminal

Changes the foreground color for all the following characters put to the terminal. The foreground color is what color to draw the text in.
Warning: Only a few terminal support 24-bit color control codes, please avoid using this unless you know all users will have compatible terminals. For details, please see this commit log.

Specified by:

applyForegroundColor in interface Terminal

Parameters:

r - Red intensity, from 0 to 255

g - Green intensity, from 0 to 255

b - Blue intensity, from 0 to 255

applyForegroundColor

public void applyForegroundColor(int index)

Description copied from interface: Terminal

Changes the foreground color for all the following characters put to the terminal. The foreground color is what color to draw the text in.
Warning: This method will use the XTerm 256 color extension, it may not be supported on all terminal emulators! The index values are resolved as this:
0 .. 15 - System color, these are taken from the schema. 16 .. 231 - Forms a 6x6x6 RGB color cube.
232 .. 255 - A gray scale ramp without black and white.

For more details on this, please see this commit message to Konsole.

Specified by:

applyForegroundColor in interface Terminal

Parameters:

index - Color index from the XTerm 256 color space

applySGR

public void applySGR(Terminal.SGR... options)

Description copied from interface: Terminal

Activates an SGR code for all the following characters put to the terminal.

Specified by:

applySGR in interface Terminal

Parameters:

options - List of SGR codes

See Also:

Terminal.SGR

clearScreen

public void clearScreen()

Description copied from interface: Terminal

Removes all the characters, colors and graphics from the screep and leaves you with a big empty space. Text cursor position is undefined after this call (depends on platform and terminal) so you should always call moveCursor next.

Specified by:

clearScreen in interface Terminal

enterPrivateMode

public void enterPrivateMode()

Description copied from interface: Terminal

Calling this method will, where supported, give your terminal a private area to use, separate from what was there before. Some terminal emulators will preserve the terminal history and restore it when you exit private mode.

Specified by:

enterPrivateMode in interface Terminal

exitPrivateMode

public void exitPrivateMode()

Description copied from interface: Terminal

If you have previously entered private mode, this method will exit this and, depending on implementation, maybe restore what the terminal looked like before private mode was entered.

Specified by:

exitPrivateMode in interface Terminal

moveCursor

public void moveCursor(int x,
              int y)

Description copied from interface: Terminal

Moves the text cursor to a new location

Specified by:

moveCursor in interface Terminal

Parameters:

x - The 0-indexed column to place the cursor at

y - The 0-indexed row to place the cursor at

setCursorVisible

public void setCursorVisible(boolean visible)

Description copied from interface: Terminal

Hides or shows the text cursor

Specified by:

setCursorVisible in interface Terminal

Parameters:

visible - Hides the text cursor if false and shows it if true

putCharacter

public void putCharacter(char c)

Description copied from interface: Terminal

Prints one character to the terminal at the current cursor location. Please note that the cursor will then move one column to the right but if reached the end of the line may move to the beginning of the next line.

Specified by:

putCharacter in interface Terminal

queryTerminalSize

public TerminalSize queryTerminalSize()

Description copied from interface: Terminal

Will ask the terminal of its current size dimensions, represented by a TerminalSize object. Please note that the default way of figuring this information out is asynchorous and so you will be given the last known dimensions. With proper resize listeners set up, this will only be a problem for figuring out the initial size of the terminal.

Specified by:

queryTerminalSize in interface Terminal

Returns:

a TerminalSize object representing the size of the terminal

See Also:

TerminalSize

getTerminalSize

public TerminalSize getTerminalSize()

Description copied from interface: Terminal

Returns the size of the terminal, expressed as a TerminalSize object. Please bear in mind that depending on the Terminal implementation, this may or may not be accurate. See the implementing classes for more information.

Specified by:

getTerminalSize in interface Terminal

Returns:

Size of the terminal

readInput

public Key readInput()

Description copied from interface: InputProvider

Returns the next Key off the input queue or null if there is none more input events available

Specified by:

readInput in interface InputProvider

Returns:

Next Key off the input queue or null if there is none

flush

public void flush()

Description copied from interface: Terminal

Calls flush() on the underlying OutputStream object, or whatever other implementation this terminal is built around.

Specified by:

flush in interface Terminal

setTerminalPalette

public void setTerminalPalette(TerminalPalette palette)

Changes the current color palett to a new one supplied

Parameters:

palette - Palett to use