Package com.hp.lft.sdk.ai

Interface AiObject

All Superinterfaces:

TestObject, TestObjectDescriber

public interface AiObject
extends TestObject

An object identified using Artificial intelligence.

Method Summary

Modifier and Type	Method	Description
void	click()	Clicks in the middle of the AI object.
void	doubleClick()	Double-clicks in the middle of the AI object.
String	getValue()	Returns the AI object's value.
void	hover()	Holds the cursor over an AI object.
void	hover(int duration)	Holds the cursor over an AI object for a given duration.
void	longClick()	Long-clicks in the middle of the AI object.
void	rightClick()	Right-clicks in the middle of the AI object.
void	search(String text)	Types the specified text into the search box and clicks the search icon.
void	select(String element)	Selects an item from a combo box.
void	select(String element, AiComboBoxSettings settings)	Selects an item from a combo box, using the specified settings.
void	sendKeys(String text)	Types the specified string into the AI object.
void	sendSecureKeys(String encodedText)	Types the specified encoded string into the AI object.
void	setState(ToggleState state)	Sets the state of a toggleable AI control.
void	setText(String text)	This method is relevant for AIObjects that represent text boxes, input controls, and combo boxes.

Methods inherited from interface com.hp.lft.sdk.TestObject

callFTMethod, callFTMethod, exists, exists, findChildren, getDescription, getDisplayName, getParent, getSnapshot, getTextLocations, getTextLocations, getVisibleText, getVisibleText, highlight, highlightMatches, setDescription, setDisplayName, verifyImageExists, verifyImageExists, verifyImageMatch, verifyImageMatch, verifyImageMatch, verifyImageMatch, verifyImageMatch, verifyImageMatch, waitUntilExists, waitUntilExists

Methods inherited from interface com.hp.lft.sdk.TestObjectDescriber

describe

Method Details

click

void click()
    throws GeneralLeanFtException

Clicks in the middle of the AI object.

Throws:

GeneralLeanFtException - if error occurs during execution

doubleClick

void doubleClick()
          throws GeneralLeanFtException

Double-clicks in the middle of the AI object. This method is not supported for mobile applications.

Throws:

GeneralLeanFtException - if error occurs during execution

longClick

void longClick()
        throws GeneralLeanFtException

Long-clicks in the middle of the AI object. This method is currently not supported for mobile applications. Will be implemented in the future.

Throws:

GeneralLeanFtException - if error occurs during execution

rightClick

void rightClick()
         throws GeneralLeanFtException

Right-clicks in the middle of the AI object. This method is not supported for mobile applications.

Throws:

GeneralLeanFtException - if error occurs during execution

sendKeys

void sendKeys(String text)
       throws GeneralLeanFtException

Types the specified string into the AI object.

Parameters:

text - the string to type in the AI object.

Throws:

GeneralLeanFtException - if error occurs during execution

search

void search(String text)
     throws GeneralLeanFtException

Types the specified text into the search box and clicks the search icon. This method is supported only for the 'search' AI class.

Parameters:

text - the text to search for.

Throws:

GeneralLeanFtException - if error occurs during execution

sendSecureKeys

void sendSecureKeys(String encodedText)
             throws GeneralLeanFtException

Types the specified encoded string into the AI object.

Parameters:

encodedText - the encoded text to type in the AI object.

Throws:

GeneralLeanFtException - if error occurs during execution

setState

void setState(ToggleState state)
       throws GeneralLeanFtException

Sets the state of a toggleable AI control. The toggleable AI controls are: Check Box, Toggle Button and Radio Button

Parameters:

state - the state to set.

Throws:

GeneralLeanFtException - if error occurs during execution

setText

void setText(String text)
      throws GeneralLeanFtException

This method is relevant for AIObjects that represent text boxes, input controls, and combo boxes. This method is not supported for mobile applications.

Parameters:

text - the input to set.

Throws:

GeneralLeanFtException - if error occurs during execution

getValue

String getValue()
         throws GeneralLeanFtException

Returns the AI object's value. The value is based on the following object properties: text for text objects, state for toggleable controls, and value for input fields, text boxes, and combo boxes.

Returns:

the AI object's value

Throws:

GeneralLeanFtException - if error occurs during execution

hover

void hover()
    throws GeneralLeanFtException

Holds the cursor over an AI object. This method is not supported for mobile applications.

Throws:

GeneralLeanFtException - if error occurs during execution

hover

void hover(int duration)
    throws GeneralLeanFtException

Holds the cursor over an AI object for a given duration. This method is not supported for mobile applications.

Parameters:

duration - The duration value.

Throws:

GeneralLeanFtException - if error occurs during execution

select

void select(String element)
     throws GeneralLeanFtException

Selects an item from a combo box.

Parameters:

element - The item to select.

Throws:

GeneralLeanFtException - if error occurs during execution

select

void select(String element,
 AiComboBoxSettings settings)
     throws GeneralLeanFtException

Selects an item from a combo box, using the specified settings. After the select operation is finished the settings will be reverted to default.

Parameters:

element - The item to select.

settings - The settings to use for the select.

Throws:

GeneralLeanFtException - if error occurs during execution