Module com.googlecode.lanterna

Package com.googlecode.lanterna.terminal.swing

Class SwingTerminalImplementation

java.lang.Object

com.googlecode.lanterna.terminal.swing.GraphicalTerminalImplementation

com.googlecode.lanterna.terminal.swing.SwingTerminalImplementation

All Implemented Interfaces:

InputProvider, IOSafeTerminal, Terminal, java.io.Closeable, java.lang.AutoCloseable

class SwingTerminalImplementation
extends GraphicalTerminalImplementation

Concrete implementation of GraphicalTerminalImplementation that adapts it to Swing

Nested Class Summary

Nested classes/interfaces inherited from class com.googlecode.lanterna.terminal.swing.GraphicalTerminalImplementation

GraphicalTerminalImplementation.TerminalInputListener, GraphicalTerminalImplementation.TerminalMouseListener

Field Summary

Fields

Modifier and Type	Field	Description
private javax.swing.JComponent	component
private SwingTerminalFontConfiguration	fontConfiguration

Constructor Summary

Constructors

Constructor	Description
SwingTerminalImplementation(javax.swing.JComponent component, SwingTerminalFontConfiguration fontConfiguration, TerminalSize initialTerminalSize, TerminalEmulatorDeviceConfiguration deviceConfiguration, TerminalEmulatorColorConfiguration colorConfiguration, TerminalScrollController scrollController)	Creates a new SwingTerminalImplementation

Method Summary

Modifier and Type	Method	Description
SwingTerminalFontConfiguration	getFontConfiguration()	Returns the current font configuration.
protected java.awt.Font	getFontForCharacter(TextCharacter character)	Returning the AWT font to use for the specific character.
protected int	getFontHeight()	Used to find out the font height, in pixels
protected int	getFontWidth()	Used to find out the font width, in pixels
protected int	getHeight()	Used when requiring the total height of the terminal component, in pixels
protected int	getWidth()	Used when requiring the total width of the terminal component, in pixels
protected boolean	isTextAntiAliased()	Returns true if anti-aliasing is enabled, false otherwise
KeyStroke	readInput()	Returns the next Key off the input queue or blocks until one is available.
protected void	repaint()	Called by the GraphicalTerminalImplementation when it would like the OS to schedule a repaint of the window

Methods inherited from class com.googlecode.lanterna.terminal.swing.GraphicalTerminalImplementation

addInput, addResizeListener, bell, clearScreen, close, disableSGR, enableSGR, enquireTerminal, enterPrivateMode, exitPrivateMode, flush, getColorConfiguration, getCursorPosition, getDeviceConfiguration, getPreferredSize, getTerminalSize, newTextGraphics, onCreated, onDestroyed, paintComponent, pollInput, putCharacter, putString, removeResizeListener, resetColorAndSGR, setBackgroundColor, setCursorPosition, setCursorPosition, setCursorVisible, setForegroundColor, startBlinkTimer, stopBlinkTimer

Methods inherited from class java.lang.Object

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

Field Detail

component

private final javax.swing.JComponent component

fontConfiguration

private final SwingTerminalFontConfiguration fontConfiguration

Constructor Detail

SwingTerminalImplementation

SwingTerminalImplementation(javax.swing.JComponent component,
                            SwingTerminalFontConfiguration fontConfiguration,
                            TerminalSize initialTerminalSize,
                            TerminalEmulatorDeviceConfiguration deviceConfiguration,
                            TerminalEmulatorColorConfiguration colorConfiguration,
                            TerminalScrollController scrollController)

Creates a new SwingTerminalImplementation

Parameters:

component - JComponent that is the Swing terminal surface

fontConfiguration - Font configuration to use

initialTerminalSize - Initial size of the terminal

deviceConfiguration - Device configuration

colorConfiguration - Color configuration

scrollController - Controller to be used when inspecting scroll status

Method Detail

getFontConfiguration

public SwingTerminalFontConfiguration getFontConfiguration()

Returns the current font configuration. Note that it is immutable and cannot be changed.

Returns:

This SwingTerminal's current font configuration

getFontHeight

protected int getFontHeight()

Description copied from class: GraphicalTerminalImplementation

Used to find out the font height, in pixels

Specified by:

getFontHeight in class GraphicalTerminalImplementation

Returns:

Terminal font height in pixels

getFontWidth

protected int getFontWidth()

Description copied from class: GraphicalTerminalImplementation

Used to find out the font width, in pixels

Specified by:

getFontWidth in class GraphicalTerminalImplementation

Returns:

Terminal font width in pixels

getHeight

protected int getHeight()

Description copied from class: GraphicalTerminalImplementation

Used when requiring the total height of the terminal component, in pixels

Specified by:

getHeight in class GraphicalTerminalImplementation

Returns:

Height of the terminal component, in pixels

getWidth

protected int getWidth()

Description copied from class: GraphicalTerminalImplementation

Used when requiring the total width of the terminal component, in pixels

Specified by:

getWidth in class GraphicalTerminalImplementation

Returns:

Width of the terminal component, in pixels

getFontForCharacter

protected java.awt.Font getFontForCharacter(TextCharacter character)

Description copied from class: GraphicalTerminalImplementation

Returning the AWT font to use for the specific character. This might not always be the same, in case a we are trying to draw an unusual character (probably CJK) which isn't contained in the standard terminal font.

Specified by:

getFontForCharacter in class GraphicalTerminalImplementation

Parameters:

character - Character to get the font for

Returns:

Font to be used for this character

isTextAntiAliased

protected boolean isTextAntiAliased()

Description copied from class: GraphicalTerminalImplementation

Returns true if anti-aliasing is enabled, false otherwise

Specified by:

isTextAntiAliased in class GraphicalTerminalImplementation

Returns:

true if anti-aliasing is enabled, false otherwise

repaint

protected void repaint()

Description copied from class: GraphicalTerminalImplementation

Called by the GraphicalTerminalImplementation when it would like the OS to schedule a repaint of the window

Specified by:

repaint in class GraphicalTerminalImplementation

readInput

public KeyStroke readInput()

Description copied from interface: InputProvider

Returns the next Key off the input queue or blocks until one is available. NOTE: In previous versions of Lanterna, this method was not blocking. From lanterna 3, it is blocking and you can call pollInput() for the non-blocking version.

Specified by:

readInput in interface InputProvider

Specified by:

readInput in interface IOSafeTerminal

Overrides:

readInput in class GraphicalTerminalImplementation

Returns:

Key object which represents a keystroke coming in through the input stream