Fix comment
[fanfix.git] / src / jexer / backend / Backend.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
KL
28 */
29package jexer.backend;
30
b1589621 31import java.util.List;
05dbb28d 32
df8de03f 33import jexer.event.TInputEvent;
df8de03f
KL
34
35/**
42873e30
KL
36 * This interface provides a screen, keyboard, and mouse to TApplication. It
37 * also exposes session information as gleaned from lower levels of the
38 * communication stack.
df8de03f 39 */
42873e30 40public interface Backend {
df8de03f
KL
41
42 /**
42873e30
KL
43 * Get a SessionInfo, which exposes text width/height, language,
44 * username, and other information from the communication stack.
7b5261bc
KL
45 *
46 * @return the SessionInfo
47 */
42873e30 48 public SessionInfo getSessionInfo();
df8de03f
KL
49
50 /**
42873e30 51 * Get a Screen, which displays the text cells to the user.
7b5261bc
KL
52 *
53 * @return the Screen
df8de03f 54 */
42873e30 55 public Screen getScreen();
df8de03f
KL
56
57 /**
42873e30
KL
58 * Classes must provide an implementation that syncs the logical screen
59 * to the physical device.
df8de03f 60 */
42873e30 61 public void flushScreen();
df8de03f 62
d36057df
KL
63 /**
64 * Check if there are events in the queue.
65 *
66 * @return if true, getEvents() has something to return to the application
67 */
68 public boolean hasEvents();
69
df8de03f 70 /**
42873e30 71 * Classes must provide an implementation to get keyboard, mouse, and
df8de03f
KL
72 * screen resize events.
73 *
623a1bd1 74 * @param queue list to append new events to
df8de03f 75 */
42873e30 76 public void getEvents(List<TInputEvent> queue);
df8de03f
KL
77
78 /**
42873e30
KL
79 * Classes must provide an implementation that closes sockets, restores
80 * console, etc.
df8de03f 81 */
42873e30 82 public void shutdown();
df8de03f 83
55d2b2c2 84 /**
42873e30 85 * Classes must provide an implementation that sets the window title.
55d2b2c2
KL
86 *
87 * @param title the new title
88 */
42873e30 89 public void setTitle(final String title);
55d2b2c2 90
88a99379
KL
91 /**
92 * Set listener to a different Object.
93 *
94 * @param listener the new listening object that run() wakes up on new
95 * input
96 */
97 public void setListener(final Object listener);
98
e23ea538
KL
99 /**
100 * Reload backend options from System properties.
101 */
102 public void reloadOptions();
103
df8de03f 104}