org.safs.autoit.lib

Class AutoItXPlus

java.lang.Object

autoitx4java.AutoItX

org.safs.autoit.lib.AutoItXPlus

public class AutoItXPlus
extends autoitx4java.AutoItX

AutoIt/AutoItX is the DLL/COM control, which can be used by different programming languages to access AutoIt through COM objects. Currently, 3rd part Java JAR autoitx4java has provided one java version AutoItX object by using JACOB to access this AutoIt/AutoItX COM object. It gives many common Java APIs to use AutoIt functionalities, but still lacks of APIs like "Ctrl + Click", "Alt + Click" to support SAFS keywords. Thus it requires creating SAFS version 'AutoItXPlus', which extends from 'autoitx4java/AutoItX', to access AutoIt functionalities through AutoIt/AutoItX COM object.

Author:

Tao Xie

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	AUTOIT_ALT_DOWN
static java.lang.String	AUTOIT_ALT_UP
static java.lang.String	AUTOIT_CTRL_DOWN
static java.lang.String	AUTOIT_CTRL_UP
static java.lang.String	AUTOIT_KEYWORD_CONTROLCLICK AutoIt 'ControlClick' keyword, sends a mouse click command to a given control.
static java.lang.String	AUTOIT_KEYWORD_MOUSEMOVE AutoIt 'MouseMove' keyword, moves the mouse pointer.
static java.lang.String	AUTOIT_KEYWORD_MOUSEMOVE_SPEED AutoIt mouse move 'speed', its range is from 1 to 100, and default value is 10.
static java.lang.String	AUTOIT_KEYWORD_SEND AutoIt 'Send' keyword, sends simulated keystrokes to the active window.
static java.lang.String	AUTOIT_LEFT_WINDOWS_DOWN
static java.lang.String	AUTOIT_LEFT_WINDOWS_UP
static java.lang.String	AUTOIT_MOUSE_BUTTON_LEFT AutoIt's click button constants
static java.lang.String	AUTOIT_MOUSE_BUTTON_MIDDLE
static java.lang.String	AUTOIT_MOUSE_BUTTON_RIGHT
static java.lang.String	AUTOIT_RIGHT_WINDOWS_DOWN
static java.lang.String	AUTOIT_RIGHT_WINDOWS_UP
static java.lang.String	AUTOIT_SHIFT_DOWN
static java.lang.String	AUTOIT_SHIFT_UP
static java.lang.String	AUTOIT_SUPPORT_PRESS_ALT AutoIt's supporting KeyPress/KeyDown keywords
static java.lang.String	AUTOIT_SUPPORT_PRESS_CTRL
static java.lang.String	AUTOIT_SUPPORT_PRESS_LWINDOWS
static java.lang.String	AUTOIT_SUPPORT_PRESS_RWINDOWS
static java.lang.String	AUTOIT_SUPPORT_PRESS_SHIFT
static boolean	DEFAULT_SUPPORT_SPECIALKEY According to https://www.autoitscript.com/autoit3/docs/functions/Send.htm, AutoIt's 'Send()' method contains the optional parameter 'flag' to indicate if text contains special characters like + and ! to indicate SHIFT and ALT key-presses.

Fields inherited from class autoitx4java.AutoItX

autoItX, OPT_CARET_COORD_MODE, OPT_MOUSE_CLICK_DELAY, OPT_MOUSE_CLICK_DOWN_DELAY, OPT_MOUSE_CLICK_DRAG_DELAY, OPT_MOUSE_COORD_MODE, OPT_PIXEL_COORD_MODE, OPT_SEND_ATTACH_MODE, OPT_SEND_CAPSLOCK_MODE, OPT_SEND_KEY_DELAY, OPT_SEND_KEY_DOWN_DELAY, OPT_WIN_DETECT_HIDDEN_TEXT, OPT_WIN_SEARCH_CHILDREN, OPT_WIN_TEXT_MATCH_MODE, OPT_WIN_TITLE_MATCH_MODE, OPT_WIN_WAIT_DELAY, SW_HIDE, SW_MAXIMIZE, SW_RESTORE, SW_SHOW, SW_SHOWDEFAULT, SW_SHOWMAXIMIZED, SW_SHOWMINIMIZED, SW_SHOWMINNOACTIVE, SW_SHOWNA, SW_SHOWNOACTIVATE, SW_SHOWNORMAL

Constructor Summary

Constructors

Constructor and Description
AutoItXPlus()

Method Summary

Modifier and Type	Method and Description
int	autoit2JavaButtonmask(java.lang.String autoitButton) Transform AutoIt button RS into Java button mask.
int	autoit2JavaSpecialKey(java.lang.String autoitSpecialKey) Transform AutoIt Special Key RS into Java key code.
boolean	click(java.lang.String title, java.lang.String text, java.lang.String controlID, java.lang.String button, int nClicks, java.awt.Point offset, java.lang.String specialKey) Workhorse of click action.
com.jacob.com.Variant[]	convertCOMParams(java.lang.String[] paramMsgs) Convert parameters String array into com.jacob.com.Variant array.
int	getBorderWidth(java.lang.String title, java.lang.String text) Get the border width of a window.
int	getTitleBarHeight(java.lang.String title, java.lang.String text) Get the title height of a window.
boolean	isValidMouseButton(java.lang.String mouseButton) Check if the mouse button string is acceptable for AutoIt engine.
void	mouseHover(java.awt.Point pos, int milliSeconds) Implement AutoItX's workhorse for keyword 'HoverMouse'.
boolean	robotClick(int x, int y, java.lang.String button, int nClicks, java.awt.Point offset, java.lang.String specialKey) Workhorse of Java AWT Robot click action.
boolean	supportHoldingKeyPress(java.lang.String keyStr) According to https://www.autoitscript.com/autoit3/docs/functions/Send.htm, AutoIt supports 5 keys pairs: 1.
java.lang.String	wrapKeyPress(java.lang.String keyStr)
java.lang.String	wrapKeyUp(java.lang.String keyStr)

Methods inherited from class autoitx4java.AutoItX

autoItSetOption, blockInput, cdTray, clipGet, clipPut, controlBool, controlClick, controlClick, controlClick, controlClick, controlCommandAddString, controlCommandBoolean, controlCommandCheck, controlCommandCurrentTab, controlCommandDeleteString, controlCommandEditPaste, controlCommandFindString, controlCommandGetCurrentCol, controlCommandGetCurrentLine, controlCommandGetCurrentSelection, controlCommandGetLineCount, controlCommandGetSelected, controlCommandHideDropDown, controlCommandInts, controlCommandIsChecked, controlCommandIsEnabled, controlCommandIsVisible, controlCommandSelectString, controlCommandSetCurrentSelection, controlCommandShowDropdown, controlCommandString, controlCommandTabLeft, controlCommandTabRight, controlCommandUncheck, controlCommandVariant, controlCommandVoid, controlDisable, controlEnable, controlFocus, controlGetFocus, controlGetFocus, controlGetHandle, controlGetPosHeight, controlGetPosWidth, controlGetPosX, controlGetPosY, controlGetText, controlHide, controlInt, controlListViewFindItem, controlListViewGetItemCount, controlListViewGetSelected, controlListViewGetSelectedArray, controlListViewGetSelectedCount, controlListViewGetSubItemCount, controlListViewGetText, controlListViewInt, controlListViewIsSelected, controlListViewSelect, controlListViewSelectAll, controlListViewSelectAll, controlListViewSelectClear, controlListViewSelectInvert, controlListViewSelectViewChange, controlListViewString, controlMove, controlMove, controlSend, controlSend, ControlSetText, controlShow, controlString, controlTreeViewBoolean, controlTreeViewCheck, controlTreeViewCollapse, controlTreeViewExists, controlTreeViewExpand, controlTreeViewGetItemCount, controlTreeViewGetSelectedItemIndex, controlTreeViewGetSelectedItemText, controlTreeViewGetText, controlTreeViewInt, controlTreeViewIsChecked, controlTreeViewSelect, controlTreeViewString, controlTreeViewUncheck, controlVariant, controlView, driveMapAdd, driveMapAdd, driveMapAdd, driveMapDelete, driveMapGet, getError, getVersion, iniDelete, iniDelete, iniRead, iniWrite, isAdmin, mouseClick, mouseClick, mouseClickDrag, mouseClickDrag, mouseDown, mouseGetCursor, mouseGetPosX, mouseGetPosY, mouseMove, mouseMove, mouseUp, mouseWheel, mouseWheel, oneToTrue, oneToTrue, pixelChecksum, pixelChecksum, pixelGetColor, pixelSearch, pixelSearch, processClose, processExists, processSetPriority, processWait, processWait, processWaitClose, processWaitClose, regDeleteKey, regDeleteVal, regEnumKey, regEnumVal, regRead, regWrite, run, run, run, runAsSet, runAsSet, runWait, runWait, runWait, safeString, send, send, setOption, shutdown, sleep, statusbarGetText, StatusbarGetText, statusbarGetText, toolTip, toolTip, winActivate, winActivate, winActive, winActive, winClose, winClose, winExists, winExists, winGetCaretPosX, winGetCaretPosY, winGetClassList, winGetClientSizeHeight, winGetClientSizeHeight, winGetClientSizeWidth, winGetClientSizeWidth, winGetHandle, winGetHandle, winGetPosHeight, winGetPosHeight, winGetPosWidth, winGetPosWidth, winGetPosX, winGetPosX, winGetPosY, winGetPosY, winGetProcess, winGetProcess, winGetState, winGetState, winGetText, winGetText, winGetTitle, winGetTitle, winKill, winKill, winList, winList, winMenuSelectItem, winMenuSelectItem, winMenuSelectItem, winMenuSelectItem, winMinimizeAll, winMinimizeAllUndo, winMove, winMove, winSetOnTop, winSetState, winSetTitle, winSetTrans, winVariant, winVariant, winVariantBool, winVariantBool, winVariantBool, winWait, winWait, winWait, winWaitActive, winWaitActive, winWaitActive, winWaitClose, winWaitClose, winWaitClose, winWaitNoActive, winWaitNoActive, winWaitNoActive

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_SUPPORT_SPECIALKEY

public static final boolean DEFAULT_SUPPORT_SPECIALKEY

According to https://www.autoitscript.com/autoit3/docs/functions/Send.htm, AutoIt's 'Send()' method contains the optional parameter 'flag' to indicate if text contains special characters like + and ! to indicate SHIFT and ALT key-presses. If 'flag == 0', it will parse special key, if 'flag == 1', no parsing.

See Also:

Constant Field Values

AUTOIT_KEYWORD_SEND

public static final java.lang.String AUTOIT_KEYWORD_SEND

AutoIt 'Send' keyword, sends simulated keystrokes to the active window.

See Also:

Constant Field Values

AUTOIT_KEYWORD_CONTROLCLICK

public static final java.lang.String AUTOIT_KEYWORD_CONTROLCLICK

AutoIt 'ControlClick' keyword, sends a mouse click command to a given control.

See Also:

Constant Field Values

AUTOIT_KEYWORD_MOUSEMOVE

public static final java.lang.String AUTOIT_KEYWORD_MOUSEMOVE

AutoIt 'MouseMove' keyword, moves the mouse pointer.

See Also:

Constant Field Values

AUTOIT_KEYWORD_MOUSEMOVE_SPEED

public static final java.lang.String AUTOIT_KEYWORD_MOUSEMOVE_SPEED

AutoIt mouse move 'speed', its range is from 1 to 100, and default value is 10.

See Also:

Constant Field Values

AUTOIT_SUPPORT_PRESS_ALT

public static final java.lang.String AUTOIT_SUPPORT_PRESS_ALT

AutoIt's supporting KeyPress/KeyDown keywords

See Also:

Constant Field Values

AUTOIT_SUPPORT_PRESS_SHIFT

public static final java.lang.String AUTOIT_SUPPORT_PRESS_SHIFT

See Also:

Constant Field Values

AUTOIT_SUPPORT_PRESS_CTRL

public static final java.lang.String AUTOIT_SUPPORT_PRESS_CTRL

See Also:

Constant Field Values

AUTOIT_SUPPORT_PRESS_LWINDOWS

public static final java.lang.String AUTOIT_SUPPORT_PRESS_LWINDOWS

See Also:

Constant Field Values

AUTOIT_SUPPORT_PRESS_RWINDOWS

public static final java.lang.String AUTOIT_SUPPORT_PRESS_RWINDOWS

See Also:

Constant Field Values

AUTOIT_ALT_DOWN

public static final java.lang.String AUTOIT_ALT_DOWN

See Also:

Constant Field Values

AUTOIT_ALT_UP

public static final java.lang.String AUTOIT_ALT_UP

See Also:

Constant Field Values

AUTOIT_SHIFT_DOWN

public static final java.lang.String AUTOIT_SHIFT_DOWN

See Also:

Constant Field Values

AUTOIT_SHIFT_UP

public static final java.lang.String AUTOIT_SHIFT_UP

See Also:

Constant Field Values

AUTOIT_CTRL_DOWN

public static final java.lang.String AUTOIT_CTRL_DOWN

See Also:

Constant Field Values

AUTOIT_CTRL_UP

public static final java.lang.String AUTOIT_CTRL_UP

See Also:

Constant Field Values

AUTOIT_LEFT_WINDOWS_DOWN

public static final java.lang.String AUTOIT_LEFT_WINDOWS_DOWN

See Also:

Constant Field Values

AUTOIT_LEFT_WINDOWS_UP

public static final java.lang.String AUTOIT_LEFT_WINDOWS_UP

See Also:

Constant Field Values

AUTOIT_RIGHT_WINDOWS_DOWN

public static final java.lang.String AUTOIT_RIGHT_WINDOWS_DOWN

See Also:

Constant Field Values

AUTOIT_RIGHT_WINDOWS_UP

public static final java.lang.String AUTOIT_RIGHT_WINDOWS_UP

See Also:

Constant Field Values

AUTOIT_MOUSE_BUTTON_LEFT

public static final java.lang.String AUTOIT_MOUSE_BUTTON_LEFT

AutoIt's click button constants

See Also:

Constant Field Values

AUTOIT_MOUSE_BUTTON_MIDDLE

public static final java.lang.String AUTOIT_MOUSE_BUTTON_MIDDLE

See Also:

Constant Field Values

AUTOIT_MOUSE_BUTTON_RIGHT

public static final java.lang.String AUTOIT_MOUSE_BUTTON_RIGHT

See Also:

Constant Field Values

Constructor Detail

AutoItXPlus

public AutoItXPlus()

Method Detail

convertCOMParams

public com.jacob.com.Variant[] convertCOMParams(java.lang.String[] paramMsgs)

Convert parameters String array into com.jacob.com.Variant array.

Parameters:

paramMsgs - String[], string array parameters

Returns:

Variant[]

isValidMouseButton

public boolean isValidMouseButton(java.lang.String mouseButton)

Check if the mouse button string is acceptable for AutoIt engine.

Parameters:

mouseButton - String, the button to click, null, empty, "left", "right", or "middle" are acceptable.

Returns:

boolean, return true if mouseButton is valid, else return false.

supportHoldingKeyPress

public boolean supportHoldingKeyPress(java.lang.String keyStr)

According to https://www.autoitscript.com/autoit3/docs/functions/Send.htm, AutoIt supports 5 keys pairs: 1. Alt: {ALTDOWN}/{ALTUP}, 2. Shift: {SHIFTDOWN}/{SHIFTUP}, 3. Ctrl: {CTRLDOWN}/{CTRLUP}, 4. Left Windows key: {LWINDOWN}/{LWINUP}, 5. Right Windows key: {RWINDOWN}/{RWINUP} Check if the key string belongs to one of these supported pressing keyword.

Parameters:

keyStr - String,

Returns:

boolean

wrapKeyPress

public java.lang.String wrapKeyPress(java.lang.String keyStr)

wrapKeyUp

public java.lang.String wrapKeyUp(java.lang.String keyStr)

autoit2JavaButtonmask

public int autoit2JavaButtonmask(java.lang.String autoitButton)
                          throws SAFSException

Transform AutoIt button RS into Java button mask.

Throws:

SAFSException

autoit2JavaSpecialKey

public int autoit2JavaSpecialKey(java.lang.String autoitSpecialKey)
                          throws SAFSException

Transform AutoIt Special Key RS into Java key code. Currently, it supports only 4 special keys: Alt, Shift, Ctrl and Windows.

Parameters:

autoitSpecialKey - String, AutoIt supported special key.

Returns:

Throws:

SAFSException - throw exception when meeting unsupported special key.

robotClick

public boolean robotClick(int x,
                          int y,
                          java.lang.String button,
                          int nClicks,
                          java.awt.Point offset,
                          java.lang.String specialKey)
                   throws java.lang.Exception

Workhorse of Java AWT Robot click action. Click by using Robot click.

Parameters:

x - int, absolute screen x coordinate of component.

y - int, absolute screen y coordinate of component.

button - String, button to click, "left", "right" or "middle".

nClicks - int, number of times to click the mouse. It's supposed to be greater than or equal to 1.

offset - Point, position to click within the control. It can be null or empty String. Default value is center.

specialKey - String, keyboard key that be hold when click action happening. It can be null or empty String.

Returns:

Throws:

java.lang.Exception

getBorderWidth

public int getBorderWidth(java.lang.String title,
                          java.lang.String text)

Get the border width of a window.

Parameters:

title - String, title of the window to access.

text - String, text of the window to access.

Returns:

int, border width of accessed window.

getTitleBarHeight

public int getTitleBarHeight(java.lang.String title,
                             java.lang.String text)

Get the title height of a window.

Parameters:

title - String, title of the window to access.

text - String, text of the window to access.

Returns:

int, title height of accessed window.

click

public boolean click(java.lang.String title,
                     java.lang.String text,
                     java.lang.String controlID,
                     java.lang.String button,
                     int nClicks,
                     java.awt.Point offset,
                     java.lang.String specialKey)

Workhorse of click action. It'll first use Java AWT Robot click call first, and then use AutoIt API to click if previous click action failed. Provide click action through command sending with. It can be assigned mouse button like 'left, middle, right', number of click times, click offset position and the special key holding when clicking.

Parameters:

title - String, title of the window to access.

text - String, text of the window to access.

controlID - String, control to interact with.

button - String, button to click, "left", "right" or "middle".

nClicks - int, number of times to click the mouse. It's supposed to be greater than or equal to 1.

offset - Point, position to click within the control. It can be null or empty String. Default value is center.

specialKey - String, keyboard key that be hold when click action happening. It can be null or empty String.

Returns:

boolean

mouseHover

public void mouseHover(java.awt.Point pos,
                       int milliSeconds)
                throws SAFSException

Implement AutoItX's workhorse for keyword 'HoverMouse'. If the AutoItX API fails, try to use Robot API 'mouseHover()'.

Parameters:

pos - Point, the screen position to hover the mouse, which must NOT be null or empty.

milliseconds - double, the period to hover the mouse, in milliseconds

Throws:

SAFSException