Interface | Description |
---|---|
IRobot |
INTERNAL USE
function template for (alternative) Robot implementations |
IScreen |
INTERNAL USE
function template for (alternative) Screen implementations
|
SikuliEventObserver | Deprecated |
Class | Description |
---|---|
App |
App implements features to manage (open, switch to, close) applications.
|
App.AppEntry | |
Button |
Defines the constants for use with the mouse actions
for the button to use and the wheel direction
|
Commands | |
Constants |
reasonable symbolic constants to be used with Sikuli features
|
Device | |
Env | Deprecated |
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 |
Image |
This class hides the complexity behind image names given as string.
|
ImageFind |
UNDER DEVELOPMENT --- SURELY HAS BUGS ;-)
Intended replacement for Finder together with ImageFinder
completely implementing the OpenCV usage on the Java level.
|
ImageFinder |
UNDER DEVELOPMENT --- SURELY HAS BUGS ;-)
Intended replacement for Finder together with ImageFind
completely implementing the OpenCV usage on the Java level.
|
ImageGroup |
UNDER DEVELOPMENT --- SURELY HAS BUGS ;-)
An ImageGroup object represents images, that are all in the same folder.
the folder can contain a set of sub folders that can be switched dynamically The folder will be found on the image path. The match data of the images can be stored and reloaded. Its main purpose is to support image sets for different environments. At runtime you can switch between image sets without changing the used image names. Based on the stored match data you might produce a new ImageGroup on the fly. |
ImageLocator | Deprecated
will be completely replaced by the classes Image and ImagePath
relevant functions are already redirected as needed
|
ImagePath |
runtain 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.
|
KeyModifier |
complementing class Key with the constants for the modifier keys
only still there for backward compatibility (is already duplicated in Key) |
Keys |
Main pupose is to coordinate the keyboard usage among threads
At any one time, the keyboard has one owner (usually a Region object) who exclusively uses the keyboard, all others wait for the keyboard to be free again if more than one possible owner is waiting, the next owner is uncertain It is detected, when the keyboard is usaed externally of the workflow, which can be used for appropriate actions (e.g. |
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. |
ObserveEvent |
provides information about the observed event being in the
ObserverCallBack |
Observer |
INTERNAL USE implements the observe action for a region and calls the ObserverCallBacks
|
ObserverCallBack |
Use this class to implement call back methods for the Region observers
onAppear, onVanish and onChange.
|
Observing |
This class globally collects
all running observations and tracks the created events.
|
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
|
RobotDesktop |
INTERNAL USE Implementation of IRobot making a DesktopRobot using java.awt.Robot
|
RobotRemote |
INTERNAL USE - UNDER DEVELOPMENT - EXPERIMENTAL
Implemenation of IRobot that redirects actions targeted towards a DesktopRobot
to a remote DesktopRobot that in turn is implemented in the package Sikuli-Remote.
|
Run | |
Runner | |
RunServer | |
RunTime |
Intended to concentrate all, that is needed at startup of sikulix or sikulixapi
and may be at runtime by SikuliX or any caller
|
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
|
ScreenRemote |
UNDER DEVELOPMENT - EXPERIMENTAL
an extension to the DesktopScreen implementation Screen,
that allows to redirect the actions to a remote screen/keyboard/mouse
in conjunction with the package SikuliX-Remote running on the remote system
|
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?
|
SikuliEvent |
CANDIDATE FOR DEPRECATION - ONLY HERE TO BE BACKWARD COMPATIBLE
|
SikuliEventAdapter | Deprecated
use @{link ObserverCallBack} instead
|
Sikulix |
global services for package API
|
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
Will be rewritten for use of Tess4J - Java only implementation
|
Enum | Description |
---|---|
App.Type | |
FindFailedResponse |
INTERNAL USE
|
IRobot.KeyMode | |
ObserveEvent.Type | |
Observer.State | |
RunTime.Type | |
TextRecognizer.ListTextMode |
Exception | Description |
---|---|
FindFailed |
implements the SikuliX FindFailed exception class
and defines constants and settings for the feature FindFailedResponse
|
SikuliException |
INTERNAL USE
|