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
  33 import jexer.event.TInputEvent;
  34 import jexer.io.SwingScreen;
  35 import jexer.io.SwingTerminal;
  36
  37 /**
  38  * This class uses standard Swing calls to handle screen, keyboard, and mouse
  39  * I/O.
  40  */
  41 public final class SwingBackend extends Backend {
  42
  43     /**
  44      * Input events are processed by this Terminal.
  45      */
  46     private SwingTerminal terminal;
  47
  48     /**
  49      * Public constructor.  The window will be 80x25 with font size 20 pts.
  50      *
  51      * @param listener the object this backend needs to wake up when new
  52      * input comes in
  53      */
  54     public SwingBackend(final Object listener) {
  55         this(listener, 80, 25, 20);
  56     }
  57
  58     /**
  59      * Public constructor.
  60      *
  61      * @param listener the object this backend needs to wake up when new
  62      * input comes in
  63      * @param windowWidth the number of text columns to start with
  64      * @param windowHeight the number of text rows to start with
  65      * @param fontSize the size in points.  Good values to pick are: 16, 20,
  66      * 22, and 24.
  67      */
  68     public SwingBackend(final Object listener, final int windowWidth,
  69         final int windowHeight, final int fontSize) {
  70
  71         // Create a screen
  72         SwingScreen screen = new SwingScreen(windowWidth, windowHeight,
  73             fontSize);
  74         this.screen = screen;
  75
  76         // Create the Swing event listeners
  77         terminal = new SwingTerminal(listener, screen);
  78
  79         // Hang onto the session info
  80         this.sessionInfo = terminal.getSessionInfo();
  81     }
  82
  83     /**
  84      * Sync the logical screen to the physical device.
  85      */
  86     @Override
  87     public void flushScreen() {
  88         screen.flushPhysical();
  89     }
  90
  91     /**
  92      * Get keyboard, mouse, and screen resize events.
  93      *
  94      * @param queue list to append new events to
  95      */
  96     @Override
  97     public void getEvents(final List<TInputEvent> queue) {
  98         if (terminal.hasEvents()) {
  99             terminal.getEvents(queue);
 100         }
 101     }
 102
 103     /**
 104      * Close the I/O, restore the console, etc.
 105      */
 106     @Override
 107     public void shutdown() {
 108         ((SwingScreen) screen).shutdown();
 109     }
 110
 111     /**
 112      * Set the window title.
 113      *
 114      * @param title the new title
 115      */
 116     @Override
 117     public void setTitle(final String title) {
 118         ((SwingScreen) screen).setTitle(title);
 119     }
 120
 121 }