Merge branch 'subtree'
[fanfix.git] / src / jexer / backend / SwingBackend.java
CommitLineData
daa4106c 1/*
1ac2ccb1
KL
2 * Jexer - Java Text User Interface
3 *
e16dda65 4 * The MIT License (MIT)
1ac2ccb1 5 *
a69ed767 6 * Copyright (C) 2019 Kevin Lamonte
1ac2ccb1 7 *
e16dda65
KL
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:
1ac2ccb1 14 *
e16dda65
KL
15 * The above copyright notice and this permission notice shall be included in
16 * all copies or substantial portions of the Software.
1ac2ccb1 17 *
e16dda65
KL
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.
1ac2ccb1
KL
25 *
26 * @author Kevin Lamonte [kevin.lamonte@gmail.com]
27 * @version 1
28 */
29package jexer.backend;
30
88a99379 31import java.awt.Font;
42873e30 32import javax.swing.JComponent;
1ac2ccb1 33
1ac2ccb1 34/**
a4406f4e 35 * This class uses standard Swing calls to handle screen, keyboard, and mouse
1ac2ccb1
KL
36 * I/O.
37 */
051e2913 38public class SwingBackend extends GenericBackend {
1ac2ccb1 39
d36057df
KL
40 // ------------------------------------------------------------------------
41 // Constructors -----------------------------------------------------------
42 // ------------------------------------------------------------------------
43
3e074355
KL
44 /**
45 * Public constructor. The window will be 80x25 with font size 20 pts.
46 */
47 public SwingBackend() {
48 this(null, 80, 25, 20);
49 }
50
1ac2ccb1 51 /**
c447c6e5 52 * Public constructor. The window will be 80x25 with font size 20 pts.
92554d64
KL
53 *
54 * @param listener the object this backend needs to wake up when new
55 * input comes in
1ac2ccb1 56 */
a4406f4e 57 public SwingBackend(final Object listener) {
c447c6e5
KL
58 this(listener, 80, 25, 20);
59 }
60
3e074355
KL
61 /**
62 * Public constructor will spawn a new JFrame with font size 20 pts.
63 *
64 * @param windowWidth the number of text columns to start with
65 * @param windowHeight the number of text rows to start with
66 */
67 public SwingBackend(final int windowWidth, final int windowHeight) {
68 this(null, windowWidth, windowHeight, 20);
69 }
70
71 /**
72 * Public constructor will spawn a new JFrame.
73 *
74 * @param windowWidth the number of text columns to start with
75 * @param windowHeight the number of text rows to start with
76 * @param fontSize the size in points. Good values to pick are: 16, 20,
77 * 22, and 24.
78 */
79 public SwingBackend(final int windowWidth, final int windowHeight,
80 final int fontSize) {
81
82 this(null, windowWidth, windowHeight, fontSize);
83 }
84
c447c6e5 85 /**
42873e30 86 * Public constructor will spawn a new JFrame.
c447c6e5
KL
87 *
88 * @param listener the object this backend needs to wake up when new
89 * input comes in
90 * @param windowWidth the number of text columns to start with
91 * @param windowHeight the number of text rows to start with
92 * @param fontSize the size in points. Good values to pick are: 16, 20,
93 * 22, and 24.
94 */
95 public SwingBackend(final Object listener, final int windowWidth,
96 final int windowHeight, final int fontSize) {
97
42873e30
KL
98 // Create a Swing backend using a JFrame
99 terminal = new SwingTerminal(windowWidth, windowHeight, fontSize,
100 listener);
92554d64 101
42873e30 102 // Hang onto the session info
88a99379 103 this.sessionInfo = ((SwingTerminal) terminal).getSessionInfo();
42873e30
KL
104
105 // SwingTerminal is the screen too
88a99379 106 screen = (SwingTerminal) terminal;
42873e30
KL
107 }
108
109 /**
110 * Public constructor will render onto a JComponent.
111 *
112 * @param component the Swing component to render to
113 * @param listener the object this backend needs to wake up when new
114 * input comes in
115 * @param windowWidth the number of text columns to start with
116 * @param windowHeight the number of text rows to start with
117 * @param fontSize the size in points. Good values to pick are: 16, 20,
118 * 22, and 24.
119 */
120 public SwingBackend(final JComponent component, final Object listener,
121 final int windowWidth, final int windowHeight, final int fontSize) {
122
123 // Create a Swing backend using a JComponent
124 terminal = new SwingTerminal(component, windowWidth, windowHeight,
125 fontSize, listener);
92554d64 126
30bd4abd 127 // Hang onto the session info
88a99379 128 this.sessionInfo = ((SwingTerminal) terminal).getSessionInfo();
42873e30
KL
129
130 // SwingTerminal is the screen too
88a99379 131 screen = (SwingTerminal) terminal;
42873e30
KL
132 }
133
d36057df
KL
134 // ------------------------------------------------------------------------
135 // SwingBackend -----------------------------------------------------------
136 // ------------------------------------------------------------------------
137
42873e30 138 /**
88a99379 139 * Set to a new font, and resize the screen to match its dimensions.
42873e30 140 *
88a99379 141 * @param font the new font
42873e30 142 */
88a99379
KL
143 public void setFont(final Font font) {
144 ((SwingTerminal) terminal).setFont(font);
55d2b2c2
KL
145 }
146
be72cb5c
KL
147 /**
148 * Get the number of millis to wait before switching the blink from
149 * visible to invisible.
150 *
151 * @return the number of milli to wait before switching the blink from
152 * visible to invisible
153 */
154 public long getBlinkMillis() {
155 return ((SwingTerminal) terminal).getBlinkMillis();
156 }
157
a2855f1d
KL
158 /**
159 * Getter for the underlying Swing component.
160 *
161 * @return the SwingComponent
162 */
163 public SwingComponent getSwingComponent() {
164 return ((SwingTerminal) terminal).getSwingComponent();
165 }
166
1ac2ccb1 167}