2 * Jexer - Java Text User Interface
4 * The MIT License (MIT)
6 * Copyright (C) 2017 Kevin Lamonte
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:
15 * The above copyright notice and this permission notice shall be included in
16 * all copies or substantial portions of the Software.
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.
26 * @author Kevin Lamonte [kevin.lamonte@gmail.com]
29 package jexer
.backend
;
31 import java
.util
.List
;
32 import javax
.swing
.JComponent
;
34 import jexer
.event
.TInputEvent
;
37 * This class uses standard Swing calls to handle screen, keyboard, and mouse
40 public final class SwingBackend
extends GenericBackend
{
43 * Input events are processed by this Terminal.
45 private SwingTerminal terminal
;
48 * Public constructor. The window will be 80x25 with font size 20 pts.
50 * @param listener the object this backend needs to wake up when new
53 public SwingBackend(final Object listener
) {
54 this(listener
, 80, 25, 20);
58 * Public constructor will spawn a new JFrame.
60 * @param listener the object this backend needs to wake up when new
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,
67 public SwingBackend(final Object listener
, final int windowWidth
,
68 final int windowHeight
, final int fontSize
) {
70 // Create a Swing backend using a JFrame
71 terminal
= new SwingTerminal(windowWidth
, windowHeight
, fontSize
,
74 // Hang onto the session info
75 this.sessionInfo
= terminal
.getSessionInfo();
77 // SwingTerminal is the screen too
82 * Public constructor will render onto a JComponent.
84 * @param component the Swing component to render to
85 * @param listener the object this backend needs to wake up when new
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,
92 public SwingBackend(final JComponent component
, final Object listener
,
93 final int windowWidth
, final int windowHeight
, final int fontSize
) {
95 // Create a Swing backend using a JComponent
96 terminal
= new SwingTerminal(component
, windowWidth
, windowHeight
,
99 // Hang onto the session info
100 this.sessionInfo
= terminal
.getSessionInfo();
102 // SwingTerminal is the screen too
107 * Sync the logical screen to the physical device.
110 public void flushScreen() {
111 screen
.flushPhysical();
115 * Get keyboard, mouse, and screen resize events.
117 * @param queue list to append new events to
120 public void getEvents(final List
<TInputEvent
> queue
) {
121 if (terminal
.hasEvents()) {
122 terminal
.getEvents(queue
);
127 * Close the I/O, restore the console, etc.
130 public void shutdown() {
131 terminal
.closeTerminal();
135 * Set the window title.
137 * @param title the new title
140 public void setTitle(final String title
) {
141 screen
.setTitle(title
);
145 * Set listener to a different Object.
147 * @param listener the new listening object that run() wakes up on new
150 public void setListener(final Object listener
) {
151 terminal
.setListener(listener
);