LICENSE CHANGED TO MIT
[nikiroo-utils.git] / src / jexer / TTreeView.java
index 8c710f3e407ef82b6507e8159678661706d0b539..f0480bddd716331a3c8963a344fdaa6ac6264364 100644 (file)
@@ -1,37 +1,33 @@
-/**
+/*
  * 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) 2016 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 jexer.bits.CellAttributes;
-import jexer.bits.GraphicsChars;
 import jexer.event.TKeypressEvent;
 import jexer.event.TMouseEvent;
 import static jexer.TKeypress.*;
@@ -47,9 +43,19 @@ public class TTreeView extends TWidget {
     private TVScroller vScroller;
 
     /**
-     * Horizontal scrollbar.  Note package private access.
+     * Horizontal scrollbar.
      */
-    THScroller hScroller;
+    private THScroller hScroller;
+
+    /**
+     * Get the horizontal scrollbar.  This is used by TTreeItem.draw(), and
+     * potentially subclasses.
+     *
+     * @return the horizontal scrollbar
+     */
+    public final THScroller getHScroller() {
+        return hScroller;
+    }
 
     /**
      * Root of the tree.
@@ -88,7 +94,7 @@ public class TTreeView extends TWidget {
      * If true, move the window to put the selected item in view.  This
      * normally only happens once after setting treeRoot.
      */
-    public boolean centerWindow = false;
+    private boolean centerWindow = false;
 
     /**
      * The action to perform when the user selects an item.
@@ -101,7 +107,9 @@ public class TTreeView extends TWidget {
      * @param treeRoot ultimate root of tree
      * @param centerWindow if true, move the window to put the root in view
      */
-    public void setTreeRoot(final TTreeItem treeRoot, final boolean centerWindow) {
+    public void setTreeRoot(final TTreeItem treeRoot,
+        final boolean centerWindow) {
+
         this.treeRoot = treeRoot;
         this.centerWindow = centerWindow;
     }
@@ -148,11 +156,11 @@ public class TTreeView extends TWidget {
     }
 
     /**
-     * Set the new selected tree view item.  Note package private access.
+     * Set the new selected tree view item.
      *
      * @param item new item that became selected
      */
-    void setSelected(final TTreeItem item) {
+    public void setSelected(final TTreeItem item) {
         if (item != null) {
             item.setSelected(true);
         }
@@ -163,9 +171,9 @@ public class TTreeView extends TWidget {
     }
 
     /**
-     * Perform user selection action.  Note package private access.
+     * Perform user selection action.
      */
-    void dispatch() {
+    public void dispatch() {
         if (action != null) {
             action.DO();
         }
@@ -217,28 +225,33 @@ public class TTreeView extends TWidget {
                 TTreeItem item = (TTreeItem) widget;
                 item.setInvisible(true);
                 item.setEnabled(false);
+                item.keyboardPrevious = null;
+                item.keyboardNext = null;
             }
         }
 
         // Expand the tree into a linear list
         getChildren().clear();
         getChildren().addAll(treeRoot.expandTree("", true));
+
+        // Locate the selected row and maximum line width
         for (TWidget widget: getChildren()) {
             TTreeItem item = (TTreeItem) widget;
 
             if (item == selectedItem) {
                 foundSelectedRow = true;
             }
-            if (foundSelectedRow == false) {
+            if (!foundSelectedRow) {
                 selectedRow++;
             }
 
             int lineWidth = item.getText().length()
-            + item.getPrefix().length() + 4;
+                + item.getPrefix().length() + 4;
             if (lineWidth > maxLineWidth) {
                 maxLineWidth = lineWidth;
             }
         }
+
         if ((centerWindow) && (foundSelectedRow)) {
             if ((selectedRow < vScroller.getValue())
                 || (selectedRow > vScroller.getValue() + getHeight() - 2)
@@ -282,13 +295,24 @@ public class TTreeView extends TWidget {
 
         int begin = vScroller.getValue();
         int topY = 0;
+
+        // As we walk the list we also adjust next/previous pointers,
+        // resulting in a doubly-linked list but only of the expanded items.
+        TTreeItem p = null;
+
         for (int i = 0; i < getChildren().size(); i++) {
             if (!(getChildren().get(i) instanceof TTreeItem)) {
-                // Skip
+                // Skip the scrollbars
                 continue;
             }
             TTreeItem item = (TTreeItem) getChildren().get(i);
 
+            if (p != null) {
+                item.keyboardPrevious = p;
+                p.keyboardNext = item;
+            }
+            p = item;
+
             if (i < begin) {
                 // Render invisible
                 item.setEnabled(false);
@@ -309,6 +333,7 @@ public class TTreeView extends TWidget {
             item.setWidth(getWidth() - 1);
             topY++;
         }
+
     }
 
     /**
@@ -337,7 +362,7 @@ public class TTreeView extends TWidget {
      * @param mouse mouse button release event
      */
     @Override
-    public void onMouseUp(TMouseEvent mouse) {
+    public void onMouseUp(final TMouseEvent mouse) {
         // Pass to children
         super.onMouseDown(mouse);
 
@@ -352,17 +377,35 @@ public class TTreeView extends TWidget {
      */
     @Override
     public void onKeypress(final TKeypressEvent keypress) {
-        if (keypress.equals(kbLeft)) {
+        if (keypress.equals(kbShiftLeft)
+            || keypress.equals(kbCtrlLeft)
+            || keypress.equals(kbAltLeft)
+        ) {
             hScroller.decrement();
-        } else if (keypress.equals(kbRight)) {
+        } else if (keypress.equals(kbShiftRight)
+            || keypress.equals(kbCtrlRight)
+            || keypress.equals(kbAltRight)
+        ) {
             hScroller.increment();
-        } else if (keypress.equals(kbUp)) {
+        } else if (keypress.equals(kbShiftUp)
+            || keypress.equals(kbCtrlUp)
+            || keypress.equals(kbAltUp)
+        ) {
             vScroller.decrement();
-        } else if (keypress.equals(kbDown)) {
+        } else if (keypress.equals(kbShiftDown)
+            || keypress.equals(kbCtrlDown)
+            || keypress.equals(kbAltDown)
+        ) {
             vScroller.increment();
-        } else if (keypress.equals(kbPgUp)) {
+        } else if (keypress.equals(kbShiftPgUp)
+            || keypress.equals(kbCtrlPgUp)
+            || keypress.equals(kbAltPgUp)
+        ) {
             vScroller.bigDecrement();
-        } else if (keypress.equals(kbPgDn)) {
+        } else if (keypress.equals(kbShiftPgDn)
+            || keypress.equals(kbCtrlPgDn)
+            || keypress.equals(kbAltPgDn)
+        ) {
             vScroller.bigIncrement();
         } else if (keypress.equals(kbHome)) {
             vScroller.toTop();
@@ -372,9 +415,42 @@ public class TTreeView extends TWidget {
             if (selectedItem != null) {
                 dispatch();
             }
+        } else if (keypress.equals(kbUp)) {
+            // Select the previous item
+            if (selectedItem != null) {
+                TTreeItem oldItem = selectedItem;
+                if (selectedItem.keyboardPrevious != null) {
+                    setSelected(selectedItem.keyboardPrevious);
+                    if (oldItem.getY() == 0) {
+                        vScroller.decrement();
+                    }
+                }
+            }
+        } else if (keypress.equals(kbDown)) {
+            // Select the next item
+            if (selectedItem != null) {
+                TTreeItem oldItem = selectedItem;
+                if (selectedItem.keyboardNext != null) {
+                    setSelected(selectedItem.keyboardNext);
+                    if (oldItem.getY() == getHeight() - 2) {
+                        vScroller.increment();
+                    }
+                }
+            }
+        } else if (keypress.equals(kbTab)) {
+            getParent().switchWidget(true);
+            return;
+        } else if (keypress.equals(kbShiftTab)
+                || keypress.equals(kbBackTab)) {
+            getParent().switchWidget(false);
+            return;
+        } else if (selectedItem != null) {
+            // Give the TTreeItem a chance to handle arrow keys
+            selectedItem.onKeypress(keypress);
         } else {
-            // Pass other keys (tab etc.) on
+            // Pass other keys (tab etc.) on to TWidget's handler.
             super.onKeypress(keypress);
+            return;
         }
 
         // Update the screen after any thing has expanded/contracted