com.smartbear.testleft.testobjects

Interface ObjectTreeNode

All Superinterfaces:

TestObject

All Known Subinterfaces:

Accordion, AccordionWithClosableItems, AccordionWithPinnableItems, AngularUICalendar, Bar, BootstrapAlert, BootstrapCarousel, BootstrapDropdown, BootstrapModal, BorlandActionMainMenuOwner, Button, CheckBox, CheckedListBox, ClosableTabControl, ComboBox, ComboBoxMulti, ComponentOneMainMenuOwner, ConsoleWindow, Control, 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, TestProcess, TextEdit, TimePicker, TimePickerNullable, ToggleButton, ToolBar, ToolbarWithDropDownMenu, TopLevelWindow, TrackBarInt, TrackBarReal, TreeView, TreeViewItemCheckable, TreeViewWithCheckableItems, TreeViewWithThreeStateCheckableItems, UpDownEdit, UpDownEditDateTime, UpDownEditInt, UpDownEditObject, UpDownEditReal, UpDownEditString, WebBrowser, WebCell, WebElement, WebObject, WebPage, WebTable, WinButton, WinCheckBox, WinComboBox, WinDateTimePicker, Window, WinFormsLinkLabel, WinHeader, WinIPAddress, WinListBox, WinListView, WinMonthCalendar, WinPager, WinRadioButton, WinRTProcess, 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 ObjectTreeNode
extends TestObject

The basic interface for test objects that correspond to processes, windows, and controls.

Method Summary

Modifier and Type	Method and Description
<T extends ObjectTreeNode> T	find(Class clazz, SearchPattern pattern) Searches for an object that matches the specified pattern.
<T extends ObjectTreeNode> T	find(Class clazz, SearchPattern pattern, int depth) Searches for an object that matches the specified pattern.
<T extends ObjectTreeNode> T	find(Class clazz, SearchPattern pattern, int depth, int timeout) Searches for an object that matches the specified pattern.
<T extends ObjectTreeNode> List<T>	findAll(Class clazz, SearchPattern pattern) Searches for objects that match the specified pattern.
<T extends ObjectTreeNode> List<T>	findAll(Class clazz, SearchPattern pattern, int depth) Searches for objects that match the specified pattern.
List<ObjectTreeNode>	getChildren() Gets the collection of child objects.
ObjectTreeNode	getParent() The parent object.
<T extends ObjectTreeNode> FindResult<T>	tryFind(Class clazz, SearchPattern pattern) Searches for an object that matches the specified pattern.
<T extends ObjectTreeNode> FindResult<T>	tryFind(Class clazz, SearchPattern pattern, int depth) Searches for an object that matches the specified pattern.
<T extends ObjectTreeNode> FindResult<T>	tryFind(Class clazz, SearchPattern pattern, int depth, Integer timeout) Searches for an object that matches the specified pattern.
boolean	waitProperty(String propertyName, Object propertyValue) Delays the test execution until the specified property equals the specified value or until the default time limit @link options.generalSettings.autoWaitTimeout is reached.
boolean	waitProperty(String propertyName, Object propertyValue, int timeout) Delays the test execution until the specified property equals the specified value or until the specified time limit is reached.

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

callMethod, callMethod, cast, getProperty, setProperty, toString

Method Detail

find

<T extends ObjectTreeNode> T find(Class clazz,
                                  SearchPattern pattern)
                           throws ObjectTreeNodeNotFoundException,
                                  HttpException

Searches for an object that matches the specified pattern.

Type Parameters:

T - The interface that will be implemented in the returned object.

Parameters:

clazz - The interface that will be implemented in the returned object.

pattern - The search pattern.

Returns:

The found object.

Throws:

ObjectTreeNodeNotFoundException - Will be thrown if no object that meets the specified criteria is found.

HttpException - Thrown if there are network problems.

find

<T extends ObjectTreeNode> T find(Class clazz,
                                  SearchPattern pattern,
                                  int depth)
                           throws ObjectTreeNodeNotFoundException,
                                  HttpException

Searches for an object that matches the specified pattern.

Type Parameters:

T - The interface that will be implemented in the returned object.

Parameters:

clazz - The interface that will be implemented in the returned object.

pattern - The search pattern.

depth - The search depth.

Returns:

The found object.

Throws:

ObjectTreeNodeNotFoundException - Will be thrown if no object that meets the specified criteria is found.

HttpException - Thrown if there are network problems.

find

<T extends ObjectTreeNode> T find(Class clazz,
                                  SearchPattern pattern,
                                  int depth,
                                  int timeout)
                           throws ObjectTreeNodeNotFoundException,
                                  HttpException

Searches for an object that matches the specified pattern.

Type Parameters:

T - The interface that will be implemented in the returned object.

Parameters:

clazz - The interface that will be implemented in the returned object.

pattern - The search pattern.

depth - The search depth.

timeout - The timeout, in milliseconds, used to wait for the object.

Returns:

The found object.

Throws:

ObjectTreeNodeNotFoundException - Will be thrown if no object that meets the specified criteria is found.

HttpException - Thrown if there are network problems.

findAll

<T extends ObjectTreeNode> List<T> findAll(Class clazz,
                                           SearchPattern pattern)
                                    throws HttpException

Searches for objects that match the specified pattern.

Type Parameters:

T - The interface of the elements in the returned sequence.

Parameters:

clazz - The interface of the elements in the returned sequence.

pattern - The search pattern.

Returns:

The sequence of the found objects.

Throws:

HttpException - Thrown if there are network problems.

findAll

<T extends ObjectTreeNode> List<T> findAll(Class clazz,
                                           SearchPattern pattern,
                                           int depth)
                                    throws HttpException

Searches for objects that match the specified pattern.

Type Parameters:

T - The interface of the elements in the returned sequence.

Parameters:

clazz - The interface of the elements in the returned sequence.

pattern - The search pattern.

depth - The search depth.

Returns:

The sequence of the found objects.

Throws:

HttpException - Thrown if there are network problems.

tryFind

<T extends ObjectTreeNode> FindResult<T> tryFind(Class clazz,
                                                 SearchPattern pattern)
                                          throws HttpException

Searches for an object that matches the specified pattern.

Type Parameters:

T - The interface that will be implemented in the returned object.

Parameters:

clazz - The interface that will be implemented in the returned object.

pattern - The search pattern.

Returns:

The object that contains the search result and the found object.

Throws:

HttpException - Thrown if there are network problems.

tryFind

<T extends ObjectTreeNode> FindResult<T> tryFind(Class clazz,
                                                 SearchPattern pattern,
                                                 int depth)
                                          throws HttpException

Searches for an object that matches the specified pattern.

Type Parameters:

T - The interface that will be implemented in the returned object.

Parameters:

clazz - The interface that will be implemented in the returned object.

pattern - The search pattern.

depth - The search depth.

Returns:

The object that contains the search result and the found object.

Throws:

HttpException - Thrown if there are network problems.

tryFind

<T extends ObjectTreeNode> FindResult<T> tryFind(Class clazz,
                                                 SearchPattern pattern,
                                                 int depth,
                                                 Integer timeout)
                                          throws HttpException

Searches for an object that matches the specified pattern.

Type Parameters:

T - The interface that will be implemented in the returned object.

Parameters:

clazz - The interface that will be implemented in the returned object.

pattern - The search pattern.

depth - The search depth.

timeout - The timeout used to wait for the object.

Returns:

The object that contains the search result and the found object.

Throws:

HttpException - Thrown if there are network problems.

getParent

ObjectTreeNode getParent()
                  throws InvocationException,
                         HttpException

The parent object.

Returns:

The parent object.

Throws:

InvocationException - Will be thrown if invocation fails.

HttpException - Will be thrown if there are network problems.

waitProperty

boolean waitProperty(String propertyName,
                     Object propertyValue)
              throws InvocationException,
                     HttpException

Delays the test execution until the specified property equals the specified value or until the default time limit @link options.generalSettings.autoWaitTimeout is reached.

Parameters:

propertyName - The property name.

propertyValue - The property value.

Returns:

True if the specified property equals the specified value; else, false.

Throws:

InvocationException - Will be thrown if invocation fails.

HttpException - Will be thrown if there are network problems.

waitProperty

boolean waitProperty(String propertyName,
                     Object propertyValue,
                     int timeout)
              throws InvocationException,
                     HttpException

Delays the test execution until the specified property equals the specified value or until the specified time limit is reached.

Parameters:

propertyName - The property name.

propertyValue - The property value.

timeout - The time limit.

Returns:

True if the specified property equals the specified value; else, false.

Throws:

InvocationException - Will be thrown if invocation fails.

HttpException - Will be thrown if there are network problems.

getChildren

List<ObjectTreeNode> getChildren()
                          throws InvocationException,
                                 HttpException

Gets the collection of child objects.

Returns:

A list of child objects.

Throws:

InvocationException - Will be thrown if invocation fails.

HttpException - Will be thrown if there are network problems.