com.auxiliary.sikuli.event

Class SikuliAbstractEvent

java.lang.Object

com.auxiliary.sikuli.event.SikuliAbstractEvent

Direct Known Subclasses:

SikuliAssertEvent, SikuliKeyboardEvent, SikuliMouseEvent, SikuliOcrEvent

public abstract class SikuliAbstractEvent
extends Object

文件名：SikuliAbstractEvent.java

用途： 定义所有sikuli事件类包含的基本方法

编码时间：2022年1月19日 上午8:02:37

修改时间：2022年1月19日 上午8:02:37

Since:

autest 3.0.0

Version:

Ver1.0

Author:

彭宇琦

Field Summary

Fields

Modifier and Type	Field and Description
protected org.sikuli.script.Region	DEFAULT_REGION 定义默认的屏幕识别范围
protected FindSikuliElement	find 指向元素查找类，用于根据名称查找元素
protected ActionLogRecord	log 指向日志记录类，用于自动记录操作的日志
protected long	operateTime 存储操作超时时间

Constructor Summary

Constructors

Constructor and Description
SikuliAbstractEvent() 构造对象，并初始化日志记录工具

Method Summary

Modifier and Type	Method and Description
protected Object	actionOperate(String eventName, SikuliElement element, Function<org.sikuli.script.Match,Object> action) 该方法用于在指定的超时时间内，执行相应的操作
void	recordLog(String logText, int removeLogNum) 该方法用于记录日志，并根据指定的数字，在记录前删除多余的日志
void	setFindElementTool(FindSikuliElement find) 该方法用于指定元素查找类对象
void	setLogRecordTool(ActionLogRecord log, boolean isSaveOldLog) 该方法用于设置记录操作日志的工具，并根据参数，决定是否保留当前已有的日志
void	setOperateTime(long operateTime) 该方法用于设置操作超时时间

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_REGION

protected final org.sikuli.script.Region DEFAULT_REGION

定义默认的屏幕识别范围

find

protected FindSikuliElement find

指向元素查找类，用于根据名称查找元素

log

protected ActionLogRecord log

指向日志记录类，用于自动记录操作的日志

operateTime

protected long operateTime

存储操作超时时间

Constructor Detail

SikuliAbstractEvent

public SikuliAbstractEvent()

构造对象，并初始化日志记录工具

Since:

autest 3.0.0

Method Detail

setFindElementTool

public void setFindElementTool(FindSikuliElement find)

该方法用于指定元素查找类对象

Parameters:

find - 元素查找类FindSikuliElement对象

Since:

autest 3.0.0

setLogRecordTool

public void setLogRecordTool(ActionLogRecord log,
                             boolean isSaveOldLog)

该方法用于设置记录操作日志的工具，并根据参数，决定是否保留当前已有的日志

Parameters:

log - 日志记录工具类ActionLogRecord对象

isSaveOldLog - 是否保存原有日志

Since:

autest 3.0.0

setOperateTime

public void setOperateTime(long operateTime)

该方法用于设置操作超时时间

Parameters:

operateTime - 操作超时时间

Since:

autest 3.0.0

recordLog

public void recordLog(String logText,
                      int removeLogNum)

该方法用于记录日志，并根据指定的数字，在记录前删除多余的日志

注意：当指定的数字小于等于0时，表示不删除日志

Parameters:

logText - 日志文本

removeLogNum - 需要移除的日志数量

Since:

autest 3.0.0

actionOperate

protected Object actionOperate(String eventName,
                               SikuliElement element,
                               Function<org.sikuli.script.Match,Object> action)

该方法用于在指定的超时时间内，执行相应的操作

注意：调用本方法时，在action失败时，需要返回一个null，以此来作为操作超时的循环执行条件，所以当action执行成功后，必须指定一个返回值

Parameters:

element - Match类对象

action - 需要执行的操作

eventName - 事件名称

Returns:

操作返回结果

Since:

autest 3.0.0