001: /*
002: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
003: *
004: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
005: *
006: * The contents of this file are subject to the terms of either the GNU
007: * General Public License Version 2 only ("GPL") or the Common
008: * Development and Distribution License("CDDL") (collectively, the
009: * "License"). You may not use this file except in compliance with the
010: * License. You can obtain a copy of the License at
011: * http://www.netbeans.org/cddl-gplv2.html
012: * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
013: * specific language governing permissions and limitations under the
014: * License. When distributing the software, include this License Header
015: * Notice in each file and include the License file at
016: * nbbuild/licenses/CDDL-GPL-2-CP. Sun designates this
017: * particular file as subject to the "Classpath" exception as provided
018: * by Sun in the GPL Version 2 section of the License file that
019: * accompanied this code. If applicable, add the following below the
020: * License Header, with the fields enclosed by brackets [] replaced by
021: * your own identifying information:
022: * "Portions Copyrighted [year] [name of copyright owner]"
023: *
024: * Contributor(s): Alexandre Iline.
025: *
026: * The Original Software is the Jemmy library.
027: * The Initial Developer of the Original Software is Alexandre Iline.
028: * All Rights Reserved.
029: *
030: * If you wish your version of this file to be governed by only the CDDL
031: * or only the GPL Version 2, indicate your decision by adding
032: * "[Contributor] elects to include this software in this distribution
033: * under the [CDDL or GPL Version 2] license." If you do not indicate a
034: * single choice of license, a recipient has the option to distribute
035: * your version of this file under either the CDDL, the GPL Version 2 or
036: * to extend the choice of license to its licensees as provided above.
037: * However, if you add GPL Version 2 code and therefore, elected the GPL
038: * Version 2 license, then the option applies only if the new code is
039: * made subject to such option by the copyright holder.
040: *
041: *
042: *
043: * $Id: MouseDriver.java,v 1.6 2007/10/05 11:36:23 jskrivanek Exp $ $Revision: 1.6 $ $Date: 2007/10/05 11:36:23 $
044: *
045: */
046:
047: package org.netbeans.jemmy.drivers;
048:
049: import org.netbeans.jemmy.Timeout;
050:
051: import org.netbeans.jemmy.operators.ComponentOperator;
052:
053: /**
054: * Defines how to simulate mouse operations.
055: */
056: public interface MouseDriver {
057:
058: /**
059: * Presses mouse.
060: * @param oper Component operator.
061: * @param x Relative x coordinate.
062: * @param y Relative y coordinate.
063: * @param mouseButton mouse button (<code>InputEvent.BUTTON*_MASK</code> field)
064: * @param modifiers a combination of <code>InputEvent.*_MASK</code> fields.
065: */
066: public void pressMouse(ComponentOperator oper, int x, int y,
067: int mouseButton, int modifiers);
068:
069: /**
070: * Releases mouse.
071: * @param oper Component operator.
072: * @param x Relative x coordinate.
073: * @param y Relative y coordinate.
074: * @param mouseButton mouse button (<code>InputEvent.BUTTON*_MASK</code> field)
075: * @param modifiers a combination of <code>InputEvent.*_MASK</code> fields.
076: */
077: public void releaseMouse(ComponentOperator oper, int x, int y,
078: int mouseButton, int modifiers);
079:
080: /**
081: * Clicks mouse.
082: * @param oper Component operator.
083: * @param x Relative x coordinate.
084: * @param y Relative y coordinate.
085: * @param clickCount How many times to click.
086: * @param mouseButton mouse button (<code>InputEvent.BUTTON*_MASK</code> field)
087: * @param modifiers a combination of <code>InputEvent.*_MASK</code> fields.
088: * @param mouseClick Time between pressing and releasing mouse.
089: */
090: public void clickMouse(ComponentOperator oper, int x, int y,
091: int clickCount, int mouseButton, int modifiers,
092: Timeout mouseClick);
093:
094: /**
095: * Moves mouse.
096: * @param oper Component operator.
097: * @param x Relative x coordinate.
098: * @param y Relative y coordinate.
099: */
100: public void moveMouse(ComponentOperator oper, int x, int y);
101:
102: /**
103: * Drags mouse.
104: * @param oper Component operator.
105: * @param x Relative x coordinate.
106: * @param y Relative y coordinate.
107: * @param mouseButton mouse button (<code>InputEvent.BUTTON*_MASK</code> field)
108: * @param modifiers a combination of <code>InputEvent.*_MASK</code> fields.
109: */
110: public void dragMouse(ComponentOperator oper, int x, int y,
111: int mouseButton, int modifiers);
112:
113: /**
114: * Performs drag'n'drop.
115: * @param oper Component operator.
116: * @param start_x Relative x coordinate of start point.
117: * @param start_y Relative y coordinate of start point.
118: * @param end_x Relative x coordinate of end point.
119: * @param end_y Relative y coordinate of end point.
120: * @param mouseButton mouse button (<code>InputEvent.BUTTON*_MASK</code> field)
121: * @param modifiers a combination of <code>InputEvent.*_MASK</code> fields.
122: * @param before Time to sleep after taking (before dragging)
123: * @param after Time to sleep before dropping (after dragging)
124: */
125: public void dragNDrop(ComponentOperator oper, int start_x,
126: int start_y, int end_x, int end_y, int mouseButton,
127: int modifiers, Timeout before, Timeout after);
128:
129: /**
130: * Moves mouse inside a component.
131: * @param oper Component operator.
132: */
133: public void enterMouse(ComponentOperator oper);
134:
135: /**
136: * Moves mouse outside a component.
137: * @param oper Component operator.
138: */
139: public void exitMouse(ComponentOperator oper);
140: }
|