org.sikuli.api
Class Relative.RelativeScreenLocationBuilder

java.lang.Object
  org.sikuli.api.Relative.RelativeScreenLocationBuilder

Enclosing class:

Relative

public static class Relative.RelativeScreenLocationBuilder
extends Object

A RelativeScreenLocationBuilder represents a copy of the original ScreenLocation.

Constructor Summary

Relative.RelativeScreenLocationBuilder(ScreenLocation screenLocation)
Constructs a new RelativeScreenLocationBuilder that is a copy of the specified ScreenLocation.

Method Summary

Relative.RelativeScreenLocationBuilder	above(int amount) Returns a new RelativeScreenLocationBuilder object that is above this ScreenLocation by the specified amount.
Relative.RelativeScreenLocationBuilder	below(int amount) Returns a new RelativeScreenLocationBuilder object that is below this ScreenLocation by the specified amount.
ScreenLocation	getScreenLocation() Returns the ScreenLocation of this RelativeScreenLocationBuilder.
Relative.RelativeScreenLocationBuilder	left(int amount) Returns a new RelativeScreenLocationBuilder object relative to the left of this ScreenLocation by the specified amount.
Relative.RelativeScreenLocationBuilder	right(int amount) Returns a new RelativeScreenLocationBuilder object relative to the right of this ScreenLocation by the specified amount.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Relative.RelativeScreenLocationBuilder

public Relative.RelativeScreenLocationBuilder(ScreenLocation screenLocation)

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

Parameters:

screenLocation - the ScreenLocation to which a relative screen location is created.

Method Detail

getScreenLocation

public ScreenLocation getScreenLocation()

Returns the ScreenLocation of this RelativeScreenLocationBuilder.

Returns:

the ScreenLocation of this RelativeScreenLocationBuilder

above

public Relative.RelativeScreenLocationBuilder above(int amount)

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

Parameters:

amount - the pixel amount to move above.

Returns:

a new RelativeScreenLocationBuilder object that is above this ScreenLocation.

below

public Relative.RelativeScreenLocationBuilder below(int amount)

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

Parameters:

amount - the pixel amount to move below.

Returns:

a new RelativeScreenLocationBuilder object that is below this ScreenLocation.

left

public Relative.RelativeScreenLocationBuilder left(int amount)

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

Parameters:

amount - the pixel amount to move to the left.

Returns:

a new RelativeScreenLocationBuilder object to the left of this ScreenLocation.

right

public Relative.RelativeScreenLocationBuilder right(int amount)

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

Parameters:

amount - the pixel amount to move to the right.

Returns:

a new RelativeScreenLocationBuilder object to the right of this ScreenLocation.