SikuliX1

https://raiman.github.io/SikuliX1/javadocs/
Admin
SikuliX1 is an automation framework that uses image recognition and visual scripting to automate GUI...
Tokens:143,972
Snippets:744
Trust Score:8.3
Update:1 year ago
Show doc for...
Tokens:
Raw
### SikuliX Screen Information

Source: https://raiman.github.io/SikuliX1/javadocs/org/sikuli/script/Screen

Utility method to display the current monitor setup configuration.

```Java
static void showMonitors()
```

--------------------------------

### App Class Methods - Basic Operations

Source: https://raiman.github.io/SikuliX1/javadocs/org/sikuli/script/App

Documents fundamental methods of the App class for checking window status, starting applications, and pausing execution.

```Java
public boolean isWindow()
public static Region start(App.Type appType)
public void pause(int time)
public void pause(float time)
```

--------------------------------

### SikuliX Java API: App Get Methods

Source: https://raiman.github.io/SikuliX1/javadocs/index-all

Methods for interacting with and retrieving information about applications. Includes getting application lists and clipboard content.

```APIDOC
App:
  getApps() - Static method
    Description: Retrieves a list of currently running applications.

  getApps(String) - Static method
    Description: Retrieves a list of applications matching the given name.

  getClipboard() - Static method
    Description: Evaluates and returns the current textual content of the system clipboard.
```

--------------------------------

### SikuliX Timer and Tracing Utilities

Source: https://raiman.github.io/SikuliX1/javadocs/org/sikuli/basics/Debug

Methods for starting and managing timers for performance profiling, and for sending trace messages. Log output for timers depends on Settings.ProfileLogs.

```Java
static Debug startTimer()
  start timer   
log output depends on Settings.ProfileLogs  
```

```Java
static Debug startTimer(java.lang.String message,           java.lang.Object... args)
  start timer with a message   
log output depends on Settings.ProfileLogs  
```

```Java
static java.lang.String trace(java.lang.String message,      java.lang.Object... args)

```

--------------------------------

### SikuliX App Class Static Method

Source: https://raiman.github.io/SikuliX1/javadocs/index-all

Documents the start(App.Type) static method in the org.sikuli.script.App class, used for launching applications of a specified type.

```Java
start(App.Type) - Static method in class org.sikuli.script.App 
```

--------------------------------

### Screen Class Instance Methods

Source: https://raiman.github.io/SikuliX1/javadocs/org/sikuli/script/Screen

Details instance methods for interacting with a specific screen, such as checking validity, getting descriptions, scale, bounds, and screen IDs.

```Java
public boolean isValid()
  Description copied from class: Region
  Check whether this Region is contained by any of the available screens
  Specified by:
    isValid in interface org.sikuli.script.support.IScreen
  Overrides:
    isValid in class Region
  Returns:
    true if yes, false otherwise
public java.lang.String isValidWithMessage()
  Specified by:
    isValidWithMessage in interface org.sikuli.script.support.IScreen
public java.lang.String getDeviceDescription()
  Specified by:
    getDeviceDescription in interface org.sikuli.script.support.IScreen
public int getScale()
public java.awt.Rectangle getBounds()
  Specified by:
    getBounds in interface org.sikuli.script.support.IScreen
  Returns:
    the screen's rectangle
public ScreenImage getLastScreenImageFromScreen()
  Specified by:
    getLastScreenImageFromScreen in interface org.sikuli.script.support.IScreen
public int getID()
  Specified by:
    getID in interface org.sikuli.script.support.IScreen
  Returns:
    the id
public java.lang.String getIDString()
  Specified by:
    getIDString in interface org.sikuli.script.support.IScreen
public int getIdFromPoint(int x, int y)
  INTERNAL USE: to be compatible with ScreenUnion
  Specified by:
    getIdFromPoint in interface org.sikuli.script.support.IScreen
  Parameters:
    x - value
    y - value
  Returns:
    id of the screen
```

--------------------------------

### Location Image and Python Helper

Source: https://raiman.github.io/SikuliX1/javadocs/org/sikuli/script/Location

Methods related to getting an image at the location and helper methods for Python integration.

```Java
Image getImage()
static Location getDefaultInstance4py()
static Location make4py(java.util.ArrayList args)
```

--------------------------------

### Location Comparison and Utility Methods

Source: https://raiman.github.io/SikuliX1/javadocs/org/sikuli/script/Location

Includes methods for comparing locations, getting offsets, and converting the location to string representations.

```APIDOC
public Offset getOffset(Location loc)
  - Calculates the offset of a given location relative to this location.
  - Parameters:
    - loc: The other Location object.
  - Returns: The relative offset.

public boolean equals(Object oThat)
  - Overrides the default equals method to compare two Location objects.
  - Parameters:
    - oThat: The object to compare with.
  - Returns: True if the locations are equal, false otherwise.

public int compareTo(Location loc)
  - Compares this location with another location.
  - Specified by: compareTo in interface Comparable<Location>
  - Parameters:
    - loc: The other Location object to compare.
  - Returns: -1 if this location is more above and/or left, 1 otherwise (0 if equal).

public String toString()
  - Overrides the default toString method to provide a string representation of the location.
  - Returns: The string description of the location.

public String toStringShort()
  - Returns a shorter string representation of the location.
  - Returns: A shorter description of the location.

public String toJSON()
  - Returns a JSON representation of the location.
```

--------------------------------

### Pattern Similarity and Resize Settings

Source: https://raiman.github.io/SikuliX1/javadocs/org/sikuli/script/Pattern

Allows setting and getting the similarity threshold for pattern matching and controlling image resizing factors. The `similar` method sets the minimum similarity for `findX` operations.

```Java
public Pattern similar(double sim)
// sets the minimum Similarity to use with findX

public double getSimilar()

public Pattern resize(float factor)

public float getResize()
```

--------------------------------

### SikuliX Settings and Version Information

Source: https://raiman.github.io/SikuliX1/javadocs/index-all

Provides access to SikuliX settings and version details. Includes methods to get the build version, timestamp, and general version information.

```Java
getSikuliVersionBuild() - Static method in class org.sikuli.script.Env 
    
Deprecated.
use Settings.getVersionBuild() instead 

getTimestamp() - Static method in class org.sikuli.basics.Settings 


getVersion() - Static method in class org.sikuli.basics.Settings 


getVersionBuild() - Static method in class org.sikuli.basics.Settings 


```

--------------------------------

### Get Operating System Information

Source: https://raiman.github.io/SikuliX1/javadocs/org/sikuli/basics/Settings

Provides methods to identify the current operating system (Windows, Linux, Mac) and retrieve its version details.

```Java
public static org.sikuli.basics.OS getOS()

```

```Java
public static boolean isWindows()

```

```Java
public static boolean isLinux()

```

```Java
public static boolean isMac()

```

```Java
public static java.lang.String getOSVersion()

```

--------------------------------

### SikuliX Debug Class Timer Methods

Source: https://raiman.github.io/SikuliX1/javadocs/index-all

Details the startTimer() and startTimer(String, Object...) static methods in the org.sikuli.basics.Debug class, used for starting timers with or without messages, logging output based on Settings.ProfileLogs.

```Java
startTimer() - Static method in class org.sikuli.basics.Debug 
    
start timer   
log output depends on Settings.ProfileLogs 

startTimer(String, Object...) - Static method in class org.sikuli.basics.Debug 
    
start timer with a message   
log output depends on Settings.ProfileLogs 
```

--------------------------------

### SikuliX Debug Timer and Profiling Methods

Source: https://raiman.github.io/SikuliX1/javadocs/org/sikuli/basics/Debug

Describes methods related to timing and profiling script execution within SikuliX. This includes starting, stopping, and marking laps in timers, along with methods for entering and exiting profiled sections of code.

```Java
public long end()
// stop timer and print timer message
// log output depends on Settings.ProfileLogs

public static void enter(java.lang.String message, java.lang.Object... args)
// profile convenience: entering a method

public static void exit(java.lang.String message, java.lang.Object... args)
// profile convenience: exiting a method

public long lap(java.lang.String message)
// lap timer and print message with timer message
// log output depends on Settings.ProfileLogs
```

--------------------------------

### FindFailed Method Summary

Source: https://raiman.github.io/SikuliX1/javadocs/org/sikuli/script/FindFailed

Summarizes the static methods available in the FindFailed class for managing find failure responses and handlers. This includes methods for getting and setting handlers, resetting configurations, and retrieving the current response.

```APIDOC
All MethodsStatic MethodsConcrete Methods Modifier and Type | Method | Description  
---|---|---
`static java.lang.Object` | `getFindFailedHandler()` |   
`static java.lang.Object` | `getImageMissingHandler()` |   
`static org.sikuli.script.FindFailedResponse` | `getResponse()` |   
`static void` | `reset()` |  reset all: response ABORT, findFailedHandler null, imageMissingHandler null  
`static void` | `resetFindFailedHandler()` |  reset to default: no handler, response ABORT  
`static void` | `resetImageMissingHandler()` |  reset to default: no handler  
`static void` | `resetResponse()` |  reset to default `setResponse(FindFailedResponse)`  
`static void` | `setFindFailedHandler(java.lang.Object handler)` |  Global FindFailedHandler for new `Region`s  
default: none  
`static void` | `setImageMissingHandler(java.lang.Object handler)` |  Global ImageMissingHandler for new `Region`s  
default: none  
`static void` | `setResponse(org.sikuli.script.FindFailedResponse response)` |  Global FindFailedResponse for new `Region`s  
ABORT - abort script on FindFailed   
SKIP - ignore FindFailed  
PROMPT - display prompt on FindFailed to let user decide how to proceed  
RETRY - continue to wait for appearence after FindFailed  
HANDLE - (set implicit) call a handler on exception `setFindFailedHandler(Object)`  
default: ABORT
```

--------------------------------

### App Class Methods - Opening and Configuring Applications

Source: https://raiman.github.io/SikuliX1/javadocs/org/sikuli/script/App

Details methods for opening applications, either by name with wait times or by using an existing App instance, and configuring application options.

```Java
public static App open(String appName, int waitTime)
public static App open(String appName)
public boolean open()
public App setUsing(String options)
```

--------------------------------

### SikuliX ScreenImage Class Variable

Source: https://raiman.github.io/SikuliX1/javadocs/index-all

Documents the 'start' variable within the org.sikuli.script.ScreenImage class, likely related to the start of an image capture or process.

```Java
start - Variable in class org.sikuli.script.ScreenImage 
```

--------------------------------

### Javadoc Organization Overview

Source: https://raiman.github.io/SikuliX1/javadocs/help-doc

Explains the structure of the Javadoc API documentation, including the purpose of each section like Overview, Package, Class, Tree, Deprecated, Index, and Help.

```APIDOC
## Overview
The Overview page is the front page of this API document and provides a list of all packages with a summary for each. This page can also contain an overall description of the set of packages.

## Package
Each package has a page that contains a list of its classes and interfaces, with a summary for each. These pages may contain six categories:
  * Interfaces
  * Classes
  * Enums
  * Exceptions
  * Errors
  * Annotation Types

## Class or Interface
Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a class/interface description, summary tables, and detailed member descriptions:
    * Class Inheritance Diagram
    * Direct Subclasses
    * All Known Subinterfaces
    * All Known Implementing Classes
    * Class or Interface Declaration
    * Class or Interface Description
  
    * Nested Class Summary
    * Field Summary
    * Property Summary
    * Constructor Summary
    * Method Summary
  
    * Field Detail
    * Property Detail
    * Constructor Detail
    * Method Detail
Each summary entry contains the first sentence from the detailed description for that item. The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.

## Annotation Type
Each annotation type has its own separate page with the following sections:
    * Annotation Type Declaration
    * Annotation Type Description
    * Required Element Summary
    * Optional Element Summary
    * Element Detail

## Enum
Each enum has its own separate page with the following sections:
    * Enum Declaration
    * Enum Description
    * Enum Constant Summary
    * Enum Constant Detail

## Tree (Class Hierarchy)
There is a Class Hierarchy page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. Classes are organized by inheritance structure starting with `java.lang.Object`. Interfaces do not inherit from `java.lang.Object`.
    * When viewing the Overview page, clicking on "Tree" displays the hierarchy for all packages.
    * When viewing a particular package, class or interface page, clicking on "Tree" displays the hierarchy for only that package.

## Deprecated API
The Deprecated API page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to improvements, and a replacement API is usually given. Deprecated APIs may be removed in future implementations.

## Index
The Index contains an alphabetic index of all classes, interfaces, constructors, methods, and fields, as well as lists of all packages and all classes.

## All Classes
The All Classes link shows all classes and interfaces except non-static nested types.

## Serialized Form
Each serializable or externalizable class has a description of its serialization fields and methods. This information is of interest to re-implementors, not to developers using the API. While there is no link in the navigation bar, you can get to this information by going to any serialized class and clicking "Serialized Form" in the "See also" section of the class description.

## Constant Field Values
The Constant Field Values page lists the static final fields and their values.

## Search
You can search for definitions of modules, packages, types, fields, methods and other terms defined in the API, using some or all of the name. "Camel-case" abbreviations are supported: for example, "InpStr" will find "InputStream" and "InputStreamReader".
```

--------------------------------

### SikuliX Java API: ObserveEvent Get Methods

Source: https://raiman.github.io/SikuliX1/javadocs/index-all

Methods for retrieving information about observation events. Includes getting the event type, image, and count.

```APIDOC
ObserveEvent:
  getChanges() - Method
    Description: Retrieves the changes associated with the observation event.

  getImage() - Method
    Description: Retrieves the image related to the observation event.

  getCount() - Method
    Description: Retrieves the count associated with the observation event.
```

--------------------------------

### App Class Methods - Application Listing and Management

Source: https://raiman.github.io/SikuliX1/javadocs/org/sikuli/script/App

Documents methods for managing and listing applications, including opening links, retrieving lists of apps, and setting working directories.

```Java
public static boolean openLink(String url)
public static List<App> getApps()
public static List<App> getApps(String name)
public static void listApps()
public static void listApps(String name)
public boolean setWorkDir()
public boolean setWorkDir(String workDirPath)
```

--------------------------------

### SikuliX Java API: Match Get Methods

Source: https://raiman.github.io/SikuliX1/javadocs/index-all

Methods for retrieving information about a successful image match. Includes getting the image filename and the index of the match.

```APIDOC
Match:
  getImageFilename() - Method
    Description: Gets the filename of the image that was used for searching.

  getIndex() - Method
    Description: Retrieves the index of this match.
```

--------------------------------

### SikuliX Java API: Location Get Methods

Source: https://raiman.github.io/SikuliX1/javadocs/index-all

Methods for retrieving information about a specific point (Location) on the screen. Includes getting the color at the location and the associated image.

```APIDOC
Location:
  getColor() - Method
    Description: Gets the color at the given Point. For details, refer to java.awt.Robot and Color.

  getImage() - Method
    Description: Retrieves the image associated with this location.
```

--------------------------------

### Pattern Initialization and Configuration

Source: https://raiman.github.io/SikuliX1/javadocs/org/sikuli/script/Pattern

Provides methods to initialize and configure a Pattern object. This includes setting exact matches, managing image file paths, and applying masks from string representations.

```Java
public Pattern exact()
// sets the minimum Similarity to 0.99 which means exact match

public Pattern setFilename(java.lang.String fileName)
// set a new image for this pattern

public void setMaskFromString(java.lang.String mask)
```

--------------------------------

### Screen Class Methods - Monitor and Screen Information

Source: https://raiman.github.io/SikuliX1/javadocs/org/sikuli/script/Screen

Details methods for retrieving information about monitors and screens, such as the total number of monitors, bounds of specific monitors, and the ID of the current screen. It also includes methods for getting the Robot associated with a screen.

```APIDOC
Method Summary
All MethodsStatic MethodsInstance MethodsConcrete Methods Modifier and Type | Method | Description  
---|---|---
`static org.sikuli.script.support.ScreenUnion` | `all()` |  create a Screen (ScreenUnion) object as a united region of all available monitors  
`static void` | `closePrompt()` |   
`static void` | `closePrompt(Screen scr)` |   
`ScreenImage` | `cmdCapture(java.lang.Object... args)` |   
`static void` | `doPrompt(java.lang.String message,         org.sikuli.util.EventObserver obs)` |   
`static Screen` | `get(int id)` |   
`java.awt.Rectangle` | `getBounds()` |   
`static java.awt.Rectangle` | `getBounds(int id)` |   
`static Screen` | `getDefaultInstance4py()` |   
`java.lang.String` | `getDeviceDescription()` |   
`int` | `getID()` |   
`int` | `getIdFromPoint(int x,               int y)` |  INTERNAL USE: to be compatible with ScreenUnion  
`java.lang.String` | `getIDString()` |   
`ScreenImage` | `getLastScreenImageFromScreen()` |   
`int` | `getMonitor()` |   
`static java.awt.Rectangle` | `getMonitorBounds()` |   
`static java.awt.Rectangle` | `getMonitorBounds(int n)` |   
`static int` | `getMonitorCount()` |   
`static org.sikuli.script.support.IRobot` | `getMonitorRobot(int n)` |   
`static int` | `getNumberScreens()` |   
`static Screen` | `getPrimaryScreen()` |   
`org.sikuli.script.support.IRobot` | `getRobot()` |  Gets the Robot of this Screen.  
`int` | `getScale()` |   
`static int` | `getScaleFactor(int x,               int y)` |   
`static Screen` | `getScreen(int id)` |   
`static int` | `getScreenMonitor(int n)` |   
`boolean` | `hasPrompt()` |   
`static boolean` | `isHeadless()` |   
`boolean` | `isValid()` |  Check whether this Region is contained by any of the available screens  
`java.lang.String` | `isValidWithMessage()` |   
`static Screen` | `make4py(java.util.ArrayList args)` |   
`Location` | `newLocation(int x,            int y)` |   
`Location` | `newLocation(Location loc)` |  creates a location on the current screen with the given point.  
`static void` | `resetMonitors()` |   
`static void` | `resetMonitorsQuiet()` |   
```

--------------------------------

### SikuliX Java API: Pattern Get Methods

Source: https://raiman.github.io/SikuliX1/javadocs/index-all

Methods related to the Pattern class, used for image matching. Includes getting the image data and the filename of the pattern.

```APIDOC
Pattern:
  getBImage() - Method
    Description: Retrieves the buffered image data for the pattern.

  getFilename() - Method
    Description: Returns the absolute file path of the current image. Returns null if the image is within a JAR or on the web.
```

--------------------------------

### SikuliX Finder Class and Constructors

Source: https://raiman.github.io/SikuliX1/javadocs/index-all

Documentation for the Finder class, including its constructors for initializing a Finder with a screen image and region, or with a specific element.

```Java
Finder - Class in org.sikuli.script 

Finder(ScreenImage, Region) - Constructor for class org.sikuli.script.Finder 
    Finder for a Region on a ScreenImage 

Finder(RIBSM) - Constructor for class org.sikuli.script.Finder 
    Create a Finder for the given element
```

--------------------------------

### SikuliX Java API: Settings and Debug Get Methods

Source: https://raiman.github.io/SikuliX1/javadocs/index-all

Methods for accessing application settings and debugging levels. Includes getting the data path and the current debug level.

```APIDOC
Settings:
  getDataPath() - Static method
    Description: Retrieves the data path configured for SikuliX.

  getFilePathSeperator() - Static method
    Description: Returns the file path separator character used by the operating system.

Debug:
  getDebugLevel() - Static method
    Description: Retrieves the current debug logging level.
```

--------------------------------

### SikuliX Java API: Region Get Methods

Source: https://raiman.github.io/SikuliX1/javadocs/index-all

Methods for retrieving information about a specific region on the screen. Includes getting cell data, column information, bounds, and associated events.

```APIDOC
Region:
  getBottomLeft() - Method
    Description: Gets the bottom-left corner coordinates of the region.

  getBottomRight() - Method
    Description: Gets the bottom-right corner coordinates of the region.

  getCell(int, int) - Method
    Description: Gets the specified cell within the region, counting from (0, 0), assuming a raster is set up.

  getCol(int) - Method
    Description: Gets the specified column, counting from 0.

  getCol(int, int) - Method
    Description: Divides the region into 'n' columns and selects the 'c'-th column as a new Region.

  getCols() - Method
    Description: Gets the number of columns in the region.

  getColW() - Method
    Description: Gets the width of a single column within the region.

  getContent() - Method
    Description: Retrieves the content associated with the region.

  getEvent(String) - Method
    Description: Retrieves and removes a specific event from the region's event list.

  getEvents() - Method
    Description: Retrieves and removes all events from the region's event list.

  getImage() - Method
    Description: Gets the image associated with the region.

  getInset(Region) - Method
    Description: Calculates and returns the inset region relative to the provided region.

  getLastScreenImage() - Method
    Description: Retrieves the last screen image captured within this region.
```

--------------------------------

### SikuliX Java API: ScreenImage Get Methods

Source: https://raiman.github.io/SikuliX1/javadocs/index-all

Methods for handling captured screen images. Includes getting the image as a buffered image, retrieving file paths, and accessing image boundaries.

```APIDOC
ScreenImage:
  getBufferedImage() - Method
    Description: Retrieves the captured screen image as a BufferedImage object.

  getEnd() - Method
    Description: Gets the end coordinates of the captured screen image.

  getFile(String) - Method
    Description: Saves the image as a PNG file in the specified path with an auto-generated filename (sikuliximage-timestamp.png).

  getFile(String, String) - Method
    Description: Saves the image as a PNG file in the specified path with the provided filename.

  getFilename() - Method
    Description: Deprecated. Use the save() method instead. Previously returned the filename of the captured image.

  getContent() - Method
    Description: Retrieves the content of the screen image.
```

--------------------------------

### SikuliX App Methods

Source: https://raiman.github.io/SikuliX1/javadocs/index-all

Provides methods for interacting with applications, including bringing application windows to the foreground.

```Java
focus() - Method in class org.sikuli.script.App 
    tries to make it the foreground application bringing its frontmost window to front 

focus(String) - Static method in class org.sikuli.script.App
```

--------------------------------

### SikuliX Java API: Screen Get Methods

Source: https://raiman.github.io/SikuliX1/javadocs/index-all

Details methods for retrieving screen-related information. This includes getting screen bounds, device descriptions, and identifying screens by ID or point coordinates.

```APIDOC
Screen:
  get() - Static method
    Description: Retrieves the path list as a string array (Note: This appears to be a duplicate description from ImagePath.get(), potential documentation error).

  get(int) - Static method
    Description: Retrieves screen information based on an integer index.

  getBounds() - Method
    Description: Gets the bounding box of the screen.

  getBounds(int) - Static method
    Description: Gets the bounding box of a screen specified by an integer index.

  getDeviceDescription() - Method
    Description: Returns a description of the screen device.

  getIDString() - Method
    Description: Returns the string identifier of the screen.

  getIdFromPoint(int, int) - Method
    Description: INTERNAL USE: Returns the ID of the screen containing the specified point (x, y). Compatible with ScreenUnion.
```

--------------------------------

### Env Class Overview

Source: https://raiman.github.io/SikuliX1/javadocs/org/sikuli/script/Env

Provides a structural overview of the Env class, its inheritance, and a summary of its methods. Many methods are deprecated and suggest alternatives.

```APIDOC
Class Env
  Inherits from: java.lang.Object

Constructor Summary:
  Env()

Method Summary:
  addHotkey(char key, int modifiers, org.sikuli.basics.HotkeyListener listener): Deprecated. Use Key.
  addHotkey(java.lang.String key, int modifiers, org.sikuli.basics.HotkeyListener listener): Deprecated. Use Key.
  getClipboard(): Deprecated. Use App.
  getHotkeyModifier(): Deprecated. Use Key.
  getMouseLocation(): Deprecated. Use Mouse.at().
  getOS(): Deprecated. Use Settings.
  getOSVersion(): Deprecated. Use Settings.
  getSeparator(): Deprecated. Use Settings.getPathSeparator().
  getSikuliDataPath(): Deprecated. Use Settings.getDataPath().
  getSikuliVersion(): Deprecated. Use Settings.getVersion().
  getSikuliVersionBuild(): Deprecated. Use Settings.getVersionBuild().
  isLinux(): Deprecated. Use Settings.
  isLockOn(char key): Deprecated. Use Key.
  isMac(): Deprecated. Use Settings.
  isWindows(): Deprecated. Use Settings.
  removeHotkey(char key, int modifiers): Deprecated. Use Key.
  removeHotkey(java.lang.String key, int modifiers): Deprecated. Use Key.
  setClipboard(java.lang.String text): Deprecated. Use App.
```

--------------------------------

### SikuliX Settings Class Methods

Source: https://raiman.github.io/SikuliX1/javadocs/index-all

Documentation for static methods within the org.sikuli.basics.Settings class. These methods provide access to system settings.

```Java
getOS()
    Static method
    
getOSVersion()
    Static method
    
getPathSeparator()
    Static method
    

```

--------------------------------

### SikuliX Java API: ImagePath Get Methods

Source: https://raiman.github.io/SikuliX1/javadocs/index-all

Provides methods to retrieve path information from SikuliX's ImagePath. Includes getting the path list as a string array and obtaining the bundle path without a trailing separator.

```APIDOC
ImagePath:
  get() - Static method
    Description: Returns the path list as a string array.

  getBundlePath() - Static method
    Description: Returns the bundle path without a trailing path separator.
```

--------------------------------

### IScreen Interface Methods

Source: https://raiman.github.io/SikuliX1/javadocs/org/sikuli/script/Screen

Provides documentation for various methods within the IScreen interface, including screen capture, monitor handling, and interactive prompts.

```APIDOC
newLocation(int x, int y)
  - Creates a new Location object.
  - Specified by: newLocation in interface org.sikuli.script.support.IScreen

all()
  - Creates a Screen (ScreenUnion) object as a united region of all available monitors.
  - Returns: ScreenUnion

setAsScreenUnion()
  - INTERNAL USE: Collects all physical screens into one large region.
  - This is under evaluation whether it really makes sense.

setAsScreen()
  - INTERNAL USE: Resets from being a screen union to the screen used before.

getMonitor()
  - Returns the current monitor index.

setMonitor(int monitor)
  - Sets the current monitor.

isHeadless()
  - Checks if the environment is headless.
  - Returns: true if headless, false otherwise.

getMonitorCount()
  - Gets the total number of monitors connected.
  - Returns: The number of monitors.

getMonitorBounds()
  - Gets the bounds of the primary monitor.
  - Returns: The Rectangle representing the primary monitor's bounds.

getMonitorBounds(int n)
  - Gets the bounds of a specific monitor.
  - Parameters:
    - n: The monitor index.
  - Returns: The Rectangle representing the specified monitor's bounds.

getMonitorRobot(int n)
  - Gets the IRobot for a specific monitor.
  - Parameters:
    - n: The monitor index.
  - Returns: The IRobot for the specified monitor.

getScreenMonitor(int n)
  - Gets the monitor index for a given screen coordinate.
  - Parameters:
    - n: The x-coordinate.
  - Returns: The monitor index.

showMonitors()
  - Displays the current monitor setup.

resetMonitors()
  - Resets the monitor configuration.

resetMonitorsQuiet()
  - Resets the monitor configuration without displaying messages.

getScaleFactor(int x, int y)
  - Gets the scale factor for the given coordinates.
  - Parameters:
    - x: The x-coordinate.
    - y: The y-coordinate.
  - Returns: The scale factor.

getRobot()
  - Gets the Robot of this Screen.
  - Specified by: getRobot in interface org.sikuli.script.support.IScreen
  - Returns: The Robot for this Screen.

cmdCapture(Object... args)
  - Executes a capture command with given arguments.

capture()
  - Creates a ScreenImage with the physical bounds of this screen.
  - Specified by: capture in interface org.sikuli.script.support.IScreen
  - Returns: The captured image.

capture(int x, int y, int w, int h)
  - Creates a ScreenImage with given coordinates on this screen.
  - Specified by: capture in interface org.sikuli.script.support.IScreen
  - Parameters:
    - x: x-coordinate of the region to be captured
    - y: y-coordinate of the region to be captured
    - w: width of the region to be captured
    - h: height of the region to be captured
  - Returns: The image of the region.

capture(java.awt.Rectangle rect)
  - Creates a ScreenImage with a given rectangle on this screen.
  - Specified by: capture in interface org.sikuli.script.support.IScreen
  - Parameters:
    - rect: The Rectangle to be captured
  - Returns: The image of the region.

capture(Region reg)
  - Creates a ScreenImage with a given region on this screen.
  - Specified by: capture in interface org.sikuli.script.support.IScreen
  - Parameters:
    - reg: The Region to be captured
  - Returns: The image of the region.

doPrompt(String message, org.sikuli.util.EventObserver obs)
  - Displays a prompt with a message and an observer.

closePrompt()
  - Closes the current prompt.

closePrompt(Screen scr)
  - Closes the prompt for a specific screen.

resetPrompt(org.sikuli.util.OverlayCapturePrompt ocp)
  - Resets the prompt with the given OverlayCapturePrompt.

hasPrompt()
  - Checks if a prompt is currently active.
  - Returns: true if a prompt is active, false otherwise.

userCapture()
  - Interactively captures a screen image using the mouse to draw the rectangle.
  - Returns: The captured image.

userCapture(String message)
  - Interactively captures a screen image with a given message.
  - Specified by: userCapture in interface org.sikuli.script.support.IScreen
  - Parameters:
    - message: The text message to display.
  - Returns: The captured image.

selectRegion()
  - Interactively creates a region by letting the user draw the rectangle using the mouse.
  - Returns: The created Region.

selectRegion(String message)
  - Interactively creates a region with a given message.
  - Parameters:
    - message: The text message to display.
```

--------------------------------

### Image Retrieval

Source: https://raiman.github.io/SikuliX1/javadocs/org/sikuli/script/Region

Method to get the image associated with a region.

```Java
public Image getImage()
// Overrides: 
```

--------------------------------

### Get Name as Text

Source: https://raiman.github.io/SikuliX1/javadocs/org/sikuli/script/Image

Retrieves the name of the image as a String.

```Java
public java.lang.String getNameAsText()
```

--------------------------------

### App Class Constructors

Source: https://raiman.github.io/SikuliX1/javadocs/org/sikuli/script/App

Provides information on the constructors for the App class, used for initializing App instances.

```Java
public App()
public App(String name)
```

--------------------------------

### SikuliX Settings - Constructor and Initialization

Source: https://raiman.github.io/SikuliX1/javadocs/org/sikuli/basics/Settings

Provides the default constructor for the Settings class and a static initialization method to set up the runtime environment.

```Java
public Settings()
public static void init(org.sikuli.script.support.RunTime givenRunTime)
```

--------------------------------

### SikuliX Region: Python Integration

Source: https://raiman.github.io/SikuliX1/javadocs/org/sikuli/script/Region

Internal method to get a default Region for Python integration.

```Java
static Region getDefaultInstance4py()
```

--------------------------------

### Env - Deprecated System Information Methods

Source: https://raiman.github.io/SikuliX1/javadocs/org/sikuli/script/Env

Methods for retrieving system information, now deprecated and suggesting alternatives in the Settings class.

```APIDOC
getOSVersion()
  Description: Gets the operating system version. Deprecated. Use Settings.
  Returns: The OS version string.

getOS()
  Description: Gets the operating system type. Deprecated. Use Settings.
  Returns: An OS object representing the operating system.

isWindows()
  Description: Checks if the operating system is Windows. Deprecated. Use Settings.
  Returns: true if the OS is Windows, false otherwise.

isLinux()
  Description: Checks if the operating system is Linux. Deprecated. Use Settings.
  Returns: true if the OS is Linux, false otherwise.

isMac()
  Description: Checks if the operating system is macOS. Deprecated. Use Settings.
  Returns: true if the OS is macOS, false otherwise.

getSeparator()
  Description: Gets the system's path separator character. Deprecated. Use Settings.getPathSeparator().
  Returns: The path separator character (e.g., ':' or ';').
```

--------------------------------

### App Management Methods

Source: https://raiman.github.io/SikuliX1/javadocs/org/sikuli/script/App

Provides methods to open, close, and manage application instances. Includes functionalities to check if an app is closing, close by key, set focus, and check focus status.

```Java
public boolean open(int waitTime)
  tries to open the app defined by this App instance and waits until app is running
  Parameters:
     `waitTime` - max waittime until running
  Returns:
    this or null on failure
```

```Java
public static boolean close(java.lang.String appName)
  tries to identify a running app with the given name and then tries to close it
  Parameters:
     `appName` - name
  Returns:
    0 for success -1 otherwise
```

```Java
public boolean isClosing()
  (no description)
```

```Java
public boolean close()
  tries to close the app defined by this App instance, waits max 10 seconds for the app to no longer be running
  Returns:
    this or null on failure
```

```Java
public boolean close(int waitTime)
  tries to close the app defined by this App instance, waits max given seconds for the app to no longer be running
  Parameters:
     `waitTime` - to wait for app to close (secs)
  Returns:
    this or null on failure
```

```Java
public int closeByKey()
  (no description)
```

```Java
public int closeByKey(int waitTime)
  (no description)
```

```Java
public void setFocused(boolean state)
  (no description)
```

```Java
public boolean hasFocus()
  (no description)
```

--------------------------------

### SikuliX Keycode Text Conversion

Source: https://raiman.github.io/SikuliX1/javadocs/org/sikuli/script/Key

Provides methods to get the text representation of a given keycode.

```Java
static java.lang.String getTextFromKeycode(int key)
```

--------------------------------

### SikuliX Initialization and Debugging Methods

Source: https://raiman.github.io/SikuliX1/javadocs/index-all

Documentation for initialization and debugging methods in SikuliX's Debug and Mouse classes.

```Java
init() - Static method in class org.sikuli.basics.Debug
init() - Static method in class org.sikuli.script.Mouse
init(RunTime) - Static method in class org.sikuli.basics.Settings
```

--------------------------------

### Env - Deprecated Mouse Location Method

Source: https://raiman.github.io/SikuliX1/javadocs/org/sikuli/script/Env

Method to get the current mouse location, deprecated in favor of Mouse.at().

```APIDOC
getMouseLocation()
  Description: Gets the current location of the mouse cursor on the screen. Deprecated. Use Mouse.at() instead.
  Returns: A Location object representing the mouse cursor's current position.
```

--------------------------------

### SikuliX Trace and User Message Handling

Source: https://raiman.github.io/SikuliX1/javadocs/org/sikuli/basics/Debug

Methods for controlling trace output and sending user-specific messages. Includes setting the start-with-trace flag and sending messages intended for user logs.

```Java
static void setStartWithTrace()

```

```Java
static boolean isStartWithTrace()

```

```Java
static void user(java.lang.String message,     java.lang.Object... args)
  messages given by the user  
switch on/off: Settings.UserLogs  
depending on Settings.UserLogTime, the prefix contains a timestamp   
the user prefix (default "user") can be set: Settings,UserLogPrefix  
```

--------------------------------

### App Class Methods - Window Management

Source: https://raiman.github.io/SikuliX1/javadocs/org/sikuli/script/App

Details methods for interacting with application windows, including waiting for windows, evaluating window regions, and setting window properties.

```Java
public Region waitForWindow()
public Region waitForWindow(int seconds)
public Region window()
public Region window(int winNum)
public boolean hasWindow()
public void setWindow(String appWindow)
```

--------------------------------

### Screen Class Constructors and Methods

Source: https://raiman.github.io/SikuliX1/javadocs/index-all

Documentation for the Screen class, including its constructors for creating screen objects and methods for managing screen representation (e.g., setting as screen union).

```Java
Screen - Class in org.sikuli.script 
    
A screen represents a physical monitor with its coordinates and size according to the global point system: the screen areas are grouped around a point (0,0) like in a cartesian system (the top left corner and the points contained in the screen area might have negative x and/or y values)   
The screens are arranged in an array (index = id) and each screen is always the same object (not possible to create new objects). 

Screen() - Constructor for class org.sikuli.script.Screen 
    
Is the screen object having the top left corner as (0,0). 

Screen(int) - Constructor for class org.sikuli.script.Screen 
    
The screen object with the given id 

setAsScreen() - Method in class org.sikuli.script.Screen 
    
INTERNAL USE reset from being a screen union to the screen used before 

setAsScreenUnion() - Method in class org.sikuli.script.Screen 
    
INTERNAL USE collect all physical screens to one big region  
This is under evaluation, wether it really makes sense
```

--------------------------------

### ScreenImage Fields

Source: https://raiman.github.io/SikuliX1/javadocs/org/sikuli/script/ScreenImage

Details the fields available in the ScreenImage class, including 'start' and 'end' which represent the screen coordinates of the captured image.

```APIDOC
Field Detail:

start
public Location start

end
public Location end
```

--------------------------------

### App open Methods

Source: https://raiman.github.io/SikuliX1/javadocs/index-all

Manages the opening of applications. These methods include options to open an app without waiting for it to be ready, waiting for a specified duration, or bringing an already open app to the foreground.

```APIDOC
open() - Method in class org.sikuli.script.App 
    tries to open the app defined by this App instance  
    do not wait for the app to get running

open(int) - Method in class org.sikuli.script.App 
    tries to open the app defined by this App instance  
    and waits until app is running

open(String) - Static method in class org.sikuli.script.App 
    tries to open an app using the given name and waits 1 sec for being ready If the app is already open, it is brought to foreground

open(String, int) - Static method in class org.sikuli.script.App 
    tries to open an app using the given name and waits waitTime for being ready If the app is already open, it is brought to foreground

openLink(String) - Static method in class org.sikuli.script.App
```

--------------------------------

### ScreenImage Fields

Source: https://raiman.github.io/SikuliX1/javadocs/org/sikuli/script/ScreenImage

Details the fields of the ScreenImage class, including start and end locations, and inherited fields from Element and Image classes.

```Java
Location end
Location start
```

```Java
wasRecaptured
```

```Java
h, w, x, y
```

--------------------------------

### Screen Class Overview

Source: https://raiman.github.io/SikuliX1/javadocs/org/sikuli/script/Screen

Provides a high-level overview of the Screen class, its inheritance hierarchy, and its role in representing physical monitors within the SikuliX framework. It highlights that Screen extends Region and implements IScreen.

```APIDOC
Class Screen
  * java.lang.Object
  *     * org.sikuli.script.Element
    *       * org.sikuli.script.Region
      *         * org.sikuli.script.Screen

  * 

All Implemented Interfaces:
    `org.sikuli.script.support.IScreen`
* *
```
public class Screen
extends Region
implements org.sikuli.script.support.IScreen
```

A screen represents a physical monitor with its coordinates and size according to the global point system: the screen areas are grouped around a point (0,0) like in a cartesian system (the top left corner and the points contained in the screen area might have negative x and/or y values)   
The screens are arranged in an array (index = id) and each screen is always the same object (not possible to create new objects).   
A screen inherits from class Region, so it can be used as such in all aspects. If you need the region of the screen more than once, you have to create new ones based on the screen.   
The so called primary screen is the one with top left (0,0) and has id 0.
```

--------------------------------

### SikuliX Java API: PathEntry Get Methods

Source: https://raiman.github.io/SikuliX1/javadocs/index-all

Method to retrieve the file associated with an ImagePath.PathEntry.

```APIDOC
ImagePath.PathEntry:
  getFile() - Method
    Description: Returns the file associated with this path entry.
```
Tokens:
Raw