Package org.sikuli.script

Class Screen

java.lang.Object

org.sikuli.script.Element

org.sikuli.script.Region

org.sikuli.script.Screen

All Implemented Interfaces:

IScreen

Direct Known Subclasses:

ScreenUnion

public class Screen
extends Region
implements IScreen

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).
A screen inherits from class Region, so it can be used as such in all aspects. If you need the region of the screen more than once, you have to create new ones based on the screen.
The so called primary screen is the one with top left (0,0) and has id 0.

Field Summary

Fields

Modifier and Type	Field	Description
protected int	curID
static boolean	ignorePrimaryAtCapture
ScreenImage	lastScreenImage
protected static String	logName
protected int	monitor
protected int	oldID
protected static int	primaryScreen
protected OverlayCapturePrompt	prompt
protected static Screen[]	screens
protected boolean	waitPrompt

Fields inherited from class org.sikuli.script.Region

BB, BH, BL, BM, BOTTOM, BR, C2, CH, CV, EAST, EAST_MID, EAST_NORTH, EAST_SOUTH, EH, EM, EN, ES, LB, LEFT, LH, LL, LM, LT, M2, M3, MH, MID_HORIZONTAL, MID_VERTICAL, MIDDLE, MIDDLE_BIG, MM, MV, NE, NH, NM, NORTH, NORTH_EAST, NORTH_MID, NORTH_WEST, NW, otherScreen, RB, RH, RIGHT, RM, RR, RT, SE, SH, SM, SOUTH, SOUTH_EAST, SOUTH_MID, SOUTH_WEST, SW, TH, TL, TM, TOP, TR, TT, WEST, WEST_MID, WEST_NORTH, WEST_SOUTH, WH, WM, WN, WS

Fields inherited from class org.sikuli.script.Element

h, imageMissingHandler, lastFindTime, lastMatch, lastMatches, lastSearchTime, lastSearchTimeRepeat, logLevel, w, x, y

Constructor Summary

Constructors

Constructor	Description
Screen()	Is the screen object having the top left corner as (0,0).
Screen(boolean isScreenUnion)	INTERNAL USE collect all physical screens to one big region TODO: under evaluation, wether it really makes sense
Screen(int id)	The screen object with the given id

Method Summary

Modifier and Type	Method	Description
static ScreenUnion	all()	create a Screen (ScreenUnion) object as a united region of all available monitors
static Screen	as(int id)
ScreenImage	capture()	create a ScreenImage with the physical bounds of this screen
ScreenImage	capture(int x, int y, int w, int h)	create a ScreenImage with given coordinates on this screen.
ScreenImage	capture(Rectangle rect)	create a ScreenImage with given rectangle on this screen.
ScreenImage	capture(Region reg)	create a ScreenImage with given region on this screen
static void	closePrompt()
static void	closePrompt(Screen scr)
ScreenImage	cmdCapture(Object... args)
static void	doPrompt(String message, EventObserver obs)
Rectangle	getBounds()
static Rectangle	getBounds(int id)
static Screen	getDefaultInstance4py()
protected static IRobot	getGlobalRobot()
int	getID()
int	getIdFromPoint(int x, int y)	INTERNAL USE: to be compatible with ScreenUnion
String	getIDString()
ScreenImage	getLastScreenImageFromScreen()
static Rectangle	getMonitor(int n)
static int	getNumberScreens()
static int	getPrimaryId()
static Screen	getPrimaryScreen()
IRobot	getRobot()	Gets the Robot of this Screen.
static IRobot	getRobot(int id)	each screen has exactly one robot (internally used for screen capturing) available as a convenience for those who know what they are doing.
protected static IRobot	getRobot(Region reg)
Screen	getScreen()
static Screen	getScreen(int id)
static Rectangle	hasPoint(Point aPoint)
boolean	hasPrompt()
protected static void	initScreens(boolean reset)
static boolean	isHeadless()
static Screen	make4py(ArrayList args)
Location	newLocation(int x, int y)
Location	newLocation(Location loc)	creates a location on the current screen with the given point.
Region	newRegion(int x, int y, int w, int h)
Region	newRegion(Location loc, int width, int height)	creates a region on the current screen with the given coordinate/size.
Region	newRegion(Region reg)
static void	resetMonitors()	re-initialize the monitor setup (e.g. when it was changed while running)
static void	resetMonitorsQuiet()
static void	resetPrompt(OverlayCapturePrompt ocp)
Region	selectRegion()	interactive region create with predefined message: lets the user draw the rectangle using the mouse
Region	selectRegion(String message)	interactive region create with given message: lets the user draw the rectangle using the mouse
void	setAsScreen()	INTERNAL USE reset from being a screen union to the screen used before
void	setAsScreenUnion()	INTERNAL USE collect all physical screens to one big region This is under evaluation, wether it really makes sense
Location	setOther(Location element)
Region	setOther(Region element)
protected Region	setScreen(IScreen s)	Should not be used - makes no sense for Screen object
static void	showMonitors()	show the current monitor setup
ScreenImage	userCapture()	interactive capture with predefined message: lets the user capture a screen image using the mouse to draw the rectangle
ScreenImage	userCapture(String message)	interactive capture with given message: lets the user capture a screen image using the mouse to draw the rectangle

Methods inherited from class org.sikuli.script.Region

above, above, aboveAt, aboveAt, add, add, add, aInput, aKey, asOffset, aSwipe, aSwipeDown, aSwipeLeft, aSwipeRight, aSwipeUp, aTap, atMouse, below, below, belowAt, belowAt, checkMatch, click, click, click, contains, contains, containsMouse, copyTo, copyTo, create, create, create, create, create, create, create, delayClick, delayType, doHighlight, doubleClick, doubleClick, doubleClick, drag, dragDrop, dragDrop, dropAt, exists, exists, existsText, existsText, find, findAll, findAllByColumn, findAllByRow, findAllList, findAllText, findAny, findAnyList, findBest, findBestList, findText, get, getAll, getAutoWaitTimeout, getBottomLeft, getBottomRight, getCell, getCenter, getCol, getCol, getCols, getColW, getEvent, getEvents, getFakeRegion, getFindFailedResponse, getImage, getInset, getLastScreenImage, getLastScreenImageFile, getLastScreenImageFile, getLastScreenImageFile, getLocationFromTarget, getObserver, getObserveScanRate, getRect, getRectangle, getRepeatWaitTime, getROI, getRow, getRow, getRowH, getRows, getScreenContaining, getTarget, getThrowException, getTopLeft, getTopRight, getWaitScanRate, grow, grow, grow, grow, grow, grow, grow, has, has, hasEvents, hasObserver, hasText, highlight, highlight, highlight, highlight, highlight4py, highlightAllOff, highlightOff, highlightOn, highlightOn, hover, hover, initScreen, inside, internalUseOnlyHighlightReset, intersection, isObserving, isOtherScreen, isRasterValid, isValid, isVirtual, keyDown, keyDown, keyUp, keyUp, keyUp, left, left, leftAt, leftAt, morphTo, mouseDown, mouseMove, mouseMove, mouseMove, mouseUp, mouseUp, moveTo, nearby, nearby, observe, observe, observeInBackground, observeInBackground, observeInLine, offset, offset, onAppear, onAppear, onChange, onChange, onChange, onChange, onVanish, onVanish, paste, paste, regionOnScreen, relocate, relocate, resetFindFailedResponse, resetScreens, resetThrowException, right, right, rightAt, rightAt, rightClick, rightClick, rightClick, saveCapture, saveLastScreenImage, setActive, setAutoWaitTimeout, setBottomLeft, setBottomRight, setCenter, setCols, setFindFailedHandler, setFindFailedResponse, setH, setInactive, setLocation, setObserveScanRate, setOtherScreen, setOtherScreen, setRaster, setRect, setRect, setRect, setRepeatWaitTime, setROI, setROI, setROI, setROI, setRows, setScreen, setSize, setThrowException, setTopLeft, setTopRight, setVirtual, setW, setWaitScanRate, setX, setY, showScreens, stopObserver, stopObserver, toGlobalCoord, toString, toStringShort, type, type, type, type, type, type, union, unionAll, unionAny, unionAnyList, virtual, wait, wait, wait, waitAny, waitAnyList, waitBest, waitBestList, waitT, waitT, waitText, waitText, waitVanish, waitVanish, wheel, wheel, wheel, write

Methods inherited from class org.sikuli.script.Element

collectLines, collectLinesText, collectWords, collectWordsText, existsT, findAllT, findLine, findLines, findLines, findT, findWord, findWords, findWords, getBufferedImage, getH, getImageFromTarget, getLastMatch, getLastMatches, getName, getW, getX, getY, hasT, isEmpty, log, returnThis, setImageMissingHandler, setName, text, textChar, textLine, textLines, textWord, textWords

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.sikuli.script.support.IScreen

getH, getLastScreenImageFile, getRect, getW, getX, getY, isOtherScreen

Field Detail

logName

protected static final String logName

See Also:

Constant Field Values

screens

protected static Screen[] screens

primaryScreen

protected static int primaryScreen

curID

protected int curID

oldID

protected int oldID

monitor

protected int monitor

waitPrompt

protected boolean waitPrompt

prompt

protected OverlayCapturePrompt prompt

ignorePrimaryAtCapture

public static boolean ignorePrimaryAtCapture

lastScreenImage

public ScreenImage lastScreenImage

Constructor Detail

Screen

public Screen()

Is the screen object having the top left corner as (0,0). If such a screen does not exist it is the screen with id 0.

Screen

public Screen(int id)

The screen object with the given id

Parameters:

id - valid screen number

Screen

public Screen(boolean isScreenUnion)

INTERNAL USE collect all physical screens to one big region
TODO: under evaluation, wether it really makes sense

Parameters:

isScreenUnion - true/false

Method Detail

getDefaultInstance4py

public static Screen getDefaultInstance4py()

isHeadless

public static boolean isHeadless()

getMonitor

public static Rectangle getMonitor(int n)

hasPoint

public static Rectangle hasPoint(Point aPoint)

initScreens

protected static void initScreens(boolean reset)

make4py

public static Screen make4py(ArrayList args)

as

public static Screen as(int id)

getGlobalRobot

protected static IRobot getGlobalRobot()

all

public static ScreenUnion all()

create a Screen (ScreenUnion) object as a united region of all available monitors

Returns:

ScreenUnion

setAsScreenUnion

public void setAsScreenUnion()

INTERNAL USE collect all physical screens to one big region
This is under evaluation, wether it really makes sense

setAsScreen

public void setAsScreen()

INTERNAL USE reset from being a screen union to the screen used before

getScreen

public Screen getScreen()

Overrides:

getScreen in class Region

Returns:

Screen

setScreen

protected Region setScreen(IScreen s)

Should not be used - makes no sense for Screen object

Overrides:

setScreen in class Region

Parameters:

s - Screen

Returns:

returns a new Region with the screen's location/dimension

showMonitors

public static void showMonitors()

show the current monitor setup

resetMonitors

public static void resetMonitors()

re-initialize the monitor setup (e.g. when it was changed while running)

resetMonitorsQuiet

public static void resetMonitorsQuiet()

getNumberScreens

public static int getNumberScreens()

Returns:

number of available screens

getPrimaryId

public static int getPrimaryId()

Returns:

the id of the screen at (0,0), if not exists 0

getPrimaryScreen

public static Screen getPrimaryScreen()

Returns:

the screen at (0,0), if not exists the one with id 0

getScreen

public static Screen getScreen(int id)

Parameters:

id - of the screen

Returns:

the screen with given id, the primary screen if id is invalid

getBounds

public Rectangle getBounds()

Specified by:

getBounds in interface IScreen

Returns:

the screen's rectangle

getBounds

public static Rectangle getBounds(int id)

Parameters:

id - of the screen

Returns:

the physical coordinate/size
as AWT.Rectangle to avoid mix up with getROI

getRobot

public static IRobot getRobot(int id)

each screen has exactly one robot (internally used for screen capturing)
available as a convenience for those who know what they are doing. Should not be needed normally.

Parameters:

id - of the screen

Returns:

the AWT.Robot of the given screen, if id invalid the primary screen

getID

public int getID()

Specified by:

getID in interface IScreen

Returns:

the id

getIDString

public String getIDString()

Specified by:

getIDString in interface IScreen

getIdFromPoint

public int getIdFromPoint(int x,
                          int y)

INTERNAL USE: to be compatible with ScreenUnion

Specified by:

getIdFromPoint in interface IScreen

Parameters:

x - value

y - value

Returns:

id of the screen

getRobot

public IRobot getRobot()

Gets the Robot of this Screen.

Specified by:

getRobot in interface IScreen

Returns:

The Robot for this Screen

getRobot

protected static IRobot getRobot(Region reg)

newRegion

public Region newRegion(Location loc,
                        int width,
                        int height)

creates a region on the current screen with the given coordinate/size. The coordinate is translated to the current screen from its relative position on the screen it would have been created normally.

Specified by:

newRegion in interface IScreen

Parameters:

loc - Location

width - value

height - value

Returns:

the new region

newRegion

public Region newRegion(Region reg)

Specified by:

newRegion in interface IScreen

newRegion

public Region newRegion(int x,
                        int y,
                        int w,
                        int h)

Specified by:

newRegion in interface IScreen

newLocation

public Location newLocation(Location loc)

creates a location on the current screen with the given point. The coordinate is translated to the current screen from its relative position on the screen it would have been created normally.

Specified by:

newLocation in interface IScreen

Parameters:

loc - Location

Returns:

the new location

getLastScreenImageFromScreen

public ScreenImage getLastScreenImageFromScreen()

Specified by:

getLastScreenImageFromScreen in interface IScreen

cmdCapture

public ScreenImage cmdCapture(Object... args)

capture

public ScreenImage capture()

create a ScreenImage with the physical bounds of this screen

Specified by:

capture in interface IScreen

Returns:

the image

capture

public ScreenImage capture(int x,
                           int y,
                           int w,
                           int h)

create a ScreenImage with given coordinates on this screen.

Specified by:

capture in interface IScreen

Parameters:

x - x-coordinate of the region to be captured

y - y-coordinate of the region to be captured

w - width of the region to be captured

h - height of the region to be captured

Returns:

the image of the region

capture

public ScreenImage capture(Rectangle rect)

create a ScreenImage with given rectangle on this screen.

Specified by:

capture in interface IScreen

Parameters:

rect - The Rectangle to be captured

Returns:

the image of the region

capture

public ScreenImage capture(Region reg)

create a ScreenImage with given region on this screen

Specified by:

capture in interface IScreen

Parameters:

reg - The Region to be captured

Returns:

the image of the region

doPrompt

public static void doPrompt(String message,
                            EventObserver obs)

closePrompt

public static void closePrompt()

closePrompt

public static void closePrompt(Screen scr)

resetPrompt

public static void resetPrompt(OverlayCapturePrompt ocp)

hasPrompt

public boolean hasPrompt()

userCapture

public ScreenImage userCapture()

interactive capture with predefined message: lets the user capture a screen image using the mouse to draw the rectangle

Returns:

the image

userCapture

public ScreenImage userCapture(String message)

interactive capture with given message: lets the user capture a screen image using the mouse to draw the rectangle

Specified by:

userCapture in interface IScreen

Parameters:

message - text

Returns:

the image

selectRegion

public Region selectRegion()

interactive region create with predefined message: lets the user draw the rectangle using the mouse

Returns:

the region

selectRegion

public Region selectRegion(String message)

interactive region create with given message: lets the user draw the rectangle using the mouse

Parameters:

message - text

Returns:

the region

setOther

public Region setOther(Region element)

Specified by:

setOther in interface IScreen

setOther

public Location setOther(Location element)

Specified by:

setOther in interface IScreen

newLocation

public Location newLocation(int x,
                            int y)

Specified by:

newLocation in interface IScreen