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