Package org.sikuli.script

  • Class Summary 
    Class Description
    App
    App implements features to manage (open, switch to, close) applications.
    Button
    Defines the constants for use with the mouse actions for the button to use and the wheel direction
    Constants
    reasonable symbolic constants to be used with Sikuli features
    Element
    INTERNAL: An abstract super-class for Region and Image.
    Env
    features moved to other classes, details below with the methods
    Finder  
    Finder.Finder2  
    Image
    This class hides the complexity behind image names given as string.
    ImageCallback  
    ImagePath
    maintain the path list of locations, where images will be searched.
    ImagePath.PathEntry
    represents an imagepath entry
    Key
    this class implements an interface to the Java key system as represented by java.awt.event.KeyEvent.
    KeyModifier
    complementing class Key with the constants for the modifier keys
    only still there for backward compatibility (is already duplicated in Key)
    Location
    A point like AWT.Point using global coordinates (x, y).
    Match
    The region on the screen or rectangle in the image, where the given image or text was found.
    Mouse
    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.
    ObserveEvent
    provides information about the observed event being in the ObserverCallBack
    ObserverCallBack
    Use this class to implement callbacks for
    the Region observers onAppear, onVanish and onChange.
    OCR
    Static helper class for OCR via Tess4J/Tesseract.
    OCR.Options
    A container for the options relevant for using OCR on Regions or Images.
    Offset  
    Options  
    Pattern
    to define a more complex search target
    - non-standard minimum similarity
    - click target other than center
    - image as in-memory image
    Region
    A Region is a rectengular area on a screen.
    Screen
    A screen represents a physical monitor with its coordinates and size according to the global point system: the screen areas are grouped around a point (0,0) like in a cartesian system (the top left corner and the points contained in the screen area might have negative x and/or y values)
    The screens are arranged in an array (index = id) and each screen is always the same object (not possible to create new objects).
    ScreenImage
    CANDIDATE FOR DEPRECATION stores a BufferedImage usually ceated by screen capture, the screen rectangle it was taken from and the filename, where it is stored as PNG (only if requested) This will be replaced by Image in the long run
    SikuliEvent
    CANDIDATE FOR DEPRECATION - ONLY HERE TO BE BACKWARD COMPATIBLE
    Sikulix  
    SikulixForJython
    Can be used in pure Jython environments to add the Sikuli Python API to sys.path
    Usage: (before any Sikuli features are used)
    import org.sikuli.script.SikulixForJython
    from sikuli import *
    SX  
    SX.Log  
    TextRecognizer
    Intended to be used only internally - still public for being backward compatible
  • Enum Summary 
    Enum Description
    App.Type  
    FindFailedResponse
    INTERNAL USE
    Image.Interpolation
    Available resize interpolation algorithms
    ObserveEvent.Type  
    OCR.OEM
    OCR Engine modes.
    OCR.PSM
    Page segmentation modes.
  • Exception Summary 
    Exception Description
    FindFailed
    SikuliX FindFailed exception
    constants and settings for the features
    FindFailedResponse
    FindFailedHandler
    ImageMissingHandler
    SikuliException
    INTERNAL USE
    SikuliXception
    INTERNAL USE