#19 TField fixes
[fanfix.git] / src / jexer / backend / SwingBackend.java
... / ...
CommitLineData
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 */
29package jexer.backend;
30
31import java.awt.Font;
32import javax.swing.JComponent;
33
34/**
35 * This class uses standard Swing calls to handle screen, keyboard, and mouse
36 * I/O.
37 */
38public final class SwingBackend extends GenericBackend {
39
40 /**
41 * Public constructor. The window will be 80x25 with font size 20 pts.
42 */
43 public SwingBackend() {
44 this(null, 80, 25, 20);
45 }
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 with font size 20 pts.
59 *
60 * @param windowWidth the number of text columns to start with
61 * @param windowHeight the number of text rows to start with
62 */
63 public SwingBackend(final int windowWidth, final int windowHeight) {
64 this(null, windowWidth, windowHeight, 20);
65 }
66
67 /**
68 * Public constructor will spawn a new JFrame.
69 *
70 * @param windowWidth the number of text columns to start with
71 * @param windowHeight the number of text rows to start with
72 * @param fontSize the size in points. Good values to pick are: 16, 20,
73 * 22, and 24.
74 */
75 public SwingBackend(final int windowWidth, final int windowHeight,
76 final int fontSize) {
77
78 this(null, windowWidth, windowHeight, fontSize);
79 }
80
81 /**
82 * Public constructor will spawn a new JFrame.
83 *
84 * @param listener the object this backend needs to wake up when new
85 * input comes in
86 * @param windowWidth the number of text columns to start with
87 * @param windowHeight the number of text rows to start with
88 * @param fontSize the size in points. Good values to pick are: 16, 20,
89 * 22, and 24.
90 */
91 public SwingBackend(final Object listener, final int windowWidth,
92 final int windowHeight, final int fontSize) {
93
94 // Create a Swing backend using a JFrame
95 terminal = new SwingTerminal(windowWidth, windowHeight, fontSize,
96 listener);
97
98 // Hang onto the session info
99 this.sessionInfo = ((SwingTerminal) terminal).getSessionInfo();
100
101 // SwingTerminal is the screen too
102 screen = (SwingTerminal) terminal;
103 }
104
105 /**
106 * Public constructor will render onto a JComponent.
107 *
108 * @param component the Swing component to render to
109 * @param listener the object this backend needs to wake up when new
110 * input comes in
111 * @param windowWidth the number of text columns to start with
112 * @param windowHeight the number of text rows to start with
113 * @param fontSize the size in points. Good values to pick are: 16, 20,
114 * 22, and 24.
115 */
116 public SwingBackend(final JComponent component, final Object listener,
117 final int windowWidth, final int windowHeight, final int fontSize) {
118
119 // Create a Swing backend using a JComponent
120 terminal = new SwingTerminal(component, windowWidth, windowHeight,
121 fontSize, listener);
122
123 // Hang onto the session info
124 this.sessionInfo = ((SwingTerminal) terminal).getSessionInfo();
125
126 // SwingTerminal is the screen too
127 screen = (SwingTerminal) terminal;
128 }
129
130 /**
131 * Set to a new font, and resize the screen to match its dimensions.
132 *
133 * @param font the new font
134 */
135 public void setFont(final Font font) {
136 ((SwingTerminal) terminal).setFont(font);
137 }
138
139 /**
140 * Get the number of millis to wait before switching the blink from
141 * visible to invisible.
142 *
143 * @return the number of milli to wait before switching the blink from
144 * visible to invisible
145 */
146 public long getBlinkMillis() {
147 return ((SwingTerminal) terminal).getBlinkMillis();
148 }
149
150}