Package Documentation for Test-suite qfs.qft

Version 9.0.0

Summary

Test suite

qfs.qft

Package overview

	Package	Description
	qfs	This package contains helpful standard procedures provided by Quality First Software.
	accessibility	Contains procedures to test the accessibility of a SUT.
	web	Accessibility tests for Web-SUTs.
	android	Contains procedures to test android applications as well as useful procedures for remote controlling android devices.
	adbUtils	Procedures using the Android Debug Bridge (adb).
	appControl	Procedures for controlling android apps.
	appPackage	Procedures to read out the package name of an android application.
	appSettings	Procedures for changing android apps settings.
	dataTransfer	Procedures for transfering data from a computer to an android device and vica versa
	checkbox	Procedures to set the state of checkboxes.
	device	Contains procedures to remote control android devices.
	gesture	Procedures for android gestures like pinch, swipe, ...
	general	Procedures which work for any Android component.
	list	Procedures for accessing lists.
	checks	Procedures for checking a list.
	menu	Procedures to select menu items
	radiobutton	Procedures to get and set the state of radio buttons.
	swipe	Packages containing swiping procedures
	text	Procedures to access text fields and text areas.
	automac	Contains procedures to work with native windows on a MacOS system.
	app	Procedures to start/close/raise a native macOS application.
	checkbox	Procedures to get and set the state of checkboxes in native macOS applications.
	component	Basic procedures for interacting with a component of a native macOS application.
	helpers	Procedures used internally by the package qfs.automac.component.
	menu	Procedures to select menu items and checkbox menu items in native macOS applications.
	autoscreen	Procedures for testing based on images.
	android	Procedures to replay events anywhere on an android application based on images.
	fx	Procedures to replay events anywhere on a JavaFX application based on images.
	screen	Procedures to replay events anywhere on the screen based on images.
	swing	Procedures to replay events anywhere on a Swing application based on images.
	swt	Procedures to replay events anywhere on a SWT application based on images.
	web	Procedures to replay events anywhere on a Web application based on images.
	autowin	Contains procedures to work with native windows of the operating system Windows.
	acrobat	Contain procedures to handle Adobe Acrobat Reader specific tasks like SaveAs or SaveAs Text ...
	checkbox	Procedures to get and set the state of checkboxes in native windows applications.
	component	Basic procedures for interacting with a component of a native windows application.
	dependencies	Dependencies for starting/stopping a native windows application.
	helpers	Procedures used internally by the package qfs.autowin.component.
	keyevents	Procedures for replaying key events to a windows application.
	menu	Procedures to select menu items and checkbox menu items in native windows applications.
	awt	Procedures for advanced manipulation of awt components.
	menu	Procedures to select menu items.
	check	Procedures for checking components or comparing various kinds of values.
	cleanup	The procedures in this package are useful for generic cleanup after an exception is thrown.
	client	Procedures for interacting with (SUT) clients.
	daemon	Procedures to work with a QF-Test daemon.
	database	Procedures to work with databases.
	databinder	Procedures to bind data for data-driven testing.
	dialogs	Procedures for showing dialogs during the test run.
	progress	Procedures to show a simple progress dialog
	fx	Procedures for advanced manipulation of fx components.
	checkbox	Procedures to get and set the state of checkboxes.
	cleanup	The procedures in this package are useful for generic cleanup after an exception is thrown.
	combobox	Procedures to handle comboboxes.
	general	Procedures which work for any fx component.
	list	Procedures for accessing lists.
	checks	Procedures for checking a list.
	selection	Procedures to (de-)select certain items of a list.
	menu	Procedures to select menu items and checkbox menu items.
	popupmenu	Procedures to select items and checkbox menu items from popup menus.
	radiobutton	Procedures to set and get the state of radio buttons.
	slider	Procedures to access sliders.
	checks	Procedure for checking slider values.
	tabbedpane	Procedures to work with TabbedPanes.
	table	Procedures to access tables.
	checkbox	Procedures to set the state of checkboxes in a table cell.
	checks	Procedures for checking a table.
	selection	Procedures to (de-)select certain rows of a table.
	text	Procedures to access text fields and text areas.
	tree	Procedures to access trees.
	checks	Procedures for checking a tree.
	ios	Contains procedures to test iOS applications as well as useful procedures for controlling ios simulator and devices.
	checkbox	Procedures to set the state of checkboxes (= switches).
	clipboard	Accessing the device clipboard from procedures.
	device	Contains procedures to control iOS simulator and devices.
	apps	Procedures for controlling iOS applications
	gesture	Procedures for iOS gestures like pinch, swipe, ...
	general	Procedures which work for any iOS element
	idbUtils	Procedures for executing commands with the iOS Development Bridge (IDB) tool.
	list	Procedures for accessing lists.
	checks	Procedures for checking a list.
	helpers	Internal helpers.
	menu	Procedures to select menu items
	radiobutton	Procedures to get and set the state of radio buttons (= switches).
	setup	Helper procedures to check and set up the test environment for iOS testing.
	homebrew	Helper procedures to check and set up the homebrew tool for iOS testing.
	idb	Helper procedures to check and set up the iOS Developer Bridge for iOS testing.
	client	Helper procedures to check and set up the iOS Developer Bridge client (idb) for iOS testing.
	companion	Helper procedures to check and set up the iOS Developer Bridge companion (idb-companion) for iOS testing.
	macos	Helper procedures to interact with macOS system functions during the test environment setup for iOS testing.
	pip3	Helper procedures to check and set up the Python package installer (pip) for iOS testing.
	python3	Helper procedures to check and set up the python 3 environment for iOS testing.
	xcode	Helper procedures to check and set up the Xcode development environment for iOS testing.
	path	Helper procedures to check and set up the Xcode development path.
	swipe	Packages containing swiping procedures
	switch	Procedures to set the state of switches.
	text	Procedures to access text fields and text areas.
	jib	Procedures for JiB (Java in Browsers).
	options	Procedures for setting special options for JiB (Java in Browsers) tests.
	pdf	Procedures for PDF testing.
	file	Procedures to work with PDF files.
	highlight	Procedures in order to highlight components.
	navigation	Procedures to navigate inside a PDF document.
	page	Procedures to get/interact with the current page / all pages.
	run-log	Procedures for writing log-entries.
	screenshots	Procedures to write screenshots into the run log.
	web	Procedures to write web specifics into run log.
	shellutils	Utility procedures for shell commands.
	swing	Procedures for advanced manipulation of swing components.
	checkbox	Procedures to set the state of checkboxes.
	cleanup	The procedures in this package are useful for generic cleanup after an exception is thrown.
	combobox	Procedures to handle comboboxes.
	dialogs	Procedures to handle Dialogs.
	filechooser	Procedures for accessing file chooser dialogs.
	general	Procedures which work for any Swing component.
	list	Procedures for accessing lists.
	checks	Procedures for checking a list.
	selection	Procedures to (de-)select certain items of a list.
	menu	Procedures to select menu items and checkbox menu items.
	optionpane	Procedures for accessing standard error/message dialogs.
	popupmenu	Procedures to select items and checkbox menu items from popup menus.
	radiobutton	Procedures to get and set the state of radio buttons.
	slider	Procedures to access sliders.
	checks	Procedure for checking slider values.
	startup	Procedures for startup of swing applications.
	tabbedpane	Procedures to work with TabbedPanes.
	table	Procedures to access tables.
	checkbox	Procedures to set the state of checkboxes in a table cell.
	checks	Procedures for checking a table.
	selection	Procedures to (de-)select certain rows of a table.
	text	Procedures to access text fields and text areas.
	tree	Procedures to access trees.
	checks	Procedures for checking a tree.
	swt	Procedures for advanced manipulation of SWT components.
	checkbox	Procedures to set the state of checkboxes.
	cleanup	The procedures in this package are useful for generic cleanup after an exception is thrown.
	colordialog	Procedures to handle Colordialogs.
	combo	Procedures to handle comboboxes.
	ctabfolder	Procedures for SWT CTabFolder widgets.
	directorydialog	Procedures for accessing directory dialogs.
	filedialog	Procedures for accessing file dialogs.
	general	Procedures which work for any SWT component.
	instrument	Procedures for SWT instrumentation.
	list	Procedures for accessing lists.
	checks	Procedures for checking a list.
	selection	Procedures to (de-)select certain items of a list.
	menu	Procedures to select menu items and checkbox menu items.
	popupmenu	Procedures to select items and checkbox menu items from popup menus.
	radiobutton	Procedures to set the state of buttons with the style SWT.RADIO.
	sash	Procedures to work with sash components.
	scrollbar	Procedures to work with scrollbar components.
	tabfolder	Procedures for SWT TabFolder widgets.
	table	Procedures to access tables.
	checkbox	Procedures to set the checked state of tableitems.
	checks	Procedures for checking a table.
	selection	Procedures to (de-)select certain rows of a table.
	text	Procedures to access text fields and text areas.
	tree	Procedures to access trees.
	checks	Procedures for checking a tree.
	multicolumn	Special procedures for multi-column trees.
	utils	Miscellaneous utility procedures.
	clipboard	Accessing the clipboard from procedures.
	email	Procedures for sending emails.
	pop3	Procedures for interacting with a POP3 server.
	files	Contain procedures to work with files.
	json	Procedures for working with JSON files.
	random	Procedures for generating random string.
	ssh	Procedures for executing commands on a remote server via ssh.
	session	Procedures for handling SSH connections.
	testrun	Procedures for handling the test execution.
	skip	Procedures for skipping test steps.
	stop	Procedures for stopping test steps.
	variables	Procedures for working with variables.
	xml	Procedures for working with XML files.
	web	Web utility procedures.
	ajax	AJAX procedures.
	browser	Browser procedures.
	dialogs	Procedures for handling error dialogs opened within the browser.
	dom	Procedures for handling DOM access.
	download	Procedures to handle downloads in QF-Test.
	external	This package contains methods to interrupt a browser-open call from a java application.
	observers	Helper procedures to register and unregister method call interceptors to detect browser opening in tested applications.
	general	General browser procedures.
	mozilla	Mozilla utility procedures.
	settings	The procedures in this package are useful for customizing browser settings.
	checkbox	Procedures to set the state of checkboxes.
	checks	Procedures for handling different web checks.
	style	Procedures for handling different element style checks.
	color	Procedures for handling different element style checks concerning color attributes.
	font	Procedures for handling different element style checks concerning font attributes.
	cwr	Procedures to support Custom Web Resolvers
	electron	Procedures for Electron testing.
	general	Procedures which work for any Web component.
	input	Procedures to access INPUT elements.
	radiobutton	Procedures to set the state of buttons.
	select	Procedures to access select nodes.
	table	Procedures to access web tables.
	checks	Procedures for checking a table.
	recording	Procedures influencing recording of web tables.
	text	Procedures to access text fields and text areas.
	win	Procedures for advanced manipulation of native windows components.
	checkbox	Procedures to set the state of checkboxes.
	combobox	Procedures to handle comboboxes.
	general	Procedures which work for any Win component.
	helpers	Helper procedure for Windows engine tests.
	list	Procedures for accessing lists.
	checks	Procedures for checking a list.
	radiobutton	Procedures to get and set the state of radio buttons.
	tabbedpane	Procedures to work with TabbedPanes.
	table	Procedures to access tables.
	checks	Procedures for checking a table.
	text	Procedures to access text fields and text areas.
	tree	Procedures to access trees.
	checks	Procedures for checking a tree.

Package overview

	Package/Procedure/Dependency	Description
	qfs	This package contains helpful standard procedures provided by Quality First Software.
	accessibility	Contains procedures to test the accessibility of a SUT.
	web	Accessibility tests for Web-SUTs.
	checkAxeRules	Runs axe-core test in a defined scope for defined rules.
	checkColorContrastSimpleGraphics	Runs a test to check the color contrast of elements.
	android	Contains procedures to test android applications as well as useful procedures for remote controlling android devices.
	adbUtils	Procedures using the Android Debug Bridge (adb).
	appControl	Procedures for controlling android apps.
	resetCurrentApp	Reset all data and permissons from the app that currently has the focus and restart it.
	startApp	Start an Android app on an already running device.
	stopApp	Stop a running Android app.
	appPackage	Procedures to read out the package name of an android application.
	getCurrentPackage	Get the package name of the app that currently has the focus.
	getPackage	Get the package name from an APK file.
	appSettings	Procedures for changing android apps settings.
	grantPermissions	Grant a permission from an app.
	resetClearData	Deletes all data from an app.
	revokePermissions	Revoke a permission from an app.
	dataTransfer	Procedures for transfering data from a computer to an android device and vica versa
	pull	Copy a file or folder from the android device to the local system.
	push	Copy a file or folder from the local system to the android device.
	getAdbPath	Get the path to the adb binary.
	runAdbCommand	Copy a file or folder from the local system to the android device.
	checkbox	Procedures to set the state of checkboxes.
	deselect	Deselect a checkbox.
	deselectWithCoordinates	Deselect a checkbox.
	getValue	Return the value of a checkbox.
	select	Select a checkbox.
	selectWithCoordinates	Select a checkbox.
	set	Set checkbox to the given state.
	setWithCoordinates	Set checkbox to the given state.
	device	Contains procedures to remote control android devices.
	appSwitch	Select the app switch button on the device.
	back	Select the back button on the device.
	closeKeyboard	Close a maybe opened keyboard window.
	gesture	Procedures for android gestures like pinch, swipe, ...
	pinch	Perform a two finger pinch action.
	zoom	Perform a two finger zoom action.
	getRotation	Get the rotation of the device.
	home	Select the home button on the device.
	setRotation	Set the rotation of the device.
	syncTime	Sync the time of the android device with the current machine or a given timestamp.
	general	Procedures which work for any Android component.
	clickAtComponent	Click on a given component, but only if the according parameter is set to true.
	clickAtComponentWithDetails	Click on a given component, but only if the according parameter is set to true.
	doClick	Click on a given component.
	doClickWithDetails	Click on a given component.
	doLongClick	Long click on a given component.
	waitForComponent	Wait for a given component.
	waitForComponentForAbsence	Wait till a given component disappears.
	list	Procedures for accessing lists.
	checks	Procedures for checking a list.
	checkNumberOfItems	Check the number of items of a given list according to a specified comparison mode.
	clickItemWithDetails	Select a given item by a mouse click on it.
	getIndexOfItem	Return the current index of a given item.
	getItemCount	Return the number of items of a given list.
	getValueOfItem	Return the text of a given item.
	isAtBottom	Check whether we are at the end of the list.
	isAtTop	Check whether we are at the top of the list.
	scroll	Scroll to a particular element in the list.
	scrollByIndex	Scroll to a particular element in the list.
	scrollToBottom	Scroll to the top of the list.
	scrollToTop	Scroll to the top of the list.
	selectItem	Select a given item by a mouse click on it.
	menu	Procedures to select menu items
	selectItem	Select an item from a menu.
	selectItemWithCoordinates	Select an item from a menu.
	radiobutton	Procedures to get and set the state of radio buttons.
	getValue	Return the value of a radio button.
	select	Select a radio button.
	selectWithCoordinates	Select a radio button.
	swipe	Packages containing swiping procedures
	down	Perform a swipe down operation.
	inDirection	Perform a swipe operation.
	left	Perform a swipe left operation.
	right	Perform a swipe right operation.
	up	Perform a swipe up operation.
	withCoordinates	Perform a swipe operation.
	text	Procedures to access text fields and text areas.
	clear	Clear a text field.
	getText	Return the text of a given textfield.
	setText	Set a given text to a given text-field or text-area.
	setTextFromFile	Read the content of a given file and set its content to a given text-field.
	automac	Contains procedures to work with native windows on a MacOS system.
	app	Procedures to start/close/raise a native macOS application.
	close	Close the application.
	connect	Connect to the given application.
	disconnect	Disconnects from the application, which was connected previously with "qfs.automac.app.connect", without closing the application.
	raise	Raise the application.
	checkbox	Procedures to get and set the state of checkboxes in native macOS applications.
	checkValue	Check the value of the given component.
	deselect	Deselect a checkbox.
	getValue	Return the value of a checkbox.
	select	Select a checkbox.
	set	Set checkbox to the given state.
	component	Basic procedures for interacting with a component of a native macOS application.
	checkGeometry	Check the position, width and height of the component on the screen.
	checkImage	Check the image of a given component.
	checkValue	Compare the given value to the value of a component according to the compareMode.
	click	Click a given component.
	getControl	Set the global Jython variable __uiauto_control to the GUI element matching the given parameters.
	getGeometry	Fetch the screen coordinates for the left border, top, width and height for the component.
	getValue	Return the value of the given control.
	setAttribute	Set a given attribute of a component.
	setValue	Set a given value to a component.
	waitForComponent	Set the global variable __uiauto_control to the GUI element matching the given parameters in the given window.
	helpers	Procedures used internally by the package qfs.automac.component.
	checkIfMac	Check if the operation system is MacOS.
	dumpComponent	Print information provided by the Accessibility Interface of the given GUI control to the QF-Test terminal.
	dumpComponents	Print role, role type, subrole, label, title and identifier of the controls in the given application to the QF-Test terminal.
	dumpComponentsToFile	Print role, type, subrole, label, title and identifier of the controls in the given window to a file.
	dumpDesktopWindows	Print the title, process id, bundle id and bundle file of all windows on the desktop of to the QF-Test terminal.
	menu	Procedures to select menu items and checkbox menu items in native macOS applications.
	selectItem	Select an item from a menu.
	sendKey	Send the given key along with the qualifier to the component having the focus.
	autoscreen	Procedures for testing based on images.
	android	Procedures to replay events anywhere on an android application based on images.
	clickAtImage	Click at an image anywhere on a Android application.
	getComponentAtImage	Find an image anywhere on an Android application and return the component ID.
	fx	Procedures to replay events anywhere on a JavaFX application based on images.
	clickAtImage	Click at an image anywhere on a JavaFX application.
	getComponentAtImage	Find an image anywhere on a JavaFX application and return the component ID.
	screen	Procedures to replay events anywhere on the screen based on images.
	clickAtImage	Click at an image anywhere on the screen.
	getPositionOfImage	Find an image anywhere on the screen and return its position.
	swing	Procedures to replay events anywhere on a Swing application based on images.
	clickAtImage	Click at an image anywhere on a JFrame of a swing application.
	getComponentAtImage	Find an image anywhere on a JFrame of a Swing application and return the component ID.
	swt	Procedures to replay events anywhere on a SWT application based on images.
	clickAtImage	Click at an image anywhere on a Shell of a SWT application.
	getComponentAtImage	Find an image anywhere on a Shell of a SWT application and return the component ID.
	web	Procedures to replay events anywhere on a Web application based on images.
	clickAtImage	Click at an image anywhere on a web application.
	getComponentAtImage	Find an image anywhere on a web application and return the component ID.
	autowin	Contains procedures to work with native windows of the operating system Windows.
	acrobat	Contain procedures to handle Adobe Acrobat Reader specific tasks like SaveAs or SaveAs Text ...
	saveAsText	Save the current open PDF in Adobe Acrobat Reader as a text file with the given filename.
	savePDF	Save the current open PDF in Adobe Acrobat Reader as a PDF file with the given filename.
	checkbox	Procedures to get and set the state of checkboxes in native windows applications.
	checkValue	Check the value of the given component.
	deselect	Deselect a checkbox.
	getValue	Return the value of a checkbox.
	select	Select a checkbox.
	set	Set checkbox to the given state.
	checkForExistence	Check, whether a native window on the operating system Windows is opened.
	checkForExistenceAndClose	Check, whether a native window on the operating system Windows is opened and close it.
	close	Close a window.
	component	Basic procedures for interacting with a component of a native windows application.
	checkGeometry	Check the position, width and height of the component on the screen.
	checkImage	Check the image of a given component.
	checkName	Compare the given name to the name of a component according to the compareMode.
	checkText	Wrapper procedure to either check the value of a component or, if no value exists, the name.
	checkValue	Compare the given value to the value of a component according to the compareMode.
	click	Click a given component.
	getControl	Set the global variable __uiauto_control to the GUI element matching the given parameters in the given window.
	getGeometry	Fetch the screen coordinates for the left border, top, width and height for the component.
	getName	Return the name of the given control.
	getText	Return the value or, if it does not exist, the name of the given control.
	getValue	Return the value of the given control.
	setText	Set a given text to a component if the method setText() is implemented by the IUIAutomationElement Interface of the component.
	setValue	Set a given value to a component.
	waitForComponent	Set the global variable __uiauto_control to the GUI element matching the given parameters in the given window.
	dependencies	Dependencies for starting/stopping a native windows application.
	SUT_started	Start a native windows application as the SUT (system under test) using the dependency funtionality.
	getURLFromIE	Read the URL from an InternetExplorer window.
	helpers	Procedures used internally by the package qfs.autowin.component.
	checkIfWindows	Check if the operation system is Microsoft Windows.
	dumpComponent	Print information provided by the IUIAutomationElement Interface of the given GUI control to the QF-Test terminal.
	dumpComponents	Print name, class name, control type and automation id of controls in the given windows to the QF-Test terminal.
	dumpComponentsToFile	Write name, class name, control type and automation id of controls in the given windows to a file.
	dumpDesktopWindows	Print the titles of all windows on the desktop of Microsoft Windows to the QF-Test terminal.
	setWindowToForeground	Set the window with the given title to the foreground on the desktop.
	keyevents	Procedures for replaying key events to a windows application.
	pressCtrlA	Perform Ctrl+a to the given window to mark all text of the compontent which has the focus.
	pressCtrlV	Perform Ctrl+v to the given window to paste the content of the clipboard to the component with the focus.
	pressCtrlX	Perform Ctrl+x to the given window to cut the selected content of the component with the focus.
	pressDelete	Replay DELETE to the given window.
	pressEnter	Replay ENTER to the given window.
	pressTab	Replay TAB to the given window.
	sendKey	Send the given key along with the qualifier to the window with the given title.
	logChildWindows	Write all children of a window to the run log.
	logUIAToplevels	This method logs the top-level objects (windows) accessible via the Windows UIAutomation API.
	markAllAndCopy	Perform Ctrl+A and then Ctrl+C to a given window.
	menu	Procedures to select menu items and checkbox menu items in native windows applications.
	selectItem	Select an item from a menu.
	saveTextToFileViaClipboard	Mark and copy the whole text of a given document via Ctrl+A and Ctrl+C.
	awt	Procedures for advanced manipulation of awt components.
	menu	Procedures to select menu items.
	selectItem	Select an item from a menu.
	selectItemWithSubMenu	Select an item from a menu.
	setCheckItem	Select a checkbox item from a menu.
	setSubCheckItem	Select a checkbox item from a menu in a submenu.
	check	Procedures for checking components or comparing various kinds of values.
	checkEnabledStatus	Check the state of a given component.
	checkImageAgainstFile	Check image of a component against a file.
	checkObjectToBeEqual	Compare two Objects for their equality.
	checkSelectedStatus	Check if given component is selected.
	checkText	Check the text of a given component.
	checkValueInRange	Check whether a value is in a given range.
	checkValueToBeEqual	Compare two string values for their equality.
	compareDates	Compare two date strings.
	compareTwoNumbers	Compare two values for their equality.
	compareTwoStringValues	Compare two values for their equality.
	cleanup	The procedures in this package are useful for generic cleanup after an exception is thrown.
	closeAllDialogs	Close all dialogs.
	closeAllMenus	Close all menus unconditionally.
	closeAllModalDialogs	Close all modal dialogs.
	implicitExceptionHandler	This procedure encompasses the usage of other cleanup procedures in this package and is the recommended operation to perform after an exception occurs and is implicitly caught.
	client	Procedures for interacting with (SUT) clients.
	renameClient	Rename an SUT client.
	sendInput	Write a string to the stdin stream of a process started by QF-Test.
	startLogging	Helper method for turning on internal logging.
	stopLogging	Helper method for turning off internal logging.
	daemon	Procedures to work with a QF-Test daemon.
	instrumentRemoteSwt	Starts remote instrumentation procedure for an Eclipse/RCP based or standalone SWT application via a given daemon.
	locateDaemons	Locate all running daemons and writes them into the run log and prints a list of running daemons to the terminal.
	startRemoteSUT	Start a client application on a remote host via the QF-Test daemon.
	database	Procedures to work with databases.
	executeSelectStatement	Build up connection to a given database and executes a specified select-sql-statement.
	executeStatement	Build up connection to a given database and execute a specified SQL-statement.
	databinder	Procedures to bind data for data-driven testing.
	bindList	Create and register a databinder that binds a list of values to a variable.
	bindSets	Create and register a databinder that binds a list of value-sets to a set of variables.
	dialogs	Procedures for showing dialogs during the test run.
	progress	Procedures to show a simple progress dialog
	hideProgressDialog	Hides a progress dialog displayed with showProgressDialog
	showProgressDialog	Shows a simple progress dialog on the screen.
	showConfigurabableDialog
	showConfigurableDialog	Show a configurable dialog equivalent to JOptionPane.
	showInformationMessageDialog	Show an information dialog with an OK option.
	showYes_No_Cancel_Dialog	Show an information dialog with a YES, NO and CANCEL option.
	showYes_No_Dialog	Show an information dialog with a YES and NO option.
	fx	Procedures for advanced manipulation of fx components.
	checkbox	Procedures to get and set the state of checkboxes.
	deselect	Deselect a checkbox.
	deselectWithCoordinates	Deselect a checkbox.
	getValue	Return the value of a checkbox.
	select	Select a checkbox.
	selectWithCoordinates	Select a checkbox.
	set	Set checkbox to the given state.
	setWithCoordinates	Set checkbox to the given state.
	cleanup	The procedures in this package are useful for generic cleanup after an exception is thrown.
	closeAllMenus	Close all menus unconditionally.
	closeAllModalDialogs	Close all modal dialogs.
	closeMenu	Close a menu by replaying an [Escape] keystroke on a Window.
	implicitExceptionHandler	This procedure encompasses the usage of other cleanup procedures in this package and is the recommended operation to perform after an exception occurs and is implicitly caught.
	combobox	Procedures to handle comboboxes.
	getIndexOfItem	Return the current index of a given item.
	getItemCount	Return the number of items of a given combobox.
	getValue	Return the text of a given combobox.
	getValueOfItem	Return the text of a given item.
	setValue	Select specified value of a given combobox.
	setValueViaIndex	Set a value in the combobox.
	setValueViaSUTScript	Select specified value of a given combobox using a SUT script.
	general	Procedures which work for any fx component.
	clickAtComponent	Click on a given component, but only if the according parameter is set to true.
	clickAtComponentWithDetails	Click on a given component, but only if the according parameter is set to true.
	deleteOverrideComponent	Delete the current association of PriorityFxNode.
	doClick	Click on a given component.
	doClickWithDetails	Click on a given component.
	doSelect	Send a selection event to a given component.
	setLocation	Set the location of a given component.
	setOverrideComponent	Set a given component to the PriorityFxNode.
	setSize	Set the width and the height of a given component.
	waitForComponent	Wait for a given component.
	waitForComponentForAbsence	Wait till a given component disappears.
	list	Procedures for accessing lists.
	checks	Procedures for checking a list.
	checkNumberOfItems	Check the number of items of a given list according to a specified comparison mode.
	clickItemWithDetails	Select a given item by a mouse click on it.
	getIndexOfItem	Return the current index of a given item.
	getItemCount	Return the number of items of a given list.
	getValueOfItem	Return the text of a given item.
	selection	Procedures to (de-)select certain items of a list.
	deselectAllItems	Deselect all items.
	deselectItem	Deselect a given item, specified by its index.
	deselectItemRange	Deselect a range of items, specified by their index.
	selectAllItems	Select all items.
	selectItem	Select a given item, specified by its index.
	selectItemRange	Select a range of items, specified by their index.
	selectItem	Select a given item by a mouse click on it.
	menu	Procedures to select menu items and checkbox menu items.
	selectCheckMenuItemInHierarchy	Select a checkbox menu item from a menu.
	selectCheckMenuItemInHierarchyWithCoordinates	Select a checkbox menu item from a menu.
	selectItem	Select an item from a menu.
	selectItemWithCoordinates	Select an item from a menu.
	selectMenuItemInHierarchy	Select an item from a menu.
	selectMenuItemInHierarchyWithCoordinates	Select an item from a menu.
	selectSubItem	Select an item within a submenu.
	selectSubItemWithCoordinates	Select an item within a submenu.
	setCheckItem	Select a checkbox menu item.
	setCheckItemWithCoordinates	Select a checkbox menu item.
	setSubCheckItem	Select a checkbox menu item within within a submenu.
	setSubCheckItemWithCoordinates	Select a checkbox menu item within within a submenu.
	popupmenu	Procedures to select items and checkbox menu items from popup menus.
	clickItemWithDetails	Select an item in a popup menu.
	selectItem	Select an item in a popup menu.
	selectSubItem	Select an item within a submenu of a popup menu.
	selectSubItemWithCoordinates	Select an item within a submenu of a popup menu.
	setCheckItem	Select a checkbox menu item in a popup menu.
	setCheckItemWithCoordinates	Select a checkbox menu item in a popup menu.
	setSubCheckItem	Select a checkbox menu item within a submenu of a popup menu.
	setSubCheckItemWithCoordinates	Select a checkbox menu item within a submenu of a popup menu.
	radiobutton	Procedures to set and get the state of radio buttons.
	getValue	Return the value of a radio button.
	select	Select a radio button.
	selectWithCoordinates	Select a radio button.
	slider	Procedures to access sliders.
	checks	Procedure for checking slider values.
	checkValue	Check the value of a slider component.
	getValue	Return the value of a slider component.
	setValue	Set the value of a slider component.
	tabbedpane	Procedures to work with TabbedPanes.
	closeTab	Close a tab via a selection event.
	getIndexOfTab	Return the index of a given tab in a TabPane.
	getItemCount	Return the number of items of a given tabbedpane.
	getValueOfTab	Return the text of a given tab in a TabPane.
	selectTab	Select a tab in a given TabPane.
	table	Procedures to access tables.
	checkbox	Procedures to set the state of checkboxes in a table cell.
	deselect	Deselect a checkbox in a table cell.
	deselectWithCoordinates	Deselect a checkbox in a table cell.
	select	Select a checkbox in a table cell.
	selectWithCoordinates	Select a checkbox in a table cell.
	set	Set checkbox in a table cell to the given state.
	setWithCoordinates	Set checkbox in a table cell to the given state.
	checks	Procedures for checking a table.
	checkNumberOfRows	Check the number of rows of a given table according to a specified comparison mode.
	clickCellWithDetails	Select a given cell.
	getColumnCount	Return the number of columns of a given table.
	getIndexOfColumn	Return the current index of a given column.
	getNameOfColumn	Return the header text of a given column.
	getRowCount	Return the number of rows of a given table.
	getRowIndexOfCell	Return the row number of a given cell.
	getValueOfCell	Return the text of a given cell.
	resizeColumn	Resize width of a table column.
	selectCell	Select a given cell.
	selection	Procedures to (de-)select certain rows of a table.
	deselectAllRows	Deselect all rows.
	deselectRow	Deselect a given row, specified by its index.
	deselectRowRange	Deselect a range of rows, specified by their index.
	selectAllRows	Select all rows.
	selectRow	Select a given row, specified by its index.
	selectRowRange	Select a range of rows, specified by their index.
	text	Procedures to access text fields and text areas.
	clearArea	Clear a multi-line text area.
	clearField	Clear a simple text field.
	getText	Return the text of a given textfield.
	setText	Set a given text to a given text-field or text-area.
	setTextFromFile	Read the content of a given file and set its content to a given text-field.
	tree	Procedures to access trees.
	checks	Procedures for checking a tree.
	checkNumberOfChildNodes	Check the number of child nodes of a given tree node according to a specified comparison mode.
	checkNumberOfRows	Check the number of visible nodes under a given tree or tree node according to a specified comparison mode.
	clickNodeWithDetails	Select a given node.
	collapse	Collapse a tree node.
	collapseNode	Collapse a tree node.
	collapseNodes	Collapse a tree node recursively.
	collapseNodeWithCoordinates	Collapse a tree node.
	collapseWithCoordinates	Collapse a tree node.
	expand	Expand a tree node.
	expandNode	Expand a tree node.
	expandNodes	Expand a tree node recursively.
	expandNodeWithCoordinates	Expand a tree node.
	expandWithCoordinates	Expand a tree node.
	getChildNodeCount	Return the number of child nodes.
	getIndexOfNode	Return the current index of a given node.
	getRowCount	Return the number of visible nodes under a given tree or tree node.
	getValueOfNode	Return the text of a given node.
	selectNode	Select a given node.
	ios	Contains procedures to test iOS applications as well as useful procedures for controlling ios simulator and devices.
	checkbox	Procedures to set the state of checkboxes (= switches).
	deselect	Deselect a checkbox.
	deselectWithCoordinates	Deselect a checkbox.
	getValue	Return the value of a checkbox.
	select	Select a checkbox.
	selectWithCoordinates	Select a checkbox.
	set	Set checkbox to the given state.
	setWithCoordinates	Set checkbox to the given state.
	clipboard	Accessing the device clipboard from procedures.
	getClipboardContent	Gets the content of the primary clipboard on the device.
	setClipboardContent	Sets the primary clipboard's content on the device.
	device	Contains procedures to control iOS simulator and devices.
	apps	Procedures for controlling iOS applications
	getActiveBundleId	Returns the bundleId of the application currently running on the device.
	getActiveName	Returns the name of the application currently running on the device (or empty, if no name can be assigned).
	getBundleId	Returns the bundleId of an app.
	install	Installs an application on the device.
	list	Lists all apps on the device
	remove	Removes an application from the device.
	start	Start an application already installed on the device.
	stop	Stops a running application on the device.
	gesture	Procedures for iOS gestures like pinch, swipe, ...
	pinch	Perform a two finger pinch action.
	zoom	Perform a two finger zoom action.
	getRotation	Get the rotation of the device.
	getUdid	Get the udid of the connected device.
	home	Return to the home screen of the iOS device.
	isLocked	Checks if the iOS device is locked.
	listAll	Lists all iOS devices.
	lock	Locks the (simulated) iOS device
	setRotation	Set the rotation of the device.
	unlock	Unlocks the (simulated) iOS device
	general	Procedures which work for any iOS element
	clickAtComponent	Click on a given component, but only if the according parameter is set to true.
	clickAtComponentWithDetails	Click on a given component, but only if the according parameter is set to true.
	doClick	Click on a given component.
	doClickWithDetails	Click on a given component.
	doDoubleClick	Double click on a given component.
	doLongClick	Long click on a given component.
	type	Types in some text on the currently selected input element
	waitForComponent	Wait for a given component.
	waitForComponentForAbsence	Wait till a given component disappears.
	idbUtils	Procedures for executing commands with the iOS Development Bridge (IDB) tool.
	getIdbPath	Get the path to the idb binary.
	runIdbCommand	Run idb command.
	list	Procedures for accessing lists.
	checks	Procedures for checking a list.
	checkNumberOfItems	Check the number of items of a given list according to a specified comparison mode.
	clickItemWithDetails	Select a given item by a mouse click on it.
	getIndexOfItem	Return the current index of a given item.
	getItemCount	Return the number of items of a given list.
	getValueOfItem	Return the text of a given item.
	helpers	Internal helpers.
	registerHelper	Helper procedures to interact with iOS lists
	scroll	Scroll to a particular element in the list.
	scrollByIndex	Scroll to a particular element in the list.
	scrollToBottom	Scroll to the top of the list.
	scrollToTop	Scroll to the top of the list.
	selectItem	Select a given item by a mouse click on it.
	menu	Procedures to select menu items
	selectItem	Select an item from a menu.
	selectItemWithCoordinates	Select an item from a menu.
	radiobutton	Procedures to get and set the state of radio buttons (= switches).
	getValue	Return the value of a radio button.
	select	Select a radio button.
	selectWithCoordinates	Select a radio button.
	setup	Helper procedures to check and set up the test environment for iOS testing.
	checkEnvironment	Checks the current environment for being compatible with iOS tests.
	homebrew	Helper procedures to check and set up the homebrew tool for iOS testing.
	checkVersion	Checks if a detected homebrew version is recent enough.
	getVersion	Get the version of the currently installed homebrew tool, if available.
	triggerInstallation	Triggers the installation of homebrew.
	idb	Helper procedures to check and set up the iOS Developer Bridge for iOS testing.
	client	Helper procedures to check and set up the iOS Developer Bridge client (idb) for iOS testing.
	checkVersion	Checks if a detected IDB client version is recent enough.
	getPath	Get the path of the currently installed IDB client, if available.
	getVersion	Get the version of the currently installed IDB client, if available.
	triggerInstallation	Triggers the installation of the IDB client.
	companion	Helper procedures to check and set up the iOS Developer Bridge companion (idb-companion) for iOS testing.
	checkBuild	Checks if a detected IDB companion build is recent enough.
	getBuild	Get the build number of the currently installed IDB companion, if available.
	getPath	Get the path of the currently installed IDB companion, if available.
	triggerInstallation	Triggers the installation of the IDB companion.
	macos	Helper procedures to interact with macOS system functions during the test environment setup for iOS testing.
	check	Checks if the current system is running macOS.
	findExecutable	Finds an executable at different possible locations on the system.
	infoAppRerun	Displays an information dialog about a started application.
	infoTerminalRerun	Displays an information dialog about installation triggered in the terminal.
	openApp	Opens on macOS an application at the given path.
	openFile	Opens on macOS a file at the given path.
	openTerminal	Opens the terminal to execute the given command.
	pip3	Helper procedures to check and set up the Python package installer (pip) for iOS testing.
	checkVersion	Checks if a detected Python package installer version is recent enough.
	getVersion	Get the version of the currently installed Python package installer, if available.
	triggerInstallation	Triggers the installation of the Python package installer.
	python3	Helper procedures to check and set up the python 3 environment for iOS testing.
	checkVersion	Checks if a detected Python 3 version is recent enough.
	getVersion	Get the version of the currently installed Python 3, if available.
	triggerInstallation	Triggers the installation of Python 3.
	triggerVenvCreation	Triggers the creation of a Python 3 virtual environment.
	xcode	Helper procedures to check and set up the Xcode development environment for iOS testing.
	checkDeviceCount	Checks if the number of earlier detected available iOS devices on the system is > 0.
	checkVersion	Checks if a detected Xcode version is recent enough.
	getDeviceInfo	Get information about a available iOS devices using Xcode tools.
	getMissingRuntime	Tries to detect if the recent runtime of the given platform is installed.
	getSimulatedDeviceCount	Returns the number of simulated iOS devices on the system using Xcode tools.
	getVersion	Get the version of the currently installed Xcode, if available.
	path	Helper procedures to check and set up the Xcode development path.
	check	Checks if the given Xcode development path matches the expected one.
	get	Returns the Xcode development path.
	set	Sets the Xcode development path.
	triggerInstallation	Triggers the installation of Xcode.
	triggerRuntimeInstallation	Triggers the installation of the Xcode runtime.
	swipe	Packages containing swiping procedures
	down	Perform a swipe down operation.
	inDirection	Perform a swipe operation.
	left	Perform a swipe left operation.
	right	Perform a swipe right operation.
	up	Perform a swipe up operation.
	withCoordinates	Perform a swipe operation.
	switch	Procedures to set the state of switches.
	deselect	Deselect a switch.
	deselectWithCoordinates	Deselect a switch.
	getValue	Return the value of a switch.
	select	Select a switch.
	selectWithCoordinates	Select a switch.
	set	Set switch to the given state.
	setWithCoordinates	Set switch to the given state.
	text	Procedures to access text fields and text areas.
	clear	Clear a text field.
	getText	Return the text of a given textfield.
	setText	Set a given text to a given text-field or text-area.
	setTextFromFile	Read the content of a given file and set its content to a given text-field.
	jib	Procedures for JiB (Java in Browsers).
	options	Procedures for setting special options for JiB (Java in Browsers) tests.
	replayFXDnDEventAs	Set the type of event for Replaying JavaFX drag and drop.
	replayFXHardMouseEventAs	Set the type of event for replaying a hard JavaFX mouse event.
	replayFXImageCheckAs	Set where to fetch the image when replaying a JavaFX image check.
	replayFXKeyEventAs	Set the type of event for replaying a JavaFX keystroke.
	replayFXSoftMouseEventAs	Set the type of event for replaying a soft JavaFX mouse event.
	replayFXTextInputAs	Set the type of event for replaying JavaFX text input.
	replaySwingDnDEventAs	Set the type of event for Replaying Swing drag and drop.
	replaySwingHardMouseEventAs	Set the type of event for replaying a hard Swing mouse event.
	replaySwingImageCheckAs	Set where to fetch the image for replaying a Swing image check.
	replaySwingKeyEventAs	Set the type of event for replaying a Swing keystroke.
	replaySwingSoftMouseEventAs	Set the type of event for replaying a soft Swing mouse event.
	replaySwingTextInputAs	Set the type of event for replaying Swing text input.
	pdf	Procedures for PDF testing.
	file	Procedures to work with PDF files.
	extractAttachment	Extract a particular attachment of a PDF file.
	listAttachments	Returns a list listing all attachments present in a particular PDF file.
	verifyAttachments	Verify that a given PDF file has one or more attachments.
	highlight	Procedures in order to highlight components.
	hideBordersAroundComponents	Hide borders around each recognized component.
	showBordersAroundComponents	Show borders around each recognized component.
	toggleBordersAroundComponents	Toggle borders around each recognized component.
	navigation	Procedures to navigate inside a PDF document.
	iterate	Iterate over all pages in a PDF document.
	openFirstPage	Open the first page of the PDF document.
	openLastPage	Open the last page of the PDF document.
	openNextPage	Open/Goto the next page of the PDF document.
	openPage	Open a specific page of the PDF document.
	openPrevPage	Open/Goto the previous page of the PDF document.
	openRandomPage	Open a random page of the PDF document.
	page	Procedures to get/interact with the current page / all pages.
	getCurrentPageName	Return the name of the currently selected page in the PDF document.
	getCurrentPageNumber	Return the index/number of the currently selected page in the PDF document.
	getPageCount	Return the number of pages in a PDF document.
	refreshCurrentPage	Refresh the currently opened page.
	run-log	Procedures for writing log-entries.
	logError	Write an error into the run log.
	logMessage	Write a message into the run log.
	logWarning	Write a warning into the run log.
	screenshots	Procedures to write screenshots into the run log.
	getMonitorCount	Return the total number of monitors.
	logImageOfComponent	Write an image of a component into the run log.
	logScreenshot	Write a screenshot of the whole screen into the run log.
	logScreenshotOfMonitor	Write a screenshots of a given monitor into the run log.
	web	Procedures to write web specifics into run log.
	logSourcecode	Write a document's source code into the run log.
	shellutils	Utility procedures for shell commands.
	copy	Copy a given file or directory to a given target.
	deleteFile	Delete a file.
	exec	Execute a shell command.
	exists	Check whether a given file or directory exists.
	getBasename	Return the basename of the given file or directory.
	getParentdirectory	Return the parent directory of the given file or directory.
	mkdir	Create a given directory.
	move	Move a given file or directory to a given target.
	removeDirectory	Remove a given directory.
	touch	Create a given file or update the last modified date of an existing file.
	swing	Procedures for advanced manipulation of swing components.
	checkbox	Procedures to set the state of checkboxes.
	deselect	Deselect a checkbox.
	deselectWithCoordinates	Deselect a checkbox.
	getValue	Return the value of a checkbox.
	select	Select a checkbox.
	selectWithCoordinates	Select a checkbox.
	set	Set checkbox to the given state.
	setWithCoordinates	Set checkbox to the given state.
	cleanup	The procedures in this package are useful for generic cleanup after an exception is thrown.
	closeAllDialogs	Close all dialogs.
	closeAllMenus	Close all menus unconditionally.
	closeAllModalDialogs	Close all modal dialogs.
	implicitExceptionHandler	This procedure encompasses the usage of other cleanup procedures in this package and is the recommended operation to perform after an exception occurs and is implicitly caught.
	combobox	Procedures to handle comboboxes.
	getIndexOfItem	Return the current index of a given item.
	getItemCount	Return the number of items of a given combobox.
	getValue	Return the text of a given combobox.
	getValueOfItem	Return the text of a given item.
	setValue	Select specified value of a given combobox.
	setValueViaIndex	Set a value in the combobox.
	setValueViaSUTScript	Select specified value of a given combobox using a SUT script.
	dialogs	Procedures to handle Dialogs.
	handleSecurityWarning	Wait for the client to connect and check whether a Java security dialog blocks the JRE start which need to be confirmed.
	filechooser	Procedures for accessing file chooser dialogs.
	disableNameResolver	Uninstall the `JFileChooser` name resolver.
	enableNameResolver	Install the `JFileChooser` name resolver.
	selectFile	Select a file in a `JFileChooser` dialog.
	selectFiles	Select several files in a `JFileChooser` dialog.
	general	Procedures which work for any Swing component.
	clickAtComponent	Click on a given component, but only if the according parameter is set to true.
	clickAtComponentWithDetails	Click on a given component, but only if the according parameter is set to true.
	deleteOverrideComponent	Delete the current association of PriorityAwtSwingComponent.
	doClick	Click on a given component.
	doClickWithDetails	Click on a given component.
	doSelect	Send a selection event to a given component.
	setLocation	Set the location of a given component.
	setOverrideComponent	Set a given component to the PriorityAwtSwingComponent.
	setSize	Set the width and the height of a given component.
	waitForComponent	Wait for a given component.
	waitForComponentForAbsence	Wait till a given component disappears.
	list	Procedures for accessing lists.
	checks	Procedures for checking a list.
	checkNumberOfItems	Check the number of items of a given list according to a specified comparison mode.
	clickItemWithDetails	Select a given item by a mouse click on it.
	getIndexOfItem	Return the current index of a given item.
	getItemCount	Return the number of items of a given list.
	getValueOfItem	Return the text of a given item.
	selection	Procedures to (de-)select certain items of a list.
	deselectAllItems	Deselect all items.
	deselectItem	Deselect a given item, specified by its index.
	deselectItemRange	Deselect a range of items, specified by their index.
	selectAllItems	Select all items.
	selectItem	Select a given item, specified by its index.
	selectItemRange	Select a range of items, specified by their index.
	selectItem	Select a given item by a mouse click on it.
	menu	Procedures to select menu items and checkbox menu items.
	selectCheckMenuItemInHierarchy	Select a checkbox menu item from a menu.
	selectCheckMenuItemInHierarchyWithCoordinates	Select a checkbox menu item from a menu.
	selectItem	Select an item from a menu.
	selectItemWithCoordinates	Select an item from a menu.
	selectMenuItemInHierarchy	Select an item from a menu.
	selectMenuItemInHierarchyWithCoordinates	Select an item from a menu.
	selectSubItem	Select an item within a submenu.
	selectSubItemWithCoordinates	Select an item within a submenu.
	setCheckItem	Select a checkbox menu item.
	setCheckItemWithCoordinates	Select a checkbox menu item.
	setSubCheckItem	Select a checkbox menu item within within a submenu.
	setSubCheckItemWithCoordinates	Select a checkbox menu item within within a submenu.
	optionpane	Procedures for accessing standard error/message dialogs.
	checkMessage	Check the message of the current `javax.swing.JOptionPane` dialog.
	checkTitle	Check the title of the current `javax.swing.JOptionPane` dialog.
	clickCancelButton	Click on the Cancel Button of the current `javax.swing.JOptionPane` dialog.
	clickNoButton	Click on the No Button of the current `javax.swing.JOptionPane` dialog.
	clickOkButton	Click on the OK Button of the current `javax.swing.JOptionPane` dialog.
	clickYesButton	Click on the Yes Button of the current `javax.swing.JOptionPane` dialog.
	disableNameResolver	Uninstall the `JOptionPane` name resolver.
	enableNameResolver	Install the `JOptionPane` name resolver.
	getMessage	Get the message of the current `javax.swing.JOptionPane` dialog.
	getOptionPaneMessageType	Return the message Type of the current `javax.swing.JOptionPane` dialog.
	getTitle	Get the title of the current `javax.swing.JOptionPane` dialog.
	hasCancelButton	Check if the current `javax.swing.JOptionPane` dialog has an Cancel Button.
	hasNoButton	Check if the current `javax.swing.JOptionPane` dialog has an NO Button.
	hasOkButton	Check if the current `javax.swing.JOptionPane` dialog has an OK Button.
	hasYesButton	Check if the current `javax.swing.JOptionPane` dialog has an YES Button.
	isErrorDialog	Check, if current window is a `javax.swing.JOptionPane` ErrorDialog.
	isInfoDialog	Check, if current window is a `javax.swing.JOptionPane` InfoDialog.
	isOptionPane	Check, if current window is a `javax.swing.JOptionPane` dialog.
	isPlainDialog	Check, if current window is a `javax.swing.JOptionPane` PlainDialog.
	isQuestionDialog	Check, if current window is a `javax.swing.JOptionPane` QuestionDialog.
	isWarningDialog	Check, if current window is a `javax.swing.JOptionPane` WarningDialog.
	popupmenu	Procedures to select items and checkbox menu items from popup menus.
	clickItemWithDetails	Select an item in a popup menu.
	selectItem	Select an item in a popup menu.
	selectSubItem	Select an item within a submenu of a popup menu.
	selectSubItemWithCoordinates	Select an item within a submenu of a popup menu.
	setCheckItem	Select a checkbox menu item in a popup menu.
	setCheckItemWithCoordinates	Select a checkbox menu item in a popup menu.
	setSubCheckItem	Select a checkbox menu item within a submenu of a popup menu.
	setSubCheckItemWithCoordinates	Select a checkbox menu item within a submenu of a popup menu.
	radiobutton	Procedures to get and set the state of radio buttons.
	getValue	Return the value of a radio button.
	select	Select a radio button.
	selectWithCoordinates	Select a radio button.
	slider	Procedures to access sliders.
	checks	Procedure for checking slider values.
	checkValue	Check the value of a slider component
	getValue	Return the value of a slider component.
	setValue	Set the value of a slider component.
	startup	Procedures for startup of swing applications.
	setDelays	Set delays for the QF-Test SUT initialization process.
	setSecurityDialogSpec	Define properties for recognizing WebStart and applet security dialogs that should be closed automatically.
	startWebstartSUT	Start a Webstart SUT.
	tabbedpane	Procedures to work with TabbedPanes.
	closeTab	Close a tab via clicking on the "X "button.
	getIndexOfTab	Return the index of a given tab in a JTabbedPane.
	getItemCount	Return the number of items of a given tabbedpane.
	getValueOfTab	Return the text of a given tab in a JTabbedPane.
	selectTab	Select a tab in a given TabbedPane.
	table	Procedures to access tables.
	checkbox	Procedures to set the state of checkboxes in a table cell.
	deselect	Deselect a checkbox in a table cell.
	deselectWithCoordinates	Deselect a checkbox in a table cell.
	select	Select a checkbox in a table cell.
	selectWithCoordinates	Select a checkbox in a table cell.
	set	Set checkbox in a table cell to the given state.
	setWithCoordinates	Set checkbox in a table cell to the given state.
	checks	Procedures for checking a table.
	checkNumberOfRows	Check the number of rows of a given table according to a specified comparison mode.
	clickCellWithDetails	Select a given cell.
	getColumnCount	Return the number of columns of a given table.
	getIndexOfColumn	Return the current index of a given column.
	getNameOfColumn	Return the header text of a given column.
	getRowCount	Return the number of rows of a given table.
	getRowIndexOfCell	Return the row number of a given cell.
	getValueOfCell	Return the text of a given cell.
	resizeColumn	Resize width of a table column.
	selectCell	Select a given cell.
	selection	Procedures to (de-)select certain rows of a table.
	deselectAllRows	Deselect all rows.
	deselectRow	Deselect a given row, specified by its index.
	deselectRowRange	Deselect a range of rows, specified by their index.
	selectAllRows	Select all rows.
	selectRow	Select a given row, specified by its index.
	selectRowRange	Select a range of rows, specified by their index.
	text	Procedures to access text fields and text areas.
	clearArea	Clear a multi-line text area.
	clearField	Clear a simple text field.
	getText	Return the text of a given textfield.
	setText	Set a given text to a given text-field or text-area.
	setTextFromFile	Read the content of a given file and set its content to a given text-field.
	tree	Procedures to access trees.
	callbackPrintNodeText	Example for a callback procedure used by expandNodes.
	checks	Procedures for checking a tree.
	checkNumberOfChildNodes	Check the number of child nodes of a given tree node according to a specified comparison mode.
	checkNumberOfRows	Check the number of visible nodes under a given tree or tree node according to a specified comparison mode.
	clickNodeWithDetails	Select a given node.
	collapse	Collapse a tree node.
	collapseNode	Collapse a tree node.
	collapseNodes	Collapse a tree node recursively.
	collapseNodeWithCoordinates	Collapse a tree node.
	collapseWithCoordinates	Collapse a tree node.
	expand	Expand a tree node.
	expandNode	Expand a tree node.
	expandNodes	Expand a tree node recursively.
	expandNodesWithCoordinates	Expand a tree node recursively.
	expandNodeWithCoordinates	Expand a tree node.
	expandWithCoordinates	Expand a tree node.
	getChildNodeCount	Return the number of child nodes.
	getIndexOfNode	Return the current index of a given node.
	getRowCount	Return the number of visible nodes under a given tree or tree node.
	getValueOfNode	Return the text of a given node.
	selectNode	Select a given node.
	swt	Procedures for advanced manipulation of SWT components.
	checkbox	Procedures to set the state of checkboxes.
	deselect	Deselect a checkbox.
	deselectWithCoordinates	Deselect a checkbox.
	getValue	Return the value of a checkbox.
	select	Select a checkbox.
	selectWithCoordinates	Select a checkbox.
	set	Set checkbox to the given state.
	setWithCoordinates	Set checkbox to the given state.
	cleanup	The procedures in this package are useful for generic cleanup after an exception is thrown.
	closeAllDialogsAndModalShells	Close all modal dialogs.
	closeAllMenus	Close all menus unconditionally.
	implicitExceptionHandler	This procedure encompasses the usage of other cleanup procedures in this package and is the recommended operation to perform after an exception occurs and is implicitly caught.
	colordialog	Procedures to handle Colordialogs.
	selectColor	Select a specified color of a ColorDialog.
	combo	Procedures to handle comboboxes.
	getIndexOfItem	Return the current index of a given item.
	getItemCount	Return the number of items of a given combobox.
	getValue	Return the text of a given combo.
	getValueOfItem	Return the text of a given item.
	setValue	Select specified value of a given combobox using a selection event.
	setValueViaSUTScript	Select specified value of a given combobox using a SUT script.
	ctabfolder	Procedures for SWT CTabFolder widgets.
	checkTabIsDirty	This procedure raises an error, if a given tab is not dirty.
	closeTab	Close a tab in a generic CTabFolder that is identified only by the fact that it contains the desired tab.
	openViewMenu	Open the View Menu for a generic CTabFolder that is identified only by the fact that it contains the desired tab.
	selectTab	Select a tab in a generic CTabFolder that is identified only by the fact that it contains the desired tab.
	directorydialog	Procedures for accessing directory dialogs.
	selectDirectory	Select a directory in a `DirectoryDialog` dialog.
	filedialog	Procedures for accessing file dialogs.
	selectFile	Select a file in a `FileDialog` dialog.
	general	Procedures which work for any SWT component.
	clickAtComponent	Click on a given component, but only if the according parameter is set to true.
	clickAtComponentWithDetails	Click on a given component, but only if the according parameter is set to true.
	deleteOverrideComponent	Delete the current association of PrioritySwtComponent.
	doClick	Click on a given component.
	doClickWithDetails	Click on a given component.
	doSelect	Send a selection event to a given component.
	setLocation	Set the location of a given component.
	setOverrideComponent	Set a given component to the PrioritySwtWidget.
	setSize	Set the width and the height of a given component.
	waitForComponent	Wait for a given component.
	waitForComponentForAbsence	Wait till a given component disappears.
	instrument	Procedures for SWT instrumentation.
	setup	If necessary, instrument an Eclipse/RCP based or standalone SWT application for use with QF-Test.
	list	Procedures for accessing lists.
	checks	Procedures for checking a list.
	checkNumberOfItems	Check the number of items of a given list according to a specified comparison mode.
	clickItemWithDetails	Select a given item by a mouse click on it.
	getIndexOfItem	Return the current index of a given item.
	getItemCount	Return the number of items of a given list.
	getValueOfItem	Return the text of a given item.
	selection	Procedures to (de-)select certain items of a list.
	deselectAllItems	Deselect all items.
	deselectItem	Deselect a given item, specified by its index.
	deselectItemRange	Deselect a range of items, specified by their index.
	selectAllItems	Select all items.
	selectItem	Select a given item, specified by its index.
	selectItemRange	Select a range of items, specified by their index.
	selectItem	Select a given item by a mouse click on it.
	menu	Procedures to select menu items and checkbox menu items.
	selectCheckMenuItemInHierarchy	Select a checkbox menu item from a menu.
	selectItem	Select an item from a menu.
	selectMenuItemInHierarchy	Select an item from a menu.
	selectSubItem	Select an item within a submenu.
	setCheckItem	Select a checkbox menu item.
	setSubCheckItem	Select a checkbox menu item within within a submenu.
	popupmenu	Procedures to select items and checkbox menu items from popup menus.
	selectItem	Select an item in a popup menu.
	selectSubItem	Select an item within a submenu of a popup menu.
	setCheckItem	Select a checkbox menu item in a popup menu.
	setSubCheckItem	Select a checkbox menu item within a submenu of a popup menu.
	radiobutton	Procedures to set the state of buttons with the style SWT.RADIO.
	getValue	Return the value of a radio button.
	select	Select a radio button.
	selectWithCoordinates	Select a radio button.
	sash	Procedures to work with sash components.
	moveSash	Move a sash by a given distance.
	moveSashTo	Move a sash to a given position.
	scrollbar	Procedures to work with scrollbar components.
	pageDown	Scroll a component one page downwards by simulating a hard mouse click below the scrollbar's thumb.
	pageLeft	Scroll a component one page to the left by simulating a hard mouse click to the left of the scrollbar's thumb.
	pageRight	Scroll a component one page to the right by simulating a hard mouse click to the right of the scrollbar's thumb.
	pageUp	Scroll a component one page upwards by simulating a hard mouse click above the scrollbar's thumb.
	scrollDown	Scroll a component downwards by simulating a hard mouse click on the down arrow button of its vertical scrollbar.
	scrollLeft	Scroll a component to the left by simulating a hard mouse click on the left arrow button of its horizontal scrollbar.
	scrollRight	Scroll a component to the right by simulating a hard mouse click on the right arrow button of its horizontal scrollbar.
	scrollUp	Scroll a component upwards by simulating a hard mouse click on the up arrow button of its vertical scrollbar.
	tabfolder	Procedures for SWT TabFolder widgets.
	closeTab	Close a tab via sending a "close" selection event.
	getIndexOfTab	Return the index of a given tab.
	getItemCount	Return the number of items of a given tabfolder.
	getValueOfTab	Return the text of a given tab.
	selectTab	Select a tab in a given Tabfolder.
	table	Procedures to access tables.
	checkbox	Procedures to set the checked state of tableitems.
	deselect	Unset the checked state of a tableitem in a table.
	select	Set the checked state of a tableitem in a table.
	set	Set checked state of a tableitem to the given state.
	checks	Procedures for checking a table.
	checkNumberOfRows	Check the number of rows of a given table according to a specified comparison mode.
	clickCellWithDetails	Select a given cell.
	getColumnCount	Return the number of columns of a given table.
	getIndexOfColumn	Return the current index of a given column.
	getNameOfColumn	Return the header text of a given column.
	getRowCount	Return the number of rows of a given table.
	getRowIndexOfCell	Return the row number of a given cell.
	getValueOfCell	Return the text of a given cell.
	selectCell	Select a given cell.
	selection	Procedures to (de-)select certain rows of a table.
	deselectAllRows	Deselect all rows.
	deselectRow	Deselect a given row, specified by its index.
	deselectRowRange	Deselect a range of rows, specified by their index.
	selectAllRows	Select all rows.
	selectRow	Select a given row, specified by its index.
	selectRowRange	Select a range of rows, specified by their index.
	text	Procedures to access text fields and text areas.
	clearArea	Clear a multi-line text area.
	clearField	Clear a simple text field.
	getText	Return the text of a given textfield.
	setText	Set a given text to a given text-field or text-area.
	setTextFromFile	Read the content of a given file and set its content to a given text-field.
	tree	Procedures to access trees.
	callbackPrintNodeText	Example for a callback procedure used by expandNodes.
	checks	Procedures for checking a tree.
	checkNumberOfChildNodes	Check the number of child nodes of a given tree node according to a specified comparison mode.
	checkNumberOfRows	Check the number of visible nodes under a given tree or tree node according to a specified comparison mode.
	clickNodeWithDetails	Select a given node.
	collapse	Collapse a tree node.
	collapseNode	Collapse a tree node.
	collapseNodeWithCoordinates	Collapse a tree node.
	collapseWithCoordinates	Collapse a tree node.
	expand	Expand a tree node.
	expandCompleteTree	Collapse a tree node.
	expandNode	Expand a tree node.
	expandNodes	Expand a tree node recursively.
	expandNodesWithCoordinates	Expand a tree node recursively.
	expandNodeWithCoordinates	Expand a tree node.
	expandWithCoordinates	Expand a tree node.
	getChildNodeCount	Return the number of child nodes.
	getIndexOfNode	Return the hierarchical index of a given node.
	getRowCount	Return the number of visible nodes under a given tree or tree node.
	getValueOfNode	Return the text of a given node.
	multicolumn	Special procedures for multi-column trees.
	getRowIndexByCellText	Return the index of the first row containing a given cell text in a given column of an SWT multi-column tree.
	selectNode	Select a given node.
	utils	Miscellaneous utility procedures.
	click	Perform a mouse click somwhere on the screen or onto a given component.
	clipboard	Accessing the clipboard from procedures.
	getTextFromClipboard	Return the current text on the system clipboard.
	setTextAtClipboard	Set a text on the system clipboard.
	createThreadDump	Trigger a full thread dump in the SUT if possible.
	dragAndDrop	Drag the source component or item onto the target and drop it.
	dumpComponents	Dump an entire component hierarchy into the run log.
	dumpHeap	Dump the heap of the Java VM.
	email	Procedures for sending emails.
	pop3	Procedures for interacting with a POP3 server.
	deleteMessages	Delete all messages from a pop3 account.
	fetchMessage	Fetch a message from a pop3 account.
	sendEmail	This procedure uses the smtplib module from Jython, to send emails via SMTP(s) server.
	sendEmail_SMTPHost	Send an email.
	files	Contain procedures to work with files.
	checkFileForContent	Check, whether a given file contain a specific value.
	checkFileForExistingLine	Check, whether a given file contain a specific value in a line.
	compareFiles	Compare the given files and returns true if equal, otherwise false.
	readExcelFile	Read a worksheet of an Excel file.
	getBoundsOnScreen	Get the screen location and the size of a component or subitem.
	getDate	Return a date, default is the current date in current locale.
	getTime	Return the time in the current format.
	getTimestamp	Return a timestamp, which represents the current time in milliseconds.
	json	Procedures for working with JSON files.
	compareJSONFiles	Compare two JSON files for full identity.
	compareJsonResponse	Compare a JSON response against an expected file.
	getRESTResponse	Get a REST response from a given URL.
	killAllClients	Kill all running clients.
	killClient	Kill a client.
	logAllMethodsOfAGivenComponent	Log all available methods of a given component.
	logMemory	Log current memory use.
	logNativeMemory	Log current memory usage of the native process(es) of a client.
	printMessage	Print a given message to STDOUT.
	printVariable	Print the visible content of a variable.
	random	Procedures for generating random string.
	getEntriesOfArea	Return a random string created of parts of a specified area.
	getNumber	Return a random number.
	getNumberFromRange	Return a random number between two given numbers.
	getString	Return a random string containing small letters.
	readTextFromFile	Read the content of a given file.
	sendEmail
	sendKey	Send the given key along with the qualifier to the component which currently has the input focus.
	sendText	Send the given text to the component which currently has the input focus.
	setWindowToForeground	Brings the specified window to the foreground.
	sleep	Sleep a given time.
	ssh	Procedures for executing commands on a remote server via ssh.
	executeCommand	Connect to a remote server by ssh and execute a command.
	session	Procedures for handling SSH connections.
	close	Close an established ssh connection.
	open	Connect to a remote server by ssh and keep the session open for further use.
	send	Send a command via an established ssh connection and wait for resulting output.
	testrun	Procedures for handling the test execution.
	skip	Procedures for skipping test steps.
	skipTestCase	Skip the execution of the current test case.
	skipTestSet	Skip the execution of the current test set.
	stop	Procedures for stopping test steps.
	stopTestCase	Stop the execution of the current test case
	stopTestRun	Stop the complete test run.
	stopTestSet	Stop the execution of the current test set.
	variables	Procedures for working with variables.
	deleteAllGlobalVariables	Delete all global QF-Test variables.
	deleteGlobalVariablesExcept	Delete all global QF-Test variables.
	deleteOneGlobalVariable	Delete a given global QF-Test variable.
	deleteOnePropertyVariable	Delete a given variable of a property group.
	deletePropertyGroup	Delete a given global property group.
	listAllMembersOfPropertyGroup	Print a list of all members of a given property group to the terminal.
	waitForClientOutput	Wait until a client prints something to the terminal.
	waitForOneOfNComponents	Wait until one of N components is available.
	writeMessageIntoFile	Write a given message into a given file.
	xml	Procedures for working with XML files.
	compareXMLFiles	Compare two XML files for full identity.
	loadPropertiesFromXML	Load properties from an XML file.
	web	Web utility procedures.
	ajax	AJAX procedures.
	dumpCustomWebResolverProperties	Dump properties of an installed CustomWebResolver.
	installCustomWebResolver	Install a generic CustomWebResolver for an Ajax framework.
	installToolkitResolver	Install a special resolver for given AJAX toolkit to improve recorded component types and hierarchy and therefore achieves improved component recognition.
	uninstallCustomWebResolver	Uninstall a previously installed generic CustomWebResolver.
	uninstallToolkitResolver	Uninstall a special resolver for given AJAX toolkit.
	updateCustomWebResolverProperties	Updates properties of an installed generic CustomWebResolver.
	browser	Browser procedures.
	dialogs	Procedures for handling error dialogs opened within the browser.
	closeCertificateWarning	Uses the Java AWT Robot/Autowin Methods to automatically close an open Certificate Warning Dialog.
	closeJavascriptWarning	Uses the Java AWT Robot Methods to automatically close an open Javascript Warning Dialog.
	upload	Handle the native Windows Upload dialog (especially for Internet Explorer 8).
	dom	Procedures for handling DOM access.
	selectAllCheckboxes	Check or uncheck all (enabled) checkboxes which are situated in the DOM tree beneath the given parent.
	download	Procedures to handle downloads in QF-Test.
	setDownloadProperty	Set the QF-Test download property.
	external	This package contains methods to interrupt a browser-open call from a java application.
	observers	Helper procedures to register and unregister method call interceptors to detect browser opening in tested applications.
	catchBrowserOpen	Registers a notification observer which intercepts external browser opening and stores the corresponding url.
	catchFileOpen	Registers a notification observer which intercepts external process launches.
	catchProcessOpen	Registers a notification observer which intercepts external process launches.
	uncatchBrowserOpen	Unregisters the a notification observer previously registered with catchBrowserOpen
	uncatchFileOpen	Unregisters the a notification observer previously registered with catchProcessOpen
	uncatchProcessOpen	Unregisters the a notification observer previously registered with catchProcessOpen
	prepareForBrowserOpen	Call this procedure before triggering an action that opens an external browser and before calling "waitForBrowser".
	stopInterceptingBrowserOpen	Call this procedure to restore the normal behavior before a call to "prepareForBrowserOpen"
	waitForBrowserOpen	Checks, if after "prepareForBrowserOpen" a call for opening an external browser has been intercepted and checks the intercepted url and/or starts a defined procedure.
	general	General browser procedures.
	checkForRunningBrowserEngine	Check for the browser and if is not running than start it.
	getBestBrowser	Tries to detect the best browser type for the current system and returns its browser name.
	openMobileEmulation	Opens a new browser window which emulates a mobile browser.
	openNewWindow	Open a new window in an already running browser.
	showUrl	Show a different URL in an open browser window.
	startAsNewProcess	Ensures the given browser executable is started as a new process.
	mozilla	Mozilla utility procedures.
	cleanupProfileDir	Performs several cleanup actions on the given mozProfile directory.
	settings	The procedures in this package are useful for customizing browser settings.
	deleteCookies	Delete cookies.
	disableCookies	Disable cookies in the browser.
	doStartupSettings	Do startup settings for the browser.
	emptyCache	Empty the browser cache.
	enableCookies	Enable cookies in the browser.
	enableMutationListeners	Enable/Disable MutationListeners in the QF-Test browser engine for a specific document or globally for all documents.
	setDirectDownload	Whether show download dialog at download (empty downloadsDir) or to download a file directly in provided directory.
	setLocale	Set preferred language for in the displaying web pages in the browser.
	setProxy	Set a proxy server for the browser.
	setTerminalLogs	Whether to pass on browser console logs to QF-Test terminal
	setUserAgent	Set user agent for the browser.
	checkbox	Procedures to set the state of checkboxes.
	deselect	Deselect a checkbox.
	deselectWithCoordinates	Deselect a checkbox If the checkbox is already deselected, no action is performed.
	getValue	Return the value of a checkbox.
	select	Select a checkbox.
	selectWithCoordinates	Select a checkbox.
	set	Set checkbox to the given state.
	setAll	Set all (enabled) checkboxes inside a given parent.
	setWithCoordinates	Set checkbox to the given state.
	checks	Procedures for handling different web checks.
	checkAttribute	Checks an attribute of a component.
	checkElements(negative)	Negates a normal Elementcheck in select elements to allow NegationChecks.
	checkForElement	Checks if the given element (option-element-text) is in the select-element (combobox).
	checkInvisibility	Negates a normal WaitForComponentCheck to allow VisibilityChecks.
	checkText(negative)	Negates a normal Textcheck to allow NegationChecks.
	checkTitle	Checks the title of the BrowserWindow.
	style	Procedures for handling different element style checks.
	checkStyleAttribute	Checks a specific style attribute for the given component.
	color	Procedures for handling different element style checks concerning color attributes.
	checkBackgroundColor	Checks the value that indicates the color behind the content of the component.
	checkColor	Checks the value that indicates the color of the text of the component.
	font	Procedures for handling different element style checks concerning font attributes.
	checkFontName	Checks the name of the font used for text in the component.
	checkFontSize	Checks the value that indicates the font size used for text in the component
	checkFontStyle	Checks the value that indicates the font style used for text in the component (italic, normal or oblique)
	getStyleAttributeThroughJS	Returns the value of a specific style attribute of the given component.
	cwr	Procedures to support Custom Web Resolvers
	dumpConfiguration	Dump configuration of an installed CustomWebResolver.
	uninstall	Uninstalls a previously installed CustomWebResolver.
	electron	Procedures for Electron testing.
	getChromeDriverPath	Get the path to the ChromeDriver and download it if neccessary.
	general	Procedures which work for any Web component.
	clickAtComponent	Click on a given component, but only if the according parameter is set to true.
	clickAtComponentWithDetails	Click on a given component, but only if the according parameter is set to true.
	clickIncreasinglyHard	Clicks the given component with increasingly hard mouse clicks and waits for the given action to be performed.
	deleteOverrideComponent	Delete the current association of PriorityWebComponent.
	doClick	Click on a given component.
	doClickWithDetails	Click on a given component.
	dragFromTo	Simulate a drag&drop operation.
	getSourcecode	Return document's source code.
	integrateFirebug	Integrates Firebug Lite from http://getfirebug.com into an open browser window for an easier analysis of the DOM.
	setOverrideComponent	Set a given component to the PriorityWebComponent.
	waitForComponent	Wait for a given component.
	waitForComponentForAbsence	Wait till a given component disappears.
	input	Procedures to access INPUT elements.
	fileUpload	Set the value of the INPUT:FILE node by whatever means that are applicable for the browser.
	radiobutton	Procedures to set the state of buttons.
	getValue	Return the value of a radio button.
	select	Select a radio button.
	selectWithCoordinates	Select a radio button.
	select	Procedures to access select nodes.
	getIndexOfItem	Return the current index of a given item.
	getItemCount	Return the number of items of a given select.
	getValue	Return the current value of a given select node.
	getValueOfItem	Return the current text of a given item.
	selectValue	Select a given value in a Select node.
	table	Procedures to access web tables.
	checks	Procedures for checking a table.
	checkNumberOfColums	Check the number of columns of a given table according to a specified comparison mode.
	checkNumberOfRows	Check the number of rows of a given table according to a specified comparison mode.
	clickCellWithDetails	Select a given cell.
	getColumnCount	Return the number of columns of a given web table.
	getIndexOfColumn	Return the current index of a given column.
	getNameOfColumn	Return the header text of a given column.
	getRowCount	Return the number of rows of a given table.
	getRowIndexOfCell	Return the row number of a given cell.
	getValueOfCell	Return the text of a given cell.
	recording	Procedures influencing recording of web tables.
	activateItemRecording	Activate recording of item based access for a given web table.
	deactivateItemRecording	Deactivate recording of item based access for a given web table.
	selectCell	Select a given cell.
	text	Procedures to access text fields and text areas.
	clearArea	Clear a multi-line text area.
	clearField	Clear a simple text field.
	getText	Return the text of a given textfield.
	setText	Set a given text to a given text-field or text-area.
	setTextFromFile	Read the content of a given file and set its content to a given text-field.
	win	Procedures for advanced manipulation of native windows components.
	checkbox	Procedures to set the state of checkboxes.
	deselect	Deselect a checkbox.
	deselectWithCoordinates	Deselect a checkbox.
	getValue	Return the value of a checkbox.
	select	Select a checkbox.
	selectWithCoordinates	Select a checkbox.
	set	Set checkbox to the given state.
	setWithCoordinates	Set checkbox to the given state.
	combobox	Procedures to handle comboboxes.
	getIndexOfItem	Return the current index of a given item.
	getValue	Return the text of a given combobox.
	getValueOfItem	Return the text of a given item.
	setValue	Select specified value of a given combobox.
	general	Procedures which work for any Win component.
	clickAtComponent	Click on a given component, but only if the according parameter is set to true.
	clickAtComponentWithDetails	Click on a given component, but only if the according parameter is set to true.
	doClick	Click on a given component.
	doClickWithDetails	Click on a given component.
	waitForComponent	Wait for a given component.
	waitForComponentForAbsence	Wait till a given component disappears.
	helpers	Helper procedure for Windows engine tests.
	hasPattern	Check whether the component has the given pattern.
	list	Procedures for accessing lists.
	checks	Procedures for checking a list.
	checkNumberOfItems	Check the number of items of a given list according to a specified comparison mode.
	clickItemWithDetails	Select a given item by a mouse click on it.
	getIndexOfItem	Return the current index of a given item.
	getItemCount	Return the number of items of a given list.
	getValueOfItem	Return the text of a given item.
	selectItem	Select a given item by a mouse click on it.
	radiobutton	Procedures to get and set the state of radio buttons.
	getValue	Return the value of a radio button.
	select	Select a radio button.
	selectWithCoordinates	Select a radio button.
	tabbedpane	Procedures to work with TabbedPanes.
	getIndexOfTab	Return the index of a given tab in a TabbedPane.
	getItemCount	Return the number of items of a given tabbedpane.
	getValueOfTab	Return the text of a given tab in a TabbedPane.
	selectTab	Select a tab in a given TabbedPane.
	table	Procedures to access tables.
	checks	Procedures for checking a table.
	checkNumberOfColumns	Check the number of columns of a given table according to a specified comparison mode.
	checkNumberOfRows	Check the number of rows of a given table according to a specified comparison mode.
	clickCellWithDetails	Select a given cell.
	getColumnCount	Return the number of columns of a given table.
	getIndexOfColumn	Return the current index of a given column.
	getNameOfColumn	Return the header text of a given column.
	getRowCount	Return the number of rows of a given table.
	getRowIndexOfCell	Return the row number of a given cell.
	getValueOfCell	Return the text of a given cell.
	resizeColumn	Resize width of a table column.
	selectCell	Select a given cell.
	text	Procedures to access text fields and text areas.
	clearArea	Clear a multi-line text area.
	clearField	Clear a simple text field.
	getText	Return the text of a given textfield.
	setText	Set a given text to a given text-field or text-area.
	setTextFromFile	Read the content of a given file and set its content to a given text-field.
	tree	Procedures to access trees.
	checks	Procedures for checking a tree.
	checkNumberOfChildNodes	Check the number of child nodes of a given tree node according to a specified comparison mode.
	clickNodeWithDetails	Select a given node.
	collapse	Collapse a tree node.
	collapseNode	Collapse a tree node.
	collapseNodeWithCoordinates	Collapse a tree node.
	collapseWithCoordinates	Collapse a tree node.
	expand	Expand a tree node.
	expandNode	Expand a tree node.
	expandNodeWithCoordinates	Expand a tree node.
	expandWithCoordinates	Expand a tree node.
	getChildNodeCount	Return the number of child nodes.
	getIndexOfNode	Return the current index of a given node.
	getValueOfNode	Return the text of a given node.
	selectNode	Select a given node.

Details

Package: "qfs"

This package contains helpful standard procedures provided by Quality First Software.

The "SUT client" name is used in many of the contained procedures represented by the "$(client)" variable. We recommend to define the variable "client" in the respective table of the test suite's root node - as long as only one SUT client is used in the test suite. This ensures that the "client" parameter doesn't have to be given separately.

Author:: QFS
Since:: 1.05.0

Package: "accessibility"

Contains procedures to test the accessibility of a SUT.

Author:: QFS
Since:: 9.0

Package: "web"

Accessibility tests for Web-SUTs.

Author:: QFS
Since:: 9.0

	Procedure/Dependency	Description
	checkAxeRules	Runs axe-core test in a defined scope for defined rules.
	checkColorContrastSimpleGraphics	Runs a test to check the color contrast of elements.

Procedure: "checkAxeRules"

Runs axe-core test in a defined scope for defined rules.

Raises error: ERR_AXE-CORE_CHECKS

Parameters:: rules - Comma separated axe rule ids or comma separated tags (for details please see manual). Empty rules defaults to all rules. default: wcag2a,wcag2aa,wcag21a,wcag21aa,wcag22aa Warning: rule ids and tags are not combinable. Examples: button-name button-name,input-button-name wcag2aa wcag2aa,best-practice; rulesToSkip - If parameter rules is set to empty or tags, it is possible to avoid checking of some of these rules by declaring comma separated axe rule ids. These rules will be excluded from the test. Examples: button-name button-name,input-button-name Empty rulesToSkip defaults to all rules of parameter rules be checked. default: empty input scope parameters:; scope - QF-Test ID of the component that defines the scope in which elements should be checked to satisfy the rule. An empty scope defaults to the entire page. default: genericDocument; genericClassesToSkip - Comma separated names of generic classes. The elements with these generic classes, including children should not be checked to satisfy the rule. default: empty; skipInvisibleElements - If true the check will not be performed for invisible elements default: true output report parameters:; showSuccessfulChecks - If true shows successful checks on elements in the run log. default: false; showImpossibleChecks - If true shows impossible checks on elements in the run log as warnings. A check is impossible if it could not be completed due to certain aspects such as visibility. default: true; logOverviewScreenshot - If true logs an image of the scope. Elements violating the rule will be highlighted on screenshot with red. Elements for which the rule was impossible to check - with yellow. default: true; allowedHeightOfOverviewScreenshot - Maximal height of the overview screenshot in pixel. Needs to be limited for memory reasons. default: 2000; logElementScreenshots - Possible values: all, first, none If "all" logs an image of all elements with a violation of a rule. If "first" and "squashCheckResultsWithSameMessage" parameter set to "true" logs an image of only the first element of all elements with same message of violation If "none" logs no element screenshots. An element violating the rule will be highlighted on screenshot with red. An element for which the rule was impossible to check - with yellow. default: all; allowedNumberOfElementScreenshots - Maximum number of screenshots for elements in case of failure. Needs to be limited for memory reasons. default: 20; logElementSmartIdToMessage - If true adds smartId to element details in message. default: false; squashCheckResultsWithSameMessage - If true only one warning or failure will be logged for all elements with the same message. default: true
Author:: QFS
Since:: 9.0

Procedure: "checkColorContrastSimpleGraphics"

Runs a test to check the color contrast of elements.

The test is executed in a defined scope for elements with defined generic classes or tags checking contrast between the foreground and background color satisfies WCAG 2 AA standard for non-text contrast (3:1 color contrast ratio for user interface components and state and graphical objects that convey meaningful information).

Raises error: ERR_COLOR_CONTRAST_SIMPLE_GRAPHICS

Parameters:: genericClasses - Comma separated generic classes or html tags of elements that will be considered for checks. default: Icon input scope parameters:; scope - QF-Test ID of the component that defines the scope in which elements should be checked to satisfy the rule. An empty scope defaults to the entire page. default: genericDocument; genericClassesToSkip - Comma separated names of generic classes. The elements with these generic classes, including children should not be checked to satisfy the rule. default: empty; skipInvisibleElements - If true the check will not be performed for invisible elements default: true output report parameters:; showSuccessfulChecks - If true shows successful checks on elements in the run log. default: false; showImpossibleChecks - If true shows impossible checks on elements in the run log as warnings. A check is impossible if it could not be completed due to certain aspects such as visibility. default: true; logOverviewScreenshot - If true logs an image of the scope. Elements violating the rule will be highlighted on screenshot with red. Elements for which the rule was impossible to check - with yellow. default: true; allowedHeightOfOverviewScreenshot - Maximal height of the overview screenshot in pixel. Needs to be limited for memory reasons. default: 2000; logElementScreenshots - Possible values: all, first, none If "all" logs an image of all elements with a violation of a rule. If "first" and "squashCheckResultsWithSameMessage" parameter set to "true" logs an image of only the first element of all elements with same message of violation If "none" logs no element screenshots. An element violating the rule will be highlighted on screenshot with red. An element for which the rule was impossible to check - with yellow. default: all; allowedNumberOfElementScreenshots - Maximum number of screenshots for elements in case of failure. Needs to be limited for memory reasons. default: 20; logElementSmartIdToMessage - If true adds smartId to element details in message. default: false; squashCheckResultsWithSameMessage - If true only one warning or failure will be logged for all elements with the same message. default: true
Author:: QFS
Since:: 9.0

Package: "android"

Contains procedures to test android applications as well as useful procedures for remote controlling android devices.

Author:: QFS
Since:: 5.4

Package: "adbUtils"

Procedures using the Android Debug Bridge (adb).

Author:: QFS
Since:: 5.4

	Procedure/Dependency	Description
	getAdbPath	Get the path to the adb binary.
	runAdbCommand	Copy a file or folder from the local system to the android device.

Procedure: "getAdbPath"

Get the path to the adb binary.

Returns:: The path to the adb binary.
Author:: QFS
Since:: 5.4

Procedure: "runAdbCommand"

Copy a file or folder from the local system to the android device.

Parameters:: command - the adb command to execute; retWithoutNewline - if the return value should cut "\n" default:false; addDeviceName - Try to add the deviceName to the adb shell command.
Returns:: The stdout/stderr output of the program. Variables in this string will not be automatically expanded.
Author:: QFS
Since:: 5.4

Package: "appControl"

Procedures for controlling android apps.

Author:: QFS
Since:: 5.4

	Procedure/Dependency	Description
	resetCurrentApp	Reset all data and permissons from the app that currently has the focus and restart it.
	startApp	Start an Android app on an already running device.
	stopApp	Stop a running Android app.

Procedure: "resetCurrentApp"

Reset all data and permissons from the app that currently has the focus and restart it.

Author:: QFS
Since:: 5.4

Procedure: "startApp"

Start an Android app on an already running device.

Parameters:: packageName - The package name of the Android app to be launched.
Author:: QFS
Since:: 5.4

Procedure: "stopApp"

Stop a running Android app.

Parameters:: packageName - The package name of the Android app to be stopped.
Author:: QFS
Since:: 5.4

Package: "appPackage"

Procedures to read out the package name of an android application.

Author:: QFS
Since:: 5.4

	Procedure/Dependency	Description
	getCurrentPackage	Get the package name of the app that currently has the focus.
	getPackage	Get the package name from an APK file.

Procedure: "getCurrentPackage"

Get the package name of the app that currently has the focus. This procedure will throw an exception in case multiple such apps exists or no such app could be found.

Returns:: the name of the package
Author:: QFS
Since:: 5.4

Procedure: "getPackage"

Get the package name from an APK file.

Parameters:: apkPath - apk path
Author:: QFS
Since:: 5.4

Package: "appSettings"

Procedures for changing android apps settings.

Author:: QFS
Since:: 5.4

	Procedure/Dependency	Description
	grantPermissions	Grant a permission from an app.
	resetClearData	Deletes all data from an app.
	revokePermissions	Revoke a permission from an app.

Procedure: "grantPermissions"

Grant a permission from an app.

Parameters:: packageName - package name; permission - android permisson
Author:: QFS
Since:: 5.4

Procedure: "resetClearData"

Deletes all data from an app.

Parameters:: packageName - package name
Author:: QFS
Since:: 5.4

Procedure: "revokePermissions"

Revoke a permission from an app.

Parameters:: packageName - package name; permission - android permisson
Author:: QFS
Since:: 5.4

Package: "dataTransfer"

Procedures for transfering data from a computer to an android device and vica versa

Author:: QFS
Since:: 5.4

	Procedure/Dependency	Description
	pull	Copy a file or folder from the android device to the local system.
	push	Copy a file or folder from the local system to the android device.

Procedure: "pull"

Copy a file or folder from the android device to the local system.

Parameters:: filePath - Source path where the file is stored.; targetPath - Target path where to copy the file
Author:: QFS
Since:: 5.4

Procedure: "push"

Copy a file or folder from the local system to the android device.

Parameters:: filePath - Source path where the file is stored.; targetPath - Target path where to copy the file
Author:: QFS
Since:: 5.4

Package: "checkbox"

Procedures to set the state of checkboxes.

Author:: QFS
Since:: 5.4

	Procedure/Dependency	Description
	deselect	Deselect a checkbox.
	deselectWithCoordinates	Deselect a checkbox.
	getValue	Return the value of a checkbox.
	select	Select a checkbox.
	selectWithCoordinates	Select a checkbox.
	set	Set checkbox to the given state.
	setWithCoordinates	Set checkbox to the given state.

Procedure: "deselect"

Deselect a checkbox. If the checkbox is already deselected, no action is performed.

Parameters:: id - The id of the checkbox.
Author:: QFS
Since:: 5.4

Procedure: "deselectWithCoordinates"

Deselect a checkbox. If the checkbox is already deselected, no action is performed. You can specify the coordinates for clicking.

Parameters:: id - The id of the checkbox.; x - The x coordinate for the click, default is empty to click in the middle.; y - The y coordinate for the click, default is empty to click in the middle.
Author:: QFS
Since:: 5.4

Procedure: "getValue"

Return the value of a checkbox. It's either 1, if box is selected or 0, if box is not selected.

Parameters:: id - ID of the checkbox.
Returns:: The state of the checkbox.
Author:: QFS
Since:: 5.4

Procedure: "select"

Select a checkbox. If the checkbox is already selected, no action is performed.

Parameters:: id - The id of the checkbox.
Author:: QFS
Since:: 5.4

Procedure: "selectWithCoordinates"

Select a checkbox. If the checkbox is already selected, no action is performed. You can specify the coordinates for clicking.

Parameters:: id - The id of the checkbox.; x - The x coordinate for the click, default is empty to click in the middle.; y - The y coordinate for the click, default is empty to click in the middle.
Author:: QFS
Since:: 5.4

Procedure: "set"

Set checkbox to the given state.

Parameters:: id - The id of the checkbox.; check - The check value to be set (either true or false).
Author:: QFS
Since:: 5.4

Procedure: "setWithCoordinates"

Set checkbox to the given state. You can specify the coordinates for clicking.

Parameters:: id - The id of the checkbox.; check - The check value to be set (either true or false).; x - The x coordinate for the click, default is empty to click in the middle.; y - The y coordinate for the click, default is empty to click in the middle.
Author:: QFS
Since:: 5.4

Package: "device"

Contains procedures to remote control android devices.

Author:: QFS
Since:: 5.4

	Procedure/Dependency	Description
	appSwitch	Select the app switch button on the device.
	back	Select the back button on the device.
	closeKeyboard	Close a maybe opened keyboard window.
	getRotation	Get the rotation of the device.
	home	Select the home button on the device.
	setRotation	Set the rotation of the device.
	syncTime	Sync the time of the android device with the current machine or a given timestamp.

Procedure: "appSwitch"

Select the app switch button on the device.

Author:: QFS
Since:: 5.4

Procedure: "back"

Select the back button on the device.

Author:: QFS
Since:: 5.4

Procedure: "closeKeyboard"

Close a maybe opened keyboard window.

Author:: QFS
Since:: 5.4.1

Procedure: "getRotation"

Get the rotation of the device.

Returns:: direction in degree as string 0, 90, 180, 270
Author:: QFS
Since:: 5.4

Procedure: "home"

Select the home button on the device.

Author:: QFS
Since:: 5.4

Procedure: "setRotation"

Set the rotation of the device.

Parameters:: rotation - The rotation in degree valid values: 0,90,180,270 0 = reset to the default position
Author:: QFS
Since:: 5.4

Procedure: "syncTime"

Sync the time of the android device with the current machine or a given timestamp.

Parameters:: timestamp - Optional timestamp, empty to use the current time of the host system, otherwise data in the form MMDDhhmm[[CC]YY][.ss]
Author:: QFS
Since:: 5.4

Package: "gesture"

Procedures for android gestures like pinch, swipe, ...

Author:: QFS
Since:: 5.4

	Procedure/Dependency	Description
	pinch	Perform a two finger pinch action.
	zoom	Perform a two finger zoom action.

Procedure: "pinch"

Perform a two finger pinch action.

Parameters:: finger1X - position X of the first finger; finger1Y - position Y of the first finger; finger2X - position X of the second finger; finger2Y - position Y of the second finger
Author:: QFS
Since:: 5.4

Procedure: "zoom"

Perform a two finger zoom action.

Parameters:: startX - position X of the start point; startY - position Y of the start point; range - moving range; angle - moving angle 0 = horizontal
Author:: QFS
Since:: 5.4

Package: "general"

Procedures which work for any Android component.

Author:: QFS
Since:: 5.4

	Procedure/Dependency	Description
	clickAtComponent	Click on a given component, but only if the according parameter is set to true.
	clickAtComponentWithDetails	Click on a given component, but only if the according parameter is set to true.
	doClick	Click on a given component.
	doClickWithDetails	Click on a given component.
	doLongClick	Long click on a given component.
	waitForComponent	Wait for a given component.
	waitForComponentForAbsence	Wait till a given component disappears.

Procedure: "clickAtComponent"

Click on a given component, but only if the according parameter is set to true.

Parameters:: id - The Id of the target component.; click - If this is set to true, the click will be performed, otherwise nothing happens.
Author:: QFS
Since:: 5.4

Procedure: "clickAtComponentWithDetails"

Click on a given component, but only if the according parameter is set to true. You can specify the coordinates for clicking and all other details of that mouse click.

Parameters:: id - The Id of the target component.; click - If this is set to true, the click will be performed, otherwise nothing happens.; x - The x coordinate for the click, default is empty to click in the middle.; y - The y coordinate for the click, default is empty to click in the middle.; clickCount - Number of clicks. Default is 1. For a double click set this to 2.; modifier - Modifier for mouse key. 16 for right mouse. 4 for left mouse.; hard - True, if hard event should be replayed. Default is false.; popupTrigger - True, if click should open a popup. Default is false.
Author:: QFS
Since:: 5.4

Procedure: "doClick"

Click on a given component.

Parameters:: id - The Id of the target component.
Author:: QFS
Since:: 5.4

Procedure: "doClickWithDetails"

Click on a given component. You can specify the coordinates for clicking and all other details of that mouse click.

Parameters:: id - The Id of the target component.; x - The x coordinate for the click, default is empty to click in the middle.; y - The y coordinate for the click, default is empty to click in the middle.; clickCount - Number of clicks. Default is 1. For a double click set this to 2.; modifier - Modifier for mouse key. 16 for right mouse. 4 for left mouse.; hard - True, if hard event should be replayed. Default is false.; popupTrigger - True, if click should open a popup. Default is false.
Author:: QFS
Since:: 5.4

Procedure: "doLongClick"

Long click on a given component.

Parameters:: id - The Id of the target component.
Author:: QFS
Since:: 5.4

Procedure: "waitForComponent"

Wait for a given component.

Parameters:: id - The Id of the target component.; timeout - The timeout to wait for that component; throwExc - True, whether procedure should throw an exception if component didn't appear.
Author:: QFS
Since:: 5.4

Procedure: "waitForComponentForAbsence"

Wait till a given component disappears.

Parameters:: id - The Id of the target component.; timeout - The timeout to wait for that component; throwExc - True, whether procedure should throw an exception if component didn't disappear.
Author:: QFS
Since:: 5.4

Package: "list"

Procedures for accessing lists.

Author:: QFS
Since:: 5.4

	Procedure/Dependency	Description
	clickItemWithDetails	Select a given item by a mouse click on it.
	getIndexOfItem	Return the current index of a given item.
	getItemCount	Return the number of items of a given list.
	getValueOfItem	Return the text of a given item.
	isAtBottom	Check whether we are at the end of the list.
	isAtTop	Check whether we are at the top of the list.
	scroll	Scroll to a particular element in the list.
	scrollByIndex	Scroll to a particular element in the list.
	scrollToBottom	Scroll to the top of the list.
	scrollToTop	Scroll to the top of the list.
	selectItem	Select a given item by a mouse click on it.

Procedure: "clickItemWithDetails"

Select a given item by a mouse click on it. You can specify the coordinates for clicking and all other details of that mouse click.

Parameters:: id - ID of the list.; item - The item.; itemSeparator - Separator to use for the item syntax. Default is @ for text values, also available & for index and % for regexp.; x - The x coordinate for the click, default is empty to click in the middle.; y - The y coordinate for the click, default is empty to click in the middle.; clickCount - Number of clicks. Default is 1. For a double click set this to 2.; modifier - Modifier for mouse key. 16 for right mouse. 4 for left mouse.; hard - True, if hard event should be replayed. Default is false.; popupTrigger - True, if click should open a popup. Default is false.
Author:: QFS
Since:: 5.4

Procedure: "getIndexOfItem"

Return the current index of a given item.

Sample usage: Can be used to determine the numeric index of an item like 'Price'.

Parameters:: id - ID of the list.; item - The item.; itemSeparator - Separator to use for the item syntax. Default is @ for text values, also available & for index and % for regexp.
Returns:: index The current index of the item, which has been read by the 'Fetch Index' node of QF-Test.
Author:: QFS
Since:: 5.4

Procedure: "getItemCount"

Return the number of items of a given list.

Parameters:: id - The component ID of the list.
Returns:: itemCount
Author:: QFS
Since:: 5.4

Procedure: "getValueOfItem"

Return the text of a given item.

Sample usage: Determine the text of the second item.

Parameters:: id - ID of the list.; item - The item.; itemSeparator - Separator to use for the item syntax. Default is @ for text values, also available & for index and % for regexp.
Returns:: value The value of the item.
Author:: QFS
Since:: 5.4

Procedure: "isAtBottom"

Check whether we are at the end of the list.

Parameters:: id - ID of the list.; pixelVisible - Number of pixels that must be visible.; scrollBack - Sometimes QF-Test needs to scroll in order to determine whether a particular list is at the bottom or not. In case QF-Test needed to scroll down but we are not at the bottom, this parameter will determine whether to scroll back.
Author:: QFS
Since:: 5.4

Procedure: "isAtTop"

Check whether we are at the top of the list.

Parameters:: id - ID of the list.; pixelVisible - Number of pixels that must be visible.
Author:: QFS
Since:: 5.4

Procedure: "scroll"

Scroll to a particular element in the list.

Parameters:: id - ID of the list.; item - The item to scroll to.; itemSeparator - The item separator (@, % or &).
Author:: QFS
Since:: 5.4

Procedure: "scrollByIndex"

Scroll to a particular element in the list.

Parameters:: id - ID of the list.; item - The item to scroll to.
Author:: QFS
Since:: 5.4

Procedure: "scrollToBottom"

Scroll to the top of the list.

Parameters:: id - ID of the list.
Author:: QFS
Since:: 5.4

Procedure: "scrollToTop"

Scroll to the top of the list.

Parameters:: id - ID of the list.
Author:: QFS
Since:: 5.4

Procedure: "selectItem"

Select a given item by a mouse click on it.

Parameters:: id - ID of the list.; item - The item.; itemSeparator - Separator to use for the item syntax. Default is @ for text values, also available & for index and % for regexp.; x - The x coordinate for the click, default is empty to click in the middle.; y - The x coordinate for the click, default is empty to click in the middle.
Author:: QFS
Since:: 5.4

Package: "checks"

Procedures for checking a list.

Author:: QFS
Since:: 5.4

	Procedure/Dependency	Description
	checkNumberOfItems	Check the number of items of a given list according to a specified comparison mode.

Procedure: "checkNumberOfItems"

Check the number of items of a given list according to a specified comparison mode.

Sample usage: You can check, that a list has exactly 6 items or that the table has less then 10 items.

Parameters:: id - The id of the list.; compareValue - The comparison value.; compareMode - The comparison mode = or ==, if the compareValue should be equal than the actual amount of items. <, if the compareValue should be greater than the actual amount of items. >, if the compareValue should be less than the actual amount of items. <=, if the compareValue should be greater or equal than the actual amount of items. >=, if the compareValue should be less or equal the actual amount of items. !=, if the compareValue should be not equal the actual amount of items.; errorLevel - The kind of error, which should be logged. Either EXCEPTION, ERROR, WARNING or MESSAGE.; appearInReport - Flag, whether to show check in report, if a message or warning are set as errorLevel. If this is set to 1, the check will be shown in the report.
Exceptions:: UserException, - if wrong comparison mode has been set.
Author:: QFS
Since:: 5.4

Package: "menu"

Procedures to select menu items

Author:: QFS
Since:: 5.4

	Procedure/Dependency	Description
	selectItem	Select an item from a menu.
	selectItemWithCoordinates	Select an item from a menu.

Procedure: "selectItem"

Select an item from a menu.

For example: for the File -> Open action, the component ID of "File" is the menu, and the ID for "Open" is the item.

Parameters:: menu - The id of the menu.; item - The id of menu item.
Author:: QFS
Since:: 5.4

Procedure: "selectItemWithCoordinates"

Select an item from a menu.

For example: for the File -> Open action, the component ID of "File" is the menu, and the ID for "Open" is the item.

Parameters:: menu - The id of the menu.; item - The id of menu item.; menuX - The x coordinate for the click on the menu, default is empty to click in the middle.; menuY - The y coordinate for the click on the menu, default is empty to click in the middle.; itemX - The x coordinate for the click on the item, default is empty to click in the middle.; itemY - The y coordinate for the click on the item, default is empty to click in the middle.
Author:: QFS
Since:: 5.4

Package: "radiobutton"

Procedures to get and set the state of radio buttons.

Author:: QFS
Since:: 5.4

	Procedure/Dependency	Description
	getValue	Return the value of a radio button.
	select	Select a radio button.
	selectWithCoordinates	Select a radio button.

Procedure: "getValue"

Return the value of a radio button. It's either 1, if radio button is selected of 0, if radio button is not selected.

Parameters:: id - ID of the radio button.
Returns:: The state of the checkbox.
Author:: QFS
Since:: 5.4

Procedure: "select"

Select a radio button. If the radio button is already selected, no action is performed.

Parameters:: id - The id of the radio button.
Author:: QFS
Since:: 5.4

Procedure: "selectWithCoordinates"

Select a radio button. If the radio button is already selected, no action is performed. You can specify the coordinates for clicking.

Parameters:: id - The id of the radio button.; x - The x coordinate for the click, default is empty to click in the middle.; y - The y coordinate for the click, default is empty to click in the middle.
Author:: QFS
Since:: 5.4

Package: "swipe"

Packages containing swiping procedures

Author:: QFS
Since:: 5.4

	Procedure/Dependency	Description
	down	Perform a swipe down operation.
	inDirection	Perform a swipe operation.
	left	Perform a swipe left operation.
	right	Perform a swipe right operation.
	up	Perform a swipe up operation.
	withCoordinates	Perform a swipe operation.

Procedure: "down"

Perform a swipe down operation.

Parameters:: id - The QF-Test ID of the component to perform the swipe operation on.; time - The duration of the swipe operation in milli seconds.
Author:: QFS
Since:: 5.4

Procedure: "inDirection"

Perform a swipe operation.

Parameters:: direction - The direction of the swipe. Valid entries: up, down, right, left, upright, up_left, down_right, down_left (and some more, see manual); id - The QF-Test ID of the component to perform the swipe operation on.; time - The duration of the swipe operation in milli seconds.
Author:: QFS
Since:: 5.4

Procedure: "left"

Perform a swipe left operation.

Parameters:: id - The QF-Test ID of the component to perform the swipe operation on.; time - The duration of the swipe operation in milli seconds.
Author:: QFS
Since:: 5.4

Procedure: "right"

Perform a swipe right operation.

Parameters:: id - The QF-Test ID of the component to perform the swipe operation on.; time - The duration of the swipe operation in milli seconds.
Author:: QFS
Since:: 5.4

Procedure: "up"

Perform a swipe up operation.

Parameters:: id - The QF-Test ID of the component to perform the swipe operation on.; time - The duration of the swipe operation in milli seconds.
Author:: QFS
Since:: 5.4

Procedure: "withCoordinates"

Perform a swipe operation.

Parameters:: id - The id the coordinates refer to; startX - The number pixels right of the upper left corner of the id where to start the swipe; startY - The number pixels down from the upper left corner of the id where to start the swipe; swipeHorizontal - The number of pixels covered by the swipe.; swipeVertical - The number of pixels covered by the swipe.; time - The time in which to execute the swipe. With many applications a quick swipe will give the display a momentum which will make the display scroll further than the actual length of the swipe.; steps - The number of steps the swipe is broken down to. If you choose a long time or long distance increase the number of steps to make the movement more fluent.
Author:: QFS
Since:: 5.4

Package: "text"

Procedures to access text fields and text areas.

Author:: QFS
Since:: 5.4

	Procedure/Dependency	Description
	clear	Clear a text field.
	getText	Return the text of a given textfield.
	setText	Set a given text to a given text-field or text-area.
	setTextFromFile	Read the content of a given file and set its content to a given text-field.

Procedure: "clear"

Clear a text field.

Parameters:: id - The id of the text field.
Author:: QFS
Since:: 5.4

Procedure: "getText"

Return the text of a given textfield.

Parameters:: id - ID of the textfield.
Returns:: The text of the textfield. Variables in this string will not be automatically expanded.
Author:: QFS
Since:: 5.4

Procedure: "setText"

Set a given text to a given text-field or text-area.

Parameters:: id - ID of the textfield.; text - text to be set.; append - if this value is set to true, the text will be appended to the current values.; clear - If this value is set to true, the text-field will be cleared before the text given as parameter "text" is inserted.; replaySingleEvents - If this value is set to true, the text will be inserted replaying single events.; newline - the separator sign for marking a linebreak within the text
Author:: QFS
Since:: 5.4

Procedure: "setTextFromFile"

Read the content of a given file and set its content to a given text-field.

Parameters:: id - The id of the text-field to set.; file - The path to the file.; append - If this value is set to true, the text will be appended to the current values.; clear - If this value is set to true, the text-field will be cleared in case an empty string is given as parameter "text".; replaySingleEvents - If this value is set to true, the text will be inserted replaying single events.; newline - the separator sign for marking a linebreak within the text
Author:: QFS
Since:: 5.4

Package: "automac"

Contains procedures to work with native windows on a MacOS system.

All procedures use the Jython libraries automac.py, located in the jython/Lib folder of the current installation. In the libraries there are even more methods for your needs.

Author:: QFS,ue
Since:: 4.4.0

	Procedure/Dependency	Description
	sendKey	Send the given key along with the qualifier to the component having the focus.

Procedure: "sendKey"

Send the given key along with the qualifier to the component having the focus. The application is defined by the global Jython variable "app" set in the procedure "qfs.automac.app.connect", which has to be called before.

Parameters:: qualifier - The qualifier to send along with the key. Valid input: SHIFT, COMMAND, META, ALT or the empty string for no qualifier; key - The key to be send along with the alt key. Valid input: a single letter of the latin alphabet, a digit or values for special keys like ENTER, DELETE, TAB, ESCAPE or F1 to F24.
Author:: QFS,ue
Since:: 4.4.0

Package: "app"

Procedures to start/close/raise a native macOS application.

Author:: QFS
Since:: 4.4.0

	Procedure/Dependency	Description
	close	Close the application.
	connect	Connect to the given application.
	disconnect	Disconnects from the application, which was connected previously with "qfs.automac.app.connect", without closing the application.
	raise	Raise the application.

Procedure: "close"

Close the application. The application defined by the global Jython variable "app" set in the procedure "qfs.automac.app.connect". The procedure deletes the global Jython variable "app".

Parameters:: timeout - Timeout how long to wait till window disappears
Exceptions:: UserException - if the window was not closed
Author:: QFS,ue
Since:: 4.4.0

Procedure: "connect"

Connect to the given application. If the application has not been started yet and either the bundle file or the bundle id is provided the application will be started first. The procedure sets the global jython variable "app".

One of the following parameters needs to be provided:

Parameters:: title - The title of the application window.; processId - The pid as shown by the Activity Monitor.; bundleFile - The bundle file of the application.; bundleId - The bundle id of the application. These are optional:; titleRegexp - Flag to interprete "title" as a regular expression; timeout - Maximum time (in ms) to wait for the application to start. Only relevant if bundleFile or bundleId are provided and the application has to be started.
Author:: QFS,ue
Since:: 4.4.0

Procedure: "disconnect"

Disconnects from the application, which was connected previously with "qfs.automac.app.connect", without closing the application.

Author:: QFS,pb
Since:: 7.1.0

Procedure: "raise"

Raise the application.

The application defined by the global Jython variable "app" set in the procedure "qfs.automac.app.connect". The procedure deletes the global Jython variable "app".

Author:: QFS,ue
Since:: 4.4.0

Package: "checkbox"

Procedures to get and set the state of checkboxes in native macOS applications.

Author:: QFS
Since:: 4.4.0

	Procedure/Dependency	Description
	checkValue	Check the value of the given component.
	deselect	Deselect a checkbox.
	getValue	Return the value of a checkbox.
	select	Select a checkbox.
	set	Set checkbox to the given state.

Procedure: "checkValue"

Check the value of the given component.

Write an error into the run log or throw an exception, if the check fails.

The application in which to look for the GUI element is defined by the global Jython variable "app" set in the procedure "qfs.automac.startApp". In case you specify more than one of the parameters for component recognition all respective attributes of the element have to match.

Parameters:: expectedValue - true if the checkbox should be checked (on), false otherwise.; errorLevel - ERROR or EXCEPTION; label - The attribute "Label" or "AXDescription" of the GUI element.; title - The attribute "Title" or "AXTitle" of the GUI element.; identifier - The attribute "Identifier" or "AXIdentifier" of the GUI element.; role - The attribute "Role" or "AXRole" of the GUI element.; roleType - The attribute "Type" or "AXRoleDescription" of the GUI element.; subrole - The attribute "Subrole" or "AXSubrole" of the GUI element.; index - The index of the GUI element in case more than one element matches the given parameters.; timeout - The time in ms to wait for the component.
Author:: QFS,ue
Since:: 4.4.0

Procedure: "deselect"

Deselect a checkbox. If the checkbox is already deselected, no action is performed.

Parameters:: label - The attribute "Label" or "AXDescription" of the GUI element.; title - The attribute "Title" or "AXTitle" of the GUI element.; identifier - The attribute "Identifier" or "AXIdentifier" of the GUI element.; role - The attribute "Role" or "AXRole" of the GUI element.; roleType - The attribute "Type" or "AXRoleDescription" of the GUI element.; subrole - The attribute "Subrole" or "AXSubrole" of the GUI element.; index - The index of the GUI element in case more than one element matches the given parameters.; timeout - The time in ms to wait for the component.
Author:: QFS,ue
Since:: 4.4.0

Procedure: "getValue"

Return the value of a checkbox. It's either 1 if box is checked or 0 if box is not checked.

Parameters:: label - The attribute "Label" or "AXDescription" of the GUI element.; title - The attribute "Title" or "AXTitle" of the GUI element.; identifier - The attribute "Identifier" or "AXIdentifier" of the GUI element.; role - The attribute "Role" or "AXRole" of the GUI element.; roleType - The attribute "Type" or "AXRoleDescription" of the GUI element.; subrole - The attribute "Subrole" or "AXSubrole" of the GUI element.; index - The index of the GUI element in case more than one element matches the given parameters.; timeout - The time in ms to wait for the component.
Returns:: The state of the checkbox.(1=checked, 0=not checked)
Author:: QFS,ue
Since:: 4.4.0

Procedure: "select"

Select a checkbox. If the checkbox is already selected, no action is performed.

Parameters:: label - The attribute "Label" or "AXDescription" of the GUI element.; title - The attribute "Title" or "AXTitle" of the GUI element.; identifier - The attribute "Identifier" or "AXIdentifier" of the GUI element.; role - The attribute "Role" or "AXRole" of the GUI element.; roleType - The attribute "Type" or "AXRoleDescription" of the GUI element.; subrole - The attribute "Subrole" or "AXSubrole" of the GUI element.; index - The index of the GUI element in case more than one element matches the given parameters.; timeout - The time in ms to wait for the component.
Author:: QFS,ue
Since:: 4.4.0

Procedure: "set"

Set checkbox to the given state.

Parameters:: check - The check value to be set (either true or false).; label - The attribute "Label" or "AXDescription" of the GUI element.; title - The attribute "Title" or "AXTitle" of the GUI element.; identifier - The attribute "Identifier" or "AXIdentifier" of the GUI element.; role - The attribute "Role" or "AXRole" of the GUI element.; roleType - The attribute "Type" or "AXRoleDescription" of the GUI element.; subrole - The attribute "Subrole" or "AXSubrole" of the GUI element.; index - The index of the GUI element in case more than one element matches the given parameters.; timeout - The time in ms to wait for the component.
Author:: QFS,ue
Since:: 4.4.0

Package: "component"

Basic procedures for interacting with a component of a native macOS application.

Author:: QFS
Since:: 4.4.0

	Procedure/Dependency	Description
	checkGeometry	Check the position, width and height of the component on the screen.
	checkImage	Check the image of a given component.
	checkValue	Compare the given value to the value of a component according to the compareMode.
	click	Click a given component.
	getControl	Set the global Jython variable __uiauto_control to the GUI element matching the given parameters.
	getGeometry	Fetch the screen coordinates for the left border, top, width and height for the component.
	getValue	Return the value of the given control.
	setAttribute	Set a given attribute of a component.
	setValue	Set a given value to a component.
	waitForComponent	Set the global variable __uiauto_control to the GUI element matching the given parameters in the given window.

Procedure: "checkGeometry"

Check the position, width and height of the component on the screen.

Parameters:: left - The expected number of pixels from the left border of the screen to the left border of the component. Empty string: skip check.; top - The expected number of pixels from the top of the screen to the top of the component. Empty string: skip check.; width - The expected number of pixels for the width of the component. Empty string: skip check.; height - The expected number of pixels for the height of the component. Empty string: skip check.; errorLevel - The kind of error, which should be logged. Either EXCEPTION, ERROR, WARNING or MESSAGE.; appearInReport - Flag, whether to show check in report, if a message or warning are set as errorLevel. If this is set to 1, the check will be shown in the report.; timeout - The time in ms to wait for the component.; label - The attribute "Label" or "AXDescription" of the GUI element.; title - The attribute "Title" or "AXTitle" of the GUI element.; identifier - The attribute "Identifier" or "AXIdentifier" of the GUI element.; role - The attribute "Role" or "AXRole" of the GUI element.; roleType - The attribute "Type" or "AXRoleDescription" of the GUI element.; subrole - The attribute "Subrole" or "AXSubrole" of the GUI element.; index - The index of the GUI element in case more than one element matches the given parameters.
Author:: QFS,ue
Since:: 4.4.0

Procedure: "checkImage"

Check the image of a given component. The target image has to be provided as PNG file. QF-Test tries to match this image to the image of the component on the screen by using an advanced image check algorithm.

Parameters:: target - An image as PNG file, e.g. C:\temp\target.png; algorithm - The algorithm used for finding the target. Best is to use the default one and adjust match probability if necessary.; best - True means to find the best match. False means to find the first match which is better than the defined probability.; errorLevel - The kind of error to be logged. Either EXCEPTION, ERROR, WARNING or MESSAGE. assumed.; label - The attribute "Label" or "AXDescription" of the GUI element.; title - The attribute "Title" or "AXTitle" of the GUI element.; identifier - The attribute "Identifier" or "AXIdentifier" of the GUI element.; role - The attribute "Role" or "AXRole" of the GUI element.; roleType - The attribute "Type" or "AXRoleDescription" of the GUI element.; subrole - The attribute "Subrole" or "AXSubrole" of the GUI element.; index - The index of the GUI element in case more than one element matches the given parameters.; timeout - The time in ms to wait for the component.
Author:: QFS,ue
Since:: 4.4.0

Procedure: "checkValue"

Compare the given value to the value of a component according to the compareMode.

Parameters:: expectedValue - The expected value.; checkMessage - The message, which should be written into the run log for that check.; compareMode - The comparison mode. = or ==, asserts got == expected <, asserts got < expected >, asserts got > expected <=, asserts got <= expected >=, asserts got >= expected !=, asserts got != expected regexp, the expected value should be treated as a regular expression, that matches the received value. regexpNegate, the expected value should be treated as a regular expression, that doesn't match the received value.; errorLevel - The kind of error, which should be logged. Either EXCEPTION, ERROR, WARNING or MESSAGE.; appearInReport - Flag, whether to show check in report, if a message or warning are set as errorLevel. If this is set to 1, the check will be shown in the report.; label - The attribute "Label" or "AXDescription" of the GUI element.; title - The attribute "Title" or "AXTitle" of the GUI element.; identifier - The attribute "Identifier" or "AXIdentifier" of the GUI element.; role - The attribute "Role" or "AXRole" of the GUI element.; roleType - The attribute "Type" or "AXRoleDescription" of the GUI element.; subrole - The attribute "Subrole" or "AXSubrole" of the GUI element.; index - The index of the GUI element in case more than one element matches the given parameters.; timeout - The time in ms to wait for the component.
Exceptions:: UserException, - if wrong comparison mode has been set.
Author:: QFS,ue
Since:: 4.4.0

Procedure: "click"

Click a given component.

Parameters:: label - The attribute "Label" or "AXDescription" of the GUI element.; title - The attribute "Title" or "AXTitle" of the GUI element.; identifier - The attribute "Identifier" or "AXIdentifier" of the GUI element.; role - The attribute "Role" or "AXRole" of the GUI element.; roleType - The attribute "Type" or "AXRoleDescription" of the GUI element.; subrole - The attribute "Subrole" or "AXSubrole" of the GUI element.; index - The index of the GUI element in case more than one element matches the given parameters.; timeout - The time in ms to wait for the component.
Author:: QFS,ue
Since:: 4.4.0

Procedure: "getControl"

Set the global Jython variable __uiauto_control to the GUI element matching the given parameters. The application in which to look for the GUI element is defined by the global Jython variable "app" set in the procedure "qfs.automac.startApp". In case you specify more than one of the following parameters all respective attributes of the element have to match.

Parameters:: label - The attribute "Label" or "AXDescription" of the GUI element.; title - The attribute "Title" or "AXTitle" of the GUI element.; identifier - The attribute "Identifier" or "AXIdentifier" of the GUI element.; role - The attribute "Role" or "AXRole" of the GUI element.; roleType - The attribute "Type" or "AXRoleDescription" of the GUI element.; subrole - The attribute "Subrole" or "AXSubrole" of the GUI element.; index - The index of the GUI element in case more than one element matches the given parameters.
Author:: QFS,ue
Since:: 4.4.0

Procedure: "getGeometry"

Fetch the screen coordinates for the left border, top, width and height for the component.

Parameters:: label - The attribute "Label" or "AXDescription" of the GUI element.; title - The attribute "Title" or "AXTitle" of the GUI element.; identifier - The attribute "Identifier" or "AXIdentifier" of the GUI element.; role - The attribute "Role" or "AXRole" of the GUI element.; roleType - The attribute "Type" or "AXRoleDescription" of the GUI element.; subrole - The attribute "Subrole" or "AXSubrole" of the GUI element.; index - The index of the GUI element in case more than one element matches the given parameters.; timeout - The time in ms to wait for the component.
Returns:: The geometry data as Geometry object (with a comma-separated list as string value: left,top,width,height).
Author:: QFS,ue
Since:: 4.4.0

Procedure: "getValue"

Return the value of the given control.

Parameters:: label - The attribute "Label" or "AXDescription" of the GUI element.; title - The attribute "Title" or "AXTitle" of the GUI element.; identifier - The attribute "Identifier" or "AXIdentifier" of the GUI element.; role - The attribute "Role" or "AXRole" of the GUI element.; roleType - The attribute "Type" or "AXRoleDescription" of the GUI element.; subrole - The attribute "Subrole" or "AXSubrole" of the GUI element.; index - The index of the GUI element in case more than one element matches the given parameters.; timeout - The time in ms to wait for the component.
Returns:: The value of the component. Variables in this string will not be automatically expanded.
Author:: QFS,ue
Since:: 4.4.0

Procedure: "setAttribute"

Set a given attribute of a component.

Parameters:: attribute - The attribute to be set.; value - The value to be set.; label - The attribute "Label" or "AXDescription" of the GUI element.; title - The attribute "Title" or "AXTitle" of the GUI element.; identifier - The attribute "Identifier" or "AXIdentifier" of the GUI element.; role - The attribute "Role" or "AXRole" of the GUI element.; roleType - The attribute "Type" or "AXRoleDescription" of the GUI element.; subrole - The attribute "Subrole" or "AXSubrole" of the GUI element.; index - The index of the GUI element in case more than one element matches the given parameters.; timeout - The time in ms to wait for the component.
Author:: QFS,ue
Since:: 4.4.0

Procedure: "setValue"

Set a given value to a component.

Parameters:: value - The value to be set.; label - The attribute "Label" or "AXDescription" of the GUI element.; title - The attribute "Title" or "AXTitle" of the GUI element.; identifier - The attribute "Identifier" or "AXIdentifier" of the GUI element.; role - The attribute "Role" or "AXRole" of the GUI element.; roleType - The attribute "Type" or "AXRoleDescription" of the GUI element.; subrole - The attribute "Subrole" or "AXSubrole" of the GUI element.; index - The index of the GUI element in case more than one element matches the given parameters.; timeout - The time in ms to wait for the component.
Author:: QFS,ue
Since:: 4.4.0

Procedure: "waitForComponent"

Set the global variable __uiauto_control to the GUI element matching the given parameters in the given window. Wait for the component for timeout ms at the most.

Parameters:: label - The attribute "Label" or "AXDescription" of the GUI element.; title - The attribute "Title" or "AXTitle" of the GUI element.; identifier - The attribute "Identifier" or "AXIdentifier" of the GUI element.; role - The attribute "Role" or "AXRole" of the GUI element.; roleType - The attribute "Type" or "AXRoleDescription" of the GUI element.; subrole - The attribute "Subrole" or "AXSubrole" of the GUI element.; index - The index of the GUI element in case more than one element matches the given parameters.; timeout - The time in ms to wait for the component.
Exceptions:: ComponentNotFoundException - If the component is not found within the given time.
Author:: QFS,ue
Since:: 4.4.0

Package: "helpers"

Procedures used internally by the package qfs.automac.component.

Author:: QFS
Since:: 4.4.0

	Procedure/Dependency	Description
	checkIfMac	Check if the operation system is MacOS.
	dumpComponent	Print information provided by the Accessibility Interface of the given GUI control to the QF-Test terminal.
	dumpComponents	Print role, role type, subrole, label, title and identifier of the controls in the given application to the QF-Test terminal.
	dumpComponentsToFile	Print role, type, subrole, label, title and identifier of the controls in the given window to a file.
	dumpDesktopWindows	Print the title, process id, bundle id and bundle file of all windows on the desktop of to the QF-Test terminal.

Procedure: "checkIfMac"

Check if the operation system is MacOS. If not throw a user exception.

Parameters:: version - if not empty (default) check if the os version is equal or higher to the given version. valid values: the main verion of the operation system e.g. 9, 10, 11
Author:: QFS,ue
Since:: 4.4.0

Procedure: "dumpComponent"

Print information provided by the Accessibility Interface of the given GUI control to the QF-Test terminal.

Returned information: role, role type, subrole, label, title, identifier and methods.

The application in which to look for the GUI element is defined by the global Jython variable "app" set in the procedure "qfs.automac.startApp". In case you specify more than one of the following parameters all respective attributes of the element have to match.

Parameters:: label - The attribute "Label" or "AXDescription" of the GUI element.; title - The attribute "Title" or "AXTitle" of the GUI element.; identifier - The attribute "Identifier" or "AXIdentifier" of the GUI element.; role - The attribute "Role" or "AXRole" of the GUI element.; roleType - The attribute "Type" or "AXRoleDescription" of the GUI element.; subrole - The attribute "Subrole" or "AXSubrole" of the GUI element.; index - The index of the GUI element in case more than one element matches the given parameters.
Author:: QFS,ue
Since:: 4.4.0

Procedure: "dumpComponents"

Print role, role type, subrole, label, title and identifier of the controls in the given application to the QF-Test terminal. The data is only listed if it is defined in the UIElement automation interface of the respective GUI control.

If the application has not been started yet and either the bundle file or the bundle id is provided the application will be started first. The procedure sets the global jython variable "app".

One of the following parameters needs to be provided.

Parameters:: title - The title of the application window.; processId - The pid as shown by the Activity Monitor.; bundleFile - The bundle file of the application.; bundleId - The bundle id of the application.; maxDepth - Defines to which level the children of nested components are processed. Default: 6
Author:: QFS,ue
Since:: 4.4.0

Procedure: "dumpComponentsToFile"

Print role, type, subrole, label, title and identifier of the controls in the given window to a file. The data is only listed if it is defined in the UIElement accessability interface of the respective GUI control.

If the application has not been started yet and either the bundle file or the bundle id is provided the application will be started first. The procedure sets the global jython variable "app".

One of the following parameters needs to be provided.

Parameters:: title - The title of the application window.; processId - The pid as shown by the Activity Monitor.; bundleFile - The bundle file of the application.; bundleId - The bundle id of the application.; maxDepth - Defines to which level the children of nested components are processed. Default: 6
Author:: QFS,ue
Since:: 4.4.0

Procedure: "dumpDesktopWindows"

Print the title, process id, bundle id and bundle file of all windows on the desktop of to the QF-Test terminal.

Author:: QFS,ue
Since:: 4.4.0

Package: "menu"

Procedures to select menu items and checkbox menu items in native macOS applications.

Author:: QFS
Since:: 4.4.0

	Procedure/Dependency	Description
	selectItem	Select an item from a menu.

Procedure: "selectItem"

Select an item from a menu.

The application in which to look for the GUI element is defined by the global Jython variable "app" set in the procedure "qfs.automac.startApp". In case you specify more than one of the parameters for a component all respective attributes of the element have to match.

Parameters:: menuDescription - The attribute "Label" or "AXDescription" of the menu.; menuTitle - The attribute "Title" or "AXTitle" of the menu.; menuIdentifier - The attribute "Identifier" or "AXIdentifier" of the menu.; menuRole - The attribute "Role" or "AXRole" of the menu.; menuRoleDescription - The attribute "Type" or "AXRoleDescription" of the menu.; menuSubrole - The attribute "Subrole" or "AXSubrole" of the menu.; menuIndex - The index of the menu in case more than one element matches the given parameters.; itemDescription - The attribute "Label" or "AXDescription" of the menu item.; itemTitle - The attribute "Title" or "AXTitle" of the menu item.; itemIdentifier - The attribute "Identifier" or "AXIdentifier" of the menu item.; itemRole - The attribute "Role" or "AXRole" of the menu item.; itemRoleDescription - The attribute "Type" or "AXRoleDescription" of the menu item.; itemSubrole - The attribute "Subrole" or "AXSubrole" of the menu item.; itemIndex - The index of the item in case more than one element matches the given parameters item.; timeout - The time in ms to wait for the component.
Author:: QFS,ue
Since:: 4.4.0

Package: "autoscreen"

Procedures for testing based on images.

Author:: QFS,mh
Since:: 3.5M1

Package: "android"

Procedures to replay events anywhere on an android application based on images.

Author:: QFS,ys
Since:: 7.0.4

	Procedure/Dependency	Description
	clickAtImage	Click at an image anywhere on a Android application.
	getComponentAtImage	Find an image anywhere on an Android application and return the component ID.

Procedure: "clickAtImage"

Click at an image anywhere on a Android application. The target image has to be provided as PNG file. QF-Test tries to find this image on the Android application by using an advanced image check algorithm. The click goes to the middle of the got image unless there are offsets defined. Note: Does only work for currently displayed images without scrolling.

Parameters:: target - An image as PNG file, e.g. C:\temp\target.png; component - A target stage which has been recorded, maybe genericAndroidApp.; componentSearchTimeout - A timeout to find the component.; algorithm - The algorithm used for finding the target. Best is to use the default one and adjust match probability if necessary.; offsetX - If defined use this x-offset instead of middle of got region.; offsetY - If defined use this y-offset instead of middle of got region.; mouseButton - An integer describing the mouse button to click with. A value of 16 will perform a short touch and a value of 4 a long touch.
Exceptions:: UserException - If the target could not be found, an TestException will be thrown.
Author:: QFS,ys
Since:: 7.0.4

Procedure: "getComponentAtImage"

Find an image anywhere on an Android application and return the component ID. The target image has to be provided as PNG file. QF-Test tries to find this image on the Android application by using an advanced image check algorithm. Note: Does only work for currently displayed images without scrolling.

Parameters:: target - An image as PNG file, e.g. C:\temp\target.png; component - A target stage node which has been recorded, maybe genericAndroidApp.; componentSearchTimeout - A timeout to find the component.; algorithm - The algorithm used for finding the target. Best is to use the default one and adjust match probability if necessary.
Returns:: The component ID which represents the found component.
Exceptions:: UserException - If the target could not be found, an TestException will be thrown.
Author:: QFS,ys
Since:: 7.0.4

Package: "fx"

Procedures to replay events anywhere on a JavaFX application based on images.

Author:: QFS,mh
Since:: 4.1.0

	Procedure/Dependency	Description
	clickAtImage	Click at an image anywhere on a JavaFX application.
	getComponentAtImage	Find an image anywhere on a JavaFX application and return the component ID.

Procedure: "clickAtImage"

Click at an image anywhere on a JavaFX application. The target image has to be provided as PNG file. QF-Test tries to find this image on the JavaFX application by using an advanced image check algorithm. The click goes to the middle of the got region unless there are offsets defined. Note: Does only work for currently displayed images without scrolling.

Parameters:: target - An image as PNG file, e.g. C:\temp\target.png; stage - A target stage which has been recorded, maybe genericStage.; algorithm - The algorithm used for finding the target. Best is to use the default one and adjust match probability if necessary.; offsetX - If defined use this x-offset instead of middle of got region.; offsetY - If defined use this y-offset instead of middle of got region.; mouseButton - An integer describing the mouse button to click with. A value of 16 will perform a left and a value of 4 a right click.
Exceptions:: UserException - If the target could not be found, an TestException will be thrown.
Author:: QFS,mh
Since:: 4.1.0

Procedure: "getComponentAtImage"

Find an image anywhere on a JavaFX application and return the component ID. The target image has to be provided as PNG file. QF-Test tries to find this image on the JavaFX application by using an advanced image check algorithm. Note: Does only work for currently displayed images without scrolling.

Parameters:: target - An image as PNG file, e.g. C:\temp\target.png; stage - A target stage node which has been recorded, maybe genericStage.; algorithm - The algorithm used for finding the target. Best is to use the default one and adjust match probability if necessary.
Returns:: The component ID which represents the found component.
Exceptions:: UserException - If the target could not be found, an TestException will be thrown.
Author:: QFS,mh
Since:: 4.1.0

Package: "screen"

Procedures to replay events anywhere on the screen based on images.

Author:: QFS,mh
Since:: 3.5M1

	Procedure/Dependency	Description
	clickAtImage	Click at an image anywhere on the screen.
	getPositionOfImage	Find an image anywhere on the screen and return its position.

Procedure: "clickAtImage"

Click at an image anywhere on the screen. The target image has to be provided as PNG file. QF-Test tries to find this image on the screen by using an advanced image check algorithm. The click goes to the middle of the got region unless there are offsets defined.

Parameters:: target - An image as PNG file, e.g. C:\temp\target.png; x - The start x position of the partial image of the screen. Empty means 0.; y - The start y position of the partial image of the screen. Empty means 0.; width - The width of the partial image of the screen. Empty means maximum width.; height - The height of the partial image of the screen. empty means maximum height.; algorithm - The algorithm used for finding the target. Best is to use the default one and adjust match probability if necessary.; offsetX - If defined use this x-offset instead of middle of got region.; offsetY - If defined use this y-offset instead of middle of got region.; best - True means to find the best match. False means to find the first match which is better than the defined probability.; mouseButton - An integer describing the mouse button to click with. A value of 16 will perform a left and a value of 4 a right click.
Exceptions:: UserException - If the target could not be found, an UserException will be thrown.
Author:: QFS,mh
Since:: 3.5M1

Procedure: "getPositionOfImage"

Find an image anywhere on the screen and return its position. The target image has to be provided as PNG file. QF-Test tries to find this image on the screen by using an advanced image check algorithm.

Parameters:: target - An image as PNG file, e.g. C:\temp\target.png; x - The start x position of the partial image of the screen. Empty means 0.; y - The start y position of the partial image of the screen. Empty means 0.; width - The width of the partial image of the screen. Empty means maximum width.; height - The height of the partial image of the screen. empty means maximum height.; algorithm - The algorithm used for finding the target. Best is to use the default one and adjust match probability if necessary.; best - True means to find the best match. False means to find the first match which is better than the defined probability.
Returns:: The position as list like [x, y].
Exceptions:: UserException - If the target could not be found, an UserException will be thrown.
Author:: QFS,mh
Since:: 3.5M1

Package: "swing"

Procedures to replay events anywhere on a Swing application based on images.

Author:: QFS,mh
Since:: 3.5M1

	Procedure/Dependency	Description
	clickAtImage	Click at an image anywhere on a JFrame of a swing application.
	getComponentAtImage	Find an image anywhere on a JFrame of a Swing application and return the component ID.

Procedure: "clickAtImage"

Click at an image anywhere on a JFrame of a swing application. The target image has to be provided as PNG file. QF-Test tries to find this image on the JFrame by using an advanced image check algorithm. The click goes to the middle of the got region unless there are offsets defined.

Parameters:: target - An image as PNG file, e.g. C:\temp\target.png; frame - A target JFrame which has been recorded, maybe genericJFrame; algorithm - The algorithm used for finding the target. Best is to use the default one and adjust match probability if necessary.; offsetX - If defined use this x-offset instead of middle of got region.; offsetY - If defined use this y-offset instead of middle of got region.; mouseButton - An integer describing the mouse button to click with. A value of 16 will perform a left and a value of 4 a right click.
Exceptions:: UserException - If the target could not be found, an UserException will be thrown.
Author:: QFS,mh
Since:: 3.5M1

Procedure: "getComponentAtImage"

Find an image anywhere on a JFrame of a Swing application and return the component ID. The target image has to be provided as PNG file. QF-Test tries to find this image on the JFrame by using an advanced image check algorithm.

Parameters:: target - An image as PNG file, e.g. C:\temp\target.png; frame - A target JFrame which has been recorded, maybe genericJFrame.; algorithm - The algorithm used for finding the target. Best is to use the default one and adjust match probability if necessary.
Returns:: The component ID which represents the found component.
Exceptions:: UserException - If the target could not be found, an UserException will be thrown.
Author:: QFS,mh
Since:: 3.5M1

Package: "swt"

Procedures to replay events anywhere on a SWT application based on images.

Author:: QFS,mh
Since:: 3.5M1

	Procedure/Dependency	Description
	clickAtImage	Click at an image anywhere on a Shell of a SWT application.
	getComponentAtImage	Find an image anywhere on a Shell of a SWT application and return the component ID.

Procedure: "clickAtImage"

Click at an image anywhere on a Shell of a SWT application. The target image has to be provided as PNG file. QF-Test tries to find this image on the Shell by using an advanced image check algorithm. The click goes to the middle of the got region unless there are offsets defined.

Parameters:: target - An image as PNG file, e.g. C:\temp\target.png; frame - A target Shell which has been recorded, maybe genericShell.; algorithm - The algorithm used for finding the target. Best is to use the default one and adjust match probability if necessary.; offsetX - If defined use this x-offset instead of middle of got region.; offsetY - If defined use this y-offset instead of middle of got region.; mouseButton - An integer describing the mouse button to click with. A value of 16 will perform a left and a value of 4 a right click.
Exceptions:: UserException - If the target could not be found, an UserException will be thrown.
Author:: QFS,mh
Since:: 3.5M1

Procedure: "getComponentAtImage"

Find an image anywhere on a Shell of a SWT application and return the component ID. The target image has to be provided as PNG file. QF-Test tries to find this image on the Shell by using an advanced image check algorithm.

Parameters:: target - An image as PNG file, e.g. C:\temp\target.png; frame - A target Shell which has been recorded, maybe genericShell.; algorithm - The algorithm used for finding the target. Best is to use the default one and adjust match probability if necessary.
Returns:: The component ID which represents the found component.
Exceptions:: UserException - If the target could not be found, an UserException will be thrown.
Author:: QFS,mh
Since:: 3.5M1

Package: "web"

Procedures to replay events anywhere on a Web application based on images.

Author:: QFS,mh
Since:: 3.5M1

	Procedure/Dependency	Description
	clickAtImage	Click at an image anywhere on a web application.
	getComponentAtImage	Find an image anywhere on a web application and return the component ID.

Procedure: "clickAtImage"

Click at an image anywhere on a web application. The target image has to be provided as PNG file. QF-Test tries to find this image on the web application by using an advanced image check algorithm. The click goes to the middle of the got region unless there are offsets defined. Note: Does only work for currently displayed images without scrolling.

Parameters:: target - An image as PNG file, e.g. C:\temp\target.png; webpage - A target web page node which has been recorded, maybe genericDocument.; algorithm - The algorithm used for finding the target. Best is to use the default one and adjust match probability if necessary.; offsetX - If defined use this x-offset instead of middle of got region.; offsetY - If defined use this y-offset instead of middle of got region.; mouseButton - An integer describing the mouse button to click with. A value of 16 will perform a left and a value of 4 a right click.
Exceptions:: UserException - If the target could not be found, an TestException will be thrown.
Author:: QFS,mh
Since:: 3.5M1

Procedure: "getComponentAtImage"

Find an image anywhere on a web application and return the component ID. The target image has to be provided as PNG file. QF-Test tries to find this image on the web application by using an advanced image check algorithm. Note: Does only work for currently displayed images without scrolling.

Parameters:: target - An image as PNG file, e.g. C:\temp\target.png; webpage - A target web page node which has been recorded, maybe genericDocument.; algorithm - The algorithm used for finding the target. Best is to use the default one and adjust match probability if necessary.
Returns:: The component ID which represents the found component.
Exceptions:: UserException - If the target could not be found, an TestException will be thrown.
Author:: QFS,mh
Since:: 3.5M1

Package: "autowin"

Contains procedures to work with native windows of the operating system Windows.

All procedures use the Jython libraries autowin.py and uiauto.py, located in the jython/Lib folder of the current installation. In the libraries there are even more methods for your needs.

Author:: QFS,mm
Since:: 3.1.4

	Procedure/Dependency	Description
	checkForExistence	Check, whether a native window on the operating system Windows is opened.
	checkForExistenceAndClose	Check, whether a native window on the operating system Windows is opened and close it.
	close	Close a window.
	getURLFromIE	Read the URL from an InternetExplorer window.
	logChildWindows	Write all children of a window to the run log.
	logUIAToplevels	This method logs the top-level objects (windows) accessible via the Windows UIAutomation API.
	markAllAndCopy	Perform Ctrl+A and then Ctrl+C to a given window.
	saveTextToFileViaClipboard	Mark and copy the whole text of a given document via Ctrl+A and Ctrl+C.

Procedure: "checkForExistence"

Check, whether a native window on the operating system Windows is opened. If the window is a result of your test you can configure it to provide an error or an exception, if the window does not appear.

Note: It is preferable to make use of QF-Test's ability to control native Windows applications directly, but in simple cases this procedure can still be useful.

Parameters:: title - The title of the window.; titleRegexp - true, if the given title is a regular expression, otherwise false.; timeout - The timeout to wait for the dialog to appear.; errorLevel - MESSAGE if a message should be logged in case the window is not visible. WARNING if a warning should be logged in case the window is not visible. EXCEPTION if an exception should be raised in case the window is not visible. in any other case an error will be logged in case the window is not visible.; appearInReport - set this to 1, if you want to track a message or warning, which should also be part of the report later.
Exceptions:: UserException - if window is not visible and parameter errorLevel is set to EXCEPTION
Author:: QFS,mm
Since:: 3.1.4

Procedure: "checkForExistenceAndClose"

Check, whether a native window on the operating system Windows is opened and close it. If the window is a result of your test you can configure it to provide an error or an exception, if the window does not appear.

Note: It is preferable to make use of QF-Test's ability to control native Windows applications directly, but in simple cases this procedure can still be useful.

Parameters:: title - The title of the window.; titleRegexp - true, if the given title is a regular expression, otherwise false.; timeout - The timeout to wait for the dialog to appear.; errorLevel - MESSAGE if a message should be logged in case the window is not visible. WARNING if a warning should be logged in case the window is not visible. EXCEPTION if an exception should be raised in case the window is not visible. in any other case an error will be logged in case the window is not visible.; appearInReport - set this to 1, if you want to track a message or warning, which should also be part of the report later.; close_timeout - Timeout how long to wait till window disappears after closing.; close_errorLevel - MESSAGE if a message should be logged in case the window wasn't closed. WARNING if a warning should be logged in case the window wasn't closed. EXCEPTION if an exception should be raised in case the window wasn't closed. in any other case an error will be logged in case the window wasn't closed.
Exceptions:: UserException - if window is not visible and parameter errorLevel is set to EXCEPTION or if window hasn't been closed and close_errorLevel is set to EXCEPTION.
Author:: QFS,mm
Since:: 3.1.4

Procedure: "close"

Close a window.

Note: It is preferable to make use of QF-Test's ability to control native Windows applications directly, but in simple cases this procedure can still be useful.

Parameters:: title - The title of the window.; titleRegexp - true, if the given title is a regular expression, otherwise false; appearInReport - set this to 1, if you want to track a message or warning, which should also be part of the report later.; timeout - Timeout how long to wait till window disappears; errorLevel - MESSAGE if a message should be logged in case the window wasn't closed. WARNING if a warning should be logged in case the window wasn't closed. EXCEPTION if an exception should be raised in case the window wasn't closed. in any other case an error will be logged in case the window wasn't closed.
Exceptions:: UserException - if window wasn't closed and parameter errorLevel is set to EXCEPTION
Author:: QFS,mm
Since:: 3.1.4

Procedure: "getURLFromIE"

Deprecated: Internet Explorer 11 has retired and the browser is officially out of support by Microsoft.

Read the URL from an InternetExplorer window.

Note: It is preferable to make use of QF-Test's ability to control native Windows applications directly, but in simple cases this procedure can still be useful.

Parameters:: title - The title of the window.; titleRegexp - true, if the given title is a regular expression, otherwise false.
Exceptions:: UserException - if the browser window is not visible or the URL cannot be determined.
Author:: QFS
Since:: 3.2.0

Procedure: "logChildWindows"

Write all children of a window to the run log.

Note: It is preferable to make use of QF-Test's ability to control native Windows applications directly, but in simple cases this procedure can still be useful.

Parameters:: titleRe - The title of the window as regular expression.
Author:: QFS, rl
Since:: 3.2.0

Procedure: "logUIAToplevels"

This method logs the top-level objects (windows) accessible via the Windows UIAutomation API.

Note: It is preferable to make use of QF-Test's ability to control native Windows applications directly, but in simple cases this procedure can still be useful.

Procedure: "markAllAndCopy"

Deprecated: QF-Test can control native windows applications directly. Most of the time direct control improves test stability over the scripting based approach used by this procedure.

Perform Ctrl+A and then Ctrl+C to a given window.

Afterwards you should have the text in the Clipboard, which enables you to insert the text somewhere for checking.

Parameters:: title - The title of the window.; titleRegexp - true, if the given title is a regular expression, otherwise false.
Exceptions:: UserException - if window is not visible
Author:: QFS,mm,mks
Since:: 3.4.0

Procedure: "saveTextToFileViaClipboard"

Deprecated: QF-Test can control native windows applications directly. Most of the time direct control improves test stability over the scripting based approach used by this procedure.

Mark and copy the whole text of a given document via Ctrl+A and Ctrl+C. Then it fetches the text from the clipboard and saves it into a given file.

Parameters:: fileName - The filename to save.; title - The title of the window.; titleRegexp - true, if the given title is a regular expression, otherwise
Exceptions:: UserException - if window is not visible
Author:: QFS,mm
Since:: 3.4.0

Package: "acrobat"

Deprecated: QF-Test can control native windows applications directly. Most of the time direct control improves test stability over the scripting based approach used by the procedures in this package.

Contain procedures to handle Adobe Acrobat Reader specific tasks like SaveAs or SaveAs Text ...

Author:: QFS,tm
Since:: 3.4.0

	Procedure/Dependency	Description
	saveAsText	Save the current open PDF in Adobe Acrobat Reader as a text file with the given filename.
	savePDF	Save the current open PDF in Adobe Acrobat Reader as a PDF file with the given filename.

Procedure: "saveAsText"

Deprecated: QF-Test can control native windows applications directly. Most of the time direct control improves test stability over the scripting based approach used by this procedure.

Save the current open PDF in Adobe Acrobat Reader as a text file with the given filename. Note: It only 'knows' English and German buttons. Thus currently only the English and German versions of Adobe Acrobat Reader are supported. Logs an error if the file is already existing but parameter overwriteExistingFile is set to false.

Parameters:: fileName - The filename to save.; title - The title of the window.; titleRegexp - true, if the given title is a regular expression, otherwise false.; fileMenuTitle - The title of the file menu.; saveAsTextMenuTitle - The title of the 'save as text' menu item.; dialogTitle - The title of the 'save as...'-dialog.; timeout - Timeout for waiting to complete the save operation.; overwriteExistingFile - If set to true an already existing file gets overwritten; windowtimer - with default 30000 - Timeout for finding the acrobat window and the sub-dialogs.; savetimer - with default 2 - internal timer which is used to determine when the save operation has finished.; enableFunctionsYDiff - The distance in pixel from the bottom of the menu bar to the "Enable all functions" button. In case of scaled ultraHD/4k resolution you might need to increase those value.; enableFunctionsXDiff - The distance in pixel from the right edge of the main window bar to the "Enable all functions" button. In case of scaled ultraHD/4k resolution you might need to increase those value.; useUIAutomation - Whether to use UIAutomation to handle the Acrobat menus.
Exceptions:: UserException - if window is not visible or the file is already existing
Author:: QFS,tm,mks,mm,mh
Since:: 3.4.0

Procedure: "savePDF"

Deprecated: QF-Test can control native windows applications directly. Most of the time direct control improves test stability over the scripting based approach used by this procedure.

Save the current open PDF in Adobe Acrobat Reader as a PDF file with the given filename. Note: It simulates CTRL+SHIFT+S keystrokes to open the file dialog. Logs an error if the file is already existing but parameter overwriteExistingFile is set to false.

Parameters:: fileName - The filename to save.; title - The title of the window.; titleRegexp - true, if the given title is a regular expression, otherwise false.; dialogTitle - The title of the 'save as...'-dialog.; timeout - with default 30000 - Timeout for waiting to complete the save operation.; overwriteExistingFile - If set to true an already existing file gets overwritten; windowtimer - with default 30000 - Timeout for finding the acrobat window and the sub-dialogs.; savetimer - with default 3 - internal timer which is used to determine when the save operation has finished.; inlineDisplay - - set to true if pdf is displayed inline (e.g. inside the browser window)
Exceptions:: UserException - if window is not visible or the file is already existing
Author:: QFS,tm,mks
Since:: 3.4.0

Package: "checkbox"

Procedures to get and set the state of checkboxes in native windows applications.

Author:: QFS
Since:: 4.2.3

	Procedure/Dependency	Description
	checkValue	Check the value of the given component.
	deselect	Deselect a checkbox.
	getValue	Return the value of a checkbox.
	select	Select a checkbox.
	set	Set checkbox to the given state.

Procedure: "checkValue"

Deprecated: QF-Test can control native windows applications directly. Most of the time direct control improves test stability over the scripting based approach used by this procedure.

Check the value of the given component.

Write an error into the run log or throw an exception, if the check fails.

Parameters:: expectedValue - true if the checkbox should be checked (on), false otherwise.; errorLevel - ERROR or EXCEPTION; window - The title of the window containing the GUI element. It has to be a regular expression.; automationId - The AutomationId of the GUI element.; name - The name of the GUI element as a regular expression. Either alone or in combination with controlType or className.; controlType - The ControlType of the GUI element. Can be combined with name or index. If neither name nor index is given then index 0 is assumed. The allowed control types are defined by the IUIAutomationElement Interface. Examples: Button, CheckBox, ComboBox, DataGrid, Edit, List, Tab, Text.; index - The index of the GUI element of the given control type. Only in combination with controlType or className.; className - The class name of the GUI element. Can be combined with name or index. If neither name nor index is given then index 0 is assumed.; timeout - The time in ms to wait for the component.
Parameter precedences:
1. automationId takes precedence over the rest. 2. controlType alone or in combination with name or index takes precedence over the rest. 3. className alone or in combination with name or index takes precedence over name only. 4. name
Author:: QFS,ue
Since:: 4.2.3

Procedure: "deselect"

Deprecated: QF-Test can control native windows applications directly. Most of the time direct control improves test stability over the scripting based approach used by this procedure.

Deselect a checkbox. If the checkbox is already deselected, no action is performed.

Parameters:: window - The title of the window containing the GUI element. It has to be a regular expression.; automationId - The AutomationId of the GUI element.; name - The name of the GUI element as a regular expression. Either alone or in combination with controlType or className.; controlType - The ControlType of the GUI element. Can be combined with name or index. If neither name nor index is given then index 0 is assumed. The allowed control types are defined by the IUIAutomationElement Interface. Examples: Button, CheckBox, ComboBox, DataGrid, Edit, List, Tab, Text.; index - The index of the GUI element of the given control type. Only in combination with controlType or className.; className - The class name of the GUI element. Can be combined with name or index. If neither name nor index is given then index 0 is assumed.; timeout - The time in ms to wait for the component.
Parameter precedences:
1. automationId takes precedence over the rest. 2. controlType alone or in combination with name or index takes precedence over the rest. 3. className alone or in combination with name or index takes precedence over name only. 4. name
Author:: QFS,ue
Since:: 4.2.3

Procedure: "getValue"

Deprecated: QF-Test can control native windows applications directly. Most of the time direct control improves test stability over the scripting based approach used by this procedure.

Return the value of a checkbox. It's either 1 if box is selected or 0 if box is not selected.

Parameters:: window - The title of the window containing the GUI element. It has to be a regular expression.; automationId - The AutomationId of the GUI element.; name - The name of the GUI element as a regular expression. Either alone or in combination with controlType or className.; controlType - The ControlType of the GUI element. Can be combined with name or index. If neither name nor index is given then index 0 is assumed. The allowed control types are defined by the IUIAutomationElement Interface. Examples: Button, CheckBox, ComboBox, DataGrid, Edit, List, Tab, Text.; index - The index of the GUI element of the given control type. Only in combination with controlType or className.; className - The class name of the GUI element. Can be combined with name or index. If neither name nor index is given then index 0 is assumed.; timeout - The time in ms to wait for the component.
Parameter precedences:
1. automationId takes precedence over the rest. 2. controlType alone or in combination with name or index takes precedence over the rest. 3. className alone or in combination with name or index takes precedence over name only. 4. name
Returns:: The state of the checkbox.
Author:: QFS,ue
Since:: 4.2.3

Procedure: "select"

Deprecated: QF-Test can control native windows applications directly. Most of the time direct control improves test stability over the scripting based approach used by this procedure.

Select a checkbox. If the checkbox is already selected, no action is performed.

Parameters:: window - The title of the window containing the GUI element. It has to be a regular expression.; automationId - The AutomationId of the GUI element.; name - The name of the GUI element as a regular expression. Either alone or in combination with controlType or className.; controlType - The ControlType of the GUI element. Can be combined with name or index. If neither name nor index is given then index 0 is assumed. The allowed control types are defined by the IUIAutomationElement Interface. Examples: Button, CheckBox, ComboBox, DataGrid, Edit, List, Tab, Text.; index - The index of the GUI element of the given control type. Only in combination with controlType or className.; className - The class name of the GUI element. Can be combined with name or index. If neither name nor index is given then index 0 is assumed.; timeout - The time in ms to wait for the component.
Parameter precedences:
1. automationId takes precedence over the rest. 2. controlType alone or in combination with name or index takes precedence over the rest. 3. className alone or in combination with name or index takes precedence over name only. 4. name
Author:: QFS,ue
Since:: 4.2.3

Procedure: "set"

Deprecated: QF-Test can control native windows applications directly. Most of the time direct control improves test stability over the scripting based approach used by this procedure.

Set checkbox to the given state.

Parameters:: check - The check value to be set (either true or false).; window - The title of the window containing the GUI element. It has to be a regular expression.; automationId - The AutomationId of the GUI element.; name - The name of the GUI element as a regular expression. Either alone or in combination with controlType or className.; controlType - The ControlType of the GUI element. Can be combined with name or index. If neither name nor index is given then index 0 is assumed. The allowed control types are defined by the IUIAutomationElement Interface. Examples: Button, CheckBox, ComboBox, DataGrid, Edit, List, Tab, Text.; index - The index of the GUI element of the given control type. Only in combination with controlType or className.; className - The class name of the GUI element. Can be combined with name or index. If neither name nor index is given then index 0 is assumed.; timeout - The time in ms to wait for the component.
Parameter precedences:
1. automationId takes precedence over the rest. 2. controlType alone or in combination with name or index takes precedence over the rest. 3. className alone or in combination with name or index takes precedence over name only. 4. name
Author:: QFS,ue
Since:: 4.2.3

Package: "component"

Basic procedures for interacting with a component of a native windows application.

Author:: QFS
Since:: 4.2.3

	Procedure/Dependency	Description
	checkGeometry	Check the position, width and height of the component on the screen.
	checkImage	Check the image of a given component.
	checkName	Compare the given name to the name of a component according to the compareMode.
	checkText	Wrapper procedure to either check the value of a component or, if no value exists, the name.
	checkValue	Compare the given value to the value of a component according to the compareMode.
	click	Click a given component.
	getControl	Set the global variable __uiauto_control to the GUI element matching the given parameters in the given window.
	getGeometry	Fetch the screen coordinates for the left border, top, width and height for the component.
	getName	Return the name of the given control.
	getText	Return the value or, if it does not exist, the name of the given control.
	getValue	Return the value of the given control.
	setText	Set a given text to a component if the method setText() is implemented by the IUIAutomationElement Interface of the component.
	setValue	Set a given value to a component.
	waitForComponent	Set the global variable __uiauto_control to the GUI element matching the given parameters in the given window.

Procedure: "checkGeometry"

Deprecated: QF-Test can control native windows applications directly. Most of the time direct control improves test stability over the scripting based approach used by this procedure.

Check the position, width and height of the component on the screen.

Parameters:: left - The expected number of pixels from the left border of the screen to the left border of the component. Empty string: skip check.; top - The expected number of pixels from the top of the screen to the top of the component. Empty string: skip check.; width - The expected number of pixels for the width of the component. Empty string: skip check.; height - The expected number of pixels for the height of the component. Empty string: skip check.; errorLevel - The kind of error, which should be logged. Either EXCEPTION, ERROR, WARNING or MESSAGE.; appearInReport - Flag, whether to show check in report, if a message or warning are set as errorLevel. If this is set to 1, the check will be shown in the report.; window - The title of the window containing the GUI element. It has to be a regular expression.; automationId - The AutomationId of the GUI element.; name - The name of the GUI element as a regular expression. Either alone or in combination with controlType or className.; controlType - The ControlType of the GUI element. Can be combined with name or index. If neither name nor index is given then index 0 is assumed. The allowed control types are defined by the IUIAutomationElement Interface. Examples: Button, CheckBox, ComboBox, DataGrid, Edit, List, Tab, Text.; index - The index of the GUI element of the given control type. Only in combination with controlType or className.; className - The class name of the GUI element. Can be combined with name or index. If neither name nor index is given then index 0 is assumed.; timeout - The time in ms to wait for the component.
Parameter precedences:
1. automationId takes precedence over the rest. 2. controlType alone or in combination with name or index takes precedence over the rest. 3. className alone or in combination with name or index takes precedence over name only. 4. name
Author:: QFS,ue
Since:: 4.2.3

Procedure: "checkImage"

Deprecated: QF-Test can control native windows applications directly. Most of the time direct control improves test stability over the scripting based approach used by this procedure.

Parameters:: target - An image as PNG file, e.g. C:\temp\target.png; algorithm - The algorithm used for finding the target. Best is to use the default one and adjust match probability if necessary.; best - True means to find the best match. False means to find the first match which is better than the defined probability.; errorLevel - The kind of error to be logged. Either EXCEPTION, ERROR, WARNING or MESSAGE.; window - The title of the window containing the GUI element. It has to be a regular expression.; automationId - The AutomationId of the GUI element.; name - The name of the GUI element as a regular expression. Either alone or in combination with controlType or className.; controlType - The ControlType of the GUI element. Can be combined with name or index. If neither name nor index is given then index 0 is assumed. The allowed control types are defined by the IUIAutomationElement Interface. Examples: Button, CheckBox, ComboBox, DataGrid, Edit, List, Tab, Text.; index - The index of the GUI element of the given control type. Only in combination with controlType or className.; className - The class name of the GUI element. Can be combined with name or index. If neither name nor index is given then index 0 is assumed.; timeout - The time in ms to wait for the component.
Parameter precedences:
1. automationId takes precedence over the rest. 2. controlType alone or in combination with name or index takes precedence over the rest. 3. className alone or in combination with name or index takes precedence over name only. 4. name
Author:: QFS,ue
Since:: 4.2.3

Procedure: "checkName"

Deprecated: QF-Test can control native windows applications directly. Most of the time direct control improves test stability over the scripting based approach used by this procedure.

Compare the given name to the name of a component according to the compareMode.

Parameters:: expectedName - The expected value.; checkMessage - The message, which should be written into the run log for that check.; compareMode - The comparison mode. = or ==, asserts got == expected <, asserts got < expected >, asserts got > expected <=, asserts got <= expected >=, asserts got >= expected !=, asserts got != expected regexp, the expected value should be treated as a regular expression, that matches the received value. regexpNegate, the expected value should be treated as a regular expression, that doesn't match the received value.; errorLevel - The kind of error, which should be logged. Either EXCEPTION, ERROR, WARNING or MESSAGE.; appearInReport - Flag, whether to show check in report, if a message or warning are set as errorLevel. If this is set to 1, the check will be shown in the report.; window - The title of the window containing the GUI element. It has to be a regular expression.; automationId - The AutomationId of the GUI element.; name - The name of the GUI element as a regular expression. Either alone or in combination with controlType or className.; controlType - The ControlType of the GUI element. Can be combined with name or index. If neither name nor index is given then index 0 is assumed. The allowed control types are defined by the IUIAutomationElement Interface. Examples: Button, CheckBox, ComboBox, DataGrid, Edit, List, Tab, Text.; index - The index of the GUI element of the given control type. Only in combination with controlType or className.; className - The class name of the GUI element. Can be combined with name or index. If neither name nor index is given then index 0 is assumed.; timeout - The time in ms to wait for the component.
Parameter precedences:
1. automationId takes precedence over the rest. 2. controlType alone or in combination with name or index takes precedence over the rest. 3. className alone or in combination with name or index takes precedence over name only. 4. name
Exceptions:: UserException, - if wrong comparison mode has been set.
Author:: QFS,ue
Since:: 4.2.3

Procedure: "checkText"

Deprecated: QF-Test can control native windows applications directly. Most of the time direct control improves test stability over the scripting based approach used by this procedure.

Wrapper procedure to either check the value of a component or, if no value exists, the name.

Parameters:: expectedText - The expected text.; checkMessage - The message, which should be written into the run log for that check.; compareMode - The comparison mode. = or ==, asserts got == expected <, asserts got < expected >, asserts got > expected <=, asserts got <= expected >=, asserts got >= expected !=, asserts got != expected regexp, the expected value should be treated as a regular expression, that matches the received value. regexpNegate, the expected value should be treated as a regular expression, that doesn't match the received value.; errorLevel - The kind of error, which should be logged. Either EXCEPTION, ERROR, WARNING or MESSAGE.; appearInReport - Flag, whether to show check in report, if a message or warning are set as errorLevel. If this is set to 1, the check will be shown in the report.; window - The title of the window containing the GUI element. It has to be a regular expression.; automationId - The AutomationId of the GUI element.; name - The name of the GUI element as a regular expression. Either alone or in combination with controlType or className.; controlType - The ControlType of the GUI element. Can be combined with name or index. If neither name nor index is given then index 0 is assumed. The allowed control types are defined by the IUIAutomationElement Interface. Examples: Button, CheckBox, ComboBox, DataGrid, Edit, List, Tab, Text.; index - The index of the GUI element of the given control type. Only in combination with controlType or className.; className - The class name of the GUI element. Can be combined with name or index. If neither name nor index is given then index 0 is assumed.; timeout - The time in ms to wait for the component.
Parameter precedences:
1. automationId takes precedence over the rest. 2. controlType alone or in combination with name or index takes precedence over the rest. 3. className alone or in combination with name or index takes precedence over name only. 4. name
Exceptions:: UserException, - if wrong comparison mode has been set.
Author:: QFS,ue
Since:: 4.2.3

Procedure: "checkValue"

Deprecated: QF-Test can control native windows applications directly. Most of the time direct control improves test stability over the scripting based approach used by this procedure.

Compare the given value to the value of a component according to the compareMode.

Parameters:: expectedValue - The expected value.; checkMessage - The message, which should be written into the run log for that check.; compareMode - The comparison mode. = or ==, asserts got == expected <, asserts got < expected >, asserts got > expected <=, asserts got <= expected >=, asserts got >= expected !=, asserts got != expected regexp, the expected value should be treated as a regular expression, that matches the received value. regexpNegate, the expected value should be treated as a regular expression, that doesn't match the received value.; errorLevel - The kind of error, which should be logged. Either EXCEPTION, ERROR, WARNING or MESSAGE.; appearInReport - Flag, whether to show check in report, if a message or warning are set as errorLevel. If this is set to 1, the check will be shown in the report.; window - The title of the window containing the GUI element. It has to be a regular expression.; automationId - The AutomationId of the GUI element.; name - The name of the GUI element as a regular expression. Either alone or in combination with controlType or className.; controlType - The ControlType of the GUI element. Can be combined with name or index. If neither name nor index is given then index 0 is assumed. The allowed control types are defined by the IUIAutomationElement Interface. Examples: Button, CheckBox, ComboBox, DataGrid, Edit, List, Tab, Text.; index - The index of the GUI element of the given control type. Only in combination with controlType or className.; className - The class name of the GUI element. Can be combined with name or index. If neither name nor index is given then index 0 is assumed.; timeout - The time in ms to wait for the component.
Parameter precedences:
1. automationId takes precedence over the rest. 2. controlType alone or in combination with name or index takes precedence over the rest. 3. className alone or in combination with name or index takes precedence over name only. 4. name
Exceptions:: UserException, - if wrong comparison mode has been set.
Author:: QFS,ue
Since:: 4.2.3

Procedure: "click"

Deprecated: QF-Test can control native windows applications directly. Most of the time direct control improves test stability over the scripting based approach used by this procedure.

Click a given component.

Parameters:: window - The title of the window containing the GUI element. It has to be a regular expression.; automationId - The AutomationId of the GUI element.; name - The name of the GUI element as a regular expression. Either alone or in combination with controlType or className.; controlType - The ControlType of the GUI element. Can be combined with name or index. If neither name nor index is given then index 0 is assumed. The allowed control types are defined by the IUIAutomationElement Interface. Examples: Button, CheckBox, ComboBox, DataGrid, Edit, List, Tab, Text.; index - The index of the GUI element of the given control type. Only in combination with controlType or className.; className - The class name of the GUI element. Can be combined with name or index. If neither name nor index is given then index 0 is assumed.; timeout - The time in ms to wait for the component.
Parameter precedences:
1. automationId takes precedence over the rest. 2. controlType alone or in combination with name or index takes precedence over the rest. 3. className alone or in combination with name or index takes precedence over name only. 4. name
Author:: QFS,ue
Since:: 4.2.3

Procedure: "getControl"

Deprecated: QF-Test can control native windows applications directly. Most of the time direct control improves test stability over the scripting based approach used by this procedure.

Set the global variable __uiauto_control to the GUI element matching the given parameters in the given window.

Parameters:: window - The title of the window containing the GUI element. It has to be a regular expression.; automationId - The AutomationId of the GUI element.; name - The name of the GUI element as a regular expression. Either alone or in combination with controlType or className.; controlType - The ControlType of the GUI element. Can be combined with name or index. If neither name nor index is given then index 0 is assumed. The allowed control types are defined by the IUIAutomationElement Interface. Examples: Button, CheckBox, ComboBox, DataGrid, Edit, List, Tab, Text.; index - The index of the GUI element of the given control type. Only in combination with controlType or className.; className - The class name of the GUI element. Can be combined with name or index. If neither name nor index is given then index 0 is assumed.
Parameter precedences:
1. automationId takes precedence over the rest. 2. controlType alone or in combination with name or index takes precedence over the rest. 3. className alone or in combination with name or index takes precedence over name only. 4. name
Author:: QFS,ue
Since:: 4.2.3

Procedure: "getGeometry"

Deprecated: QF-Test can control native windows applications directly. Most of the time direct control improves test stability over the scripting based approach used by this procedure.

Fetch the screen coordinates for the left border, top, width and height for the component.

Parameters:: window - The title of the window containing the GUI element. It has to be a regular expression.; automationId - The AutomationId of the GUI element.; name - The name of the GUI element as a regular expression. Either alone or in combination with controlType or className.; controlType - The ControlType of the GUI element. Can be combined with name or index. If neither name nor index is given then index 0 is assumed. The allowed control types are defined by the IUIAutomationElement Interface. Examples: Button, CheckBox, ComboBox, DataGrid, Edit, List, Tab, Text.; index - The index of the GUI element of the given control type. Only in combination with controlType or className.; className - The class name of the GUI element. Can be combined with name or index. If neither name nor index is given then index 0 is assumed.; timeout - The time in ms to wait for the component.
Parameter precedences:
1. automationId takes precedence over the rest. 2. controlType alone or in combination with name or index takes precedence over the rest. 3. className alone or in combination with name or index takes precedence over name only. 4. name
Returns:: The geometry data as Geometry object (with a comma-separated list as string value: left,top,width,height).
Author:: QFS,ue
Since:: 4.2.3

Procedure: "getName"

Deprecated: QF-Test can control native windows applications directly. Most of the time direct control improves test stability over the scripting based approach used by this procedure.

Return the name of the given control.

Parameters:: window - The title of the window containing the GUI element. It has to be a regular expression.; automationId - The AutomationId of the GUI element.; name - The name of the GUI element as a regular expression. Either alone or in combination with controlType or className.; controlType - The ControlType of the GUI element. Can be combined with name or index. If neither name nor index is given then index 0 is assumed. The allowed control types are defined by the IUIAutomationElement Interface. Examples: Button, CheckBox, ComboBox, DataGrid, Edit, List, Tab, Text.; index - The index of the GUI element of the given control type. Only in combination with controlType or className.; className - The class name of the GUI element. Can be combined with name or index. If neither name nor index is given then index 0 is assumed.; timeout - The time in ms to wait for the component.
Parameter precedences:
1. automationId takes precedence over the rest. 2. controlType alone or in combination with name or index takes precedence over the rest. 3. className alone or in combination with name or index takes precedence over name only. 4. name
Returns:: The name of the component.
Author:: QFS,ue
Since:: 4.2.3

Procedure: "getText"

Deprecated: QF-Test can control native windows applications directly. Most of the time direct control improves test stability over the scripting based approach used by this procedure.

Return the value or, if it does not exist, the name of the given control.

Parameters:: window - The title of the window containing the GUI element. It has to be a regular expression.; automationId - The AutomationId of the GUI element.; name - The name of the GUI element as a regular expression. Either alone or in combination with controlType or className.; controlType - The ControlType of the GUI element. Can be combined with name or index. If neither name nor index is given then index 0 is assumed. The allowed control types are defined by the IUIAutomationElement Interface. Examples: Button, CheckBox, ComboBox, DataGrid, Edit, List, Tab, Text.; index - The index of the GUI element of the given control type. Only in combination with controlType or className.; className - The class name of the GUI element. Can be combined with name or index. If neither name nor index is given then index 0 is assumed.; timeout - The time in ms to wait for the component.
Parameter precedences:
1. automationId takes precedence over the rest. 2. controlType alone or in combination with name or index takes precedence over the rest. 3. className alone or in combination with name or index takes precedence over name only. 4. name
Returns:: The value or name of the component. Variables in this string will not be automatically expanded.
Author:: QFS,ue
Since:: 4.2.3

Procedure: "getValue"

Deprecated: QF-Test can control native windows applications directly. Most of the time direct control improves test stability over the scripting based approach used by this procedure.

Return the value of the given control.

Parameters:: window - The title of the window containing the GUI element. It has to be a regular expression.; automationId - The AutomationId of the GUI element.; name - The name of the GUI element as a regular expression. Either alone or in combination with controlType or className.; controlType - The ControlType of the GUI element. Can be combined with name or index. If neither name nor index is given then index 0 is assumed. The allowed control types are defined by the IUIAutomationElement Interface. Examples: Button, CheckBox, ComboBox, DataGrid, Edit, List, Tab, Text.; index - The index of the GUI element of the given control type. Only in combination with controlType or className.; className - The class name of the GUI element. Can be combined with name or index. If neither name nor index is given then index 0 is assumed.; timeout - The time in ms to wait for the component.
Parameter precedences:
1. automationId takes precedence over the rest. 2. controlType alone or in combination with name or index takes precedence over the rest. 3. className alone or in combination with name or index takes precedence over name only. 4. name
Returns:: The value of the component.
Author:: QFS,ue
Since:: 4.2.3

Procedure: "setText"

Deprecated: QF-Test can control native windows applications directly. Most of the time direct control improves test stability over the scripting based approach used by this procedure.

Set a given text to a component if the method setText() is implemented by the IUIAutomationElement Interface of the component. If not try setValue() instead.

Parameters:: text - Text to be set.; window - The title of the window containing the GUI element. It has to be a regular expression.; automationId - The AutomationId of the GUI element.; name - The name of the GUI element as a regular expression. Either alone or in combination with controlType or className.; controlType - The ControlType of the GUI element. Can be combined with name or index. If neither name nor index is given then index 0 is assumed. The allowed control types are defined by the IUIAutomationElement Interface. Examples: Button, CheckBox, ComboBox, DataGrid, Edit, List, Tab, Text.; index - The index of the GUI element of the given control type. Only in combination with controlType or className.; className - The class name of the GUI element. Can be combined with name or index. If neither name nor index is given then index 0 is assumed.; timeout - The time in ms to wait for the component.
Parameter precedences:
1. automationId takes precedence over the rest. 2. controlType alone or in combination with name or index takes precedence over the rest. 3. className alone or in combination with name or index takes precedence over name only. 4. name
Author:: QFS,ue
Since:: 4.2.3

Procedure: "setValue"

Deprecated: QF-Test can control native windows applications directly. Most of the time direct control improves test stability over the scripting based approach used by this procedure.

Set a given value to a component.

Parameters:: value - The value to be set.; window - The title of the window containing the GUI element. It has to be a regular expression.; automationId - The AutomationId of the GUI element.; name - The name of the GUI element as a regular expression. Either alone or in combination with controlType or className.; controlType - The ControlType of the GUI element. Can be combined with name or index. If neither name nor index is given then index 0 is assumed. The allowed control types are defined by the IUIAutomationElement Interface. Examples: Button, CheckBox, ComboBox, DataGrid, Edit, List, Tab, Text.; index - The index of the GUI element of the given control type. Only in combination with controlType or className.; className - The class name of the GUI element. Can be combined with name or index. If neither name nor index is given then index 0 is assumed.; timeout - The time in ms to wait for the component.
Parameter precedences:
1. automationId takes precedence over the rest. 2. controlType alone or in combination with name or index takes precedence over the rest. 3. className alone or in combination with name or index takes precedence over name only. 4. name
Author:: QFS,ue
Since:: 4.2.3

Procedure: "waitForComponent"

Deprecated: QF-Test can control native windows applications directly. Most of the time direct control improves test stability over the scripting based approach used by this procedure.

Set the global variable __uiauto_control to the GUI element matching the given parameters in the given window. Wait for the component for timeout ms at the most.

Parameters:: window - The title of the window containing the GUI element. It has to be a regular expression.; automationId - The AutomationId of the GUI element.; name - The name of the GUI element as a regular expression. Either alone or in combination with controlType or className.; controlType - The ControlType of the GUI element. Can be combined with name or index. If neither name nor index is given then index 0 is assumed. The allowed control types are defined by the IUIAutomationElement Interface. Examples: Button, CheckBox, ComboBox, DataGrid, Edit, List, Tab, Text.; index - The index of the GUI element of the given control type. Only in combination with controlType or className.; className - The class name of the GUI element. Can be combined with name or index. If neither name nor index is given then index 0 is assumed.; timeout - The time in ms to wait for the component.
Exceptions:: ComponentNotFoundException - If the component is not found within the given time.
Parameter precedences:
1. automationId takes precedence over the rest. 2. controlType alone or in combination with name or index takes precedence over the rest. 3. className alone or in combination with name or index takes precedence over name only. 4. name
Author:: QFS,ue
Since:: 4.2.3

Package: "dependencies"

Dependencies for starting/stopping a native windows application.

Author:: QFS
Since:: 4.2.3

	Procedure/Dependency	Description
	SUT_started	Start a native windows application as the SUT (system under test) using the dependency funtionality.

Dependency: "SUT_started"

Deprecated: QF-Test can control native windows applications directly. Most of the time direct control improves test stability over the scripting based approach used by this procedure.

Start a native windows application as the SUT (system under test) using the dependency funtionality. This implies stopping the SUT when a different dependency is called or when the value of one of the characteristic variables (dialogtitle, executable, path, titleRegexp) changes as compared to the last time the dependency was called. For more information about dependencies please refer to the tutorial or the the manual, chapter 'Organizing the test suite', section 'Dependency nodes'.

When starting the application you can specify via the parameter checkOutput that QF-Test retrieves the output written by the application to standard out during startup and compare it to the given expected output.

The global variable "window" is set to the dialogtitle. In the cleanup sequence it will be deleted again.

Parameters:: executable - The fully qualified name of the native windows application to be started. Instead of the fully qualified name you may also specify a path relative to the test suite.; workdir - The working directory for the application.; dialogtitle - The title of the application window when it is first started.; titleRegexp - True (default) if the dialogtitle is specified as a regular expression, false otherwise. For more details on regular expressions please refer to the respective in the manual.; expectedOutput - The output that ought to appear in standard out during startup of the application. The parameter is only evaluated if the parameter checkOutput is set to true.; checkOutput - See above.
Author:: QFS,ue
Since:: 4.2.3

Package: "helpers"

Procedures used internally by the package qfs.autowin.component.

Author:: QFS
Since:: 4.2.3

	Procedure/Dependency	Description
	checkIfWindows	Check if the operation system is Microsoft Windows.
	dumpComponent	Print information provided by the IUIAutomationElement Interface of the given GUI control to the QF-Test terminal.
	dumpComponents	Print name, class name, control type and automation id of controls in the given windows to the QF-Test terminal.
	dumpComponentsToFile	Write name, class name, control type and automation id of controls in the given windows to a file.
	dumpDesktopWindows	Print the titles of all windows on the desktop of Microsoft Windows to the QF-Test terminal.
	setWindowToForeground	Set the window with the given title to the foreground on the desktop.

Procedure: "checkIfWindows"

Check if the operation system is Microsoft Windows. If not throw a user exception.

Note: It is preferable to make use of QF-Test's ability to control native Windows applications directly, but in simple cases this procedure can still be useful.

Parameters:: version - if not empty (default) check if the os version is equal or higher to the given version. valid values: the main version of the operating system e.g. 9, 10, 11
Author:: QFS,ue
Since:: 4.2.4

Procedure: "dumpComponent"

Print information provided by the IUIAutomationElement Interface of the given GUI control to the QF-Test terminal.

Returned information: name, value, clickable point, class name, bounding rectangle, control type, automation id and methods.

Note: It is preferable to make use of QF-Test's ability to control native Windows applications directly, but in simple cases this procedure can still be useful.

Author:: QFS,ue
Since:: 4.2.3

Procedure: "dumpComponents"

Print name, class name, control type and automation id of controls in the given windows to the QF-Test terminal. The data is only listed if it is defined in the IUIAutomationElement Interface of the respective GUI control.

Note: It is preferable to make use of QF-Test's ability to control native Windows applications directly, but in simple cases this procedure can still be useful.

Parameters:: window - The title of the window containing the GUI element. It has to be a regular expression.; maxDepth - Defines to which level the children of nested components are processed. Default: 6
Author:: QFS,ue
Since:: 4.2.3

Procedure: "dumpComponentsToFile"

Write name, class name, control type and automation id of controls in the given windows to a file. The data is only listed if it is defined in the IUIAutomationElement Interface of the respective GUI control.

Note: It is preferable to make use of QF-Test's ability to control native Windows applications directly, but in simple cases this procedure can still be useful.

Parameters:: window - The title of the window containing the GUI element. It has to be a regular expression.; maxDepth - Defines to which level the children of nested components are processed. Default: 6; file - The file where to write the data to. Either a fully qualified file name or with a path relative to the test suite.
Author:: QFS,ue
Since:: 4.2.3

Procedure: "dumpDesktopWindows"

Print the titles of all windows on the desktop of Microsoft Windows to the QF-Test terminal.

Note: It is preferable to make use of QF-Test's ability to control native Windows applications directly, but in simple cases this procedure can still be useful.

Author:: QFS,ue
Since:: 4.2.3

Procedure: "setWindowToForeground"

Set the window with the given title to the foreground on the desktop.

Parameters:: title - The title of the window.; titleRegexp - true, if the given title is a regular expression, otherwise false.
Exceptions:: ComponentNotFoundException - if the window is not found
Author:: QFS,ue
Since:: 4.2.3

Package: "keyevents"

Procedures for replaying key events to a windows application.

Author:: QFS
Since:: 4.2.3

	Procedure/Dependency	Description
	pressCtrlA	Perform Ctrl+a to the given window to mark all text of the compontent which has the focus.
	pressCtrlV	Perform Ctrl+v to the given window to paste the content of the clipboard to the component with the focus.
	pressCtrlX	Perform Ctrl+x to the given window to cut the selected content of the component with the focus.
	pressDelete	Replay DELETE to the given window.
	pressEnter	Replay ENTER to the given window.
	pressTab	Replay TAB to the given window.
	sendKey	Send the given key along with the qualifier to the window with the given title.

Procedure: "pressCtrlA"

Deprecated: QF-Test can control native windows applications directly. Most of the time direct control improves test stability over the scripting based approach used by this procedure.

Perform Ctrl+a to the given window to mark all text of the compontent which has the focus.

Parameters:: title - The title of the window.; titleRegexp - true, if the given title is a regular expression, otherwise false.
Exceptions:: ComponentNotFoundException - if window is not found
Author:: QFS,ue
Since:: 4.2.3

Procedure: "pressCtrlV"

Deprecated: QF-Test can control native windows applications directly. Most of the time direct control improves test stability over the scripting based approach used by this procedure.

Perform Ctrl+v to the given window to paste the content of the clipboard to the component with the focus.

Parameters:: title - The title of the window.; titleRegexp - true, if the given title is a regular expression, otherwise false.
Exceptions:: ComponentNotFoundException - if window is not found
Author:: QFS,ue
Since:: 4.2.3

Procedure: "pressCtrlX"

Deprecated: QF-Test can control native windows applications directly. Most of the time direct control improves test stability over the scripting based approach used by this procedure.

Perform Ctrl+x to the given window to cut the selected content of the component with the focus.

Parameters:: title - The title of the window.; titleRegexp - true, if the given title is a regular expression, otherwise false.
Exceptions:: ComponentNotFoundException - if window is not found
Author:: QFS,ue
Since:: 4.2

Procedure: "pressDelete"

Deprecated: QF-Test can control native windows applications directly. Most of the time direct control improves test stability over the scripting based approach used by this procedure.

Replay DELETE to the given window.

Parameters:: title - The title of the window.; titleRegexp - true, if the given title is a regular expression, otherwise false.
Exceptions:: ComponentNotFoundException - if window is not found
Author:: QFS,ue
Since:: 4.2.3

Procedure: "pressEnter"

Deprecated: QF-Test can control native windows applications directly. Most of the time direct control improves test stability over the scripting based approach used by this procedure.

Replay ENTER to the given window.

Parameters:: title - The title of the window.; titleRegexp - true, if the given title is a regular expression, otherwise false.
Exceptions:: ComponentNotFoundException - if window is not found
Author:: QFS,ue
Since:: 4.2.3

Procedure: "pressTab"

Deprecated: QF-Test can control native windows applications directly. Most of the time direct control improves test stability over the scripting based approach used by this procedure.

Replay TAB to the given window.

Parameters:: title - The title of the window.; titleRegexp - true, if the given title is a regular expression, otherwise false.
Exceptions:: ComponentNotFoundException - if window is not found
Author:: QFS,ue
Since:: 4.2.3

Procedure: "sendKey"

Send the given key along with the qualifier to the window with the given title.

Parameters:: title - The title of the window.; titleRegexp - true, if the given title is a regular expression, otherwise false.; qualifier - The qualifier to send along with the key. Valid input: SHIFT, CTRL, ALT or the empty string for no qualifier; key - The key to be send along with the alt key. Valid input: a single letter of the latin alphabet, a digit or values for special keys like ENTER, DELETE, TAB, ESCAPE or F1 to F24.
Exceptions:: ComponentNotFoundException - if window is not visible
Author:: QFS,ue
Since:: 4.2.3

Package: "menu"

Procedures to select menu items and checkbox menu items in native windows applications.

Author:: QFS
Since:: 4.2.3

	Procedure/Dependency	Description
	selectItem	Select an item from a menu.

Procedure: "selectItem"

Deprecated: QF-Test can control native windows applications directly. Most of the time direct control improves test stability over the scripting based approach used by this procedure.

Select an item from a menu.

Parameters:: window - The title of the window containing the GUI element. It has to be a regular expression.; menuAutomationId - The AutomationId of the GUI element.; menuName - The name of the GUI element as a regular expression. Either alone or in combination with controlType or className.; menuControlType - The ControlType of the GUI element. Can be combined with name or index. If neither name nor index is given then index 0 is assumed. The allowed control types are defined by the IUIAutomationElement Interface. Examples: Button, CheckBox, ComboBox, DataGrid, Edit, List, Tab, Text.; menuIndex - The index of the GUI element of the given control type. Only in combination with controlType or className.; menuClassName - The class name of the GUI element. Can be combined with name or index. If neither name nor index is given then index 0 is assumed.; itemAutomationId - The AutomationId of the GUI element.; itemName - The name of the GUI element as a regular expression. Either alone or in combination with controlType or className.; itemControlType - The ControlType of the GUI element. Can be combined with name or index. If neither name nor index is given then index 0 is assumed. The allowed control types are defined by the IUIAutomationElement Interface. Examples: Button, CheckBox, ComboBox, DataGrid, Edit, List, Tab, Text.; itemIndex - The index of the GUI element of the given control type. Only in combination with controlType or className.; itemClassName - The class name of the GUI element. Can be combined with name or index. If neither name nor index is given then index 0 is assumed.; timeout - The time in ms to wait for the component.
Parameter precedences:
1. automationId takes precedence over the rest. 2. controlType alone or in combination with name or index takes precedence over the rest. 3. className alone or in combination with name or index takes precedence over name only. 4. name
Author:: QFS,ue
Since:: 4.2.3

Package: "awt"

Procedures for advanced manipulation of awt components.

Author:: QFS
Since:: 2.1.0

Package: "menu"

Procedures to select menu items.

(AWT components java.awt.MenuItem from java.awt.Menu)

Plain AWT Menus are not supported by QF-Test out of the box, but you can use the procedures of this package to work with those menus.

Author:: QFS
Since:: 2.1.0

	Procedure/Dependency	Description
	selectItem	Select an item from a menu.
	selectItemWithSubMenu	Select an item from a menu.
	setCheckItem	Select a checkbox item from a menu.
	setSubCheckItem	Select a checkbox item from a menu in a submenu.

Procedure: "selectItem"

Select an item from a menu.

For example: for the "File" -> "Open" action, the label of "File" is the menu, and the label for "Open" is the item.

Parameters:: client - The name of the SUT client.; frame - The id of the frame, which contains the menu.; menu - The label of the menu, e.g. "File".; item - The label of menu item, e.g. "Open".
Author:: QFS
Since:: 2.1.0

Procedure: "selectItemWithSubMenu"

Select an item from a menu.

For example: for the "File" -> "Save as" -> "File" action, the label of "File" is the menu, the label for submenu is "Save as", and the label of "Open" is the item.

Parameters:: client - The name of the SUT client.; frame - The id of the frame, which contains the menu.; menu - The label of the menu, e.g. "File".; submenu - The label of the submenu, e.g. "Save as".; item - The label of menu item, e.g. "Open".
Author:: QFS,mm
Since:: 4.0

Procedure: "setCheckItem"

Select a checkbox item from a menu.

For example: for the "File" -> "Open" action, the label of "File" is the menu, and the label for "Open" is the item.

Parameters:: client - The name of the SUT client.; frame - The id of the frame, which contains the menu.; menu - The label of the menu, e.g. "File".; checkItem - The label of menu item, e.g. "Open".; checkItemValue - The check item value to be set - 'true' to select the checkbox item (default), 'false' to deselect.
Author:: QFS
Since:: 4.0

Procedure: "setSubCheckItem"

Select a checkbox item from a menu in a submenu.

For example: for the "File" -> "Save as" -> "File" action, the label of "File" is the menu, the label for submenu is "Save as", and the label of "Open" is the item.

Parameters:: client - The name of the SUT client.; frame - The id of the frame, which contains the menu.; menu - The label of the menu, e.g. "File".; submenu - The label of the submenu, e.g. "Save as".; subCheckItem - The label of menu item, e.g. "Open".; subCheckItemValue - The checkbox item value to be set - "true" to select the checkbox item (default), "false" to deselect.
Author:: QFS,mm
Since:: 4.0

Package: "check"

Procedures for checking components or comparing various kinds of values.

Author:: QFS,mm
Since:: 2.1.0

	Procedure/Dependency	Description
	checkEnabledStatus	Check the state of a given component.
	checkImageAgainstFile	Check image of a component against a file.
	checkObjectToBeEqual	Compare two Objects for their equality.
	checkSelectedStatus	Check if given component is selected.
	checkText	Check the text of a given component.
	checkValueInRange	Check whether a value is in a given range.
	checkValueToBeEqual	Compare two string values for their equality.
	compareDates	Compare two date strings.
	compareTwoNumbers	Compare two values for their equality.
	compareTwoStringValues	Compare two values for their equality.

Procedure: "checkEnabledStatus"

Check the state of a given component.

It writes an error into the run log, if the check fails.

Parameters:: id - ID of the component.; enabled - true, if component should be enabled. otherwise, if component should be disabled.; throwExc - whether the check should throw an exception on failure.; reportName - the Name for the check in the report.; timeout - Timeout for the checked condition to happen.
Author:: QFS,mm
Since:: 2.1.0

Procedure: "checkImageAgainstFile"

Check image of a component against a file.

It writes an error into the run log, if the check fails.

Parameters:: id - ID of the component.; file - The full path to the expected file.; algorithm - If an algorithm is defined, use it. If empty, execute a classic check.; checkMessage - The message, which should be written into the run log for that check.; errorLevel - The kind of error, which should be logged. Either EXCEPTION, ERROR, WARNING or MESSAGE.; appearInReport - Flag, whether to show check in report, if a message or warning are set as errorLevel. If this is set to 1, the check will be shown in the report.; guiengine - The name of the GUI engine to run the SUTscript, e.g. awt, swt, web. Can be empty, if you work with one engine at the same time.
Author:: QFS,mh
Since:: 3.4.9

Procedure: "checkObjectToBeEqual"

Compare two Objects for their equality.

It uses the rc.checkEqual() method from QF-Test.

Parameters:: got - The got Object for comparison.; expected - The expected Object for comparison.; checkMessage - The message, which should be written into the run log for that check.; errorLevel - The kind of error, which should be logged. Either EXCEPTION, ERROR, WARNING or MESSAGE.; appearInReport - Flag, whether to show check in report, if a message or warning are set as errorLevel. If this is set to 1, the check will be shown in the report.
Author:: QFS,msc
Since:: 9.0

Procedure: "checkSelectedStatus"

Check if given component is selected.

It writes an error into the run log, if the check fails.

Parameters:: id - ID of the component.; selected - true, if component should be selected. otherwise, if component shouldn't be selected.; throwExc - whether the check should throw an exception on failure.; reportName - the Name for the check in the report.; timeout - Timeout for the checked condition to happen.
Author:: QFS,mm
Since:: 2.1.0

Procedure: "checkText"

Check the text of a given component.

It writes an error into the run log, if the check fails.

Parameters:: id - ID of the component.; text - text, which should be checked.; regexp - if this value is set to true, the text will be checks as regular expression.; negate - if, the check should check for anything but the given text.; nameCheckType - the value for "name of check type" attribute.; throwExc - whether the check should throw an exception on failure.; reportName - the Name for the check in the report.; timeout - Timeout for the checked condition to happen.
Author:: QFS,mm
Since:: 2.1.0

Procedure: "checkValueInRange"

Check whether a value is in a given range.

Parameters:: value - The value to check.; minimum - The minimum of the range.; maximum - The maximum of the range.; includingMinimum - If minimum itself is ok.; includingMaximum - If maximum itself is ok.; checkMessage - The message, which should be written into the run log for that check.; errorLevel - The kind of error, which should be logged. Either EXCEPTION, ERROR, WARNING or MESSAGE.; appearInReport - Flag, whether to show check in report, if a message or warning are set as errorLevel. If this is set to 1, the check will be shown in the report.
Author:: QFS,mm
Since:: 4.0

Procedure: "checkValueToBeEqual"

Compare two string values for their equality.

It uses the rc.checkEqual() method from QF-Test.

Parameters:: got - The got value for comparison.; expected - The expected value for comparison.; checkMessage - The message, which should be written into the run log for that check.; errorLevel - The kind of error, which should be logged. Either EXCEPTION, ERROR, WARNING or MESSAGE.; appearInReport - Flag, whether to show check in report, if a message or warning are set as errorLevel. If this is set to 1, the check will be shown in the report.
Author:: QFS,mm
Since:: 3.1.1

Procedure: "compareDates"

Compare two date strings.

Formatting rules: If a format and a locale are specified the date will be formated using both values. If only a format is specified the date will be formatted only with that format. If only a locale is specified the date will be formatted according to the locale-format.

Parameters:: got - The received date for comparison.; expected - The expected date.; gotFormat - The format in which the got date is formatted. You can specify this via the SimpleDateFormat in Java, e.g. MM/dd/yyyy. dd means two digits for the day. MM means two digits for month. yyyy means four digits for year.; expectedFormat - The format in which the expected date is formatted. You can specify this via the SimpleDateFormat in Java, e.g. MM/dd/yyyy. dd means two digits for the day. MM means two digits for month. yyyy means four digits for year.; gotLocale - The locale of the got date, e.g. de, us, it, es, fr, zh, ko, ru, pt, ar or specific locales as en_gb, de_ch etc.; expectedLocale - The locale of the expected date, e.g. de, us, it, es, fr, zh, ko, ru, pt, ar or specific locales as en_gb, de_ch etc.; checkMessage - The message, which should be written into the run log for that check.; compareMode - The comparison mode. = or ==, asserts got == expected <, asserts got < expected >, asserts got > expected <=, asserts got <= expected >=, asserts got >= expected !=, asserts got != expected //======================== RETURN Options =============================; reuturnOnly - Decides wheter to return boolean value, or directly write to run log True: returns the compare result False: log directly in report - see below; errorLevel - The kind of error, which should be logged. Either EXCEPTION, ERROR, WARNING or MESSAGE.; appearInReport - Flag, whether to show check in report, if a message or warning are set as errorLevel. If this is set to 1, the check will be shown in the report. Further samples: MMM stands for the name of the month, e.g. 'Feb'. E stands for the day of the week, e.g. 'Mon'. w stands for week in the year. Further samples can be found at SimpleDateFormat documentation at Java's documentation.
Exceptions:: UserException, - if wrong comparison mode has been set, or if the date cannot be parsed.
Author:: QFS,ys,mm
Since:: 4.0.3

Procedure: "compareTwoNumbers"

Compare two values for their equality. Both values should be numbers.

It uses the rc.check() method from QF-Test.

Parameters:: got - The received value for comparison.; expected - The expected value.; checkMessage - The message, which should be written into the run log for that check.; compareMode - The comparison mode. = or ==, asserts got == expected <, asserts got < expected >, asserts got > expected <=, asserts got <= expected >=, asserts got >= expected !=, asserts got != expected; errorLevel - The kind of error, which should be logged. Either EXCEPTION, ERROR, WARNING or MESSAGE.; appearInReport - Flag, whether to show check in report, if a message or warning are set as errorLevel. If this is set to 1, the check will be shown in the report.
Exceptions:: UserException, - if wrong comparison mode has been set.
Author:: QFS,mm
Since:: 3.1.1

Procedure: "compareTwoStringValues"

Compare two values for their equality. The values should be string values.

It uses the rc.check() method from QF-Test.

Parameters:: got - The received value for comparison.; expected - The expected value.; checkMessage - The message, which should be written into the run log for that check.; compareMode - The comparison mode. = or ==, asserts got == expected <, asserts got < expected >, asserts got > expected <=, asserts got <= expected >=, asserts got >= expected !=, asserts got != expected regexp, the expected value should be treated as a regular expression, that matches the received value. regexpNegate, the expected value should be treated as a regular expression, that doesn't match the received value.; errorLevel - The kind of error, which should be logged. Either EXCEPTION, ERROR, WARNING or MESSAGE.; appearInReport - Flag, whether to show check in report, if a message or warning are set as errorLevel. If this is set to 1, the check will be shown in the report.
Exceptions:: UserException, - if wrong comparison mode has been set.
Author:: QFS,mm
Since:: 3.1.1

Package: "cleanup"

Deprecated: This package is deprecated because according cleanup procedures are implemented in the qfs.swing resp. qfs.swt package. Please use the technology specific procedures.

The procedures in this package are useful for generic cleanup after an exception is thrown. In some cases a menu or modal dialog may have been left open, causing future events for the SUT to be blocked.

Author:: QFS
Since:: 1.05.0

	Procedure/Dependency	Description
	closeAllDialogs	Close all dialogs.
	closeAllMenus	Close all menus unconditionally.
	closeAllModalDialogs	Close all modal dialogs.
	implicitExceptionHandler	This procedure encompasses the usage of other cleanup procedures in this package and is the recommended operation to perform after an exception occurs and is implicitly caught.

Procedure: "closeAllDialogs"

Deprecated: Please use the technology specific procedures in the qfs.swing or qfs.swt package according to your SUT.

Close all dialogs.

Parameters:: client - The name of the SUT client.; maxDialogs - Maximum number of dialogs that are tried to be closed. (Optional, default 6)
Author:: QFS
Since:: 1.05.0

Procedure: "closeAllMenus"

Deprecated: Please use the technology specific procedures in the qfs.swing or qfs.swt package according to your SUT.

Close all menus unconditionally. A menu left open (or even just selected) will cause events for the SUT to be blocked. This procedure is recommended for cleanup after an exception occurs.

Parameters:: client - The name of the SUT client.
Author:: QFS
Since:: 1.05.0

Procedure: "closeAllModalDialogs"

Deprecated: Please use the technology specific procedures in the qfs.swing or qfs.swt package according to your SUT.

Parameters:: client - The name of the SUT client.; maxDialogs - Maximum number of modal dialogs that are tried to be closed. (Optional, default 5)
Author:: QFS
Since:: 1.05.0

Procedure: "implicitExceptionHandler"

Deprecated: Please use the technology specific procedures in the qfs.swing or qfs.swt package according to your SUT.

This procedure encompasses the usage of other cleanup procedures in this package and is the recommended operation to perform after an exception occurs and is implicitly caught.

Calling this procedure should be the first step in the cleanup sequence of any Test node with the "Implicitly catch exceptions" attribute set.

Parameters:: client - The name of the SUT client.
Author:: QFS
Since:: 1.05.0

Package: "client"

Procedures for interacting with (SUT) clients.

Author:: QFS
Since:: 3.4

	Procedure/Dependency	Description
	renameClient	Rename an SUT client.
	sendInput	Write a string to the stdin stream of a process started by QF-Test.
	startLogging	Helper method for turning on internal logging.
	stopLogging	Helper method for turning off internal logging.

Procedure: "renameClient"

Rename an SUT client. This is especially useful when interacting with sub-processes of an SUT where you don't have full control over the client name during startup.

Parameters:: oldName - The current name of the client.; newName - The new name of the client.; trueName - An optional name to use for recording which may include variable syntax with escaped $, e.g. $$(subclient).; checkBeforeRename - If this is set to true, QF-Test will check whether a client with newName is already running.
Author:: QFS,mm
Since:: 3.4

Procedure: "sendInput"

Write a string to the stdin stream of a process started by QF-Test.

Parameters:: client - The name of the client.; input - The input to send; addNewline - Whether to append a line separator to the input.; newline - The newline character to send. Can be specified as \n.
Exceptions:: NoSuchClientException - If there is no such client.; UserException - It the output cannot be written.
Author:: QFS,gs
Since:: 3.4.8

Procedure: "startLogging"

Helper method for turning on internal logging. For QFS support and debugging use only.

Parameters:: levels - Classes and levels to log (class=level, comma separated); logfile - The name of file where the log should be saved; bufsize - Number of last log entries to log if parameter logfile is not set; guiengine - The name of the GUI engine to run the SUTscript, e.g. awt, swt, web. If empty or undefined, the primariy engine of the SUT is used.
Author:: QFS
Since:: 3.4

Procedure: "stopLogging"

Helper method for turning off internal logging. For QFS support and debugging use only.

Parameters:: dontcompactify - Whether to prevent the resulting log entry from compactification.; messagesizelimit - Limit for the size of individual messages. 0 = unlimited.; guiengine - The name of the GUI engine to run the SUTscript, e.g. awt, swt, web. If empty or undefined, the primariy engine of the SUT is used.
Author:: QFS
Since:: 3.4

Package: "daemon"

Procedures to work with a QF-Test daemon.

Author:: QFS
Since:: 2.9.9

	Procedure/Dependency	Description
	instrumentRemoteSwt	Starts remote instrumentation procedure for an Eclipse/RCP based or standalone SWT application via a given daemon.
	locateDaemons	Locate all running daemons and writes them into the run log and prints a list of running daemons to the terminal.
	startRemoteSUT	Start a client application on a remote host via the QF-Test daemon.

Procedure: "instrumentRemoteSwt"

Starts remote instrumentation procedure for an Eclipse/RCP based or standalone SWT application via a given daemon. See procedure qfs.swt.instrument.setup for further information.

Parameters:: daemonhost - The host name or IP address of the QF-Test daemon.; daemonport - The port where the daemon is listening.; sutdir - The installation directory of the SUT at the destination machine.; plugin - Optional: The specific plugin to instrument. Useful in case the directories are not layed out as expected.; forceInstrumentation - Whether to force instrumentation even if not required.
Author:: QFS, gs
Since:: 3.3.0

Procedure: "locateDaemons"

Locate all running daemons and writes them into the run log and prints a list of running daemons to the terminal. If no daemons can be found it logs an error.

Parameters:: timeout - Timeout for waiting for running daemons.
Author:: QFS,mm
Since:: 3.3.0

Procedure: "startRemoteSUT"

Start a client application on a remote host via the QF-Test daemon.

Parameters:: daemonhost - The host name or IP address of the QF-Test daemon.; daemonport - The port where the daemon is listening.; commandline - The commandline used by the daemon to launch the client. Arguments containing spaces must be wrapped into quotes.
Author:: QFS
Since:: 2.9.9

Package: "database"

Procedures to work with databases.

Author:: QFS,mm
Since:: 2.1.0

	Procedure/Dependency	Description
	executeSelectStatement	Build up connection to a given database and executes a specified select-sql-statement.
	executeStatement	Build up connection to a given database and execute a specified SQL-statement.

Procedure: "executeSelectStatement"

Build up connection to a given database and executes a specified select-sql-statement. You can configure the procedure to store all results in a group QF-Test variable.

NOTE: The SQL-statement should be a select statement! NOTE: The class of the database driver must be either in QF-Test's plugin directory or in the CLASSPATH environment variable before QF-Test startup!

For more information about connection-strings please see www.connectionstrings.com.

Parameters:: driver - The class-name of the database driver.; connectionString - The connection-string to the database.; dbUser - The user for establishing database-connection.; dbPass - The password for establishing database-connection.; statement - The SQL-statement, it should be a select statement.; resultGroupName - If this name is specified the result is stored in a Propertygroup, which an be accessed via ${resultGroup:'Columnname'.'RowIdx'}. ${resultGroup:'count'} gives the number of rows in the result set.; throwExceptionOnDuplicateColumns - If the result set has two columns with the same name (which could happen if you join tables), then you will get an exception.; commit - true, false or auto. Whether to explicitly execute db.commit() at the end. Some databases / connection modes reuqire the execution of this statement. When this option is set to auto, QF-Test tries to determine if that is possible.
Returns:: Set a global variable 'resultRows', which contains all result-rows. You can access this variable in any Server-script.
Exceptions:: TestException - If something went wrong with the database or execution of statement.; TestException - If there are duplicate in column names, which could happen in case of joins on tables.
Author:: QFS,mm
Since:: 2.1.0

Procedure: "executeStatement"

Build up connection to a given database and execute a specified SQL-statement.

NOTE: The class of the database driver must be either in QF-Test's plugin directory or in the CLASSPATH environment variable before QF-Test startup!

For more information about connection-strings please see www.connectionstrings.com.

Parameters:: driver - The class-name of the database driver.; connectionString - The connection-string to the database.; dbUser - The user for establishing database-connection.; dbPass - The password for establishing database-connection.; statement - The SQL-statement.
Returns:: result 1 If result has been executed, otherwise 0. (Only for backward compatibility.)
Exceptions:: TestException - If something went wrong with the database or execution of statement.
Author:: QFS,mm
Since:: 2.1.0

Package: "databinder"

Procedures to bind data for data-driven testing.

Author:: QFS
Since:: 2.2.0

	Procedure/Dependency	Description
	bindList	Create and register a databinder that binds a list of values to a variable.
	bindSets	Create and register a databinder that binds a list of value-sets to a set of variables.

Procedure: "bindList"

Create and register a databinder that binds a list of values to a variable.

Parameters:: varname - The name of the variable to bind to.; values - The values to bind.; separator - Optional separator character for splitting the values. Default is whitespace.; counter - Optional variable name for the iteration counter.; intervals - Optional ranges of indices, separated by comma, e.g. "0,2-3"
Author:: QFS
Since:: 2.2.0

Procedure: "bindSets"

Create and register a databinder that binds a list of value-sets to a set of variables.

Parameters:: loopname - The name for which to register the databinder.; varnames - The names of the variables to bind to.; values - The values to bind. Value-sets are separated by linebreaks.; separator - Optional separator character for splitting the varnames and value-sets. Default is whitespace.; counter - Optional variable name for the iteration counter.; intervals - Optional ranges of indices, separated by comma, e.g. "0,2-3"
Author:: QFS
Since:: 2.2.0

Package: "dialogs"

Procedures for showing dialogs during the test run.

Author:: QFS
Since:: 3.0

	Procedure/Dependency	Description
	showConfigurabableDialog
	showConfigurableDialog	Show a configurable dialog equivalent to JOptionPane.
	showInformationMessageDialog	Show an information dialog with an OK option.
	showYes_No_Cancel_Dialog	Show an information dialog with a YES, NO and CANCEL option.
	showYes_No_Dialog	Show an information dialog with a YES and NO option.

Procedure: "showConfigurabableDialog"

Deprecated: - Redirect for procedure name with typo

Procedure: "showConfigurableDialog"

Show a configurable dialog equivalent to JOptionPane.

Parameters:: title - The title of the dialog.; msg - The message to be shown.; timeout - The timeout for closing the dialog in ms. -1 means no timeout.; alwaysOnTop - Try to bring the dialog to front. Supported for JDKs >= 1.5.; wraplength - Approximate line length of the message text (0 to avoid line breaks).; messagetype - The message type, one of ERROR_MESSAGE, INFORMATION_MESSAGE, WARNING_MESSAGE, QUESTION_MESSAGE, PLAIN_MESSAGE .; optiontype - The option type, one of DEFAULT_OPTION, YES_NO_OPTION, YES_NO_CANCEL_OPTION or OK_CANCEL_OPTION.; buttons - Explicit button labels, separated by comma (optional)
Returns:: The code for the clicked button. 0 for YES/OK, 1 for NO, 2 for CANCEL, (or custom button index) and -1 for timeout.
Author:: QFS
Since:: 3.0

Procedure: "showInformationMessageDialog"

Show an information dialog with an OK option.

Parameters:: title - The title of the dialog.; msg - The message to be shown.; timeout - The timeout for closing the dialog in ms. -1 means no timeout.; alwaysOnTop - Try to bring the dialog to front. Supported for JDKs >= 1.5.; wraplength - Approximate line length of the message text (0 to avoid line breaks).
Returns:: The code for the clicked button. 0 for OK and -1 for timeout.
Author:: QFS
Since:: 3.0

Procedure: "showYes_No_Cancel_Dialog"

Show an information dialog with a YES, NO and CANCEL option.

Parameters:: title - The title of the dialog.; msg - The message to be shown.; timeout - The timeout for closing the dialog in ms. -1 means no timeout.; alwaysOnTop - Try to bring the dialog to front. Supported for JDKs >= 1.5.; wraplength - Approximate line length of the message text (0 to avoid line breaks).
Returns:: The code for the clicked button. 0 for YES, 1 for NO, 2 for CANCEL and -1 for timeout or closed.
Author:: QFS
Since:: 3.0

Procedure: "showYes_No_Dialog"

Show an information dialog with a YES and NO option.

Parameters:: title - The title of the dialog.; msg - The message to be shown.; timeout - The timeout for closing the dialog in ms. -1 means no timeout.; alwaysOnTop - Try to bring the dialog to front. Supported for JDKs >= 1.5.; wraplength - Approximate line length of the message text (0 to avoid line breaks).
Returns:: The code for the clicked button. 0 for YES, 1 for NO and -1 for timeout.
Author:: QFS
Since:: 3.0

Package: "progress"

Procedures to show a simple progress dialog

Author:: QFS
Since:: 8.0

	Procedure/Dependency	Description
	hideProgressDialog	Hides a progress dialog displayed with showProgressDialog
	showProgressDialog	Shows a simple progress dialog on the screen.

Procedure: "hideProgressDialog"

Hides a progress dialog displayed with showProgressDialog

Author:: QFS
Since:: 8.0

Procedure: "showProgressDialog"

Shows a simple progress dialog on the screen. Only one dialog is displayed at the time.

Parameters:: title - The title of the dialog; msg - The text of the label; alwaysOnTop - If true, the dialog remains on top, even if not focused
Author:: QFS
Since:: 8.0

Package: "fx"

Procedures for advanced manipulation of fx components.

Author:: QFS
Since:: 4.0

Package: "checkbox"

Procedures to get and set the state of checkboxes. (fx component javafx.scene.control.CheckBox)

Author:: QFS,mm
Since:: 4.0

	Procedure/Dependency	Description
	deselect	Deselect a checkbox.
	deselectWithCoordinates	Deselect a checkbox.
	getValue	Return the value of a checkbox.
	select	Select a checkbox.
	selectWithCoordinates	Select a checkbox.
	set	Set checkbox to the given state.
	setWithCoordinates	Set checkbox to the given state.

Procedure: "deselect"

Deselect a checkbox. If the checkbox is already deselected, no action is performed.

Parameters:: client - The name of the SUT client.; id - The id of the checkbox.
Author:: QFS,mm
Since:: 4.0

Procedure: "deselectWithCoordinates"

Deselect a checkbox. If the checkbox is already deselected, no action is performed. You can specify the coordinates for clicking.

Parameters:: client - The name of the SUT client.; id - The id of the checkbox.; x - The x coordinate for the click, default is empty to click in the middle.; y - The y coordinate for the click, default is empty to click in the middle.
Author:: QFS,mm
Since:: 4.0

Procedure: "getValue"

Return the value of a checkbox. It's either 1, if box is selected or 0, if box is not selected.

Parameters:: id - ID of the checkbox.
Returns:: The state of the checkbox.
Author:: QFS,mm
Since:: 4.0

Procedure: "select"

Select a checkbox. If the checkbox is already selected, no action is performed.

Parameters:: client - The name of the SUT client.; id - The id of the checkbox.
Author:: QFS,mm
Since:: 4.0

Procedure: "selectWithCoordinates"

Select a checkbox. If the checkbox is already selected, no action is performed. You can specify the coordinates for clicking.

Parameters:: client - The name of the SUT client.; id - The id of the checkbox.; x - The x coordinate for the click, default is empty to click in the middle.; y - The y coordinate for the click, default is empty to click in the middle.
Author:: QFS,mm
Since:: 4.0

Procedure: "set"

Set checkbox to the given state.

Parameters:: client - The name of the SUT client.; id - The id of the checkbox.; check - The check value to be set (either true or false).
Author:: QFS,mm
Since:: 4.0

Procedure: "setWithCoordinates"

Set checkbox to the given state. You can specify the coordinates for clicking.

Parameters:: client - The name of the SUT client.; id - The id of the checkbox.; check - The check value to be set (either true or false).; x - The x coordinate for the click, default is empty to click in the middle.; y - The y coordinate for the click, default is empty to click in the middle.
Author:: QFS,mm
Since:: 4.0

Package: "cleanup"

Author:: QFS,gs
Since:: 4.0

	Procedure/Dependency	Description
	closeAllMenus	Close all menus unconditionally.
	closeAllModalDialogs	Close all modal dialogs.
	closeMenu	Close a menu by replaying an [Escape] keystroke on a Window.
	implicitExceptionHandler	This procedure encompasses the usage of other cleanup procedures in this package and is the recommended operation to perform after an exception occurs and is implicitly caught.

Procedure: "closeAllMenus"

Close all menus unconditionally. A menu left open (or even just selected) will cause events for the SUT to be blocked. This procedure is recommended for cleanup after an exception occurs.

Parameters:: client - The name of the SUT client.
Author:: QFS,gs
Since:: 4.0

Procedure: "closeAllModalDialogs"

Parameters:: client - The name of the SUT client.; maxDialogs - Maximum number of modal dialogs that are tried to be closed. (Optional, default 5)
Author:: QFS,gs
Since:: 4.0

Procedure: "closeMenu"

Close a menu by replaying an [Escape] keystroke on a Window.

Parameters:: client - The name of the SUT client.; id - The id of the Window with the menu.
Author:: QFS,gs
Since:: 4.0

Procedure: "implicitExceptionHandler"

This procedure encompasses the usage of other cleanup procedures in this package and is the recommended operation to perform after an exception occurs and is implicitly caught.

Calling this procedure should be the first step in the error handler of a base dependency or the cleanup sequence of any Test node with the "Implicitly catch exceptions" attribute set.

Parameters:: client - The name of the SUT client.; maxDialogs - Maximum number of modal dialogs that are tried to be closed. (Optional, default 5)
Author:: QFS,gs
Since:: 4.0

Package: "combobox"

Procedures to handle comboboxes. (fx component javafx.scene.control.ComboBox)

Author:: QFS,mm
Since:: 4.0

	Procedure/Dependency	Description
	getIndexOfItem	Return the current index of a given item.
	getItemCount	Return the number of items of a given combobox.
	getValue	Return the text of a given combobox.
	getValueOfItem	Return the text of a given item.
	setValue	Select specified value of a given combobox.
	setValueViaIndex	Set a value in the combobox.
	setValueViaSUTScript	Select specified value of a given combobox using a SUT script.

Procedure: "getIndexOfItem"

Return the current index of a given item.

Sample usage: Can be used to determine the numeric index of an item like 'Price'.

Parameters:: id - ID of the combobox.; item - The item.; itemSeparator - Separator to use for the item syntax. Default is @ for text values, also available & for index and % for regexp.
Returns:: index The current index of the item, which has been read by the 'Fetch Index' node of QF-Test.
Author:: QFS,mm
Since:: 4.0

Procedure: "getItemCount"

Return the number of items of a given combobox. It uses the method getItems().getSize() to get the number.

Parameters:: id - The component ID of the combobox.
Returns:: itemCount
Author:: QFS,mm
Since:: 4.0

Procedure: "getValue"

Return the text of a given combobox.

Parameters:: id - ID of the combobox.
Returns:: The text of the combobox.
Author:: QFS,mm
Since:: 4.0

Procedure: "getValueOfItem"

Return the text of a given item.

Sample usage: Determine the text of the second item.

Parameters:: id - ID of the combobox.; item - The item.; itemSeparator - Separator to use for the item syntax. Default is @ for text values, also available & for index and % for regexp.
Returns:: value The value of the item.
Author:: QFS,mm
Since:: 4.0

Procedure: "setValue"

Select specified value of a given combobox.

If the given value is empty, no action will take place.

You should use this procedure for any standard selections.

Parameters:: client - The name of the SUT client.; id - ID of the button to open the list.; listId - ID of the list containing values.; value - Value, which should be selected.; separator - Separator to use for the list syntax. Default is @ for text values, also available & for index and % for regexp.; btnX - The x coordinate for the click on the button to open the list, default is empty to click in the middle.; btnY - The y coordinate for the click on the button to open the list, default is empty to click in the middle.; itemX - The x coordinate for the click on the item, default is empty to click in the middle.; itemY - The y coordinate for the click on the item, default is empty to click in the middle.
Author:: QFS,mm
Since:: 4.0

Procedure: "setValueViaIndex"

Set a value in the combobox.

You should use this procedure if setValue doesn't work correctly.

Parameters:: client - The name of the SUT client.; id - ID of the combobox.; value - The value to be set.; separator - Separator to use for the list syntax. Default is @ for text values, also available & for index and % for regexp.
Author:: QFS,mm
Since:: 4.0

Procedure: "setValueViaSUTScript"

Select specified value of a given combobox using a SUT script. It uses the API-method getSelectionModel.select() of javafx.scene.control.ComboBox

If the given value is empty, no action will take place.

You should use this procedure only if setValue and setValueViaIndex don't work for your use-case.

Parameters:: client - The name of the SUT client.; id - ID of the combobox.; value - Value, which should be selected.; separator - Separator to use for the list syntax. Default is @ for text values, also available & for index and % for regexp.
Author:: QFS,mm
Since:: 4.0

Package: "general"

Procedures which work for any fx component.

Author:: QFS,mm
Since:: 4.0

	Procedure/Dependency	Description
	clickAtComponent	Click on a given component, but only if the according parameter is set to true.
	clickAtComponentWithDetails	Click on a given component, but only if the according parameter is set to true.
	deleteOverrideComponent	Delete the current association of PriorityFxNode.
	doClick	Click on a given component.
	doClickWithDetails	Click on a given component.
	doSelect	Send a selection event to a given component.
	setLocation	Set the location of a given component.
	setOverrideComponent	Set a given component to the PriorityFxNode.
	setSize	Set the width and the height of a given component.
	waitForComponent	Wait for a given component.
	waitForComponentForAbsence	Wait till a given component disappears.

Procedure: "clickAtComponent"

Click on a given component, but only if the according parameter is set to true.

Parameters:: client - The name of the SUT client.; id - The Id of the target component.; click - If this is set to true, the click will be performed, otherwise nothing happens.
Author:: QFS,mm
Since:: 4.0

Procedure: "clickAtComponentWithDetails"

Click on a given component, but only if the according parameter is set to true. You can specify the coordinates for clicking and all other details of that mouse click.

Parameters:: client - The name of the SUT client.; id - The Id of the target component.; click - If this is set to true, the click will be performed, otherwise nothing happens.; x - The x coordinate for the click, default is empty to click in the middle.; y - The y coordinate for the click, default is empty to click in the middle.; clickCount - Number of clicks. Default is 1. For a double click set this to 2.; modifier - Modifier for mouse key. 4 for right mouse. 16 for left mouse.; hard - True, if hard event should be replayed. Default is false.; popupTrigger - True, if click should open a popup. Default is false.
Author:: QFS,mm
Since:: 4.0

Procedure: "deleteOverrideComponent"

Delete the current association of PriorityFxNode.

Parameters:: client - The name of the SUT client.
Author:: QFS,mm
Since:: 4.0

Procedure: "doClick"

Click on a given component.

Parameters:: client - The name of the SUT client.; id - The Id of the target component.
Author:: QFS,mm
Since:: 4.0

Procedure: "doClickWithDetails"

Click on a given component. You can specify the coordinates for clicking and all other details of that mouse click.

Parameters:: client - The name of the SUT client.; id - The Id of the target component.; x - The x coordinate for the click, default is empty to click in the middle.; y - The y coordinate for the click, default is empty to click in the middle.; clickCount - Number of clicks. Default is 1. For a double click set this to 2.; modifier - Modifier for mouse key. 4 for right mouse. 16 for left mouse.; hard - True, if hard event should be replayed. Default is false.; popupTrigger - True, if click should open a popup. Default is false.
Author:: QFS,mm
Since:: 4.0

Procedure: "doSelect"

Send a selection event to a given component. That's not a mouse click. Selection events are special events for menus or list selection.

Parameters:: client - The name of the SUT client.; id - The Id of the target component.; detail - The detail of the selection. Important for closing dialogs etc. For menu items leave it blank.
Author:: QFS,mm
Since:: 4.0

Procedure: "setLocation"

Set the location of a given component.

Parameters:: client - The name of the SUT client.; id - The Id of the target component.; x - The new x-coordinate of the location.; y - The new y-coordinate of the location.
Author:: QFS,gs
Since:: 4.0

Procedure: "setOverrideComponent"

Set a given component to the PriorityFxNode.

Parameters:: client - The name of the SUT client.; id - The Id of the target component.
Author:: QFS,mm
Since:: 4.0

Procedure: "setSize"

Set the width and the height of a given component.

It uses setSize(width, height) to set the size.

Parameters:: client - The name of the SUT client.; id - The Id of the target component.; width - The new width of the component.; height - The new height of the component.
Author:: QFS,mm
Since:: 4.0

Procedure: "waitForComponent"

Wait for a given component.

Parameters:: client - The name of the SUT client.; id - The Id of the target component.; timeout - The timeout to wait for that component; throwExc - True, whether procedure should throw an exception if component didn't appear.
Author:: QFS,mm
Since:: 4.0

Procedure: "waitForComponentForAbsence"

Wait till a given component disappears.

Parameters:: client - The name of the SUT client.; id - The Id of the target component.; timeout - The timeout to wait for that component; throwExc - True, whether procedure should throw an exception if component didn't disappear.
Author:: QFS,mm
Since:: 4.0

Package: "list"

Procedures for accessing lists. (fx component javafx.scene.control.ListView)

Author:: QFS,mm
Since:: 4.0

	Procedure/Dependency	Description
	clickItemWithDetails	Select a given item by a mouse click on it.
	getIndexOfItem	Return the current index of a given item.
	getItemCount	Return the number of items of a given list.
	getValueOfItem	Return the text of a given item.
	selectItem	Select a given item by a mouse click on it.

Procedure: "clickItemWithDetails"

Select a given item by a mouse click on it. You can specify the coordinates for clicking and all other details of that mouse click.

Parameters:: id - ID of the list.; item - The item.; itemSeparator - Separator to use for the item syntax. Default is @ for text values, also available & for index and % for regexp.; x - The x coordinate for the click, default is empty to click in the middle.; y - The y coordinate for the click, default is empty to click in the middle.; clickCount - Number of clicks. Default is 1. For a double click set this to 2.; modifier - Modifier for mouse key. 4 for right mouse. 16 for left mouse.; hard - True, if hard event should be replayed. Default is false.; popupTrigger - True, if click should open a popup. Default is false.
Author:: QFS,mm
Since:: 4.0

Procedure: "getIndexOfItem"

Return the current index of a given item.

Sample usage: Can be used to determine the numeric index of an item like 'Price'.

Parameters:: id - ID of the list.; item - The item.; itemSeparator - Separator to use for the item syntax. Default is @ for text values, also available & for index and % for regexp.
Returns:: index The current index of the item, which has been read by the 'Fetch Index' node of QF-Test.
Author:: QFS,mm
Since:: 4.0

Procedure: "getItemCount"

Return the number of items of a given list. It uses the method getItems().size() to get the number.

Parameters:: id - The component ID of the list.
Returns:: itemCount
Author:: QFS, mm, ue
Since:: 4.0

Procedure: "getValueOfItem"

Return the text of a given item.

Sample usage: Determine the text of the second item.

Parameters:: id - ID of the list.; item - The item.; itemSeparator - Separator to use for the item syntax. Default is @ for text values, also available & for index and % for regexp.
Returns:: value The value of the item.
Author:: QFS,mm
Since:: 4.0

Procedure: "selectItem"

Select a given item by a mouse click on it.

Parameters:: id - ID of the list.; item - The item.; itemSeparator - Separator to use for the item syntax. Default is @ for text values, also available & for index and % for regexp.
Author:: QFS,mm,ue
Since:: 4.0

Package: "checks"

Procedures for checking a list.

Author:: QFS,mm
Since:: 4.0

	Procedure/Dependency	Description
	checkNumberOfItems	Check the number of items of a given list according to a specified comparison mode.

Procedure: "checkNumberOfItems"

Check the number of items of a given list according to a specified comparison mode.

It uses getItems().size() to get the number. Sample usage: You can check, that a list has exactly 6 items or that the table has less then 10 items.

Parameters:: id - The id of the list.; compareValue - The comparison value.; compareMode - The comparison mode = or ==, if the compareValue should be equal than the actual amount of items. <, if the compareValue should be greater than the actual amount of items. >, if the compareValue should be less than the actual amount of items. <=, if the compareValue should be greater or equal than the actual amount of items. >=, if the compareValue should be less or equal the actual amount of items. !=, if the compareValue should be not equal the actual amount of items.; errorLevel - The kind of error, which should be logged. Either EXCEPTION, ERROR, WARNING or MESSAGE.; appearInReport - Flag, whether to show check in report, if a message or warning are set as errorLevel. If this is set to 1, the check will be shown in the report.
Exceptions:: UserException, - if wrong comparison mode has been set.
Author:: QFS,mm
Since:: 4.0

Package: "selection"

Procedures to (de-)select certain items of a list.

Author:: QFS,mm
Since:: 4.0

	Procedure/Dependency	Description
	deselectAllItems	Deselect all items.
	deselectItem	Deselect a given item, specified by its index.
	deselectItemRange	Deselect a range of items, specified by their index.
	selectAllItems	Select all items.
	selectItem	Select a given item, specified by its index.
	selectItemRange	Select a range of items, specified by their index.

Procedure: "deselectAllItems"

Deselect all items. It uses clearSelection.

Parameters:: id - ID of the list.
Author:: QFS,ue
Since:: 4.0

Procedure: "deselectItem"

Deselect a given item, specified by its index. It uses clearSelection(item).

Parameters:: id - ID of the list.; item - The index of the item.
Author:: QFS,mm
Since:: 4.0

Procedure: "deselectItemRange"

Deselect a range of items, specified by their index. It uses clearSelection(item).

Parameters:: id - ID of the list.; startItem - The index of first item to be deselected.; endItem - The index of last item to be deselected.
Author:: QFS,ue
Since:: 4.0

Procedure: "selectAllItems"

Select all items. It uses selectAll().

Parameters:: id - ID of the list.
Author:: QFS, mzs
Since:: 4.0

Procedure: "selectItem"

Select a given item, specified by its index. It uses select(item).

Parameters:: id - ID of the list.; row - The index of the item.
Author:: QFS,mm
Since:: 4.0

Procedure: "selectItemRange"

Select a range of items, specified by their index.

Parameters:: id - ID of the list.; startItem - The index of first item to be selected.; endItem - The index of last item to be selected.
Author:: QFS,ue
Since:: 4.0

Package: "menu"

Procedures to select menu items and checkbox menu items. (fx components javafx.scene.control.RadioMenuItem and javafx.scene.control.CheckMenuItem from javafx.scene.control.MenuItem)

Author:: QFS
Since:: 4.0

	Procedure/Dependency	Description
	selectCheckMenuItemInHierarchy	Select a checkbox menu item from a menu.
	selectCheckMenuItemInHierarchyWithCoordinates	Select a checkbox menu item from a menu.
	selectItem	Select an item from a menu.
	selectItemWithCoordinates	Select an item from a menu.
	selectMenuItemInHierarchy	Select an item from a menu.
	selectMenuItemInHierarchyWithCoordinates	Select an item from a menu.
	selectSubItem	Select an item within a submenu.
	selectSubItemWithCoordinates	Select an item within a submenu.
	setCheckItem	Select a checkbox menu item.
	setCheckItemWithCoordinates	Select a checkbox menu item.
	setSubCheckItem	Select a checkbox menu item within within a submenu.
	setSubCheckItemWithCoordinates	Select a checkbox menu item within within a submenu.

Procedure: "selectCheckMenuItemInHierarchy"

Select a checkbox menu item from a menu. This procedure is designed to work with any menu item. You can define the entire menu path in the parameter menu. Samples: If you want to select at "View" -> "Show terminal" you set menu to the component id "mView" and item to "mShowTerminal" (Of course you need to set your component id's). If you want to select at "Options" -> "Search" -> "Exclude digits" you set menu to the component id "mFile.mSearch" and item to "mExcludeDigits" (Of course you need to set your component id's).

Parameters:: client - The name of the SUT client.; menu - The path of the parent menus. The path is specified as list of component ids.; menustringSeparator - The value, which separates the path of the parent menu.; checkItem - The id of the checkbox item.; checkItemValue - The check item value to be set - 'true' to select the checkbox item (default), 'false' to deselect.
Author:: QFS,mm
Since:: 4.0

Procedure: "selectCheckMenuItemInHierarchyWithCoordinates"

Parameters:: client - The name of the SUT client.; menu - The path of the parent menus. The path is specified as list of component ids.; menustringSeparator - The value, which separates the path of the parent menu.; checkItem - The id of the checkbox item.; checkItemValue - The check item value to be set - 'true' to select the checkbox item (default), 'false' to deselect.; menuX - The x coordinate for the click on the menu, default is empty to click in the middle.; menuY - The y coordinate for the click on the menu, default is empty to click in the middle.; checkItemX - The x coordinate for the click on the checkbox item, default is empty to click in the middle.; checkItemY - The y coordinate for the click on the checkbox item, default is empty to click in the middle.
Author:: QFS,mm
Since:: 4.0

Procedure: "selectItem"

Select an item from a menu.

For example: for the File -> Open action, the component ID of "File" is the menu, and the ID for "Open" is the item.

Parameters:: client - The name of the SUT client.; menu - The id of the menu.; item - The id of menu item.
Author:: QFS
Since:: 4.0

Procedure: "selectItemWithCoordinates"

Select an item from a menu.

For example: for the File -> Open action, the component ID of "File" is the menu, and the ID for "Open" is the item.

Parameters:: client - The name of the SUT client.; menu - The id of the menu.; item - The id of menu item.; menuX - The x coordinate for the click on the menu, default is empty to click in the middle.; menuY - The y coordinate for the click on the menu, default is empty to click in the middle.; itemX - The x coordinate for the click on the item, default is empty to click in the middle.; itemY - The y coordinate for the click on the item, default is empty to click in the middle.
Author:: QFS
Since:: 4.0

Procedure: "selectMenuItemInHierarchy"

Select an item from a menu. This procedure is designed to work with any menu item. You can define the entire menu path in the parameter menu. Samples: If you want to select at "File" -> "Close" you set menu to the component id "mFile" and item to "mClose" (Of course you need to set your component id's). If you want to select at "Options" -> "Search" -> "Search text" you set menu to the component id "mFile.mSearch" and item to "mSearchText" (Of course you need to set your component id's).

Parameters:: client - The name of the SUT client.; menu - The path of the parent menus. The path is specified as list of component ids.; item - The id of menu item.; menustringSeparator - The value, which separates the path of the parent menu.
Author:: QFS,mm
Since:: 4.0

Procedure: "selectMenuItemInHierarchyWithCoordinates"

Select an item from a menu. This procedure is designed to work with any menu item. You can define the entire menu path in the parameter menu. You can specify the coordinates for clicking.

Samples: If you want to select at "File" -> "Close" you set menu to the component id "mFile" and item to "mClose" (Of course you need to set your component id's). If you want to select at "Options" -> "Search" -> "Search text" you set menu to the component id "mFile.mSearch" and item to "mSearchText" (Of course you need to set your component id's).

Parameters:: client - The name of the SUT client.; menu - The path of the parent menus. The path is specified as list of component ids.; item - The id of menu item.; menustringSeparator - The value, which separates the path of the parent menu.; menuX - The x coordinate for the click on the menu, default is empty to click in the middle.; menuY - The y coordinate for the click on the menu, default is empty to click in the middle.; itemX - The x coordinate for the click on the menu item, default is empty to click in the middle.; itemY - The y coordinate for the click on the menu item, default is empty to click in the middle.
Author:: QFS,mm
Since:: 4.0

Procedure: "selectSubItem"

Select an item within a submenu.

For example: for the View -> Terminal -> Show action, the component ID of "View" is the menu, the ID for "Terminal" is the item, and the ID for "Show" is the subitem to select.

Parameters:: client - The name of the SUT client.; menu - The id of the menu.; item - The id of the item to open the submenu.; subItem - The id of item in submenu.
Author:: QFS
Since:: 4.0

Procedure: "selectSubItemWithCoordinates"

Select an item within a submenu.

For example: for the View -> Terminal -> Show action, the component ID of "View" is the menu, the ID for "Terminal" is the item, and the ID for "Show" is the subitem to select.

Parameters:: client - The name of the SUT client.; menu - The id of the menu.; item - The id of the item to open the submenu.; subItem - The id of item in submenu.; menuX - The x coordinate for the click on the menu, default is empty to click in the middle.; menuY - The y coordinate for the click on the menu, default is empty to click in the middle.; itemX - The x coordinate for the click on the item, default is empty to click in the middle.; itemY - The y coordinate for the click on the item, default is empty to click in the middle.; subItemX - The x coordinate for the click on the subitem, default is empty to click in the middle.; subItemY - The y coordinate for the click on the subitem, default is empty to click in the middle.
Author:: QFS
Since:: 4.0

Procedure: "setCheckItem"

Select a checkbox menu item.

For example: for the View -> Show Details action, the component ID of "View" is the menu, and the ID for "Show Details" is the checkbox item to set (to true or false).

Parameters:: client - The name of the SUT client.; menu - The id of the menu.; checkItem - The id of the checkbox item.; checkItemValue - The check item value to be set - 'true' to select the checkbox item (default), 'false' to deselect.
Author:: QFS
Since:: 4.0

Procedure: "setCheckItemWithCoordinates"

Select a checkbox menu item.

For example: for the View -> Show Details action, the component ID of "View" is the menu, and the ID for "Show Details" is the checkbox item to set (to true or false).

Parameters:: client - The name of the SUT client.; menu - The id of the menu.; checkItem - The id of the checkbox item.; checkItemValue - The check item value to be set - 'true' to select the checkbox item (default), 'false' to deselect.; menuX - The x coordinate for the click on the menu, default is empty to click in the middle.; menuY - The y coordinate for the click on the menu, default is empty to click in the middle.; checkItemX - The x coordinate for the click on the checkbox item, default is empty to click in the middle.; checkItemY - The y coordinate for the click on the checkbox item, default is empty to click in the middle.
Author:: QFS
Since:: 4.0

Procedure: "setSubCheckItem"

Select a checkbox menu item within within a submenu.

For example: for the View -> Terminal -> Wrap Lines action, the component ID of "View" is the menu, the ID for "Terminal" is the item and the ID for "Wrap Lines" is the checkbox menu item to set (to true or false).

Parameters:: client - The name of the SUT client.; menu - The id of the menu.; item - The id of the item to open the submenu.; subCheckItem - The id of the checkbox item in the submenu.; checkItemValue - The checkbox item value to be set - "true" to select the checkbox item (default), "false" to deselect.
Author:: QFS
Since:: 4.0

Procedure: "setSubCheckItemWithCoordinates"

Select a checkbox menu item within within a submenu.

Parameters:: client - The name of the SUT client.; menu - The id of the menu.; item - The id of the item to open the submenu.; subCheckItem - The id of the checkbox item in the submenu.; checkItemValue - The checkbox item value to be set - "true" to select the checkbox item (default), "false" to deselect.; menuX - The x coordinate for the click on the menu, default is empty to click in the middle.; menuY - The y coordinate for the click on the menu, default is empty to click in the middle.; itemX - The x coordinate for the click on the item, default is empty to click in the middle.; itemY - The y coordinate for the click on the item, default is empty to click in the middle.; subCheckItemX - The x coordinate for the click on the checkbox item, default is empty to click in the middle.; subCheckItemY - The y coordinate for the click on the checkbox item, default is empty to click in the middle.
Author:: QFS
Since:: 4.0

Package: "popupmenu"

Procedures to select items and checkbox menu items from popup menus.

Note that for all procedures, the popup menu must first be opened by the calling test suite, as the popup menu is component-dependent.

See package "menu" for more details about menus and submenus. (fx components javafx.scene.control.RadioMenuItem and javafx.scene.control.CheckMenuItem from javafx.scene.control.MenuItem)

Author:: QFS
Since:: 4.0

	Procedure/Dependency	Description
	clickItemWithDetails	Select an item in a popup menu.
	selectItem	Select an item in a popup menu.
	selectSubItem	Select an item within a submenu of a popup menu.
	selectSubItemWithCoordinates	Select an item within a submenu of a popup menu.
	setCheckItem	Select a checkbox menu item in a popup menu.
	setCheckItemWithCoordinates	Select a checkbox menu item in a popup menu.
	setSubCheckItem	Select a checkbox menu item within a submenu of a popup menu.
	setSubCheckItemWithCoordinates	Select a checkbox menu item within a submenu of a popup menu.

Procedure: "clickItemWithDetails"

Select an item in a popup menu. You can specify the coordinates for clicking and all other details of that mouse click.

Parameters:: client - The name of the SUT client.; item - The id of menu item.; x - The x coordinate for the click, default is empty to click in the middle.; y - The y coordinate for the click, default is empty to click in the middle.; clickCount - Number of clicks. Default is 1. For a double click set this to 2.; modifier - Modifier for mouse key. 4 for right mouse. 16 for left mouse.; hard - True, if hard event should be replayed. Default is false.
Author:: QFS,mm
Since:: 4.0

Procedure: "selectItem"

Select an item in a popup menu.

Parameters:: client - The name of the SUT client.; item - The id of menu item.
Author:: QFS
Since:: 4.0

Procedure: "selectSubItem"

Select an item within a submenu of a popup menu.

Parameters:: client - The name of the SUT client.; item - The id of the item to open the submenu.; subItem - The id of item in submenu.
Author:: QFS
Since:: 4.0

Procedure: "selectSubItemWithCoordinates"

Select an item within a submenu of a popup menu. You can specify the coordinates for clicking.

Parameters:: client - The name of the SUT client.; item - The id of the item to open the submenu.; subItem - The id of item in submenu.; itemX - The x coordinate for the click on the item, default is empty to click in the middle.; itemY - The y coordinate for the click on the item, default is empty to click in the middle.; subItemX - The x coordinate for the click on the subitem, default is empty to click in the middle.; subItemY - The y coordinate for the click on the subitem, default is empty to click in the middle.
Author:: QFS
Since:: 4.0

Procedure: "setCheckItem"

Select a checkbox menu item in a popup menu.

Parameters:: client - The name of the SUT client.; checkItem - The id of the menu checkbox item.; checkItemValue - The checkbox item value to be set - "true" to select the checkbox item (default), "false" to deselect.
Author:: QFS
Since:: 4.0

Procedure: "setCheckItemWithCoordinates"

Select a checkbox menu item in a popup menu. You can specify the coordinates for clicking.

Parameters:: client - The name of the SUT client.; checkItem - The id of the menu checkbox item.; checkItemValue - The checkbox item value to be set - "true" to select the checkbox item (default), "false" to deselect.; x - The x coordinate for the click, default is empty to click in the middle.; y - The y coordinate for the click, default is empty to click in the middle.
Author:: QFS
Since:: 4.0

Procedure: "setSubCheckItem"

Select a checkbox menu item within a submenu of a popup menu.

Parameters:: client - The name of the SUT client.; item - The id of item to open the submenu.; subCheckItem - The id of the checkbox item in the submenu.; checkItemValue - The checkbox item value to be set - "true" to select the checkbox item (default), "false" to deselect.
Author:: QFS
Since:: 4.0

Procedure: "setSubCheckItemWithCoordinates"

Select a checkbox menu item within a submenu of a popup menu. You can specify the coordinates for clicking.

Parameters:: client - The name of the SUT client.; item - The id of item to open the submenu.; subCheckItem - The id of the checkbox item in the submenu.; checkItemValue - The checkbox item value to be set - "true" to select the checkbox item (default), "false" to deselect.; itemX - The x coordinate for the click on the item, default is empty to click in the middle.; itemY - The y coordinate for the click on the item, default is empty to click in the middle.; subCheckItemX - The x coordinate for the click on the checkbox item, default is empty to click in the middle.; subCheckItemY - The y coordinate for the click on the checkbox item, default is empty to click in the middle.
Author:: QFS
Since:: 4.0

Package: "radiobutton"

Procedures to set and get the state of radio buttons. (fx component javax.fx.JRadioButton)

Author:: QFS,mm
Since:: 4.0

	Procedure/Dependency	Description
	getValue	Return the value of a radio button.
	select	Select a radio button.
	selectWithCoordinates	Select a radio button.

Procedure: "getValue"

Return the value of a radio button. It's either 1, if radio button is selected of 0, if radio button is not selected.

Parameters:: id - ID of the radio button.
Returns:: The state of the checkbox.
Author:: QFS,mm
Since:: 4.0

Procedure: "select"

Select a radio button. If the radio button is already selected, no action is performed.

Parameters:: id - The id of the radio button.
Author:: QFS,mm
Since:: 4.0

Procedure: "selectWithCoordinates"

Select a radio button. If the radio button is already selected, no action is performed. You can specify the coordinates for clicking.

Parameters:: id - The id of the radio button.; x - The x coordinate for the click, default is empty to click in the middle.; y - The y coordinate for the click, default is empty to click in the middle.
Author:: QFS,mm
Since:: 4.0

Package: "slider"

Procedures to access sliders. (fx component javafx.scene.control.Slider)

Author:: QFS, mm
Since:: 4.0

	Procedure/Dependency	Description
	getValue	Return the value of a slider component.
	setValue	Set the value of a slider component.

Procedure: "getValue"

Return the value of a slider component.

Parameters:: id - The component ID of the slider.
Returns:: The current value of the slider.
Author:: QFS, mm
Since:: 4.0

Procedure: "setValue"

Set the value of a slider component.

Parameters:: id - The component ID of the slider.; value - The value to set.
Author:: QFS, mm
Since:: 4.0

Package: "checks"

Procedure for checking slider values.

Author:: QFS, mm
Since:: 4.0

	Procedure/Dependency	Description
	checkValue	Check the value of a slider component.

Procedure: "checkValue"

Check the value of a slider component.

Parameters:: id - The component ID of the slider.; value - The value to be checked,; regexp - if this value is set to true, the text will be checks as regular expression.; negate - if, the check should check for anything but the given text.; nameCheckType - the value for "name of check type" attribute.; throwExc - whether the check should throw an exception on failure.; reportName - the Name for the check in the report.; timeout - Timeout for the checked condition to happen.
Author:: QFS, mm
Since:: 4.0

Package: "tabbedpane"

Procedures to work with TabbedPanes. (fx component javafx.scene.control.TabPane or any other TabFolder implementations)

Author:: QFS,mm
Since:: 4.0

	Procedure/Dependency	Description
	closeTab	Close a tab via a selection event.
	getIndexOfTab	Return the index of a given tab in a TabPane.
	getItemCount	Return the number of items of a given tabbedpane.
	getValueOfTab	Return the text of a given tab in a TabPane.
	selectTab	Select a tab in a given TabPane.

Procedure: "closeTab"

Close a tab via a selection event.

Parameters:: id - ID of tab, which should be closed.
Author:: QFS,gs
Since:: 4.0

Procedure: "getIndexOfTab"

Return the index of a given tab in a TabPane.

Parameters:: client - The name of the SUT client.; id - The component ID of the tabbedpane.; separator - Separator to use for the tab syntax. Default is @ for text values, also available & for index and % for regexp.; value - The value to look for.
Returns:: The index of the tab.
Author:: QFS,mm
Since:: 4.0

Procedure: "getItemCount"

Return the number of items of a given tabbedpane.

Parameters:: id - The component ID of the tabbedpane.
Returns:: itemCount
Author:: QFS
Since:: 5.3.1

Procedure: "getValueOfTab"

Return the text of a given tab in a TabPane.

Parameters:: client - The name of the SUT client.; id - The component ID of the tabbedpane.; separator - Separator to use for the tab syntax. Default is @ for text values, also available & for index and % for regexp.; value - The index to look for.
Returns:: The value of the tab.
Author:: QFS,mm
Since:: 4.0

Procedure: "selectTab"

Select a tab in a given TabPane.

Parameters:: client - The name of the SUT client.; id - The component ID of the tabbedpane to select.; separator - Separator to use for the tab syntax. Default is @ for text values, also available & for index and % for regexp.; value - The value to select.
Author:: QFS,mm
Since:: 4.0

Package: "table"

Procedures to access tables. (fx component javafx.scene.control.TableView)

Author:: QFS,mm
Since:: 4.0

	Procedure/Dependency	Description
	clickCellWithDetails	Select a given cell.
	getColumnCount	Return the number of columns of a given table.
	getIndexOfColumn	Return the current index of a given column.
	getNameOfColumn	Return the header text of a given column.
	getRowCount	Return the number of rows of a given table.
	getRowIndexOfCell	Return the row number of a given cell.
	getValueOfCell	Return the text of a given cell.
	resizeColumn	Resize width of a table column.
	selectCell	Select a given cell.

Procedure: "clickCellWithDetails"

Select a given cell. You can specify the coordinates for clicking and all other details of that mouse click.

Parameters:: id - ID of the table.; column - The column.; row - The row.; columnSeparator - Separator to use for the column syntax. Default is @ for text values, also available & for index and % for regexp.; rowSeparator - Separator to use for the row syntax. Default is @ for text values, also available & for index and % for regexp.; x - The x coordinate for the click, default is empty to click in the middle.; y - The y coordinate for the click, default is empty to click in the middle.; clickCount - Number of clicks. Default is 1. For a double click set this to 2.; modifier - Modifier for mouse key. 4 for right mouse. 16 for left mouse.; hard - True, if hard event should be replayed. Default is false.; popupTrigger - True, if click should open a popup. Default is false.
Author:: QFS,mm
Since:: 4.0

Procedure: "getColumnCount"

Return the number of columns of a given table. It uses the method getColumns().size() to get the number.

Parameters:: id - The component ID of the table.
Returns:: columnCount
Author:: QFS,mm
Since:: 4.0

Procedure: "getIndexOfColumn"

Return the current index of a given column.

Sample usage: Can be used to determine the numeric index of a column like 'Price'.

Parameters:: id - ID of the table.; column - The column.; columnSeparator - Separator to use for the column syntax. Default is @ for text values, also available & for index and % for regexp.
Returns:: index The current index of the column, which has been read by the 'Fetch Index' node of QF-Test.
Author:: QFS,mm
Since:: 4.0

Procedure: "getNameOfColumn"

Return the header text of a given column.

Sample usage: Determine the title of the second column.

Parameters:: id - ID of the table.; column - The column.; columnSeparator - Separator to use for the column syntax. Default is @ for text values, also available & for index and % for regexp.
Returns:: name The name of the column.
Author:: QFS,mm
Since:: 4.0

Procedure: "getRowCount"

Return the number of rows of a given table. It uses the method getItems().size() to get the number.

Parameters:: id - The component id of the table.
Returns:: rowCount
Author:: QFS,ue
Since:: 4.0

Procedure: "getRowIndexOfCell"

Return the row number of a given cell.

Sample usage: Can be used to determine in which row a dedicated cell is located.

Parameters:: id - ID of the table.; column - The column.; row - The row.; columnSeparator - Separator to use for the column syntax. Default is @ for text values, also available & for index and % for regexp.; rowSeparator - Separator to use for the row syntax. Default is @ for text values, also available & for index and % for regexp.
Returns:: index The current index of the row, which has been read by the 'Fetch Index' node of QF-Test.
Author:: QFS,mm
Since:: 4.0

Procedure: "getValueOfCell"

Return the text of a given cell.

Sample usage: Can be used to determine the text of the cell in the first column and first row.

Parameters:: id - ID of the table.; column - The column.; row - The row.; columnSeparator - Separator to use for the column syntax. Default is @ for text values, also available & for index and % for regexp.; rowSeparator - Separator to use for the row syntax. Default is @ for text values, also available & for index and % for regexp.
Returns:: value The current value of the row, which has been read by the 'Fetch text' node of QF-Test.
Author:: QFS,mm
Since:: 4.0

Procedure: "resizeColumn"

Resize width of a table column.

Parameters:: client - The name of the client.; idColumn - The id of the table column to be resized.; width - The new width - additional or absolute, dependent on the 'absolute' parameter. For additional width also negative values are possible to shrink the column size.; absolute - True, if the with value shall be the absolute new column width (default is 'true').
Author:: QFS,mm
Since:: 4.0

Procedure: "selectCell"

Select a given cell.

Parameters:: id - ID of the table.; column - The column.; row - The row.; columnSeparator - Separator to use for the column syntax. Default is @ for text values, also available & for index and % for regexp.; rowSeparator - Separator to use for the row syntax. Default is @ for text values, also available & for index and % for regexp.
Author:: QFS,mm
Since:: 4.0

Package: "checkbox"

Procedures to set the state of checkboxes in a table cell. These procedures become necessary, because checkboxes in tables cannot be treated like normal checkboxes.

Author:: QFS,mm
Since:: 4.0

	Procedure/Dependency	Description
	deselect	Deselect a checkbox in a table cell.
	deselectWithCoordinates	Deselect a checkbox in a table cell.
	select	Select a checkbox in a table cell.
	selectWithCoordinates	Select a checkbox in a table cell.
	set	Set checkbox in a table cell to the given state.
	setWithCoordinates	Set checkbox in a table cell to the given state.

Procedure: "deselect"

Deselect a checkbox in a table cell. If the checkbox is already deselected, no action is performed.

Parameters:: client - The name of the SUT client.; id - The id of the checkbox, including the table id and the addressing of the cell.
Author:: QFS,gs
Since:: 4.0

Procedure: "deselectWithCoordinates"

Deselect a checkbox in a table cell. If the checkbox is already deselected, no action is performed. You can specify the coordinates (relative to the table cell) for clicking.

Parameters:: client - The name of the SUT client.; id - The id of the checkbox, including the table id and the addressing of the cell.; x - The x coordinate for the click, default is empty to click in the middle.; y - The y coordinate for the click, default is empty to click in the middle.
Author:: QFS,gs
Since:: 4.0

Procedure: "select"

Select a checkbox in a table cell. If the checkbox is already selected, no action is performed.

Parameters:: client - The name of the SUT client.; id - The id of the checkbox, including the table id and the addressing of the cell.
Author:: QFS,gs
Since:: 4.0

Procedure: "selectWithCoordinates"

Select a checkbox in a table cell. If the checkbox is already selected, no action is performed. You can specify the coordinates (relative to the table cell) for clicking.

Parameters:: client - The name of the SUT client.; id - The id of the checkbox, including the table id and the addressing of the cell.; x - The x coordinate for the click, default is empty to click in the middle.; y - The y coordinate for the click, default is empty to click in the middle.
Author:: QFS,gs
Since:: 4.0

Procedure: "set"

Set checkbox in a table cell to the given state.

Parameters:: client - The name of the SUT client.; id - The id of the checkbox, including the table id and the addressing of the cell.; check - The check value to be set (either true or false).
Author:: QFS,mm
Since:: 4.0

Procedure: "setWithCoordinates"

Set checkbox in a table cell to the given state. You can specify the coordinates for clicking.

Parameters:: client - The name of the SUT client.; id - The id of the checkbox, including the table id and the addressing of the cell.; check - The check value to be set (either true or false).; x - The x coordinate for the click, default is empty to click in the middle.; y - The y coordinate for the click, default is empty to click in the middle.
Author:: QFS,mm
Since:: 4.0

Package: "checks"

Procedures for checking a table.

Author:: QFS,mm
Since:: 4.0

	Procedure/Dependency	Description
	checkNumberOfRows	Check the number of rows of a given table according to a specified comparison mode.

Procedure: "checkNumberOfRows"

Check the number of rows of a given table according to a specified comparison mode. It uses the method getItems().size() to get the number.

Sample usage: You can check, that a table has exactly 6 rows or that the table has less then 10 rows.

Parameters:: id - The id of the table.; compareValue - The comparison value.; compareMode - The comparison mode = or ==, if the compareValue should be equal than the actual amount of rows. <, if the compareValue should be greater than the actual amount of rows. >, if the compareValue should be less than the actual amount of rows. <=, if the compareValue should be greater or equal than the actual amount of rows. >=, if the compareValue should be less or equal the actual amount of rows. !=, if the compareValue should be not equal the actual amount of items.; errorLevel - The kind of error, which should be logged. Either EXCEPTION, ERROR, WARNING or MESSAGE.; appearInReport - Flag, whether to show check in report, if a message or warning are set as errorLevel. If this is set to 1, the check will be shown in the report.
Exceptions:: UserException - if wrong comparison mode has been set.
Author:: QFS,mm
Since:: 4.0

Package: "selection"

Procedures to (de-)select certain rows of a table.

Author:: QFS,mm
Since:: 4.0

	Procedure/Dependency	Description
	deselectAllRows	Deselect all rows.
	deselectRow	Deselect a given row, specified by its index.
	deselectRowRange	Deselect a range of rows, specified by their index.
	selectAllRows	Select all rows.
	selectRow	Select a given row, specified by its index.
	selectRowRange	Select a range of rows, specified by their index.

Procedure: "deselectAllRows"

Deselect all rows. It uses getSelectionModel().clearSelection().

Parameters:: id - ID of the table.
Author:: QFS,mm
Since:: 4.0

Procedure: "deselectRow"

Deselect a given row, specified by its index. It uses clearSelection(row).

Parameters:: id - ID of the table.; row - The index of the row.
Author:: QFS,mzs
Since:: 4.0

Procedure: "deselectRowRange"

Deselect a range of rows, specified by their index. It uses clearSelection(row).

Parameters:: id - ID of the table.; startRow - The index of first row to be selected.; endRow - The index of last row to be selected.
Author:: QFS,mzs
Since:: 4.0

Procedure: "selectAllRows"

Select all rows. It uses selectAll()

Parameters:: id - ID of the table.
Author:: QFS,mzs
Since:: 4.0

Procedure: "selectRow"

Select a given row, specified by its index. It uses select(row).

Parameters:: id - ID of the table.; row - The index of the row.
Author:: QFS,mm
Since:: 4.0

Procedure: "selectRowRange"

Select a range of rows, specified by their index. It uses selectRange.

Parameters:: id - ID of the table.; startRow - The index of first row to be selected.; endRow - The index of last row to be selected.
Author:: QFS,mzs
Since:: 4.0

Package: "text"

Procedures to access text fields and text areas. (fx components javafx.scene.control.TextField and javafx.scene.control.TextArea)

Author:: QFS,mm
Since:: 4.0

	Procedure/Dependency	Description
	clearArea	Clear a multi-line text area.
	clearField	Clear a simple text field.
	getText	Return the text of a given textfield.
	setText	Set a given text to a given text-field or text-area.
	setTextFromFile	Read the content of a given file and set its content to a given text-field.

Procedure: "clearArea"

Clear a multi-line text area.

Parameters:: client - The name of the SUT client.; id - The id of the text area.
Author:: QFS,mm
Since:: 4.0

Procedure: "clearField"

Clear a simple text field.

Parameters:: client - The name of the SUT client.; id - The id of the text field.
Author:: QFS,mm
Since:: 4.0

Procedure: "getText"

Return the text of a given textfield.

Parameters:: id - ID of the textfield.
Returns:: The text of the textfield. Variables in this string will not be automatically expanded.
Author:: QFS,mm
Since:: 4.0

Procedure: "setText"

Set a given text to a given text-field or text-area.

If the text is empty, no action will take place.

Parameters:: id - ID of the textfield.; text - Text to be set.; append - If this value is set to true, the text will be appended to the current values.; clear - If this value is set to true, the text-field will be cleared in case an empty string is given as parameter "text".; replaySingleEvents - If this value is set to true, the text will be inserted replaying single events.; newline - the separator sign for marking a linebreak within the text
Author:: QFS,mm
Since:: 4.0

Procedure: "setTextFromFile"

Read the content of a given file and set its content to a given text-field.

Parameters:: id - The id of the text-field to set.; file - The path to the file.; append - If this value is set to true, the text will be appended to the current values.; clear - If this value is set to true, the text-field will be cleared in case an empty string is given as parameter "text".; replaySingleEvents - If this value is set to true, the text will be inserted replaying single events.; newline - the separator sign for marking a linebreak within the text
Author:: QFS,mm
Since:: 4.0

Package: "tree"

Procedures to access trees. (fx component javafx.scene.control.TreeView)

Author:: QFS,mm
Since:: 4.0

	Procedure/Dependency	Description
	clickNodeWithDetails	Select a given node.
	collapse	Collapse a tree node.
	collapseNode	Collapse a tree node.
	collapseNodes	Collapse a tree node recursively.
	collapseNodeWithCoordinates	Collapse a tree node.
	collapseWithCoordinates	Collapse a tree node.
	expand	Expand a tree node.
	expandNode	Expand a tree node.
	expandNodes	Expand a tree node recursively.
	expandNodeWithCoordinates	Expand a tree node.
	expandWithCoordinates	Expand a tree node.
	getChildNodeCount	Return the number of child nodes.
	getIndexOfNode	Return the current index of a given node.
	getRowCount	Return the number of visible nodes under a given tree or tree node.
	getValueOfNode	Return the text of a given node.
	selectNode	Select a given node.

Procedure: "clickNodeWithDetails"

Select a given node. You can specify the coordinates for clicking and all other details of that mouse click.

Parameters:: id - ID of the tree.; node - The node, e.g. '/Root/Price' or '/0/0'.; separator - Separator to use for the node syntax. Default is @ for text values, also available & for index and % for regexp.; x - The x coordinate for the click, default is empty to click in the middle.; y - The y coordinate for the click, default is empty to click in the middle.; clickCount - Number of clicks. Default is 1. For a double click set this to 2.; modifier - Modifier for mouse key. 4 for right mouse. 16 for left mouse.; hard - True, if hard event should be replayed. Default is false.; popupTrigger - True, if click should open a popup. Default is false
Author:: QFS,mm
Since:: 4.0

Procedure: "collapse"

Collapse a tree node. It clicks on the tree node, replays a left key press event and selects the node again. If your tree doesn't support keyboard actions to collapse a node, this procedure won't work.

Parameters:: client - The name of the SUT client.; node - The id of the tree node to collapse.
Author:: QFS,mm
Since:: 4.0

Procedure: "collapseNode"

Parameters:: client - The name of the SUT client.; id - The id of the tree.; node - The node, e.g. like '/Root/Price' or '/0/0'.; separator - Separator to use for the node syntax. Default is @ for text values, also available & for index and % for regexp.
Author:: QFS,mm
Since:: 4.0

Procedure: "collapseNodes"

Collapse a tree node recursively.

Parameters:: id - The id of the tree node.
Author:: QFS,gs
Since:: 4.0

Procedure: "collapseNodeWithCoordinates"

Parameters:: client - The name of the SUT client.; id - The id of the tree.; node - The node, e.g. like '/Root/Price' or '/0/0'.; separator - Separator to use for the node syntax. Default is @ for text values, also available & for index and % for regexp.; x - The x coordinate for the click, default is empty to click in the middle.; y - The y coordinate for the click, default is empty to click in the middle.
Author:: QFS,mm
Since:: 4.0

Procedure: "collapseWithCoordinates"

Parameters:: client - The name of the SUT client.; node - The id of the tree node to collapse.; x - The x coordinate for the click, default is empty to click in the middle.; y - The y coordinate for the click, default is empty to click in the middle.
Author:: QFS,mm
Since:: 4.0

Procedure: "expand"

Expand a tree node. It clicks on the tree node, replays a right key press event and selects the node again. If your tree doesn't support keyboard actions to expand a node, this procedure won't work.

Parameters:: client - The name of the SUT client.; node - The id of the tree node to expand.
Author:: QFS,mm
Since:: 4.0

Procedure: "expandNode"

Expand a tree node. It clicks on the tree node, replays a right key press event and selects the node again. If your tree doesn't support keyboard actions to expand a node, this procedure won't work.

Parameters:: client - The name of the SUT client.; id - The id of the tree.; node - The node, e.g. '/Root/Price' or '/0/0'.; separator - Separator to use for the node syntax. Default is @ for text values, also available & for index and % for regexp.
Author:: QFS,mm
Since:: 4.0

Procedure: "expandNodes"

Expand a tree node recursively.

Parameters:: id - The id of the tree node.; callbackProc - The name of a procedure to be called for every visited node.; script - True to expand via script, in which case there are no callbacks.
Author:: QFS,gs
Since:: 4.0

Procedure: "expandNodeWithCoordinates"

Expand a tree node. It clicks on the tree node, replays a right key press event and selects the node again. If your tree doesn't support keyboard actions to expand a node, this procedure won't work. You can specify the coordinates for clicking.

Parameters:: client - The name of the SUT client.; id - The id of the tree.; node - The node, e.g. '/Root/Price' or '/0/0'.; separator - Separator to use for the node syntax. Default is @ for text values, also available & for index and % for regexp.; x - The x coordinate for the click, default is empty to click in the middle.; y - The y coordinate for the click, default is empty to click in the middle.
Author:: QFS,mm
Since:: 4.0

Procedure: "expandWithCoordinates"

Parameters:: client - The name of the SUT client.; node - The id of the tree node to expand.; x - The x coordinate for the click, default is empty to click in the middle.; y - The y coordinate for the click, default is empty to click in the middle.
Author:: QFS,mm
Since:: 4.0

Procedure: "getChildNodeCount"

Return the number of child nodes.

Parameters:: id - The component id of the tree.; node - The node. like '/Root/Price' or '/0/0'. If no node is specified, QF-Test will count the items of the root node.; nodeSeparator - Separator to use for the node syntax. Default is @ for text values, also available & for index and % for regexp.; countOnlyVisibleNodes - If true, only visible children will be taken into account. Otherwise also invisible children. If the node itself is invisible QF-Test tries to expand that node before performing the count operation.
Returns:: nodeCount
Author:: QFS,mm
Since:: 4.1

Procedure: "getIndexOfNode"

Return the current index of a given node.

Sample usage: Can be used to determine the numeric index of a node like '/Root/Price'.

Parameters:: id - ID of the tree.; node - The node. like '/Root/Price' or '/0/0'.; nodeSeparator - Separator to use for the node syntax. Default is @ for text values, also available & for index and % for regexp.; linear - If true, return the linear index, ignoring the tree structure, otherwise return a hierarchical index like /0/1.
Returns:: index The current index of the node, which has been read by the 'Fetch Index' node of QF-Test.
Author:: QFS,mm
Since:: 4.0

Procedure: "getRowCount"

Return the number of visible nodes under a given tree or tree node. If no node is specified, you will get the visible nodes or all loaded nodes of the entire tree.

Parameters:: id - The component id of the tree.; node - The node. like '/Root/Price' or '/0/0'. If no node is specified, QF-Test will count the nodes of the root node.; nodeSeparator - Separator to use for the node syntax. Default is @ for text values, also available & for index and % for regexp.; countOnlyVisibleNodes - If true, only visible children will be taken into account. Otherwise also invisible children. If the node itself is invisible QF-Test tries to expand that node before performing the count operation.
Returns:: rowCount
Author:: QFS,mm
Since:: 4.1

Procedure: "getValueOfNode"

Return the text of a given node.

Sample usage: Determine the text value for a node referenced by index like /0/1.

Parameters:: id - ID of the tree.; node - The node. It should be something like '/Root/Price' or '/0/0'.; nodeSeparator - Separator to use for the node syntax. Default is @ for text values, also available & for index and % for regexp.
Returns:: name The value of the node.
Author:: QFS,mm
Since:: 4.0

Procedure: "selectNode"

Select a given node.

Parameters:: id - ID of the tree.; node - The node, e.g. '/Root/Price' or '/0/0'.; separator - Separator to use for the node syntax. Default is @ for text values, also available & for index and % for regexp.
Author:: QFS,mm
Since:: 4.0

Package: "checks"

Procedures for checking a tree.

Author:: QFS,mm
Since:: 3.1.1

	Procedure/Dependency	Description
	checkNumberOfChildNodes	Check the number of child nodes of a given tree node according to a specified comparison mode.
	checkNumberOfRows	Check the number of visible nodes under a given tree or tree node according to a specified comparison mode.

Procedure: "checkNumberOfChildNodes"

Check the number of child nodes of a given tree node according to a specified comparison mode.

Sample usage: You can check, that a tree has exactly 6 visible rows or that the tree has less then 10 visible rows.

Parameters:: id - The id of the tree.; node - The node. like '/Root/Price' or '/0/0'. Leave empty, if you want to count rows of whole tree.; nodeSeparator - Separator to use for the node syntax. Default is @ for text values, also available & for index and % for regexp.; countOnlyVisibleNodes - If true, only visible children will be taken into account. Otherwise also invisible children. If the node itself is invisible QF-Test tries to expand that node before performing the count operation.; compareValue - The comparison value.; compareMode - The comparison mode = or ==, if the compareValue should be equal than the actual amount of rows. <, if the compareValue should be greater than the actual amount of rows. >, if the compareValue should be less than the actual amount of rows. <=, if the compareValue should be greater or equal than the actual amount of rows. >=, if the compareValue should be less or equal the actual amount of rows. !=, if the compareValue should be not equal the actual amount of items.; errorLevel - The kind of error, which should be logged. Either EXCEPTION, ERROR, WARNING or MESSAGE.; appearInReport - Flag, whether to show check in report, if a message or warning are set as errorLevel. If this is set to 1, the check will be shown in the report.
Exceptions:: UserException, - if wrong comparison mode has been set.
Author:: QFS,mm
Since:: 4.1

Procedure: "checkNumberOfRows"

Check the number of visible nodes under a given tree or tree node according to a specified comparison mode. If no node is specified, you will get the visible nodes or all loaded nodes.

Sample usage: You can check, that a tree has exactly 6 visible rows or that the tree has less then 10 visible rows.

Parameters:: id - The id of the tree.; node - The node. like '/Root/Price' or '/0/0'. Leave empty, if you want to count rows of whole tree.; nodeSeparator - Separator to use for the node syntax. Default is @ for text values, also available & for index and % for regexp.; countOnlyVisibleNodes - If true, only visible children will be taken into account. Otherwise also invisible children. If the node itself is invisible QF-Test tries to expand that node before performing the count operation.; compareValue - The comparison value.; compareMode - The comparison mode = or ==, if the compareValue should be equal than the actual amount of rows. <, if the compareValue should be greater than the actual amount of rows. >, if the compareValue should be less than the actual amount of rows. <=, if the compareValue should be greater or equal than the actual amount of rows. >=, if the compareValue should be less or equal the actual amount of rows. !=, if the compareValue should be not equal the actual amount of items.; errorLevel - The kind of error, which should be logged. Either EXCEPTION, ERROR, WARNING or MESSAGE.; appearInReport - Flag, whether to show check in report, if a message or warning are set as errorLevel. If this is set to 1, the check will be shown in the report.
Exceptions:: UserException, - if wrong comparison mode has been set.
Author:: QFS,mm
Since:: 3.1.1

Package: "ios"

Contains procedures to test iOS applications as well as useful procedures for controlling ios simulator and devices.

Author:: QFS
Since:: 8.0

Package: "checkbox"

Procedures to set the state of checkboxes (= switches).

Author:: QFS
Since:: 8.0

	Procedure/Dependency	Description
	deselect	Deselect a checkbox.
	deselectWithCoordinates	Deselect a checkbox.
	getValue	Return the value of a checkbox.
	select	Select a checkbox.
	selectWithCoordinates	Select a checkbox.
	set	Set checkbox to the given state.
	setWithCoordinates	Set checkbox to the given state.

Procedure: "deselect"

Deselect a checkbox. If the checkbox is already deselected, no action is performed.

Parameters:: id - The id of the checkbox.
Author:: QFS
Since:: 8.0

Procedure: "deselectWithCoordinates"

Deselect a checkbox. If the checkbox is already deselected, no action is performed. You can specify the coordinates for clicking.

Parameters:: id - The id of the checkbox.; x - The x coordinate for the click, default is empty to click in the middle.; y - The y coordinate for the click, default is empty to click in the middle.
Author:: QFS
Since:: 8.0

Procedure: "getValue"

Return the value of a checkbox. It's either 1, if box is selected or 0, if box is not selected.

Parameters:: id - ID of the checkbox.
Returns:: The state of the checkbox.
Author:: QFS
Since:: 8.0

Procedure: "select"

Select a checkbox. If the checkbox is already selected, no action is performed.

Parameters:: id - The id of the checkbox.
Author:: QFS
Since:: 8.0

Procedure: "selectWithCoordinates"

Select a checkbox. If the checkbox is already selected, no action is performed. You can specify the coordinates for clicking.

Parameters:: id - The id of the checkbox.; x - The x coordinate for the click, default is empty to click in the middle.; y - The y coordinate for the click, default is empty to click in the middle.
Author:: QFS
Since:: 8.0

Procedure: "set"

Set checkbox to the given state.

Parameters:: id - The id of the checkbox.; check - The check value to be set (either true or false).
Author:: QFS
Since:: 8.0

Procedure: "setWithCoordinates"

Set checkbox to the given state. You can specify the coordinates for clicking.

Parameters:: id - The id of the checkbox.; check - The check value to be set (either true or false).; x - The x coordinate for the click, default is empty to click in the middle.; y - The y coordinate for the click, default is empty to click in the middle.
Author:: QFS
Since:: 8.0

Package: "clipboard"

Accessing the device clipboard from procedures.

Author:: QFS
Since:: 8.0.0

	Procedure/Dependency	Description
	getClipboardContent	Gets the content of the primary clipboard on the device.
	setClipboardContent	Sets the primary clipboard's content on the device.

Procedure: "getClipboardContent"

Gets the content of the primary clipboard on the device.

Parameters:: contentType - The type of the content to get. Valid types are "plaintext", "image" or "url".; decodePlaintext - If true and the content type is "plaintext" the clipboard content will be decoded as a normal string.
Returns:: The actual content of the clipboard, encoded as a base64 string, unless decodePlaintext is set, in which case a normal string can also be returned. Variables in this string will not be automatically expanded.
Author:: QFS
Since:: 8.0.0

Procedure: "setClipboardContent"

Sets the primary clipboard's content on the device.

Parameters:: content - The content to be set as base64 encoded string.; contentType - The type of the content to set. Valid types are "plaintext", "image" or "url".; encodePlaintext - If true and the content type is "plaintext" the content will be encoded as base64 string.
Author:: QFS
Since:: 8.0.0

Package: "device"

Contains procedures to control iOS simulator and devices.

Author:: QFS
Since:: 8.0

	Procedure/Dependency	Description
	getRotation	Get the rotation of the device.
	getUdid	Get the udid of the connected device.
	home	Return to the home screen of the iOS device.
	isLocked	Checks if the iOS device is locked.
	listAll	Lists all iOS devices.
	lock	Locks the (simulated) iOS device
	setRotation	Set the rotation of the device.
	unlock	Unlocks the (simulated) iOS device

Procedure: "getRotation"

Get the rotation of the device.

Returns:: direction in degree as string 0, 90, 180, 270
Author:: QFS
Since:: 8.0

Procedure: "getUdid"

Get the udid of the connected device.

Returns:: The udid of the connected device.
Author:: QFS
Since:: 8.0

Procedure: "home"

Return to the home screen of the iOS device.

Author:: QFS
Since:: 8.0

Procedure: "isLocked"

Checks if the iOS device is locked.

Parameters:: client - The name of the SUT client.; expected - The expected lock state. If empty, no check is performed.; throwExc - Whether to throw an exception if the check fails
Returns:: true if the device is locked, false otherwise
Exceptions:: ClientNotConnectedException - If SUT wasn't started this exception will be thrown.
Author:: QFS
Since:: 8.0

Procedure: "listAll"

Lists all iOS devices.

Writes list as information to the run log and returns a parsable list of names.

Parameters:: includeSimulators - If true, simulator are included in the result; includeDevices - If true, real devices are included in the result; asJson - If true, return the result as JSON formated data
Author:: QFS
Since:: 8.0

Procedure: "lock"

Locks the (simulated) iOS device

Author:: QFS
Since:: 8.0

Procedure: "setRotation"

Set the rotation of the device.

Parameters:: rotation - The rotation in degree valid values: 0,90,180,270 0 = reset to the default position
Author:: QFS
Since:: 8.0

Procedure: "unlock"

Unlocks the (simulated) iOS device

Author:: QFS
Since:: 8.0

Package: "apps"

Procedures for controlling iOS applications

Author:: QFS
Since:: 8.0

	Procedure/Dependency	Description
	getActiveBundleId	Returns the bundleId of the application currently running on the device.
	getActiveName	Returns the name of the application currently running on the device (or empty, if no name can be assigned).
	getBundleId	Returns the bundleId of an app.
	install	Installs an application on the device.
	list	Lists all apps on the device
	remove	Removes an application from the device.
	start	Start an application already installed on the device.
	stop	Stops a running application on the device.

Procedure: "getActiveBundleId"

Returns the bundleId of the application currently running on the device.

Author:: QFS
Since:: 8.0

Procedure: "getActiveName"

Returns the name of the application currently running on the device (or empty, if no name can be assigned).

Author:: QFS
Since:: 8.0

Procedure: "getBundleId"

Returns the bundleId of an app.

Parameters:: appName - The name of the app.; throwExc - True, whether procedure should throw an exception if component didn't appear.
Author:: QFS
Since:: 8.0

Procedure: "install"

Installs an application on the device.

Parameters:: appFile - The path of the app to install. Can be an .app bundle, a .ipa archive or a zip file containing the bundle; start - Set to "true" to automatically start the app after installation
Author:: QFS
Since:: 8.0

Procedure: "list"

Lists all apps on the device

Writes list as information to the run log and returns a parsable list of bundleIds.

Author:: QFS
Since:: 8.0

Procedure: "remove"

Removes an application from the device. At least the name of the app or the bundleId must be specified.

Parameters:: bundleId - The bundle id of the app to remove.; appName - The name of the app to remove, if bundleId is empty.
Author:: QFS
Since:: 8.0

Procedure: "start"

Start an application already installed on the device. At least the name of the app or the bundleId must be specified.

Parameters:: bundleId - The bundle id of the app to stop.; appName - The name of the app to stop, if bundleId is empty.
Author:: QFS
Since:: 8.0

Procedure: "stop"

Stops a running application on the device. At least the name of the app or the bundleId must be specified.

Parameters:: bundleId - The bundle id of the app to stop.; appName - The name of the app to stop, if bundleId is empty.
Author:: QFS
Since:: 8.0

Package: "gesture"

Procedures for iOS gestures like pinch, swipe, ...

Author:: QFS
Since:: 8.0

	Procedure/Dependency	Description
	pinch	Perform a two finger pinch action.
	zoom	Perform a two finger zoom action.

Procedure: "pinch"

Perform a two finger pinch action.

Parameters:: finger1X - position X of the first finger; finger1Y - position Y of the first finger; finger2X - position X of the second finger; finger2Y - position Y of the second finger
Author:: QFS
Since:: 8.0

Procedure: "zoom"

Perform a two finger zoom action.

Parameters:: startX - position X of the start point; startY - position Y of the start point; range - moving range; angle - moving angle 0 = horizontal
Author:: QFS
Since:: 8.0

Package: "general"

Procedures which work for any iOS element

Author:: QFS
Since:: 8.0

	Procedure/Dependency	Description
	clickAtComponent	Click on a given component, but only if the according parameter is set to true.
	clickAtComponentWithDetails	Click on a given component, but only if the according parameter is set to true.
	doClick	Click on a given component.
	doClickWithDetails	Click on a given component.
	doDoubleClick	Double click on a given component.
	doLongClick	Long click on a given component.
	type	Types in some text on the currently selected input element
	waitForComponent	Wait for a given component.
	waitForComponentForAbsence	Wait till a given component disappears.

Procedure: "clickAtComponent"

Click on a given component, but only if the according parameter is set to true.

Parameters:: id - The Id of the target component.; click - If this is set to true, the click will be performed, otherwise nothing happens.
Author:: QFS
Since:: 8.0

Procedure: "clickAtComponentWithDetails"

Click on a given component, but only if the according parameter is set to true. You can specify the coordinates for clicking within the component.

Parameters:: id - The Id of the target component.; click - If this is set to true, the click will be performed, otherwise nothing happens.; x - The x coordinate for the click, default is empty to click in the middle.; y - The y coordinate for the click, default is empty to click in the middle.; clickCount - Number of clicks. Default is 1. For a double click set this to 2.
Author:: QFS
Since:: 8.0

Procedure: "doClick"

Click on a given component.

Parameters:: id - The Id of the target component.
Author:: QFS
Since:: 8.0

Procedure: "doClickWithDetails"

Click on a given component. You can specify the coordinates for clicking within the component.

Parameters:: id - The Id of the target component.; x - The x coordinate for the click, default is empty to click in the middle.; y - The y coordinate for the click, default is empty to click in the middle.; clickCount - Number of clicks. Default is 1. For a double click set this to 2.
Author:: QFS
Since:: 8.0

Procedure: "doDoubleClick"

Double click on a given component.

Parameters:: id - The Id of the target component.
Author:: QFS
Since:: 8.0

Procedure: "doLongClick"

Long click on a given component.

Parameters:: id - The Id of the target component.; duration - How long the tap should be (in ms). Defaults to 600ms
Author:: QFS
Since:: 8.0

Procedure: "type"

Types in some text on the currently selected input element

Parameters:: text - The text to type
Author:: QFS
Since:: 8.0

Procedure: "waitForComponent"

Wait for a given component.

Parameters:: id - The Id of the target component.; timeout - The timeout to wait for that component; throwExc - True, whether procedure should throw an exception if component didn't appear.
Author:: QFS
Since:: 8.0

Procedure: "waitForComponentForAbsence"

Wait till a given component disappears.

Parameters:: id - The Id of the target component.; timeout - The timeout to wait for that component; throwExc - True, whether procedure should throw an exception if component didn't disappear.
Author:: QFS
Since:: 8.0

Package: "idbUtils"

Procedures for executing commands with the iOS Development Bridge (IDB) tool.

Author:: QFS
Since:: 8.0

	Procedure/Dependency	Description
	getIdbPath	Get the path to the idb binary.
	runIdbCommand	Run idb command.

Procedure: "getIdbPath"

Get the path to the idb binary.

Returns:: The path to the idb binary.
Author:: QFS
Since:: 8.0

Procedure: "runIdbCommand"

Run idb command.

Parameters:: command - the idb command to execute; retWithoutNewline - if the return value should cut "\n" default:false
Returns:: The stdout/stderr output of the program.
Author:: QFS
Since:: 8.0

Package: "list"

Procedures for accessing lists.

Author:: QFS
Since:: 8.0

	Procedure/Dependency	Description
	clickItemWithDetails	Select a given item by a mouse click on it.
	getIndexOfItem	Return the current index of a given item.
	getItemCount	Return the number of items of a given list.
	getValueOfItem	Return the text of a given item.
	scroll	Scroll to a particular element in the list.
	scrollByIndex	Scroll to a particular element in the list.
	scrollToBottom	Scroll to the top of the list.
	scrollToTop	Scroll to the top of the list.
	selectItem	Select a given item by a mouse click on it.

Procedure: "clickItemWithDetails"

Select a given item by a mouse click on it. You can specify the coordinates for clicking and all other details of that mouse click.

Parameters:: id - ID of the list.; item - The item.; itemSeparator - Separator to use for the item syntax. Default is @ for text values, also available & for index and % for regexp.; x - The x coordinate for the click, default is empty to click in the middle.; y - The y coordinate for the click, default is empty to click in the middle.; clickCount - Number of clicks. Default is 1. For a double click set this to 2.; modifier - Modifier for mouse key. 16 for right mouse. 4 for left mouse.; hard - True, if hard event should be replayed. Default is false.; popupTrigger - True, if click should open a popup. Default is false.
Author:: QFS
Since:: 8.0

Procedure: "getIndexOfItem"

Return the current index of a given item.

Sample usage: Can be used to determine the numeric index of an item like 'Price'.

Parameters:: id - ID of the list.; item - The item.; itemSeparator - Separator to use for the item syntax. Default is @ for text values, also available & for index and % for regexp.
Returns:: index The current index of the item related to the complete list, not only the visible part
Author:: QFS
Since:: 8.0

Procedure: "getItemCount"

Return the number of items of a given list.

Parameters:: id - The component ID of the list.
Returns:: itemCount
Author:: QFS
Since:: 8.0

Procedure: "getValueOfItem"

Return the text of a given item.

Sample usage: Determine the text of the second item.

Parameters:: id - ID of the list.; item - The item.; itemSeparator - Separator to use for the item syntax. Default is @ for text values, also available & for index and % for regexp.
Returns:: value The value of the item.
Author:: QFS
Since:: 8.0

Procedure: "scroll"

Scroll to a particular element in the list.

Parameters:: id - ID of the list.; item - The item to scroll to.; itemSeparator - The item separator (@, % or &).
Author:: QFS
Since:: 8.0

Procedure: "scrollByIndex"

Scroll to a particular element in the list.

Parameters:: id - ID of the list.; item - The item to scroll to.
Author:: QFS
Since:: 8.0

Procedure: "scrollToBottom"

Scroll to the top of the list.

Parameters:: id - ID of the list.
Author:: QFS
Since:: 8.0

Procedure: "scrollToTop"

Scroll to the top of the list.

Parameters:: id - ID of the list.
Author:: QFS
Since:: 8.0

Procedure: "selectItem"

Select a given item by a mouse click on it.

Parameters:: id - ID of the list.; item - The item.; itemSeparator - Separator to use for the item syntax. Default is @ for text values, also available & for index and % for regexp.; x - The x coordinate for the click, default is empty to click in the middle.; y - The x coordinate for the click, default is empty to click in the middle.
Author:: QFS
Since:: 8.0

Package: "checks"

Procedures for checking a list.

Author:: QFS
Since:: 8.0

	Procedure/Dependency	Description
	checkNumberOfItems	Check the number of items of a given list according to a specified comparison mode.

Procedure: "checkNumberOfItems"

Check the number of items of a given list according to a specified comparison mode.

Sample usage: You can check, that a list has exactly 6 items or that the table has less then 10 items.

Parameters:: id - The id of the list.; compareValue - The comparison value.; compareMode - The comparison mode = or ==, if the compareValue should be equal than the actual amount of items. <, if the compareValue should be greater than the actual amount of items. >, if the compareValue should be less than the actual amount of items. <=, if the compareValue should be greater or equal than the actual amount of items. >=, if the compareValue should be less or equal the actual amount of items. !=, if the compareValue should be not equal the actual amount of items.; errorLevel - The kind of error, which should be logged. Either EXCEPTION, ERROR, WARNING or MESSAGE.; appearInReport - Flag, whether to show check in report, if a message or warning are set as errorLevel. If this is set to 1, the check will be shown in the report.
Exceptions:: UserException, - if wrong comparison mode has been set.
Author:: QFS
Since:: 8.0

Package: "helpers"

Internal helpers.

Author:: QFS
Since:: 8.0

	Procedure/Dependency	Description
	registerHelper	Helper procedures to interact with iOS lists

Procedure: "registerHelper"

Helper procedures to interact with iOS lists

Package: "menu"

Procedures to select menu items

Author:: QFS
Since:: 8.0

	Procedure/Dependency	Description
	selectItem	Select an item from a menu.
	selectItemWithCoordinates	Select an item from a menu.

Procedure: "selectItem"

Select an item from a menu.

For example: for the File -> Open action, the component ID of "File" is the menu, and the ID for "Open" is the item.

Parameters:: menu - The id of the menu.; item - The id of menu item.
Author:: QFS
Since:: 8.0

Procedure: "selectItemWithCoordinates"

Select an item from a menu.

For example: for the File -> Open action, the component ID of "File" is the menu, and the ID for "Open" is the item.

Parameters:: menu - The id of the menu.; item - The id of menu item.; menuX - The x coordinate for the click on the menu, default is empty to click in the middle.; menuY - The y coordinate for the click on the menu, default is empty to click in the middle.; itemX - The x coordinate for the click on the item, default is empty to click in the middle.; itemY - The y coordinate for the click on the item, default is empty to click in the middle.
Author:: QFS
Since:: 8.0

Package: "radiobutton"

Procedures to get and set the state of radio buttons (= switches).

Author:: QFS
Since:: 8.0

	Procedure/Dependency	Description
	getValue	Return the value of a radio button.
	select	Select a radio button.
	selectWithCoordinates	Select a radio button.

Procedure: "getValue"

Return the value of a radio button. It's either 1, if radio button is selected of 0, if radio button is not selected.

Parameters:: id - ID of the radio button.
Returns:: The state of the checkbox.
Author:: QFS
Since:: 8.0

Procedure: "select"

Select a radio button. If the radio button is already selected, no action is performed.

Parameters:: id - The id of the radio button.
Author:: QFS
Since:: 8.0

Procedure: "selectWithCoordinates"

Select a radio button. If the radio button is already selected, no action is performed. You can specify the coordinates for clicking.

Parameters:: id - The id of the radio button.; x - The x coordinate for the click, default is empty to click in the middle.; y - The y coordinate for the click, default is empty to click in the middle.
Author:: QFS
Since:: 8.0

Package: "setup"

Helper procedures to check and set up the test environment for iOS testing.

Author:: QFS
Since:: 8.0

	Procedure/Dependency	Description
	checkEnvironment	Checks the current environment for being compatible with iOS tests.

Procedure: "checkEnvironment"

Checks the current environment for being compatible with iOS tests.

Parameters:: interactive - If true, dialogs are shown and tool installation is supported.; requirePythonVenv - If true, the installation of python tools in a virtual environment is required.
Author:: QFS
Since:: 8.0

Package: "homebrew"

Helper procedures to check and set up the homebrew tool for iOS testing.

Author:: QFS
Since:: 8.0

	Procedure/Dependency	Description
	checkVersion	Checks if a detected homebrew version is recent enough.
	getVersion	Get the version of the currently installed homebrew tool, if available.
	triggerInstallation	Triggers the installation of homebrew.

Procedure: "checkVersion"

Checks if a detected homebrew version is recent enough.

Author:: QFS
Since:: 8.0

Procedure: "getVersion"

Get the version of the currently installed homebrew tool, if available.

Author:: QFS
Since:: 8.0

Procedure: "triggerInstallation"

Triggers the installation of homebrew.

Author:: QFS
Since:: 8.0

Package: "idb"

Helper procedures to check and set up the iOS Developer Bridge for iOS testing.

Author:: QFS
Since:: 8.0

Package: "client"

Helper procedures to check and set up the iOS Developer Bridge client (idb) for iOS testing.

Author:: QFS
Since:: 8.0

	Procedure/Dependency	Description
	checkVersion	Checks if a detected IDB client version is recent enough.
	getPath	Get the path of the currently installed IDB client, if available.
	getVersion	Get the version of the currently installed IDB client, if available.
	triggerInstallation	Triggers the installation of the IDB client.

Procedure: "checkVersion"

Checks if a detected IDB client version is recent enough.

Author:: QFS
Since:: 8.0

Procedure: "getPath"

Get the path of the currently installed IDB client, if available.

Author:: QFS
Since:: 8.0

Procedure: "getVersion"

Get the version of the currently installed IDB client, if available.

Author:: QFS
Since:: 8.0

Procedure: "triggerInstallation"

Triggers the installation of the IDB client.

Author:: QFS
Since:: 8.0

Package: "companion"

Helper procedures to check and set up the iOS Developer Bridge companion (idb-companion) for iOS testing.

Author:: QFS
Since:: 8.0

	Procedure/Dependency	Description
	checkBuild	Checks if a detected IDB companion build is recent enough.
	getBuild	Get the build number of the currently installed IDB companion, if available.
	getPath	Get the path of the currently installed IDB companion, if available.
	triggerInstallation	Triggers the installation of the IDB companion.

Procedure: "checkBuild"

Checks if a detected IDB companion build is recent enough.

Author:: QFS
Since:: 8.0

Procedure: "getBuild"

Get the build number of the currently installed IDB companion, if available.

Author:: QFS
Since:: 8.0

Procedure: "getPath"

Get the path of the currently installed IDB companion, if available.

Author:: QFS
Since:: 8.0

Procedure: "triggerInstallation"

Triggers the installation of the IDB companion.

Author:: QFS
Since:: 8.0

Package: "macos"

Helper procedures to interact with macOS system functions during the test environment setup for iOS testing.

Author:: QFS
Since:: 8.0

	Procedure/Dependency	Description
	check	Checks if the current system is running macOS.
	findExecutable	Finds an executable at different possible locations on the system.
	infoAppRerun	Displays an information dialog about a started application.
	infoTerminalRerun	Displays an information dialog about installation triggered in the terminal.
	openApp	Opens on macOS an application at the given path.
	openFile	Opens on macOS a file at the given path.
	openTerminal	Opens the terminal to execute the given command.

Procedure: "check"

Checks if the current system is running macOS.

Author:: QFS
Since:: 8.0

Procedure: "findExecutable"

Finds an executable at different possible locations on the system.

Author:: QFS
Since:: 8.0

Procedure: "infoAppRerun"

Displays an information dialog about a started application.

Author:: QFS
Since:: 8.0

Procedure: "infoTerminalRerun"

Displays an information dialog about installation triggered in the terminal.

Author:: QFS
Since:: 8.0

Procedure: "openApp"

Opens on macOS an application at the given path.

Author:: QFS
Since:: 8.0

Procedure: "openFile"

Opens on macOS a file at the given path.

Author:: QFS
Since:: 8.0

Procedure: "openTerminal"

Opens the terminal to execute the given command.

Author:: QFS
Since:: 8.0

Package: "pip3"

Helper procedures to check and set up the Python package installer (pip) for iOS testing.

Author:: QFS
Since:: 8.0

	Procedure/Dependency	Description
	checkVersion	Checks if a detected Python package installer version is recent enough.
	getVersion	Get the version of the currently installed Python package installer, if available.
	triggerInstallation	Triggers the installation of the Python package installer.

Procedure: "checkVersion"

Checks if a detected Python package installer version is recent enough.

Author:: QFS
Since:: 8.0

Procedure: "getVersion"

Get the version of the currently installed Python package installer, if available.

Author:: QFS
Since:: 8.0

Procedure: "triggerInstallation"

Triggers the installation of the Python package installer.

Author:: QFS
Since:: 8.0

Package: "python3"

Helper procedures to check and set up the python 3 environment for iOS testing.

Author:: QFS
Since:: 8.0

	Procedure/Dependency	Description
	checkVersion	Checks if a detected Python 3 version is recent enough.
	getVersion	Get the version of the currently installed Python 3, if available.
	triggerInstallation	Triggers the installation of Python 3.
	triggerVenvCreation	Triggers the creation of a Python 3 virtual environment.

Procedure: "checkVersion"

Checks if a detected Python 3 version is recent enough.

Author:: QFS
Since:: 8.0

Procedure: "getVersion"

Get the version of the currently installed Python 3, if available.

Author:: QFS
Since:: 8.0

Procedure: "triggerInstallation"

Triggers the installation of Python 3.

Author:: QFS
Since:: 8.0

Procedure: "triggerVenvCreation"

Triggers the creation of a Python 3 virtual environment.

Author:: QFS
Since:: 8.0

Package: "xcode"

Helper procedures to check and set up the Xcode development environment for iOS testing.

Author:: QFS
Since:: 8.0

	Procedure/Dependency	Description
	checkDeviceCount	Checks if the number of earlier detected available iOS devices on the system is > 0.
	checkVersion	Checks if a detected Xcode version is recent enough.
	getDeviceInfo	Get information about a available iOS devices using Xcode tools.
	getMissingRuntime	Tries to detect if the recent runtime of the given platform is installed.
	getSimulatedDeviceCount	Returns the number of simulated iOS devices on the system using Xcode tools.
	getVersion	Get the version of the currently installed Xcode, if available.
	triggerInstallation	Triggers the installation of Xcode.
	triggerRuntimeInstallation	Triggers the installation of the Xcode runtime.

Procedure: "checkDeviceCount"

Checks if the number of earlier detected available iOS devices on the system is > 0.

Author:: QFS
Since:: 8.0

Procedure: "checkVersion"

Checks if a detected Xcode version is recent enough.

Author:: QFS
Since:: 8.0

Procedure: "getDeviceInfo"

Get information about a available iOS devices using Xcode tools.

Author:: QFS
Since:: 8.0

Procedure: "getMissingRuntime"

Tries to detect if the recent runtime of the given platform is installed.

Returns the version of the missing runtime, or "" if everything is ok, or "-1" upon error

Requires Xcode 14+

Author:: QFS
Since:: 8.0

Procedure: "getSimulatedDeviceCount"

Returns the number of simulated iOS devices on the system using Xcode tools.

Author:: QFS
Since:: 8.0

Procedure: "getVersion"

Get the version of the currently installed Xcode, if available.

Author:: QFS
Since:: 8.0

Procedure: "triggerInstallation"

Triggers the installation of Xcode.

Author:: QFS
Since:: 8.0

Procedure: "triggerRuntimeInstallation"

Triggers the installation of the Xcode runtime.

Requires Xcode 14+

Author:: QFS
Since:: 8.0

Package: "path"

Helper procedures to check and set up the Xcode development path.

Author:: QFS
Since:: 8.0

	Procedure/Dependency	Description
	check	Checks if the given Xcode development path matches the expected one.
	get	Returns the Xcode development path.
	set	Sets the Xcode development path.

Procedure: "check"

Checks if the given Xcode development path matches the expected one.

Author:: QFS
Since:: 8.0

Procedure: "get"

Returns the Xcode development path.

Author:: QFS
Since:: 8.0

Procedure: "set"

Sets the Xcode development path.

Author:: QFS
Since:: 8.0

Package: "swipe"

Packages containing swiping procedures

Author:: QFS
Since:: 8.0

	Procedure/Dependency	Description
	down	Perform a swipe down operation.
	inDirection	Perform a swipe operation.
	left	Perform a swipe left operation.
	right	Perform a swipe right operation.
	up	Perform a swipe up operation.
	withCoordinates	Perform a swipe operation.

Procedure: "down"

Perform a swipe down operation.

Parameters:: id - The QF-Test ID of the component to perform the swipe operation on.; time - The duration of the swipe operation in milli seconds.
Author:: QFS
Since:: 8.0

Procedure: "inDirection"

Perform a swipe operation.

Parameters:: direction - The direction of the swipe. Valid entries: up, down, right, left, upright, up_left, down_right, down_left (and some more, see manual); id - The QF-Test ID of the component to perform the swipe operation on.; time - The duration of the swipe operation in milli seconds.
Author:: QFS
Since:: 8.0

Procedure: "left"

Perform a swipe left operation.

Parameters:: id - The QF-Test ID of the component to perform the swipe operation on.; time - The duration of the swipe operation in milli seconds.
Author:: QFS
Since:: 8.0

Procedure: "right"

Perform a swipe right operation.

Parameters:: id - The QF-Test ID of the component to perform the swipe operation on.; time - The duration of the swipe operation in milli seconds.
Author:: QFS
Since:: 8.0

Procedure: "up"

Perform a swipe up operation.

Parameters:: id - The QF-Test ID of the component to perform the swipe operation on.; time - The duration of the swipe operation in milli seconds.
Author:: QFS
Since:: 8.0

Procedure: "withCoordinates"

Perform a swipe operation.

Parameters:: id - The id the coordinates refer to; startX - The number pixels right of the upper left corner of the id where to start the swipe; startY - The number pixels down from the upper left corner of the id where to start the swipe; swipeHorizontal - The number of pixels covered by the swipe.; swipeVertical - The number of pixels covered by the swipe.; time - The time in which to execute the swipe. With many applications a quick swipe will give the display a momentum which will make the display scroll further than the actual length of the swipe.; steps - The number of steps the swipe is broken down to. If you choose a long time or long distance increase the number of steps to make the movement more fluent.
Author:: QFS
Since:: 8.0

Package: "switch"

Procedures to set the state of switches.

Author:: QFS
Since:: 8.0

	Procedure/Dependency	Description
	deselect	Deselect a switch.
	deselectWithCoordinates	Deselect a switch.
	getValue	Return the value of a switch.
	select	Select a switch.
	selectWithCoordinates	Select a switch.
	set	Set switch to the given state.
	setWithCoordinates	Set switch to the given state.

Procedure: "deselect"

Deselect a switch. If the switch is already deselected, no action is performed.

Parameters:: id - The id of the switch.
Author:: QFS
Since:: 8.0

Procedure: "deselectWithCoordinates"

Deselect a switch. If the switch is already deselected, no action is performed. You can specify the coordinates for clicking.

Parameters:: id - The id of the switch.; x - The x coordinate for the click, default is empty to click in the middle.; y - The y coordinate for the click, default is empty to click in the middle.
Author:: QFS
Since:: 8.0

Procedure: "getValue"

Return the value of a switch. It's either 1, if box is selected or 0, if box is not selected.

Parameters:: id - ID of the switch.
Returns:: The state of the switch.
Author:: QFS
Since:: 8.0

Procedure: "select"

Select a switch. If the switch is already selected, no action is performed.

Parameters:: id - The id of the switch.
Author:: QFS
Since:: 8.0

Procedure: "selectWithCoordinates"

Select a switch. If the switch is already selected, no action is performed. You can specify the coordinates for clicking.

Parameters:: id - The id of the switch.; x - The x coordinate for the click, default is empty to click in the middle.; y - The y coordinate for the click, default is empty to click in the middle.
Author:: QFS
Since:: 8.0

Procedure: "set"

Set switch to the given state.

Parameters:: id - The id of the switch.; check - The check value to be set (either true or false).
Author:: QFS
Since:: 8.0

Procedure: "setWithCoordinates"

Set switch to the given state. You can specify the coordinates for clicking.

Parameters:: id - The id of the switch.; check - The check value to be set (either true or false).; x - The x coordinate for the click, default is empty to click in the middle.; y - The y coordinate for the click, default is empty to click in the middle.
Author:: QFS
Since:: 8.0

Package: "text"

Procedures to access text fields and text areas.

Author:: QFS
Since:: 8.0

	Procedure/Dependency	Description
	clear	Clear a text field.
	getText	Return the text of a given textfield.
	setText	Set a given text to a given text-field or text-area.
	setTextFromFile	Read the content of a given file and set its content to a given text-field.

Procedure: "clear"

Clear a text field.

Parameters:: id - The id of the text field.
Author:: QFS
Since:: 8.0

Procedure: "getText"

Return the text of a given textfield.

Parameters:: id - ID of the textfield.
Returns:: The text of the textfield. Variables in this string will not be automatically expanded.
Author:: QFS
Since:: 8.0

Procedure: "setText"

Set a given text to a given text-field or text-area.

Parameters:: id - ID of the textfield.; text - text to be set.; append - if this value is set to true, the text will be appended to the current values.; clear - If this value is set to true, the text-field will be cleared before the text given as parameter "text" is inserted.; replaySingleEvents - If this value is set to true, the text will be inserted replaying single events.; newline - the separator sign for marking a linebreak within the text
Author:: QFS
Since:: 8.0

Procedure: "setTextFromFile"

Read the content of a given file and set its content to a given text-field.

Parameters:: id - The id of the text-field to set.; file - The path to the file.; append - If this value is set to true, the text will be appended to the current values.; clear - If this value is set to true, the text-field will be cleared in case an empty string is given as parameter "text".; replaySingleEvents - If this value is set to true, the text will be inserted replaying single events.; newline - the separator sign for marking a linebreak within the text
Author:: QFS
Since:: 8.0

Package: "jib"

Procedures for JiB (Java in Browsers).

Package: "options"

Procedures for setting special options for JiB (Java in Browsers) tests.

Author:: QFS
Since:: 5.2.0

	Procedure/Dependency	Description
	replayFXDnDEventAs	Set the type of event for Replaying JavaFX drag and drop.
	replayFXHardMouseEventAs	Set the type of event for replaying a hard JavaFX mouse event.
	replayFXImageCheckAs	Set where to fetch the image when replaying a JavaFX image check.
	replayFXKeyEventAs	Set the type of event for replaying a JavaFX keystroke.
	replayFXSoftMouseEventAs	Set the type of event for replaying a soft JavaFX mouse event.
	replayFXTextInputAs	Set the type of event for replaying JavaFX text input.
	replaySwingDnDEventAs	Set the type of event for Replaying Swing drag and drop.
	replaySwingHardMouseEventAs	Set the type of event for replaying a hard Swing mouse event.
	replaySwingImageCheckAs	Set where to fetch the image for replaying a Swing image check.
	replaySwingKeyEventAs	Set the type of event for replaying a Swing keystroke.
	replaySwingSoftMouseEventAs	Set the type of event for replaying a soft Swing mouse event.
	replaySwingTextInputAs	Set the type of event for replaying Swing text input.

Procedure: "replayFXDnDEventAs"

Set the type of event for Replaying JavaFX drag and drop.

Parameters:: type - "web" for drag and drop in web or "fx" for drag and drop in JavaFX.
Author:: QFS
Since:: 5.2.0

Procedure: "replayFXHardMouseEventAs"

Set the type of event for replaying a hard JavaFX mouse event.

Parameters:: clicktype - "hard", "semihard" or "soft" for click in web or "fx" for click in JavaFX.
Author:: QFS
Since:: 5.2.0

Procedure: "replayFXImageCheckAs"

Set where to fetch the image when replaying a JavaFX image check.

Parameters:: type - "web" to fetch the image from the browser or "fx" to check in JavaFX.
Author:: QFS
Since:: 5.2.0

Procedure: "replayFXKeyEventAs"

Set the type of event for replaying a JavaFX keystroke.

Parameters:: type - "web" for replay in web or "fx" to replay in JavaFX .
Author:: QFS
Since:: 5.2.0

Procedure: "replayFXSoftMouseEventAs"

Set the type of event for replaying a soft JavaFX mouse event.

Parameters:: clicktype - "hard", "semihard" or "soft" for click in web or "fx" for click in JavaFX.
Author:: QFS
Since:: 5.2.0

Procedure: "replayFXTextInputAs"

Set the type of event for replaying JavaFX text input.

Parameters:: type - "web" for replay in web or "fx" to replay in JavaFX .
Author:: QFS
Since:: 5.2.0

Procedure: "replaySwingDnDEventAs"

Set the type of event for Replaying Swing drag and drop.

Parameters:: type - "web" for drag and drop in web or "swing" for drag and drop in Swing.
Author:: QFS
Since:: 5.2.0

Procedure: "replaySwingHardMouseEventAs"

Set the type of event for replaying a hard Swing mouse event.

Parameters:: clicktype - "hard", "semihard" or "soft" for click in web or "swing" for click in Swing.
Author:: QFS
Since:: 5.2.0

Procedure: "replaySwingImageCheckAs"

Set where to fetch the image for replaying a Swing image check.

Parameters:: type - "web" to fetch the image from the browser or "swing" to check in Swing.
Author:: QFS
Since:: 5.2.0

Procedure: "replaySwingKeyEventAs"

Set the type of event for replaying a Swing keystroke.

Parameters:: type - "web" for replay in web or "swing" to replay in Swing.
Author:: QFS
Since:: 5.2.0

Procedure: "replaySwingSoftMouseEventAs"

Set the type of event for replaying a soft Swing mouse event.

Parameters:: clicktype - "hard", "semihard" or "soft" for click in web or "swing" for click in Swing.
Author:: QFS
Since:: 5.2.0

Procedure: "replaySwingTextInputAs"

Set the type of event for replaying Swing text input.

Parameters:: type - "web" for replay in web or "swing" to replay in Swing.
Author:: QFS
Since:: 5.2.0

Package: "pdf"

Procedures for PDF testing.

Author:: QFS
Since:: 4.2

Package: "file"

Procedures to work with PDF files.

Author:: QFS,gs
Since:: 9.0

	Procedure/Dependency	Description
	extractAttachment	Extract a particular attachment of a PDF file.
	listAttachments	Returns a list listing all attachments present in a particular PDF file.
	verifyAttachments	Verify that a given PDF file has one or more attachments.

Procedure: "extractAttachment"

Extract a particular attachment of a PDF file.

Parameters:: pdfFile - Full path to the PDF file.; password - The password for the PDF file in case it is encrypted.; attachment - The attachment (with path) to extract.; file - The file where the extracted attachment should get saved.
Exceptions:: TestException - If something fails.
Author:: QFS,ys
Since:: 9.0

Procedure: "listAttachments"

Returns a list listing all attachments present in a particular PDF file.

Parameters:: pdfFile - Full path to the PDF file.; password - The password for the PDF file in case it is encrypted.; withPath - Whether to include directories. If false, return only the filenames.
Returns:: A list of all attachements of the pdf file.
Author:: QFS,ys
Since:: 9.0

Procedure: "verifyAttachments"

Verify that a given PDF file has one or more attachments.

Parameters:: pdfFile - Full path to the PDF file to test.; password - The password for the PDF file in case it is encrypted.; attachments - The list of attachments to check for. Can be: (a) A String object. The list of attachments will be determined by splitting the string at the newline characters. Trimmed, empty lines will be ignored. (b) A Java object implementing the java.util.Collection interface. The list of attachments will be determined by calling the toString() Method on all objects present in the collection. Null "objects" will be ignored.; withPath - Whether to include directories. If false, check only the filename.; logChecks - True to log a check result for each successful or failed test, "fail" to log only failing checks, false to run silently.; checkMode - A string that is either: empty: Indicating that the pdf should NOT contain any attachments. none: Indicating that the pdf should NOT contain any of the attachments given in the attachments list. all: Indicating that the pdf should contain all attachments given in the attachment list. allNoMore: Indicating that the pdf should contain exactly the attachments given in the attachment list (and no more).; errorLevel - If logChecks is true/fail: The kind of error to log for a failed check. Either EXCEPTION, ERROR, WARNING or MESSAGE.; appearInReport - If logChecks is true/fail: Flag, whether to show check in report in case errorLevel is WARNING or MESSAGE.
Returns:: true if all checks passed, false otherwise.
Author:: QFS,gs|ys
Since:: 9.0

Package: "highlight"

Procedures in order to highlight components.

Author:: QFS,ys
Since:: 4.2

	Procedure/Dependency	Description
	hideBordersAroundComponents	Hide borders around each recognized component.
	showBordersAroundComponents	Show borders around each recognized component.
	toggleBordersAroundComponents	Toggle borders around each recognized component.

Procedure: "hideBordersAroundComponents"

Hide borders around each recognized component.

Author:: QFS,ys
Since:: 4.2

Procedure: "showBordersAroundComponents"

Show borders around each recognized component.

Author:: QFS,ys
Since:: 4.2

Procedure: "toggleBordersAroundComponents"

Toggle borders around each recognized component.

Author:: QFS,ys
Since:: 4.2

Package: "navigation"

Procedures to navigate inside a PDF document.

Author:: QFS,ys
Since:: 4.2

	Procedure/Dependency	Description
	iterate	Iterate over all pages in a PDF document.
	openFirstPage	Open the first page of the PDF document.
	openLastPage	Open the last page of the PDF document.
	openNextPage	Open/Goto the next page of the PDF document.
	openPage	Open a specific page of the PDF document.
	openPrevPage	Open/Goto the previous page of the PDF document.
	openRandomPage	Open a random page of the PDF document.

Procedure: "iterate"

Iterate over all pages in a PDF document. It's possible to call a procedure on every page.

Parameters:: order - The order in which to iterate over the pages of the PDF document. Possible values: "forward" (will iterate over all pages in forward order), "reversed" (will iterate over all pages in reversed order), "random" (will iterate over all pages in random order).; exclude - Comma-separated list of pages to exclude from iteration.; procedureToCall - On each page a certain procedure gets called (specified via this argument). The current pageNumber will be passed to the procedure as argument. The procedure may break the iteration by throwing a BreakException.
Returns:: The list of page numbers which got 'true' returned by the called 'procedureToCall' parameter (with a string value of comma-separated page numbers).
Author:: QFS,ys
Since:: 4.2

Procedure: "openFirstPage"

Open the first page of the PDF document.

Author:: QFS,ys
Since:: 4.2

Procedure: "openLastPage"

Open the last page of the PDF document.

Author:: QFS,ys
Since:: 4.2

Procedure: "openNextPage"

Open/Goto the next page of the PDF document.

Parameters:: lastPageStrategy - May either be "exception", "stay", "first page" or "random". If lastPageStrategy equals to "exception" and this method get's called a TestException is thrown. If lastPageStrategy equals to "stay" and this method get's called nothing will be done. If lastPageStrategy equals to "first page" and this method get's called, the first page will be opened. If lastPageStrategy equals to "random" and this method get's called a random page will get opened.
Author:: QFS,ys
Since:: 4.2

Procedure: "openPage"

Open a specific page of the PDF document.

Parameters:: pageNumber - The number of the page to open
Author:: QFS,ys
Since:: 4.2

Procedure: "openPrevPage"

Open/Goto the previous page of the PDF document.

Parameters:: firstPageStrategy - May either be "exception", "stay", "last page" or "random". If firstPageStrategy equals to "exception" and this method get's called a TestException is thrown. If firstPageStrategy equals to "stay" and this method get's called nothing will be done. If firstPageStrategy equals to "last page" and this method get's called, the last page will be opened. If firstPageStrategy equals to "random" and this method get's called a random page will get opened.
Author:: QFS,ys
Since:: 4.2

Procedure: "openRandomPage"

Open a random page of the PDF document.

Author:: QFS,ys
Since:: 4.2

Package: "page"

Procedures to get/interact with the current page / all pages.

Author:: QFS,ys
Since:: 4.2

	Procedure/Dependency	Description
	getCurrentPageName	Return the name of the currently selected page in the PDF document.
	getCurrentPageNumber	Return the index/number of the currently selected page in the PDF document.
	getPageCount	Return the number of pages in a PDF document.
	refreshCurrentPage	Refresh the currently opened page.

Procedure: "getCurrentPageName"

Return the name of the currently selected page in the PDF document.

Exceptions:: TestException - If no page is selected.
Author:: QFS,ys
Since:: 4.2

Procedure: "getCurrentPageNumber"

Return the index/number of the currently selected page in the PDF document.

Exceptions:: TestException - If no page is selected.
Author:: QFS,ys
Since:: 4.2

Procedure: "getPageCount"

Return the number of pages in a PDF document.

Author:: QFS,ys
Since:: 4.2

Procedure: "refreshCurrentPage"

Refresh the currently opened page.

Author:: QFS,ys
Since:: 4.2

Package: "run-log"

Procedures for writing log-entries.

Author:: QFS,mm
Since:: 2.1.0

	Procedure/Dependency	Description
	logError	Write an error into the run log.
	logMessage	Write a message into the run log.
	logWarning	Write a warning into the run log.

Procedure: "logError"

Write an error into the run log. Note: since 7.0 a new QF-Test node "Error" can be used for more Options

Parameters:: client - The name of the SUT client.; message - The message, which should be written.; withScreenshots - If true, try to take screenshots from individual SUT windows.; guiengine - The name of the engine to run the SUTscript, e.g. awt, swt, web. Can be empty, if you work with one engine at the same time.
Author:: QFS,mm
Since:: 2.1.0

Procedure: "logMessage"

Write a message into the run log.

Parameters:: message - The message, which should be written.; dontcompactify - If true, the message will not be removed from the run log. Use with care!; report - If true, the message will be shown in the report. Implies dontcompactify.
Author:: QFS,mm
Since:: 2.1.0

Procedure: "logWarning"

Write a warning into the run log.

Parameters:: message - The message, which should be written.; report - If true, the warning will be shown in the report.
Author:: QFS,mm
Since:: 2.1.0

Package: "screenshots"

Procedures to write screenshots into the run log.

Author:: QFS,mm
Since:: 3.0

	Procedure/Dependency	Description
	getMonitorCount	Return the total number of monitors.
	logImageOfComponent	Write an image of a component into the run log.
	logScreenshot	Write a screenshot of the whole screen into the run log.
	logScreenshotOfMonitor	Write a screenshots of a given monitor into the run log.

Procedure: "getMonitorCount"

Return the total number of monitors.

Parameters:: inSUT - Whether to take the screenshot in a SUT script. Should be true, if you start the SUT remotely.; guiengine - The name of the engine to run the SUTscript, e.g. awt, swt, web. Can be empty, if you work with one engine at the same time.
Returns:: The total number of monitors.
Author:: QFS,mm
Since:: 3.0

Procedure: "logImageOfComponent"

Write an image of a component into the run log.

Parameters:: client - The name of the SUT client.; id - The ID of the component to be written into the run log.; title - An optional title for the image.; dontcompactify - If true, the screenshot will not be removed from the run log. Use with care!; report - If true, the screenshot will be shown in the report. Implies dontcompactify.; guiengine - The name of the engine to run the SUTscript, e.g. awt, swt, web. Can be empty, if you work with one engine at the same time.
Author:: QFS,mm
Since:: 3.0

Procedure: "logScreenshot"

Write a screenshot of the whole screen into the run log.

Parameters:: inSUT - Whether to take the screenshot in a SUT script. Should be true, if you start the SUT remotely.; title - An optional title for the image.; dontcompactify - If true, the screenshot will not be removed from the run log. Use with care!; report - If true, the screenshot will be shown in the report. Implies dontcompactify.; guiengine - The name of the engine to run the SUTscript, e.g. awt, swt, web. Can be empty, if you work with one engine at the same time.
Author:: QFS,mm
Since:: 3.0

Procedure: "logScreenshotOfMonitor"

Write a screenshots of a given monitor into the run log.

Parameters:: monitor - The index of the monitor, the first one is 0, the second 1 etc.; inSUT - Whether to take the screenshot in a SUT script. Should be true, if you start the SUT remotely.; title - An optional title for the image.; dontcompactify - If true, the screenshot will not be removed from the run log. Use with care!; report - If true, the screenshot will be shown in the report. Implies dontcompactify.; guiengine - The name of the engine to run the SUTscript, e.g. awt, swt, web. Can be empty, if you work with one engine at the same time.
Author:: QFS,mm
Since:: 3.0

Package: "web"

Procedures to write web specifics into run log.

Author:: QFS,mm
Since:: 3.4.9

	Procedure/Dependency	Description
	logSourcecode	Write a document's source code into the run log.

Procedure: "logSourcecode"

Write a document's source code into the run log. It also logs the source code of all child documents of the given document. If you want to log only one dedicated frame you can specify the name of the frame. If this frame has child frames, those children will also be logged.

Parameters:: docId - The Id of the web page.; frameName - The name of the frame to provide source code.; msgLevel - The level of the message, which should be logged. Either ERROR, WARNING or MESSAGE. If no msgLevel or any wrong level is specified it will log the message as message.
Author:: QFS, mm
Since:: 3.4.9

Package: "shellutils"

Utility procedures for shell commands.

Author:: QFS,mm
Since:: 2.2

	Procedure/Dependency	Description
	copy	Copy a given file or directory to a given target.
	deleteFile	Delete a file.
	exec	Execute a shell command.
	exists	Check whether a given file or directory exists.
	getBasename	Return the basename of the given file or directory.
	getParentdirectory	Return the parent directory of the given file or directory.
	mkdir	Create a given directory.
	move	Move a given file or directory to a given target.
	removeDirectory	Remove a given directory.
	touch	Create a given file or update the last modified date of an existing file.

Procedure: "copy"

Copy a given file or directory to a given target. If the target is a directory, copy source into that directory. If target's parent directory does not exist, create it.

Parameters:: source - The source to be copied.; target - The target to be copied to.
Author:: QFS,mm
Since:: 2.2

Procedure: "deleteFile"

Delete a file.

Parameters:: file - The file to remove.
Author:: QFS,mm
Since:: 2.2

Procedure: "exec"

Execute a shell command.

Parameters:: cmd - The command to execute.; dir - The working directory.; timeout - The maximal amount of time to wait for the program to finish.; expectedExitCode - The expected error level (or "" (without quotes, that means an empty string) in order to disable this check).; errorLvl - Whether to log a IGNORE, WARNING, ERROR or EXCEPTION in case the program did not finish within the specified amount of time or with an unexpected exit code.; stdoutVar - The name of the global variable in which to save the stdout of the program.; stderrVar - The name of the global variable in which to save the stderr of the program.; exitCodeVar - The name of the global variable in which to save the exitCode of the program.; outputFilterDrop - A regular expression of all the output that should get dropped.; outputFilterKeep - A regular expression of all the output that should get keeped.
Returns:: The stdout/stderr output of the program.
Author:: QFS,ys
Since:: 4.5

Procedure: "exists"

Check whether a given file or directory exists.

Parameters:: file - The path of the file or directory to check.
Returns:: exists true if file exists false if file does not exist
Author:: QFS,mm
Since:: 2.2

Procedure: "getBasename"

Return the basename of the given file or directory. If the root directory is specified as parameter an empty string will returned.

Parameters:: file - The file or directory.
Returns:: The basename of the file or directory.
Author:: QFS,mm
Since:: 2.2

Procedure: "getParentdirectory"

Return the parent directory of the given file or directory. If the root directory is specified as parameter an empty string will returned.

Parameters:: file - The file or directory.
Returns:: The parent directory of the file or directory.
Author:: QFS,mm
Since:: 2.2

Procedure: "mkdir"

Create a given directory. It also creates non-existing parent directories.

Parameters:: directory - The directory to create.
Exceptions:: UserException, - if the directory couldn't be created
Author:: QFS,mm
Since:: 2.2

Procedure: "move"

Move a given file or directory to a given target. If the target is a directory, move source into that directory. If target's parent directory does not exist, create it. If an error happens during moving, source is not changed.

Parameters:: source - The source to be moved.; target - The target to be moved.
Author:: QFS,mm
Since:: 2.2

Procedure: "removeDirectory"

Remove a given directory.

Parameters:: directory - The directory to remove.
Author:: QFS,mm
Since:: 2.2

Procedure: "touch"

Create a given file or update the last modified date of an existing file.

For creation it also creates non-existing parent directories.

Parameters:: file - The file to touch.
Author:: QFS,mm
Since:: 2.2

Package: "swing"

Procedures for advanced manipulation of swing components.

Author:: QFS
Since:: 1.05.0

Package: "checkbox"

Procedures to set the state of checkboxes. (Swing component javax.swing.JCheckBox)

Author:: QFS,mm
Since:: 1.05.0

	Procedure/Dependency	Description
	deselect	Deselect a checkbox.
	deselectWithCoordinates	Deselect a checkbox.
	getValue	Return the value of a checkbox.
	select	Select a checkbox.
	selectWithCoordinates	Select a checkbox.
	set	Set checkbox to the given state.
	setWithCoordinates	Set checkbox to the given state.

Procedure: "deselect"

Deselect a checkbox. If the checkbox is already deselected, no action is performed.

Parameters:: client - The name of the SUT client.; id - The id of the checkbox.
Author:: QFS,mm
Since:: 1.05.0

Procedure: "deselectWithCoordinates"

Deselect a checkbox. If the checkbox is already deselected, no action is performed. You can specify the coordinates for clicking.

Parameters:: client - The name of the SUT client.; id - The id of the checkbox.; x - The x coordinate for the click, default is empty to click in the middle.; y - The y coordinate for the click, default is empty to click in the middle.
Author:: QFS,mm
Since:: 4.0

Procedure: "getValue"

Return the value of a checkbox. It's either 1, if box is selected or 0, if box is not selected.

Parameters:: id - ID of the checkbox.
Returns:: The state of the checkbox.
Author:: QFS,mm
Since:: 3.5.0

Procedure: "select"

Select a checkbox. If the checkbox is already selected, no action is performed.

Parameters:: client - The name of the SUT client.; id - The id of the checkbox.
Author:: QFS,mm
Since:: 1.05.0

Procedure: "selectWithCoordinates"

Select a checkbox. If the checkbox is already selected, no action is performed. You can specify the coordinates for clicking.

Parameters:: client - The name of the SUT client.; id - The id of the checkbox.; x - The x coordinate for the click, default is empty to click in the middle.; y - The y coordinate for the click, default is empty to click in the middle.
Author:: QFS,mm
Since:: 4.0

Procedure: "set"

Set checkbox to the given state.

Parameters:: client - The name of the SUT client.; id - The id of the checkbox.; check - The check value to be set (either true or false).
Author:: QFS,mm
Since:: 1.05.0

Procedure: "setWithCoordinates"

Set checkbox to the given state. You can specify the coordinates for clicking.

Parameters:: client - The name of the SUT client.; id - The id of the checkbox.; check - The check value to be set (either true or false).; x - The x coordinate for the click, default is empty to click in the middle.; y - The y coordinate for the click, default is empty to click in the middle.
Author:: QFS,mm
Since:: 4.0

Package: "cleanup"

Author:: QFS,mm
Since:: 2.1.0

	Procedure/Dependency	Description
	closeAllDialogs	Close all dialogs.
	closeAllMenus	Close all menus unconditionally.
	closeAllModalDialogs	Close all modal dialogs.
	implicitExceptionHandler	This procedure encompasses the usage of other cleanup procedures in this package and is the recommended operation to perform after an exception occurs and is implicitly caught.

Procedure: "closeAllDialogs"

Close all dialogs.

Parameters:: client - The name of the SUT client.; maxDialogs - Maximum number of dialogs that are tried to be closed. (Optional, default 6)
Author:: QFS,mm
Since:: 2.1.0

Procedure: "closeAllMenus"

Close all menus unconditionally. A menu left open (or even just selected) will cause events for the SUT to be blocked. This procedure is recommended for cleanup after an exception occurs.

Parameters:: client - The name of the SUT client.
Author:: QFS,mm
Since:: 2.1.0

Procedure: "closeAllModalDialogs"

Parameters:: client - The name of the SUT client.; maxDialogs - Maximum number of modal dialogs that are tried to be closed. (Optional, default 5)
Author:: QFS,mm
Since:: 2.1.0

Procedure: "implicitExceptionHandler"

This procedure encompasses the usage of other cleanup procedures in this package and is the recommended operation to perform after an exception occurs and is implicitly caught.

Calling this procedure should be the first step in the cleanup sequence of any Test node with the "Implicitly catch exceptions" attribute set.

Parameters:: client - The name of the SUT client.; maxDialogs - Maximum number of modal dialogs that are tried to be closed. (Optional, default 5)
Author:: QFS,mm
Since:: 2.1.0

Package: "combobox"

Procedures to handle comboboxes. (Swing component javax.swing.JComboBox)

Author:: QFS,mm
Since:: 2.1.0

	Procedure/Dependency	Description
	getIndexOfItem	Return the current index of a given item.
	getItemCount	Return the number of items of a given combobox.
	getValue	Return the text of a given combobox.
	getValueOfItem	Return the text of a given item.
	setValue	Select specified value of a given combobox.
	setValueViaIndex	Set a value in the combobox.
	setValueViaSUTScript	Select specified value of a given combobox using a SUT script.

Procedure: "getIndexOfItem"

Return the current index of a given item.

Sample usage: Can be used to determine the numeric index of an item like 'Price'.

Parameters:: id - ID of the combobox.; item - The item.; itemSeparator - Separator to use for the item syntax. Default is @ for text values, also available & for index and % for regexp.
Returns:: index The current index of the item, which has been read by the 'Fetch Index' node of QF-Test.
Author:: QFS,mm
Since:: 3.5.0

Procedure: "getItemCount"

Return the number of items of a given combobox. It uses the method getModel().getSize() to get the number.

Parameters:: id - The component ID of the combobox.
Returns:: itemCount
Author:: QFS,mm
Since:: 3.0

Procedure: "getValue"

Return the text of a given combobox.

Parameters:: id - ID of the combobox.
Returns:: The text of the combobox.
Author:: QFS,mm
Since:: 3.5.0

Procedure: "getValueOfItem"

Return the text of a given item.

Sample usage: Determine the text of the second item.

Parameters:: id - ID of the combobox.; item - The item.; itemSeparator - Separator to use for the item syntax. Default is @ for text values, also available & for index and % for regexp.
Returns:: value The value of the item.
Author:: QFS,mm
Since:: 3.5.0

Procedure: "setValue"

Select specified value of a given combobox.

If the given value is empty, no action will take place.

You should use this procedure for any standard selections.

Parameters:: client - The name of the SUT client.; id - ID of the button to open the list.; listId - ID of the list containing values.; value - Value, which should be selected.; separator - Separator to use for the list syntax. Default is @ for text values, also available & for index and % for regexp.; btnX - The x coordinate for the click on the button to open the list, default is empty to click in the middle.; btnY - The y coordinate for the click on the button to open the list, default is empty to click in the middle.; itemX - The x coordinate for the click on the item, default is empty to click in the middle.; itemY - The y coordinate for the click on the item, default is empty to click in the middle.
Author:: QFS,mm
Since:: 2.1.0

Procedure: "setValueViaIndex"

Set a value in the combobox.

You should use this procedure if setValue doesn't work correctly.

Parameters:: client - The name of the SUT client.; id - ID of the combobox.; value - The value to be set.; separator - Separator to use for the list syntax. Default is @ for text values, also available & for index and % for regexp.
Author:: QFS,mm
Since:: 3.1.2

Procedure: "setValueViaSUTScript"

Select specified value of a given combobox using a SUT script. It uses the API-method setSelectedItem() of javax.swing.JCombobox

If the given value is empty, no action will take place.

You should use this procedure only if setValue and setValueViaIndex don't work for your use-case.

Parameters:: client - The name of the SUT client.; id - ID of the combobox.; value - Value, which should be selected.; separator - Separator to use for the list syntax. Default is @ for text values, also available & for index and % for regexp.
Author:: QFS,mm
Since:: 2.1.0

Package: "dialogs"

Procedures to handle Dialogs. (Swing component javax.swing.JDialog)

Author:: QFS,kk
Since:: 3.4.14

	Procedure/Dependency	Description
	handleSecurityWarning	Wait for the client to connect and check whether a Java security dialog blocks the JRE start which need to be confirmed.

Procedure: "handleSecurityWarning"

Deprecated: This procedure is deprecated because security dialogs are now handled by the qfs.swing.startup.setSecurityDialogSpec procedure at a different level. Note: If the dialog needs a two way confirmation, like a checkbox with "I accept the risk...", this cannot be handled automatically but need to be confirmed by hand including the permanent permission for content of this vendor.

Wait for the client to connect and check whether a Java security dialog blocks the JRE start which need to be confirmed.

Parameters:: timeout - Seconds to wait for the client to connect.; dialogTitleRegExp - Regular expression matching the dialog title text.; runButtonLabelRegExp - Regular expression matching the run button text.
Exceptions:: UserException - "Client finally not connected" in case the client doesn't connect within the timeout
Author:: QFS,kk
Since:: 3.4.14

Package: "filechooser"

Procedures for accessing file chooser dialogs. (Swing component javax.swing.JFileChooser)

Author:: QFS
Since:: 1.05.0

	Procedure/Dependency	Description
	disableNameResolver	Uninstall the `JFileChooser` name resolver.
	enableNameResolver	Install the `JFileChooser` name resolver.
	selectFile	Select a file in a `JFileChooser` dialog.
	selectFiles	Select several files in a `JFileChooser` dialog.

Procedure: "disableNameResolver"

Uninstall the JFileChooser name resolver.

Parameters:: client - The name of the SUT client.
Author:: QFS
Since:: 1.05.0

Procedure: "enableNameResolver"

Install the JFileChooser name resolver. The effect is similar to assigning names to the most important components in JFileChooser dialogs with setName().

Parameters:: client - The name of the SUT client.
Author:: QFS
Since:: 1.05.0

Procedure: "selectFile"

Select a file in a JFileChooser dialog.

The filechooser dialog must already be open (or at least be triggered to open).

Parameters:: client - The name of the SUT client.; file - The file to select (absolute or relative absolute to the filechooser's current directory).
Author:: QFS
Since:: 1.05.0

Procedure: "selectFiles"

Select several files in a JFileChooser dialog.

The filechooser dialog must already be open (or at least be triggered to open).

Parameters:: client - The name of the SUT client.; files - The files to select (absolute or relative to the filechooser's current directory) as a comma-separated list.
Author:: QFS,gs
Since:: 3.5.1

Package: "general"

Procedures which work for any Swing component.

Author:: QFS,mm
Since:: 2.1.0

	Procedure/Dependency	Description
	clickAtComponent	Click on a given component, but only if the according parameter is set to true.
	clickAtComponentWithDetails	Click on a given component, but only if the according parameter is set to true.
	deleteOverrideComponent	Delete the current association of PriorityAwtSwingComponent.
	doClick	Click on a given component.
	doClickWithDetails	Click on a given component.
	doSelect	Send a selection event to a given component.
	setLocation	Set the location of a given component.
	setOverrideComponent	Set a given component to the PriorityAwtSwingComponent.
	setSize	Set the width and the height of a given component.
	waitForComponent	Wait for a given component.
	waitForComponentForAbsence	Wait till a given component disappears.

Procedure: "clickAtComponent"

Click on a given component, but only if the according parameter is set to true.

Parameters:: client - The name of the SUT client.; id - The Id of the target component.; click - If this is set to true, the click will be performed, otherwise nothing happens.
Author:: QFS,mm
Since:: 3.0

Procedure: "clickAtComponentWithDetails"

Click on a given component, but only if the according parameter is set to true. You can specify the coordinates for clicking and all other details of that mouse click.

Parameters:: client - The name of the SUT client.; id - The Id of the target component.; click - If this is set to true, the click will be performed, otherwise nothing happens.; x - The x coordinate for the click, default is empty to click in the middle.; y - The y coordinate for the click, default is empty to click in the middle.; clickCount - Number of clicks. Default is 1. For a double click set this to 2.; modifier - Modifier for mouse key. 4 for right mouse. 16 for left mouse.; hard - True, if hard event should be replayed. Default is false.; popupTrigger - True, if click should open a popup. Default is false.
Author:: QFS,mm
Since:: 4.0

Procedure: "deleteOverrideComponent"

Delete the current association of PriorityAwtSwingComponent.

Parameters:: client - The name of the SUT client.
Author:: QFS,mm
Since:: 3.3.0

Procedure: "doClick"

Click on a given component.

Parameters:: client - The name of the SUT client.; id - The Id of the target component.
Author:: QFS,mm
Since:: 2.1.0

Procedure: "doClickWithDetails"

Click on a given component. You can specify the coordinates for clicking and all other details of that mouse click.

Parameters:: client - The name of the SUT client.; id - The Id of the target component.; x - The x coordinate for the click, default is empty to click in the middle.; y - The y coordinate for the click, default is empty to click in the middle.; clickCount - Number of clicks. Default is 1. For a double click set this to 2.; modifier - Modifier for mouse key. 4 for right mouse. 16 for left mouse.; hard - True, if hard event should be replayed. Default is false.; popupTrigger - True, if click should open a popup. Default is false.
Author:: QFS,mm
Since:: 4.0

Procedure: "doSelect"

Send a selection event to a given component. That's not a mouse click. Selection events are special events for menus or list selection.

Parameters:: client - The name of the SUT client.; id - The Id of the target component.; detail - The detail of the selection. Important for closing dialogs etc. For menu items leave it blank.
Author:: QFS,mm
Since:: 3.5.0

Procedure: "setLocation"

Set the location of a given component.

It uses setLocation(x,y) to set the location.

Parameters:: client - The name of the SUT client.; id - The Id of the target component.; x - The new x-coordinate of the location.; y - The new y-coordinate of the location.
Author:: QFS,mm
Since:: 2.1.0

Procedure: "setOverrideComponent"

Set a given component to the PriorityAwtSwingComponent.

Parameters:: client - The name of the SUT client.; id - The Id of the target component.
Author:: QFS,mm
Since:: 3.3.0

Procedure: "setSize"

Set the width and the height of a given component.

It uses setSize(width, height) to set the size.

Parameters:: client - The name of the SUT client.; id - The Id of the target component.; width - The new width of the component.; height - The new height of the component.
Author:: QFS,mm
Since:: 2.1.0

Procedure: "waitForComponent"

Wait for a given component.

Parameters:: client - The name of the SUT client.; id - The Id of the target component.; timeout - The timeout to wait for that component; throwExc - True, whether procedure should throw an exception if component didn't appear.
Author:: QFS,mm
Since:: 4.0

Procedure: "waitForComponentForAbsence"

Wait till a given component disappears.

Parameters:: client - The name of the SUT client.; id - The Id of the target component.; timeout - The timeout to wait for that component; throwExc - True, whether procedure should throw an exception if component didn't disappear.
Author:: QFS,mm
Since:: 4.0

Package: "list"

Procedures for accessing lists. (Swing component javax.swing.JList)

Author:: QFS,mm
Since:: 3.0

	Procedure/Dependency	Description
	clickItemWithDetails	Select a given item by a mouse click on it.
	getIndexOfItem	Return the current index of a given item.
	getItemCount	Return the number of items of a given list.
	getValueOfItem	Return the text of a given item.
	selectItem	Select a given item by a mouse click on it.

Procedure: "clickItemWithDetails"

Select a given item by a mouse click on it. You can specify the coordinates for clicking and all other details of that mouse click.

Parameters:: id - ID of the list.; item - The item.; itemSeparator - Separator to use for the item syntax. Default is @ for text values, also available & for index and % for regexp.; x - The x coordinate for the click, default is empty to click in the middle.; y - The y coordinate for the click, default is empty to click in the middle.; clickCount - Number of clicks. Default is 1. For a double click set this to 2.; modifier - Modifier for mouse key. 4 for right mouse. 16 for left mouse.; hard - True, if hard event should be replayed. Default is false.; popupTrigger - True, if click should open a popup. Default is false.
Author:: QFS,mm
Since:: 4.0

Procedure: "getIndexOfItem"

Return the current index of a given item.

Sample usage: Can be used to determine the numeric index of an item like 'Price'.

Parameters:: id - ID of the list.; item - The item.; itemSeparator - Separator to use for the item syntax. Default is @ for text values, also available & for index and % for regexp.
Returns:: index The current index of the item, which has been read by the 'Fetch Index' node of QF-Test.
Author:: QFS,mm
Since:: 3.1.1

Procedure: "getItemCount"

Return the number of items of a given list. It uses the method getModel().getSize() to get the number.

Parameters:: id - The component ID of the list.
Returns:: itemCount
Author:: QFS,mm
Since:: 3.0

Procedure: "getValueOfItem"

Return the text of a given item.

Sample usage: Determine the text of the second item.

Parameters:: id - ID of the list.; item - The item.; itemSeparator - Separator to use for the item syntax. Default is @ for text values, also available & for index and % for regexp.
Returns:: value The value of the item.
Author:: QFS,mm
Since:: 3.1.1

Procedure: "selectItem"

Select a given item by a mouse click on it.

Parameters:: id - ID of the list.; item - The item.; itemSeparator - Separator to use for the item syntax. Default is @ for text values, also available & for index and % for regexp.; x - The x coordinate for the click, default is empty to click in the middle.; y - The x coordinate for the click, default is empty to click in the middle.
Author:: QFS,mm
Since:: 3.1.1

Package: "checks"

Procedures for checking a list.

Author:: QFS,mm
Since:: 3.1.1

	Procedure/Dependency	Description
	checkNumberOfItems	Check the number of items of a given list according to a specified comparison mode.

Procedure: "checkNumberOfItems"

Check the number of items of a given list according to a specified comparison mode.

It uses JList.getModel().getSize() to get the number. Sample usage: You can check, that a list has exactly 6 items or that the table has less then 10 items.

Parameters:: id - The id of the list.; compareValue - The comparison value.; compareMode - The comparison mode = or ==, if the compareValue should be equal than the actual amount of items. <, if the compareValue should be greater than the actual amount of items. >, if the compareValue should be less than the actual amount of items. <=, if the compareValue should be greater or equal than the actual amount of items. >=, if the compareValue should be less or equal the actual amount of items. !=, if the compareValue should be not equal the actual amount of items.; errorLevel - The kind of error, which should be logged. Either EXCEPTION, ERROR, WARNING or MESSAGE.; appearInReport - Flag, whether to show check in report, if a message or warning are set as errorLevel. If this is set to 1, the check will be shown in the report.
Exceptions:: UserException, - if wrong comparison mode has been set.
Author:: QFS,mm
Since:: 3.1.1

Package: "selection"

Procedures to (de-)select certain items of a list.

Author:: QFS,mm
Since:: 3.1.1

	Procedure/Dependency	Description
	deselectAllItems	Deselect all items.
	deselectItem	Deselect a given item, specified by its index.
	deselectItemRange	Deselect a range of items, specified by their index.
	selectAllItems	Select all items.
	selectItem	Select a given item, specified by its index.
	selectItemRange	Select a range of items, specified by their index.

Procedure: "deselectAllItems"

Deselect all items. It uses removeSelectionInterval.

Parameters:: id - ID of the list.
Author:: QFS,mm
Since:: 3.1.1

Procedure: "deselectItem"

Deselect a given item, specified by its index. It uses removeSelectionInterval.

Parameters:: id - ID of the list.; item - The index of the item.
Author:: QFS,mm
Since:: 3.1.1

Procedure: "deselectItemRange"

Deselect a range of items, specified by their index. It uses removeSelectionInterval.

Parameters:: id - ID of the list.; startItem - The index of first item to be selected.; endItem - The index of last item to be selected.
Author:: QFS,mm
Since:: 3.1.1

Procedure: "selectAllItems"

Select all items. It uses setSelectionInterval.

Parameters:: id - ID of the list.
Author:: QFS,mm
Since:: 3.1.1

Procedure: "selectItem"

Select a given item, specified by its index. It uses setSelectionInterval.

Parameters:: id - ID of the list.; row - The index of the item.
Author:: QFS,mm
Since:: 3.1.1

Procedure: "selectItemRange"

Select a range of items, specified by their index. It uses setSelectionInterval.

Parameters:: id - ID of the list.; startItem - The index of first item to be selected.; endItem - The index of last item to be selected.
Author:: QFS,mm
Since:: 3.1.1

Package: "menu"

Procedures to select menu items and checkbox menu items. (Swing components javax.swing.JMenuItem and javax.swing.JCheckBoxMenuItem from javax.swing.JMenu)

Author:: QFS
Since:: 1.05.0

	Procedure/Dependency	Description
	selectCheckMenuItemInHierarchy	Select a checkbox menu item from a menu.
	selectCheckMenuItemInHierarchyWithCoordinates	Select a checkbox menu item from a menu.
	selectItem	Select an item from a menu.
	selectItemWithCoordinates	Select an item from a menu.
	selectMenuItemInHierarchy	Select an item from a menu.
	selectMenuItemInHierarchyWithCoordinates	Select an item from a menu.
	selectSubItem	Select an item within a submenu.
	selectSubItemWithCoordinates	Select an item within a submenu.
	setCheckItem	Select a checkbox menu item.
	setCheckItemWithCoordinates	Select a checkbox menu item.
	setSubCheckItem	Select a checkbox menu item within within a submenu.
	setSubCheckItemWithCoordinates	Select a checkbox menu item within within a submenu.

Procedure: "selectCheckMenuItemInHierarchy"

Parameters:: client - The name of the SUT client.; menu - The path of the parent menus. The path is specified as list of component ids.; menustringSeparator - The value, which separates the path of the parent menu.; checkItem - The id of the checkbox item.; checkItemValue - The check item value to be set - 'true' to select the checkbox item (default), 'false' to deselect.
Author:: QFS,mm
Since:: 3.5

Procedure: "selectCheckMenuItemInHierarchyWithCoordinates"

Parameters:: client - The name of the SUT client.; menu - The path of the parent menus. The path is specified as list of component ids.; menustringSeparator - The value, which separates the path of the parent menu.; checkItem - The id of the checkbox item.; checkItemValue - The check item value to be set - 'true' to select the checkbox item (default), 'false' to deselect.; menuX - The x coordinate for the click on the menu, default is empty to click in the middle.; menuY - The y coordinate for the click on the menu, default is empty to click in the middle.; checkItemX - The x coordinate for the click on the checkbox item, default is empty to click in the middle.; checkItemY - The y coordinate for the click on the checkbox item, default is empty to click in the middle.
Author:: QFS,mm
Since:: 4.0

Procedure: "selectItem"

Select an item from a menu.

For example: for the File -> Open action, the component ID of "File" is the menu, and the ID for "Open" is the item.

Parameters:: client - The name of the SUT client.; menu - The id of the menu.; item - The id of menu item.
Author:: QFS
Since:: 1.05.0

Procedure: "selectItemWithCoordinates"

Select an item from a menu.

For example: for the File -> Open action, the component ID of "File" is the menu, and the ID for "Open" is the item.

Parameters:: client - The name of the SUT client.; menu - The id of the menu.; item - The id of menu item.; menuX - The x coordinate for the click on the menu, default is empty to click in the middle.; menuY - The y coordinate for the click on the menu, default is empty to click in the middle.; itemX - The x coordinate for the click on the item, default is empty to click in the middle.; itemY - The y coordinate for the click on the item, default is empty to click in the middle.
Author:: QFS
Since:: 4.0

Procedure: "selectMenuItemInHierarchy"

Parameters:: client - The name of the SUT client.; menu - The path of the parent menus. The path is specified as list of component ids.; item - The id of menu item. When item is an empty string, the last component id of 'menu' will be used as 'item'.; menustringSeparator - The value, which separates the path of the parent menu.
Author:: QFS,mm
Since:: 3.5

Procedure: "selectMenuItemInHierarchyWithCoordinates"

Select an item from a menu. This procedure is designed to work with any menu item. You can define the entire menu path in the parameter menu. You can specify the coordinates for clicking.

Parameters:: client - The name of the SUT client.; menu - The path of the parent menus. The path is specified as list of component ids.; item - The id of menu item.; menustringSeparator - The value, which separates the path of the parent menu.; menuX - The x coordinate for the click on the menu, default is empty to click in the middle.; menuY - The y coordinate for the click on the menu, default is empty to click in the middle.; itemX - The x coordinate for the click on the menu item, default is empty to click in the middle.; itemY - The y coordinate for the click on the menu item, default is empty to click in the middle.
Author:: QFS,mm
Since:: 4.0

Procedure: "selectSubItem"

Select an item within a submenu.

For example: for the View -> Terminal -> Show action, the component ID of "View" is the menu, the ID for "Terminal" is the item, and the ID for "Show" is the subitem to select.

Parameters:: client - The name of the SUT client.; menu - The id of the menu.; item - The id of the item to open the submenu.; subItem - The id of item in submenu.
Author:: QFS
Since:: 1.05.0

Procedure: "selectSubItemWithCoordinates"

Select an item within a submenu.

For example: for the View -> Terminal -> Show action, the component ID of "View" is the menu, the ID for "Terminal" is the item, and the ID for "Show" is the subitem to select.

Parameters:: client - The name of the SUT client.; menu - The id of the menu.; item - The id of the item to open the submenu.; subItem - The id of item in submenu.; menuX - The x coordinate for the click on the menu, default is empty to click in the middle.; menuY - The y coordinate for the click on the menu, default is empty to click in the middle.; itemX - The x coordinate for the click on the item, default is empty to click in the middle.; itemY - The y coordinate for the click on the item, default is empty to click in the middle.; subItemX - The x coordinate for the click on the subitem, default is empty to click in the middle.; subItemY - The y coordinate for the click on the subitem, default is empty to click in the middle.
Author:: QFS
Since:: 4.0

Procedure: "setCheckItem"

Select a checkbox menu item.

For example: for the View -> Show Details action, the component ID of "View" is the menu, and the ID for "Show Details" is the checkbox item to set (to true or false).

Parameters:: client - The name of the SUT client.; menu - The id of the menu.; checkItem - The id of the checkbox item.; checkItemValue - The check item value to be set - 'true' to select the checkbox item (default), 'false' to deselect.
Author:: QFS
Since:: 1.05.0

Procedure: "setCheckItemWithCoordinates"

Select a checkbox menu item.

For example: for the View -> Show Details action, the component ID of "View" is the menu, and the ID for "Show Details" is the checkbox item to set (to true or false).

Parameters:: client - The name of the SUT client.; menu - The id of the menu.; checkItem - The id of the checkbox item.; checkItemValue - The check item value to be set - 'true' to select the checkbox item (default), 'false' to deselect.; menuX - The x coordinate for the click on the menu, default is empty to click in the middle.; menuY - The y coordinate for the click on the menu, default is empty to click in the middle.; checkItemX - The x coordinate for the click on the checkbox item, default is empty to click in the middle.; checkItemY - The y coordinate for the click on the checkbox item, default is empty to click in the middle.
Author:: QFS
Since:: 4.0

Procedure: "setSubCheckItem"

Select a checkbox menu item within within a submenu.

Parameters:: client - The name of the SUT client.; menu - The id of the menu.; item - The id of the item to open the submenu.; subCheckItem - The id of the checkbox item in the submenu.; checkItemValue - The checkbox item value to be set - "true" to select the checkbox item (default), "false" to deselect.
Author:: QFS
Since:: 1.05.0

Procedure: "setSubCheckItemWithCoordinates"

Select a checkbox menu item within within a submenu.

Parameters:: client - The name of the SUT client.; menu - The id of the menu.; item - The id of the item to open the submenu.; subCheckItem - The id of the checkbox item in the submenu.; checkItemValue - The checkbox item value to be set - "true" to select the checkbox item (default), "false" to deselect.; menuX - The x coordinate for the click on the menu, default is empty to click in the middle.; menuY - The y coordinate for the click on the menu, default is empty to click in the middle.; itemX - The x coordinate for the click on the item, default is empty to click in the middle.; itemY - The y coordinate for the click on the item, default is empty to click in the middle.; subCheckItemX - The x coordinate for the click on the checkbox item, default is empty to click in the middle.; subCheckItemY - The y coordinate for the click on the checkbox item, default is empty to click in the middle.
Author:: QFS
Since:: 4.0

Package: "optionpane"

Procedures for accessing standard error/message dialogs. (Swing component javax.swing.JOptionPane)

Author:: QFS
Since:: 1.07.0

	Procedure/Dependency	Description
	checkMessage	Check the message of the current `javax.swing.JOptionPane` dialog.
	checkTitle	Check the title of the current `javax.swing.JOptionPane` dialog.
	clickCancelButton	Click on the Cancel Button of the current `javax.swing.JOptionPane` dialog.
	clickNoButton	Click on the No Button of the current `javax.swing.JOptionPane` dialog.
	clickOkButton	Click on the OK Button of the current `javax.swing.JOptionPane` dialog.
	clickYesButton	Click on the Yes Button of the current `javax.swing.JOptionPane` dialog.
	disableNameResolver	Uninstall the `JOptionPane` name resolver.
	enableNameResolver	Install the `JOptionPane` name resolver.
	getMessage	Get the message of the current `javax.swing.JOptionPane` dialog.
	getOptionPaneMessageType	Return the message Type of the current `javax.swing.JOptionPane` dialog.
	getTitle	Get the title of the current `javax.swing.JOptionPane` dialog.
	hasCancelButton	Check if the current `javax.swing.JOptionPane` dialog has an Cancel Button.
	hasNoButton	Check if the current `javax.swing.JOptionPane` dialog has an NO Button.
	hasOkButton	Check if the current `javax.swing.JOptionPane` dialog has an OK Button.
	hasYesButton	Check if the current `javax.swing.JOptionPane` dialog has an YES Button.
	isErrorDialog	Check, if current window is a `javax.swing.JOptionPane` ErrorDialog.
	isInfoDialog	Check, if current window is a `javax.swing.JOptionPane` InfoDialog.
	isOptionPane	Check, if current window is a `javax.swing.JOptionPane` dialog.
	isPlainDialog	Check, if current window is a `javax.swing.JOptionPane` PlainDialog.
	isQuestionDialog	Check, if current window is a `javax.swing.JOptionPane` QuestionDialog.
	isWarningDialog	Check, if current window is a `javax.swing.JOptionPane` WarningDialog.

Procedure: "checkMessage"

Check the message of the current javax.swing.JOptionPane dialog.

Parameters:: client - The name of the SUT client.; newline - The newline character used in the JOptionPane dialog.; expectedMsg - The string representing the expected message.; checkMessage - The message, which should be written into the run log for that check.; compareMode - The comparison mode. = or ==, asserts got == expected <, asserts got < expected >, asserts got > expected <=, asserts got <= expected >=, asserts got >= expected !=, asserts got != expected regexp, the expected value should be treated as a regular expression, that matches the received value. regexpNegate, the expected value should be treated as a regular expression, that doesn't match the received value.; errorLevel - The kind of error, which should be logged. Either EXCEPTION, ERROR, WARNING or MESSAGE.; appearInReport - Flag, whether to show check in report, if a message or warning are set as errorLevel. If this is set to 1, the check will be shown in the report.
Exceptions:: UserException - If wrong comparison mode has been set this exception will be thrown.; ClientNotConnectedException - If SUT wasn't started this exception will be thrown.; ComponentNotFoundException - If no optionpane dialog was found, this exception will be thrown.
Author:: QFS,ys
Since:: 3.5.3

Procedure: "checkTitle"

Check the title of the current javax.swing.JOptionPane dialog.

Parameters:: client - The name of the SUT client.; expectedTitle - The string representing the expected title.; checkMessage - The message, which should be written into the run log for that check.; compareMode - The comparison mode. = or ==, asserts got == expected <, asserts got < expected >, asserts got > expected <=, asserts got <= expected >=, asserts got >= expected !=, asserts got != expected regexp, the expected value should be treated as regular expression, that matches the received value. regexpNegate, the expected value should be treated as regular expression, that doesn't match the received value.; errorLevel - The kind of error, which should be logged. Either EXCEPTION, ERROR, WARNING or MESSAGE.; appearInReport - Flag, whether to show check in report, if a message or warning are set as errorLevel. If this is set to 1, the check will be shown in the report.
Exceptions:: UserException - If wrong comparison mode has been set this exception will be thrown.; ClientNotConnectedException - If SUT wasn't started this exception will be thrown.; ComponentNotFoundException - If no optionpane dialog was found, this exception will be thrown.
Author:: QFS,ys
Since:: 3.5.3

Procedure: "clickCancelButton"

Click on the Cancel Button of the current javax.swing.JOptionPane dialog.

Parameters:: client - The name of the SUT client.
Exceptions:: ClientNotConnectedException - If SUT wasn't started this exception will be thrown.; ComponentNotFoundException - If no optionpane dialog was found, this exception will be thrown.
Author:: QFS,ys
Since:: 3.5.3

Procedure: "clickNoButton"

Click on the No Button of the current javax.swing.JOptionPane dialog.

Parameters:: client - The name of the SUT client.
Exceptions:: ClientNotConnectedException - If SUT wasn't started this exception will be thrown.; ComponentNotFoundException - If no optionpane dialog was found, this exception will be thrown.
Author:: QFS,ys
Since:: 3.5.3

Procedure: "clickOkButton"

Click on the OK Button of the current javax.swing.JOptionPane dialog.

Parameters:: client - The name of the SUT client.
Exceptions:: ClientNotConnectedException - If SUT wasn't started this exception will be thrown.; ComponentNotFoundException - If no optionpane dialog was found, this exception will be thrown.
Author:: QFS,ys
Since:: 3.5.3

Procedure: "clickYesButton"

Click on the Yes Button of the current javax.swing.JOptionPane dialog.

Parameters:: client - The name of the SUT client.
Exceptions:: ClientNotConnectedException - If SUT wasn't started this exception will be thrown.; ComponentNotFoundException - If no optionpane dialog was found, this exception will be thrown.
Author:: QFS,ys
Since:: 3.5.3

Procedure: "disableNameResolver"

Uninstall the JOptionPane name resolver.

The name resolver is automatically enabled and disabled by the other procedures of this packages. Therefore you typically don't need to do this explicitly.

Parameters:: client - The name of the SUT client.
Author:: QFS
Since:: 1.07.0

Procedure: "enableNameResolver"

Install the JOptionPane name resolver. The effect is similar to assigning names to the most important components in JOptionPane dialogs with setName().

The name resolver is automatically enabled and disabled by the other procedures of this packages. Therefore you typically don't need to do this explicitly.

Parameters:: client - The name of the SUT client.
Author:: QFS
Since:: 1.07.0

Procedure: "getMessage"

Get the message of the current javax.swing.JOptionPane dialog.

Parameters:: client - The name of the SUT client.; newline - The newline character used in the JOptionPane dialog.
Returns:: The message of the optionpane dialog.
Exceptions:: ClientNotConnectedException - If SUT wasn't started this exception will be thrown.; ComponentNotFoundException - If no optionpane dialog was found, this exception will be thrown.
Author:: QFS,ys
Since:: 3.5.3

Procedure: "getOptionPaneMessageType"

Return the message Type of the current javax.swing.JOptionPane dialog.

Parameters:: client - The name of the SUT client.
Returns:: This function returns one of the following Strings: ErrorDialog, if an error dialog was detected; InfoDialog, if an info dialog was detected; WarningDialog, if a warning dialog was detected; PlainDialog, if a plain dialog was detected; QuestionDialog, if a question dialog was detected.
Exceptions:: ClientNotConnectedException - If SUT wasn't started this exception will be thrown.; ComponentNotFoundException - If no JOptionPane dialog was found, this exception will be thrown!; UserException - with the message "Unknown dialog!" if non of these dialogs could be detected.
Author:: QFS,ys
Since:: 3.5.3

Procedure: "getTitle"

Get the title of the current javax.swing.JOptionPane dialog.

Parameters:: client - The name of the SUT client.
Returns:: Returns the title of the current optionpane dialog.
Exceptions:: ClientNotConnectedException - If SUT wasn't started this exception will be thrown.
Author:: QFS,ys
Since:: 3.5.3

Procedure: "hasCancelButton"

Check if the current javax.swing.JOptionPane dialog has an Cancel Button.

Parameters:: client - The name of the SUT client.; throwExc - Whether to throw a ComponentNotFoundException, if the optionpane dialog has no Cancel button.
Returns:: The result of the check ('true' if Cancel Button was found otherwise 'false').
Exceptions:: ClientNotConnectedException - If SUT wasn't started this exception will be thrown.; ComponentNotFoundException - If no optionpane dialog or no Cancel Button was found, this exception will be thrown.
Author:: QFS,ys
Since:: 3.5.3

Procedure: "hasNoButton"

Check if the current javax.swing.JOptionPane dialog has an NO Button.

Parameters:: client - The name of the SUT client.; throwExc - Whether to throw a ComponentNotFoundException, if the optionpane dialog has no NO button.
Returns:: The result of the check ('true' if NO Button was found otherwise 'false').
Exceptions:: ClientNotConnectedException - If SUT wasn't started this exception will be thrown.; ComponentNotFoundException - If no optionpane dialog or no No Button was found, this exception will be thrown.
Author:: QFS,ys
Since:: 3.5.3

Procedure: "hasOkButton"

Check if the current javax.swing.JOptionPane dialog has an OK Button.

Parameters:: client - The name of the SUT client.; throwExc - Whether to throw a ComponentNotFoundException, if the optionpane dialog has no OK button.
Returns:: The result of the check ('true' if OK Button was found otherwise 'false').
Exceptions:: ClientNotConnectedException - If SUT wasn't started this exception will be thrown.; ComponentNotFoundException - If no optionpane dialog or no Ok Button was found, this exception will be thrown.
Author:: QFS,ys
Since:: 3.5.3

Procedure: "hasYesButton"

Check if the current javax.swing.JOptionPane dialog has an YES Button.

Parameters:: client - The name of the SUT client.; throwExc - Whether to throw a ComponentNotFoundException, if the optionpane dialog has no YES button.
Returns:: The result of the check ('true' if YES Button was found otherwise 'false').
Exceptions:: ClientNotConnectedException - If SUT wasn't started this exception will be thrown.; ComponentNotFoundException - If no optionpane dialog or no Yes Button was found, this exception will be thrown.
Author:: QFS,ys
Since:: 3.5.3

Procedure: "isErrorDialog"

Check, if current window is a javax.swing.JOptionPane ErrorDialog.

Parameters:: client - The name of the SUT client.; throwExc - Whether to throw an exception, if the JOptionPane ErrorDialog wasn't found.
Returns:: This function returns true if current window is a JOptionPane error dialog, otherwise false.
Exceptions:: ClientNotConnectedException - If SUT wasn't started this exception will be thrown.
Author:: QFS,ys
Since:: 3.5.3

Procedure: "isInfoDialog"

Check, if current window is a javax.swing.JOptionPane InfoDialog.

Parameters:: client - The name of the SUT client.; throwExc - Whether to throw an exception, if the JOptionPane InfoDialog wasn't found.
Returns:: This function returns true if current window is a JOptionPane info dialog, otherwise false.
Exceptions:: ClientNotConnectedException - If SUT wasn't started this exception will be thrown.
Author:: QFS,ys
Since:: 3.5.3

Procedure: "isOptionPane"

Check, if current window is a javax.swing.JOptionPane dialog.

Parameters:: client - The name of the SUT client.; throwExc - Whether to throw an exception, if the JOptionPane dialog wasn't found.
Returns:: This function returns true if current window is a JOptionPane dialog, otherwise false.
Exceptions:: ClientNotConnectedException - If SUT wasn't started this exception will be thrown.
Author:: QFS,ys
Since:: 3.5.3

Procedure: "isPlainDialog"

Check, if current window is a javax.swing.JOptionPane PlainDialog.

Parameters:: client - The name of the SUT client.; throwExc - Whether to throw an exception, if the JOptionPane dialog wasn't found.
Returns:: This function returns true if current window is a JOptionPane plain dialog, otherwise false.
Exceptions:: ClientNotConnectedException - If SUT wasn't started this exception will be thrown.
Author:: QFS,ys
Since:: 3.5.3

Procedure: "isQuestionDialog"

Check, if current window is a javax.swing.JOptionPane QuestionDialog.

Parameters:: client - The name of the SUT client.; throwExc - Whether to throw an exception, if the JOptionPane QuestionDialog wasn't found.
Returns:: This function returns true if current window is a JOptionPane question dialog, otherwise false.
Exceptions:: ClientNotConnectedException - If SUT wasn't started this exception will be thrown.
Author:: QFS,ys
Since:: 3.5.3

Procedure: "isWarningDialog"

Check, if current window is a javax.swing.JOptionPane WarningDialog.

Parameters:: client - The name of the SUT client.; throwExc - Whether to throw an exception, if the JOptionPane WarningDialog wasn't found.
Returns:: This function returns true if current window is a JOptionPane warning dialog, otherwise false.
Exceptions:: ClientNotConnectedException - If SUT wasn't started this exception will be thrown.
Author:: QFS,ys
Since:: 3.5.3

Package: "popupmenu"

Procedures to select items and checkbox menu items from popup menus.

Note that for all procedures, the popup menu must first be opened by the calling test suite, as the popup menu is component-dependent.

See package "menu" for more details about menus and submenus. (Swing components javax.swing.JMenuItem and javax.swing.JCheckBoxMenuItem from javax.swing.JPopupMenu)

Author:: QFS
Since:: 1.05.0

	Procedure/Dependency	Description
	clickItemWithDetails	Select an item in a popup menu.
	selectItem	Select an item in a popup menu.
	selectSubItem	Select an item within a submenu of a popup menu.
	selectSubItemWithCoordinates	Select an item within a submenu of a popup menu.
	setCheckItem	Select a checkbox menu item in a popup menu.
	setCheckItemWithCoordinates	Select a checkbox menu item in a popup menu.
	setSubCheckItem	Select a checkbox menu item within a submenu of a popup menu.
	setSubCheckItemWithCoordinates	Select a checkbox menu item within a submenu of a popup menu.

Procedure: "clickItemWithDetails"

Select an item in a popup menu. You can specify the coordinates for clicking and all other details of that mouse click.

Parameters:: client - The name of the SUT client.; item - The id of menu item.; x - The x coordinate for the click, default is empty to click in the middle.; y - The y coordinate for the click, default is empty to click in the middle.; clickCount - Number of clicks. Default is 1. For a double click set this to 2.; modifier - Modifier for mouse key. 4 for right mouse. 16 for left mouse.; hard - True, if hard event should be replayed. Default is false.
Author:: QFS,mm
Since:: 4.0

Procedure: "selectItem"

Select an item in a popup menu.

Parameters:: client - The name of the SUT client.; item - The id of menu item.
Author:: QFS
Since:: 1.05.0

Procedure: "selectSubItem"

Select an item within a submenu of a popup menu.

Parameters:: client - The name of the SUT client.; item - The id of the item to open the submenu.; subItem - The id of item in submenu.
Author:: QFS
Since:: 1.05.0

Procedure: "selectSubItemWithCoordinates"

Select an item within a submenu of a popup menu. You can specify the coordinates for clicking.

Parameters:: client - The name of the SUT client.; item - The id of the item to open the submenu.; subItem - The id of item in submenu.; itemX - The x coordinate for the click on the item, default is empty to click in the middle.; itemY - The y coordinate for the click on the item, default is empty to click in the middle.; subItemX - The x coordinate for the click on the subitem, default is empty to click in the middle.; subItemY - The y coordinate for the click on the subitem, default is empty to click in the middle.
Author:: QFS
Since:: 4.0

Procedure: "setCheckItem"

Select a checkbox menu item in a popup menu.

Parameters:: client - The name of the SUT client.; checkItem - The id of the menu checkbox item.; checkItemValue - The checkbox item value to be set - "true" to select the checkbox item (default), "false" to deselect.
Author:: QFS
Since:: 1.05.0

Procedure: "setCheckItemWithCoordinates"

Select a checkbox menu item in a popup menu. You can specify the coordinates for clicking.

Parameters:: client - The name of the SUT client.; checkItem - The id of the menu checkbox item.; checkItemValue - The checkbox item value to be set - "true" to select the checkbox item (default), "false" to deselect.; x - The x coordinate for the click, default is empty to click in the middle.; y - The y coordinate for the click, default is empty to click in the middle.
Author:: QFS
Since:: 4.0

Procedure: "setSubCheckItem"

Select a checkbox menu item within a submenu of a popup menu.

Parameters:: client - The name of the SUT client.; item - The id of item to open the submenu.; subCheckItem - The id of the checkbox item in the submenu.; checkItemValue - The checkbox item value to be set - "true" to select the checkbox item (default), "false" to deselect.
Author:: QFS
Since:: 1.05.0

Procedure: "setSubCheckItemWithCoordinates"

Select a checkbox menu item within a submenu of a popup menu. You can specify the coordinates for clicking.

Parameters:: client - The name of the SUT client.; item - The id of item to open the submenu.; subCheckItem - The id of the checkbox item in the submenu.; checkItemValue - The checkbox item value to be set - "true" to select the checkbox item (default), "false" to deselect.; itemX - The x coordinate for the click on the item, default is empty to click in the middle.; itemY - The y coordinate for the click on the item, default is empty to click in the middle.; subCheckItemX - The x coordinate for the click on the checkbox item, default is empty to click in the middle.; subCheckItemY - The y coordinate for the click on the checkbox item, default is empty to click in the middle.
Author:: QFS
Since:: 4.0

Package: "radiobutton"

Procedures to get and set the state of radio buttons. (Swing component javax.swing.JRadioButton)

Author:: QFS,mm
Since:: 3.5.0

	Procedure/Dependency	Description
	getValue	Return the value of a radio button.
	select	Select a radio button.
	selectWithCoordinates	Select a radio button.

Procedure: "getValue"

Return the value of a radio button. It's either 1, if radio button is selected of 0, if radio button is not selected.

Parameters:: id - ID of the radio button.
Returns:: The state of the checkbox.
Author:: QFS,mm
Since:: 3.5.0

Procedure: "select"

Select a radio button. If the radio button is already selected, no action is performed.

Parameters:: id - The id of the radio button.
Author:: QFS,mm
Since:: 3.5.0

Procedure: "selectWithCoordinates"

Select a radio button. If the radio button is already selected, no action is performed. You can specify the coordinates for clicking.

Parameters:: id - The id of the radio button.; x - The x coordinate for the click, default is empty to click in the middle.; y - The y coordinate for the click, default is empty to click in the middle.
Author:: QFS,mm
Since:: 4.0

Package: "slider"

Procedures to access sliders. (Swing component javax.swing.JSlider)

Author:: QFS, mm
Since:: 3.4.1

	Procedure/Dependency	Description
	getValue	Return the value of a slider component.
	setValue	Set the value of a slider component.

Procedure: "getValue"

Return the value of a slider component.

Parameters:: id - The component ID of the slider.
Returns:: The current vale of the slider.
Author:: QFS, mm
Since:: 3.4.1

Procedure: "setValue"

Set the value of a slider component.

Parameters:: id - The component ID of the slider.; value - The value to set.
Author:: QFS, mm
Since:: 3.4.1

Package: "checks"

Procedure for checking slider values.

Author:: QFS, mm
Since:: 3.4.1

	Procedure/Dependency	Description
	checkValue	Check the value of a slider component

Procedure: "checkValue"

Check the value of a slider component

Parameters:: id - The component ID of the slider.; value - The value to be checked,; regexp - if this value is set to true, the text will be checks as regular expression.; negate - if, the check should check for anything but the given text.; nameCheckType - the value for "name of check type" attribute.; throwExc - whether the check should throw an exception on failure.; reportName - the Name for the check in the report.; timeout - Timeout for the checked condition to happen.
Author:: QFS, mm
Since:: 3.4.1

Package: "startup"

Procedures for startup of swing applications.

Author:: QFS, gs
Since:: 3.4.14

	Procedure/Dependency	Description
	setDelays	Set delays for the QF-Test SUT initialization process.
	setSecurityDialogSpec	Define properties for recognizing WebStart and applet security dialogs that should be closed automatically.
	startWebstartSUT	Start a Webstart SUT.

Procedure: "setDelays"

Set delays for the QF-Test SUT initialization process.

Note: Values that are documented to have a default will pick up that default when you set them to 0. Use 1 to disable the default.

The Java WebStart launcher has several race conditions where initialization of QF-Test SUT client wrapper can lead to problems, even to crashes. Newer versions of the Java applet plugin exhibit similar problems. QF-Test therefore delays certain steps in the SUT connection process to allow the SUT to get past the critical points.

By calling this procedure before SUT startup with one or more of the following parameters it is possible to fine-tune these delays. Unfortunately there is no single optimal setting. In case you experience problems with SUT startup you will need to experiment with these values. Start with few parameters and values between 5000 and 10000.

Parameters:: delay-1 - Earliest place, called once. Default is 3000 for WebStart and applets. Good choice up to 30000.; delay0 - Before checking ThreadGroups. Called often, use small values.; delay10 - After checking ThreadGroups. Called often, use small values.; delay1 - Before checking ThreadGroups for security engine. Called often, use small values.; delay11 - After checking ThreadGroups for security engine. Called often, use small values.; delay2 - Applet plugin only, good choice for that.; delay3 - Before initializing RMI, normal engine. Good choice. Default 3000.; delay13 - Before initializing RMI, security engine. Good choice. Default 2000.; delay4 - Before creating security engine. Rarely useful.; delay5 - Before installing EventQueue. Rarely useful.; delay6 - After installing EventQueue. Rarely useful.; delay7 - Before connecting with QF-Test. Rarely useful.; delay8 - WebStart only. Before initializing the engine on the system ThreadGroup which should be avoided if possible. Default 30000.; delay20 - WebStart and applet only. Before automatically closing security dialogs. Can be set to enable manual interaction. Default 300.
Author:: QFS,gs
Since:: 3.4.14

Procedure: "setSecurityDialogSpec"

Define properties for recognizing WebStart and applet security dialogs that should be closed automatically. Default values, which handle English and German security dialogs in current versions of Java 6, 7 and 8 apply in case of empty parameters.

Do disable automatic handling of security dialogs, set the title parameter to '-'.

Parameters:: title - A regular expression matching the dialog title. Set to '-' to disable automatic handling of security dialogs. Default: .*(Security|Sicherheit|Deprecation warning|Veraltet - Warnung).*"; button - A regular expression matching the text of the button to click. Default: (OK|Yes|Run|Continue|Ja|Ausf.hren|Fortfahren|Weiter); permanent - Whether to accept the certificate permanently. Default is false.; checkbox - A regular expression matching the text of the checkbox to select in order to accept the certificate permanently. Default: .*(not show this|lways trust|nicht (mehr|wieder) anzeigen|immer vertrauen).*
Author:: QFS,gs
Since:: 3.5.2

Procedure: "startWebstartSUT"

Start a Webstart SUT.

Parameters:: client - The client.; exec - The Java webstart executable. Default is javaws.; jnlp - The jnlp Descriptor file either given local or as URL.; waitForClientTimeout - Time in ms to wait for the client to connect. Default is 120000.
Author:: QFS,kk
Since:: 3.5

Package: "tabbedpane"

Procedures to work with TabbedPanes. (Swing component javax.swing.JTabbedPane or any other TabFolder implementations)

Author:: QFS,mm
Since:: 2.1.0

	Procedure/Dependency	Description
	closeTab	Close a tab via clicking on the "X "button.
	getIndexOfTab	Return the index of a given tab in a JTabbedPane.
	getItemCount	Return the number of items of a given tabbedpane.
	getValueOfTab	Return the text of a given tab in a JTabbedPane.
	selectTab	Select a tab in a given TabbedPane.

Procedure: "closeTab"

Close a tab via clicking on the "X "button. The procedure assumes that the "X" button is located 10 pixel away from the right corner. If this doesn't work for you, you can configure this via the parameter "wdiff".

Parameters:: id - ID of tab, which should be closed.; wdiff - X position of the "x" button seen from the right side.; y - The y coordinate for the click, default is empty to click in the middle.
Author:: QFS,mm
Since:: 2.1.0

Procedure: "getIndexOfTab"

Return the index of a given tab in a JTabbedPane.

Parameters:: client - The name of the SUT client.; id - The component ID of the tabbedpane.; separator - Separator to use for the tab syntax. Default is @ for text values, also available & for index and % for regexp.; value - The value to look for.
Returns:: The index of the tab.
Author:: QFS,mm
Since:: 3.5.0

Procedure: "getItemCount"

Return the number of items of a given tabbedpane.

Parameters:: id - The component ID of the tabbedpane.
Returns:: itemCount
Author:: QFS
Since:: 5.3.1

Procedure: "getValueOfTab"

Return the text of a given tab in a JTabbedPane.

Parameters:: client - The name of the SUT client.; id - The component ID of the tabbedpane.; separator - Separator to use for the tab syntax. Default is @ for text values, also available & for index and % for regexp.; value - The index to look for.
Returns:: The value of the tab.
Author:: QFS,mm
Since:: 3.5.0

Procedure: "selectTab"

Select a tab in a given TabbedPane.

Parameters:: client - The name of the SUT client.; id - The component ID of the tabbedpane to select.; separator - Separator to use for the tab syntax. Default is @ for text values, also available & for index and % for regexp.; value - The value to select.
Author:: QFS,mm
Since:: 2.1.0

Package: "table"

Procedures to access tables. (Swing component javax.swing.JTable)

Author:: QFS,mm
Since:: 1.08.4

	Procedure/Dependency	Description
	clickCellWithDetails	Select a given cell.
	getColumnCount	Return the number of columns of a given table.
	getIndexOfColumn	Return the current index of a given column.
	getNameOfColumn	Return the header text of a given column.
	getRowCount	Return the number of rows of a given table.
	getRowIndexOfCell	Return the row number of a given cell.
	getValueOfCell	Return the text of a given cell.
	resizeColumn	Resize width of a table column.
	selectCell	Select a given cell.

Procedure: "clickCellWithDetails"

Select a given cell. You can specify the coordinates for clicking and all other details of that mouse click.

Parameters:: id - ID of the table.; column - The column.; row - The row.; columnSeparator - Separator to use for the column syntax. Default is @ for text values, also available & for index and % for regexp.; rowSeparator - Separator to use for the row syntax. Default is @ for text values, also available & for index and % for regexp.; x - The x coordinate for the click, default is empty to click in the middle.; y - The y coordinate for the click, default is empty to click in the middle.; clickCount - Number of clicks. Default is 1. For a double click set this to 2.; modifier - Modifier for mouse key. 4 for right mouse. 16 for left mouse.; hard - True, if hard event should be replayed. Default is false.; popupTrigger - True, if click should open a popup. Default is false.
Author:: QFS,mm
Since:: 4.0

Procedure: "getColumnCount"

Return the number of columns of a given table. It uses the method getColumnCount() to get the number.

Parameters:: id - The component ID of the table.
Returns:: columnCount
Author:: QFS,mm
Since:: 2.1.0

Procedure: "getIndexOfColumn"

Return the current index of a given column.

Sample usage: Can be used to determine the numeric index of a column like 'Price'.

Parameters:: id - ID of the table.; column - The column.; columnSeparator - Separator to use for the column syntax. Default is @ for text values, also available & for index and % for regexp.
Returns:: index The current index of the column, which has been read by the 'Fetch Index' node of QF-Test.
Author:: QFS,mm
Since:: 3.1.1

Procedure: "getNameOfColumn"

Return the header text of a given column.

Sample usage: Determine the title of the second column.

Parameters:: id - ID of the table.; column - The column.; columnSeparator - Separator to use for the column syntax. Default is @ for text values, also available & for index and % for regexp.
Returns:: name The name of the column.
Author:: QFS,mm
Since:: 3.1.1

Procedure: "getRowCount"

Return the number of rows of a given table. It uses the method JTable.getRowCount() to get the number.

Parameters:: id - The component id of the table.
Returns:: rowCount
Author:: QFS,mm
Since:: 2.1.0

Procedure: "getRowIndexOfCell"

Return the row number of a given cell.

Sample usage: Can be used to determine in which row a dedicated cell is located.

Parameters:: id - ID of the table.; column - The column.; row - The row.; columnSeparator - Separator to use for the column syntax. Default is @ for text values, also available & for index and % for regexp.; rowSeparator - Separator to use for the row syntax. Default is @ for text values, also available & for index and % for regexp.
Returns:: index The current index of the row, which has been read by the 'Fetch Index' node of QF-Test.
Author:: QFS,mm
Since:: 3.1.1

Procedure: "getValueOfCell"

Return the text of a given cell.

Sample usage: Can be used to determine the text of the cell in the first column and first row.

Parameters:: id - ID of the table.; column - The column.; row - The row.; columnSeparator - Separator to use for the column syntax. Default is @ for text values, also available & for index and % for regexp.; rowSeparator - Separator to use for the row syntax. Default is @ for text values, also available & for index and % for regexp.
Returns:: value The current value of the row, which has been read by the 'Fetch text' node of QF-Test.
Author:: QFS,mm
Since:: 3.1.1

Procedure: "resizeColumn"

Resize width of a table column.

Parameters:: client - The name of the client.; idColumn - The id of the table column to be resized.; width - The new width - additional or absolute, dependent on the 'absolute' parameter. For additional width also negative values are possible to shrink the column size.; absolute - True, if the with value shall be the absolute new column width (default is 'true').
Author:: QFS,mm
Since:: 1.08.4

Procedure: "selectCell"

Select a given cell.

Parameters:: id - ID of the table.; column - The column.; row - The row.; columnSeparator - Separator to use for the column syntax. Default is @ for text values, also available & for index and % for regexp.; rowSeparator - Separator to use for the row syntax. Default is @ for text values, also available & for index and % for regexp.
Author:: QFS,mm
Since:: 2.1.0

Package: "checkbox"

Procedures to set the state of checkboxes in a table cell. These procedures become necessary, because checkboxes in tables cannot be treated like normal checkboxes.

Author:: QFS,mm
Since:: 3.0

	Procedure/Dependency	Description
	deselect	Deselect a checkbox in a table cell.
	deselectWithCoordinates	Deselect a checkbox in a table cell.
	select	Select a checkbox in a table cell.
	selectWithCoordinates	Select a checkbox in a table cell.
	set	Set checkbox in a table cell to the given state.
	setWithCoordinates	Set checkbox in a table cell to the given state.

Procedure: "deselect"

Deselect a checkbox in a table cell. If the checkbox is already deselected, no action is performed.

Parameters:: client - The name of the SUT client.; id - The id of the checkbox, including the table id and the addressing of the cell.
Author:: QFS,mm
Since:: 3.0

Procedure: "deselectWithCoordinates"

Deselect a checkbox in a table cell. If the checkbox is already deselected, no action is performed. You can specify the coordinates for clicking.

Parameters:: client - The name of the SUT client.; id - The id of the checkbox, including the table id and the addressing of the cell.; x - The x coordinate for the click, default is empty to click in the middle.; y - The y coordinate for the click, default is empty to click in the middle.
Author:: QFS,mm
Since:: 4.0

Procedure: "select"

Select a checkbox in a table cell. If the checkbox is already selected, no action is performed.

Parameters:: client - The name of the SUT client.; id - The id of the checkbox, including the table id and the addressing of the cell.
Author:: QFS,mm
Since:: 3.0

Procedure: "selectWithCoordinates"

Select a checkbox in a table cell. If the checkbox is already selected, no action is performed. You can specify the coordinates for clicking.

Parameters:: client - The name of the SUT client.; id - The id of the checkbox, including the table id and the addressing of the cell.; x - The x coordinate for the click, default is empty to click in the middle.; y - The y coordinate for the click, default is empty to click in the middle.
Author:: QFS,mm
Since:: 4.0

Procedure: "set"

Set checkbox in a table cell to the given state.

Parameters:: client - The name of the SUT client.; id - The id of the checkbox, including the table id and the addressing of the cell.; check - The check value to be set (either true or false).
Author:: QFS,mm
Since:: 3.0

Procedure: "setWithCoordinates"

Set checkbox in a table cell to the given state. You can specify the coordinates for clicking.

Parameters:: client - The name of the SUT client.; id - The id of the checkbox, including the table id and the addressing of the cell.; check - The check value to be set (either true or false).; x - The x coordinate for the click, default is empty to click in the middle.; y - The y coordinate for the click, default is empty to click in the middle.
Author:: QFS,mm
Since:: 4.0

Package: "checks"

Procedures for checking a table.

Author:: QFS,mm
Since:: 3.1.1

	Procedure/Dependency	Description
	checkNumberOfRows	Check the number of rows of a given table according to a specified comparison mode.

Procedure: "checkNumberOfRows"

Check the number of rows of a given table according to a specified comparison mode. It uses the method JTable.getRowCount() to get the number.

Sample usage: You can check, that a table has exactly 6 rows or that the table has less then 10 rows.

Parameters:: id - The id of the table.; compareValue - The comparison value.; compareMode - The comparison mode = or ==, if the compareValue should be equal than the actual amount of rows. <, if the compareValue should be greater than the actual amount of rows. >, if the compareValue should be less than the actual amount of rows. <=, if the compareValue should be greater or equal than the actual amount of rows. >=, if the compareValue should be less or equal the actual amount of rows. !=, if the compareValue should be not equal the actual amount of items.; errorLevel - The kind of error, which should be logged. Either EXCEPTION, ERROR, WARNING or MESSAGE.; appearInReport - Flag, whether to show check in report, if a message or warning are set as errorLevel. If this is set to 1, the check will be shown in the report.
Exceptions:: UserException, - if wrong comparison mode has been set.
Author:: QFS,mm
Since:: 3.1.1

Package: "selection"

Procedures to (de-)select certain rows of a table.

Author:: QFS,mm
Since:: 2.1.0

	Procedure/Dependency	Description
	deselectAllRows	Deselect all rows.
	deselectRow	Deselect a given row, specified by its index.
	deselectRowRange	Deselect a range of rows, specified by their index.
	selectAllRows	Select all rows.
	selectRow	Select a given row, specified by its index.
	selectRowRange	Select a range of rows, specified by their index.

Procedure: "deselectAllRows"

Deselect all rows. It uses removeSelectionInterval.

Parameters:: id - ID of the table.
Author:: QFS,mm
Since:: 2.1.0

Procedure: "deselectRow"

Deselect a given row, specified by its index. It uses removeSelectionInterval.

Parameters:: id - ID of the table.; row - The index of the row.
Author:: QFS,mm
Since:: 2.1.0

Procedure: "deselectRowRange"

Deselect a range of rows, specified by their index. It uses removeSelectionInterval.

Parameters:: id - ID of the table.; startRow - The index of first row to be selected.; endRow - The index of last row to be selected.
Author:: QFS,mm
Since:: 2.1.0

Procedure: "selectAllRows"

Select all rows. It uses setSelectionInterval.

Parameters:: id - ID of the table.
Author:: QFS,mm
Since:: 2.1.0

Procedure: "selectRow"

Select a given row, specified by its index. It uses setSelectionInterval.

Parameters:: id - ID of the table.; row - The index of the row.
Author:: QFS,mm
Since:: 2.1.0

Procedure: "selectRowRange"

Select a range of rows, specified by their index. It uses setSelectionInterval.

Parameters:: id - ID of the table.; startRow - The index of first row to be selected.; endRow - The index of last row to be selected.
Author:: QFS,mm
Since:: 2.1.0

Package: "text"

Procedures to access text fields and text areas. (Swing components javax.swing.JTextField and javax.swing.JTextArea)

Author:: QFS,mm
Since:: 1.05.0

	Procedure/Dependency	Description
	clearArea	Clear a multi-line text area.
	clearField	Clear a simple text field.
	getText	Return the text of a given textfield.
	setText	Set a given text to a given text-field or text-area.
	setTextFromFile	Read the content of a given file and set its content to a given text-field.

Procedure: "clearArea"

Clear a multi-line text area.

Parameters:: client - The name of the SUT client.; id - The id of the text area.
Author:: QFS,mm
Since:: 1.05.0

Procedure: "clearField"

Clear a simple text field.

Parameters:: client - The name of the SUT client.; id - The id of the text field.
Author:: QFS,mm
Since:: 1.05.0

Procedure: "getText"

Return the text of a given textfield.

Parameters:: id - ID of the textfield.
Returns:: The text of the textfield. Variables in this string will not be automatically expanded.
Author:: QFS,mm
Since:: 3.5.0

Procedure: "setText"

Set a given text to a given text-field or text-area.

If the text is empty, no action will take place.

Parameters:: id - ID of the textfield.; text - Text to be set.; append - If this value is set to true, the text will be appended to the current values.; clear - If this value is set to true, the text-field will be cleared in case an empty string is given as parameter "text".; replaySingleEvents - If this value is set to true, the text will be inserted replaying single events.; newline - the separator sign for marking a linebreak within the text
Author:: QFS,mm
Since:: 2.1.0

Procedure: "setTextFromFile"

Read the content of a given file and set its content to a given text-field.

Parameters:: id - The id of the text-field to set.; file - The path to the file.; append - If this value is set to true, the text will be appended to the current values.; clear - If this value is set to true, the text-field will be cleared in case an empty string is given as parameter "text".; replaySingleEvents - If this value is set to true, the text will be inserted replaying single events.; newline - the separator sign for marking a linebreak within the text
Author:: QFS,mm
Since:: 3.1.1

Package: "tree"

Procedures to access trees. (Swing component javax.swing.JTree)

Author:: QFS,mm
Since:: 1.05.0

	Procedure/Dependency	Description
	callbackPrintNodeText	Example for a callback procedure used by expandNodes.
	clickNodeWithDetails	Select a given node.
	collapse	Collapse a tree node.
	collapseNode	Collapse a tree node.
	collapseNodes	Collapse a tree node recursively.
	collapseNodeWithCoordinates	Collapse a tree node.
	collapseWithCoordinates	Collapse a tree node.
	expand	Expand a tree node.
	expandNode	Expand a tree node.
	expandNodes	Expand a tree node recursively.
	expandNodesWithCoordinates	Expand a tree node recursively.
	expandNodeWithCoordinates	Expand a tree node.
	expandWithCoordinates	Expand a tree node.
	getChildNodeCount	Return the number of child nodes.
	getIndexOfNode	Return the current index of a given node.
	getRowCount	Return the number of visible nodes under a given tree or tree node.
	getValueOfNode	Return the text of a given node.
	selectNode	Select a given node.

Procedure: "callbackPrintNodeText"

Example for a callback procedure used by expandNodes.

Parameters:: treeId - The id of the tree.; node - The index of the node.
Author:: QFS
Since:: 3.0

Procedure: "clickNodeWithDetails"

Select a given node. You can specify the coordinates for clicking and all other details of that mouse click.

Parameters:: id - ID of the tree.; node - The node, e.g. '/Root/Price' or '/0/0'.; separator - Separator to use for the node syntax. Default is @ for text values, also available & for index and % for regexp.; x - The x coordinate for the click, default is empty to click in the middle.; y - The y coordinate for the click, default is empty to click in the middle.; clickCount - Number of clicks. Default is 1. For a double click set this to 2.; modifier - Modifier for mouse key. 4 for right mouse. 16 for left mouse.; hard - True, if hard event should be replayed. Default is false.; popupTrigger - True, if click should open a popup. Default is false
Author:: QFS,mm
Since:: 4.0

Procedure: "collapse"

Parameters:: client - The name of the SUT client.; node - The id of the tree node to collapse.
Author:: QFS,mm
Since:: 1.05.0

Procedure: "collapseNode"

Parameters:: client - The name of the SUT client.; id - The id of the tree.; node - The node, e.g. like '/Root/Price' or '/0/0'.; separator - Separator to use for the node syntax. Default is @ for text values, also available & for index and % for regexp.
Author:: QFS,mm
Since:: 3.0

Procedure: "collapseNodes"

Collapse a tree node recursively.

Parameters:: id - The id of the tree node.
Author:: QFS,mh
Since:: 3.4.11

Procedure: "collapseNodeWithCoordinates"

Parameters:: client - The name of the SUT client.; id - The id of the tree.; node - The node, e.g. like '/Root/Price' or '/0/0'.; separator - Separator to use for the node syntax. Default is @ for text values, also available & for index and % for regexp.; x - The x coordinate for the click, default is empty to click in the middle.; y - The y coordinate for the click, default is empty to click in the middle.
Author:: QFS,mm
Since:: 4.0

Procedure: "collapseWithCoordinates"

Parameters:: client - The name of the SUT client.; node - The id of the tree node to collapse.; x - The x coordinate for the click, default is empty to click in the middle.; y - The y coordinate for the click, default is empty to click in the middle.
Author:: QFS,mm
Since:: 4.0

Procedure: "expand"

Expand a tree node. It clicks on the tree node, replays a right key press event and selects the node again. If your tree doesn't support keyboard actions to expand a node, this procedure won't work.

Parameters:: client - The name of the SUT client.; node - The id of the tree node to expand.
Author:: QFS,mm
Since:: 1.05.0

Procedure: "expandNode"

Expand a tree node. It clicks on the tree node, replays a right key press event and selects the node again. If your tree doesn't support keyboard actions to expand a node, this procedure won't work.

Parameters:: client - The name of the SUT client.; id - The id of the tree.; node - The node, e.g. '/Root/Price' or '/0/0'.; separator - Separator to use for the node syntax. Default is @ for text values, also available & for index and % for regexp.
Author:: QFS,mm
Since:: 3.0

Procedure: "expandNodes"

Expand a tree node recursively.

Parameters:: id - The id of the tree node.; callbackProc - The name of a procedure to be called for every visited node.
Author:: QFS,mm
Since:: 3.0

Procedure: "expandNodesWithCoordinates"

Expand a tree node recursively. You can specify the coordinates for clicking.

Parameters:: id - The id of the tree node.; callbackProc - The name of a procedure to be called for every visited node.; x - The x coordinate for the click, default is empty to click in the middle.; y - The y coordinate for the click, default is empty to click in the middle.
Author:: QFS,mm
Since:: 4.0

Procedure: "expandNodeWithCoordinates"

Parameters:: client - The name of the SUT client.; id - The id of the tree.; node - The node, e.g. '/Root/Price' or '/0/0'.; separator - Separator to use for the node syntax. Default is @ for text values, also available & for index and % for regexp.; x - The x coordinate for the click, default is empty to click in the middle.; y - The y coordinate for the click, default is empty to click in the middle.
Author:: QFS,mm
Since:: 4.0

Procedure: "expandWithCoordinates"

Parameters:: client - The name of the SUT client.; node - The id of the tree node to expand.; x - The x coordinate for the click, default is empty to click in the middle.; y - The y coordinate for the click, default is empty to click in the middle.
Author:: QFS,mm
Since:: 4.0

Procedure: "getChildNodeCount"

Return the number of child nodes.

Parameters:: id - The component id of the tree.; node - The node. like '/Root/Price' or '/0/0'. If no node is specified, QF-Test will count the items of the root node.; nodeSeparator - Separator to use for the node syntax. Default is @ for text values, also available & for index and % for regexp.; countOnlyVisibleNodes - If true, only visible children will be taken into account. Otherwise also invisible children. If the node itself is invisible QF-Test tries to expand that node before performing the count operation.
Returns:: nodeCount
Author:: QFS,mm
Since:: 4.1

Procedure: "getIndexOfNode"

Return the current index of a given node.

Sample usage: Can be used to determine the numeric index of a node like '/Root/Price'.

Parameters:: id - ID of the tree.; node - The node. like '/Root/Price' or '/0/0'.; nodeSeparator - Separator to use for the node syntax. Default is @ for text values, also available & for index and % for regexp.; linear - If true, return the linear index, ignoring the tree structure, otherwise return a hierarchical index like /0/1.
Returns:: index The current index of the node, which has been read by the 'Fetch Index' node of QF-Test.
Author:: QFS,mm
Since:: 3.1.1

Procedure: "getRowCount"

Return the number of visible nodes under a given tree or tree node. If no node is specified, you will get the visible nodes or all loaded nodes of the entire tree.

Parameters:: id - The component id of the tree.; node - The node. like '/Root/Price' or '/0/0'. If no node is specified, QF-Test will count the nodes of the root node.; nodeSeparator - Separator to use for the node syntax. Default is @ for text values, also available & for index and % for regexp.; countOnlyVisibleNodes - If true, only visible children will be taken into account. Otherwise also invisible children. If the node itself is invisible QF-Test tries to expand that node before performing the count operation.
Returns:: rowCount
Author:: QFS,mm
Since:: 3.1.1

Procedure: "getValueOfNode"

Return the text of a given node.

Sample usage: Determine the text value for a node referenced by index like /0/1.

Parameters:: id - ID of the tree.; node - The node. It should be something like '/Root/Price' or '/0/0'.; nodeSeparator - Separator to use for the node syntax. Default is & for index values, also available @ for text and % for regexp.
Returns:: name The value of the node.
Author:: QFS
Since:: 5.0

Procedure: "selectNode"

Select a given node.

Parameters:: id - ID of the tree.; node - The node, e.g. '/Root/Price' or '/0/0'.; separator - Separator to use for the node syntax. Default is @ for text values, also available & for index and % for regexp.
Author:: QFS,mm
Since:: 2.1.0

Package: "checks"

Procedures for checking a tree.

Author:: QFS,mm
Since:: 3.1.1

	Procedure/Dependency	Description
	checkNumberOfChildNodes	Check the number of child nodes of a given tree node according to a specified comparison mode.
	checkNumberOfRows	Check the number of visible nodes under a given tree or tree node according to a specified comparison mode.

Procedure: "checkNumberOfChildNodes"

Check the number of child nodes of a given tree node according to a specified comparison mode.

Sample usage: You can check, that a tree has exactly 6 visible rows or that the tree has less then 10 visible rows.

Parameters:: id - The id of the tree.; node - The node. like '/Root/Price' or '/0/0'. Leave empty, if you want to count rows of whole tree.; nodeSeparator - Separator to use for the node syntax. Default is @ for text values, also available & for index and % for regexp.; countOnlyVisibleNodes - If true, only visible children will be taken into account. Otherwise also invisible children. If the node itself is invisible QF-Test tries to expand that node before performing the count operation.; compareValue - The comparison value.; compareMode - The comparison mode = or ==, if the compareValue should be equal than the actual amount of rows. <, if the compareValue should be greater than the actual amount of rows. >, if the compareValue should be less than the actual amount of rows. <=, if the compareValue should be greater or equal than the actual amount of rows. >=, if the compareValue should be less or equal the actual amount of rows. !=, if the compareValue should be not equal the actual amount of items.; errorLevel - The kind of error, which should be logged. Either EXCEPTION, ERROR, WARNING or MESSAGE.; appearInReport - Flag, whether to show check in report, if a message or warning are set as errorLevel. If this is set to 1, the check will be shown in the report.
Exceptions:: UserException, - if wrong comparison mode has been set.
Author:: QFS,mm
Since:: 4.1

Procedure: "checkNumberOfRows"

Check the number of visible nodes under a given tree or tree node according to a specified comparison mode. If no node is specified, you will get the visible nodes or all loaded nodes.

Sample usage: You can check, that a tree has exactly 6 visible rows or that the tree has less then 10 visible rows.

Parameters:: id - The id of the tree.; node - The node. like '/Root/Price' or '/0/0'. Leave empty, if you want to count rows of whole tree.; nodeSeparator - Separator to use for the node syntax. Default is @ for text values, also available & for index and % for regexp.; countOnlyVisibleNodes - If true, only visible children will be taken into account. Otherwise also invisible children. If the node itself is invisible QF-Test tries to expand that node before performing the count operation.; compareValue - The comparison value.; compareMode - The comparison mode = or ==, if the compareValue should be equal than the actual amount of rows. <, if the compareValue should be greater than the actual amount of rows. >, if the compareValue should be less than the actual amount of rows. <=, if the compareValue should be greater or equal than the actual amount of rows. >=, if the compareValue should be less or equal the actual amount of rows. !=, if the compareValue should be not equal the actual amount of items.; errorLevel - The kind of error, which should be logged. Either EXCEPTION, ERROR, WARNING or MESSAGE.; appearInReport - Flag, whether to show check in report, if a message or warning are set as errorLevel. If this is set to 1, the check will be shown in the report.
Exceptions:: UserException, - if wrong comparison mode has been set.
Author:: QFS,mm
Since:: 3.1.1

Package: "swt"

Procedures for advanced manipulation of SWT components.

Author:: QFS,mm
Since:: 2.0.3

Package: "checkbox"

Procedures to set the state of checkboxes. (SWT component org.eclipse.swt.widgets.Button)

Author:: QFS,mm
Since:: 2.1.0

	Procedure/Dependency	Description
	deselect	Deselect a checkbox.
	deselectWithCoordinates	Deselect a checkbox.
	getValue	Return the value of a checkbox.
	select	Select a checkbox.
	selectWithCoordinates	Select a checkbox.
	set	Set checkbox to the given state.
	setWithCoordinates	Set checkbox to the given state.

Procedure: "deselect"

Deselect a checkbox. If the checkbox is already deselected, no action is performed.

Parameters:: client - The name of the SUT client.; id - The id of the checkbox.
Author:: QFS,mm
Since:: 2.1.0

Procedure: "deselectWithCoordinates"

Deselect a checkbox. If the checkbox is already deselected, no action is performed. You can specify the coordinates for clicking.

Parameters:: client - The name of the SUT client.; id - The id of the checkbox.; x - The x coordinate for the click, default is empty to click in the middle.; y - The y coordinate for the click, default is empty to click in the middle.
Author:: QFS,mm
Since:: 4.0

Procedure: "getValue"

Return the value of a checkbox. It's either 1, if box is selected or 0, if box is not selected.

Parameters:: id - ID of the checkbox.
Returns:: The state of the checkbox.
Author:: QFS,mm
Since:: 3.5.0

Procedure: "select"

Select a checkbox. If the checkbox is already selected, no action is performed.

Parameters:: client - The name of the SUT client.; id - The id of the checkbox.
Author:: QFS,mm
Since:: 2.1.0

Procedure: "selectWithCoordinates"

Select a checkbox. If the checkbox is already selected, no action is performed. You can specify the coordinates for clicking.

Parameters:: client - The name of the SUT client.; id - The id of the checkbox.; x - The x coordinate for the click, default is empty to click in the middle.; y - The y coordinate for the click, default is empty to click in the middle.
Author:: QFS,mm
Since:: 4.0

Procedure: "set"

Set checkbox to the given state.

Parameters:: client - The name of the SUT client.; id - The id of the checkbox.; check - The check value to be set (either true or false).
Author:: QFS,mm
Since:: 2.1.0

Procedure: "setWithCoordinates"

Set checkbox to the given state. You can specify the coordinates for clicking.

Parameters:: client - The name of the SUT client.; id - The id of the checkbox.; check - The check value to be set (either true or false).; x - The x coordinate for the click, default is empty to click in the middle.; y - The y coordinate for the click, default is empty to click in the middle.
Author:: QFS,mm
Since:: 4.0

Package: "cleanup"

Author:: QFS,mm
Since:: 2.1.0

	Procedure/Dependency	Description
	closeAllDialogsAndModalShells	Close all modal dialogs.
	closeAllMenus	Close all menus unconditionally.
	implicitExceptionHandler	This procedure encompasses the usage of other cleanup procedures in this package and is the recommended operation to perform after an exception occurs and is implicitly caught.

Procedure: "closeAllDialogsAndModalShells"

Close all modal dialogs. A modal dialog that is left open will cause events for the SUT to be blocked. Ensuring that modal dialogs are closed is a good operation to conduct in a setup/cleanup sequence. Closing all instances of org.eclipse.swt.widgets.Dialog and all modal instances of org.eclipse.swt.widgets.Shell.

Parameters:: client - The name of the SUT client.; maxDialogs - Maximum number of modal dialogs that are tried to be closed. (Optional, default 5)
Author:: QFS,mm
Since:: 2.1.0

Procedure: "closeAllMenus"

Close all menus unconditionally. A menu left open (or even just selected) will cause events for the SUT to be blocked. This procedure is recommended for cleanup after an exception occurs.

Parameters:: client - The name of the SUT client.
Author:: QFS,mm
Since:: 2.1.0

Procedure: "implicitExceptionHandler"

This procedure encompasses the usage of other cleanup procedures in this package and is the recommended operation to perform after an exception occurs and is implicitly caught.

Calling this procedure should be the first step in the cleanup sequence of any Test node with the "Implicitly catch exceptions" attribute set.

Parameters:: client - The name of the SUT client.; maxDialogs - Maximum number of modal dialogs that are tried to be closed. (Optional, default 5)
Author:: QFS,mm
Since:: 2.1.0

Package: "colordialog"

Procedures to handle Colordialogs. (SWT component org.eclipse.swt.widgets.ColorDialog)

Author:: QFS,mm
Since:: 3.0

	Procedure/Dependency	Description
	selectColor	Select a specified color of a ColorDialog.

Procedure: "selectColor"

Select a specified color of a ColorDialog.

The color should be in RGB values, e.g. #FF0000 for red. If no color is specified, it will close the dialog without selection.

Parameters:: client - The name of the SUT client.; id - ID of the ColorDialog.; color - Color to be selected.
Author:: QFS,mm
Since:: 3.0

Package: "combo"

Procedures to handle comboboxes. (SWT component org.eclipse.swt.widgets.Combo)

Author:: QFS,mm
Since:: 2.1.0

	Procedure/Dependency	Description
	getIndexOfItem	Return the current index of a given item.
	getItemCount	Return the number of items of a given combobox.
	getValue	Return the text of a given combo.
	getValueOfItem	Return the text of a given item.
	setValue	Select specified value of a given combobox using a selection event.
	setValueViaSUTScript	Select specified value of a given combobox using a SUT script.

Procedure: "getIndexOfItem"

Return the current index of a given item.

Sample usage: Can be used to determine the numeric index of an item like 'Price'.

Parameters:: id - ID of the combo.; item - The item.; itemSeparator - Separator to use for the item syntax. Default is @ for text values, also available & for index and % for regexp.
Returns:: index The current index of the item, which has been read by the 'Fetch Index' node of QF-Test.
Author:: QFS,mm
Since:: 3.5.0

Procedure: "getItemCount"

Return the number of items of a given combobox. It uses the method getItemCount() to get the number.

Parameters:: id - The component ID of the combobox.
Returns:: itemCount
Author:: QFS,mm
Since:: 3.0

Procedure: "getValue"

Return the text of a given combo.

Parameters:: id - ID of the combo.
Returns:: The text of the combo.
Author:: QFS,mm
Since:: 3.5.0

Procedure: "getValueOfItem"

Return the text of a given item.

Sample usage: Determine the text of the second item.

Parameters:: id - ID of the combo.; item - The item.; itemSeparator - Separator to use for the item syntax. Default is @ for text values, also available & for index and % for regexp.
Returns:: value The value of the item.
Author:: QFS,mm
Since:: 3.5.0

Procedure: "setValue"

Select specified value of a given combobox using a selection event.

If the given value is empty, no action will take place.

You should use this procedure for any standard selections.

Parameters:: client - The name of the SUT client.; id - ID of the Combo.; value - Value, which should be selected.; separator - Separator to use for the list syntax. Default is @ for text values, also available & for index and % for regexp.
Author:: QFS,mm
Since:: 2.1.0

Procedure: "setValueViaSUTScript"

Select specified value of a given combobox using a SUT script. It used the API-method select().

If the given value is empty, no action will take place.

You should use this procedure only if setValue doesn't work for your use-case.

Parameters:: client - The name of the SUT client.; id - ID of the Combo.; value - Value, which should be selected.
Author:: QFS,mm
Since:: 2.1.0

Package: "ctabfolder"

Procedures for SWT CTabFolder widgets. (SWT component org.eclipse.swt.custom.CTabFolder)

Author:: QFS,mm
Since:: 2.0.3

	Procedure/Dependency	Description
	checkTabIsDirty	This procedure raises an error, if a given tab is not dirty.
	closeTab	Close a tab in a generic CTabFolder that is identified only by the fact that it contains the desired tab.
	openViewMenu	Open the View Menu for a generic CTabFolder that is identified only by the fact that it contains the desired tab.
	selectTab	Select a tab in a generic CTabFolder that is identified only by the fact that it contains the desired tab.

Procedure: "checkTabIsDirty"

This procedure raises an error, if a given tab is not dirty. This procedure checks for the standard dirty marker, i.e. a * at the beginning of the tab name.

Parameters:: client - The name of the SUT client.; tabname - The name of the tab to select.; separator - @ for addressing the tab name by text, % for addressing the tab by regular expression. Note: & is not supported by this procedure.; expectedDirty - True, if marker is expected. False if marker is not expected.; throwExc - Whether the check should throw an exception on failure.; reportName - The Name for the check in the report.
Author:: QFS,mm
Since:: 3.4.2

Procedure: "closeTab"

Close a tab in a generic CTabFolder that is identified only by the fact that it contains the desired tab. Even the target window is arbitrary.

Parameters:: client - The name of the SUT client.; tabname - The name of the tab to close.; separator - @ for addressing the tab name by text, % for addressing the tab by regular expression. Note: & is not supported by this procedure.
Author:: QFS,mm
Since:: 2.0.3

Procedure: "openViewMenu"

Open the View Menu for a generic CTabFolder that is identified only by the fact that it contains the desired tab. Even the target window is arbitrary.

Parameters:: client - The name of the SUT client.; tabname - The name of the tab to which the View Menu belongs.; separator - @ for addressing the tab name by text, % for addressing the tab by regular expression. Note: & is not supported by this procedure.
Author:: QFS,gs
Since:: 3.4.7

Procedure: "selectTab"

Select a tab in a generic CTabFolder that is identified only by the fact that it contains the desired tab. Even the target window is arbitrary.

Parameters:: client - The name of the SUT client.; tabname - The name of the tab to select.; separator - @ for addressing the tab name by text, % for addressing the tab by regular expression. Note: & is not supported by this procedure.
Author:: QFS,mm
Since:: 2.0.3

Package: "directorydialog"

Procedures for accessing directory dialogs. (SWT component org.eclipse.swt.widgets.DirectoryDialog)

Author:: QFS,mm
Since:: 2.1.0

	Procedure/Dependency	Description
	selectDirectory	Select a directory in a `DirectoryDialog` dialog.

Procedure: "selectDirectory"

Select a directory in a DirectoryDialog dialog.

The Directorydialog must already be open (or at least be triggered to open).

Parameters:: client - The name of the SUT client.; directory - The directory to select (relative or absolute to the directorydialog's current directory).
Author:: QFS,mm
Since:: 2.1.0

Package: "filedialog"

Procedures for accessing file dialogs. (SWT component org.eclipse.swt.widgets.FileDialog)

Author:: QFS,mm
Since:: 2.1.0

	Procedure/Dependency	Description
	selectFile	Select a file in a `FileDialog` dialog.

Procedure: "selectFile"

Select a file in a FileDialog dialog.

The filechooser dialog must already be open (or at least be triggered to open).

Parameters:: client - The name of the SUT client.; file - The file to select (relative or absolute to the filechooser's current directory).
Author:: QFS,mm
Since:: 2.1.0

Package: "general"

Procedures which work for any SWT component.

Author:: QFS,mm
Since:: 2.1.0

	Procedure/Dependency	Description
	clickAtComponent	Click on a given component, but only if the according parameter is set to true.
	clickAtComponentWithDetails	Click on a given component, but only if the according parameter is set to true.
	deleteOverrideComponent	Delete the current association of PrioritySwtComponent.
	doClick	Click on a given component.
	doClickWithDetails	Click on a given component.
	doSelect	Send a selection event to a given component.
	setLocation	Set the location of a given component.
	setOverrideComponent	Set a given component to the PrioritySwtWidget.
	setSize	Set the width and the height of a given component.
	waitForComponent	Wait for a given component.
	waitForComponentForAbsence	Wait till a given component disappears.

Procedure: "clickAtComponent"

Click on a given component, but only if the according parameter is set to true.

Parameters:: client - The name of the SUT client.; id - The Id of the target component.; click - If this is set to true, the click will be performed, otherwise nothing happens.; x - The x coordinate for the click, default is empty to click in the middle.; y - The y coordinate for the click, default is empty to click in the middle.; clickCount - Number of clicks. Default is 1. For a double click set this to 2.; modifier - Modifier for mouse key. 4 for right mouse. 16 for left mouse.; hard - True, if hard event should be replayed. Default is false.; popupTrigger - True, if click should open a popup. Default is false.
Author:: QFS,mm
Since:: 3.0

Procedure: "clickAtComponentWithDetails"

Click on a given component, but only if the according parameter is set to true. You can specify the coordinates for clicking and all other details of that mouse click.

Parameters:: client - The name of the SUT client.; id - The Id of the target component.; click - If this is set to true, the click will be performed, otherwise nothing happens.; x - The x coordinate for the click, default is empty to click in the middle.; y - The y coordinate for the click, default is empty to click in the middle.; clickCount - Number of clicks. Default is 1. For a double click set this to 2.; modifier - Modifier for mouse key. 4 for right mouse. 16 for left mouse.; hard - True, if hard event should be replayed. Default is false.; popupTrigger - True, if click should open a popup. Default is false.
Author:: QFS,mm
Since:: 4.0

Procedure: "deleteOverrideComponent"

Delete the current association of PrioritySwtComponent.

Parameters:: client - The name of the SUT client.
Author:: QFS,mm
Since:: 3.3.0

Procedure: "doClick"

Click on a given component.

Parameters:: client - The name of the SUT client.; id - The Id of the target component.
Author:: QFS,mm
Since:: 2.1.0

Procedure: "doClickWithDetails"

Click on a given component. You can specify the coordinates for clicking and all other details of that mouse click.

Parameters:: client - The name of the SUT client.; id - The Id of the target component.; x - The x coordinate for the click, default is empty to click in the middle.; y - The y coordinate for the click, default is empty to click in the middle.; clickCount - Number of clicks. Default is 1. For a double click set this to 2.; modifier - Modifier for mouse key. 4 for right mouse. 16 for left mouse.; hard - True, if hard event should be replayed. Default is false.; popupTrigger - True, if click should open a popup. Default is false.
Author:: QFS,mm
Since:: 4.0

Procedure: "doSelect"

Send a selection event to a given component. That's not a mouse click. Selection events are special events for menus or list selection.

Parameters:: client - The name of the SUT client.; id - The Id of the target component.; detail - The detail of the selection. Important for closing dialogs etc. For menu items leave it blank.
Author:: QFS,mm
Since:: 3.5.0

Procedure: "setLocation"

Set the location of a given component.

It uses setLocation(x,y) to set the location.

Parameters:: client - The name of the SUT client.; id - The Id of the target component.; x - The new x-coordinate of the location.; y - The new y-coordinate of the location.
Author:: QFS,mm
Since:: 2.1.0

Procedure: "setOverrideComponent"

Set a given component to the PrioritySwtWidget.

Parameters:: client - The name of the SUT client.; id - The Id of the target component.
Author:: QFS,mm
Since:: 3.3.0

Procedure: "setSize"

Set the width and the height of a given component.

It uses setSize(width, height) to set the size.

Parameters:: client - The name of the SUT client.; id - The Id of the target component.; width - The new width of the component.; height - The new height of the component.
Author:: QFS,mm
Since:: 2.1.0

Procedure: "waitForComponent"

Wait for a given component.

Parameters:: client - The name of the SUT client.; id - The Id of the target component.; timeout - The timeout to wait for that component; throwExc - True, whether procedure should throw an exception if component didn't appear.
Author:: QFS,mm
Since:: 4.0

Procedure: "waitForComponentForAbsence"

Wait till a given component disappears.

Parameters:: client - The name of the SUT client.; id - The Id of the target component.; timeout - The timeout to wait for that component; throwExc - True, whether procedure should throw an exception if component didn't disappear.
Author:: QFS,mm
Since:: 4.0

Package: "instrument"

Procedures for SWT instrumentation.

Author:: QFS
Since:: 2.0.3

	Procedure/Dependency	Description
	setup	If necessary, instrument an Eclipse/RCP based or standalone SWT application for use with QF-Test.

Procedure: "setup"

If necessary, instrument an Eclipse/RCP based or standalone SWT application for use with QF-Test. If the option Replay->Clients->Connect without SWT instrumentation is active and the SWT version is new enough, instumentation is not performed unless the parameter forceInstrumentation is set to true. Manual chapter 4 describes the effects of SWT instrumentation in detail.

Parameters:: sutdir - The installation directory of the SUT.; plugin - Optional: The specific plugin (the jar file, not the plugin folder) to instrument. Useful in case the directories are not layed out as expected.; forceInstrumentation - Whether to force instrumentation even if not required.
Author:: QFS,kk,gs

Package: "list"

Procedures for accessing lists. (SWT component org.eclipse.swt.widgets.List)

Author:: QFS,mm
Since:: 3.0

	Procedure/Dependency	Description
	clickItemWithDetails	Select a given item by a mouse click on it.
	getIndexOfItem	Return the current index of a given item.
	getItemCount	Return the number of items of a given list.
	getValueOfItem	Return the text of a given item.
	selectItem	Select a given item by a mouse click on it.

Procedure: "clickItemWithDetails"

Select a given item by a mouse click on it. You can specify the coordinates for clicking and all other details of that mouse click.

Parameters:: id - ID of the list.; item - The item.; itemSeparator - Separator to use for the item syntax. Default is @ for text values, also available & for index and % for regexp.; x - The x coordinate for the click, default is empty to click in the middle.; y - The y coordinate for the click, default is empty to click in the middle.; clickCount - Number of clicks. Default is 1. For a double click set this to 2.; modifier - Modifier for mouse key. 4 for right mouse. 16 for left mouse.; hard - True, if hard event should be replayed. Default is false.; popupTrigger - True, if click should open a popup. Default is false.
Author:: QFS,mm
Since:: 4.0

Procedure: "getIndexOfItem"

Return the current index of a given item.

Sample usage: Can be used to determine the numeric index of an item like 'Price'.

Parameters:: id - ID of the list.; item - The item.; itemSeparator - Separator to use for the item syntax. Default is @ for text values, also available & for index and % for regexp.
Returns:: index The current index of the item, which has been read by the 'Fetch Index' node of QF-Test.
Author:: QFS,mm
Since:: 3.5.0

Procedure: "getItemCount"

Return the number of items of a given list. It uses the method list.getItemCount() to get the number.

Parameters:: id - The component ID of the list.
Returns:: itemCount
Author:: QFS,mm
Since:: 3.0

Procedure: "getValueOfItem"

Return the text of a given item.

Sample usage: Determine the text of the second item.

Parameters:: id - ID of the list.; item - The item.; itemSeparator - Separator to use for the item syntax. Default is @ for text values, also available & for index and % for regexp.
Returns:: value The value of the item.
Author:: QFS,mm
Since:: 3.1.1

Procedure: "selectItem"

Select a given item by a mouse click on it.

Parameters:: id - ID of the list.; item - The item.; itemSeparator - Separator to use for the item syntax. Default is @ for text values, also available & for index and % for regexp.
Author:: QFS,mm
Since:: 3.1.1

Package: "checks"

Procedures for checking a list.

Author:: QFS,mm
Since:: 3.1.1

	Procedure/Dependency	Description
	checkNumberOfItems	Check the number of items of a given list according to a specified comparison mode.

Procedure: "checkNumberOfItems"

Check the number of items of a given list according to a specified comparison mode.

It uses the method list.getItemCount() to get the number.

Sample usage: You can check, that a list has exactly 6 items or that the table has less then 10 items.

Parameters:: id - The id of the list.; compareValue - The comparison value.; compareMode - The comparison mode = or ==, if the compareValue should be equal than the actual amount of items. <, if the compareValue should be greater than the actual amount of items. >, if the compareValue should be less than the actual amount of items. <=, if the compareValue should be greater or equal than the actual amount of items. >=, if the compareValue should be less or equal the actual amount of items. !=, if the compareValue should be not equal the actual amount of items.; errorLevel - The kind of error, which should be logged. Either EXCEPTION, ERROR, WARNING or MESSAGE.; appearInReport - Flag, whether to show check in report, if a message or warning are set as errorLevel. If this is set to 1, the check will be shown in the report.
Exceptions:: UserException, - if wrong comparison mode has been set.
Author:: QFS,mm
Since:: 3.1.1

Package: "selection"

Procedures to (de-)select certain items of a list.

Author:: QFS,mm
Since:: 3.1.1

	Procedure/Dependency	Description
	deselectAllItems	Deselect all items.
	deselectItem	Deselect a given item, specified by its index.
	deselectItemRange	Deselect a range of items, specified by their index.
	selectAllItems	Select all items.
	selectItem	Select a given item, specified by its index.
	selectItemRange	Select a range of items, specified by their index.

Procedure: "deselectAllItems"

Deselect all items. It uses deselectAll.

Parameters:: id - ID of the list.
Author:: QFS,mm
Since:: 3.1.1

Procedure: "deselectItem"

Deselect a given item, specified by its index. It uses deselect.

Parameters:: id - ID of the list.; item - The index of the item.
Author:: QFS,mm
Since:: 3.1.1

Procedure: "deselectItemRange"

Deselect a range of items, specified by their index. It uses deselect.

Parameters:: id - ID of the list.; startItem - The index of first item to be selected.; endItem - The index of last item to be selected.
Author:: QFS,mm
Since:: 3.1.1

Procedure: "selectAllItems"

Select all items. It uses selectAll.

Parameters:: id - ID of the list.
Author:: QFS,mm
Since:: 3.1.1

Procedure: "selectItem"

Select a given item, specified by its index. It uses select.

Parameters:: id - ID of the list.; row - The index of the item.
Author:: QFS,mm
Since:: 3.1.1

Procedure: "selectItemRange"

Select a range of items, specified by their index. It uses select.

Parameters:: id - ID of the list.; startItem - The index of first item to be selected.; endItem - The index of last item to be selected.
Author:: QFS,mm
Since:: 3.1.1

Package: "menu"

Procedures to select menu items and checkbox menu items. (SWT components org.eclipse.swt.widgets.MenuItem from org.eclipse.swt.widgets.Menu)

Author:: QFS,mm
Since:: 2.1.0

	Procedure/Dependency	Description
	selectCheckMenuItemInHierarchy	Select a checkbox menu item from a menu.
	selectItem	Select an item from a menu.
	selectMenuItemInHierarchy	Select an item from a menu.
	selectSubItem	Select an item within a submenu.
	setCheckItem	Select a checkbox menu item.
	setSubCheckItem	Select a checkbox menu item within within a submenu.

Procedure: "selectCheckMenuItemInHierarchy"

Parameters:: client - The name of the SUT client.; menu - The path of the parent menus. The path is specified as list of component ids.; menustringSeparator - The value, which separates the path of the parent menu.; checkItem - The id of the checkbox item.; checkItemValue - The check item value to be set - 'true' to select the checkbox item (default), 'false' to deselect.
Author:: QFS,mm
Since:: 3.5

Procedure: "selectItem"

Select an item from a menu.

For example: for the File -> Open action, the component ID of "File" is the menu, and the ID for "Open" is the item.

Parameters:: client - The name of the SUT client.; menu - The id of the menu.; item - The id of menu item.
Author:: QFS,mm
Since:: 2.1.0

Procedure: "selectMenuItemInHierarchy"

Parameters:: client - The name of the SUT client.; menu - The path of the parent menus. The path is specified as list of component ids.; item - The id of menu item.; menustringSeparator - The value, which separates the path of the parent menu.
Author:: QFS,mm
Since:: 3.5

Procedure: "selectSubItem"

Select an item within a submenu.

For example: for the View -> Terminal -> Show action, the component ID of "View" is the menu, the ID for "Terminal" is the item, and the ID for "Show" is the subitem to select.

Parameters:: client - The name of the SUT client.; menu - The id of the menu.; item - The id of the item to open the submenu.; subItem - The id of item in submenu.
Author:: QFS,mm
Since:: 2.1.0

Procedure: "setCheckItem"

Select a checkbox menu item.

For example: for the View -> Show Details action, the component ID of "View" is the menu, and the ID for "Show Details" is the checkbox item to set (to true or false).

Parameters:: client - The name of the SUT client.; menu - The id of the menu.; checkItem - The id of the checkbox item.; checkItemValue - The check item value to be set - 'true' to select the checkbox item (default), 'false' to deselect.
Author:: QFS,mm
Since:: 2.1.0

Procedure: "setSubCheckItem"

Select a checkbox menu item within within a submenu.

Parameters:: client - The name of the SUT client.; menu - The id of the menu.; item - The id of the item to open the submenu.; subCheckItem - The id of the checkbox item in the submenu.; checkItemValue - The checkbox item value to be set - "true" to select the checkbox item (default), "false" to deselect.
Author:: QFS,mm
Since:: 2.1.0

Package: "popupmenu"

Procedures to select items and checkbox menu items from popup menus.

Note that for all procedures, the popup menu must first be opened by the calling test suite, as the popup menu is component-dependent.

See package "menu" for more details about menus and submenus. (SWT components org.eclipse.swt.widgets.MenuItem from org.eclipse.swt.widgets.Menu)

Author:: QFS,mm
Since:: 2.1.0

	Procedure/Dependency	Description
	selectItem	Select an item in a popup menu.
	selectSubItem	Select an item within a submenu of a popup menu.
	setCheckItem	Select a checkbox menu item in a popup menu.
	setSubCheckItem	Select a checkbox menu item within a submenu of a popup menu.

Procedure: "selectItem"

Select an item in a popup menu.

Parameters:: client - The name of the SUT client.; item - The id of menu item.
Author:: QFS,mm
Since:: 2.1.0

Procedure: "selectSubItem"

Select an item within a submenu of a popup menu.

Parameters:: client - The name of the SUT client.; item - The id of the item to open the submenu.; subItem - The id of item in submenu.
Author:: QFS,mm
Since:: 2.1.0

Procedure: "setCheckItem"

Select a checkbox menu item in a popup menu.

Parameters:: client - The name of the SUT client.; checkItem - The id of the menu checkbox item.; checkItemValue - The checkbox item value to be set - "true" to select the checkbox item (default), "false" to deselect.
Author:: QFS,mm
Since:: 2.1.0

Procedure: "setSubCheckItem"

Select a checkbox menu item within a submenu of a popup menu.

Parameters:: client - The name of the SUT client.; item - The id of item to open the submenu.; subCheckItem - The id of the checkbox item in the submenu.; checkItemValue - The checkbox item value to be set - "true" to select the checkbox item (default), "false" to deselect.
Author:: QFS,mm
Since:: 2.1.0

Package: "radiobutton"

Procedures to set the state of buttons with the style SWT.RADIO. (SWT component org.eclipse.swt.widgets.Button)

Author:: QFS,mm
Since:: 3.5.0

	Procedure/Dependency	Description
	getValue	Return the value of a radio button.
	select	Select a radio button.
	selectWithCoordinates	Select a radio button.

Procedure: "getValue"

Return the value of a radio button. It's either 1, if radio button is selected of 0, if radio button is not selected.

Parameters:: id - ID of the radio button.
Returns:: The state of the checkbox.
Author:: QFS,mm
Since:: 3.5.0

Procedure: "select"

Select a radio button. If the radio button is already selected, no action is performed.

Parameters:: id - The id of the radio button.
Author:: QFS,mm
Since:: 3.5.0

Procedure: "selectWithCoordinates"

Select a radio button. If the radio button is already selected, no action is performed. You can specify the coordinates for clicking.

Parameters:: id - The id of the radio button.; x - The x coordinate for the click, default is empty to click in the middle.; y - The y coordinate for the click, default is empty to click in the middle.
Author:: QFS,mm
Since:: 4.0

Package: "sash"

Procedures to work with sash components. (SWT component org.eclipse.swt.widgets.Sash)

Author:: QFS,mm
Since:: 2.1.1

	Procedure/Dependency	Description
	moveSash	Move a sash by a given distance.
	moveSashTo	Move a sash to a given position.

Procedure: "moveSash"

Move a sash by a given distance.

Parameters:: id - The component ID of the sash.; distance - The number of pixels to move the sash.
Author:: QFS,mm
Since:: 2.1.1

Procedure: "moveSashTo"

Move a sash to a given position.

Parameters:: id - The component ID of the sash.; target - The target position for the sash.
Author:: QFS,mm
Since:: 2.1.1

Package: "scrollbar"

Procedures to work with scrollbar components.

Author:: QFS
Since:: 3.0

	Procedure/Dependency	Description
	pageDown	Scroll a component one page downwards by simulating a hard mouse click below the scrollbar's thumb.
	pageLeft	Scroll a component one page to the left by simulating a hard mouse click to the left of the scrollbar's thumb.
	pageRight	Scroll a component one page to the right by simulating a hard mouse click to the right of the scrollbar's thumb.
	pageUp	Scroll a component one page upwards by simulating a hard mouse click above the scrollbar's thumb.
	scrollDown	Scroll a component downwards by simulating a hard mouse click on the down arrow button of its vertical scrollbar.
	scrollLeft	Scroll a component to the left by simulating a hard mouse click on the left arrow button of its horizontal scrollbar.
	scrollRight	Scroll a component to the right by simulating a hard mouse click on the right arrow button of its horizontal scrollbar.
	scrollUp	Scroll a component upwards by simulating a hard mouse click on the up arrow button of its vertical scrollbar.

Procedure: "pageDown"

Scroll a component one page downwards by simulating a hard mouse click below the scrollbar's thumb.

Parameters:: id - The id of the component to scroll.
Exceptions:: UserException - If no horizontal scrollbar is visible.
Author:: QFS,kk
Since:: 3.0

Procedure: "pageLeft"

Scroll a component one page to the left by simulating a hard mouse click to the left of the scrollbar's thumb.

Parameters:: id - The id of the component to scroll.
Exceptions:: UserException - If no horizontal scrollbar is visible.
Author:: QFS,kk
Since:: 3.0

Procedure: "pageRight"

Scroll a component one page to the right by simulating a hard mouse click to the right of the scrollbar's thumb.

Parameters:: id - The id of the component to scroll.
Exceptions:: UserException - If no horizontal scrollbar is visible.
Author:: QFS,kk
Since:: 3.0

Procedure: "pageUp"

Scroll a component one page upwards by simulating a hard mouse click above the scrollbar's thumb.

Parameters:: id - The id of the component to scroll.
Exceptions:: UserException - If no horizontal scrollbar is visible.
Author:: QFS,kk
Since:: 3.0

Procedure: "scrollDown"

Scroll a component downwards by simulating a hard mouse click on the down arrow button of its vertical scrollbar.

Parameters:: id - The id of the component to scroll.
Exceptions:: UserException - If no horizontal scrollbar is visible.
Author:: QFS,kk
Since:: 3.0

Procedure: "scrollLeft"

Scroll a component to the left by simulating a hard mouse click on the left arrow button of its horizontal scrollbar.

Parameters:: id - The id of the component to scroll.
Exceptions:: UserException - If no horizontal scrollbar is visible.
Author:: QFS,kk
Since:: 3.0

Procedure: "scrollRight"

Scroll a component to the right by simulating a hard mouse click on the right arrow button of its horizontal scrollbar.

Parameters:: id - The id of the component to scroll.
Exceptions:: UserException - If no horizontal scrollbar is visible.
Author:: QFS,kk
Since:: 3.0

Procedure: "scrollUp"

Scroll a component upwards by simulating a hard mouse click on the up arrow button of its vertical scrollbar.

Parameters:: id - The id of the component to scroll.
Exceptions:: UserException - If no horizontal scrollbar is visible.
Author:: QFS,kk
Since:: 3.0

Package: "tabfolder"

Procedures for SWT TabFolder widgets. (SWT component org.eclipse.swt.widgets.TabFolder)

Author:: QFS,mm
Since:: 2.2.0

	Procedure/Dependency	Description
	closeTab	Close a tab via sending a "close" selection event.
	getIndexOfTab	Return the index of a given tab.
	getItemCount	Return the number of items of a given tabfolder.
	getValueOfTab	Return the text of a given tab.
	selectTab	Select a tab in a given Tabfolder.

Procedure: "closeTab"

Close a tab via sending a "close" selection event.

Parameters:: client - The name of the SUT client.; id - The component ID of the tabfolder to select.; separator - Separator to use for the tab syntax. Default is @ for text values, also available & for index and % for regexp.; value - The value to select.
Author:: QFS,mm
Since:: 2.2.0

Procedure: "getIndexOfTab"

Return the index of a given tab.

Parameters:: client - The name of the SUT client.; id - The component ID of the tabfolder.; separator - Separator to use for the tab syntax. Default is @ for text values, also available & for index and % for regexp.; value - The value to look for.
Returns:: The index of the tab.
Author:: QFS,mm
Since:: 3.5.0

Procedure: "getItemCount"

Return the number of items of a given tabfolder.

Parameters:: id - The component ID of the tabfolder.
Returns:: itemCount
Author:: QFS
Since:: 5.3.1

Procedure: "getValueOfTab"

Return the text of a given tab.

Parameters:: client - The name of the SUT client.; id - The component ID of the tabfolder.; separator - Separator to use for the tab syntax. Default is @ for text values, also available & for index and % for regexp.; value - The index to look for.
Returns:: The value of the tab.
Author:: QFS,mm
Since:: 3.5.0

Procedure: "selectTab"

Select a tab in a given Tabfolder.

Parameters:: client - The name of the SUT client.; id - The component ID of the tabfolder to select.; separator - Separator to use for the tab syntax. Default is @ for text values, also available & for index and % for regexp.; value - The value to select.
Author:: QFS,mm
Since:: 2.2.0

Package: "table"

Procedures to access tables. (SWT component org.eclipse.swt.widgets.Table)

Author:: QFS,mm
Since:: 2.1.0

	Procedure/Dependency	Description
	clickCellWithDetails	Select a given cell.
	getColumnCount	Return the number of columns of a given table.
	getIndexOfColumn	Return the current index of a given column.
	getNameOfColumn	Return the header text of a given column.
	getRowCount	Return the number of rows of a given table.
	getRowIndexOfCell	Return the row number of a given cell.
	getValueOfCell	Return the text of a given cell.
	selectCell	Select a given cell.

Procedure: "clickCellWithDetails"

Select a given cell. You can specify the coordinates for clicking and all other details of that mouse click.

Parameters:: id - ID of the table.; column - The column.; row - The row.; columnSeparator - Separator to use for the column syntax. Default is @ for text values, also available & for index and % for regexp.; rowSeparator - Separator to use for the row syntax. Default is @ for text values, also available & for index and % for regexp.; x - The x coordinate for the click, default is empty to click in the middle.; y - The y coordinate for the click, default is empty to click in the middle.; clickCount - Number of clicks. Default is 1. For a double click set this to 2.; modifier - Modifier for mouse key. 4 for right mouse. 16 for left mouse.; hard - True, if hard event should be replayed. Default is false.; popupTrigger - True, if click should open a popup. Default is false.
Author:: QFS,mm
Since:: 4.0

Procedure: "getColumnCount"

Return the number of columns of a given table. It uses the method getColumnCount() do get the number.

Parameters:: id - The component ID of the table.
Returns:: columnCount
Author:: QFS,mm
Since:: 2.1.0

Procedure: "getIndexOfColumn"

Return the current index of a given column.

Sample usage: Can be used to determine the numeric index of a column like 'Price'.

Parameters:: id - ID of the table.; column - The column.; columnSeparator - Separator to use for the column syntax. Default is @ for text values, also available & for index and % for regexp.
Returns:: index The current index of the column, which has been read by the 'Fetch Index' node of QF-Test.
Author:: QFS,mm
Since:: 3.5.0

Procedure: "getNameOfColumn"

Return the header text of a given column.

Sample usage: Determine the title of the second column.

Parameters:: id - ID of the table.; column - The column.; columnSeparator - Separator to use for the column syntax. Default is @ for text values, also available & for index and % for regexp.
Returns:: name The name of the column.
Author:: QFS,mm
Since:: 3.1.1

Procedure: "getRowCount"

Return the number of rows of a given table. It uses the method Table.getItemCount() to get the number.

Parameters:: id - The component ID of the table.
Returns:: rowCount
Author:: QFS,mm
Since:: 2.1.0

Procedure: "getRowIndexOfCell"

Return the row number of a given cell.

Sample usage: Can be used to determine in which row a dedicated cell is located.

Parameters:: id - ID of the table.; column - The column.; row - The row.; columnSeparator - Separator to use for the column syntax. Default is @ for text values, also available & for index and % for regexp.; rowSeparator - Separator to use for the row syntax. Default is @ for text values, also available & for index and % for regexp.
Returns:: index The current index of the row, which has been read by the 'Fetch Index' node of QF-Test.
Author:: QFS,mm
Since:: 3.5.0

Procedure: "getValueOfCell"

Return the text of a given cell.

Sample usage: Can be used to determine the text of the cell in the first column and first row.

Parameters:: id - ID of the table.; column - The column.; row - The row.; columnSeparator - Separator to use for the column syntax. Default is @ for text values, also available & for index and % for regexp.; rowSeparator - Separator to use for the row syntax. Default is @ for text values, also available & for index and % for regexp.
Returns:: value The current value of the row, which has been read by the 'Fetch text' node of QF-Test.
Author:: QFS,mm
Since:: 3.1.1

Procedure: "selectCell"

Select a given cell.

Parameters:: id - ID of the table.; column - The column.; row - The row.; columnSeparator - Separator to use for the column syntax. Default is @ for text values, also available & for index and % for regexp.; rowSeparator - Separator to use for the row syntax. Default is @ for text values, also available & for index and % for regexp.
Author:: QFS,mm
Since:: 2.1.0

Package: "checkbox"

Procedures to set the checked state of tableitems. These procedures become necessary, because checkboxes in tables cannot be treated like normal checkboxes.

Author:: QFS,fs
Since:: 3.5

	Procedure/Dependency	Description
	deselect	Unset the checked state of a tableitem in a table.
	select	Set the checked state of a tableitem in a table.
	set	Set checked state of a tableitem to the given state.

Procedure: "deselect"

Unset the checked state of a tableitem in a table. If the checkbox is already deselected, no action is performed.

Parameters:: client - The name of the SUT client.; id - The id of the tableitem, including the table id and the addressing of the cell.
Author:: QFS,fs
Since:: 3.5

Procedure: "select"

Set the checked state of a tableitem in a table. If the checkbox is already checked, no action is performed.

Parameters:: client - The name of the SUT client.; id - The id of the tableitem, including the table id and the addressing of the cell.
Author:: QFS,fs
Since:: 3.5

Procedure: "set"

Set checked state of a tableitem to the given state.

Parameters:: client - The name of the SUT client.; id - The id of the tableitem, including the table id and the addressing of the cell.; check - The check value to be set (either true or false).
Author:: QFS,fs
Since:: 3.5

Package: "checks"

Procedures for checking a table.

Author:: QFS,mm
Since:: 3.1.1

	Procedure/Dependency	Description
	checkNumberOfRows	Check the number of rows of a given table according to a specified comparison mode.

Procedure: "checkNumberOfRows"

Check the number of rows of a given table according to a specified comparison mode. It uses the method Table.getItemCount() to get the number.

Sample usage: You can check, that a table has exactly 6 rows or that the table has less then 10 rows.

Parameters:: id - The id of the table.; compareValue - The comparison value.; compareMode - The comparison mode = or ==, if the compareValue should be equal than the actual amount of rows. <, if the compareValue should be greater than the actual amount of rows. >, if the compareValue should be less than the actual amount of rows. <=, if the compareValue should be greater or equal than the actual amount of rows. >=, if the compareValue should be less or equal the actual amount of rows. !=, if the compareValue should be not equal the actual amount of items.; errorLevel - The kind of error, which should be logged. Either EXCEPTION, ERROR, WARNING or MESSAGE.; appearInReport - Flag, whether to show check in report, if a message or warning are set as errorLevel. If this is set to 1, the check will be shown in the report.
Exceptions:: UserException, - if wrong comparison mode has been set.
Author:: QFS,mm
Since:: 3.1.1

Package: "selection"

Procedures to (de-)select certain rows of a table.

Author:: QFS,mm
Since:: 2.1.0

	Procedure/Dependency	Description
	deselectAllRows	Deselect all rows.
	deselectRow	Deselect a given row, specified by its index.
	deselectRowRange	Deselect a range of rows, specified by their index.
	selectAllRows	Select all rows.
	selectRow	Select a given row, specified by its index.
	selectRowRange	Select a range of rows, specified by their index.

Procedure: "deselectAllRows"

Deselect all rows. It uses deselectAll().

Parameters:: id - ID of the table.
Author:: QFS,mm
Since:: 2.1.0

Procedure: "deselectRow"

Deselect a given row, specified by its index. It uses deselect().

Parameters:: id - ID of the table.; row - The index of the row.
Author:: QFS,mm
Since:: 2.1.0

Procedure: "deselectRowRange"

Deselect a range of rows, specified by their index. It uses deselect().

Parameters:: id - ID of the table.; startRow - The index of first row to be selected.; endRow - The index of last row to be selected.
Author:: QFS,mm
Since:: 2.1.0

Procedure: "selectAllRows"

Select all rows. It uses selectAll().

Parameters:: id - ID of the table.
Author:: QFS,mm
Since:: 2.1.0

Procedure: "selectRow"

Select a given row, specified by its index. It uses select().

Parameters:: id - ID of the table.; row - The index of the row.
Author:: QFS,mm
Since:: 2.1.0

Procedure: "selectRowRange"

Select a range of rows, specified by their index. It uses select().

Parameters:: id - ID of the table.; startRow - The index of first row to be selected.; endRow - The index of last row to be selected.
Author:: QFS,mm
Since:: 2.1.0

Package: "text"

Procedures to access text fields and text areas. It should work with any SWT components representing textfields or textareas, e.g. org.eclipse.swt.custom.StyledText or org.eclipse.swt.widgets.Text.

Author:: QFS,mm
Since:: 2.1.0

	Procedure/Dependency	Description
	clearArea	Clear a multi-line text area.
	clearField	Clear a simple text field.
	getText	Return the text of a given textfield.
	setText	Set a given text to a given text-field or text-area.
	setTextFromFile	Read the content of a given file and set its content to a given text-field.

Procedure: "clearArea"

Clear a multi-line text area.

Parameters:: client - The name of the SUT client.; id - The id of the text area.
Author:: QFS,mm
Since:: 2.1.0

Procedure: "clearField"

Clear a simple text field.

Parameters:: client - The name of the SUT client.; id - The id of the text field.
Author:: QFS,mm
Since:: 2.1.0

Procedure: "getText"

Return the text of a given textfield.

Parameters:: id - ID of the textfield.
Returns:: The text of the textfield. Variables in this string will not be automatically expanded.
Author:: QFS,mm
Since:: 3.5.0

Procedure: "setText"

Set a given text to a given text-field or text-area.

If the text is empty, no action will take place.

Parameters:: id - ID of the textfield.; text - text to be set.; append - if this value is set to true, the text will be appended to the current values.; clear - If this value is set to true, the text-field will be cleared in case an empty string is given as parameter "text".; replaySingleEvents - If this value is set to true, the text will be inserted replaying single events.; newline - the separator sign for marking a linebreak within the text
Author:: QFS,mm
Since:: 2.1.0

Procedure: "setTextFromFile"

Read the content of a given file and set its content to a given text-field.

Parameters:: id - The id of the text-field to set.; file - The path to the file.; append - If this value is set to true, the text will be appended to the current values.; clear - If this value is set to true, the text-field will be cleared in case an empty string is given as parameter "text".; replaySingleEvents - If this value is set to true, the text will be inserted replaying single events.; newline - the separator sign for marking a linebreak within the text
Author:: QFS,mm
Since:: 3.1.1

Package: "tree"

Procedures to access trees. (SWT component org.eclipse.swt.widgets.Tree)

Author:: QFS,mm
Since:: 2.1.0

	Procedure/Dependency	Description
	callbackPrintNodeText	Example for a callback procedure used by expandNodes.
	clickNodeWithDetails	Select a given node.
	collapse	Collapse a tree node.
	collapseNode	Collapse a tree node.
	collapseNodeWithCoordinates	Collapse a tree node.
	collapseWithCoordinates	Collapse a tree node.
	expand	Expand a tree node.
	expandCompleteTree	Collapse a tree node.
	expandNode	Expand a tree node.
	expandNodes	Expand a tree node recursively.
	expandNodesWithCoordinates	Expand a tree node recursively.
	expandNodeWithCoordinates	Expand a tree node.
	expandWithCoordinates	Expand a tree node.
	getChildNodeCount	Return the number of child nodes.
	getIndexOfNode	Return the hierarchical index of a given node.
	getRowCount	Return the number of visible nodes under a given tree or tree node.
	getValueOfNode	Return the text of a given node.
	selectNode	Select a given node.

Procedure: "callbackPrintNodeText"

Example for a callback procedure used by expandNodes.

Parameters:: treeId - The id of the tree.; node - The index of the node.
Author:: QFS
Since:: 3.0

Procedure: "clickNodeWithDetails"

Select a given node. You can specify the coordinates for clicking and all other details of that mouse click.

Parameters:: id - ID of the tree.; node - The node, e.g. '/Root/Price' or '/0/0'.; separator - Separator to use for the node syntax. Default is @ for text values, also available & for index and % for regexp.; x - The x coordinate for the click, default is empty to click in the middle.; y - The y coordinate for the click, default is empty to click in the middle.; clickCount - Number of clicks. Default is 1. For a double click set this to 2.; modifier - Modifier for mouse key. 4 for right mouse. 16 for left mouse.; hard - True, if hard event should be replayed. Default is false.; popupTrigger - True, if click should open a popup. Default is false
Author:: QFS,mm
Since:: 4.0

Procedure: "collapse"

Collapse a tree node.

Parameters:: client - The name of the SUT client.; node - The id of the tree node to collapse.
Author:: QFS,mm
Since:: 2.1.0

Procedure: "collapseNode"

Collapse a tree node.

Parameters:: client - The name of the SUT client.; id - The id of the tree.; node - The node.; separator - Separator to use for the node syntax. Default is @ for text values, also available & for index and % for regexp.
Author:: QFS,mm
Since:: 3.0

Procedure: "collapseNodeWithCoordinates"

Collapse a tree node. It clicks on the tree node and collapses the node programatically. You can specify the coordinates for selecting the node.

Parameters:: client - The name of the SUT client.; id - The id of the tree.; node - The node, e.g. like '/Root/Price' or '/0/0'.; separator - Separator to use for the node syntax. Default is @ for text values, also available & for index and % for regexp.; x - The x coordinate for the click, default is empty to click in the middle.; y - The y coordinate for the click, default is empty to click in the middle.
Author:: QFS,mm
Since:: 4.0

Procedure: "collapseWithCoordinates"

Collapse a tree node. It clicks on the tree node and collapses the node programatically. You can specify the coordinates for selecting the node.

Parameters:: client - The name of the SUT client.; id - The id of the tree.; node - The node, e.g. like '/Root/Price' or '/0/0'.; separator - Separator to use for the node syntax. Default is @ for text values, also available & for index and % for regexp.; x - The x coordinate for the click, default is empty to click in the middle.; y - The y coordinate for the click, default is empty to click in the middle.
Author:: QFS,mm
Since:: 4.0

Procedure: "expand"

Expand a tree node.

Parameters:: client - The name of the SUT client.; node - The id of the tree node to expand.
Author:: QFS,mm
Since:: 2.1.0

Procedure: "expandCompleteTree"

Collapse a tree node.

Parameters:: client - The name of the SUT client.; id - The id of the tree to collapse.; level - If positive, expand tree nodes only to that depth/level.; expand - If false, collapse tree items instead of expanding.
Author:: QFS,ys
Since:: 4.3

Procedure: "expandNode"

Expand a tree node.

Parameters:: client - The name of the SUT client.; id - The id of the tree.; node - The node.; separator - Separator to use for the node syntax. Default is @ for text values, also available & for index and % for regexp.
Author:: QFS,mm
Since:: 3.0

Procedure: "expandNodes"

Expand a tree node recursively.

Parameters:: id - The id of the tree node.; callbackProc - The name of a procedure to be called for every visited node.
Author:: QFS
Since:: 3.0

Procedure: "expandNodesWithCoordinates"

Expand a tree node recursively. You can specify the coordinates for clicking.

Parameters:: id - The id of the tree node.; callbackProc - The name of a procedure to be called for every visited node.; x - The x coordinate for the click, default is empty to click in the middle.; y - The y coordinate for the click, default is empty to click in the middle.
Author:: QFS,mm
Since:: 4.0

Procedure: "expandNodeWithCoordinates"

Expand a tree node. It clicks on the tree node and expands the node programatically. You can specify the coordinates for selecting the node.

Parameters:: client - The name of the SUT client.; id - The id of the tree.; node - The node, e.g. '/Root/Price' or '/0/0'.; separator - Separator to use for the node syntax. Default is @ for text values, also available & for index and % for regexp.; x - The x coordinate for the click, default is empty to click in the middle.; y - The y coordinate for the click, default is empty to click in the middle.
Author:: QFS,mm
Since:: 4.0

Procedure: "expandWithCoordinates"

Expand a tree node. It clicks on the tree node and expands the node programatically. You can specify the coordinates for selecting the node.

Parameters:: client - The name of the SUT client.; node - The id of the tree node to expand.; x - The x coordinate for the click, default is empty to click in the middle.; y - The y coordinate for the click, default is empty to click in the middle.
Author:: QFS,mm
Since:: 4.0

Procedure: "getChildNodeCount"

Return the number of child nodes.

Parameters:: id - The component id of the tree.; node - The node. like '/Root/Price' or '/0/0'. If no node is specified, QF-Test will count the items of the root node.; nodeSeparator - Separator to use for the node syntax. Default is @ for text values, also available & for index and % for regexp.; countOnlyVisibleNodes - If true, only visible children will be taken into account. Otherwise also invisible children. If the node itself is invisible QF-Test tries to expand that node before performing the count operation.
Returns:: nodeCount
Author:: QFS,mm
Since:: 4.1

Procedure: "getIndexOfNode"

Return the hierarchical index of a given node.

Sample usage: Can be used to determine the numeric index of a node like '/Root/Price'.

Parameters:: id - ID of the tree.; node - The node. like '/Root/Price' or '/0/0'.; nodeSeparator - Separator to use for the node syntax. Default is @ for text values, also available & for index and % for regexp.
Returns:: index The current index of the node, which has been read by the 'Fetch Index' node of QF-Test. This will be something like /0/1.
Author:: QFS,mm
Since:: 3.5.0

Procedure: "getRowCount"

Return the number of visible nodes under a given tree or tree node. If no node is specified, you will get the visible nodes or all loaded nodes of the entire tree.

Parameters:: id - The component id of the tree.; node - The node. like '/Root/Price' or '/0/0'. If no node is specified, QF-Test will count the nodes of the root node.; nodeSeparator - Separator to use for the node syntax. Default is @ for text values, also available & for index and % for regexp.; countOnlyVisibleNodes - If true, only visible children will be taken into account. Otherwise also invisible children. If the node itself is invisible QF-Test tries to expand that node before performing the count operation.
Returns:: rowCount
Author:: QFS,mm
Since:: 3.1.1

Procedure: "getValueOfNode"

Return the text of a given node.

Sample usage: Determine the text value for a node referenced by index like /0/1.

Parameters:: id - ID of the tree.; node - The node. It should be something like '/Root/Price' or '/0/0'.; nodeSeparator - Separator to use for the node syntax. Default is @ for text values, also available & for index and % for regexp.
Returns:: The value of the node.
Author:: QFS,mm
Since:: 3.1.1

Procedure: "selectNode"

Select a given node.

Parameters:: id - The id of the tree.; node - The node.; separator - Separator to use for the node syntax. Default is @ for text values, also available & for index and % for regexp.
Author:: QFS,mm
Since:: 2.1.0

Package: "checks"

Procedures for checking a tree.

Author:: QFS,mm
Since:: 3.1.1

	Procedure/Dependency	Description
	checkNumberOfChildNodes	Check the number of child nodes of a given tree node according to a specified comparison mode.
	checkNumberOfRows	Check the number of visible nodes under a given tree or tree node according to a specified comparison mode.

Procedure: "checkNumberOfChildNodes"

Check the number of child nodes of a given tree node according to a specified comparison mode.

Sample usage: You can check, that a tree has exactly 6 visible rows or that the tree has less then 10 visible rows.

Parameters:: id - The id of the tree.; node - The node. like '/Root/Price' or '/0/0'. Leave empty, if you want to count rows of whole tree.; nodeSeparator - Separator to use for the node syntax. Default is @ for text values, also available & for index and % for regexp.; countOnlyVisibleNodes - If true, only visible children will be taken into account. Otherwise also invisible children. If the node itself is invisible QF-Test tries to expand that node before performing the count operation.; compareValue - The comparison value.; compareMode - The comparison mode = or ==, if the compareValue should be equal than the actual amount of rows. <, if the compareValue should be greater than the actual amount of rows. >, if the compareValue should be less than the actual amount of rows. <=, if the compareValue should be greater or equal than the actual amount of rows. >=, if the compareValue should be less or equal the actual amount of rows. !=, if the compareValue should be not equal the actual amount of items.; errorLevel - The kind of error, which should be logged. Either EXCEPTION, ERROR, WARNING or MESSAGE.; appearInReport - Flag, whether to show check in report, if a message or warning are set as errorLevel. If this is set to 1, the check will be shown in the report.
Exceptions:: UserException, - if wrong comparison mode has been set.
Author:: QFS,mm
Since:: 4.1

Procedure: "checkNumberOfRows"

Check the number of visible nodes under a given tree or tree node according to a specified comparison mode. If no node is specified, you will get the visible nodes or all loaded nodes.

Sample usage: You can check, that a tree has exactly 6 visible rows or that the tree has less then 10 visible rows.

Parameters:: id - The id of the tree.; node - The node. like '/Root/Price' or '/0/0'. Leave empty, if you want to count rows of whole tree.; nodeSeparator - Separator to use for the node syntax. Default is @ for text values, also available & for index and % for regexp.; countOnlyVisibleNodes - If true, only visible children will be taken into account. Otherwise also invisible children. If the node itself is invisible QF-Test tries to expand that node before performing the count operation.; compareValue - The comparison value.; compareMode - The comparison mode = or ==, if the compareValue should be equal than the actual amount of rows. <, if the compareValue should be greater than the actual amount of rows. >, if the compareValue should be less than the actual amount of rows. <=, if the compareValue should be greater or equal than the actual amount of rows. >=, if the compareValue should be less or equal the actual amount of rows. !=, if the compareValue should be not equal the actual amount of items.; errorLevel - The kind of error, which should be logged. Either EXCEPTION, ERROR, WARNING or MESSAGE.; appearInReport - Flag, whether to show check in report, if a message or warning are set as errorLevel. If this is set to 1, the check will be shown in the report.
Exceptions:: UserException, - if wrong comparison mode has been set.
Author:: QFS,mm
Since:: 3.1.1

Package: "multicolumn"

Special procedures for multi-column trees.

Author:: QFS,kk
Since:: 3.5.0

	Procedure/Dependency	Description
	getRowIndexByCellText	Return the index of the first row containing a given cell text in a given column of an SWT multi-column tree.

Procedure: "getRowIndexByCellText"

Return the index of the first row containing a given cell text in a given column of an SWT multi-column tree.

Parameters:: treeId - The id of the swt multi-column tree.; column - The column header text.; columnSeparator - The separator to use for the node syntax. Default is @ for text values, also available & for index and % for regexp.; text - The cell text to look for.; regexp - If true the text parameter is meant as regexp. Default is false.
Returns:: The row index. -1 in case no fitting cell is found.
Author:: QFS,kk
Since:: 3.5.0

Package: "utils"

Miscellaneous utility procedures.

Author:: QFS,mm
Since:: 2.1.0

	Procedure/Dependency	Description
	click	Perform a mouse click somwhere on the screen or onto a given component.
	createThreadDump	Trigger a full thread dump in the SUT if possible.
	dragAndDrop	Drag the source component or item onto the target and drop it.
	dumpComponents	Dump an entire component hierarchy into the run log.
	dumpHeap	Dump the heap of the Java VM.
	getBoundsOnScreen	Get the screen location and the size of a component or subitem.
	getDate	Return a date, default is the current date in current locale.
	getTime	Return the time in the current format.
	getTimestamp	Return a timestamp, which represents the current time in milliseconds.
	killAllClients	Kill all running clients.
	killClient	Kill a client.
	logAllMethodsOfAGivenComponent	Log all available methods of a given component.
	logMemory	Log current memory use.
	logNativeMemory	Log current memory usage of the native process(es) of a client.
	printMessage	Print a given message to STDOUT.
	printVariable	Print the visible content of a variable.
	readTextFromFile	Read the content of a given file.
	sendEmail
	sendKey	Send the given key along with the qualifier to the component which currently has the input focus.
	sendText	Send the given text to the component which currently has the input focus.
	setWindowToForeground	Brings the specified window to the foreground.
	sleep	Sleep a given time.
	waitForClientOutput	Wait until a client prints something to the terminal.
	waitForOneOfNComponents	Wait until one of N components is available.
	writeMessageIntoFile	Write a given message into a given file.

Procedure: "click"

Perform a mouse click somwhere on the screen or onto a given component.

Parameters:: id - The QF-Test component ID of the source to click on or SCREEN.; x - The x coordinate of the click. Use "-" to replay a click on the center of the source.; y - The y coordinate of the click. Use "-" to replay a click on the center of the source.; mouseModifier - The mouse modifier: 16 - left click, 4 - right click; nrTimes - The number of times that the click gets executed (set to 2 in order to replay a double click); keyModifier - Whether to press a modifier key during the operation: 1 - SHIFT, 2 - CTRL, 3 - SHIFT+CTRL, 4 - CMD, 8 - ALT
Author:: QFS,ys
Since:: 4.7.0

Procedure: "createThreadDump"

Trigger a full thread dump in the SUT if possible.

Parameters:: client - The name of the SUT client.
Author:: QFS
Since:: 3.4

Procedure: "dragAndDrop"

Drag the source component or item onto the target and drop it.

Parameters:: source - The QF-Test component ID of the source or SCREEN; target - The QF-Test component ID of the target or SCREEN; fromX - An X-offset when starting to drag the source; fromY - A Y-offset when starting to drag the source; toX - An X-offset when dropping on the target; toY - A Y-offset when dropping on the target; fromClient - The name of the source's client; toClient - The name of the target's client; modifier - Whether to press a modifier key during the operation: 17 - SHIFT, 18 - CTRL, 19 - SHIFT+CTRL; eventDelay - The amount of milliseconds to wait between each inserted event. High values ensure that the SUT has the time to respond to every event generated while low values will speedup the replay. Default is 50.
Author:: QFS,rl
Since:: 4.0.5

Procedure: "dumpComponents"

Dump an entire component hierarchy into the run log.

Parameters:: id - The id of the component from which to start dumping.; visibleOnly - Whether to include only visible components, i.e. ignore all components that are not currently showing.; interestingOnly - Whether to include only "interesting" components, i.e. ignore all components that QF-Test would not record with the default option settings.; filter - Optional comma-separated list of classes. If defined, dump only components of these classes or not of these classes, if filter is negated by preprending ^.; dontcompactify - Whether to prevent the resulting log entry from compactification.
Author:: QFS,gs
Since:: 4.0.5

Procedure: "dumpHeap"

Dump the heap of the Java VM.

Parameters:: sut - True to dump the SUT heap for $(client), false for the QF-Test heap.; client - The name of the SUT client in case sut is true.; file - The name of the file to dump the heap to.; deleteFirst - Whether to delete the file first. Otherwise an existing file will not be overwritten.; guiengine - The name of the GUI engine to run the SUTscript, e.g. awt, swt, web. Can be empty, if you work with one engine at the same time.
Author:: QFS
Since:: 3.4

Procedure: "getBoundsOnScreen"

Get the screen location and the size of a component or subitem.

Parameters:: id - The QF-Test component ID of the component; client - The client of the component
Returns:: The bounds as Geometry object (with a comma-separated list as string value: left,top,width,height).
Author:: QFS,rl
Since:: 4.0.5

Procedure: "getDate"

Return a date, default is the current date in current locale.

Formatting rules: If a format and a locale are specified the date will be formatted using both values. If only a format is specified the date will be formatted only with that format. If only a locale is specified the date will be formatted according to the locale-format.

Parameters:: format - The format of the date, default is the current locale. You can specify this via the SimpleDateFormat in Java, e.g. MM/dd/yyyy. dd means two digits for the day. MM means two digits for month. yyyy means four digits for year.; offset - The number of days in future/past. For yesterday's date specify -1. For tomorrow's date specify 1.; locale - The locale of the date, e.g. de, us, it, es, fr, zh, ko, ru, pt, ar or specific locales as en_gb, de_ch etc.
Returns:: date The date in specified format. Further samples: MMM stands for the name of the month, e.g. 'Feb'. E stands for the day of the week, e.g. 'Mon'. w stands for week in the year. Further samples can be found at SimpleDateFormat documentation at Java's documentation.
Author:: QFS,mm
Since:: 2.1.0

Procedure: "getTime"

Return the time in the current format. Default is now, timestamps in the past or in future can be specified via the offset parameter.

Formatting rules: If a format and a locale are specified the time will be formatted using both values. If only a format is specified the time will be formatted only with that format. If only a locale is specified the time will be formatted according to the locale-format.

Parameters:: format - The format of the date, default HH:mm:ss. hh means two digits for the hour. mm means two digits for minutes. ss means two digits for seconds.; offset - The seconds in future/past. For one minute ago specify -60. For one minute in future specify +60.; timezone - The timezone to get the time from. If left empty, the local time will be taken. If an invalid timezone is specified the timezone will be set to GMT. Examples see below.; locale - The locale of the date, e.g. de, us, it, es, fr, zh, ko, ru, pt, ar or specific locales as en_gb, de_ch etc. Further samples: S stands for current millisecond. K stands for hour in am/pm (0-11) k stands for hour in day (1-24) a stands for the am/pm marker z stands for the time zone abbreviation (zzzz) stands for the time zone name Further samples can be found at SimpleDateFormat documentation at Java's documentation. Samples for timezone: GMT (Greenwich mean time), CET (Central european time), IST (India Standard Time), GMT-08:00 GMT+2:00.
Returns:: The time in specified format.
Author:: QFS,mm, Denis Gauthier
Since:: 2.1.0, 3.1.4

Procedure: "getTimestamp"

Return a timestamp, which represents the current time in milliseconds.

Returns:: The timestamp in milliseconds.
Author:: QFS,mm
Since:: 3.3.0

Procedure: "killAllClients"

Kill all running clients.

Parameters:: timeout - The timeout for waiting for process termination after killing a client.
Exceptions:: ClientNotTerminatedException - if a client has not been killed.
Author:: QFS,mm
Since:: 3.1.1

Procedure: "killClient"

Kill a client.

Parameters:: client - The connection.; timeout - The timeout for waiting for process termination after killing.
Exceptions:: ClientNotTerminatedException - if a client has not been killed.
Author:: QFS,mm
Since:: 3.1.1

Procedure: "logAllMethodsOfAGivenComponent"

Log all available methods of a given component. This script can be used to look for dedicated methods of objects. NOTE: If you use custom classloaders, the procedure could fail.

Parameters:: id - The id of the component.; guiengine - The name of the GUI engine to run the SUTscript, e.g. awt, swt, web. Can be empty, if you work with one engine at the same time.
Author:: QFS,mm
Since:: 3.1.1

Procedure: "logMemory"

Log current memory use.

Parameters:: sut - True to log SUT memory for $(client), false for qftest memory.; client - The name of the SUT client in case sut is true.; warningLimit - Optional value in MB. If exceeded, log a warning instead of a plain message.; warningDelay - If warningLimit is exceeded, wait the given delay in seconds, then try again and log a warning only if the limit is still exceeded.; errorLimit - Optional value in MB. If exceeded, log an error instead of a warning or a plain message.; errorDelay - If errorLimit is exceeded, wait the given delay in seconds, then try again and log an error only if the limit is still exceeded.; guiengine - The name of the GUI engine to run the SUTscript, e.g. awt, swt, web. Can be empty, if you work with one engine at the same time.
Returns:: The memory used in MB.
Author:: QFS
Since:: 2.1.0

Procedure: "logNativeMemory"

Log current memory usage of the native process(es) of a client.

Parameters:: client - Optional name of the SUT client. Its processID is used unless processID is explicitly specified.; processID - Can be explicitly specified if known, otherwise the client parameter is used to determine the process.; warningLimit - Optional value in MB. If exceeded, log a warning instead of a plain message.; errorLimit - Optional value in MB. If exceeded, log an error instead of a warning or a plain message.; processTree - If set to True the amount of the process itself and all its child processes will get logged.
Returns:: The memory used in MB.
Author:: QFS, mh
Since:: 3.4.11

Procedure: "printMessage"

Print a given message to STDOUT.

Parameters:: message - The message to be printed.
Author:: QFS,mm
Since:: 2.1.0

Procedure: "printVariable"

Print the visible content of a variable.

Parameters:: variableName - The name of the variable.
Author:: QFS,mm
Since:: 2.1.0

Procedure: "readTextFromFile"

Read the content of a given file.

Parameters:: file - The path to the file.; fileencoding - The file encoding to use. If this parameter is empty, the default file encoding will be used.
Returns:: The contents of the file. Variables in this string will not be automatically expanded.
Exceptions:: UserException, - if files doesn't exist.
Author:: QFS,mm
Since:: 3.1.1

Procedure: "sendEmail"

Deprecated: Use qfs.utils.email.sendEmail or qfs.utils.email.sendEmail_SMTPHost instead.

Author:: QFS,mm
Since:: 2.9.1

Procedure: "sendKey"

Send the given key along with the qualifier to the component which currently has the input focus.

Parameters:: key - The key to be send along with the qualifier key. Valid input: a single letter of the latin alphabet, a digit or values for special keys like ENTER, DELETE, TAB, ESCAPE or F1 to F24.; qualifier - The qualifiers to send along with the key. Valid inputs: SHIFT, CONTROL/CTRL, ALT (= OPTION), META (= WINDOWS/COMMAND), combinations of these, or the empty string for no qualifier; title - (optional) The title of the window to bring to front before pressing the shortcut.; titleRegexp - (optional) true, if the given title is a regular expression, otherwise false.
Author:: QFS,pb
Since:: 5.2

Procedure: "sendText"

Send the given text to the component which currently has the input focus.

Parameters:: text - The text to be send.; title - (optional) The title of the window to bring to front before sending the text.; titleRegexp - (optional) true, if the given title is a regular expression, otherwise false.
Author:: QFS,pb
Since:: 5.2

Procedure: "setWindowToForeground"

Brings the specified window to the foreground.

Parameters:: title - The title of the window to bring to front before pressing the shortcut.; titleRegexp - true, if the given title is a regular expression, otherwise false.
Author:: QFS,pb
Since:: 5.2

Procedure: "sleep"

Sleep a given time.

Parameters:: sleeptime - The time to sleep in milliseconds.
Author:: QFS,mm
Since:: 3.5.0

Procedure: "waitForClientOutput"

Wait until a client prints something to the terminal.

If no output can be determined, throw an exception or log an error depending on the parameters.

Parameters:: client - The client for which the output should be inspected.; expectedOutput - The output to wait for.; isRegex - True to have the output matched as regular expression.; timeout - The maximal waiting time (in ms).; polling - The interval in milliseconds in which to poll for new components.; dologerror - Log an error instead of throwing an exception.
Exceptions:: Exception - If dologerror==false and the terminal output was not found once timeout exceeded.
Author:: QFS,pb
Since:: 5.2

Procedure: "waitForOneOfNComponents"

Wait until one of N components is available. If no component can be determined within a given timeout it will throw an exception or log an error depending on the parameters.

Parameters:: comids - Comma-separated list of component ids to wait for.; disappear - If this parameter is set to true, the procedure will wait until at least one of the given component disappeared.; hidden - Whether to accept hidden components.; timeout - The maximal waiting timeout (in ms).; polling - The interval in milliseconds in which to poll for new components.; dologerror - Log an error instead of throwing an exception.; comidsSeparator - The value, which separates the component ids. , is default.
Exceptions:: ComponentNotFoundException - If dologerror==false, disappear==false and non of the components was found once timeout exceeded.; ComponentFoundException - If dologerror==false, disappear==true and all components can still be found once timeout exceeded.
Author:: QFS,ys
Since:: 4.2.1

Procedure: "writeMessageIntoFile"

Write a given message into a given file. NOTE: Special characters like \n or \t won't be expanded and will be treated as normal characters.

Parameters:: message - The message, which should be written.; file - The file, where the message has to be written into.; addLinebreak - If this is set to true, a linebreak `\n` will be appended to the text. On Windows '\r\n will be added.
Exceptions:: UserException, - if no proper values for file and message have been set.
Author:: QFS,mm
Since:: 2.1.0

Package: "clipboard"

Accessing the clipboard from procedures.

Author:: QFS,mm
Since:: 3.4.0

	Procedure/Dependency	Description
	getTextFromClipboard	Return the current text on the system clipboard.
	setTextAtClipboard	Set a text on the system clipboard.

Procedure: "getTextFromClipboard"

Return the current text on the system clipboard.

Returns:: The current text on the clipboard. Variables in this string will not be automatically expanded.
Author:: QFS,mm
Since:: 3.4.0

Procedure: "setTextAtClipboard"

Set a text on the system clipboard.

Author:: QFS,mh
Since:: 3.5.91

Package: "email"

Procedures for sending emails.

Author:: QFS,mm
Since:: 3.1.2

	Procedure/Dependency	Description
	sendEmail	This procedure uses the smtplib module from Jython, to send emails via SMTP(s) server.
	sendEmail_SMTPHost	Send an email.

Procedure: "sendEmail"

This procedure uses the smtplib module from Jython, to send emails via SMTP(s) server. This procedure performs a login of a given user to a given SMTP server before sending the email. The attachment type is guessed based on file extension.

Logs detailed Error/Warning messages.

Note: To and From fields work only with ASCII characters, see https://docs.python.org/2.7/library/email.header.html

Parameters:: from - The address of the sender.; to - A comma-separated list of recipients.; subject - The subject of the email.; text - The text of the email.; asHtml - The Body of the email. Plain text or HTML.; smtpHost - SMTP server for sending emails. HOSTNAME:PORT; smtpUser - Username for login to the SMTP server.; smtpPassword - Password for login to the SMTP server.; fileToAttach - File to attach. Use full path.; readFileAsText - force file to be read as text file; suppressErrors - Log Warnings instead of errors in run log
Author:: QFS,pv
Since:: 4.1

Procedure: "sendEmail_SMTPHost"

Deprecated: Use qfs.utils.email.sendEmail because it provides the same functionallity.

Send an email. This procedure uses the smtplib module from Jython, which requires a SMTP server for sending emails. This procedure performs a login of a given user to a given SMTP server before sending the email.

It is possible that you have to copy that script and use it as template for your own script, because your mail-server requires a different authentication.

Parameters:: from - The address of the sender.; to - A comma-separated list of recipients.; subject - The subject of the email.; text - The text of the email.; asHtml - The Content-Type of the text is text/html.; smtpHost - SMTP server for sending emails.; smtpUser - User for the SMTP server.; smtpPassword - Password for the SMTP server.
Exceptions:: Exception - If something went wrong
Author:: QFS,fs
Since:: 3.1.2

Package: "pop3"

Procedures for interacting with a POP3 server.

Author:: QFS
Since:: 3.1.3

	Procedure/Dependency	Description
	deleteMessages	Delete all messages from a pop3 account.
	fetchMessage	Fetch a message from a pop3 account.

Procedure: "deleteMessages"

Delete all messages from a pop3 account.

Parameters:: host - Hostname of the pop3 server.; port - Optional port of the pop3 server, leave empty to use the standard port.; username - Username for the pop3 account.; password - Password for the pop3 account.; useSSL - Whether to use SSL.

Procedure: "fetchMessage"

Fetch a message from a pop3 account.

Parameters:: host - Hostname of the pop3 server.; port - Optional port of the pop3 server, leave empty to use the standard port.; username - Username for the pop3 account.; password - Password for the pop3 account.; number - Optional number of the message to get, default 1.; delete - Whether to delete the message, default true.; timeout - Approximate maximum time in ms to wait for the message to appear.; useSSL - Whether to use SSL.

Package: "files"

Contain procedures to work with files.

Author:: QFS,mm
Since:: 3.4.0

	Procedure/Dependency	Description
	checkFileForContent	Check, whether a given file contain a specific value.
	checkFileForExistingLine	Check, whether a given file contain a specific value in a line.
	compareFiles	Compare the given files and returns true if equal, otherwise false.
	readExcelFile	Read a worksheet of an Excel file.

Procedure: "checkFileForContent"

Check, whether a given file contain a specific value. The value has to be a regular expression. It checks the whole text of the file for the value, so you can also specify text containing line breaks, if required.

Parameters:: fileName - The filename to check.; value - The value for checking.; errorLevel - The kind of error, which should be logged. Either EXCEPTION, ERROR, WARNING or MESSAGE.; appearInReport - Flag, whether to show check in report, if a message or warning are set as errorLevel. If this is set to 1, the check will be shown in the report.
Exceptions:: UserException, - if file doesn't exist.
Author:: QFS,mm
Since:: 3.4.0

Procedure: "checkFileForExistingLine"

Check, whether a given file contain a specific value in a line. If valueRegex is set to true, it checks for a regular expression. If valueRegex is set to false the text has in a row has to match exactly.

Parameters:: fileName - The filename to check.; value - The value for checking.; valueRegex - True, if the value is a regex, otherwise false.; errorLevel - The kind of error, which should be logged. Either EXCEPTION, ERROR, WARNING or MESSAGE.; appearInReport - Flag, whether to show check in report, if a message or warning are set as errorLevel. If this is set to 1, the check will be shown in the report.
Exceptions:: UserException, - if file doesn't exist.
Author:: QFS,mm
Since:: 3.4.0

Procedure: "compareFiles"

Compare the given files and returns true if equal, otherwise false. It uses the Jython module filecmp for the comparison. It doesn't return the diff of the files in case of differences.

Parameters:: file1 - The name and path of the first file to compare.; file2 - The name and path of the second file to compare with.
Returns:: true If both files are equal. false If both files are not equal.
Exceptions:: UserException - If at least one of both file to be compared does not exist.
Author:: QFS,mks
Since:: 3.5.0

Procedure: "readExcelFile"

Read a worksheet of an Excel file.

Parameters:: fileName - The name of the file to read.; sheet - The name or the index of the worksheet.; dateFormat - A format string for the Java SimpleDateFormat.; resultGroupName - If this name is specified, the result is stored in a property group which an be accessed via ${resultGroupName:cellReference}, for example ${resultGroup:A2}
Author:: QFS,rl
Since:: 3.5.0

Package: "json"

Procedures for working with JSON files.

Author:: QFS,ml
Since:: 7.1.0

	Procedure/Dependency	Description
	compareJSONFiles	Compare two JSON files for full identity.
	compareJsonResponse	Compare a JSON response against an expected file.
	getRESTResponse	Get a REST response from a given URL.

Procedure: "compareJSONFiles"

Compare two JSON files for full identity.

If differences are found, an error is logged for each different key.

The 'noCheck' parameter can be used to exclude keys from the comparison, for example variable values like timestamps. 'noCheck' also ignores keys that only appear in one JSON file, so optional keys can be specified there as well.

Examples for 'noCheck': noCheck: date ... ignores all 'date' keys. noCheck: date@value=11122015 ... ignores all 'date' keys with the value '11122015'. noCheck: date@value=%.*2015 ... ignores all 'date' keys where the regular expression '.*2015' matches the value.

Parameters:: originalFile - The original file for comparison.; compareFile - The file for comparing.; ignoreOrder - Whether to ignore the order of the keys.; stopAtFirstDiff - If enabled, only the first difference will be logged in the run log. The files won't be compared any further. This can lead to shorter run times, especially when comparing large files. If no difference is found, the parameter will not affect the comparison.; noCheck - A comma separated list of keys which are excluded from checking. To ignore attributes specifiy key@attr, or key@attr=value or key@attr=%regex-for-value.; timeout - Maximum time for the comparison. Once the timeout is reached the check is ended. This may lead to an incomplete check!
Exceptions:: UserException, - if any of the given files don't exist.
Author:: QFS,ml
Since:: 7.1.0

Procedure: "compareJsonResponse"

Compare a JSON response against an expected file.

If differences are found, an error is logged for each different key.

Parameters:: URL - The URL to connect to.; expectedFile - The file to compare to.; ignoreOrder - Whether to ignore the order of the keys.; stopAtFirstDiff - If enabled, only the first difference will be logged in the run log. The files won't be compared any further. This can lead to shorter run times, especially when comparing large files. If no difference is found, the parameter will not affect the comparison.; noCheck - A comma separated list of keys and attributes, which are excluded from checking. To ignore attributes specifiy key@attr or key@attr=value or key@attr=%regex-for-value.; requestMethod - The request method, e.g. GET.; actualFile - The file to save the response to.; headers - Optional headers.; payload - The payload to send.; payloadAsFile - Whether the payload is a file.; timeout - Maximum time for the comparison. Once the timeout is reached the check is ended. This may lead to an incomplete check!
Exceptions:: UserException, - if something went wrong.
Author:: QFS,ml
Since:: 7.1.0

Procedure: "getRESTResponse"

Get a REST response from a given URL.

Parameters:: URL - The URL to connect to.; requestMethod - The request method, e.g. GET.; responseFile - The file whre the repsonse is saved to.; headers - Optional headers.; payload - The payload to send.; payloadAsFile - Whether the payload is a file.
Exceptions:: UserException, - if something went wrong.
Author:: QFS,ml
Since:: 7.1.0

Package: "random"

Procedures for generating random string.

Author:: QFS,mm
Since:: 3.0

	Procedure/Dependency	Description
	getEntriesOfArea	Return a random string created of parts of a specified area.
	getNumber	Return a random number.
	getNumberFromRange	Return a random number between two given numbers.
	getString	Return a random string containing small letters.

Procedure: "getEntriesOfArea"

Return a random string created of parts of a specified area. The length of the string can also be specified as parameter.

Parameters:: area - The area, which contains the choices.; length - The length of the random string.
Returns:: string The random string.
Author:: QFS,mm
Since:: 3.0

Procedure: "getNumber"

Return a random number.

Parameters:: length - The length of the random string.
Returns:: number The random number.
Author:: QFS,mm
Since:: 3.0

Procedure: "getNumberFromRange"

Return a random number between two given numbers.

If you call it with lowest 0 and highest 3. The procedure could return 0, 1 or 2.

Parameters:: lowest - The lowest number for the random choice. It could be returned.; highest - The highest number for the random choice. It won't be included.
Returns:: random The random number.
Author:: QFS,mm
Since:: 3.4.0

Procedure: "getString"

Return a random string containing small letters.

Parameters:: length - The length of the random string.
Returns:: string The random string.
Author:: QFS,mm
Since:: 3.0

Package: "ssh"

Procedures for executing commands on a remote server via ssh.

Author:: QFS,ys
Since:: 4.0

	Procedure/Dependency	Description
	executeCommand	Connect to a remote server by ssh and execute a command.

Procedure: "executeCommand"

Connect to a remote server by ssh and execute a command.

Parameters:: server - The remote server to connect to.; port - The port to use for ssh login (optional, default 22).; user - The username to use.; password - The password to use (optional).; keyfile - The name of the file containing the key for public key authentication. Used only if no password is specified (optional, default is /.ssh/id_rsa).; checkKnownHosts - Whether to check the fingerprint of the remote server. For security reasons this should be enabled.; knownHostFile - A file containing the fingerprint for the remote server (optional, default is /.ssh/known_hosts).; connectionTimeout - Time in ms to wait for a connection. -1 to wait forever (optional, default is 5000).; command - The command to execute on the remote server.; stdin - Text to be based to the stdin of the executing program. Ignored if stdinFile is specified.; stdinFile - The path to a local file or nothing. If a file is specified, the content of this file is passed to the stdin of the executing program.; mixOut - If true, stdout and stderr of the executing program are captured together in the stdout stream with stderr remaining empty (optional, default False).; programTimeout - Time in ms to wait for the command to execute. -1 to wait forever (optional, default is 5000).; encoding - The encoding for the stdout and stderr stream (optional, default is UTF-8).; resultGroupName - If this name is specified the stdout, stderr and exit code of the executed command are stored in a property group and may be accessed with ${resultGroup:'stdout'} (for the stdout of the program), ${resultGroup:'stderr'} (for the stderr of the program) and ${resultGroup:'exitCode'} (for the exit code of the program).
Exceptions:: Exception - If something goes wrong with the ssh connection or program execution.
Author:: QFS, ys, gs
Since:: 4.0

Package: "session"

Procedures for handling SSH connections.

Author:: QFS,ys
Since:: 4.0

	Procedure/Dependency	Description
	close	Close an established ssh connection.
	open	Connect to a remote server by ssh and keep the session open for further use.
	send	Send a command via an established ssh connection and wait for resulting output.

Procedure: "close"

Close an established ssh connection.

Parameters:: sessionName - The name of the global Jython variable in which the session is stored.; resultGroupName - If this name is specified the combined stdout and stderr and the exit code of the executed command are stored in a property group and may be accessed with ${resultGroup:'stdout'} (for the stdout and stderr of the program) and ${resultGroup:'exitCode'} (for the exit code of the program).
Exceptions:: Exception - If something goes wrong with the ssh connection.
Author:: QFS, gs
Since:: 4.0

Procedure: "open"

Connect to a remote server by ssh and keep the session open for further use.

Parameters:: sessionName - The name of the global Jython variable in which the session is stored.; server - The remote server to connect to.; port - The port to use for ssh login (optional, default 22).; user - The username to use.; password - The password to use (optional).; keyfile - The name of the file containing the key for public key authentication. Used only if no password is specified (optional, default is /.ssh/id_rsa).; checkKnownHost - Whether to check the fingerprint of the remote server. For security reasons this should be enabled.; knownHostFile - A file containing the fingerprint for the remote server (optional, default is /.ssh/known_hosts).; connectionTimeout - Time in ms to wait for a connection. -1 to wait forever (optional, default is 5000).; encoding - The encoding for the stdout and stderr stream (optional, default is UTF-8).
Exceptions:: Exception - If something goes wrong with the ssh connection.
Author:: QFS, gs
Since:: 4.0

Procedure: "send"

Send a command via an established ssh connection and wait for resulting output.

Parameters:: sessionName - The name of the global Jython variable in which the session is stored.; input - The text to send.; addNewline - Whether to automatically terminate the command with a newline character if necessary (optional, default true).; expect - A regular expression for the output to expect from the program.; timeout - The maximum time to wait for the output.
Returns:: The partial output from the program from the start or the last point of execution of this procedure to the end of the string that we were waiting for.
Exceptions:: Exception - If something goes wrong with the ssh connection or program execution.
Author:: QFS, gs
Since:: 4.0

Package: "testrun"

Procedures for handling the test execution.

Author:: QFS,mm
Since:: 3.1.3

Package: "skip"

Procedures for skipping test steps.

Author:: QFS,mm
Since:: 3.1.3

	Procedure/Dependency	Description
	skipTestCase	Skip the execution of the current test case.
	skipTestSet	Skip the execution of the current test set.

Procedure: "skipTestCase"

Skip the execution of the current test case.

Author:: QFS,mm
Since:: 3.1.3

Procedure: "skipTestSet"

Skip the execution of the current test set.

Author:: QFS,mm
Since:: 3.1.3

Package: "stop"

Procedures for stopping test steps.

Author:: QFS,mm
Since:: 3.1.3

	Procedure/Dependency	Description
	stopTestCase	Stop the execution of the current test case
	stopTestRun	Stop the complete test run.
	stopTestSet	Stop the execution of the current test set.

Procedure: "stopTestCase"

Stop the execution of the current test case

Parameters:: expectedToFail - Whether test case was expected to fail.
Author:: QFS,mm
Since:: 3.1.3

Procedure: "stopTestRun"

Stop the complete test run.

Author:: QFS,mm
Since:: 3.1.3

Procedure: "stopTestSet"

Stop the execution of the current test set.

Author:: QFS,mm
Since:: 3.1.3

Package: "variables"

Procedures for working with variables.

Author:: QFS,mm
Since:: 3.3.0

	Procedure/Dependency	Description
	deleteAllGlobalVariables	Delete all global QF-Test variables.
	deleteGlobalVariablesExcept	Delete all global QF-Test variables.
	deleteOneGlobalVariable	Delete a given global QF-Test variable.
	deleteOnePropertyVariable	Delete a given variable of a property group.
	deletePropertyGroup	Delete a given global property group.
	listAllMembersOfPropertyGroup	Print a list of all members of a given property group to the terminal.

Procedure: "deleteAllGlobalVariables"

Delete all global QF-Test variables.

Author:: QFS,mm
Since:: 3.3.0

Procedure: "deleteGlobalVariablesExcept"

Delete all global QF-Test variables. You can define some exceptions for variable names, which shouldn't be deleted.

Parameters:: dontDelete - A comma-separated list of variable names which shouldn't be deleted. If dontDelete is set to: client,number The variables client and number won't become deleted.
Author:: QFS,mm
Since:: 3.5.0

Procedure: "deleteOneGlobalVariable"

Delete a given global QF-Test variable.

Parameters:: variableName - The name of the variable.
Author:: QFS,mm
Since:: 3.3.0

Procedure: "deleteOnePropertyVariable"

Delete a given variable of a property group.

Parameters:: groupName - The name of the group.; variableName - The name of the variable.
Author:: QFS,mm
Since:: 3.5.0

Procedure: "deletePropertyGroup"

Delete a given global property group. You can also use this to delete a custom resource bundle set, which have been read by the Load-Resource bundle node.

Parameters:: groupName - The name of the group.
Author:: QFS,mm
Since:: 3.5.0

Procedure: "listAllMembersOfPropertyGroup"

Print a list of all members of a given property group to the terminal.

Parameters:: groupName - The name of the group.
Author:: QFS,mm
Since:: 3.5.0

Package: "xml"

Procedures for working with XML files.

Author:: QFS,mm
Since:: 3.1.1

	Procedure/Dependency	Description
	compareXMLFiles	Compare two XML files for full identity.
	loadPropertiesFromXML	Load properties from an XML file.

Procedure: "compareXMLFiles"

Compare two XML files for full identity.

If differences are found, an error is logged for each different tag.

The 'noCheck' parameter can be used to exclude tags and attributes from the comparison, for example random values like timestamps. 'noCheck' also ignores tags, that only appear in one xml file, so optional tags can be specified there as well.

Examples for noCheck: noCheck: date ... ignores all 'date' tags. noCheck: date@value ... ignores all 'date' tags with the attribute 'value'. noCheck: date@value=11122015 ... ignores all 'date' tags with the attribute 'value' and corresponding value '11122015'. noCheck: date@value=%.*2015 ... ignores all 'date' tags where the regular expression '.*2015' matches to the value of the attribute 'value'.

Parameters:: originalFile - The original file for comparison.; compareFile - The file for comparing.; noCheck - A comma separated list of tags and attributes, which are excluded for checking, to ignore attributes specifiy tag@attr, or tag@attr=value or tag@attr=%regex-for-value.; stripWhitespace - Whether to strip leading and trailing whitespaces from text nodes before comparing.; xmlNamespace - Whether to process xml namespace definitions. Legal values are 'ignore' (remove all namespaces) or 'normalize' (normalize the namespaces). For all other values, xml namespace definitions are not preprocessed and possible namespaces are interpreted literally.; technology - The technology to use in order to compare the two xml files. Currently either 'sax', 'minidom', or 'auto' can be specified here. While 'sax' is the faster one, 'minidom' supports the additional 'sort=true' parameter. 'auto' means to take the technology which can probably best handle the given situation. Minidom exclusive; sort - Sort the xml trees from both files before checking for identity. SAX exclusive; stopAtFirstDiff - If enabled, only the first difference will be logged in the protocol. The files won't be compared any further which could lead to better runtime, especially while comparing large files. If no difference is found, the parameter will not affect the comparison.; compareComments - Whether the content of comments should be compared. If the parameter is disabled it will only be checked if both files include a comment tag at the same position.
Exceptions:: UserException, - if one of the given files don't exist.
Author:: QFS,mm,ys
Since:: 3.1.1

Procedure: "loadPropertiesFromXML"

Load properties from an XML file. Property names are created from the node hierarchy and separated by a '.' or '.@' respectively (in case of an attribute), for example:

${group:root.first.second}=Text of this node ${group:root.first.@id}=Value of the id attribute

Parameters:: file - The name of the XML file.; group - The name of the properties group.; includeAttributes - Whether to define attributes as variables too.
Author:: QFS
Since:: 3.5, rl

Package: "web"

Web utility procedures.

Author:: QFS
Since:: 2.9.0

Package: "ajax"

Deprecated: Use the "Install CustomWebResolver" step and the procedures from qfs.web.cwr instead.

AJAX procedures.

Author:: QFS
Since:: 3.3.0

	Procedure/Dependency	Description
	dumpCustomWebResolverProperties	Dump properties of an installed CustomWebResolver.
	installCustomWebResolver	Install a generic CustomWebResolver for an Ajax framework.
	installToolkitResolver	Install a special resolver for given AJAX toolkit to improve recorded component types and hierarchy and therefore achieves improved component recognition.
	uninstallCustomWebResolver	Uninstall a previously installed generic CustomWebResolver.
	uninstallToolkitResolver	Uninstall a special resolver for given AJAX toolkit.
	updateCustomWebResolverProperties	Updates properties of an installed generic CustomWebResolver.

Procedure: "dumpCustomWebResolverProperties"

Deprecated: Use qfs.web.cwr.dumpConfiguration instead for a configuration usable by the "Install CustomWebResolver" node.

Dump properties of an installed CustomWebResolver.

Author:: QFS,fs
Since:: 4.0.9

Procedure: "installCustomWebResolver"

Deprecated: Use the "Install CustomWebResolver" step instead.

Install a generic CustomWebResolver for an Ajax framework.

Component recognition is mostly based on determining QF-Test generic class names from CSS classes or other attributes.

Lists below are to be specified as comma separated lists. Regular expressions can be specified by prefixing '%'.

Please find a list of any parameters ordered by their priority. Under normal circumstances you should only use parameters from the sections "REQUIRED PARAMETERS" and "PARAMETERS PRIORITY 1". Any other parameters should be used very carefully.

You can find further information about Generic classes of QF-Test in the manual in chapter "Generic classes". You can also find a chapter how to apply this procedure to your web page, please see chapter "Customizing QF-Test for your AJAX toolkit".

Samples of parameter settings: ============================================================

Sample 1: ================= Name Value resolver custom version genericClasses css-button=Button,css-label=Label

... maps the css classes "css-button" to the generic QF-Test class "Button" and maps the css class "css-label" to the generic class "Label".

Sample 2: ================= Name Value resolver gwt version genericClasses gwtButton=Button,tc=TableCell@::parent=TableRow attributesToGenericClasses id=%.*list=List customIdAttributes qfs-id,qfs-tableid@::ancestor=Table

... extends the GWT resolver and maps every component with css-class 'gwtButton' to QF-Test generic class Button. Then it maps every component with the css-class 'tc' to TableCell but only if its direct parent has the QF-Test class TableRow. Every node having an 'id' attribute matching the regular expression .*list (so everything which ends with list) will be mapped to a QF-Test generic class List. Every node having the attribute 'qfs-id' will get this attribute as 'id' from a QF-Test perspective (used as QF-Test name and for id extra feature of component recognition). Every node having the attribute 'qfs-tableid' will get this attribute as 'id' from a QF-Test perspective, but only if one of the ancestor nodes has the generic class name Table (so only inside Tables).

Special syntaxes: ============================================================ Using regular expressions works with leading %, e.g. %css.*=Button

Using @:: operators (Can be used in all priority 1 parameters): css-button=Button@::ancestor=Table Map button only if one ancestor has the class Table. Script: node.getAncestorOfClass("Table") css-button=Button@::parent=Table Map button only if direct parent has the class Table. Script: node.getParent() css-button=Button@::interestingparent=Table Map button only if the QF-Test parent has the class Table. Script: node.getInterestingParent().

Using exact tag matching (Can be used in all priority 1 parameters): row=TableRow=SPAN Map css class 'row' to a QF-Test TableRow only if the tag itself is a SPAN. row=TableRow=SPAN@::parent=Table Map css class 'row' to a QF-Test TableRow only if the tag itself is a SPAN and if it has a direct of the QF-Test class Table.

myid=%.*=INPUT Can be used for any attribute mappings as well. Here every value of the attribute 'myid' matches, but only if the node itself has the tag INPUT.

Using @:: operators with levels (Can be used in all priority 1 parameters): Those parameters rely on the component structure recorded by QF-Test or the generated DomNode, so they could fail if the web page or your resovler gets changed. You should consider to use the normal @::ancestor operator in that case or map a dedicated parent to a specific parent class which can use with @::parent or @::ancestor again. css-button=Button@::ancestor<3>=Table Map button only if an ancestor within the three parent levels has the class Table. Script: node.getAncestorOfClass("Table", 3) css-button=Button@::parent<3>=Table Map button only if parent at 3rd level has the class Table. Script: node.getNthParent(3). css-button=Button@::interestingparent<3>=Table Map button only if the 3rd level of QF-Test parent has the class Table. Script: node.getInterestingParent(3).

PARAMETERS: ============================================================

******************************** REQUIRED PARAMETERS *********************************************

Parameters:: resolver - The resolver to extend. Either 'custom' or the concrete name, e.g. 'zk' or 'vaadin'.; version - Leave it blank for the latest versions. The resolver version, e.g. 1 or 1.0 or 1.1.1. The latest possible version with the given restriction will be used, e.g. if 1.0 is given, than the latest 1.0.x will apply. If empty, latest available version will be used. Delete or also leave empty when auto detection is used. *********************************************** PARAMETERS PRIORITY 1 *********************************************** Those parameters will make use for most applications.; genericClasses - CSS classes that map to a generic class name, e.g. ui-button=Button,ui-table=Table. (uses node.getAttribute("class")). Can be overridden by attributesToGenericClasses.; attributesToGenericClasses - List of attributes, which should be mapped to generic classes, e.g. id=table=Table,name=%.*combo.*=ComboBox. Assignments from here can override genericClasses values.; tagsToGenericClasses - List of tags which should be mapped to generic classes, e.g. LI=ListItem.; ignoreTags - Class names or tags for which to ignore nodes when creating the parent hierarchy of a node, e.g. DIV,TBODY. In this example only DIV and TBODY nodes that are not mapped to some other class will be ignored.; ignoreByAttributes - List of attributes which should be ignored, e.g. id=container,id=header.; autoIdPatterns - List of patterns, which mark an automated generated ID from your framework. If the "id" attribute matches this criteria, it will be ignored, e.g. myAutoId,%auto.*; customIdAttributes - List of attribute-names which can act as ids for component, e.g. myid,qft-id will use the attributes myid and qft-id in case they are set for ID-resolution.; interestingByAttributes - List of attributes which should be interesting and not ignored, e.g. id=container,id=header.; attributesToQftFeature - List of attributes which will be used for QF-Test feature recognition of components.; documentJS - Javascript code which should be injected to the web page. Can be used to inject custom Javascript functions.; name - A name of the customized CustomWebResolver *********************************************** PARAMETERS PRIORITY 2 *********************************************** Those parameters will just make sense for a few applications. Please just use them only if you have discussed them with the QFS support team.; attributesToQftName - List of attributes, which will be used for QF-Test name recognition of components.; nonTrivialClasses - List of CSS classes of objects, which shouldn't be ignored by QF-Test. Trivial nodes are I, FONT, BOLD etc. if you want to keep them, you need to activate them here specifying a proper CSS class.; redirectClasses - Specify the redirect behavior of events to those nodes, e.g. Button=False no redirection Button=True redirect in any case Button=maybe redirect only if there is no other redirection inside that Button Button=Label=false ... Don't redirect to button objects within labels.; allBrowsersSemihardClasses - List of classes to activate semi-hard events for those classes, e.g. Button for all browsers. Alternative might be setting the global Options.OPT_WEB_SEMI_HARD_EVENTS option to true, which works for all components.; chromeSemihardClasses - List of classes to activate semi-hard events for those classes, e.g. Button for Chrome. Alternative might be setting the global Options.OPT_WEB_SEMI_HARD_EVENTS option to true, which works for all components. Alternative might be setting the global Options.OPT_WEB_SEMI_HARD_EVENTS option to true, which works for all components.; mozSemihardClasses - List of classes to activate semi-hard events for those classes, e.g. Button for Firefox. Alternative might be setting the global Options.OPT_WEB_SEMI_HARD_EVENTS option to true, which works for all components.; edgeSemihardClasses - List of classes to activate semi-hard events for those classes, e.g. Button for Edge. Alternative might be setting the global Options.OPT_WEB_SEMI_HARD_EVENTS option to true, which works for all components.; allBrowsersHardClasses - List of classes to activate hard events for those classes, e.g. Button for all browsers. Alternative might be activating "Replay as hard event" for mouse click nodes.; chromeHardClasses - List of classes to activate hard events for those classes, e.g. Button for Chrome. Alternative might be activating "Replay as hard event" for mouse click nodes. Alternative might be activating "Replay as hard event" for mouse click nodes.; mozHardClasses - List of classes to activate hard events for those classes, e.g. Button for Firefox. Alternative might be activating "Replay as hard event" for mouse click nodes.; edgeHardClasses - List of classes to activate hard events for those classes, e.g. Button for Edge. Alternative might be activating "Replay as hard event" for mouse click nodes.; ignoreStructureClasses - List of classes to record the component without any structure (index and count) information.; ignoreStructureIndexClasses - List of classes to record the component without structure index information.; ignoreStructureCountClasses - List of classes to record the component without any structure count information.; ignoreGeometryClasses - List of classes to record the component without any geometry (height, width, x and y) information.; ignoreLocationClasses - List of classes to record the component without any geometry location (x and y) information.; ignoreSizeClasses - List of classes to record the component without any geometry size (height, width) information.; keepStructureClasses - List of classes to record the component with structure information (index and count). Useful to override default settings.; keepStructureIndexClasses - List of classes to record the component with structure index. Useful to override default settings.; keepStructureCountClasses - List of classes to record the component with structure count. Useful to override default settings.; keepGeometryClasses - List of classes to record the component with geometry information (height, width, x and y). Useful to override default settings.; keepLocationClasses - List of classes to record the component with geometry location (x and y). Useful to override default settings.; keepSizeClasses - List of classes to record the component with geometry size (height, width). Useful to override default settings.; menuItemClasses - List of classes which act as MenuItems.; busyPaneBreakerClasses - List of classes which shouldn't be blocked by BusyPane objects.; ignoreTextClasses - List of classes which shouldn't be taken into account if a text is retrieved from a node. *********************************************** PARAMETERS PRIORITY 3 *********************************************** Those parameters are pure experts parameters, which should only be use in rare use cases. If you use them, you should have discussed them with the QFS support team.; volatileClasses - List of classes which have an not stabile way of recording all mouse events to the same node. Need to be set if mouse events are recorded in four nodes instead of one Mouse click event.; abstractCoordinatesClasses - List of classes which don't get mouse coordinates recorded for mouse click events. Recording only.; mozCorrectMouseClasses - List of classes to fix some recorded coordinates for Firefox.; chromeCorrectMouseClasses - List of classes to fix some recorded coordinates for Chrome.; abstractedCoordinatesRedirectClasses - List of classes which gets a dedicated target, if no mouse events are specified. Replay only. E.g. CheckBox=INPUT:CHECKBOX redirect any click without coordinates at Checkbox to underlying INPUT:CHECKBOX.; keepMovedClasses - List of classes to keep MOUSE_MOVED events.; missingReleaseClasses - List of classes for components, where the release events are missing during recording. Recording only.; cursorPositionAsItemClasses - List of classes for components, which shouldn't record the subitems for content.; ignoreTextSameGenericClassnameClasses - List of classes which shouldn't be taken into account if nodes of those classes have the same nodes as nested content. *********************************************** PARAMETERS PRIORITY 4 *********************************************** Those parameters impact the way how the internal mechanism works. There is no relation to classes or tags. They just influence internal behavior.; logMode - Default true, everything is written into the DiagnosticLog. If false nothing will be written to DiagnosticLog.; textRedirect - If true, then text events and checks will be recorded on redirected TextField and TextArea nodes. (Default) If false, every text event and text check will be redirected to the real INPUT:TEXT or TEXTAREA nodes.; timeout - Timeout in ms which will be waited after every node change.; insertClassesFront - If true, new class mappings will be put to the beginning of the classes list. If false (default) no mappings will be added to the end of the classes list.; excludeHiddenTableItems - If true hidden table items will be taken into account. Otherwise (default) they will be ignored.; excludeHiddenListItems - If true hidden list items will be taken into account. If false (default) they will be ignored.; excludeHiddenTreeNodes - If true (default) hidden tree nodes will be taken into account. If false they will be ignored.; unregisterDefaultTableResolver - If true the default table recognition will be disabled. Very dangerous to disable.; unregisterDefaultGenericClassNameResolver - If true the default generic class name recognition will be disabled. Very dangerous to disable. *********************************************** DEPRECATED PARAMETERS *********************************************** You should replace those parameters with genericClasses, ignoreByAttributes, attributestoGenericClasses etc.; goodCssClasses - CSS classes that make a good class name. They will become a Class for QF-Test component.; ignoreCssClasses - CSS classes that should be ignored. Those css classes won't be used for Qf-Test classes coming from goodCSSClasses.; badCssClasses - CSS classes that should not get a class name. Nodes having this css class somewhere won't get any QF-Test class name.; remapClasses - List of from:to pairs to remap one class to another class, e.g. table-row-odd:table-row; preferredCssClasses - CSS classes that should be preferred, if multiple CSS classes are defined.
Exceptions:: UserException - If no resolver was found or installed.
Author:: QFS,fs
Since:: 3.5.3

Procedure: "installToolkitResolver"

Deprecated: Use qfs.web.ajax.installCustomWebResolver instead.

Install a special resolver for given AJAX toolkit to improve recorded component types and hierarchy and therefore achieves improved component recognition.

Parameters:: toolkit - The AJAX toolkit. Currently supported are autodetect, extjs, extgwt, gwt, icefaces, jeasyui, jqueryui, primefaces, qooxdoo, rap, richfaces, vaadin and zk.; resolver_version - The resolver version, e.g. 1 or 1.0 or 1.1.1. The latest possible version with the given restriction will be used, e.g. if 1.0 is given, than the latest 1.0.x will apply. If empty, latest available version will be used. Delete or also leave empty when auto detection is used.; nofallback - Optional parameter for toolkits with different resolver versions. If nofallback is true, QF-Test will not try to determine the best version but use the version specified.; auto_extjs_version - The resolver version for extjs to be used by the autodetector. Typically automatically set by the Quickstart Wizard.; auto_extgwt_version - The resolver version for extgwt to be used by the autodetector. Typically automatically set by the Quickstart Wizard.; auto_gwt_version - The resolver version for gwt to be used by the autodetector. Typically automatically set by the Quickstart Wizard.; auto_icefaces_version - The resolver version for icefaces to be used by the autodetector. Typically automatically set by the Quickstart Wizard.; auto_jqueryui_version - The resolver version for jquery to be used by the autodetector. Typically automatically set by the Quickstart Wizard.; auto_kendoui_version - The resolver version for kendoui to be used by the autodetector. Typically automatically set by the Quickstart Wizard.; auto_primefaces_version - The resolver version for primefaces to be used by the autodetector. Typically automatically set by the Quickstart Wizard.; auto_qooxdoo_version - The resolver version for qooxdoo to be used by the autodetector. Typically automatically set by the Quickstart Wizard.; auto_rap_version - The resolver version for rap < 2.0 to be used by the autodetector. Typically automatically set by the Quickstart Wizard.; auto_rap2_version - The resolver version for rap >= 2.0 to be used by the autodetector. Typically automatically set by the Quickstart Wizard.; auto_richfaces_version - The resolver version for richfaces to be used by the autodetector. Typically automatically set by the Quickstart Wizard.; auto_vaadin_version - The resolver version for vaadin to be used by the autodetector. Typically automatically set by the Quickstart Wizard.; auto_zk_version - The resolver version for zk to be used by the autodetector. Typically automatically set by the Quickstart Wizard.
Author:: QFS,kk
Since:: 3.3.0

Procedure: "uninstallCustomWebResolver"

Deprecated: Use qfs.web.cwr.uninstall instead.

Uninstall a previously installed generic CustomWebResolver.

Author:: QFS,fs
Since:: 3.5.3

Procedure: "uninstallToolkitResolver"

Deprecated: Use qfs.web.ajax.uninstallCustomWebResolver instead.

Uninstall a special resolver for given AJAX toolkit.

Parameters:: toolkit - The AJAX toolkit. Currently supported are autodetect, extjs, extgwt, gwt, icefaces, jeasyui,jqueryui, primefaces, qooxdoo, rap, richfaces, vaadin and zk.
Author:: QFS,mm
Since:: 3.5.0

Procedure: "updateCustomWebResolverProperties"

Deprecated: Use the "Install CustomWebResolver" step instead.

Updates properties of an installed generic CustomWebResolver.

Parameters:: excludeHiddenItem - Flag to check for all or only visible elements in list of table items. e.g. List=false,Accordion=false,Table=true; eventSync - EventSynchronizer e.g. duration=10000,sleepTime=99,initialSleepTime=10 sleepTime -> Sleep time, if page is busy. initialSleepTime -> Initial sleep time before calling the first check. duration -> Duration time how long it should be checked.; treeResolver - Tree and TreeTable resolver e.g. nodeTolerance=10, postExpansionDelay=100, customExpanderClickPositon=x5ydefault, autoExpansionClick=semihard, treeTextNodeRetrieval=default, treeCalculationMode=treeCalculatedHierarchy, nodeTolerance -> Tolerance for depth comparison of nodes. Normally all nodes should be on the same x level, but in some cases a selected node could be moved by one or two pixels. In this case that value can be set to be more flexible. postExpansionDelay -> Sleep time for waiting after tree node expanding. customExpanderClickPositon -> Custom Expander x and y click position. Key word default clicks in the middle. autoExpansionClick -> The mode of the tree node auto expand click event. (hard,semihard) treeTextNodeRetrieval -> Mode for text node retrieval. Uses as default the text node with the longest text. Key word default uses always the first text node. (default,treeLongestText) treeCalculationMode -> Mode for calculating TreeNode elements. Key word treeCalculatedHierarchy counts the parent elements of the hierarchical structure. (treeCalculatedLocation,treeCalculatedHierarchy); treetableResolver - TreeTable resolver e.g. treetableCustomColumn=1, treetableCustomColumn -> Custom column index to use for the TreeTable. Uses as default the first column with the index 0.
Author:: QFS,fs
Since:: 4

Package: "browser"

Browser procedures.

Author:: QFS
Since:: 2.9.0

Package: "dialogs"

Procedures for handling error dialogs opened within the browser.

Author:: QFS,tm
Since:: 2.9.1

	Procedure/Dependency	Description
	closeCertificateWarning	Uses the Java AWT Robot/Autowin Methods to automatically close an open Certificate Warning Dialog.
	closeJavascriptWarning	Uses the Java AWT Robot Methods to automatically close an open Javascript Warning Dialog.
	upload	Handle the native Windows Upload dialog (especially for Internet Explorer 8).

Procedure: "closeCertificateWarning"

Deprecated: Is handled by the browser engine internally.

Uses the Java AWT Robot/Autowin Methods to automatically close an open Certificate Warning Dialog.

Parameters:: browser - - The browser.; button- - The title of the button to click.; timeout - with default 30000 - The timeout to wait for the dialog.; title - with default .*ertificate.*|Sicherheitshinweis|Security.* - The title of the dialog.
Author:: QFS,tm
Since:: 2.9.1

Procedure: "closeJavascriptWarning"

Deprecated: Is handled by the browser engine internally.

Uses the Java AWT Robot Methods to automatically close an open Javascript Warning Dialog.

Author:: QFS,tm
Since:: 2.9.1

Procedure: "upload"

Deprecated: Please use qfs.web.input.fileUpload instead.

Handle the native Windows Upload dialog (especially for Internet Explorer 8).

Parameters:: filename - The name of the file to be uploaded.; title - A regexp for the title of the dialog.; button - A regexp for the text on the open button.
Author:: QFS
Since:: 3.2

Package: "dom"

Procedures for handling DOM access.

Author:: QFS,tm
Since:: 2.9.1

	Procedure/Dependency	Description
	selectAllCheckboxes	Check or uncheck all (enabled) checkboxes which are situated in the DOM tree beneath the given parent.

Procedure: "selectAllCheckboxes"

Deprecated: Use qfs.web.checkbox.setAll instead.

Check or uncheck all (enabled) checkboxes which are situated in the DOM tree beneath the given parent. In most of the cases the parent should be set to the form rlement which contains the checkboxes.

Parameters:: parent - The parent Element.; select - If set to false, all Checkboxes are unchecked.
Author:: QFS,tm
Since:: 2.9.1

Package: "download"

Procedures to handle downloads in QF-Test.

Author:: QFS,mm
Since:: 4.1.0

	Procedure/Dependency	Description
	setDownloadProperty	Set the QF-Test download property.

Procedure: "setDownloadProperty"

Set the QF-Test download property.

Parameters:: downloadproperty - 0 is default, 1 could fix most problems 2 in rare use cases.
Author:: QFS, mm
Since:: 4.1.0

Package: "external"

This package contains methods to interrupt a browser-open call from a java application.

Author:: QFS
Since:: 5.2.0

	Procedure/Dependency	Description
	prepareForBrowserOpen	Call this procedure before triggering an action that opens an external browser and before calling "waitForBrowser".
	stopInterceptingBrowserOpen	Call this procedure to restore the normal behavior before a call to "prepareForBrowserOpen"
	waitForBrowserOpen	Checks, if after "prepareForBrowserOpen" a call for opening an external browser has been intercepted and checks the intercepted url and/or starts a defined procedure.

Procedure: "prepareForBrowserOpen"

Call this procedure before triggering an action that opens an external browser and before calling "waitForBrowser".

This procedure installs an notification observer in Java and Electron apps, which prevents an external browser from opening and stores the url instead.

Parameters:: client - The client for which browser calls should be intercepted.; interceptProcessCalls - If "true" all external processes opened by the SUT are checked and treated as a browser call, as soon as their arguments contain a URL starting with http://, https:// or file://
Author:: QFS,pb
Since:: 5.2

Procedure: "stopInterceptingBrowserOpen"

Call this procedure to restore the normal behavior before a call to "prepareForBrowserOpen"

Parameters:: client - The client for which browser calls have been intercepted.
Author:: QFS,pb
Since:: 5.2

Procedure: "waitForBrowserOpen"

Checks, if after "prepareForBrowserOpen" a call for opening an external browser has been intercepted and checks the intercepted url and/or starts a defined procedure. Returns the url of the browser open call.

Parameters:: client - The client for which browser calls were intercepted.; checkUrl - The expected url which should have been opened (option); isRegex - If "true", checkUrl will be interpreted as regular expression.; callProcedure - If set, the given procedure is called with "url" as argument.; timeout - The maximal waiting timeout (in ms).; polling - The interval in milliseconds in which to poll for the interception.; dologerror - Log an error instead of throwing an exception.
Exceptions:: Exception - If dologerror==false and no call was intercepted once timeout exceeded.
Author:: QFS,pb
Since:: 5.2

Package: "observers"

Helper procedures to register and unregister method call interceptors to detect browser opening in tested applications.

Author:: QFS,pb
Since:: 5.2

	Procedure/Dependency	Description
	catchBrowserOpen	Registers a notification observer which intercepts external browser opening and stores the corresponding url.
	catchFileOpen	Registers a notification observer which intercepts external process launches.
	catchProcessOpen	Registers a notification observer which intercepts external process launches.
	uncatchBrowserOpen	Unregisters the a notification observer previously registered with catchBrowserOpen
	uncatchFileOpen	Unregisters the a notification observer previously registered with catchProcessOpen
	uncatchProcessOpen	Unregisters the a notification observer previously registered with catchProcessOpen

Procedure: "catchBrowserOpen"

Registers a notification observer which intercepts external browser opening and stores the corresponding url.

Parameters:: client - The client in which the observer is registered.
Author:: QFS,pb
Since:: 5.2

Procedure: "catchFileOpen"

Registers a notification observer which intercepts external process launches. If the process arguments contain a web link, the process call is treated as browser open call.

Parameters:: client - The client in which the observer is registered.
Author:: QFS,pb
Since:: 5.2

Procedure: "catchProcessOpen"

Registers a notification observer which intercepts external process launches. If the process arguments contain a web link, the process call is treated as browser open call.

Parameters:: client - The client in which the observer is registered.
Author:: QFS,pb
Since:: 5.2

Procedure: "uncatchBrowserOpen"

Unregisters the a notification observer previously registered with catchBrowserOpen

Parameters:: client - The client in which the observer is unregistered.
Author:: QFS,pb
Since:: 5.2

Procedure: "uncatchFileOpen"

Unregisters the a notification observer previously registered with catchProcessOpen

Parameters:: client - The client in which the observer is unregistered.
Author:: QFS,pb
Since:: 5.2

Procedure: "uncatchProcessOpen"

Unregisters the a notification observer previously registered with catchProcessOpen

Parameters:: client - The client in which the observer is unregistered.
Author:: QFS,pb
Since:: 5.2

Package: "general"

General browser procedures.

Author:: QFS
Since:: 2.9.0

	Procedure/Dependency	Description
	checkForRunningBrowserEngine	Check for the browser and if is not running than start it.
	getBestBrowser	Tries to detect the best browser type for the current system and returns its browser name.
	openMobileEmulation	Opens a new browser window which emulates a mobile browser.
	openNewWindow	Open a new window in an already running browser.
	showUrl	Show a different URL in an open browser window.
	startAsNewProcess	Ensures the given browser executable is started as a new process.

Procedure: "checkForRunningBrowserEngine"

Check for the browser and if is not running than start it.

Parameters:: client - The client.; browser - The browser.; mozhome - The Mozilla installation directory (optional).; mozprofile - The directory to store the profile data (optional).; startBrowserIfNotRunning - If true, the browser will be started, default is false not to start the browser. (optional).
Author:: QFS,tm
Since:: 2.9.0

Procedure: "getBestBrowser"

Tries to detect the best browser type for the current system and returns its browser name.

Parameters:: browserDir - Directory where to find the browser in (optional).; connectionMode - Connection mode for the browser (optional).; throwException - If true, a TestException is thrown if no browser could be found.
Author:: QFS,pb
Since:: 6.0.0

Procedure: "openMobileEmulation"

Opens a new browser window which emulates a mobile browser. If the web engine is not started yet, or is using Chrome or headless Chrome and a WebDriver connection, the mobile emulation mode of Chrome is used. Otherwise, the selected browser is started with the mobile userAgent and screen size set to mimic a mobile browser. If already a browser window was opened in the web engine, the web engine is closed, first.

Valid parameters for "deviceName" are: "iPhone 4", "iPhone 5/SE", "iPhone 5", "iPhone SE", "iPhone 6/7/8", "iPhone 6", "iPhone 7", "iPhone 8", "iPhone 6/7/8 Plus", "iPhone 6 Plus", "iPhone 7 Plus", "iPhone 8 Plus", "iPhone X", "iPhone SE 2nd/3rd Gen", "iPhone SE 2nd Gen", "iPhone SE 3rd Gen", "iPhone XR", "iPhone Xs Max", "iPhone Xs", "iPhone 11", "iPhone 11 Pro", "iPhone 11 Pro Max", "iPhone 12/13/14", "iPhone 12", "iPhone 13", "iPhone 14", "iPhone 12/13 Pro", "iPhone 12 Pro", "iPhone 13 Pro", "iPhone 12/13 Pro Max", "iPhone 12 Pro Max", "iPhone 13 Pro Max", "iPhone 12/13 mini", "iPhone 12 mini", "iPhone 13 mini", "iPhone 14 plus", "iPhone 14 Pro", "iPhone 14 Pro Max", "iPhone 15", "iPhone 15 plus", "iPhone 15 Pro", "iPhone 15 Pro Max", "BlackBerry Z30", "Nexus 4", "Nexus 5", "Nexus 5X", "Nexus 6", "Nexus 6P", "Pixel 2", "Pixel 2 XL", "Pixel 3", "Pixel 3 XL", "Pixel 4", "Pixel 4 XL", "Pixel 5", "LG Optimus L70", "Nokia N9", "Nokia Lumia 520", "Microsoft Lumia 550", "Microsoft Lumia 950", "Galaxy S III", "Galaxy S5", "Galaxy S7", "Galaxy S8", "Galaxy S8+", "Samsung Galaxy S20 Ultra", "Galaxy S9", "Galaxy S9+", "Galaxy Note 9", "Samsung Galaxy S10", "Samsung Galaxy S10+", "Samsung Galaxy S10e", "Samsung Galaxy A20", "Samsung Galaxy A51/71", "Samsung Galaxy A51", "Samsung Galaxy 71", "Samsung Galaxy Note 10", "Samsung Galaxy Note 10+", "Palm PVG100", "JioPhone 2", "Kindle Fire HDX", "iPad Mini", "iPad Mini (8.3″)", "iPad", "iPad (10.2″)", "iPad (10.9″)", "iPad Air", "iPad Air (10.5″)", "iPad Air (10.9″)", "iPad Pro", "iPad Pro (10.5″)", "iPad Pro (11″)", "iPad Pro (12.9″)", "Blackberry PlayBook", "Nexus 10", "Nexus 7", "Red Hydrogen One", "Surface Pro 7", "Surface Duo", "Galaxy Note 3", "Galaxy Note II", "Galaxy Tab S3", "Samsung Galaxy Tab S4", "Galaxy Note 8", "Galaxy Fold", "Galaxy A51/71", "Galaxy A51", "Galaxy 71", "Nest Hub Max", "Nest Hub", "Laptop with touch", "Laptop with HiDPI screen", "Laptop with MDPI screen", "Moto G4", "Moto G Power", "Custom"

Parameters:: client - The client name.; url - The URL to open in the mobile emulation.; windowname - The name of the new window. (optional); deviceName - A valid device name to use for extracting the mobile device parameters; orientation - If "deviceName" is used, options are "vertical" and "horizontal". (optional); insets - If "deviceName" is used, can be set to "True" to reduce the visible area by the default browser insets of the device, or to the title of a device specific presentation mode (e.g. "keyboard") to select the insets of this mode, or to an int array like "10,10,10,10". "False" or empty represent the fullscreen browser. (optional); x - X-Coordinate for the browser window. (optional); y - Y-Coordinate for the browser window. (optional); width - Width of the emulated device. (optional, if deviceName is not set); height - Height of the emulated device. (optional, if deviceName is not set); userAgent - The user agent to use. (optional, if deviceName is not set); pixelRatio - The pixelRatio to emulate. (optional, if deviceName is not set)
Author:: QFS,pb
Since:: 4.2.1

Procedure: "openNewWindow"

Open a new window in an already running browser.

Parameters:: client - The client.; browser - The type of Browser (ie, mozilla).; url - The URL to open in the new window.; windowname - The name of the new window. (optional); x - X-Coordinate for the browser window. (optional); y - Y-Coordinate for the browser window. (optional); width - Width for the browser window. (optional); height - Height for the browser window. (optional)
Author:: QFS,tm
Since:: 2.9.1

Procedure: "showUrl"

Show a different URL in an open browser window.

Parameters:: client - The client.; url - The URL to show.
Author:: QFS,tm
Since:: 2.9.1

Procedure: "startAsNewProcess"

Ensures the given browser executable is started as a new process. This is especially important when testing an applet in the browser. Otherwise the applet is not properly recognized by QF-Test.

Firefox and Chrome need to be started with a separate profile in order to not block. Those profiles get created within the .qftest directory below the users home directory. For firefox options are set by creating a user.js in the profile directory to avoid blocking dialogs like checking for default browser, checking for updates etc. Safari neither offers a command line option nor supports profiles. Therefore in case there are already running instances those will be terminated. In interactive mode a dialog asks for permission to do so, in batch mode it's simply done.

Parameters:: client - The client.; executable - The browser executable. Possibly the full path is necessary.; browsertype - The browser type that needs special handling: 'firefox' for Firefox, 'chrome' for Google Chrome, 'safari' for Apple Safari, 'no' for no special handling.; args - Optional browser arguments. For Google chrome the following args may become helpful to avoid blocking after update or on new available java plugins: --always-authorize-plugins --allow-outdated-plugins; url - The URL of (typically) the applet.; waitForClientTimeout - Time in ms to wait for the client to connect. Default is 120000.; profileTemplateDir - Firefox only: Directory containing firefox profile data to be used. The template directory is copied to a temporary location before being used. If not specified an empty profile is used, which is also the default.; threadDelay - When executing applet tests on multiple threads, a delay can be necessary between the single browser starts to avoid java plugin connection get's confused.; syncStart - Synchronize multiple threads after browser start.; dialogTimeout - Timeout value in ms for the dialog in interactive mode. When timeout is reached, test continues with terminating the processes. -1 means infinite waiting time.
Author:: QFS,kk
Since:: 3.4

Package: "mozilla"

Mozilla utility procedures.

Author:: QFS
Since:: 2.9.0

	Procedure/Dependency	Description
	cleanupProfileDir	Performs several cleanup actions on the given mozProfile directory.

Procedure: "cleanupProfileDir"

Performs several cleanup actions on the given mozProfile directory. If no directory is given the default directory (user.home)/.qftest/mozProfile is used.

Parameters:: mozprofile - The Mozilla profile directory.
Author:: QFS,tm
Since:: 4.0.0

Package: "settings"

The procedures in this package are useful for customizing browser settings.

Author:: QFS
Since:: 2.9.0

	Procedure/Dependency	Description
	deleteCookies	Delete cookies.
	disableCookies	Disable cookies in the browser.
	doStartupSettings	Do startup settings for the browser.
	emptyCache	Empty the browser cache.
	enableCookies	Enable cookies in the browser.
	enableMutationListeners	Enable/Disable MutationListeners in the QF-Test browser engine for a specific document or globally for all documents.
	setDirectDownload	Whether show download dialog at download (empty downloadsDir) or to download a file directly in provided directory.
	setLocale	Set preferred language for in the displaying web pages in the browser.
	setProxy	Set a proxy server for the browser.
	setTerminalLogs	Whether to pass on browser console logs to QF-Test terminal
	setUserAgent	Set user agent for the browser.

Procedure: "deleteCookies"

Delete cookies.

Parameters:: client - The name of the SUT client.; browser - The browser.; mozhome - The Mozilla installation directory (optional).; startBrowserIfNotRunning - If true, the browser will be started, default is false not to start the browser. (optional).
Author:: QFS,tm
Since:: 2.9.0

Procedure: "disableCookies"

Disable cookies in the browser.

Parameters:: client - The name of the SUT client.; browser - The browser.; mozhome - The Mozilla installation directory (optional).; startBrowserIfNotRunning - If true, the browser will be started, default is false not to start the browser. (optional).
Author:: QFS,tm
Since:: 2.9.0

Procedure: "doStartupSettings"

Do startup settings for the browser. This procedure is used by the Quickstart Wizard.

Parameters:: client - The name of the SUT client.; browser - The browser.; mozhome - The Mozilla installation directory (optional).; mozprofile - The folder to store the profile-data(optional). original browser mode. With modes not ending with doc, all webpages are displayed just in this mode regardless of the !DOCTYPE directive.; emptyCache - true, to enable caching.; enableCookies - true, to allow cookies.; deleteCookies - true, to delete stored cookies.; locale - The locale to be used.; enableProxy - true to enable proxy settings; proxyAddress - Optional address for a proxy server.; proxyPort - Optional port for a proxy server.; enableProxyBypass - true to overwrite system proxy bypass settings when proxy is enabled.; proxyBypass - Optional list of URLs to exclude from Proxy. Use ',' as separator.; proxyAutoconfigurl - URL to get the proxy configuration from.; proxyType - Type of proxy (is empty by default; set regardless of activate). If empty, the proxy type is determined by address and autoconfigurl parameters. For details, see comments on setProxy procedure; consoleOutputValue - 0, to forward no logs from browser console to QF-Test terminal; 1, to forward logs; 2, to forward logs with timestamp; 3, to forward logs with log level; 4, to forward logs with timestamp and log level; 5, to forward logs with timestamp, log level and multiline description (option 5 is available for CDP-Driver only); parameter is optional, default value is 0.; userAgentValue - The user agent to be used (not empty value, to override user agent).; directDownloadsDir - Add a path here if you want to have files directly downloaded to this directory and avoid download dialogs. If the parameter left empty, you will need to choose download path via dialog as usual. (The parameter is evaluated in CDP-Driver mode only.); startBrowserIfNotRunning - If true, the browser will be started, default is false not to start the browser. (optional).
Author:: QFS,tm
Since:: 2.9.0

Procedure: "emptyCache"

Empty the browser cache.

Parameters:: client - The name of the SUT client.; browser - The browser.; mozhome - The Mozilla installation directory (optional).; startBrowserIfNotRunning - If true, the browser will be started, default is false not to start the browser. (optional).
Author:: QFS,tm
Since:: 2.9.0

Procedure: "enableCookies"

Enable cookies in the browser.

Parameters:: client - The name of the SUT client.; browser - The browser.; mozhome - The Mozilla installation directory (optional).; startBrowserIfNotRunning - If true, the browser will be started, default is false not to start the browser. (optional).
Author:: QFS,tm
Since:: 2.9.0

Procedure: "enableMutationListeners"

Enable/Disable MutationListeners in the QF-Test browser engine for a specific document or globally for all documents.

Parameters:: client - The name of the SUT client.; browser - The browser.; mozhome - The Mozilla installation directory (optional).; documentId - If empty or not present, enable/disable works globally for all document. Otherwise for the documentId given; enable - enable/disable MutationListener; forceRescanOnEnable - force a DOM rescan after enabling the Mutation Listener; startBrowserIfNotRunning - If true, the browser will be started, default is false not to start the browser. (optional).
Author:: QFS,tm
Since:: 3.4.0.

Procedure: "setDirectDownload"

Whether show download dialog at download (empty downloadsDir) or to download a file directly in provided directory. The procedure is evaluated in CDP-Driver mode only.

Parameters:: downloadsDir - The path to save downloaded file (no direct download if empty); client - The name of the SUT client.; browser - The browser.; mozhome - The Mozilla installation directory (optional).; startBrowserIfNotRunning - If true, the browser will be started, default is false not to start the browser. (optional).
Author:: QFS
Since:: 5.3.0

Procedure: "setLocale"

Set preferred language for in the displaying web pages in the browser.

Parameters:: client - The name of the SUT client.; browser - The browser.; mozhome - The Mozilla installation directory (optional).; locale - The locale, i.e. en for english, en-us for english/United States.; startBrowserIfNotRunning - If true, the browser will be started, default is false not to start the browser. (optional).
Author:: QFS,tm
Since:: 2.9.0

Procedure: "setProxy"

Set a proxy server for the browser.

Parameters:: client - The name of the SUT client.; browser - The browser.; mozhome - The Mozilla installation directory (optional).; address - The address of the proxy server (only set if activate=1).; port - The port of the proxy server (only set if activate=1).; enableProxyBypass - true to overwrite system proxy bypass settings, false to ignore the parameter.; bypass - List of URLs to exclude from proxy. Use ',' as separator. (only set if activate=1 and enableProxyBypass=true); activate - 1 to activate the parameters address, port, bypass and autoconfigurl, 0 to use a direct connection (no proxy).; autoconfigurl - URL to get the proxy configuration from.; type - Type of proxy (is empty by default; set regardless of activate value). If empty, the type is determined by address and autoconfigurl parameters. Optional values to override the default behavior: proxy off (use direct connection) = 0 ; proxy on = 1; use autoconfig proxy url = 2; auto detect proxy = 4; use system proxy settings = 5;; startBrowserIfNotRunning - If true, the browser will be started, default is false not to start the browser. (optional).
Author:: QFS,tm
Since:: 3.0.1

Procedure: "setTerminalLogs"

Whether to pass on browser console logs to QF-Test terminal

Parameters:: consoleOutputValue - 0, to forward no logs from browser console to QF-Test terminal; 1, to forward logs; 2, to forward logs with timestamp, 3, to forward logs with log level; 4, to forward logs with timestamp and log level; 5, to forward logs with timestamp, log level and multiline description (option 5 is available for CDP-Driver only).; client - The name of the SUT client.; browser - The browser.; mozhome - The Mozilla installation directory (optional).; startBrowserIfNotRunning - If true, the browser will be started, default is false not to start the browser. (optional).
Author:: QFS
Since:: 5.3.0

Procedure: "setUserAgent"

Set user agent for the browser.

Parameters:: userAgentValue - The new value for user agent.; client - The name of the SUT client.; browser - The browser.; mozhome - The Mozilla installation directory (optional).; startBrowserIfNotRunning - If true, the browser will be started, default is false not to start the browser. (optional).
Author:: QFS
Since:: 5.3.0

Package: "checkbox"

Procedures to set the state of checkboxes. (Web component INPUT:CHECKBOX)

Author:: QFS
Since:: 3.0

	Procedure/Dependency	Description
	deselect	Deselect a checkbox.
	deselectWithCoordinates	Deselect a checkbox If the checkbox is already deselected, no action is performed.
	getValue	Return the value of a checkbox.
	select	Select a checkbox.
	selectWithCoordinates	Select a checkbox.
	set	Set checkbox to the given state.
	setAll	Set all (enabled) checkboxes inside a given parent.
	setWithCoordinates	Set checkbox to the given state.

Procedure: "deselect"

Deselect a checkbox. If the checkbox is already deselected, no action is performed.

Parameters:: client - The name of the SUT client.; id - The id of the checkbox.
Author:: QFS,tm
Since:: 3.0

Procedure: "deselectWithCoordinates"

Deselect a checkbox If the checkbox is already deselected, no action is performed. You can specify the coordinates for clicking.

Parameters:: client - The name of the SUT client.; id - The id of the checkbox.; x - The x coordinate for the click, default is empty to click in the middle.; y - The y coordinate for the click, default is empty to click in the middle.
Author:: QFS,mm
Since:: 4.0

Procedure: "getValue"

Return the value of a checkbox. It's either 1, if box is selected or 0, if box is not selected.

Parameters:: id - ID of the checkbox.
Returns:: The state of the checkbox.
Author:: QFS,mm
Since:: 3.5.0

Procedure: "select"

Select a checkbox. If the checkbox is already selected, no action is performed.

Parameters:: client - The name of the SUT client.; id - The id of the checkbox.
Author:: QFS,tm
Since:: 3.0

Procedure: "selectWithCoordinates"

Select a checkbox. If the checkbox is already selected, no action is performed. You can specify the coordinates for clicking.

Parameters:: client - The name of the SUT client.; id - The id of the checkbox.; x - The x coordinate for the click, default is empty to click in the middle.; y - The y coordinate for the click, default is empty to click in the middle.
Author:: QFS,mm
Since:: 4.0

Procedure: "set"

Set checkbox to the given state.

Parameters:: client - The name of the SUT client.; id - The id of the checkbox.; check - The check value to be set (either true or false).
Author:: QFS,tm
Since:: 3.0

Procedure: "setAll"

Set all (enabled) checkboxes inside a given parent. In most of the cases the parent should be set to the form element which contains the checkboxes.

Parameters:: parent - The parent element.; check - The check value to be set (either true or false).
Author:: QFS,kk
Since:: 3.1.1

Procedure: "setWithCoordinates"

Set checkbox to the given state. You can specify the coordinates for clicking.

Parameters:: client - The name of the SUT client.; id - The id of the checkbox.; check - The check value to be set (either true or false).; x - The x coordinate for the click, default is empty to click in the middle.; y - The y coordinate for the click, default is empty to click in the middle.
Author:: QFS,mm
Since:: 4.0

Package: "checks"

Procedures for handling different web checks.

Author:: QFS,tm
Since:: 2.9.1

	Procedure/Dependency	Description
	checkAttribute	Checks an attribute of a component.
	checkElements(negative)	Negates a normal Elementcheck in select elements to allow NegationChecks.
	checkForElement	Checks if the given element (option-element-text) is in the select-element (combobox).
	checkInvisibility	Negates a normal WaitForComponentCheck to allow VisibilityChecks.
	checkText(negative)	Negates a normal Textcheck to allow NegationChecks.
	checkTitle	Checks the title of the BrowserWindow.

Procedure: "checkAttribute"

Checks an attribute of a component.

It writes an error into the run log, if the check fails.

Parameters:: id - The id of the component.; attribute - The attribute to check.; value - The expected value.; appearInReport - Flag, whether to show check in report, if a message or warning are set as errorLevel. If this is set to 1, the check will be shown in the report.
Author:: QFS,tm
Since:: 2.9.1

Procedure: "checkElements(negative)"

Negates a normal Elementcheck in select elements to allow NegationChecks.

It writes an error into the run log, if the check fails.

Parameters:: id - The id of the component.; value - The value that should "NOT" be the Text of one element the Component.
Author:: QFS,tm
Since:: 2.9.1

Procedure: "checkForElement"

Checks if the given element (option-element-text) is in the select-element (combobox).

It writes an error into the run log, if the element is not found.

Parameters:: id - The id of the select-element.; element - The Option-Element-Text.
Author:: QFS,tm
Since:: 2.9.1

Procedure: "checkInvisibility"

Negates a normal WaitForComponentCheck to allow VisibilityChecks.

It writes an error into the run log, if the check fails.

Parameters:: id - The id of the component.
Author:: QFS,tm
Since:: 2.9.1

Procedure: "checkText(negative)"

Negates a normal Textcheck to allow NegationChecks.

It writes an error into the run log, if the check fails.

Parameters:: id - The id of the component.; value - The value that should "NOT" be the Text of the Component.; reportName - the Name for the check in the report.
Author:: QFS,tm
Since:: 2.9.1

Procedure: "checkTitle"

Checks the title of the BrowserWindow.

It writes an error into the run log, if the check fails.

Parameters:: title - Title, which should be checked.; reportName - the Name for the check in the report.
Author:: QFS,tm
Since:: 2.9.1

Package: "style"

Procedures for handling different element style checks.

Author:: QFS,tm
Since:: 3.5.

	Procedure/Dependency	Description
	checkStyleAttribute	Checks a specific style attribute for the given component.
	getStyleAttributeThroughJS	Returns the value of a specific style attribute of the given component.

Procedure: "checkStyleAttribute"

Checks a specific style attribute for the given component.

It writes an error into the run log, if the check fails.

Parameters:: browser - The type of Browser (ie, mozilla).; id - The id of the component.; attribute - The attribute which should be checked.; value - The attribute value to check for.
Author:: QFS,tm
Since:: 3.5.

Procedure: "getStyleAttributeThroughJS"

Returns the value of a specific style attribute of the given component.

Parameters:: browser - The type of Browser (ie, mozilla).; id - The id of the component.; attribute - The style attribute to check for.
Returns:: The value of the style attribute. Returns "undefined" if the style attribute not exists.
Author:: QFS,tm
Since:: 3.5.

Package: "color"

Procedures for handling different element style checks concerning color attributes.

Author:: QFS,tm
Since:: 3.5.

	Procedure/Dependency	Description
	checkBackgroundColor	Checks the value that indicates the color behind the content of the component.
	checkColor	Checks the value that indicates the color of the text of the component.

Procedure: "checkBackgroundColor"

Checks the value that indicates the color behind the content of the component.

It writes an error into the run log, if the check fails.

Parameters:: id - The id of the component.; value - The background color to check for.
Author:: QFS,tm
Since:: 3.5.

Procedure: "checkColor"

Checks the value that indicates the color of the text of the component.

It writes an error into the run log, if the check fails.

Parameters:: id - The id of the component.; value - The color to check for.
Author:: QFS,tm
Since:: 3.5.

Package: "font"

Procedures for handling different element style checks concerning font attributes.

Author:: QFS,tm
Since:: 3.5.

	Procedure/Dependency	Description
	checkFontName	Checks the name of the font used for text in the component.
	checkFontSize	Checks the value that indicates the font size used for text in the component
	checkFontStyle	Checks the value that indicates the font style used for text in the component (italic, normal or oblique)

Procedure: "checkFontName"

Checks the name of the font used for text in the component.

It writes an error into the run log, if the check fails.

Parameters:: id - The id of the component.; value - The font family to check for.
Author:: QFS,tm
Since:: 3.5.

Procedure: "checkFontSize"

Checks the value that indicates the font size used for text in the component

It writes an error into the run log, if the check fails.

Parameters:: id - The id of the component.; value - The font size to check for.
Author:: QFS,tm
Since:: 3.5.

Procedure: "checkFontStyle"

Checks the value that indicates the font style used for text in the component (italic, normal or oblique)

It writes an error into the run log, if the check fails.

Parameters:: id - The id of the component.; value - The font style to check for. (italic, normal or oblique)
Author:: QFS,tm
Since:: 3.5.

Package: "cwr"

Procedures to support Custom Web Resolvers

Author:: QFS
Since:: 7.0

	Procedure/Dependency	Description
	dumpConfiguration	Dump configuration of an installed CustomWebResolver.
	uninstall	Uninstalls a previously installed CustomWebResolver.

Procedure: "dumpConfiguration"

Dump configuration of an installed CustomWebResolver.

Author:: QFS
Since:: 7.0

Procedure: "uninstall"

Uninstalls a previously installed CustomWebResolver.

Author:: QFS
Since:: 7.0

Package: "electron"

Procedures for Electron testing.

Author:: QFS
Since:: 4.5.0

	Procedure/Dependency	Description
	getChromeDriverPath	Get the path to the ChromeDriver and download it if neccessary.

Procedure: "getChromeDriverPath"

Get the path to the ChromeDriver and download it if neccessary.

Parameters:: chromeDriverVersion - The ChromeDriver version to get the path from.; download - Whether to download the ChromeDriver if not available.
Returns:: The path to the ChromeDriver
Author:: QFS
Since:: 4.5.0

Package: "general"

Procedures which work for any Web component.

Author:: QFS
Since:: 3.0

	Procedure/Dependency	Description
	clickAtComponent	Click on a given component, but only if the according parameter is set to true.
	clickAtComponentWithDetails	Click on a given component, but only if the according parameter is set to true.
	clickIncreasinglyHard	Clicks the given component with increasingly hard mouse clicks and waits for the given action to be performed.
	deleteOverrideComponent	Delete the current association of PriorityWebComponent.
	doClick	Click on a given component.
	doClickWithDetails	Click on a given component.
	dragFromTo	Simulate a drag&drop operation.
	getSourcecode	Return document's source code.
	integrateFirebug	Integrates Firebug Lite from http://getfirebug.com into an open browser window for an easier analysis of the DOM.
	setOverrideComponent	Set a given component to the PriorityWebComponent.
	waitForComponent	Wait for a given component.
	waitForComponentForAbsence	Wait till a given component disappears.

Procedure: "clickAtComponent"

Click on a given component, but only if the according parameter is set to true.

Parameters:: client - The name of the SUT client.; id - The Id of the target component.; click - If this is set to true, the click will be performed, otherwise nothing happens.
Author:: QFS,mm
Since:: 3.0

Procedure: "clickAtComponentWithDetails"

Click on a given component, but only if the according parameter is set to true. You can specify the coordinates for clicking and all other details of that mouse click.

Parameters:: client - The name of the SUT client.; id - The Id of the target component.; click - If this is set to true, the click will be performed, otherwise nothing happens.; x - The x coordinate for the click, default is empty to click in the middle.; y - The y coordinate for the click, default is empty to click in the middle.; clickCount - Number of clicks. Default is 1. For a double click set this to 2.; modifier - Modifier for mouse key. 4 for right mouse. 16 for left mouse.; hard - True, if hard event should be replayed. Default is false.; popupTrigger - True, if click should open a popup. Default is false.
Author:: QFS,mm
Since:: 4.0

Procedure: "clickIncreasinglyHard"

Clicks the given component with increasingly hard mouse clicks and waits for the given action to be performed.

After the click a procedure is executed that checks that the click triggered the expected result, e.g. another component appeared, disappeared or was selected. In case the check fails the click is repeated a step harder. I.e. from software-replayed clicks to actually moving the mouse and using clicks triggered via operating system.

Any procedure that returns true or false as a result can be specified for the parameter actionToWaitFor. There are predefined actions like WAIT_FOR_COMPONENT or WAIT_FOR_CHECKBOX_STATE (complete list see below) that wait for the respective action to be performed for the component defined by the parameter componentAddressedByAction.

If the parameters are set so that the very last click would be a hard click then the last click will be replayed using the robot, as long it is a normal single or double click (i.e. robot clicks will not be performed if the click works as a popup trigger or has modifiers other than 16).

Parameters:: clicktype - whether to start the click series with a soft, semihard or hard mouse click; timeout - timeout used in the procedure specified by the parameter actionToWaitFor; numberOfRetries - the maximum number of times to retry the click (default: 5); clickX - x-coordinate where to click the component; clickY - y-coordinate where to click the component; actionToWaitFor - a predefined action (keywords see below) or any procedure that returns true or false, thus indicating whether the action to be triggered by the click was successful or not.; componentAddressedByAction - the component that is involved with the action specified, e.g. the component to wait for; delayBefore - time in ms to wait before the mouse click is performed; delayAfter - time in ms to wait after the mouse click was performed; doubleclick - determines whether or not to perform a doubleclick (default: false); popupTrigger - determines whether the click triggers a popup (default: false); modifier - determines the modifier that is to be used with the mouse click. Allowed values: 16 (default), 17, 18 and 19, 4 for popup Keywords for actionToWaitFor WAIT_FOR_COMPONENT wait for the compontent specified by the parameter componentAddressedByAction to appear WAIT_FOR_COMPONENT_TO_DISAPPEAR wait for the compontent specified by the parameter componentAddressedByAction to disappear WAIT_FOR_COMPONENT_TO_BE_SELECTED wait for the compontent specified by the parameter componentAddressedByAction to be selected WAIT_FOR_CHECKBOX_STATE wait for the checkbox specified by the parameter componentAddressedByAction to get the state defined by the additional parameter:; checked - true if the checkbox specified by the parameter componentAddressedByAction should be checked, false otherwise (only in combination with actionToWaitFor=WAIT_FOR_CHECKBOX_STATE)
Author:: QFS,ue
Since:: 4.0

Procedure: "deleteOverrideComponent"

Delete the current association of PriorityWebComponent.

Parameters:: client - The name of the SUT client.
Author:: QFS
Since:: 3.3.0

Procedure: "doClick"

Click on a given component.

Parameters:: client - The name of the SUT client.; id - The Id of the target component.
Author:: QFS,mm
Since:: 2.1.0

Procedure: "doClickWithDetails"

Click on a given component. You can specify the coordinates for clicking and all other details of that mouse click.

Parameters:: client - The name of the SUT client.; id - The Id of the target component.; x - The x coordinate for the click, default is empty to click in the middle.; y - The y coordinate for the click, default is empty to click in the middle.; clickCount - Number of clicks. Default is 1. For a double click set this to 2.; modifier - Modifier for mouse key. 4 for right mouse. 16 for left mouse.; hard - True, if hard event should be replayed. Default is false.; popupTrigger - True, if click should open a popup. Default is false.
Author:: QFS,mm
Since:: 4.0

Procedure: "dragFromTo"

Simulate a drag&drop operation.

Parameters:: fromId - ID of the component to start the drag from.; toId - ID of the component to drop to.; useJavascript - If set to true the events are initiated at javascript level.
Author:: QFS, tm
Since:: 4.0.0.

Procedure: "getSourcecode"

Return document's source code.

If you leave frameName blank, this procedure logs the source code of every frame of the webpage into the run log. It returns just the source code of the main document. If you specify a dedicated frameName, only the source code of that particular frame will be logged and returned.

Parameters:: docId - The Id of the web page.; frameName - The name of the frame to provide source code.
Returns:: The source code.
Author:: QFS, mm
Since:: 3.4.9

Procedure: "integrateFirebug"

Integrates Firebug Lite from http://getfirebug.com into an open browser window for an easier analysis of the DOM.

Parameters:: client - The name of the SUT client.; docid - The Id of the document.
Author:: QFS,tm
Since:: 3.5.2

Procedure: "setOverrideComponent"

Set a given component to the PriorityWebComponent.

Parameters:: client - The name of the SUT client.; id - The Id of the target component.
Author:: QFS
Since:: 3.3.0

Procedure: "waitForComponent"

Wait for a given component.

Parameters:: client - The name of the SUT client.; id - The Id of the target component.; timeout - The timeout to wait for that component; throwExc - True, whether procedure should throw an exception if component didn't appear.
Author:: QFS,mm
Since:: 4.0

Procedure: "waitForComponentForAbsence"

Wait till a given component disappears.

Parameters:: client - The name of the SUT client.; id - The Id of the target component.; timeout - The timeout to wait for that component; throwExc - True, whether procedure should throw an exception if component didn't disappear.
Author:: QFS,mm
Since:: 4.0

Package: "input"

Procedures to access INPUT elements.

Author:: QFS
Since:: 3.2

	Procedure/Dependency	Description
	fileUpload	Set the value of the INPUT:FILE node by whatever means that are applicable for the browser.

Procedure: "fileUpload"

Set the value of the INPUT:FILE node by whatever means that are applicable for the browser.

Author:: QFS
Since:: 3.2

Package: "radiobutton"

Procedures to set the state of buttons. (Web component INPUT:RADIO)

Author:: QFS,mm
Since:: 3.5.0

	Procedure/Dependency	Description
	getValue	Return the value of a radio button.
	select	Select a radio button.
	selectWithCoordinates	Select a radio button.

Procedure: "getValue"

Return the value of a radio button. It's either 1, if radio button is selected of 0, if radio button is not selected.

Parameters:: id - ID of the radio button.
Returns:: The state of the checkbox.
Author:: QFS,mm
Since:: 3.5.0

Procedure: "select"

Select a radio button. If the radio button is already selected, no action is performed.

Parameters:: id - The id of the radio button.
Author:: QFS,mm
Since:: 3.5.0

Procedure: "selectWithCoordinates"

Select a radio button. If the radio button is already selected, no action is performed. You can specify the coordinates for clicking.

Parameters:: id - The id of the radio button.; x - The x coordinate for the click, default is empty to click in the middle.; y - The y coordinate for the click, default is empty to click in the middle.
Author:: QFS,mm
Since:: 4.0

Package: "select"

Procedures to access select nodes. It should work with any SELECT element.

Author:: QFS,mm
Since:: 3.5.0

	Procedure/Dependency	Description
	getIndexOfItem	Return the current index of a given item.
	getItemCount	Return the number of items of a given select.
	getValue	Return the current value of a given select node.
	getValueOfItem	Return the current text of a given item.
	selectValue	Select a given value in a Select node.

Procedure: "getIndexOfItem"

Return the current index of a given item.

Sample usage: Can be used to determine the numeric index of an item like 'Price'.

Parameters:: id - ID of the select.; item - The item to look for.; itemSeparator - Separator to use for the item syntax. Default is @ for text values, also available & for index and % for regexp.
Returns:: index The current index of an item, which has been read by the 'Fetch Index' node of QF-Test.
Author:: QFS,mm
Since:: 3.5.0

Procedure: "getItemCount"

Return the number of items of a given select.

Parameters:: id - The component ID of the select.
Returns:: itemCount
Author:: QFS,mm
Since:: 3.5.0

Procedure: "getValue"

Return the current value of a given select node.

Parameters:: id - ID of the select node.
Returns:: The current value of the SELECT node, which has been read by the 'Fetch Text' node of QF-Test.
Author:: QFS,mm
Since:: 3.5.0

Procedure: "getValueOfItem"

Return the current text of a given item.

Sample usage: Can be used to determine the text of the first item.

Parameters:: id - ID of the select node.; item - The item to look for.; itemSeparator - Separator to use for the item syntax. Default is @ for text values, also available & for index and % for regexp.
Returns:: The value of given item of the SELECT node, which has been read by the 'Fetch Text' node of QF-Test.
Author:: QFS,mm
Since:: 3.5.0

Procedure: "selectValue"

Select a given value in a Select node.

Parameters:: id - ID of the select node.; value - Value, which should be selected.; separator - Separator to use for the list syntax. Default is @ for text values, also available & for index and % for regexp.
Author:: QFS,mm
Since:: 3.5.0

Package: "table"

Procedures to access web tables.

Author:: QFS,kk
Since:: 3.5

	Procedure/Dependency	Description
	clickCellWithDetails	Select a given cell.
	getColumnCount	Return the number of columns of a given web table.
	getIndexOfColumn	Return the current index of a given column.
	getNameOfColumn	Return the header text of a given column.
	getRowCount	Return the number of rows of a given table.
	getRowIndexOfCell	Return the row number of a given cell.
	getValueOfCell	Return the text of a given cell.
	selectCell	Select a given cell.

Procedure: "clickCellWithDetails"

Select a given cell. You can specify the coordinates for clicking and all other details of that mouse click.

Parameters:: id - ID of the table.; column - The column.; row - The row.; columnSeparator - Separator to use for the column syntax. Default is @ for text values, also available & for index and % for regexp.; rowSeparator - Separator to use for the row syntax. Default is @ for text values, also available & for index and % for regexp.; x - The x coordinate for the click, default is empty to click in the middle.; y - The y coordinate for the click, default is empty to click in the middle.; clickCount - Number of clicks. Default is 1. For a double click set this to 2.; modifier - Modifier for mouse key. 4 for right mouse. 16 for left mouse.; hard - True, if hard event should be replayed. Default is false.; popupTrigger - True, if click should open a popup. Default is false.
Author:: QFS,mm
Since:: 4.0

Procedure: "getColumnCount"

Return the number of columns of a given web table.

Parameters:: id - The component ID of the table.
Returns:: columnCount
Author:: QFS,kk
Since:: 3.5

Procedure: "getIndexOfColumn"

Return the current index of a given column.

Sample usage: Can be used to determine the numeric index of a column like 'Price'.

Parameters:: id - ID of the table.; column - The column.; columnSeparator - Separator to use for the column syntax. Default is @ for text values, also available & for index and % for regexp.
Returns:: index The current index of the column, which has been read by the 'Fetch Index' node of QF-Test.
Author:: QFS,kk
Since:: 3.5

Procedure: "getNameOfColumn"

Return the header text of a given column.

Sample usage: Determine the title of the second column.

Parameters:: id - ID of the table.; column - The column.; columnSeparator - Separator to use for the column syntax. Default is @ for text values, also available & for index and % for regexp.
Returns:: name The name of the column.
Author:: QFS,kk
Since:: 3.5

Procedure: "getRowCount"

Return the number of rows of a given table.

Parameters:: id - The component id of the table.
Returns:: rowCount
Author:: QFS,kk
Since:: 3.5

Procedure: "getRowIndexOfCell"

Return the row number of a given cell.

Sample usage: Can be used to determine in which row a dedicated cell is located.

Parameters:: id - ID of the table.; column - The column.; row - The row.; columnSeparator - Separator to use for the column syntax. Default is @ for text values, also available & for index and % for regexp.; rowSeparator - Separator to use for the row syntax. Default is @ for text values, also available & for index and % for regexp.
Returns:: index The current index of the row, which has been read by the 'Fetch Index' node of QF-Test.
Author:: QFS,kk
Since:: 3.5

Procedure: "getValueOfCell"

Return the text of a given cell.

Sample usage: Can be used to determine the text of the cell in the first column and first row.

Parameters:: id - ID of the table.; column - The column.; row - The row.; columnSeparator - Separator to use for the column syntax. Default is @ for text values, also available & for index and % for regexp.; rowSeparator - Separator to use for the row syntax. Default is @ for text values, also available & for index and % for regexp.
Returns:: value The current value of the row, which has been read by the 'Fetch text' node of QF-Test.
Author:: QFS,kk
Since:: 3.5

Procedure: "selectCell"

Select a given cell.

Parameters:: id - ID of the table.; column - The column.; row - The row.; columnSeparator - Separator to use for the column syntax. Default is @ for text values, also available & for index and % for regexp.; rowSeparator - Separator to use for the row syntax. Default is @ for text values, also available & for index and % for regexp.
Author:: QFS,mm
Since:: 3.5.0

Package: "checks"

Procedures for checking a table.

Author:: QFS,kk
Since:: 3.5

	Procedure/Dependency	Description
	checkNumberOfColums	Check the number of columns of a given table according to a specified comparison mode.
	checkNumberOfRows	Check the number of rows of a given table according to a specified comparison mode.

Procedure: "checkNumberOfColums"

Check the number of columns of a given table according to a specified comparison mode.

Sample usage: You can check, that a table has exactly 6 columns or that the table has less then 10 columns.

Parameters:: id - The id of the table.; compareValue - The comparison value.; compareMode - The comparison mode = or ==, if the compareValue should be equal than the actual amount of columns <, if the compareValue should be greater than the actual amount of columns. >, if the compareValue should be less than the actual amount of columns. <=, if the compareValue should be greater or equal than the actual amount of colunns. >=, if the compareValue should be less or equal the actual amount of columns. !=, if the compareValue should be not equal the actual amount of items.; errorLevel - The kind of error, which should be logged. Either EXCEPTION, ERROR, WARNING or MESSAGE.; appearInReport - Flag, whether to show check in report, if a message or warning are set as errorLevel. If this is set to 1, the check will be shown in the report.
Exceptions:: UserException, - if wrong comparison mode has been set.
Author:: QFS,kk
Since:: 3.5

Procedure: "checkNumberOfRows"

Check the number of rows of a given table according to a specified comparison mode.

Sample usage: You can check, that a table has exactly 6 rows or that the table has less then 10 rows.

Parameters:: id - The id of the table.; compareValue - The comparison value.; compareMode - The comparison mode = or ==, if the compareValue should be equal than the actual amount of rows. <, if the compareValue should be greater than the actual amount of rows. >, if the compareValue should be less than the actual amount of rows. <=, if the compareValue should be greater or equal than the actual amount of rows. >=, if the compareValue should be less or equal the actual amount of rows. !=, if the compareValue should be not equal the actual amount of items.; errorLevel - The kind of error, which should be logged. Either EXCEPTION, ERROR, WARNING or MESSAGE.; appearInReport - Flag, whether to show check in report, if a message or warning are set as errorLevel. If this is set to 1, the check will be shown in the report.
Exceptions:: UserException, - if wrong comparison mode has been set.
Author:: QFS,kk
Since:: 3.5

Package: "recording"

Procedures influencing recording of web tables.

Author:: QFS,kk
Since:: 3.5

	Procedure/Dependency	Description
	activateItemRecording	Activate recording of item based access for a given web table.
	deactivateItemRecording	Deactivate recording of item based access for a given web table.

Procedure: "activateItemRecording"

Activate recording of item based access for a given web table.

Background: As tables on web pages are both used for layout purposes and for logical tables, QF-Test cannot know where logical tables start. This procedure allows to provide this information and to activate recording items for logical tables. Item based replay on web tables work always.

Parameters:: id - ID of the table.
Author:: QFS,kk
Since:: 3.5

Procedure: "deactivateItemRecording"

Deactivate recording of item based access for a given web table.

Parameters:: id - ID of the table.
Author:: QFS,kk
Since:: 3.5

Package: "text"

Procedures to access text fields and text areas. It should work with any INPUT:TEXT elements.

Author:: QFS
Since:: 3.0

	Procedure/Dependency	Description
	clearArea	Clear a multi-line text area.
	clearField	Clear a simple text field.
	getText	Return the text of a given textfield.
	setText	Set a given text to a given text-field or text-area.
	setTextFromFile	Read the content of a given file and set its content to a given text-field.

Procedure: "clearArea"

Clear a multi-line text area.

Parameters:: client - The name of the SUT client.; id - The id of the text area.
Author:: QFS
Since:: 3.0

Procedure: "clearField"

Clear a simple text field.

Parameters:: client - The name of the SUT client.; id - The id of the text field.
Author:: QFS
Since:: 3.0

Procedure: "getText"

Return the text of a given textfield.

Parameters:: id - ID of the textfield.
Returns:: The text of the textfield. Variables in this string will not be automatically expanded.
Author:: QFS,mm
Since:: 3.5.0

Procedure: "setText"

Set a given text to a given text-field or text-area.

Parameters:: id - ID of the textfield.; text - text to be set.; append - if this value is set to true, the text will be appended to the current values.; clear - If this value is set to true, the text-field will be cleared before the text given as parameter "text" is inserted.; replaySingleEvents - If this value is set to true, the text will be inserted replaying single events.; newline - the separator sign for marking a linebreak within the text
Author:: QFS
Since:: 3.0

Procedure: "setTextFromFile"

Read the content of a given file and set its content to a given text-field.

Parameters:: id - The id of the text-field to set.; file - The path to the file.; append - If this value is set to true, the text will be appended to the current values.; clear - If this value is set to true, the text-field will be cleared in case an empty string is given as parameter "text".; replaySingleEvents - If this value is set to true, the text will be inserted replaying single events.; newline - the separator sign for marking a linebreak within the text
Author:: QFS
Since:: 3.1.1

Package: "win"

Procedures for advanced manipulation of native windows components.

Author:: QFS
Since:: 5.0

Package: "checkbox"

Procedures to set the state of checkboxes.

Author:: QFS
Since:: 5.0

	Procedure/Dependency	Description
	deselect	Deselect a checkbox.
	deselectWithCoordinates	Deselect a checkbox.
	getValue	Return the value of a checkbox.
	select	Select a checkbox.
	selectWithCoordinates	Select a checkbox.
	set	Set checkbox to the given state.
	setWithCoordinates	Set checkbox to the given state.

Procedure: "deselect"

Deselect a checkbox. If the checkbox is already deselected, no action is performed.

Parameters:: client - The name of the SUT client.; id - The id of the checkbox.
Author:: QFS
Since:: 5.0

Procedure: "deselectWithCoordinates"

Deselect a checkbox. If the checkbox is already deselected, no action is performed. You can specify the coordinates for clicking.

Parameters:: client - The name of the SUT client.; id - The id of the checkbox.; x - The x coordinate for the click, default is empty to click in the middle.; y - The y coordinate for the click, default is empty to click in the middle.
Author:: QFS
Since:: 5.0

Procedure: "getValue"

Return the value of a checkbox. It's either 1, if box is selected or 0, if box is not selected.

Parameters:: id - ID of the checkbox.
Returns:: The state of the checkbox.
Author:: QFS
Since:: 5.0

Procedure: "select"

Select a checkbox. If the checkbox is already selected, no action is performed.

Parameters:: client - The name of the SUT client.; id - The id of the checkbox.
Author:: QFS
Since:: 5.0

Procedure: "selectWithCoordinates"

Select a checkbox. If the checkbox is already selected, no action is performed. You can specify the coordinates for clicking.

Parameters:: client - The name of the SUT client.; id - The id of the checkbox.; x - The x coordinate for the click, default is empty to click in the middle.; y - The y coordinate for the click, default is empty to click in the middle.
Author:: QFS
Since:: 5.0

Procedure: "set"

Set checkbox to the given state.

Parameters:: client - The name of the SUT client.; id - The id of the checkbox.; check - The check value to be set (either true or false).
Author:: QFS
Since:: 5.0

Procedure: "setWithCoordinates"

Set checkbox to the given state. You can specify the coordinates for clicking.

Parameters:: client - The name of the SUT client.; id - The id of the checkbox.; check - The check value to be set (either true or false).; x - The x coordinate for the click, default is empty to click in the middle.; y - The y coordinate for the click, default is empty to click in the middle.
Author:: QFS
Since:: 5.0

Package: "combobox"

Procedures to handle comboboxes.

Author:: QFS
Since:: 5.0

	Procedure/Dependency	Description
	getIndexOfItem	Return the current index of a given item.
	getValue	Return the text of a given combobox.
	getValueOfItem	Return the text of a given item.
	setValue	Select specified value of a given combobox.

Procedure: "getIndexOfItem"

Return the current index of a given item.

Parameters:: id - ID of the combobox.; item - The item.; itemSeparator - Separator to use for the item syntax. Default is @ for text values, also available & for index and % for regexp.
Returns:: index The current index of the item, which has been read by the 'Fetch Index' node of QF-Test.
Author:: QFS
Since:: 5.0

Procedure: "getValue"

Return the text of a given combobox.

Parameters:: id - ID of the combobox.
Returns:: The text of the combobox.
Author:: QFS
Since:: 5.0

Procedure: "getValueOfItem"

Return the text of a given item.

Sample usage: Determine the text of the second item.

Parameters:: id - ID of the combobox.; item - The item.; itemSeparator - Separator to use for the item syntax. Default is @ for text values, also available & for index and % for regexp.
Returns:: value The value of the item.
Author:: QFS
Since:: 5.0

Procedure: "setValue"

Select specified value of a given combobox.

If the given value is empty, no action will take place.

You should use this procedure for any standard selections.

Parameters:: client - The name of the SUT client.; id - ID of the button to open the list.; value - Value, which should be selected.; separator - Separator to use for the list syntax. Default is @ for text values, also available & for index and % for regexp.; btnX - The x coordinate for the click on the button to open the list, default is empty to click in the middle.; btnY - The y coordinate for the click on the button to open the list, default is empty to click in the middle.; itemX - The x coordinate for the click on the item, default is empty to click in the middle.; itemY - The y coordinate for the click on the item, default is empty to click in the middle.
Author:: QFS
Since:: 5.0

Package: "general"

Procedures which work for any Win component.

Author:: QFS
Since:: 5.0

	Procedure/Dependency	Description
	clickAtComponent	Click on a given component, but only if the according parameter is set to true.
	clickAtComponentWithDetails	Click on a given component, but only if the according parameter is set to true.
	doClick	Click on a given component.
	doClickWithDetails	Click on a given component.
	waitForComponent	Wait for a given component.
	waitForComponentForAbsence	Wait till a given component disappears.

Procedure: "clickAtComponent"

Click on a given component, but only if the according parameter is set to true.

Parameters:: client - The name of the SUT client.; id - The Id of the target component.; click - If this is set to true, the click will be performed, otherwise nothing happens.
Author:: QFS
Since:: 5.0

Procedure: "clickAtComponentWithDetails"

Click on a given component, but only if the according parameter is set to true. You can specify the coordinates for clicking and all other details of that mouse click.

Parameters:: client - The name of the SUT client.; id - The Id of the target component.; click - If this is set to true, the click will be performed, otherwise nothing happens.; x - The x coordinate for the click, default is empty to click in the middle.; y - The y coordinate for the click, default is empty to click in the middle.; clickCount - Number of clicks. Default is 1. For a double click set this to 2.; modifier - Modifier for mouse key. 4 for right mouse. 16 for left mouse.; hard - True, if hard event should be replayed. Default is false.; popupTrigger - True, if click should open a popup. Default is false.
Author:: QFS
Since:: 5.0

Procedure: "doClick"

Click on a given component.

Parameters:: client - The name of the SUT client.; id - The Id of the target component.
Author:: QFS
Since:: 5.0

Procedure: "doClickWithDetails"

Click on a given component. You can specify the coordinates for clicking and all other details of that mouse click.

Parameters:: client - The name of the SUT client.; id - The Id of the target component.; x - The x coordinate for the click, default is empty to click in the middle.; y - The y coordinate for the click, default is empty to click in the middle.; clickCount - Number of clicks. Default is 1. For a double click set this to 2.; modifier - Modifier for mouse key. 4 for right mouse. 16 for left mouse.; hard - True, if hard event should be replayed. Default is false.; popupTrigger - True, if click should open a popup. Default is false.
Author:: QFS
Since:: 5.0

Procedure: "waitForComponent"

Wait for a given component.

Parameters:: client - The name of the SUT client.; id - The Id of the target component.; timeout - The timeout to wait for that component; throwExc - True, whether procedure should throw an exception if component didn't appear.
Author:: QFS
Since:: 5.0

Procedure: "waitForComponentForAbsence"

Wait till a given component disappears.

Parameters:: client - The name of the SUT client.; id - The Id of the target component.; timeout - The timeout to wait for that component; throwExc - True, whether procedure should throw an exception if component didn't disappear.
Author:: QFS
Since:: 5.0

Package: "helpers"

Helper procedure for Windows engine tests.

Author:: QFS
Since:: 5.0

	Procedure/Dependency	Description
	hasPattern	Check whether the component has the given pattern.

Procedure: "hasPattern"

Check whether the component has the given pattern.

Parameters:: id - The Id of the component.; pattern - The pattern name, e.g ”Invoke”, ”ExpandCollapse” etc.
Returns:: true If the pattern is supported by the element false If the pattern is not supported by the element
Author:: QFS
Since:: 5.0

Package: "list"

Procedures for accessing lists.

Author:: QFS
Since:: 5.0

	Procedure/Dependency	Description
	clickItemWithDetails	Select a given item by a mouse click on it.
	getIndexOfItem	Return the current index of a given item.
	getItemCount	Return the number of items of a given list.
	getValueOfItem	Return the text of a given item.
	selectItem	Select a given item by a mouse click on it.

Procedure: "clickItemWithDetails"

Select a given item by a mouse click on it. You can specify the coordinates for clicking and all other details of that mouse click.

Parameters:: id - ID of the list.; item - The item.; itemSeparator - Separator to use for the item syntax. Default is @ for text values, also available & for index and % for regexp.; x - The x coordinate for the click, default is empty to click in the middle.; y - The y coordinate for the click, default is empty to click in the middle.; clickCount - Number of clicks. Default is 1. For a double click set this to 2.; modifier - Modifier for mouse key. 4 for right mouse. 16 for left mouse.; hard - True, if hard event should be replayed. Default is false.; popupTrigger - True, if click should open a popup. Default is false.
Author:: QFS
Since:: 5.0

Procedure: "getIndexOfItem"

Return the current index of a given item.

Sample usage: Can be used to determine the numeric index of an item like 'Price'.

Parameters:: id - ID of the list.; item - The item.; itemSeparator - Separator to use for the item syntax. Default is @ for text values, also available & for index and % for regexp.
Returns:: index The current index of the item, which has been read by the 'Fetch Index' node of QF-Test.
Author:: QFS
Since:: 5.0

Procedure: "getItemCount"

Return the number of items of a given list. It uses the method getChildCount() to get the number.

Parameters:: id - The component ID of the list.
Returns:: itemCount
Author:: QFS,bp
Since:: 5.0

Procedure: "getValueOfItem"

Return the text of a given item.

Sample usage: Determine the text of the second item.

Parameters:: id - ID of the list.; item - The item.; itemSeparator - Separator to use for the item syntax. Default is @ for text values, also available & for index and % for regexp.
Returns:: value The value of the item.
Author:: QFS
Since:: 5.0

Procedure: "selectItem"

Select a given item by a mouse click on it.

Parameters:: id - ID of the list.; item - The item.; itemSeparator - Separator to use for the item syntax. Default is @ for text values, also available & for index and % for regexp.; x - The x coordinate for the click, default is empty to click in the middle.; y - The x coordinate for the click, default is empty to click in the middle.
Author:: QFS
Since:: 5.0

Package: "checks"

Procedures for checking a list.

Author:: QFS
Since:: 5.0

	Procedure/Dependency	Description
	checkNumberOfItems	Check the number of items of a given list according to a specified comparison mode.

Procedure: "checkNumberOfItems"

Check the number of items of a given list according to a specified comparison mode.

It uses the method getChildCount(() to get the number. Sample usage: You can check, that a list has exactly 6 items or that the table has less then 10 items.

Parameters:: id - The id of the list.; compareValue - The comparison value.; compareMode - The comparison mode = or ==, if the compareValue should be equal than the actual amount of items. <, if the compareValue should be greater than the actual amount of items. >, if the compareValue should be less than the actual amount of items. <=, if the compareValue should be greater or equal than the actual amount of items. >=, if the compareValue should be less or equal the actual amount of items. !=, if the compareValue should be not equal the actual amount of items.; errorLevel - The kind of error, which should be logged. Either EXCEPTION, ERROR, WARNING or MESSAGE.; appearInReport - Flag, whether to show check in report, if a message or warning are set as errorLevel. If this is set to 1, the check will be shown in the report.
Exceptions:: UserException, - if wrong comparison mode has been set.
Author:: QFS
Since:: 5.0

Package: "radiobutton"

Procedures to get and set the state of radio buttons.

Author:: QFS
Since:: 5.0

	Procedure/Dependency	Description
	getValue	Return the value of a radio button.
	select	Select a radio button.
	selectWithCoordinates	Select a radio button.

Procedure: "getValue"

Return the value of a radio button. It's either 1, if radio button is selected of 0, if radio button is not selected.

Parameters:: id - ID of the radio button.
Returns:: The state of the checkbox.
Author:: QFS
Since:: 5.0

Procedure: "select"

Select a radio button. If the radio button is already selected, no action is performed.

Parameters:: id - The id of the radio button.
Author:: QFS
Since:: 5.0

Procedure: "selectWithCoordinates"

Select a radio button. If the radio button is already selected, no action is performed. You can specify the coordinates for clicking.

Parameters:: id - The id of the radio button.; x - The x coordinate for the click, default is empty to click in the middle.; y - The y coordinate for the click, default is empty to click in the middle.
Author:: QFS
Since:: 5.0

Package: "tabbedpane"

Procedures to work with TabbedPanes.

Author:: QFS
Since:: 5.0

	Procedure/Dependency	Description
	getIndexOfTab	Return the index of a given tab in a TabbedPane.
	getItemCount	Return the number of items of a given tabbedpane.
	getValueOfTab	Return the text of a given tab in a TabbedPane.
	selectTab	Select a tab in a given TabbedPane.

Procedure: "getIndexOfTab"

Return the index of a given tab in a TabbedPane.

Parameters:: client - The name of the SUT client.; id - The component ID of the tabbedpane.; separator - Separator to use for the tab syntax. Default is @ for text values, also available & for index and % for regexp.; value - The value to look for.
Returns:: The index of the tab.
Author:: QFS
Since:: 5.0

Procedure: "getItemCount"

Return the number of items of a given tabbedpane.

Parameters:: id - The component ID of the tabbedpane.
Returns:: itemCount
Author:: QFS
Since:: 5.3.1

Procedure: "getValueOfTab"

Return the text of a given tab in a TabbedPane.

Parameters:: client - The name of the SUT client.; id - The component ID of the tabbedpane.; separator - Separator to use for the tab syntax. Default is @ for text values, also available & for index and % for regexp.; value - The index to look for.
Returns:: The value of the tab.
Author:: QFS
Since:: 5.0

Procedure: "selectTab"

Select a tab in a given TabbedPane.

Parameters:: client - The name of the SUT client.; id - The component ID of the tabbedpane to select.; separator - Separator to use for the tab syntax. Default is @ for text values, also available & for index and % for regexp.; value - The value to select.
Author:: QFS
Since:: 5.0

Package: "table"

Procedures to access tables.

Author:: QFS
Since:: 5.0

	Procedure/Dependency	Description
	clickCellWithDetails	Select a given cell.
	getColumnCount	Return the number of columns of a given table.
	getIndexOfColumn	Return the current index of a given column.
	getNameOfColumn	Return the header text of a given column.
	getRowCount	Return the number of rows of a given table.
	getRowIndexOfCell	Return the row number of a given cell.
	getValueOfCell	Return the text of a given cell.
	resizeColumn	Resize width of a table column.
	selectCell	Select a given cell.

Procedure: "clickCellWithDetails"

Select a given cell. You can specify the coordinates for clicking and all other details of that mouse click.

Parameters:: id - ID of the table.; column - The column.; row - The row.; columnSeparator - Separator to use for the column syntax. Default is @ for text values, also available & for index and % for regexp.; rowSeparator - Separator to use for the row syntax. Default is @ for text values, also available & for index and % for regexp.; x - The x coordinate for the click, default is empty to click in the middle.; y - The y coordinate for the click, default is empty to click in the middle.; clickCount - Number of clicks. Default is 1. For a double click set this to 2.; modifier - Modifier for mouse key. 4 for right mouse. 16 for left mouse.; hard - True, if hard event should be replayed. Default is false.; popupTrigger - True, if click should open a popup. Default is false.
Author:: QFS
Since:: 5.0

Procedure: "getColumnCount"

Return the number of columns of a given table.

Parameters:: id - The component ID of the table.
Returns:: columnCount
Author:: QFS
Since:: 5.0

Procedure: "getIndexOfColumn"

Return the current index of a given column.

Sample usage: Can be used to determine the numeric index of a column like 'Price'.

Parameters:: id - ID of the table.; column - The column.; columnSeparator - Separator to use for the column syntax. Default is @ for text values, also available & for index and % for regexp.
Returns:: index The current index of the column, which has been read by the 'Fetch Index' node of QF-Test.
Author:: QFS
Since:: 5.0

Procedure: "getNameOfColumn"

Return the header text of a given column.

Sample usage: Determine the title of the second column.

Parameters:: id - ID of the table.; column - The column.; columnSeparator - Separator to use for the column syntax. Default is @ for text values, also available & for index and % for regexp.
Returns:: name The name of the column.
Author:: QFS
Since:: 5.0

Procedure: "getRowCount"

Return the number of rows of a given table.

Parameters:: id - The component id of the table.
Returns:: rowCount
Author:: QFS
Since:: 5.0

Procedure: "getRowIndexOfCell"

Return the row number of a given cell.

Sample usage: Can be used to determine in which row a dedicated cell is located.

Parameters:: id - ID of the table.; column - The column.; row - The row.; columnSeparator - Separator to use for the column syntax. Default is @ for text values, also available & for index and % for regexp.; rowSeparator - Separator to use for the row syntax. Default is @ for text values, also available & for index and % for regexp.
Returns:: index The current index of the row, which has been read by the 'Fetch Index' node of QF-Test.
Author:: QFS
Since:: 5.0

Procedure: "getValueOfCell"

Return the text of a given cell.

Sample usage: Can be used to determine the text of the cell in the first column and first row.

Parameters:: id - ID of the table.; column - The column.; row - The row.; columnSeparator - Separator to use for the column syntax. Default is @ for text values, also available & for index and % for regexp.; rowSeparator - Separator to use for the row syntax. Default is @ for text values, also available & for index and % for regexp.
Returns:: value The current value of the row, which has been read by the 'Fetch text' node of QF-Test.
Author:: QFS
Since:: 5.0

Procedure: "resizeColumn"

Resize width of a table column.

Parameters:: client - The name of the client.; idColumn - The id of the table column to be resized.; width - The new width - additional or absolute, dependent on the 'absolute' parameter. For additional width also negative values are possible to shrink the column size.; absolute - True, if the with value shall be the absolute new column width (default is 'true').
Author:: QFS
Since:: 5.0

Procedure: "selectCell"

Select a given cell.

Parameters:: id - ID of the table.; column - The column.; row - The row.; columnSeparator - Separator to use for the column syntax. Default is @ for text values, also available & for index and % for regexp.; rowSeparator - Separator to use for the row syntax. Default is @ for text values, also available & for index and % for regexp.
Author:: QFS
Since:: 5.0

Package: "checks"

Procedures for checking a table.

Author:: QFS
Since:: 5.0

	Procedure/Dependency	Description
	checkNumberOfColumns	Check the number of columns of a given table according to a specified comparison mode.
	checkNumberOfRows	Check the number of rows of a given table according to a specified comparison mode.

Procedure: "checkNumberOfColumns"

Check the number of columns of a given table according to a specified comparison mode.

Sample usage: You can check, that a table has exactly 6 columns or that the table has less then 10 columns.

Parameters:: id - The id of the table.; compareValue - The comparison value.; compareMode - The comparison mode = or ==, if the compareValue should be equal than the actual amount of columns. <, if the compareValue should be greater than the actual amount of columns. >, if the compareValue should be less than the actual amount of columns. <=, if the compareValue should be greater or equal than the actual amount of columns. >=, if the compareValue should be less or equal the actual amount of columns. !=, if the compareValue should be not equal the actual amount of items.; errorLevel - The kind of error, which should be logged. Either EXCEPTION, ERROR, WARNING or MESSAGE.; appearInReport - Flag, whether to show check in report, if a message or warning are set as errorLevel. If this is set to 1, the check will be shown in the report.
Exceptions:: UserException, - if wrong comparison mode has been set.
Author:: QFS
Since:: 5.0

Procedure: "checkNumberOfRows"

Check the number of rows of a given table according to a specified comparison mode.

Sample usage: You can check, that a table has exactly 6 rows or that the table has less then 10 rows.

Parameters:: id - The id of the table.; compareValue - The comparison value.; compareMode - The comparison mode = or ==, if the compareValue should be equal than the actual amount of rows. <, if the compareValue should be greater than the actual amount of rows. >, if the compareValue should be less than the actual amount of rows. <=, if the compareValue should be greater or equal than the actual amount of rows. >=, if the compareValue should be less or equal the actual amount of rows. !=, if the compareValue should be not equal the actual amount of items.; errorLevel - The kind of error, which should be logged. Either EXCEPTION, ERROR, WARNING or MESSAGE.; appearInReport - Flag, whether to show check in report, if a message or warning are set as errorLevel. If this is set to 1, the check will be shown in the report.
Exceptions:: UserException, - if wrong comparison mode has been set.
Author:: QFS
Since:: 5.0

Package: "text"

Procedures to access text fields and text areas.

Author:: QFS
Since:: 5.0

	Procedure/Dependency	Description
	clearArea	Clear a multi-line text area.
	clearField	Clear a simple text field.
	getText	Return the text of a given textfield.
	setText	Set a given text to a given text-field or text-area.
	setTextFromFile	Read the content of a given file and set its content to a given text-field.

Procedure: "clearArea"

Clear a multi-line text area.

Parameters:: client - The name of the SUT client.; id - The id of the text area.
Author:: QFS
Since:: 5.0

Procedure: "clearField"

Clear a simple text field.

Parameters:: client - The name of the SUT client.; id - The id of the text field.
Author:: QFS
Since:: 5.0

Procedure: "getText"

Return the text of a given textfield.

Parameters:: id - ID of the textfield.
Returns:: The text of the textfield. Variables in this string will not be automatically expanded.
Author:: QFS
Since:: 5.0

Procedure: "setText"

Set a given text to a given text-field or text-area.

Parameters:: id - ID of the textfield.; text - text to be set.; append - if this value is set to true, the text will be appended to the current values.; clear - If this value is set to true, the text-field will be cleared before the text given as parameter "text" is inserted.; replaySingleEvents - If this value is set to true, the text will be inserted replaying single events.; newline - the separator sign for marking a linebreak within the text
Author:: QFS
Since:: 5.0

Procedure: "setTextFromFile"

Read the content of a given file and set its content to a given text-field.

Parameters:: id - The id of the text-field to set.; file - The path to the file.; append - If this value is set to true, the text will be appended to the current values.; clear - If this value is set to true, the text-field will be cleared in case an empty string is given as parameter "text".; replaySingleEvents - If this value is set to true, the text will be inserted replaying single events.; newline - the separator sign for marking a linebreak within the text
Author:: QFS
Since:: 5.0

Package: "tree"

Procedures to access trees.

Author:: QFS
Since:: 5.0

	Procedure/Dependency	Description
	clickNodeWithDetails	Select a given node.
	collapse	Collapse a tree node.
	collapseNode	Collapse a tree node.
	collapseNodeWithCoordinates	Collapse a tree node.
	collapseWithCoordinates	Collapse a tree node.
	expand	Expand a tree node.
	expandNode	Expand a tree node.
	expandNodeWithCoordinates	Expand a tree node.
	expandWithCoordinates	Expand a tree node.
	getChildNodeCount	Return the number of child nodes.
	getIndexOfNode	Return the current index of a given node.
	getValueOfNode	Return the text of a given node.
	selectNode	Select a given node.

Procedure: "clickNodeWithDetails"

Select a given node. You can specify the coordinates for clicking and all other details of that mouse click.

Parameters:: id - ID of the tree.; node - The node, e.g. '/Root/Price' or '/0/0'.; separator - Separator to use for the node syntax. Default is @ for text values, also available & for index and % for regexp.; x - The x coordinate for the click, default is empty to click in the middle.; y - The y coordinate for the click, default is empty to click in the middle.; clickCount - Number of clicks. Default is 1. For a double click set this to 2.; modifier - Modifier for mouse key. 4 for right mouse. 16 for left mouse.; hard - True, if hard event should be replayed. Default is false.; popupTrigger - True, if click should open a popup. Default is false
Author:: QFS
Since:: 5.0

Procedure: "collapse"

Parameters:: client - The name of the SUT client.; node - The id of the tree node to collapse.
Author:: QFS
Since:: 5.0

Procedure: "collapseNode"

Parameters:: client - The name of the SUT client.; id - The id of the tree.; node - The node, e.g. like '/Root/Price' or '/0/0'.; separator - Separator to use for the node syntax. Default is @ for text values, also available & for index and % for regexp.
Author:: QFS
Since:: 5.0

Procedure: "collapseNodeWithCoordinates"

Parameters:: client - The name of the SUT client.; id - The id of the tree.; node - The node, e.g. like '/Root/Price' or '/0/0'.; separator - Separator to use for the node syntax. Default is @ for text values, also available & for index and % for regexp.; x - The x coordinate for the click, default is empty to click in the middle.; y - The y coordinate for the click, default is empty to click in the middle.
Author:: QFS,mm
Since:: 5.0

Procedure: "collapseWithCoordinates"

Parameters:: client - The name of the SUT client.; node - The id of the tree node to collapse.; x - The x coordinate for the click, default is empty to click in the middle.; y - The y coordinate for the click, default is empty to click in the middle.
Author:: QFS
Since:: 5.0

Procedure: "expand"

Expand a tree node. It clicks on the tree node, replays a right key press event and selects the node again. If your tree doesn't support keyboard actions to expand a node, this procedure won't work.

Parameters:: client - The name of the SUT client.; node - The id of the tree node to expand.
Author:: QFS
Since:: 5.0

Procedure: "expandNode"

Expand a tree node. It clicks on the tree node, replays a right key press event and selects the node again. If your tree doesn't support keyboard actions to expand a node, this procedure won't work.

Parameters:: client - The name of the SUT client.; id - The id of the tree.; node - The node, e.g. '/Root/Price' or '/0/0'.; separator - Separator to use for the node syntax. Default is @ for text values, also available & for index and % for regexp.
Author:: QFS
Since:: 5.0

Procedure: "expandNodeWithCoordinates"

Parameters:: client - The name of the SUT client.; id - The id of the tree.; node - The node, e.g. '/Root/Price' or '/0/0'.; separator - Separator to use for the node syntax. Default is @ for text values, also available & for index and % for regexp.; x - The x coordinate for the click, default is empty to click in the middle.; y - The y coordinate for the click, default is empty to click in the middle.
Author:: QFS
Since:: 5.0

Procedure: "expandWithCoordinates"

Parameters:: client - The name of the SUT client.; node - The id of the tree node to expand.; x - The x coordinate for the click, default is empty to click in the middle.; y - The y coordinate for the click, default is empty to click in the middle.
Author:: QFS
Since:: 5.0

Procedure: "getChildNodeCount"

Return the number of child nodes.

Parameters:: id - The component id of the tree.; node - The node. like '/Root/Price' or '/0/0'. If no node is specified, QF-Test will count the items of the root node.; nodeSeparator - Separator to use for the node syntax. Default is @ for text values, also available & for index and % for regexp.
Returns:: nodeCount
Author:: QFS
Since:: 5.0

Procedure: "getIndexOfNode"

Return the current index of a given node.

Sample usage: Can be used to determine the numeric index of a node like '/Root/Price'.

Parameters:: id - ID of the tree.; node - The node. like '/Root/Price' or '/0/0'.; nodeSeparator - Separator to use for the node syntax. Default is @ for text values, also available & for index and % for regexp.
Returns:: index The current index of the node
Author:: QFS
Since:: 5.0

Procedure: "getValueOfNode"

Return the text of a given node.

Sample usage: Determine the text value for a node referenced by index like /0/1.

Parameters:: id - ID of the tree.; node - The node. It should be something like '/Root/Price' or '/0/0'.; nodeSeparator - Separator to use for the node syntax. Default is & for index, also available @ for text values and % for regexp.
Returns:: name The value of the node.
Author:: QFS
Since:: 5.0

Procedure: "selectNode"

Select a given node.

Parameters:: id - ID of the tree.; node - The node, e.g. '/Root/Price' or '/0/0'.; separator - Separator to use for the node syntax. Default is @ for text values, also available & for index and % for regexp.
Author:: QFS
Since:: 5.0

Package: "checks"

Procedures for checking a tree.

Author:: QFS
Since:: 5.0

	Procedure/Dependency	Description
	checkNumberOfChildNodes	Check the number of child nodes of a given tree node according to a specified comparison mode.

Procedure: "checkNumberOfChildNodes"

Check the number of child nodes of a given tree node according to a specified comparison mode.

Sample usage: You can check, that a tree has exactly 6 rows or that the tree has less then 10 rows.

Parameters:: id - The id of the tree.; node - The node. like '/Root/Price' or '/0/0'. Leave empty, if you want to count rows of whole tree.; nodeSeparator - Separator to use for the node syntax. Default is @ for text values, also available & for index and % for regexp.; compareValue - The comparison value.; compareMode - The comparison mode = or ==, if the compareValue should be equal than the actual amount of rows. <, if the compareValue should be greater than the actual amount of rows. >, if the compareValue should be less than the actual amount of rows. <=, if the compareValue should be greater or equal than the actual amount of rows. >=, if the compareValue should be less or equal the actual amount of rows. !=, if the compareValue should be not equal the actual amount of items.; errorLevel - The kind of error, which should be logged. Either EXCEPTION, ERROR, WARNING or MESSAGE.; appearInReport - Flag, whether to show check in report, if a message or warning are set as errorLevel. If this is set to 1, the check will be shown in the report.
Exceptions:: UserException, - if wrong comparison mode has been set.
Author:: QFS
Since:: 5.0