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

A

above(int) - Method in class org.sikuli.api.Relative.RelativeScreenLocationBuilder

Returns a new RelativeScreenLocationBuilder object that is above this ScreenLocation by the specified amount.

above(int) - Method in class org.sikuli.api.Relative.RelativeScreenRegionBuilder

Returns a new RelativeScreenRegionBuilder object that is above this ScreenRegion by the specified amount.

above(Region) - Method in class org.sikuli.api.visual.CanvasBuilder.LabelElementPlacementSetter

above(int) - Method in class org.sikuli.api.visual.CanvasBuilder.RelativeToRegion

AbstractScreenRegion - Class in org.sikuli.api

AbstractScreenRegion is the abstract base class for all screen region contexts.

AbstractScreenRegion(Screen) - Constructor for class org.sikuli.api.AbstractScreenRegion

Constructs a new AbstractScreenRegion object whose Screen is the specified Screen object, and upper-left corner is at (0, 0) in the coordinate space.

AbstractScreenRegion(Screen, int, int, int, int) - Constructor for class org.sikuli.api.AbstractScreenRegion

Constructs a new AbstractScreenRegion object.

ADD - Static variable in class org.sikuli.api.robot.Key

add(Element) - Method in class org.sikuli.api.visual.Canvas

add() - Method in class org.sikuli.api.visual.Canvas

addBox(Region) - Method in class org.sikuli.api.visual.Canvas

Deprecated.

addCircle(Location, int) - Method in class org.sikuli.api.visual.Canvas

Deprecated.

addDot(Location) - Method in class org.sikuli.api.visual.Canvas

Deprecated.

addImage(Location, BufferedImage) - Method in class org.sikuli.api.visual.Canvas

Deprecated.

addLabel(Region, String) - Method in class org.sikuli.api.visual.Canvas

Deprecated.

addLabel(Location, String) - Method in class org.sikuli.api.visual.Canvas

Deprecated.

addListener(Element.Listener) - Method in class org.sikuli.api.visual.element.Element

addListener(ImageElement.Listener) - Method in class org.sikuli.api.visual.element.ImageElement

addListener(LabelElement.Listener) - Method in class org.sikuli.api.visual.element.LabelElement

addROI(int, int, int, int) - Method in class org.sikuli.api.DefaultScreenRegion

addROI(int, int, int, int) - Method in interface org.sikuli.api.ScreenRegion

Add a rectangular region of interest into this ScreenRegion.

addState(Target, Object) - Method in class org.sikuli.api.DefaultScreenRegion

addState(Target, Object) - Method in class org.sikuli.api.MultiStateTarget

Adds a new state to this MultiStateTarget object as represented by the presence of the given target.

addState(Target, Object) - Method in interface org.sikuli.api.ScreenRegion

Defines a new state of this screen region as represented by the presence of the given target.

addStateChangeEventListener(StateChangeListener) - Method in class org.sikuli.api.DefaultScreenRegion

addStateChangeEventListener(ScreenRegion, StateChangeListener) - Method in class org.sikuli.api.event.VisualEventManager

addStateChangeEventListener(StateChangeListener) - Method in interface org.sikuli.api.ScreenRegion

Adds a listener to handle the state changes within this screen region.

addTargetEventListener(Target, TargetEventListener) - Method in class org.sikuli.api.DefaultScreenRegion

addTargetEventListener(ScreenRegion, Target, TargetEventListener) - Method in class org.sikuli.api.event.VisualEventManager

addTargetEventListener(Target, TargetEventListener) - Method in interface org.sikuli.api.ScreenRegion

Adds a listener for a given target.

ALT - Static variable in class org.sikuli.api.robot.Key

ALT - Static variable in class org.sikuli.api.robot.KeyModifier

API - Class in org.sikuli.api

API class that defines a set of methods that perform common operations in the API.

API() - Constructor for class org.sikuli.api.API

around(int, int, int, int) - Method in class org.sikuli.api.visual.CanvasBuilder.ElementAreaSetter

around(Region) - Method in class org.sikuli.api.visual.CanvasBuilder.ElementAreaSetter

at(int, int) - Method in class org.sikuli.api.visual.CanvasBuilder.ElementPointSetter

at(Location) - Method in class org.sikuli.api.visual.CanvasBuilder.ElementPointSetter

at(Location) - Method in class org.sikuli.api.visual.CanvasBuilder.LabelElementPlacementSetter

at(int, int) - Method in class org.sikuli.api.visual.CanvasBuilder.LabelElementPlacementSetter

B

backgroundColor(Color) - Method in class org.sikuli.api.visual.element.ElementStyleSetter

Sets the background color of this canvas element.

BACKSPACE - Static variable in class org.sikuli.api.robot.Key

below(int) - Method in class org.sikuli.api.Relative.RelativeScreenLocationBuilder

Returns a new RelativeScreenLocationBuilder object that is below this ScreenLocation by the specified amount.

below(int) - Method in class org.sikuli.api.Relative.RelativeScreenRegionBuilder

Returns a new RelativeScreenRegionBuilder object that is below this ScreenRegion by the specified amount.

below(Region) - Method in class org.sikuli.api.visual.CanvasBuilder.LabelElementPlacementSetter

bottomCenter() - Method in class org.sikuli.api.Relative.RelativeScreenRegionBuilder

Returns a new RelativeScreenLocationBuilder object that corresponds to the bottom-center of this ScreenRegion.

bottomLeft() - Method in class org.sikuli.api.Relative.RelativeScreenRegionBuilder

Returns a new RelativeScreenLocationBuilder object that corresponds to the bottom-left corner of this ScreenRegion.

bottomRight() - Method in class org.sikuli.api.Relative.RelativeScreenRegionBuilder

Returns a new RelativeScreenLocationBuilder object that corresponds to the bottom-right corner of this ScreenRegion.

box() - Method in class org.sikuli.api.visual.CanvasBuilder.ElementAdder

BoxElement - Class in org.sikuli.api.visual.element

BoxElement() - Constructor for class org.sikuli.api.visual.element.BoxElement

browse(URL) - Static method in class org.sikuli.api.API

Launches the default browser to open a URL.

C

C_ADD - Static variable in class org.sikuli.api.robot.Key

C_ALT - Static variable in class org.sikuli.api.robot.Key

C_CAPS_LOCK - Static variable in class org.sikuli.api.robot.Key

C_CMD - Static variable in class org.sikuli.api.robot.Key

C_CTRL - Static variable in class org.sikuli.api.robot.Key

C_DELETE - Static variable in class org.sikuli.api.robot.Key

C_DIVIDE - Static variable in class org.sikuli.api.robot.Key

C_DOWN - Static variable in class org.sikuli.api.robot.Key

C_END - Static variable in class org.sikuli.api.robot.Key

C_ESC - Static variable in class org.sikuli.api.robot.Key

C_F1 - Static variable in class org.sikuli.api.robot.Key

C_F10 - Static variable in class org.sikuli.api.robot.Key

C_F11 - Static variable in class org.sikuli.api.robot.Key

C_F12 - Static variable in class org.sikuli.api.robot.Key

C_F13 - Static variable in class org.sikuli.api.robot.Key

C_F14 - Static variable in class org.sikuli.api.robot.Key

C_F15 - Static variable in class org.sikuli.api.robot.Key

C_F2 - Static variable in class org.sikuli.api.robot.Key

C_F3 - Static variable in class org.sikuli.api.robot.Key

C_F4 - Static variable in class org.sikuli.api.robot.Key

C_F5 - Static variable in class org.sikuli.api.robot.Key

C_F6 - Static variable in class org.sikuli.api.robot.Key

C_F7 - Static variable in class org.sikuli.api.robot.Key

C_F8 - Static variable in class org.sikuli.api.robot.Key

C_F9 - Static variable in class org.sikuli.api.robot.Key

C_HOME - Static variable in class org.sikuli.api.robot.Key

C_INSERT - Static variable in class org.sikuli.api.robot.Key

C_LEFT - Static variable in class org.sikuli.api.robot.Key

C_META - Static variable in class org.sikuli.api.robot.Key

C_MINUS - Static variable in class org.sikuli.api.robot.Key

C_MULTIPLY - Static variable in class org.sikuli.api.robot.Key

C_NUM0 - Static variable in class org.sikuli.api.robot.Key

C_NUM1 - Static variable in class org.sikuli.api.robot.Key

C_NUM2 - Static variable in class org.sikuli.api.robot.Key

C_NUM3 - Static variable in class org.sikuli.api.robot.Key

C_NUM4 - Static variable in class org.sikuli.api.robot.Key

C_NUM5 - Static variable in class org.sikuli.api.robot.Key

C_NUM6 - Static variable in class org.sikuli.api.robot.Key

C_NUM7 - Static variable in class org.sikuli.api.robot.Key

C_NUM8 - Static variable in class org.sikuli.api.robot.Key

C_NUM9 - Static variable in class org.sikuli.api.robot.Key

C_NUM_LOCK - Static variable in class org.sikuli.api.robot.Key

C_PAGE_DOWN - Static variable in class org.sikuli.api.robot.Key

C_PAGE_UP - Static variable in class org.sikuli.api.robot.Key

C_PAUSE - Static variable in class org.sikuli.api.robot.Key

C_PRINTSCREEN - Static variable in class org.sikuli.api.robot.Key

C_RIGHT - Static variable in class org.sikuli.api.robot.Key

C_SCROLL_LOCK - Static variable in class org.sikuli.api.robot.Key

C_SEPARATOR - Static variable in class org.sikuli.api.robot.Key

C_SHIFT - Static variable in class org.sikuli.api.robot.Key

C_UP - Static variable in class org.sikuli.api.robot.Key

C_WIN - Static variable in class org.sikuli.api.robot.Key

Canvas - Class in org.sikuli.api.visual

Canvas class is the abstract base class for all canvas context.

Canvas() - Constructor for class org.sikuli.api.visual.Canvas

CanvasBuilder - Class in org.sikuli.api.visual

CanvasBuilder(Canvas) - Constructor for class org.sikuli.api.visual.CanvasBuilder

CanvasBuilder.ElementAdder - Class in org.sikuli.api.visual

CanvasBuilder.ElementAdder() - Constructor for class org.sikuli.api.visual.CanvasBuilder.ElementAdder

CanvasBuilder.ElementAreaSetter - Class in org.sikuli.api.visual

CanvasBuilder.ElementAreaSetter(Element) - Constructor for class org.sikuli.api.visual.CanvasBuilder.ElementAreaSetter

CanvasBuilder.ElementPointSetter - Class in org.sikuli.api.visual

CanvasBuilder.ElementPointSetter(Element) - Constructor for class org.sikuli.api.visual.CanvasBuilder.ElementPointSetter

CanvasBuilder.ElementSetter - Class in org.sikuli.api.visual

CanvasBuilder.ElementSetter(Element) - Constructor for class org.sikuli.api.visual.CanvasBuilder.ElementSetter

CanvasBuilder.LabelElementPlacementSetter - Class in org.sikuli.api.visual

CanvasBuilder.LabelElementPlacementSetter(Element) - Constructor for class org.sikuli.api.visual.CanvasBuilder.LabelElementPlacementSetter

CanvasBuilder.RelativeToRegion - Class in org.sikuli.api.visual

CanvasBuilder.RelativeToRegion(Element, int, int, int, int) - Constructor for class org.sikuli.api.visual.CanvasBuilder.RelativeToRegion

CAPS_LOCK - Static variable in class org.sikuli.api.robot.Key

capture() - Method in class org.sikuli.api.DefaultScreenRegion

capture() - Method in interface org.sikuli.api.ScreenRegion

Captures and returns a screenshot of this screen region.

center() - Method in class org.sikuli.api.Relative.RelativeScreenRegionBuilder

Returns a new RelativeScreenLocationBuilder object that corresponds to the center of this ScreenRegion.

centeredAbove(Region) - Method in class org.sikuli.api.visual.CanvasBuilder.ElementPointSetter

centeredAt(int, int) - Method in class org.sikuli.api.visual.CanvasBuilder.ElementPointSetter

centeredAt(Region) - Method in class org.sikuli.api.visual.CanvasBuilder.ElementPointSetter

circle() - Method in class org.sikuli.api.visual.CanvasBuilder.ElementAdder

CircleElement - Class in org.sikuli.api.visual.element

CircleElement() - Constructor for class org.sikuli.api.visual.element.CircleElement

clear() - Method in class org.sikuli.api.visual.Canvas

Removes all canvas elements.

click(ScreenLocation) - Method in class org.sikuli.api.robot.desktop.DesktopMouse

click(ScreenLocation) - Method in interface org.sikuli.api.robot.Mouse

Left-click on a given screen location

clone() - Method in class org.sikuli.api.event.VisualEventManager

CMD - Static variable in class org.sikuli.api.robot.Key

CMD - Static variable in class org.sikuli.api.robot.KeyModifier

color(Color) - Method in class org.sikuli.api.visual.element.ElementStyleSetter

Sets the foreground color of this canvas element.

ColorImageTarget - Class in org.sikuli.api

The ColorImageTarget class defines targets based on color patterns.

ColorImageTarget(URL) - Constructor for class org.sikuli.api.ColorImageTarget

Creates a ColorImageTarget from an image at a given URL.

ColorImageTarget(BufferedImage) - Constructor for class org.sikuli.api.ColorImageTarget

Creates a ColorImageTarget from a BufferedImage.

ColorImageTarget(File) - Constructor for class org.sikuli.api.ColorImageTarget

Creates a ColorImageTarget from a given File object.

copy() - Method in class org.sikuli.api.robot.desktop.DesktopKeyboard

copy() - Method in interface org.sikuli.api.robot.Keyboard

Clears the clipboard, performs the "copy" keyboard shortcut, then attempts to return the clipboard contents as a String.

copyRegion(ScreenRegion) - Method in class org.sikuli.api.robot.desktop.DesktopKeyboard

copyRegion(ScreenRegion) - Method in interface org.sikuli.api.robot.Keyboard

Copies the content of a screen region into the clipboard.

createComponentImage(Component) - Static method in class org.sikuli.api.visual.ImageCanvas

createImage() - Method in class org.sikuli.api.visual.Canvas

createImage() - Method in class org.sikuli.api.visual.ImageCanvas

createImage() - Method in class org.sikuli.api.visual.ScreenRegionCanvas

createPNode() - Method in class org.sikuli.api.visual.element.Element

Creates a new PNode, the central abstraction in Piccolo.

CTRL - Static variable in class org.sikuli.api.robot.Key

CTRL - Static variable in class org.sikuli.api.robot.KeyModifier

D

DefaultLocation - Class in org.sikuli.api

The DefaultLocation class is used to describe a location on the screen coordinate.

DefaultLocation(int, int) - Constructor for class org.sikuli.api.DefaultLocation

Constructs a default location at the given screen coordinates.

DefaultRegion - Class in org.sikuli.api

The DefaultRegion class is used to describe a region of the screen.

DefaultRegion(int, int, int, int) - Constructor for class org.sikuli.api.DefaultRegion

Constructs a new screen region whose upper-left corner is specified as (x,y) and whose width and height are specified by the arguments of the same name.

DefaultRegion(Rectangle) - Constructor for class org.sikuli.api.DefaultRegion

Constructs a new screen region, initialized to match the bounds of the specified Rectangle.

DefaultScreenLocation - Class in org.sikuli.api

This class provides manipulation methods that can be used for the default screen location.

DefaultScreenLocation(Screen, int, int) - Constructor for class org.sikuli.api.DefaultScreenLocation

Constructs a new screen location whose screen is the specified screen (screenRef), and whose (x,y) coordinates are specified by the arguments of the same name.

DefaultScreenLocation(ScreenLocation) - Constructor for class org.sikuli.api.DefaultScreenLocation

Constructs a new screen location whose screen and (x,y) coordinates are specified by the ScreenLocation argument.

DefaultScreenRegion - Class in org.sikuli.api

This class provides manipulation methods that can be used by the default screen region.

DefaultScreenRegion(Screen) - Constructor for class org.sikuli.api.DefaultScreenRegion

Constructs a new DefaultScreenRegion on the specified Screen object whose upper-left corner is at (0, 0) in the coordinate space.

DefaultScreenRegion(ScreenRegion, int, int, int, int) - Constructor for class org.sikuli.api.DefaultScreenRegion

Constructs a new DefaultScreenRegion object whose Screen is the same as the parent ScreenRegion with the specified region values.

DefaultScreenRegion(Screen, int, int, int, int) - Constructor for class org.sikuli.api.DefaultScreenRegion

Constructs a new DefaultScreenRegion object on the specified Screen and region values.

DefaultTarget - Class in org.sikuli.api

DefaultTarget is the abstract base class for all targets.

DefaultTarget() - Constructor for class org.sikuli.api.DefaultTarget

Constructs a Target with default parameters

DELETE - Static variable in class org.sikuli.api.robot.Key

DesktopCanvas - Class in org.sikuli.api.visual

The DesktopCanvas class represents a canvas (frame) to be displayed on a screen region.

DesktopCanvas() - Constructor for class org.sikuli.api.visual.DesktopCanvas

Constructs a new DesktopCanvas whose screen region is in full screen, and whose screen is the default screen (i.e., screen 0)

DesktopCanvas(int) - Constructor for class org.sikuli.api.visual.DesktopCanvas

DesktopKeyboard - Class in org.sikuli.api.robot.desktop

DesktopKeyboard() - Constructor for class org.sikuli.api.robot.desktop.DesktopKeyboard

DesktopMouse - Class in org.sikuli.api.robot.desktop

DesktopMouse() - Constructor for class org.sikuli.api.robot.desktop.DesktopMouse

DesktopScreen - Class in org.sikuli.api.robot.desktop

The DesktopScreen class defines methods for retrieving properties of the connected screen(s).

DesktopScreen(int) - Constructor for class org.sikuli.api.robot.desktop.DesktopScreen

Constructs a new DesktopScreen whose screen id is specified by the screenId argument.

DesktopScreenLocation - Class in org.sikuli.api

This DesktopScreenLocation class represents a screen location and its corresponding screen.

DesktopScreenLocation(int, int) - Constructor for class org.sikuli.api.DesktopScreenLocation

Constructs a new screen location based on the coordinates.

DesktopScreenRegion - Class in org.sikuli.api

A DesktopScreenRegion object is used to describe a region of any DesktopScreen.

DesktopScreenRegion() - Constructor for class org.sikuli.api.DesktopScreenRegion

Creates a ScreenRegion in full screen on the default screen (i.e., screen 0)

DesktopScreenRegion(int) - Constructor for class org.sikuli.api.DesktopScreenRegion

Creates a ScreenRegion in full screen on a screen specified by an id.

DesktopScreenRegion(int, int, int, int) - Constructor for class org.sikuli.api.DesktopScreenRegion

Create a screen region based on X, Y, width and height.

DesktopScreenRegion(int, int, int, int, int) - Constructor for class org.sikuli.api.DesktopScreenRegion

Create a screen region based on the specified screen id and region values.

display(int) - Method in class org.sikuli.api.visual.Canvas

Displays a canvas for the specified duration.

display(double) - Method in class org.sikuli.api.visual.Canvas

Displays a canvas for the specified duration.

display(int) - Method in class org.sikuli.api.visual.ImageCanvas

display(double) - Method in class org.sikuli.api.visual.ImageCanvas

display(int) - Method in class org.sikuli.api.visual.ScreenRegionCanvas

display(double) - Method in class org.sikuli.api.visual.ScreenRegionCanvas

display(int) - Method in class org.sikuli.api.visual.StyleBuilder

Displays the canvas for the specified duration.

display(double) - Method in class org.sikuli.api.visual.StyleBuilder

Displays the canvas for the specified duration.

displayOnScreen() - Method in interface org.sikuli.api.visual.ScreenDisplayable

displayWhile(Runnable) - Method in class org.sikuli.api.visual.Canvas

Displays the canvas and blocks the calling thread, while running the passed runnable on a background thread.

displayWhile(Runnable) - Method in class org.sikuli.api.visual.ImageCanvas

displayWhile(Runnable) - Method in class org.sikuli.api.visual.ScreenRegionCanvas

DIVIDE - Static variable in class org.sikuli.api.robot.Key

doFindAll(ScreenRegion) - Method in class org.sikuli.api.DefaultTarget

doFindAll(ScreenRegion) - Method in interface org.sikuli.api.Target

Sorts all found instances of a screenRegion objects according to the Ordering value of this Target.

dot() - Method in class org.sikuli.api.visual.CanvasBuilder.ElementAdder

DotElement - Class in org.sikuli.api.visual.element

DotElement() - Constructor for class org.sikuli.api.visual.element.DotElement

doubleClick(ScreenLocation) - Method in class org.sikuli.api.robot.desktop.DesktopMouse

doubleClick(ScreenLocation) - Method in interface org.sikuli.api.robot.Mouse

Double-click on a given screen location

DOWN - Static variable in class org.sikuli.api.robot.Key

drag(ScreenLocation) - Method in class org.sikuli.api.robot.desktop.DesktopMouse

drag(ScreenLocation) - Method in interface org.sikuli.api.robot.Mouse

Drag at a given screen location

drop(ScreenLocation) - Method in class org.sikuli.api.robot.desktop.DesktopMouse

drop(ScreenLocation) - Method in interface org.sikuli.api.robot.Mouse

Drop at a given screen location

E

Element - Class in org.sikuli.api.visual.element

Element is an abstraction for objects to be displayed on the screen.

Element() - Constructor for class org.sikuli.api.visual.element.Element

Element.HorizontalAlignment - Enum in org.sikuli.api.visual.element

The horizontal alignment of the Element.

Element.Listener - Interface in org.sikuli.api.visual.element

Element.VerticalAlignment - Enum in org.sikuli.api.visual.element

The vertical alignment of the Element.

ElementStyleSetter - Class in org.sikuli.api.visual.element

A StyleBuilder is used to to ease style building the Canvas.

ElementStyleSetter(Element) - Constructor for class org.sikuli.api.visual.element.ElementStyleSetter

Constructs a new StyleBuilder whose Canvas and Element specified with the arguments of the same name.

END - Static variable in class org.sikuli.api.robot.Key

ENTER - Static variable in class org.sikuli.api.robot.Key

Env - Class in org.sikuli.api.robot

Env() - Constructor for class org.sikuli.api.robot.Env

ESC - Static variable in class org.sikuli.api.robot.Key

F

F1 - Static variable in class org.sikuli.api.robot.Key

F10 - Static variable in class org.sikuli.api.robot.Key

F11 - Static variable in class org.sikuli.api.robot.Key

F12 - Static variable in class org.sikuli.api.robot.Key

F13 - Static variable in class org.sikuli.api.robot.Key

F14 - Static variable in class org.sikuli.api.robot.Key

F15 - Static variable in class org.sikuli.api.robot.Key

F2 - Static variable in class org.sikuli.api.robot.Key

F3 - Static variable in class org.sikuli.api.robot.Key

F4 - Static variable in class org.sikuli.api.robot.Key

F5 - Static variable in class org.sikuli.api.robot.Key

F6 - Static variable in class org.sikuli.api.robot.Key

F7 - Static variable in class org.sikuli.api.robot.Key

F8 - Static variable in class org.sikuli.api.robot.Key

F9 - Static variable in class org.sikuli.api.robot.Key

find(Target) - Method in class org.sikuli.api.DefaultScreenRegion

find(Target) - Method in interface org.sikuli.api.ScreenRegion

Finds a target on the screen immediately.

findAll(Target) - Method in class org.sikuli.api.DefaultScreenRegion

findAll(Target) - Method in interface org.sikuli.api.ScreenRegion

Finds all the instances of the target on the screen immediately.

fontSize(float) - Method in class org.sikuli.api.visual.element.ElementStyleSetter

ForegroundTarget - Class in org.sikuli.api

The ForegroundTarget class defines targets based on whether they have textures (as opposed to textureless background).

ForegroundTarget() - Constructor for class org.sikuli.api.ForegroundTarget

Constructs a new ForegroundTarget with default values.

G

getBackgroundColor() - Method in class org.sikuli.api.visual.element.Element

Returns the background color of this Element.

getBounds() - Method in class org.sikuli.api.AbstractScreenRegion

getBounds() - Method in class org.sikuli.api.DefaultRegion

getBounds() - Method in interface org.sikuli.api.Region

Returns the bounding Rectangle of this Region.

getBounds() - Method in class org.sikuli.api.robot.desktop.DesktopScreen

Returns the bounding Rectangle of this DesktopScreen.

getCenter() - Method in class org.sikuli.api.AbstractScreenRegion

getCenter() - Method in class org.sikuli.api.DefaultScreenRegion

getCenter() - Method in interface org.sikuli.api.ScreenRegion

Returns the center of this screen region.

getColor() - Method in class org.sikuli.api.visual.element.Element

Returns the Color of this Element.

getFontSize() - Method in class org.sikuli.api.visual.element.Element

Returns the font size of this Element in points.

getHeight() - Method in class org.sikuli.api.AbstractScreenRegion

Returns the height of the rectangular screen region.

getHeight() - Method in class org.sikuli.api.DefaultRegion

getHeight() - Method in interface org.sikuli.api.Region

getHotkeyModifier() - Static method in class org.sikuli.api.robot.Env

getId() - Method in class org.sikuli.api.robot.desktop.DesktopScreen

Returns screen id of this DesktopScreen.

getImage() - Method in class org.sikuli.api.ImageTarget

Returns the image describing this ImageTarget.

getImage() - Method in class org.sikuli.api.visual.element.ImageElement

getImage() - Method in class org.sikuli.api.visual.RefreshableImage

getLastCapturedImage() - Method in class org.sikuli.api.DefaultScreenRegion

Returns the last captured screenshot in this screen region.

getLastCapturedImage() - Method in interface org.sikuli.api.ScreenRegion

Returns the last captured image of this ScreenRegion.

getLimit() - Method in class org.sikuli.api.DefaultTarget

Returns the limit on the number of matched targets to return.

getLimit() - Method in interface org.sikuli.api.Target

Returns the limit on the number of matched targets to return.

getLineColor() - Method in class org.sikuli.api.visual.element.Element

Returns the line color of this Element.

getLineWidth() - Method in class org.sikuli.api.visual.element.Element

Returns the line width of this Element in points.

getLocation() - Method in class org.sikuli.api.robot.desktop.DesktopMouse

getLocation() - Method in interface org.sikuli.api.robot.Mouse

Get the screen location the mouse cursor is currently at

getLowerLeftCorner() - Method in class org.sikuli.api.DefaultScreenRegion

getLowerLeftCorner() - Method in interface org.sikuli.api.ScreenRegion

Returns the lower-left corner of this screen region.

getLowerRightCorner() - Method in class org.sikuli.api.DefaultScreenRegion

getLowerRightCorner() - Method in interface org.sikuli.api.ScreenRegion

Returns the lower-right corner of this screen region.

getMinScore() - Method in class org.sikuli.api.DefaultTarget

Returns the minimum matching score of this DefaultTarget.

getMinScore() - Method in interface org.sikuli.api.Target

Returns the minimum matching score of this Target.

getNewState() - Method in class org.sikuli.api.event.StateChangeEvent

getNumberScreens() - Static method in class org.sikuli.api.robot.desktop.DesktopScreen

Gets the number of screens available on the desktop.

getOldState() - Method in class org.sikuli.api.event.StateChangeEvent

getOrdering() - Method in class org.sikuli.api.DefaultTarget

Returns the Ordering of matched targets this DefaultTarget uses.

getOrdering() - Method in interface org.sikuli.api.Target

Returns the Ordering of matched targets this Target uses.

getOS() - Static method in class org.sikuli.api.robot.Env

getOSVersion() - Static method in class org.sikuli.api.robot.Env

getRelativeScreenLocation(int, int) - Method in class org.sikuli.api.AbstractScreenRegion

getRelativeScreenLocation(int, int) - Method in class org.sikuli.api.DefaultScreenLocation

getRelativeScreenLocation(int, int) - Method in interface org.sikuli.api.ScreenLocation

Returns a new ScreenLocation relative to the specified offsets.

getRelativeScreenLocation(int, int) - Method in interface org.sikuli.api.ScreenRegion

Returns a ScreenRegion relative to the specified region values.

getRelativeScreenRegion(int, int, int, int) - Method in class org.sikuli.api.AbstractScreenRegion

getRelativeScreenRegion(int, int, int, int) - Method in interface org.sikuli.api.ScreenRegion

Returns a ScreenRegion relative to the specified region values.

getROIs() - Method in class org.sikuli.api.DefaultScreenRegion

getROIs() - Method in interface org.sikuli.api.ScreenRegion

Returns a list of Rectangle that represent the rectangular regions of interest for this ScreenRegion.

getScore() - Method in class org.sikuli.api.AbstractScreenRegion

getScore() - Method in interface org.sikuli.api.ScreenRegion

Returns the minimum matching score of this ScreenRegion, which is set if this screen region was returned as the result of a find command.

getScreen() - Method in class org.sikuli.api.AbstractScreenRegion

getScreen() - Method in class org.sikuli.api.DefaultScreenLocation

getScreen() - Method in interface org.sikuli.api.ScreenLocation

Returns the screen associated with this screen location.

getScreen() - Method in interface org.sikuli.api.ScreenRegion

Returns a Screen object of this ScreenRegion.

getScreenAtCoord(int, int) - Static method in class org.sikuli.api.robot.desktop.DesktopScreen

Determines and returns the DesktopScreen of the specified (x,y) coordinates.

getScreenId() - Method in class org.sikuli.api.robot.desktop.DesktopScreen

getScreenLocation() - Method in class org.sikuli.api.Relative.RelativeScreenLocationBuilder

Returns the ScreenLocation of this RelativeScreenLocationBuilder.

getScreenRegion() - Method in class org.sikuli.api.event.StateChangeEvent

getScreenRegion() - Method in class org.sikuli.api.event.TargetEvent

Returns the ScreenRegion object that represents the initial screen region where the target is being watched.

getScreenRegion() - Method in class org.sikuli.api.Relative.RelativeScreenRegionBuilder

Returns the ScreenRegion of this RelativeScreenRegionBuilder.

getScreenRegion() - Method in class org.sikuli.api.visual.ScreenRegionCanvas

Returns the ScreenRegion of this ScreenRegionCanvas object.

getScreenshot(int, int, int, int) - Method in class org.sikuli.api.robot.desktop.DesktopScreen

getScreenshot(int, int, int, int) - Method in interface org.sikuli.api.Screen

Creates and returns an image containing a screen capture of the specified arguments of the same name.

getScreenshot(int, int, int, int) - Method in class org.sikuli.api.StaticImageScreen

getSeparator() - Static method in class org.sikuli.api.robot.Env

getSingleton() - Static method in class org.sikuli.api.event.VisualEventManager

getSize() - Method in class org.sikuli.api.robot.desktop.DesktopScreen

getSize() - Method in interface org.sikuli.api.Screen

Gets the size of this Screen, represented by the returned Dimension.

getSize() - Method in class org.sikuli.api.StaticImageScreen

getState() - Method in class org.sikuli.api.DefaultScreenRegion

getState() - Method in interface org.sikuli.api.ScreenRegion

Returns the state of this ScreenRegion.

getStates() - Method in class org.sikuli.api.DefaultScreenRegion

Returns a map of Target objects and states, which can be any object, of this DefaultScreenRegion.

getStates() - Method in interface org.sikuli.api.ScreenRegion

Returns a map of Target objects and states, which can be any object, for this screen region.

getTarget() - Method in class org.sikuli.api.event.TargetEvent

Returns the Target object of this TargetEvent.

getTargetRegion() - Method in class org.sikuli.api.event.TargetEvent

Returns the ScreenRegion object that represents the new screen region that is currently occupied by the target.

getText() - Method in class org.sikuli.api.visual.element.LabelElement

getTransparency() - Method in class org.sikuli.api.visual.element.Element

Returns the transparency (alpha component) value of this Element.

getUpperLeftCorner() - Method in class org.sikuli.api.DefaultScreenRegion

getUpperLeftCorner() - Method in interface org.sikuli.api.ScreenRegion

Returns the upper-left corner of this screen region.

getUpperRightCorner() - Method in class org.sikuli.api.DefaultScreenRegion

getUpperRightCorner() - Method in interface org.sikuli.api.ScreenRegion

Returns the upper-right corner of this screen region.

getURL() - Method in class org.sikuli.api.ImageTarget

Returns the URL of the image for this ImageTarget.

getWidth() - Method in class org.sikuli.api.AbstractScreenRegion

Returns the width of the rectangular screen region.

getWidth() - Method in class org.sikuli.api.DefaultRegion

getWidth() - Method in interface org.sikuli.api.Region

getX() - Method in class org.sikuli.api.AbstractScreenRegion

Returns the X coordinate of the upper-left corner of the rectangular screen region.

getX() - Method in class org.sikuli.api.DefaultLocation

getX() - Method in class org.sikuli.api.DefaultRegion

getX() - Method in class org.sikuli.api.DefaultScreenLocation

getX() - Method in interface org.sikuli.api.Location

Returns the X location of the screen coordinate.

getX() - Method in interface org.sikuli.api.Region

getY() - Method in class org.sikuli.api.AbstractScreenRegion

Returns the Y coordinate of the upper-left corner of the rectangular screen region.

getY() - Method in class org.sikuli.api.DefaultLocation

getY() - Method in class org.sikuli.api.DefaultRegion

getY() - Method in class org.sikuli.api.DefaultScreenLocation

getY() - Method in interface org.sikuli.api.Location

the Y location of the screen coordinate.

getY() - Method in interface org.sikuli.api.Region

H

height - Variable in class org.sikuli.api.visual.element.Element

hide() - Method in class org.sikuli.api.visual.Canvas

Clears the shown canvas.

hide() - Method in class org.sikuli.api.visual.ImageCanvas

hide() - Method in class org.sikuli.api.visual.ScreenRegionCanvas

hideFromScreen() - Method in interface org.sikuli.api.visual.ScreenDisplayable

HOME - Static variable in class org.sikuli.api.robot.Key

horizontalAlignment - Variable in class org.sikuli.api.visual.element.Element

horizontalAlignmentCenter() - Method in class org.sikuli.api.visual.element.ElementStyleSetter

Sets the horizontal alignment of this canvas element at the center.

horizontalAlignmentLeft() - Method in class org.sikuli.api.visual.element.ElementStyleSetter

Sets the horizontal alignment of this canvas element on the left.

horizontalAlignmentRight() - Method in class org.sikuli.api.visual.element.ElementStyleSetter

Sets the horizontal alignment of this canvas element on the right.

hover(ScreenLocation) - Method in class org.sikuli.api.robot.desktop.DesktopMouse

hover(ScreenLocation) - Method in interface org.sikuli.api.robot.Mouse

Hover the mouse cursor to a screen location.

I

image(BufferedImage) - Method in class org.sikuli.api.visual.CanvasBuilder.ElementAdder

image - Variable in class org.sikuli.api.visual.element.RefreshableImageElement

ImageCanvas - Class in org.sikuli.api.visual

ImageCanvas(URL) - Constructor for class org.sikuli.api.visual.ImageCanvas

ImageCanvas(BufferedImage) - Constructor for class org.sikuli.api.visual.ImageCanvas

ImageElement - Class in org.sikuli.api.visual.element

ImageElement() - Constructor for class org.sikuli.api.visual.element.ImageElement

ImageElement.Listener - Interface in org.sikuli.api.visual.element

ImageTarget - Class in org.sikuli.api

An ImageTarget object describes a target using an image.

ImageTarget(URL) - Constructor for class org.sikuli.api.ImageTarget

Creates an ImageTarget from an image at a given URL.

ImageTarget(File) - Constructor for class org.sikuli.api.ImageTarget

Creates an ImageTarget from a File object.

ImageTarget(BufferedImage) - Constructor for class org.sikuli.api.ImageTarget

Creates an ImageTarget from a BufferedImage.

imageUpdated(BufferedImage) - Method in interface org.sikuli.api.visual.element.ImageElement.Listener

imageUpdated(BufferedImage) - Method in interface org.sikuli.api.visual.ImageUpdateListener

ImageUpdateListener - Interface in org.sikuli.api.visual

INSERT - Static variable in class org.sikuli.api.robot.Key

inside(Region) - Method in class org.sikuli.api.visual.CanvasBuilder.LabelElementPlacementSetter

isLinux() - Static method in class org.sikuli.api.robot.Env

isLockOn(char) - Static method in class org.sikuli.api.robot.Env

isMac() - Static method in class org.sikuli.api.robot.Env

isWindows() - Static method in class org.sikuli.api.robot.Env

K

Key - Class in org.sikuli.api.robot

Key() - Constructor for class org.sikuli.api.robot.Key

KEY_ALT - Static variable in class org.sikuli.api.robot.KeyModifier

Deprecated.

KEY_CMD - Static variable in class org.sikuli.api.robot.KeyModifier

Deprecated.

KEY_CTRL - Static variable in class org.sikuli.api.robot.KeyModifier

Deprecated.

KEY_META - Static variable in class org.sikuli.api.robot.KeyModifier

Deprecated.

KEY_SHIFT - Static variable in class org.sikuli.api.robot.KeyModifier

Deprecated.

KEY_WIN - Static variable in class org.sikuli.api.robot.KeyModifier

Deprecated.

Keyboard - Interface in org.sikuli.api.robot

Keyboard interface provides definitions for generating native keyboard events.

keyDown(int) - Method in class org.sikuli.api.robot.desktop.DesktopKeyboard

press down the key (given by the key code) on the underlying device.

keyDown(String) - Method in class org.sikuli.api.robot.desktop.DesktopKeyboard

keyDown(int) - Method in interface org.sikuli.api.robot.Keyboard

Presses down the key (given by the key code) on the underlying device.

keyDown(String) - Method in interface org.sikuli.api.robot.Keyboard

Presses down a series of keys specified by the String argument keys.

KeyModifier - Class in org.sikuli.api.robot

KeyModifier() - Constructor for class org.sikuli.api.robot.KeyModifier

keyUp(int) - Method in class org.sikuli.api.robot.desktop.DesktopKeyboard

release the key (given by the key code) on the underlying device.

keyUp() - Method in class org.sikuli.api.robot.desktop.DesktopKeyboard

keyUp(String) - Method in class org.sikuli.api.robot.desktop.DesktopKeyboard

keyUp(int) - Method in interface org.sikuli.api.robot.Keyboard

Releases the key (given by the key code) on the underlying device.

keyUp() - Method in interface org.sikuli.api.robot.Keyboard

Releases all the held down keys.

keyUp(String) - Method in interface org.sikuli.api.robot.Keyboard

Releases a series of keys specified by the String argument keys.

L

label(String) - Method in class org.sikuli.api.visual.CanvasBuilder.ElementAdder

LabelElement - Class in org.sikuli.api.visual.element

LabelElement() - Constructor for class org.sikuli.api.visual.element.LabelElement

LabelElement.Listener - Interface in org.sikuli.api.visual.element

left(int) - Method in class org.sikuli.api.Relative.RelativeScreenLocationBuilder

Returns a new RelativeScreenLocationBuilder object relative to the left of this ScreenLocation by the specified amount.

left(int) - Method in class org.sikuli.api.Relative.RelativeScreenRegionBuilder

Returns a new RelativeScreenRegionBuilder object relative to the left of this ScreenRegion by the specified amount.

LEFT - Static variable in class org.sikuli.api.robot.Key

left(Region) - Method in class org.sikuli.api.visual.CanvasBuilder.LabelElementPlacementSetter

lineColor(Color) - Method in class org.sikuli.api.visual.element.ElementStyleSetter

Sets the line color of this canvas element.

lineWidth(int) - Method in class org.sikuli.api.visual.element.ElementStyleSetter

Sets the line width of this canvas element.

Location - Interface in org.sikuli.api

The Location interface provides definitions for the objects that represent a location on the screen coordinate.

M

META - Static variable in class org.sikuli.api.robot.Key

META - Static variable in class org.sikuli.api.robot.KeyModifier

middleLeft() - Method in class org.sikuli.api.Relative.RelativeScreenRegionBuilder

Returns a new RelativeScreenLocationBuilder object that corresponds to the middle-left location of this ScreenRegion.

middleRight() - Method in class org.sikuli.api.Relative.RelativeScreenRegionBuilder

Returns a new RelativeScreenLocationBuilder object that corresponds to the middle-right location of this ScreenRegion.

MINUS - Static variable in class org.sikuli.api.robot.Key

Mouse - Interface in org.sikuli.api.robot

Mouse interface provides definitions for generating native mouse events.

mouseDown(int) - Method in class org.sikuli.api.robot.desktop.DesktopMouse

mouseDown(int) - Method in interface org.sikuli.api.robot.Mouse

mouseUp() - Method in class org.sikuli.api.robot.desktop.DesktopMouse

mouseUp(int) - Method in class org.sikuli.api.robot.desktop.DesktopMouse

mouseUp() - Method in interface org.sikuli.api.robot.Mouse

mouseUp(int) - Method in interface org.sikuli.api.robot.Mouse

move(ScreenLocation) - Method in class org.sikuli.api.robot.desktop.DesktopMouse

move(ScreenLocation) - Method in interface org.sikuli.api.robot.Mouse

Move the mouse cursor to a destination screen location immediately.

moved(int, int) - Method in interface org.sikuli.api.visual.element.Element.Listener

MULTIPLY - Static variable in class org.sikuli.api.robot.Key

MultiStateTarget - Class in org.sikuli.api

The MultiStateTarget class defines a target that may look differently according its state.

MultiStateTarget() - Constructor for class org.sikuli.api.MultiStateTarget

N

narrower(int) - Method in class org.sikuli.api.Relative.RelativeScreenRegionBuilder

Returns a new RelativeScreenRegionBuilder object that is narrower than this ScreenRegion by the specified amount.

NUM0 - Static variable in class org.sikuli.api.robot.Key

NUM1 - Static variable in class org.sikuli.api.robot.Key

NUM2 - Static variable in class org.sikuli.api.robot.Key

NUM3 - Static variable in class org.sikuli.api.robot.Key

NUM4 - Static variable in class org.sikuli.api.robot.Key

NUM5 - Static variable in class org.sikuli.api.robot.Key

NUM6 - Static variable in class org.sikuli.api.robot.Key

NUM7 - Static variable in class org.sikuli.api.robot.Key

NUM8 - Static variable in class org.sikuli.api.robot.Key

NUM9 - Static variable in class org.sikuli.api.robot.Key

NUM_LOCK - Static variable in class org.sikuli.api.robot.Key

O

offset(int, int) - Method in class org.sikuli.api.Relative.RelativeScreenRegionBuilder

Returns a new RelativeScreenRegionBuilder object to the offset of the ScreenRegion

org.sikuli.api - package org.sikuli.api

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

org.sikuli.api.event - package org.sikuli.api.event

Contains the classes for creating visual based events fired when the visual appearance of targets changes.

org.sikuli.api.robot - package org.sikuli.api.robot

Interfaces and utilities for mouse and keyboard implementations.

org.sikuli.api.robot.desktop - package org.sikuli.api.robot.desktop

Provides the classes necessary to simulate desktop user interactions (mouse and keyboard actions).

org.sikuli.api.visual - package org.sikuli.api.visual

Provides the classes to annotate the screen and display canvases (frames) on a screen region.

org.sikuli.api.visual.element - package org.sikuli.api.visual.element

Provides classes to assist in creating different shapes to annotate the screen.

OS - Enum in org.sikuli.api.robot

P

PAGE_DOWN - Static variable in class org.sikuli.api.robot.Key

PAGE_UP - Static variable in class org.sikuli.api.robot.Key

paste(String) - Method in class org.sikuli.api.robot.desktop.DesktopKeyboard

paste(String) - Method in interface org.sikuli.api.robot.Keyboard

Gets plain text from the clipboard and performs the "paste" keyboard shortcut.

pause(int) - Static method in class org.sikuli.api.API

Causes the currently executing thread to pause (sleep) for the specified number of milliseconds.

PAUSE - Static variable in class org.sikuli.api.robot.Key

press() - Method in class org.sikuli.api.robot.desktop.DesktopMouse

press() - Method in interface org.sikuli.api.robot.Mouse

Press the left button

PRINTSCREEN - Static variable in class org.sikuli.api.robot.Key

R

refresh() - Method in class org.sikuli.api.visual.ScreenRegionCanvas

RefreshableImage - Class in org.sikuli.api.visual

RefreshableImage() - Constructor for class org.sikuli.api.visual.RefreshableImage

RefreshableImageElement - Class in org.sikuli.api.visual.element

RefreshableImageElement() - Constructor for class org.sikuli.api.visual.element.RefreshableImageElement

Region - Interface in org.sikuli.api

The Region interface provides definitions for the objects that represent a Region.

region(Region) - Method in class org.sikuli.api.Relative.RelativeScreenRegionBuilder

Returns a new RelativeScreenRegionBuilder object that is a region relative to the upper-left corner (origin) of this ScreenRegion.

region(int, int, int, int) - Method in class org.sikuli.api.Relative.RelativeScreenRegionBuilder

Returns a new RelativeScreenRegionBuilder object that is a region relative to the upper-left corner (origin) of this ScreenRegion.

region(double, double, double, double) - Method in class org.sikuli.api.Relative.RelativeScreenRegionBuilder

Returns a new RelativeScreenRegionBuilder object that is a region relative to the upper-left corner (origin) of the ScreenRegion.

Relative - Class in org.sikuli.api

The Relative class provides new regions relative to the region of a screen region object.

Relative() - Constructor for class org.sikuli.api.Relative

Relative.RelativeScreenLocationBuilder - Class in org.sikuli.api

A RelativeScreenLocationBuilder represents a copy of the original ScreenLocation.

Relative.RelativeScreenLocationBuilder(ScreenLocation) - Constructor for class org.sikuli.api.Relative.RelativeScreenLocationBuilder

Constructs a new RelativeScreenLocationBuilder that is a copy of the specified ScreenLocation.

Relative.RelativeScreenRegionBuilder - Class in org.sikuli.api

A RelativeScreenRegionBuilder represents a copy of the original ScreenRegion.

Relative.RelativeScreenRegionBuilder(ScreenRegion) - Constructor for class org.sikuli.api.Relative.RelativeScreenRegionBuilder

Constructs a new RelativeScreenRegionBuilder that is a copy of the specified ScreenRegion.

relativeTo(Region) - Method in class org.sikuli.api.visual.CanvasBuilder.ElementPointSetter

release() - Method in class org.sikuli.api.robot.desktop.DesktopMouse

release() - Method in interface org.sikuli.api.robot.Mouse

Release the left button

removeListener(Element.Listener) - Method in class org.sikuli.api.visual.element.Element

removeListener(ImageElement.Listener) - Method in class org.sikuli.api.visual.element.ImageElement

removeListener(LabelElement.Listener) - Method in class org.sikuli.api.visual.element.LabelElement

removeState(Target) - Method in class org.sikuli.api.DefaultScreenRegion

removeState(Target) - Method in interface org.sikuli.api.ScreenRegion

Removes a particular state represented by the given target from this screen region.

removeTargetEventListener(Target, TargetEventListener) - Method in class org.sikuli.api.DefaultScreenRegion

removeTargetEventListener(ScreenRegion, Target, TargetEventListener) - Method in class org.sikuli.api.event.VisualEventManager

removeTargetEventListener(Target, TargetEventListener) - Method in interface org.sikuli.api.ScreenRegion

Removes a particular listener for a particular target.

right(int) - Method in class org.sikuli.api.Relative.RelativeScreenLocationBuilder

Returns a new RelativeScreenLocationBuilder object relative to the right of this ScreenLocation by the specified amount.

right(int) - Method in class org.sikuli.api.Relative.RelativeScreenRegionBuilder

Returns a new RelativeScreenRegionBuilder object relative to the right of this ScreenRegion by the specified amount.

RIGHT - Static variable in class org.sikuli.api.robot.Key

right(Region) - Method in class org.sikuli.api.visual.CanvasBuilder.LabelElementPlacementSetter

rightClick(ScreenLocation) - Method in class org.sikuli.api.robot.desktop.DesktopMouse

rightClick(ScreenLocation) - Method in interface org.sikuli.api.robot.Mouse

Right-click on a given screen location

rightPress() - Method in class org.sikuli.api.robot.desktop.DesktopMouse

rightPress() - Method in interface org.sikuli.api.robot.Mouse

Press the right button

rightRelease() - Method in class org.sikuli.api.robot.desktop.DesktopMouse

rightRelease() - Method in interface org.sikuli.api.robot.Mouse

Release the right button

S

Screen - Interface in org.sikuli.api

The Screen interface provides definitions for the objects that represent a Screen.

ScreenDisplayable - Interface in org.sikuli.api.visual

ScreenLocation - Interface in org.sikuli.api

The ScreenLocation interface provides definitions for the objects that represent a location on any screen coordinate.

ScreenRegion - Interface in org.sikuli.api

The ScreenRegion interface provides definitions for the objects that represent regions of the screen.

ScreenRegionCanvas - Class in org.sikuli.api.visual

ScreenRegionCanvas(ScreenRegion) - Constructor for class org.sikuli.api.visual.ScreenRegionCanvas

Constructs a new DesktopCanvas whose screen region is specified with the argument of the same name.

SCROLL_LOCK - Static variable in class org.sikuli.api.robot.Key

SEPARATOR - Static variable in class org.sikuli.api.robot.Key

setBackgroundColor(Color) - Method in class org.sikuli.api.visual.element.Element

Sets the background color of this Element.

setBounds(Rectangle) - Method in class org.sikuli.api.AbstractScreenRegion

setBounds(Rectangle) - Method in class org.sikuli.api.DefaultRegion

setBounds(Rectangle) - Method in interface org.sikuli.api.Region

Sets the bounding Rectangle of this Rectangle.

setColor(Color) - Method in class org.sikuli.api.visual.element.BoxElement

setColor(Color) - Method in class org.sikuli.api.visual.element.Element

Sets the color of this Element

setFontSize(float) - Method in class org.sikuli.api.visual.element.Element

Sets the font size of this Elements in points.

setHeight(int) - Method in class org.sikuli.api.AbstractScreenRegion

Sets the height of the rectangular screen region.

setImage(BufferedImage) - Method in class org.sikuli.api.visual.element.ImageElement

setImage(BufferedImage) - Method in class org.sikuli.api.visual.RefreshableImage

setLimit(int) - Method in class org.sikuli.api.DefaultTarget

Sets the limit on the number of matched targets to return.

setLimit(int) - Method in interface org.sikuli.api.Target

Sets the limit on the number of matched targets to return.

setLineColor(Color) - Method in class org.sikuli.api.visual.element.DotElement

setLineColor(Color) - Method in class org.sikuli.api.visual.element.Element

Sets the line color of this Element.

setLineWidth(int) - Method in class org.sikuli.api.visual.element.Element

Sets the line width of this Element in points.

setLocation(int, int) - Method in class org.sikuli.api.visual.element.Element

setMinScore(double) - Method in class org.sikuli.api.DefaultTarget

Sets the minimum matching score.

setMinScore(double) - Method in interface org.sikuli.api.Target

Sets the minimum matching score.

setOrdering(Target.Ordering) - Method in class org.sikuli.api.DefaultTarget

Sets the ordering of the matched targets.

setOrdering(Target.Ordering) - Method in interface org.sikuli.api.Target

Sets the ordering of the matched targets.

setScore(double) - Method in class org.sikuli.api.AbstractScreenRegion

setScore(double) - Method in interface org.sikuli.api.ScreenRegion

Sets the minimum matching score value for a target to be considered a match.

setScreen(Screen) - Method in class org.sikuli.api.AbstractScreenRegion

setScreen(Screen) - Method in class org.sikuli.api.DefaultScreenLocation

setScreen(Screen) - Method in interface org.sikuli.api.ScreenLocation

Sets the screen associated with this screen location.

setScreen(Screen) - Method in interface org.sikuli.api.ScreenRegion

Sets the Screen of this ScreenRegion to be the specified Screen.

setScreenRegion(ScreenRegion) - Method in class org.sikuli.api.visual.ScreenRegionCanvas

Sets the ScreenRegion of this ScreenRegionCanvas object.

setText(String) - Method in class org.sikuli.api.visual.element.LabelElement

setTransparency(float) - Method in class org.sikuli.api.visual.element.Element

Sets the transparency (alpha component) value of this Element.

setWidth(int) - Method in class org.sikuli.api.AbstractScreenRegion

Sets the width of the rectangular screen region.

setX(int) - Method in class org.sikuli.api.AbstractScreenRegion

Sets the X coordinate of the upper-left corner of the rectangular screen region.

setX(int) - Method in class org.sikuli.api.DefaultLocation

setX(int) - Method in class org.sikuli.api.DefaultScreenLocation

setX(int) - Method in interface org.sikuli.api.Location

Sets the X location of the screen coordinate.

setY(int) - Method in class org.sikuli.api.AbstractScreenRegion

Sets the Y coordinate of the upper-left corner of the rectangular screen region.

setY(int) - Method in class org.sikuli.api.DefaultLocation

setY(int) - Method in class org.sikuli.api.DefaultScreenLocation

setY(int) - Method in interface org.sikuli.api.Location

Sets the Y location of the screen coordinate.

SHIFT - Static variable in class org.sikuli.api.robot.Key

SHIFT - Static variable in class org.sikuli.api.robot.KeyModifier

shorter(int) - Method in class org.sikuli.api.Relative.RelativeScreenRegionBuilder

Returns a new RelativeScreenRegionBuilder object that is shorter than this ScreenRegion by the specified amount.

show() - Method in class org.sikuli.api.visual.Canvas

Shows a canvas.

show() - Method in class org.sikuli.api.visual.ImageCanvas

show() - Method in class org.sikuli.api.visual.ScreenRegionCanvas

SikuliRuntimeException - Exception in org.sikuli.api

SikuliRuntimeException() - Constructor for exception org.sikuli.api.SikuliRuntimeException

SikuliRuntimeException(String, Throwable) - Constructor for exception org.sikuli.api.SikuliRuntimeException

SikuliRuntimeException(String) - Constructor for exception org.sikuli.api.SikuliRuntimeException

SikuliRuntimeException(Throwable) - Constructor for exception org.sikuli.api.SikuliRuntimeException

size(int, int) - Method in class org.sikuli.api.visual.CanvasBuilder.ElementAreaSetter

snapshot() - Method in class org.sikuli.api.DefaultScreenRegion

snapshot() - Method in interface org.sikuli.api.ScreenRegion

Returns a ScreenRegion object that corresponds to the screen and region of this ScreenRegion.

SPACE - Static variable in class org.sikuli.api.robot.Key

stateChanged(StateChangeEvent) - Method in interface org.sikuli.api.event.StateChangeListener

Invoked when the state of a ScreenRegion has changed.

StateChangeEvent - Class in org.sikuli.api.event

Event that a screen region has changed its state null means the state is unknown

StateChangeEvent(ScreenRegion, Object, Object) - Constructor for class org.sikuli.api.event.StateChangeEvent

StateChangeListener - Interface in org.sikuli.api.event

Interface for a screen region to register to receive notifications when the state of this screen region has changed.

StaticImageScreen - Class in org.sikuli.api

StaticImageScreen class implements a Screen that behaves as if it *always* displays a given image.

StaticImageScreen(BufferedImage) - Constructor for class org.sikuli.api.StaticImageScreen

StaticImageScreenRegion - Class in org.sikuli.api

StaticImageScreenRegion class behaves like a ScreenRegion but it always provides a given image as the screenshot.

StaticImageScreenRegion(BufferedImage) - Constructor for class org.sikuli.api.StaticImageScreenRegion

StyleBuilder - Class in org.sikuli.api.visual

A StyleBuilder is used to to ease style building the Canvas.

StyleBuilder(Canvas, Element) - Constructor for class org.sikuli.api.visual.StyleBuilder

Constructs a new StyleBuilder whose Canvas and Element specified with the arguments of the same name.

StyledRectangleTarget - Class in org.sikuli.api

StyledRectangleTarget class is used to identify rectangular targets that have a particular rectangle style (lines and corners) while ignoring the content inside the rectangle.

StyledRectangleTarget(URL) - Constructor for class org.sikuli.api.StyledRectangleTarget

Creates a StyledRectangleTarget from an image at a given URL.

StyledRectangleTarget(File) - Constructor for class org.sikuli.api.StyledRectangleTarget

Creates a StyledRectangleTarget from a File object.

StyledRectangleTarget(BufferedImage) - Constructor for class org.sikuli.api.StyledRectangleTarget

Creates a StyledRectangleTarget from a BufferedImage.

styleWith() - Method in class org.sikuli.api.visual.CanvasBuilder.RelativeToRegion

styleWith() - Method in class org.sikuli.api.visual.element.Element

T

TAB - Static variable in class org.sikuli.api.robot.Key

taller(int) - Method in class org.sikuli.api.Relative.RelativeScreenRegionBuilder

Returns a new RelativeScreenRegionBuilder object that is taller than this ScreenRegion by the specified amount.

Target - Interface in org.sikuli.api

The Target interface allows you to specify what targets to find or wait for and also to specify several control parameters.

Target.Ordering - Enum in org.sikuli.api

Defines a set of constants to use to indicate how multiple targets should be ordered by find functions

targetAppeared(TargetEvent) - Method in interface org.sikuli.api.event.TargetEventListener

Invoked when a target has appeared in a screen region.

TargetEvent - Class in org.sikuli.api.event

Event that a target has appeared, vanished, or moved in a specific screen region

TargetEvent(Target, ScreenRegion, ScreenRegion) - Constructor for class org.sikuli.api.event.TargetEvent

Constructs a new TargetEvent from the specified Target and ScreenRegion, and targetRegion.

TargetEventListener - Interface in org.sikuli.api.event

Interface for a screen region to register and receive notifications when a target has appeared, vanished, or moved within this screen region.

targetMoved(TargetEvent) - Method in interface org.sikuli.api.event.TargetEventListener

Invoked when a target has moved to another location in a screen region.

targetVanished(TargetEvent) - Method in interface org.sikuli.api.event.TargetEventListener

Invoked when a target has vanished from a screen region.

textUpdated(String) - Method in interface org.sikuli.api.visual.element.LabelElement.Listener

to(ScreenRegion) - Static method in class org.sikuli.api.Relative

Returns a new RelativeScreenRegionBuilder object using the specified ScreenRegion object.

to(ScreenLocation) - Static method in class org.sikuli.api.Relative

Returns a new RelativeScreenLocationBuilder object using the specified ScreenLocation object.

toImage() - Method in class org.sikuli.api.DefaultTarget

Gets the image representation of this target for visualization purposes

toImage() - Method in class org.sikuli.api.ImageTarget

toJavaKeyCode(String) - Static method in class org.sikuli.api.robot.Key

Convert Sikuli Key to Java virtual key code

toJavaKeyCode(char) - Static method in class org.sikuli.api.robot.Key

Convert Sikuli Key to Java virtual key code

topCenter() - Method in class org.sikuli.api.Relative.RelativeScreenRegionBuilder

Returns a new RelativeScreenLocationBuilder object that corresponds to the top-center of this ScreenRegion.

topLeft() - Method in class org.sikuli.api.Relative.RelativeScreenRegionBuilder

Returns a new RelativeScreenLocationBuilder object that corresponds to the top-left corner of this ScreenRegion.

topRight() - Method in class org.sikuli.api.Relative.RelativeScreenRegionBuilder

Returns a new RelativeScreenLocationBuilder object that corresponds to the top-right corner of this ScreenRegion.

toString() - Method in class org.sikuli.api.AbstractScreenRegion

toString() - Method in class org.sikuli.api.DefaultScreenLocation

Returns a String representation of this DefaultScreenLocation and its values.

toString() - Method in class org.sikuli.api.ImageTarget

Returns a String object representing this ImageTarget object's value.

toString() - Method in class org.sikuli.api.robot.desktop.DesktopScreen

Returns a String representation of this DesktopScreen and its values.

transparency(float) - Method in class org.sikuli.api.visual.element.ElementStyleSetter

Sets the transparency (alpha component) value of this canvas element.

type(String) - Method in class org.sikuli.api.robot.desktop.DesktopKeyboard

type(String) - Method in interface org.sikuli.api.robot.Keyboard

Performs keyboard typing of the text specified by the arguments of the same name.

U

UP - Static variable in class org.sikuli.api.robot.Key

V

valueOf(String) - Static method in enum org.sikuli.api.robot.OS

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.sikuli.api.Target.Ordering

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.sikuli.api.visual.element.Element.HorizontalAlignment

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.sikuli.api.visual.element.Element.VerticalAlignment

Returns the enum constant of this type with the specified name.

values() - Static method in enum org.sikuli.api.robot.OS

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.sikuli.api.Target.Ordering

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.sikuli.api.visual.element.Element.HorizontalAlignment

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.sikuli.api.visual.element.Element.VerticalAlignment

Returns an array containing the constants of this enum type, in the order they are declared.

verticalAlignment - Variable in class org.sikuli.api.visual.element.Element

verticalAlignmentBottom() - Method in class org.sikuli.api.visual.element.ElementStyleSetter

Sets the vertical alignment of this canvas element at the bottom.

verticalAlignmentMiddle() - Method in class org.sikuli.api.visual.element.ElementStyleSetter

Sets the vertical alignment of this canvas element in the middle.

verticalAlignmentTop() - Method in class org.sikuli.api.visual.element.ElementStyleSetter

Sets the vertical alignment of this canvas element at the top.

VisualEventManager - Class in org.sikuli.api.event

W

wait(Target, int) - Method in class org.sikuli.api.DefaultScreenRegion

wait(Target, int) - Method in interface org.sikuli.api.ScreenRegion

Blocks and waits until a target is found in this screen region within a given time period.

wheel(int, int) - Method in class org.sikuli.api.robot.desktop.DesktopMouse

wheel(int, int) - Method in interface org.sikuli.api.robot.Mouse

Move the wheel at the current position

wider(int) - Method in class org.sikuli.api.Relative.RelativeScreenRegionBuilder

Returns a new RelativeScreenRegionBuilder object that is wider than this ScreenRegion by the specified amount.

width - Variable in class org.sikuli.api.visual.element.Element

WIN - Static variable in class org.sikuli.api.robot.Key

WIN - Static variable in class org.sikuli.api.robot.KeyModifier

withBackgroundColor(Color) - Method in class org.sikuli.api.visual.StyleBuilder

Sets the background color of this canvas element.

withColor(Color) - Method in class org.sikuli.api.visual.StyleBuilder

Sets the foreground color of this canvas element.

withFontSize(int) - Method in class org.sikuli.api.visual.element.ElementStyleSetter

Sets the font size color of this canvas element.

withFontSize(int) - Method in class org.sikuli.api.visual.StyleBuilder

Sets the font size color of this canvas element.

withHorizontalAlignmentCenter() - Method in class org.sikuli.api.visual.StyleBuilder

Sets the horizontal alignment of this canvas element at the center.

withHorizontalAlignmentLeft() - Method in class org.sikuli.api.visual.StyleBuilder

Sets the horizontal alignment of this canvas element on the left.

withHorizontalAlignmentRight() - Method in class org.sikuli.api.visual.StyleBuilder

Sets the horizontal alignment of this canvas element on the right.

withLineColor(Color) - Method in class org.sikuli.api.visual.StyleBuilder

Sets the line color of this canvas element.

withLineWidth(int) - Method in class org.sikuli.api.visual.StyleBuilder

Sets the line width of this canvas element.

withTransparency(float) - Method in class org.sikuli.api.visual.StyleBuilder

Sets the transparency (alpha component) value of this canvas element.

withVerticalAlignmentBottom() - Method in class org.sikuli.api.visual.StyleBuilder

Sets the vertical alignment of this canvas element at the bottom.

withVerticalAlignmentMiddle() - Method in class org.sikuli.api.visual.StyleBuilder

Sets the vertical alignment of this canvas element in the middle.

withVerticalAlignmentTop() - Method in class org.sikuli.api.visual.StyleBuilder

Sets the vertical alignment of this canvas element at the top.

X

x - Variable in class org.sikuli.api.visual.element.Element

Y

y - Variable in class org.sikuli.api.visual.element.Element

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