LICENSE CHANGED TO MIT
[nikiroo-utils.git] / src / jexer / TDirectoryTreeItem.java
index 01c9b46a4170dad07854cc65898d46e80511d712..0066e49356c3806c1af8f68a59c419001e631a39 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) 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
@@ -42,51 +40,60 @@ import java.util.LinkedList;
 public class TDirectoryTreeItem extends TTreeItem {
 
     /**
-     * Directory entry corresponding to this list item.
+     * File corresponding to this list item.
+     */
+    private File file;
+
+    /**
+     * Get the File corresponding to this list item.
+     *
+     * @return the File
      */
-    File dir;
+    public final File getFile() {
+        return file;
+    }
 
     /**
      * Called when this item is expanded or collapsed.  this.expanded will be
      * true if this item was just expanded from a mouse click or keypress.
      */
     @Override
-    public void onExpand() {
-        // System.err.printf("onExpand() %s\n", dir);
+    public final void onExpand() {
+        // System.err.printf("onExpand() %s\n", file);
 
-        if (dir == null) {
+        if (file == null) {
             return;
         }
         getChildren().clear();
 
         // Make sure we can read it before trying to.
-        if (dir.canRead()) {
+        if (file.canRead()) {
             setSelectable(true);
         } else {
             setSelectable(false);
         }
-        assert (dir.isDirectory());
+        assert (file.isDirectory());
         setExpandable(true);
 
-        if ((isExpanded() == false) || (isExpandable() == false)) {
+        if (!isExpanded() || !isExpandable()) {
             getTreeView().reflow();
             return;
         }
 
-        for (File file: dir.listFiles()) {
+        for (File f: file.listFiles()) {
             // System.err.printf("   -> file %s %s\n", file, file.getName());
 
-            if (file.getName().startsWith(".")) {
+            if (f.getName().startsWith(".")) {
                 // Hide dot-files
                 continue;
             }
-            if (!file.isDirectory()) {
+            if (!f.isDirectory()) {
                 continue;
             }
 
             try {
                 TDirectoryTreeItem item = new TDirectoryTreeItem(getTreeView(),
-                    file.getCanonicalPath(), false, false);
+                    f.getCanonicalPath(), false, false);
 
                 item.level = this.level + 1;
                 getChildren().add(item);
@@ -109,7 +116,9 @@ public class TDirectoryTreeItem extends TTreeItem {
      * @throws IllegalArgumentException if this function is called
      */
     @Override
-    public final TTreeItem addChild(final String text, final boolean expanded) {
+    public final TTreeItem addChild(final String text,
+        final boolean expanded) throws IllegalArgumentException {
+
         throw new IllegalArgumentException("Do not call addChild(), use onExpand() instead");
     }
 
@@ -118,6 +127,7 @@ public class TDirectoryTreeItem extends TTreeItem {
      *
      * @param view root TTreeView
      * @param text text for this item
+     * @throws IOException if a java.io operation throws
      */
     public TDirectoryTreeItem(final TTreeView view,
         final String text) throws IOException {
@@ -131,6 +141,7 @@ public class TDirectoryTreeItem extends TTreeItem {
      * @param view root TTreeView
      * @param text text for this item
      * @param expanded if true, have it expanded immediately
+     * @throws IOException if a java.io operation throws
      */
     public TDirectoryTreeItem(final TTreeView view, final String text,
         final boolean expanded) throws IOException {
@@ -146,58 +157,59 @@ public class TDirectoryTreeItem extends TTreeItem {
      * @param expanded if true, have it expanded immediately
      * @param openParents if true, expand all paths up the root path and
      * return the root path entry
+     * @throws IOException if a java.io operation throws
      */
     public TDirectoryTreeItem(final TTreeView view, final String text,
         final boolean expanded, final boolean openParents) throws IOException {
 
         super(view, text, false);
 
-        List<String> parentPaths = new LinkedList<String>();
+        List<String> parentFiles = new LinkedList<String>();
         boolean oldExpanded = expanded;
 
         // Convert to canonical path
-        File rootPath = new File(text);
-        rootPath = rootPath.getCanonicalFile();
+        File rootFile = new File(text);
+        rootFile = rootFile.getCanonicalFile();
 
-        if (openParents == true) {
+        if (openParents) {
             setExpanded(true);
 
             // Go up the directory tree
-            File parent = rootPath.getParentFile();
+            File parent = rootFile.getParentFile();
             while (parent != null) {
-                parentPaths.add(rootPath.getName());
-                rootPath = rootPath.getParentFile();
-                parent = rootPath.getParentFile();
+                parentFiles.add(rootFile.getName());
+                rootFile = rootFile.getParentFile();
+                parent = rootFile.getParentFile();
             }
         }
-        dir = rootPath;
-        if (rootPath.getParentFile() == null) {
+        file = rootFile;
+        if (rootFile.getParentFile() == null) {
             // This is a filesystem root, use its full name
-            setText(rootPath.getCanonicalPath());
+            setText(rootFile.getCanonicalPath());
         } else {
             // This is a relative path.  We got here because openParents was
             // false.
-            assert (openParents == false);
-            setText(rootPath.getName());
+            assert (!openParents);
+            setText(rootFile.getName());
         }
         onExpand();
 
-        if (openParents == true) {
-            TDirectoryTreeItem childPath = this;
-            Collections.reverse(parentPaths);
-            for (String p: parentPaths) {
-                for (TWidget widget: childPath.getChildren()) {
+        if (openParents) {
+            TDirectoryTreeItem childFile = this;
+            Collections.reverse(parentFiles);
+            for (String p: parentFiles) {
+                for (TWidget widget: childFile.getChildren()) {
                     TDirectoryTreeItem child = (TDirectoryTreeItem) widget;
                     if (child.getText().equals(p)) {
-                        childPath = child;
-                        childPath.setExpanded(true);
-                        childPath.onExpand();
+                        childFile = child;
+                        childFile.setExpanded(true);
+                        childFile.onExpand();
                         break;
                     }
                 }
             }
             unselect();
-            getTreeView().setSelected(childPath);
+            getTreeView().setSelected(childFile);
             setExpanded(oldExpanded);
         }
         getTreeView().reflow();