expose sixel palette size
[fanfix.git] / src / jexer / TField.java
CommitLineData
daa4106c 1/*
128e5be1
KL
2 * Jexer - Java Text User Interface
3 *
e16dda65 4 * The MIT License (MIT)
128e5be1 5 *
a69ed767 6 * Copyright (C) 2019 Kevin Lamonte
128e5be1 7 *
e16dda65
KL
8 * Permission is hereby granted, free of charge, to any person obtaining a
9 * copy of this software and associated documentation files (the "Software"),
10 * to deal in the Software without restriction, including without limitation
11 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
12 * and/or sell copies of the Software, and to permit persons to whom the
13 * Software is furnished to do so, subject to the following conditions:
128e5be1 14 *
e16dda65
KL
15 * The above copyright notice and this permission notice shall be included in
16 * all copies or substantial portions of the Software.
128e5be1 17 *
e16dda65
KL
18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
21 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
23 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
24 * DEALINGS IN THE SOFTWARE.
128e5be1
KL
25 *
26 * @author Kevin Lamonte [kevin.lamonte@gmail.com]
27 * @version 1
28 */
29package jexer;
30
31import jexer.bits.CellAttributes;
32import jexer.bits.GraphicsChars;
58c6a100 33import jexer.bits.StringUtils;
128e5be1
KL
34import jexer.event.TKeypressEvent;
35import jexer.event.TMouseEvent;
36import static jexer.TKeypress.*;
37
38/**
87a17f3c 39 * TField implements an editable text field.
128e5be1 40 */
87a17f3c 41public class TField extends TWidget {
128e5be1 42
d36057df
KL
43 // ------------------------------------------------------------------------
44 // Variables --------------------------------------------------------------
45 // ------------------------------------------------------------------------
46
1dac6b8d
KL
47 /**
48 * Background character for unfilled-in text.
49 */
50 protected char backgroundChar = GraphicsChars.HATCH;
51
128e5be1
KL
52 /**
53 * Field text.
54 */
87a17f3c 55 protected String text = "";
128e5be1 56
128e5be1
KL
57 /**
58 * If true, only allow enough characters that will fit in the width. If
59 * false, allow the field to scroll to the right.
60 */
87a17f3c 61 protected boolean fixed = false;
128e5be1
KL
62
63 /**
64 * Current editing position within text.
65 */
87a17f3c 66 protected int position = 0;
128e5be1 67
58c6a100
KL
68 /**
69 * Current editing position screen column number.
70 */
71 protected int screenPosition = 0;
72
128e5be1
KL
73 /**
74 * Beginning of visible portion.
75 */
87a17f3c 76 protected int windowStart = 0;
128e5be1
KL
77
78 /**
79 * If true, new characters are inserted at position.
80 */
87a17f3c 81 protected boolean insertMode = true;
128e5be1
KL
82
83 /**
84 * Remember mouse state.
85 */
87a17f3c 86 protected TMouseEvent mouse;
128e5be1
KL
87
88 /**
89 * The action to perform when the user presses enter.
90 */
87a17f3c 91 protected TAction enterAction;
128e5be1
KL
92
93 /**
94 * The action to perform when the text is updated.
95 */
87a17f3c 96 protected TAction updateAction;
128e5be1 97
1dac6b8d
KL
98 /**
99 * The color to use when this field is active.
100 */
101 private String activeColorKey = "tfield.active";
102
103 /**
104 * The color to use when this field is not active.
105 */
106 private String inactiveColorKey = "tfield.inactive";
107
d36057df
KL
108 // ------------------------------------------------------------------------
109 // Constructors -----------------------------------------------------------
110 // ------------------------------------------------------------------------
111
128e5be1
KL
112 /**
113 * Public constructor.
114 *
115 * @param parent parent widget
116 * @param x column relative to parent
117 * @param y row relative to parent
118 * @param width visible text width
119 * @param fixed if true, the text cannot exceed the display width
120 */
121 public TField(final TWidget parent, final int x, final int y,
122 final int width, final boolean fixed) {
123
124 this(parent, x, y, width, fixed, "", null, null);
125 }
126
127 /**
128 * Public constructor.
129 *
130 * @param parent parent widget
131 * @param x column relative to parent
132 * @param y row relative to parent
133 * @param width visible text width
134 * @param fixed if true, the text cannot exceed the display width
135 * @param text initial text, default is empty string
136 */
137 public TField(final TWidget parent, final int x, final int y,
138 final int width, final boolean fixed, final String text) {
139
140 this(parent, x, y, width, fixed, text, null, null);
141 }
142
143 /**
144 * Public constructor.
145 *
146 * @param parent parent widget
147 * @param x column relative to parent
148 * @param y row relative to parent
149 * @param width visible text width
150 * @param fixed if true, the text cannot exceed the display width
151 * @param text initial text, default is empty string
152 * @param enterAction function to call when enter key is pressed
153 * @param updateAction function to call when the text is updated
154 */
155 public TField(final TWidget parent, final int x, final int y,
156 final int width, final boolean fixed, final String text,
157 final TAction enterAction, final TAction updateAction) {
158
159 // Set parent and window
a83fea2b 160 super(parent, x, y, width, 1);
128e5be1 161
7c870d89 162 setCursorVisible(true);
128e5be1
KL
163 this.fixed = fixed;
164 this.text = text;
165 this.enterAction = enterAction;
166 this.updateAction = updateAction;
167 }
168
d36057df
KL
169 // ------------------------------------------------------------------------
170 // Event handlers ---------------------------------------------------------
171 // ------------------------------------------------------------------------
172
128e5be1
KL
173 /**
174 * Returns true if the mouse is currently on the field.
175 *
176 * @return if true the mouse is currently on the field
177 */
87a17f3c 178 protected boolean mouseOnField() {
128e5be1
KL
179 int rightEdge = getWidth() - 1;
180 if ((mouse != null)
181 && (mouse.getY() == 0)
182 && (mouse.getX() >= 0)
183 && (mouse.getX() <= rightEdge)
184 ) {
185 return true;
186 }
187 return false;
188 }
189
128e5be1
KL
190 /**
191 * Handle mouse button presses.
192 *
193 * @param mouse mouse button event
194 */
195 @Override
196 public void onMouseDown(final TMouseEvent mouse) {
197 this.mouse = mouse;
198
7c870d89 199 if ((mouseOnField()) && (mouse.isMouse1())) {
128e5be1
KL
200 // Move cursor
201 int deltaX = mouse.getX() - getCursorX();
58c6a100
KL
202 screenPosition += deltaX;
203 if (screenPosition > StringUtils.width(text)) {
204 screenPosition = StringUtils.width(text);
128e5be1 205 }
58c6a100 206 position = screenToTextPosition(screenPosition);
128e5be1
KL
207 updateCursor();
208 return;
209 }
210 }
211
212 /**
213 * Handle keystrokes.
214 *
215 * @param keypress keystroke event
216 */
217 @Override
218 public void onKeypress(final TKeypressEvent keypress) {
219
220 if (keypress.equals(kbLeft)) {
221 if (position > 0) {
58c6a100
KL
222 if (position < text.length()) {
223 screenPosition -= StringUtils.width(text.charAt(position));
224 } else {
225 screenPosition--;
226 }
128e5be1
KL
227 position--;
228 }
229 if (fixed == false) {
58c6a100
KL
230 if ((screenPosition == windowStart) && (windowStart > 0)) {
231 windowStart -= StringUtils.width(text.charAt(
232 screenToTextPosition(windowStart)));
128e5be1
KL
233 }
234 }
24489803 235 normalizeWindowStart();
128e5be1
KL
236 return;
237 }
238
239 if (keypress.equals(kbRight)) {
240 if (position < text.length()) {
58c6a100 241 screenPosition += StringUtils.width(text.charAt(position));
128e5be1
KL
242 position++;
243 if (fixed == true) {
58c6a100
KL
244 if (screenPosition == getWidth()) {
245 screenPosition--;
128e5be1
KL
246 position--;
247 }
248 } else {
58c6a100
KL
249 if ((screenPosition - windowStart) >= getWidth()) {
250 windowStart += StringUtils.width(text.charAt(
251 screenToTextPosition(windowStart)));
128e5be1
KL
252 }
253 }
254 }
255 return;
256 }
257
258 if (keypress.equals(kbEnter)) {
259 dispatch(true);
260 return;
261 }
262
263 if (keypress.equals(kbIns)) {
264 insertMode = !insertMode;
265 return;
266 }
267 if (keypress.equals(kbHome)) {
1b120607 268 home();
128e5be1
KL
269 return;
270 }
271
272 if (keypress.equals(kbEnd)) {
1b120607 273 end();
128e5be1
KL
274 return;
275 }
276
277 if (keypress.equals(kbDel)) {
278 if ((text.length() > 0) && (position < text.length())) {
279 text = text.substring(0, position)
280 + text.substring(position + 1);
58c6a100 281 screenPosition = StringUtils.width(text.substring(0, position));
128e5be1 282 }
24489803 283 dispatch(false);
128e5be1
KL
284 return;
285 }
286
287 if (keypress.equals(kbBackspace) || keypress.equals(kbBackspaceDel)) {
288 if (position > 0) {
289 position--;
290 text = text.substring(0, position)
291 + text.substring(position + 1);
58c6a100 292 screenPosition = StringUtils.width(text.substring(0, position));
128e5be1
KL
293 }
294 if (fixed == false) {
58c6a100 295 if ((screenPosition >= windowStart)
128e5be1
KL
296 && (windowStart > 0)
297 ) {
58c6a100
KL
298 windowStart -= StringUtils.width(text.charAt(
299 screenToTextPosition(windowStart)));
128e5be1
KL
300 }
301 }
302 dispatch(false);
24489803 303 normalizeWindowStart();
128e5be1
KL
304 return;
305 }
306
7c870d89
KL
307 if (!keypress.getKey().isFnKey()
308 && !keypress.getKey().isAlt()
309 && !keypress.getKey().isCtrl()
128e5be1
KL
310 ) {
311 // Plain old keystroke, process it
312 if ((position == text.length())
58c6a100 313 && (StringUtils.width(text) < getWidth())) {
128e5be1
KL
314
315 // Append case
7c870d89 316 appendChar(keypress.getKey().getChar());
128e5be1 317 } else if ((position < text.length())
58c6a100 318 && (StringUtils.width(text) < getWidth())) {
128e5be1
KL
319
320 // Overwrite or insert a character
321 if (insertMode == false) {
322 // Replace character
323 text = text.substring(0, position)
7c870d89 324 + keypress.getKey().getChar()
128e5be1 325 + text.substring(position + 1);
58c6a100 326 screenPosition += StringUtils.width(text.charAt(position));
128e5be1
KL
327 position++;
328 } else {
329 // Insert character
7c870d89 330 insertChar(keypress.getKey().getChar());
128e5be1
KL
331 }
332 } else if ((position < text.length())
58c6a100 333 && (StringUtils.width(text) >= getWidth())) {
128e5be1
KL
334
335 // Multiple cases here
336 if ((fixed == true) && (insertMode == true)) {
337 // Buffer is full, do nothing
338 } else if ((fixed == true) && (insertMode == false)) {
339 // Overwrite the last character, maybe move position
340 text = text.substring(0, position)
7c870d89 341 + keypress.getKey().getChar()
128e5be1 342 + text.substring(position + 1);
58c6a100
KL
343 if (screenPosition < getWidth() - 1) {
344 screenPosition += StringUtils.width(text.charAt(position));
128e5be1
KL
345 position++;
346 }
347 } else if ((fixed == false) && (insertMode == false)) {
348 // Overwrite the last character, definitely move position
349 text = text.substring(0, position)
7c870d89 350 + keypress.getKey().getChar()
128e5be1 351 + text.substring(position + 1);
58c6a100 352 screenPosition += StringUtils.width(text.charAt(position));
128e5be1
KL
353 position++;
354 } else {
355 if (position == text.length()) {
356 // Append this character
7c870d89 357 appendChar(keypress.getKey().getChar());
128e5be1
KL
358 } else {
359 // Insert this character
7c870d89 360 insertChar(keypress.getKey().getChar());
128e5be1
KL
361 }
362 }
363 } else {
364 assert (!fixed);
365
366 // Append this character
7c870d89 367 appendChar(keypress.getKey().getChar());
128e5be1
KL
368 }
369 dispatch(false);
370 return;
371 }
372
373 // Pass to parent for the things we don't care about.
374 super.onKeypress(keypress);
375 }
376
d36057df
KL
377 // ------------------------------------------------------------------------
378 // TWidget ----------------------------------------------------------------
379 // ------------------------------------------------------------------------
380
381 /**
382 * Draw the text field.
383 */
384 @Override
385 public void draw() {
386 CellAttributes fieldColor;
387
388 if (isAbsoluteActive()) {
1dac6b8d 389 fieldColor = getTheme().getColor(activeColorKey);
d36057df 390 } else {
1dac6b8d 391 fieldColor = getTheme().getColor(inactiveColorKey);
d36057df
KL
392 }
393
394 int end = windowStart + getWidth();
58c6a100
KL
395 if (end > StringUtils.width(text)) {
396 end = StringUtils.width(text);
d36057df 397 }
1dac6b8d 398 hLineXY(0, 0, getWidth(), backgroundChar, fieldColor);
58c6a100
KL
399 putStringXY(0, 0, text.substring(screenToTextPosition(windowStart),
400 screenToTextPosition(end)), fieldColor);
d36057df
KL
401
402 // Fix the cursor, it will be rendered by TApplication.drawAll().
403 updateCursor();
404 }
405
406 // ------------------------------------------------------------------------
407 // TField -----------------------------------------------------------------
408 // ------------------------------------------------------------------------
409
1dac6b8d
KL
410 /**
411 * Get field background character.
412 *
413 * @return background character
414 */
415 public final char getBackgroundChar() {
416 return backgroundChar;
417 }
418
419 /**
420 * Set field background character.
421 *
422 * @param backgroundChar the background character
423 */
424 public void setBackgroundChar(final char backgroundChar) {
425 this.backgroundChar = backgroundChar;
426 }
427
d36057df
KL
428 /**
429 * Get field text.
430 *
431 * @return field text
432 */
433 public final String getText() {
434 return text;
435 }
436
437 /**
438 * Set field text.
439 *
440 * @param text the new field text
441 */
051e2913 442 public void setText(final String text) {
a69ed767 443 assert (text != null);
d36057df
KL
444 this.text = text;
445 position = 0;
446 windowStart = 0;
447 }
448
449 /**
450 * Dispatch to the action function.
451 *
452 * @param enter if true, the user pressed Enter, else this was an update
453 * to the text.
454 */
455 protected void dispatch(final boolean enter) {
456 if (enter) {
457 if (enterAction != null) {
458 enterAction.DO();
459 }
460 } else {
461 if (updateAction != null) {
462 updateAction.DO();
463 }
464 }
465 }
466
58c6a100
KL
467 /**
468 * Determine string position from screen position.
469 *
470 * @param screenPosition the position on screen
471 * @return the equivalent position in text
472 */
473 protected int screenToTextPosition(final int screenPosition) {
474 if (screenPosition == 0) {
475 return 0;
476 }
477
478 int n = 0;
479 for (int i = 0; i < text.length(); i++) {
480 n += StringUtils.width(text.charAt(i));
481 if (n >= screenPosition) {
482 return i + 1;
483 }
484 }
485 // screenPosition exceeds the available text length.
486 throw new IndexOutOfBoundsException("screenPosition " + screenPosition +
487 " exceeds available text length " + text.length());
488 }
489
d36057df
KL
490 /**
491 * Update the visible cursor position to match the location of position
492 * and windowStart.
493 */
494 protected void updateCursor() {
58c6a100 495 if ((screenPosition > getWidth()) && fixed) {
d36057df 496 setCursorX(getWidth());
58c6a100 497 } else if ((screenPosition - windowStart >= getWidth()) && !fixed) {
d36057df
KL
498 setCursorX(getWidth() - 1);
499 } else {
58c6a100 500 setCursorX(screenPosition - windowStart);
d36057df
KL
501 }
502 }
503
504 /**
505 * Normalize windowStart such that most of the field data if visible.
506 */
507 protected void normalizeWindowStart() {
508 if (fixed) {
509 // windowStart had better be zero, there is nothing to do here.
510 assert (windowStart == 0);
511 return;
512 }
58c6a100 513 windowStart = screenPosition - (getWidth() - 1);
d36057df
KL
514 if (windowStart < 0) {
515 windowStart = 0;
516 }
517
518 updateCursor();
519 }
520
128e5be1
KL
521 /**
522 * Append char to the end of the field.
523 *
524 * @param ch = char to append
525 */
87a17f3c 526 protected void appendChar(final char ch) {
128e5be1
KL
527 // Append the LAST character
528 text += ch;
529 position++;
58c6a100 530 screenPosition += StringUtils.width(ch);
128e5be1
KL
531
532 assert (position == text.length());
533
534 if (fixed) {
58c6a100 535 if (screenPosition >= getWidth()) {
128e5be1 536 position--;
58c6a100 537 screenPosition -= StringUtils.width(ch);
128e5be1
KL
538 }
539 } else {
58c6a100 540 if ((screenPosition - windowStart) >= getWidth()) {
128e5be1
KL
541 windowStart++;
542 }
543 }
544 }
545
546 /**
547 * Insert char somewhere in the middle of the field.
548 *
549 * @param ch char to append
550 */
87a17f3c 551 protected void insertChar(final char ch) {
128e5be1
KL
552 text = text.substring(0, position) + ch + text.substring(position);
553 position++;
58c6a100
KL
554 screenPosition += StringUtils.width(ch);
555 if ((screenPosition - windowStart) == getWidth()) {
128e5be1
KL
556 assert (!fixed);
557 windowStart++;
558 }
559 }
560
1b120607
KL
561 /**
562 * Position the cursor at the first column. The field may adjust the
563 * window start to show as much of the field as possible.
564 */
565 public void home() {
566 position = 0;
58c6a100 567 screenPosition = 0;
1b120607
KL
568 windowStart = 0;
569 }
570
571 /**
572 * Set the editing position to the last filled character. The field may
573 * adjust the window start to show as much of the field as possible.
574 */
575 public void end() {
576 position = text.length();
58c6a100 577 screenPosition = StringUtils.width(text);
1b120607 578 if (fixed == true) {
58c6a100 579 if (screenPosition >= getWidth()) {
1b120607 580 position = text.length() - 1;
58c6a100
KL
581 screenPosition = StringUtils.width(text) - 1;
582 }
1b120607 583 } else {
58c6a100 584 windowStart = StringUtils.width(text) - getWidth() + 1;
1b120607
KL
585 if (windowStart < 0) {
586 windowStart = 0;
587 }
588 }
589 }
590
591 /**
592 * Set the editing position. The field may adjust the window start to
593 * show as much of the field as possible.
594 *
595 * @param position the new position
596 * @throws IndexOutOfBoundsException if position is outside the range of
597 * the available text
598 */
599 public void setPosition(final int position) {
600 if ((position < 0) || (position >= text.length())) {
601 throw new IndexOutOfBoundsException("Max length is " +
58c6a100 602 StringUtils.width(text) + ", requested position " + position);
1b120607
KL
603 }
604 this.position = position;
605 normalizeWindowStart();
606 }
607
1dac6b8d
KL
608 /**
609 * Set the active color key.
610 *
611 * @param activeColorKey ColorTheme key color to use when this field is
612 * active
613 */
614 public void setActiveColorKey(final String activeColorKey) {
615 this.activeColorKey = activeColorKey;
616 }
617
618 /**
619 * Set the inactive color key.
620 *
621 * @param inactiveColorKey ColorTheme key color to use when this field is
622 * inactive
623 */
624 public void setInactiveColorKey(final String inactiveColorKey) {
625 this.inactiveColorKey = inactiveColorKey;
626 }
627
2b427404
KL
628 /**
629 * Set the action to perform when the user presses enter.
630 *
631 * @param action the action to perform when the user presses enter
632 */
633 public void setEnterAction(final TAction action) {
634 enterAction = action;
635 }
636
637 /**
638 * Set the action to perform when the field is updated.
639 *
640 * @param action the action to perform when the field is updated
641 */
642 public void setUpdateAction(final TAction action) {
643 updateAction = action;
644 }
1dac6b8d 645
128e5be1 646}