org.sikuli.vnc

Class VNCScreen

java.lang.Object

org.sikuli.script.Region

org.sikuli.vnc.VNCScreen

All Implemented Interfaces:

Closeable, AutoCloseable, IScreen

public class VNCScreen
extends Region
implements IScreen, Closeable

Field Summary

Fields inherited from class org.sikuli.script.Region

BB, BH, BL, BM, BR, C2, CH, CREATE_X_DIRECTION_LEFT, CREATE_X_DIRECTION_RIGHT, CREATE_Y_DIRECTION_BOTTOM, CREATE_Y_DIRECTION_TOP, CV, EAST, EAST_MID, EAST_NORTH, EAST_SOUTH, EH, EM, EN, ES, h, LB, 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, RM, RR, RT, SE, SH, SM, SOUTH, SOUTH_EAST, SOUTH_MID, SOUTH_WEST, SW, TH, TL, TM, TR, TT, w, WEST, WEST_MID, WEST_NORTH, WEST_SOUTH, WH, WM, WN, WS, x, y

Method Summary

Modifier and Type	Method and Description
ScreenImage	capture()
ScreenImage	capture(int x, int y, int w, int h)
ScreenImage	capture(Rectangle rect)
ScreenImage	capture(Region reg)
void	close()
Rectangle	getBounds()
org.sikuli.vnc.VNCClient	getClient()
int	getID()
int	getIdFromPoint(int srcx, int srcy)
ScreenImage	getLastScreenImageFromScreen()
protected <PSIMRL> Location	getLocationFromTarget(PSIMRL target)
IRobot	getRobot()
void	showTarget(Location loc)
protected void	showTarget(Location loc, double secs)
static VNCScreen	start(String theIP, int thePort, int cTimeout, int timeout)
static VNCScreen	start(String theIP, int thePort, String password, int cTimeout, int timeout)
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, compare, compare, contains, contains, containsMouse, copyTo, copyTo, create, create, create, create, create, create, delayClick, delayType, doubleClick, doubleClick, doubleClick, drag, dragDrop, dragDrop, dropAt, exists, exists, find, findAll, findAllByColumn, findAllByRow, findAllText, findBest, findText, findText, get, getAutoWaitTimeout, getBottomLeft, getBottomRight, getCell, getCenter, getCol, getCol, getCols, getColW, getEvent, getEvents, getFindFailedResponse, getH, getIDString, getLastMatch, getLastMatches, getLastScreenImage, getLastScreenImageFile, getLastScreenImageFile, getLastScreenImageFile, getObserver, getObserveScanRate, getRect, getRectangle, getRepeatWaitTime, getROI, getRow, getRow, getRowH, getRows, getScreen, getScreenContaining, getTarget, getThrowException, getTopLeft, getTopRight, getW, getWaitScanRate, getX, getY, grow, grow, grow, grow, grow, grow, grow, hasEvents, hasObserver, highlight, highlight, highlight, highlight, highlight, highlight, hover, hover, initScreen, inside, intersection, isObserving, isOtherScreen, isRasterValid, isValid, isVirtual, keyDown, keyDown, keyUp, keyUp, keyUp, left, left, leftAt, leftAt, listText, morphTo, mouseDown, mouseMove, mouseMove, mouseMove, mouseUp, mouseUp, moveTo, nearby, nearby, observe, observe, observeInBackground, observeInLine, offset, offset, onAppear, onAppear, onChange, onChange, onChange, onChange, onChangeDo, onVanish, onVanish, paste, paste, regionOnScreen, resetScreens, right, right, rightAt, rightAt, rightClick, rightClick, rightClick, saveLastScreenImage, saveScreenCapture, saveScreenCapture, saveScreenCapture, setActive, setAutoWaitTimeout, setBottomLeft, setBottomRight, setCenter, setCols, setFindFailedHandler, setFindFailedResponse, setH, setImageMissingHandler, 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, silentHighlight, stopObserver, stopObserver, text, toGlobalCoord, toString, toStringShort, type, type, type, type, type, type, union, updateSelf, virtual, wait, wait, wait, waitVanish, waitVanish, wheel, wheel, wheel, write

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.sikuli.script.IScreen

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

Method Detail

start

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

Throws:

IOException

start

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

Throws:

IOException

stop

public void stop()

stopAll

public static void stopAll()

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException

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

showTarget

public void showTarget(Location loc)

Specified by:

showTarget in interface IScreen

showTarget

protected void showTarget(Location loc,
                          double secs)

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 org.sikuli.vnc.VNCClient getClient()