Commit | Line | Data |
---|---|---|
daa4106c | 1 | /* |
df8de03f KL |
2 | * Jexer - Java Text User Interface |
3 | * | |
e16dda65 | 4 | * The MIT License (MIT) |
df8de03f | 5 | * |
a2018e99 | 6 | * Copyright (C) 2017 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 | 29 | package jexer.backend; |
df8de03f | 30 | |
42873e30 | 31 | import java.util.List; |
df8de03f | 32 | |
42873e30 | 33 | import 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 | */ | |
40 | public abstract class GenericBackend implements Backend { | |
df8de03f KL |
41 | |
42 | /** | |
42873e30 | 43 | * The session information. |
df8de03f | 44 | */ |
42873e30 | 45 | protected SessionInfo sessionInfo; |
df8de03f KL |
46 | |
47 | /** | |
42873e30 | 48 | * Getter for sessionInfo. |
df8de03f | 49 | * |
42873e30 | 50 | * @return the SessionInfo |
df8de03f | 51 | */ |
42873e30 KL |
52 | public final SessionInfo getSessionInfo() { |
53 | return sessionInfo; | |
df8de03f KL |
54 | } |
55 | ||
56 | /** | |
42873e30 | 57 | * The screen to draw on. |
df8de03f | 58 | */ |
42873e30 | 59 | protected Screen screen; |
df8de03f KL |
60 | |
61 | /** | |
42873e30 | 62 | * Getter for screen. |
df8de03f | 63 | * |
42873e30 | 64 | * @return the Screen |
df8de03f | 65 | */ |
42873e30 KL |
66 | public final Screen getScreen() { |
67 | return screen; | |
df8de03f KL |
68 | } |
69 | ||
70 | /** | |
42873e30 KL |
71 | * Subclasses must provide an implementation that syncs the logical |
72 | * screen to the physical device. | |
df8de03f | 73 | */ |
42873e30 | 74 | public abstract void flushScreen(); |
df8de03f KL |
75 | |
76 | /** | |
42873e30 KL |
77 | * Subclasses must provide an implementation to get keyboard, mouse, and |
78 | * screen resize events. | |
c8496dac | 79 | * |
42873e30 | 80 | * @param queue list to append new events to |
df8de03f | 81 | */ |
42873e30 | 82 | public abstract void getEvents(List<TInputEvent> queue); |
df8de03f KL |
83 | |
84 | /** | |
42873e30 KL |
85 | * Subclasses must provide an implementation that closes sockets, |
86 | * restores console, etc. | |
df8de03f | 87 | */ |
42873e30 | 88 | public abstract void shutdown(); |
c8496dac KL |
89 | |
90 | /** | |
42873e30 KL |
91 | * Subclasses must provide an implementation that sets the window title. |
92 | * | |
93 | * @param title the new title | |
c8496dac | 94 | */ |
42873e30 | 95 | public abstract void setTitle(final String title); |
c8496dac | 96 | |
df8de03f | 97 | } |