com.tplan.robot.remoteclient.capabilities

Interface LocalDesktopCapable

All Superinterfaces:

Capability

All Known Subinterfaces:

LocalAppCapable

public interface LocalDesktopCapable
extends Capability

Interface of a client capable of a local desktop connection.

T-Plan Robot Enterprise, (C) 2009-2022 T-Plan Limited. All rights reserved.

Method Summary

Modifier and Type	Method and Description
BufferedImage	getImageCopy(boolean refresh) Get a screen image copy.
boolean	shouldWaitForImageEvent() Indicates whether the UI should wait for the RemoteDesktopServerEvent.SERVER_IMAGE_AVAILABLE_EVENT event before displaying the desktop screen in the viewer.

Method Detail

getImageCopy

BufferedImage getImageCopy(boolean refresh)

Get a screen image copy.

Parameters:

refresh - the value of true will make the client to force a full screen refresh before the image copy is created.

Returns:

the screen image copy.

shouldWaitForImageEvent

boolean shouldWaitForImageEvent()

Indicates whether the UI should wait for the RemoteDesktopServerEvent.SERVER_IMAGE_AVAILABLE_EVENT event before displaying the desktop screen in the viewer. This is intended to help clients that do not know up front whether the connection is local or remote and need to obtain a screen image before deciding it.

Returns:

true if the UI should not display the screen image until the RemoteDesktopServerEvent.SERVER_IMAGE_AVAILABLE_EVENT is received, false if not.