A B C D E F G H I K L M N O P Q R S T U V W X Y
All Classes All Packages
All Classes All Packages
All Classes All Packages
A
- ABORT - Static variable in exception org.sikuli.script.FindFailed
-
FindFailedResponse ABORT: should abort the SikuliX application
- above() - Method in class org.sikuli.script.Region
-
create a region above the top side with same width.
- 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(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.
- 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(int, int, int, int) - Method in class org.sikuli.script.Region
-
resize the region using the given padding values.
- 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(Location) - Method in class org.sikuli.script.Region
-
extend the region, so it contains the given point.
- add(Region) - Method in class org.sikuli.script.Region
-
extend the region, so it contains the given region.
- ADD - Static variable in class org.sikuli.script.Key
- addHotkey(char, 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.Key
-
add a hotkey and listener
- addHotkey(String, 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
- 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
- aKey(int) - Method in class org.sikuli.script.Region
- 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
- AlwaysResize - Static variable in class org.sikuli.basics.Settings
- App - Class in org.sikuli.script
-
App implements features to manage (open, switch to, close) applications.
- App() - Constructor for class org.sikuli.script.App
- App(String) - Constructor for class org.sikuli.script.App
- App.Type - Enum in org.sikuli.script
- APPEAR - org.sikuli.script.ObserveEvent.Type
- appeared(ObserveEvent) - Method in class org.sikuli.script.ObserverCallBack
-
to be overwritten to handle appear events
- asChar() - Method in class org.sikuli.script.OCR.Options
-
Configure Options to recognize a single character.
- asLine() - Method in class org.sikuli.script.OCR.Options
-
Configure Options to recognize a single line.
- asList() - Method in class org.sikuli.script.Finder
- asList() - Method in class org.sikuli.script.Match
- asMatch() - Method in class org.sikuli.script.Finder
- asMatch() - Method in class org.sikuli.script.Match
- 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
- asRegEx(String) - Static method in class org.sikuli.script.Finder
- aSwipe(PFRML, PFRML) - Method in class org.sikuli.script.Region
- aSwipeDown() - Method in class org.sikuli.script.Region
- aSwipeLeft() - Method in class org.sikuli.script.Region
- aSwipeRight() - Method in class org.sikuli.script.Region
- aSwipeUp() - Method in class org.sikuli.script.Region
- asWord() - Method in class org.sikuli.script.OCR.Options
-
Configure Options to recognize a single word.
- at() - Static method in class org.sikuli.script.Mouse
- aTap(PFRML) - Method in class org.sikuli.script.Region
- atMouse() - Static method in class org.sikuli.script.Region
-
Deprecated.use
Mouse.at()
instead - AUTO - org.sikuli.script.OCR.PSM
- AUTO_ONLY - org.sikuli.script.OCR.PSM
- AUTO_OSD - org.sikuli.script.OCR.PSM
- AutoDetectKeyboardLayout - Static variable in class org.sikuli.basics.Settings
- 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() - Method in class org.sikuli.script.Region
-
create a region below the bottom side with same width.
- 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(int) - Method in class org.sikuli.script.Region
-
create a region below the bottom side with same width and given height.
- belowAt() - Method in class org.sikuli.script.Region
- belowAt(int) - Method in class org.sikuli.script.Region
-
positive offset goes towards bottom of screen.
- bestDPI(int) - Method in class org.sikuli.script.OCR.Options
-
INTERNAL: (under investigation).
- 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
- bottom(Number...) - Method in class org.sikuli.script.Region
-
At the bottom a new Region with same width is created.
- BOTTOM - Static variable in class org.sikuli.script.Region
-
Flag for the
Region.create(Location, int, int, int, int)
method. - bottomLeft(Number...) - Method in class org.sikuli.script.Region
-
In the bottom left corner a new Region is created.
- bottomMiddle(Number...) - Method in class org.sikuli.script.Region
-
In the bottom middle a new Region is created.
- bottomRight(Number...) - Method in class org.sikuli.script.Region
-
In the bottom right corner a new Region is created.
- BR - Static variable in class org.sikuli.script.Region
- BROWSER - org.sikuli.script.App.Type
- 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
- 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_NUM_LOCK - 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_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
- C2 - Static variable in class org.sikuli.script.Region
- 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
- CH - Static variable in class org.sikuli.script.Region
- CHANGE - org.sikuli.script.ObserveEvent.Type
- changed(ObserveEvent) - Method in class org.sikuli.script.ObserverCallBack
-
to be overwritten to handle changed events
- CheckLastSeen - Static variable in class org.sikuli.basics.Settings
- CheckLastSeenSimilar - Static variable in class org.sikuli.basics.Settings
- checkMousePosition - Static variable in class org.sikuli.basics.Settings
- CIRCLE_WORD - org.sikuli.script.OCR.PSM
- 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 ... - ClickDelay - Static variable in class org.sikuli.basics.Settings
-
Specify a delay between the mouse down and up in seconds as 0.nnn.
- ClickTypeHack - Static variable in class org.sikuli.basics.Settings
- clone() - Method in class org.sikuli.script.OCR.Options
-
makes a copy of this Options
- close() - Method in class org.sikuli.script.App
-
tries to close the app defined by this App instance, waits max 10 seconds for the app to no longer be running
- close(int) - Method in class org.sikuli.script.App
-
tries to close the app defined by this App instance, waits max given seconds for the app to no longer be running
- 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
- closeByKey() - Method in class org.sikuli.script.App
- closeByKey(int) - Method in class org.sikuli.script.App
- 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
- compareTo(Location) - Method in class org.sikuli.script.Location
- compareTo(Match) - Method in class org.sikuli.script.Match
- configs() - Method in class org.sikuli.script.OCR.Options
-
get current configs
- configs(String...) - Method in class org.sikuli.script.OCR.Options
-
set one ore more configs file names.
- configs(List<String>) - Method in class org.sikuli.script.OCR.Options
-
set a list of configs file names.
- 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
- 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(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.Location
-
New point 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(int, int, int, int) - Static method in class org.sikuli.script.Region
-
Create a region with the provided top left corner and size
- create(int, int, int, int, IScreen) - Static method in class org.sikuli.script.Region
-
Create a region with the provided top left corner and size
- create(Rectangle) - Static method in class org.sikuli.script.Region
-
Create a region from a Rectangle
- create(File) - Static method in class org.sikuli.script.Image
-
create a new image from the given file
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) - 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) - 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(Image) - Static method in class org.sikuli.script.Image
-
create a new Image as copy of the given Image
- 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.
- create(Match, IScreen) - Static method in class org.sikuli.script.Match
- create(Region) - Static method in class org.sikuli.script.Region
-
Create a region from another region including the region's settings
- createFromResult(Element, FindAttributes, Match, long[]) - Static method in class org.sikuli.script.Match
- 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
- createSubimage(BufferedImage, Rectangle) - Static method in class org.sikuli.script.Image
- CTRL - Static variable in class org.sikuli.script.Key
- CV - Static variable in class org.sikuli.script.Region
D
- dataPath() - Method in class org.sikuli.script.OCR.Options
-
get the current datapath in this Options.
- dataPath(String) - Method in class org.sikuli.script.OCR.Options
-
Set folder for Tesseract to find language and configs files.
- 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) - 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
- DEFAULT - org.sikuli.script.OCR.OEM
- DefaultHighlightColor - Static variable in class org.sikuli.basics.Settings
- DefaultHighlightTime - Static variable in class org.sikuli.basics.Settings
- DefaultPadding - Static variable in class org.sikuli.basics.Settings
- DelayAfterDrag - Static variable in class org.sikuli.basics.Settings
- 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
- 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 - Static variable in class org.sikuli.script.Key
- destroy() - Method in class org.sikuli.script.Finder
- DIVIDE - Static variable in class org.sikuli.script.Key
- doPrompt(String, EventObserver) - Static method in class org.sikuli.script.Screen
- doToString(boolean) - Method in class org.sikuli.script.Match
- 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.
- doubleClick(PFRML, Integer) - Method in class org.sikuli.script.Region
-
double click at the given target location.
- down(int) - Static method in class org.sikuli.script.Mouse
-
press and hold the given buttons
Button
- DOWN - Static variable in class org.sikuli.script.Key
- drag(PFRML) - Method in class org.sikuli.script.Region
-
Prepare a drag action: move mouse to given target.
- dragDrop(PFRML) - Method in class org.sikuli.script.Region
-
Drag from region's last match and drop at given target.
- dragDrop(PFRML, PFRML) - Method in class org.sikuli.script.Region
-
Drag from a position and drop to another using left mouse button.
- dropAt(PFRML) - Method in class org.sikuli.script.Region
-
finalize a drag action with a drop: move mouse to given target.
- dump() - Static method in class org.sikuli.script.Key
- dump(int) - Static method in class org.sikuli.script.ImagePath
-
print the list of path entries
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
- EDITOR - org.sikuli.script.App.Type
- 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 - Variable in class org.sikuli.script.ScreenImage
- 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
-
features moved to other classes, details below with the methods
- Env() - Constructor for class org.sikuli.script.Env
- 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
- equals(Object) - Method in class org.sikuli.script.ScreenImage
- 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
- exists(PSI, double) - Method in class org.sikuli.script.Region
-
Check if target exists with a specified timeout.
- existsFile() - Method in class org.sikuli.script.ImagePath.PathEntry
- existsText(String) - Method in class org.sikuli.script.Region
- existsText(String, double) - Method in class org.sikuli.script.Region
- 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(BufferedImage) - Method in class org.sikuli.script.Finder
-
do a find op with the given image in the Finder's image (hasNext() and next() will reveal possible match results)
- find(File) - 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(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(String) - Static method in class org.sikuli.script.ImagePath
- find(Image) - Method in class org.sikuli.script.Finder
-
do a find op with the given image 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(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(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(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(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.
- findAllList(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
- findAny(Object...) - Method in class org.sikuli.script.Region
- findAnyList(List<Object>) - Method in class org.sikuli.script.Region
- findChanges(Object) - Method in class org.sikuli.script.Finder
- Finder - Class in org.sikuli.script
- Finder(ScreenImage, Region) - Constructor for class org.sikuli.script.Finder
-
Finder for a Region on a ScreenImage
- Finder(RIBSM) - Constructor for class org.sikuli.script.Finder
-
Create a Finder for the given element
- findfailed(ObserveEvent) - Method in class org.sikuli.script.ObserverCallBack
-
to be overwritten to handle FindFailed events
- FindFailed - Exception in org.sikuli.script
-
SikuliX FindFailed exception
constants and settings for the features
FindFailedResponse
FindFailedHandler
ImageMissingHandler - FindFailed(String) - Constructor for exception org.sikuli.script.FindFailed
-
the exception
- FINDFAILED - org.sikuli.script.ObserveEvent.Type
- findLine(String) - Method in class org.sikuli.script.Finder
- findLines() - Method in class org.sikuli.script.Finder
- findLines(String) - Method in class org.sikuli.script.Finder
- 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) - Method in class org.sikuli.script.Region
- findWord(String) - Method in class org.sikuli.script.Finder
- findWords() - Method in class org.sikuli.script.Finder
- findWords(String) - Method in class org.sikuli.script.Finder
- focus() - Method in class org.sikuli.script.App
-
tries to make it the foreground application bringing its frontmost window to front
- focus(String) - Static method in class org.sikuli.script.App
-
tries to identify a running app with name or (part of) window title 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 or (part of) window title bringing its window with given index 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)
- fontSize(int) - Method in class org.sikuli.script.OCR.Options
-
Configure the image optimization.
- forEachRemaining(Consumer<? super Match>) - Method in class org.sikuli.script.Match
- FOREVER - Static variable in class org.sikuli.basics.Settings
G
- GENERIC - org.sikuli.script.ObserveEvent.Type
- get() - Static method in class org.sikuli.script.ImagePath
-
the path list as string array
- get(int) - Static method in class org.sikuli.script.Screen
- getApps() - Static method in class org.sikuli.script.App
- getApps(String) - Static method in class org.sikuli.script.App
- getBImage() - Method in class org.sikuli.script.Pattern
- 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
- getBufferedImage() - Method in class org.sikuli.script.ScreenImage
- getBundlePath() - Static method in class org.sikuli.script.ImagePath
-
no trailing path separator
- getCell(int, int) - Method in class org.sikuli.script.Region
-
get the specified cell counting from (0, 0), if a raster is setup.
- 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.Region
-
get the specified column counting from 0.
- 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.Region
- getColW() - Method in class org.sikuli.script.Region
- getContent() - Method in class org.sikuli.script.Region
- getContent() - Method in class org.sikuli.script.ScreenImage
- getCount() - Method in class org.sikuli.script.ObserveEvent
- getDataPath() - Static method in class org.sikuli.basics.Settings
- getDebugLevel() - Static method in class org.sikuli.basics.Debug
- getDefaultInstance4py() - Static method in class org.sikuli.script.Image
- getDefaultInstance4py() - Static method in class org.sikuli.script.Location
- getDefaultInstance4py() - Static method in class org.sikuli.script.Offset
- getDefaultInstance4py() - Static method in class org.sikuli.script.Region
-
INTERNAL: Get a default Region for Python
- getDefaultInstance4py() - Static method in class org.sikuli.script.Screen
- getDeviceDescription() - Method in class org.sikuli.script.Screen
- getEnd() - Method in class org.sikuli.script.ScreenImage
- 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
- getExec() - Method in class org.sikuli.script.App
- getFile() - Method in class org.sikuli.script.ImagePath.PathEntry
- 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 - getFilename() - Method in class org.sikuli.script.ScreenImage
-
Deprecated.use save() instead
- getFilePathSeperator() - Static method in class org.sikuli.basics.Settings
- getFindFailedHandler() - Static method in exception org.sikuli.script.FindFailed
- 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.Screen
- getImage() - Method in class org.sikuli.script.Location
- getImage() - Method in class org.sikuli.script.ObserveEvent
- getImage() - Method in class org.sikuli.script.Pattern
- getImage() - Method in class org.sikuli.script.Region
- 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
- getIndex() - Method in class org.sikuli.script.Match
- getInset(Region) - Method in class org.sikuli.script.Region
- 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
- getList() - Method in class org.sikuli.script.Finder
- getListFor(RI) - Method in class org.sikuli.script.Finder
- getMask() - Method in class org.sikuli.script.Image
- getMask() - Method in class org.sikuli.script.Pattern
- getMatch() - Method in class org.sikuli.script.ObserveEvent
- getMonitor() - Method in class org.sikuli.script.Screen
- getMonitorBounds() - Static method in class org.sikuli.script.Screen
- getMonitorBounds(int) - Static method in class org.sikuli.script.Screen
- getMonitorCount() - Static method in class org.sikuli.script.Screen
- getMonitorRobot(int) - Static method in class org.sikuli.script.Screen
- 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.ObserveEvent
- getNameAsText() - Method in class org.sikuli.script.Image
- getNameGiven() - Method in class org.sikuli.script.App
- getNumberScreens() - Static method in class org.sikuli.script.Screen
- getObserver() - Method in class org.sikuli.script.Region
- getOffset(Location) - Method in class org.sikuli.script.Location
-
the offset of given point to this Location
- getOptions() - Method in class org.sikuli.script.App
- getOS() - Static method in class org.sikuli.basics.Settings
- getOS() - Static method in class org.sikuli.script.Env
-
Deprecated.use the Settings features
- getOSVersion() - Static method in class org.sikuli.basics.Settings
- getOSVersion() - Static method in class org.sikuli.script.Env
-
Deprecated.use Settings. ... instead
- 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
- getPrimaryScreen() - Static method in class org.sikuli.script.Screen
- getRandom() - Static method in class org.sikuli.script.Mouse
- getRegEx(String) - Static method in class org.sikuli.script.Finder
- getRegion() - Method in class org.sikuli.script.Match
- getRegion() - Method in class org.sikuli.script.ObserveEvent
- getRegion() - Method in class org.sikuli.script.ScreenImage
- getResize() - Method in class org.sikuli.script.Pattern
- getResponse() - Static method in exception org.sikuli.script.FindFailed
- getResponse() - Method in class org.sikuli.script.ObserveEvent
- 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.Region
-
get the specified row counting from 0.
- getRow(int, int) - Method in class org.sikuli.script.Region
- getRowH() - Method in class org.sikuli.script.Region
- getRows() - Method in class org.sikuli.script.Region
- getScale() - Method in class org.sikuli.script.Screen
- getScaleFactor(int, int) - Static method in class org.sikuli.script.Screen
- getScore() - Method in class org.sikuli.script.Match
-
the match score
- 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
Element.getScreen()
- getScreenMonitor(int) - Static method in class org.sikuli.script.Screen
- getSeparator() - Static method in class org.sikuli.script.Env
-
Deprecated.use Settings.getPathSeparator() ... instead
- getSikuliDataPath() - Static method in class org.sikuli.script.Env
-
Deprecated.use Settings.getDataPath() instead
- getSikuliVersion() - Static method in class org.sikuli.script.Env
-
Deprecated.use Settings.getVersion() instead
- getSikuliVersionBuild() - Static method in class org.sikuli.script.Env
-
Deprecated.use Settings.getVersionBuild() instead
- getSimilar() - Method in class org.sikuli.script.Pattern
- getStart() - Method in class org.sikuli.script.ScreenImage
- getStoredAt() - Method in class org.sikuli.script.ScreenImage
- getSub(int) - Method in class org.sikuli.script.Image
-
create a sub image from this image
- getSub(int, int, int, int) - Method in class org.sikuli.script.Image
-
create a sub image from this image
- getSub(Rectangle) - Method in class org.sikuli.script.ScreenImage
- getSub(Region) - Method in class org.sikuli.script.Image
- getTarget() - Method in class org.sikuli.script.Match
- getTargetImage() - Method in class org.sikuli.script.Match
-
get the image used for searching
- 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.Match
- getTextFromKeycode(int) - Static method in class org.sikuli.script.Key
- getTile(int) - Method in class org.sikuli.script.Region
- getTime() - Method in class org.sikuli.script.Match
- getTime() - Method in class org.sikuli.script.ObserveEvent
- getTimestamp() - Static method in class org.sikuli.basics.Settings
- getTitle() - Method in class org.sikuli.script.App
- getTitle(int) - Method in class org.sikuli.script.App
- getToken() - Method in class org.sikuli.script.App
- 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
-
INTERNAL USE
- getURL() - Method in class org.sikuli.script.Image
- 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)
- getVersion() - Static method in class org.sikuli.basics.Settings
- getVersionBuild() - Static method in class org.sikuli.basics.Settings
- getWindows() - Method in class org.sikuli.script.App
- getWindowTitle() - Method in class org.sikuli.script.App
- getWorkDir() - Method in class org.sikuli.script.App
- getX() - Method in class org.sikuli.script.Offset
- getY() - Method in class org.sikuli.script.Offset
- globalOptions() - Static method in class org.sikuli.script.OCR
-
access/get the current global Options as singleton.
- globalTraceOff() - Static method in class org.sikuli.basics.Debug
- globalTraceOn() - Static method in class org.sikuli.basics.Debug
- grow() - Method in class org.sikuli.script.Location
-
create a region with this point as center and size Settings.DefaultPadding
- 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.Location
-
create a region with this point as center and the given size
- 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.Location
-
create a region with this point as center and the given size
- 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.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(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.
- grow(Location) - Static method in class org.sikuli.script.Region
-
create a minimal region at given point with size 1 x 1
- 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, int, int, int, int) - Static method in class org.sikuli.script.Region
-
create a region with a corner at the given point.
H
- HANDLE - Static variable in exception org.sikuli.script.FindFailed
-
FindFailedResponse HANDLE: should call a handler
FindFailed.setFindFailedHandler(Object)
on FindFailed - happened(ObserveEvent) - Method in class org.sikuli.script.ObserverCallBack
-
to be overwritten to handle generic events
- hasBundlePath() - Static method in class org.sikuli.script.ImagePath
- hasEvents() - Method in class org.sikuli.script.Region
- hasFocus() - Method in class org.sikuli.script.App
- hasMask() - Method in class org.sikuli.script.Image
- hasMask() - Method in class org.sikuli.script.Pattern
- hasMoved() - Static method in class org.sikuli.script.Mouse
-
check if mouse was moved since last mouse action
- hasNext() - Method in class org.sikuli.script.Finder
- hasNext() - Method in class org.sikuli.script.Match
- 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
- hasRandom() - Static method in class org.sikuli.script.Mouse
- hasText(String) - Method in class org.sikuli.script.Region
- hasWindow() - Method in class org.sikuli.script.App
- highlight() - Method in class org.sikuli.script.Region
-
show a colored frame around the region for a given time or switch on/off
- highlight(double) - 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(double, 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(String) - Method in class org.sikuli.script.Region
-
Toggle the regions Highlight border (given color).
- Highlight - Static variable in class org.sikuli.basics.Settings
-
true = highlight every match (default: false) (show red rectangle around) for DefaultHighlightTime seconds (default: 2)
- highlight4py(ArrayList) - Method in class org.sikuli.script.Region
-
INTERNAL: highlight (for Python support):
- highlightAllOff() - Static method in class org.sikuli.script.Region
-
Switch off all actual highlights
- highlightOff() - Static method in class org.sikuli.basics.Debug
- highlightOff() - Method in class org.sikuli.script.Region
-
Switch off the regions highlight
- highlightOn() - Static method in class org.sikuli.basics.Debug
- highlightOn() - Method in class org.sikuli.script.Region
-
Switch on the regions highlight with default color
- highlightOn(String) - Method in class org.sikuli.script.Region
-
Switch on the regions highlight with given color
- HighlightTransparent - Static variable in class org.sikuli.basics.Settings
- history(String, Object...) - Static method in class org.sikuli.basics.Debug
-
Deprecated.
- HOME - Static variable in class org.sikuli.script.Key
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(Class, String) - Constructor for class org.sikuli.script.Image
-
Creates an Image from a resource file on classpath.
- Image(SUFEBMP) - Constructor for class org.sikuli.script.Image
-
Create an Image from various sources.
- Image(SUFEBMP, String) - Constructor for class org.sikuli.script.Image
-
Create an Image from various sources.
- ImageCaching - Static variable in class org.sikuli.basics.Settings
- ImageCallback - Static variable in class org.sikuli.basics.Settings
- ImagePath - Class in org.sikuli.script
-
maintain 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.script.Mouse
- init(RunTime) - Static method in class org.sikuli.basics.Settings
- 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
- internalUseOnlyHighlightReset() - Method in class org.sikuli.script.Region
-
INTERNAL: ONLY
- is() - Static method in class org.sikuli.basics.Debug
- is(int) - 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
- isBeQuiet() - Static method in class org.sikuli.basics.Debug
- 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
- isClosing() - Method in class org.sikuli.script.App
- 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
- isGlobalDebug() - Static method in class org.sikuli.basics.Debug
- isGlobalTrace() - Static method in class org.sikuli.basics.Debug
- isHeadless() - Static method in class org.sikuli.script.Screen
- isHTTP() - Method in class org.sikuli.script.ImagePath.PathEntry
- isImageBundled(URL) - Static method in class org.sikuli.script.ImagePath
- isJar() - Method in class org.sikuli.script.ImagePath.PathEntry
- 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 method in class org.sikuli.basics.Settings
- isMac() - Static method in class org.sikuli.script.Env
-
Deprecated.use Settings. ... instead
- isMacApp - Static variable in class org.sikuli.basics.Settings
- isMasked() - Method in class org.sikuli.script.Image
- isMissing() - Method in class org.sikuli.script.ObserveEvent
-
check the observe event type
- isModifier(char) - Static method in class org.sikuli.script.Key
- isModifier(String) - Static method in class org.sikuli.script.Key
- isObserving() - Method in class org.sikuli.script.Region
- 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
- isRegEx(String) - Static method in class org.sikuli.script.Finder
- 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
- isShowActions() - Static method in class org.sikuli.basics.Settings
- isStartWithTrace() - Static method in class org.sikuli.basics.Debug
- 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.ImagePath.PathEntry
- isValid() - Method in class org.sikuli.script.Pattern
- isValid() - Method in class org.sikuli.script.Region
-
Check whether this Region is contained by any of the available screens
- isValid() - Method in class org.sikuli.script.Screen
- isValidWithMessage() - Method in class org.sikuli.script.Screen
- isVanish() - Method in class org.sikuli.script.ObserveEvent
-
check the observe event type
- isWindow() - Method in class org.sikuli.script.App
- isWindows() - Static method in class org.sikuli.basics.Settings
- isWindows() - Static method in class org.sikuli.script.Env
-
Deprecated.use Settings. ... instead
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.
- 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
- language() - Method in class org.sikuli.script.OCR.Options
-
get the cutrrent language
- language(String) - Method in class org.sikuli.script.OCR.Options
-
Set the language short string.
- 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
- lastScreenImage - Variable in class org.sikuli.script.Screen
- LB - Static variable in class org.sikuli.script.Region
- left() - Method in class org.sikuli.script.Region
-
create a region left of the left side with same height.
- 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(int) - Method in class org.sikuli.script.Region
-
create a region left of the left side with same height and given width.
- LEFT - Static variable in class org.sikuli.script.Button
- LEFT - Static variable in class org.sikuli.script.Key
- LEFT - Static variable in class org.sikuli.script.Mouse
- LEFT - Static variable in class org.sikuli.script.Region
-
Flag for the
Region.create(Location, int, int, int, int)
method. - leftAt() - Method in class org.sikuli.script.Region
- leftAt(int) - Method in class org.sikuli.script.Region
-
negative offset goes to the left.
- leftMiddle(Number...) - Method in class org.sikuli.script.Region
-
In the left middle a new Region is created.
- leftSide(Number...) - Method in class org.sikuli.script.Region
-
At the left side a new Region with same height is created.
- LH - Static variable in class org.sikuli.script.Region
- listApps() - Static method in class org.sikuli.script.App
- listApps(String) - Static method in class org.sikuli.script.App
- 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(Point) - Constructor for class org.sikuli.script.Location
-
create from AWT point
- Location(Location) - Constructor for class org.sikuli.script.Location
-
duplicates the point
- Location(Offset) - Constructor for class org.sikuli.script.Location
- log(int, String, Object...) - Static method in class org.sikuli.basics.Debug
-
Sikuli debug messages with level
switch on/off: Settings.DebugLogs (off) and/or -Dsikuli.Debug - log(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(String, Object...) - Static method in class org.sikuli.script.App
- logCallStack(int, String) - Static method in class org.sikuli.basics.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
- logOff() - Static method in class org.sikuli.script.App
- logOn() - Static method in class org.sikuli.script.App
- logp(String, Object...) - Static method in class org.sikuli.basics.Debug
- logt(String) - 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
- LSTM_ONLY - org.sikuli.script.OCR.OEM
- 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
- make(Image, double, Location, float, String) - Static method in class org.sikuli.script.Pattern
- make4py(ArrayList) - Static method in class org.sikuli.script.Location
- make4py(ArrayList) - Static method in class org.sikuli.script.Offset
- make4py(ArrayList) - Static method in class org.sikuli.script.Region
-
Create a new Region
- Region(x, y, w, h)
- Region(someRegion) - make4py(ArrayList) - Static method in class org.sikuli.script.Screen
- makeMat() - Method in class org.sikuli.script.ScreenImage
- mask(SUFEBMP) - Method in class org.sikuli.script.Image
- mask(SUFEBMP) - Method in class org.sikuli.script.Pattern
- masked() - Method in class org.sikuli.script.Image
- Match - Class in org.sikuli.script
-
The region on the screen or rectangle in the image, where the given image or text was found.
- Match() - Constructor for class org.sikuli.script.Match
-
creates a Match on primary screen as (0, 0, 1, 1)
- Match(int, int, int, int) - Constructor for class org.sikuli.script.Match
- Match(int, int, int, int, double, IScreen) - Constructor for class org.sikuli.script.Match
- Match(Point, double, Mat) - Constructor for class org.sikuli.script.Match
- Match(Rectangle) - Constructor for class org.sikuli.script.Match
- Match(Element) - Constructor for class org.sikuli.script.Match
-
create a copy of another Match or create new Match with element's dimension
to e.g. - Match(Region, double) - Constructor for class org.sikuli.script.Match
-
create a Match from a region with given SimScore
- Match(Region, IScreen) - Constructor for class org.sikuli.script.Match
- 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(Number...) - Method in class org.sikuli.script.Region
-
Around the center a new Region is created.
- 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
-
to be overwritten to handle image missing events
- MISSING - org.sikuli.script.ObserveEvent.Type
- MM - Static variable in class org.sikuli.script.Region
- MODIFIER_KEYS - Static variable in class org.sikuli.script.Key
- modify(RMILO) - Method in class org.sikuli.script.Offset
- 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. - move(int, int) - Method in class org.sikuli.script.Location
-
convenience: like awt point
- move(int, int) - Static method in class org.sikuli.script.Mouse
-
move the mouse from the current position to the offset position given by the parameters
- move(Location) - Static method in class org.sikuli.script.Mouse
-
move the mouse to the given location (local and remote)
- moveFor(int, int) - Method in class org.sikuli.script.Location
-
Deprecated.
- 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
- 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
- NewAPI - Static variable in class org.sikuli.basics.Settings
- newLocation(int, int) - Method in class org.sikuli.script.Screen
- newLocation(Location) - Method in class org.sikuli.script.Screen
-
creates a location on the current screen with the given point.
- newRegion(int, int, int, int) - Method in class org.sikuli.script.Screen
- newRegion(Location, int, int) - Method in class org.sikuli.script.Screen
-
creates a region on the current screen with the given coordinate/size.
- newRegion(Region) - Method in class org.sikuli.script.Screen
- next() - Method in class org.sikuli.script.Finder
- next() - Method in class org.sikuli.script.Match
- 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
- 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 getTile()
- NUM_LOCK - Static variable in class org.sikuli.script.Key
- 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
- NW - Static variable in class org.sikuli.script.Region
-
the area constants for use with getTile()
O
- observe() - Method in class org.sikuli.script.Region
-
start an observer in this region that runs forever (use stopObserving() in handler) for details about the observe event handler:
ObserverCallBack
for details about APPEAR/VANISH/CHANGE events:ObserveEvent
- observe(double) - Method in class org.sikuli.script.Region
-
start an observer in this region for the given time for details about the observe event handler:
ObserverCallBack
for details about APPEAR/VANISH/CHANGE events:ObserveEvent
- ObserveEvent - Class in org.sikuli.script
-
provides information about the observed event being in the
ObserverCallBack
- ObserveEvent() - Constructor for class org.sikuli.script.ObserveEvent
- ObserveEvent(String, ObserveEvent.Type, Object, Object, Object, long) - Constructor for class org.sikuli.script.ObserveEvent
-
INTERNAL: creates an observed event
- ObserveEvent(String, ObserveEvent.Type, Element, Element) - Constructor for class org.sikuli.script.ObserveEvent
-
INTERNAL: creates an observed event
- ObserveEvent.Type - Enum in org.sikuli.script
- 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
- observeInBackground(double) - Method in class org.sikuli.script.Region
-
start an observer in this region for the given time that runs in background - for details about the observe event handler:
ObserverCallBack
for details about APPEAR/VANISH/CHANGE events:ObserveEvent
- observeInLine(double) - Method in class org.sikuli.script.Region
-
INTERNAL: 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 callbacks for
the Region observers onAppear, onVanish and onChange. - ObserverCallBack() - Constructor for class org.sikuli.script.ObserverCallBack
-
setup a callback to be used on the Java API level
- ObserverCallBack(Object, ObserveEvent.Type) - Constructor for class org.sikuli.script.ObserverCallBack
-
INTERNAL: callbacks from Jython or JRuby
- ObserveScanRate - Static variable in class org.sikuli.basics.Settings
- OCR - Class in org.sikuli.script
-
Static helper class for OCR via Tess4J/Tesseract.
- OCR() - Constructor for class org.sikuli.script.OCR
- OCR.OEM - Enum in org.sikuli.script
-
OCR Engine modes.
- OCR.Options - Class in org.sikuli.script
- OCR.PSM - Enum in org.sikuli.script
-
Page segmentation modes.
- OcrDataPath - Static variable in class org.sikuli.basics.Settings
- OcrLanguage - Static variable in class org.sikuli.basics.Settings
- OcrLanguageDefault - 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
- oem() - Method in class org.sikuli.script.OCR.Options
-
get this OEM.
- oem(int) - Method in class org.sikuli.script.OCR.Options
-
set this OEM.
- oem(OCR.OEM) - Method in class org.sikuli.script.OCR.Options
-
set this OEM.
- off() - Static method in class org.sikuli.basics.Debug
- offset() - Method in class org.sikuli.script.Image
-
Get the value of offset
- offset(int, int) - Method in class org.sikuli.script.Image
-
Set the value of offset
- 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(int, int) - Method in class org.sikuli.script.Region
-
create region with same size at top left corner offset
- offset(Object) - 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(Object) - Method in class org.sikuli.script.Region
-
create region with same size at top left corner offset
- offset(Location) - Method in class org.sikuli.script.Image
-
Set the value of offset
- Offset - Class in org.sikuli.script
- Offset() - Constructor for class org.sikuli.script.Offset
- Offset(int, int) - Constructor for class org.sikuli.script.Offset
-
a new offset with given x and y distances
- Offset(RMILO) - Constructor for class org.sikuli.script.Offset
- on(int) - Static method in class org.sikuli.basics.Debug
- on(String) - Static method in class org.sikuli.basics.Debug
- 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
Observing
. - 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.
- 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
Observing
. - 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
Observing
. - 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(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.
- onChangeDo(Integer, Object) - Method in class org.sikuli.script.Region
- 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
Observing
. - 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.
- 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.App
-
tries to open an app using the given name and waits 1 sec for being ready If the app is already open, it is brought to foreground
- 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 - open(String, int) - Static method in class org.sikuli.script.App
-
tries to open an app using the given name and waits waitTime for being ready If the app is already open, it is brought to foreground
- openLink(String) - Static method in class org.sikuli.script.App
- Options() - Constructor for class org.sikuli.script.OCR.Options
-
create a new Options set from the initial defaults settings.
- org.sikuli.basics - package org.sikuli.basics
- org.sikuli.script - package org.sikuli.script
- OSD_ONLY - org.sikuli.script.OCR.PSM
- 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.
- paste(PFRML, String) - Method in class org.sikuli.script.Region
-
first does a click(target) at the given target position to gain focus/carret.
- path - Variable in class org.sikuli.script.ImagePath.PathEntry
- PathEntry(File) - Constructor for 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
- masked image (ignore transparent pixels) - resize in case of different environment (scaled views) - wait after used in actions like click - Pattern(PSUFEBM) - Constructor for class org.sikuli.script.Pattern
-
Create a Pattern from various sources.
- pause(float) - Static method in class org.sikuli.script.App
- pause(int) - Static method in class org.sikuli.script.App
- PAUSE - Static variable in class org.sikuli.script.Key
- 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
- psm() - Method in class org.sikuli.script.OCR.Options
-
get this PSM.
- psm(int) - Method in class org.sikuli.script.OCR.Options
-
set this PSM.
- psm(OCR.PSM) - Method in class org.sikuli.script.OCR.Options
-
set this PSM.
Q
- quietOff() - Static method in class org.sikuli.basics.Debug
- quietOn() - Static method in class org.sikuli.basics.Debug
R
- randomize() - Static method in class org.sikuli.script.Mouse
- randomize(long) - Static method in class org.sikuli.script.Mouse
- RAW_LINE - org.sikuli.script.OCR.PSM
- RB - Static variable in class org.sikuli.script.Region
- readChar(SFIRBS) - Static method in class org.sikuli.script.OCR
-
Reads text from the given source (character).
- readChar(SFIRBS, OCR.Options) - Static method in class org.sikuli.script.OCR
-
Reads text from the given source (character).
- readLine(SFIRBS) - Static method in class org.sikuli.script.OCR
-
Reads text from the given source (line).
- readLine(SFIRBS, OCR.Options) - Static method in class org.sikuli.script.OCR
-
Reads text from the given source (line).
- readLines(SFIRBS) - Static method in class org.sikuli.script.OCR
-
Treats text from the given source as lines.
- readLines(SFIRBS, OCR.Options) - Static method in class org.sikuli.script.OCR
-
Treats text from the given source as lines.
- readText(SFIRBS) - Static method in class org.sikuli.script.OCR
-
Reads text from the given source.
- readText(SFIRBS, OCR.Options) - Static method in class org.sikuli.script.OCR
-
Reads text from the given source.
- readWord(SFIRBS) - Static method in class org.sikuli.script.OCR
-
Reads text from the given source (word).
- readWord(SFIRBS, OCR.Options) - Static method in class org.sikuli.script.OCR
-
Reads text from the given source (word).
- readWords(SFIRBS) - Static method in class org.sikuli.script.OCR
-
Treats text from the given source as words.
- readWords(SFIRBS, OCR.Options) - Static method in class org.sikuli.script.OCR
-
Treats text from the given source as words.
- Region - Class in org.sikuli.script
-
A Region is a rectangular area on a screen.
- Region(int, int) - Constructor for class org.sikuli.script.Region
-
Convenience: a minimal Region to be used as a Point
- Region(int, int, int, int) - Constructor for class org.sikuli.script.Region
-
Create a region with the provided coordinate / size
- 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(Dimension) - Constructor for class org.sikuli.script.Region
- 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.
- remove() - Method in class org.sikuli.script.Finder
- remove() - Method in class org.sikuli.script.Match
- remove(File) - Static method in class org.sikuli.script.ImagePath
-
remove entry with given path (same as given with add)
- remove(String) - Static method in class org.sikuli.script.ImagePath
-
remove entry with given path (same as given with add)
- removeHotkey(char, int) - Static method in class org.sikuli.script.Env
-
Deprecated.use Key. ... instead
- removeHotkey(char, int) - Static method in class org.sikuli.script.Key
-
remove a hotkey and listener
- removeHotkey(String, 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
- 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 class org.sikuli.basics.Debug
- reset() - Method in class org.sikuli.script.App
- reset() - Static method in exception org.sikuli.script.FindFailed
-
reset all: response ABORT, findFailedHandler null, imageMissingHandler null
- reset() - Static method in class org.sikuli.script.ImagePath
-
empty path list and keep bundlePath (entry 0)
Image cache is cleared completely convenience for the scripting level - reset() - Static method in class org.sikuli.script.Mouse
- reset() - Method in class org.sikuli.script.OCR.Options
-
resets this Options set to the initial defaults.
- reset() - Static method in class org.sikuli.script.OCR
-
Resets the global options to the initial defaults.
- 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
- resetFindChanges() - Method in class org.sikuli.script.Finder
- resetFindFailedHandler() - Static method in exception org.sikuli.script.FindFailed
-
reset to default: no handler, response ABORT
- resetGlobalDebug() - Static method in class org.sikuli.basics.Debug
- resetImageMissingHandler() - Static method in exception org.sikuli.script.FindFailed
-
reset to default: no handler
- resetMonitors() - Static method in class org.sikuli.script.Screen
- resetMonitorsQuiet() - Static method in class org.sikuli.script.Screen
- resetPrompt(OverlayCapturePrompt) - Static method in class org.sikuli.script.Screen
- resetPSM() - Method in class org.sikuli.script.OCR.Options
-
Sets this PSM to -1.
- resetRandom() - Static method in class org.sikuli.script.Mouse
- resetResponse() - Static method in exception org.sikuli.script.FindFailed
-
reset to default
FindFailed.setResponse(FindFailedResponse)
- resize(float) - Method in class org.sikuli.script.Pattern
- resizeInterpolation(Element.Interpolation) - Method in class org.sikuli.script.OCR.Options
-
INTERNAL: (under investigation).
- RETRY - Static variable in exception org.sikuli.script.FindFailed
-
FindFailedResponse RETRY: should retry the find op on FindFailed
- RH - Static variable in class org.sikuli.script.Region
- right() - Method in class org.sikuli.script.Region
-
create a region right of the right side with same height.
- 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(int) - Method in class org.sikuli.script.Region
-
create a region right of the right side with same height and given width.
- RIGHT - Static variable in class org.sikuli.script.Button
- RIGHT - Static variable in class org.sikuli.script.Key
- RIGHT - Static variable in class org.sikuli.script.Mouse
- RIGHT - Static variable in class org.sikuli.script.Region
-
Flag for the
Region.create(Location, int, int, int, int)
method. - 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.Region
-
right click at the region's last successful match.
- 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 - rightMiddle(Number...) - Method in class org.sikuli.script.Region
-
In the right middle a new Region is created.
- rightSide(Number...) - Method in class org.sikuli.script.Region
-
At the right side a new Region with same height is created.
- RM - Static variable in class org.sikuli.script.Region
- 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).
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
- saveCapture(Object...) - Method in class org.sikuli.script.Region
- saveInto(File) - Method in class org.sikuli.script.ScreenImage
- saveInto(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)
- 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
- score() - Method in class org.sikuli.script.Match
-
the match score
- score(double) - Method in class org.sikuli.script.Match
- 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() - Constructor for class org.sikuli.script.Screen
-
Is the screen object having the top left corner as (0,0).
- Screen(int) - Constructor for class org.sikuli.script.Screen
-
The screen object with the given id
- ScreenImage - Class in org.sikuli.script
-
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)
- ScreenImage(Rectangle, BufferedImage) - Constructor for class org.sikuli.script.ScreenImage
-
create ScreenImage with given
- ScreenImage(File) - Constructor for class org.sikuli.script.ScreenImage
-
create ScreenImage from given
- SCREENSHOT_DIRECTORY - Static variable in class org.sikuli.script.ImagePath
- 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
- set(double, double) - Method in class org.sikuli.script.Offset
-
sets the given values
- set(int, int) - Method in class org.sikuli.script.Offset
-
sets to the given values
- setActive() - Method in class org.sikuli.script.ObserveEvent
- 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 - 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
- setBundleFolder(File) - Static method in class org.sikuli.script.ImagePath
- setBundlePath(String) - Static method in class org.sikuli.script.ImagePath
-
the given path replaces bundlepath (entry 0)
- setChanges(List<Match>) - Method in class org.sikuli.script.ObserveEvent
- 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.Region
-
store info: this region is divided horizontally into n even columns.
- 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)
- setExec(String) - Method in class org.sikuli.script.App
- setFilename(String) - Method in class org.sikuli.script.Pattern
-
set a new image for this pattern
- setFileURL(URL) - Method in class org.sikuli.script.Image
- setFindChangesImageDiff(int) - Method in class org.sikuli.script.Finder
- setFindChangesPixelDiff(int) - Method in class org.sikuli.script.Finder
- setFindFailedHandler(Object) - Static method in exception org.sikuli.script.FindFailed
-
Global FindFailedHandler for new
Region
s
default: none - setFocused(boolean) - Method in class org.sikuli.script.App
- setGlobalDebug(int) - Static method in class org.sikuli.basics.Debug
- setIDEshouldReload(Element) - Static method in class org.sikuli.script.Image
- setImage(Object) - Method in class org.sikuli.script.ObserveEvent
- setImageMissingHandler(Object) - Static method in exception org.sikuli.script.FindFailed
-
Global ImageMissingHandler for new
Region
s
default: none - setInactive() - Method in class org.sikuli.script.ObserveEvent
- setInactive(String) - Method in class org.sikuli.script.Region
-
set the observer with the given name inactive (not checked while observing)
- setIndex(int) - Method in class org.sikuli.script.Match
- setIndex(int) - Method in class org.sikuli.script.ObserveEvent
- setIsAbsolute(boolean) - Method in class org.sikuli.script.Image
- setLastSeen(Rectangle, double) - Method in class org.sikuli.script.Image
-
Internal Use: set the last seen info after a find
- setLocation(Location) - Method in class org.sikuli.script.Region
-
set the regions position.
- 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 - setMaskFromString(String) - Method in class org.sikuli.script.Pattern
- setMatch(Object) - Method in class org.sikuli.script.ObserveEvent
- setMonitor(int) - Method in class org.sikuli.script.Screen
- 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
- setName(String) - Method in class org.sikuli.script.App
- setNameGiven(String) - Method in class org.sikuli.script.App
- setOther(Location) - Method in class org.sikuli.script.Screen
- setOther(Region) - Method in class org.sikuli.script.Screen
- setPattern(Object) - Method in class org.sikuli.script.ObserveEvent
- setPID(int) - Method in class org.sikuli.script.App
- setPID(String) - Method in class org.sikuli.script.App
- setRandom() - Static method in class org.sikuli.script.Mouse
- setRandom(int) - Static method in class org.sikuli.script.Mouse
- setRaster(int, int) - Method in class org.sikuli.script.Region
-
store info: this region is divided into a raster of even cells.
- setRegion(Object) - Method in class org.sikuli.script.ObserveEvent
- setResponse(FindFailedResponse) - Static method in exception org.sikuli.script.FindFailed
-
Global FindFailedResponse for new
Region
s
ABORT - abort script on FindFailed
SKIP - ignore FindFailed
PROMPT - display prompt on FindFailed to let user decide how to proceed
RETRY - continue to wait for appearence after FindFailed
HANDLE - (set implicit) call a handler on exceptionFindFailed.setFindFailedHandler(Object)
default: ABORT - 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.
- setROI(Rectangle) - Method in class org.sikuli.script.Region
-
resets this region to the given rectangle.
- setROI(Region) - Method in class org.sikuli.script.Region
-
resets this region to the given region.
- setRows(int) - Method in class org.sikuli.script.Region
-
store info: this region is divided vertically into n even rows.
- setShowActions(boolean) - Static method in class org.sikuli.basics.Settings
- setSize(int, int) - Method in class org.sikuli.script.Region
- setStartEnd(Location, Location) - Method in class org.sikuli.script.ScreenImage
- setStartWithTrace() - Static method in class org.sikuli.basics.Debug
- setTarget(int, int) - Method in class org.sikuli.script.Match
-
INTERNAL USE
- setTargetOffset(int, int) - Method in class org.sikuli.script.Match
-
like
Pattern.targetOffset
sets the click target relative to the center - setTargetOffset(Location) - Method in class org.sikuli.script.Match
-
like
Pattern.targetOffset
sets the click target by offset relative to the center - 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
- setToken(String) - Method in class org.sikuli.script.App
- 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
-
INTERNAL USE
- 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
- setWindow(String) - Method in class org.sikuli.script.App
- setWithTimeElapsed() - Static method in class org.sikuli.basics.Debug
- setWithTimeElapsed(long) - Static method in class org.sikuli.basics.Debug
- setWorkDir() - Method in class org.sikuli.script.App
- setWorkDir(String) - Method in class org.sikuli.script.App
- setX(double) - Method in class org.sikuli.script.Offset
-
sets x to the given value
- setX(int) - Method in class org.sikuli.script.Offset
-
sets x to the given value
- setY(double) - Method in class org.sikuli.script.Offset
-
sets y to the given value
- setY(int) - Method in class org.sikuli.script.Offset
-
sets y to the given value
- 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
- similar(double) - Method in class org.sikuli.script.Pattern
-
sets the minimum Similarity to use with findX
- similarity() - Method in class org.sikuli.script.Image
-
Get the value of similarity
- similarity(double) - Method in class org.sikuli.script.Image
-
Set the value of similarity
- SINGLE_BLOCK - org.sikuli.script.OCR.PSM
- SINGLE_BLOCK_VERT_TEXT - org.sikuli.script.OCR.PSM
- SINGLE_CHAR - org.sikuli.script.OCR.PSM
- SINGLE_COLUMN - org.sikuli.script.OCR.PSM
- SINGLE_LINE - org.sikuli.script.OCR.PSM
- SINGLE_WORD - org.sikuli.script.OCR.PSM
- 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
- smallFont() - Method in class org.sikuli.script.OCR.Options
-
Convenience: Configure the Option's optimization.
- 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
- SPARSE_TEXT - org.sikuli.script.OCR.PSM
- SPARSE_TEXT_OSD - org.sikuli.script.OCR.PSM
- start - Variable in class org.sikuli.script.ScreenImage
- 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 - status() - Static method in class org.sikuli.script.OCR
-
prints out the current global options.
- stopObserver() - Method in class org.sikuli.script.ObserveEvent
-
stops the observer
- stopObserver() - Method in class org.sikuli.script.Region
-
stops a running observer
- stopObserver(String) - Method in class org.sikuli.script.ObserveEvent
-
stops the observer and prints the given text
- 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
- SwitchToText - Static variable in class org.sikuli.basics.Settings
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
- TESSERACT_LSTM_COMBINED - org.sikuli.script.OCR.OEM
- TESSERACT_ONLY - org.sikuli.script.OCR.OEM
- test(String, Object...) - Static method in class org.sikuli.basics.Debug
-
Sikuli messages to use in tests
switch on/off: always on - textHeight() - Method in class org.sikuli.script.OCR.Options
-
current base for image optimization before OCR.
- textHeight(float) - Method in class org.sikuli.script.OCR.Options
-
Configure image optimization.
- 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 getTile()
- TM - Static variable in class org.sikuli.script.Region
- toJavaKeyCode(char) - Static method in class org.sikuli.script.Key
-
Convert Sikuli Key to Java virtual key code
- toJavaKeyCode(String) - 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
- top(Number...) - Method in class org.sikuli.script.Region
-
At the top a new Region with same width is created.
- TOP - Static variable in class org.sikuli.script.Region
-
Flag for the
Region.create(Location, int, int, int, int)
method. - topLeft(Number...) - Method in class org.sikuli.script.Region
-
In the top left corner a new Region is created.
- topMiddle(Number...) - Method in class org.sikuli.script.Region
-
In the top middle a new Region is created.
- topRight(Number...) - Method in class org.sikuli.script.Region
-
In the top right corner a new Region is created.
- toString() - Method in class org.sikuli.script.App
- 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.OCR.Options
-
Current state of this Options as some formatted lines of text.
- toString() - Method in class org.sikuli.script.Pattern
- toString() - Method in class org.sikuli.script.Region
- toStringLong() - Method in class org.sikuli.script.Match
- 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
- TR - Static variable in class org.sikuli.script.Region
- trace(String, Object...) - Static method in class org.sikuli.basics.Debug
- 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
- 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.
- type(String, int) - Method in class org.sikuli.script.Region
-
enters the given text one character/key after another using keyDown/keyUp.
- type(String, String) - Method in class org.sikuli.script.Region
-
enters the given text one character/key after another using keyDown/keyUp.
- type(PFRML, String) - Method in class org.sikuli.script.Region
-
first does a click(target) at the given target position to gain focus/carret.
- 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
- union(Location) - Method in class org.sikuli.script.Location
-
creates a
Region
with the given points as top-left and bottom-right corners - unsetWithTimeElapsed() - Static method in class org.sikuli.basics.Debug
- up() - Static method in class org.sikuli.script.Mouse
-
release all buttons
- up(int) - Static method in class org.sikuli.script.Mouse
-
release the given buttons
Button
- UP - Static variable in class org.sikuli.script.Key
- 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
- userDPI(int) - Method in class org.sikuli.script.OCR.Options
-
INTERNAL: (under investigation).
- 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.
- valueOf(String) - Static method in enum org.sikuli.script.OCR.OEM
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.sikuli.script.OCR.PSM
-
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.
- values() - Static method in enum org.sikuli.script.OCR.OEM
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum org.sikuli.script.OCR.PSM
-
Returns an array containing the constants of this enum type, in the order they are declared.
- VANISH - org.sikuli.script.ObserveEvent.Type
- vanished(ObserveEvent) - Method in class org.sikuli.script.ObserverCallBack
-
to be overwritten to handle vanish events
- variable(String, String) - Method in class org.sikuli.script.OCR.Options
-
set a variable for Tesseract.
- variables() - Method in class org.sikuli.script.OCR.Options
- VIEWER - org.sikuli.script.App.Type
W
- 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
- waitAfter() - Method in class org.sikuli.script.Image
-
Get the value of waitAfter
- waitAfter() - Method in class org.sikuli.script.Pattern
-
Get the value of waitAfter
- waitAfter(int) - Method in class org.sikuli.script.Image
-
Set the value of waitAfter
- waitAfter(int) - Method in class org.sikuli.script.Pattern
-
Set the value of waitAfter
- 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
- waitT(String) - Method in class org.sikuli.script.Region
- waitT(String, double) - Method in class org.sikuli.script.Region
- waitText(String) - Method in class org.sikuli.script.Region
- waitText(String, double) - Method in class org.sikuli.script.Region
- waitVanish(PSI, double) - Method in class org.sikuli.script.Region
-
waits until target vanishes or timeout (in seconds) is passed
- wasRecaptured - Variable in class org.sikuli.script.Image
- WEST - Static variable in class org.sikuli.script.Region
- WEST_MID - Static variable in class org.sikuli.script.Region
- WEST_NORTH - Static variable in class org.sikuli.script.Region
- WEST_SOUTH - Static variable in class org.sikuli.script.Region
- WH - Static variable in class org.sikuli.script.Region
- wheel(int, int) - Static method in class org.sikuli.script.Mouse
-
move mouse using mouse wheel in the given direction the given steps
the result is system dependent - wheel(int, int) - Method in class org.sikuli.script.Region
-
Move the wheel at the current mouse position.
- wheel(int, 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(int, int, int, int) - Method in class org.sikuli.script.Region
-
Move the wheel at the current mouse position.
- wheel(int, int, String) - Method in class org.sikuli.script.Region
-
Move the wheel at the current mouse position.
- wheel(int, int, String, int) - Method in class org.sikuli.script.Region
-
Move the wheel at the current mouse position.
- 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(PFRML, int, int, int, int) - Method in class org.sikuli.script.Region
-
move the mouse pointer to the given target location.
- wheel(PFRML, int, int, String) - 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, String, int) - Method in class org.sikuli.script.Region
-
move the mouse pointer to the given target location.
- 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
- WheelNatural - Static variable in class org.sikuli.basics.Settings
- WIN - Static variable in class org.sikuli.script.Key
- 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
Y
A B C D E F G H I K L M N O P Q R S T U V W X YAll Classes All Packages