#10 left/center/right/full justified text for TText
[fanfix.git] / src / jexer / TText.java
index 6d2fe27faaf6e3ae9652761acd52e9c7ea8d1830..21c2f1f1445ed826106061bb47e25e14c3251664 100644 (file)
@@ -1,48 +1,85 @@
-/**
+/*
  * Jexer - Java Text User Interface
  *
- * License: LGPLv3 or later
- *
- * 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.
+ * The MIT License (MIT)
  *
- *     Copyright (C) 2015  Kevin Lamonte
+ * Copyright (C) 2017 Kevin Lamonte
  *
- * 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.
+ * 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 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.
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
  *
- * 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
  */
 package jexer;
 
+import static jexer.TKeypress.kbDown;
+import static jexer.TKeypress.kbEnd;
+import static jexer.TKeypress.kbHome;
+import static jexer.TKeypress.kbLeft;
+import static jexer.TKeypress.kbPgDn;
+import static jexer.TKeypress.kbPgUp;
+import static jexer.TKeypress.kbRight;
+import static jexer.TKeypress.kbUp;
+
 import java.util.LinkedList;
 import java.util.List;
 
 import jexer.bits.CellAttributes;
 import jexer.event.TKeypressEvent;
 import jexer.event.TMouseEvent;
-import static jexer.TKeypress.*;
 
 /**
- * TText implements a simple text windget.
+ * TText implements a simple scrollable text area. It reflows automatically on
+ * resize.
  */
 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.
      */
@@ -98,13 +135,13 @@ public final class TText extends TWidget {
      */
     private void computeBounds() {
         maxLineWidth = 0;
-        for (String line: lines) {
+        for (String line : lines) {
             if (line.length() > maxLineWidth) {
                 maxLineWidth = line.length();
             }
         }
 
-        vScroller.setBottomValue(lines.size() - getHeight() + 1);
+        vScroller.setBottomValue((lines.size() - getHeight()) + 1);
         if (vScroller.getBottomValue() < 0) {
             vScroller.setBottomValue(0);
         }
@@ -112,7 +149,7 @@ public final class TText extends TWidget {
             vScroller.setValue(vScroller.getBottomValue());
         }
 
-        hScroller.setRightValue(maxLineWidth - getWidth() + 1);
+        hScroller.setRightValue((maxLineWidth - getWidth()) + 1);
         if (hScroller.getRightValue() < 0) {
             hScroller.setRightValue(0);
         }
@@ -122,48 +159,46 @@ 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();
+    }
 
     /**
      * Resize text and scrollbars for a new width/height.
@@ -173,12 +208,27 @@ public final class TText extends TWidget {
         lines.clear();
 
         // 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);
+        String[] paragraphs = text.split("\n\n");
+        for (String p : paragraphs) {
+            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("");
             }
@@ -186,8 +236,7 @@ public final class TText extends TWidget {
 
         // Start at the top
         if (vScroller == null) {
-            vScroller = new TVScroller(this, getWidth() - 1, 0,
-                getHeight() - 1);
+            vScroller = new TVScroller(this, getWidth() - 1, 0, getHeight() - 1);
             vScroller.setTopValue(0);
             vScroller.setValue(0);
         } else {
@@ -198,8 +247,7 @@ public final class TText extends TWidget {
 
         // Start at the left
         if (hScroller == null) {
-            hScroller = new THScroller(this, 0, getHeight() - 1,
-                getWidth() - 1);
+            hScroller = new THScroller(this, 0, getHeight() - 1, getWidth() - 1);
             hScroller.setLeftValue(0);
             hScroller.setValue(0);
         } else {
@@ -222,7 +270,7 @@ public final class TText extends TWidget {
      * @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) {
+            final int y, final int width, final int height) {
 
         this(parent, text, x, y, width, height, "ttext");
     }
@@ -236,11 +284,12 @@ public final class TText extends TWidget {
      * @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 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, final String colorKey) {
+            final int y, final int width, final int height,
+            final String colorKey) {
 
         // Set parent and window
         super(parent, x, y, width, height);
@@ -271,17 +320,17 @@ public final class TText extends TWidget {
                 line = "";
             }
             String formatString = "%-" + Integer.toString(getWidth() - 1) + "s";
-            getScreen().putStrXY(0, topY, String.format(formatString, line),
-                color);
+            getScreen().putStringXY(0, topY, String.format(formatString, line),
+                    color);
             topY++;
 
-            if (topY >= getHeight() - 1) {
+            if (topY >= (getHeight() - 1)) {
                 break;
             }
         }
 
         // Pad the rest with blank lines
-        for (int i = topY; i < getHeight() - 1; i++) {
+        for (int i = topY; i < (getHeight() - 1); i++) {
             getScreen().hLineXY(0, i, getWidth() - 1, ' ', color);
         }
 
@@ -294,11 +343,11 @@ public final class TText extends TWidget {
      */
     @Override
     public void onMouseDown(final TMouseEvent mouse) {
-        if (mouse.getMouseWheelUp()) {
+        if (mouse.isMouseWheelUp()) {
             vScroller.decrement();
             return;
         }
-        if (mouse.getMouseWheelDown()) {
+        if (mouse.isMouseWheelDown()) {
             vScroller.increment();
             return;
         }