src/jexer/backend/SwingBackend.java

   1 /*
   2  * Jexer - Java Text User Interface
   3  *
   4  * The MIT License (MIT)
   5  *
   6  * Copyright (C) 2017 Kevin Lamonte
   7  *
   8  * Permission is hereby granted, free of charge, to any person obtaining a
   9  * copy of this software and associated documentation files (the "Software"),
  10  * to deal in the Software without restriction, including without limitation
  11  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
  12  * and/or sell copies of the Software, and to permit persons to whom the
  13  * Software is furnished to do so, subject to the following conditions:
  14  *
  15  * The above copyright notice and this permission notice shall be included in
  16  * all copies or substantial portions of the Software.
  17  *
  18  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  19  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  20  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
  21  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  22  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  23  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  24  * DEALINGS IN THE SOFTWARE.
  25  *
  26  * @author Kevin Lamonte [kevin.lamonte@gmail.com]
  27  * @version 1
  28  */
  29 package jexer.backend;
  30
  31 import java.util.List;
  32 import javax.swing.JComponent;
  33
  34 import jexer.event.TInputEvent;
  35
  36 /**
  37  * This class uses standard Swing calls to handle screen, keyboard, and mouse
  38  * I/O.
  39  */
  40 public final class SwingBackend extends GenericBackend {
  41
  42     /**
  43      * Input events are processed by this Terminal.
  44      */
  45     private SwingTerminal terminal;
  46
  47     /**
  48      * Public constructor.  The window will be 80x25 with font size 20 pts.
  49      *
  50      * @param listener the object this backend needs to wake up when new
  51      * input comes in
  52      */
  53     public SwingBackend(final Object listener) {
  54         this(listener, 80, 25, 20);
  55     }
  56
  57     /**
  58      * Public constructor will spawn a new JFrame.
  59      *
  60      * @param listener the object this backend needs to wake up when new
  61      * input comes in
  62      * @param windowWidth the number of text columns to start with
  63      * @param windowHeight the number of text rows to start with
  64      * @param fontSize the size in points.  Good values to pick are: 16, 20,
  65      * 22, and 24.
  66      */
  67     public SwingBackend(final Object listener, final int windowWidth,
  68         final int windowHeight, final int fontSize) {
  69
  70         // Create a Swing backend using a JFrame
  71         terminal = new SwingTerminal(windowWidth, windowHeight, fontSize,
  72             listener);
  73
  74         // Hang onto the session info
  75         this.sessionInfo = terminal.getSessionInfo();
  76
  77         // SwingTerminal is the screen too
  78         screen = terminal;
  79     }
  80
  81     /**
  82      * Public constructor will render onto a JComponent.
  83      *
  84      * @param component the Swing component to render to
  85      * @param listener the object this backend needs to wake up when new
  86      * input comes in
  87      * @param windowWidth the number of text columns to start with
  88      * @param windowHeight the number of text rows to start with
  89      * @param fontSize the size in points.  Good values to pick are: 16, 20,
  90      * 22, and 24.
  91      */
  92     public SwingBackend(final JComponent component, final Object listener,
  93         final int windowWidth, final int windowHeight, final int fontSize) {
  94
  95         // Create a Swing backend using a JComponent
  96         terminal = new SwingTerminal(component, windowWidth, windowHeight,
  97             fontSize, listener);
  98
  99         // Hang onto the session info
 100         this.sessionInfo = terminal.getSessionInfo();
 101
 102         // SwingTerminal is the screen too
 103         screen = terminal;
 104     }
 105
 106     /**
 107      * Sync the logical screen to the physical device.
 108      */
 109     @Override
 110     public void flushScreen() {
 111         screen.flushPhysical();
 112     }
 113
 114     /**
 115      * Get keyboard, mouse, and screen resize events.
 116      *
 117      * @param queue list to append new events to
 118      */
 119     @Override
 120     public void getEvents(final List<TInputEvent> queue) {
 121         if (terminal.hasEvents()) {
 122             terminal.getEvents(queue);
 123         }
 124     }
 125
 126     /**
 127      * Close the I/O, restore the console, etc.
 128      */
 129     @Override
 130     public void shutdown() {
 131         terminal.closeTerminal();
 132     }
 133
 134     /**
 135      * Set the window title.
 136      *
 137      * @param title the new title
 138      */
 139     @Override
 140     public void setTitle(final String title) {
 141         screen.setTitle(title);
 142     }
 143
 144     /**
 145      * Set listener to a different Object.
 146      *
 147      * @param listener the new listening object that run() wakes up on new
 148      * input
 149      */
 150     public void setListener(final Object listener) {
 151         terminal.setListener(listener);
 152     }
 153
 154 }