All Classes

Class	Description
App	App implements features to manage (open, switch to, close) applications.
App.Type
Button	Defines the constants for use with the mouse actions for the button to use and the wheel direction
Debug	Debug is a utility class that wraps println statements and allows more or less command line output to be turned on. For debug messages only ( Debug.log() ): Use system property: sikuli.Debug to set the debug level (default = 1) On the command line, use -Dsikuli.Debug=n to set it to level n -Dsikuli.Debug will disable any debug messages (which is equivalent to using Settings.Debuglogs = false) It prints if the level number is less than or equal to the currently set DEBUG_LEVEL. For messages ActionLogs, InfoLogs see Settings You might send all messages generated by this class to a file: -Dsikuli.Logfile=pathname (no path given: SikuliLog.txt in working folder) This can be restricted to Debug.user only (others go to System.out): -Dsikuli.LogfileUser=pathname (no path given: UserLog.txt in working folder)
Env	features moved to other classes, details below with the methods
Finder
FindFailed	SikuliX FindFailed exception constants and settings for the features FindFailedResponse FindFailedHandler ImageMissingHandler
Image	This class hides the complexity behind image names given as string.
ImagePath	maintain the path list of locations, where images will be searched.
ImagePath.PathEntry	represents an imagepath entry
Key	this class implements an interface to the Java key system as represented by java.awt.event.KeyEvent.
Location	A point like AWT.Point using global coordinates (x, y).
Match	The region on the screen or rectangle in the image, where the given image or text was found.
Mouse	Main pupose is to coordinate the mouse usage among threads At any one time, the mouse has one owner (usually a Region object) who exclusively uses the mouse, all others wait for the mouse to be free again if more than one possible owner is waiting, the next owner is uncertain It is detected, when the mouse is moved external from the workflow, which can be used for appropriate actions (e.g.
ObserveEvent	provides information about the observed event being in the ObserverCallBack
ObserveEvent.Type
ObserverCallBack	Use this class to implement callbacks for the Region observers onAppear, onVanish and onChange.
OCR	Static helper class for OCR via Tess4J/Tesseract.
OCR.OEM	OCR Engine modes.
OCR.Options	A container for the options relevant for using OCR on Region or Image.
OCR.PSM	Page segmentation modes.
Offset
Pattern	to define a more complex search target - non-standard minimum similarity - click target other than center - masked image (ignore transparent pixels) - resize in case of different environment (scaled views) - wait after used in actions like click
Region	A Region is a rectangular area on a screen.
Screen	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).
ScreenImage	stores a BufferedImage usually ceated by screen capture, the screen rectangle it was taken from and the filename, where it is stored as PNG (only if requested)
Settings	This is the container for all