All Classes
-
All Classes Interface Summary Class Summary Enum Summary Exception Summary Class Description AbortableScriptRunnerWrapper AbstractLocalFileScriptRunner AbstractScriptRunner ADBClient Created by tg44 on 2016. 06. 26..ADBDevice AdbDeviceResponder Created by vidstige on 20/03/14.AdbResponder Created by vidstige on 20/03/14.ADBRobot Created by Törcsi on 2016. 06. 26.ADBScreen Created by Törcsi on 2016. 06. 26.AdbServer Created by vidstige on 2014-03-20ADBTest Created by RaiMan on 12.07.16.AnimationFactory Animator INTERNAL USE allows to implement timed animations (e.g. mouse move)Animator AnimatorLinear AnimatorLinearInterpolation AnimatorOutQuarticEase AnimatorPulse AnimatorQuarticEase AnimatorStopExtention AnimatorTimeBased AnimatorTimeValueFunction 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.Type AppleScriptRunner Bash Button Defines the constants for use with the mouse actions for the button to use and the wheel directionCarbon Author: Denis Tulskiy Date: 6/15/11Carbon.EventHandlerProcPtr Carbon.EventHotKeyID Carbon.EventHotKeyID.ByValue Carbon.EventTypeSpec CarbonProvider Author: Denis Tulskiy Date: 6/17/11ClickableWindow CommandArgs CommandArgsEnum Enum that stores the info about the commandline argsCommandExecutorException Wrapper for all Exception which occurs during native command execution.CommandExecutorHelper CommandExecutorResult Commons ComponentMover Constants reasonable symbolic constants to be used with Sikuli featuresCrawler 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)
You might redirect info, action, error and debug messages to your own logger object
Start with setLogger() and then define with setLoggerXyz() the redirection targets This solution is NOT threadsafe !!!Device EXPERIMENTAL --- INTERNAL USE ONLY
is not official API --- will not be in version 2DistanceComparator Compares the Regions by distance to a point.Element Env features moved to other classes, details below with the methodsEventObserver INTRENAL USEEventSubject INTERNAL USEExtensionManager ExtensionManagerFrame FileManager INTERNAL USE: Support for accessing files and other ressourcesFileManager.FileFilter Finder Finder.Finder2 FindFailed SikuliX FindFailed exception
constants and settings for the features
FindFailedResponse
FindFailedHandler
ImageMissingHandlerFindFailedDialog INTERNAL USEFindFailedResponse INTERNAL USEGenericHotkeyManager GlobalMouseMotionListener GlobalMouseMotionTracker Guide Highlight HorizontalComparator Compares the Regions by x-position.HotKey Internal representation of a hotkey.HotkeyCallback HotkeyController Singleton class to bind hotkeys to hotkey listenersHotkeyEvent HotkeyEvent HotkeyListener HotKeyListener Author: Denis Tulskiy Date: 6/21/11HotkeyManager Singleton class to bind hotkeys to hotkey listenersIAnimator Image This class hides the complexity behind image names given as string.Image.Interpolation Available resize interpolation algorithmsImageCallback ImageGroup EXPERIMENTAL --- INTERNAL USE ONLY
is not official API --- will not be in version 2ImagePath maintain the path list of locations, where images will be searched.ImagePath.PathEntry represents an imagepath entryInvalidRunner IRobot INTERNAL USE
function template for (alternative) Robot implementationsIRobot.KeyMode IRunnerSupport This interface provides script language specific methods which are non a part of ScriptRunner classes.IScreen INTERNAL USE function template for (alternative) Screen implementationsIScriptRunner Interface for ScriptRunners like Jython.IScriptRunner.EffectiveRunner IScriptRunner.Options Special options to pass to the runner.JarExeRunner Runs a sikulix script packed in a jar fileJarRunner Runs a sikulix script packed in a jar fileJRubyRunner JRubySupport JythonRunner Executes Sikuliscripts written in Python/Jython.JythonSupport Key this class implements an interface to the Java key system as represented by java.awt.event.KeyEvent.KeyboardLayout KeyMap Author: Denis Tulskiy Date: 6/17/11KeyMap Author: Denis Tulskiy Date: 6/20/11KeyMap Author: Denis Tulskiy Date: 6/13/11KeyModifier complementing class Key with the constants for the modifier keys
only still there for backward compatibility (is already duplicated in Key)Keys this class implements an interface to the Java key system as represented by java.awt.event.KeyEvent.KeySymDef Author: Denis Tulskiy Date: 6/13/11LinuxHotkeyManager LinuxSupport INTERNAL USE: all things needed with Linux at setup or runtimeLinuxUtil Location A point like AWT.Point using global coordinates (x, y).MacUtil Match The region on the screen or rectangle in the image, where the given image or text was found.MediaKey Author: Denis Tulskiy Date: 6/12/11Mouse 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 isNetworkRunner ObserveEvent provides information about the observed event being in theObserverCallBackObserveEvent.Type Observer INTERNAL USE implements the observe action for a region and calls the ObserverCallBacksObserver.State ObserverCallBack Use this class to implement callbacks for
the Region observers onAppear, onVanish and onChange.Observing INTERNAL USE ONLY --- NOT part of the official API This class globally collects all running observations and tracks the created events.OCR Static helper class for OCR via Tess4J/Tesseract.OCR.OEM OCR Engine modes.OCR.Options OCR.PSM Page segmentation modes.Offset Options OS Deprecated. use Settings.isWindows(), ...isMac() or ...isLinux() insteadOSUtil OverlayCapturePrompt INTERNAL USE implements the screen overlay used with the capture featureOverlayTransparentWindow INTERNAL USE implements a transparent screen overlay for various purposesPackage Android packagePackageManager Java interface to package manager.PackageManager.InstallOption Pattern to define a more complex search target
- non-standard minimum similarity
- click target other than center
- image as in-memory imagePowershellRunner PreferencesUser ProcessRunner PropertyManager A class which works with properties, uses getprop and setprop methods of android shellProvider Main interface to global hotkey providers
Author: Denis Tulskiy Date: 6/12/11PythonRunner Region A Region is a rectengular area on a screen.RobotDesktop INTERNAL USE Implementation of IRobot making a DesktopRobot using java.awt.RobotRobotRunner Run Run EXPERIMENTAL --- NOT official API
not in version 2Runner RunTime INTERNAL USE --- NOT official API
not as is in version 2RunTime.RunType 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 runScreenUnion 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?ServerRunner EXPERIMENTAL --- NOT official API
not as is in version 2Settings This is the container for allShadowRenderer SikuliEvent CANDIDATE FOR DEPRECATION - ONLY HERE TO BE BACKWARD COMPATIBLESikuliException INTERNAL USESikulix SikulixAPI SikuliXception INTERNAL USESikulixEvaluate SikulixFileChooser SikulixForJython Deprecated. 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 *SikulixRun SikulixRunner Runs Sikulix scripts.SilkulixGitTestRunner Runs the Sikulix test scripts from https://github.com/RaiMan/SikuliX-2014/tree/master/TestScripts TODO Check if this is still neededSKLRunner Runs a packed sikulix scriptSocketServer SplashFrame SX SX.Log SxAnchor SxAnchor.AnchorListener SxArea SxArrow SxBeam SxBracket SxButton SxCallout SxCircle SxClickable SxFlag SxHotspot SxImage SxMagnet SxRectangle SxSpotlight SxText SXUser32 SysUtil TextRecognizer Intended to be used only internally - still public for being backward compatibleTextRunner Runs a text file.TimeoutTransition Tracker Transition Transition.TransitionListener TransitionDialog User32 Author: Denis Tulskiy Date: 6/15/11VerticalComparator Compares the Regions by y-position.Visual Visual.Layout VNCScreen WindowsProvider Author: Denis Tulskiy Date: 6/12/11WinUtil WinUtil.ProcessInfo WinUtil.WindowInfo X11 Author: Denis Tulskiy Date: 7/14/11X11.XErrorEvent X11.XErrorHandler X11.XEvent X11.XKeyEvent X11Provider Author: Denis Tulskiy Date: 6/13/11ZipRunner Runs a packed sikulix script