AutoItRs (SAFS API DOCUMENT)

java.lang.Object
- org.safs.autoit.AutoItRs

All Implemented Interfaces:

IAutoItRs
```
public class AutoItRs
extends java.lang.Object
implements IAutoItRs
```
Class to handle recognition-string-parsing for the AutoIt engine.
Window Recognition String will be converted to AUTOIT window's RS.
Child Recognition String will be converted to AUTOIT control's RS.
The TEXT in Window Recognition String will be converted to Window Text.

The recognition string is composed with pairs of RsKey=value separated by semi-colon ; such as key1=value;key2=value

Window Recognition:
Note: the case-insensitive ":autoit:" prefix MUST appear in Window RS and will be removed when parsing.
The window's RsKey (case-insensitive) can be
- TITLE \ CAPTION - Window title.
  By default, The TITLE or CAPTION must be the beginning part of the title. For example, we have a Notepad window with title "Untitled - Notepad", we can define RS as
  Notepad=":AUTOIT:title=Untitled - Notepad" using the full title
  Notepad=":AUTOIT:title=Untitled" using the beginning part of the title
  But we should NOT define RS as Notepad=":AUTOIT:title=Notepad" which uses the ending part of the title.
  
  The CAPTION also supports wildcard, * represents zero or more character, ? represent 1 character. If it is expressed as wildcard string, then the 'title mode' will be invalid.
  For example, the Notepad window with title "Untitled - Notepad", we can define as
  Notepad=":AUTOIT:caption=Untitled*Note?ad"
  Notepad=":AUTOIT:caption=?ntitled*pad"
- TEXT - The window text consists of all the text that AutoIt can "see". This will usually be things like the contents of edit controls but will also include other text like:
  - Button text like &Yes, &No, &Next (the & indicates an underlined letter)
  - Dialog text like "Are you sure you wish to continue?"
  - Control text
  - Misc text - sometimes you don't know what it is :)
  When you specify the TEXT RsKey, it is treated as a substring.
- CLASS - The internal window classname
- REGEXPTITLE - Window title using a regular expression
- REGEXPCLASS - Window classname using a regular expression
- LAST - Last window used in a previous Windows AutoIt Function
- ACTIVE - Currently active window
- X \ Y \ W \ H - The position and size of a window
- INDEX \ INSTANCE - The 1-based instance when all given properties match
Child Control Recognition:
Note: the case-insensitive ":autoit:" prefix CAN appear in Control RS and will be removed if present when parsing.
The control's RsKey (case-insensitive) can be
- ID - The internal control ID. The Control ID is the internal numeric identifier that windows gives to each control. It is generally the best method of identifying controls.
- TEXT - The text on a control, for example "&Next" on a button
- CLASS - The internal control classname such as "Edit" or "Button"
- CLASSNN - The ClassnameNN value as used in previous versions of AutoIt, such as "Edit1"
- REGEXPCLASS - Control classname using a regular expression
- NAME - The internal .NET Framework WinForms name (if available)
- X \ Y \ W \ H - The position and size of a control.
- INDEX \ INSTANCE - The 1-based instance when all given properties match.
Examples
- Window Recognition:
  - Calculator=":AUTOIT:title=Calculator"
  - Calculator=":AUTOIT:Caption=Calculator"
  - Calculator=":AUTOIT:CAPTION=?alcul*"
  - Calculator=":AUTOIT:CAPTION=Ca?culat*"
  - Calculator=":AUTOIT:class=CalcFrame"
  - Calculator=":AUTOIT:REGEXPTITLE=[C|c].*lator"
  - Calculator=":AUTOIT:REGEXPCLASS=.*Fra.*"
  - Calculator=":AUTOIT:title=Calculator;class=CalcFrame"
  - Notepad_Replace=":AUTOIT:title=Replace;class=#32770"
- Child Control Recognition:
  - btnRadians=":AutoIt:text=Radians"
  - btnRadians="text=Radians"
  - btnRadians="id=131"
  - btnRadians="classnn=Button5"
  - btnRadians="class=Button"
  - btnRadians="id=131;class=Button"
  - btnRadians="class=Button;instance=5"
  - childName="caption=MDI Caption;id=theControlID" (future)
Author:

dharmesh

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`protected static class`	`AutoItRs.Control` The AUTOIT Control object, the implementation of `AutoItRs.Recognizable`
`protected static class`	`AutoItRs.DefaultRecognizable` This class provides default implementation of interface `AutoItRs.Recognizable`. As the field of name starting with `Constants.AutoItConstants.PREFIX_PROPERTY_FOR_RS` will be used for generating recognition string, please avoid adding new fields of name starting with `Constants.AutoItConstants.PREFIX_PROPERTY_FOR_RS` to this class when refactoring this class.
`protected static class`	`AutoItRs.DefaultRecognizableAutoIt` This class provides default implementation of interface `AutoItRs.Recognizable` for AUTOIT engine.
`protected static interface`	`AutoItRs.Recognizable` This interface represents something can be used by automation tool to find AUT's window or component.
`protected static class`	`AutoItRs.Window` The AUTOIT Window object, the implementation of `AutoItRs.Recognizable`

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String AUTOIT_DELIMITER
";"

static java.lang.String AUTOIT_PREFIX
":autoit:"

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`AUTOIT_DELIMITER` ";"
`static java.lang.String`	`AUTOIT_PREFIX` ":autoit:"

Constructor Summary

Constructors
Constructor and Description

AutoItRs(java.lang.String winRawRS, java.lang.String compRawRS)

Constructors
Constructor and Description
`AutoItRs(java.lang.String winRawRS, java.lang.String compRawRS)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`getComponentRS()`
`java.lang.String`	`getWindowsRS()`
`java.lang.String`	`getWindowText()`
`static boolean`	`isAutoitBasedRecognition(java.lang.String recognition)` Attempt to determine if recognition string is for autoit testing
`static boolean`	`isEngineRs(java.lang.String rs)` If the RS begins with [ and ends with ], then it is considered as AUTOIT RS.
`boolean`	`isWindow()`
`void`	`normalize(AutoItXPlus it)` If the window title is not complete, call this method to complete.
`void`	`setWindowText(java.lang.String windowText)`
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - AUTOIT_PREFIX
```
public static final java.lang.String AUTOIT_PREFIX
```
    ":autoit:"
    
    See Also:
    
    Constant Field Values
  - AUTOIT_DELIMITER
```
public static final java.lang.String AUTOIT_DELIMITER
```
    ";"
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - AutoItRs
```
public AutoItRs(java.lang.String winRawRS,
                java.lang.String compRawRS)
         throws SAFSObjectRecognitionException
```
    Throws:
    
    SAFSObjectRecognitionException
- Method Detail
  - isAutoitBasedRecognition
```
public static boolean isAutoitBasedRecognition(java.lang.String recognition)
```
    Attempt to determine if recognition string is for autoit testing
    
    Parameters:
    
    recognition - -- recognition, usually from App Map
    
    Returns:
    
    true if it contains elements of autoit testing recognition. Primarily, that is startsWith the :autoit: prefix.
    
    See Also:
    
    AUTOIT_PREFIX
  - isEngineRs
```
public static boolean isEngineRs(java.lang.String rs)
```
    If the RS begins with [ and ends with ], then it is considered as AUTOIT RS.
    
    Parameters:
    
    rs - String, the recognition string to test
    
    Returns:
    
    boolean
  - getWindowsRS
```
public java.lang.String getWindowsRS()
```
    Specified by:
    
    getWindowsRS in interface IAutoItRs
    
    Returns:
    
    String return AUTOIT window recognition string.
  - getWindowText
```
public java.lang.String getWindowText()
```
    Specified by:
    
    getWindowText in interface IAutoItRs
    
    Returns:
    
    String return AUTOIT window text.
  - setWindowText
```
public void setWindowText(java.lang.String windowText)
```
  - normalize
```
public void normalize(AutoItXPlus it)
```
    If the window title is not complete, call this method to complete.
    
    Parameters:
    
    it - The AutoIt instance.
  - isWindow
```
public boolean isWindow()
                 throws SAFSObjectRecognitionException
```
    Specified by:
    
    isWindow in interface IAutoItRs
    
    Returns:
    
    boolean true if the recognition string represents a window.
    
    Throws:
    
    SAFSObjectRecognitionException - if the window's recognition string is not valid.
  - getComponentRS
```
public java.lang.String getComponentRS()
```
    Specified by:
    
    getComponentRS in interface IAutoItRs
    
    Returns:
    
    String return AUTOIT control recognition string.
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class AutoItRs

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

AUTOIT_PREFIX

AUTOIT_DELIMITER

Constructor Detail

AutoItRs

Method Detail

isAutoitBasedRecognition

isEngineRs

getWindowsRS

getWindowText

setWindowText

normalize

isWindow

getComponentRS

toString