X-Git-Url: http://git.nikiroo.be/?a=blobdiff_plain;f=src%2Fjexer%2FTField.java;h=992f274fb388792c1ed76c5e33bcc6a4472cb6a8;hb=2b4274048c2f409b5eba8373ab3018aa75911c73;hp=14e93e78c0d34585e40bcda850451a7a9b1e3902;hpb=128e5be1ffb65d047d8461ea1cfb65c22686ec91;p=fanfix.git diff --git a/src/jexer/TField.java b/src/jexer/TField.java index 14e93e7..992f274 100644 --- a/src/jexer/TField.java +++ b/src/jexer/TField.java @@ -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 @@ -37,59 +35,73 @@ import jexer.event.TMouseEvent; import static jexer.TKeypress.*; /** - * + * TField implements an editable text field. */ -public final class TField extends TWidget { +public class TField extends TWidget { + + // ------------------------------------------------------------------------ + // Variables -------------------------------------------------------------- + // ------------------------------------------------------------------------ /** - * Field text. + * Background character for unfilled-in text. */ - private String text = ""; + protected char backgroundChar = GraphicsChars.HATCH; /** - * Get field text. - * - * @return field text + * Field text. */ - public String getText() { - return text; - } + protected String text = ""; /** * If true, only allow enough characters that will fit in the width. If * false, allow the field to scroll to the right. */ - private boolean fixed = false; + protected boolean fixed = false; /** * Current editing position within text. */ - private int position = 0; + protected int position = 0; /** * Beginning of visible portion. */ - private int windowStart = 0; + protected int windowStart = 0; /** * If true, new characters are inserted at position. */ - private boolean insertMode = true; + protected boolean insertMode = true; /** * Remember mouse state. */ - private TMouseEvent mouse; + protected TMouseEvent mouse; /** * The action to perform when the user presses enter. */ - private TAction enterAction; + protected TAction enterAction; /** * The action to perform when the text is updated. */ - private TAction updateAction; + protected TAction updateAction; + + /** + * The color to use when this field is active. + */ + private String activeColorKey = "tfield.active"; + + /** + * The color to use when this field is not active. + */ + private String inactiveColorKey = "tfield.inactive"; + + // ------------------------------------------------------------------------ + // Constructors ----------------------------------------------------------- + // ------------------------------------------------------------------------ /** * Public constructor. @@ -139,25 +151,25 @@ public final class TField extends TWidget { final TAction enterAction, final TAction updateAction) { // Set parent and window - super(parent); - setX(x); - setY(y); - setHeight(1); - setWidth(width); - setHasCursor(true); + super(parent, x, y, width, 1); + setCursorVisible(true); this.fixed = fixed; this.text = text; this.enterAction = enterAction; this.updateAction = updateAction; } + // ------------------------------------------------------------------------ + // Event handlers --------------------------------------------------------- + // ------------------------------------------------------------------------ + /** * Returns true if the mouse is currently on the field. * * @return if true the mouse is currently on the field */ - private boolean mouseOnField() { + protected boolean mouseOnField() { int rightEdge = getWidth() - 1; if ((mouse != null) && (mouse.getY() == 0) @@ -169,62 +181,6 @@ public final class TField extends TWidget { return false; } - /** - * Dispatch to the action function. - * - * @param enter if true, the user pressed Enter, else this was an update - * to the text. - */ - private void dispatch(final boolean enter) { - if (enter) { - if (enterAction != null) { - enterAction.DO(); - } - } else { - if (updateAction != null) { - updateAction.DO(); - } - } - } - - /** - * Draw the text field. - */ - @Override - public void draw() { - CellAttributes fieldColor; - - if (getAbsoluteActive()) { - fieldColor = getTheme().getColor("tfield.active"); - } else { - fieldColor = getTheme().getColor("tfield.inactive"); - } - - int end = windowStart + getWidth(); - if (end > text.length()) { - end = text.length(); - } - getScreen().hLineXY(0, 0, getWidth(), GraphicsChars.HATCH, fieldColor); - getScreen().putStrXY(0, 0, text.substring(windowStart, end), - fieldColor); - - // Fix the cursor, it will be rendered by TApplication.drawAll(). - updateCursor(); - } - - /** - * Update the cursor position. - */ - private void updateCursor() { - if ((position > getWidth()) && fixed) { - setCursorX(getWidth()); - } else if ((position - windowStart == getWidth()) && !fixed) { - setCursorX(getWidth() - 1); - } else { - setCursorX(position - windowStart); - } - } - /** * Handle mouse button presses. * @@ -234,7 +190,7 @@ public final class TField extends TWidget { public void onMouseDown(final TMouseEvent mouse) { this.mouse = mouse; - if ((mouseOnField()) && (mouse.getMouse1())) { + if ((mouseOnField()) && (mouse.isMouse1())) { // Move cursor int deltaX = mouse.getX() - getCursorX(); position += deltaX; @@ -263,6 +219,7 @@ public final class TField extends TWidget { windowStart--; } } + normalizeWindowStart(); return; } @@ -292,23 +249,12 @@ public final 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; } @@ -317,6 +263,7 @@ public final class TField extends TWidget { text = text.substring(0, position) + text.substring(position + 1); } + dispatch(false); return; } @@ -334,19 +281,20 @@ public final class TField extends TWidget { } } dispatch(false); + normalizeWindowStart(); return; } - if (!keypress.getKey().getIsKey() - && !keypress.getKey().getAlt() - && !keypress.getKey().getCtrl() + if (!keypress.getKey().isFnKey() + && !keypress.getKey().isAlt() + && !keypress.getKey().isCtrl() ) { // Plain old keystroke, process it if ((position == text.length()) && (text.length() < getWidth())) { // Append case - appendChar(keypress.getKey().getCh()); + appendChar(keypress.getKey().getChar()); } else if ((position < text.length()) && (text.length() < getWidth())) { @@ -354,12 +302,12 @@ public final class TField extends TWidget { if (insertMode == false) { // Replace character text = text.substring(0, position) - + keypress.getKey().getCh() + + keypress.getKey().getChar() + text.substring(position + 1); position++; } else { // Insert character - insertChar(keypress.getKey().getCh()); + insertChar(keypress.getKey().getChar()); } } else if ((position < text.length()) && (text.length() >= getWidth())) { @@ -370,7 +318,7 @@ public final class TField extends TWidget { } else if ((fixed == true) && (insertMode == false)) { // Overwrite the last character, maybe move position text = text.substring(0, position) - + keypress.getKey().getCh() + + keypress.getKey().getChar() + text.substring(position + 1); if (position < getWidth() - 1) { position++; @@ -378,23 +326,23 @@ public final class TField extends TWidget { } else if ((fixed == false) && (insertMode == false)) { // Overwrite the last character, definitely move position text = text.substring(0, position) - + keypress.getKey().getCh() + + keypress.getKey().getChar() + text.substring(position + 1); position++; } else { if (position == text.length()) { // Append this character - appendChar(keypress.getKey().getCh()); + appendChar(keypress.getKey().getChar()); } else { // Insert this character - insertChar(keypress.getKey().getCh()); + insertChar(keypress.getKey().getChar()); } } } else { assert (!fixed); // Append this character - appendChar(keypress.getKey().getCh()); + appendChar(keypress.getKey().getChar()); } dispatch(false); return; @@ -404,12 +352,132 @@ public final class TField extends TWidget { super.onKeypress(keypress); } + // ------------------------------------------------------------------------ + // TWidget ---------------------------------------------------------------- + // ------------------------------------------------------------------------ + + /** + * Draw the text field. + */ + @Override + public void draw() { + CellAttributes fieldColor; + + if (isAbsoluteActive()) { + fieldColor = getTheme().getColor(activeColorKey); + } else { + fieldColor = getTheme().getColor(inactiveColorKey); + } + + int end = windowStart + getWidth(); + if (end > text.length()) { + end = text.length(); + } + hLineXY(0, 0, getWidth(), backgroundChar, fieldColor); + putStringXY(0, 0, text.substring(windowStart, end), fieldColor); + + // Fix the cursor, it will be rendered by TApplication.drawAll(). + updateCursor(); + } + + // ------------------------------------------------------------------------ + // TField ----------------------------------------------------------------- + // ------------------------------------------------------------------------ + + /** + * Get field background character. + * + * @return background character + */ + public final char getBackgroundChar() { + return backgroundChar; + } + + /** + * Set field background character. + * + * @param backgroundChar the background character + */ + public void setBackgroundChar(final char backgroundChar) { + this.backgroundChar = backgroundChar; + } + + /** + * Get field text. + * + * @return field text + */ + public final String getText() { + return text; + } + + /** + * Set field text. + * + * @param text the new field text + */ + public void setText(final String text) { + assert (text != null); + this.text = text; + position = 0; + windowStart = 0; + } + + /** + * Dispatch to the action function. + * + * @param enter if true, the user pressed Enter, else this was an update + * to the text. + */ + protected void dispatch(final boolean enter) { + if (enter) { + if (enterAction != null) { + enterAction.DO(); + } + } else { + if (updateAction != null) { + updateAction.DO(); + } + } + } + + /** + * Update the visible cursor position to match the location of position + * and windowStart. + */ + protected void updateCursor() { + if ((position > getWidth()) && fixed) { + setCursorX(getWidth()); + } else if ((position - windowStart == getWidth()) && !fixed) { + setCursorX(getWidth() - 1); + } else { + setCursorX(position - windowStart); + } + } + + /** + * 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(); + } + /** * Append char to the end of the field. * * @param ch = char to append */ - private void appendChar(final char ch) { + protected void appendChar(final char ch) { // Append the LAST character text += ch; position++; @@ -432,7 +500,7 @@ public final class TField extends TWidget { * * @param ch char to append */ - private void insertChar(final char ch) { + protected void insertChar(final char ch) { text = text.substring(0, position) + ch + text.substring(position); position++; if ((position - windowStart) == getWidth()) { @@ -441,4 +509,86 @@ public final 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(); + } + + /** + * Set the active color key. + * + * @param activeColorKey ColorTheme key color to use when this field is + * active + */ + public void setActiveColorKey(final String activeColorKey) { + this.activeColorKey = activeColorKey; + } + + /** + * Set the inactive color key. + * + * @param inactiveColorKey ColorTheme key color to use when this field is + * inactive + */ + public void setInactiveColorKey(final String inactiveColorKey) { + this.inactiveColorKey = inactiveColorKey; + } + + /** + * Set the action to perform when the user presses enter. + * + * @param action the action to perform when the user presses enter + */ + public void setEnterAction(final TAction action) { + enterAction = action; + } + + /** + * Set the action to perform when the field is updated. + * + * @param action the action to perform when the field is updated + */ + public void setUpdateAction(final TAction action) { + updateAction = action; + } + }