se.claremont.taf.javasupport.objectstructure

Class JavaWindow

java.lang.Object

se.claremont.taf.javasupport.objectstructure.JavaWindow

All Implemented Interfaces:

Serializable

public class JavaWindow
extends Object
implements Serializable

A JavaWindow is any GUI Window used in automation. Created by jordam on 2017-02-14.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
JavaWindow(String titleAsRegularExpression)
JavaWindow(String titleAsRegularExpression, String name)
JavaWindow(Window window)
JavaWindow(Window window, String name)

Method Summary

Modifier and Type	Method and Description
static List<Component>	getAllComponents(Container c)
List<Component>	getComponents()
ArrayList<JavaGuiElement>	getComponentsAsJavaGuiElements() Collects all sub element of the window and tries converting them to JavaGuiElements and returning that list.
int	getElementMatchCount(JavaGuiElement javaGuiElement)
List<Object>	getMatchingComponents(JavaGuiElement javaGuiElement)
String	getName()
String	getTitle() Returns the runtime title of this window.
Object	getWindow() Identifies and returns the runtime interaction object of this window.
boolean	isRenderingCompleted()
boolean	isShown()
void	mapWindowToDescriptionClass(String outputFile) Tries to create element descriptions for the elements in the window, to be used in automation.
void	printIdentifiedComponents() Prints the currently identified components to standard out.
List<String>	textsInComponents() Goes through all identified elements in the GUI and collects the displayed text in these.
Object	waitForWindowToAppear(int timeoutInSeconds) Halts execution while waiting for this window to become visible.

Methods inherited from class java.lang.Object

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

Constructor Detail

JavaWindow

public JavaWindow(String titleAsRegularExpression)

JavaWindow

public JavaWindow(String titleAsRegularExpression,
                  String name)

JavaWindow

public JavaWindow(Window window)

JavaWindow

public JavaWindow(Window window,
                  String name)

Method Detail

getName

public String getName()

waitForWindowToAppear

public Object waitForWindowToAppear(int timeoutInSeconds)

Halts execution while waiting for this window to become visible. If it has not become visible before the timeout it returns null.

Parameters:

timeoutInSeconds - Timeout period to wait, stated in seconds.

Returns:

Returns the Window itself if encountered before the timeout, otherwise returning null.

getTitle

public String getTitle()

Returns the runtime title of this window.

Returns:

Returns the runtime title of this window.

isRenderingCompleted

public boolean isRenderingCompleted()

getWindow

public Object getWindow()

Identifies and returns the runtime interaction object of this window.

Returns:

The interaction runtime instance of this window if possible to identify, otherwise null.

getComponentsAsJavaGuiElements

public ArrayList<JavaGuiElement> getComponentsAsJavaGuiElements()

Collects all sub element of the window and tries converting them to JavaGuiElements and returning that list. Used for PositionBasedIdentification.

Returns:

Returns all sub element of the window.

getAllComponents

public static List<Component> getAllComponents(Container c)

getComponents

public List<Component> getComponents()

printIdentifiedComponents

public void printIdentifiedComponents()

Prints the currently identified components to standard out.

textsInComponents

public List<String> textsInComponents()

Goes through all identified elements in the GUI and collects the displayed text in these. Should probably only be used in debugging.

Returns:

Returns a list of the texts of all identified components.

mapWindowToDescriptionClass

public void mapWindowToDescriptionClass(String outputFile)

Tries to create element descriptions for the elements in the window, to be used in automation.

Parameters:

outputFile - The file to write the window element descriptors to.

getElementMatchCount

public int getElementMatchCount(JavaGuiElement javaGuiElement)

getMatchingComponents

public List<Object> getMatchingComponents(JavaGuiElement javaGuiElement)

isShown

public boolean isShown()