#19 expose home/end for TField
[fanfix.git] / src / jexer / TField.java
index 07a457bcf7eb7beb4e05af9e71f8f782a6cc2227..c93cecbcbf97670babe1d07d26508498467a3030 100644 (file)
@@ -1,29 +1,27 @@
-/**
+/*
  * 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
@@ -55,6 +53,17 @@ public class TField extends TWidget {
         return text;
     }
 
+    /**
+     * Set field text.
+     *
+     * @param text the new field text
+     */
+    public final void setText(String text) {
+        this.text = text;
+        position = 0;
+        windowStart = 0;
+    }
+
     /**
      * If true, only allow enough characters that will fit in the width.  If
      * false, allow the field to scroll to the right.
@@ -201,7 +210,7 @@ public class TField extends TWidget {
             end = text.length();
         }
         getScreen().hLineXY(0, 0, getWidth(), GraphicsChars.HATCH, fieldColor);
-        getScreen().putStrXY(0, 0, text.substring(windowStart, end),
+        getScreen().putStringXY(0, 0, text.substring(windowStart, end),
             fieldColor);
 
         // Fix the cursor, it will be rendered by TApplication.drawAll().
@@ -209,7 +218,8 @@ public class TField extends TWidget {
     }
 
     /**
-     * Update the cursor position.
+     * Update the visible cursor position to match the location of position
+     * and windowStart.
      */
     protected void updateCursor() {
         if ((position > getWidth()) && fixed) {
@@ -221,6 +231,23 @@ public class TField extends TWidget {
         }
     }
 
+    /**
+     * Normalize windowStart such that most of the field data if visible.
+     */
+    protected void normalizeWindowStart() {
+        if (fixed) {
+            // windowStart had better be zero, there is nothing to do here.
+            assert (windowStart == 0);
+            return;
+        }
+        windowStart = position - (getWidth() - 1);
+        if (windowStart < 0) {
+            windowStart = 0;
+        }
+
+        updateCursor();
+    }
+
     /**
      * Handle mouse button presses.
      *
@@ -259,6 +286,7 @@ public class TField extends TWidget {
                     windowStart--;
                 }
             }
+            normalizeWindowStart();
             return;
         }
 
@@ -288,23 +316,12 @@ public class TField extends TWidget {
             return;
         }
         if (keypress.equals(kbHome)) {
-            position = 0;
-            windowStart = 0;
+            home();
             return;
         }
 
         if (keypress.equals(kbEnd)) {
-            position = text.length();
-            if (fixed == true) {
-                if (position >= getWidth()) {
-                    position = text.length() - 1;
-                }
-            } else {
-                windowStart = text.length() - getWidth() + 1;
-                if (windowStart < 0) {
-                    windowStart = 0;
-                }
-            }
+            end();
             return;
         }
 
@@ -313,6 +330,7 @@ public class TField extends TWidget {
                 text = text.substring(0, position)
                         + text.substring(position + 1);
             }
+            dispatch(false);
             return;
         }
 
@@ -330,6 +348,7 @@ public class TField extends TWidget {
                 }
             }
             dispatch(false);
+            normalizeWindowStart();
             return;
         }
 
@@ -437,4 +456,48 @@ public class TField extends TWidget {
         }
     }
 
+    /**
+     * Position the cursor at the first column.  The field may adjust the
+     * window start to show as much of the field as possible.
+     */
+    public void home() {
+        position = 0;
+        windowStart = 0;
+    }
+
+    /**
+     * Set the editing position to the last filled character.  The field may
+     * adjust the window start to show as much of the field as possible.
+     */
+    public void end() {
+        position = text.length();
+        if (fixed == true) {
+            if (position >= getWidth()) {
+                position = text.length() - 1;
+            }
+        } else {
+            windowStart = text.length() - getWidth() + 1;
+            if (windowStart < 0) {
+                windowStart = 0;
+            }
+        }
+    }
+
+    /**
+     * Set the editing position.  The field may adjust the window start to
+     * show as much of the field as possible.
+     *
+     * @param position the new position
+     * @throws IndexOutOfBoundsException if position is outside the range of
+     * the available text
+     */
+    public void setPosition(final int position) {
+        if ((position < 0) || (position >= text.length())) {
+            throw new IndexOutOfBoundsException("Max length is " +
+                text.length() + ", requested position " + position);
+        }
+        this.position = position;
+        normalizeWindowStart();
+    }
+
 }