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
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
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
 
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(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
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)
addJar(String, String) - Static method in class org.sikuli.script.ImagePath
 
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
ALT - Static variable in class org.sikuli.script.Key
 
ALTGR - Static variable in class org.sikuli.script.Key
 
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
 
appeared(ObserveEvent) - Method in class org.sikuli.script.ObserverCallBack
 
AppEntry(String, String, String, String, String) - Constructor for class org.sikuli.script.App.AppEntry
 
appPathMac - Static variable in class org.sikuli.basics.Settings
 
as(int) - Static method in class org.sikuli.script.Screen
 
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
AutoWaitTimeout - Static variable in class org.sikuli.basics.Settings
 

B

BACKSPACE - Static variable in class org.sikuli.script.Key
 
BB - Static variable in class org.sikuli.script.Region
 
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
BH - Static variable in class org.sikuli.script.Region
 
BL - Static variable in class org.sikuli.script.Region
 
BM - Static variable in class org.sikuli.script.Region
 
BR - Static variable in class org.sikuli.script.Region
 
breakPoint - Static variable in class org.sikuli.basics.Settings
 
BundlePath - Static variable in class org.sikuli.basics.Settings
 
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
 

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
 
CAPS_LOCK - Static variable in class org.sikuli.script.Key
 
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
captureforHighlight(int, int, int, int) - Method in class org.sikuli.script.Screen
 
CH - Static variable in class org.sikuli.script.Region
 
changed(ObserveEvent) - Method in class org.sikuli.script.ObserverCallBack
 
CheckLastSeen - Static variable in class org.sikuli.basics.Settings
 
CheckLastSeenSimilar - Static variable in class org.sikuli.basics.Settings
 
cleanUp() - Static method in class org.sikuli.script.Env
Deprecated.
 
clearCache(int) - Static method in class org.sikuli.script.Image
 
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() - 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
ClickDelay - Static variable in class org.sikuli.basics.Settings
Specify a delay between the mouse down and up in seconds as 0.nnn.
ClickFast - Static variable in class org.sikuli.basics.Settings
 
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
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
 
cmdCapture(Object...) - Method in class org.sikuli.script.Screen
 
cMin - Static variable in class org.sikuli.script.Key
 
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
 
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
 
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
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
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(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
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
createThumbNail(String) - Static method in class org.sikuli.script.Image
FOR INTERNAL USE: from IDE - suppresses load error message
CTRL - Static variable in class org.sikuli.script.Key
 
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
 
DebugLogs - Static variable in class org.sikuli.basics.Settings
 
DECIMAL - Static variable in class org.sikuli.script.Key
 
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()
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.script.Image
 
DELETE - Static variable in class org.sikuli.script.Key
 
destroy() - Method in class org.sikuli.script.Finder
to explicitly free the Finder's resources
DIVIDE - Static variable in class org.sikuli.script.Key
 
doPrompt(String, EventObserver) - Static method in class org.sikuli.script.Screen
 
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
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
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
 

E

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
 
EH - Static variable in class org.sikuli.script.Region
 
EM - Static variable in class org.sikuli.script.Region
 
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
 
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.
 
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
 
error(String, Object...) - Static method in class org.sikuli.basics.Debug
Sikuli error messages
switch on/off: always on
ES - Static variable in class org.sikuli.script.Region
 
ESC - Static variable in class org.sikuli.script.Key
 
exact() - Method in class org.sikuli.script.Pattern
sets the minimum Similarity to 0.99 which means exact match
execName - Variable in class org.sikuli.script.App.AppEntry
 
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
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
 

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
 
FALSE - Static variable in class org.sikuli.basics.Settings
 
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(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(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
 
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
 
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
 
FindProfiling - Static variable in class org.sikuli.basics.Settings
 
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, 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
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
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)

G

get() - Method in class org.sikuli.script.Image
return the image's BufferedImage (load it if not in cache)
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.
getApps(String) - Static method in class org.sikuli.script.App
 
getApps() - Static method in class org.sikuli.script.App
 
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.script.Screen
 
getBounds(int) - Static method in class org.sikuli.script.Screen
 
getBundleFolder() - Static method in class org.sikuli.script.ImagePath
no trailing path separator
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
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.script.Region
 
getChanges() - Method in class org.sikuli.script.ObserveEvent
 
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
negative counts reverse from the end (last is -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
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
 
getCount() - Method in class org.sikuli.script.ObserveEvent
 
getcurrentID() - Method in class org.sikuli.script.Screen
 
getDebugLevel() - Static method in class org.sikuli.basics.Debug
 
getEvent(String) - Method in class org.sikuli.script.Region
the event is removed from the list
getEvents() - Method in class org.sikuli.script.Region
the region's events are removed from the list
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
 
getGlobalRobot() - Static method in class org.sikuli.script.Screen
 
getGroup() - Method in class org.sikuli.script.Image
 
getH() - Method in class org.sikuli.script.Region
 
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
getID() - Method in class org.sikuli.script.Screen
 
getIDEshouldReload() - Static method in class org.sikuli.script.Image
 
getIdFromPoint(int, int) - Method in class org.sikuli.script.Screen
INTERNAL USE: to be compatible with ScreenUnion
getIDString() - Method in class org.sikuli.script.Region
INTERNAL USE ONLY
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
getImageMissingHandler() - Static method in exception org.sikuli.script.FindFailed
 
getImageName() - Method in class org.sikuli.script.Image
 
getIndex() - Method in class org.sikuli.script.Match
 
getInstallBase() - Static method in class org.sikuli.basics.Settings
Deprecated.
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
getLastScreenImage() - Method in class org.sikuli.script.Region
get the last image taken on this regions screen
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.script.Screen
 
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
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
 
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.
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() - 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
 
getNumberScreens() - Static method in class org.sikuli.script.Screen
 
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
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.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
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.script.ObserveEvent
 
getPID() - Method in class org.sikuli.script.App
 
getPoint() - Method in class org.sikuli.script.Location
get as AWT point
getPrimaryId() - Static method in class org.sikuli.script.Screen
 
getPrimaryScreen() - Static method in class org.sikuli.script.Screen
 
getRect() - Method in class org.sikuli.script.Region
 
getRegion() - Method in class org.sikuli.script.ObserveEvent
 
getRegion() - Method in class org.sikuli.script.ScreenImage
 
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(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.
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
negative counts reverse from the end (last is -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.script.Match
the match score
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.Screen
getScreen(int) - Static method in class org.sikuli.script.Screen
 
getScreenContaining() - Method in class org.sikuli.script.Region
Deprecated.
Only for compatibility, to get the screen containing this region, use Region.getScreen()
getSeparator() - Static method in class org.sikuli.script.Env
Deprecated.
use Settings.getPathSeparator() ... instead
getShortOS() - Static method in class org.sikuli.basics.Settings
 
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.script.Image
Get the value of similarity
getSize() - Method in class org.sikuli.script.Image
 
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
 
getTarget() - Method in class org.sikuli.script.Match
convenience method
getTarget() - Method in class org.sikuli.script.Region
convenience method
getTargetOffset() - Method in class org.sikuli.script.Match
convenience - same as Pattern.getTargetOffset()
getTargetOffset() - Method in class org.sikuli.script.Pattern
 
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
 
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
 
getUserExtPath() - Static method in class org.sikuli.basics.Settings
 
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)
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
 
getWindow() - Method in class org.sikuli.script.App
 
getX() - Method in class org.sikuli.script.Location
 
getX() - Method in class org.sikuli.script.Region
 
getY() - Method in class org.sikuli.script.Location
 
getY() - Method in class org.sikuli.script.Region
 
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.

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
 
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
 
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)
hasPrompt() - Method in class org.sikuli.script.Screen
 
hasWindow() - Method in class org.sikuli.script.App
 
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
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
 
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

ignorePrimaryAtCapture - Static variable in class org.sikuli.script.Screen
 
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
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
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.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
 
initScreen(IScreen) - Method in class org.sikuli.script.Region
INTERNAL USE
initScreen(Screen) - Method in class org.sikuli.script.Screen
 
InputFontMono - Static variable in class org.sikuli.basics.Settings
 
InputFontSize - Static variable in class org.sikuli.basics.Settings
 
INSERT - Static variable in class org.sikuli.script.Key
 
inside() - Method in class org.sikuli.script.Region
Deprecated.
only for backward compatibility
intersection(Region) - Method in class org.sikuli.script.Region
create a region that is the intersection of the given regions
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
 
isAppear() - Method in class org.sikuli.script.ObserveEvent
check the observe event type
isBundled() - Method in class org.sikuli.script.Image
INTERNAL USE: image is contained in a bundle (.sikuli)
isChange() - Method in class org.sikuli.script.ObserveEvent
check the observe event type
isFile() - Method in class org.sikuli.script.Image
 
isFile() - Method in class org.sikuli.script.ImagePath.PathEntry
 
isFindFailed() - Method in class org.sikuli.script.ObserveEvent
check the observe event type
isGeneric() - Method in class org.sikuli.script.ObserveEvent
check the observe event type
isHTTP() - Method in class org.sikuli.script.ImagePath.PathEntry
 
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
isJar() - Method in class org.sikuli.script.ImagePath.PathEntry
 
isJava6() - Static method in class org.sikuli.basics.Settings
 
isJava7() - Static method in class org.sikuli.basics.Settings
 
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
 
ISNOTSUPPORTED - Static variable in class org.sikuli.basics.Settings
 
isObserving() - Method in class org.sikuli.script.Region
 
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
isPattern() - Method in class org.sikuli.script.Image
true if this image contains pattern aspects
only useable with the new ImageFinder
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
 
isRepeatable(String) - Static method in class org.sikuli.script.Key
 
isRunning() - Method in class org.sikuli.script.App
 
isRunning(int) - Method in class org.sikuli.script.App
 
isRunningIDE - Static variable in class org.sikuli.basics.Settings
 
isShowActions() - Static method in class org.sikuli.basics.Settings
 
isText() - Method in class org.sikuli.script.Image
 
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.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.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
isValidImageFilename(String) - Static method in class org.sikuli.basics.Settings
 
isVanish() - Method in class org.sikuli.script.ObserveEvent
check the observe event type
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

J

JavaArch - Static variable in class org.sikuli.basics.Settings
 
JavaVersion - Static variable in class org.sikuli.basics.Settings
 
JREVersion - Static variable in class org.sikuli.basics.Settings
 

K

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
 
keyboardUS - Static variable in class org.sikuli.script.Key
 
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
keyMaxLength - Static variable in class org.sikuli.script.Key
 
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) )

L

lap(String) - Method in class org.sikuli.basics.Debug
lap timer and print message with timer message
log output depends on Settings.ProfileLogs
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
 
LB - Static variable in class org.sikuli.script.Region
 
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
LH - Static variable in class org.sikuli.script.Region
 
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 ...
LL - Static variable in class org.sikuli.script.Region
 
LM - Static variable in class org.sikuli.script.Region
 
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
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
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
 
makeAppEntry() - Method in class org.sikuli.script.App
 
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
META - Static variable in class org.sikuli.script.Key
 
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.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
 
MM - Static variable in class org.sikuli.script.Region
 
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.
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
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
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
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
moveFor(int, int) - Method in class org.sikuli.script.Location
MoveMouseDelay - Static variable in class org.sikuli.basics.Settings
 
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
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.script.Screen
creates a region on the current screen with the given coordinate/size.
next() - Method in class org.sikuli.script.Finder
 
NEXT - Static variable in class org.sikuli.script.Key
 
NH - Static variable in class org.sikuli.script.Region
 
NM - Static variable in class org.sikuli.script.Region
 
noPupUps - Static variable in class org.sikuli.basics.Settings
 
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()
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.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
observeInBackground() - Method in class org.sikuli.script.Region
start an observer in this region that runs in background forever - 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
 
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
 
OcrDataPath - Static variable in class org.sikuli.basics.Settings
location of folder Tessdata
OcrLanguage - Static variable in class org.sikuli.basics.Settings
 
OcrTextRead - Static variable in class org.sikuli.basics.Settings
 
OcrTextSearch - Static variable in class org.sikuli.basics.Settings
 
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
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
 
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) - 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.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
openLink(String) - Static method in class org.sikuli.script.App
 
options - Variable in class org.sikuli.script.App.AppEntry
 
org.sikuli.basics - package org.sikuli.basics
 
org.sikuli.script - package org.sikuli.script
 
out(String) - Static method in class org.sikuli.basics.Debug
 
OverwriteImages - Static variable in class org.sikuli.basics.Settings
 

P

PAGE_DOWN - Static variable in class org.sikuli.script.Key
 
PAGE_UP - Static variable in class org.sikuli.script.Key
 
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
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
 
pid - Variable in class org.sikuli.script.App.AppEntry
 
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
 
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
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

R

RB - Static variable in class org.sikuli.script.Region
 
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
reload(String) - Static method in class org.sikuli.script.Image
 
remove() - Method in class org.sikuli.script.Finder
not used
remove() - Method in class org.sikuli.script.Image
 
remove(String) - Static method in class org.sikuli.script.ImagePath
remove entry with given path (same as given with add)
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
 
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)
RepeatWaitTime - Static variable in class org.sikuli.basics.Settings
 
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
 
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.
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
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 - 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() - 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
RM - Static variable in class org.sikuli.script.Region
 
RobotFake - Static variable in class org.sikuli.basics.Settings
 
RR - Static variable in class org.sikuli.script.Region
 
RT - Static variable in class org.sikuli.script.Region
 
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).
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
 

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)
saveCapture(String) - Method in class org.sikuli.script.Screen
 
saveCapture(String, Region) - Method in class org.sikuli.script.Screen
 
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
 
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
 
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).
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
SCROLL_LOCK - Static variable in class org.sikuli.script.Key
 
SE - Static variable in class org.sikuli.script.Region
 
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
SEPARATOR - Static variable in class org.sikuli.script.Key
 
setActive(String) - Method in class org.sikuli.script.Region
set the observer with the given name active (checked while observing)
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
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
setBImage(BufferedImage) - Method in class org.sikuli.script.Pattern
ONLY FOR INTERNAL USE! Might vanish without notice!
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.ImagePath
the given path replaces bundlepath (entry 0) and Settings.bundlePath is set to given path
setCenter(Location) - Method in class org.sikuli.script.Region
Moves the region to the area, whose center is the given location
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
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()
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)
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
 
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)
setGroup(ImageGroup) - Method in class org.sikuli.script.Image
set the ImageGroup this image should belong to
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
 
setIDEshouldReload(Image) - Static method in class org.sikuli.script.Image
 
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.Region
set the observer with the given name inactive (not checked while observing)
setIndex(int) - Method in class org.sikuli.script.Match
 
setIsAbsolute(boolean) - Method in class org.sikuli.script.Image
 
setIsPattern(boolean) - Method in class org.sikuli.script.Image
 
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
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
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
 
setObserveScanRate(float) - Method in class org.sikuli.script.Region
set the regions individual ObserveScanRate
setOffset(Location) - Method in class org.sikuli.script.Image
Set the value of offset
setOnScreen(boolean) - Method in class org.sikuli.script.Match
 
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
setPattern(Object) - Method in class org.sikuli.script.ObserveEvent
 
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()
adjusted to a minimum cell size of 5 x 5 pixels
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
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
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
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
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
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()
setShowActions(boolean) - Static method in class org.sikuli.basics.Settings
 
setSimilarity(float) - Method in class org.sikuli.script.Image
Set the value of similarity
setSize(int, int) - Method in class org.sikuli.script.Region
 
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
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
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
 
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
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
setUsing(String) - Method in class org.sikuli.script.App
 
setVirtual(boolean) - Method in class org.sikuli.script.Region
INTERNAL USE - EXPERIMENTAL
setW(int) - Method in class org.sikuli.script.Region
 
setWaitAfter(int) - Method in class org.sikuli.script.Image
Set the value of waitAfter
setWaitScanRate(float) - Method in class org.sikuli.script.Region
set the regions individual WaitScanRate
setX(int) - Method in class org.sikuli.script.Region
 
setY(int) - Method in class org.sikuli.script.Region
 
SH - Static variable in class org.sikuli.script.Region
 
SHIFT - Static variable in class org.sikuli.script.Key
 
shouldHighlight() - Static method in class org.sikuli.basics.Debug
 
shouldLogJython - Static variable in class org.sikuli.basics.Debug
 
showMonitors() - Static method in class org.sikuli.script.Screen
show the current monitor setup
showScreens() - Method in class org.sikuli.script.Region
synonym for showMonitors
showTarget(Location) - Method in class org.sikuli.script.Screen
 
SIKULI_LIB - Static variable in class org.sikuli.basics.Settings
Resource types to be used with IResourceLoader implementations
SikuliVersion - Static variable in class org.sikuli.script.Env
Deprecated.
use Settings.getVersion() instead
similar(float) - Method in class org.sikuli.script.Pattern
sets the minimum Similarity to use with findX
SKIP - Static variable in exception org.sikuli.script.FindFailed
FindFailedResponse SKIP: should silently continue on FindFailed
SlowMotionDelay - Static variable in class org.sikuli.basics.Settings
 
SM - Static variable in class org.sikuli.script.Region
 
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
 
start(App.Type) - Static method in class org.sikuli.script.App
 
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
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
SW - Static variable in class org.sikuli.script.Region
 

T

TAB - Static variable in class org.sikuli.script.Key
 
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
test(String, Object...) - Static method in class org.sikuli.basics.Debug
Sikuli messages to use in tests
switch on/off: always on
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
TH - Static variable in class org.sikuli.script.Region
 
ThrowException - Static variable in class org.sikuli.basics.Settings
 
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
 
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.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
 
toStringShort() - Method in class org.sikuli.script.App
 
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()
TR - Static variable in class org.sikuli.script.Region
 
TraceLogs - Static variable in class org.sikuli.basics.Settings
 
translate(int, int) - Method in class org.sikuli.script.Location
convenience: like awt point
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)
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
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
TypeDelay - Static variable in class org.sikuli.basics.Settings
Specify a delay between the key presses in seconds as 0.nnn.

U

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
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
UseImageFinder - Static variable in class org.sikuli.basics.Settings
 
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() - 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
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
 

V

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.ObserveEvent.Type
Returns the enum constant of this type with the specified name.
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.ObserveEvent.Type
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
 
virtual(Rectangle) - Static method in class org.sikuli.script.Region
INTERNAL USE - EXPERIMENTAL if true: this region is not bound to any screen

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(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
WaitAfterHighlight - Static variable in class org.sikuli.basics.Settings
 
waitForWindow() - Method in class org.sikuli.script.App
 
waitForWindow(int) - Method in class org.sikuli.script.App
 
WaitScanRate - Static variable in class org.sikuli.basics.Settings
 
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
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) - 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
 
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.
WM - Static variable in class org.sikuli.script.Region
 
WN - Static variable in class org.sikuli.script.Region
 
write(String) - Method in class org.sikuli.script.Region
Compact alternative for type() with more options
- special keys and options are coded as #XN.
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

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
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