ScreenRemote (Javadoc of Sikuli Script)

java.lang.Object
- org.sikuli.script.Region
- - org.sikuli.script.Screen
  - - org.sikuli.script.ScreenRemote

All Implemented Interfaces:

IScreen, EventObserver
```
public class ScreenRemote
extends Screen
implements IScreen
```
UNDER DEVELOPMENT - EXPERIMENTAL an extension to the DesktopScreen implementation Screen, that allows to redirect the actions to a remote screen/keyboard/mouse in conjunction with the package SikuliX-Remote running on the remote system

Field Summary
- Fields inherited from class org.sikuli.script.Screen
  monitor, oldID, primaryScreen, prompt, robot, screens, waitPrompt
- 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

Constructor Summary

Constructors
Constructor and Description

ScreenRemote(String adr, String p)

Constructors
Constructor and Description
`ScreenRemote(String adr, String p)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`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 r)` create a ScreenImage with given rectangle on this screen.
`ScreenImage`	`capture(Region r)` create a ScreenImage with given region on this screen
`boolean`	`close()`
`boolean`	`close(boolean stopServer)`
`Rectangle`	`getBounds()`
`ObjectInputStream`	`getIn()`
`OutputStreamWriter`	`getOut()`
`IRobot`	`getRobot()` Gets the Robot of this Screen.
`boolean`	`isValid()` Check wether thie Region is contained by any of the available screens
`Location`	`mousePointer()`
`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 w, int h)` creates a region on the current screen with the given coordinate/size.
`Region`	`newRegion(Rectangle r)`
`Region`	`newRegion(Region r)`
`String`	`toString()`
`String`	`toStringShort()` only a short version of toString()

Methods inherited from class org.sikuli.script.Screen
all, as, captureforHighlight, closePrompt, getBounds, getcurrentID, getFakeRegion, getID, getIdFromPoint, getLastScreenImageFromScreen, getMouseRobot, getNumberScreens, getPrimaryId, getPrimaryScreen, getRobot, getScreen, getScreen, initScreen, resetMonitors, saveCapture, saveCapture, selectRegion, selectRegion, setAsScreen, setAsScreenUnion, setScreen, showMonitors, showTarget, showTarget, startPrompt, toJSON, update, useFullscreen, userCapture, userCapture

Methods inherited from class org.sikuli.script.Region
above, above, aboveAt, aboveAt, add, add, add, asOffset, 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, getLastMatch, getLastMatches, getLastScreenImage, getLastScreenImageFile, getLastScreenImageFile, getLastScreenImageFile, getLastTime, getObserver, getObserveScanRate, getRect, getRectangle, getRepeatWaitTime, getROI, getRow, getRow, getRowH, getRows, 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, init, initScreen, inside, intersection, isObserving, isOtherScreen, isRasterValid, isVirtual, keyDown, keyDown, keyUp, keyUp, keyUp, left, left, leftAt, leftAt, listText, morphTo, mouseDown, mouseMove, mouseMove, mouseMove, mouseUp, mouseUp, moveTo, nearby, nearby, observe, observe, observeInBackground, observeJ, 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, setFindFailedResponse, setH, setInactive, setLocation, setObserveScanRate, setOtherScreen, setRaster, setRect, setRect, setRect, setRepeatWaitTime, setROI, setROI, setROI, setROI, setRows, setScreen, setSize, setThrowException, setTopLeft, setTopRight, setVirtual, setW, setWaitScanRate, setX, setY, showScreens, silentHighlight, stopObserver, stopObserver, text, toGlobalCoord, 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, getID, getIdFromPoint, getLastScreenImageFile, getLastScreenImageFromScreen, getRect, getW, getX, getY, isOtherScreen, showTarget, userCapture

- Constructor Detail
  - ScreenRemote
```
public ScreenRemote(String adr,
                    String p)
```
- Method Detail
  - toString
```
public String toString()
```
    Description copied from class: Region
    
    Overrides:
    
    toString in class Screen
    
    Returns:
    
    the description
  - toStringShort
```
public String toStringShort()
```
    Description copied from class: Screen
    
    only a short version of toString()
    
    Specified by:
    
    toStringShort in interface IScreen
    
    Overrides:
    
    toStringShort in class Screen
    
    Returns:
    
    like S(0) [0,0, 1440x900]
  - isValid
```
public boolean isValid()
```
    Description copied from class: Region
    
    Check wether thie Region is contained by any of the available screens
    
    Overrides:
    
    isValid in class Region
    
    Returns:
    
    true if yes, false otherwise
  - getIn
```
public ObjectInputStream getIn()
```
  - getOut
```
public OutputStreamWriter getOut()
```
  - close
```
public boolean close(boolean stopServer)
```
  - close
```
public boolean close()
```
  - getRobot
```
public IRobot getRobot()
```
    Description copied from class: Screen
    
    Gets the Robot of this Screen.
    
    Specified by:
    
    getRobot in interface IScreen
    
    Overrides:
    
    getRobot in class Screen
    
    Returns:
    
    The Robot for this Screen
  - getBounds
```
public Rectangle getBounds()
```
    Specified by:
    
    getBounds in interface IScreen
    
    Overrides:
    
    getBounds in class Screen
    
    Returns:
    
    the screen's rectangle
  - capture
```
public ScreenImage capture()
```
    Description copied from class: Screen
    
    create a ScreenImage with the physical bounds of this screen
    
    Specified by:
    
    capture in interface IScreen
    
    Overrides:
    
    capture in class Screen
    
    Returns:
    
    the image
  - capture
```
public ScreenImage capture(int x,
                           int y,
                           int w,
                           int h)
```
    Description copied from class: Screen
    
    create a ScreenImage with given coordinates on this screen.
    
    Specified by:
    
    capture in interface IScreen
    
    Overrides:
    
    capture in class Screen
    
    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 r)
```
    Description copied from class: Screen
    
    create a ScreenImage with given rectangle on this screen.
    
    Specified by:
    
    capture in interface IScreen
    
    Overrides:
    
    capture in class Screen
    
    Parameters:
    
    r - The Rectangle to be captured
    
    Returns:
    
    the image of the region
  - capture
```
public ScreenImage capture(Region r)
```
    Description copied from class: Screen
    
    create a ScreenImage with given region on this screen
    
    Specified by:
    
    capture in interface IScreen
    
    Overrides:
    
    capture in class Screen
    
    Parameters:
    
    r - The Region to be captured
    
    Returns:
    
    the image of the region
  - newLocation
```
public Location newLocation(Location loc)
```
    Description copied from class: Screen
    
    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.
    
    Overrides:
    
    newLocation in class Screen
    
    Parameters:
    
    loc - Location
    
    Returns:
    
    the new location
  - newLocation
```
public Location newLocation(int x,
                            int y)
```
  - newRegion
```
public Region newRegion(Location loc,
                        int w,
                        int h)
```
    Description copied from class: Screen
    
    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.
    
    Overrides:
    
    newRegion in class Screen
    
    Parameters:
    
    loc - Location
    
    w - value
    
    h - value
    
    Returns:
    
    the new region
  - newRegion
```
public Region newRegion(int x,
                        int y,
                        int w,
                        int h)
```
  - newRegion
```
public Region newRegion(Region r)
```
  - newRegion
```
public Region newRegion(Rectangle r)
```
  - mousePointer
```
public Location mousePointer()
```

Class ScreenRemote

Field Summary

Fields inherited from class org.sikuli.script.Screen

Fields inherited from class org.sikuli.script.Region

Constructor Summary

Method Summary

Methods inherited from class org.sikuli.script.Screen

Methods inherited from class org.sikuli.script.Region

Methods inherited from class java.lang.Object

Methods inherited from interface org.sikuli.script.IScreen

Constructor Detail

ScreenRemote

Method Detail

toString

toStringShort

isValid

getIn

getOut

close

close

getRobot

getBounds

capture

capture

capture

capture

newLocation

newLocation

newRegion

newRegion

newRegion

newRegion

mousePointer