com.smartbear.testleft.testobjects

Interface Control

All Superinterfaces:

ObjectTreeNode, TestObject, VisualObject

All Known Subinterfaces:

Accordion, AccordionWithClosableItems, AccordionWithPinnableItems, AngularUICalendar, Bar, BootstrapAlert, BootstrapCarousel, BootstrapDropdown, BootstrapModal, BorlandActionMainMenuOwner, Button, CheckBox, CheckedListBox, ClosableTabControl, ComboBox, ComboBoxMulti, ComponentOneMainMenuOwner, ConsoleWindow, DatePicker, DatePickerNullable, DevExpressQuantumGrid, DevExpressQuantumTreeList, DevExpressVCLSpinButton, DevExpressWebMenu, DevExpressWebTabControl, DevExpressWPFButtonEdit, DevExpressWPFGridControl, DevExpressXtraEditWithButtons, DevExpressXtraGrid, DevExpressXtraMainMenuOwner, DevExpressXtraPopupMenu, DevExpressXtraPopupMenuOwner, DevExpressXtraTextEdit, DevExpressXtraTreeList, DevExpressXtraVerticalGrid, DropDown, DropDownButton, DropDownWithText, Expander, ExplorerBar, ExtJSComboBox, ExtJSMultiSlider, ExtJSPanel, ExtJSSingleSlider, ExtJSTimeField, ExtJSToggleSplitButton, ExtJSTreePanelView, GridView, GridViewWithGroups, GWTMenuBar, HyperLink, IjQueryMobileListView, IjQueryMobileMultipleSelectMenu, IjQueryMobileRangeSlider, IjQueryUISlider, InfragisticsDockablePane, InfragisticsEditWithButtons, InfragisticsUltraGridRowView, InfragisticsUltraListView, InfragisticsUltraMainMenuOwner, InfragisticsUltraPopupMenuOwner, InfragisticsWebDataGrid, InfragisticsWebDateTimeEdit, InfragisticsWebNumericEdit, InfragisticsXamDataGrid, JanusMainMenuOwner, JavaFXMenuBar, JavaFXPopupMenuOwner, JComponent, JMenuBar, JPasswordField, ListBox, MFCEditBrowse, MooToolsSlider, MSAAObject, MxDateField, MxSlider, OpenFileDialog, PropertyGridView, QtDateTimeEdit, QtDoubleSpinBox, QtLineEdit, QtMenu, QtMenuBar, QtSpinBox, QtTableWidget, QtToolButton, QtTreeWidget, QtWidget, RadioButton, RadioGroup, RichTextEdit, SaveFileDialog, ScrollBarInt, ScrollBarReal, ScrollViewInt, ScrollViewReal, SilverlightPasswordBox, StatusBar, StripMainMenuOwner, StripPopupMenuOwner, SyncfusionEssGrid, SyncfusionEssMainMenuOwner, TabControl, TelerikAgMaskedTextInput, TelerikAgSlider, TelerikRadGridView, TelerikSlRadGridView, TelerikWebMenu, TelerikWPFRadGridView, TextEdit, TimePicker, TimePickerNullable, ToggleButton, ToolBar, ToolbarWithDropDownMenu, TopLevelWindow, TrackBarInt, TrackBarReal, TreeView, TreeViewItemCheckable, TreeViewWithCheckableItems, TreeViewWithThreeStateCheckableItems, UpDownEdit, UpDownEditDateTime, UpDownEditInt, UpDownEditObject, UpDownEditReal, UpDownEditString, WebCell, WebElement, WebObject, WebPage, WebTable, WinButton, WinCheckBox, WinComboBox, WinDateTimePicker, Window, WinFormsLinkLabel, WinHeader, WinIPAddress, WinListBox, WinListView, WinMonthCalendar, WinPager, WinRadioButton, WinStatusBar, WinSysLink, WinTabControl, WinTextEdit, WinToolBar, WinTooltip, WinTrackBar, WinTreeView, WinTreeViewItem, WinUpDownEdit, WPFMenu, WPFPasswordEdit, WPFPopupMenuOwner, WPFRepeatButton, WPFTextEdit, WPFTrackBar, XceedGrid, XceedGridGroups, XULTree, YUI2Calendar, YUI2Carousel, YUI2DualSlider, YUI2SimpleEditor, YUI2Slider

public interface Control
extends ObjectTreeNode, VisualObject

Method Summary

Modifier and Type	Method and Description
void	click() Simulates a left-button single click in a window or control.
void	click(int clientX, int clientY) Simulates a left-button single click in a window or control.
void	click(int clientX, int clientY, ShiftKey shift) Simulates a left-button single click in a window or control.
void	clickM() Simulates a middle-button single click in a window or control.
void	clickM(int clientX, int clientY) Simulates a middle-button single click in a window or control.
void	clickM(int clientX, int clientY, ShiftKey shift) Simulates a middle-button single click in a window or control.
void	clickR() Simulates a right-button single click in a window or control.
void	clickR(int clientX, int clientY) Simulates a right-button single click in a window or control.
void	clickR(int clientX, int clientY, ShiftKey shift) Simulates a right-button single click in a window or control.
void	dblClick() Simulates a left-button double click in a window or control.
void	dblClick(int clientX, int clientY) Simulates a left-button double click in a window or control.
void	dblClick(int clientX, int clientY, ShiftKey shift) Simulates a left-button double click in a window or control.
void	dblClickM() Simulates a middle-button double click in a window or control.
void	dblClickM(int clientX, int clientY) Simulates a middle-button double click in a window or control.
void	dblClickM(int clientX, int clientY, ShiftKey shift) Simulates a middle-button double click in a window or control.
void	dblClickR() Simulates a right-button double click in a window or control.
void	dblClickR(int clientX, int clientY) Simulates a right-button double click in a window or control.
void	dblClickR(int clientX, int clientY, ShiftKey shift) Simulates a right-button double click in a window or control.
void	drag(int clientX, int clientY, int toX, int toY) Simulates a left-button mouse drag in a window or control.
void	drag(int clientX, int clientY, int toX, int toY, ShiftKey shift) Simulates a left-button mouse drag in a window or control.
void	dragM(int clientX, int clientY, int toX, int toY) Simulates a middle-button mouse drag in a window or control.
void	dragM(int clientX, int clientY, int toX, int toY, ShiftKey shift) Simulates a middle-button mouse drag in a window or control.
void	dragR(int clientX, int clientY, int toX, int toY) Simulates a right-button mouse drag in a window or control.
void	dragR(int clientX, int clientY, int toX, int toY, ShiftKey shift) Simulates a right-button mouse drag in a window or control.
boolean	getEnabled() Specifies whether the object is enabled or disabled.
int	getHeight() The object's height in pixels.
int	getScreenLeft() The horizontal position of the object's left edge in screen coordinates.
int	getScreenTop() The vertical position of the object's top edge in screen coordinates.
boolean	getVisible() Specifies whether an onscreen object is visible to users.
boolean	getVisibleOnScreen() Specifies whether the whole object or any of its parts is currently visible on screen.
int	getWidth() The object's width in pixels.
void	hoverMouse() Places the mouse pointer over the specified control.
void	hoverMouse(int clientX, int clientY) Places the mouse pointer over the specified control.
void	keys(String keys) Simulates keyboard input to a window or control.
void	mouseWheel(int delta) Simulates mouse wheel rotation.
void	mouseWheel(int delta, ShiftKey shift) Simulates mouse wheel rotation.
Point	screenToWindow(int x, int y) Converts screen coordinates to coordinates relative to the object.
Point	windowToScreen(int x, int y) Converts coordinates relative to the object to coordinates relative to screen.

Methods inherited from interface com.smartbear.testleft.testobjects.ObjectTreeNode

find, find, find, findAll, findAll, getChildren, getParent, tryFind, tryFind, tryFind, waitProperty, waitProperty

Methods inherited from interface com.smartbear.testleft.testobjects.VisualObject

picture, picture, picture

Methods inherited from interface com.smartbear.testleft.testobjects.TestObject

callMethod, callMethod, cast, getProperty, setProperty, toString

Method Detail

getWidth

int getWidth()
      throws InvocationException,
             HttpException

The object's width in pixels.

Returns:

Object width in pixels

Throws:

InvocationException - Will be thrown if invocation fails.

HttpException - Will be thrown if there are network problems.

getHeight

int getHeight()
       throws InvocationException,
              HttpException

The object's height in pixels.

Returns:

Object height in pixels

Throws:

InvocationException - Will be thrown if invocation fails.

HttpException - Will be thrown if there are network problems.

getScreenLeft

int getScreenLeft()
           throws InvocationException,
                  HttpException

The horizontal position of the object's left edge in screen coordinates.

Returns:

The horizontal position of the object's left edge in screen coordinates.

Throws:

InvocationException - Will be thrown if invocation fails.

HttpException - Will be thrown if there are network problems.

getScreenTop

int getScreenTop()
          throws InvocationException,
                 HttpException

The vertical position of the object's top edge in screen coordinates.

Returns:

The vertical position of the object's top edge in screen coordinates.

Throws:

InvocationException - Will be thrown if invocation fails.

HttpException - Will be thrown if there are network problems.

getVisible

boolean getVisible()
            throws InvocationException,
                   HttpException

Specifies whether an onscreen object is visible to users.

Returns:

Boolean that represent onscreen object is visible to users.

Throws:

InvocationException - Will be thrown if invocation fails.

HttpException - Will be thrown if there are network problems.

getVisibleOnScreen

boolean getVisibleOnScreen()
                    throws InvocationException,
                           HttpException

Specifies whether the whole object or any of its parts is currently visible on screen.

Returns:

Boolean that represent whole object or any of its parts is currently visible on screen

Throws:

InvocationException - Will be thrown if invocation fails.

HttpException - Will be thrown if there are network problems.

getEnabled

boolean getEnabled()
            throws InvocationException,
                   HttpException

Specifies whether the object is enabled or disabled.

Returns:

Boolean that represent object is enabled or disabled.

Throws:

InvocationException - Will be thrown if invocation fails.

HttpException - Will be thrown if there are network problems.

click

void click()
    throws InvocationException,
           HttpException

Simulates a left-button single click in a window or control.

Throws:

InvocationException - Will be thrown if invocation fails.

HttpException - Will be thrown if there are network problems.

click

void click(int clientX,
           int clientY)
    throws InvocationException,
           HttpException

Simulates a left-button single click in a window or control.

Parameters:

clientX - The X coordinate of the click point.

clientY - The Y coordinate of the click point.

Throws:

InvocationException - Will be thrown if invocation fails.

HttpException - Will be thrown if there are network problems.

click

void click(int clientX,
           int clientY,
           ShiftKey shift)
    throws InvocationException,
           HttpException

Simulates a left-button single click in a window or control.

Parameters:

clientX - The X coordinate of the click point.

clientY - The Y coordinate of the click point.

shift - The button that is pressed when a click is performed.

Throws:

InvocationException - Will be thrown if invocation fails.

HttpException - Will be thrown if there are network problems.

clickM

void clickM()
     throws InvocationException,
            HttpException

Simulates a middle-button single click in a window or control.

Throws:

InvocationException - Will be thrown if invocation fails.

HttpException - Will be thrown if there are network problems.

clickM

void clickM(int clientX,
            int clientY)
     throws InvocationException,
            HttpException

Simulates a middle-button single click in a window or control.

Parameters:

clientX - The X coordinate of the click point.

clientY - The Y coordinate of the click point.

Throws:

InvocationException - Will be thrown if invocation fails.

HttpException - Will be thrown if there are network problems.

clickM

void clickM(int clientX,
            int clientY,
            ShiftKey shift)
     throws InvocationException,
            HttpException

Simulates a middle-button single click in a window or control.

Parameters:

clientX - The X coordinate of the click point.

clientY - The Y coordinate of the click point.

shift - The button that is pressed when a click is performed.

Throws:

InvocationException - Will be thrown if invocation fails.

HttpException - Will be thrown if there are network problems.

clickR

void clickR()
     throws InvocationException,
            HttpException

Simulates a right-button single click in a window or control.

Throws:

InvocationException - Will be thrown if invocation fails.

HttpException - Will be thrown if there are network problems.

clickR

void clickR(int clientX,
            int clientY)
     throws InvocationException,
            HttpException

Simulates a right-button single click in a window or control.

Parameters:

clientX - The X coordinate of the click point.

clientY - The Y coordinate of the click point.

Throws:

InvocationException - Will be thrown if invocation fails.

HttpException - Will be thrown if there are network problems.

clickR

void clickR(int clientX,
            int clientY,
            ShiftKey shift)
     throws InvocationException,
            HttpException

Simulates a right-button single click in a window or control.

Parameters:

clientX - The X coordinate of the click point.

clientY - The Y coordinate of the click point.

shift - The button that is pressed when a click is performed.

Throws:

InvocationException - Will be thrown if invocation fails.

HttpException - Will be thrown if there are network problems.

dblClick

void dblClick()
       throws InvocationException,
              HttpException

Simulates a left-button double click in a window or control.

Throws:

InvocationException - Will be thrown if invocation fails.

HttpException - Will be thrown if there are network problems.

dblClick

void dblClick(int clientX,
              int clientY)
       throws InvocationException,
              HttpException

Simulates a left-button double click in a window or control.

Parameters:

clientX - The X coordinate of the click point.

clientY - The Y coordinate of the click point.

Throws:

InvocationException - Will be thrown if invocation fails.

HttpException - Will be thrown if there are network problems.

dblClick

void dblClick(int clientX,
              int clientY,
              ShiftKey shift)
       throws InvocationException,
              HttpException

Simulates a left-button double click in a window or control.

Parameters:

clientX - The X coordinate of the click point.

clientY - The Y coordinate of the click point.

shift - The button that is pressed when a click is performed.

Throws:

InvocationException - Will be thrown if invocation fails.

HttpException - Will be thrown if there are network problems.

dblClickM

void dblClickM()
        throws InvocationException,
               HttpException

Simulates a middle-button double click in a window or control.

Throws:

InvocationException - Will be thrown if invocation fails.

HttpException - Will be thrown if there are network problems.

dblClickM

void dblClickM(int clientX,
               int clientY)
        throws InvocationException,
               HttpException

Simulates a middle-button double click in a window or control.

Parameters:

clientX - The X coordinate of the click point.

clientY - The Y coordinate of the click point.

Throws:

InvocationException - Will be thrown if invocation fails.

HttpException - Will be thrown if there are network problems.

dblClickM

void dblClickM(int clientX,
               int clientY,
               ShiftKey shift)
        throws InvocationException,
               HttpException

Simulates a middle-button double click in a window or control.

Parameters:

clientX - The X coordinate of the click point.

clientY - The Y coordinate of the click point.

shift - The button that is pressed when a click is performed.

Throws:

InvocationException - Will be thrown if invocation fails.

HttpException - Will be thrown if there are network problems.

dblClickR

void dblClickR()
        throws InvocationException,
               HttpException

Simulates a right-button double click in a window or control.

Throws:

InvocationException - Will be thrown if invocation fails.

HttpException - Will be thrown if there are network problems.

dblClickR

void dblClickR(int clientX,
               int clientY)
        throws InvocationException,
               HttpException

Simulates a right-button double click in a window or control.

Parameters:

clientX - The X coordinate of the click point.

clientY - The Y coordinate of the click point.

Throws:

InvocationException - Will be thrown if invocation fails.

HttpException - Will be thrown if there are network problems.

dblClickR

void dblClickR(int clientX,
               int clientY,
               ShiftKey shift)
        throws InvocationException,
               HttpException

Simulates a right-button double click in a window or control.

Parameters:

clientX - The X coordinate of the click point.

clientY - The Y coordinate of the click point.

shift - The button that is pressed when a click is performed.

Throws:

InvocationException - Will be thrown if invocation fails.

HttpException - Will be thrown if there are network problems.

drag

void drag(int clientX,
          int clientY,
          int toX,
          int toY)
   throws InvocationException,
          HttpException

Simulates a left-button mouse drag in a window or control.

Parameters:

clientX - The X coordinate of the start position.

clientY - The Y coordinate of the start position.

toX - The X coordinate of the end position.

toY - The Y coordinate of the end position.

Throws:

InvocationException - Will be thrown if invocation fails.

HttpException - Will be thrown if there are network problems.

drag

void drag(int clientX,
          int clientY,
          int toX,
          int toY,
          ShiftKey shift)
   throws InvocationException,
          HttpException

Simulates a left-button mouse drag in a window or control.

Parameters:

clientX - The X coordinate of the start position.

clientY - The Y coordinate of the start position.

toX - The X coordinate of the end position.

toY - The Y coordinate of the end position.

shift - The button that is pressed when a click is performed.

Throws:

InvocationException - Will be thrown if invocation fails.

HttpException - Will be thrown if there are network problems.

dragM

void dragM(int clientX,
           int clientY,
           int toX,
           int toY)
    throws InvocationException,
           HttpException

Simulates a middle-button mouse drag in a window or control.

Parameters:

clientX - The X coordinate of the start position.

clientY - The Y coordinate of the start position.

toX - The X coordinate of the end position.

toY - The Y coordinate of the end position.

Throws:

InvocationException - Will be thrown if invocation fails.

HttpException - Will be thrown if there are network problems.

dragM

void dragM(int clientX,
           int clientY,
           int toX,
           int toY,
           ShiftKey shift)
    throws InvocationException,
           HttpException

Simulates a middle-button mouse drag in a window or control.

Parameters:

clientX - The X coordinate of the start position.

clientY - The Y coordinate of the start position.

toX - The X coordinate of the end position.

toY - The Y coordinate of the end position.

shift - The button that is pressed when a click is performed.

Throws:

InvocationException - Will be thrown if invocation fails.

HttpException - Will be thrown if there are network problems.

dragR

void dragR(int clientX,
           int clientY,
           int toX,
           int toY)
    throws InvocationException,
           HttpException

Simulates a right-button mouse drag in a window or control.

Parameters:

clientX - The X coordinate of the start position.

clientY - The Y coordinate of the start position.

toX - The X coordinate of the end position.

toY - The Y coordinate of the end position.

Throws:

InvocationException - Will be thrown if invocation fails.

HttpException - Will be thrown if there are network problems.

dragR

void dragR(int clientX,
           int clientY,
           int toX,
           int toY,
           ShiftKey shift)
    throws InvocationException,
           HttpException

Simulates a right-button mouse drag in a window or control.

Parameters:

clientX - The X coordinate of the start position.

clientY - The Y coordinate of the start position.

toX - The X coordinate of the end position.

toY - The Y coordinate of the end position.

shift - The button that is pressed when a click is performed.

Throws:

InvocationException - Will be thrown if invocation fails.

HttpException - Will be thrown if there are network problems.

hoverMouse

void hoverMouse()
         throws InvocationException,
                HttpException

Places the mouse pointer over the specified control.

Throws:

InvocationException - Will be thrown if invocation fails.

HttpException - Will be thrown if there are network problems.

hoverMouse

void hoverMouse(int clientX,
                int clientY)
         throws InvocationException,
                HttpException

Places the mouse pointer over the specified control.

Parameters:

clientX - The X coordinate of the target position.

clientY - The Y coordinate of the target position.

Throws:

InvocationException - Will be thrown if invocation fails.

HttpException - Will be thrown if there are network problems.

keys

void keys(String keys)
   throws InvocationException,
          HttpException

Simulates keyboard input to a window or control.

Parameters:

keys - The keystrokes to be simulated. Can include alphanumeric characters and special key codes (CRTL, ALT and others). To learn more about the keystroke format, see Simulating Keystrokes in TestLeft documentation.

Throws:

InvocationException - Will be thrown if invocation fails.

HttpException - Will be thrown if there are network problems.

mouseWheel

void mouseWheel(int delta)
         throws InvocationException,
                HttpException

Simulates mouse wheel rotation.

Parameters:

delta - Delta indicates the distance the wheel is rotated (a positive value indicates that the wheel was rotated forward, away from the user; a negative value indicates that the wheel was rotated backward, toward the user).

Throws:

InvocationException - Will be thrown if invocation fails.

HttpException - Will be thrown if there are network problems.

mouseWheel

void mouseWheel(int delta,
                ShiftKey shift)
         throws InvocationException,
                HttpException

Simulates mouse wheel rotation.

Parameters:

delta - Delta indicates the distance the wheel is rotated (a positive value indicates that the wheel was rotated forward, away from the user; a negative value indicates that the wheel was rotated backward, toward the user).

shift - The button that is pressed when a wheel action is performed.

Throws:

InvocationException - Will be thrown if invocation fails.

HttpException - Will be thrown if there are network problems.

screenToWindow

Point screenToWindow(int x,
                     int y)
              throws InvocationException,
                     HttpException

Converts screen coordinates to coordinates relative to the object.

Parameters:

x - An X coordinate.

y - A Y coordinate.

Returns:

The Point object that represents the result of the conversion.

Throws:

InvocationException - Will be thrown if invocation fails.

HttpException - Will be thrown if there are network problems.

windowToScreen

Point windowToScreen(int x,
                     int y)
              throws InvocationException,
                     HttpException

Converts coordinates relative to the object to coordinates relative to screen.

Parameters:

x - An X coordinate.

y - A Y coordinate.

Returns:

The Point object that represents the result of the conversion.

Throws:

InvocationException - Will be thrown if invocation fails.

HttpException - Will be thrown if there are network problems.