X-Git-Url: http://git.nikiroo.be/?a=blobdiff_plain;f=README.md;h=7dc0bb4b32ebe78dd9af6f88a7b5310eac880605;hb=e8a11f986bfe2556e450d7b8ad6ef0059b369bbc;hp=7cfe9b4c789a87f547b8926a02ac5a31570ef5af;hpb=1c15371a2d2f702238f51a712643962491fc0793;p=nikiroo-utils.git diff --git a/README.md b/README.md index 7cfe9b4..7dc0bb4 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,10 +24,11 @@ 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 @@ -123,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. @@ -138,6 +141,21 @@ 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. + + * 'java -cp jexer.jar jexer.demos.Demo5' . This demonstrates two + demo applications using different fonts in the same Swing frame. + + * 'java -cp jexer.jar jexer.demos.Demo6' . This demonstrates one + application performing I/O to two screens: an xterm screen and a + Swing screen. + More Screenshots @@ -157,15 +175,26 @@ 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 ----------------------- - Used by jexer.io.SwingScreen. Selects the cursor style to draw. - Valid values are: underline, block, outline. Default: underline. + Used by jexer.backend.SwingTerminal. Selects the cursor style to + draw. Valid values are: underline, block, outline. Default: + underline. + + jexer.Swing.tripleBuffer + ------------------------ + + Used by jexer.backend.SwingTerminal. 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. @@ -176,6 +205,11 @@ Some arbitrary design decisions had to be made when either the obviously expected behavior did not happen or when a specification was ambiguous. This section describes such issues. + - The JVM needs some warmup time to exhibit the true performance + behavior. Drag a window around for a bit to see this: the initial + performance is slow, then the JIT compiler kicks in and Jexer can + be visually competitive with C/C++ curses applications. + - See jexer.tterminal.ECMA48 for more specifics of terminal emulation limitations. @@ -207,9 +241,9 @@ ambiguous. This section describes such issues. check the current window size, performing the same function as ioctl(TIOCGWINSZ) but without requiring a native library. - - 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. + - jexer.backend.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.