com.googlecode.lanterna.terminal.swing.AWTTerminalFrame Maven / Gradle / Ivy
Show all versions of lanterna Show documentation
/*
* This file is part of lanterna (http://code.google.com/p/lanterna/).
*
* lanterna is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this program. If not, see Please note that this is the AWT version and there is a Swing counterpart: {@link SwingTerminalFrame}
* @see AWTTerminal
* @see SwingTerminalFrame
* @author martin
*/
@SuppressWarnings("serial")
public class AWTTerminalFrame extends Frame implements IOSafeTerminal {
private final AWTTerminal awtTerminal;
private final EnumSet autoCloseTriggers;
private boolean disposed;
/**
* Creates a new AWTTerminalFrame with an optional list of auto-close triggers
* @param autoCloseTriggers What to trigger automatic disposal of the Frame
*/
@SuppressWarnings({"SameParameterValue", "WeakerAccess"})
public AWTTerminalFrame(TerminalEmulatorAutoCloseTrigger... autoCloseTriggers) {
this("AwtTerminalFrame", autoCloseTriggers);
}
/**
* Creates a new AWTTerminalFrame with a given window title and an optional list of auto-close triggers
* @param title Title to use for the window
* @param autoCloseTriggers What to trigger automatic disposal of the Frame
*/
@SuppressWarnings("WeakerAccess")
public AWTTerminalFrame(String title, TerminalEmulatorAutoCloseTrigger... autoCloseTriggers) throws HeadlessException {
this(title, new AWTTerminal(), autoCloseTriggers);
}
/**
* Creates a new AWTTerminalFrame using a specified title and a series of AWT terminal configuration objects
* @param title What title to use for the window
* @param deviceConfiguration Device configuration for the embedded AWTTerminal
* @param fontConfiguration Font configuration for the embedded AWTTerminal
* @param colorConfiguration Color configuration for the embedded AWTTerminal
* @param autoCloseTriggers What to trigger automatic disposal of the Frame
*/
public AWTTerminalFrame(String title,
TerminalEmulatorDeviceConfiguration deviceConfiguration,
AWTTerminalFontConfiguration fontConfiguration,
TerminalEmulatorColorConfiguration colorConfiguration,
TerminalEmulatorAutoCloseTrigger... autoCloseTriggers) {
this(title, null, deviceConfiguration, fontConfiguration, colorConfiguration, autoCloseTriggers);
}
/**
* Creates a new AWTTerminalFrame using a specified title and a series of AWT terminal configuration objects
* @param title What title to use for the window
* @param terminalSize Initial size of the terminal, in rows and columns. If null, it will default to 80x25.
* @param deviceConfiguration Device configuration for the embedded AWTTerminal
* @param fontConfiguration Font configuration for the embedded AWTTerminal
* @param colorConfiguration Color configuration for the embedded AWTTerminal
* @param autoCloseTriggers What to trigger automatic disposal of the Frame
*/
public AWTTerminalFrame(String title,
TerminalSize terminalSize,
TerminalEmulatorDeviceConfiguration deviceConfiguration,
AWTTerminalFontConfiguration fontConfiguration,
TerminalEmulatorColorConfiguration colorConfiguration,
TerminalEmulatorAutoCloseTrigger... autoCloseTriggers) {
this(title,
new AWTTerminal(terminalSize, deviceConfiguration, fontConfiguration, colorConfiguration),
autoCloseTriggers);
}
private AWTTerminalFrame(String title, AWTTerminal awtTerminal, TerminalEmulatorAutoCloseTrigger... autoCloseTrigger) {
super(title != null ? title : "AWTTerminalFrame");
this.awtTerminal = awtTerminal;
this.autoCloseTriggers = EnumSet.copyOf(Arrays.asList(autoCloseTrigger));
this.disposed = false;
setLayout(new BorderLayout());
add(awtTerminal, BorderLayout.CENTER);
setBackground(Color.BLACK); //This will reduce white flicker when resizing the window
pack();
//Put input focus on the terminal component by default
awtTerminal.requestFocusInWindow();
}
/**
* Returns the current font configuration. Note that it is immutable and cannot be changed.
* @return This {@link AWTTerminalFrame}'s current font configuration
*/
public AWTTerminalFontConfiguration getFontConfiguration() {
return awtTerminal.getFontConfiguration();
}
/**
* Returns this terminal emulator's color configuration. Note that it is immutable and cannot be changed.
* @return This {@link AWTTerminalFrame}'s color configuration
*/
public TerminalEmulatorColorConfiguration getColorConfiguration() {
return awtTerminal.getColorConfiguration();
}
/**
* Returns this terminal emulator's device configuration. Note that it is immutable and cannot be changed.
* @return This {@link AWTTerminalFrame}'s device configuration
*/
public TerminalEmulatorDeviceConfiguration getDeviceConfiguration() {
return awtTerminal.getDeviceConfiguration();
}
/**
* Returns the auto-close triggers used by the AWTTerminalFrame
* @return Current auto-close trigger
*/
public Set getAutoCloseTrigger() {
return EnumSet.copyOf(autoCloseTriggers);
}
/**
* Changes the current auto-close trigger used by this AWTTerminalFrame
* @param autoCloseTrigger New auto-close trigger to use
* @deprecated Use
*/
@Deprecated
public void setAutoCloseTrigger(TerminalEmulatorAutoCloseTrigger autoCloseTrigger) {
this.autoCloseTriggers.clear();
this.autoCloseTriggers.add(autoCloseTrigger);
}
public void addAutoCloseTrigger(TerminalEmulatorAutoCloseTrigger autoCloseTrigger) {
autoCloseTriggers.add(autoCloseTrigger);
}
@Override
public void dispose() {
super.dispose();
disposed = true;
}
@Override
public void close() {
dispose();
}
/**
* Takes a KeyStroke and puts it on the input queue of the terminal emulator. This way you can insert synthetic
* input events to be processed as if they came from the user typing on the keyboard.
* @param keyStroke Key stroke input event to put on the queue
*/
public void addInput(KeyStroke keyStroke) {
awtTerminal.addInput(keyStroke);
}
///////////
// Delegate all Terminal interface implementations to AWTTerminal
///////////
@Override
public KeyStroke pollInput() {
if(disposed) {
return new KeyStroke(KeyType.EOF);
}
KeyStroke keyStroke = awtTerminal.pollInput();
if(autoCloseTriggers.contains(TerminalEmulatorAutoCloseTrigger.CloseOnEscape) &&
keyStroke != null &&
keyStroke.getKeyType() == KeyType.Escape) {
dispose();
}
return keyStroke;
}
@Override
public KeyStroke readInput() {
return awtTerminal.readInput();
}
@Override
public void enterPrivateMode() {
awtTerminal.enterPrivateMode();
}
@Override
public void exitPrivateMode() {
awtTerminal.exitPrivateMode();
if(autoCloseTriggers.contains(TerminalEmulatorAutoCloseTrigger.CloseOnExitPrivateMode)) {
dispose();
}
}
@Override
public void clearScreen() {
awtTerminal.clearScreen();
}
@Override
public void setCursorPosition(int x, int y) {
awtTerminal.setCursorPosition(x, y);
}
@Override
public void setCursorPosition(TerminalPosition position) {
awtTerminal.setCursorPosition(position);
}
@Override
public TerminalPosition getCursorPosition() {
return awtTerminal.getCursorPosition();
}
@Override
public void setCursorVisible(boolean visible) {
awtTerminal.setCursorVisible(visible);
}
@Override
public void putCharacter(char c) {
awtTerminal.putCharacter(c);
}
@Override
public TextGraphics newTextGraphics() {
return awtTerminal.newTextGraphics();
}
@Override
public void enableSGR(SGR sgr) {
awtTerminal.enableSGR(sgr);
}
@Override
public void disableSGR(SGR sgr) {
awtTerminal.disableSGR(sgr);
}
@Override
public void resetColorAndSGR() {
awtTerminal.resetColorAndSGR();
}
@Override
public void setForegroundColor(TextColor color) {
awtTerminal.setForegroundColor(color);
}
@Override
public void setBackgroundColor(TextColor color) {
awtTerminal.setBackgroundColor(color);
}
@Override
public TerminalSize getTerminalSize() {
return awtTerminal.getTerminalSize();
}
@Override
public byte[] enquireTerminal(int timeout, TimeUnit timeoutUnit) {
return awtTerminal.enquireTerminal(timeout, timeoutUnit);
}
@Override
public void bell() {
awtTerminal.bell();
}
@Override
public void flush() {
awtTerminal.flush();
}
@Override
public void addResizeListener(TerminalResizeListener listener) {
awtTerminal.addResizeListener(listener);
}
@Override
public void removeResizeListener(TerminalResizeListener listener) {
awtTerminal.removeResizeListener(listener);
}
}