Package org.sikuli.api

Provides the classes necessary to find targets and the classes to create screen regions and locations.

See:
          Description

Interface Summary
Location The Location interface provides definitions for the objects that represent a location on the screen coordinate.
Region The Region interface provides definitions for the objects that represent a Region.
Screen The Screen interface provides definitions for the objects that represent a Screen.
ScreenLocation The ScreenLocation interface provides definitions for the objects that represent a location on any screen coordinate.
ScreenRegion The ScreenRegion interface provides definitions for the objects that represent regions of the screen.
Target The Target interface allows you to specify what targets to find or wait for and also to specify several control parameters.
 

Class Summary
AbstractScreenRegion AbstractScreenRegion is the abstract base class for all screen region contexts.
API API class that defines a set of methods that perform common operations in the API.
ColorImageTarget The ColorImageTarget class defines targets based on color patterns.
DefaultLocation The DefaultLocation class is used to describe a location on the screen coordinate.
DefaultRegion The DefaultRegion class is used to describe a region of the screen.
DefaultScreenLocation This class provides manipulation methods that can be used for the default screen location.
DefaultScreenRegion This class provides manipulation methods that can be used by the default screen region.
DefaultTarget DefaultTarget is the abstract base class for all targets.
DesktopScreenLocation This DesktopScreenLocation class represents a screen location and its corresponding screen.
DesktopScreenRegion A DesktopScreenRegion object is used to describe a region of any DesktopScreen.
ForegroundTarget The ForegroundTarget class defines targets based on whether they have textures (as opposed to textureless background).
ImageTarget An ImageTarget object describes a target using an image.
MultiStateTarget The MultiStateTarget class defines a target that may look differently according its state.
Relative The Relative class provides new regions relative to the region of a screen region object.
Relative.RelativeScreenLocationBuilder A RelativeScreenLocationBuilder represents a copy of the original ScreenLocation.
Relative.RelativeScreenRegionBuilder A RelativeScreenRegionBuilder represents a copy of the original ScreenRegion.
StaticImageScreen StaticImageScreen class implements a Screen that behaves as if it *always* displays a given image.
StaticImageScreenRegion StaticImageScreenRegion class behaves like a ScreenRegion but it always provides a given image as the screenshot.
StyledRectangleTarget StyledRectangleTarget class is used to identify rectangular targets that have a particular rectangle style (lines and corners) while ignoring the content inside the rectangle.
 

Enum Summary
Target.Ordering Defines a set of constants to use to indicate how multiple targets should be ordered by find functions
 

Exception Summary
SikuliRuntimeException  
 

Package org.sikuli.api Description

Provides the classes necessary to find targets and the classes to create screen regions and locations.



Copyright © 2014. All rights reserved.