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]
29 package jexer
.teditor
;
31 import java
.util
.ArrayList
;
32 import java
.util
.List
;
34 import jexer
.bits
.CellAttributes
;
35 import jexer
.bits
.StringUtils
;
38 * A Line represents a single line of text on the screen, as a collection of
43 // ------------------------------------------------------------------------
44 // Variables --------------------------------------------------------------
45 // ------------------------------------------------------------------------
50 private ArrayList
<Word
> words
= new ArrayList
<Word
>();
53 * The default color for the TEditor class.
55 private CellAttributes defaultColor
= null;
58 * The text highlighter to use.
60 private Highlighter highlighter
= null;
63 * The current cursor position on this line.
65 private int cursor
= 0;
68 * The raw text of this line, what is passed to Word to determine
69 * highlighting behavior.
71 private StringBuilder rawText
;
73 // ------------------------------------------------------------------------
74 // Constructors -----------------------------------------------------------
75 // ------------------------------------------------------------------------
78 * Construct a new Line from an existing text string, and highlight
81 * @param str the text string
82 * @param defaultColor the color for unhighlighted text
83 * @param highlighter the highlighter to use
85 public Line(final String str
, final CellAttributes defaultColor
,
86 final Highlighter highlighter
) {
88 this.defaultColor
= defaultColor
;
89 this.highlighter
= highlighter
;
90 this.rawText
= new StringBuilder(str
);
96 * Construct a new Line from an existing text string.
98 * @param str the text string
99 * @param defaultColor the color for unhighlighted text
101 public Line(final String str
, final CellAttributes defaultColor
) {
102 this(str
, defaultColor
, null);
105 // ------------------------------------------------------------------------
106 // Line -------------------------------------------------------------------
107 // ------------------------------------------------------------------------
110 * Get a (shallow) copy of the words in this line.
112 * @return a copy of the word list
114 public List
<Word
> getWords() {
115 return new ArrayList
<Word
>(words
);
119 * Get the current cursor position.
121 * @return the cursor position
123 public int getCursor() {
128 * Set the current cursor position.
130 * @param cursor the new cursor position
132 public void setCursor(final int cursor
) {
134 || ((cursor
>= getDisplayLength())
135 && (getDisplayLength() > 0))
137 throw new IndexOutOfBoundsException("Max length is " +
138 getDisplayLength() + ", requested position " + cursor
);
140 this.cursor
= cursor
;
144 * Get the on-screen display length.
146 * @return the number of cells needed to display this line
148 public int getDisplayLength() {
149 int n
= StringUtils
.width(rawText
.toString());
151 // For now just return the raw text length.
153 // If we have any visible characters, add one to the display so
154 // that the cursor is immediately after the data.
161 * Get the raw string that matches this line.
165 public String
getRawString() {
166 return rawText
.toString();
170 * Scan rawText and make words out of it.
172 private void scanLine() {
174 Word word
= new Word(this.defaultColor
, this.highlighter
);
176 for (int i
= 0; i
< rawText
.length();) {
177 int ch
= rawText
.codePointAt(i
);
178 i
+= Character
.charCount(ch
);
179 Word newWord
= word
.addChar(ch
);
180 if (newWord
!= word
) {
185 for (Word w
: words
) {
191 * Decrement the cursor by one. If at the first column, do nothing.
193 * @return true if the cursor position changed
195 public boolean left() {
199 cursor
-= StringUtils
.width(rawText
.codePointAt(cursor
- 1));
204 * Increment the cursor by one. If at the last column, do nothing.
206 * @return true if the cursor position changed
208 public boolean right() {
209 if (getDisplayLength() == 0) {
212 if (cursor
== getDisplayLength() - 1) {
215 if (cursor
< getDisplayLength()) {
216 cursor
+= StringUtils
.width(rawText
.codePointAt(cursor
));
224 * Go to the first column of this line.
226 * @return true if the cursor position changed
228 public boolean home() {
237 * Go to the last column of this line.
239 * @return true if the cursor position changed
241 public boolean end() {
242 if (cursor
!= getDisplayLength() - 1) {
243 cursor
= getDisplayLength() - 1;
253 * Delete the character under the cursor.
256 assert (words
.size() > 0);
258 if (cursor
< getDisplayLength()) {
259 for (int i
= 0; i
< Character
.charCount(rawText
.charAt(cursor
)); i
++) {
260 rawText
.deleteCharAt(cursor
);
264 // Re-scan the line to determine the new word boundaries.
269 * Delete the character immediately preceeding the cursor.
271 public void backspace() {
278 * Insert a character at the cursor.
280 * @param ch the character to insert
282 public void addChar(final int ch
) {
283 if (cursor
< getDisplayLength() - 1) {
284 rawText
.insert(cursor
, Character
.toChars(ch
));
286 rawText
.append(Character
.toChars(ch
));
293 * Replace a character at the cursor.
295 * @param ch the character to replace
297 public void replaceChar(final int ch
) {
298 if (cursor
< getDisplayLength() - 1) {
299 for (int i
= 0; i
< Character
.charCount(rawText
.charAt(cursor
)); i
++) {
300 rawText
.deleteCharAt(cursor
);
302 rawText
.insert(cursor
, Character
.toChars(ch
));
304 rawText
.append(Character
.toChars(ch
));