Package org.sikuli.vnc

Class VNCScreen

java.lang.Object

org.sikuli.script.Element

org.sikuli.script.Region

org.sikuli.vnc.VNCScreen

All Implemented Interfaces:

IScreen

public class VNCScreen
extends Region
implements IScreen

Field Summary

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, logName, 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

Method Summary

Modifier and Type	Method	Description
ScreenImage	capture()
ScreenImage	capture(int x, int y, int w, int h)
ScreenImage	capture(Rectangle rect)
ScreenImage	capture(Region reg)
Rectangle	getBounds()
com.sikulix.vnc.VNCClient	getClient()
int	getID()
int	getIdFromPoint(int srcx, int srcy)
String	getIDString()
ScreenImage	getLastScreenImageFromScreen()
protected <PSIMRL> Location	getLocationFromTarget(PSIMRL target)
IRobot	getRobot()
boolean	isRunning()
Location	newLocation(int x, int y)
Location	newLocation(Location loc)
Region	newRegion(int x, int y, int w, int h)
Region	newRegion(Location loc, int w, int h)
Region	newRegion(Region reg)
Location	set(Location element)
Region	set(Region element)
Location	setOther(Location element)
Region	setOther(Region element)
static VNCScreen	start()
static VNCScreen	start(String theIP)
static VNCScreen	start(String theIP, int thePort)
static VNCScreen	start(String theIP, int thePort, int cTimeout, int timeout)
static VNCScreen	start(String theIP, int thePort, String password, int cTimeout, int timeout)
static void	startUp(int waittime)
void	stop()
static void	stopAll()
ScreenImage	userCapture(String msg)

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, getDefaultInstance4py, getEvent, getEvents, getFakeRegion, getFindFailedResponse, getImage, getInset, getLastScreenImage, getLastScreenImageFile, getLastScreenImageFile, getLastScreenImageFile, getObserver, getObserveScanRate, getRect, getRectangle, getRepeatWaitTime, getROI, getRow, getRow, getRowH, getRows, getScreen, 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, make4py, 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, 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

Method Detail

startUp

public static void startUp(int waittime)

start

public static VNCScreen start()

start

public static VNCScreen start(String theIP)

start

public static VNCScreen start(String theIP,
                              int thePort)

start

public static VNCScreen start(String theIP,
                              int thePort,
                              int cTimeout,
                              int timeout)

start

public static VNCScreen start(String theIP,
                              int thePort,
                              String password,
                              int cTimeout,
                              int timeout)

getIDString

public String getIDString()

Specified by:

getIDString in interface IScreen

stop

public void stop()

stopAll

public static void stopAll()

isRunning

public boolean isRunning()

getRobot

public IRobot getRobot()

Specified by:

getRobot in interface IScreen

getBounds

public Rectangle getBounds()

Specified by:

getBounds in interface IScreen

capture

public ScreenImage capture()

Specified by:

capture in interface IScreen

capture

public ScreenImage capture(Region reg)

Specified by:

capture in interface IScreen

capture

public ScreenImage capture(Rectangle rect)

Specified by:

capture in interface IScreen

capture

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

Specified by:

capture in interface IScreen

getID

public int getID()

Specified by:

getID in interface IScreen

getIdFromPoint

public int getIdFromPoint(int srcx,
                          int srcy)

Specified by:

getIdFromPoint in interface IScreen

getLocationFromTarget

protected <PSIMRL> Location getLocationFromTarget(PSIMRL target)
                                           throws FindFailed

Overrides:

getLocationFromTarget in class Region

Throws:

FindFailed

getLastScreenImageFromScreen

public ScreenImage getLastScreenImageFromScreen()

Specified by:

getLastScreenImageFromScreen in interface IScreen

userCapture

public ScreenImage userCapture(String msg)

Specified by:

userCapture in interface IScreen

getClient

public com.sikulix.vnc.VNCClient getClient()

set

public Region set(Region element)

set

public Location set(Location element)

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

newLocation

public Location newLocation(Location loc)

Specified by:

newLocation in interface IScreen

newRegion

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

Specified by:

newRegion in interface IScreen

newRegion

public Region newRegion(Location loc,
                        int w,
                        int h)

Specified by:

newRegion in interface IScreen

newRegion

public Region newRegion(Region reg)

Specified by:

newRegion in interface IScreen