1 /*
2  * Copyright (c) 1997, 2016, Oracle and/or its affiliates. All rights reserved.
3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4  *
5  * This code is free software; you can redistribute it and/or modify it
6  * under the terms of the GNU General Public License version 2 only, as
7  * published by the Free Software Foundation. Oracle designates this
8  * particular file as subject to the "Classpath" exception as provided
9  * by Oracle in the LICENSE file that accompanied this code.
10  *
11  * This code is distributed in the hope that it will be useful, but WITHOUT
12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
14  * version 2 for more details (a copy is included in the LICENSE file that
15  * accompanied this code).
16  *
17  * You should have received a copy of the GNU General Public License version
18  * 2 along with this work; if not, write to the Free Software Foundation,
19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20  *
21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22  * or visit www.oracle.com if you need additional information or have any
23  * questions.
24  */
25 package org.netbeans.jemmy.drivers;
26 
27 import org.netbeans.jemmy.operators.ComponentOperator;
28 
29 /**
30  * Defines how to work with text components.
31  *
32  * @author Alexandre Iline (alexandre.iline@oracle.com)
33  */
34 public interface TextDriver {
35 
36     /**
37      * Moves caret.
38      *
39      * @param oper Text component operator.
40      * @param position Position to move caret to.
41      */
changeCaretPosition(ComponentOperator oper, int position)42     public void changeCaretPosition(ComponentOperator oper, int position);
43 
44     /**
45      * Selects text.
46      *
47      * @param oper Text component operator.
48      * @param startPosition a posistion of selction start
49      * @param finalPosition a posistion of selction end
50      */
selectText(ComponentOperator oper, int startPosition, int finalPosition)51     public void selectText(ComponentOperator oper, int startPosition, int finalPosition);
52 
53     /**
54      * Clears component text.
55      *
56      * @param oper Text component operator.
57      */
clearText(ComponentOperator oper)58     public void clearText(ComponentOperator oper);
59 
60     /**
61      * Types new text.
62      *
63      * @param oper Text component operator.
64      * @param text New text to type.
65      * @param caretPosition Type text at that position.
66      */
typeText(ComponentOperator oper, String text, int caretPosition)67     public void typeText(ComponentOperator oper, String text, int caretPosition);
68 
69     /**
70      * Replace component text.
71      *
72      * @param oper Text component operator.
73      * @param text New text to type.
74      */
changeText(ComponentOperator oper, String text)75     public void changeText(ComponentOperator oper, String text);
76 
77     /**
78      * Type text and push enter.
79      *
80      * @param oper Text component operator.
81      * @param text New text to type.
82      */
enterText(ComponentOperator oper, String text)83     public void enterText(ComponentOperator oper, String text);
84 }
85