Skip to content
This repository has been archived by the owner on Mar 14, 2018. It is now read-only.

Home

Jump to bottom
RaiMan edited this page Sep 13, 2014 · 14 revisions

Welcome to the SikuliX-2014 wiki!

More information related to the Maven aspects in this project
How to produce the ready_to_use jar packages

Hints for usage in IDEs (Eclipse, ...) with Java programming and scripting with Jython

Some information on new features usable with scripting and Java programming

  • It is based on the Java API. Specials to take into account on the script level are mentioned if applicable.

  • As in previous versions: the methods of class Region can be used in Sikuli scripts without qualification (e.g. click() instead of some_region.click() ) if they address the primary screen (internally they are mapped to the "constant" object SCREEN, which is initialized to Screen(0) at start of IDE)

A full documentation of the Java API (Java docs) can be found here

Since in the following new or changed functions you only get a short note, currently you have to look into the Java API docs for a more detailed description of feature, parameters and return values.

The docs for scripting are still work in progress.

Class Region Tried to make it as compatible as possible to java.awt.Rectangle.
Generally all methods are revised to return the region if possible for dot chains.

  • create a new region with the given point as one of its corners and a given width/height
  • create, grow, offset
  • create a new region based on a given region - enlarge on all sides, on left/right or at the given sides
  • grow
  • create a new region based on 2 other regions
  • intersection, union
  • create same region on another screen
  • copyTo
  • change a regions location
  • setCenter, setLocation/setTopLeft, setTopRight, setBottomLeft, setBottomRight
  • change a regions size
  • setSize
  • change a regions size (and eventually location) by adding a point or region
  • add
  • define points with a given offset to the middle point of a region's edge
  • leftAt, topAt, rightAt, buttomAt
  • check wether a region contains another region, a point or the mousepointer
  • contains, containsMouse
  • get location of mouse pointer
  • atMouse (long term replacement for Env.getMouseLocation)
  • get the last screen image taken for this regions screen and optionally save it to a file
  • getLastScreenImage, getLastScreenImageFile
  • act on the regions last match (shortcut for action(reg.getLastMatch()) or the center, if no last match
  • use the action methods (click, ...) without parameters
  • for highlight() there is a hack: use negative duration value
  • the log message of type() has been made "readable"

Class Screen Support for multi monitor environments and coordinated mouse and keyboard handling will be further improved with version 1.1.

  • log the current monitor setup
  • showMonitors (showScreens on script level)
  • experimental: reset the monitor setup on the fly
  • resetMonitors (resetScreens on script level)

Class Location Made as similar to java.awt.Point as it makes sense.

  • create new regions based on this point
  • grow
  • change the points location
  • moveFor, moveTo
  • get the color at a point
  • getColor (be aware: too slow, to use it in a loop on very many points)
  • get a point with same relative location on other screen
  • copyTo

Class Pattern

  • exact() internally is taken as 0.99

Class Env all methods have been delegated to other classes and the class itself and its methods are marked deprecated.

Clone this wiki locally