Uses of Package
org.sikuli.script

Packages that use org.sikuli.script

Package	Description
org.sikuli.android
org.sikuli.guide
org.sikuli.natives
org.sikuli.script
org.sikuli.script.compare
org.sikuli.util
org.sikuli.vnc

Classes in org.sikuli.script used by org.sikuli.android

Class and Description
FindFailed implements the SikuliX FindFailed exception class and defines constants and settings for the feature FindFailedResponse
IRobot INTERNAL USE function template for (alternative) Robot implementations
IRobot.KeyMode
IScreen INTERNAL USE function template for (alternative) Screen implementations
Location A point like AWT.Point using global coordinates (x, y).
Region A Region is a rectengular area and lies always completely inside its parent screen
ScreenImage CANDIDATE FOR DEPRECATION 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) This will be replaced by Image in the long run

Classes in org.sikuli.script used by org.sikuli.guide

Class and Description
Pattern to define a more complex search target - non-standard minimum similarity - click target other than center - image as in-memory image
Region A Region is a rectengular area and lies always completely inside its parent screen

Classes in org.sikuli.script used by org.sikuli.natives

Class and Description
App.AppEntry

Classes in org.sikuli.script used by org.sikuli.script

Class and Description
App App implements features to manage (open, switch to, close) applications. on the system we are running on and to access their assets like windows TAKE CARE: function behavior differs depending on the running system (cosult the docs for more info)
App.AppEntry
App.Type
Finder implements the process to find one image in another image this is the historical implementation based on the C++ JNI access to the native OpenCV libraries It is being replaced by ImageFinder, that implements the Finder features completely in Java using the OpenCV newly provided JAVA interface At time of realisation the Finder API will be redirected to ImageFinder
FindFailed implements the SikuliX FindFailed exception class and defines constants and settings for the feature FindFailedResponse
FindFailedResponse INTERNAL USE
Image This class hides the complexity behind image names given as string.
ImageFind EXPERIMENTAL --- INTERNAL USE ONLY is not official API --- will not be in version 2
ImageFinder EXPERIMENTAL --- INTERNAL USE ONLY is not official API --- will not be in version 2
ImageGroup EXPERIMENTAL --- INTERNAL USE ONLY is not official API --- will not be in version 2
ImagePath.PathEntry represents an imagepath entry
IRobot INTERNAL USE function template for (alternative) Robot implementations
IRobot.KeyMode
IScreen INTERNAL USE function template for (alternative) Screen implementations
Location A point like AWT.Point using global coordinates (x, y).
Match holds the result of a find operation, is itself the region on the screen, where the image was found and hence inherits all methods from Region.
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. pause a script) the mouse can be blocked for a longer time, so only this owner can use the mouse (like some transactional processing) Currently deadlocks and infinite waits are not detected, but should not happen ;-) Contained are methods to use the mouse (click, move, button down/up) as is
ObserveEvent provides information about the observed event being in the ObserverCallBack
ObserveEvent.Type
Observer INTERNAL USE implements the observe action for a region and calls the ObserverCallBacks
Observer.State
ObserverCallBack Use this class to implement call back methods for the Region observers onAppear, onVanish and onChange.
Pattern to define a more complex search target - non-standard minimum similarity - click target other than center - image as in-memory image
Region A Region is a rectengular area and lies always completely inside its parent screen
RunTime INTERNAL USE --- NOT official API not as is in version 2 Intended to concentrate all, that is needed at startup of sikulix or sikulixapi and may be at runtime by SikuliX or any caller
RunTime.Type
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 CANDIDATE FOR DEPRECATION 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) This will be replaced by Image in the long run
ScreenUnion CANDIDATE FOR DEPRECATION INTERNAL USE An extension of DesktopScreen, that uses all active monitors as one big screen TO BE EVALUATED: is this really needed?
SikuliEventObserver Deprecated.
SikuliException INTERNAL USE
SikulixForJython Can be used in pure Jython environments to add the Sikuli Python API to sys.path Usage: (before any Sikuli features are used) import org.sikuli.script.SikulixForJython from sikuli import *
TextRecognizer INTERNAL USE --- NOT part of official API Will be rewritten for use of Tess4J - Java only implementation
TextRecognizer.ListTextMode

Classes in org.sikuli.script used by org.sikuli.script.compare

Class and Description
Location A point like AWT.Point using global coordinates (x, y).
Region A Region is a rectengular area and lies always completely inside its parent screen

Classes in org.sikuli.script used by org.sikuli.util

Class and Description
IRobot INTERNAL USE function template for (alternative) Robot implementations
IRobot.KeyMode
IScreen INTERNAL USE function template for (alternative) Screen implementations
Location A point like AWT.Point using global coordinates (x, y).
Region A Region is a rectengular area and lies always completely inside its parent screen
ScreenImage CANDIDATE FOR DEPRECATION 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) This will be replaced by Image in the long run

Classes in org.sikuli.script used by org.sikuli.vnc

Class and Description
FindFailed implements the SikuliX FindFailed exception class and defines constants and settings for the feature FindFailedResponse
IRobot INTERNAL USE function template for (alternative) Robot implementations
IScreen INTERNAL USE function template for (alternative) Screen implementations
Location A point like AWT.Point using global coordinates (x, y).
Region A Region is a rectengular area and lies always completely inside its parent screen
ScreenImage CANDIDATE FOR DEPRECATION 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) This will be replaced by Image in the long run