Commit | Line | Data |
---|---|---|
7d4115a5 KL |
1 | Jexer - Java Text User Interface library |
2 | ======================================== | |
3 | ||
30bd4abd KL |
4 | WARNING: THIS IS ALPHA CODE! |
5 | ||
6 | This library is intended to implement a text-based windowing system | |
7 | loosely reminiscient of Borland's [Turbo | |
8 | Vision](http://en.wikipedia.org/wiki/Turbo_Vision) library. For those | |
9 | wishing to use the actual C++ Turbo Vision library, see [Sergio | |
10 | Sigala's updated version](http://tvision.sourceforge.net/) that runs | |
11 | on many more platforms. | |
7d4115a5 | 12 | |
1ac2ccb1 KL |
13 | Two backends are available: |
14 | ||
30bd4abd KL |
15 | * System.in/out to a command-line ECMA-48 / ANSI X3.64 type terminal |
16 | (tested on Linux + xterm). I/O is handled through terminal escape | |
17 | sequences generated by the library itself: ncurses is not required | |
18 | or linked to. xterm mouse tracking using UTF8 coordinates is | |
19 | supported. This is the default backend on non-Windows platforms. | |
1ac2ccb1 | 20 | |
30bd4abd KL |
21 | * Java AWT UI. This backend can be selected by setting |
22 | jexer.AWT=true. This is the default backend on Windows platforms. | |
23 | AWT is VERY experimental, please consider filing bugs when you | |
24 | encounter them. | |
1ac2ccb1 KL |
25 | |
26 | A demo application showing the existing UI controls is available via | |
27 | 'java -jar jexer.jar' or 'java -Djexer.AWT=true -jar jexer.jar' . | |
28 | ||
29 | ||
7d4115a5 KL |
30 | |
31 | License | |
32 | ------- | |
33 | ||
30bd4abd | 34 | This project is licensed LGPL ("GNU Lesser General Public License") |
7d4115a5 KL |
35 | version 3 or greater. See the file LICENSE for the full license text, |
36 | which includes both the GPL v3 and the LGPL supplemental terms. | |
37 | ||
38 | ||
30bd4abd KL |
39 | |
40 | Acknowledgements | |
41 | ---------------- | |
42 | ||
43 | Jexer makes use of the Terminus TrueType font [made available | |
44 | here](http://files.ax86.net/terminus-ttf/) . | |
45 | ||
46 | ||
47 | ||
7d4115a5 KL |
48 | Usage |
49 | ----- | |
50 | ||
30bd4abd KL |
51 | Usage patterns are still being worked on, but in general the goal will |
52 | be to build applications somewhat as follows: | |
7d4115a5 KL |
53 | |
54 | ```Java | |
55 | import jexer.*; | |
56 | ||
57 | public class MyApplication extends TApplication { | |
58 | ||
59 | public MyApplication() { | |
fca67db0 | 60 | super(); |
7d4115a5 | 61 | |
fca67db0 KL |
62 | // Create standard menus for File and Window |
63 | addFileMenu(); | |
64 | addWindowMenu(); | |
7d4115a5 KL |
65 | } |
66 | ||
67 | public static void main(String [] args) { | |
fca67db0 KL |
68 | MyApplication app = new MyApplication(); |
69 | app.run(); | |
7d4115a5 KL |
70 | } |
71 | } | |
72 | ``` | |
73 | ||
87a17f3c | 74 | See the file demos/Demo1.java for detailed examples. |
30bd4abd KL |
75 | |
76 | ||
7d4115a5 KL |
77 | |
78 | Roadmap | |
79 | ------- | |
80 | ||
30d336cc | 81 | Many tasks remain before calling this version 1.0: |
7d4115a5 | 82 | |
7d4115a5 KL |
83 | 0.0.2: |
84 | ||
30bd4abd KL |
85 | - AWT: |
86 | - Blinking cursor | |
30bd4abd | 87 | - Clean up TWidget constuctors (everyone is doing setX() / setY() / set...) |
1ac2ccb1 | 88 | - ECMA48Backend running on socket |
cc99cba8 KL |
89 | - TTreeView |
90 | - TDirectoryList | |
b1b355b8 | 91 | - TFileOpen |
30bd4abd KL |
92 | - Decide on naming convention: getText, getValue, getLabel: one or all |
93 | of them? | |
7d4115a5 KL |
94 | |
95 | 0.0.3: | |
96 | ||
cc99cba8 | 97 | - TEditor |
cc99cba8 KL |
98 | |
99 | 0.0.4: | |
100 | ||
b1b355b8 | 101 | - Bugs |
70f5b2bb | 102 | - Bare ESC isn't being returned immediately |
cc99cba8 | 103 | - TTimer is jittery with I/O |
b1b355b8 | 104 | - TSubMenu keyboard mnemonic not working |
30bd4abd | 105 | - kbDel and use by TMenu (MID_CLEAR) |
cc99cba8 KL |
106 | - TDirectoryList cannot be navigated only with keyboard |
107 | - TTreeView cannot be navigated only with keyboard | |
108 | - RangeViolation after dragging scrollbar up/down | |
9edb442b | 109 | |
cc99cba8 | 110 | 0.1.0: |
9edb442b | 111 | |
cc99cba8 KL |
112 | - TWindow |
113 | - "Smart placement" for new windows | |
7d4115a5 KL |
114 | - ECMATerminal |
115 | - Mouse 1006 mode parsing | |
7d4115a5 KL |
116 | |
117 | Wishlist features (2.0): | |
118 | ||
119 | - TTerminal | |
120 | - Handle resize events (pass to child process) | |
121 | - xterm mouse handling | |
7d4115a5 KL |
122 | - Screen |
123 | - Allow complex characters in putCharXY() and detect them in putStrXY(). | |
124 | - TComboBox | |
125 | - TListBox | |
126 | - TSpinner | |
127 | - TCalendar widget | |
128 | - TColorPicker widget | |
129 | - Drag and drop | |
130 | - TEditor | |
131 | - TField | |
132 | - TText | |
133 | - TTerminal | |
134 | - TComboBox |