UiEngineConfigurator (ATS-UIEngine 4.0.2 API)

java.lang.Object
- com.axway.ats.config.AbstractConfigurator
- - com.axway.ats.uiengine.configuration.UiEngineConfigurator

```
public class UiEngineConfigurator
extends AbstractConfigurator
```
This class is used to read a set of properties used by the UI Engine

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`getBrowserActionTimeout()`
`String`	`getBrowserDownloadDir()`
`String`	`getBrowserDownloadMimeTypes()`
`org.openqa.selenium.chrome.ChromeOptions`	`getChromeDriverOptions()`
`int`	`getCommandDelay()`
`int`	`getElementStateChangeDelay()`
`org.openqa.selenium.firefox.FirefoxOptions`	`getFirefoxDriverOptions()`
`boolean`	`getHighlightElements()`
`static UiEngineConfigurator`	`getInstance()`
`String`	`getMapFilesBaseDir()`
`int`	`getWaitPageToLoadTimeout()`
`boolean`	`isWorkWithInvisibleElements()`
`protected void`	`reloadData()`
`void`	`setBrowserActionTimeout(int actionTimeout)` Overwrite the timeout in seconds for waiting a browser action to finish This method must be called before starting the browser.
`void`	`setBrowserDownloadDir(String directory)` Overwrite browser download directory (absolute path)
`void`	`setBrowserDownloadMimeTypes(String downloadMimeTypes)` Overwrite MIME types of files (comma separated) which will be automatically saved to disk by the browser
`void`	`setChromeDriverOptions(org.openqa.selenium.chrome.ChromeOptions options)` Pass options which will be applied when starting a Chrome broswer through Selenium
`void`	`setCommandDelay(int commandDelay)` Overwrite the delay between UI command
`void`	`setElementStateChangeDelay(int elementStateChangeDelay)` Overwrite the delay waiting for element's state to change or to be found
`void`	`setFirefoxDriverOptions(org.openqa.selenium.firefox.FirefoxOptions options)` Pass options which will be applied when starting a Firefox broswer through Selenium
`void`	`setHighlightElements(boolean highlightElements)` Overwrite whether will try to highlight elements
`void`	`setMapFilesBaseDir(String mapFilesBaseDir)` Overwrite the map files' root directory
`void`	`setWaitPageToLoadTimeout(int pageLoadTimeout)` Overwrite the timeout in seconds for waiting a web page to get loaded
`void`	`setWorkWithInvisibleElements(boolean workWithInvisibleElements)`

Methods inherited from class com.axway.ats.config.AbstractConfigurator
addConfigFile, addConfigFileFromClassPath, clearCustomProperties, clearTempProperties, getBooleanProperty, getCharProperty, getIntegerProperty, getLongProperty, getOptionalProperty, getProperties, getProperty, setCustomProperty, setTempProperty

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

- Method Detail
  - getInstance
```
public static UiEngineConfigurator getInstance()
```
  - getMapFilesBaseDir
```
public String getMapFilesBaseDir()
```
    Returns:
    
    the map files' root directory
  - setMapFilesBaseDir
```
public void setMapFilesBaseDir(String mapFilesBaseDir)
```
    Overwrite the map files' root directory
    
    Parameters:
    
    mapFilesBaseDir - the map files' root directory
  - getCommandDelay
```
public int getCommandDelay()
```
    Returns:
    
    the delay between UI commands
  - setCommandDelay
```
public void setCommandDelay(int commandDelay)
```
    Overwrite the delay between UI command
    
    Parameters:
    
    commandDelay - the delay between UI command
  - getElementStateChangeDelay
```
public int getElementStateChangeDelay()
```
    Returns:
    
    the delay waiting for element's state to change or to be found. In milliseconds
  - setElementStateChangeDelay
```
public void setElementStateChangeDelay(int elementStateChangeDelay)
```
    Overwrite the delay waiting for element's state to change or to be found
    
    Parameters:
    
    elementStateChangeDelay - the delay waiting for element's state to change. In milliseconds
  - getHighlightElements
```
public boolean getHighlightElements()
```
    Returns:
    
    whether will try to highlight elements
  - setHighlightElements
```
public void setHighlightElements(boolean highlightElements)
```
    Overwrite whether will try to highlight elements
    
    Parameters:
    
    highlightElements - whether will try to highlight elements
  - getBrowserActionTimeout
```
public int getBrowserActionTimeout()
```
    Returns:
    
    the timeout in seconds for waiting a browser action to finish
  - setBrowserActionTimeout
```
public void setBrowserActionTimeout(int actionTimeout)
```
    Overwrite the timeout in seconds for waiting a browser action to finish This method must be called before starting the browser.
    
    Parameters:
    
    actionTimeout - a timeout in second for waiting a browser action to finish
  - reloadData
```
protected void reloadData()
```
    Specified by:
    
    reloadData in class AbstractConfigurator
  - getBrowserDownloadDir
```
public String getBrowserDownloadDir()
```
    Returns:
    
    browser download directory (absolute path)
  - setBrowserDownloadDir
```
public void setBrowserDownloadDir(String directory)
```
    Overwrite browser download directory (absolute path)
    
    Parameters:
    
    directory - - browser download directory (absolute path)
  - getBrowserDownloadMimeTypes
```
public String getBrowserDownloadMimeTypes()
```
    Returns:
    
    MIME types of files (comma separated) which will be automatically saved to disk by the browser
  - setBrowserDownloadMimeTypes
```
public void setBrowserDownloadMimeTypes(String downloadMimeTypes)
```
    Overwrite MIME types of files (comma separated) which will be automatically saved to disk by the browser
    
    Parameters:
    
    downloadMimeTypes - MIME types of files (comma separated) which will be automatically saved to disk by the browser
  - getWaitPageToLoadTimeout
```
public int getWaitPageToLoadTimeout()
```
    Returns:
    
    the timeout in seconds for waiting a web page to get loaded
  - setWaitPageToLoadTimeout
```
public void setWaitPageToLoadTimeout(int pageLoadTimeout)
```
    Overwrite the timeout in seconds for waiting a web page to get loaded
    
    Parameters:
    
    pageLoadTimeout - the new timeout
  - isWorkWithInvisibleElements
```
public boolean isWorkWithInvisibleElements()
```
    Returns:
    
    true if we will work with the invisible elements too
  - setWorkWithInvisibleElements
```
public void setWorkWithInvisibleElements(boolean workWithInvisibleElements)
```
    Parameters:
    
    workWithInvisibleElements - whether to work with the invisible elements too
  - getChromeDriverOptions
```
public org.openqa.selenium.chrome.ChromeOptions getChromeDriverOptions()
```
    Returns:
    
    the Chrome options
  - setChromeDriverOptions
```
public void setChromeDriverOptions(org.openqa.selenium.chrome.ChromeOptions options)
```
    Pass options which will be applied when starting a Chrome broswer through Selenium
    
    Parameters:
    
    options - Chrome options
  - getFirefoxDriverOptions
```
public org.openqa.selenium.firefox.FirefoxOptions getFirefoxDriverOptions()
```
    Returns:
    
    the Firefox options
  - setFirefoxDriverOptions
```
public void setFirefoxDriverOptions(org.openqa.selenium.firefox.FirefoxOptions options)
```
    Pass options which will be applied when starting a Firefox broswer through Selenium
    
    Parameters:
    
    options - Firefox options

Class UiEngineConfigurator

Method Summary

Methods inherited from class com.axway.ats.config.AbstractConfigurator

Methods inherited from class java.lang.Object

Method Detail

getInstance

getMapFilesBaseDir

setMapFilesBaseDir

getCommandDelay

setCommandDelay

getElementStateChangeDelay

setElementStateChangeDelay

getHighlightElements

setHighlightElements

getBrowserActionTimeout

setBrowserActionTimeout

reloadData

getBrowserDownloadDir

setBrowserDownloadDir

getBrowserDownloadMimeTypes

setBrowserDownloadMimeTypes

getWaitPageToLoadTimeout

setWaitPageToLoadTimeout

isWorkWithInvisibleElements

setWorkWithInvisibleElements

getChromeDriverOptions

setChromeDriverOptions

getFirefoxDriverOptions

setFirefoxDriverOptions