-/**
+/*
* Jexer - Java Text User Interface
*
- * License: LGPLv3 or later
- *
- * This module is licensed under the GNU Lesser General Public License
- * Version 3. Please see the file "COPYING" in this directory for more
- * information about the GNU Lesser General Public License Version 3.
+ * The MIT License (MIT)
*
- * Copyright (C) 2015 Kevin Lamonte
+ * Copyright (C) 2019 Kevin Lamonte
*
- * This program 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.
+ * Permission is hereby granted, free of charge, to any person obtaining a
+ * copy of this software and associated documentation files (the "Software"),
+ * to deal in the Software without restriction, including without limitation
+ * the rights to use, copy, modify, merge, publish, distribute, sublicense,
+ * and/or sell copies of the Software, and to permit persons to whom the
+ * Software is furnished to do so, subject to the following conditions:
*
- * 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
- * General Public License for more details.
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
*
- * You should have received a copy of the GNU Lesser General Public
- * License along with this program; if not, see
- * http://www.gnu.org/licenses/, or write to the Free Software
- * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
- * 02110-1301 USA
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
+ * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+ * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+ * DEALINGS IN THE SOFTWARE.
*
* @author Kevin Lamonte [kevin.lamonte@gmail.com]
* @version 1
*/
package jexer.backend;
-import java.util.List;
-
-import jexer.event.TInputEvent;
-import jexer.io.SwingScreen;
-import jexer.io.SwingTerminal;
+import java.awt.Font;
+import javax.swing.JComponent;
/**
* This class uses standard Swing calls to handle screen, keyboard, and mouse
* I/O.
*/
-public final class SwingBackend extends Backend {
+public class SwingBackend extends GenericBackend {
+
+ // ------------------------------------------------------------------------
+ // Constructors -----------------------------------------------------------
+ // ------------------------------------------------------------------------
/**
- * Input events are processed by this Terminal.
+ * Public constructor. The window will be 80x25 with font size 20 pts.
*/
- private SwingTerminal terminal;
+ public SwingBackend() {
+ this(null, 80, 25, 20);
+ }
/**
- * Public constructor.
+ * Public constructor. The window will be 80x25 with font size 20 pts.
*
* @param listener the object this backend needs to wake up when new
* input comes in
*/
public SwingBackend(final Object listener) {
- // Create a screen
- SwingScreen screen = new SwingScreen();
- this.screen = screen;
+ this(listener, 80, 25, 20);
+ }
+
+ /**
+ * Public constructor will spawn a new JFrame with font size 20 pts.
+ *
+ * @param windowWidth the number of text columns to start with
+ * @param windowHeight the number of text rows to start with
+ */
+ public SwingBackend(final int windowWidth, final int windowHeight) {
+ this(null, windowWidth, windowHeight, 20);
+ }
+
+ /**
+ * Public constructor will spawn a new JFrame.
+ *
+ * @param windowWidth the number of text columns to start with
+ * @param windowHeight the number of text rows to start with
+ * @param fontSize the size in points. Good values to pick are: 16, 20,
+ * 22, and 24.
+ */
+ public SwingBackend(final int windowWidth, final int windowHeight,
+ final int fontSize) {
+
+ this(null, windowWidth, windowHeight, fontSize);
+ }
+
+ /**
+ * Public constructor will spawn a new JFrame.
+ *
+ * @param listener the object this backend needs to wake up when new
+ * input comes in
+ * @param windowWidth the number of text columns to start with
+ * @param windowHeight the number of text rows to start with
+ * @param fontSize the size in points. Good values to pick are: 16, 20,
+ * 22, and 24.
+ */
+ public SwingBackend(final Object listener, final int windowWidth,
+ final int windowHeight, final int fontSize) {
- // Create the Swing event listeners
- terminal = new SwingTerminal(listener, screen);
+ // Create a Swing backend using a JFrame
+ terminal = new SwingTerminal(windowWidth, windowHeight, fontSize,
+ listener);
// Hang onto the session info
- this.sessionInfo = terminal.getSessionInfo();
+ this.sessionInfo = ((SwingTerminal) terminal).getSessionInfo();
+
+ // SwingTerminal is the screen too
+ screen = (SwingTerminal) terminal;
}
/**
- * Sync the logical screen to the physical device.
+ * Public constructor will render onto a JComponent.
+ *
+ * @param component the Swing component to render to
+ * @param listener the object this backend needs to wake up when new
+ * input comes in
+ * @param windowWidth the number of text columns to start with
+ * @param windowHeight the number of text rows to start with
+ * @param fontSize the size in points. Good values to pick are: 16, 20,
+ * 22, and 24.
*/
- @Override
- public void flushScreen() {
- screen.flushPhysical();
+ public SwingBackend(final JComponent component, final Object listener,
+ final int windowWidth, final int windowHeight, final int fontSize) {
+
+ // Create a Swing backend using a JComponent
+ terminal = new SwingTerminal(component, windowWidth, windowHeight,
+ fontSize, listener);
+
+ // Hang onto the session info
+ this.sessionInfo = ((SwingTerminal) terminal).getSessionInfo();
+
+ // SwingTerminal is the screen too
+ screen = (SwingTerminal) terminal;
}
+ // ------------------------------------------------------------------------
+ // SwingBackend -----------------------------------------------------------
+ // ------------------------------------------------------------------------
+
/**
- * Get keyboard, mouse, and screen resize events.
+ * Set to a new font, and resize the screen to match its dimensions.
*
- * @param queue list to append new events to
+ * @param font the new font
*/
- @Override
- public void getEvents(final List<TInputEvent> queue) {
- if (terminal.hasEvents()) {
- terminal.getEvents(queue);
- }
+ public void setFont(final Font font) {
+ ((SwingTerminal) terminal).setFont(font);
}
/**
- * Close the I/O, restore the console, etc.
+ * Get the number of millis to wait before switching the blink from
+ * visible to invisible.
+ *
+ * @return the number of milli to wait before switching the blink from
+ * visible to invisible
+ */
+ public long getBlinkMillis() {
+ return ((SwingTerminal) terminal).getBlinkMillis();
+ }
+
+ /**
+ * Getter for the underlying Swing component.
+ *
+ * @return the SwingComponent
*/
- @Override
- public void shutdown() {
- ((SwingScreen) screen).shutdown();
+ public SwingComponent getSwingComponent() {
+ return ((SwingTerminal) terminal).getSwingComponent();
}
}