/*
* Jexer - Java Text User Interface
*
- * License: LGPLv3 or later
+ * The MIT License (MIT)
*
- * 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.
+ * Copyright (C) 2019 Kevin Lamonte
*
- * Copyright (C) 2015 Kevin Lamonte
+ * 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 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.
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
*
- * 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.
- *
- * 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
import jexer.bits.CellAttributes;
import jexer.bits.GraphicsChars;
+import jexer.bits.StringUtils;
/**
* 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;
+ /**
+ * Value that corresponds to 100% progress.
+ */
+ private int maxValue = 100;
+
+ /**
+ * Current value of the progress.
+ */
+ private int value = 0;
+
+ /**
+ * The left border character.
+ */
+ private int leftBorderChar = GraphicsChars.CP437[0xC3];
+
+ /**
+ * The filled-in part of the bar.
+ */
+ private int completedChar = GraphicsChars.BOX;
+
+ /**
+ * The remaining to be filled in part of the bar.
+ */
+ private int remainingChar = GraphicsChars.SINGLE_BAR;
+
+ /**
+ * The right border character.
+ */
+ private int rightBorderChar = GraphicsChars.CP437[0xB4];
+
+ // ------------------------------------------------------------------------
+ // Constructors -----------------------------------------------------------
+ // ------------------------------------------------------------------------
+
+ /**
+ * Public constructor.
+ *
+ * @param parent parent widget
+ * @param x column relative to parent
+ * @param y row relative to parent
+ * @param width width of progress bar
+ * @param value initial value of percent complete
+ */
+ public TProgressBar(final TWidget parent, final int x, final int y,
+ final int width, final int value) {
+
+ // Set parent and window
+ super(parent, false, x, y, width, 1);
+
+ this.value = value;
+ }
+
+ // ------------------------------------------------------------------------
+ // Event handlers ---------------------------------------------------------
+ // ------------------------------------------------------------------------
+
+
+ // ------------------------------------------------------------------------
+ // TWidget ----------------------------------------------------------------
+ // ------------------------------------------------------------------------
+
+ /**
+ * Override TWidget's height: we can only set height at construction
+ * time.
+ *
+ * @param height new widget height (ignored)
+ */
+ @Override
+ public void setHeight(final int height) {
+ // Do nothing
+ }
+
+ /**
+ * Draw a static progress bar.
+ */
+ @Override
+ public void draw() {
+
+ if (getWidth() <= 2) {
+ // Bail out, we are too narrow to draw anything.
+ return;
+ }
+
+ CellAttributes completeColor = getTheme().getColor("tprogressbar.complete");
+ CellAttributes incompleteColor = getTheme().getColor("tprogressbar.incomplete");
+
+ float progress = ((float)value - minValue) / ((float)maxValue - minValue);
+ int progressInt = (int)(progress * 100);
+ int progressUnit = 100 / (getWidth() - 2);
+
+ putCharXY(0, 0, leftBorderChar, incompleteColor);
+ for (int i = StringUtils.width(leftBorderChar); i < getWidth() - 2;) {
+ float iProgress = (float)i / (getWidth() - 2);
+ int iProgressInt = (int)(iProgress * 100);
+ if (iProgressInt <= progressInt - progressUnit) {
+ putCharXY(i, 0, completedChar, completeColor);
+ i += StringUtils.width(completedChar);
+ } else {
+ putCharXY(i, 0, remainingChar, incompleteColor);
+ i += StringUtils.width(remainingChar);
+ }
+ }
+ if (value >= maxValue) {
+ putCharXY(getWidth() - StringUtils.width(leftBorderChar) -
+ StringUtils.width(rightBorderChar), 0, completedChar,
+ completeColor);
+ } else {
+ putCharXY(getWidth() - StringUtils.width(leftBorderChar) -
+ StringUtils.width(rightBorderChar), 0, remainingChar,
+ incompleteColor);
+ }
+ putCharXY(getWidth() - StringUtils.width(rightBorderChar), 0,
+ rightBorderChar, incompleteColor);
+ }
+
+ // ------------------------------------------------------------------------
+ // TProgressBar -----------------------------------------------------------
+ // ------------------------------------------------------------------------
+
/**
* Get the value that corresponds to 0% progress.
*
this.minValue = minValue;
}
- /**
- * Value that corresponds to 100% progress.
- */
- private int maxValue = 100;
-
/**
* Get the value that corresponds to 100% progress.
*
this.maxValue = maxValue;
}
- /**
- * Current value of the progress.
- */
- private int value = 0;
-
/**
* Get the current value of the progress.
*
}
/**
- * Public constructor.
+ * Set the left border character.
*
- * @param parent parent widget
- * @param x column relative to parent
- * @param y row relative to parent
- * @param width width of progress bar
- * @param value initial value of percent complete
+ * @param ch the char to use
*/
- public TProgressBar(final TWidget parent, final int x, final int y,
- final int width, final int value) {
+ public void setLeftBorderChar(final int ch) {
+ leftBorderChar = ch;
+ }
- // Set parent and window
- super(parent, false, x, y, width, 1);
+ /**
+ * Get the left border character.
+ *
+ * @return the char
+ */
+ public int getLeftBorderChar() {
+ return leftBorderChar;
+ }
- this.value = value;
+ /**
+ * Set the filled-in part of the bar.
+ *
+ * @param ch the char to use
+ */
+ public void setCompletedChar(final int ch) {
+ completedChar = ch;
}
/**
- * Draw a static progress bar.
+ * Get the filled-in part of the bar.
+ *
+ * @return the char
*/
- @Override
- public void draw() {
- CellAttributes completeColor = getTheme().getColor("tprogressbar.complete");
- CellAttributes incompleteColor = getTheme().getColor("tprogressbar.incomplete");
+ public int getCompletedChar() {
+ return completedChar;
+ }
- float progress = ((float)value - minValue) / ((float)maxValue - minValue);
- int progressInt = (int)(progress * 100);
- int progressUnit = 100 / (getWidth() - 2);
+ /**
+ * Set the remaining to be filled in part of the bar.
+ *
+ * @param ch the char to use
+ */
+ public void setRemainingChar(final int ch) {
+ remainingChar = ch;
+ }
- getScreen().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);
- } else {
- getScreen().putCharXY(i + 1, 0, GraphicsChars.SINGLE_BAR,
- incompleteColor);
- }
- }
- if (value >= maxValue) {
- getScreen().putCharXY(getWidth() - 2, 0, GraphicsChars.BOX,
- completeColor);
- } else {
- getScreen().putCharXY(getWidth() - 2, 0, GraphicsChars.SINGLE_BAR,
- incompleteColor);
- }
- getScreen().putCharXY(getWidth() - 1, 0, GraphicsChars.CP437[0xB4],
- incompleteColor);
+ /**
+ * Get the remaining to be filled in part of the bar.
+ *
+ * @return the char
+ */
+ public int getRemainingChar() {
+ return remainingChar;
+ }
+
+ /**
+ * Set the right border character.
+ *
+ * @param ch the char to use
+ */
+ public void setRightBorderChar(final int ch) {
+ rightBorderChar = ch;
+ }
+
+ /**
+ * Get the right border character.
+ *
+ * @return the char
+ */
+ public int getRightBorderChar() {
+ return rightBorderChar;
}
}
git://git.nikiroo.be / fanfix.git / blobdiff