1 /*
2 * Tethys: GUI Utilities
3 * Copyright 2012-2026. Tony Washer
4 *
5 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
6 * use this file except in compliance with the License. You may obtain a copy
7 * of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
13 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
14 * License for the specific language governing permissions and limitations under
15 * the License.
16 */
17 package io.github.tonywasher.joceanus.tethys.api.control;
18
19 import io.github.tonywasher.joceanus.tethys.api.base.TethysUIComponent;
20
21 /**
22 * Non-editable text area.
23 */
24 public interface TethysUITextArea
25 extends TethysUIComponent {
26 /**
27 * Set the text.
28 *
29 * @param pText the text
30 */
31 void setText(String pText);
32
33 /**
34 * Append the text.
35 *
36 * @param pText the text
37 */
38 void appendText(String pText);
39
40 /**
41 * Insert the text at position.
42 *
43 * @param pText the text
44 * @param pPos the position
45 */
46 void insertText(String pText,
47 int pPos);
48
49 /**
50 * replace the text at position.
51 *
52 * @param pText the text
53 * @param pStart the start position
54 * @param pEnd the end position
55 */
56 void replaceText(String pText,
57 int pStart,
58 int pEnd);
59
60 /**
61 * SetCaretPosition.
62 *
63 * @param pPos the position
64 */
65 void setCaretPosition(int pPos);
66
67 /**
68 * GetCaretPosition.
69 *
70 * @return the position
71 */
72 int getCaretPosition();
73
74 /**
75 * Obtain textLength.
76 *
77 * @return the length
78 */
79 int getTextLength();
80 }