2 * Jexer - Java Text User Interface
4 * The MIT License (MIT)
6 * Copyright (C) 2017 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 final class TEditorWidget
extends TWidget
{
49 * The document being edited.
51 private Document document
;
54 * The default color for the TEditor class.
56 private CellAttributes defaultColor
= null;
59 * The topmost line number in the visible area. 0-based.
61 private int topLine
= 0;
64 * The leftmost column number in the visible area. 0-based.
66 private int leftColumn
= 0;
71 * @param parent parent widget
72 * @param text text on the screen
73 * @param x column relative to parent
74 * @param y row relative to parent
75 * @param width width of text area
76 * @param height height of text area
78 public TEditorWidget(final TWidget parent
, final String text
, final int x
,
79 final int y
, final int width
, final int height
) {
81 // Set parent and window
82 super(parent
, x
, y
, width
, height
);
84 setCursorVisible(true);
86 defaultColor
= getTheme().getColor("teditor");
87 document
= new Document(text
, defaultColor
);
95 for (int i
= 0; i
< getHeight(); i
++) {
97 getScreen().hLineXY(0, i
, getWidth(), ' ', defaultColor
);
99 // Now draw document's line
100 if (topLine
+ i
< document
.getLineCount()) {
101 Line line
= document
.getLine(topLine
+ i
);
103 for (Word word
: line
.getWords()) {
104 // For now, we are cheating: draw outside the left region
105 // if needed and let screen do the clipping.
106 getScreen().putStringXY(x
- leftColumn
, i
, word
.getText(),
108 x
+= word
.getDisplayLength();
109 if (x
- leftColumn
> getWidth()) {
118 * Handle mouse press events.
120 * @param mouse mouse button press event
123 public void onMouseDown(final TMouseEvent mouse
) {
124 if (mouse
.isMouseWheelUp()) {
127 alignDocument(false);
131 if (mouse
.isMouseWheelDown()) {
132 if (topLine
< document
.getLineCount() - 1) {
139 if (mouse
.isMouse1()) {
140 // Set the row and column
141 int newLine
= topLine
+ mouse
.getY();
142 int newX
= leftColumn
+ mouse
.getX();
143 if (newLine
> document
.getLineCount() - 1) {
145 document
.setLineNumber(document
.getLineCount() - 1);
147 if (newLine
> document
.getLineCount() - 1) {
148 setCursorY(document
.getLineCount() - 1 - topLine
);
150 setCursorY(mouse
.getY());
156 document
.setLineNumber(newLine
);
157 setCursorY(mouse
.getY());
158 if (newX
> document
.getCurrentLine().getDisplayLength()) {
162 document
.setCursor(newX
);
163 setCursorX(mouse
.getX());
169 super.onMouseDown(mouse
);
173 * Align visible area with document current line.
175 * @param topLineIsTop if true, make the top visible line the document
176 * current line if it was off-screen. If false, make the bottom visible
177 * line the document current line.
179 private void alignTopLine(final boolean topLineIsTop
) {
180 int line
= document
.getLineNumber();
182 if ((line
< topLine
) || (line
> topLine
+ getHeight() - 1)) {
183 // Need to move topLine to bring document back into view.
185 topLine
= line
- (getHeight() - 1);
189 assert (topLine
>= 0);
192 assert (topLine
>= 0);
197 System.err.println("line " + line + " topLine " + topLine);
200 // Document is in view, let's set cursorY
201 assert (line
>= topLine
);
202 setCursorY(line
- topLine
);
207 * Align document current line with visible area.
209 * @param topLineIsTop if true, make the top visible line the document
210 * current line if it was off-screen. If false, make the bottom visible
211 * line the document current line.
213 private void alignDocument(final boolean topLineIsTop
) {
214 int line
= document
.getLineNumber();
215 int cursor
= document
.getCursor();
217 if ((line
< topLine
) || (line
> topLine
+ getHeight() - 1)) {
218 // Need to move document to ensure it fits view.
220 document
.setLineNumber(topLine
);
222 document
.setLineNumber(topLine
+ (getHeight() - 1));
224 if (cursor
< document
.getCurrentLine().getDisplayLength()) {
225 document
.setCursor(cursor
);
230 System.err.println("getLineNumber() " + document.getLineNumber() +
231 " topLine " + topLine);
234 // Document is in view, let's set cursorY
235 setCursorY(document
.getLineNumber() - topLine
);
240 * Align visible cursor with document cursor.
242 private void alignCursor() {
243 int width
= getWidth();
245 int desiredX
= document
.getCursor() - leftColumn
;
247 // We need to push the screen to the left.
248 leftColumn
= document
.getCursor();
249 } else if (desiredX
> width
- 1) {
250 // We need to push the screen to the right.
251 leftColumn
= document
.getCursor() - (width
- 1);
255 System.err.println("document cursor " + document.getCursor() +
256 " leftColumn " + leftColumn);
260 setCursorX(document
.getCursor() - leftColumn
);
266 * @param keypress keystroke event
269 public void onKeypress(final TKeypressEvent keypress
) {
270 if (keypress
.equals(kbLeft
)) {
273 } else if (keypress
.equals(kbRight
)) {
276 } else if (keypress
.equals(kbUp
)) {
279 } else if (keypress
.equals(kbDown
)) {
282 } else if (keypress
.equals(kbPgUp
)) {
283 document
.up(getHeight() - 1);
285 } else if (keypress
.equals(kbPgDn
)) {
286 document
.down(getHeight() - 1);
288 } else if (keypress
.equals(kbHome
)) {
289 if (document
.home()) {
291 if (leftColumn
< 0) {
296 } else if (keypress
.equals(kbEnd
)) {
297 if (document
.end()) {
300 } else if (keypress
.equals(kbCtrlHome
)) {
301 document
.setLineNumber(0);
307 } else if (keypress
.equals(kbCtrlEnd
)) {
308 document
.setLineNumber(document
.getLineCount() - 1);
311 } else if (keypress
.equals(kbIns
)) {
312 document
.setOverwrite(!document
.getOverwrite());
313 } else if (keypress
.equals(kbDel
)) {
316 } else if (keypress
.equals(kbBackspace
)) {
317 document
.backspace();
319 } else if (keypress
.equals(kbTab
)) {
320 // TODO: tab character. For now just add spaces until we hit
322 for (int i
= document
.getCursor(); (i
+ 1) % 8 != 0; i
++) {
323 document
.addChar(' ');
326 } else if (keypress
.equals(kbEnter
)) {
329 } else if (!keypress
.getKey().isFnKey()
330 && !keypress
.getKey().isAlt()
331 && !keypress
.getKey().isCtrl()
333 // Plain old keystroke, process it
334 document
.addChar(keypress
.getKey().getChar());
337 // Pass other keys (tab etc.) on to TWidget
338 super.onKeypress(keypress
);
343 * Method that subclasses can override to handle window/screen resize
346 * @param resize resize event
349 public void onResize(final TResizeEvent resize
) {
350 // Change my width/height, and pull the cursor in as needed.
351 if (resize
.getType() == TResizeEvent
.Type
.WIDGET
) {
352 setWidth(resize
.getWidth());
353 setHeight(resize
.getHeight());
354 // See if the cursor is now outside the window, and if so move
356 if (getCursorX() >= getWidth()) {
357 leftColumn
+= getCursorX() - (getWidth() - 1);
358 setCursorX(getWidth() - 1);
360 if (getCursorY() >= getHeight()) {
361 topLine
+= getCursorY() - (getHeight() - 1);
362 setCursorY(getHeight() - 1);
365 // Let superclass handle it
366 super.onResize(resize
);
371 * Get the number of lines in the underlying Document.
373 * @return the number of lines
375 public int getLineCount() {
376 return document
.getLineCount();
380 * Get the current editing row number. 1-based.
382 * @return the editing row number. Row 1 is the first row.
384 public int getEditingRowNumber() {
385 return document
.getLineNumber() + 1;
389 * Set the current editing row number. 1-based.
391 * @param row the new editing row number. Row 1 is the first row.
393 public void setEditingRowNumber(final int row
) {
395 if ((row
> 0) && (row
< document
.getLineCount())) {
396 document
.setLineNumber(row
- 1);
402 * Get the current editing column number. 1-based.
404 * @return the editing column number. Column 1 is the first column.
406 public int getEditingColumnNumber() {
407 return document
.getCursor() + 1;
411 * Set the current editing column number. 1-based.
413 * @param column the new editing column number. Column 1 is the first
416 public void setEditingColumnNumber(final int column
) {
417 if ((column
> 0) && (column
< document
.getLineLength())) {
418 document
.setCursor(column
- 1);
424 * Get the maximum possible row number. 1-based.
426 * @return the maximum row number. Row 1 is the first row.
428 public int getMaximumRowNumber() {
429 return document
.getLineCount() + 1;
433 * Get the maximum possible column number. 1-based.
435 * @return the maximum column number. Column 1 is the first column.
437 public int getMaximumColumnNumber() {
438 return document
.getLineLengthMax() + 1;
442 * Get the dirty value.
444 * @return true if the buffer is dirty
446 public boolean isDirty() {
447 return document
.isDirty();
451 * Save contents to file.
453 * @param filename file to save to
454 * @throws IOException if a java.io operation throws
456 public void saveToFilename(final String filename
) throws IOException
{
457 document
.saveToFilename(filename
);