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.awt.Font;
  32 import javax.swing.JComponent;
  33
  34 /**
  35  * This class uses standard Swing calls to handle screen, keyboard, and mouse
  36  * I/O.
  37  */
  38 public final class SwingBackend extends GenericBackend {
  39
  40     /**
  41      * Public constructor.  The window will be 80x25 with font size 20 pts.
  42      *
  43      * @param listener the object this backend needs to wake up when new
  44      * input comes in
  45      */
  46     public SwingBackend(final Object listener) {
  47         this(listener, 80, 25, 20);
  48     }
  49
  50     /**
  51      * Public constructor will spawn a new JFrame.
  52      *
  53      * @param listener the object this backend needs to wake up when new
  54      * input comes in
  55      * @param windowWidth the number of text columns to start with
  56      * @param windowHeight the number of text rows to start with
  57      * @param fontSize the size in points.  Good values to pick are: 16, 20,
  58      * 22, and 24.
  59      */
  60     public SwingBackend(final Object listener, final int windowWidth,
  61         final int windowHeight, final int fontSize) {
  62
  63         // Create a Swing backend using a JFrame
  64         terminal = new SwingTerminal(windowWidth, windowHeight, fontSize,
  65             listener);
  66
  67         // Hang onto the session info
  68         this.sessionInfo = ((SwingTerminal) terminal).getSessionInfo();
  69
  70         // SwingTerminal is the screen too
  71         screen = (SwingTerminal) terminal;
  72     }
  73
  74     /**
  75      * Public constructor will render onto a JComponent.
  76      *
  77      * @param component the Swing component to render to
  78      * @param listener the object this backend needs to wake up when new
  79      * input comes in
  80      * @param windowWidth the number of text columns to start with
  81      * @param windowHeight the number of text rows to start with
  82      * @param fontSize the size in points.  Good values to pick are: 16, 20,
  83      * 22, and 24.
  84      */
  85     public SwingBackend(final JComponent component, final Object listener,
  86         final int windowWidth, final int windowHeight, final int fontSize) {
  87
  88         // Create a Swing backend using a JComponent
  89         terminal = new SwingTerminal(component, windowWidth, windowHeight,
  90             fontSize, listener);
  91
  92         // Hang onto the session info
  93         this.sessionInfo = ((SwingTerminal) terminal).getSessionInfo();
  94
  95         // SwingTerminal is the screen too
  96         screen = (SwingTerminal) terminal;
  97     }
  98
  99     /**
 100      * Set to a new font, and resize the screen to match its dimensions.
 101      *
 102      * @param font the new font
 103      */
 104     public void setFont(final Font font) {
 105         ((SwingTerminal) terminal).setFont(font);
 106     }
 107
 108 }