#10 left/center/right/full justified text for TText
[fanfix.git] / src / jexer / TText.java
index e9eb310e0ef1eff9962367fd877089d8b04ea126..21c2f1f1445ed826106061bb47e25e14c3251664 100644 (file)
@@ -1,29 +1,27 @@
 /*
  * Jexer - Java Text User Interface
  *
- * License: LGPLv3 or later
+ * The MIT License (MIT)
  *
- * This module is licensed under the GNU Lesser General Public License
- * Version 3.  Please see the file "COPYING" in this directory for more
- * information about the GNU Lesser General Public License Version 3.
+ * Copyright (C) 2017 Kevin Lamonte
  *
- *     Copyright (C) 2015  Kevin Lamonte
+ * Permission is hereby granted, free of charge, to any person obtaining a
+ * copy of this software and associated documentation files (the "Software"),
+ * to deal in the Software without restriction, including without limitation
+ * the rights to use, copy, modify, merge, publish, distribute, sublicense,
+ * and/or sell copies of the Software, and to permit persons to whom the
+ * Software is furnished to do so, subject to the following conditions:
  *
- * This program is free software; you can redistribute it and/or
- * modify it under the terms of the GNU Lesser General Public License
- * as published by the Free Software Foundation; either version 3 of
- * the License, or (at your option) any later version.
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
  *
- * This program is distributed in the hope that it will be useful, but
- * WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
- * General Public License for more details.
- *
- * You should have received a copy of the GNU Lesser General Public
- * License along with this program; if not, see
- * http://www.gnu.org/licenses/, or write to the Free Software
- * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
- * 02110-1301 USA
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
+ * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+ * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+ * DEALINGS IN THE SOFTWARE.
  *
  * @author Kevin Lamonte [kevin.lamonte@gmail.com]
  * @version 1
@@ -52,6 +50,36 @@ import jexer.event.TMouseEvent;
  */
 public final class TText extends TWidget {
 
+    /**
+     * Available text justifications.
+     */
+    public enum Justification {
+        /**
+         * Left-justified text.
+         */
+        LEFT,
+
+        /**
+         * Centered text.
+         */
+        CENTER,
+
+        /**
+         * Right-justified text.
+         */
+        RIGHT,
+
+        /**
+         * Fully-justified text.
+         */
+        FULL,
+    }
+
+    /**
+     * How to justify the text.
+     */
+    private Justification justification = Justification.LEFT;
+
     /**
      * Text to display.
      */
@@ -90,8 +118,7 @@ public final class TText extends TWidget {
     /**
      * Convenience method used by TWindowLoggerOutput.
      *
-     * @param line
-     *            new line to add
+     * @param line new line to add
      */
     public void addLine(final String line) {
         if (text.length() == 0) {
@@ -132,48 +159,45 @@ public final class TText extends TWidget {
     }
 
     /**
-     * Insert newlines into a string to wrap it to a maximum column. Terminate
-     * the final string with a newline. Note that interior newlines are
-     * converted to spaces.
+     * Set justification.
      *
-     * @param str
-     *            the string
-     * @param n
-     *            the maximum number of characters in a line
-     * @return the wrapped string
+     * @param justification LEFT, CENTER, RIGHT, or FULL
      */
-    private String wrap(final String str, final int n) {
-        assert (n > 0);
-
-        StringBuilder sb = new StringBuilder();
-        StringBuilder word = new StringBuilder();
-        int col = 0;
-        for (int i = 0; i < str.length(); i++) {
-            char ch = str.charAt(i);
-            if (ch == '\n') {
-                ch = ' ';
-            }
-            if (ch == ' ') {
-                sb.append(word.toString());
-                sb.append(ch);
-                if (word.length() >= (n - 1)) {
-                    sb.append('\n');
-                    col = 0;
-                }
-                word = new StringBuilder();
-            } else {
-                word.append(ch);
-            }
+    public void setJustification(final Justification justification) {
+        this.justification = justification;
+        reflow();
+    }
 
-            col++;
-            if (col >= (n - 1)) {
-                sb.append('\n');
-                col = 0;
-            }
-        }
-        sb.append(word.toString());
-        sb.append('\n');
-        return sb.toString();
+    /**
+     * Left-justify the text.
+     */
+    public void leftJustify() {
+        justification = Justification.LEFT;
+        reflow();
+    }
+
+    /**
+     * Center-justify the text.
+     */
+    public void centerJustify() {
+        justification = Justification.CENTER;
+        reflow();
+    }
+
+    /**
+     * Right-justify the text.
+     */
+    public void rightJustify() {
+        justification = Justification.RIGHT;
+        reflow();
+    }
+
+    /**
+     * Fully-justify the text.
+     */
+    public void fullJustify() {
+        justification = Justification.FULL;
+        reflow();
     }
 
     /**
@@ -186,10 +210,25 @@ public final class TText extends TWidget {
         // Break up text into paragraphs
         String[] paragraphs = text.split("\n\n");
         for (String p : paragraphs) {
-            String paragraph = wrap(p, getWidth() - 1);
-            for (String line : paragraph.split("\n")) {
-                lines.add(line);
+            switch (justification) {
+            case LEFT:
+                lines.addAll(jexer.bits.StringJustifier.left(p,
+                        getWidth() - 1));
+                break;
+            case CENTER:
+                lines.addAll(jexer.bits.StringJustifier.center(p,
+                        getWidth() - 1));
+                break;
+            case RIGHT:
+                lines.addAll(jexer.bits.StringJustifier.right(p,
+                        getWidth() - 1));
+                break;
+            case FULL:
+                lines.addAll(jexer.bits.StringJustifier.full(p,
+                        getWidth() - 1));
+                break;
             }
+
             for (int i = 0; i < lineSpacing; i++) {
                 lines.add("");
             }
@@ -223,18 +262,12 @@ public final class TText extends TWidget {
     /**
      * Public constructor.
      *
-     * @param parent
-     *            parent widget
-     * @param text
-     *            text on the screen
-     * @param x
-     *            column relative to parent
-     * @param y
-     *            row relative to parent
-     * @param width
-     *            width of text area
-     * @param height
-     *            height of text area
+     * @param parent parent widget
+     * @param text text on the screen
+     * @param x column relative to parent
+     * @param y row relative to parent
+     * @param width width of text area
+     * @param height height of text area
      */
     public TText(final TWidget parent, final String text, final int x,
             final int y, final int width, final int height) {
@@ -245,21 +278,14 @@ public final class TText extends TWidget {
     /**
      * Public constructor.
      *
-     * @param parent
-     *            parent widget
-     * @param text
-     *            text on the screen
-     * @param x
-     *            column relative to parent
-     * @param y
-     *            row relative to parent
-     * @param width
-     *            width of text area
-     * @param height
-     *            height of text area
-     * @param colorKey
-     *            ColorTheme key color to use for foreground text. Default is
-     *            "ttext"
+     * @param parent parent widget
+     * @param text text on the screen
+     * @param x column relative to parent
+     * @param y row relative to parent
+     * @param width width of text area
+     * @param height height of text area
+     * @param colorKey ColorTheme key color to use for foreground
+     * text. Default is "ttext".
      */
     public TText(final TWidget parent, final String text, final int x,
             final int y, final int width, final int height,
@@ -313,8 +339,7 @@ public final class TText extends TWidget {
     /**
      * Handle mouse press events.
      *
-     * @param mouse
-     *            mouse button press event
+     * @param mouse mouse button press event
      */
     @Override
     public void onMouseDown(final TMouseEvent mouse) {
@@ -334,8 +359,7 @@ public final class TText extends TWidget {
     /**
      * Handle keystrokes.
      *
-     * @param keypress
-     *            keystroke event
+     * @param keypress keystroke event
      */
     @Override
     public void onKeypress(final TKeypressEvent keypress) {