Commit | Line | Data |
---|---|---|
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 | */ | |
29 | package jexer; | |
30 | ||
31 | import jexer.bits.CellAttributes; | |
32 | import jexer.bits.GraphicsChars; | |
58c6a100 | 33 | import jexer.bits.StringUtils; |
51e46b3e | 34 | import jexer.event.TCommandEvent; |
128e5be1 KL |
35 | import jexer.event.TKeypressEvent; |
36 | import jexer.event.TMouseEvent; | |
51e46b3e | 37 | import static jexer.TCommand.*; |
128e5be1 KL |
38 | import static jexer.TKeypress.*; |
39 | ||
40 | /** | |
87a17f3c | 41 | * TField implements an editable text field. |
128e5be1 | 42 | */ |
51e46b3e | 43 | public class TField extends TWidget implements EditMenuUser { |
128e5be1 | 44 | |
d36057df KL |
45 | // ------------------------------------------------------------------------ |
46 | // Variables -------------------------------------------------------------- | |
47 | // ------------------------------------------------------------------------ | |
48 | ||
1dac6b8d KL |
49 | /** |
50 | * Background character for unfilled-in text. | |
51 | */ | |
afdec5e9 | 52 | protected int backgroundChar = GraphicsChars.HATCH; |
1dac6b8d | 53 | |
128e5be1 KL |
54 | /** |
55 | * Field text. | |
56 | */ | |
87a17f3c | 57 | protected String text = ""; |
128e5be1 | 58 | |
128e5be1 KL |
59 | /** |
60 | * If true, only allow enough characters that will fit in the width. If | |
61 | * false, allow the field to scroll to the right. | |
62 | */ | |
87a17f3c | 63 | protected boolean fixed = false; |
128e5be1 KL |
64 | |
65 | /** | |
66 | * Current editing position within text. | |
67 | */ | |
87a17f3c | 68 | protected int position = 0; |
128e5be1 | 69 | |
58c6a100 KL |
70 | /** |
71 | * Current editing position screen column number. | |
72 | */ | |
73 | protected int screenPosition = 0; | |
74 | ||
128e5be1 KL |
75 | /** |
76 | * Beginning of visible portion. | |
77 | */ | |
87a17f3c | 78 | protected int windowStart = 0; |
128e5be1 KL |
79 | |
80 | /** | |
81 | * If true, new characters are inserted at position. | |
82 | */ | |
87a17f3c | 83 | protected boolean insertMode = true; |
128e5be1 KL |
84 | |
85 | /** | |
86 | * Remember mouse state. | |
87 | */ | |
87a17f3c | 88 | protected TMouseEvent mouse; |
128e5be1 KL |
89 | |
90 | /** | |
91 | * The action to perform when the user presses enter. | |
92 | */ | |
87a17f3c | 93 | protected TAction enterAction; |
128e5be1 KL |
94 | |
95 | /** | |
96 | * The action to perform when the text is updated. | |
97 | */ | |
87a17f3c | 98 | protected TAction updateAction; |
128e5be1 | 99 | |
1dac6b8d KL |
100 | /** |
101 | * The color to use when this field is active. | |
102 | */ | |
103 | private String activeColorKey = "tfield.active"; | |
104 | ||
105 | /** | |
106 | * The color to use when this field is not active. | |
107 | */ | |
108 | private String inactiveColorKey = "tfield.inactive"; | |
109 | ||
d36057df KL |
110 | // ------------------------------------------------------------------------ |
111 | // Constructors ----------------------------------------------------------- | |
112 | // ------------------------------------------------------------------------ | |
113 | ||
128e5be1 KL |
114 | /** |
115 | * Public constructor. | |
116 | * | |
117 | * @param parent parent widget | |
118 | * @param x column relative to parent | |
119 | * @param y row relative to parent | |
120 | * @param width visible text width | |
121 | * @param fixed if true, the text cannot exceed the display width | |
122 | */ | |
123 | public TField(final TWidget parent, final int x, final int y, | |
124 | final int width, final boolean fixed) { | |
125 | ||
126 | this(parent, x, y, width, fixed, "", null, null); | |
127 | } | |
128 | ||
129 | /** | |
130 | * Public constructor. | |
131 | * | |
132 | * @param parent parent widget | |
133 | * @param x column relative to parent | |
134 | * @param y row relative to parent | |
135 | * @param width visible text width | |
136 | * @param fixed if true, the text cannot exceed the display width | |
137 | * @param text initial text, default is empty string | |
138 | */ | |
139 | public TField(final TWidget parent, final int x, final int y, | |
140 | final int width, final boolean fixed, final String text) { | |
141 | ||
142 | this(parent, x, y, width, fixed, text, null, null); | |
143 | } | |
144 | ||
145 | /** | |
146 | * Public constructor. | |
147 | * | |
148 | * @param parent parent widget | |
149 | * @param x column relative to parent | |
150 | * @param y row relative to parent | |
151 | * @param width visible text width | |
152 | * @param fixed if true, the text cannot exceed the display width | |
153 | * @param text initial text, default is empty string | |
154 | * @param enterAction function to call when enter key is pressed | |
155 | * @param updateAction function to call when the text is updated | |
156 | */ | |
157 | public TField(final TWidget parent, final int x, final int y, | |
158 | final int width, final boolean fixed, final String text, | |
159 | final TAction enterAction, final TAction updateAction) { | |
160 | ||
161 | // Set parent and window | |
a83fea2b | 162 | super(parent, x, y, width, 1); |
128e5be1 | 163 | |
7c870d89 | 164 | setCursorVisible(true); |
128e5be1 KL |
165 | this.fixed = fixed; |
166 | this.text = text; | |
167 | this.enterAction = enterAction; | |
168 | this.updateAction = updateAction; | |
169 | } | |
170 | ||
d36057df KL |
171 | // ------------------------------------------------------------------------ |
172 | // Event handlers --------------------------------------------------------- | |
173 | // ------------------------------------------------------------------------ | |
174 | ||
128e5be1 KL |
175 | /** |
176 | * Returns true if the mouse is currently on the field. | |
177 | * | |
178 | * @return if true the mouse is currently on the field | |
179 | */ | |
87a17f3c | 180 | protected boolean mouseOnField() { |
128e5be1 KL |
181 | int rightEdge = getWidth() - 1; |
182 | if ((mouse != null) | |
183 | && (mouse.getY() == 0) | |
184 | && (mouse.getX() >= 0) | |
185 | && (mouse.getX() <= rightEdge) | |
186 | ) { | |
187 | return true; | |
188 | } | |
189 | return false; | |
190 | } | |
191 | ||
128e5be1 KL |
192 | /** |
193 | * Handle mouse button presses. | |
194 | * | |
195 | * @param mouse mouse button event | |
196 | */ | |
197 | @Override | |
198 | public void onMouseDown(final TMouseEvent mouse) { | |
199 | this.mouse = mouse; | |
200 | ||
7c870d89 | 201 | if ((mouseOnField()) && (mouse.isMouse1())) { |
128e5be1 KL |
202 | // Move cursor |
203 | int deltaX = mouse.getX() - getCursorX(); | |
58c6a100 KL |
204 | screenPosition += deltaX; |
205 | if (screenPosition > StringUtils.width(text)) { | |
206 | screenPosition = StringUtils.width(text); | |
128e5be1 | 207 | } |
58c6a100 | 208 | position = screenToTextPosition(screenPosition); |
128e5be1 KL |
209 | updateCursor(); |
210 | return; | |
211 | } | |
212 | } | |
213 | ||
214 | /** | |
215 | * Handle keystrokes. | |
216 | * | |
217 | * @param keypress keystroke event | |
218 | */ | |
219 | @Override | |
220 | public void onKeypress(final TKeypressEvent keypress) { | |
221 | ||
222 | if (keypress.equals(kbLeft)) { | |
223 | if (position > 0) { | |
ebb9a1e4 KL |
224 | screenPosition -= StringUtils.width(text.codePointBefore(position)); |
225 | position -= Character.charCount(text.codePointBefore(position)); | |
128e5be1 KL |
226 | } |
227 | if (fixed == false) { | |
58c6a100 | 228 | if ((screenPosition == windowStart) && (windowStart > 0)) { |
84a34fdf | 229 | windowStart -= StringUtils.width(text.codePointAt( |
58c6a100 | 230 | screenToTextPosition(windowStart))); |
128e5be1 KL |
231 | } |
232 | } | |
24489803 | 233 | normalizeWindowStart(); |
128e5be1 KL |
234 | return; |
235 | } | |
236 | ||
237 | if (keypress.equals(kbRight)) { | |
ebb9a1e4 | 238 | if (position < text.length()) { |
51e46b3e | 239 | int lastPosition = position; |
84a34fdf | 240 | screenPosition += StringUtils.width(text.codePointAt(position)); |
6b2633ac | 241 | position += Character.charCount(text.codePointAt(position)); |
128e5be1 | 242 | if (fixed == true) { |
58c6a100 KL |
243 | if (screenPosition == getWidth()) { |
244 | screenPosition--; | |
51e46b3e | 245 | position -= Character.charCount(text.codePointAt(lastPosition)); |
128e5be1 KL |
246 | } |
247 | } else { | |
ebb9a1e4 KL |
248 | while ((screenPosition - windowStart + |
249 | StringUtils.width(text.codePointAt(text.length() - 1))) | |
250 | > getWidth() | |
251 | ) { | |
84a34fdf | 252 | windowStart += StringUtils.width(text.codePointAt( |
58c6a100 | 253 | screenToTextPosition(windowStart))); |
128e5be1 KL |
254 | } |
255 | } | |
256 | } | |
ebb9a1e4 | 257 | assert (position <= text.length()); |
128e5be1 KL |
258 | return; |
259 | } | |
260 | ||
261 | if (keypress.equals(kbEnter)) { | |
262 | dispatch(true); | |
263 | return; | |
264 | } | |
265 | ||
266 | if (keypress.equals(kbIns)) { | |
267 | insertMode = !insertMode; | |
268 | return; | |
269 | } | |
270 | if (keypress.equals(kbHome)) { | |
1b120607 | 271 | home(); |
128e5be1 KL |
272 | return; |
273 | } | |
274 | ||
275 | if (keypress.equals(kbEnd)) { | |
1b120607 | 276 | end(); |
128e5be1 KL |
277 | return; |
278 | } | |
279 | ||
280 | if (keypress.equals(kbDel)) { | |
ebb9a1e4 | 281 | if ((text.length() > 0) && (position < text.length())) { |
128e5be1 KL |
282 | text = text.substring(0, position) |
283 | + text.substring(position + 1); | |
58c6a100 | 284 | screenPosition = StringUtils.width(text.substring(0, position)); |
128e5be1 | 285 | } |
24489803 | 286 | dispatch(false); |
128e5be1 KL |
287 | return; |
288 | } | |
289 | ||
290 | if (keypress.equals(kbBackspace) || keypress.equals(kbBackspaceDel)) { | |
291 | if (position > 0) { | |
6b2633ac | 292 | position -= Character.charCount(text.codePointBefore(position)); |
128e5be1 KL |
293 | text = text.substring(0, position) |
294 | + text.substring(position + 1); | |
58c6a100 | 295 | screenPosition = StringUtils.width(text.substring(0, position)); |
128e5be1 KL |
296 | } |
297 | if (fixed == false) { | |
58c6a100 | 298 | if ((screenPosition >= windowStart) |
128e5be1 KL |
299 | && (windowStart > 0) |
300 | ) { | |
84a34fdf | 301 | windowStart -= StringUtils.width(text.codePointAt( |
58c6a100 | 302 | screenToTextPosition(windowStart))); |
128e5be1 KL |
303 | } |
304 | } | |
305 | dispatch(false); | |
24489803 | 306 | normalizeWindowStart(); |
128e5be1 KL |
307 | return; |
308 | } | |
309 | ||
7c870d89 KL |
310 | if (!keypress.getKey().isFnKey() |
311 | && !keypress.getKey().isAlt() | |
312 | && !keypress.getKey().isCtrl() | |
128e5be1 KL |
313 | ) { |
314 | // Plain old keystroke, process it | |
ebb9a1e4 | 315 | if ((position == text.length()) |
58c6a100 | 316 | && (StringUtils.width(text) < getWidth())) { |
128e5be1 KL |
317 | |
318 | // Append case | |
7c870d89 | 319 | appendChar(keypress.getKey().getChar()); |
ebb9a1e4 | 320 | } else if ((position < text.length()) |
58c6a100 | 321 | && (StringUtils.width(text) < getWidth())) { |
128e5be1 KL |
322 | |
323 | // Overwrite or insert a character | |
324 | if (insertMode == false) { | |
325 | // Replace character | |
326 | text = text.substring(0, position) | |
84a34fdf | 327 | + codePointString(keypress.getKey().getChar()) |
128e5be1 | 328 | + text.substring(position + 1); |
84a34fdf KL |
329 | screenPosition += StringUtils.width(text.codePointAt(position)); |
330 | position += Character.charCount(keypress.getKey().getChar()); | |
128e5be1 KL |
331 | } else { |
332 | // Insert character | |
7c870d89 | 333 | insertChar(keypress.getKey().getChar()); |
128e5be1 | 334 | } |
ebb9a1e4 | 335 | } else if ((position < text.length()) |
58c6a100 | 336 | && (StringUtils.width(text) >= getWidth())) { |
128e5be1 KL |
337 | |
338 | // Multiple cases here | |
339 | if ((fixed == true) && (insertMode == true)) { | |
340 | // Buffer is full, do nothing | |
341 | } else if ((fixed == true) && (insertMode == false)) { | |
342 | // Overwrite the last character, maybe move position | |
343 | text = text.substring(0, position) | |
84a34fdf | 344 | + codePointString(keypress.getKey().getChar()) |
128e5be1 | 345 | + text.substring(position + 1); |
58c6a100 | 346 | if (screenPosition < getWidth() - 1) { |
84a34fdf KL |
347 | screenPosition += StringUtils.width(text.codePointAt(position)); |
348 | position += Character.charCount(keypress.getKey().getChar()); | |
128e5be1 KL |
349 | } |
350 | } else if ((fixed == false) && (insertMode == false)) { | |
351 | // Overwrite the last character, definitely move position | |
352 | text = text.substring(0, position) | |
84a34fdf | 353 | + codePointString(keypress.getKey().getChar()) |
128e5be1 | 354 | + text.substring(position + 1); |
84a34fdf KL |
355 | screenPosition += StringUtils.width(text.codePointAt(position)); |
356 | position += Character.charCount(keypress.getKey().getChar()); | |
128e5be1 | 357 | } else { |
ebb9a1e4 | 358 | if (position == text.length()) { |
128e5be1 | 359 | // Append this character |
7c870d89 | 360 | appendChar(keypress.getKey().getChar()); |
128e5be1 KL |
361 | } else { |
362 | // Insert this character | |
7c870d89 | 363 | insertChar(keypress.getKey().getChar()); |
128e5be1 KL |
364 | } |
365 | } | |
366 | } else { | |
367 | assert (!fixed); | |
368 | ||
369 | // Append this character | |
7c870d89 | 370 | appendChar(keypress.getKey().getChar()); |
128e5be1 KL |
371 | } |
372 | dispatch(false); | |
373 | return; | |
374 | } | |
375 | ||
376 | // Pass to parent for the things we don't care about. | |
377 | super.onKeypress(keypress); | |
378 | } | |
51e46b3e KL |
379 | /** |
380 | * Handle posted command events. | |
381 | * | |
382 | * @param command command event | |
383 | */ | |
384 | @Override | |
385 | public void onCommand(final TCommandEvent command) { | |
386 | if (command.equals(cmCut)) { | |
387 | // Copy text to clipboard, and then remove it. | |
388 | getClipboard().copyText(text); | |
389 | setText(""); | |
390 | return; | |
391 | } | |
392 | ||
393 | if (command.equals(cmCopy)) { | |
394 | // Copy text to clipboard. | |
395 | getClipboard().copyText(text); | |
396 | return; | |
397 | } | |
398 | ||
399 | if (command.equals(cmPaste)) { | |
400 | // Paste text from clipboard. | |
401 | String newText = getClipboard().pasteText(); | |
402 | if (newText != null) { | |
403 | setText(newText); | |
404 | } | |
405 | return; | |
406 | } | |
407 | ||
408 | if (command.equals(cmClear)) { | |
409 | // Remove text. | |
410 | setText(""); | |
411 | return; | |
412 | } | |
413 | ||
414 | } | |
128e5be1 | 415 | |
d36057df KL |
416 | // ------------------------------------------------------------------------ |
417 | // TWidget ---------------------------------------------------------------- | |
418 | // ------------------------------------------------------------------------ | |
419 | ||
d8dc8aea KL |
420 | /** |
421 | * Override TWidget's height: we can only set height at construction | |
422 | * time. | |
423 | * | |
424 | * @param height new widget height (ignored) | |
425 | */ | |
426 | @Override | |
427 | public void setHeight(final int height) { | |
428 | // Do nothing | |
429 | } | |
430 | ||
d36057df KL |
431 | /** |
432 | * Draw the text field. | |
433 | */ | |
434 | @Override | |
435 | public void draw() { | |
436 | CellAttributes fieldColor; | |
437 | ||
438 | if (isAbsoluteActive()) { | |
1dac6b8d | 439 | fieldColor = getTheme().getColor(activeColorKey); |
d36057df | 440 | } else { |
1dac6b8d | 441 | fieldColor = getTheme().getColor(inactiveColorKey); |
d36057df KL |
442 | } |
443 | ||
444 | int end = windowStart + getWidth(); | |
58c6a100 KL |
445 | if (end > StringUtils.width(text)) { |
446 | end = StringUtils.width(text); | |
d36057df | 447 | } |
1dac6b8d | 448 | hLineXY(0, 0, getWidth(), backgroundChar, fieldColor); |
58c6a100 KL |
449 | putStringXY(0, 0, text.substring(screenToTextPosition(windowStart), |
450 | screenToTextPosition(end)), fieldColor); | |
d36057df KL |
451 | |
452 | // Fix the cursor, it will be rendered by TApplication.drawAll(). | |
453 | updateCursor(); | |
454 | } | |
455 | ||
456 | // ------------------------------------------------------------------------ | |
457 | // TField ----------------------------------------------------------------- | |
458 | // ------------------------------------------------------------------------ | |
459 | ||
84a34fdf KL |
460 | /** |
461 | * Convert a char (codepoint) to a string. | |
462 | * | |
463 | * @param ch the char | |
464 | * @return the string | |
465 | */ | |
466 | private String codePointString(final int ch) { | |
467 | StringBuilder sb = new StringBuilder(1); | |
468 | sb.append(Character.toChars(ch)); | |
ebb9a1e4 | 469 | assert (Character.charCount(ch) == sb.length()); |
84a34fdf KL |
470 | return sb.toString(); |
471 | } | |
472 | ||
1dac6b8d KL |
473 | /** |
474 | * Get field background character. | |
475 | * | |
476 | * @return background character | |
477 | */ | |
afdec5e9 | 478 | public final int getBackgroundChar() { |
1dac6b8d KL |
479 | return backgroundChar; |
480 | } | |
481 | ||
482 | /** | |
483 | * Set field background character. | |
484 | * | |
485 | * @param backgroundChar the background character | |
486 | */ | |
afdec5e9 | 487 | public void setBackgroundChar(final int backgroundChar) { |
1dac6b8d KL |
488 | this.backgroundChar = backgroundChar; |
489 | } | |
490 | ||
d36057df KL |
491 | /** |
492 | * Get field text. | |
493 | * | |
494 | * @return field text | |
495 | */ | |
496 | public final String getText() { | |
497 | return text; | |
498 | } | |
499 | ||
500 | /** | |
501 | * Set field text. | |
502 | * | |
503 | * @param text the new field text | |
504 | */ | |
051e2913 | 505 | public void setText(final String text) { |
a69ed767 | 506 | assert (text != null); |
d36057df KL |
507 | this.text = text; |
508 | position = 0; | |
51e46b3e | 509 | screenPosition = 0; |
d36057df | 510 | windowStart = 0; |
51e46b3e KL |
511 | if ((fixed == true) && (this.text.length() > getWidth())) { |
512 | this.text = this.text.substring(0, getWidth()); | |
513 | } | |
d36057df KL |
514 | } |
515 | ||
516 | /** | |
517 | * Dispatch to the action function. | |
518 | * | |
519 | * @param enter if true, the user pressed Enter, else this was an update | |
520 | * to the text. | |
521 | */ | |
522 | protected void dispatch(final boolean enter) { | |
523 | if (enter) { | |
524 | if (enterAction != null) { | |
a524aa2e | 525 | enterAction.DO(this); |
d36057df KL |
526 | } |
527 | } else { | |
528 | if (updateAction != null) { | |
a524aa2e | 529 | updateAction.DO(this); |
d36057df KL |
530 | } |
531 | } | |
532 | } | |
533 | ||
58c6a100 KL |
534 | /** |
535 | * Determine string position from screen position. | |
536 | * | |
537 | * @param screenPosition the position on screen | |
538 | * @return the equivalent position in text | |
539 | */ | |
540 | protected int screenToTextPosition(final int screenPosition) { | |
541 | if (screenPosition == 0) { | |
542 | return 0; | |
543 | } | |
544 | ||
545 | int n = 0; | |
ebb9a1e4 | 546 | for (int i = 0; i < text.length(); i++) { |
84a34fdf | 547 | n += StringUtils.width(text.codePointAt(i)); |
58c6a100 KL |
548 | if (n >= screenPosition) { |
549 | return i + 1; | |
550 | } | |
551 | } | |
552 | // screenPosition exceeds the available text length. | |
553 | throw new IndexOutOfBoundsException("screenPosition " + screenPosition + | |
ebb9a1e4 | 554 | " exceeds available text length " + text.length()); |
58c6a100 KL |
555 | } |
556 | ||
d36057df KL |
557 | /** |
558 | * Update the visible cursor position to match the location of position | |
559 | * and windowStart. | |
560 | */ | |
561 | protected void updateCursor() { | |
58c6a100 | 562 | if ((screenPosition > getWidth()) && fixed) { |
d36057df | 563 | setCursorX(getWidth()); |
58c6a100 | 564 | } else if ((screenPosition - windowStart >= getWidth()) && !fixed) { |
d36057df KL |
565 | setCursorX(getWidth() - 1); |
566 | } else { | |
58c6a100 | 567 | setCursorX(screenPosition - windowStart); |
d36057df KL |
568 | } |
569 | } | |
570 | ||
571 | /** | |
572 | * Normalize windowStart such that most of the field data if visible. | |
573 | */ | |
574 | protected void normalizeWindowStart() { | |
575 | if (fixed) { | |
576 | // windowStart had better be zero, there is nothing to do here. | |
577 | assert (windowStart == 0); | |
578 | return; | |
579 | } | |
58c6a100 | 580 | windowStart = screenPosition - (getWidth() - 1); |
d36057df KL |
581 | if (windowStart < 0) { |
582 | windowStart = 0; | |
583 | } | |
584 | ||
585 | updateCursor(); | |
586 | } | |
587 | ||
128e5be1 KL |
588 | /** |
589 | * Append char to the end of the field. | |
590 | * | |
afdec5e9 | 591 | * @param ch char to append |
128e5be1 | 592 | */ |
afdec5e9 | 593 | protected void appendChar(final int ch) { |
128e5be1 | 594 | // Append the LAST character |
84a34fdf KL |
595 | text += codePointString(ch); |
596 | position += Character.charCount(ch); | |
58c6a100 | 597 | screenPosition += StringUtils.width(ch); |
128e5be1 | 598 | |
ebb9a1e4 | 599 | assert (position == text.length()); |
128e5be1 KL |
600 | |
601 | if (fixed) { | |
58c6a100 | 602 | if (screenPosition >= getWidth()) { |
84a34fdf | 603 | position -= Character.charCount(ch); |
58c6a100 | 604 | screenPosition -= StringUtils.width(ch); |
128e5be1 KL |
605 | } |
606 | } else { | |
58c6a100 | 607 | if ((screenPosition - windowStart) >= getWidth()) { |
128e5be1 KL |
608 | windowStart++; |
609 | } | |
610 | } | |
611 | } | |
612 | ||
613 | /** | |
614 | * Insert char somewhere in the middle of the field. | |
615 | * | |
616 | * @param ch char to append | |
617 | */ | |
afdec5e9 | 618 | protected void insertChar(final int ch) { |
84a34fdf KL |
619 | text = text.substring(0, position) + codePointString(ch) |
620 | + text.substring(position); | |
621 | position += Character.charCount(ch); | |
58c6a100 KL |
622 | screenPosition += StringUtils.width(ch); |
623 | if ((screenPosition - windowStart) == getWidth()) { | |
128e5be1 KL |
624 | assert (!fixed); |
625 | windowStart++; | |
626 | } | |
627 | } | |
628 | ||
1b120607 KL |
629 | /** |
630 | * Position the cursor at the first column. The field may adjust the | |
631 | * window start to show as much of the field as possible. | |
632 | */ | |
633 | public void home() { | |
634 | position = 0; | |
58c6a100 | 635 | screenPosition = 0; |
1b120607 KL |
636 | windowStart = 0; |
637 | } | |
638 | ||
639 | /** | |
640 | * Set the editing position to the last filled character. The field may | |
641 | * adjust the window start to show as much of the field as possible. | |
642 | */ | |
643 | public void end() { | |
ebb9a1e4 | 644 | position = text.length(); |
58c6a100 | 645 | screenPosition = StringUtils.width(text); |
1b120607 | 646 | if (fixed == true) { |
58c6a100 | 647 | if (screenPosition >= getWidth()) { |
ebb9a1e4 | 648 | position -= Character.charCount(text.codePointBefore(position)); |
58c6a100 KL |
649 | screenPosition = StringUtils.width(text) - 1; |
650 | } | |
1b120607 | 651 | } else { |
58c6a100 | 652 | windowStart = StringUtils.width(text) - getWidth() + 1; |
1b120607 KL |
653 | if (windowStart < 0) { |
654 | windowStart = 0; | |
655 | } | |
656 | } | |
657 | } | |
658 | ||
659 | /** | |
660 | * Set the editing position. The field may adjust the window start to | |
661 | * show as much of the field as possible. | |
662 | * | |
663 | * @param position the new position | |
664 | * @throws IndexOutOfBoundsException if position is outside the range of | |
665 | * the available text | |
666 | */ | |
667 | public void setPosition(final int position) { | |
ebb9a1e4 | 668 | if ((position < 0) || (position >= text.length())) { |
1b120607 | 669 | throw new IndexOutOfBoundsException("Max length is " + |
ebb9a1e4 | 670 | text.length() + ", requested position " + position); |
1b120607 KL |
671 | } |
672 | this.position = position; | |
673 | normalizeWindowStart(); | |
674 | } | |
675 | ||
1dac6b8d KL |
676 | /** |
677 | * Set the active color key. | |
678 | * | |
679 | * @param activeColorKey ColorTheme key color to use when this field is | |
680 | * active | |
681 | */ | |
682 | public void setActiveColorKey(final String activeColorKey) { | |
683 | this.activeColorKey = activeColorKey; | |
684 | } | |
685 | ||
686 | /** | |
687 | * Set the inactive color key. | |
688 | * | |
689 | * @param inactiveColorKey ColorTheme key color to use when this field is | |
690 | * inactive | |
691 | */ | |
692 | public void setInactiveColorKey(final String inactiveColorKey) { | |
693 | this.inactiveColorKey = inactiveColorKey; | |
694 | } | |
695 | ||
2b427404 KL |
696 | /** |
697 | * Set the action to perform when the user presses enter. | |
698 | * | |
699 | * @param action the action to perform when the user presses enter | |
700 | */ | |
701 | public void setEnterAction(final TAction action) { | |
702 | enterAction = action; | |
703 | } | |
704 | ||
705 | /** | |
706 | * Set the action to perform when the field is updated. | |
707 | * | |
708 | * @param action the action to perform when the field is updated | |
709 | */ | |
710 | public void setUpdateAction(final TAction action) { | |
711 | updateAction = action; | |
712 | } | |
1dac6b8d | 713 | |
51e46b3e KL |
714 | // ------------------------------------------------------------------------ |
715 | // EditMenuUser ----------------------------------------------------------- | |
716 | // ------------------------------------------------------------------------ | |
717 | ||
718 | /** | |
719 | * Check if the cut menu item should be enabled. | |
720 | * | |
721 | * @return true if the cut menu item should be enabled | |
722 | */ | |
723 | public boolean isEditMenuCut() { | |
724 | return true; | |
725 | } | |
726 | ||
727 | /** | |
728 | * Check if the copy menu item should be enabled. | |
729 | * | |
730 | * @return true if the copy menu item should be enabled | |
731 | */ | |
732 | public boolean isEditMenuCopy() { | |
733 | return true; | |
734 | } | |
735 | ||
736 | /** | |
737 | * Check if the paste menu item should be enabled. | |
738 | * | |
739 | * @return true if the paste menu item should be enabled | |
740 | */ | |
741 | public boolean isEditMenuPaste() { | |
742 | return true; | |
743 | } | |
744 | ||
745 | /** | |
746 | * Check if the clear menu item should be enabled. | |
747 | * | |
748 | * @return true if the clear menu item should be enabled | |
749 | */ | |
750 | public boolean isEditMenuClear() { | |
751 | return true; | |
752 | } | |
753 | ||
128e5be1 | 754 | } |