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]
29 package jexer
.teditor
;
31 import java
.util
.ArrayList
;
32 import java
.util
.List
;
34 import jexer
.bits
.CellAttributes
;
37 * A Line represents a single line of text on the screen, as a collection of
45 private ArrayList
<Word
> words
= new ArrayList
<Word
>();
48 * The default color for the TEditor class.
50 private CellAttributes defaultColor
= null;
53 * The text highlighter to use.
55 private Highlighter highlighter
= null;
58 * The current cursor position on this line.
60 private int cursor
= 0;
63 * The raw text of this line, what is passed to Word to determine
64 * highlighting behavior.
66 private StringBuilder rawText
;
69 * Get a (shallow) copy of the words in this line.
71 * @return a copy of the word list
73 public List
<Word
> getWords() {
74 return new ArrayList
<Word
>(words
);
78 * Get the current cursor position.
80 * @return the cursor position
82 public int getCursor() {
87 * Set the current cursor position.
89 * @param cursor the new cursor position
91 public void setCursor(final int cursor
) {
93 || ((cursor
>= getDisplayLength())
94 && (getDisplayLength() > 0))
96 throw new IndexOutOfBoundsException("Max length is " +
97 getDisplayLength() + ", requested position " + cursor
);
103 * Get the on-screen display length.
105 * @return the number of cells needed to display this line
107 public int getDisplayLength() {
108 int n
= rawText
.length();
110 // For now just return the raw text length.
112 // If we have any visible characters, add one to the display so
113 // that the cursor is immediately after the data.
120 * Get the raw string that matches this line.
124 public String
getRawString() {
125 return rawText
.toString();
129 * Scan rawText and make words out of it.
131 private void scanLine() {
133 Word word
= new Word(this.defaultColor
, this.highlighter
);
135 for (int i
= 0; i
< rawText
.length(); i
++) {
136 char ch
= rawText
.charAt(i
);
137 Word newWord
= word
.addChar(ch
);
138 if (newWord
!= word
) {
143 for (Word w
: words
) {
149 * Construct a new Line from an existing text string, and highlight
152 * @param str the text string
153 * @param defaultColor the color for unhighlighted text
154 * @param highlighter the highlighter to use
156 public Line(final String str
, final CellAttributes defaultColor
,
157 final Highlighter highlighter
) {
159 this.defaultColor
= defaultColor
;
160 this.highlighter
= highlighter
;
161 this.rawText
= new StringBuilder(str
);
167 * Construct a new Line from an existing text string.
169 * @param str the text string
170 * @param defaultColor the color for unhighlighted text
172 public Line(final String str
, final CellAttributes defaultColor
) {
173 this(str
, defaultColor
, null);
177 * Decrement the cursor by one. If at the first column, do nothing.
179 * @return true if the cursor position changed
181 public boolean left() {
190 * Increment the cursor by one. If at the last column, do nothing.
192 * @return true if the cursor position changed
194 public boolean right() {
195 if (getDisplayLength() == 0) {
198 if (cursor
== getDisplayLength() - 1) {
206 * Go to the first column of this line.
208 * @return true if the cursor position changed
210 public boolean home() {
219 * Go to the last column of this line.
221 * @return true if the cursor position changed
223 public boolean end() {
224 if (cursor
!= getDisplayLength() - 1) {
225 cursor
= getDisplayLength() - 1;
235 * Delete the character under the cursor.
238 assert (words
.size() > 0);
240 if (cursor
< getDisplayLength()) {
241 rawText
.deleteCharAt(cursor
);
244 // Re-scan the line to determine the new word boundaries.
249 * Delete the character immediately preceeding the cursor.
251 public void backspace() {
258 * Insert a character at the cursor.
260 * @param ch the character to insert
262 public void addChar(final char ch
) {
263 if (cursor
< getDisplayLength() - 1) {
264 rawText
.insert(cursor
, ch
);
273 * Replace a character at the cursor.
275 * @param ch the character to replace
277 public void replaceChar(final char ch
) {
278 if (cursor
< getDisplayLength() - 1) {
279 rawText
.setCharAt(cursor
, ch
);