X-Git-Url: http://git.nikiroo.be/?a=blobdiff_plain;f=README.md;h=b4114f32a3186cd50900758933aa8c14fedb8957;hb=42873e30bf487bc0b695d60652dba44f82185dbb;hp=22436558fb3f653491423ec7a26bb600fb3855aa;hpb=2ce6dab2bbd951e6d0f09f94759efda5ee4b65ac;p=fanfix.git diff --git a/README.md b/README.md index 2243655..b4114f3 100644 --- a/README.md +++ b/README.md @@ -4,8 +4,10 @@ Jexer - Java Text User Interface library This library implements a text-based windowing system reminiscient of Borland's [Turbo Vision](http://en.wikipedia.org/wiki/Turbo_Vision) system. (For those wishing to use the actual C++ Turbo Vision -library, see [Sergio Sigala's C++ version based on the public domain -sources released by Borland.](http://tvision.sourceforge.net/) ) +library, see [Sergio Sigala's C++ version based on the sources +released by Borland,](http://tvision.sourceforge.net/) or consider +Free Pascal's [Free Vision +library.](http://wiki.freepascal.org/Free_Vision)) Jexer currently supports three backends: @@ -22,15 +24,20 @@ Jexer currently supports three backends: TCP socket. jexer.demos.Demo3 demonstrates how one might use a character encoding than the default UTF-8. -* Java Swing UI. This backend can be selected by setting - jexer.Swing=true. The default window size for Swing is 80x25, which - is set in jexer.session.SwingSession. For the demo application, - this is the default backend on Windows and Mac platforms. +* Java Swing UI. The default window size for Swing is 80x25 and 20 + point font; this can be changed in the TApplication(BackendType) + constructor. For the demo applications, this is the default backend + on Windows and Mac platforms. This backend can be explicitly + selected for the demo applications by setting jexer.Swing=true. Additional backends can be created by subclassing jexer.backend.Backend and passing it into the TApplication constructor. +The Jexer homepage, which includes additional information and binary +release downloads, is at: https://jexer.sourceforge.io . The Jexer +source code is hosted at: https://github.com/klamonte/jexer . + License @@ -119,12 +126,12 @@ it and you'll see an application like this: ![The Example Code Above](/screenshots/readme_application.png?raw=true "The application in the text of README.md") See the files in jexer.demos for many more detailed examples showing -all of the existing UI controls. The demo can be run in three -different ways: +all of the existing UI controls. The available demos can be run as +follows: * 'java -jar jexer.jar' . This will use System.in/out with - xterm-like sequences on non-Windows platforms. On Windows it will - use a Swing JFrame. + xterm-like sequences on non-Windows non-Mac platforms. On Windows + and Mac it will use a Swing JFrame. * 'java -Djexer.Swing=true -jar jexer.jar' . This will always use Swing on any platform. @@ -134,6 +141,14 @@ different ways: protocol to establish an 8-bit clean channel and be aware of screen size changes. + * 'java -cp jexer.jar jexer.demos.Demo3' . This will use + System.in/out with xterm-like sequences. One can see in the code + how to pass a different InputReader and OutputReader to + TApplication, permitting a different encoding than UTF-8. + + * 'java -cp jexer.jar jexer.demos.Demo4' . This demonstrates hidden + windows and a custom TDesktop. + More Screenshots @@ -153,9 +168,10 @@ The following properties control features of Jexer: jexer.Swing ----------- - Used only by jexer.demos.Demo1. If true, use the Swing interface - for the demo application. Default: true on Windows platforms - (os.name starts with "Windows"), false on non-Windows platforms. + Used only by jexer.demos.Demo1 and jexer.demos.Demo4. If true, use + the Swing interface for the demo application. Default: true on + Windows (os.name starts with "Windows") and Mac (os.name starts with + "Mac"), false on non-Windows and non-Mac platforms. jexer.Swing.cursorStyle ----------------------- @@ -163,6 +179,15 @@ The following properties control features of Jexer: Used by jexer.io.SwingScreen. Selects the cursor style to draw. Valid values are: underline, block, outline. Default: underline. + jexer.Swing.tripleBuffer + ------------------------ + + Used by jexer.io.SwingScreen. If true, use triple-buffering which + reduces screen tearing but may also be slower to draw on slower + systems. If false, use naive Swing thread drawing, which may be + faster on slower systems but also more likely to have screen + tearing. Default: true. + Known Issues / Arbitrary Decisions @@ -205,7 +230,7 @@ ambiguous. This section describes such issues. - jexer.io.ECMA48Terminal calls 'stty' to perform the equivalent of cfmakeraw() when using System.in/out. System.out is also - (blindly!) put in 'stty sane cooked' mode when exiting. + (blindly!) put in 'stty sane cooked' mode when exiting.