src/jexer/package-info.java

   1 /*
   2  * Jexer - Java Text User Interface
   3  *
   4  * The MIT License (MIT)
   5  *
   6  * Copyright (C) 2016 Kevin Lamonte
   7  *
   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:
  14  *
  15  * The above copyright notice and this permission notice shall be included in
  16  * all copies or substantial portions of the Software.
  17  *
  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.
  25  *
  26  * @author Kevin Lamonte [kevin.lamonte@gmail.com]
  27  * @version 1
  28  */
  29
  30 /**
  31  * Jexer - Java Text User Interface library
  32  *
  33  * <p>
  34  * This library is currently in design, but when finished it is intended to
  35  * implement a text-based windowing system loosely reminiscient of Borland's
  36  * <a href="http://en.wikipedia.org/wiki/Turbo_Vision">Turbo Vision</a>
  37  * library.
  38  *
  39  * <p>
  40  * The library is currently under initial development, usage patterns are
  41  * still being worked on.  Generally the goal will be to build applications
  42  * somewhat as follows:
  43  *
  44  * <p>
  45  * <pre>
  46  * {@code
  47  * import jexer.*;
  48  *
  49  * public class MyApplication extends TApplication {
  50  *
  51  *     public MyApplication() {
  52  *         super();
  53  *
  54  *         // Create an editor window that has support for copy/paste,
  55  *         // search text, arrow keys, horizontal and vertical scrollbar, etc.
  56  *         addEditor();
  57  *
  58  *         // Create standard menus for File and Window
  59  *         addFileMenu();
  60  *         addWindowMenu();
  61  *     }
  62  *
  63  *     public static void main(String [] args) {
  64  *         MyApplication app = new MyApplication();
  65  *         app.run();
  66  *     }
  67  * }
  68  * }
  69  * </pre>
  70  */
  71 package jexer;