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

A

ABORT - Static variable in exception org.sikuli.script.FindFailed
 
above(int) - Method in class org.sikuli.script.Location
creates a point at the given offset above, might be negative
might create a point outside of any screen, not checked
above() - Method in class org.sikuli.script.Region
create a region above the top side with same width
the new region extends to the top screen border
use grow() to include the current region
above(int) - Method in class org.sikuli.script.Region
create a region above the top side with same width and given height
use grow() to include the current region
aboveAt() - Method in class org.sikuli.script.Region
 
aboveAt(int) - Method in class org.sikuli.script.Region
negative offset goes towards top of screen
might be off current screen
ADD - Static variable in class org.sikuli.script.Key
 
add(int, int, int, int) - Method in class org.sikuli.script.Region
resize the region using the given padding values
might be negative
add(Region) - Method in class org.sikuli.script.Region
extend the region, so it contains the given region
but only the part inside the current screen
add(Location) - Method in class org.sikuli.script.Region
extend the region, so it contains the given point
but only the part inside the current screen
addAppearObserver(PSC, SikuliEventObserver) - Method in class org.sikuli.script.SikuliEventManager
 
addChangeObserver(int, SikuliEventObserver) - Method in class org.sikuli.script.SikuliEventManager
 
addHotkey(String, int, HotkeyListener) - Static method in class org.sikuli.script.Env
Deprecated.
use Key. ... instead
addHotkey(char, int, HotkeyListener) - Static method in class org.sikuli.script.Env
Deprecated.
use Key. ... instead
addListener(SikuliActionListener) - Method in class org.sikuli.script.SikuliActionManager
 
addObserver(EventObserver) - Method in interface org.sikuli.script.EventSubject
 
addObserver(EventObserver) - Method in class org.sikuli.script.OverlayCapturePrompt
 
addObserver(EventObserver) - Method in class org.sikuli.script.OverlayTransparentWindow
 
addVanishObserver(PSC, SikuliEventObserver) - Method in class org.sikuli.script.SikuliEventManager
 
ALT - Static variable in class org.sikuli.script.Key
 
ALT - Static variable in class org.sikuli.script.KeyModifier
 
ALTGR - Static variable in class org.sikuli.script.Key
 
ALTGR - Static variable in class org.sikuli.script.KeyModifier
 
App - Class in org.sikuli.script
 
App(String) - Constructor for class org.sikuli.script.App
 
App(String, int) - Constructor for class org.sikuli.script.App
 
atMouse() - Static method in class org.sikuli.script.Region
 

B

BACKSPACE - Static variable in class org.sikuli.script.Key
 
below(int) - Method in class org.sikuli.script.Location
creates a point at the given offset below, might be negative
might create a point outside of any screen, not checked
below() - Method in class org.sikuli.script.Region
create a region below the bottom side with same width
the new region extends to the bottom screen border
use grow() to include the current region
below(int) - Method in class org.sikuli.script.Region
create a region below the bottom side with same width and given height
use grow() to include the current region
belowAt() - Method in class org.sikuli.script.Region
 
belowAt(int) - Method in class org.sikuli.script.Region
positive offset goes towards bottom of screen
might be off current screen
Button - Class in org.sikuli.script
 
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_NUM0 - Static variable in class org.sikuli.script.Key
 
C_NUM1 - Static variable in class org.sikuli.script.Key
 
C_NUM2 - Static variable in class org.sikuli.script.Key
 
C_NUM3 - Static variable in class org.sikuli.script.Key
 
C_NUM4 - Static variable in class org.sikuli.script.Key
 
C_NUM5 - Static variable in class org.sikuli.script.Key
 
C_NUM6 - Static variable in class org.sikuli.script.Key
 
C_NUM7 - Static variable in class org.sikuli.script.Key
 
C_NUM8 - Static variable in class org.sikuli.script.Key
 
C_NUM9 - Static variable in class org.sikuli.script.Key
 
C_NUM_LOCK - Static variable in class org.sikuli.script.Key
 
C_PAGE_DOWN - Static variable in class org.sikuli.script.Key
 
C_PAGE_UP - Static variable in class org.sikuli.script.Key
 
C_PAUSE - Static variable in class org.sikuli.script.Key
 
C_PRINTSCREEN - Static variable in class org.sikuli.script.Key
 
C_RIGHT - Static variable in class org.sikuli.script.Key
 
C_SCROLL_LOCK - Static variable in class org.sikuli.script.Key
 
C_SEPARATOR - Static variable in class org.sikuli.script.Key
 
C_SHIFT - Static variable in class org.sikuli.script.Key
 
C_UP - Static variable in class org.sikuli.script.Key
 
C_WIN - Static variable in class org.sikuli.script.Key
 
CAPS_LOCK - Static variable in class org.sikuli.script.Key
 
capture() - Method in interface org.sikuli.script.IScreen
 
capture(int, int, int, int) - Method in interface org.sikuli.script.IScreen
 
capture(Rectangle) - Method in interface org.sikuli.script.IScreen
 
capture(Region) - Method in interface org.sikuli.script.IScreen
 
capture() - Method in class org.sikuli.script.Screen
create a ScreenImage with the physical bounds of this screen
capture(int, int, int, int) - Method in class org.sikuli.script.Screen
create a ScreenImage with given coordinates on this screen.
capture(Rectangle) - Method in class org.sikuli.script.Screen
create a ScreenImage with given rectangle on this screen.
capture(Region) - Method in class org.sikuli.script.Screen
create a ScreenImage with given region on this screen
capture(Rectangle) - Method in class org.sikuli.script.ScreenUnion
 
captureScreen(Rectangle) - Method in interface org.sikuli.script.IRobot
 
captureScreen(Rectangle) - Method in class org.sikuli.script.RobotDesktop
 
changes - Variable in class org.sikuli.script.SikuliEvent
 
checkFile() - Method in class org.sikuli.script.Pattern
check for a valid image file
cleanUp() - Static method in class org.sikuli.script.Env
Deprecated.
 
cleanup() - Method in interface org.sikuli.script.IRobot
 
cleanup() - Method in class org.sikuli.script.RobotDesktop
 
cleanUp(int) - Static method in class org.sikuli.script.SikuliX
 
click() - Method in class org.sikuli.script.Region
left click at the region's last successful match
use center if no lastMatch
if region is a match: click targetOffset
click(PatternFilenameRegionMatchLocation) - Method in class org.sikuli.script.Region
left click at the given target location
Pattern or Filename - do a find before and use the match
Region - position at center
Match - position at match's targetOffset
Location - position at that point
click(PatternFilenameRegionMatchLocation, int) - Method in class org.sikuli.script.Region
left click at the given target location
holding down the given modifier keys
Pattern or Filename - do a find before and use the match
Region - position at center
Match - position at match's targetOffset
Location - position at that point
clickTarget(Region, PSRML, ScreenImage, Match) - Method in class org.sikuli.script.SikuliActionManager
 
close(String) - Static method in class org.sikuli.script.App
 
close() - Method in class org.sikuli.script.App
 
close() - Method in class org.sikuli.script.OverlayCapturePrompt
 
close() - Method in class org.sikuli.script.OverlayTransparentWindow
 
close() - Method in class org.sikuli.script.ScreenHighlighter
 
closeAll() - Static method in class org.sikuli.script.ScreenHighlighter
 
CMD - Static variable in class org.sikuli.script.Key
 
CMD - Static variable in class org.sikuli.script.KeyModifier
 
compareTo(Object) - Method in class org.sikuli.script.Match
 
Constants - Class in org.sikuli.script
 
Constants() - Constructor for class org.sikuli.script.Constants
 
contains(Location) - Method in class org.sikuli.script.Region
check if current region contains given point
contains(Region) - Method in class org.sikuli.script.Region
check if current region contains given region
containsMouse() - Method in class org.sikuli.script.Region
check if mouse pointer is inside current region
CONTEXT - Static variable in class org.sikuli.script.Key
 
convertModifiers(String) - Static method in class org.sikuli.script.Key
 
copyTo(int) - Method in class org.sikuli.script.Location
new point with same offset to current screen's top left on given screen
copyTo(Screen) - 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(Screen) - 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(Location, int, int) - Static method in class org.sikuli.script.Region
Create a region with the provided top left corner and size
create(Location, int, int, int, int) - Static method in class org.sikuli.script.Region
create a region with a corner at the given point
as specified with x y
0 0 top left
0 1 bottom left
1 0 top right
1 1 bottom right
create(Rectangle) - Static method in class org.sikuli.script.Region
Create a region from a Rectangle
create(Rectangle, Screen) - Static method in class org.sikuli.script.Region
Create a region from a Rectangle on a given Screen
create(Region) - Static method in class org.sikuli.script.Region
Create a region from another region
including the region's settings
CREATE_X_DIRECTION_LEFT - Static variable in class org.sikuli.script.Region
CREATE_X_DIRECTION_RIGHT - Static variable in class org.sikuli.script.Region
CREATE_Y_DIRECTION_BOTTOM - Static variable in class org.sikuli.script.Region
CREATE_Y_DIRECTION_TOP - Static variable in class org.sikuli.script.Region
CTRL - Static variable in class org.sikuli.script.Key
 
CTRL - Static variable in class org.sikuli.script.KeyModifier
 
curGD - Variable in class org.sikuli.script.Screen
 
curID - Variable in class org.sikuli.script.Screen
 

D

DECIMAL - Static variable in class org.sikuli.script.Key
 
defaultFindFailedResponse - Static variable in exception org.sikuli.script.FindFailed
 
delay(int) - Method in interface org.sikuli.script.IRobot
 
delay(int) - Method in class org.sikuli.script.RobotDesktop
 
DELETE - Static variable in class org.sikuli.script.Key
 
destroy() - Method in class org.sikuli.script.Finder
to explicitly free the Finder's resources
DIVIDE - Static variable in class org.sikuli.script.Key
 
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(PatternFilenameRegionMatchLocation) - Method in class org.sikuli.script.Region
double click at the given target location
Pattern or Filename - do a find before and use the match
Region - position at center
Match - position at match's targetOffset
Location - position at that point
doubleClick(PatternFilenameRegionMatchLocation, int) - Method in class org.sikuli.script.Region
double click at the given target location
holding down the given modifier keys
Pattern or Filename - do a find before and use the match
Region - position at center
Match - position at match's targetOffset
Location - position at that point
doubleClickTarget(Region, PSRML, ScreenImage, Match) - Method in class org.sikuli.script.SikuliActionManager
 
DOWN - Static variable in class org.sikuli.script.Key
 
drag(PatternFilenameRegionMatchLocation) - Method in class org.sikuli.script.Region
Prepare a drag action: move mouse to given target
press and hold left mouse button
wait Settings.DelayAfterDrag
dragDrop(PatternFilenameRegionMatchLocation) - Method in class org.sikuli.script.Region
Drag from region's last match and drop at given target
applying Settings.DelayAfterDrag and DelayBeforeDrop
using left mouse button
dragDrop(PatternFilenameRegionMatchLocation, PatternFilenameRegionMatchLocation) - Method in class org.sikuli.script.Region
Drag from a position and drop to another using left mouse button
applying Settings.DelayAfterDrag and DelayBeforeDrop
dropAt(PatternFilenameRegionMatchLocation) - Method in class org.sikuli.script.Region
finalize a drag action with a drop: move mouse to given target
wait Settings.DelayBeforeDrop
release the left mouse button

E

END - Static variable in class org.sikuli.script.Key
 
endError(int) - Static method in class org.sikuli.script.SikuliX
 
endFatal(int) - Static method in class org.sikuli.script.SikuliX
 
endNormal(int) - Static method in class org.sikuli.script.SikuliX
 
endWarning(int) - Static method in class org.sikuli.script.SikuliX
 
ENTER - Static variable in class org.sikuli.script.Key
 
Env - Class in org.sikuli.script
Deprecated. 
Env() - Constructor for class org.sikuli.script.Env
Deprecated.
 
equals(Object) - Method in class org.sikuli.script.Match
 
ESC - Static variable in class org.sikuli.script.Key
 
EventObserver - Interface in org.sikuli.script
 
EventSubject - Interface in org.sikuli.script
 
exact() - Method in class org.sikuli.script.Pattern
sets the minimum Similarity to 0.99 which means exact match
exists(PatternOrString) - Method in class org.sikuli.script.Region
Check if target exists (with the default autoWaitTimeout)
exists(PatternOrString, double) - Method in class org.sikuli.script.Region
Check if target exists with a specified timeout

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
 
finalize() - Method in class org.sikuli.script.Finder
 
find(String, double) - Method in class org.sikuli.script.Finder
 
find(Pattern) - Method in class org.sikuli.script.Finder
find given pattern within the stored image
find(String) - Method in class org.sikuli.script.Finder
 
find(PatternOrString) - Method in class org.sikuli.script.Region
Match find( Pattern/String ) finds the given pattern on the screen and returns the best match.
findAll(String, double) - Method in class org.sikuli.script.Finder
 
findAll(Pattern) - Method in class org.sikuli.script.Finder
 
findAll(String) - Method in class org.sikuli.script.Finder
 
findAll(PatternOrString) - Method in class org.sikuli.script.Region
Iterator findAll( Pattern/String/PatternClass ) finds the given pattern on the screen and returns the best match.
findAllRepeat() - Method in class org.sikuli.script.Finder
internal use: repeat find with same Finder
findAllText(String, double) - Method in class org.sikuli.script.Region
 
findAllText(String) - Method in class org.sikuli.script.Region
 
Finder - Class in org.sikuli.script
 
Finder(String) - Constructor for class org.sikuli.script.Finder
Finder constructor (finding within an image).
Finder(String, Region) - Constructor for class org.sikuli.script.Finder
Finder constructor (finding within an image within the given region).
Finder(BufferedImage) - Constructor for class org.sikuli.script.Finder
Constructor for special use from a BufferedImage
Finder(ScreenImage) - Constructor for class org.sikuli.script.Finder
Finder constructor for special use froma a ScreenImage
Finder(ScreenImage, Region) - Constructor for class org.sikuli.script.Finder
Finder constructor for special use from a ScreenImage
FindFailed - Exception in org.sikuli.script
 
FindFailed(String) - Constructor for exception org.sikuli.script.FindFailed
 
FindFailedResponse - Enum in org.sikuli.script
 
findRepeat() - Method in class org.sikuli.script.Finder
internal use: repeat find with same Finder
findText(String, double) - Method in class org.sikuli.script.Region
 
findText(String) - Method in class org.sikuli.script.Region
 
focus(String) - Static method in class org.sikuli.script.App
 
focus(String, int) - Static method in class org.sikuli.script.App
 
focus() - Method in class org.sikuli.script.App
 
focus(int) - Method in class org.sikuli.script.App
 
focusedWindow() - Static method in class org.sikuli.script.App
 
FOREVER - Static variable in class org.sikuli.script.Constants
 

G

gdevs - Static variable in class org.sikuli.script.Screen
 
genv - Static variable in class org.sikuli.script.Screen
 
getAutoWaitTimeout() - Method in class org.sikuli.script.Region
current setting for this region (see setAutoWaitTimeout)
getBottomLeft() - Method in class org.sikuli.script.Region
 
getBottomRight() - Method in class org.sikuli.script.Region
 
getBounds() - Method in interface org.sikuli.script.IScreen
 
getBounds(int) - Static method in class org.sikuli.script.Screen
 
getBounds() - Method in class org.sikuli.script.Screen
 
getBounds() - Method in class org.sikuli.script.ScreenUnion
 
getCenter() - Method in class org.sikuli.script.Region
 
getClipboard() - Static method in class org.sikuli.script.App
 
getClipboard() - Static method in class org.sikuli.script.Env
Deprecated.
use App. ... instead
getColor() - Method in class org.sikuli.script.Location
Get the color at the given Point for details: see java.awt.Robot and ...Color
getColorAt(int, int) - Method in interface org.sikuli.script.IRobot
 
getColorAt(int, int) - Method in class org.sikuli.script.RobotDesktop
 
getCount() - Method in class org.sikuli.script.SikuliEvent
 
getCount(Object) - Method in class org.sikuli.script.SikuliEventManager
 
getEvtMgr() - Method in class org.sikuli.script.Region
 
getFile() - Method in class org.sikuli.script.ScreenImage
stores the image as PNG file in the standard temp folder with a created filename (sikuli-image-#unique-random#.png) if not yet stored before
getFile(String) - Method in class org.sikuli.script.ScreenImage
stores the image as PNG file in the given path with a created filename (sikuli-image-#unique-random#.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.Pattern
the current image absolute filepath if any
getFilename() - Method in class org.sikuli.script.ScreenImage
Deprecated.
use getFile() instead
getFindFailedResponse() - Method in class org.sikuli.script.Region
 
getGraphicsDevice() - Method in class org.sikuli.script.Screen
 
getH() - Method in class org.sikuli.script.Region
 
getHotkeyModifier() - Static method in class org.sikuli.script.Env
Deprecated.
use Key. ... instead
getHotkeyModifier() - Static method in class org.sikuli.script.Key
 
getID() - Method in class org.sikuli.script.Screen
 
getIdFromPoint(int, int) - Method in class org.sikuli.script.ScreenUnion
 
getImage() - Method in class org.sikuli.script.Match
get the image used for searching as in-memory image
getImage() - Method in class org.sikuli.script.Pattern
return the image if any
getImage() - Method in class org.sikuli.script.ScreenImage
 
getImageFilename() - Method in class org.sikuli.script.Match
get the filename of the image used for searching
getInstance() - Static method in class org.sikuli.script.SikuliActionManager
 
getInstance() - Static method in class org.sikuli.script.TextRecognizer
 
getJPanel() - Method in class org.sikuli.script.OverlayTransparentWindow
 
getJPanelGraphics() - Method in class org.sikuli.script.OverlayTransparentWindow
 
getLastMatch() - Method in class org.sikuli.script.Region
a find operation saves its match on success in the used region object
unchanged if not successful
getLastMatches() - Method in class org.sikuli.script.Region
a findAll operation saves its matches on success in the used region object
unchanged if not successful
getLastScreenImage() - Method in class org.sikuli.script.Region
get the last image taken on this regions screen
getLastScreenImageFile() - Method in class org.sikuli.script.Region
stores the lastScreenImage in the current bundle path with a created unique name
getLastScreenImageFile(String) - Method in class org.sikuli.script.Region
stores the lastScreenImage in the current bundle path with the given name
getLastScreenImageFile(String, String) - Method in class org.sikuli.script.Region
stores the lastScreenImage in the given path with the given name
getMatch() - Method in class org.sikuli.script.SikuliAction
 
getMatch() - Method in class org.sikuli.script.SikuliEvent
 
getMouseLocation() - Static method in class org.sikuli.script.Env
Deprecated.
use Region.atMouse() ... instead
getNumberScreens() - Static method in class org.sikuli.script.Screen
 
getObserveScanRate() - Method in class org.sikuli.script.Region
 
getOffset(Location) - Method in class org.sikuli.script.Location
the offset of given point as (x,y) relative to this point
getOS() - Static method in class org.sikuli.script.Env
Deprecated.
use the Settings features
getOSUtil() - Static method in class org.sikuli.script.Env
Deprecated.
getOSVersion() - Static method in class org.sikuli.script.Env
Deprecated.
use Settings. ... instead
getPattern() - Method in class org.sikuli.script.SikuliEvent
 
getPrimaryId() - Static method in class org.sikuli.script.Screen
 
getPrimaryScreen() - Static method in class org.sikuli.script.Screen
 
getRect() - Method in class org.sikuli.script.Region
 
getRegion() - Method in class org.sikuli.script.SikuliEvent
 
getRobot() - Method in interface org.sikuli.script.IScreen
 
getRobot(int) - Static method in class org.sikuli.script.Screen
each screen has exactly one robot (internally used for screen capturing)
available as a convenience for those who know what they are doing.
getRobot() - Method in class org.sikuli.script.Screen
Gets the Robot of this Screen.
getROI() - Method in class org.sikuli.script.ScreenImage
 
getScore() - Method in class org.sikuli.script.Match
the match score
getScreen() - Method in interface org.sikuli.script.IRobot
Return the underlying device object (if any).
getScreen() - Method in class org.sikuli.script.Location
Returns null, if outside of any screen
subsequent actions will crash
getScreen() - Method in class org.sikuli.script.Region
 
getScreen() - Method in class org.sikuli.script.RobotDesktop
 
getScreen() - Method in class org.sikuli.script.Screen
getScreen(int) - Static method in class org.sikuli.script.Screen
 
getScreenContaining() - Method in class org.sikuli.script.Region
Deprecated.
Only for compatibility, to get the screen containing this region, use Region.getScreen()
getScreenImage() - Method in class org.sikuli.script.SikuliAction
 
getSelection() - Method in class org.sikuli.script.OverlayCapturePrompt
 
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. ... instead
getSikuliVersion() - Static method in class org.sikuli.script.Env
Deprecated.
use Settings.SikuliVersion
getSimilar() - Method in class org.sikuli.script.Pattern
 
getSource() - Method in class org.sikuli.script.SikuliAction
 
getTarget() - Method in class org.sikuli.script.Match
 
getTarget() - Method in class org.sikuli.script.Region
convenience method
getTarget() - Method in class org.sikuli.script.SikuliAction
 
getTargetOffset() - Method in class org.sikuli.script.Match
convenience - same as for Pattern
getTargetOffset() - Method in class org.sikuli.script.Pattern
 
getText() - Method in class org.sikuli.script.Match
 
getThrowException() - Method in class org.sikuli.script.Region
current setting for this region (see setThrowException)
getTopLeft() - Method in class org.sikuli.script.Region
 
getTopRight() - Method in class org.sikuli.script.Region
 
getType() - Method in class org.sikuli.script.SikuliAction
 
getW() - Method in class org.sikuli.script.Region
 
getWaitForVanish() - Method in class org.sikuli.script.Region
 
getWaitScanRate() - Method in class org.sikuli.script.Region
 
getX() - Method in class org.sikuli.script.Location
 
getX() - Method in class org.sikuli.script.Region
 
getY() - Method in class org.sikuli.script.Location
 
getY() - Method in class org.sikuli.script.Region
 
grow(int, int) - Method in class org.sikuli.script.Location
create a region with this point as center and the given size
grow(int) - Method in class org.sikuli.script.Location
create a region with this point as center and the given size
grow(int, int, int, int) - Method in class org.sikuli.script.Location
create a region with a corner at this point
as specified with x y
0 0 top left
0 1 bottom left
1 0 top right
1 1 bottom right
grow(Location, int, int, int, int) - Static method in class org.sikuli.script.Region
create a region with a corner at the given point
as specified with x y
0 0 top left
0 1 bottom left
1 0 top right
1 1 bottom right
same as the corresponding create method, here to be naming compatible with class Location
grow(Location, int, int) - Static method in class org.sikuli.script.Region
create a region with the given point as center and the given size
grow(Location) - Static method in class org.sikuli.script.Region
create a minimal symetric region at given point as center with size 3x3
grow(int) - Method in class org.sikuli.script.Region
create a region enlarged range pixels on each side
grow(int, int) - Method in class org.sikuli.script.Region
create a region enlarged w pixels on left and right side
and h pixels at top and bottom
grow(int, int, int, int) - Method in class org.sikuli.script.Region
create a region enlarged l pixels on left and r pixels right side
and t pixels at top side and b pixels at bottom side

H

h - Variable in class org.sikuli.script.Region
Height of the Region
h - Variable in class org.sikuli.script.ScreenImage
x, y, w, h of the stored ROI
hasNext() - Method in class org.sikuli.script.Finder
 
highlight() - Method in class org.sikuli.script.Region
Toggle the regions Highlight visibility (currently red frame)
highlight(float) - Method in class org.sikuli.script.Region
show the regions Highlight for the given time in seconds (currently red frame) if 0 - use the global Settings.SlowMotionDelay
highlight(int) - Method in class org.sikuli.script.Region
hack to implement the getLastMatch() convenience 0 means same as highlight() <.0 same as highlight(secs) if available the last match is highlighted
highlight(Region) - Method in class org.sikuli.script.ScreenHighlighter
 
highlight(Region, float) - Method in class org.sikuli.script.ScreenHighlighter
 
HOME - Static variable in class org.sikuli.script.Key
 
hover() - Method in class org.sikuli.script.Region
move the mouse pointer to region's last successful match
use center if no lastMatch
if region is a match: move to targetOffset
same as mouseMove
hover(PatternFilenameRegionMatchLocation) - Method in class org.sikuli.script.Region
move the mouse pointer to the given target location
same as mouseMove
Pattern or Filename - do a find before and use the match
Region - position at center
Match - position at match's targetOffset
Location - position at that point

I

init() - Method in class org.sikuli.script.TextRecognizer
 
initialize() - Method in class org.sikuli.script.SikuliEventManager
 
initScreen(Screen) - Method in class org.sikuli.script.Region
Detects on which Screen the Region is present.
initScreen(Screen) - Method in class org.sikuli.script.Screen
Detects on which Screen the Region is present.
INSERT - Static variable in class org.sikuli.script.Key
 
inside() - Method in class org.sikuli.script.Region
Deprecated.
only for backward compatibility
intersection(Region) - Method in class org.sikuli.script.Region
create a region that is the intersection of the given regions
IRobot - Interface in org.sikuli.script
 
IRobot.KeyMode - Enum in org.sikuli.script
 
IScreen - Interface in org.sikuli.script
 
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
isMac() - Static method in class org.sikuli.script.Env
Deprecated.
use Settings. ... instead
isObserving() - Method in class org.sikuli.script.Region
 
isWindows() - Static method in class org.sikuli.script.Env
Deprecated.
use Settings. ... instead

K

Key - Class in org.sikuli.script
 
Key() - Constructor for class org.sikuli.script.Key
 
KEY_ALT - Static variable in class org.sikuli.script.KeyModifier
Deprecated.
KEY_CMD - Static variable in class org.sikuli.script.KeyModifier
Deprecated.
KEY_CTRL - Static variable in class org.sikuli.script.KeyModifier
Deprecated.
KEY_META - Static variable in class org.sikuli.script.KeyModifier
Deprecated.
KEY_SHIFT - Static variable in class org.sikuli.script.KeyModifier
Deprecated.
KEY_WIN - Static variable in class org.sikuli.script.KeyModifier
Deprecated.
keyDown(String) - Method in interface org.sikuli.script.IRobot
 
keyDown(int) - Method in interface org.sikuli.script.IRobot
 
keyDown(int) - Method in class org.sikuli.script.Region
press and hold the given key use a constant from java.awt.event.KeyEvent which might be special in the current machine/system environment
keyDown(String) - Method in class org.sikuli.script.Region
press and hold the given keys including modifier keys
use the key constants defined in class Key,
which only provides a subset of a US-QWERTY PC keyboard layout
might be mixed with simple characters
use + to concatenate Key constants
keyDown(String) - Method in class org.sikuli.script.RobotDesktop
 
keyDown(int) - Method in class org.sikuli.script.RobotDesktop
 
KeyModifier - Class in org.sikuli.script
 
KeyModifier() - Constructor for class org.sikuli.script.KeyModifier
 
keyUp(String) - Method in interface org.sikuli.script.IRobot
 
keyUp(int) - Method in interface org.sikuli.script.IRobot
 
keyUp() - Method in interface org.sikuli.script.IRobot
 
keyUp() - Method in class org.sikuli.script.Region
release all currently pressed keys
keyUp(int) - Method in class org.sikuli.script.Region
release the given keys (see keyDown(keycode) )
keyUp(String) - Method in class org.sikuli.script.Region
release the given keys (see keyDown(keys) )
keyUp(String) - Method in class org.sikuli.script.RobotDesktop
 
keyUp(int) - Method in class org.sikuli.script.RobotDesktop
 
keyUp() - Method in class org.sikuli.script.RobotDesktop
 

L

lastScreenImage - Variable in class org.sikuli.script.Screen
 
LEFT - Static variable in class org.sikuli.script.Button
 
LEFT - Static variable in class org.sikuli.script.Key
 
left(int) - Method in class org.sikuli.script.Location
creates a point at the given offset to the left, might be negative
might create a point outside of any screen, not checked
left() - Method in class org.sikuli.script.Region
create a region left of the left side with same height
the new region extends to the left screen border
use grow() to include the current region
left(int) - Method in class org.sikuli.script.Region
create a region left of the left side with same height and given width
use grow() to include the current region
leftAt() - Method in class org.sikuli.script.Region
 
leftAt(int) - Method in class org.sikuli.script.Region
negative offset goes to the left
might be off current screen
listText() - Method in class org.sikuli.script.Region
VERY EXPERIMENTAL: returns a list of matches, that represent single words, that have been found in this region
the match's x,y,w,h the region of the word
Match.getText() returns the word (utf8) at this match
Match.getScore() returns a value between 0 ...
listText(ScreenImage, Region) - Method in class org.sikuli.script.TextRecognizer
 
listText(ScreenImage, Region, TextRecognizer.ListTextMode) - Method in class org.sikuli.script.TextRecognizer
 
Location - Class in org.sikuli.script
A point like AWT.Point using global coordinates, hence modifications might move location out of any screen (not checked as is done with region)
Location(float, float) - 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
 
Location(Location) - Constructor for class org.sikuli.script.Location
 
Location(Point) - Constructor for class org.sikuli.script.Location
 

M

main(String[]) - Static method in class org.sikuli.script.SikuliX
can be used in IDE's to run scripts
Match - Class in org.sikuli.script
holds the result of a find operation, is itself the region on the screen, where the image was found and hence inherits all methods from Region
attributes:
the match score (0 ...
Match(Match) - Constructor for class org.sikuli.script.Match
create a copy of Match object
to e.g.
Match(int, int, int, int, double, Screen, String) - Constructor for class org.sikuli.script.Match
internally used constructor by TextRecognizer.listText()
Match(FindResult, Screen) - Constructor for class org.sikuli.script.Match
internally used constructor used by find image
match - Variable in class org.sikuli.script.SikuliEvent
 
META - Static variable in class org.sikuli.script.Key
 
META - Static variable in class org.sikuli.script.KeyModifier
 
MIDDLE - Static variable in class org.sikuli.script.Button
 
MINUS - Static variable in class org.sikuli.script.Key
 
morphTo(Region) - Method in class org.sikuli.script.Region
Deprecated.
to be like AWT Rectangle API use setRect() instead
mouseClicked(MouseEvent) - Method in class org.sikuli.script.ScreenHighlighter
 
mouseDown(int) - Method in interface org.sikuli.script.IRobot
 
mouseDown(int) - Method in class org.sikuli.script.Region
press and hold the specified buttons - use + to combine Button.LEFT left mouse button Button.MIDDLE middle mouse button Button.RIGHT right mouse button
mouseDown(int) - Method in class org.sikuli.script.RobotDesktop
 
mouseEntered(MouseEvent) - Method in class org.sikuli.script.ScreenHighlighter
 
mouseExited(MouseEvent) - Method in class org.sikuli.script.ScreenHighlighter
 
mouseMove(int, int) - Method in interface org.sikuli.script.IRobot
 
mouseMove() - Method in class org.sikuli.script.Region
move the mouse pointer to the region's last successful match
same as hover
mouseMove(PatternFilenameRegionMatchLocation) - Method in class org.sikuli.script.Region
move the mouse pointer to the given target location
same as hover
Pattern or Filename - do a find before and use the match
Region - position at center
Match - position at match's targetOffset
Location - position at that point
mousePressed(MouseEvent) - Method in class org.sikuli.script.ScreenHighlighter
 
mouseReleased(MouseEvent) - Method in class org.sikuli.script.ScreenHighlighter
 
mouseUp(int) - Method in interface org.sikuli.script.IRobot
 
mouseUp() - Method in class org.sikuli.script.Region
release all currently held buttons
mouseUp(int) - Method in class org.sikuli.script.Region
release the specified mouse buttons (see mouseDown) if buttons==0, all currently held buttons are released
mouseUp(int) - Method in class org.sikuli.script.RobotDesktop
 
mouseWheel(int) - Method in interface org.sikuli.script.IRobot
 
move(int, int) - Method in class org.sikuli.script.Location
convenience: like awt point
moveFor(int, int) - Method in class org.sikuli.script.Location
moves the point the given amounts in the x and y direction, might be negative
might move point outside of any screen, not checked
moveTo(int, int) - Method in class org.sikuli.script.Location
changes the locations x and y value to the given values (moves it)
might move point outside of any screen, not checked
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
 

N

name() - Method in class org.sikuli.script.App
 
nearby() - Method in class org.sikuli.script.Region
Deprecated.
to be like AWT Rectangle API use grow() instead
nearby(int) - Method in class org.sikuli.script.Region
Deprecated.
to be like AWT Rectangle API use grow() instaed
newLocation(Location) - Method in class org.sikuli.script.Screen
creates a location on the current screen with the given point.
newRegion(Location, int, int) - Method in class org.sikuli.script.Screen
creates a region on the current screen with the given coordinate/size.
next() - Method in class org.sikuli.script.Finder
 
notifyObserver() - Method in interface org.sikuli.script.EventSubject
 
notifyObserver() - Method in class org.sikuli.script.OverlayCapturePrompt
 
notifyObserver() - Method in class org.sikuli.script.OverlayTransparentWindow
 
NUM0 - Static variable in class org.sikuli.script.Key
 
NUM1 - Static variable in class org.sikuli.script.Key
 
NUM2 - Static variable in class org.sikuli.script.Key
 
NUM3 - Static variable in class org.sikuli.script.Key
 
NUM4 - Static variable in class org.sikuli.script.Key
 
NUM5 - Static variable in class org.sikuli.script.Key
 
NUM6 - Static variable in class org.sikuli.script.Key
 
NUM7 - Static variable in class org.sikuli.script.Key
 
NUM8 - Static variable in class org.sikuli.script.Key
 
NUM9 - Static variable in class org.sikuli.script.Key
 
NUM_LOCK - Static variable in class org.sikuli.script.Key
 

O

observe() - Method in class org.sikuli.script.Region
 
observe(double) - Method in class org.sikuli.script.Region
 
observeInBackground(double) - Method in class org.sikuli.script.Region
 
offset(int, int) - Method in class org.sikuli.script.Location
creates a point at the given offset, might be negative
might create a point outside of any screen, not checked
offset(Location) - Method in class org.sikuli.script.Region
create region with same size at top left corner offset
offset(int, int) - Method in class org.sikuli.script.Region
create region with same size at top left corner offset
onAppear(PatternOrString, Object) - Method in class org.sikuli.script.Region
 
onChange(int, Object) - Method in class org.sikuli.script.Region
 
onChange(SikuliEventObserver) - Method in class org.sikuli.script.Region
 
onVanish(PatternOrString, Object) - Method in class org.sikuli.script.Region
 
open(String) - Static method in class org.sikuli.script.App
 
open() - Method in class org.sikuli.script.App
 
org.sikuli.script - package org.sikuli.script
 
OverlayAnimator - Interface in org.sikuli.script
 
OverlayCapturePrompt - Class in org.sikuli.script
 
OverlayCapturePrompt(Screen, EventObserver) - Constructor for class org.sikuli.script.OverlayCapturePrompt
 
OverlayTransparentWindow - Class in org.sikuli.script
 
OverlayTransparentWindow() - Constructor for class org.sikuli.script.OverlayTransparentWindow
 
OverlayTransparentWindow(Color, EventObserver) - Constructor for class org.sikuli.script.OverlayTransparentWindow
 

P

PAGE_DOWN - Static variable in class org.sikuli.script.Key
 
PAGE_UP - Static variable in class org.sikuli.script.Key
 
paint(Graphics) - Method in class org.sikuli.script.OverlayCapturePrompt
 
paint(Graphics) - Method in class org.sikuli.script.ScreenHighlighter
 
paste(String) - Method in class org.sikuli.script.Region
pastes the text at the current position of the focus/carret
using the clipboard and strg/ctrl/cmd-v (paste keyboard shortcut)
paste(PatternFilenameRegionMatchLocation, String) - Method in class org.sikuli.script.Region
first does a click(target) at the given target position to gain focus/carret
and then pastes the text
using the clipboard and strg/ctrl/cmd-v (paste keyboard shortcut)
Pattern - Class in org.sikuli.script
to define a more complex search target
- non-standard minimum similarity
- click target other than center
- image as in-memory image
Pattern() - Constructor for class org.sikuli.script.Pattern
creates empty Pattern object at least setFilename() or setImage() must be used before the Pattern object is ready for anything
Pattern(Pattern) - Constructor for class org.sikuli.script.Pattern
create a new Pattern from another (attribs are copied)
Pattern(String) - Constructor for class org.sikuli.script.Pattern
create a Pattern with an image file name
checked only when used
see checkFile()
Pattern(BufferedImage) - Constructor for class org.sikuli.script.Pattern
A Pattern from a BufferedImage ** not tested yet totally **
Pattern(ScreenImage) - Constructor for class org.sikuli.script.Pattern
A Pattern from a ScreenImage ** not tested yet totally **
pattern - Variable in class org.sikuli.script.SikuliEvent
 
PAUSE - Static variable in class org.sikuli.script.Key
 
pressModifiers(int) - Method in interface org.sikuli.script.IRobot
 
pressModifiers(int) - Method in class org.sikuli.script.RobotDesktop
 
primaryScreen - Static variable in class org.sikuli.script.Screen
 
PRINTSCREEN - Static variable in class org.sikuli.script.Key
 
PROMPT - Static variable in exception org.sikuli.script.FindFailed
 
prompt(String, int) - Method in class org.sikuli.script.OverlayCapturePrompt
 
prompt(int) - Method in class org.sikuli.script.OverlayCapturePrompt
 
prompt() - Method in class org.sikuli.script.OverlayCapturePrompt
 
prompt(String) - Method in class org.sikuli.script.OverlayCapturePrompt
 
prompt - Variable in class org.sikuli.script.Screen
 

R

recognize(ScreenImage) - Method in class org.sikuli.script.TextRecognizer
 
recognize(BufferedImage) - Method in class org.sikuli.script.TextRecognizer
 
recognizeWord(ScreenImage) - Method in class org.sikuli.script.TextRecognizer
 
recognizeWord(BufferedImage) - Method in class org.sikuli.script.TextRecognizer
 
Region - Class in org.sikuli.script
A Region always lies completely inside its parent screen
Region(int, int, int, int, int) - Constructor for class org.sikuli.script.Region
Create a region with the provided coordinate / size and screen
Region(int, int, int, int, Screen) - Constructor for class org.sikuli.script.Region
Create a region with the provided coordinate / size and screen
Region(int, int, int, int) - Constructor for class org.sikuli.script.Region
Create a region with the provided coordinate / size
Region(Rectangle) - Constructor for class org.sikuli.script.Region
Create a region from a Rectangle
Region(Region) - Constructor for class org.sikuli.script.Region
Create a new region from another region
including the region's settings
Region() - Constructor for class org.sikuli.script.Region
internal use only, used for new Screen objects to get the Region behavior
region - Variable in class org.sikuli.script.SikuliEvent
 
regionOnScreen(Screen) - Method in class org.sikuli.script.Region
Checks if the Screen contains the Region.
releaseModifiers(int) - Method in interface org.sikuli.script.IRobot
 
releaseModifiers(int) - Method in class org.sikuli.script.RobotDesktop
 
remove() - Method in class org.sikuli.script.Finder
not used
removeAppearObserver(PSC) - Method in class org.sikuli.script.SikuliEventManager
 
removeChangeObserver(int) - Method in class org.sikuli.script.SikuliEventManager
 
removeHotkey(String, int) - Static method in class org.sikuli.script.Env
Deprecated.
use Key. ... instead
removeHotkey(char, int) - Static method in class org.sikuli.script.Env
Deprecated.
use Key. ... instead
removeListener(SikuliActionListener) - Method in class org.sikuli.script.SikuliActionManager
 
removeVanishObserver(PSC) - Method in class org.sikuli.script.SikuliEventManager
 
repeat() - Method in class org.sikuli.script.SikuliEvent
 
repeat(long) - Method in class org.sikuli.script.SikuliEvent
 
repeat(SikuliEvent.Type, Object, Match, long) - Method in class org.sikuli.script.SikuliEventManager
 
resetMonitors() - Static method in class org.sikuli.script.Screen
re-initialize the monitor setup (e.g.
resetScreens() - Method in class org.sikuli.script.Region
synonym for resetMonitors
RETRY - Static variable in exception org.sikuli.script.FindFailed
 
RIGHT - Static variable in class org.sikuli.script.Button
 
RIGHT - Static variable in class org.sikuli.script.Key
 
right(int) - Method in class org.sikuli.script.Location
creates a point at the given offset to the right, might be negative
might create a point outside of any screen, not checked
right() - Method in class org.sikuli.script.Region
create a region right of the right side with same height
the new region extends to the right screen border
use grow() to include the current region
right(int) - Method in class org.sikuli.script.Region
create a region right of the right side with same height and given width
use grow() to include the current region
rightAt() - Method in class org.sikuli.script.Region
 
rightAt(int) - Method in class org.sikuli.script.Region
positive offset goes to the right
might be off current screen
rightClick() - Method in class org.sikuli.script.Region
right click at the region's last successful match
use center if no lastMatch
if region is a match: click targetOffset
rightClick(PatternFilenameRegionMatchLocation) - 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(PatternFilenameRegionMatchLocation, int) - 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
rightClickTarget(Region, PSRML, ScreenImage, Match) - Method in class org.sikuli.script.SikuliActionManager
 
robot - Variable in class org.sikuli.script.Screen
 
RobotDesktop - Class in org.sikuli.script
 
RobotDesktop(Screen) - Constructor for class org.sikuli.script.RobotDesktop
 
running() - Method in interface org.sikuli.script.OverlayAnimator
 

S

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 containd in the screen area might have negative x and/or y values)
The screens are aranged in an array (index = id) and each screen is always the same object (not possible to create new objects).
Screen(int) - Constructor for class org.sikuli.script.Screen
Is the screen object at the given id
Screen() - Constructor for class org.sikuli.script.Screen
Is the screen object having the top left corner as (0,0).
ScreenHighlighter - Class in org.sikuli.script
 
ScreenHighlighter(Screen) - Constructor for class org.sikuli.script.ScreenHighlighter
 
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
screens - Static variable in class org.sikuli.script.Screen
 
ScreenUnion - Class in org.sikuli.script
 
ScreenUnion() - Constructor for class org.sikuli.script.ScreenUnion
 
SCROLL_LOCK - Static variable in class org.sikuli.script.Key
 
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
 
setAutoDelay(int) - Method in interface org.sikuli.script.IRobot
 
setAutoWaitTimeout(double) - Method in class org.sikuli.script.Region
the time in seconds a find operation should wait for the appearence of the target in this region
initial value 3 secs
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
setCenter(Location) - Method in class org.sikuli.script.Region
Moves the region to the area, whose center is the given location
setClipboard(String) - Static method in class org.sikuli.script.App
 
setClipboard(String) - Static method in class org.sikuli.script.Env
Deprecated.
use App. ... instead
setEvtMgr(SikuliEventManager) - Method in class org.sikuli.script.Region
 
setFilename(String) - Method in class org.sikuli.script.Pattern
set the Patterns image file name It is only checked if Pattern is used or with getFilename()
setFindFailedResponse(FindFailedResponse) - Method in class org.sikuli.script.Region
FindFailedResponse.
ABORT - (initial value) abort script on FindFailed (= setThrowException(true) )
SKIP - ignore FindFailed (same as setThrowException(false) )
PROMPT - display prompt on FindFailed to let user decide how to proceed
RETRY - continue to wait for appearence on FindFailed (caution: endless loop)
setH(int) - Method in class org.sikuli.script.Region
 
setImage(String) - Method in class org.sikuli.script.Match
internal use: set the image filename after finding with success
setImage(BufferedImage) - Method in class org.sikuli.script.Pattern
sets the Pattern's image
setImage(ScreenImage) - Method in class org.sikuli.script.Pattern
sets the Pattern's image
setLocation(int, int) - Method in class org.sikuli.script.Location
sets the coordinates to the given values
setLocation(float, float) - Method in class org.sikuli.script.Location
sets the coordinates to the given values
setLocation(Location) - Method in class org.sikuli.script.Region
set the regions position
this might move the region even to another screen
setMatch(Match) - Method in class org.sikuli.script.SikuliAction
 
setObserveScanRate(float) - Method in class org.sikuli.script.Region
set the regions individual ObserveScanRate
setOpacity(float) - Method in class org.sikuli.script.OverlayTransparentWindow
 
setRect(Rectangle) - Method in class org.sikuli.script.Region
set the regions position/size
this might move the region even to another screen
setRect(int, int, int, int) - Method in class org.sikuli.script.Region
set the regions position/size
this might move the region even to another screen
setRect(Region) - Method in class org.sikuli.script.Region
set the regions position/size
this might move the region even to another screen
setRegion(Region) - Method in class org.sikuli.script.SikuliEventManager
 
setRepeating() - Method in class org.sikuli.script.Finder
internal use: to be able to reuse the same Finder
setROI(int, int, int, int) - Method in class org.sikuli.script.Region
resets this region to the given location, and size
this might move the region even to another screen Because of the wanted side effect for the containing screen, this should only be used with screen objects.
setROI(Rectangle) - Method in class org.sikuli.script.Region
resets this region to the given rectangle
this might move the region even to another screen Because of the wanted side effect for the containing screen, this should only be used with screen objects.
setROI(Region) - Method in class org.sikuli.script.Region
resets this region to the given region
this might move the region even to another screen Because of the wanted side effect for the containing screen, this should only be used with screen objects.
setScreen(Screen) - Method in class org.sikuli.script.Region
Sets a new Screen for this region.
setScreen(int) - Method in class org.sikuli.script.Region
Sets a new Screen for this region.
setScreen(Screen) - Method in class org.sikuli.script.Screen
Sets a new Screen for this region.
setScreenImage(ScreenImage) - Method in class org.sikuli.script.Finder
internal use: exchange the source image in existing Finder
setScreenImage(ScreenImage) - Method in class org.sikuli.script.SikuliAction
 
setSize(int, int) - Method in class org.sikuli.script.Region
 
setSource(Region) - Method in class org.sikuli.script.SikuliAction
 
setTarget(Object) - Method in class org.sikuli.script.SikuliAction
 
setTargetOffset(Location) - Method in class org.sikuli.script.Match
like Pattern.TargetOffset sets the click target by offset relative to the center
setTargetOffset(int, int) - Method in class org.sikuli.script.Match
like Pattern.TargetOffset sets the click target relative to the center
setThrowException(boolean) - Method in class org.sikuli.script.Region
true - (initial setting) should throw exception FindFailed if find unsuccessful in this region
false - do not abort script on FindFailed (might leed to null pointer exceptions later)
setTimeAfter(int) - Method in class org.sikuli.script.Pattern
set the seconds to wait, after this pattern is acted on
setTimeAfter() - Method in class org.sikuli.script.Pattern
get the seconds to wait, after this pattern is acted on
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(SikuliAction.ActionType) - Method in class org.sikuli.script.SikuliAction
 
setW(int) - Method in class org.sikuli.script.Region
 
setWaitForVanish(int) - Method in class org.sikuli.script.Region
set the regions individual WaitForVanish
setWaitScanRate(float) - Method in class org.sikuli.script.Region
set the regions individual WaitScanRate
setX(int) - Method in class org.sikuli.script.Region
 
setY(int) - Method in class org.sikuli.script.Region
 
SHIFT - Static variable in class org.sikuli.script.Key
 
SHIFT - Static variable in class org.sikuli.script.KeyModifier
 
showMonitors() - Static method in class org.sikuli.script.Screen
show the current monitor setup
showScreens() - Method in class org.sikuli.script.Region
synonym for showMonitors
showTarget(Location) - Method in class org.sikuli.script.Screen
 
showTarget(Location, double) - Method in class org.sikuli.script.Screen
 
showTarget(Location, float) - Method in class org.sikuli.script.ScreenHighlighter
 
SikuliAction - Class in org.sikuli.script
 
SikuliAction(SikuliAction.ActionType, Region, PSC, ScreenImage, Match) - Constructor for class org.sikuli.script.SikuliAction
 
SikuliAction.ActionType - Enum in org.sikuli.script
 
SikuliActionListener - Interface in org.sikuli.script
 
SikuliActionManager - Class in org.sikuli.script
 
SikuliEvent - Class in org.sikuli.script
 
SikuliEvent() - Constructor for class org.sikuli.script.SikuliEvent
 
SikuliEvent(Object, Match, Region) - Constructor for class org.sikuli.script.SikuliEvent
 
SikuliEvent.Type - Enum in org.sikuli.script
 
SikuliEventAdapter - Class in org.sikuli.script
 
SikuliEventAdapter() - Constructor for class org.sikuli.script.SikuliEventAdapter
 
SikuliEventAppear - Class in org.sikuli.script
 
SikuliEventAppear(Object, Match, Region) - Constructor for class org.sikuli.script.SikuliEventAppear
 
SikuliEventChange - Class in org.sikuli.script
 
SikuliEventChange(List<Match>, Region) - Constructor for class org.sikuli.script.SikuliEventChange
 
SikuliEventManager - Class in org.sikuli.script
 
SikuliEventManager(Region) - Constructor for class org.sikuli.script.SikuliEventManager
 
SikuliEventManager.State - Enum in org.sikuli.script
 
SikuliEventObserver - Interface in org.sikuli.script
 
SikuliEventVanish - Class in org.sikuli.script
 
SikuliEventVanish(Object, Match, Region) - Constructor for class org.sikuli.script.SikuliEventVanish
 
SikuliException - Exception in org.sikuli.script
 
SikuliException(String) - Constructor for exception org.sikuli.script.SikuliException
 
SikuliVersion - Static variable in class org.sikuli.script.Env
Deprecated.
use Settings.getVersion() instead
SikuliX - Class in org.sikuli.script
 
SikuliX() - Constructor for class org.sikuli.script.SikuliX
 
similar(float) - Method in class org.sikuli.script.Pattern
sets the minimum Similarity to use with find
SKIP - Static variable in exception org.sikuli.script.FindFailed
 
smoothMove(Location) - Method in interface org.sikuli.script.IRobot
 
smoothMove(Location, Location, long) - Method in interface org.sikuli.script.IRobot
 
smoothMove(Location) - Method in class org.sikuli.script.RobotDesktop
 
smoothMove(Location, Location, long) - Method in class org.sikuli.script.RobotDesktop
 
SPACE - Static variable in class org.sikuli.script.Key
 
step() - Method in interface org.sikuli.script.OverlayAnimator
 
stopObserver() - Method in class org.sikuli.script.Region
 
stopObserver() - Method in class org.sikuli.script.SikuliEvent
 

T

TAB - Static variable in class org.sikuli.script.Key
 
targetAppeared(SikuliEventAppear) - Method in class org.sikuli.script.SikuliEventAdapter
 
targetAppeared(SikuliEventAppear) - Method in interface org.sikuli.script.SikuliEventObserver
 
targetChanged(SikuliEventChange) - Method in class org.sikuli.script.SikuliEventAdapter
 
targetChanged(SikuliEventChange) - Method in interface org.sikuli.script.SikuliEventObserver
 
targetClicked(SikuliAction) - Method in interface org.sikuli.script.SikuliActionListener
 
targetDoubleClicked(SikuliAction) - Method in interface org.sikuli.script.SikuliActionListener
 
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
targetRightClicked(SikuliAction) - Method in interface org.sikuli.script.SikuliActionListener
 
targetVanished(SikuliEventVanish) - Method in class org.sikuli.script.SikuliEventAdapter
 
targetVanished(SikuliEventVanish) - Method in interface org.sikuli.script.SikuliEventObserver
 
testSetup() - Static method in class org.sikuli.script.SikuliX
 
text() - Method in class org.sikuli.script.Region
STILL EXPERIMENTAL: tries to read the text in this region
might contain misread characters, NL characters and other stuff, when interpreting contained grafics as text
Best results: one line of text with no grafics in the line
TextRecognizer - Class in org.sikuli.script
 
TextRecognizer() - Constructor for class org.sikuli.script.TextRecognizer
 
TextRecognizer.ListTextMode - Enum in org.sikuli.script
 
toGlobalCoord(Match) - Method in class org.sikuli.script.Region
used in SikuliEventManager.callChangeObserver, Finder.next to adjust region relative coordinates of matches to screen coordinates
toJavaKeyCode(String) - Static method in class org.sikuli.script.Key
Convert Sikuli Key to Java virtual key code
toJavaKeyCode(char) - Static method in class org.sikuli.script.Key
Convert Sikuli Key to Java virtual key code
toJavaKeyCodeText(char) - Static method in class org.sikuli.script.Key
 
toString() - Method in class org.sikuli.script.App
 
toString() - Method in class org.sikuli.script.Location
toString() - Method in class org.sikuli.script.Match
 
toString() - Method in class org.sikuli.script.Pattern
 
toString() - Method in class org.sikuli.script.Region
toString() - Method in class org.sikuli.script.Screen
 
toString() - Method in class org.sikuli.script.SikuliEvent
 
toString() - Method in class org.sikuli.script.SikuliEventChange
 
toString() - Method in exception org.sikuli.script.SikuliException
 
toStringShort() - Method in class org.sikuli.script.Location
 
toStringShort() - Method in class org.sikuli.script.Match
 
toStringShort() - Method in class org.sikuli.script.Region
 
toStringShort() - Method in class org.sikuli.script.Screen
only a short version of toString()
translate(int, int) - Method in class org.sikuli.script.Location
convenience: like awt point
type(String) - Method in class org.sikuli.script.Region
enters the given text one character/key after another using keyDown/keyUp
about the usable Key constants see keyDown(keys)
Class Key only provides a subset of a US-QWERTY PC keyboard layout
the text is entered at the current position of the focus/carret
type(String, int) - Method in class org.sikuli.script.Region
enters the given text one character/key after another using keyDown/keyUp
while holding down the given modifier keys
about the usable Key constants see keyDown(keys)
Class Key only provides a subset of a US-QWERTY PC keyboard layout
the text is entered at the current position of the focus/carret
type(String, String) - Method in class org.sikuli.script.Region
enters the given text one character/key after another using keyDown/keyUp
while holding down the given modifier keys
about the usable Key constants see keyDown(keys)
Class Key only provides a subset of a US-QWERTY PC keyboard layout
the text is entered at the current position of the focus/carret
type(PatternFilenameRegionMatchLocation, String) - Method in class org.sikuli.script.Region
first does a click(target) at the given target position to gain focus/carret
enters the given text one character/key after another using keyDown/keyUp
about the usable Key constants see keyDown(keys)
Class Key only provides a subset of a US-QWERTY PC keyboard layout
type(PatternFilenameRegionMatchLocation, 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(PatternFilenameRegionMatchLocation, 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
type - Variable in class org.sikuli.script.SikuliEvent
 
typeChar(char, IRobot.KeyMode) - Method in interface org.sikuli.script.IRobot
 
typeChar(char, IRobot.KeyMode) - Method in class org.sikuli.script.RobotDesktop
 

U

union(Region) - Method in class org.sikuli.script.Region
create a new region containing both regions
UP - Static variable in class org.sikuli.script.Key
 
update(EventSubject) - Method in interface org.sikuli.script.EventObserver
 
update(EventSubject) - Method in class org.sikuli.script.Screen
Internal use only
update(ScreenImage) - Method in class org.sikuli.script.SikuliEventManager
 
updateSelf() - Method in class org.sikuli.script.Region
 
useFullscreen() - Method in class org.sikuli.script.Screen
 
useFullscreen() - Method in class org.sikuli.script.ScreenUnion
 
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

V

valueOf(String) - Static method in enum org.sikuli.script.FindFailedResponse
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.sikuli.script.IRobot.KeyMode
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.sikuli.script.SikuliAction.ActionType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.sikuli.script.SikuliEvent.Type
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.sikuli.script.SikuliEventManager.State
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.sikuli.script.TextRecognizer.ListTextMode
Returns the enum constant of this type with the specified name.
values() - Static method in enum org.sikuli.script.FindFailedResponse
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.sikuli.script.IRobot.KeyMode
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.sikuli.script.SikuliAction.ActionType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.sikuli.script.SikuliEvent.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.SikuliEventManager.State
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.sikuli.script.TextRecognizer.ListTextMode
Returns an array containing the constants of this enum type, in the order they are declared.

W

w - Variable in class org.sikuli.script.Region
Width of the Region
w - Variable in class org.sikuli.script.ScreenImage
x, y, w, h of the stored ROI
wait(double) - Method in class org.sikuli.script.Region
WARNING: wait(long timeout) is taken by Java Object as final.
wait(PatternOrString) - Method in class org.sikuli.script.Region
Waits for the PatternOrString to appear
wait(PatternOrString, double) - Method in class org.sikuli.script.Region
Match wait(Pattern/String/PatternClass target, timeout-sec) waits until target appears or timeout (in second) is passed
waitForIdle() - Method in interface org.sikuli.script.IRobot
 
waitPrompt - Variable in class org.sikuli.script.Screen
 
waitVanish(PatternOrString) - Method in class org.sikuli.script.Region
boolean waitVanish(Pattern/String/PatternClass target, timeout-sec) waits until target vanishes or timeout (in second) is passed
waitVanish(PatternOrString, double) - Method in class org.sikuli.script.Region
boolean waitVanish(Pattern/String/PatternClass target, timeout-sec) waits until target vanishes or timeout (in second) is passed
wheel(int, int) - Method in class org.sikuli.script.Region
Move the wheel at the current mouse position
the given steps in the given direction:
Button.WHEEL_DOWN, Button.WHEEL_UP
wheel(PatternFilenameRegionMatchLocation, int, int) - Method in class org.sikuli.script.Region
move the mouse pointer to the given target location
and move the wheel the given steps in the given direction:
Button.WHEEL_DOWN, Button.WHEEL_UP
WHEEL_DOWN - Static variable in class org.sikuli.script.Button
 
WHEEL_UP - Static variable in class org.sikuli.script.Button
 
WIN - Static variable in class org.sikuli.script.Key
 
WIN - Static variable in class org.sikuli.script.KeyModifier
 
window() - Method in class org.sikuli.script.App
 
window(int) - Method in class org.sikuli.script.App
 

X

x - Variable in class org.sikuli.script.Location
 
x - Variable in class org.sikuli.script.Region
X-coordinate of the Region
x - Variable in class org.sikuli.script.ScreenImage
x, y, w, h of the stored ROI

Y

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

_

_appName - Variable in class org.sikuli.script.App
 
_filename - Variable in class org.sikuli.script.ScreenImage
 
_img - Variable in class org.sikuli.script.ScreenImage
 
_instance - Static variable in class org.sikuli.script.TextRecognizer
 
_name - Variable in exception org.sikuli.script.SikuliException
 
_osUtil - Static variable in class org.sikuli.script.App
 
_pid - Variable in class org.sikuli.script.App
 
_roi - Variable in class org.sikuli.script.ScreenImage
 
A B C D E F G H I K L M N O P R S T U V W X Y _