Skip navigation links
A B C D E F G H I J K L M N O P R S T U V W X Y _ 

A

ABORT - Static variable in exception org.sikuli.script.FindFailed
FindFailedResponse ABORT: should abort the SikuliX application
abortScripting(String, String) - Method in class org.sikuli.script.RunTime
 
above() - Method in class org.sikuli.guide.Visual
 
above(int) - Method in class org.sikuli.guide.Visual
 
above(int) - Method in class org.sikuli.script.Location
creates a point at the given offset above, might be negative
might create a point outside of any screen, not checked
above() - Method in class org.sikuli.script.Region
create a region above the top side with same width
the new region extends to the top screen border
use grow() to include the current region
above(int) - Method in class org.sikuli.script.Region
create a region above the top side with same width and given height
negative height creates the top part with height inside the region use grow() to include the current region
aboveAt() - Method in class org.sikuli.script.Region
 
aboveAt(int) - Method in class org.sikuli.script.Region
negative offset goes towards top of screen
might be off current screen
accept(File) - Method in interface org.sikuli.basics.FileManager.FileFilter
 
accept(ZipEntry, String) - Method in interface org.sikuli.basics.FileManager.JarFileFilter
 
accept(File, String) - Method in class org.sikuli.script.RunTime.oneFileFilter
 
action(String, Object...) - Static method in class org.sikuli.basics.Debug
Sikuli messages from actions like click, ...
switch on/off: Settings.ActionLogs
ActionLogs - Static variable in class org.sikuli.basics.Settings
 
actionPerformed(ActionEvent) - Method in class org.sikuli.guide.GlobalMouseMotionTracker
 
actionPerformed(ActionEvent) - Method in class org.sikuli.guide.TimeoutTransition
 
ADBClient - Class in org.sikuli.android
Created by tg44 on 2016.
ADBClient() - Constructor for class org.sikuli.android.ADBClient
 
ADBDevice - Class in org.sikuli.android
 
ADBRobot - Class in org.sikuli.android
Created by Törcsi on 2016.
ADBRobot(ADBScreen, ADBDevice) - Constructor for class org.sikuli.android.ADBRobot
 
ADBScreen - Class in org.sikuli.android
Created by Törcsi on 2016.
ADBScreen() - Constructor for class org.sikuli.android.ADBScreen
 
ADBTest - Class in org.sikuli.android
Created by RaiMan on 12.07.16.
ADBTest() - Constructor for class org.sikuli.android.ADBTest
 
add(FindResult) - Method in class org.sikuli.natives.FindResults
 
add(OCRChar) - Method in class org.sikuli.natives.OCRChars
 
add(OCRLine) - Method in class org.sikuli.natives.OCRLines
 
add(OCRParagraph) - Method in class org.sikuli.natives.OCRParagraphs
 
add(OCRWord) - Method in class org.sikuli.natives.OCRWords
 
add(String) - Static method in class org.sikuli.script.ImagePath
create a new PathEntry from the given absolute path name and add it to the end of the current image path
for usage with jars see; ImagePath.add(String, String)
add(String, String) - Static method in class org.sikuli.script.ImagePath
create a new PathEntry from the given absolute path name and add it to the end of the current image path
for images stored in jars:
Set the primary image path to the top folder level of a jar based on the given class name (must be found on class path).
add(URL) - Static method in class org.sikuli.script.ImagePath
add entry to end of list (the given URL is not checked)
ADD - Static variable in class org.sikuli.script.Key
 
add(Region, ObserverCallBack, ObserveEvent.Type, Object) - Static method in class org.sikuli.script.Observing
 
add(int, int, int, int) - Method in class org.sikuli.script.Region
resize the region using the given padding values
might be negative
add(Region) - Method in class org.sikuli.script.Region
extend the region, so it contains the given region
but only the part inside the current screen
add(Location) - Method in class org.sikuli.script.Region
extend the region, so it contains the given point
but only the part inside the current screen
addAnimation(NewAnimator) - Method in class org.sikuli.guide.Visual
 
addAnimationListener(AnimationListener) - Method in class org.sikuli.guide.Visual
 
addBeam(Region) - Method in class org.sikuli.guide.Guide
 
addButton(String) - Method in class org.sikuli.guide.TransitionDialog
 
addCircleAnimation(Point, float) - Method in class org.sikuli.guide.Visual
 
addClickable(SxClickable) - Method in class org.sikuli.guide.ClickableWindow
 
addClickableRegion(Region, String) - Method in class org.sikuli.guide.ClickableWindow
 
addComponent(JComponent) - Method in class org.sikuli.guide.Guide
 
addComponent(Visual, int) - Method in class org.sikuli.guide.Guide
 
addEvent(ObserveEvent) - Static method in class org.sikuli.script.Observing
 
addFadeinAnimation() - Method in class org.sikuli.guide.Visual
 
addFadeoutAnimation() - Method in class org.sikuli.guide.Visual
 
addFollower(Visual) - Method in class org.sikuli.guide.Visual
 
addHotkey(String, HotkeyListener) - Method in class org.sikuli.basics.HotkeyManager
install a hotkey listener for a global hotkey (capture, abort, ...)
addHotkey(char, int, HotkeyListener) - Method in class org.sikuli.basics.HotkeyManager
install a hotkey listener.
addHotkey(String, int, HotkeyListener) - Method in class org.sikuli.basics.HotkeyManager
install a hotkey listener.
addHotkey(String, int, HotkeyListener) - Static method in class org.sikuli.script.Env
Deprecated.
use Key. ... instead
addHotkey(char, int, HotkeyListener) - Static method in class org.sikuli.script.Env
Deprecated.
use Key. ... instead
addHotkey(String, int, HotkeyListener) - Static method in class org.sikuli.script.Key
add a hotkey and listener
addHotkey(char, int, HotkeyListener) - Static method in class org.sikuli.script.Key
add a hotkey and listener
addHTTP(String) - Static method in class org.sikuli.script.ImagePath
create a new PathEntry from the given net resource folder accessible via HTTP at end of the current image path
BE AWARE:
Files stored in the given remote folder must allow HTTP HEAD-requests (checked)
redirections are not followed (suppressed)
addImageFacts(Image, Rectangle, double) - Method in class org.sikuli.script.ImageGroup
 
addImagePath(String) - Static method in class org.sikuli.script.ImageLocator
Deprecated. 
addJar(String, String) - Static method in class org.sikuli.script.ImagePath
 
addLandmark(Visual) - Method in class org.sikuli.guide.SxArea
 
addListener(GlobalMouseMotionListener) - Method in class org.sikuli.guide.GlobalMouseMotionTracker
 
addListener(SxAnchor.AnchorListener) - Method in class org.sikuli.guide.SxAnchor
 
addMoveAnimation(Point, Point) - Method in class org.sikuli.guide.Visual
 
addObserver(PSC, ObserverCallBack, String, ObserveEvent.Type) - Method in class org.sikuli.script.Observer
 
addObserver(EventObserver) - Method in interface org.sikuli.util.EventSubject
 
addObserver(EventObserver) - Method in class org.sikuli.util.OverlayCapturePrompt
 
addObserver(EventObserver) - Method in class org.sikuli.util.OverlayTransparentWindow
 
addPreferenceChangeListener(PreferenceChangeListener) - Method in class org.sikuli.basics.PreferencesUser
 
addRegion(Region) - Method in class org.sikuli.guide.SxArea
 
addResizeAnimation(Dimension, Dimension) - Method in class org.sikuli.guide.Visual
 
addRunningObserver(Region) - Static method in class org.sikuli.script.Observing
 
addSitePackages() - Method in class org.sikuli.util.JythonHelper
 
addSlideAnimation(Point, Visual.Layout) - Method in class org.sikuli.guide.Visual
 
addSysPath(String) - Method in class org.sikuli.util.JythonHelper
 
addSysPath(File) - Method in class org.sikuli.util.JythonHelper
 
addTarget(Pattern) - Method in class org.sikuli.guide.SxMagnet
 
addToClasspath(String) - Method in class org.sikuli.script.RunTime
adds the given folder or jar to the end of the current classpath
addToClasspath(String) - Static method in class org.sikuli.script.Sikulix
Deprecated.
addToFront(JComponent) - Method in class org.sikuli.guide.Guide
 
addToFront(Visual) - Method in class org.sikuli.guide.Guide
 
addTracker(Pattern, SxAnchor) - Method in class org.sikuli.guide.Guide
 
addTracker(Pattern, Region, Visual) - Method in class org.sikuli.guide.Guide
 
addTracker(Pattern, Region, ArrayList<Visual>) - Method in class org.sikuli.guide.Guide
 
addTransition(Transition) - Method in class org.sikuli.guide.Guide
 
afterWait - Variable in class org.sikuli.script.Mouse
 
aInput(String) - Method in class org.sikuli.script.Region
EXPERIMENTAL: for Android over ADB
aKey(int) - Method in class org.sikuli.script.Region
EXPERIMENTAL: for Android over ADB
all() - Static method in class org.sikuli.script.Screen
create a Screen (ScreenUnion) object as a united region of all available monitors
ALL_MAX - Static variable in class org.sikuli.script.ImageFind
 
allTargetAnchored() - Method in class org.sikuli.guide.SxMagnet
 
ALT - Static variable in class org.sikuli.script.Key
 
ALT - Static variable in class org.sikuli.script.KeyModifier
 
ALTGR - Static variable in class org.sikuli.script.Key
 
ALTGR - Static variable in class org.sikuli.script.KeyModifier
 
anchored() - Method in class org.sikuli.guide.SxAnchor
 
anchored() - Method in interface org.sikuli.guide.SxAnchor.AnchorListener
 
animationCompleted() - Method in class org.sikuli.guide.Visual
 
AnimationFactory - Class in org.sikuli.guide
 
AnimationFactory() - Constructor for class org.sikuli.guide.AnimationFactory
 
Animator - Interface in org.sikuli.basics
INTERNAL USE allows to implement timed animations (e.g.
Animator - Class in org.sikuli.guide
 
Animator(Visual) - Constructor for class org.sikuli.guide.Animator
 
AnimatorLinear - Class in org.sikuli.basics
 
AnimatorLinear(float, float, long) - Constructor for class org.sikuli.basics.AnimatorLinear
 
AnimatorLinearInterpolation - Class in org.sikuli.basics
 
AnimatorLinearInterpolation(float, float, long) - Constructor for class org.sikuli.basics.AnimatorLinearInterpolation
 
AnimatorOutQuarticEase - Class in org.sikuli.basics
 
AnimatorOutQuarticEase(float, float, long) - Constructor for class org.sikuli.basics.AnimatorOutQuarticEase
 
AnimatorPulse - Class in org.sikuli.basics
 
AnimatorPulse(float, float, long, long) - Constructor for class org.sikuli.basics.AnimatorPulse
 
AnimatorQuarticEase - Class in org.sikuli.basics
 
AnimatorQuarticEase(float, float, long) - Constructor for class org.sikuli.basics.AnimatorQuarticEase
 
AnimatorStopExtention - Class in org.sikuli.basics
 
AnimatorStopExtention(AnimatorTimeValueFunction, long) - Constructor for class org.sikuli.basics.AnimatorStopExtention
 
AnimatorTimeBased - Class in org.sikuli.basics
 
AnimatorTimeBased(AnimatorTimeValueFunction) - Constructor for class org.sikuli.basics.AnimatorTimeBased
 
AnimatorTimeValueFunction - Class in org.sikuli.basics
 
AnimatorTimeValueFunction(float, float, long) - Constructor for class org.sikuli.basics.AnimatorTimeValueFunction
 
App - Class in org.sikuli.script
App implements features to manage (open, switch to, close) applications.
App(String) - Constructor for class org.sikuli.script.App
creates an instance for an app with this name (nothing done yet)
App(int) - Constructor for class org.sikuli.script.App
 
App.AppEntry - Class in org.sikuli.script
 
App.Type - Enum in org.sikuli.script
 
appDataMsg - Static variable in class org.sikuli.script.RunTime
 
appeared(ObserveEvent) - Method in class org.sikuli.script.ObserverCallBack
 
appeared(ObserveEvent) - Method in class org.sikuli.script.SikuliEventAdapter
Deprecated.
 
appendSysPath(String) - Method in class org.sikuli.util.JythonHelper
 
AppEntry(String, String, String, String, String) - Constructor for class org.sikuli.script.App.AppEntry
 
appPathMac - Static variable in class org.sikuli.basics.Settings
 
argname() - Method in enum org.sikuli.util.CommandArgsEnum
Returns the argname
arrayToString(String[]) - Static method in class org.sikuli.script.Sikulix
 
arrow(Object, Object) - Method in class org.sikuli.guide.Guide
 
as(int) - Static method in class org.sikuli.script.Screen
 
AS_COLUMNS - Static variable in class org.sikuli.script.ImageFind
 
AS_ROWS - Static variable in class org.sikuli.script.ImageFind
 
asExtension(String) - Method in class org.sikuli.script.RunTime
 
asFile() - Method in class org.sikuli.script.Image
stores the image as PNG file in the standard temp folder with a created filename (sikuli-image-#unique-random#.png) if not yet stored before
asOffset() - Method in class org.sikuli.script.Region
create a Location object, that can be used as an offset taking the width and hight of this Region
aSwipe(PFRML, PFRML) - Method in class org.sikuli.script.Region
EXPERIMENTAL: for Android over ADB
aSwipeDown() - Method in class org.sikuli.script.Region
EXPERIMENTAL: for Android over ADB
aSwipeLeft() - Method in class org.sikuli.script.Region
EXPERIMENTAL: for Android over ADB
aSwipeRight() - Method in class org.sikuli.script.Region
EXPERIMENTAL: for Android over ADB
aSwipeUp() - Method in class org.sikuli.script.Region
EXPERIMENTAL: for Android over ADB
at() - Static method in class org.sikuli.script.Mouse
 
aTap(PFRML) - Method in class org.sikuli.script.Region
EXPERIMENTAL: for Android over ADB
atMouse() - Static method in class org.sikuli.script.Region
Deprecated.
use Mouse.at() instead
AUTO_NAMING_OCR - Static variable in class org.sikuli.basics.PreferencesUser
 
AUTO_NAMING_OFF - Static variable in class org.sikuli.basics.PreferencesUser
 
AUTO_NAMING_TIMESTAMP - Static variable in class org.sikuli.basics.PreferencesUser
 
AutoWaitTimeout - Static variable in class org.sikuli.basics.Settings
 

B

BACKSPACE - Static variable in class org.sikuli.script.Key
 
backup() - Method in class org.sikuli.script.Image
 
base - Variable in class org.sikuli.script.ImageFinder
 
baseJar - Variable in class org.sikuli.script.RunTime
 
BB - Static variable in class org.sikuli.script.Region
 
beforeWait - Variable in class org.sikuli.script.Mouse
 
below() - Method in class org.sikuli.guide.Visual
 
below(int) - Method in class org.sikuli.guide.Visual
 
below(int) - Method in class org.sikuli.script.Location
creates a point at the given offset below, might be negative
might create a point outside of any screen, not checked
below() - Method in class org.sikuli.script.Region
create a region below the bottom side with same width
the new region extends to the bottom screen border
use grow() to include the current region
below(int) - Method in class org.sikuli.script.Region
create a region below the bottom side with same width and given height
negative height creates the bottom part with height inside the region use grow() to include the current region
belowAt() - Method in class org.sikuli.script.Region
 
belowAt(int) - Method in class org.sikuli.script.Region
positive offset goes towards bottom of screen
might be off current screen
BEST_FIRST - Static variable in class org.sikuli.script.ImageFind
 
BH - Static variable in class org.sikuli.script.Region
 
BL - Static variable in class org.sikuli.script.Region
 
block() - Method in class org.sikuli.script.Device
to block the device globally
only the contained device methods without owner will be granted
block(Object) - Method in class org.sikuli.script.Device
to block the device globally for the given owner
only the contained mouse methods having the same owner will be granted
BM - Static variable in class org.sikuli.script.Region
 
BOUNDING - Static variable in class org.sikuli.guide.SxArea
 
BR - Static variable in class org.sikuli.script.Region
 
bracket() - Method in class org.sikuli.guide.Guide
 
breakPoint - Static variable in class org.sikuli.basics.Settings
 
bringWindowToFront(Window, boolean) - Method in class org.sikuli.natives.LinuxUtil
 
bringWindowToFront(Window, boolean) - Method in class org.sikuli.natives.MacUtil
 
bringWindowToFront(Window, boolean) - Method in interface org.sikuli.natives.OSUtil
 
bringWindowToFront(Window, boolean) - Method in class org.sikuli.natives.WinUtil
 
buildJar(String, String[], String[], String[], FileManager.JarFileFilter) - Static method in class org.sikuli.basics.FileManager
 
buildJarFromFolder(String, String) - Static method in class org.sikuli.script.Sikulix
build a jar on the fly at runtime from a folder.
special for Jython: if the folder contains a __init__.py on first level, the folder will be copied to the jar root (hence preserving module folders)
buildVision() - Static method in class org.sikuli.util.LinuxSupport
 
BundlePath - Static variable in class org.sikuli.basics.Settings
 
button(String) - Method in class org.sikuli.guide.Guide
 
BUTTON - Static variable in class org.sikuli.natives.TARGET_TYPE
 
Button - Class in org.sikuli.script
Defines the constants for use with the mouse actions for the button to use and the wheel direction
Button() - Constructor for class org.sikuli.script.Button
 
buttons - Variable in class org.sikuli.script.Mouse
 

C

C2 - Static variable in class org.sikuli.script.Region
 
C_ADD - Static variable in class org.sikuli.script.Key
 
C_ALT - Static variable in class org.sikuli.script.Key
 
C_ALTGR - Static variable in class org.sikuli.script.Key
 
C_CAPS_LOCK - Static variable in class org.sikuli.script.Key
 
C_CMD - Static variable in class org.sikuli.script.Key
 
C_CONTEXT - Static variable in class org.sikuli.script.Key
 
C_CTRL - Static variable in class org.sikuli.script.Key
 
C_DECIMAL - Static variable in class org.sikuli.script.Key
 
C_DELETE - Static variable in class org.sikuli.script.Key
 
C_DIVIDE - Static variable in class org.sikuli.script.Key
 
C_DOWN - Static variable in class org.sikuli.script.Key
 
C_END - Static variable in class org.sikuli.script.Key
 
C_ESC - Static variable in class org.sikuli.script.Key
 
C_F1 - Static variable in class org.sikuli.script.Key
 
C_F10 - Static variable in class org.sikuli.script.Key
 
C_F11 - Static variable in class org.sikuli.script.Key
 
C_F12 - Static variable in class org.sikuli.script.Key
 
C_F13 - Static variable in class org.sikuli.script.Key
 
C_F14 - Static variable in class org.sikuli.script.Key
 
C_F15 - Static variable in class org.sikuli.script.Key
 
C_F2 - Static variable in class org.sikuli.script.Key
 
C_F3 - Static variable in class org.sikuli.script.Key
 
C_F4 - Static variable in class org.sikuli.script.Key
 
C_F5 - Static variable in class org.sikuli.script.Key
 
C_F6 - Static variable in class org.sikuli.script.Key
 
C_F7 - Static variable in class org.sikuli.script.Key
 
C_F8 - Static variable in class org.sikuli.script.Key
 
C_F9 - Static variable in class org.sikuli.script.Key
 
C_HOME - Static variable in class org.sikuli.script.Key
 
C_INSERT - Static variable in class org.sikuli.script.Key
 
C_LEFT - Static variable in class org.sikuli.script.Key
 
C_META - Static variable in class org.sikuli.script.Key
 
C_MINUS - Static variable in class org.sikuli.script.Key
 
C_MULTIPLY - Static variable in class org.sikuli.script.Key
 
C_NEXT - Static variable in class org.sikuli.script.Key
 
C_NUM0 - Static variable in class org.sikuli.script.Key
 
C_NUM1 - Static variable in class org.sikuli.script.Key
 
C_NUM2 - Static variable in class org.sikuli.script.Key
 
C_NUM3 - Static variable in class org.sikuli.script.Key
 
C_NUM4 - Static variable in class org.sikuli.script.Key
 
C_NUM5 - Static variable in class org.sikuli.script.Key
 
C_NUM6 - Static variable in class org.sikuli.script.Key
 
C_NUM7 - Static variable in class org.sikuli.script.Key
 
C_NUM8 - Static variable in class org.sikuli.script.Key
 
C_NUM9 - Static variable in class org.sikuli.script.Key
 
C_NUM_LOCK - Static variable in class org.sikuli.script.Key
 
C_PAGE_DOWN - Static variable in class org.sikuli.script.Key
 
C_PAGE_UP - Static variable in class org.sikuli.script.Key
 
C_PAUSE - Static variable in class org.sikuli.script.Key
 
C_PRINTSCREEN - Static variable in class org.sikuli.script.Key
 
C_RIGHT - Static variable in class org.sikuli.script.Key
 
C_SCROLL_LOCK - Static variable in class org.sikuli.script.Key
 
C_SEPARATOR - Static variable in class org.sikuli.script.Key
 
C_SHIFT - Static variable in class org.sikuli.script.Key
 
C_UP - Static variable in class org.sikuli.script.Key
 
C_WIN - Static variable in class org.sikuli.script.Key
 
call(String, Object...) - Static method in class org.sikuli.script.Commands
INTERNAL USE: call interface for JavaScript to be used with predefined functions
callback - Variable in class org.sikuli.script.Device
 
callout(String) - Method in class org.sikuli.guide.Guide
 
canRun() - Static method in class org.sikuli.script.Sikulix
Can SikuliX be run on this machine?
capacity() - Method in class org.sikuli.natives.FindResults
 
capacity() - Method in class org.sikuli.natives.OCRChars
 
capacity() - Method in class org.sikuli.natives.OCRLines
 
capacity() - Method in class org.sikuli.natives.OCRParagraphs
 
capacity() - Method in class org.sikuli.natives.OCRWords
 
CAPS_LOCK - Static variable in class org.sikuli.script.Key
 
capture() - Method in class org.sikuli.android.ADBScreen
 
capture(int, int, int, int) - Method in class org.sikuli.android.ADBScreen
 
capture(Region) - Method in class org.sikuli.android.ADBScreen
 
capture(Rectangle) - Method in class org.sikuli.android.ADBScreen
 
capture() - Method in interface org.sikuli.script.IScreen
 
capture(int, int, int, int) - Method in interface org.sikuli.script.IScreen
 
capture(Rectangle) - Method in interface org.sikuli.script.IScreen
 
capture(Region) - Method in interface org.sikuli.script.IScreen
 
capture() - Method in class org.sikuli.script.Screen
create a ScreenImage with the physical bounds of this screen
capture(int, int, int, int) - Method in class org.sikuli.script.Screen
create a ScreenImage with given coordinates on this screen.
capture(Rectangle) - Method in class org.sikuli.script.Screen
create a ScreenImage with given rectangle on this screen.
capture(Region) - Method in class org.sikuli.script.Screen
create a ScreenImage with given region on this screen
capture(Rectangle) - Method in class org.sikuli.script.ScreenUnion
 
capture() - Method in class org.sikuli.vnc.VNCScreen
 
capture(Region) - Method in class org.sikuli.vnc.VNCScreen
 
capture(Rectangle) - Method in class org.sikuli.vnc.VNCScreen
 
capture(int, int, int, int) - Method in class org.sikuli.vnc.VNCScreen
 
captureDeviceScreen() - Method in class org.sikuli.android.ADBDevice
 
captureDeviceScreen(int, int) - Method in class org.sikuli.android.ADBDevice
 
captureDeviceScreen(int, int, int, int) - Method in class org.sikuli.android.ADBDevice
 
captureDeviceScreenMat(int, int, int, int) - Method in class org.sikuli.android.ADBDevice
 
captureforHighlight(int, int, int, int) - Method in class org.sikuli.script.Screen
 
captureScreen() - Method in class org.sikuli.android.ADBDevice
 
captureScreen(Rectangle) - Method in class org.sikuli.android.ADBDevice
 
captureScreen(Rectangle) - Method in class org.sikuli.android.ADBRobot
 
captureScreen(Rectangle) - Method in interface org.sikuli.script.IRobot
 
captureScreen(Rectangle) - Method in class org.sikuli.script.RobotDesktop
 
captureScreen(Rectangle) - Method in class org.sikuli.util.FakeRobot
 
CASCRIPT - Static variable in class org.sikuli.script.Runner
 
CH - Static variable in class org.sikuli.script.Region
 
changed(ObserveEvent) - Method in class org.sikuli.script.ObserverCallBack
 
changed(ObserveEvent) - Method in class org.sikuli.script.SikuliEventAdapter
Deprecated.
 
checkAllLibs() - Static method in class org.sikuli.util.LinuxSupport
 
checkArgs(String[], RunTime.Type) - Static method in class org.sikuli.script.RunTime
 
checkCallback(Object[]) - Method in class org.sikuli.util.JythonHelper
 
checkFeatureAvailability() - Method in class org.sikuli.natives.LinuxUtil
 
checkFeatureAvailability() - Method in class org.sikuli.natives.MacUtil
 
checkFeatureAvailability() - Method in interface org.sikuli.natives.OSUtil
check if needed command libraries or packages are installed and working
if not ok, respective features will do nothing but issue error messages
checkFeatureAvailability() - Method in class org.sikuli.natives.WinUtil
 
checkFind(ImageFinder, Object, Object...) - Method in class org.sikuli.script.ImageFind
 
checkJarContent(String, String) - Static method in class org.sikuli.basics.FileManager
 
CheckLastSeen - Static variable in class org.sikuli.basics.Settings
 
CheckLastSeenSimilar - Static variable in class org.sikuli.basics.Settings
 
checkMatch() - Method in class org.sikuli.script.Region
 
circle() - Method in class org.sikuli.guide.Guide
 
CIRCLE - Static variable in class org.sikuli.guide.SxSpotlight
 
circle(Object) - Static method in class org.sikuli.script.Commands
 
CJSCRIPT - Static variable in class org.sikuli.script.Runner
 
classLoader - Variable in class org.sikuli.script.RunTime
 
cleanup() - Method in class org.sikuli.android.ADBRobot
 
cleanUp() - Method in class org.sikuli.basics.HotkeyManager
 
cleanUp() - Method in class org.sikuli.basics.LinuxHotkeyManager
 
cleanUp() - Method in class org.sikuli.basics.MacHotkeyManager
 
cleanUp() - Method in class org.sikuli.basics.WindowsHotkeyManager
 
cleanUp() - Static method in class org.sikuli.script.Env
Deprecated.
 
cleanup() - Method in interface org.sikuli.script.IRobot
 
cleanUp() - Static method in class org.sikuli.script.Observing
stop and remove all observers and their registered events
cleanup() - Method in class org.sikuli.script.RobotDesktop
 
cleanUp(int) - Static method in class org.sikuli.script.Sikulix
INTERNAL USE: resets stateful Sikuli X features:
ScreenHighlighter, Observing, Mouse, Key, Hotkeys
When in IDE: resets selected options to defaults (TODO)
cleanup() - Method in class org.sikuli.util.FakeRobot
 
clear() - Method in class org.sikuli.guide.ClickableWindow
 
clear() - Method in class org.sikuli.guide.Guide
 
clear() - Method in class org.sikuli.natives.FindResults
 
clear() - Method in class org.sikuli.natives.OCRChars
 
clear() - Method in class org.sikuli.natives.OCRLines
 
clear() - Method in class org.sikuli.natives.OCRParagraphs
 
clear() - Method in class org.sikuli.natives.OCRWords
 
clearCache(int) - Static method in class org.sikuli.script.Image
 
clearEvents() - Static method in class org.sikuli.script.Observing
the event list is purged
click(Object...) - Static method in class org.sikuli.script.Commands
move the mouse with hover() and click using the left button
click() - Method in class org.sikuli.script.Location
Move the mouse to this location point and click left
click(Location, String, Integer...) - Static method in class org.sikuli.script.Mouse
to click (left, right, middle - single or double) at the given location using the given button only useable for local screens timing parameters:
- one value
< 0 wait before mouse down
> 0 wait after mouse up
- 2 or 3 values 1st wait before mouse down
2nd wait after mouse up
3rd inner wait (milli secs, cut to 1000): pause between mouse down and up (Settings.ClickDelay) wait before and after: > 9 taken as milli secs - 1 ...
click(Location, int, Integer, boolean, Region) - Static method in class org.sikuli.script.Mouse
 
click() - Method in class org.sikuli.script.Region
left click at the region's last successful match
use center if no lastMatch
if region is a match: click targetOffset
click(PFRML) - Method in class org.sikuli.script.Region
left click at the given target location
Pattern or Filename - do a find before and use the match
Region - position at center
Match - position at match's targetOffset
Location - position at that point
click(PFRML, Integer) - Method in class org.sikuli.script.Region
left click at the given target location
holding down the given modifier keys
Pattern or Filename - do a find before and use the match
Region - position at center
Match - position at match's targetOffset
Location - position at that point
ClickableWindow - Class in org.sikuli.guide
 
ClickableWindow(Guide) - Constructor for class org.sikuli.guide.ClickableWindow
 
ClickDelay - Static variable in class org.sikuli.basics.Settings
Specify a delay between the mouse down and up in seconds as 0.nnn.
clickDouble - Variable in class org.sikuli.script.Mouse
 
clickEnds() - Method in class org.sikuli.android.ADBRobot
 
clickEnds() - Method in interface org.sikuli.script.IRobot
 
clickEnds() - Method in class org.sikuli.script.RobotDesktop
 
clickEnds() - Method in class org.sikuli.util.FakeRobot
 
ClickFast - Static variable in class org.sikuli.basics.Settings
 
clickStarts() - Method in class org.sikuli.android.ADBRobot
 
clickStarts() - Method in interface org.sikuli.script.IRobot
 
clickStarts() - Method in class org.sikuli.script.RobotDesktop
 
clickStarts() - Method in class org.sikuli.util.FakeRobot
 
clone() - Method in class org.sikuli.guide.Visual
 
close(String) - Method in class org.sikuli.natives.LinuxUtil
 
close(App.AppEntry) - Method in class org.sikuli.natives.LinuxUtil
 
close(int) - Method in class org.sikuli.natives.LinuxUtil
 
close(String) - Method in class org.sikuli.natives.MacUtil
 
close(int) - Method in class org.sikuli.natives.MacUtil
 
close(App.AppEntry) - Method in class org.sikuli.natives.MacUtil
 
close(String) - Method in interface org.sikuli.natives.OSUtil
 
close(int) - Method in interface org.sikuli.natives.OSUtil
 
close(App.AppEntry) - Method in interface org.sikuli.natives.OSUtil
 
close(String) - Method in class org.sikuli.natives.WinUtil
 
close(int) - Method in class org.sikuli.natives.WinUtil
 
close(App.AppEntry) - Method in class org.sikuli.natives.WinUtil
 
close(String) - Static method in class org.sikuli.script.App
tries to identify a running app with the given name and then tries to close it
close() - Method in class org.sikuli.script.App
tries to close the app defined by this App instance
close(ImageGroup) - Static method in class org.sikuli.script.ImageGroup
 
close() - Static method in class org.sikuli.script.Run
 
close() - Method in class org.sikuli.util.OverlayCapturePrompt
 
close() - Method in class org.sikuli.util.OverlayTransparentWindow
 
close() - Method in class org.sikuli.util.ScreenHighlighter
 
close() - Method in class org.sikuli.vnc.VNCScreen
 
closeAfter(int) - Method in class org.sikuli.basics.SplashFrame
 
closeAll() - Static method in class org.sikuli.util.ScreenHighlighter
 
closeApp(String) - Method in class org.sikuli.natives.WinUtil
 
closeApp(int) - Method in class org.sikuli.natives.WinUtil
 
closePrompt() - Static method in class org.sikuli.script.Screen
 
closePrompt(Screen) - Static method in class org.sikuli.script.Screen
 
cMax - Static variable in class org.sikuli.script.Key
 
CMD - Static variable in class org.sikuli.script.Key
 
CMD - Static variable in class org.sikuli.script.KeyModifier
 
cmdCapture(Object...) - Method in class org.sikuli.script.Screen
 
cMin - Static variable in class org.sikuli.script.Key
 
CommandArgs - Class in org.sikuli.util
 
CommandArgs(String) - Constructor for class org.sikuli.util.CommandArgs
 
CommandArgsEnum - Enum in org.sikuli.util
Enum that stores the info about the commandline args
CommandExecutorException - Exception in org.sikuli.natives
Wrapper for all Exception which occurs during native command execution.
CommandExecutorException(String) - Constructor for exception org.sikuli.natives.CommandExecutorException
 
CommandExecutorException(String, CommandExecutorResult) - Constructor for exception org.sikuli.natives.CommandExecutorException
 
CommandExecutorHelper - Class in org.sikuli.natives
 
CommandExecutorHelper() - Constructor for class org.sikuli.natives.CommandExecutorHelper
 
CommandExecutorResult - Class in org.sikuli.natives
 
CommandExecutorResult(int, String, String) - Constructor for class org.sikuli.natives.CommandExecutorResult
 
Commands - Class in org.sikuli.script
EXPERIMENTAL --- INTERNAL USE ONLY
is not official API --- will not be in version 2
Commands() - Constructor for class org.sikuli.script.Commands
 
compare(Mat, Mat) - Static method in class org.sikuli.natives.Vision
 
compare(Region, Region) - Method in class org.sikuli.script.compare.DistanceComparator
Compares the distance of two Region objects.
compare(Region, Region) - Method in class org.sikuli.script.compare.HorizontalComparator
Compares the X-Position of two Region objects.
compare(Region, Region) - Method in class org.sikuli.script.compare.VerticalComparator
Compares the Y-Position of two Region objects.
compare(String) - Method in class org.sikuli.script.Region
time optimized Region.exists, when image-size == region-size
1.1.x: just using exists(img, 0), sizes not checked
compare(Image) - Method in class org.sikuli.script.Region
time optimized Region.exists, when image-size == region-size
1.1.x: just using exists(img, 0), sizes not checked
compareTo(Location) - Method in class org.sikuli.script.Location
compareTo(Match) - Method in class org.sikuli.script.Match
 
compileJythonFolder(String, String) - Static method in class org.sikuli.script.Sikulix
the foo.py files in the given source folder are compiled to JVM-ByteCode-classfiles foo$py.class and stored in the target folder (thus securing your code against changes).
A folder structure is preserved.
componentHidden(ComponentEvent) - Method in class org.sikuli.guide.SxArea
 
componentHidden(ComponentEvent) - Method in class org.sikuli.guide.SxArrow
 
componentMoved(ComponentEvent) - Method in class org.sikuli.guide.SxArea
 
componentMoved(ComponentEvent) - Method in class org.sikuli.guide.SxArrow
 
ComponentMover - Class in org.sikuli.guide
 
ComponentMover() - Constructor for class org.sikuli.guide.ComponentMover
Constructor for moving individual components.
ComponentMover(Class, Component...) - Constructor for class org.sikuli.guide.ComponentMover
Constructor to specify a Class of Component that will be moved when drag events are generated on a registered child component.
ComponentMover(Component, Component...) - Constructor for class org.sikuli.guide.ComponentMover
Constructor to specify a parent component that will be moved when drag events are generated on a registered child component.
componentResized(ComponentEvent) - Method in class org.sikuli.guide.SxArea
 
componentResized(ComponentEvent) - Method in class org.sikuli.guide.SxArrow
 
componentShown(ComponentEvent) - Method in class org.sikuli.guide.SxArea
 
componentShown(ComponentEvent) - Method in class org.sikuli.guide.SxArrow
 
connect() - Static method in class org.sikuli.script.Run
 
Constants - Class in org.sikuli.script
reasonable symbolic constants to be used with Sikuli features
Constants() - Constructor for class org.sikuli.script.Constants
 
contains(Location) - Method in class org.sikuli.script.Region
check if current region contains given point
contains(Region) - Method in class org.sikuli.script.Region
check if current region contains given region
containsMouse() - Method in class org.sikuli.script.Region
check if mouse pointer is inside current region
CONTEXT - Static variable in class org.sikuli.script.Key
 
convertBufferedImageToByteArray(BufferedImage) - Static method in class org.sikuli.script.Image
 
convertBufferedImageToMat(BufferedImage) - Static method in class org.sikuli.script.Image
 
convertImageData(BufferedImage) - Static method in class org.sikuli.script.Image
Converts BufferedImage to ByteBuffer.
convertImageToGrayscale(BufferedImage) - Static method in class org.sikuli.script.Image
A simple method to convert an image to gray scale.
convertKeyToText(int, int) - Static method in class org.sikuli.script.Key
INTERNAL USE ONLY
convertModifiers(String) - Static method in class org.sikuli.script.Key
 
convertStreamToString(InputStream) - Static method in class org.sikuli.basics.FileManager
 
copyProvidedLibs(File) - Static method in class org.sikuli.util.LinuxSupport
 
copyTo(int) - Method in class org.sikuli.script.Location
new point with same offset to current screen's top left on given screen
copyTo(IScreen) - Method in class org.sikuli.script.Location
New point with same offset to current screen's top left on given screen
copyTo(int) - Method in class org.sikuli.script.Region
new region with same offset to current screen's top left on given screen
copyTo(IScreen) - Method in class org.sikuli.script.Region
new region with same offset to current screen's top left on given screen
CPLAIN - Static variable in class org.sikuli.script.Runner
 
CPYTHON - Static variable in class org.sikuli.script.Runner
 
create(Image) - Static method in class org.sikuli.script.Image
create a new Image as copy of the given Image
create(String) - Static method in class org.sikuli.script.Image
create a new image from a filename
file ending .png is added if missing (currently valid: png, jpg, jpeg)
relative filename: [...path.../]name[.png] is searched on current image path
absolute filename is taken as is if image exists, it is loaded to cache
already loaded image with same name (given path) is reused (taken from cache)
if image not found, it might be a text to be searched (imageIsText = true)
create(Pattern) - Static method in class org.sikuli.script.Image
create a new Image with Pattern aspects from an existing Pattern
create(URL) - Static method in class org.sikuli.script.Image
create a new image from the given url
file ending .png is added if missing
filename: ...url-path.../name[.png] is loaded from the url and and cached
already loaded image with same url is reused (reference) and taken from cache
create(int, int, int, int) - Static method in class org.sikuli.script.Region
Create a region with the provided top left corner and size
create(Location, int, int) - Static method in class org.sikuli.script.Region
Create a region with the provided top left corner and size
create(Location, int, int, int, int) - Static method in class org.sikuli.script.Region
create a region with a corner at the given point
as specified with x y
0 0 top left
0 1 bottom left
1 0 top right
1 1 bottom right
create(Rectangle) - Static method in class org.sikuli.script.Region
Create a region from a Rectangle
create(Rectangle, IScreen) - Static method in class org.sikuli.script.Region
Create a region from a Rectangle on a given Screen
create(Region) - Static method in class org.sikuli.script.Region
Create a region from another region
including the region's settings
CREATE_X_DIRECTION_LEFT - Static variable in class org.sikuli.script.Region
CREATE_X_DIRECTION_RIGHT - Static variable in class org.sikuli.script.Region
CREATE_Y_DIRECTION_BOTTOM - Static variable in class org.sikuli.script.Region
CREATE_Y_DIRECTION_TOP - Static variable in class org.sikuli.script.Region
createBufferedImage(int, int) - Static method in class org.sikuli.script.Image
 
createCircleAnimation(Visual, Point, float) - Static method in class org.sikuli.guide.AnimationFactory
 
createdefault(Region, Image) - Static method in exception org.sikuli.script.FindFailed
 
createKeyTable() - Static method in class org.sikuli.script.Key
INTERNAL USE ONLY create a table containing all relevant key, keycode and keytext settings for VK_xxx
createMat(int, int, byte[]) - Static method in class org.sikuli.natives.Vision
 
createMat(BufferedImage) - Static method in class org.sikuli.script.Image
 
createMoveAnimator(int, int) - Method in class org.sikuli.guide.Visual
 
createOpacityAnimation(Visual, float, float) - Static method in class org.sikuli.guide.AnimationFactory
 
createShadowImage() - Method in class org.sikuli.guide.ShadowRenderer
 
createSlidingAnimator(int, int) - Method in class org.sikuli.guide.Visual
 
createTempDir(String) - Static method in class org.sikuli.basics.FileManager
 
createTempDir() - Static method in class org.sikuli.basics.FileManager
 
createTempFile(String) - Static method in class org.sikuli.basics.FileManager
 
createTempFile(String, String) - Static method in class org.sikuli.basics.FileManager
 
createThumbNail(String) - Static method in class org.sikuli.script.Image
FOR INTERNAL USE: from IDE - suppresses load error message
CRUBY - Static variable in class org.sikuli.script.Runner
 
CSSCRIPT - Static variable in class org.sikuli.script.Runner
 
CTRL - Static variable in class org.sikuli.script.Key
 
CTRL - Static variable in class org.sikuli.script.KeyModifier
 
curID - Variable in class org.sikuli.script.Screen
 
current - Variable in class org.sikuli.guide.SxBeam
 
currentLayout - Variable in class org.sikuli.guide.Visual
 
CV - Static variable in class org.sikuli.script.Region
 

D

Debug - Class in org.sikuli.basics
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 !!!
Debug() - Constructor for class org.sikuli.basics.Debug
 
DebugCategories - Class in org.sikuli.natives
 
DebugCategories() - Constructor for class org.sikuli.natives.DebugCategories
 
debuglevelAPI - Variable in class org.sikuli.script.RunTime
 
DebugLogs - Static variable in class org.sikuli.basics.Settings
 
DECIMAL - Static variable in class org.sikuli.script.Key
 
DEFAULT_CONSOLE_CSS - Static variable in class org.sikuli.basics.PreferencesUser
 
defaultFindFailedResponse - Static variable in exception org.sikuli.script.FindFailed
default FindFailedResponse is ABORT
DefaultHighlightTime - Static variable in class org.sikuli.basics.Settings
 
DefaultPadding - Static variable in class org.sikuli.basics.Settings
default pixels to add around with nearby() and grow()
defColor - Static variable in class org.sikuli.guide.Visual
 
defColorBack - Static variable in class org.sikuli.guide.Visual
 
defColorFrame - Static variable in class org.sikuli.guide.Visual
 
defColorFront - Static variable in class org.sikuli.guide.Visual
 
defColorText - Static variable in class org.sikuli.guide.Visual
 
defFont - Static variable in class org.sikuli.guide.Visual
 
defFontSize - Static variable in class org.sikuli.guide.Visual
 
defStroke - Static variable in class org.sikuli.guide.Visual
 
delay(int) - Method in class org.sikuli.android.ADBRobot
 
delay(int) - Static method in class org.sikuli.script.Device
 
delay(int) - Method in interface org.sikuli.script.IRobot
 
delay(int) - Method in class org.sikuli.script.RobotDesktop
 
delay(int) - Method in class org.sikuli.util.FakeRobot
 
DelayAfterDrag - Static variable in class org.sikuli.basics.Settings
Deprecated.
DelayBeforeDrag - Static variable in class org.sikuli.basics.Settings
 
DelayBeforeDrop - Static variable in class org.sikuli.basics.Settings
 
DelayBeforeMouseDown - Static variable in class org.sikuli.basics.Settings
 
delayClick(int) - Method in class org.sikuli.script.Region
time in milliseconds to delay between button down/up at next click only (max 1000)
delayType(int) - Method in class org.sikuli.script.Region
time in milliseconds to delay between each character at next type only (max 1000)
DelayValue - Static variable in class org.sikuli.basics.Settings
 
delete() - Method in class org.sikuli.natives.FindInput
 
delete() - Method in class org.sikuli.natives.FindResult
 
delete() - Method in class org.sikuli.natives.FindResults
 
delete() - Method in class org.sikuli.natives.Mat
 
delete() - Method in class org.sikuli.natives.OCR
 
delete() - Method in class org.sikuli.natives.OCRChar
 
delete() - Method in class org.sikuli.natives.OCRChars
 
delete() - Method in class org.sikuli.natives.OCRLine
 
delete() - Method in class org.sikuli.natives.OCRLines
 
delete() - Method in class org.sikuli.natives.OCRParagraph
 
delete() - Method in class org.sikuli.natives.OCRParagraphs
 
delete() - Method in class org.sikuli.natives.OCRRect
 
delete() - Method in class org.sikuli.natives.OCRText
 
delete() - Method in class org.sikuli.natives.OCRWord
 
delete() - Method in class org.sikuli.natives.OCRWords
 
delete() - Method in class org.sikuli.natives.Vision
 
delete() - Method in class org.sikuli.script.Image
 
DELETE - Static variable in class org.sikuli.script.Key
 
delete_FindInput(long) - Static method in class org.sikuli.natives.VisionProxyJNI
 
delete_FindResult(long) - Static method in class org.sikuli.natives.VisionProxyJNI
 
delete_FindResults(long) - Static method in class org.sikuli.natives.VisionProxyJNI
 
delete_Mat(long) - Static method in class org.sikuli.natives.VisionProxyJNI
 
delete_OCR(long) - Static method in class org.sikuli.natives.VisionProxyJNI
 
delete_OCRChar(long) - Static method in class org.sikuli.natives.VisionProxyJNI
 
delete_OCRChars(long) - Static method in class org.sikuli.natives.VisionProxyJNI
 
delete_OCRLine(long) - Static method in class org.sikuli.natives.VisionProxyJNI
 
delete_OCRLines(long) - Static method in class org.sikuli.natives.VisionProxyJNI
 
delete_OCRParagraph(long) - Static method in class org.sikuli.natives.VisionProxyJNI
 
delete_OCRParagraphs(long) - Static method in class org.sikuli.natives.VisionProxyJNI
 
delete_OCRRect(long) - Static method in class org.sikuli.natives.VisionProxyJNI
 
delete_OCRText(long) - Static method in class org.sikuli.natives.VisionProxyJNI
 
delete_OCRWord(long) - Static method in class org.sikuli.natives.VisionProxyJNI
 
delete_OCRWords(long) - Static method in class org.sikuli.natives.VisionProxyJNI
 
delete_Vision(long) - Static method in class org.sikuli.natives.VisionProxyJNI
 
deleteFileOrFolder(File, FileManager.FileFilter) - Static method in class org.sikuli.basics.FileManager
 
deleteFileOrFolder(File) - Static method in class org.sikuli.basics.FileManager
 
deleteFileOrFolder(String, FileManager.FileFilter) - Static method in class org.sikuli.basics.FileManager
 
deleteFileOrFolder(String) - Static method in class org.sikuli.basics.FileManager
 
deleteNotUsedImages(String, Set<String>) - Static method in class org.sikuli.basics.FileManager
 
deleteTempDir(String) - Static method in class org.sikuli.basics.FileManager
 
delOpt(Properties, String) - Static method in class org.sikuli.script.RunTime
 
delOpts(Properties) - Static method in class org.sikuli.script.RunTime
 
deregisterComponent(Component...) - Method in class org.sikuli.guide.ComponentMover
Remove listeners from the specified component
description() - Method in enum org.sikuli.util.CommandArgsEnum
Description for the param
destroy() - Method in class org.sikuli.script.Finder
to explicitly free the Finder's resources
destroy() - Method in class org.sikuli.script.ImageFinder
 
Device - Class in org.sikuli.script
EXPERIMENTAL --- INTERNAL USE ONLY
is not official API --- will not be in version 2
Device(Mouse) - Constructor for class org.sikuli.script.Device
 
Device(Screen) - Constructor for class org.sikuli.script.Device
 
DIRECTION_EAST - Static variable in class org.sikuli.guide.SxBracket
 
DIRECTION_EAST - Static variable in class org.sikuli.guide.SxFlag
 
DIRECTION_NORTH - Static variable in class org.sikuli.guide.SxBracket
 
DIRECTION_NORTH - Static variable in class org.sikuli.guide.SxFlag
 
DIRECTION_SOUTH - Static variable in class org.sikuli.guide.SxBracket
 
DIRECTION_SOUTH - Static variable in class org.sikuli.guide.SxFlag
 
DIRECTION_WEST - Static variable in class org.sikuli.guide.SxBracket
 
DIRECTION_WEST - Static variable in class org.sikuli.guide.SxFlag
 
dismiss() - Method in class org.sikuli.guide.TransitionDialog
 
displaySplash(String[]) - Static method in class org.sikuli.basics.SplashFrame
 
displaySplashFirstTime(String[]) - Static method in class org.sikuli.basics.SplashFrame
 
DistanceComparator - Class in org.sikuli.script.compare
Compares the Regions by distance to a point.
DistanceComparator(int, int) - Constructor for class org.sikuli.script.compare.DistanceComparator
Constructor for class DistanceComparator.
DistanceComparator(Location) - Constructor for class org.sikuli.script.compare.DistanceComparator
Constructor for class DistanceComparator.
DistanceComparator(Region) - Constructor for class org.sikuli.script.compare.DistanceComparator
Constructor for class DistanceComparator.
DIVIDE - Static variable in class org.sikuli.script.Key
 
dlMavenRelease - Variable in class org.sikuli.script.RunTime
 
dlMavenSnapshot - Variable in class org.sikuli.script.RunTime
 
Do - Class in org.sikuli.script
This class implements handy features from version 2
Do() - Constructor for class org.sikuli.script.Do
 
doFind() - Method in class org.sikuli.script.ImageFind
 
doPrompt(String, EventObserver) - Static method in class org.sikuli.script.Screen
 
doubleClick(Object...) - Static method in class org.sikuli.script.Commands
move the mouse with hover() and double click using the left button
doubleClick() - Method in class org.sikuli.script.Location
Move the mouse to this location point and double click left
doubleClick() - Method in class org.sikuli.script.Region
double click at the region's last successful match
use center if no lastMatch
if region is a match: click targetOffset
doubleClick(PFRML) - Method in class org.sikuli.script.Region
double click at the given target location
Pattern or Filename - do a find before and use the match
Region - position at center
Match - position at match's targetOffset
Location - position at that point
doubleClick(PFRML, Integer) - Method in class org.sikuli.script.Region
double click at the given target location
holding down the given modifier keys
Pattern or Filename - do a find before and use the match
Region - position at center
Match - position at match's targetOffset
Location - position at that point
DOWN - Static variable in class org.sikuli.script.Key
 
down(int) - Static method in class org.sikuli.script.Mouse
press and hold the given buttons Button
down(int, Region) - Static method in class org.sikuli.script.Mouse
 
downloadBaseDir - Variable in class org.sikuli.script.RunTime
 
downloadBaseDirBase - Variable in class org.sikuli.script.RunTime
 
downloadBaseDirWeb - Variable in class org.sikuli.script.RunTime
 
downloadURL(URL, String) - Static method in class org.sikuli.basics.FileManager
download a file at the given url to a local folder
downloadURL(String, String) - Static method in class org.sikuli.basics.FileManager
download a file at the given url to a local folder
downloadURL(String, String, JFrame) - Static method in class org.sikuli.basics.FileManager
 
downloadURLtoString(String) - Static method in class org.sikuli.basics.FileManager
 
downloadURLtoString(URL) - Static method in class org.sikuli.basics.FileManager
 
drag(PFRML) - Method in class org.sikuli.script.Region
Prepare a drag action: move mouse to given target
press and hold left mouse button
wait Settings.DelayAfterDrag
dragDrop(PFRML) - Method in class org.sikuli.script.Region
Drag from region's last match and drop at given target
applying Settings.DelayAfterDrag and DelayBeforeDrop
using left mouse button
dragDrop(PFRML, PFRML) - Method in class org.sikuli.script.Region
Drag from a position and drop to another using left mouse button
applying Settings.DelayAfterDrag and DelayBeforeDrop
drawRayPolygon(Graphics, Point, Rectangle) - Method in class org.sikuli.guide.SxBeam
 
drawRayPolygon1(Graphics, Point, Rectangle) - Method in class org.sikuli.guide.SxBeam
 
dropAt(PFRML) - Method in class org.sikuli.script.Region
finalize a drag action with a drop: move mouse to given target
wait Settings.DelayBeforeDrop
before releasing the left mouse button
dump() - Static method in class org.sikuli.script.Image
Print the current state of the cache
dump(int) - Static method in class org.sikuli.script.Image
Print the current state of the cache, verbosity depends on debug level
dump(int) - Static method in class org.sikuli.script.ImagePath
print the list of path entries
dump() - Static method in class org.sikuli.script.Key
 
dumpClassPath() - Method in class org.sikuli.script.RunTime
print the current classpath entries to sysout
dumpClassPath(String) - Method in class org.sikuli.script.RunTime
print the current classpath entries to sysout whose path name contain the given string
dumpOptions() - Method in class org.sikuli.script.RunTime
all options and their values written to sysout as key = value
dumpsys(String) - Method in class org.sikuli.android.ADBDevice
 
dumpSysProps() - Method in class org.sikuli.script.RunTime
print the current java system properties key-value pairs sorted by key
dumpSysProps(String) - Method in class org.sikuli.script.RunTime
print the current java system properties key-value pairs sorted by key but only keys containing filter

E

EASCRIPT - Static variable in class org.sikuli.script.Runner
 
EAST - Static variable in class org.sikuli.script.Region
 
EAST_MID - Static variable in class org.sikuli.script.Region
 
EAST_NORTH - Static variable in class org.sikuli.script.Region
 
EAST_SOUTH - Static variable in class org.sikuli.script.Region
 
EDEFAULT - Static variable in class org.sikuli.script.Runner
 
EH - Static variable in class org.sikuli.script.Region
 
EJSCRIPT - Static variable in class org.sikuli.script.Runner
 
ELBOW_X - Static variable in class org.sikuli.guide.SxArrow
 
ELBOW_Y - Static variable in class org.sikuli.guide.SxArrow
 
EM - Static variable in class org.sikuli.script.Region
 
empty() - Method in class org.sikuli.basics.VDictProxy
 
EN - Static variable in class org.sikuli.script.Region
 
end() - Method in class org.sikuli.basics.Debug
stop timer and print timer message
log output depends on Settings.ProfileLogs
END - Static variable in class org.sikuli.script.Key
 
endError(int) - Static method in class org.sikuli.script.Sikulix
INTERNAL USE: convenience function: runs Sikulix.cleanUp(int), prints a message endError and terminates with returncode
endingTypes - Static variable in class org.sikuli.script.Runner
 
endNormal(int) - Static method in class org.sikuli.script.Sikulix
INTERNAL USE: convenience function: runs Sikulix.cleanUp(int), prints a message endNormal and terminates with returncode
endWarning(int) - Static method in class org.sikuli.script.Sikulix
INTERNAL USE: convenience function: runs Sikulix.cleanUp(int), prints a message endWarning and terminates with returncode
enter(String, Object...) - Static method in class org.sikuli.basics.Debug
profile convenience: entering a method
ENTER - Static variable in class org.sikuli.script.Key
 
Env - Class in org.sikuli.script
Deprecated. 
Env() - Constructor for class org.sikuli.script.Env
Deprecated.
 
EPLAIN - Static variable in class org.sikuli.script.Runner
 
EPYTHON - Static variable in class org.sikuli.script.Runner
 
equals(Object) - Method in class org.sikuli.script.ImagePath.PathEntry
 
equals(Object) - Method in class org.sikuli.script.Location
 
equals(Object) - Method in class org.sikuli.script.Match
 
erase(String) - Method in class org.sikuli.basics.VDictProxy
 
error(String, Object...) - Static method in class org.sikuli.basics.Debug
Sikuli error messages
switch on/off: always on
ERUBY - Static variable in class org.sikuli.script.Runner
 
ES - Static variable in class org.sikuli.script.Region
 
ESC - Static variable in class org.sikuli.script.Key
 
ESSCRIPT - Static variable in class org.sikuli.script.Runner
 
evalArgs(String[]) - Static method in class org.sikuli.script.Runner
 
EventObserver - Interface in org.sikuli.util
INTRENAL USE
EventSubject - Interface in org.sikuli.util
INTERNAL USE
exact() - Method in class org.sikuli.script.Pattern
sets the minimum Similarity to 0.99 which means exact match
exec(String, String...) - Method in class org.sikuli.android.ADBDevice
 
exec(String, String...) - Method in class org.sikuli.android.ADBScreen
 
exec(String) - Method in class org.sikuli.util.JythonHelper
 
execfile(String) - Method in class org.sikuli.util.JythonHelper
 
execName - Variable in class org.sikuli.script.App.AppEntry
 
execute(String, int) - Static method in class org.sikuli.natives.CommandExecutorHelper
 
exists(String) - Static method in class org.sikuli.basics.FileManager
 
exists(Object...) - Static method in class org.sikuli.script.Commands
wait for the given visual to appear within the given wait time
exists() - Method in class org.sikuli.script.ImagePath.PathEntry
 
exists(PSI) - Method in class org.sikuli.script.Region
Check if target exists (with the default autoWaitTimeout)
exists(PSI, double) - Method in class org.sikuli.script.Region
Check if target exists with a specified timeout
timout = 0: returns immediately after first search
existsLibs() - Static method in class org.sikuli.util.LinuxSupport
 
existsSysPathJar(String) - Method in class org.sikuli.util.JythonHelper
 
existsSysPathModule(String) - Method in class org.sikuli.util.JythonHelper
 
exit(String, Object...) - Static method in class org.sikuli.basics.Debug
profile convenience: exiting a method
experimental - Static variable in class org.sikuli.basics.Settings
 
export() - Method in class org.sikuli.util.SikulixFileChooser
 
exportPrefs(String) - Method in class org.sikuli.basics.PreferencesUser
 
exportPrefs(String) - Static method in class org.sikuli.script.Sikulix
 
ExtensionManager - Class in org.sikuli.basics
 
extractResource(String, File) - Static method in class org.sikuli.basics.FileManager
 
extractResourceAsLines(String) - Static method in class org.sikuli.basics.FileManager
 
extractResourcesToFolder(String, File, FilenameFilter) - Method in class org.sikuli.script.RunTime
export all resource files from the given subtree on classpath to the given folder retaining the subtree
to export a specific file from classpath use extractResourceToFile or extractResourceToString
extractResourcesToFolderFromJar(String, String, File, FilenameFilter) - Method in class org.sikuli.script.RunTime
export all resource files from the given subtree in given jar to the given folder retaining the subtree
extractResourceToFile(String, String, File) - Method in class org.sikuli.script.RunTime
store a resource found on classpath to a file in the given folder with same filename
extractResourceToFile(String, String, File, String) - Method in class org.sikuli.script.RunTime
store a resource found on classpath to a file in the given folder
extractResourceToString(String, String, String) - Method in class org.sikuli.script.RunTime
store the content of a resource found on classpath in the returned string
extractTessData(File) - Method in class org.sikuli.script.RunTime
 

F

F1 - Static variable in class org.sikuli.script.Key
 
F10 - Static variable in class org.sikuli.script.Key
 
F11 - Static variable in class org.sikuli.script.Key
 
F12 - Static variable in class org.sikuli.script.Key
 
F13 - Static variable in class org.sikuli.script.Key
 
F14 - Static variable in class org.sikuli.script.Key
 
F15 - Static variable in class org.sikuli.script.Key
 
F2 - Static variable in class org.sikuli.script.Key
 
F3 - Static variable in class org.sikuli.script.Key
 
F4 - Static variable in class org.sikuli.script.Key
 
F5 - Static variable in class org.sikuli.script.Key
 
F6 - Static variable in class org.sikuli.script.Key
 
F7 - Static variable in class org.sikuli.script.Key
 
F8 - Static variable in class org.sikuli.script.Key
 
F9 - Static variable in class org.sikuli.script.Key
 
FakeRobot - Class in org.sikuli.util
for testing non local IScreen implementations (e.g.
FakeRobot() - Constructor for class org.sikuli.util.FakeRobot
 
FALSE - Static variable in class org.sikuli.basics.Settings
 
fAppPath - Variable in class org.sikuli.script.RunTime
 
fBaseTempPath - Variable in class org.sikuli.script.RunTime
 
FileManager - Class in org.sikuli.basics
INTERNAL USE: Support for accessing files and other ressources
FileManager() - Constructor for class org.sikuli.basics.FileManager
 
FileManager.FileFilter - Interface in org.sikuli.basics
 
FileManager.JarFileFilter - Interface in org.sikuli.basics
 
finalize() - Method in class org.sikuli.natives.FindInput
 
finalize() - Method in class org.sikuli.natives.FindResult
 
finalize() - Method in class org.sikuli.natives.FindResults
 
finalize() - Method in class org.sikuli.natives.Mat
 
finalize() - Method in class org.sikuli.natives.OCR
 
finalize() - Method in class org.sikuli.natives.OCRChar
 
finalize() - Method in class org.sikuli.natives.OCRChars
 
finalize() - Method in class org.sikuli.natives.OCRLine
 
finalize() - Method in class org.sikuli.natives.OCRLines
 
finalize() - Method in class org.sikuli.natives.OCRParagraph
 
finalize() - Method in class org.sikuli.natives.OCRParagraphs
 
finalize() - Method in class org.sikuli.natives.OCRRect
 
finalize() - Method in class org.sikuli.natives.OCRText
 
finalize() - Method in class org.sikuli.natives.OCRWord
 
finalize() - Method in class org.sikuli.natives.OCRWords
 
finalize() - Method in class org.sikuli.natives.Vision
 
finalize() - Method in class org.sikuli.script.Finder
 
find(FindInput) - Static method in class org.sikuli.natives.Vision
 
find(String) - Method in class org.sikuli.script.Finder
do a find op with the given image or the given text in the Finder's image (hasNext() and next() will reveal possible match results)
find(Pattern) - Method in class org.sikuli.script.Finder
do a find op with the given pattern in the Finder's image (hasNext() and next() will reveal possible match results)
find(Image) - Method in class org.sikuli.script.Finder
do a find op with the given pattern in the Finder's image (hasNext() and next() will reveal possible match results)
find(Image) - Method in class org.sikuli.script.Image
find an image in another image
find(Image) - Method in class org.sikuli.script.ImageFinder
 
find(String) - Method in class org.sikuli.script.ImageFinder
 
find(Pattern) - Method in class org.sikuli.script.ImageFinder
 
find(String) - Static method in class org.sikuli.script.ImagePath
try to find the given relative image file name on the image path
starting from entry 0, the first found existence is taken
absolute file names are checked for existence
find(PSI) - Method in class org.sikuli.script.Region
finds the given Pattern, String or Image in the region and returns the best match.
findAll(String) - Method in class org.sikuli.script.Finder
do a findAll op with the given image or the given text in the Finder's image (hasNext() and next() will reveal possible match results)
findAll(Pattern) - Method in class org.sikuli.script.Finder
do a find op with the given pattern in the Finder's image (hasNext() and next() will reveal possible match results)
findAll(Image) - Method in class org.sikuli.script.Finder
do a findAll op with the given image in the Finder's image (hasNext() and next() will reveal possible match results)
findAll(Image) - Method in class org.sikuli.script.Image
find all images in another image
findAll(Image) - Method in class org.sikuli.script.ImageFinder
 
findAll(String) - Method in class org.sikuli.script.ImageFinder
 
findAll(Pattern) - Method in class org.sikuli.script.ImageFinder
 
findAll(PSI) - Method in class org.sikuli.script.Region
finds all occurences of the given Pattern, String or Image in the region and returns an Iterator of Matches.
findAllByColumn(PSI) - Method in class org.sikuli.script.Region
 
findAllByRow(PSI) - Method in class org.sikuli.script.Region
 
findAllRepeat() - Method in class org.sikuli.script.Finder
internal use: repeat with same Finder
findAllText(String) - Method in class org.sikuli.script.Finder
do a findAll op with the given text in the Finder's image (hasNext() and next() will reveal possible match results)
findAllText(String) - Method in class org.sikuli.script.Region
Use findAllText() instead of findAll() in cases where the given string could be misinterpreted as an image filename
findBest(Object...) - Method in class org.sikuli.script.Region
 
findChanges(FindInput) - Static method in class org.sikuli.natives.Vision
 
FINDER - Static variable in class org.sikuli.natives.DebugCategories
 
Finder - Class in org.sikuli.script
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
Finder() - Constructor for class org.sikuli.script.Finder
Just to force library initialization
Finder(String) - Constructor for class org.sikuli.script.Finder
Finder constructor (finding within an image).
Finder(String, Region) - Constructor for class org.sikuli.script.Finder
Finder constructor (finding within an image within the given region).
Finder(BufferedImage) - Constructor for class org.sikuli.script.Finder
Constructor for special use from a BufferedImage
Finder(ScreenImage) - Constructor for class org.sikuli.script.Finder
Finder constructor for special use from a ScreenImage
Finder(ScreenImage, Region) - Constructor for class org.sikuli.script.Finder
Finder constructor for special use from a ScreenImage
Finder(Image) - Constructor for class org.sikuli.script.Finder
Finder constructor for special use from an Image
FindFailed - Exception in org.sikuli.script
implements the SikuliX FindFailed exception class and defines constants and settings for the feature FindFailedResponse
FindFailed(String) - Constructor for exception org.sikuli.script.FindFailed
the exception
findfailed(ObserveEvent) - Method in class org.sikuli.script.ObserverCallBack
 
FindFailedResponse - Enum in org.sikuli.script
INTERNAL USE
FINDING_ALL - Static variable in class org.sikuli.script.ImageFind
 
FINDING_ANY - Static variable in class org.sikuli.script.ImageFind
 
FINDING_SOME - Static variable in class org.sikuli.script.ImageFind
 
findInner(PSI, double) - Method in class org.sikuli.script.ImageFinder
 
FindInput - Class in org.sikuli.natives
 
FindInput(long, boolean) - Constructor for class org.sikuli.natives.FindInput
 
FindInput() - Constructor for class org.sikuli.natives.FindInput
 
FindInput(Mat, Mat) - Constructor for class org.sikuli.natives.FindInput
 
FindInput(Mat, int, String) - Constructor for class org.sikuli.natives.FindInput
 
FindInput(String, int, String) - Constructor for class org.sikuli.natives.FindInput
 
FindInput(Mat, int) - Constructor for class org.sikuli.natives.FindInput
 
FindInput(String, int) - Constructor for class org.sikuli.natives.FindInput
 
FindInput(Mat, FindInput) - Constructor for class org.sikuli.natives.FindInput
 
FindInput_getLimit(long, FindInput) - Static method in class org.sikuli.natives.VisionProxyJNI
 
FindInput_getSimilarity(long, FindInput) - Static method in class org.sikuli.natives.VisionProxyJNI
 
FindInput_getSourceMat(long, FindInput) - Static method in class org.sikuli.natives.VisionProxyJNI
 
FindInput_getTargetMat(long, FindInput) - Static method in class org.sikuli.natives.VisionProxyJNI
 
FindInput_getTargetText(long, FindInput) - Static method in class org.sikuli.natives.VisionProxyJNI
 
FindInput_getTargetType(long, FindInput) - Static method in class org.sikuli.natives.VisionProxyJNI
 
FindInput_isFindingAll(long, FindInput) - Static method in class org.sikuli.natives.VisionProxyJNI
 
FindInput_setFindAll(long, FindInput, boolean) - Static method in class org.sikuli.natives.VisionProxyJNI
 
FindInput_setLimit(long, FindInput, int) - Static method in class org.sikuli.natives.VisionProxyJNI
 
FindInput_setSimilarity(long, FindInput, double) - Static method in class org.sikuli.natives.VisionProxyJNI
 
FindInput_setSource__SWIG_0(long, FindInput, String) - Static method in class org.sikuli.natives.VisionProxyJNI
 
FindInput_setSource__SWIG_1(long, FindInput, long, Mat) - Static method in class org.sikuli.natives.VisionProxyJNI
 
FindInput_setTarget__SWIG_0(long, FindInput, int, String) - Static method in class org.sikuli.natives.VisionProxyJNI
 
FindInput_setTarget__SWIG_1(long, FindInput, long, Mat) - Static method in class org.sikuli.natives.VisionProxyJNI
 
findModule(String, Object, Object) - Method in class org.sikuli.util.JythonHelper
 
FindProfiling - Static variable in class org.sikuli.basics.Settings
 
findRepeat() - Method in class org.sikuli.script.Finder
internal use: repeat with same Finder
FindResult - Class in org.sikuli.natives
 
FindResult(long, boolean) - Constructor for class org.sikuli.natives.FindResult
 
FindResult() - Constructor for class org.sikuli.natives.FindResult
 
FindResult(int, int, int, int, double) - Constructor for class org.sikuli.natives.FindResult
 
FindResult_h_get(long, FindResult) - Static method in class org.sikuli.natives.VisionProxyJNI
 
FindResult_h_set(long, FindResult, int) - Static method in class org.sikuli.natives.VisionProxyJNI
 
FindResult_score_get(long, FindResult) - Static method in class org.sikuli.natives.VisionProxyJNI
 
FindResult_score_set(long, FindResult, double) - Static method in class org.sikuli.natives.VisionProxyJNI
 
FindResult_text_get(long, FindResult) - Static method in class org.sikuli.natives.VisionProxyJNI
 
FindResult_text_set(long, FindResult, String) - Static method in class org.sikuli.natives.VisionProxyJNI
 
FindResult_w_get(long, FindResult) - Static method in class org.sikuli.natives.VisionProxyJNI
 
FindResult_w_set(long, FindResult, int) - Static method in class org.sikuli.natives.VisionProxyJNI
 
FindResult_x_get(long, FindResult) - Static method in class org.sikuli.natives.VisionProxyJNI
 
FindResult_x_set(long, FindResult, int) - Static method in class org.sikuli.natives.VisionProxyJNI
 
FindResult_y_get(long, FindResult) - Static method in class org.sikuli.natives.VisionProxyJNI
 
FindResult_y_set(long, FindResult, int) - Static method in class org.sikuli.natives.VisionProxyJNI
 
FindResults - Class in org.sikuli.natives
 
FindResults(long, boolean) - Constructor for class org.sikuli.natives.FindResults
 
FindResults() - Constructor for class org.sikuli.natives.FindResults
 
FindResults(long) - Constructor for class org.sikuli.natives.FindResults
 
FindResults_add(long, FindResults, long, FindResult) - Static method in class org.sikuli.natives.VisionProxyJNI
 
FindResults_capacity(long, FindResults) - Static method in class org.sikuli.natives.VisionProxyJNI
 
FindResults_clear(long, FindResults) - Static method in class org.sikuli.natives.VisionProxyJNI
 
FindResults_get(long, FindResults, int) - Static method in class org.sikuli.natives.VisionProxyJNI
 
FindResults_isEmpty(long, FindResults) - Static method in class org.sikuli.natives.VisionProxyJNI
 
FindResults_reserve(long, FindResults, long) - Static method in class org.sikuli.natives.VisionProxyJNI
 
FindResults_set(long, FindResults, int, long, FindResult) - Static method in class org.sikuli.natives.VisionProxyJNI
 
FindResults_size(long, FindResults) - Static method in class org.sikuli.natives.VisionProxyJNI
 
findText(String) - Method in class org.sikuli.script.Finder
do a text find with the given text in the Finder's image (hasNext() and next() will reveal possible match results)
findText(String) - Method in class org.sikuli.script.ImageFinder
 
findText(String, double) - Method in class org.sikuli.script.Region
Use findText() instead of find() in cases where the given string could be misinterpreted as an image filename
findText(String) - Method in class org.sikuli.script.Region
Use findText() instead of find() in cases where the given string could be misinterpreted as an image filename
findWindowPID(String, int) - Method in class org.sikuli.natives.LinuxUtil
Returns a PID of the givenAppname and the winNumber
FIRST - Static variable in class org.sikuli.guide.Guide
 
flag(String) - Method in class org.sikuli.guide.Guide
 
fLibsFolder - Variable in class org.sikuli.script.RunTime
 
fLibsLocal - Variable in class org.sikuli.script.RunTime
 
fLibsProvided - Variable in class org.sikuli.script.RunTime
 
focus(String) - Static method in class org.sikuli.script.App
tries to identify a running app with name and if not running tries to open it and tries to make it the foreground application bringing its topmost window to front
focus(String, int) - Static method in class org.sikuli.script.App
tries to identify a running app with name and if not running tries to open it and tries to make it the foreground application bringing its window with the given number to front
focus() - Method in class org.sikuli.script.App
tries to make it the foreground application bringing its topmost window to front
focus(int) - Method in class org.sikuli.script.App
tries to make it the foreground application bringing its window with the given number to front
focusBelow() - Method in class org.sikuli.guide.Guide
 
focusedWindow() - Static method in class org.sikuli.script.App
evaluates the region currently occupied by the systemwide frontmost window (usually the one that has focus for mouse and keyboard actions)
FOREVER - Static variable in class org.sikuli.basics.Settings
standard place in the net to get information about extensions
needs a file extensions.json with content
{"extension-list":
 {"extensions":
  [
   {
    "name":"SikuliGuide",
    "version":"0.3",
    "description":"visual annotations",
    "imgurl":"somewhere in the net",
    "infourl":"http://doc.sikuli.org",
    "jarurl":"---extensions---"
   },
  ]
 }
}
imgurl: to get an icon from
infourl: where to get more information
jarurl: where to download the jar from (no url: this standard place)
FOREVER - Static variable in class org.sikuli.script.Constants
use it for a very long time value
found(SxAnchor) - Method in interface org.sikuli.guide.SxAnchor.AnchorListener
 
found(Rectangle) - Method in class org.sikuli.guide.SxAnchor
 
fpBaseTempPath - Variable in class org.sikuli.script.RunTime
 
fpContent - Variable in class org.sikuli.script.RunTime
 
fpJarLibs - Variable in class org.sikuli.script.RunTime
 
fpSysLibs - Variable in class org.sikuli.script.RunTime
 
fromClasspath(String) - Method in class org.sikuli.script.RunTime
 
fromJSON(Object) - Static method in class org.sikuli.script.Commands
experimental: create the real object from the given JSON
take care: content length not checked if valid (risk for index out of bounds)
planned to be used with a socket/RPC based interface to any framework (e.g.
fSikulixAppPath - Variable in class org.sikuli.script.RunTime
 
fSikulixDownloadsBuild - Variable in class org.sikuli.script.RunTime
 
fSikulixDownloadsGeneric - Variable in class org.sikuli.script.RunTime
 
fSikulixExtensions - Variable in class org.sikuli.script.RunTime
 
fSikulixLib - Variable in class org.sikuli.script.RunTime
 
fSikulixSetup - Variable in class org.sikuli.script.RunTime
 
fSikulixStore - Variable in class org.sikuli.script.RunTime
 
fSxBase - Variable in class org.sikuli.script.RunTime
 
fSxBaseJar - Variable in class org.sikuli.script.RunTime
 
fSxProject - Variable in class org.sikuli.script.RunTime
 
fSxProjectTestScripts - Variable in class org.sikuli.script.RunTime
 
fSxProjectTestScriptsJS - Variable in class org.sikuli.script.RunTime
 
fTempPath - Variable in class org.sikuli.script.RunTime
 
fTestFile - Variable in class org.sikuli.script.RunTime
 
fTestFolder - Variable in class org.sikuli.script.RunTime
 
fUserDir - Variable in class org.sikuli.script.RunTime
 
fWorkDir - Variable in class org.sikuli.script.RunTime
 

G

get(String, String) - Method in class org.sikuli.basics.PreferencesUser
 
get(int) - Method in class org.sikuli.natives.FindResults
 
get(int) - Method in class org.sikuli.natives.OCRChars
 
get(int) - Method in class org.sikuli.natives.OCRLines
 
get(int) - Method in class org.sikuli.natives.OCRParagraphs
 
get(int) - Method in class org.sikuli.natives.OCRWords
 
get(String) - Static method in class org.sikuli.script.Image
FOR INTERNAL USE: see get(String, boolean)
get(URL) - Static method in class org.sikuli.script.Image
 
get() - Method in class org.sikuli.script.Image
return the image's BufferedImage (load it if not in cache)
get(boolean) - Method in class org.sikuli.script.Image
 
get() - Method in class org.sikuli.script.ImageFind
 
get(int) - Method in class org.sikuli.script.ImageFind
 
get() - Static method in class org.sikuli.script.ImagePath
the path list as string array
get(int) - Method in class org.sikuli.script.Region
select the specified part of the region.
get(RunTime.Type) - Static method in class org.sikuli.script.RunTime
 
get(RunTime.Type, String[]) - Static method in class org.sikuli.script.RunTime
INTERNAL USE to initialize the runtime environment for SikuliX
for public use: use RunTime.get() to get the existing instance
get() - Static method in class org.sikuli.script.RunTime
get the initialized RunTime singleton instance
get() - Static method in class org.sikuli.script.SikulixForJython
 
get() - Static method in class org.sikuli.util.JRubyHelper
Mandatory method which returns an instance of the helper
get() - Static method in class org.sikuli.util.JythonHelper
 
getActionCommand() - Method in class org.sikuli.guide.TransitionDialog
 
getActualBounds() - Method in class org.sikuli.guide.Visual
 
getActualHeight() - Method in class org.sikuli.guide.Visual
 
getActualLocation() - Method in class org.sikuli.guide.Visual
 
getActualSize() - Method in class org.sikuli.guide.Visual
 
getActualWidth() - Method in class org.sikuli.guide.Visual
 
getAddress(String) - Static method in class org.sikuli.basics.FileManager
 
getAddress(String) - Static method in class org.sikuli.script.Run
 
getAllMonitors() - Method in class org.sikuli.script.RunTime
 
getAltFilename(String) - Static method in class org.sikuli.basics.FileManager
 
getApp(int, String) - Method in class org.sikuli.natives.LinuxUtil
 
getApp(int, String) - Method in class org.sikuli.natives.MacUtil
 
getApp(int, String) - Method in interface org.sikuli.natives.OSUtil
 
getApp(int, String) - Method in class org.sikuli.natives.WinUtil
 
getApps(String) - Method in class org.sikuli.natives.LinuxUtil
 
getApps(String) - Method in class org.sikuli.natives.MacUtil
 
getApps(String) - Method in interface org.sikuli.natives.OSUtil
 
getApps(String) - Method in class org.sikuli.natives.WinUtil
 
getApps(String) - Static method in class org.sikuli.script.App
 
getApps() - Static method in class org.sikuli.script.App
 
getArgs() - Method in class org.sikuli.script.RunTime
 
getArgsOrg() - Method in class org.sikuli.util.CommandArgs
 
getAtSaveCleanBundle() - Method in class org.sikuli.basics.PreferencesUser
 
getAtSaveMakeHTML() - Method in class org.sikuli.basics.PreferencesUser
 
getAutoCaptureForCmdButtons() - Method in class org.sikuli.basics.PreferencesUser
 
getAutoNamingMethod() - Method in class org.sikuli.basics.PreferencesUser
 
getAutoWaitTimeout() - Method in class org.sikuli.script.Region
current setting for this region (see setAutoWaitTimeout)
getBImage() - Method in class org.sikuli.script.Pattern
ONLY FOR INTERNAL USE! Might vanish without notice!
getBottomLeft() - Method in class org.sikuli.script.Region
 
getBottomRight() - Method in class org.sikuli.script.Region
 
getBounds() - Method in class org.sikuli.android.ADBDevice
 
getBounds() - Method in class org.sikuli.android.ADBScreen
 
getBounds() - Method in interface org.sikuli.script.IScreen
 
getBounds() - Method in class org.sikuli.script.Screen
 
getBounds(int) - Static method in class org.sikuli.script.Screen
 
getBounds() - Method in class org.sikuli.script.ScreenUnion
 
getBounds() - Method in class org.sikuli.vnc.VNCScreen
 
getBundleFolder() - Static method in class org.sikuli.script.ImagePath
no trailing path separator
getBundlePath() - Static method in class org.sikuli.script.ImageLocator
Deprecated. 
getBundlePath() - Static method in class org.sikuli.script.ImagePath
no trailing path separator
getBundlePathSet() - Static method in class org.sikuli.script.ImagePath
no trailing path separator
getCaptureDelay() - Method in class org.sikuli.basics.PreferencesUser
 
getCaptureHotkey() - Method in class org.sikuli.basics.PreferencesUser
 
getCaptureHotkeyModifiers() - Method in class org.sikuli.basics.PreferencesUser
 
getCell(int, int) - Method in class org.sikuli.script.Image
get the specified cell counting from (0, 0), if a raster is setup
negative counts reverse from the end (last = -1)
values outside range are 0 or last respectively
getCell(int, int) - Method in class org.sikuli.script.Region
get the specified cell counting from (0, 0), if a raster is setup
negative counts reverse from the end (last = -1) values outside range are 0 or last respectively
getCenter() - Method in class org.sikuli.guide.Visual
 
getCenter() - Method in class org.sikuli.script.Region
 
getCh() - Method in class org.sikuli.natives.OCRChar
 
getChanges() - Method in class org.sikuli.script.ObserveEvent
 
getChars() - Method in class org.sikuli.natives.OCRWord
 
getCheckUpdate() - Method in class org.sikuli.basics.PreferencesUser
 
getCheckUpdateTime() - Method in class org.sikuli.basics.PreferencesUser
 
getClickables() - Method in class org.sikuli.guide.ClickableWindow
 
getClient() - Method in class org.sikuli.vnc.VNCScreen
 
getClipboard() - Static method in class org.sikuli.script.App
evaluates the current textual content of the system clipboard
getClipboard() - Static method in class org.sikuli.script.Env
Deprecated.
use App. ... instead
getCol(int) - Method in class org.sikuli.script.Image
get the specified column counting from 0, if columns or raster are setup
negative counts reverse from the end (last = -1)
values outside range are 0 or last respectively
getCol(int) - Method in class org.sikuli.script.Region
get the specified column counting from 0, if columns or raster are setup negative counts reverse from the end (last = -1) values outside range are 0 or last respectively
getCol(int, int) - Method in class org.sikuli.script.Region
divide the region in n columns and select column c as new Region
getColor() - Method in class org.sikuli.script.Location
Get the color at the given Point for details: see java.awt.Robot and ...Color
getColorAt(int, int) - Method in class org.sikuli.android.ADBRobot
 
getColorAt(int, int) - Method in interface org.sikuli.script.IRobot
 
getColorAt(int, int) - Method in class org.sikuli.script.RobotDesktop
 
getColorAt(int, int) - Method in class org.sikuli.util.FakeRobot
 
getColorHex(Color) - Static method in class org.sikuli.guide.Visual
 
getCols() - Method in class org.sikuli.script.Image
 
getCols() - Method in class org.sikuli.script.Region
 
getColW() - Method in class org.sikuli.script.Image
 
getColW() - Method in class org.sikuli.script.Region
 
getCommandExecutorResult() - Method in exception org.sikuli.natives.CommandExecutorException
 
getCommandLine(String[]) - Method in class org.sikuli.util.CommandArgs
 
getConsoleCSS() - Method in class org.sikuli.basics.PreferencesUser
 
getCount() - Method in class org.sikuli.script.ObserveEvent
 
getCount(String) - Method in class org.sikuli.script.Observer
 
getCPtr(FindInput) - Static method in class org.sikuli.natives.FindInput
 
getCPtr(FindResult) - Static method in class org.sikuli.natives.FindResult
 
getCPtr(FindResults) - Static method in class org.sikuli.natives.FindResults
 
getCPtr(Mat) - Static method in class org.sikuli.natives.Mat
 
getCPtr(OCR) - Static method in class org.sikuli.natives.OCR
 
getCPtr(OCRChar) - Static method in class org.sikuli.natives.OCRChar
 
getCPtr(OCRChars) - Static method in class org.sikuli.natives.OCRChars
 
getCPtr(OCRLine) - Static method in class org.sikuli.natives.OCRLine
 
getCPtr(OCRLines) - Static method in class org.sikuli.natives.OCRLines
 
getCPtr(OCRParagraph) - Static method in class org.sikuli.natives.OCRParagraph
 
getCPtr(OCRParagraphs) - Static method in class org.sikuli.natives.OCRParagraphs
 
getCPtr(OCRRect) - Static method in class org.sikuli.natives.OCRRect
 
getCPtr(OCRText) - Static method in class org.sikuli.natives.OCRText
 
getCPtr(OCRWord) - Static method in class org.sikuli.natives.OCRWord
 
getCPtr(OCRWords) - Static method in class org.sikuli.natives.OCRWords
 
getCPtr(Vision) - Static method in class org.sikuli.natives.Vision
 
getcurrentID() - Method in class org.sikuli.script.Screen
 
getCurrentLine() - Method in class org.sikuli.util.JythonHelper
 
getDebugLevel() - Static method in class org.sikuli.basics.Debug
 
getDefaultThumbHeight() - Method in class org.sikuli.basics.PreferencesUser
 
getDesktopRobot() - Static method in class org.sikuli.util.FakeRobot
 
getDestination() - Method in class org.sikuli.guide.SxArrow
 
getDevice() - Static method in class org.sikuli.android.ADBClient
 
getDevice() - Method in class org.sikuli.android.ADBScreen
 
getDeviceDescription() - Method in class org.sikuli.android.ADBScreen
 
getDeviceSerial() - Method in class org.sikuli.android.ADBDevice
 
getDragInsets() - Method in class org.sikuli.guide.ComponentMover
Get the drag insets
getEnvironmentVariable(String) - Static method in class org.sikuli.util.SysJNA.WinKernel32
get the current value of a variable from real Windows environment
getErrorOutput() - Method in class org.sikuli.natives.CommandExecutorResult
 
getEvent(String) - Static method in class org.sikuli.script.Observing
retrieves and removes the requested event
getEvent(String) - Method in class org.sikuli.script.Region
the event is removed from the list
getEvents(Region) - Static method in class org.sikuli.script.Observing
return the events for that region
events are removed from the list
getEvents() - Static method in class org.sikuli.script.Observing
return all events (they are preserved)
getEvents() - Method in class org.sikuli.script.Region
the region's events are removed from the list
getExitValue() - Method in class org.sikuli.natives.CommandExecutorResult
 
getExpandTab() - Method in class org.sikuli.basics.PreferencesUser
 
getFakeRegion() - Static method in class org.sikuli.script.Screen
 
getFile() - Method in class org.sikuli.script.ScreenImage
INTERNAL USE: use getTimedFile() instead
getFile(String) - Method in class org.sikuli.script.ScreenImage
stores the image as PNG file in the given path with a created filename (sikuliximage-timestamp.png)
getFile(String, String) - Method in class org.sikuli.script.ScreenImage
stores the image as PNG file in the given path with the given filename
getFilename() - Method in class org.sikuli.script.Image
 
getFilename() - Method in class org.sikuli.script.Pattern
the current image's absolute filepath
will return null, if image is in jar or in web
use getFileURL in this case
getFilename() - Method in class org.sikuli.script.ScreenImage
Deprecated.
use getFile() instead
getFilePathSeperator() - Static method in class org.sikuli.basics.Settings
 
getFileURL() - Method in class org.sikuli.script.Image
 
getFileURL() - Method in class org.sikuli.script.Pattern
the current image's URL
getFindFailedHandler() - Static method in exception org.sikuli.script.FindFailed
 
getFindFailedResponse() - Method in class org.sikuli.script.Region
 
getFocusedRegion() - Static method in class org.sikuli.natives.MacUtil
 
getFocusedWindow() - Method in class org.sikuli.natives.LinuxUtil
 
getFocusedWindow() - Method in class org.sikuli.natives.MacUtil
 
getFocusedWindow() - Method in interface org.sikuli.natives.OSUtil
 
getFocusedWindow() - Method in class org.sikuli.natives.WinUtil
 
getFollowerBounds() - Method in class org.sikuli.guide.Visual
 
getFollowers() - Method in class org.sikuli.guide.Visual
 
getFontName() - Method in class org.sikuli.basics.PreferencesUser
 
getFontSize() - Method in class org.sikuli.basics.PreferencesUser
 
getGlobalRobot() - Static method in class org.sikuli.script.Screen
 
getGraphicsDevice(int) - Method in class org.sikuli.script.RunTime
 
getGroup() - Method in class org.sikuli.script.Image
 
getH() - Method in class org.sikuli.natives.FindResult
 
getH() - Method in interface org.sikuli.script.IScreen
 
getH() - Method in class org.sikuli.script.Region
 
getHeight() - Method in class org.sikuli.natives.OCRRect
 
getHotkeyModifier() - Static method in class org.sikuli.script.Env
Deprecated.
use Key. ... instead
getHotkeyModifier() - Static method in class org.sikuli.script.Key
HotKey modifier to be used with Sikuli's HotKey feature
getHotKeyText(String) - Method in class org.sikuli.basics.HotkeyManager
 
getID() - Method in class org.sikuli.android.ADBScreen
 
getID() - Method in interface org.sikuli.script.IScreen
 
getID() - Method in class org.sikuli.script.Screen
 
getID() - Method in class org.sikuli.vnc.VNCScreen
 
getIdeLocation() - Method in class org.sikuli.basics.PreferencesUser
 
getIdeSession() - Method in class org.sikuli.basics.PreferencesUser
 
getIDEshouldReload() - Static method in class org.sikuli.script.Image
 
getIdeSize() - Method in class org.sikuli.basics.PreferencesUser
 
getIdFromPoint(int, int) - Method in class org.sikuli.android.ADBScreen
 
getIdFromPoint(int, int) - Method in interface org.sikuli.script.IScreen
 
getIdFromPoint(int, int) - Method in class org.sikuli.script.Screen
INTERNAL USE: to be compatible with ScreenUnion
getIdFromPoint(int, int) - Method in class org.sikuli.script.ScreenUnion
 
getIdFromPoint(int, int) - Method in class org.sikuli.vnc.VNCScreen
 
getIDString() - Method in class org.sikuli.android.ADBScreen
 
getIDString() - Method in interface org.sikuli.script.IScreen
 
getIDString() - Method in class org.sikuli.script.Region
INTERNAL USE ONLY
getImage() - Method in class org.sikuli.guide.SxImage
 
getImage(String) - Static method in class org.sikuli.script.ImageLocator
Deprecated. 
getImage() - Method in class org.sikuli.script.Match
get the image used for searching
getImage() - Method in class org.sikuli.script.ObserveEvent
 
getImage() - Method in class org.sikuli.script.Pattern
get the Pattern's image
getImage() - Method in class org.sikuli.script.ScreenImage
 
getImageCache() - Static method in class org.sikuli.basics.Settings
 
getImageFilename() - Method in class org.sikuli.script.Match
get the filename of the image used for searching
getImageFromTarget(PSI) - Static method in class org.sikuli.script.Image
 
getImageMissingHandler() - Static method in exception org.sikuli.script.FindFailed
 
getImageName() - Method in class org.sikuli.script.Image
 
getImagePath() - Static method in class org.sikuli.script.ImageLocator
Deprecated. 
getIndex() - Method in class org.sikuli.script.Match
 
getInstallBase() - Static method in class org.sikuli.basics.Settings
Deprecated.
getInstance() - Static method in class org.sikuli.basics.ExtensionManager
 
getInstance() - Static method in class org.sikuli.basics.HotkeyManager
 
getInstance() - Static method in class org.sikuli.basics.PreferencesUser
 
getInstance() - Static method in class org.sikuli.guide.GlobalMouseMotionTracker
 
getInstance() - Static method in class org.sikuli.script.TextRecognizer
 
getJarName(Class) - Static method in class org.sikuli.basics.FileManager
 
getJarParentFolder() - Static method in class org.sikuli.basics.FileManager
 
getJarParentPath() - Static method in class org.sikuli.script.Sikulix
 
getJarPath(Class) - Static method in class org.sikuli.basics.FileManager
 
getJarPath() - Static method in class org.sikuli.script.Sikulix
 
getJPanel() - Method in class org.sikuli.util.OverlayTransparentWindow
 
getJPanelGraphics() - Method in class org.sikuli.util.OverlayTransparentWindow
 
getLastClicked() - Method in class org.sikuli.guide.ClickableWindow
 
getLastCommandResult() - Method in class org.sikuli.script.RunTime
 
getLastMatch() - Method in class org.sikuli.script.Region
a find operation saves its match on success in the used region object
unchanged if not successful
getLastMatches() - Method in class org.sikuli.script.Region
a searchAll operation saves its matches on success in the used region object
unchanged if not successful
getLastReturnCode() - Static method in class org.sikuli.script.Runner
 
getLastScreenImage() - Method in class org.sikuli.script.Region
get the last image taken on this regions screen
getLastScreenImageFile(String, String) - Method in interface org.sikuli.script.IScreen
 
getLastScreenImageFile() - Method in class org.sikuli.script.Region
stores the lastScreenImage in the current bundle path with a created unique name
getLastScreenImageFile(String) - Method in class org.sikuli.script.Region
stores the lastScreenImage in the current bundle path with the given name
getLastScreenImageFile(String, String) - Method in class org.sikuli.script.Region
stores the lastScreenImage in the given path with the given name
getLastScreenImageFromScreen() - Method in class org.sikuli.android.ADBScreen
 
getLastScreenImageFromScreen() - Method in interface org.sikuli.script.IScreen
 
getLastScreenImageFromScreen() - Method in class org.sikuli.script.Screen
 
getLastScreenImageFromScreen() - Method in class org.sikuli.vnc.VNCScreen
 
getLastSeen() - Method in class org.sikuli.script.Image
if the image was already found before
getLastSeenScore() - Method in class org.sikuli.script.Image
if the image was already found before
getLastSeenUpdate() - Method in class org.sikuli.basics.PreferencesUser
 
getLeader() - Method in class org.sikuli.guide.Visual
 
getLimit() - Method in class org.sikuli.natives.FindInput
 
getLines() - Method in class org.sikuli.natives.OCRParagraph
 
getLinuxDistro() - Static method in class org.sikuli.util.LinuxSupport
 
getLoadPath(String) - Method in class org.sikuli.basics.ExtensionManager
 
getLocale() - Method in class org.sikuli.basics.PreferencesUser
 
getLocation() - Method in class org.sikuli.script.Device
 
getLocationFromTarget(PSIMRL) - Method in class org.sikuli.script.Region
 
getLocationFromTarget(PSIMRL) - Method in class org.sikuli.vnc.VNCScreen
 
getMat() - Method in class org.sikuli.script.Image
get the OpenCV Mat version of the image's BufferedImage
getMatch() - Method in class org.sikuli.script.ObserveEvent
 
getMatches() - Method in class org.sikuli.script.ImageFind
 
getMatNative() - Method in class org.sikuli.script.Image
Deprecated. 
getMessage() - Method in exception org.sikuli.natives.CommandExecutorException
 
getMonitor() - Method in class org.sikuli.script.Location
Returns primary screen, if outside of any screen or not contained in a non-Desktop Screen instance (e.g.
getMonitor(int) - Method in class org.sikuli.script.RunTime
 
getMouseLocation() - Static method in class org.sikuli.script.Env
Deprecated.
use Mouse.at() instead
getMouseMovedResponse() - Static method in class org.sikuli.script.Mouse
current setting what to do if mouse is moved outside Sikuli's mouse protection
getName(String) - Static method in class org.sikuli.basics.FileManager
 
getName() - Method in class org.sikuli.guide.SxClickable
 
getName() - Method in class org.sikuli.script.App
 
getName() - Method in class org.sikuli.script.Image
Get the image's descriptive name
getName() - Method in class org.sikuli.script.ObserveEvent
 
getNames() - Method in class org.sikuli.script.Observer
 
getNumberScreens() - Static method in class org.sikuli.script.Screen
 
getObserver() - Method in class org.sikuli.script.Region
 
getObserveScanRate() - Method in class org.sikuli.script.Region
 
getOffset() - Method in class org.sikuli.script.Image
Get the value of offset
getOffset(Location) - Method in class org.sikuli.script.Location
the offset of given point to this Location
getOpt(Properties, String) - Static method in class org.sikuli.script.RunTime
 
getOpt(Properties, String, String) - Static method in class org.sikuli.script.RunTime
 
getOption(String) - Method in class org.sikuli.script.RunTime
look into the option file if any (if no option file is found, the option is taken as not existing)
getOption(String, String) - Method in class org.sikuli.script.RunTime
look into the option file if any (if no option file is found, the option is taken as not existing)
side-effect: if no options file is there, an options store will be created in memory
in this case and when the option is absent or empty, the given default will be stored
you might later save the options store to a file with storeOptions()
getOptionNumber(String) - Method in class org.sikuli.script.RunTime
CONVENIENCE: look into the option file if any (if no option file is found, the option is taken as not existing)
tries to convert the stored string value into an integer number (gives 0 if not possible)
getOptionNumber(String, Integer) - Method in class org.sikuli.script.RunTime
CONVENIENCE: look into the option file if any (if no option file is found, the option is taken as not existing)
tries to convert the stored string value into an integer number (gives 0 if not possible)
getOptions() - Method in class org.sikuli.script.RunTime
all options and their values
getOptNum(Properties, String) - Static method in class org.sikuli.script.RunTime
 
getOptNum(Properties, String, double) - Static method in class org.sikuli.script.RunTime
 
getOpts(Properties) - Static method in class org.sikuli.script.RunTime
 
getOS() - Static method in class org.sikuli.basics.Settings
 
getOS() - Static method in class org.sikuli.script.Env
Deprecated.
use the Settings features
getOSUtil() - Static method in class org.sikuli.natives.SysUtil
 
getOSUtil() - Static method in class org.sikuli.script.Env
Deprecated.
getOSVersion() - Static method in class org.sikuli.basics.Settings
 
getOSVersion() - Static method in class org.sikuli.script.Env
Deprecated.
use Settings. ... instead
getParagraphs() - Method in class org.sikuli.natives.OCRText
 
getParameter(String) - Static method in class org.sikuli.natives.Vision
 
getPath(int) - Static method in class org.sikuli.script.ImagePath
 
getPath() - Method in class org.sikuli.script.ImagePath.PathEntry
 
getPaths() - Static method in class org.sikuli.script.ImagePath
get the list of path entries (as PathEntry)
getPathSeparator() - Static method in class org.sikuli.basics.Settings
 
getPattern() - Method in class org.sikuli.guide.SxAnchor
 
getPattern() - Method in class org.sikuli.script.ObserveEvent
 
getPID(String) - Static method in class org.sikuli.natives.MacUtil
 
getPID() - Method in class org.sikuli.script.App
 
getPoint() - Method in class org.sikuli.script.Location
get as AWT point
getPort(String) - Static method in class org.sikuli.basics.FileManager
 
getPort(String) - Static method in class org.sikuli.script.Run
 
getPrefMoreCommandBar() - Method in class org.sikuli.basics.PreferencesUser
 
getPrefMoreHighlight() - Method in class org.sikuli.basics.PreferencesUser
 
getPrefMoreImages() - Method in class org.sikuli.basics.PreferencesUser
 
getPrefMoreImagesPath() - Method in class org.sikuli.basics.PreferencesUser
 
getPrefMoreImageThumbs() - Method in class org.sikuli.basics.PreferencesUser
 
getPrefMoreLogActions() - Method in class org.sikuli.basics.PreferencesUser
 
getPrefMoreLogDebug() - Method in class org.sikuli.basics.PreferencesUser
 
getPrefMoreLogInfo() - Method in class org.sikuli.basics.PreferencesUser
 
getPrefMoreMessage() - Method in class org.sikuli.basics.PreferencesUser
 
getPrefMorePlainText() - Method in class org.sikuli.basics.PreferencesUser
 
getPrefMoreRunSave() - Method in class org.sikuli.basics.PreferencesUser
 
getPrefMoreTextOCR() - Method in class org.sikuli.basics.PreferencesUser
 
getPrefMoreTextSearch() - Method in class org.sikuli.basics.PreferencesUser
 
getPrimaryId() - Static method in class org.sikuli.script.Screen
 
getPrimaryScreen() - Static method in class org.sikuli.script.Screen
 
getProxy() - Static method in class org.sikuli.basics.FileManager
 
getProxyAddress(String) - Static method in class org.sikuli.basics.FileManager
 
getProxyPort(String) - Static method in class org.sikuli.basics.FileManager
 
getRandomInt() - Static method in class org.sikuli.basics.FileManager
 
getRect() - Method in interface org.sikuli.script.IScreen
 
getRect() - Method in class org.sikuli.script.Region
 
getRectangle(Rectangle, int) - Static method in class org.sikuli.script.Region
 
getRegion() - Method in class org.sikuli.guide.Guide
 
getRegion() - Method in class org.sikuli.guide.Visual
 
getRegion(int, int) - Static method in class org.sikuli.natives.MacUtil
 
getRegion() - Method in class org.sikuli.script.ObserveEvent
 
getRegion() - Method in class org.sikuli.script.ScreenImage
 
getRegion() - Method in class org.sikuli.script.ScreenUnion
 
getRepeatWaitTime() - Method in class org.sikuli.script.Region
INTERNAL USE: Observe
getResponse() - Static method in exception org.sikuli.script.FindFailed
 
getResponse() - Method in class org.sikuli.script.ObserveEvent
 
getRobot(ADBScreen) - Method in class org.sikuli.android.ADBDevice
 
getRobot() - Method in class org.sikuli.android.ADBScreen
 
getRobot() - Method in interface org.sikuli.script.IScreen
 
getRobot(int) - Static method in class org.sikuli.script.Screen
each screen has exactly one robot (internally used for screen capturing)
available as a convenience for those who know what they are doing.
getRobot() - Method in class org.sikuli.script.Screen
Gets the Robot of this Screen.
getRobot(Region) - Static method in class org.sikuli.script.Screen
 
getRobot() - Method in class org.sikuli.vnc.VNCScreen
 
getRobotForPoint(String) - Method in class org.sikuli.script.Location
 
getROI() - Method in class org.sikuli.script.Region
A function only for backward compatibility - Only makes sense with Screen objects
getROI() - Method in class org.sikuli.script.ScreenImage
 
getRow(int) - Method in class org.sikuli.script.Image
get the specified row counting from 0, if rows or raster are setup
negative counts reverse from the end (last = -1)
values outside range are 0 or last respectively
getRow(int) - Method in class org.sikuli.script.Region
get the specified row counting from 0, if rows or raster are setup negative counts reverse from the end (last = -1) values outside range are 0 or last respectively
getRow(int, int) - Method in class org.sikuli.script.Region
 
getRowH() - Method in class org.sikuli.script.Image
 
getRowH() - Method in class org.sikuli.script.Region
 
getRows() - Method in class org.sikuli.script.Image
 
getRows() - Method in class org.sikuli.script.Region
 
getScore() - Method in class org.sikuli.natives.FindResult
 
getScore() - Method in class org.sikuli.natives.OCRWord
 
getScore() - Method in class org.sikuli.script.Match
the match score
getScreen() - Method in class org.sikuli.android.ADBRobot
 
getScreen() - Method in class org.sikuli.android.ADBScreen
 
getScreen() - Method in interface org.sikuli.script.IRobot
Return the underlying device object (if any).
getScreen() - Method in class org.sikuli.script.Location
Returns null, if outside of any screen and not contained in a non-Desktop Screen instance (e.g.
getScreen() - Method in class org.sikuli.script.Region
 
getScreen() - Method in class org.sikuli.script.RobotDesktop
 
getScreen() - Method in class org.sikuli.script.Screen
getScreen(int) - Static method in class org.sikuli.script.Screen
 
getScreen() - Method in class org.sikuli.util.FakeRobot
Return the underlying device object (if any).
getScreenContaining() - Method in class org.sikuli.script.Region
Deprecated.
Only for compatibility, to get the screen containing this region, use Region.getScreen()
getScrID() - Method in class org.sikuli.util.OverlayCapturePrompt
 
getScriptFile(File) - Static method in class org.sikuli.basics.FileManager
 
getScriptFile(File) - Static method in class org.sikuli.script.Runner
 
getSelection() - Method in class org.sikuli.util.OverlayCapturePrompt
 
getSeparator() - Static method in class org.sikuli.script.Env
Deprecated.
use Settings.getPathSeparator() ... instead
getShortOS() - Static method in class org.sikuli.basics.Settings
 
getSikuliArgs() - Method in class org.sikuli.script.RunTime
 
getSikuliArgs() - Method in class org.sikuli.util.CommandArgs
 
getSikuliDataPath() - Static method in class org.sikuli.basics.Settings
 
getSikuliDataPath() - Static method in class org.sikuli.script.Env
Deprecated.
use Settings. ... instead
getSikuliVersion() - Static method in class org.sikuli.script.Env
Deprecated.
use Settings.SikuliVersion
getSimilar() - Method in class org.sikuli.script.Pattern
 
getSimilarity() - Method in class org.sikuli.natives.FindInput
 
getSimilarity() - Method in class org.sikuli.script.Image
Get the value of similarity
getSize() - Method in class org.sikuli.script.Image
 
getSize() - Method in class org.sikuli.script.ImageFind
 
getSnapSize() - Method in class org.sikuli.guide.ComponentMover
Get the snap size
getSource() - Method in class org.sikuli.guide.SxArrow
 
getSourceMat() - Method in class org.sikuli.natives.FindInput
 
getSParameter(String) - Static method in class org.sikuli.natives.Vision
 
getStandardOutput() - Method in class org.sikuli.natives.CommandExecutorResult
 
getStatus() - Method in class org.sikuli.script.RunTime
 
getStopHotkey() - Method in class org.sikuli.basics.PreferencesUser
 
getStopHotkeyModifiers() - Method in class org.sikuli.basics.PreferencesUser
 
getStopOnFirstEvent() - Static method in class org.sikuli.script.Observing
 
getString() - Method in class org.sikuli.natives.OCRLine
 
getString() - Method in class org.sikuli.natives.OCRText
 
getString() - Method in class org.sikuli.natives.OCRWord
 
getSub(int, int, int, int) - Method in class org.sikuli.script.Image
create a sub image from this image
getSub(int) - Method in class org.sikuli.script.Image
create a sub image from this image
getSub(Rectangle) - Method in class org.sikuli.script.ScreenImage
 
getSysArgv() - Method in class org.sikuli.util.JythonHelper
 
getSysPath() - Method in class org.sikuli.util.JythonHelper
 
getSysPathEntry(File) - Method in class org.sikuli.util.JythonHelper
 
getSystemInfo() - Method in class org.sikuli.script.RunTime
 
getTabWhitespace() - Method in class org.sikuli.basics.PreferencesUser
 
getTabWidth() - Method in class org.sikuli.basics.PreferencesUser
 
getTarget() - Method in class org.sikuli.guide.Visual
 
getTarget() - Method in class org.sikuli.script.Match
convenience method
getTarget() - Method in class org.sikuli.script.Region
convenience method
getTargetMat() - Method in class org.sikuli.natives.FindInput
 
getTargetOffset() - Method in class org.sikuli.script.Match
convenience - same as Pattern.getTargetOffset()
getTargetOffset() - Method in class org.sikuli.script.Pattern
 
getTargetText() - Method in class org.sikuli.natives.FindInput
 
getTargetType() - Method in class org.sikuli.natives.FindInput
 
getText() - Method in class org.sikuli.guide.Visual
 
getText() - Method in class org.sikuli.natives.FindResult
 
getText() - Method in class org.sikuli.script.Image
 
getText() - Method in class org.sikuli.script.Match
 
getTextFromKeycode(int) - Static method in class org.sikuli.script.Key
 
getThrowException() - Method in class org.sikuli.script.Region
current setting for this region (see setThrowException)
getTime() - Method in class org.sikuli.script.Match
 
getTime() - Method in class org.sikuli.script.ObserveEvent
 
getTimeAfter() - Method in class org.sikuli.script.Pattern

TODO: Usage to be implemented! get the seconds to wait, after this pattern is acted on
getTimestamp() - Static method in class org.sikuli.basics.Settings
 
getTopLeft() - Method in class org.sikuli.script.Region
 
getTopRight() - Method in class org.sikuli.script.Region
 
getTransition() - Method in class org.sikuli.guide.Guide
 
getType() - Method in class org.sikuli.script.ObserveEvent
get the observe event type
getType() - Method in class org.sikuli.script.ObserverCallBack
 
getURL() - Method in class org.sikuli.script.Image
 
getURLForContentFromURL(URL, String) - Static method in class org.sikuli.basics.FileManager
 
getUserArgs() - Method in class org.sikuli.util.CommandArgs
 
getUserExtPath() - Static method in class org.sikuli.basics.Settings
 
getUserType() - Method in class org.sikuli.basics.PreferencesUser
 
getValidImageFilename(String) - Static method in class org.sikuli.basics.Settings
 
getVals() - Method in class org.sikuli.script.ObserveEvent
for type GENERIC: (the value's type is known by creator and user of getVals as some private protocol)
getValue(long) - Method in class org.sikuli.basics.AnimatorLinearInterpolation
 
getValue(long) - Method in class org.sikuli.basics.AnimatorOutQuarticEase
 
getValue(long) - Method in class org.sikuli.basics.AnimatorQuarticEase
 
getValue(long) - Method in class org.sikuli.basics.AnimatorStopExtention
 
getValue(long) - Method in class org.sikuli.basics.AnimatorTimeValueFunction
 
getVersion(String) - Method in class org.sikuli.basics.ExtensionManager
 
getVersion() - Method in class org.sikuli.script.RunTime
 
getVersionShort() - Method in class org.sikuli.script.RunTime
 
getVersionShortBasic() - Method in class org.sikuli.script.RunTime
 
getW() - Method in class org.sikuli.natives.FindResult
 
getW() - Method in interface org.sikuli.script.IScreen
 
getW() - Method in class org.sikuli.script.Region
 
getWaitAfter() - Method in class org.sikuli.script.Image
Get the value of waitAfter
getWaitScanRate() - Method in class org.sikuli.script.Region
 
getWantBeta() - Method in class org.sikuli.basics.PreferencesUser
 
getWidth() - Method in class org.sikuli.natives.OCRRect
 
getWindow(String) - Method in class org.sikuli.natives.LinuxUtil
 
getWindow(String, int) - Method in class org.sikuli.natives.LinuxUtil
 
getWindow(int) - Method in class org.sikuli.natives.LinuxUtil
 
getWindow(int, int) - Method in class org.sikuli.natives.LinuxUtil
 
getWindow(String, int) - Method in class org.sikuli.natives.MacUtil
 
getWindow(String) - Method in class org.sikuli.natives.MacUtil
 
getWindow(int) - Method in class org.sikuli.natives.MacUtil
 
getWindow(int, int) - Method in class org.sikuli.natives.MacUtil
 
getWindow(String) - Method in interface org.sikuli.natives.OSUtil
 
getWindow(String, int) - Method in interface org.sikuli.natives.OSUtil
 
getWindow(int) - Method in interface org.sikuli.natives.OSUtil
 
getWindow(int, int) - Method in interface org.sikuli.natives.OSUtil
 
getWindow(String) - Method in class org.sikuli.natives.WinUtil
 
getWindow(int) - Method in class org.sikuli.natives.WinUtil
 
getWindow(String, int) - Method in class org.sikuli.natives.WinUtil
 
getWindow(int, int) - Method in class org.sikuli.natives.WinUtil
 
getWindow() - Method in class org.sikuli.script.App
 
getWords() - Method in class org.sikuli.natives.OCRLine
 
getWords() - Method in class org.sikuli.natives.OCRText
 
getX() - Method in class org.sikuli.natives.FindResult
 
getX() - Method in class org.sikuli.natives.OCRRect
 
getX() - Method in interface org.sikuli.script.IScreen
 
getX() - Method in class org.sikuli.script.Location
 
getX() - Method in class org.sikuli.script.Region
 
getY() - Method in class org.sikuli.natives.FindResult
 
getY() - Method in class org.sikuli.natives.OCRRect
 
getY() - Method in interface org.sikuli.script.IScreen
 
getY() - Method in class org.sikuli.script.Location
 
getY() - Method in class org.sikuli.script.Region
 
globalMouseClicked(Point) - Method in class org.sikuli.guide.SxClickable
 
globalMouseEntered() - Method in class org.sikuli.guide.SxClickable
 
globalMouseEntered() - Method in class org.sikuli.guide.SxHotspot
 
globalMouseExited() - Method in class org.sikuli.guide.SxClickable
 
globalMouseExited() - Method in class org.sikuli.guide.SxHotspot
 
globalMouseIdled(int, int) - Method in class org.sikuli.guide.ClickableWindow
 
globalMouseIdled(int, int) - Method in interface org.sikuli.guide.GlobalMouseMotionListener
 
globalMouseIdled(int, int) - Method in class org.sikuli.guide.SxBeam
 
globalMouseIdled(int, int) - Method in class org.sikuli.guide.SxMagnet
 
GlobalMouseMotionListener - Interface in org.sikuli.guide
 
GlobalMouseMotionTracker - Class in org.sikuli.guide
 
globalMouseMoved(int, int) - Method in class org.sikuli.guide.ClickableWindow
 
globalMouseMoved(int, int) - Method in interface org.sikuli.guide.GlobalMouseMotionListener
 
globalMouseMoved(int, int) - Method in class org.sikuli.guide.SxBeam
 
globalMouseMoved(Point) - Method in class org.sikuli.guide.SxClickable
 
globalMouseMoved(int, int) - Method in class org.sikuli.guide.SxMagnet
 
grow(int, int) - Method in class org.sikuli.script.Location
create a region with this point as center and the given size
grow(int) - Method in class org.sikuli.script.Location
create a region with this point as center and the given size
grow(int, int, int, int) - Method in class org.sikuli.script.Location
create a region with a corner at this point
as specified with x y
0 0 top left
0 1 bottom left
1 0 top right
1 1 bottom right
grow(Location, int, int, int, int) - Static method in class org.sikuli.script.Region
create a region with a corner at the given point
as specified with x y
0 0 top left
0 1 bottom left
1 0 top right
1 1 bottom right
same as the corresponding create method, here to be naming compatible with class Location
grow(Location, int, int) - Static method in class org.sikuli.script.Region
create a region with the given point as center and the given size
grow(Location) - Static method in class org.sikuli.script.Region
create a minimal region at given point with size 1 x 1
grow() - Method in class org.sikuli.script.Region
create a region enlarged n pixels on each side (n = Settings.DefaultPadding = 50 default)
grow(int) - Method in class org.sikuli.script.Region
create a region enlarged range pixels on each side
grow(int, int) - Method in class org.sikuli.script.Region
create a region enlarged w pixels on left and right side and h pixels at top and bottom
grow(int, int, int, int) - Method in class org.sikuli.script.Region
create a region enlarged l pixels on left and r pixels right side and t pixels at top side and b pixels a bottom side.
Guide - Class in org.sikuli.guide
 
Guide() - Constructor for class org.sikuli.guide.Guide
create a new guide overlay on whole primary screen
Guide(Region) - Constructor for class org.sikuli.guide.Guide
create a new guide overlay on given region

H

h - Variable in class org.sikuli.script.Region
Height of the Region
h - Variable in class org.sikuli.script.ScreenImage
x, y, w, h of the stored ROI
HANDLE - Static variable in exception org.sikuli.script.FindFailed
FindFailedResponse HANDLE: should call a given handler on FindFailed
handlesMacBundles - Static variable in class org.sikuli.basics.Settings
 
happened(ObserveEvent) - Method in class org.sikuli.script.ObserverCallBack
 
hasChanged - Variable in class org.sikuli.guide.Visual
 
hasChanges(Mat) - Method in class org.sikuli.script.ImageFinder
 
hasDevices() - Method in class org.sikuli.android.ADBClient
 
hasEvent(String) - Static method in class org.sikuli.script.Observing
are their any happened events for the observer having this name?
hasEvents() - Static method in class org.sikuli.script.Observing
are their any happened events
hasEvents(Region) - Static method in class org.sikuli.script.Observing
are their any happened events for this region?
hasEvents() - Method in class org.sikuli.script.Region
 
hasIOException() - Method in class org.sikuli.script.Image
 
hasMoved() - Static method in class org.sikuli.script.Mouse
check if mouse was moved since last mouse action
hasNext() - Method in class org.sikuli.script.Finder
 
hasNext() - Method in class org.sikuli.script.ImageFind
 
hasNext() - Method in class org.sikuli.script.ImageFinder
 
hasObserver() - Method in class org.sikuli.script.Region
evaluate if at least one event observer is defined for this region (the observer need not be running)
hasObservers() - Method in class org.sikuli.script.Observer
 
hasOpt(Properties, String) - Static method in class org.sikuli.script.RunTime
 
hasOptions() - Method in class org.sikuli.script.RunTime
check whether options are defined
hasOpts(Properties) - Static method in class org.sikuli.script.RunTime
 
hasPoint(Point) - Method in class org.sikuli.script.RunTime
 
hasPrompt() - Method in class org.sikuli.script.Screen
 
hasRectangle(Rectangle) - Method in class org.sikuli.script.RunTime
 
hasSysPath(String) - Method in class org.sikuli.util.JythonHelper
 
hasWindow() - Method in class org.sikuli.script.App
 
haveToBuild() - Static method in class org.sikuli.util.LinuxSupport
 
Highlight - Static variable in class org.sikuli.basics.Settings
true = highlight every match (default: false) (show red rectangle around) for DefaultHighlightTime seconds (default: 2)
highlight() - Method in class org.sikuli.script.Region
Toggle the regions Highlight visibility (red frame)
highlight(String) - Method in class org.sikuli.script.Region
Toggle the regions Highlight visibility (frame of specified color)
allowed color specifications for frame color:
- a color name out of: black, blue, cyan, gray, green, magenta, orange, pink, red, white, yellow (lowercase and uppercase can be mixed, internally transformed to all uppercase)
- these colornames exactly written: lightGray, LIGHT_GRAY, darkGray and DARK_GRAY
- a hex value like in HTML: #XXXXXX (max 6 hex digits) - an RGB specification as: #rrrgggbbb where rrr, ggg, bbb are integer values in range 0 - 255 padded with leading zeros if needed (hence exactly 9 digits)
highlight(float) - Method in class org.sikuli.script.Region
show the regions Highlight for the given time in seconds (red frame) if 0 - use the global Settings.SlowMotionDelay
highlight(float, String) - Method in class org.sikuli.script.Region
show the regions Highlight for the given time in seconds (frame of specified color) if 0 - use the global Settings.SlowMotionDelay
highlight(int) - Method in class org.sikuli.script.Region
hack to implement the getLastMatch() convenience 0 means same as highlight() < 0 same as highlight(secs) if available the last match is highlighted
highlight(int, String) - Method in class org.sikuli.script.Region
Show highlight in selected color
highlight(Region) - Method in class org.sikuli.util.ScreenHighlighter
 
highlight(Region, float) - Method in class org.sikuli.util.ScreenHighlighter
 
highlightOff() - Static method in class org.sikuli.basics.Debug
 
highlightOn() - Static method in class org.sikuli.basics.Debug
 
history(String, Object...) - Static method in class org.sikuli.basics.Debug
Deprecated. 
HOME - Static variable in class org.sikuli.script.Key
 
HORIZONTAL - Static variable in class org.sikuli.basics.PreferencesUser
 
HORIZONTAL - Static variable in class org.sikuli.guide.SxArea
 
HorizontalComparator - Class in org.sikuli.script.compare
Compares the Regions by x-position.
HorizontalComparator() - Constructor for class org.sikuli.script.compare.HorizontalComparator
 
HotkeyEvent - Class in org.sikuli.basics
 
HotkeyEvent(int, int) - Constructor for class org.sikuli.basics.HotkeyEvent
 
HotkeyListener - Class in org.sikuli.basics
 
HotkeyListener() - Constructor for class org.sikuli.basics.HotkeyListener
 
HotkeyManager - Class in org.sikuli.basics
Singleton class to bind hotkeys to hotkey listeners
HotkeyManager() - Constructor for class org.sikuli.basics.HotkeyManager
 
hotkeyPressed(HotkeyEvent) - Method in class org.sikuli.basics.HotkeyListener
Override this to implement your own hotkey handler.
hover(Object...) - Static method in class org.sikuli.script.Commands
move the mouse to the given location with a given offset
3 parameter configurations:
--1: wait for a visual and move mouse to it (args see wait())
--2: move to the given region/location/match with a given offset
--3: move to the given offset relative to the last match of the region in use
hover() - Method in class org.sikuli.script.Location
Move the mouse to this location point
hover() - Method in class org.sikuli.script.Region
move the mouse pointer to region's last successful match
use center if no lastMatch
if region is a match: move to targetOffset
same as mouseMove
hover(PFRML) - Method in class org.sikuli.script.Region
move the mouse pointer to the given target location
same as mouseMove
Pattern or Filename - do a find before and use the match
Region - position at center
Match - position at match's targetOffset
Location - position at that point

I

IAnimator - Interface in org.sikuli.guide
 
ideTest(ADBScreen) - Static method in class org.sikuli.android.ADBTest
used in SikuliIDE menu tool to run a test against an attached device
ignorePrimaryAtCapture - Static variable in class org.sikuli.script.Screen
 
image(Object) - Method in class org.sikuli.guide.Guide
 
IMAGE - Static variable in class org.sikuli.natives.TARGET_TYPE
 
Image - Class in org.sikuli.script
This class hides the complexity behind image names given as string.
Image(BufferedImage) - Constructor for class org.sikuli.script.Image
create a new image from a buffered image
can only be reused with the object reference
Image(BufferedImage, String) - Constructor for class org.sikuli.script.Image
create a new image from a buffered image
giving it a descriptive name for printout and logging
can only be reused with the object reference
Image(ScreenImage) - Constructor for class org.sikuli.script.Image
create a new image from a Sikuli ScreenImage (captured)
can only be reused with the object reference
Image(ScreenImage, String) - Constructor for class org.sikuli.script.Image
create a new image from a Sikuli ScreenImage (captured)
giving it a descriptive name for printout and logging
can only be reused with the object reference
ImageFind - Class in org.sikuli.script
EXPERIMENTAL --- INTERNAL USE ONLY
is not official API --- will not be in version 2
ImageFind() - Constructor for class org.sikuli.script.ImageFind
 
ImageFinder - Class in org.sikuli.script
EXPERIMENTAL --- INTERNAL USE ONLY
is not official API --- will not be in version 2
ImageFinder() - Constructor for class org.sikuli.script.ImageFinder
 
ImageFinder(Image) - Constructor for class org.sikuli.script.ImageFinder
 
ImageFinder(IScreen) - Constructor for class org.sikuli.script.ImageFinder
 
ImageFinder(Region) - Constructor for class org.sikuli.script.ImageFinder
 
ImageFinder(Mat) - Constructor for class org.sikuli.script.ImageFinder
 
ImageGroup - Class in org.sikuli.script
EXPERIMENTAL --- INTERNAL USE ONLY
is not official API --- will not be in version 2
ImageLocator - Class in org.sikuli.script
Deprecated.
will be completely replaced by the classes Image and ImagePath relevant functions are already redirected as needed
ImageLocator() - Constructor for class org.sikuli.script.ImageLocator
Deprecated.
 
ImagePath - Class in org.sikuli.script
runtain the path list of locations, where images will be searched.
ImagePath() - Constructor for class org.sikuli.script.ImagePath
 
ImagePath.PathEntry - Class in org.sikuli.script
represents an imagepath entry
importPrefs(String) - Method in class org.sikuli.basics.PreferencesUser
 
importPrefs(String) - Static method in class org.sikuli.script.Sikulix
 
info(String, Object...) - Static method in class org.sikuli.basics.Debug
informative Sikuli messages
switch on/off: Settings.InfoLogs
InfoLogs - Static variable in class org.sikuli.basics.Settings
 
init() - Static method in class org.sikuli.android.ADBDevice
 
init() - Static method in class org.sikuli.basics.Debug
 
init() - Static method in class org.sikuli.basics.Settings
INTERNAL USE: to trigger the initialization
init() - Static method in class org.sikuli.script.Mouse
 
init() - Static method in class org.sikuli.script.Sikulix
call this, to initialize Sikuli up to useability
initialize() - Method in class org.sikuli.script.Observer
 
initjs() - Static method in class org.sikuli.script.Runner
 
initOCR(String) - Static method in class org.sikuli.natives.Vision
 
initpy() - Static method in class org.sikuli.script.Runner
 
initScreen(IScreen) - Method in class org.sikuli.script.Region
INTERNAL USE
initScreen(Screen) - Method in class org.sikuli.script.Screen
 
innerWait - Variable in class org.sikuli.script.Mouse
 
input(String) - Method in class org.sikuli.android.ADBDevice
 
input(Object...) - Static method in class org.sikuli.script.Do
 
input(String, String, String, boolean) - Static method in class org.sikuli.script.Sikulix
request user's input as one line of text
with hidden = true:
the dialog works as password input (input text hidden as bullets)
take care to destroy the return value as soon as possible (internally the password is deleted on return)
input(String, String, boolean) - Static method in class org.sikuli.script.Sikulix
 
input(String, boolean) - Static method in class org.sikuli.script.Sikulix
 
input(String, String, String) - Static method in class org.sikuli.script.Sikulix
 
input(String, String) - Static method in class org.sikuli.script.Sikulix
 
input(String) - Static method in class org.sikuli.script.Sikulix
 
inputDelay - Static variable in class org.sikuli.android.ADBDevice
 
InputFontMono - Static variable in class org.sikuli.basics.Settings
 
InputFontSize - Static variable in class org.sikuli.basics.Settings
 
inputKeyEvent(int) - Method in class org.sikuli.android.ADBDevice
 
inputText(String) - Static method in class org.sikuli.script.Sikulix
 
inputText(String, int, int) - Static method in class org.sikuli.script.Sikulix
 
inputText(String, int, int, String) - Static method in class org.sikuli.script.Sikulix
 
inputText(String, String) - Static method in class org.sikuli.script.Sikulix
 
inputText(String, String, int, int, String) - Static method in class org.sikuli.script.Sikulix
Shows a dialog request to enter text in a multiline text field
it has line wrapping on word bounds and a vertical scrollbar if needed
insert(String, T) - Method in class org.sikuli.basics.VDictProxy
 
INSERT - Static variable in class org.sikuli.script.Key
 
insertSysPath(File) - Method in class org.sikuli.util.JythonHelper
 
inside() - Method in class org.sikuli.script.Region
Deprecated.
only for backward compatibility
install(String, String, String) - Method in class org.sikuli.basics.ExtensionManager
 
interactiveRunner - Variable in class org.sikuli.script.RunTime
 
INTERSECTION - Static variable in class org.sikuli.guide.SxArea
 
intersection(Region) - Method in class org.sikuli.script.Region
create a region that is the intersection of the given regions
inUse - Variable in class org.sikuli.script.Device
 
invokeHotkeyPressed(HotkeyEvent) - Method in class org.sikuli.basics.HotkeyListener
INTERNAL USE: system specific handler implementation
IRobot - Interface in org.sikuli.script
INTERNAL USE
function template for (alternative) Robot implementations
IRobot.KeyMode - Enum in org.sikuli.script
 
is(int) - Static method in class org.sikuli.basics.Debug
 
is() - Static method in class org.sikuli.basics.Debug
 
isAbsolute() - Method in class org.sikuli.script.Image
 
isAdbAvailable - Static variable in class org.sikuli.android.ADBClient
 
isAlreadyTracking(Pattern, Region) - Method in class org.sikuli.guide.Tracker
 
isAnimateAnchoring() - Method in class org.sikuli.guide.SxAnchor
 
isAppear() - Method in class org.sikuli.script.ObserveEvent
check the observe event type
isAutoLayoutEnabled() - Method in class org.sikuli.guide.Visual
 
isAutoMoveEnabled() - Method in class org.sikuli.guide.Visual
 
isAutoResizeEnabled() - Method in class org.sikuli.guide.Visual
 
isAutoVisibilityEnabled() - Method in class org.sikuli.guide.Visual
 
isAxEnabled() - Static method in class org.sikuli.natives.MacUtil
 
isBlocked() - Method in class org.sikuli.script.Device
 
isBundle(String) - Static method in class org.sikuli.basics.FileManager
 
isBundled() - Method in class org.sikuli.script.Image
INTERNAL USE: image is contained in a bundle (.sikuli)
isCapsLockOn() - Static method in class org.sikuli.util.SysJNA.WinUser32
 
isChange() - Method in class org.sikuli.script.ObserveEvent
check the observe event type
isChangeCursor() - Method in class org.sikuli.guide.ComponentMover
Get the change cursor property
isComplete() - Method in class org.sikuli.util.OverlayCapturePrompt
 
IScreen - Interface in org.sikuli.script
INTERNAL USE function template for (alternative) Screen implementations
isDisplayOn() - Method in class org.sikuli.android.ADBDevice
 
isEmpty() - Method in class org.sikuli.natives.FindResults
 
isEmpty() - Method in class org.sikuli.natives.OCRChars
 
isEmpty() - Method in class org.sikuli.natives.OCRLines
 
isEmpty() - Method in class org.sikuli.natives.OCRParagraphs
 
isEmpty() - Method in class org.sikuli.natives.OCRWords
 
isEnd(long) - Method in class org.sikuli.basics.AnimatorStopExtention
 
isEnd(long) - Method in class org.sikuli.basics.AnimatorTimeValueFunction
 
isFile() - Method in class org.sikuli.script.Image
 
isFile() - Method in class org.sikuli.script.ImagePath.PathEntry
 
isFilenameDotted(String) - Static method in class org.sikuli.basics.FileManager
 
isFindFailed() - Method in class org.sikuli.script.ObserveEvent
check the observe event type
isFindingAll() - Method in class org.sikuli.natives.FindInput
 
isGeneric() - Method in class org.sikuli.script.ObserveEvent
check the observe event type
isHeadless() - Method in class org.sikuli.script.RunTime
checks, whether Java runs with a valid GraphicsEnvironment (usually means real screens connected)
isHTTP() - Method in class org.sikuli.script.ImagePath.PathEntry
 
isIDE() - Static method in class org.sikuli.util.CommandArgs
 
isImage - Variable in class org.sikuli.script.ImageFinder
 
isImage() - Method in class org.sikuli.script.ImageFinder
 
isImageBundled(URL) - Static method in class org.sikuli.script.ImagePath
 
isImagePattern() - Method in class org.sikuli.script.Pattern
true if Pattern was created from Image
isInstalled(String) - Method in class org.sikuli.basics.ExtensionManager
 
isInUse() - Method in class org.sikuli.script.Device
 
isJar() - Method in class org.sikuli.script.ImagePath.PathEntry
 
isJarOnClasspath(String) - Method in class org.sikuli.script.RunTime
 
isJava6() - Static method in class org.sikuli.basics.Settings
 
isJava7() - Static method in class org.sikuli.basics.Settings
 
isJava7() - Method in class org.sikuli.script.RunTime
 
isJava8() - Method in class org.sikuli.script.RunTime
 
isJSON(Object) - Static method in class org.sikuli.script.Commands
check wether the given object is in JSON format as ["ID", ...]
isJythonReady - Variable in class org.sikuli.script.RunTime
 
ISLINUX - Static variable in class org.sikuli.basics.Settings
 
isLinux() - Static method in class org.sikuli.basics.Settings
 
isLinux() - Static method in class org.sikuli.script.Env
Deprecated.
use Settings. ... instead
isLockOn(char) - Static method in class org.sikuli.script.Env
Deprecated.
use Key. ... instead
isLockOn(char) - Static method in class org.sikuli.script.Key
get the lock state of the given key
isLogToFile() - Static method in class org.sikuli.basics.Debug
does Sikuli log go to a file?
ISMAC - Static variable in class org.sikuli.basics.Settings
 
isMac() - Static method in class org.sikuli.basics.Settings
 
isMac() - Static method in class org.sikuli.script.Env
Deprecated.
use Settings. ... instead
isMac10() - Static method in class org.sikuli.basics.Settings
 
isMacApp - Static variable in class org.sikuli.basics.Settings
 
isMissing() - Method in class org.sikuli.script.ObserveEvent
check the observe event type
isModifier(String) - Static method in class org.sikuli.script.Key
 
isMouse - Variable in class org.sikuli.script.Device
 
isMouseOver() - Method in class org.sikuli.guide.SxClickable
 
isMultiFinder - Variable in class org.sikuli.script.ImageFinder
 
isMultiMonitor() - Method in class org.sikuli.script.RunTime
 
isNashorn() - Static method in class org.sikuli.script.Commands
 
isNotLocal(Object) - Method in class org.sikuli.script.Device
 
ISNOTSUPPORTED - Static variable in class org.sikuli.basics.Settings
 
isNumLockOn() - Static method in class org.sikuli.util.SysJNA.WinUser32
 
isObserving() - Method in class org.sikuli.script.Region
 
isOnClasspath(String) - Method in class org.sikuli.script.RunTime
 
isOnClasspath(URL) - Method in class org.sikuli.script.RunTime
check wether a the given URL is on classpath
isOnClasspath(String) - Static method in class org.sikuli.script.Sikulix
Deprecated.
isOption(String) - Method in class org.sikuli.script.RunTime
CONVENIENCE: look into the option file if any (if no option file is found, the option is taken as not existing)
isOption(String, Boolean) - Method in class org.sikuli.script.RunTime
CONVENIENCE: look into the option file if any (if no option file is found, the option is taken as not existing)
isOSX10() - Method in class org.sikuli.script.RunTime
 
isOtherScreen() - Method in interface org.sikuli.script.IScreen
 
isOtherScreen() - Method in class org.sikuli.script.Location
INTERNAL USE reveals wether the containing screen is a DeskTopScreen or not
isOtherScreen() - Method in class org.sikuli.script.Region
INTERNAL USE: checks wether this region belongs to a non-Desktop screen
isOutOfDate(String, String) - Method in class org.sikuli.basics.ExtensionManager
 
isPattern() - Method in class org.sikuli.script.Image
true if this image contains pattern aspects
only useable with the new ImageFinder
isPlayed() - Method in class org.sikuli.guide.Animator
 
isRasterValid() - Method in class org.sikuli.script.Region
Can be used to check, wether the Region currently has a valid raster
isRecaptured() - Method in class org.sikuli.script.Image
 
isRegion - Variable in class org.sikuli.script.ImageFinder
 
isRemote() - Method in class org.sikuli.android.ADBRobot
 
isRemote() - Method in interface org.sikuli.script.IRobot
 
isRemote() - Method in class org.sikuli.script.RobotDesktop
 
isRemote() - Method in class org.sikuli.util.FakeRobot
 
isRepeatable(String) - Static method in class org.sikuli.script.Key
 
isRunning() - Method in class org.sikuli.guide.Animator
 
isRunning(App.AppEntry) - Method in class org.sikuli.natives.LinuxUtil
 
isRunning(App.AppEntry) - Method in class org.sikuli.natives.MacUtil
 
isRunning(App.AppEntry) - Method in interface org.sikuli.natives.OSUtil
 
isRunning(App.AppEntry) - Method in class org.sikuli.natives.WinUtil
 
isRunning() - Method in class org.sikuli.script.App
 
isRunning(int) - Method in class org.sikuli.script.App
 
isRunningFromJar() - Method in class org.sikuli.script.RunTime
INTERNAL USE: to check whether we are running in compiled classes context
isRunningFromJar() - Static method in class org.sikuli.script.Sikulix
 
isRunningIDE - Static variable in class org.sikuli.basics.Settings
 
isRunningSikulixapi() - Static method in class org.sikuli.script.Sikulix
Get the value of runningSikulixUtilapi
isScreen - Variable in class org.sikuli.script.ImageFinder
 
isScript() - Static method in class org.sikuli.util.CommandArgs
 
isScrollLockOn() - Static method in class org.sikuli.util.SysJNA.WinUser32
 
isShouldRunCallback() - Method in class org.sikuli.script.Device
 
isShowActions() - Static method in class org.sikuli.basics.Settings
 
isSuspended() - Method in class org.sikuli.script.Device
 
isText() - Method in class org.sikuli.script.Image
 
isUrlUseabel(String) - Static method in class org.sikuli.basics.FileManager
 
isUrlUseabel(URL) - Static method in class org.sikuli.basics.FileManager
 
isUseable() - Method in class org.sikuli.script.Image
checks, wether the Image can be used with the new ImageFinder
isUserLogToFile() - Static method in class org.sikuli.basics.Debug
does user log go to a file?
isValid() - Method in class org.sikuli.android.ADBClient
 
isValid() - Method in class org.sikuli.android.ADBScreen
 
isValid() - Method in class org.sikuli.script.App
 
isValid() - Method in class org.sikuli.script.Finder
 
isValid() - Method in class org.sikuli.script.Image
check whether image is available for Finder.find()
This is for backward compatibility
The new ImageFinder uses isUsable()
isValid() - Method in class org.sikuli.script.ImageFind
 
isValid() - Method in class org.sikuli.script.ImageFinder
 
isValid() - Method in class org.sikuli.script.ImageGroup
 
isValid() - Method in class org.sikuli.script.Pattern
check wether the image is valid
isValid() - Method in class org.sikuli.script.Region
Check wether thie Region is contained by any of the available screens
isValid() - Static method in class org.sikuli.script.Run
 
isValidImageFilename(String) - Static method in class org.sikuli.basics.Settings
 
isVanish() - Method in class org.sikuli.script.ObserveEvent
check the observe event type
isVersionRelease() - Method in class org.sikuli.script.RunTime
 
isVirtual() - Method in class org.sikuli.script.Region
INTERNAL USE - EXPERIMENTAL if true: this region is not bound to any screen
isWinApp - Static variable in class org.sikuli.basics.Settings
 
ISWINDOWS - Static variable in class org.sikuli.basics.Settings
 
isWindows() - Static method in class org.sikuli.basics.Settings
 
isWindows() - Static method in class org.sikuli.script.Env
Deprecated.
use Settings. ... instead
isWindowTranslucencySupported() - Method in class org.sikuli.util.ScreenHighlighter
 

J

JavaArch - Static variable in class org.sikuli.basics.Settings
 
javaArch - Variable in class org.sikuli.script.RunTime
 
javahome - Variable in class org.sikuli.script.RunTime
 
javaShow - Variable in class org.sikuli.script.RunTime
 
JavaVersion - Static variable in class org.sikuli.basics.Settings
 
javaVersion - Variable in class org.sikuli.script.RunTime
 
JLangHelperInterface - Interface in org.sikuli.util
This interface provides script language specific methods which are non a part of ScriptRunner classes.
JREVersion - Static variable in class org.sikuli.basics.Settings
 
jreVersion - Variable in class org.sikuli.script.RunTime
 
JRubyHelper - Class in org.sikuli.util
This class implements JRuby specific parts
JRubyHelper() - Constructor for class org.sikuli.util.JRubyHelper
 
JythonHelper - Class in org.sikuli.util
 

K

keep - Variable in class org.sikuli.script.Device
 
keep(Object) - Method in class org.sikuli.script.Device
 
keep(Object) - Static method in class org.sikuli.script.Mouse
 
Key - Class in org.sikuli.script
this class implements an interface to the Java key system as represented by java.awt.event.KeyEvent.
Key() - Constructor for class org.sikuli.script.Key
 
KEY_ALT - Static variable in class org.sikuli.script.KeyModifier
Deprecated.
KEY_BACK - Static variable in class org.sikuli.android.ADBDevice
 
KEY_CMD - Static variable in class org.sikuli.script.KeyModifier
Deprecated.
KEY_CTRL - Static variable in class org.sikuli.script.KeyModifier
Deprecated.
KEY_HOME - Static variable in class org.sikuli.android.ADBDevice
 
KEY_MENU - Static variable in class org.sikuli.android.ADBDevice
 
KEY_META - Static variable in class org.sikuli.script.KeyModifier
Deprecated.
KEY_POWER - Static variable in class org.sikuli.android.ADBDevice
 
KEY_SHIFT - Static variable in class org.sikuli.script.KeyModifier
Deprecated.
KEY_WIN - Static variable in class org.sikuli.script.KeyModifier
Deprecated.
keyboardUS - Static variable in class org.sikuli.script.Key
 
keyCode - Variable in class org.sikuli.basics.HotkeyEvent
 
keyDown(String) - Method in class org.sikuli.android.ADBRobot
 
keyDown(int) - Method in class org.sikuli.android.ADBRobot
 
keyDown(String) - Method in interface org.sikuli.script.IRobot
 
keyDown(int) - Method in interface org.sikuli.script.IRobot
 
keyDown(int) - Method in class org.sikuli.script.Region
press and hold the given key use a constant from java.awt.event.KeyEvent which might be special in the current machine/system environment
keyDown(String) - Method in class org.sikuli.script.Region
press and hold the given keys including modifier keys
use the key constants defined in class Key,
which only provides a subset of a US-QWERTY PC keyboard layout
might be mixed with simple characters
use + to concatenate Key constants
keyDown(String) - Method in class org.sikuli.script.RobotDesktop
 
keyDown(int) - Method in class org.sikuli.script.RobotDesktop
 
keyDown(String) - Method in class org.sikuli.util.FakeRobot
 
keyDown(int) - Method in class org.sikuli.util.FakeRobot
 
keyMaxLength - Static variable in class org.sikuli.script.Key
 
KeyModifier - Class in org.sikuli.script
complementing class Key with the constants for the modifier keys
only still there for backward compatibility (is already duplicated in Key)
KeyModifier() - Constructor for class org.sikuli.script.KeyModifier
 
keyUp(String) - Method in class org.sikuli.android.ADBRobot
 
keyUp(int) - Method in class org.sikuli.android.ADBRobot
 
keyUp() - Method in class org.sikuli.android.ADBRobot
 
keyUp(String) - Method in interface org.sikuli.script.IRobot
 
keyUp(int) - Method in interface org.sikuli.script.IRobot
 
keyUp() - Method in interface org.sikuli.script.IRobot
 
keyUp() - Method in class org.sikuli.script.Region
release all currently pressed keys
keyUp(int) - Method in class org.sikuli.script.Region
release the given keys (see keyDown(keycode) )
keyUp(String) - Method in class org.sikuli.script.Region
release the given keys (see keyDown(keys) )
keyUp(String) - Method in class org.sikuli.script.RobotDesktop
 
keyUp(int) - Method in class org.sikuli.script.RobotDesktop
 
keyUp() - Method in class org.sikuli.script.RobotDesktop
 
keyUp(String) - Method in class org.sikuli.util.FakeRobot
 
keyUp(int) - Method in class org.sikuli.util.FakeRobot
 
keyUp() - Method in class org.sikuli.util.FakeRobot
 

L

lap(String) - Method in class org.sikuli.basics.Debug
lap timer and print message with timer message
log output depends on Settings.ProfileLogs
LAST - Static variable in class org.sikuli.guide.Guide
 
lastPos - Variable in class org.sikuli.script.Device
 
lastRunResult - Static variable in class org.sikuli.script.App
 
lastRunReturnCode - Static variable in class org.sikuli.script.App
 
lastRunStderr - Static variable in class org.sikuli.script.App
 
lastRunStdout - Static variable in class org.sikuli.script.App
 
layout - Variable in class org.sikuli.guide.Visual
 
LB - Static variable in class org.sikuli.script.Region
 
left() - Method in class org.sikuli.guide.Visual
 
left(int) - Method in class org.sikuli.guide.Visual
 
LEFT - Static variable in class org.sikuli.script.Button
 
LEFT - Static variable in class org.sikuli.script.Key
 
left(int) - Method in class org.sikuli.script.Location
creates a point at the given offset to the left, might be negative
might create a point outside of any screen, not checked
LEFT - Static variable in class org.sikuli.script.Mouse
 
left() - Method in class org.sikuli.script.Region
create a region left of the left side with same height
the new region extends to the left screen border
use grow() to include the current region
left(int) - Method in class org.sikuli.script.Region
create a region left of the left side with same height and given width
negative width creates the left part with width inside the region use grow() to include the current region
leftAt() - Method in class org.sikuli.script.Region
 
leftAt(int) - Method in class org.sikuli.script.Region
negative offset goes to the left
might be off current screen
let() - Method in class org.sikuli.script.Device
 
let(Object) - Method in class org.sikuli.script.Device
 
let() - Static method in class org.sikuli.script.Mouse
 
let(Object) - Static method in class org.sikuli.script.Mouse
 
LH - Static variable in class org.sikuli.script.Region
 
libGrabKey - Static variable in class org.sikuli.util.LinuxSupport
 
libOpenCV - Variable in class org.sikuli.script.RunTime
 
libVision - Static variable in class org.sikuli.util.LinuxSupport
 
linuxDistro - Variable in class org.sikuli.script.RunTime
 
LinuxHotkeyManager - Class in org.sikuli.basics
 
LinuxHotkeyManager() - Constructor for class org.sikuli.basics.LinuxHotkeyManager
 
linuxNeededLibs - Variable in class org.sikuli.script.RunTime
 
LinuxSupport - Class in org.sikuli.util
INTERNAL USE: all things needed with Linux at setup or runtime
LinuxSupport() - Constructor for class org.sikuli.util.LinuxSupport
 
LinuxUtil - Class in org.sikuli.natives
 
LinuxUtil() - Constructor for class org.sikuli.natives.LinuxUtil
 
listText() - Method in class org.sikuli.script.Region
VERY EXPERIMENTAL: returns a list of matches, that represent single words, that have been found in this region
the match's x,y,w,h the region of the word
Match.getText() returns the word (utf8) at this match
Match.getScore() returns a value between 0 ...
listText(ScreenImage, Region) - Method in class org.sikuli.script.TextRecognizer
 
listText(ScreenImage, Region, TextRecognizer.ListTextMode) - Method in class org.sikuli.script.TextRecognizer
 
LL - Static variable in class org.sikuli.script.Region
 
LM - Static variable in class org.sikuli.script.Region
 
load(String) - Static method in class org.sikuli.script.Sikulix
add a jar to the scripting environment
Jython: added to sys.path
JRuby: not yet supported
JavaScript: not yet supported
if no scripting active (API usage), jar is added to classpath if available
load(String, String) - Static method in class org.sikuli.script.Sikulix
add a jar to the scripting environment or to classpath
Jython: added to sys.path
JRuby: only added to classpath
JavaScript: only added to classpath
if no scripting is active (API usage), jar is added to classpath if available
additionally: fpJar/fpJarImagePath is added to ImagePath (not checked)
load(String) - Method in class org.sikuli.util.JythonHelper
 
load() - Method in class org.sikuli.util.SikulixFileChooser
 
loadImage() - Method in class org.sikuli.util.SikulixFileChooser
 
loadImageFacts() - Method in class org.sikuli.script.ImageGroup
 
loadLibrary(String) - Static method in class org.sikuli.script.RunTime
INTERNAL USE: load a native library from the libs folder
loadLibrary(String, boolean) - Static method in class org.sikuli.script.RunTime
INTERNAL USE: load a native library from the libs folder
loadModulePrepare(String, String) - Method in class org.sikuli.util.JythonHelper
 
loadOpts(String) - Method in class org.sikuli.script.RunTime
load a properties file
locate(String) - Static method in class org.sikuli.script.ImageLocator
Deprecated.
 
Location - Class in org.sikuli.script
A point like AWT.Point using global coordinates (x, y).
Location(double, double) - Constructor for class org.sikuli.script.Location
to allow calculated x and y that might not be integers
Location(int, int) - Constructor for class org.sikuli.script.Location
a new point at the given coordinates
Location(Location) - Constructor for class org.sikuli.script.Location
duplicates the point
Location(Point) - Constructor for class org.sikuli.script.Location
create from AWT point
log(String, Object...) - Static method in class org.sikuli.basics.Debug
Sikuli debug messages with default level
switch on/off: Settings.DebugLogs (off) and/or -Dsikuli.Debug
log(int, String, Object...) - Static method in class org.sikuli.basics.Debug
Sikuli debug messages with level
switch on/off: Settings.DebugLogs (off) and/or -Dsikuli.Debug
log(int, String, Object...) - Method in class org.sikuli.util.JythonHelper
 
log(int, String, Object...) - Static method in class org.sikuli.util.LinuxSupport
 
logfile - Static variable in class org.sikuli.basics.Debug
 
logj(String, Object...) - Static method in class org.sikuli.basics.Debug
 
logJython() - Static method in class org.sikuli.basics.Debug
 
logJython(Boolean) - Static method in class org.sikuli.basics.Debug
 
logp(String, Object...) - Static method in class org.sikuli.basics.Debug
 
LogTime - Static variable in class org.sikuli.basics.Settings
 
logx(int, String, Object...) - Static method in class org.sikuli.basics.Debug
INTERNAL USE: special debug messages
longname() - Method in enum org.sikuli.util.CommandArgsEnum
Returns the long name
lookup(String) - Method in class org.sikuli.basics.VDictProxy
 
lookup_similar(String, double) - Method in class org.sikuli.basics.VDictProxy
 
lookup_similar_n(String, double, int) - Method in class org.sikuli.basics.VDictProxy
 
LT - Static variable in class org.sikuli.script.Region
 

M

M2 - Static variable in class org.sikuli.script.Region
 
M3 - Static variable in class org.sikuli.script.Region
 
MacHotkeyManager - Class in org.sikuli.basics
 
MacHotkeyManager() - Constructor for class org.sikuli.basics.MacHotkeyManager
 
MacUtil - Class in org.sikuli.natives
 
MacUtil() - Constructor for class org.sikuli.natives.MacUtil
 
main(String[]) - Static method in class org.sikuli.android.ADBTest
 
main(String[]) - Static method in class org.sikuli.guide.Run
 
main(String[]) - Static method in class org.sikuli.script.Run
 
main(String[]) - Static method in class org.sikuli.script.Sikulix
checking parameter -d on commandline
0 - list all available tests
1 - run all available tests
n - run the test with that number if available
makeAppEntry() - Method in class org.sikuli.script.App
 
makeFileList(File, String) - Static method in class org.sikuli.basics.FileManager
 
makeFolders() - Method in class org.sikuli.script.RunTime
 
makeOpts() - Static method in class org.sikuli.script.RunTime
 
makeURL(String) - Static method in class org.sikuli.basics.FileManager
 
makeURL(String, String) - Static method in class org.sikuli.basics.FileManager
 
makeURL(URL, String) - Static method in class org.sikuli.basics.FileManager
 
Mat - Class in org.sikuli.natives
 
Mat(long, boolean) - Constructor for class org.sikuli.natives.Mat
 
Mat() - Constructor for class org.sikuli.natives.Mat
 
MAT - Static variable in class org.sikuli.natives.TARGET_TYPE
 
Match - Class in org.sikuli.script
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.
Match(Match) - Constructor for class org.sikuli.script.Match
create a copy of Match object
to e.g.
Match(Region, double) - Constructor for class org.sikuli.script.Match
create a Match from a region with given SimScore
Match(int, int, int, int, double, IScreen, String) - Constructor for class org.sikuli.script.Match
internally used constructor by TextRecognizer.listText()
Match(FindResult, IScreen) - Constructor for class org.sikuli.script.Match
internally used constructor used by findX image
MaxTimePerScan - Variable in class org.sikuli.script.ImageFinder
 
META - Static variable in class org.sikuli.script.Key
 
META - Static variable in class org.sikuli.script.KeyModifier
 
MH - Static variable in class org.sikuli.script.Region
 
MID_HORIZONTAL - Static variable in class org.sikuli.script.Region
 
MID_VERTICAL - Static variable in class org.sikuli.script.Region
 
MIDDLE - Static variable in class org.sikuli.guide.Guide
 
MIDDLE - Static variable in class org.sikuli.script.Button
 
MIDDLE - Static variable in class org.sikuli.script.Mouse
 
MIDDLE - Static variable in class org.sikuli.script.Region
 
MIDDLE_BIG - Static variable in class org.sikuli.script.Region
 
MinSimilarity - Static variable in class org.sikuli.basics.Settings
 
MINUS - Static variable in class org.sikuli.script.Key
 
missing(ObserveEvent) - Method in class org.sikuli.script.ObserverCallBack
 
mkdir(String) - Static method in class org.sikuli.basics.FileManager
 
MM - Static variable in class org.sikuli.script.Region
 
modifiers - Variable in class org.sikuli.basics.HotkeyEvent
 
monitor - Variable in class org.sikuli.script.Screen
 
monitorBounds - Variable in class org.sikuli.script.RunTime
 
morphTo(Region) - Method in class org.sikuli.script.Region
Deprecated.
to be like AWT Rectangle API use setRect() instead
Mouse - Class in org.sikuli.script
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.
mouseClicked(MouseEvent) - Method in class org.sikuli.guide.ClickableWindow
 
mouseClicked(MouseEvent) - Method in class org.sikuli.util.ScreenHighlighter
 
mouseDown(int) - Method in class org.sikuli.android.ADBRobot
 
mouseDown(int) - Method in interface org.sikuli.script.IRobot
 
mouseDown(int) - Method in class org.sikuli.script.Region
press and hold the specified buttons - use + to combine Button.LEFT left mouse button Button.MIDDLE middle mouse button Button.RIGHT right mouse button
mouseDown(int) - Method in class org.sikuli.script.RobotDesktop
 
mouseDown(int) - Method in class org.sikuli.util.FakeRobot
 
mouseDragged(MouseEvent) - Method in class org.sikuli.guide.ComponentMover
Move the component to its new location.
mouseEntered(MouseEvent) - Method in class org.sikuli.guide.ClickableWindow
 
mouseEntered(MouseEvent) - Method in class org.sikuli.util.ScreenHighlighter
 
mouseExited(MouseEvent) - Method in class org.sikuli.guide.ClickableWindow
 
mouseExited(MouseEvent) - Method in class org.sikuli.util.ScreenHighlighter
 
mouseMove(int, int) - Method in class org.sikuli.android.ADBRobot
 
mouseMove(int, int) - Method in interface org.sikuli.script.IRobot
 
mouseMove() - Method in class org.sikuli.script.Region
move the mouse pointer to the region's last successful match
same as hover
mouseMove(PFRML) - Method in class org.sikuli.script.Region
move the mouse pointer to the given target location
same as hover
Pattern or Filename - do a find before and use the match
Region - position at center
Match - position at match's targetOffset
Location - position at that point
mouseMove(int, int) - Method in class org.sikuli.script.Region
move the mouse from the current position to the offset position given by the parameters
mouseMove(int, int) - Method in class org.sikuli.util.FakeRobot
 
MouseMovedAction - Variable in class org.sikuli.script.Device
 
mouseMovedCallback - Variable in class org.sikuli.script.Device
 
MouseMovedHighlight - Variable in class org.sikuli.script.Device
 
MouseMovedIgnore - Variable in class org.sikuli.script.Device
 
MouseMovedPause - Variable in class org.sikuli.script.Device
 
mouseMovedResponse - Variable in class org.sikuli.script.Device
 
MouseMovedShow - Variable in class org.sikuli.script.Device
 
mousePos - Variable in class org.sikuli.script.Mouse
 
mousePressed(MouseEvent) - Method in class org.sikuli.guide.ClickableWindow
 
mousePressed(MouseEvent) - Method in class org.sikuli.guide.ComponentMover
Setup the variables used to control the moving of the component: source - the source component of the mouse event destination - the component that will ultimately be moved pressed - the Point where the mouse was pressed in the destination component coordinates.
mousePressed(MouseEvent) - Method in class org.sikuli.util.ScreenHighlighter
 
mouseReleased(MouseEvent) - Method in class org.sikuli.guide.ClickableWindow
 
mouseReleased(MouseEvent) - Method in class org.sikuli.guide.ComponentMover
Restore the original state of the Component
mouseReleased(MouseEvent) - Method in class org.sikuli.util.ScreenHighlighter
 
mouseReset() - Method in class org.sikuli.android.ADBRobot
 
mouseReset() - Method in interface org.sikuli.script.IRobot
 
mouseReset() - Method in class org.sikuli.script.RobotDesktop
 
mouseReset() - Method in class org.sikuli.util.FakeRobot
 
mouseUp(int) - Method in class org.sikuli.android.ADBRobot
 
mouseUp(int) - Method in interface org.sikuli.script.IRobot
 
mouseUp() - Method in class org.sikuli.script.Region
release all currently held buttons
mouseUp(int) - Method in class org.sikuli.script.Region
release the specified mouse buttons (see mouseDown) if buttons==0, all currently held buttons are released
mouseUp(int) - Method in class org.sikuli.script.RobotDesktop
 
mouseUp(int) - Method in class org.sikuli.util.FakeRobot
 
mouseWheel(int) - Method in class org.sikuli.android.ADBRobot
 
mouseWheel(int) - Method in interface org.sikuli.script.IRobot
 
mouseWheel(int) - Method in class org.sikuli.util.FakeRobot
 
move(int, int) - Method in class org.sikuli.script.Location
convenience: like awt point
move(Location) - Static method in class org.sikuli.script.Mouse
move the mouse to the given location (local and remote)
move(int, int) - Static method in class org.sikuli.script.Mouse
move the mouse from the current position to the offset position given by the parameters
move(Location, Region) - Static method in class org.sikuli.script.Mouse
 
moveFor(int, int) - Method in class org.sikuli.script.Location
MoveMouseDelay - Static variable in class org.sikuli.basics.Settings
 
moveTo(Point) - Method in class org.sikuli.guide.Visual
 
moveTo(Point, AnimationListener) - Method in class org.sikuli.guide.Visual
 
moveTo(int, int) - Method in class org.sikuli.script.Location
Deprecated.
moveTo(Location) - Method in class org.sikuli.script.Region
Deprecated.
to be like AWT Rectangle API use setLocation()
MULTIPLY - Static variable in class org.sikuli.script.Key
 
MV - Static variable in class org.sikuli.script.Region
 

N

name - Variable in class org.sikuli.script.App.AppEntry
 
NE - Static variable in class org.sikuli.script.Region
 
nearby() - Method in class org.sikuli.script.Region
Deprecated.
to be like AWT Rectangle API use grow() instead
nearby(int) - Method in class org.sikuli.script.Region
Deprecated.
to be like AWT Rectangle API use grow() instaed
needsRobotFake() - Method in class org.sikuli.script.RunTime
 
needsUnLock - Variable in class org.sikuli.android.ADBScreen
 
new_FindInput__SWIG_0() - Static method in class org.sikuli.natives.VisionProxyJNI
 
new_FindInput__SWIG_1(long, Mat, long, Mat) - Static method in class org.sikuli.natives.VisionProxyJNI
 
new_FindInput__SWIG_2(long, Mat, int, String) - Static method in class org.sikuli.natives.VisionProxyJNI
 
new_FindInput__SWIG_3(String, int, String) - Static method in class org.sikuli.natives.VisionProxyJNI
 
new_FindInput__SWIG_4(long, Mat, int) - Static method in class org.sikuli.natives.VisionProxyJNI
 
new_FindInput__SWIG_5(String, int) - Static method in class org.sikuli.natives.VisionProxyJNI
 
new_FindInput__SWIG_6(long, Mat, long, FindInput) - Static method in class org.sikuli.natives.VisionProxyJNI
 
new_FindResult__SWIG_0() - Static method in class org.sikuli.natives.VisionProxyJNI
 
new_FindResult__SWIG_1(int, int, int, int, double) - Static method in class org.sikuli.natives.VisionProxyJNI
 
new_FindResults__SWIG_0() - Static method in class org.sikuli.natives.VisionProxyJNI
 
new_FindResults__SWIG_1(long) - Static method in class org.sikuli.natives.VisionProxyJNI
 
new_Mat() - Static method in class org.sikuli.natives.VisionProxyJNI
 
new_OCR() - Static method in class org.sikuli.natives.VisionProxyJNI
 
new_OCRChar(String, int, int, int, int) - Static method in class org.sikuli.natives.VisionProxyJNI
 
new_OCRChars__SWIG_0() - Static method in class org.sikuli.natives.VisionProxyJNI
 
new_OCRChars__SWIG_1(long) - Static method in class org.sikuli.natives.VisionProxyJNI
 
new_OCRLine() - Static method in class org.sikuli.natives.VisionProxyJNI
 
new_OCRLines__SWIG_0() - Static method in class org.sikuli.natives.VisionProxyJNI
 
new_OCRLines__SWIG_1(long) - Static method in class org.sikuli.natives.VisionProxyJNI
 
new_OCRParagraph() - Static method in class org.sikuli.natives.VisionProxyJNI
 
new_OCRParagraphs__SWIG_0() - Static method in class org.sikuli.natives.VisionProxyJNI
 
new_OCRParagraphs__SWIG_1(long) - Static method in class org.sikuli.natives.VisionProxyJNI
 
new_OCRRect__SWIG_0() - Static method in class org.sikuli.natives.VisionProxyJNI
 
new_OCRRect__SWIG_1(int, int, int, int) - Static method in class org.sikuli.natives.VisionProxyJNI
 
new_OCRText() - Static method in class org.sikuli.natives.VisionProxyJNI
 
new_OCRWord() - Static method in class org.sikuli.natives.VisionProxyJNI
 
new_OCRWords__SWIG_0() - Static method in class org.sikuli.natives.VisionProxyJNI
 
new_OCRWords__SWIG_1(long) - Static method in class org.sikuli.natives.VisionProxyJNI
 
new_Vision() - Static method in class org.sikuli.natives.VisionProxyJNI
 
NEWBEE - Static variable in class org.sikuli.basics.PreferencesUser
 
newLocation(int, int) - Method in class org.sikuli.android.ADBScreen
 
newLocation(Location) - Method in class org.sikuli.script.Screen
creates a location on the current screen with the given point.
newRegion(Location, int, int) - Method in class org.sikuli.android.ADBScreen
 
newRegion(int, int, int, int) - Method in class org.sikuli.android.ADBScreen
 
newRegion(Location, int, int) - Method in class org.sikuli.script.Screen
creates a region on the current screen with the given coordinate/size.
next() - Method in class org.sikuli.script.Finder
 
next() - Method in class org.sikuli.script.ImageFind
 
next() - Method in class org.sikuli.script.ImageFinder
 
NEXT - Static variable in class org.sikuli.script.Key
 
NH - Static variable in class org.sikuli.script.Region
 
NL - Static variable in class org.sikuli.script.RunTime
 
NM - Static variable in class org.sikuli.script.Region
 
no - Static variable in class org.sikuli.basics.PreferencesUser
 
noPupUps - Static variable in class org.sikuli.basics.Settings
 
normalize(String) - Static method in class org.sikuli.basics.FileManager
 
normalizeAbsolute(String, boolean) - Static method in class org.sikuli.basics.FileManager
 
NORTH - Static variable in class org.sikuli.script.Region
 
NORTH_EAST - Static variable in class org.sikuli.script.Region
 
NORTH_MID - Static variable in class org.sikuli.script.Region
 
NORTH_WEST - Static variable in class org.sikuli.script.Region
the area constants for use with get()
notifyObserver() - Method in interface org.sikuli.util.EventSubject
 
notifyObserver() - Method in class org.sikuli.util.OverlayCapturePrompt
 
notifyObserver() - Method in class org.sikuli.util.OverlayTransparentWindow
 
NUM0 - Static variable in class org.sikuli.script.Key
 
NUM1 - Static variable in class org.sikuli.script.Key
 
NUM2 - Static variable in class org.sikuli.script.Key
 
NUM3 - Static variable in class org.sikuli.script.Key
 
NUM4 - Static variable in class org.sikuli.script.Key
 
NUM5 - Static variable in class org.sikuli.script.Key
 
NUM6 - Static variable in class org.sikuli.script.Key
 
NUM7 - Static variable in class org.sikuli.script.Key
 
NUM8 - Static variable in class org.sikuli.script.Key
 
NUM9 - Static variable in class org.sikuli.script.Key
 
NUM_LOCK - Static variable in class org.sikuli.script.Key
 
NW - Static variable in class org.sikuli.script.Region
the area constants for use with get()

O

observe() - Method in class org.sikuli.script.Region
start an observer in this region that runs forever (use stopObserving() in handler) for details about the observe event handler: ObserverCallBack for details about APPEAR/VANISH/CHANGE events: ObserveEvent
observe(double) - Method in class org.sikuli.script.Region
start an observer in this region for the given time for details about the observe event handler: ObserverCallBack for details about APPEAR/VANISH/CHANGE events: ObserveEvent
ObserveEvent - Class in org.sikuli.script
provides information about the observed event being in the ObserverCallBack
ObserveEvent() - Constructor for class org.sikuli.script.ObserveEvent
 
ObserveEvent(String, ObserveEvent.Type, Object, Object, Object, long) - Constructor for class org.sikuli.script.ObserveEvent
INTERNAL USE ONLY: creates an observed event
ObserveEvent.Type - Enum in org.sikuli.script
 
observeInBackground(double) - Method in class org.sikuli.script.Region
start an observer in this region for the given time that runs in background for details about the observe event handler: ObserverCallBack for details about APPEAR/VANISH/CHANGE events: ObserveEvent
observeInLine(double) - Method in class org.sikuli.script.Region
INTERNAL USE ONLY: for use with scripting API bridges
ObserveMinChangedPixels - Static variable in class org.sikuli.basics.Settings
 
Observer - Class in org.sikuli.script
INTERNAL USE implements the observe action for a region and calls the ObserverCallBacks
Observer(Region) - Constructor for class org.sikuli.script.Observer
 
Observer.State - Enum in org.sikuli.script
 
ObserverCallBack - Class in org.sikuli.script
Use this class to implement call back methods for the Region observers onAppear, onVanish and onChange.
ObserverCallBack() - Constructor for class org.sikuli.script.ObserverCallBack
 
ObserverCallBack(Object, ObserveEvent.Type) - Constructor for class org.sikuli.script.ObserverCallBack
 
ObserveScanRate - Static variable in class org.sikuli.basics.Settings
 
Observing - Class in org.sikuli.script
INTERNAL USE ONLY --- NOT part of the official API This class globally collects all running observations and tracks the created events.
OCR - Static variable in class org.sikuli.natives.DebugCategories
 
OCR - Class in org.sikuli.natives
 
OCR(long, boolean) - Constructor for class org.sikuli.natives.OCR
 
OCR() - Constructor for class org.sikuli.natives.OCR
 
OCR_setParameter(String, String) - Static method in class org.sikuli.natives.VisionProxyJNI
 
OCRChar - Class in org.sikuli.natives
 
OCRChar(long, boolean) - Constructor for class org.sikuli.natives.OCRChar
 
OCRChar(String, int, int, int, int) - Constructor for class org.sikuli.natives.OCRChar
 
OCRChar_ch_get(long, OCRChar) - Static method in class org.sikuli.natives.VisionProxyJNI
 
OCRChar_ch_set(long, OCRChar, String) - Static method in class org.sikuli.natives.VisionProxyJNI
 
OCRChar_SWIGUpcast(long) - Static method in class org.sikuli.natives.VisionProxyJNI
 
OCRChars - Class in org.sikuli.natives
 
OCRChars(long, boolean) - Constructor for class org.sikuli.natives.OCRChars
 
OCRChars() - Constructor for class org.sikuli.natives.OCRChars
 
OCRChars(long) - Constructor for class org.sikuli.natives.OCRChars
 
OCRChars_add(long, OCRChars, long, OCRChar) - Static method in class org.sikuli.natives.VisionProxyJNI
 
OCRChars_capacity(long, OCRChars) - Static method in class org.sikuli.natives.VisionProxyJNI
 
OCRChars_clear(long, OCRChars) - Static method in class org.sikuli.natives.VisionProxyJNI
 
OCRChars_get(long, OCRChars, int) - Static method in class org.sikuli.natives.VisionProxyJNI
 
OCRChars_isEmpty(long, OCRChars) - Static method in class org.sikuli.natives.VisionProxyJNI
 
OCRChars_reserve(long, OCRChars, long) - Static method in class org.sikuli.natives.VisionProxyJNI
 
OCRChars_set(long, OCRChars, int, long, OCRChar) - Static method in class org.sikuli.natives.VisionProxyJNI
 
OCRChars_size(long, OCRChars) - Static method in class org.sikuli.natives.VisionProxyJNI
 
OcrDataPath - Static variable in class org.sikuli.basics.Settings
location of folder Tessdata
OcrLanguage - Static variable in class org.sikuli.basics.Settings
 
OCRLine - Class in org.sikuli.natives
 
OCRLine(long, boolean) - Constructor for class org.sikuli.natives.OCRLine
 
OCRLine() - Constructor for class org.sikuli.natives.OCRLine
 
OCRLine_getString(long, OCRLine) - Static method in class org.sikuli.natives.VisionProxyJNI
 
OCRLine_getWords(long, OCRLine) - Static method in class org.sikuli.natives.VisionProxyJNI
 
OCRLine_SWIGUpcast(long) - Static method in class org.sikuli.natives.VisionProxyJNI
 
OCRLines - Class in org.sikuli.natives
 
OCRLines(long, boolean) - Constructor for class org.sikuli.natives.OCRLines
 
OCRLines() - Constructor for class org.sikuli.natives.OCRLines
 
OCRLines(long) - Constructor for class org.sikuli.natives.OCRLines
 
OCRLines_add(long, OCRLines, long, OCRLine) - Static method in class org.sikuli.natives.VisionProxyJNI
 
OCRLines_capacity(long, OCRLines) - Static method in class org.sikuli.natives.VisionProxyJNI
 
OCRLines_clear(long, OCRLines) - Static method in class org.sikuli.natives.VisionProxyJNI
 
OCRLines_get(long, OCRLines, int) - Static method in class org.sikuli.natives.VisionProxyJNI
 
OCRLines_isEmpty(long, OCRLines) - Static method in class org.sikuli.natives.VisionProxyJNI
 
OCRLines_reserve(long, OCRLines, long) - Static method in class org.sikuli.natives.VisionProxyJNI
 
OCRLines_set(long, OCRLines, int, long, OCRLine) - Static method in class org.sikuli.natives.VisionProxyJNI
 
OCRLines_size(long, OCRLines) - Static method in class org.sikuli.natives.VisionProxyJNI
 
OCRParagraph - Class in org.sikuli.natives
 
OCRParagraph(long, boolean) - Constructor for class org.sikuli.natives.OCRParagraph
 
OCRParagraph() - Constructor for class org.sikuli.natives.OCRParagraph
 
OCRParagraph_getLines(long, OCRParagraph) - Static method in class org.sikuli.natives.VisionProxyJNI
 
OCRParagraph_SWIGUpcast(long) - Static method in class org.sikuli.natives.VisionProxyJNI
 
OCRParagraphs - Class in org.sikuli.natives
 
OCRParagraphs(long, boolean) - Constructor for class org.sikuli.natives.OCRParagraphs
 
OCRParagraphs() - Constructor for class org.sikuli.natives.OCRParagraphs
 
OCRParagraphs(long) - Constructor for class org.sikuli.natives.OCRParagraphs
 
OCRParagraphs_add(long, OCRParagraphs, long, OCRParagraph) - Static method in class org.sikuli.natives.VisionProxyJNI
 
OCRParagraphs_capacity(long, OCRParagraphs) - Static method in class org.sikuli.natives.VisionProxyJNI
 
OCRParagraphs_clear(long, OCRParagraphs) - Static method in class org.sikuli.natives.VisionProxyJNI
 
OCRParagraphs_get(long, OCRParagraphs, int) - Static method in class org.sikuli.natives.VisionProxyJNI
 
OCRParagraphs_isEmpty(long, OCRParagraphs) - Static method in class org.sikuli.natives.VisionProxyJNI
 
OCRParagraphs_reserve(long, OCRParagraphs, long) - Static method in class org.sikuli.natives.VisionProxyJNI
 
OCRParagraphs_set(long, OCRParagraphs, int, long, OCRParagraph) - Static method in class org.sikuli.natives.VisionProxyJNI
 
OCRParagraphs_size(long, OCRParagraphs) - Static method in class org.sikuli.natives.VisionProxyJNI
 
OCRRect - Class in org.sikuli.natives
 
OCRRect(long, boolean) - Constructor for class org.sikuli.natives.OCRRect
 
OCRRect() - Constructor for class org.sikuli.natives.OCRRect
 
OCRRect(int, int, int, int) - Constructor for class org.sikuli.natives.OCRRect
 
OCRRect_height_get(long, OCRRect) - Static method in class org.sikuli.natives.VisionProxyJNI
 
OCRRect_height_set(long, OCRRect, int) - Static method in class org.sikuli.natives.VisionProxyJNI
 
OCRRect_width_get(long, OCRRect) - Static method in class org.sikuli.natives.VisionProxyJNI
 
OCRRect_width_set(long, OCRRect, int) - Static method in class org.sikuli.natives.VisionProxyJNI
 
OCRRect_x_get(long, OCRRect) - Static method in class org.sikuli.natives.VisionProxyJNI
 
OCRRect_x_set(long, OCRRect, int) - Static method in class org.sikuli.natives.VisionProxyJNI
 
OCRRect_y_get(long, OCRRect) - Static method in class org.sikuli.natives.VisionProxyJNI
 
OCRRect_y_set(long, OCRRect, int) - Static method in class org.sikuli.natives.VisionProxyJNI
 
OCRText - Class in org.sikuli.natives
 
OCRText(long, boolean) - Constructor for class org.sikuli.natives.OCRText
 
OCRText() - Constructor for class org.sikuli.natives.OCRText
 
OCRText_getParagraphs(long, OCRText) - Static method in class org.sikuli.natives.VisionProxyJNI
 
OCRText_getString(long, OCRText) - Static method in class org.sikuli.natives.VisionProxyJNI
 
OCRText_getWords(long, OCRText) - Static method in class org.sikuli.natives.VisionProxyJNI
 
OCRText_SWIGUpcast(long) - Static method in class org.sikuli.natives.VisionProxyJNI
 
OcrTextRead - Static variable in class org.sikuli.basics.Settings
 
OcrTextSearch - Static variable in class org.sikuli.basics.Settings
 
OCRWord - Class in org.sikuli.natives
 
OCRWord(long, boolean) - Constructor for class org.sikuli.natives.OCRWord
 
OCRWord() - Constructor for class org.sikuli.natives.OCRWord
 
OCRWord_getChars(long, OCRWord) - Static method in class org.sikuli.natives.VisionProxyJNI
 
OCRWord_getString(long, OCRWord) - Static method in class org.sikuli.natives.VisionProxyJNI
 
OCRWord_score_get(long, OCRWord) - Static method in class org.sikuli.natives.VisionProxyJNI
 
OCRWord_score_set(long, OCRWord, float) - Static method in class org.sikuli.natives.VisionProxyJNI
 
OCRWord_SWIGUpcast(long) - Static method in class org.sikuli.natives.VisionProxyJNI
 
OCRWords - Class in org.sikuli.natives
 
OCRWords(long, boolean) - Constructor for class org.sikuli.natives.OCRWords
 
OCRWords() - Constructor for class org.sikuli.natives.OCRWords
 
OCRWords(long) - Constructor for class org.sikuli.natives.OCRWords
 
OCRWords_add(long, OCRWords, long, OCRWord) - Static method in class org.sikuli.natives.VisionProxyJNI
 
OCRWords_capacity(long, OCRWords) - Static method in class org.sikuli.natives.VisionProxyJNI
 
OCRWords_clear(long, OCRWords) - Static method in class org.sikuli.natives.VisionProxyJNI
 
OCRWords_get(long, OCRWords, int) - Static method in class org.sikuli.natives.VisionProxyJNI
 
OCRWords_isEmpty(long, OCRWords) - Static method in class org.sikuli.natives.VisionProxyJNI
 
OCRWords_reserve(long, OCRWords, long) - Static method in class org.sikuli.natives.VisionProxyJNI
 
OCRWords_set(long, OCRWords, int, long, OCRWord) - Static method in class org.sikuli.natives.VisionProxyJNI
 
OCRWords_size(long, OCRWords) - Static method in class org.sikuli.natives.VisionProxyJNI
 
off() - Static method in class org.sikuli.basics.Debug
 
offset(int, int) - Method in class org.sikuli.script.Location
creates a point at the given offset, might be negative
might create a point outside of any screen, not checked
offset(Location) - Method in class org.sikuli.script.Location
creates a point at the given offset, might be negative
might create a point outside of any screen, not checked
offset(Location) - Method in class org.sikuli.script.Region
create region with same size at top left corner offset
offset(int, int) - Method in class org.sikuli.script.Region
create region with same size at top left corner offset
offsetLocation(int, int) - Method in class org.sikuli.guide.Visual
 
offX - Variable in class org.sikuli.script.ImageFinder
 
offY - Variable in class org.sikuli.script.ImageFinder
 
oldID - Variable in class org.sikuli.script.Screen
 
on(int) - Static method in class org.sikuli.basics.Debug
 
on(String) - Static method in class org.sikuli.basics.Debug
 
onAppear(PSI, Object) - Method in class org.sikuli.script.Region
a subsequently started observer in this region should wait for target and notify the given observer about this event
for details about the observe event handler: ObserverCallBack
for details about APPEAR/VANISH/CHANGE events: ObserveEvent
onAppear(PSI) - Method in class org.sikuli.script.Region
a subsequently started observer in this region should wait for target success and details about the event can be obtained using @{link Observing}
for details about APPEAR/VANISH/CHANGE events: ObserveEvent
onChange(Integer, Object) - Method in class org.sikuli.script.Region
a subsequently started observer in this region should wait for changes in the region and notify the given observer about this event for details about the observe event handler: ObserverCallBack for details about APPEAR/VANISH/CHANGE events: ObserveEvent
onChange(Integer) - Method in class org.sikuli.script.Region
a subsequently started observer in this region should wait for changes in the region success and details about the event can be obtained using @{link Observing}
for details about APPEAR/VANISH/CHANGE events: ObserveEvent
onChange(Object) - Method in class org.sikuli.script.Region
a subsequently started observer in this region should wait for changes in the region and notify the given observer about this event
minimum size of changes used: Settings.ObserveMinChangedPixels for details about the observe event handler: ObserverCallBack for details about APPEAR/VANISH/CHANGE events: ObserveEvent
onChange() - Method in class org.sikuli.script.Region
a subsequently started observer in this region should wait for changes in the region success and details about the event can be obtained using @{link Observing}
minimum size of changes used: Settings.ObserveMinChangedPixels for details about APPEAR/VANISH/CHANGE events: ObserveEvent
onChangeDo(Integer, Object) - Method in class org.sikuli.script.Region
 
oneFileFilter(String) - Constructor for class org.sikuli.script.RunTime.oneFileFilter
 
onVanish(PSI, Object) - Method in class org.sikuli.script.Region
a subsequently started observer in this region should wait for the target to vanish and notify the given observer about this event
for details about the observe event handler: ObserverCallBack
for details about APPEAR/VANISH/CHANGE events: ObserveEvent
onVanish(PSI) - Method in class org.sikuli.script.Region
a subsequently started observer in this region should wait for the target to vanish success and details about the event can be obtained using @{link Observing}
for details about APPEAR/VANISH/CHANGE events: ObserveEvent
open(String) - Method in class org.sikuli.natives.LinuxUtil
 
open(App.AppEntry) - Method in class org.sikuli.natives.LinuxUtil
 
open(String) - Method in class org.sikuli.natives.MacUtil
 
open(App.AppEntry) - Method in class org.sikuli.natives.MacUtil
 
open(String) - Method in interface org.sikuli.natives.OSUtil
 
open(App.AppEntry) - Method in interface org.sikuli.natives.OSUtil
 
open(String) - Method in class org.sikuli.natives.WinUtil
 
open(App.AppEntry) - Method in class org.sikuli.natives.WinUtil
 
open(String) - Static method in class org.sikuli.script.App
creates an instance for an app with this name and tries to open it
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.ImageGroup
 
open(String) - Static method in class org.sikuli.script.ImagePath
given absolute or relative (searched on image path) file name
is tried to open as a BufferedReader
BE AWARE: use br.close() when finished
openApp(String) - Method in class org.sikuli.natives.WinUtil
 
openAxSetting() - Static method in class org.sikuli.natives.MacUtil
 
openLink(String) - Static method in class org.sikuli.script.App
 
openURL(String) - Static method in class org.sikuli.basics.FileManager
open the given url in the standard browser
options - Variable in class org.sikuli.script.App.AppEntry
 
optionsIDE - Variable in class org.sikuli.script.RunTime
 
org.sikuli.android - package org.sikuli.android
 
org.sikuli.basics - package org.sikuli.basics
 
org.sikuli.guide - package org.sikuli.guide
 
org.sikuli.natives - package org.sikuli.natives
 
org.sikuli.script - package org.sikuli.script
 
org.sikuli.script.compare - package org.sikuli.script.compare
 
org.sikuli.util - package org.sikuli.util
 
org.sikuli.vnc - package org.sikuli.vnc
 
OS - Enum in org.sikuli.basics
Deprecated.
use Settings.isWindows(), ...isMac() or ...isLinux() instead
osName - Variable in class org.sikuli.script.RunTime
 
OSUtil - Interface in org.sikuli.natives
 
osVersion - Variable in class org.sikuli.script.RunTime
 
otherScreen - Variable in class org.sikuli.script.Region
 
out(String) - Static method in class org.sikuli.basics.Debug
 
OverlayCapturePrompt - Class in org.sikuli.util
INTERNAL USE implements the screen overlay used with the capture feature
OverlayCapturePrompt(IScreen) - Constructor for class org.sikuli.util.OverlayCapturePrompt
 
OverlayTransparentWindow - Class in org.sikuli.util
INTERNAL USE implements a transparent screen overlay for various purposes
OverlayTransparentWindow() - Constructor for class org.sikuli.util.OverlayTransparentWindow
 
OverlayTransparentWindow(Color, EventObserver) - Constructor for class org.sikuli.util.OverlayTransparentWindow
 
OverwriteImages - Static variable in class org.sikuli.basics.Settings
 
owner - Variable in class org.sikuli.script.Device
 

P

packJar(String, String, String) - Static method in class org.sikuli.basics.FileManager
 
PADDING_X - Variable in class org.sikuli.guide.SxBracket
 
PADDING_X - Variable in class org.sikuli.guide.Visual
 
PADDING_Y - Variable in class org.sikuli.guide.SxBracket
 
PADDING_Y - Variable in class org.sikuli.guide.Visual
 
PAGE_DOWN - Static variable in class org.sikuli.script.Key
 
PAGE_UP - Static variable in class org.sikuli.script.Key
 
paint(Graphics) - Method in class org.sikuli.guide.SxSpotlight
 
paint(Graphics) - Method in class org.sikuli.guide.Visual
 
paint(Graphics) - Method in class org.sikuli.util.OverlayCapturePrompt
 
paint(Graphics) - Method in class org.sikuli.util.ScreenHighlighter
 
paintComponent(Graphics) - Method in class org.sikuli.guide.ShadowRenderer
 
paintComponent(Graphics) - Method in class org.sikuli.guide.SxAnchor
 
paintComponent(Graphics) - Method in class org.sikuli.guide.SxArea
 
paintComponent(Graphics) - Method in class org.sikuli.guide.SxArrow
 
paintComponent(Graphics) - Method in class org.sikuli.guide.SxBracket
 
paintComponent(Graphics) - Method in class org.sikuli.guide.SxButton
 
paintComponent(Graphics) - Method in class org.sikuli.guide.SxCallout
 
paintComponent(Graphics) - Method in class org.sikuli.guide.SxCircle
 
paintComponent(Graphics) - Method in class org.sikuli.guide.SxClickable
 
paintComponent(Graphics) - Method in class org.sikuli.guide.SxFlag
 
paintComponent(Graphics) - Method in class org.sikuli.guide.SxHotspot
 
paintComponent(Graphics) - Method in class org.sikuli.guide.SxImage
 
paintComponent(Graphics) - Method in class org.sikuli.guide.SxRectangle
 
paintComponent(Graphics) - Method in class org.sikuli.guide.SxSpotlight
 
paintComponent(Graphics) - Method in class org.sikuli.guide.SxText
 
paintPlain(Graphics) - Method in class org.sikuli.guide.Visual
 
paste(Object...) - Static method in class org.sikuli.script.Commands
just doing a currentRegion.paste(text) (see paste())
paste(String) - Method in class org.sikuli.script.Region
pastes the text at the current position of the focus/carret
using the clipboard and strg/ctrl/cmd-v (paste keyboard shortcut)
paste(PFRML, String) - Method in class org.sikuli.script.Region
first does a click(target) at the given target position to gain focus/carret
and then pastes the text
using the clipboard and strg/ctrl/cmd-v (paste keyboard shortcut)
path - Variable in class org.sikuli.script.ImagePath.PathEntry
 
PathEntry(String, URL) - Constructor for class org.sikuli.script.ImagePath.PathEntry
create a new image path entry
pathEquals(String, String) - Static method in class org.sikuli.basics.FileManager
compares to path strings using java.io.File.equals()
pathURL - Variable in class org.sikuli.script.ImagePath.PathEntry
 
Pattern - Class in org.sikuli.script
to define a more complex search target
- non-standard minimum similarity
- click target other than center
- image as in-memory image
Pattern() - Constructor for class org.sikuli.script.Pattern
creates empty Pattern object at least setFilename() or setBImage() must be used before the Pattern object is ready for anything
Pattern(Pattern) - Constructor for class org.sikuli.script.Pattern
create a new Pattern from another (attribs are copied)
Pattern(Image) - Constructor for class org.sikuli.script.Pattern
create a Pattern with given image
Pattern(String) - Constructor for class org.sikuli.script.Pattern
create a Pattern based on an image file name
Pattern(URL) - Constructor for class org.sikuli.script.Pattern
Pattern from a Java resource (Object.class.getResource)
Pattern(BufferedImage) - Constructor for class org.sikuli.script.Pattern
A Pattern from a BufferedImage
Pattern(ScreenImage) - Constructor for class org.sikuli.script.Pattern
A Pattern from a ScreenImage
pause(int) - Static method in class org.sikuli.script.App
 
pause(float) - Static method in class org.sikuli.script.App
 
PAUSE - Static variable in class org.sikuli.script.Key
 
pause(int) - Static method in class org.sikuli.script.RunTime
 
pause(float) - Static method in class org.sikuli.script.RunTime
 
pid - Variable in class org.sikuli.script.App.AppEntry
 
popAsk(Object...) - Static method in class org.sikuli.script.Do
 
popAsk(String) - Static method in class org.sikuli.script.Sikulix
 
popAsk(String, String) - Static method in class org.sikuli.script.Sikulix
 
popat(Location) - Static method in class org.sikuli.script.Sikulix
 
popat(Region) - Static method in class org.sikuli.script.Sikulix
 
popat(int, int) - Static method in class org.sikuli.script.Sikulix
 
popat() - Static method in class org.sikuli.script.Sikulix
 
popError(Object...) - Static method in class org.sikuli.script.Do
 
popError(String) - Static method in class org.sikuli.script.Sikulix
 
popError(String, String) - Static method in class org.sikuli.script.Sikulix
 
popFile(String) - Static method in class org.sikuli.script.Sikulix
 
popin() - Method in class org.sikuli.guide.Visual
 
popout() - Method in class org.sikuli.guide.Visual
 
popSelect(String, String[], String) - Static method in class org.sikuli.script.Sikulix
 
popSelect(String, String[]) - Static method in class org.sikuli.script.Sikulix
 
popSelect(String, String, String[]) - Static method in class org.sikuli.script.Sikulix
 
popSelect(String, String, String[], String) - Static method in class org.sikuli.script.Sikulix
 
popup(Object...) - Static method in class org.sikuli.script.Do
 
popup(String) - Static method in class org.sikuli.script.Sikulix
 
popup(String, String) - Static method in class org.sikuli.script.Sikulix
 
PreferencesUser - Class in org.sikuli.basics
 
prefLoad(String) - Static method in class org.sikuli.script.Sikulix
retrieve the value of a previously stored a key-value-pair from Javas persistent preferences storage that is used by SikuliX to save settings and information between IDE sessions
prefLoad(String, String) - Static method in class org.sikuli.script.Sikulix
retrieve the value of a previously stored a key-value-pair from Javas persistent preferences storage that is used by SikuliX to save settings and information between IDE sessions
prefRemove(String) - Static method in class org.sikuli.script.Sikulix
permanently remove the previously stored key-value-pair having the given key from Javas persistent preferences storage that is used by SikuliX to save settings and information between IDE sessions
prefRemove() - Static method in class org.sikuli.script.Sikulix
permanently remove all previously stored key-value-pairs (by prefsStore()) from Javas persistent preferences storage that is used by SikuliX to save settings and information between IDE sessions
prefStore(String, String) - Static method in class org.sikuli.script.Sikulix
store a key-value-pair in Javas persistent preferences storage that is used by SikuliX to save settings and information between IDE sessions
this allows, to easily make some valuable information persistent
prepareRobot() - Method in class org.sikuli.util.JythonHelper
 
pressModifiers(int) - Method in class org.sikuli.android.ADBRobot
 
pressModifiers(int) - Method in interface org.sikuli.script.IRobot
 
pressModifiers(int) - Method in class org.sikuli.script.RobotDesktop
 
pressModifiers(int) - Method in class org.sikuli.util.FakeRobot
 
primaryScreen - Static variable in class org.sikuli.script.Screen
 
printArgs() - Method in class org.sikuli.script.RunTime
 
printDump(String) - Method in class org.sikuli.android.ADBDevice
 
printDump() - Method in class org.sikuli.android.ADBDevice
 
printHelp() - Method in class org.sikuli.util.CommandArgs
Prints the help
PRINTSCREEN - Static variable in class org.sikuli.script.Key
 
profile(String, Object...) - Static method in class org.sikuli.basics.Debug
Sikuli profiling messages
switch on/off: Settings.ProfileLogs, default off
ProfileLogs - Static variable in class org.sikuli.basics.Settings
 
prologjs(String) - Static method in class org.sikuli.script.Runner
 
prompt - Variable in class org.sikuli.android.ADBScreen
 
PROMPT - Static variable in exception org.sikuli.script.FindFailed
FindFailedResponse PROMPT: should display a prompt dialog with the failing image having the options retry, skip and abort
prompt - Variable in class org.sikuli.script.Screen
 
prompt(String, int) - Method in class org.sikuli.util.OverlayCapturePrompt
 
prompt(int) - Method in class org.sikuli.util.OverlayCapturePrompt
 
prompt() - Method in class org.sikuli.util.OverlayCapturePrompt
 
prompt(String) - Method in class org.sikuli.util.OverlayCapturePrompt
 
proxy - Static variable in class org.sikuli.basics.Settings
 
proxyAddress - Static variable in class org.sikuli.basics.Settings
 
proxyChecked - Static variable in class org.sikuli.basics.Settings
 
proxyIP - Static variable in class org.sikuli.basics.Settings
 
proxyName - Static variable in class org.sikuli.basics.Settings
 
proxyPort - Static variable in class org.sikuli.basics.Settings
 
purge(String) - Static method in class org.sikuli.script.Image
INTERNAL USE: IDE: to get rid of cache entries at script save, close or save as
purge(ImagePath.PathEntry) - Static method in class org.sikuli.script.Image
 
purge(URL) - Static method in class org.sikuli.script.Image
 
put(String, String) - Method in class org.sikuli.basics.PreferencesUser
 
putSysPath(String, int) - Method in class org.sikuli.util.JythonHelper
 

R

RASCRIPT - Static variable in class org.sikuli.script.Runner
 
RB - Static variable in class org.sikuli.script.Region
 
RDEFAULT - Static variable in class org.sikuli.script.Runner
 
readFileToString(File) - Static method in class org.sikuli.basics.FileManager
 
recognize(Mat) - Static method in class org.sikuli.natives.Vision
 
recognize(ScreenImage) - Method in class org.sikuli.script.TextRecognizer
 
recognize(BufferedImage) - Method in class org.sikuli.script.TextRecognizer
 
recognize_as_ocrtext(Mat) - Static method in class org.sikuli.natives.Vision
 
recognizeWord(Mat) - Static method in class org.sikuli.natives.Vision
 
recognizeWord(ScreenImage) - Method in class org.sikuli.script.TextRecognizer
 
recognizeWord(BufferedImage) - Method in class org.sikuli.script.TextRecognizer
 
rectangle() - Method in class org.sikuli.guide.Guide
create a rectangle in this guide plane and add to front
RECTANGLE - Static variable in class org.sikuli.guide.SxSpotlight
 
region - Variable in class org.sikuli.script.ImageFinder
 
Region - Class in org.sikuli.script
A Region is a rectengular area and lies always completely inside its parent screen
Region(int, int, int, int, int) - Constructor for class org.sikuli.script.Region
Create a region with the provided coordinate / size and screen
Region(int, int, int, int, IScreen) - Constructor for class org.sikuli.script.Region
Create a region with the provided coordinate / size and screen
Region(int, int) - Constructor for class org.sikuli.script.Region
Convenience: a minimal Region to be used as a Point (backport from Version 2)
is always on primary screen
Region(int, int, int, int) - Constructor for class org.sikuli.script.Region
Create a region with the provided coordinate / size
Region(Rectangle) - Constructor for class org.sikuli.script.Region
Create a region from a Rectangle
Region(Region) - Constructor for class org.sikuli.script.Region
Create a new region from another region
including the region's settings
Region() - Constructor for class org.sikuli.script.Region
internal use only, used for new Screen objects to get the Region behavior
Region(boolean) - Constructor for class org.sikuli.script.Region
internal use only, used for new Screen objects to get the Region behavior
regionOnScreen(IScreen) - Method in class org.sikuli.script.Region
Checks if the Screen contains the Region.
registerComponent(Component...) - Method in class org.sikuli.guide.ComponentMover
Add the required listeners to the specified component
releaseModifiers(int) - Method in class org.sikuli.android.ADBRobot
 
releaseModifiers(int) - Method in interface org.sikuli.script.IRobot
 
releaseModifiers(int) - Method in class org.sikuli.script.RobotDesktop
 
releaseModifiers(int) - Method in class org.sikuli.util.FakeRobot
 
reload(String) - Static method in class org.sikuli.script.Image
 
reloadImported() - Method in class org.sikuli.util.JythonHelper
 
remove(String) - Method in class org.sikuli.basics.PreferencesUser
 
remove() - Method in class org.sikuli.script.Finder
not used
remove() - Method in class org.sikuli.script.Image
 
remove() - Method in class org.sikuli.script.ImageFind
 
remove() - Method in class org.sikuli.script.ImageFinder
 
remove(String) - Static method in class org.sikuli.script.ImagePath
remove entry with given path (same as given with add)
remove(String) - Static method in class org.sikuli.script.Observing
remove the observer from the list, a region observer will be stopped
events for that observer are removed as well
remove(Region) - Static method in class org.sikuli.script.Observing
stop and remove all observers registered for this region from the list
events for those observers are removed as well
removeAll(String) - Method in class org.sikuli.basics.PreferencesUser
 
removeComponent(Component) - Method in class org.sikuli.guide.Guide
 
removeFollower(Visual) - Method in class org.sikuli.guide.Visual
 
removeFrom(Container) - Method in class org.sikuli.guide.Visual
 
removeFromLeader() - Method in class org.sikuli.guide.Visual
 
removeHotkey(String) - Method in class org.sikuli.basics.HotkeyManager
remove a hotkey by type (not supported yet)
removeHotkey(char, int) - Method in class org.sikuli.basics.HotkeyManager
remove a hotkey and uninstall a hotkey listener.
removeHotkey(String, int) - Method in class org.sikuli.basics.HotkeyManager
uninstall a hotkey listener.
removeHotkey(String, int) - Static method in class org.sikuli.script.Env
Deprecated.
use Key. ... instead
removeHotkey(char, int) - Static method in class org.sikuli.script.Env
Deprecated.
use Key. ... instead
removeHotkey(String, int) - Static method in class org.sikuli.script.Key
remove a hotkey and listener
removeHotkey(char, int) - Static method in class org.sikuli.script.Key
remove a hotkey and listener
removeHTTP(String) - Static method in class org.sikuli.script.ImagePath
 
removeImagePath(String) - Static method in class org.sikuli.script.ImageLocator
Deprecated. 
removeObserver(String) - Method in class org.sikuli.script.Observer
 
removeRunningObserver(Region) - Static method in class org.sikuli.script.Observing
 
removeSpotlights() - Method in class org.sikuli.guide.Guide
 
removeSysPath(File) - Method in class org.sikuli.util.JythonHelper
 
repeat() - Method in class org.sikuli.script.ObserveEvent
tell the observer to repeat this event's observe action immediately after returning from this handler (APPEAR, VANISH)
repeat(long) - Method in class org.sikuli.script.ObserveEvent
tell the observer to repeat this event's observe action after given time in secs after returning from this handler (APPEAR, VANISH)
repeat(String, long) - Method in class org.sikuli.script.Observer
 
RepeatWaitTime - Static variable in class org.sikuli.basics.Settings
 
reserve(long) - Method in class org.sikuli.natives.FindResults
 
reserve(long) - Method in class org.sikuli.natives.OCRChars
 
reserve(long) - Method in class org.sikuli.natives.OCRLines
 
reserve(long) - Method in class org.sikuli.natives.OCRParagraphs
 
reserve(long) - Method in class org.sikuli.natives.OCRWords
 
reset() - Static method in class org.sikuli.android.ADBClient
 
reset() - Static method in class org.sikuli.android.ADBDevice
 
reset() - Static method in class org.sikuli.basics.HotkeyManager
remove all hotkeys
reset() - Static method in exception org.sikuli.script.FindFailed
 
reset() - Static method in class org.sikuli.script.Image
clears all caches (should only be needed for debugging)
reset(String) - Static method in class org.sikuli.script.ImagePath
empty path list and add given path as first entry Image cache is cleared completely
reset() - Static method in class org.sikuli.script.ImagePath
empty path list and keep bundlePath (entry 0)
Image cache is cleared completely convenience for the scripting level
reset() - Static method in class org.sikuli.script.Mouse
 
reset(RunTime.Type) - Static method in class org.sikuli.script.RunTime
INTERNAL USE get a new initialized RunTime singleton instance
reset() - Static method in class org.sikuli.script.RunTime
INTERNAL USE get a new initialized RunTime singleton instance
reset() - Static method in class org.sikuli.script.TextRecognizer
 
resetDefaultThumbHeight() - Method in class org.sikuli.basics.PreferencesUser
 
resetFolder(File) - Static method in class org.sikuli.basics.FileManager
 
resetImage(Image) - Method in class org.sikuli.script.Finder
 
resetMonitors() - Static method in class org.sikuli.script.Screen
re-initialize the monitor setup (e.g.
resetProject() - Static method in class org.sikuli.script.RunTime
 
resetPrompt(OverlayCapturePrompt) - Static method in class org.sikuli.script.Screen
 
resetScreens() - Method in class org.sikuli.script.Region
synonym for resetMonitors
resize(float) - Method in class org.sikuli.script.Image
resize the loaded image with factor using Graphics2D.drawImage
resizeTo(Dimension) - Method in class org.sikuli.guide.Visual
 
resolveImagePath(File) - Static method in class org.sikuli.basics.FileManager
Returns the directory that contains the images used by the ScriptRunner.
resourceListAsFile(String, File, FilenameFilter) - Method in class org.sikuli.script.RunTime
write the list as it is produced by calling extractResourcesToFolder to the given file with system line separator
non-compact format: every file with full path
resourceListAsSikulixContent(String, File, FilenameFilter) - Method in class org.sikuli.script.RunTime
write the list as it is produced by calling extractResourcesToFolder to the given file with system line separator
compact sikulixcontent format
resourceListAsSikulixContentFromJar(String, String, File, FilenameFilter) - Method in class org.sikuli.script.RunTime
write the list as it is produced by calling extractResourcesToFolder to the given file with system line separator
compact sikulixcontent format
resourceListAsString(String, FilenameFilter) - Method in class org.sikuli.script.RunTime
write the list produced by calling extractResourcesToFolder to the returned string with system line separator
non-compact format: every file with full path
resourceListAsString(String, FilenameFilter, String) - Method in class org.sikuli.script.RunTime
write the list produced by calling extractResourcesToFolder to the returned string with given separator
non-compact format: every file with full path
resourceLocation(String) - Method in class org.sikuli.script.RunTime
 
restore() - Method in class org.sikuli.script.Image
 
restoreUsed() - Static method in class org.sikuli.script.Commands
INTERNAL USE: restore a saved use() after a use1()
RETRY - Static variable in exception org.sikuli.script.FindFailed
FindFailedResponse RETRY: should retry the find op on FindFailed
RH - Static variable in class org.sikuli.script.Region
 
right() - Method in class org.sikuli.guide.Visual
 
right(int) - Method in class org.sikuli.guide.Visual
 
RIGHT - Static variable in class org.sikuli.script.Button
 
RIGHT - Static variable in class org.sikuli.script.Key
 
right(int) - Method in class org.sikuli.script.Location
creates a point at the given offset to the right, might be negative
might create a point outside of any screen, not checked
RIGHT - Static variable in class org.sikuli.script.Mouse
 
right() - Method in class org.sikuli.script.Region
create a region right of the right side with same height.
right(int) - Method in class org.sikuli.script.Region
create a region right of the right side with same height and given width.
rightAt() - Method in class org.sikuli.script.Region
point middle on right edge
rightAt(int) - Method in class org.sikuli.script.Region
positive offset goes to the right.
rightClick(Object...) - Static method in class org.sikuli.script.Commands
move the mouse with hover() and do a right click
rightClick() - Method in class org.sikuli.script.Location
Move the mouse to this location point and click right
rightClick() - Method in class org.sikuli.script.Region
right click at the region's last successful match
use center if no lastMatch
if region is a match: click targetOffset
rightClick(PFRML) - Method in class org.sikuli.script.Region
right click at the given target location
Pattern or Filename - do a find before and use the match
Region - position at center
Match - position at match's targetOffset
Location - position at that point
rightClick(PFRML, Integer) - Method in class org.sikuli.script.Region
right click at the given target location
holding down the given modifier keys
Pattern or Filename - do a find before and use the match
Region - position at center
Match - position at match's targetOffset
Location - position at that point
RJSCRIPT - Static variable in class org.sikuli.script.Runner
 
RM - Static variable in class org.sikuli.script.Region
 
robot - Variable in class org.sikuli.android.ADBScreen
 
robot - Variable in class org.sikuli.script.Screen
 
RobotDesktop - Class in org.sikuli.script
INTERNAL USE Implementation of IRobot making a DesktopRobot using java.awt.Robot
RobotDesktop(Screen) - Constructor for class org.sikuli.script.RobotDesktop
 
RobotDesktop() - Constructor for class org.sikuli.script.RobotDesktop
 
RobotFake - Static variable in class org.sikuli.basics.Settings
 
RPYTHON - Static variable in class org.sikuli.script.Runner
 
RR - Static variable in class org.sikuli.script.Region
 
RRSCRIPT - Static variable in class org.sikuli.script.Runner
 
RRUBY - Static variable in class org.sikuli.script.Runner
 
RSSCRIPT - Static variable in class org.sikuli.script.Runner
 
RT - Static variable in class org.sikuli.script.Region
 
Run - Class in org.sikuli.guide
 
Run() - Constructor for class org.sikuli.guide.Run
 
run() - Method in class org.sikuli.guide.Tracker
 
run(String) - Static method in class org.sikuli.script.App
the given text is parsed into a String[] suitable for issuing a Runtime.getRuntime().exec(args).
run(Object...) - Static method in class org.sikuli.script.Commands
 
Run - Class in org.sikuli.script
EXPERIMENTAL --- NOT official API
not in version 2
run(String) - Static method in class org.sikuli.script.Runner
 
run(String, String[]) - Static method in class org.sikuli.script.Runner
 
run(String[]) - Static method in class org.sikuli.script.RunServer
 
run(String) - Static method in class org.sikuli.script.Sikulix
 
run(String[]) - Static method in class org.sikuli.script.Sikulix
 
runas(String) - Static method in class org.sikuli.script.Runner
 
runas(String, boolean) - Static method in class org.sikuli.script.Runner
 
runBoxInit(String, File, URL) - Static method in class org.sikuli.script.Runner
 
runCallback(Object[]) - Method in class org.sikuli.util.JythonHelper
 
runcmd(String) - Method in class org.sikuli.script.RunTime
run a system command finally using Java::Runtime.getRuntime().exec(args) and waiting for completion
runcmd(String[]) - Method in class org.sikuli.script.RunTime
run a system command finally using Java::Runtime.getRuntime().exec(args) and waiting for completion
runCmdError - Static variable in class org.sikuli.script.RunTime
 
runjs(File, URL, String, String[]) - Static method in class org.sikuli.script.Runner
 
runjsEval(String) - Static method in class org.sikuli.script.Runner
 
runLoggerCallback(Object[]) - Method in class org.sikuli.util.JythonHelper
 
Runner - Class in org.sikuli.script
INTERNAL USE --- NOT official API
not in version 2
Runner() - Constructor for class org.sikuli.script.Runner
 
runnerTypes - Static variable in class org.sikuli.script.Runner
 
running() - Method in interface org.sikuli.basics.Animator
 
running() - Method in class org.sikuli.basics.AnimatorPulse
 
running() - Method in class org.sikuli.basics.AnimatorTimeBased
 
running() - Method in interface org.sikuli.guide.IAnimator
 
runningInProject - Variable in class org.sikuli.script.RunTime
 
runningInteractive - Variable in class org.sikuli.script.RunTime
 
runningJar - Variable in class org.sikuli.script.RunTime
 
runningLinux - Variable in class org.sikuli.script.RunTime
 
runningMac - Variable in class org.sikuli.script.RunTime
 
runningMacApp - Variable in class org.sikuli.script.RunTime
 
runningSetup - Static variable in class org.sikuli.basics.Settings
 
runningSetupInContext - Static variable in class org.sikuli.basics.Settings
 
runningSetupInValidContext - Static variable in class org.sikuli.basics.Settings
 
runningSetupWithJar - Static variable in class org.sikuli.basics.Settings
 
runningTests - Variable in class org.sikuli.script.RunTime
 
runningWinApp - Variable in class org.sikuli.script.RunTime
 
runningWindows - Variable in class org.sikuli.script.RunTime
 
runObserveCallback(Object[]) - Method in interface org.sikuli.util.JLangHelperInterface
Run callback for observers.
runObserveCallback(Object[]) - Method in class org.sikuli.util.JRubyHelper
 
runObserveCallback(Object[]) - Method in class org.sikuli.util.JythonHelper
 
runps(String) - Static method in class org.sikuli.script.Runner
 
runpy(File, URL, String, String[]) - Static method in class org.sikuli.script.Runner
 
runrb(File, URL, String, String[]) - Static method in class org.sikuli.script.Runner
 
runrobot(String) - Static method in class org.sikuli.script.Runner
 
runScripts(String[]) - Static method in class org.sikuli.script.Runner
 
RunServer - Class in org.sikuli.script
EXPERIMENTAL --- NOT official API
not as is in version 2
runTest(String) - Static method in class org.sikuli.script.Runner
 
runTest(String, String[]) - Static method in class org.sikuli.script.Runner
 
runTest(int) - Static method in class org.sikuli.util.Tests
 
RunTime - Class in org.sikuli.script
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.oneFileFilter - Class in org.sikuli.script
 
RunTime.Type - Enum in org.sikuli.script
 
runtxt(File, URL, String, String[]) - Static method in class org.sikuli.script.Runner
 
runType - Variable in class org.sikuli.script.RunTime
 

S

save() - Method in class org.sikuli.script.ScreenImage
stores the image as PNG file in the standard temp folder with a created filename (sikuliximage-timestamp.png) if not yet stored before
save(String) - Method in class org.sikuli.script.ScreenImage
stores the image as PNG file in the given path with a created filename (sikuliximage-timestamp.png)
save(String, String) - Method in class org.sikuli.script.ScreenImage
stores the image as PNG file in the given path with a created filename (givenName-timestamp.png)
save() - Method in class org.sikuli.util.SikulixFileChooser
 
saveCapture(String) - Method in class org.sikuli.script.Screen
 
saveCapture(String, Region) - Method in class org.sikuli.script.Screen
 
saveImage(BufferedImage, String, String) - Static method in class org.sikuli.basics.FileManager
 
saveImageFacts() - Method in class org.sikuli.script.ImageGroup
 
saveInBundle(String) - Method in class org.sikuli.script.ScreenImage
 
saveLastScreenImage() - Method in class org.sikuli.script.Region
 
saveLastScreenImage(File) - Method in class org.sikuli.script.ScreenImage
 
saveOpts(Properties) - Method in class org.sikuli.script.RunTime
save a properties store to a file (prop: this.comingfrom = abs.
saveOpts(Properties, String) - Method in class org.sikuli.script.RunTime
save a properties store to the given file
saveRedirected(PrintStream, PrintStream) - Static method in class org.sikuli.basics.Debug
 
saveScreenCapture() - Method in class org.sikuli.script.Region
 
saveScreenCapture(String) - Method in class org.sikuli.script.Region
 
saveScreenCapture(String, String) - Method in class org.sikuli.script.Region
 
saveTimedImage(BufferedImage) - Static method in class org.sikuli.basics.FileManager
 
saveTimedImage(BufferedImage, String) - Static method in class org.sikuli.basics.FileManager
 
saveTimedImage(BufferedImage, String, String) - Static method in class org.sikuli.basics.FileManager
 
saveTmpImage(BufferedImage) - Static method in class org.sikuli.basics.FileManager
 
saveTmpImage(BufferedImage, String) - Static method in class org.sikuli.basics.FileManager
 
scanArgs(String[]) - Static method in class org.sikuli.util.CommandArgs
 
screen - Variable in class org.sikuli.script.ImageFinder
 
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(int) - Constructor for class org.sikuli.script.Screen
The screen object with the given id
Screen(boolean) - Constructor for class org.sikuli.script.Screen
INTERNAL USE collect all physical screens to one big region
TODO: under evaluation, wether it really makes sense
Screen() - Constructor for class org.sikuli.script.Screen
Is the screen object having the top left corner as (0,0).
ScreenHighlighter - Class in org.sikuli.util
INTERNAL USE produces and manages the red framed rectangles from Region.highlight()
ScreenHighlighter(IScreen, String) - Constructor for class org.sikuli.util.ScreenHighlighter
 
ScreenImage - Class in org.sikuli.script
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
ScreenImage(Rectangle, BufferedImage) - Constructor for class org.sikuli.script.ScreenImage
create ScreenImage with given
screens - Static variable in class org.sikuli.script.Screen
 
ScreenUnion - Class in org.sikuli.script
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?
ScreenUnion() - Constructor for class org.sikuli.script.ScreenUnion
 
SCRIPTER - Static variable in class org.sikuli.basics.PreferencesUser
 
scriptProject - Static variable in class org.sikuli.script.RunTime
 
SCROLL_LOCK - Static variable in class org.sikuli.script.Key
 
SE - Static variable in class org.sikuli.script.Region
 
search(PSI, Object...) - Method in class org.sikuli.script.ImageFinder
 
searchAll(PSI, Object...) - Method in class org.sikuli.script.ImageFinder
 
searchAll(PSI, int, Object...) - Method in class org.sikuli.script.ImageFinder
 
searchAny(PSI, Object...) - Method in class org.sikuli.script.ImageFinder
 
searchSome(PSI, Object...) - Method in class org.sikuli.script.ImageFinder
 
searchSome(PSI, int, Object...) - Method in class org.sikuli.script.ImageFinder
 
selectRegion() - Method in class org.sikuli.script.Screen
interactive region create with predefined message: lets the user draw the rectangle using the mouse
selectRegion(String) - Method in class org.sikuli.script.Screen
interactive region create with given message: lets the user draw the rectangle using the mouse
send(String) - Static method in class org.sikuli.script.Run
 
SEPARATOR - Static variable in class org.sikuli.script.Key
 
ServerList - Variable in class org.sikuli.script.RunTime
 
set(int, FindResult) - Method in class org.sikuli.natives.FindResults
 
set(int, OCRChar) - Method in class org.sikuli.natives.OCRChars
 
set(int, OCRLine) - Method in class org.sikuli.natives.OCRLines
 
set(int, OCRParagraph) - Method in class org.sikuli.natives.OCRParagraphs
 
set(int, OCRWord) - Method in class org.sikuli.natives.OCRWords
 
set(Image) - Static method in class org.sikuli.script.Image
 
set(Object) - Static method in class org.sikuli.util.JythonHelper
 
setActive(String, boolean) - Method in class org.sikuli.script.Observer
 
setActive(String) - Method in class org.sikuli.script.Observing
set the observer with the given name active (checked while observing)
setActive(String, boolean) - Static method in class org.sikuli.script.Observing
 
setActive(String) - Method in class org.sikuli.script.Region
set the observer with the given name active (checked while observing)
setActualBounds(Rectangle) - Method in class org.sikuli.guide.Visual
 
setActualLocation(Point) - Method in class org.sikuli.guide.Visual
 
setActualLocation(int, int) - Method in class org.sikuli.guide.Visual
 
setActualSize(int, int) - Method in class org.sikuli.guide.Visual
 
setActualSize(Dimension) - Method in class org.sikuli.guide.Visual
 
setAnchor(Visual) - Method in class org.sikuli.guide.Tracker
 
setAnimateAnchoring(boolean) - Method in class org.sikuli.guide.SxAnchor
 
setArgs(String[], String[]) - Method in class org.sikuli.script.RunTime
 
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
setAtSaveCleanBundle(boolean) - Method in class org.sikuli.basics.PreferencesUser
 
setAtSaveMakeHTML(boolean) - Method in class org.sikuli.basics.PreferencesUser
 
setAutoCaptureForCmdButtons(boolean) - Method in class org.sikuli.basics.PreferencesUser
 
setAutoDelay(int) - Method in class org.sikuli.android.ADBRobot
 
setAutoDelay(int) - Method in interface org.sikuli.script.IRobot
 
setAutoDelay(int) - Method in class org.sikuli.util.FakeRobot
 
setAutoLayoutEnabled(boolean) - Method in class org.sikuli.guide.Visual
 
setAutoMoveEnabled(boolean) - Method in class org.sikuli.guide.Visual
 
setAutoNamingMethod(int) - Method in class org.sikuli.basics.PreferencesUser
 
setAutoResizeEnabled(boolean) - Method in class org.sikuli.guide.Visual
 
setAutoVisibilityEnabled(boolean) - Method in class org.sikuli.guide.Visual
 
setAutoWaitTimeout(double) - Method in class org.sikuli.script.Region
the time in seconds a find operation should wait for the appearence of the target in this region
initial value is the global AutoWaitTimeout setting at time of Region creation
setBase(BufferedImage) - Method in class org.sikuli.script.ImageFinder
 
setBImage(BufferedImage) - Method in class org.sikuli.script.Pattern
ONLY FOR INTERNAL USE! Might vanish without notice!
setBimg(BufferedImage) - Method in class org.sikuli.script.Image
 
setBorderVisible(boolean) - Method in class org.sikuli.guide.SxClickable
 
setBottomLeft(Location) - Method in class org.sikuli.script.Region
Moves the region to the area, whose bottom left corner is the given location
setBottomRight(Location) - Method in class org.sikuli.script.Region
Moves the region to the area, whose bottom right corner is the given location
setBundlePath(String) - Static method in class org.sikuli.script.ImageLocator
Deprecated. 
setBundlePath(String) - Static method in class org.sikuli.script.ImagePath
the given path replaces bundlepath (entry 0) and Settings.bundlePath is set to given path
setCallback(Object) - Method in class org.sikuli.script.Device
what to do if mouse is moved outside Sikuli's mouse protection
in case of event the user provided callBack.happened is called
setCaptureDelay(double) - Method in class org.sikuli.basics.PreferencesUser
 
setCaptureHotkey(int) - Method in class org.sikuli.basics.PreferencesUser
 
setCaptureHotkeyModifiers(int) - Method in class org.sikuli.basics.PreferencesUser
 
setCenter(Location) - Method in class org.sikuli.script.Region
Moves the region to the area, whose center is the given location
setCh(String) - Method in class org.sikuli.natives.OCRChar
 
setChangeCursor(boolean) - Method in class org.sikuli.guide.ComponentMover
Set the change cursor property
setChanges(List<Match>) - Method in class org.sikuli.script.ObserveEvent
 
setCheckUpdate(boolean) - Method in class org.sikuli.basics.PreferencesUser
 
setCheckUpdateTime() - Method in class org.sikuli.basics.PreferencesUser
 
setClipboard(String) - Static method in class org.sikuli.script.App
sets the current textual content of the system clipboard to the given text
setClipboard(String) - Static method in class org.sikuli.script.Env
Deprecated.
use App. ... instead
setColor(Color) - Method in class org.sikuli.guide.Visual
set the front and back color
setColor(int, int, int) - Method in class org.sikuli.guide.Visual
set the front and back color as (r, g, b) integer array
setColors(Color, Color, Color, Color, Color) - Method in class org.sikuli.guide.Visual
set a Java Color for the component
not all components have all color options
setColors(int[], int[], int[], int[]) - Method in class org.sikuli.guide.Visual
mainly for Jython layer: colors given as (r, g, b) integer array
setCols(int) - Method in class org.sikuli.script.Image
store info: this image is divided horizontally into n even columns
a preparation for using getCol()
setCols(int) - Method in class org.sikuli.script.Region
store info: this region is divided horizontally into n even columns
a preparation for using getCol()
setConsoleCSS(String) - Method in class org.sikuli.basics.PreferencesUser
 
setCount(int) - Method in class org.sikuli.script.ImageFind
 
setDarken(boolean) - Method in class org.sikuli.guide.Guide
 
setDebug(int, int) - Static method in class org.sikuli.natives.VisionProxy
 
setDebug(int, int) - Static method in class org.sikuli.natives.VisionProxyJNI
 
setDebugLevel() - Static method in class org.sikuli.basics.Debug
set debug level to default level
setDebugLevel(int) - Static method in class org.sikuli.basics.Debug
set debug level to given value
setDebugLevel(String) - Static method in class org.sikuli.basics.Debug
set debug level to given number value as string (ignored if invalid)
setDefaults(int) - Method in class org.sikuli.basics.PreferencesUser
 
setDefaultThumbHeight(int) - Method in class org.sikuli.basics.PreferencesUser
 
setDefaultTimeout(float) - Method in class org.sikuli.guide.Guide
 
setDestination(Point) - Method in class org.sikuli.guide.SxArrow
 
setDialog(String) - Method in class org.sikuli.guide.Guide
 
setDialog(TransitionDialog) - Method in class org.sikuli.guide.Guide
 
setDirection(int) - Method in class org.sikuli.guide.SxBracket
 
setDirection(int) - Method in class org.sikuli.guide.SxFlag
 
setDragInsets(Insets) - Method in class org.sikuli.guide.ComponentMover
Set the drag insets.
setEmphasisAnimation(Animator) - Method in class org.sikuli.guide.Visual
 
setEntranceAnimation(Animator) - Method in class org.sikuli.guide.Visual
 
setEnvironmentVariable(String, String) - Static method in class org.sikuli.util.SysJNA.WinKernel32
set the value of a variable in real Windows environment
setExpandTab(boolean) - Method in class org.sikuli.basics.PreferencesUser
 
setFilename(String) - Method in class org.sikuli.script.Pattern
set a new image for this pattern
setFilename(URL) - Method in class org.sikuli.script.Pattern
set a new image for this pattern
setFilename(Image) - Method in class org.sikuli.script.Pattern
set a new image for this pattern
setFileURL(URL) - Method in class org.sikuli.script.Image
 
setFindAll(boolean) - Method in class org.sikuli.natives.FindInput
 
setFindFailedHandler(Object) - Method in exception org.sikuli.script.FindFailed
 
setFindFailedHandler(Object) - Method in class org.sikuli.script.Region
 
setFindFailedResponse(FindFailedResponse) - Method in class org.sikuli.script.Region
FindFailedResponse.
ABORT - (initial value) abort script on FindFailed (= setThrowException(true) )
SKIP - ignore FindFailed (same as setThrowException(false) )
PROMPT - display prompt on FindFailed to let user decide how to proceed
RETRY - continue to wait for appearence after FindFailed (caution: endless loop)
setFinding(int) - Method in class org.sikuli.script.ImageFind
 
setFindTimeout(double) - Method in class org.sikuli.script.ImageFind
 
setFindTimeout(double) - Method in class org.sikuli.script.ImageFinder
 
setFont(String, int) - Method in class org.sikuli.guide.SxFlag
 
setFont(String, int) - Method in class org.sikuli.guide.Visual
 
setFontName(String) - Method in class org.sikuli.basics.PreferencesUser
 
setFontSize(int) - Method in class org.sikuli.basics.PreferencesUser
 
setFontSize(int) - Method in class org.sikuli.guide.Visual
 
setGroup(ImageGroup) - Method in class org.sikuli.script.Image
set the ImageGroup this image should belong to
setGuide(Guide) - Method in class org.sikuli.guide.Visual
 
setH(int) - Method in class org.sikuli.natives.FindResult
 
setH(int) - Method in class org.sikuli.script.Region
 
setHandler(Object) - Static method in exception org.sikuli.script.FindFailed
 
setHasIOException(boolean) - Method in class org.sikuli.script.Image
 
setHeight(int) - Method in class org.sikuli.natives.OCRRect
 
setHorizontalAlignmentWithRegion(Region, float) - Method in class org.sikuli.guide.Visual
 
setIdeLocation(Point) - Method in class org.sikuli.basics.PreferencesUser
 
setIdeSession(String) - Method in class org.sikuli.basics.PreferencesUser
 
setIDEshouldReload(Image) - Static method in class org.sikuli.script.Image
 
setIdeSize(Dimension) - Method in class org.sikuli.basics.PreferencesUser
 
setImage(BufferedImage) - Method in class org.sikuli.guide.SxImage
 
setImage(Image) - Method in class org.sikuli.script.ImageFinder
 
setImage(Image) - Method in class org.sikuli.script.Match
set the image after finding with success
setImage(Object) - Method in class org.sikuli.script.ObserveEvent
 
setImage(Image) - Method in class org.sikuli.script.Pattern
sets the Pattern's image
setImageCache(int) - Static method in class org.sikuli.basics.Settings
set the maximum to be used for the Image cache
the start up value is 64 (meaning MB)
using 0 switches off caching and clears the cache in that moment
setImageMissingHandler(Object) - Method in exception org.sikuli.script.FindFailed
 
setImageMissingHandler(Object) - Method in class org.sikuli.script.Region
 
setImageName(String) - Method in class org.sikuli.script.Image
 
setInactive(String) - Method in class org.sikuli.script.Observing
set the observer with the given name inactive (not checked while observing)
setInactive(String) - Method in class org.sikuli.script.Region
set the observer with the given name inactive (not checked while observing)
setIndex(int) - Method in class org.sikuli.script.Match
 
setIndex(int) - Method in class org.sikuli.script.ObserveEvent
 
setIsAbsolute(boolean) - Method in class org.sikuli.script.Image
 
setIsInnerFind() - Method in class org.sikuli.script.ImageFind
 
setIsMultiFinder() - Method in class org.sikuli.script.ImageFinder
 
setIsPattern(boolean) - Method in class org.sikuli.script.Image
 
setLastSeen(Rectangle, double) - Method in class org.sikuli.script.Image
Internal Use: set the last seen info after a find
setLastSeenUpdate(String) - Method in class org.sikuli.basics.PreferencesUser
 
setLayout(Visual.Layout) - Method in class org.sikuli.guide.Visual
 
setLimit(int) - Method in class org.sikuli.natives.FindInput
 
setLocale(Locale) - Method in class org.sikuli.basics.PreferencesUser
 
setLocation(int, int) - Method in class org.sikuli.script.Location
sets the coordinates to the given values (moves it)
setLocation(double, double) - Method in class org.sikuli.script.Location
sets the coordinates to the given values (moves it)
setLocation(Location) - Method in class org.sikuli.script.Region
set the regions position
this might move the region even to another screen
setLocationRelative(Visual.Layout) - Method in class org.sikuli.guide.Visual
 
setLocationRelativeToComponent(Visual, Visual.Layout) - Method in class org.sikuli.guide.Visual
 
setLocationRelativeToComponent(Visual, int, int) - Method in class org.sikuli.guide.Visual
 
setLocationRelativeToComponent(Visual, float, float) - Method in class org.sikuli.guide.Visual
 
setLocationRelativeToComponent(Visual) - Method in class org.sikuli.guide.Visual
 
setLocationRelativeToPoint(Point, Visual.Layout) - Method in class org.sikuli.guide.Visual
 
setLocationRelativeToRegion(Region, Visual.Layout) - Method in class org.sikuli.guide.SxBracket
 
setLocationRelativeToRegion(Region, Visual.Layout) - Method in class org.sikuli.guide.SxCallout
 
setLocationRelativeToRegion(Region, Visual.Layout) - Method in class org.sikuli.guide.SxFlag
 
setLocationRelativeToRegion(Region, Visual.Layout) - Method in class org.sikuli.guide.Visual
 
setLocationToUserPreferredLocation() - Method in class org.sikuli.guide.TransitionDialog
 
setLogFile(String) - Static method in class org.sikuli.basics.Debug
specify, where the logs should be written:
null - use from property sikuli.Logfile empty - use SikuliLog.txt in working folder not empty - use given filename
setLogger(Object) - Static method in class org.sikuli.basics.Debug
A logger object that is intended, to get Sikuli's log messages per redirection
setLoggerAction(String) - Static method in class org.sikuli.basics.Debug
specify the target method for redirection of Sikuli's action messages [log]
must be the name of an instance method of the previously defined logger and
must accept exactly one string parameter, that contains the info message
setLoggerAll(String) - Static method in class org.sikuli.basics.Debug
sets the redirection for all message types user, info, action, error and debug must be the name of an instance method of the previously defined logger and
must accept exactly one string parameter, that contains the message text
setLoggerDebug(String) - Static method in class org.sikuli.basics.Debug
specify the target method for redirection of Sikuli's debug messages [debug]
must be the name of an instance method of the previously defined logger and
must accept exactly one string parameter, that contains the info message
setLoggerError(String) - Static method in class org.sikuli.basics.Debug
specify the target method for redirection of Sikuli's error messages [error]
must be the name of an instance method of the previously defined logger and
must accept exactly one string parameter, that contains the info message
setLoggerInfo(String) - Static method in class org.sikuli.basics.Debug
specify the target method for redirection of Sikuli's info messages [info]
must be the name of an instance method of the previously defined logger and
must accept exactly one string parameter, that contains the info message
setLoggerNoPrefix(Object) - Static method in class org.sikuli.basics.Debug
same as setLogger(), but the Sikuli prefixes are omitted in all redirected messages
setLoggerUser(String) - Static method in class org.sikuli.basics.Debug
specify the target method for redirection of Sikuli's user log messages [user]
must be the name of an instance method of the previously defined logger and
must accept exactly one string parameter, that contains the info message
setMargin(int, int, int, int) - Method in class org.sikuli.guide.Visual
 
setMatch(Object) - Method in class org.sikuli.script.ObserveEvent
 
setMaxWidth(int) - Method in class org.sikuli.guide.Visual
 
setMinChanges(int) - Method in class org.sikuli.script.ImageFinder
 
setMode(int) - Method in class org.sikuli.guide.SxArea
 
setMouseMovedAction(int) - Static method in class org.sikuli.script.Mouse
what to do if mouse is moved outside Sikuli's mouse protection
- Mouse.MouseMovedIgnore (0) ignore it (default)
- Mouse.MouseMovedShow (1) show and ignore it
- Mouse.MouseMovedPause (2) show it and pause until user says continue
(2 not implemented yet - 1 is used)
setMouseMovedCallback(Object) - Static method in class org.sikuli.script.Mouse
what to do if mouse is moved outside Sikuli's mouse protection
only 3 is honored:
in case of event the user provided callBack.happened is called
setMouseMovedHighlight(boolean) - Static method in class org.sikuli.script.Mouse
 
setMouseOver(boolean) - Method in class org.sikuli.guide.SxClickable
 
setMouseOverVisible(boolean) - Method in class org.sikuli.guide.SxClickable
 
setMovable(boolean) - Method in class org.sikuli.guide.Visual
 
setName(String) - Method in class org.sikuli.guide.SxButton
 
setName(String) - Method in class org.sikuli.guide.SxClickable
 
setObserveScanRate(float) - Method in class org.sikuli.script.Region
set the regions individual ObserveScanRate
setOffset(int, int) - Method in class org.sikuli.guide.Visual
 
setOffset(Location) - Method in class org.sikuli.script.Image
Set the value of offset
setOnScreen(boolean) - Method in class org.sikuli.script.Match
 
setOpacity(float) - Method in class org.sikuli.guide.Visual
 
setOpacity(float) - Method in class org.sikuli.util.OverlayTransparentWindow
 
setOpt(Properties, String, String) - Static method in class org.sikuli.script.RunTime
 
setOption(String, String) - Method in class org.sikuli.script.RunTime
store an option key-value pair, overwrites existing value
new option store is created if necessary and can later be saved to a file
setOptNum(Properties, String, double) - Static method in class org.sikuli.script.RunTime
 
setOpts(Properties, Map<String, String>) - Static method in class org.sikuli.script.RunTime
 
setOtherScreen(IScreen) - Method in class org.sikuli.script.Location
INTERNAL USE identifies the point as being on a non-desktop-screen
setOtherScreen() - Method in class org.sikuli.script.Region
INTERNAL USE: flags this region as belonging to a non-Desktop screen
setOtherScreen(IScreen) - Method in class org.sikuli.script.Region
INTERNAL USE: flags this region as belonging to a non-Desktop screen
setParameter(String, String) - Static method in class org.sikuli.natives.OCR
 
setParameter(String, float) - Static method in class org.sikuli.natives.Vision
 
setPattern(Object) - Method in class org.sikuli.script.ObserveEvent
 
setPrefMoreCommandBar(boolean) - Method in class org.sikuli.basics.PreferencesUser
 
setPrefMoreHighlight(boolean) - Method in class org.sikuli.basics.PreferencesUser
 
setPrefMoreImages(boolean) - Method in class org.sikuli.basics.PreferencesUser
 
setPrefMoreImagesPath(String) - Method in class org.sikuli.basics.PreferencesUser
 
setPrefMoreImageThumbs(boolean) - Method in class org.sikuli.basics.PreferencesUser
 
setPrefMoreLogActions(boolean) - Method in class org.sikuli.basics.PreferencesUser
 
setPrefMoreLogDebug(boolean) - Method in class org.sikuli.basics.PreferencesUser
 
setPrefMoreLogInfo(boolean) - Method in class org.sikuli.basics.PreferencesUser
 
setPrefMoreMessage(int) - Method in class org.sikuli.basics.PreferencesUser
 
setPrefMorePlainText(boolean) - Method in class org.sikuli.basics.PreferencesUser
 
setPrefMoreRunSave(boolean) - Method in class org.sikuli.basics.PreferencesUser
 
setPrefMoreTextOCR(boolean) - Method in class org.sikuli.basics.PreferencesUser
 
setPrefMoreTextSearch(boolean) - Method in class org.sikuli.basics.PreferencesUser
 
setProDone(int) - Method in class org.sikuli.basics.SplashFrame
 
setProFile(String) - Method in class org.sikuli.basics.SplashFrame
 
setProSize(int) - Method in class org.sikuli.basics.SplashFrame
 
setProxy(String, String) - Static method in class org.sikuli.basics.FileManager
 
setRaster(int, int) - Method in class org.sikuli.script.Image
store info: this image is divided into a raster of even cells
a preparation for using getCell()
setRaster(int, int) - Method in class org.sikuli.script.Region
store info: this region is divided into a raster of even cells
a preparation for using getCell()
setRect(Rectangle) - Method in class org.sikuli.script.Region
set the regions position/size
this might move the region even to another screen
setRect(int, int, int, int) - Method in class org.sikuli.script.Region
set the regions position/size
this might move the region even to another screen
setRect(Region) - Method in class org.sikuli.script.Region
set the regions position/size
this might move the region even to another screen
setRegion(Region) - Method in class org.sikuli.script.ImageFinder
 
setRegion(Object) - Method in class org.sikuli.script.ObserveEvent
 
setRelationship(int) - Method in class org.sikuli.guide.SxArea
 
setRepeating() - Method in class org.sikuli.script.Finder
internal use: to be able to reuse the same Finder
setRepeatWaitTime(int) - Method in class org.sikuli.script.Region
INTERNAL USE: Observe set the regions individual WaitForVanish
setResponse(FindFailedResponse) - Static method in exception org.sikuli.script.FindFailed
 
setResponse(FindFailedResponse) - Method in class org.sikuli.script.ObserveEvent
 
setROI() - Method in class org.sikuli.script.Region
resets this region (usually a Screen object) to the coordinates of the containing screen Because of the wanted side effect for the containing screen, this should only be used with screen objects.
setROI(int, int, int, int) - Method in class org.sikuli.script.Region
resets this region to the given location, and size
this might move the region even to another screen
Because of the wanted side effect for the containing screen, this should only be used with screen objects.
setROI(Rectangle) - Method in class org.sikuli.script.Region
resets this region to the given rectangle
this might move the region even to another screen
Because of the wanted side effect for the containing screen, this should only be used with screen objects.
setROI(Region) - Method in class org.sikuli.script.Region
resets this region to the given region
this might move the region even to another screen
Because of the wanted side effect for the containing screen, this should only be used with screen objects.
setRows(int) - Method in class org.sikuli.script.Image
store info: this image is divided vertically into n even rows
a preparation for using getRow()
setRows(int) - Method in class org.sikuli.script.Region
store info: this region is divided vertically into n even rows
a preparation for using getRow()
setRunningSikulixapi(boolean) - Static method in class org.sikuli.script.Sikulix
Set the value of runningSikulixUtilapi
setScale(float) - Method in class org.sikuli.guide.SxImage
 
setScale(float) - Method in class org.sikuli.guide.Visual
 
setScore(double) - Method in class org.sikuli.natives.FindResult
 
setScore(float) - Method in class org.sikuli.natives.OCRWord
 
setScreen(IScreen) - Method in class org.sikuli.script.ImageFinder
 
setScreen(IScreen) - Method in class org.sikuli.script.Region
Sets a new Screen for this region.
setScreen(int) - Method in class org.sikuli.script.Region
Sets a new Screen for this region.
setScreen(IScreen) - Method in class org.sikuli.script.Screen
Should not be used - throws UnsupportedOperationException
setScreenImage(ScreenImage) - Method in class org.sikuli.script.Finder
internal use: exchange the source image in existing Finder
setShadow(int, int) - Method in class org.sikuli.guide.Visual
 
setShadowDefault() - Method in class org.sikuli.guide.Visual
 
setShape(int) - Method in class org.sikuli.guide.SxSpotlight
 
setShouldRunCallback(boolean) - Method in class org.sikuli.script.Device
 
setShouldTerminate() - Static method in class org.sikuli.script.Device
 
setShowActions(boolean) - Static method in class org.sikuli.basics.Settings
 
setSikuliVersion(String) - Static method in class org.sikuli.script.Env
Deprecated.
 
setSimilarity(double) - Method in class org.sikuli.natives.FindInput
 
setSimilarity(float) - Method in class org.sikuli.script.Image
Set the value of similarity
setSize(int, int) - Method in class org.sikuli.script.Region
 
setSnapSize(Dimension) - Method in class org.sikuli.guide.ComponentMover
Set the snap size.
setSorted(int) - Method in class org.sikuli.script.ImageFind
 
setSource(Point) - Method in class org.sikuli.guide.SxArrow
 
setSource(String) - Method in class org.sikuli.natives.FindInput
 
setSource(Mat) - Method in class org.sikuli.natives.FindInput
 
setSParameter(String, String) - Static method in class org.sikuli.natives.Vision
 
setStopHotkey(int) - Method in class org.sikuli.basics.PreferencesUser
 
setStopHotkeyModifiers(int) - Method in class org.sikuli.basics.PreferencesUser
 
setStopOnFirstEvent() - Method in class org.sikuli.script.Observer
 
setStopOnFirstEvent() - Static method in class org.sikuli.script.Observing
tell the next starting observer, to stop on the first event
setStroke(int) - Method in class org.sikuli.guide.Visual
 
setStyle(int) - Method in class org.sikuli.guide.SxArrow
 
setSysArgv(String[]) - Method in class org.sikuli.util.JythonHelper
 
setSysPath() - Method in class org.sikuli.util.JythonHelper
 
setTabWidth(int) - Method in class org.sikuli.basics.PreferencesUser
 
setTarget(RCPS) - Method in class org.sikuli.guide.Visual
 
setTarget(int, String) - Method in class org.sikuli.natives.FindInput
 
setTarget(Mat) - Method in class org.sikuli.natives.FindInput
 
setTarget(int, int) - Method in class org.sikuli.script.Match
INTERNAL USE
setTargetOffset(Location) - Method in class org.sikuli.script.Match
like Pattern.targetOffset sets the click target by offset relative to the center
setTargetOffset(int, int) - Method in class org.sikuli.script.Match
like Pattern.targetOffset sets the click target relative to the center
setText(String) - Method in class org.sikuli.guide.SxFlag
 
setText(String) - Method in class org.sikuli.guide.TransitionDialog
 
setText(String) - Method in class org.sikuli.guide.Visual
 
setText(String) - Method in class org.sikuli.natives.FindResult
 
setTextColor(Color) - Method in class org.sikuli.guide.Visual
set the text color
setTextColor(int, int, int) - Method in class org.sikuli.guide.Visual
set text color as (r, g, b) integer array
setThrowException(boolean) - Method in class org.sikuli.script.Region
true - (initial setting) should throw exception FindFailed if findX unsuccessful in this region
false - do not abort script on FindFailed (might leed to null pointer exceptions later)
setTimeAfter(int) - Method in class org.sikuli.script.Pattern
set the seconds to wait, after this pattern is acted on
setTimeout(int) - Method in class org.sikuli.guide.TransitionDialog
 
setTimes(long, long) - Method in class org.sikuli.script.Match
INTERNAL USE set the elapsed times from search
Settings - Class in org.sikuli.basics
This is the container for all
Settings() - Constructor for class org.sikuli.basics.Settings
 
setTitle(String) - Method in class org.sikuli.guide.TransitionDialog
 
setTopLeft(Location) - Method in class org.sikuli.script.Region
Moves the region to the area, whose top left corner is the given location
setTopRight(Location) - Method in class org.sikuli.script.Region
Moves the region to the area, whose top right corner is the given location
setTracker(Pattern) - Method in class org.sikuli.guide.SxAnchor
 
setType(ObserveEvent.Type) - Method in class org.sikuli.script.ObserverCallBack
 
setUserLogFile(String) - Static method in class org.sikuli.basics.Debug
specify, where the user logs (Debug.user) should be written:
null - use from property sikuli.LogfileUser empty - use UserLog.txt in working folder not empty - use given filename
setUserType(int) - Method in class org.sikuli.basics.PreferencesUser
 
setUsing(String) - Method in class org.sikuli.script.App
 
setVals(Object, Object, Object) - Method in class org.sikuli.script.ObserveEvent
for type GENERIC: 3 values can be stored in the event (the value's type is known by creator and user of getVals as some private protocol)
setVerticalAlignmentWithRegion(Region, float) - Method in class org.sikuli.guide.Visual
 
setVirtual(boolean) - Method in class org.sikuli.script.Region
INTERNAL USE - EXPERIMENTAL
setVisible(boolean) - Method in class org.sikuli.guide.Visual
 
setW(int) - Method in class org.sikuli.natives.FindResult
 
setW(int) - Method in class org.sikuli.script.Region
 
setWaitAfter(int) - Method in class org.sikuli.script.Image
Set the value of waitAfter
setWaitAfter(boolean) - Method in class org.sikuli.util.ScreenHighlighter
 
setWaitScanRate(float) - Method in class org.sikuli.script.Region
set the regions individual WaitScanRate
setWantBeta(boolean) - Method in class org.sikuli.basics.PreferencesUser
 
setWidth(int) - Method in class org.sikuli.natives.OCRRect
 
setX(int) - Method in class org.sikuli.natives.FindResult
 
setX(int) - Method in class org.sikuli.natives.OCRRect
 
setX(int) - Method in class org.sikuli.script.Region
 
setY(int) - Method in class org.sikuli.natives.FindResult
 
setY(int) - Method in class org.sikuli.natives.OCRRect
 
setY(int) - Method in class org.sikuli.script.Region
 
setZoomLevel(float) - Method in class org.sikuli.guide.Visual
 
SH - Static variable in class org.sikuli.script.Region
 
SHADOW_SIZE - Variable in class org.sikuli.guide.SxBracket
 
ShadowRenderer - Class in org.sikuli.guide
 
ShadowRenderer(Visual, int) - Constructor for class org.sikuli.guide.ShadowRenderer
 
SHIFT - Static variable in class org.sikuli.script.Key
 
SHIFT - Static variable in class org.sikuli.script.KeyModifier
 
shortname() - Method in enum org.sikuli.util.CommandArgsEnum
Returns the short name
shouldCleanDownloads - Variable in class org.sikuli.script.RunTime
 
shouldHighlight() - Static method in class org.sikuli.basics.Debug
 
shouldLogJython - Static variable in class org.sikuli.basics.Debug
 
shouldRunServer - Static variable in class org.sikuli.script.RunTime
 
shouldUseProvided - Static variable in class org.sikuli.util.LinuxSupport
 
show() - Static method in class org.sikuli.script.Run
 
show() - Method in class org.sikuli.script.RunTime
print out some basic information about the current runtime environment
show(String) - Method in class org.sikuli.util.SikulixFileChooser
 
showMonitors() - Static method in class org.sikuli.script.Screen
show the current monitor setup
showNow(float) - Method in class org.sikuli.guide.Guide
 
showNow() - Method in class org.sikuli.guide.Guide
 
showScreens() - Method in class org.sikuli.script.Region
synonym for showMonitors
showSysPath() - Method in class org.sikuli.util.JythonHelper
 
showTarget(Location) - Method in class org.sikuli.android.ADBScreen
 
showTarget(Location, double) - Method in class org.sikuli.android.ADBScreen
 
showTarget(Location) - Method in interface org.sikuli.script.IScreen
 
showTarget(Location) - Method in class org.sikuli.script.Screen
 
showTarget(Location, double) - Method in class org.sikuli.script.Screen
 
showTarget(Location, float) - Method in class org.sikuli.util.ScreenHighlighter
 
showTarget(Location) - Method in class org.sikuli.vnc.VNCScreen
 
showTarget(Location, double) - Method in class org.sikuli.vnc.VNCScreen
 
SIKULI_LIB - Static variable in class org.sikuli.basics.Settings
Resource types to be used with IResourceLoader implementations
SIKULI_USER - Static variable in class org.sikuli.basics.PreferencesUser
 
SikuliEvent - Class in org.sikuli.script
CANDIDATE FOR DEPRECATION - ONLY HERE TO BE BACKWARD COMPATIBLE
SikuliEvent() - Constructor for class org.sikuli.script.SikuliEvent
 
SikuliEventAdapter - Class in org.sikuli.script
Deprecated.
use @{link ObserverCallBack} instead
SikuliEventAdapter() - Constructor for class org.sikuli.script.SikuliEventAdapter
Deprecated.
 
SikuliEventObserver - Interface in org.sikuli.script
Deprecated. 
SikuliException - Exception in org.sikuli.script
INTERNAL USE
SikuliException(String) - Constructor for exception org.sikuli.script.SikuliException
 
SikuliJavaVersion - Variable in class org.sikuli.script.RunTime
 
SikuliJRuby - Variable in class org.sikuli.script.RunTime
 
SikuliJRubyMaven - Variable in class org.sikuli.script.RunTime
 
SikuliJRubyVersion - Variable in class org.sikuli.script.RunTime
 
SikuliJython - Variable in class org.sikuli.script.RunTime
 
SikuliJython25 - Variable in class org.sikuli.script.RunTime
 
SikuliJythonMaven - Variable in class org.sikuli.script.RunTime
 
SikuliJythonMaven25 - Variable in class org.sikuli.script.RunTime
 
SikuliJythonVersion - Variable in class org.sikuli.script.RunTime
 
SikuliJythonVersion25 - Variable in class org.sikuli.script.RunTime
 
SikuliLocalRepo - Variable in class org.sikuli.script.RunTime
 
SikuliProjectVersion - Variable in class org.sikuli.script.RunTime
 
SikuliProjectVersionUsed - Variable in class org.sikuli.script.RunTime
 
SikuliRepo - Variable in class org.sikuli.script.RunTime
 
SikuliSystemVersion - Variable in class org.sikuli.script.RunTime
 
SikuliVersion - Static variable in class org.sikuli.script.Env
Deprecated.
use Settings.getVersion() instead
SikuliVersion - Variable in class org.sikuli.script.RunTime
 
SikuliVersionBeta - Variable in class org.sikuli.script.RunTime
 
SikuliVersionBetaIDE - Variable in class org.sikuli.script.RunTime
 
SikuliVersionBetaN - Variable in class org.sikuli.script.RunTime
 
SikuliVersionBetaScript - Variable in class org.sikuli.script.RunTime
 
SikuliVersionBuild - Variable in class org.sikuli.script.RunTime
 
SikuliVersionDefault - Variable in class org.sikuli.script.RunTime
 
SikuliVersionDefaultIDE - Variable in class org.sikuli.script.RunTime
 
SikuliVersionDefaultScript - Variable in class org.sikuli.script.RunTime
 
SikuliVersionIDE - Variable in class org.sikuli.script.RunTime
 
SikuliVersionLong - Variable in class org.sikuli.script.RunTime
 
SikuliVersionMajor - Variable in class org.sikuli.script.RunTime
 
SikuliVersionMinor - Variable in class org.sikuli.script.RunTime
 
SikuliVersionScript - Variable in class org.sikuli.script.RunTime
 
SikuliVersionSub - Variable in class org.sikuli.script.RunTime
 
SikuliVersionType - Variable in class org.sikuli.script.RunTime
 
SikuliVersionTypeText - Variable in class org.sikuli.script.RunTime
 
Sikulix - Class in org.sikuli.script
INTERNAL USE ONLY --- NOT part of official API
Sikulix() - Constructor for class org.sikuli.script.Sikulix
 
SikulixFileChooser - Class in org.sikuli.util
 
SikulixFileChooser(Frame) - Constructor for class org.sikuli.util.SikulixFileChooser
 
SikulixFileChooser(Frame, boolean) - Constructor for class org.sikuli.util.SikulixFileChooser
 
SikulixForJython - Class in org.sikuli.basics
Deprecated.
SikulixForJython() - Constructor for class org.sikuli.basics.SikulixForJython
Deprecated.
 
SikulixForJython - Class in org.sikuli.script
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 *
silentHighlight(boolean) - Method in class org.sikuli.script.Region
 
similar(float) - Method in class org.sikuli.script.Pattern
sets the minimum Similarity to use with findX
SIMPLE - Static variable in class org.sikuli.guide.Guide
 
size() - Method in class org.sikuli.basics.VDictProxy
 
size() - Method in class org.sikuli.natives.FindResults
 
size() - Method in class org.sikuli.natives.OCRChars
 
size() - Method in class org.sikuli.natives.OCRLines
 
size() - Method in class org.sikuli.natives.OCRParagraphs
 
size() - Method in class org.sikuli.natives.OCRWords
 
SKIP - Static variable in exception org.sikuli.script.FindFailed
FindFailedResponse SKIP: should silently continue on FindFailed
slashify(String, Boolean) - Static method in class org.sikuli.basics.FileManager
 
slibVision - Static variable in class org.sikuli.util.LinuxSupport
 
SlowMotionDelay - Static variable in class org.sikuli.basics.Settings
 
SM - Static variable in class org.sikuli.script.Region
 
smartCopy(String, String) - Static method in class org.sikuli.basics.FileManager
Copy a file *src* to the path *dest* and check if the file name conflicts.
smoothMove(Location) - Method in class org.sikuli.android.ADBRobot
 
smoothMove(Location, Location, long) - Method in class org.sikuli.android.ADBRobot
 
smoothMove(Location) - Method in interface org.sikuli.script.IRobot
 
smoothMove(Location, Location, long) - Method in interface org.sikuli.script.IRobot
 
smoothMove(Location) - Method in class org.sikuli.script.RobotDesktop
 
smoothMove(Location, Location, long) - Method in class org.sikuli.script.RobotDesktop
 
smoothMove(Location) - Method in class org.sikuli.util.FakeRobot
 
smoothMove(Location, Location, long) - Method in class org.sikuli.util.FakeRobot
 
SOME_COUNT - Static variable in class org.sikuli.script.ImageFind
 
SOUTH - Static variable in class org.sikuli.script.Region
 
SOUTH_EAST - Static variable in class org.sikuli.script.Region
 
SOUTH_MID - Static variable in class org.sikuli.script.Region
 
SOUTH_WEST - Static variable in class org.sikuli.script.Region
 
SPACE - Static variable in class org.sikuli.script.Key
 
SplashFrame - Class in org.sikuli.basics
 
SplashFrame(String) - Constructor for class org.sikuli.basics.SplashFrame
 
SplashFrame(String[]) - Constructor for class org.sikuli.basics.SplashFrame
 
standardExtensions - Variable in class org.sikuli.script.RunTime
 
start() - Static method in class org.sikuli.android.ADBScreen
 
start() - Method in class org.sikuli.guide.Animator
 
start() - Method in class org.sikuli.guide.GlobalMouseMotionTracker
 
start(App.Type) - Static method in class org.sikuli.script.App
 
start(String, int, String, int, int) - Static method in class org.sikuli.vnc.VNCScreen
 
start(String, int, int, int) - Static method in class org.sikuli.vnc.VNCScreen
 
startAnimation() - Method in class org.sikuli.guide.Guide
 
startAnimation() - Method in class org.sikuli.guide.SxBracket
 
startAnimation() - Method in class org.sikuli.guide.Visual
 
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
startTracking() - Method in class org.sikuli.guide.Guide
 
startTracking() - Method in class org.sikuli.guide.SxAnchor
 
stdAutoDelay - Static variable in class org.sikuli.script.RobotDesktop
 
stdDelay - Static variable in class org.sikuli.script.RobotDesktop
 
stdMaxElapsed - Static variable in class org.sikuli.script.RobotDesktop
 
step() - Method in interface org.sikuli.basics.Animator
 
step() - Method in class org.sikuli.basics.AnimatorPulse
 
step() - Method in class org.sikuli.basics.AnimatorTimeBased
 
step() - Method in interface org.sikuli.guide.IAnimator
 
stop() - Static method in class org.sikuli.android.ADBScreen
 
stop() - Method in class org.sikuli.guide.Animator
 
stop() - Method in class org.sikuli.guide.GlobalMouseMotionTracker
 
stop() - Static method in class org.sikuli.script.Run
 
stop() - Method in class org.sikuli.vnc.VNCScreen
 
stopAll() - Static method in class org.sikuli.vnc.VNCScreen
 
stopAnimation() - Method in class org.sikuli.guide.Guide
 
stopAnimation() - Method in class org.sikuli.guide.Visual
 
stopObserver() - Method in class org.sikuli.script.ObserveEvent
stops the observer
stopObserver(String) - Method in class org.sikuli.script.ObserveEvent
stops the observer and prints the given text
stopObserver() - Method in class org.sikuli.script.Region
stops a running observer
stopObserver(String) - Method in class org.sikuli.script.Region
stops a running observer printing an info message
stopTracking() - Method in class org.sikuli.guide.Guide
 
stopTracking() - Method in class org.sikuli.guide.SxAnchor
 
stopTracking() - Method in class org.sikuli.guide.Tracker
 
STRAIGHT - Static variable in class org.sikuli.guide.SxArrow
 
SW - Static variable in class org.sikuli.script.Region
 
swigCMemOwn - Variable in class org.sikuli.natives.FindInput
 
swigCMemOwn - Variable in class org.sikuli.natives.FindResult
 
swigCMemOwn - Variable in class org.sikuli.natives.FindResults
 
swigCMemOwn - Variable in class org.sikuli.natives.Mat
 
swigCMemOwn - Variable in class org.sikuli.natives.OCR
 
swigCMemOwn - Variable in class org.sikuli.natives.OCRChars
 
swigCMemOwn - Variable in class org.sikuli.natives.OCRLines
 
swigCMemOwn - Variable in class org.sikuli.natives.OCRParagraphs
 
swigCMemOwn - Variable in class org.sikuli.natives.OCRRect
 
swigCMemOwn - Variable in class org.sikuli.natives.OCRWords
 
swigCMemOwn - Variable in class org.sikuli.natives.Vision
 
swipe(int, int, int, int) - Method in class org.sikuli.android.ADBDevice
 
switchApp(String, int) - Method in class org.sikuli.natives.WinUtil
 
switchApp(int, int) - Method in class org.sikuli.natives.WinUtil
 
switchto(String, int) - Method in class org.sikuli.natives.LinuxUtil
 
switchto(String) - Method in class org.sikuli.natives.LinuxUtil
 
switchto(App.AppEntry, int) - Method in class org.sikuli.natives.LinuxUtil
 
switchto(int, int) - Method in class org.sikuli.natives.LinuxUtil
 
switchto(String) - Method in class org.sikuli.natives.MacUtil
 
switchto(int, int) - Method in class org.sikuli.natives.MacUtil
 
switchto(String, int) - Method in class org.sikuli.natives.MacUtil
 
switchto(App.AppEntry, int) - Method in class org.sikuli.natives.MacUtil
 
switchto(String) - Method in interface org.sikuli.natives.OSUtil
 
switchto(String, int) - Method in interface org.sikuli.natives.OSUtil
 
switchto(int, int) - Method in interface org.sikuli.natives.OSUtil
 
switchto(App.AppEntry, int) - Method in interface org.sikuli.natives.OSUtil
 
switchto(String) - Method in class org.sikuli.natives.WinUtil
 
switchto(String, int) - Method in class org.sikuli.natives.WinUtil
 
switchto(int, int) - Method in class org.sikuli.natives.WinUtil
 
switchto(App.AppEntry, int) - Method in class org.sikuli.natives.WinUtil
 
SxAnchor - Class in org.sikuli.guide
 
SxAnchor() - Constructor for class org.sikuli.guide.SxAnchor
 
SxAnchor(Pattern) - Constructor for class org.sikuli.guide.SxAnchor
 
SxAnchor(Region) - Constructor for class org.sikuli.guide.SxAnchor
 
SxAnchor.AnchorListener - Interface in org.sikuli.guide
 
SxArea - Class in org.sikuli.guide
 
SxArea() - Constructor for class org.sikuli.guide.SxArea
 
SxArrow - Class in org.sikuli.guide
 
SxArrow(Point, Point) - Constructor for class org.sikuli.guide.SxArrow
 
SxArrow(Visual, Visual) - Constructor for class org.sikuli.guide.SxArrow
 
SxBeam - Class in org.sikuli.guide
 
SxBeam(Guide, Region) - Constructor for class org.sikuli.guide.SxBeam
 
SxBracket - Class in org.sikuli.guide
 
SxBracket() - Constructor for class org.sikuli.guide.SxBracket
 
sxBuild - Variable in class org.sikuli.script.RunTime
 
sxBuildStamp - Variable in class org.sikuli.script.RunTime
 
SxButton - Class in org.sikuli.guide
 
SxButton(String) - Constructor for class org.sikuli.guide.SxButton
 
SxCallout - Class in org.sikuli.guide
 
SxCallout(String) - Constructor for class org.sikuli.guide.SxCallout
 
SxCircle - Class in org.sikuli.guide
 
SxCircle(Region) - Constructor for class org.sikuli.guide.SxCircle
 
SxCircle(Visual) - Constructor for class org.sikuli.guide.SxCircle
 
SxCircle() - Constructor for class org.sikuli.guide.SxCircle
 
SxClickable - Class in org.sikuli.guide
 
SxClickable(Region) - Constructor for class org.sikuli.guide.SxClickable
 
SxClickable() - Constructor for class org.sikuli.guide.SxClickable
 
SxFlag - Class in org.sikuli.guide
 
SxFlag(String) - Constructor for class org.sikuli.guide.SxFlag
 
SxHotspot - Class in org.sikuli.guide
 
SxHotspot(Region, Visual, Guide) - Constructor for class org.sikuli.guide.SxHotspot
 
SxImage - Class in org.sikuli.guide
 
SxImage(String) - Constructor for class org.sikuli.guide.SxImage
 
SxImage(BufferedImage) - Constructor for class org.sikuli.guide.SxImage
 
SxMagnet - Class in org.sikuli.guide
 
SxMagnet(Guide) - Constructor for class org.sikuli.guide.SxMagnet
 
SxRectangle - Class in org.sikuli.guide
 
SxRectangle(Region) - Constructor for class org.sikuli.guide.SxRectangle
 
SxRectangle(Visual) - Constructor for class org.sikuli.guide.SxRectangle
 
SxRectangle() - Constructor for class org.sikuli.guide.SxRectangle
 
SxSpotlight - Class in org.sikuli.guide
 
SxSpotlight() - Constructor for class org.sikuli.guide.SxSpotlight
 
SxSpotlight(Region) - Constructor for class org.sikuli.guide.SxSpotlight
 
SxText - Class in org.sikuli.guide
 
SxText(String) - Constructor for class org.sikuli.guide.SxText
 
SysJNA - Class in org.sikuli.util
Direct access to system functions via JNI, JNA, BridJ, ...
SysJNA() - Constructor for class org.sikuli.util.SysJNA
 
SysJNA.WinKernel32 - Class in org.sikuli.util
Direct access to Windows API kernel32.dll via BridJ
SysJNA.WinUser32 - Class in org.sikuli.util
Direct access to Windows API user32.dll via BridJ
sysName - Variable in class org.sikuli.script.RunTime
 
SysUtil - Class in org.sikuli.natives
 
SysUtil() - Constructor for class org.sikuli.natives.SysUtil
 

T

TAB - Static variable in class org.sikuli.script.Key
 
tap(int, int) - Method in class org.sikuli.android.ADBDevice
 
TARGET_TYPE - Class in org.sikuli.natives
 
TARGET_TYPE() - Constructor for class org.sikuli.natives.TARGET_TYPE
 
targetAppeared(ObserveEvent) - Method in class org.sikuli.script.SikuliEventAdapter
Deprecated.
 
targetAppeared(ObserveEvent) - Method in interface org.sikuli.script.SikuliEventObserver
Deprecated.
 
targetChanged(ObserveEvent) - Method in class org.sikuli.script.SikuliEventAdapter
Deprecated.
 
targetChanged(ObserveEvent) - Method in interface org.sikuli.script.SikuliEventObserver
Deprecated.
 
targetOffset(int, int) - Method in class org.sikuli.script.Pattern
set the offset from the match's center to be used with mouse actions
targetOffset(Location) - Method in class org.sikuli.script.Pattern
set the offset from the match's center to be used with mouse actions
targetVanished(ObserveEvent) - Method in class org.sikuli.script.SikuliEventAdapter
Deprecated.
 
targetVanished(ObserveEvent) - Method in interface org.sikuli.script.SikuliEventObserver
Deprecated.
 
terminate(int, String, Object...) - Method in class org.sikuli.script.RunTime
 
terminate(int) - Static method in class org.sikuli.script.Sikulix
 
terminate(int, String, Object...) - Method in class org.sikuli.util.JythonHelper
 
tessData - Variable in class org.sikuli.script.RunTime
 
test(String, Object...) - Static method in class org.sikuli.basics.Debug
Sikuli messages to use in tests
switch on/off: always on
test02_ExtractResourcesFromClasspath() - Static method in class org.sikuli.util.Tests
 
test03_ImageFromJar() - Static method in class org.sikuli.util.Tests
 
test04_ResourceListToFile() - Static method in class org.sikuli.util.Tests
 
test05_MakeLibswinContentFile() - Static method in class org.sikuli.util.Tests
 
testButton() - Method in class org.sikuli.guide.Run
 
testing - Static variable in class org.sikuli.script.RunTime
 
testingWinApp - Static variable in class org.sikuli.script.RunTime
 
testNumber - Static variable in class org.sikuli.script.Sikulix
 
Tests - Class in org.sikuli.util
 
Tests() - Constructor for class org.sikuli.util.Tests
 
testSetup() - Static method in class org.sikuli.script.Sikulix
INTERNAL USE: used in setup: tests basic SikulixUtil features
testSetup(String) - Static method in class org.sikuli.script.Sikulix
INTERNAL USE: used in setup: tests basic SikulixUtil features
testSetupSilent() - Static method in class org.sikuli.script.Sikulix
INTERNAL USE: used in setup: tests basic SikulixUtil features
testSwitch() - Method in class org.sikuli.script.RunTime
 
text(String) - Method in class org.sikuli.guide.Guide
 
TEXT - Static variable in class org.sikuli.natives.TARGET_TYPE
 
text() - Method in class org.sikuli.script.Image
OCR-read the text from the image
text(String) - Static method in class org.sikuli.script.Image
convenience method: get text from given image file
text() - Method in class org.sikuli.script.Region
STILL EXPERIMENTAL: tries to read the text in this region
might contain misread characters, NL characters and other stuff, when interpreting contained grafics as text
Best results: one line of text with no grafics in the line
TextRecognizer - Class in org.sikuli.script
INTERNAL USE --- NOT part of official API Will be rewritten for use of Tess4J - Java only implementation
TextRecognizer.ListTextMode - Enum in org.sikuli.script
 
TH - Static variable in class org.sikuli.script.Region
 
ThrowException - Static variable in class org.sikuli.basics.Settings
 
THUMB_HEIGHT - Static variable in class org.sikuli.basics.PreferencesUser
 
TimeoutTransition - Class in org.sikuli.guide
 
TimeoutTransition(int) - Constructor for class org.sikuli.guide.TimeoutTransition
 
TL - Static variable in class org.sikuli.script.Region
the area constants for use with get()
TM - Static variable in class org.sikuli.script.Region
 
to - Variable in class org.sikuli.guide.SxBeam
 
toFront() - Method in class org.sikuli.guide.ClickableWindow
 
toFront() - Method in class org.sikuli.guide.Guide
 
toFront() - Method in class org.sikuli.guide.SxBeam
 
toGlobalCoord(Match) - Method in class org.sikuli.script.Region
used in Observer.callChangeObserving, Finder.next to adjust region relative coordinates of matches to screen coordinates
toJavaKeyCode(String) - Static method in class org.sikuli.script.Key
Convert Sikuli Key to Java virtual key code
toJavaKeyCode(char) - Static method in class org.sikuli.script.Key
Convert Sikuli Key to Java virtual key code
toJavaKeyCodeFromText(String) - Static method in class org.sikuli.script.Key
 
toJavaKeyCodeText(char) - Static method in class org.sikuli.script.Key
 
toJSON() - Method in class org.sikuli.script.Location
 
toString() - Method in class org.sikuli.android.ADBDevice
 
toString() - Method in class org.sikuli.android.ADBScreen
 
toString() - Method in class org.sikuli.guide.Visual
 
toString() - Method in class org.sikuli.script.App
 
toString() - Method in class org.sikuli.script.Image
 
toString() - Method in class org.sikuli.script.ImagePath.PathEntry
 
toString() - Method in class org.sikuli.script.Location
toString() - Method in class org.sikuli.script.Match
 
toString() - Method in class org.sikuli.script.ObserveEvent
 
toString() - Method in class org.sikuli.script.Pattern
 
toString() - Method in class org.sikuli.script.Region
toString() - Method in class org.sikuli.script.Screen
 
toString() - Method in exception org.sikuli.script.SikuliException
 
toStringShort() - Method in class org.sikuli.script.App
 
toStringShort() - Method in interface org.sikuli.script.IScreen
 
toStringShort() - Method in class org.sikuli.script.Location
 
toStringShort() - Method in class org.sikuli.script.Match
 
toStringShort() - Method in class org.sikuli.script.Region
 
toStringShort() - Method in class org.sikuli.script.Screen
only a short version of toString()
toStringShort() - Method in exception org.sikuli.script.SikuliException
 
TR - Static variable in class org.sikuli.script.Region
 
TraceLogs - Static variable in class org.sikuli.basics.Settings
 
Tracker - Class in org.sikuli.guide
 
Tracker(Pattern) - Constructor for class org.sikuli.guide.Tracker
 
Tracker(Guide, Pattern, Region) - Constructor for class org.sikuli.guide.Tracker
 
Transition - Interface in org.sikuli.guide
 
Transition.TransitionListener - Interface in org.sikuli.guide
 
TransitionDialog - Class in org.sikuli.guide
 
TransitionDialog() - Constructor for class org.sikuli.guide.TransitionDialog
 
TransitionDialog(String) - Constructor for class org.sikuli.guide.TransitionDialog
 
transitionOccurred(Object) - Method in interface org.sikuli.guide.Transition.TransitionListener
 
translate(int, int) - Method in class org.sikuli.script.Location
convenience: like awt point
traverseFolder(File, FileManager.FileFilter) - Static method in class org.sikuli.basics.FileManager
 
TRUE - Static variable in class org.sikuli.basics.Settings
true = start slow motion mode, false: stop it (default: false) show a visual for SlowMotionDelay seconds (default: 2)
tryGetFileSize(URL) - Static method in class org.sikuli.basics.FileManager
 
TT - Static variable in class org.sikuli.script.Region
 
type(String) - Method in class org.sikuli.script.Region
enters the given text one character/key after another using keyDown/keyUp
about the usable Key constants see keyDown(keys)
Class Key only provides a subset of a US-QWERTY PC keyboard layout
the text is entered at the current position of the focus/carret
type(String, int) - Method in class org.sikuli.script.Region
enters the given text one character/key after another using keyDown/keyUp
while holding down the given modifier keys
about the usable Key constants see keyDown(keys)
Class Key only provides a subset of a US-QWERTY PC keyboard layout
the text is entered at the current position of the focus/carret
type(String, String) - Method in class org.sikuli.script.Region
enters the given text one character/key after another using keyDown/keyUp
while holding down the given modifier keys
about the usable Key constants see keyDown(keys)
Class Key only provides a subset of a US-QWERTY PC keyboard layout
the text is entered at the current position of the focus/carret
type(PFRML, String) - Method in class org.sikuli.script.Region
first does a click(target) at the given target position to gain focus/carret
enters the given text one character/key after another using keyDown/keyUp
about the usable Key constants see keyDown(keys)
Class Key only provides a subset of a US-QWERTY PC keyboard layout
type(PFRML, String, int) - Method in class org.sikuli.script.Region
first does a click(target) at the given target position to gain focus/carret
enters the given text one character/key after another using keyDown/keyUp
while holding down the given modifier keys
about the usable Key constants see keyDown(keys)
Class Key only provides a subset of a US-QWERTY PC keyboard layout
type(PFRML, String, String) - Method in class org.sikuli.script.Region
first does a click(target) at the given target position to gain focus/carret
enters the given text one character/key after another using keyDown/keyUp
while holding down the given modifier keys
about the usable Key constants see keyDown(keys)
Class Key only provides a subset of a US-QWERTY PC keyboard layout
typeChar(char) - Method in class org.sikuli.android.ADBDevice
 
typeChar(char, IRobot.KeyMode) - Method in class org.sikuli.android.ADBRobot
 
typeChar(char, IRobot.KeyMode) - Method in interface org.sikuli.script.IRobot
 
typeChar(char, IRobot.KeyMode) - Method in class org.sikuli.script.RobotDesktop
 
typeChar(char, IRobot.KeyMode) - Method in class org.sikuli.util.FakeRobot
 
TypeDelay - Static variable in class org.sikuli.basics.Settings
Specify a delay between the key presses in seconds as 0.nnn.
typeEndings - Static variable in class org.sikuli.script.Runner
 
typeEnds() - Method in class org.sikuli.android.ADBDevice
 
typeEnds() - Method in class org.sikuli.android.ADBRobot
 
typeEnds() - Method in interface org.sikuli.script.IRobot
 
typeEnds() - Method in class org.sikuli.script.RobotDesktop
 
typeEnds() - Method in class org.sikuli.util.FakeRobot
 
typeKey(int) - Method in class org.sikuli.android.ADBRobot
 
typeKey(int) - Method in interface org.sikuli.script.IRobot
 
typeKey(int) - Method in class org.sikuli.script.RobotDesktop
 
typeKey(int) - Method in class org.sikuli.util.FakeRobot
 
typeStarts() - Method in class org.sikuli.android.ADBDevice
 
typeStarts() - Method in class org.sikuli.android.ADBRobot
 
typeStarts() - Method in interface org.sikuli.script.IRobot
 
typeStarts() - Method in class org.sikuli.script.RobotDesktop
 
typeStarts() - Method in class org.sikuli.util.FakeRobot
 

U

unblock() - Method in class org.sikuli.script.Device
free the mouse globally after a block()
unblock(Object) - Method in class org.sikuli.script.Device
free the mouse globally for this owner after a block(owner)
unCacheBundledImage(String) - Static method in class org.sikuli.script.Image
purge the given image file's in memory image data and remove it from cache.
unCacheImage(URL) - Static method in class org.sikuli.script.Image
purge the given image's in memory image data and remove it from cache.
union(Region) - Method in class org.sikuli.script.Region
create a new region containing both regions
UNKNOWN - Static variable in class org.sikuli.basics.PreferencesUser
 
unpackJar(String, String, boolean, boolean, FileManager.JarFileFilter) - Static method in class org.sikuli.basics.FileManager
unpack a jar file to a folder
unzip(String, String) - Static method in class org.sikuli.basics.FileManager
 
unzip(File, File) - Static method in class org.sikuli.basics.FileManager
 
unzipSKL(String) - Static method in class org.sikuli.basics.FileManager
 
UP - Static variable in class org.sikuli.script.Key
 
up() - Static method in class org.sikuli.script.Mouse
release all buttons
up(int) - Static method in class org.sikuli.script.Mouse
release the given buttons Button
up(int, Region) - Static method in class org.sikuli.script.Mouse
 
update(EventSubject) - Method in class org.sikuli.android.ADBScreen
 
update(EventSubject) - Method in class org.sikuli.guide.Guide
 
update(EventSubject) - Method in class org.sikuli.guide.SxBeam
 
update(ScreenImage) - Method in class org.sikuli.script.Observer
 
update(EventSubject) - Method in interface org.sikuli.util.EventObserver
 
updateComponent() - Method in class org.sikuli.guide.SxArrow
 
updateComponent() - Method in class org.sikuli.guide.SxBracket
 
updateComponent() - Method in class org.sikuli.guide.SxButton
 
updateComponent() - Method in class org.sikuli.guide.SxCallout
 
updateComponent() - Method in class org.sikuli.guide.SxCircle
 
updateComponent() - Method in class org.sikuli.guide.SxFlag
 
updateComponent() - Method in class org.sikuli.guide.SxImage
 
updateComponent() - Method in class org.sikuli.guide.SxRectangle
 
updateComponent() - Method in class org.sikuli.guide.SxText
 
updateComponent() - Method in class org.sikuli.guide.Visual
 
updateSelf() - Method in class org.sikuli.script.Region
 
updateSpotlights(ArrayList<Region>) - Method in class org.sikuli.guide.Guide
 
uScriptProject - Static variable in class org.sikuli.script.RunTime
 
use(Object...) - Static method in class org.sikuli.script.Commands
all following undotted function calls will use the given screen or region until this is changed by a later use()
-- no args: use Screen(0) (this is the default after start)
-- a number: use Screen(number), Screen(0) if not valid
-- a region: use the given region
use() - Method in class org.sikuli.script.Device
 
use(Object) - Method in class org.sikuli.script.Device
 
use(String) - Method in class org.sikuli.script.ImageGroup
 
use() - Static method in class org.sikuli.script.Mouse
 
use(Object) - Static method in class org.sikuli.script.Mouse
 
use1(Object...) - Static method in class org.sikuli.script.Commands
same as use(), but only affects the next processed undotted function after that the use() active before is restored
useFullscreen() - Method in class org.sikuli.script.Screen
 
useFullscreen() - Method in class org.sikuli.script.ScreenUnion
 
UseImageFinder - Static variable in class org.sikuli.basics.Settings
 
useLibsProvided - Variable in class org.sikuli.script.RunTime
 
user(String, Object...) - Static method in class org.sikuli.basics.Debug
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
userCapture(String) - Method in class org.sikuli.android.ADBScreen
 
userCapture(String) - Method in interface org.sikuli.script.IScreen
 
userCapture() - Method in class org.sikuli.script.Screen
interactive capture with predefined message: lets the user capture a screen image using the mouse to draw the rectangle
userCapture(String) - Method in class org.sikuli.script.Screen
interactive capture with given message: lets the user capture a screen image using the mouse to draw the rectangle
userCapture(String) - Method in class org.sikuli.vnc.VNCScreen
 
UserLogPrefix - Static variable in class org.sikuli.basics.Settings
 
UserLogs - Static variable in class org.sikuli.basics.Settings
 
UserLogTime - Static variable in class org.sikuli.basics.Settings
 
userName - Variable in class org.sikuli.script.RunTime
 

V

valueOf(String) - Static method in enum org.sikuli.basics.OS
Deprecated.
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.sikuli.guide.Visual.Layout
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.sikuli.script.App.Type
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.sikuli.script.FindFailedResponse
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.sikuli.script.IRobot.KeyMode
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.sikuli.script.ObserveEvent.Type
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.sikuli.script.Observer.State
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.sikuli.script.RunTime.Type
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.sikuli.script.TextRecognizer.ListTextMode
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.sikuli.util.CommandArgsEnum
Returns the enum constant of this type with the specified name.
values() - Static method in enum org.sikuli.basics.OS
Deprecated.
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.sikuli.guide.Visual.Layout
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.sikuli.script.App.Type
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.sikuli.script.FindFailedResponse
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.sikuli.script.IRobot.KeyMode
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.sikuli.script.ObserveEvent.Type
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.sikuli.script.Observer.State
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.sikuli.script.RunTime.Type
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.sikuli.script.TextRecognizer.ListTextMode
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.sikuli.util.CommandArgsEnum
Returns an array containing the constants of this enum type, in the order they are declared.
vanished(ObserveEvent) - Method in class org.sikuli.script.ObserverCallBack
 
vanished(ObserveEvent) - Method in class org.sikuli.script.SikuliEventAdapter
Deprecated.
 
VDictProxy<T> - Class in org.sikuli.basics
 
VDictProxy() - Constructor for class org.sikuli.basics.VDictProxy
 
VERTICAL - Static variable in class org.sikuli.basics.PreferencesUser
 
VERTICAL - Static variable in class org.sikuli.guide.SxArea
 
VerticalComparator - Class in org.sikuli.script.compare
Compares the Regions by y-position.
VerticalComparator() - Constructor for class org.sikuli.script.compare.VerticalComparator
 
virtual(Rectangle) - Static method in class org.sikuli.script.Region
INTERNAL USE - EXPERIMENTAL if true: this region is not bound to any screen
Vision - Class in org.sikuli.natives
 
Vision(long, boolean) - Constructor for class org.sikuli.natives.Vision
 
Vision() - Constructor for class org.sikuli.natives.Vision
 
Vision_compare(long, Mat, long, Mat) - Static method in class org.sikuli.natives.VisionProxyJNI
 
Vision_createMat(int, int, byte[]) - Static method in class org.sikuli.natives.VisionProxyJNI
 
Vision_find(long, FindInput) - Static method in class org.sikuli.natives.VisionProxyJNI
 
Vision_findChanges(long, FindInput) - Static method in class org.sikuli.natives.VisionProxyJNI
 
Vision_getParameter(String) - Static method in class org.sikuli.natives.VisionProxyJNI
 
Vision_getSParameter(String) - Static method in class org.sikuli.natives.VisionProxyJNI
 
Vision_initOCR(String) - Static method in class org.sikuli.natives.VisionProxyJNI
 
Vision_recognize(long, Mat) - Static method in class org.sikuli.natives.VisionProxyJNI
 
Vision_recognize_as_ocrtext(long, Mat) - Static method in class org.sikuli.natives.VisionProxyJNI
 
Vision_recognizeWord(long, Mat) - Static method in class org.sikuli.natives.VisionProxyJNI
 
Vision_setParameter(String, float) - Static method in class org.sikuli.natives.VisionProxyJNI
 
Vision_setSParameter(String, String) - Static method in class org.sikuli.natives.VisionProxyJNI
 
VisionProxy - Class in org.sikuli.natives
 
VisionProxy() - Constructor for class org.sikuli.natives.VisionProxy
 
VisionProxyJNI - Class in org.sikuli.natives
 
VisionProxyJNI() - Constructor for class org.sikuli.natives.VisionProxyJNI
 
Visual - Class in org.sikuli.guide
 
Visual() - Constructor for class org.sikuli.guide.Visual
 
Visual.Layout - Enum in org.sikuli.guide
 
VNCScreen - Class in org.sikuli.vnc
 

W

w - Variable in class org.sikuli.script.Region
Width of the Region
w - Variable in class org.sikuli.script.ScreenImage
x, y, w, h of the stored ROI
wait(Object...) - Static method in class org.sikuli.script.Commands
wait for the given visual to appear within the given wait time
args [String|Pattern|Double, [Double, [Float]]] (max 3 args)
arg1: String/Pattern to search or double time to wait (rest ignored)
arg2: time to wait in seconds
arg3: minimum similarity to use for search (overwrites Pattern setting)
wait(double) - Method in class org.sikuli.script.Region
WARNING: wait(long timeout) is taken by Java Object as final.
wait(PSI) - Method in class org.sikuli.script.Region
Waits for the Pattern, String or Image to appear until the AutoWaitTimeout value is exceeded.
wait(PSI, double) - Method in class org.sikuli.script.Region
Waits for the Pattern, String or Image to appear or timeout (in second) is passed
waitAfterAction - Variable in class org.sikuli.android.ADBScreen
 
WaitAfterHighlight - Static variable in class org.sikuli.basics.Settings
 
waitForIdle() - Method in class org.sikuli.android.ADBRobot
 
waitForIdle() - Method in interface org.sikuli.script.IRobot
 
waitForIdle() - Method in class org.sikuli.util.FakeRobot
 
waitForTransition(Transition.TransitionListener) - Method in class org.sikuli.guide.ClickableWindow
 
waitForTransition(Transition.TransitionListener) - Method in class org.sikuli.guide.SxBeam
 
waitForTransition(Transition.TransitionListener) - Method in class org.sikuli.guide.SxMagnet
 
waitForTransition(Transition.TransitionListener) - Method in class org.sikuli.guide.TimeoutTransition
 
waitForTransition(Transition.TransitionListener) - Method in interface org.sikuli.guide.Transition
 
waitForTransition(Transition.TransitionListener) - Method in class org.sikuli.guide.TransitionDialog
 
waitForWindow() - Method in class org.sikuli.script.App
 
waitForWindow(int) - Method in class org.sikuli.script.App
 
waitPrompt - Variable in class org.sikuli.script.Screen
 
WaitScanRate - Static variable in class org.sikuli.basics.Settings
 
waitVanish(Object...) - Static method in class org.sikuli.script.Commands
wait for the given visual to vanish within the given wait time
waitVanish(PSI) - Method in class org.sikuli.script.Region
waits until target vanishes or timeout (in seconds) is passed (AutoWaitTimeout)
waitVanish(PSI, double) - Method in class org.sikuli.script.Region
waits until target vanishes or timeout (in seconds) is passed
wakeUp(int) - Method in class org.sikuli.android.ADBDevice
 
wakeUp(int) - Method in class org.sikuli.android.ADBScreen
 
wasRecaptured - Variable in class org.sikuli.script.Image
 
WEST - Static variable in class org.sikuli.script.Region
 
WEST_MID - Static variable in class org.sikuli.script.Region
 
WEST_NORTH - Static variable in class org.sikuli.script.Region
 
WEST_SOUTH - Static variable in class org.sikuli.script.Region
 
WH - Static variable in class org.sikuli.script.Region
 
wheel(int, int) - Static method in class org.sikuli.script.Mouse
move mouse using mouse wheel in the given direction the given steps
the result is system dependent
wheel(int, int, Region) - Static method in class org.sikuli.script.Mouse
 
wheel(int, int, Region, int) - Static method in class org.sikuli.script.Mouse
 
wheel(int, int) - Method in class org.sikuli.script.Region
Move the wheel at the current mouse position
the given steps in the given direction:
Button.WHEEL_DOWN, Button.WHEEL_UP
wheel(PFRML, int, int) - Method in class org.sikuli.script.Region
move the mouse pointer to the given target location
and move the wheel the given steps in the given direction:
Button.WHEEL_DOWN, Button.WHEEL_UP
wheel(PFRML, int, int, int) - Method in class org.sikuli.script.Region
move the mouse pointer to the given target location
and move the wheel the given steps in the given direction:
Button.WHEEL_DOWN, Button.WHEEL_UP
WHEEL_DOWN - Static variable in class org.sikuli.script.Button
 
WHEEL_DOWN - Static variable in class org.sikuli.script.Mouse
 
WHEEL_STEP_DELAY - Static variable in class org.sikuli.script.Mouse
 
WHEEL_UP - Static variable in class org.sikuli.script.Button
 
WHEEL_UP - Static variable in class org.sikuli.script.Mouse
 
WIN - Static variable in class org.sikuli.script.Key
 
WIN - Static variable in class org.sikuli.script.KeyModifier
 
window - Variable in class org.sikuli.script.App.AppEntry
 
window() - Method in class org.sikuli.script.App
evaluates the region currently occupied by the topmost window of this App instance.
window(int) - Method in class org.sikuli.script.App
evaluates the region currently occupied by the window with the given number of this App instance.
WindowsHotkeyManager - Class in org.sikuli.basics
 
WindowsHotkeyManager() - Constructor for class org.sikuli.basics.WindowsHotkeyManager
 
WinKernel32() - Constructor for class org.sikuli.util.SysJNA.WinKernel32
 
WinUser32() - Constructor for class org.sikuli.util.SysJNA.WinUser32
 
WinUtil - Class in org.sikuli.natives
 
WinUtil() - Constructor for class org.sikuli.natives.WinUtil
 
WM - Static variable in class org.sikuli.script.Region
 
WN - Static variable in class org.sikuli.script.Region
 
write(Object...) - Static method in class org.sikuli.script.Commands
just doing a currentRegion.write(text) (see write())
write(String) - Method in class org.sikuli.script.Region
Compact alternative for type() with more options
- special keys and options are coded as #XN.
writeStringToFile(String, String) - Static method in class org.sikuli.basics.FileManager
 
writeStringToFile(String, File) - Static method in class org.sikuli.basics.FileManager
 
WS - Static variable in class org.sikuli.script.Region
 

X

x - Variable in class org.sikuli.script.Location
 
x - Variable in class org.sikuli.script.Region
X-coordinate of the Region
x - Variable in class org.sikuli.script.ScreenImage
x, y, w, h of the stored ROI
xcopy(File, File) - Static method in class org.sikuli.basics.FileManager
 
xcopy(File, File, FileManager.FileFilter) - Static method in class org.sikuli.basics.FileManager
 
xcopy(String, String) - Static method in class org.sikuli.basics.FileManager
 
xcopy(String, String, FileManager.FileFilter) - Static method in class org.sikuli.basics.FileManager
 

Y

y - Variable in class org.sikuli.script.Location
 
y - Variable in class org.sikuli.script.Region
Y-coordinate of the Region
y - Variable in class org.sikuli.script.ScreenImage
x, y, w, h of the stored ROI
yes - Static variable in class org.sikuli.basics.PreferencesUser
 

_

_addHotkey(int, int, HotkeyListener) - Method in class org.sikuli.basics.HotkeyManager
 
_addHotkey(int, int, HotkeyListener) - Method in class org.sikuli.basics.LinuxHotkeyManager
 
_addHotkey(int, int, HotkeyListener) - Method in class org.sikuli.basics.MacHotkeyManager
 
_addHotkey(int, int, HotkeyListener) - Method in class org.sikuli.basics.WindowsHotkeyManager
 
_begin_time - Variable in class org.sikuli.basics.AnimatorPulse
 
_beginVal - Variable in class org.sikuli.basics.AnimatorTimeValueFunction
 
_endVal - Variable in class org.sikuli.basics.AnimatorTimeValueFunction
 
_filename - Variable in class org.sikuli.script.ScreenImage
 
_img - Variable in class org.sikuli.script.ScreenImage
 
_insert(long, String, int) - Method in class org.sikuli.basics.VDictProxy
 
_interval - Variable in class org.sikuli.basics.AnimatorPulse
 
_name - Variable in exception org.sikuli.script.SikuliException
 
_openApp(String) - Static method in class org.sikuli.natives.MacUtil
 
_removeHotkey(int, int) - Method in class org.sikuli.basics.HotkeyManager
 
_removeHotkey(int, int) - Method in class org.sikuli.basics.LinuxHotkeyManager
 
_removeHotkey(int, int) - Method in class org.sikuli.basics.MacHotkeyManager
 
_removeHotkey(int, int) - Method in class org.sikuli.basics.WindowsHotkeyManager
 
_roi - Variable in class org.sikuli.script.ScreenImage
 
_running - Variable in class org.sikuli.basics.AnimatorPulse
 
_totalMS - Variable in class org.sikuli.basics.AnimatorPulse
 
_totalTime - Variable in class org.sikuli.basics.AnimatorTimeValueFunction
 
_v1 - Variable in class org.sikuli.basics.AnimatorPulse
 
_v2 - Variable in class org.sikuli.basics.AnimatorPulse
 
A B C D E F G H I J K L M N O P R S T U V W X Y _ 
Skip navigation links