Prep for 2019 release
[fanfix.git] / src / jexer / TProgressBar.java
index 1cd950c9babed03fdbcfa1c013b00ec8215f2aaf..b144fd2757fddda34aa620698e40c3eed3bba2da 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) 2019 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
@@ -36,76 +34,30 @@ import jexer.bits.GraphicsChars;
 /**
  * TProgressBar implements a simple progress bar.
  */
-public final class TProgressBar extends TWidget {
+public class TProgressBar extends TWidget {
+
+    // ------------------------------------------------------------------------
+    // Variables --------------------------------------------------------------
+    // ------------------------------------------------------------------------
 
     /**
      * Value that corresponds to 0% progress.
      */
     private int minValue = 0;
 
-    /**
-     * Get the value that corresponds to 0% progress.
-     *
-     * @return the value that corresponds to 0% progress
-     */
-    public int getMinValue() {
-        return minValue;
-    }
-
-    /**
-     * Set the value that corresponds to 0% progress.
-     *
-     * @param minValue the value that corresponds to 0% progress
-     */
-    public void setMinValue(final int minValue) {
-        this.minValue = minValue;
-    }
-
     /**
      * Value that corresponds to 100% progress.
      */
     private int maxValue = 100;
 
-    /**
-     * Get the value that corresponds to 100% progress.
-     *
-     * @return the value that corresponds to 100% progress
-     */
-    public int getMaxValue() {
-        return maxValue;
-    }
-
-    /**
-     * Set the value that corresponds to 100% progress.
-     *
-     * @param maxValue the value that corresponds to 100% progress
-     */
-    public void setMaxValue(final int maxValue) {
-        this.maxValue = maxValue;
-    }
-
     /**
      * Current value of the progress.
      */
     private int value = 0;
 
-    /**
-     * Get the current value of the progress.
-     *
-     * @return the current value of the progress
-     */
-    public int getValue() {
-        return value;
-    }
-
-    /**
-     * Set the current value of the progress.
-     *
-     * @param value the current value of the progress
-     */
-    public void setValue(final int value) {
-        this.value = value;
-    }
+    // ------------------------------------------------------------------------
+    // Constructors -----------------------------------------------------------
+    // ------------------------------------------------------------------------
 
     /**
      * Public constructor.
@@ -120,15 +72,20 @@ public final class TProgressBar extends TWidget {
         final int width, final int value) {
 
         // Set parent and window
-        super(parent, false);
+        super(parent, false, x, y, width, 1);
 
-        setX(x);
-        setY(y);
-        setHeight(1);
-        setWidth(width);
         this.value = value;
     }
 
+    // ------------------------------------------------------------------------
+    // Event handlers ---------------------------------------------------------
+    // ------------------------------------------------------------------------
+
+
+    // ------------------------------------------------------------------------
+    // TWidget ----------------------------------------------------------------
+    // ------------------------------------------------------------------------
+
     /**
      * Draw a static progress bar.
      */
@@ -141,27 +98,82 @@ public final class TProgressBar extends TWidget {
         int progressInt = (int)(progress * 100);
         int progressUnit = 100 / (getWidth() - 2);
 
-        getScreen().putCharXY(0, 0, GraphicsChars.CP437[0xC3], incompleteColor);
+        putCharXY(0, 0, GraphicsChars.CP437[0xC3], incompleteColor);
         for (int i = 0; i < getWidth() - 2; i++) {
             float iProgress = (float)i / (getWidth() - 2);
             int iProgressInt = (int)(iProgress * 100);
             if (iProgressInt <= progressInt - progressUnit) {
-                getScreen().putCharXY(i + 1, 0, GraphicsChars.BOX,
-                    completeColor);
+                putCharXY(i + 1, 0, GraphicsChars.BOX, completeColor);
             } else {
-                getScreen().putCharXY(i + 1, 0, GraphicsChars.SINGLE_BAR,
-                    incompleteColor);
+                putCharXY(i + 1, 0, GraphicsChars.SINGLE_BAR, incompleteColor);
             }
         }
         if (value >= maxValue) {
-            getScreen().putCharXY(getWidth() - 2, 0, GraphicsChars.BOX,
-                completeColor);
+            putCharXY(getWidth() - 2, 0, GraphicsChars.BOX, completeColor);
         } else {
-            getScreen().putCharXY(getWidth() - 2, 0, GraphicsChars.SINGLE_BAR,
+            putCharXY(getWidth() - 2, 0, GraphicsChars.SINGLE_BAR,
                 incompleteColor);
         }
-        getScreen().putCharXY(getWidth() - 1, 0, GraphicsChars.CP437[0xB4],
+        putCharXY(getWidth() - 1, 0, GraphicsChars.CP437[0xB4],
             incompleteColor);
     }
 
+    // ------------------------------------------------------------------------
+    // TProgressBar -----------------------------------------------------------
+    // ------------------------------------------------------------------------
+
+    /**
+     * Get the value that corresponds to 0% progress.
+     *
+     * @return the value that corresponds to 0% progress
+     */
+    public int getMinValue() {
+        return minValue;
+    }
+
+    /**
+     * Set the value that corresponds to 0% progress.
+     *
+     * @param minValue the value that corresponds to 0% progress
+     */
+    public void setMinValue(final int minValue) {
+        this.minValue = minValue;
+    }
+
+    /**
+     * Get the value that corresponds to 100% progress.
+     *
+     * @return the value that corresponds to 100% progress
+     */
+    public int getMaxValue() {
+        return maxValue;
+    }
+
+    /**
+     * Set the value that corresponds to 100% progress.
+     *
+     * @param maxValue the value that corresponds to 100% progress
+     */
+    public void setMaxValue(final int maxValue) {
+        this.maxValue = maxValue;
+    }
+
+    /**
+     * Get the current value of the progress.
+     *
+     * @return the current value of the progress
+     */
+    public int getValue() {
+        return value;
+    }
+
+    /**
+     * Set the current value of the progress.
+     *
+     * @param value the current value of the progress
+     */
+    public void setValue(final int value) {
+        this.value = value;
+    }
+
 }