com.auxiliary.sikuli.element

Class FindSikuliElement

java.lang.Object

com.auxiliary.sikuli.element.FindSikuliElement

public class FindSikuliElement
extends Object

文件名：FindSingleElement.java

用途： 通过指定的元素文件读取类对象（继承自AbstractSikuliLocation类的类对象），在指定的识别范围中，查找相应的单个元素。在指定的时间内，若能查找到元素， 则返回相应的SikuliElement类对象

编码时间：2022年1月13日 上午8:15:49

修改时间：2022年1月13日 上午8:15:49

Since:

autest 3.0.0

Version:

Ver1.0

Author:

彭宇琦

Constructor Summary

Constructors

Constructor and Description
FindSikuliElement(org.sikuli.script.Region region) 构造对象，并指定当前需要识别的屏幕范围

Method Summary

Modifier and Type	Method and Description
List<SikuliElement>	findAllElement(String name, String... linkKeys) 该方法用于根据设置的识别范围，查找对应名称的元素所有元素，并返回目标元素集合
SikuliElement	findElement(String name, int index, String... linkKeys) 该方法用于根据设置的识别范围，查找对应名称的元素，并返回指定下标的元素
SikuliElement	findElement(String name, String... linkKeys) 该方法用于根据设置的识别范围，查找对应名称的元素。若界面上识别到多个结果，则取第1个作为目标元素。
FindSikuliElement	setReadMode(AbstractSikuliLocation locationFile) 该方法用于设置当前需要读取的元素存储文件

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FindSikuliElement

public FindSikuliElement(org.sikuli.script.Region region)

构造对象，并指定当前需要识别的屏幕范围

Parameters:

region - Region类对象，默认屏幕时，可传入Screen类对象

Since:

autest 3.0.0

Method Detail

setReadMode

public FindSikuliElement setReadMode(AbstractSikuliLocation locationFile)

该方法用于设置当前需要读取的元素存储文件

Parameters:

locationFile - 元素文件读取类对象

Since:

autest 3.0.0

findElement

public SikuliElement findElement(String name,
                                 String... linkKeys)

该方法用于根据设置的识别范围，查找对应名称的元素。若界面上识别到多个结果，则取第1个作为目标元素。

Parameters:

name - 元素名称

linkKeys - 外链词语

Returns:

查找到的元素类对象

Throws:

TimeoutException - 当元素查找超时时，抛出的异常

Since:

autest 3.0.0

findElement

public SikuliElement findElement(String name,
                                 int index,
                                 String... linkKeys)

该方法用于根据设置的识别范围，查找对应名称的元素，并返回指定下标的元素

注意：元素下标传入元素的真实下标，例如，当在界面识别到3个相同的元素时，需要取第2个作为目标元素，则下标传入2。 另外，下标可以传入负数，表示从后向前遍历

Parameters:

name - 元素名称

index - 多元素时的下标

linkKeys - 外链词语

Returns:

查找到的元素类对象

Throws:

TimeoutException - 当元素查找超时时，抛出的异常

Since:

autest 3.0.0

findAllElement

public List<SikuliElement> findAllElement(String name,
                                          String... linkKeys)

该方法用于根据设置的识别范围，查找对应名称的元素所有元素，并返回目标元素集合

Parameters:

name - 元素名称

linkKeys - 外链词语

Returns:

查找到的元素类对象

Throws:

TimeoutException - 当元素查找超时时，抛出的异常

Since:

autest3.0.0