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()) {
119 * Handle mouse press events.
121 * @param mouse mouse button press event
124 public void onMouseDown(final TMouseEvent mouse
) {
125 if (mouse
.isMouseWheelUp()) {
128 alignDocument(false);
132 if (mouse
.isMouseWheelDown()) {
133 if (topLine
< document
.getLineCount() - 1) {
140 if (mouse
.isMouse1()) {
141 // Set the row and column
142 int newLine
= topLine
+ mouse
.getY();
143 int newX
= leftColumn
+ mouse
.getX();
144 if (newLine
> document
.getLineCount()) {
146 document
.setLineNumber(document
.getLineCount() - 1);
148 if (document
.getLineCount() > getHeight()) {
149 setCursorY(getHeight() - 1);
151 setCursorY(document
.getLineCount() - 1);
157 document
.setLineNumber(newLine
);
158 setCursorY(mouse
.getY());
159 if (newX
> document
.getCurrentLine().getDisplayLength()) {
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);
192 System.err.println("line " + line + " topLine " + topLine);
195 // Document is in view, let's set cursorY
196 setCursorY(line
- topLine
);
201 * Align document current line with visible area.
203 * @param topLineIsTop if true, make the top visible line the document
204 * current line if it was off-screen. If false, make the bottom visible
205 * line the document current line.
207 private void alignDocument(final boolean topLineIsTop
) {
208 int line
= document
.getLineNumber();
210 if ((line
< topLine
) || (line
> topLine
+ getHeight() - 1)) {
211 // Need to move document to ensure it fits view.
213 document
.setLineNumber(topLine
);
215 document
.setLineNumber(topLine
+ (getHeight() - 1));
220 System.err.println("getLineNumber() " + document.getLineNumber() +
221 " topLine " + topLine);
224 // Document is in view, let's set cursorY
225 setCursorY(document
.getLineNumber() - topLine
);
230 * Align visible cursor with document cursor.
232 private void alignCursor() {
233 int width
= getWidth();
235 int desiredX
= document
.getCursor() - leftColumn
;
237 // We need to push the screen to the left.
238 leftColumn
= document
.getCursor();
239 } else if (desiredX
> width
- 1) {
240 // We need to push the screen to the right.
241 leftColumn
= document
.getCursor() - (width
- 1);
245 System.err.println("document cursor " + document.getCursor() +
246 " leftColumn " + leftColumn);
249 setCursorX(document
.getCursor() - leftColumn
);
255 * @param keypress keystroke event
258 public void onKeypress(final TKeypressEvent keypress
) {
259 if (keypress
.equals(kbLeft
)) {
260 if (document
.left()) {
263 } else if (keypress
.equals(kbRight
)) {
264 if (document
.right()) {
267 } else if (keypress
.equals(kbUp
)) {
270 } else if (keypress
.equals(kbDown
)) {
273 } else if (keypress
.equals(kbPgUp
)) {
274 document
.up(getHeight() - 1);
276 } else if (keypress
.equals(kbPgDn
)) {
277 document
.down(getHeight() - 1);
279 } else if (keypress
.equals(kbHome
)) {
280 if (document
.home()) {
282 if (leftColumn
< 0) {
287 } else if (keypress
.equals(kbEnd
)) {
288 if (document
.end()) {
291 } else if (keypress
.equals(kbCtrlHome
)) {
292 document
.setLineNumber(0);
298 } else if (keypress
.equals(kbCtrlEnd
)) {
299 document
.setLineNumber(document
.getLineCount() - 1);
302 } else if (keypress
.equals(kbIns
)) {
303 document
.setOverwrite(!document
.getOverwrite());
304 } else if (keypress
.equals(kbDel
)) {
308 } else if (keypress
.equals(kbBackspace
)) {
309 document
.backspace();
311 } else if (keypress
.equals(kbEnter
)) {
313 } else if (!keypress
.getKey().isFnKey()
314 && !keypress
.getKey().isAlt()
315 && !keypress
.getKey().isCtrl()
317 // Plain old keystroke, process it
318 document
.addChar(keypress
.getKey().getChar());
321 // Pass other keys (tab etc.) on to TWidget
322 super.onKeypress(keypress
);
327 * Method that subclasses can override to handle window/screen resize
330 * @param resize resize event
333 public void onResize(final TResizeEvent resize
) {
334 // Change my width/height, and pull the cursor in as needed.
335 if (resize
.getType() == TResizeEvent
.Type
.WIDGET
) {
336 setWidth(resize
.getWidth());
337 setHeight(resize
.getHeight());
338 // See if the cursor is now outside the window, and if so move
340 if (getCursorX() >= getWidth()) {
341 leftColumn
+= getCursorX() - (getWidth() - 1);
342 setCursorX(getWidth() - 1);
344 if (getCursorY() >= getHeight()) {
345 topLine
+= getCursorY() - (getHeight() - 1);
346 setCursorY(getHeight() - 1);
349 // Let superclass handle it
350 super.onResize(resize
);
355 * Get the number of lines in the underlying Document.
357 * @return the number of lines
359 public int getLineCount() {
360 return document
.getLineCount();
364 * Get the current editing row number. 1-based.
366 * @return the editing row number. Row 1 is the first row.
368 public int getEditingRowNumber() {
369 return document
.getLineNumber() + 1;
373 * Set the current editing row number. 1-based.
375 * @param row the new editing row number. Row 1 is the first row.
377 public void setEditingRowNumber(final int row
) {
378 document
.setLineNumber(row
- 1);
382 * Get the current editing column number. 1-based.
384 * @return the editing column number. Column 1 is the first column.
386 public int getEditingColumnNumber() {
387 return document
.getCursor() + 1;
391 * Set the current editing column number. 1-based.
393 * @param column the new editing column number. Column 1 is the first
396 public void setEditingColumnNumber(final int column
) {
397 document
.setCursor(column
- 1);
401 * Get the maximum possible row number. 1-based.
403 * @return the maximum row number. Row 1 is the first row.
405 public int getMaximumRowNumber() {
406 return document
.getLineCount() + 1;
410 * Get the maximum possible column number. 1-based.
412 * @return the maximum column number. Column 1 is the first column.
414 public int getMaximumColumnNumber() {
415 return document
.getLineLengthMax() + 1;
419 * Get the dirty value.
421 * @return true if the buffer is dirty
423 public boolean isDirty() {
424 return document
.isDirty();
428 * Save contents to file.
430 * @param filename file to save to
431 * @throws IOException if a java.io operation throws
433 public void saveToFilename(final String filename
) throws IOException
{
434 document
.saveToFilename(filename
);