From 4b257bd88a40bb1b7ad6b14c3ecaf6a3d5d10a9b Mon Sep 17 00:00:00 2001 From: Kevin Lamonte Date: Thu, 2 Apr 2015 09:19:13 -0400 Subject: [PATCH] clean readme --- README.md | 169 ++++++++++++++++++----------- screenshots/readme_application.png | Bin 0 -> 4633 bytes 2 files changed, 105 insertions(+), 64 deletions(-) create mode 100644 screenshots/readme_application.png diff --git a/README.md b/README.md index 31cf523..14eaa40 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,13 @@ Jexer - Java Text User Interface library ======================================== -WARNING: THIS IS ALPHA CODE! PLEASE CONSIDER FILING BUGS AS YOU -ENCOUNTER THEM. +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/) ) -This library is intended to implement a text-based windowing system -loosely reminiscient of Borland's [Turbo -Vision](http://en.wikipedia.org/wiki/Turbo_Vision) library. For those -wishing to use the actual C++ Turbo Vision library, see [Sergio -Sigala's updated version](http://tvision.sourceforge.net/) that runs -on many more platforms. - -Three backends are available: +Jexer currently supports three backends: * System.in/out to a command-line ECMA-48 / ANSI X3.64 type terminal (tested on Linux + xterm). I/O is handled through terminal escape @@ -30,20 +26,6 @@ Three backends are available: which is set in jexer.session.SwingSession. For the demo application, this is the default backend on Windows platforms. -The demo application showing the existing UI controls can be seen in -three ways: - - * 'java -jar jexer.jar' . This will use System.in/out on - non-Windows, or Swing on Windows. - - * 'java -Djexer.Swing=true -jar jexer.jar' . This will always use - Swing. - - * 'java -cp jexer.jar jexer.demos.Demo2 PORT' (where PORT is a - number to run the TCP daemon on). This will use the telnet - protocol to establish an 8-bit clean channel and be aware of - screen size changes. - Additional backends can be created by subclassing jexer.backend.Backend and passing it into the TApplication constructor. @@ -75,30 +57,116 @@ here](http://files.ax86.net/terminus-ttf/) . Usage ----- -Usage patterns are still being worked on, but in general the goal will -be to build applications as follows: +Simply subclass TApplication and then run it in a new thread: ```Java import jexer.*; -public class MyApplication extends TApplication { +class MyApplication extends TApplication { - public MyApplication() { + public MyApplication() throws Exception { super(BackendType.SWING); // Could also use BackendType.XTERM // Create standard menus for File and Window addFileMenu(); addWindowMenu(); + + // Add a custom window, see below for its code. + addWindow(new MyWindow(this)); } public static void main(String [] args) { - MyApplication app = new MyApplication(); - (new Thread(app)).start(); + try { + MyApplication app = new MyApplication(); + (new Thread(app)).start(); + } catch (Throwable t) { + t.printStackTrace(); + } } } ``` -See the files in jexer.demos for more detailed examples. +Similarly, subclass TWindow and add some widgets: + +```Java +class MyWindow extends TWindow { + + public MyWindow(TApplication application) { + // See TWindow's API for several constructors. This one uses the + // application, title, width, and height. Note that the window width + // and height include the borders. The widgets inside the window + // will see (0, 0) as the top-left corner inside the borders, + // i.e. what the window would see as (1, 1). + super(application, "My Window", 30, 20); + + // See TWidget's API for convenience methods to add various kinds of + // widgets. Note that ANY widget can be a container for other + // widgets: TRadioGroup for example has TRadioButtons as child + // widgets. + + // We will add a basic label, text entry field, and button. + addLabel("This is a label", 5, 3); + addField(5, 5, 20, false, "enter text here"); + // For the button, we will pop up a message box if the user presses + // it. + addButton("Press &Me!", 5, 8, new TAction() { + public void DO() { + MyWindow.this.messageBox("Box Title", "You pressed me, yay!"); + } + } ); + } +} +``` + +Put these into a file, compile it with jexer.jar in the classpath, run +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: + + * '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. + + * 'java -Djexer.Swing=true -jar jexer.jar' . This will always use + Swing on any platform. + + * 'java -cp jexer.jar jexer.demos.Demo2 PORT' (where PORT is a + number to run the TCP daemon on). This will use the telnet + protocol to establish an 8-bit clean channel and be aware of + screen size changes. + + + +More Screenshots +---------------- + +![Several Windows Open Including A Terminal](/screenshots/screenshot1.png?raw=true "Several Windows Open Including A Terminal") + +![Yo Dawg...](/screenshots/yodawg.png?raw=true "Yo Dawg, I heard you like text windowing systems, so I ran a text windowing system inside your text windowing system so you can have a terminal in your terminal.") + + + +System Properties +----------------- + +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. + + jexer.Swing.cursorStyle + ----------------------- + + Used by jexer.io.SwingScreen. Selects the cursor style to draw. + Valid values are: underline, block, outline. Default: underline. @@ -148,34 +216,17 @@ ambiguous. This section describes such issues. -System Properties ------------------ - -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. - - jexer.Swing.cursorStyle - ----------------------- - - Used by jexer.io.SwingScreen. Selects the cursor style to draw. - Valid values are: underline, block, outline. Default: underline. - - - Roadmap ------- Many tasks remain before calling this version 1.0: -0.0.3: FINISH PORTING +0.0.3 -0.0.4: NEW STUFF +- TListBox +- TColorPicker + +0.0.4 - TStatusBar - TEditor @@ -190,27 +241,17 @@ Many tasks remain before calling this version 1.0: - TSpinner - TComboBox -- TListBox - TCalendar -- TColorPicker Wishlist features (2.0): - TTerminal - Handle resize events (pass to child process) - Screen - - Allow complex characters in putCharXY() and detect them in putStrXY(). + - Allow complex characters in putCharXY() and detect them in putStringXY(). - Drag and drop - TEditor - TField - TText - TTerminal - TComboBox - - -Screenshots ------------ - -![Several Windows Open Including A Terminal](/screenshots/screenshot1.png?raw=true "Several Windows Open Including A Terminal") - -![Yo Dawg...](/screenshots/yodawg.png?raw=true "Yo Dawg, I heard you like text windowing systems, so I ran a text windowing system inside your text windowing system so you can have a terminal in your terminal.") diff --git a/screenshots/readme_application.png b/screenshots/readme_application.png new file mode 100644 index 0000000000000000000000000000000000000000..6e3eed81efbd2307b74342e2a29ed3eae54456d7 GIT binary patch literal 4633 zcmeHLX;>528jf|X3y8M3v0M}vtbpK+Vq~cWL@I)`fCa-~-B6=&A;xSF>QaMR#A-!F zmRmOzG*iR?!3k6mq(X>jVGtyMNKzOgOB|3Skb5Q(1s;F&{=Cm~;m4fwo#mZxd%tgT ze3P%&w8?WPlSrg#-s?TSA(6%lNTjhF#*GD%EuYO=0UqPR*KS-(B4sB|(SAQ3%>S`{ z{Wlv)B+eod>4&2vk{XD9_=`khEGLoLw~|Pd3nbF4f29=oJA(zQO+Eph;CTc5fd}bE zKtO<2t0mna{iF5SUCn;JwjvV&k|^rkPAGZ(iX; zBAIOV_E;Ohs#7*>h^XIfI)3Zq@vLP@)BmguUOOk6Gqz^J)Fb4|s|h~br_a|m?J>@& zmrK*Hu0MWe;fBvF2YvS`E^w^RQRDJ2zxw)2e0-Vpo%Npbq-!Emx~=1V(O|N|)ou2v zg?|hRbx2}oxjbP;+zH1Xk)5%fQAL)1Q>Mt(39hDQ+!Q6}{!^N?EJA?H*T_NMoR6(!RyHc;clI#re^>A8f#GpF0mOvieBWCsPE z%u4>_m$)98lwNGoUPFu!-t+%-Ans?4?p}?6t*E`BlVdfrgbMDm~3v0IT{NxMdje*kz zclgc`X|i-I@hIBPM+z&cku{fO@?_NU7u2tWPDX+fifM%h|3_`7ekd?QrlT z^h+00ztUgm;#g=`s9W7DAteH?-;UB)wyRX?TzY~PUJ8YE3O6E2*{s;AmlZSyqQPzD z>hDeNObzb8^sT}XjngpU)+FvEI1o~Wuq3o|=zJuIEul4&KS&-u4Hs6%(g{> z0--4|`*u$QdQl#n{Q>sWAX!!6Ykc;_a# zxP!Ma8hU zLYs3A9sfL7`%fB_By^G<4B`3bo{Fq?0jH{XskfQotnf1C%GbBlH}m~lELgTJ-JIV= za$(&)R5DN?;%;7iFYI71wpWl7?Wqv{RE5>d2yK7iG_AIWBD>XF*FT+sK#e>BVOI9Q z{YMG>N|kvErcOW|UEz6tIs4N2tGn{E3nFr3A^A1u$20~Do@fMLn+5aJ39smFDij4t zgf1Q(R^SfX2f&3RO#KlFaORNl2`2`cC!i&8x@pm&h5|>zn>(CAKvYMu2Y#cp?dE9J zNKzC#HWg^4KNX03z|Rf{d1XbDzM5ibc_PHj&OXvi;LMMVlQ z?hRjUcgTc3igQg?hA`&Tu4-sWvRC=UpCuwe=dTF33yPD_+Dfo2{!sMmWP-f{rPVg$ zW`jMBU+pnu&Ihw+J|2-kU}1Oy$%XBjgMrmV$d8bZN-WcN_kT#W4-(%}EKY1uDLt*T z5FIwSKO&dk6_N_0jr667l{l;&@M1VO3w<77oy=xs8MWwKrx>tJbsADg^PwrII?h0M zDeYnk+F5~bVYLV;Yhjh;AEC9v@*g$fgV(w@uSVTuyjHrookHkSj=kch)M+!8*D-bd zm_mBD4lYh)je)D%SmwJ{?s<~BxPpO2ZNHO~-4#-*WJIOG-#JdW00MMCiMArgO#FKL zFelVIdn-y0ovxV(@4N-Ak{3`C2L|j?jJ%mhMC;dd2~8LWN4lX%k^?IhXp)RJZ+{w< z)=5rNXd;S|Y&hl?jxuxBi??&bEJ|pMxlmjeBNIvT=el%&MAlPBd-$Mknf0uP213cJ zbsxbO!^sD*n+`fuwi7a5L-3UCsElyB`L{A_)Txi~S9PB<(?D+TJpErWqk&-yBR2;Q z3%7USFbd3ML?jWJI!q!F?lsQl$Gdn8qhEsGPj-#6$!N*X0S1az=ScA4Nwa%A_Zyo4 zY5=?rWd!%W@OLlV5nRIqp53bfSzs5i z1{dqBq9u2}1;wWC&>L@hXv*8Nr^?-yX;^7f`bzWxW`Vdy8QUzPBrS7^68LT5u_Qn= z7+q&^CM;x{Qq?Vz&5t=;BSqv4dnhbcklx2kxdNgM>TAYT-ds?IGdipmD?mwWIE#i? z;x>u%q{%c$RS*ZyJNrW2k)n#paEo|FhBbX^G3sK@fv)pbF8U(<%Ib^zz%C{{5g4T5 z9y(S+)*D8Zj3O)1BW$InM`^X@w%d8K=^XzUFI#J{tZYZQuA5*}I z5=LDk6=*Hygr>FuM|z6(ElH;?R(%1}isX2LSQaa| z23*sAPg=e#Sz7*3bjoXooB{`MdIP*hbw8t~K94q41b|odsx#@SY0khx_yNTA zz+$DQg$!r30i3zEi*a``?x zjoTQYjDQ*d)O6tt^!8$SqYf$D1>PwJ8SKVzWeDN9#1brTd0ju1Uj^Pk@sdGCF9Hoz zs)8dRSU5dUcqPA!!-K+gPI0j`c+~=_8PPwg)MoG_H*`fUe6RO(&fpPN>~(Zz+0