2 * Jexer - Java Text User Interface
4 * The MIT License (MIT)
6 * Copyright (C) 2019 Kevin Lamonte
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:
15 * The above copyright notice and this permission notice shall be included in
16 * all copies or substantial portions of the Software.
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.
26 * @author Kevin Lamonte [kevin.lamonte@gmail.com]
31 import java
.io
.IOException
;
33 import jexer
.bits
.CellAttributes
;
34 import jexer
.event
.TKeypressEvent
;
35 import jexer
.event
.TMouseEvent
;
36 import jexer
.event
.TResizeEvent
;
37 import jexer
.teditor
.Document
;
38 import jexer
.teditor
.Line
;
39 import jexer
.teditor
.Word
;
40 import static jexer
.TKeypress
.*;
43 * TEditorWidget displays an editable text document. It is unaware of
44 * scrolling behavior, but can respond to mouse and keyboard events.
46 public class TEditorWidget
extends TWidget
{
48 // ------------------------------------------------------------------------
49 // Constants --------------------------------------------------------------
50 // ------------------------------------------------------------------------
53 * The number of lines to scroll on mouse wheel up/down.
55 private static final int wheelScrollSize
= 3;
57 // ------------------------------------------------------------------------
58 // Variables --------------------------------------------------------------
59 // ------------------------------------------------------------------------
62 * The document being edited.
64 private Document document
;
67 * The default color for the TEditor class.
69 private CellAttributes defaultColor
= null;
72 * The topmost line number in the visible area. 0-based.
74 private int topLine
= 0;
77 * The leftmost column number in the visible area. 0-based.
79 private int leftColumn
= 0;
81 // ------------------------------------------------------------------------
82 // Constructors -----------------------------------------------------------
83 // ------------------------------------------------------------------------
88 * @param parent parent widget
89 * @param text text on the screen
90 * @param x column relative to parent
91 * @param y row relative to parent
92 * @param width width of text area
93 * @param height height of text area
95 public TEditorWidget(final TWidget parent
, final String text
, final int x
,
96 final int y
, final int width
, final int height
) {
98 // Set parent and window
99 super(parent
, x
, y
, width
, height
);
101 setCursorVisible(true);
103 defaultColor
= getTheme().getColor("teditor");
104 document
= new Document(text
, defaultColor
);
107 // ------------------------------------------------------------------------
108 // TWidget ----------------------------------------------------------------
109 // ------------------------------------------------------------------------
116 for (int i
= 0; i
< getHeight(); i
++) {
118 getScreen().hLineXY(0, i
, getWidth(), ' ', defaultColor
);
120 // Now draw document's line
121 if (topLine
+ i
< document
.getLineCount()) {
122 Line line
= document
.getLine(topLine
+ i
);
124 for (Word word
: line
.getWords()) {
125 // For now, we are cheating: draw outside the left region
126 // if needed and let screen do the clipping.
127 getScreen().putStringXY(x
- leftColumn
, i
, word
.getText(),
129 x
+= word
.getDisplayLength();
130 if (x
- leftColumn
> getWidth()) {
139 * Handle mouse press events.
141 * @param mouse mouse button press event
144 public void onMouseDown(final TMouseEvent mouse
) {
145 if (mouse
.isMouseWheelUp()) {
146 for (int i
= 0; i
< wheelScrollSize
; i
++) {
149 alignDocument(false);
154 if (mouse
.isMouseWheelDown()) {
155 for (int i
= 0; i
< wheelScrollSize
; i
++) {
156 if (topLine
< document
.getLineCount() - 1) {
164 if (mouse
.isMouse1()) {
165 // Set the row and column
166 int newLine
= topLine
+ mouse
.getY();
167 int newX
= leftColumn
+ mouse
.getX();
168 if (newLine
> document
.getLineCount() - 1) {
170 document
.setLineNumber(document
.getLineCount() - 1);
172 if (newLine
> document
.getLineCount() - 1) {
173 setCursorY(document
.getLineCount() - 1 - topLine
);
175 setCursorY(mouse
.getY());
181 document
.setLineNumber(newLine
);
182 setCursorY(mouse
.getY());
183 if (newX
>= document
.getCurrentLine().getDisplayLength()) {
187 document
.setCursor(newX
);
188 setCursorX(mouse
.getX());
194 super.onMouseDown(mouse
);
200 * @param keypress keystroke event
203 public void onKeypress(final TKeypressEvent keypress
) {
204 if (keypress
.equals(kbLeft
)) {
207 } else if (keypress
.equals(kbRight
)) {
210 } else if (keypress
.equals(kbUp
)) {
213 } else if (keypress
.equals(kbDown
)) {
216 } else if (keypress
.equals(kbPgUp
)) {
217 document
.up(getHeight() - 1);
219 } else if (keypress
.equals(kbPgDn
)) {
220 document
.down(getHeight() - 1);
222 } else if (keypress
.equals(kbHome
)) {
223 if (document
.home()) {
225 if (leftColumn
< 0) {
230 } else if (keypress
.equals(kbEnd
)) {
231 if (document
.end()) {
234 } else if (keypress
.equals(kbCtrlHome
)) {
235 document
.setLineNumber(0);
241 } else if (keypress
.equals(kbCtrlEnd
)) {
242 document
.setLineNumber(document
.getLineCount() - 1);
245 } else if (keypress
.equals(kbIns
)) {
246 document
.setOverwrite(!document
.getOverwrite());
247 } else if (keypress
.equals(kbDel
)) {
250 } else if (keypress
.equals(kbBackspace
)) {
251 document
.backspace();
253 } else if (keypress
.equals(kbTab
)) {
254 // TODO: tab character. For now just add spaces until we hit
256 for (int i
= document
.getCursor(); (i
+ 1) % 8 != 0; i
++) {
257 document
.addChar(' ');
260 } else if (keypress
.equals(kbEnter
)) {
263 } else if (!keypress
.getKey().isFnKey()
264 && !keypress
.getKey().isAlt()
265 && !keypress
.getKey().isCtrl()
267 // Plain old keystroke, process it
268 document
.addChar(keypress
.getKey().getChar());
271 // Pass other keys (tab etc.) on to TWidget
272 super.onKeypress(keypress
);
277 * Method that subclasses can override to handle window/screen resize
280 * @param resize resize event
283 public void onResize(final TResizeEvent resize
) {
284 // Change my width/height, and pull the cursor in as needed.
285 if (resize
.getType() == TResizeEvent
.Type
.WIDGET
) {
286 setWidth(resize
.getWidth());
287 setHeight(resize
.getHeight());
288 // See if the cursor is now outside the window, and if so move
290 if (getCursorX() >= getWidth()) {
291 leftColumn
+= getCursorX() - (getWidth() - 1);
292 setCursorX(getWidth() - 1);
294 if (getCursorY() >= getHeight()) {
295 topLine
+= getCursorY() - (getHeight() - 1);
296 setCursorY(getHeight() - 1);
299 // Let superclass handle it
300 super.onResize(resize
);
304 // ------------------------------------------------------------------------
305 // TEditorWidget ----------------------------------------------------------
306 // ------------------------------------------------------------------------
309 * Align visible area with document current line.
311 * @param topLineIsTop if true, make the top visible line the document
312 * current line if it was off-screen. If false, make the bottom visible
313 * line the document current line.
315 private void alignTopLine(final boolean topLineIsTop
) {
316 int line
= document
.getLineNumber();
318 if ((line
< topLine
) || (line
> topLine
+ getHeight() - 1)) {
319 // Need to move topLine to bring document back into view.
321 topLine
= line
- (getHeight() - 1);
325 assert (topLine
>= 0);
328 assert (topLine
>= 0);
333 System.err.println("line " + line + " topLine " + topLine);
336 // Document is in view, let's set cursorY
337 assert (line
>= topLine
);
338 setCursorY(line
- topLine
);
343 * Align document current line with visible area.
345 * @param topLineIsTop if true, make the top visible line the document
346 * current line if it was off-screen. If false, make the bottom visible
347 * line the document current line.
349 private void alignDocument(final boolean topLineIsTop
) {
350 int line
= document
.getLineNumber();
351 int cursor
= document
.getCursor();
353 if ((line
< topLine
) || (line
> topLine
+ getHeight() - 1)) {
354 // Need to move document to ensure it fits view.
356 document
.setLineNumber(topLine
);
358 document
.setLineNumber(topLine
+ (getHeight() - 1));
360 if (cursor
< document
.getCurrentLine().getDisplayLength()) {
361 document
.setCursor(cursor
);
366 System.err.println("getLineNumber() " + document.getLineNumber() +
367 " topLine " + topLine);
370 // Document is in view, let's set cursorY
371 setCursorY(document
.getLineNumber() - topLine
);
376 * Align visible cursor with document cursor.
378 private void alignCursor() {
379 int width
= getWidth();
381 int desiredX
= document
.getCursor() - leftColumn
;
383 // We need to push the screen to the left.
384 leftColumn
= document
.getCursor();
385 } else if (desiredX
> width
- 1) {
386 // We need to push the screen to the right.
387 leftColumn
= document
.getCursor() - (width
- 1);
391 System.err.println("document cursor " + document.getCursor() +
392 " leftColumn " + leftColumn);
396 setCursorX(document
.getCursor() - leftColumn
);
400 * Get the number of lines in the underlying Document.
402 * @return the number of lines
404 public int getLineCount() {
405 return document
.getLineCount();
409 * Get the current visible top row number. 1-based.
411 * @return the visible top row number. Row 1 is the first row.
413 public int getVisibleRowNumber() {
418 * Set the current visible row number. 1-based.
420 * @param row the new visible row number. Row 1 is the first row.
422 public void setVisibleRowNumber(final int row
) {
424 if ((row
> 0) && (row
< document
.getLineCount())) {
431 * Get the current editing row number. 1-based.
433 * @return the editing row number. Row 1 is the first row.
435 public int getEditingRowNumber() {
436 return document
.getLineNumber() + 1;
440 * Set the current editing row number. 1-based.
442 * @param row the new editing row number. Row 1 is the first row.
444 public void setEditingRowNumber(final int row
) {
446 if ((row
> 0) && (row
< document
.getLineCount())) {
447 document
.setLineNumber(row
- 1);
453 * Get the current editing column number. 1-based.
455 * @return the editing column number. Column 1 is the first column.
457 public int getEditingColumnNumber() {
458 return document
.getCursor() + 1;
462 * Set the current editing column number. 1-based.
464 * @param column the new editing column number. Column 1 is the first
467 public void setEditingColumnNumber(final int column
) {
468 if ((column
> 0) && (column
< document
.getLineLength())) {
469 document
.setCursor(column
- 1);
475 * Get the maximum possible row number. 1-based.
477 * @return the maximum row number. Row 1 is the first row.
479 public int getMaximumRowNumber() {
480 return document
.getLineCount() + 1;
484 * Get the maximum possible column number. 1-based.
486 * @return the maximum column number. Column 1 is the first column.
488 public int getMaximumColumnNumber() {
489 return document
.getLineLengthMax() + 1;
493 * Get the dirty value.
495 * @return true if the buffer is dirty
497 public boolean isDirty() {
498 return document
.isDirty();
502 * Save contents to file.
504 * @param filename file to save to
505 * @throws IOException if a java.io operation throws
507 public void saveToFilename(final String filename
) throws IOException
{
508 document
.saveToFilename(filename
);