com.tplan.robot.remoteclient.capabilities

Interface LocalAppCapable

All Superinterfaces:

Capability, LocalDesktopCapable

public interface LocalAppCapable
extends LocalDesktopCapable

Interface of a client automating a single application displayed on the local desktop.

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

Method Summary

Modifier and Type	Method and Description
boolean	canRotate() Indicate if the screen can rotate or not.
Rectangle	checkAppPosition() Check position of the target application window and move it eventually to a new position where the window fits the screen or minimizes the invisible areas.
Insets	getInsets() Get the custom insets.
com.tplan.robot.remoteclient.nativeutils.NativeWindow	getTargetApplicationWindow() Get the target locally running application window.
boolean	isLocalKeyboardIO() Indicate whether the client automates the local keyboard.
boolean	isLocalMouseIO() Indicate whether the client automates the local mouse.
Point	rotateIfNeeded(Point p) Convert a coordinate if needed.
void	setInsets(Insets in, boolean blend) Set the app insets.
Point	unrotateIfNeeded(Point p) Perform a reverse operation to rotateIfNeeded(java.awt.Point).

Methods inherited from interface com.tplan.robot.remoteclient.capabilities.LocalDesktopCapable

getImageCopy, shouldWaitForImageEvent

Method Detail

getTargetApplicationWindow

com.tplan.robot.remoteclient.nativeutils.NativeWindow getTargetApplicationWindow()

Get the target locally running application window. Clients automating the whole desktop may return null.

Returns:

a window proxy obtained through the NativeUtils class.

isLocalMouseIO

boolean isLocalMouseIO()

Indicate whether the client automates the local mouse. A classic local desktop client returns true. Clients which automate remote devices through the combination of local screen mirroring and a VNC driven mouse should return false.

The flag controls whether the Robot's UI pauses the executed script when a user mouse activity is detected. This feature is enabled only if this method returns true.

Returns:

true if the client injects mouse events into the local desktop event queue.

isLocalKeyboardIO

boolean isLocalKeyboardIO()

Indicate whether the client automates the local keyboard. A classic local desktop client returns true. Clients which automate remote devices through the combination of local screen mirroring and a VNC driven keyboard should return false.

Returns:

true if the client injects keyboard events into the local desktop event queue.

canRotate

boolean canRotate()

Indicate if the screen can rotate or not. When the method returns true the UI size gets calculated to fit both the portrait and landscape views. Also, when the local desktop resolution is not large enough to fit the application size the user gets warned.

Returns:

true if the screen may rotate or false if not.

rotateIfNeeded

Point rotateIfNeeded(Point p)

Convert a coordinate if needed. This method allows the client to convert the given coordinate when the I/O connection device screen orientation is out of sync with the displayed front end UI. For example, automation of an iOS screen displayed in Reflection may display both in the portrait and landscape mode while the VNC client used for the keyboard and mouse I/O keeps using the portrait coordinates. Hence if the screen is in the landscape mode and a mouse click is performed, the coordinates have to be recalculated to the portrait view before sending them to the VNC viewer.

Parameters:

p - screen coordinates.

Returns:

converted coordinates with regard to the current device screen orientation. Clients that do not support screen rotation should return the unchanged argument.

unrotateIfNeeded

Point unrotateIfNeeded(Point p)

Perform a reverse operation to rotateIfNeeded(java.awt.Point).

Parameters:

p - a point.

Returns:

a converted point. Clients that do not support screen rotation should return the unchanged argument.

getInsets

Insets getInsets()

Get the custom insets. This method allows to define custom insets specifying how to crop the application window in the desktop view. This is in most cases used to limit the automation just to a part of the application window, for example to remove the OS or theme specific window title bar and borders.

This applies just to the automation of an application window running on the local desktop. Other clients may return null.

Returns:

the insets.

setInsets

void setInsets(Insets in,
               boolean blend)

Set the app insets. This method was introduced in 4.1.1 to enable dynamic detection of insets.

Parameters:

in - the new insets. The value of null or empty insets are interpreted as insets reset.

blend - true to merge the previous insets with the new one or false to discard the old ones and apply the new ones.

Since:

4.1.1

checkAppPosition

Rectangle checkAppPosition()

Check position of the target application window and move it eventually to a new position where the window fits the screen or minimizes the invisible areas.

Returns:

the resulting window rectangle.

Since:

3.4.1