Merge branch 'subtree'
[fanfix.git] / src / jexer / TText.java
index 21c2f1f1445ed826106061bb47e25e14c3251664..f6d7febcc0aefdcd159aa3e5af50d72f1631be0f 100644 (file)
@@ -3,7 +3,7 @@
  *
  * The MIT License (MIT)
  *
- * Copyright (C) 2017 Kevin Lamonte
+ * Copyright (C) 2019 Kevin Lamonte
  *
  * Permission is hereby granted, free of charge, to any person obtaining a
  * copy of this software and associated documentation files (the "Software"),
  */
 package jexer;
 
+import java.util.Arrays;
+import java.util.ArrayList;
+import java.util.List;
+
+import jexer.bits.CellAttributes;
+import jexer.bits.StringUtils;
+import jexer.event.TKeypressEvent;
+import jexer.event.TMouseEvent;
 import static jexer.TKeypress.kbDown;
 import static jexer.TKeypress.kbEnd;
 import static jexer.TKeypress.kbHome;
@@ -37,23 +45,26 @@ 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;
-
 /**
  * TText implements a simple scrollable text area. It reflows automatically on
  * resize.
  */
-public final class TText extends TWidget {
+public class TText extends TScrollableWidget {
+
+    // ------------------------------------------------------------------------
+    // Constants --------------------------------------------------------------
+    // ------------------------------------------------------------------------
 
     /**
      * Available text justifications.
      */
     public enum Justification {
+
+        /**
+         * Not justified at all, use spacing as provided by the client.
+         */
+        NONE,
+
         /**
          * Left-justified text.
          */
@@ -75,6 +86,10 @@ public final class TText extends TWidget {
         FULL,
     }
 
+    // ------------------------------------------------------------------------
+    // Variables --------------------------------------------------------------
+    // ------------------------------------------------------------------------
+
     /**
      * How to justify the text.
      */
@@ -95,16 +110,6 @@ public final class TText extends TWidget {
      */
     private String colorKey;
 
-    /**
-     * Vertical scrollbar.
-     */
-    private TVScroller vScroller;
-
-    /**
-     * Horizontal scrollbar.
-     */
-    private THScroller hScroller;
-
     /**
      * Maximum width of a single line.
      */
@@ -115,149 +120,9 @@ public final class TText extends TWidget {
      */
     private int lineSpacing = 1;
 
-    /**
-     * Convenience method used by TWindowLoggerOutput.
-     *
-     * @param line new line to add
-     */
-    public void addLine(final String line) {
-        if (text.length() == 0) {
-            text = line;
-        } else {
-            text += "\n\n";
-            text += line;
-        }
-        reflow();
-    }
-
-    /**
-     * Recompute the bounds for the scrollbars.
-     */
-    private void computeBounds() {
-        maxLineWidth = 0;
-        for (String line : lines) {
-            if (line.length() > maxLineWidth) {
-                maxLineWidth = line.length();
-            }
-        }
-
-        vScroller.setBottomValue((lines.size() - getHeight()) + 1);
-        if (vScroller.getBottomValue() < 0) {
-            vScroller.setBottomValue(0);
-        }
-        if (vScroller.getValue() > vScroller.getBottomValue()) {
-            vScroller.setValue(vScroller.getBottomValue());
-        }
-
-        hScroller.setRightValue((maxLineWidth - getWidth()) + 1);
-        if (hScroller.getRightValue() < 0) {
-            hScroller.setRightValue(0);
-        }
-        if (hScroller.getValue() > hScroller.getRightValue()) {
-            hScroller.setValue(hScroller.getRightValue());
-        }
-    }
-
-    /**
-     * Set justification.
-     *
-     * @param justification LEFT, CENTER, RIGHT, or FULL
-     */
-    public void setJustification(final Justification justification) {
-        this.justification = justification;
-        reflow();
-    }
-
-    /**
-     * 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.
-     */
-    public void reflow() {
-        // Reset the lines
-        lines.clear();
-
-        // Break up text into paragraphs
-        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("");
-            }
-        }
-
-        // Start at the top
-        if (vScroller == null) {
-            vScroller = new TVScroller(this, getWidth() - 1, 0, getHeight() - 1);
-            vScroller.setTopValue(0);
-            vScroller.setValue(0);
-        } else {
-            vScroller.setX(getWidth() - 1);
-            vScroller.setHeight(getHeight() - 1);
-        }
-        vScroller.setBigChange(getHeight() - 1);
-
-        // Start at the left
-        if (hScroller == null) {
-            hScroller = new THScroller(this, 0, getHeight() - 1, getWidth() - 1);
-            hScroller.setLeftValue(0);
-            hScroller.setValue(0);
-        } else {
-            hScroller.setY(getHeight() - 1);
-            hScroller.setWidth(getWidth() - 1);
-        }
-        hScroller.setBigChange(getWidth() - 1);
-
-        computeBounds();
-    }
+    // ------------------------------------------------------------------------
+    // Constructors -----------------------------------------------------------
+    // ------------------------------------------------------------------------
 
     /**
      * Public constructor.
@@ -297,9 +162,50 @@ public final class TText extends TWidget {
         this.text = text;
         this.colorKey = colorKey;
 
-        lines = new LinkedList<String>();
+        lines = new ArrayList<String>();
 
-        reflow();
+        vScroller = new TVScroller(this, getWidth() - 1, 0,
+            Math.max(1, getHeight() - 1));
+        hScroller = new THScroller(this, 0, getHeight() - 1,
+            Math.max(1, getWidth() - 1));
+        reflowData();
+    }
+
+    // ------------------------------------------------------------------------
+    // TScrollableWidget ------------------------------------------------------
+    // ------------------------------------------------------------------------
+
+    /**
+     * Override TWidget's width: we need to set child widget widths.
+     *
+     * @param width new widget width
+     */
+    @Override
+    public void setWidth(final int width) {
+        super.setWidth(width);
+        if (hScroller != null) {
+            hScroller.setWidth(getWidth() - 1);
+        }
+        if (vScroller != null) {
+            vScroller.setX(getWidth() - 1);
+        }
+    }
+
+    /**
+     * Override TWidget's height: we need to set child widget heights.
+     * time.
+     *
+     * @param height new widget height
+     */
+    @Override
+    public void setHeight(final int height) {
+        super.setHeight(height);
+        if (hScroller != null) {
+            hScroller.setY(getHeight() - 1);
+        }
+        if (vScroller != null) {
+            vScroller.setHeight(getHeight() - 1);
+        }
     }
 
     /**
@@ -314,14 +220,15 @@ public final class TText extends TWidget {
         int topY = 0;
         for (int i = begin; i < lines.size(); i++) {
             String line = lines.get(i);
-            if (hScroller.getValue() < line.length()) {
+            if (hScroller.getValue() < StringUtils.width(line)) {
                 line = line.substring(hScroller.getValue());
             } else {
                 line = "";
             }
-            String formatString = "%-" + Integer.toString(getWidth() - 1) + "s";
-            getScreen().putStringXY(0, topY, String.format(formatString, line),
-                    color);
+            if (getWidth() > 3) {
+                String formatString = "%-" + Integer.toString(getWidth() - 1) + "s";
+                putStringXY(0, topY, String.format(formatString, line), color);
+            }
             topY++;
 
             if (topY >= (getHeight() - 1)) {
@@ -331,7 +238,7 @@ public final class TText extends TWidget {
 
         // Pad the rest with blank lines
         for (int i = topY; i < (getHeight() - 1); i++) {
-            getScreen().hLineXY(0, i, getWidth() - 1, ' ', color);
+            hLineXY(0, i, getWidth() - 1, ' ', color);
         }
 
     }
@@ -385,4 +292,162 @@ public final class TText extends TWidget {
         }
     }
 
+    /**
+     * Resize text and scrollbars for a new width/height.
+     */
+    @Override
+    public void reflowData() {
+        // Reset the lines
+        lines.clear();
+
+        // Break up text into paragraphs
+        String[] paragraphs = text.split("\n\n");
+        for (String p : paragraphs) {
+            switch (justification) {
+            case NONE:
+                lines.addAll(Arrays.asList(p.split("\n")));
+                break;
+            case LEFT:
+                lines.addAll(jexer.bits.StringUtils.left(p,
+                        getWidth() - 1));
+                break;
+            case CENTER:
+                lines.addAll(jexer.bits.StringUtils.center(p,
+                        getWidth() - 1));
+                break;
+            case RIGHT:
+                lines.addAll(jexer.bits.StringUtils.right(p,
+                        getWidth() - 1));
+                break;
+            case FULL:
+                lines.addAll(jexer.bits.StringUtils.full(p,
+                        getWidth() - 1));
+                break;
+            }
+
+            for (int i = 0; i < lineSpacing; i++) {
+                lines.add("");
+            }
+        }
+        computeBounds();
+    }
+
+    // ------------------------------------------------------------------------
+    // TText ------------------------------------------------------------------
+    // ------------------------------------------------------------------------
+
+    /**
+     * Set the text.
+     *
+     * @param text new text to display
+     */
+    public void setText(final String text) {
+        this.text = text;
+        reflowData();
+    }
+
+    /**
+     * Get the text.
+     *
+     * @return the text
+     */
+    public String getText() {
+        return text;
+    }
+
+    /**
+     * Convenience method used by TWindowLoggerOutput.
+     *
+     * @param line new line to add
+     */
+    public void addLine(final String line) {
+        if (StringUtils.width(text) == 0) {
+            text = line;
+        } else {
+            text += "\n\n";
+            text += line;
+        }
+        reflowData();
+    }
+
+    /**
+     * Recompute the bounds for the scrollbars.
+     */
+    private void computeBounds() {
+        maxLineWidth = 0;
+        for (String line : lines) {
+            if (StringUtils.width(line) > maxLineWidth) {
+                maxLineWidth = StringUtils.width(line);
+            }
+        }
+
+        vScroller.setTopValue(0);
+        vScroller.setBottomValue((lines.size() - getHeight()) + 1);
+        if (vScroller.getBottomValue() < 0) {
+            vScroller.setBottomValue(0);
+        }
+        if (vScroller.getValue() > vScroller.getBottomValue()) {
+            vScroller.setValue(vScroller.getBottomValue());
+        }
+
+        hScroller.setLeftValue(0);
+        hScroller.setRightValue((maxLineWidth - getWidth()) + 1);
+        if (hScroller.getRightValue() < 0) {
+            hScroller.setRightValue(0);
+        }
+        if (hScroller.getValue() > hScroller.getRightValue()) {
+            hScroller.setValue(hScroller.getRightValue());
+        }
+    }
+
+    /**
+     * Set justification.
+     *
+     * @param justification NONE, LEFT, CENTER, RIGHT, or FULL
+     */
+    public void setJustification(final Justification justification) {
+        this.justification = justification;
+        reflowData();
+    }
+
+    /**
+     * Left-justify the text.
+     */
+    public void leftJustify() {
+        justification = Justification.LEFT;
+        reflowData();
+    }
+
+    /**
+     * Center-justify the text.
+     */
+    public void centerJustify() {
+        justification = Justification.CENTER;
+        reflowData();
+    }
+
+    /**
+     * Right-justify the text.
+     */
+    public void rightJustify() {
+        justification = Justification.RIGHT;
+        reflowData();
+    }
+
+    /**
+     * Fully-justify the text.
+     */
+    public void fullJustify() {
+        justification = Justification.FULL;
+        reflowData();
+    }
+
+    /**
+     * Un-justify the text.
+     */
+    public void unJustify() {
+        justification = Justification.NONE;
+        reflowData();
+    }
+
 }