Fix comment
[fanfix.git] / src / jexer / backend / GenericBackend.java
CommitLineData
daa4106c 1/*
df8de03f
KL
2 * Jexer - Java Text User Interface
3 *
e16dda65 4 * The MIT License (MIT)
df8de03f 5 *
a69ed767 6 * Copyright (C) 2019 Kevin Lamonte
df8de03f 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:
df8de03f 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.
df8de03f 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.
7b5261bc
KL
25 *
26 * @author Kevin Lamonte [kevin.lamonte@gmail.com]
27 * @version 1
df8de03f 28 */
42873e30 29package jexer.backend;
df8de03f 30
42873e30 31import java.util.List;
df8de03f 32
42873e30 33import jexer.event.TInputEvent;
df8de03f 34
42873e30
KL
35/**
36 * This abstract class provides a screen, keyboard, and mouse to
37 * TApplication. It also exposes session information as gleaned from lower
38 * levels of the communication stack.
39 */
40public abstract class GenericBackend implements Backend {
df8de03f 41
d36057df
KL
42 // ------------------------------------------------------------------------
43 // Variables --------------------------------------------------------------
44 // ------------------------------------------------------------------------
45
df8de03f 46 /**
42873e30 47 * The session information.
df8de03f 48 */
42873e30 49 protected SessionInfo sessionInfo;
df8de03f 50
d36057df
KL
51 /**
52 * The screen to draw on.
53 */
54 protected Screen screen;
55
56 /**
57 * Input events are processed by this Terminal.
58 */
59 protected TerminalReader terminal;
60
61 // ------------------------------------------------------------------------
62 // Constructors -----------------------------------------------------------
63 // ------------------------------------------------------------------------
64
65 // ------------------------------------------------------------------------
66 // Backend ----------------------------------------------------------------
67 // ------------------------------------------------------------------------
68
df8de03f 69 /**
42873e30 70 * Getter for sessionInfo.
df8de03f 71 *
42873e30 72 * @return the SessionInfo
df8de03f 73 */
42873e30
KL
74 public final SessionInfo getSessionInfo() {
75 return sessionInfo;
df8de03f
KL
76 }
77
df8de03f 78 /**
42873e30 79 * Getter for screen.
df8de03f 80 *
42873e30 81 * @return the Screen
df8de03f 82 */
42873e30
KL
83 public final Screen getScreen() {
84 return screen;
df8de03f
KL
85 }
86
87 /**
88a99379 88 * Sync the logical screen to the physical device.
df8de03f 89 */
88a99379
KL
90 public void flushScreen() {
91 screen.flushPhysical();
92 }
93
94 /**
d36057df
KL
95 * Check if there are events in the queue.
96 *
97 * @return if true, getEvents() has something to return to the application
88a99379 98 */
d36057df
KL
99 public boolean hasEvents() {
100 return terminal.hasEvents();
101 }
df8de03f
KL
102
103 /**
88a99379 104 * Get keyboard, mouse, and screen resize events.
c8496dac 105 *
42873e30 106 * @param queue list to append new events to
df8de03f 107 */
88a99379
KL
108 public void getEvents(final List<TInputEvent> queue) {
109 if (terminal.hasEvents()) {
110 terminal.getEvents(queue);
111 }
112 }
df8de03f
KL
113
114 /**
88a99379 115 * Close the I/O, restore the console, etc.
df8de03f 116 */
88a99379
KL
117 public void shutdown() {
118 terminal.closeTerminal();
119 }
c8496dac
KL
120
121 /**
88a99379 122 * Set the window title.
42873e30
KL
123 *
124 * @param title the new title
c8496dac 125 */
88a99379
KL
126 public void setTitle(final String title) {
127 screen.setTitle(title);
128 }
129
130 /**
131 * Set listener to a different Object.
132 *
133 * @param listener the new listening object that run() wakes up on new
134 * input
135 */
136 public void setListener(final Object listener) {
137 terminal.setListener(listener);
138 }
c8496dac 139
e23ea538
KL
140 /**
141 * Reload backend options from System properties.
142 */
143 public void reloadOptions() {
144 terminal.reloadOptions();
145 }
146
df8de03f 147}