Manual

Package Documentation for QFS Standard Library qfs.qft
Package Documentation for QFS Standard Library qfs.qftQF-Test
Version 4.2.5
Summary
Test-suiteqfs.qft
Directory

This suite contains useful standard procedures provided and maintained by Quality First Software GmbH.

For a description of packages and procedures of this library in javadoc format, see qfs.html in the same directory.

Package overview
PackageDescription
Packageqfs
This package contains helpful standard procedures provided by Quality First Software.
Procedures for testing based on images.
Packagefx
Procedures to replay events anywhere on a JavaFX application based on images.
Procedures to replay events anywhere on the screen based on images.
Procedures to replay events anywhere on a Swing application based on images.
Packageswt
Procedures to replay events anywhere on a SWT application based on images.
Packageweb
Procedures to replay events anywhere on a Web application based on images.
Contains procedures to work with native windows of the operating system Windows.
Contain procedures to handle Adobe Acrobat Reader specific tasks like SaveAs or SaveAs Text ...
Procedures to get and set the state of checkboxes in native windows applications.
Basic procedures for interacting with a component of a native windows application.
Dependencies for starting/stopping a native windows application.
Procedures used internally by the package qfs.autowin.component.
Procedures for replaying key events to a windows application.
Procedures to select menu items and checkbox menu items in native windows applications.
Packageawt
Procedures for advanced manipulation of awt components.
Procedures to select menu items.
Contains procedures to check components.
The procedures in this package are useful for generic cleanup after an exception is thrown.
Procedures for interacting with (SUT) clients.
Procedures to work with a QF-Test daemon.
Procedures to work with databases.
Procedures to bind data for data-driven testing.
Procedures for showing dialogs during the test-run.
Packagefx
Procedures for advanced manipulation of fx components.
Procedures to get and set the state of checkboxes.
The procedures in this package are useful for generic cleanup after an exception is thrown.
Procedures to handle comboboxes.
Procedures which work for any fx component.
Procedures for accessing lists.
Procedures for checking a list.
Procedures to (de-)select certain items of a list.
Procedures to select menu items and checkbox menu items.
Procedures to select items and checkbox menu items from popup menus.
Procedures to set and get the state of radio buttons.
Procedures to access sliders.
Procedure for checking slider values.
Procedures to work with TabbedPanes.
Procedures to access tables.
Procedures to set the state of checkboxes in a table-cell.
Procedures for checking a table.
Procedures to (de-)select certain rows of a table.
Procedures to access text fields and text areas.
Procedures to access trees.
Procedures for checking a tree.
Packagepdf
Procedures for PDF testing.
Procedures in order to highlight components.
Procedures to navigate inside a PDF document.
Procedures to get/interact with the current page / all pages.
Procedures for writing log-entries.
Procedures to write screenshots into the run-log.
Packageweb
Procedures to write web specifics into run-log.
Utility procedures for shell commands.
Procedures for advanced manipulation of swing components.
Procedures to set the state of checkboxes.
The procedures in this package are useful for generic cleanup after an exception is thrown.
Procedures to handle comboboxes.
Procedures to handle Dialogs.
Procedures for accessing file chooser dialogs.
Procedures which work for any Swing component.
Procedures for accessing lists.
Procedures for checking a list.
Procedures to (de-)select certain items of a list.
Procedures to select menu items and checkbox menu items.
Procedures for accessing standard error/message dialogs.
Procedures to select items and checkbox menu items from popup menus.
Procedures to get and set the state of radio buttons.
Procedures to access sliders.
Procedure for checking slider values.
Procedures for startup of swing applications.
Procedures to work with TabbedPanes.
Procedures to access tables.
Procedures to set the state of checkboxes in a table-cell.
Procedures for checking a table.
Procedures to (de-)select certain rows of a table.
Procedures to access text fields and text areas.
Procedures to access trees.
Procedures for checking a tree.
Packageswt
Procedures for advanced manipulation of SWT components.
Procedures to set the state of checkboxes.
The procedures in this package are useful for generic cleanup after an exception is thrown.
Procedures to handle Colordialogs.
Procedures to handle comboboxes.
Procedures for SWT CTabFolder widgets.
Procedures for accessing directory dialogs.
Procedures for accessing file dialogs.
Procedures which work for any SWT component.
Procedures for SWT instrumentation.
Procedures for accessing lists.
Procedures for checking a list.
Procedures to (de-)select certain items of a list.
Procedures to select menu items and checkbox menu items.
Procedures to select items and checkbox menu items from popup menus.
Procedures to set the state of buttons with the style SWT.RADIO.
Procedures to work with sash components.
Procedures to work with scrollbar components.
Procedures for SWT TabFolder widgets.
Procedures to access tables.
Procedures to set the checked state of tableitems.
Procedures for checking a table.
Procedures to (de-)select certain rows of a table.
Procedures to access text fields and text areas.
Procedures to access trees.
Procedures for checking a tree.
Special procedures for multi-column trees.
Miscellaneous utility procedures.
Accessing the clipboard from procedures.
Procedures for sending E-Mails.
Procedures for interacting with a POP3 server.
Contain procedures to work with files.
Procedures for generating random string.
Packagessh
Procedures for executing commands on a remote server via ssh.
 
Procedures for handling the test execution.
Procedures for skipping test-steps.
Procedures for stopping test-steps.
Procedures for working with variables.
Packagexml
Procedures for working with XML files.
Packageweb
Web utility procedures.
AJAX procedures.
Browser procedures.
Procedures for handling Error-Dialogs opened within the Browser.
Packagedom
Procedures for handling DOM access.
Procedures to handle downloads in QF-Test.
General browser procedures.
Mozilla utility procedures.
The procedures in this package are useful for customizing browser settings.
Procedures to set the state of checkboxes.
Procedures for handling different web checks.
Procedures for handling different element style checks.
Procedures for handling different element style checks concerning color attributes.
Procedures for handling different element style checks concerning font attributes.
Procedures which work for any Web component.
Procedures to access INPUT elements.
Procedures to set the state of buttons.
Procedures to access select nodes.
Procedures to access web tables.
Procedures for checking a table.
Procedures influencing recording of web tables.
Procedures to access text fields and text areas.
Package overview
Package/Procedure/DependencyDescription
Packageqfs
This package contains helpful standard procedures provided by Quality First Software.
Procedures for testing based on images.
Packagefx
Procedures to replay events anywhere on a JavaFX application based on images.
Click at an image anywhere on a JavaFX application.
Find an image anywhere on a JavaFX application and return the component ID.
Procedures to replay events anywhere on the screen based on images.
Click at an image anywhere on the screen.
Find an image anywhere on the screen and return its position.
Procedures to replay events anywhere on a Swing application based on images.
Click at an image anywhere on a JFrame of a swing application.
Find an image anywhere on a JFrame of a Swing application and return the component ID.
Packageswt
Procedures to replay events anywhere on a SWT application based on images.
Click at an image anywhere on a Shell of a SWT application.
Find an image anywhere on a Shell of a SWT application and return the component ID.
Packageweb
Procedures to replay events anywhere on a Web application based on images.
Click at an image anywhere on a web application.
Find an image anywhere on a web application and return the component ID.
Contains procedures to work with native windows of the operating system Windows.
Contain procedures to handle Adobe Acrobat Reader specific tasks like SaveAs or SaveAs Text ...
Save the current open PDF in Adobe Acrobat Reader as a text file with the given filename.
Save the current open PDF in Adobe Acrobat Reader as a PDF file with the given filename.
Procedures to get and set the state of checkboxes in native windows applications.
Check the value of the given component.
Deselect a checkbox.
Return the value of a checkbox.
Select a checkbox.
Procedureset
Set checkbox to the given state.
Check, whether a native window on the operating system Windows is opened.
Check, whether a native window on the operating system Windows is opened and close it.
Close a window.
Basic procedures for interacting with a component of a native windows application.
Check the position, width and height of the component on the screen.
Check the image of a given component.
Compare the given name to the name of a component according to the compareMode.
Wrapper procedure to either check the value of a component or, if no value exists, the name.
Compare the given value to the value of a component according to the compareMode.
Click a given component.
Set the global variable __uiauto_control to the GUI element matching the given parameters in the given window.
Fetch the screen coordinates for the left border, top, width and height for the component.
Return the name of the given control.
Return the value or, if it does not exist, the name of the given control.
Return the value of the given control.
Set a given text to a component if the method setText() is implemented by the IUIAutomationElement Interface of the component.
Set a given value to a component.
Set the global variable __uiauto_control to the GUI element matching the given parameters in the given window.
Dependencies for starting/stopping a native windows application.
Start a native windows application as the SUT (system under test) using the dependency funtionality.
Read the URL from an InternetExplorer window.
Procedures used internally by the package qfs.autowin.component.
Check if the operation system is Microsoft Windows.
Print information provided by the IUIAutomationElement Interface of the given GUI control to the QF-Test terminal: name, value, clickable point, class name, bounding rectangle, control type, automation id and methods.
Print name, class name, control type and automation id of controls in the given windows to the QF-Test terminal.
Write name, class name, control type and automation id of controls in the given windows to a file.
Print the titles of all windows on the desktop of Microsoft Windows to the QF-Test terminal.
Set the window with the given title to the foreground on the desktop.
Procedures for replaying key events to a windows application.
Perform Ctrl+a to the given window to mark all text of the compontent which has the focus.
Perform Ctrl+v to the given window to paste the content of the clipboard to the component with the focus.
Perform Ctrl+x to the given window to cut the selected content of the component with the focus.
Replay DELETE to the given window.
Replay ENTER to the given window.
Replay TAB to the given window.
Send the given key along with the qualifier to the window with the given title.
Write all children of a window to the run-log.
Perform Ctrl+A and then Ctrl+C to a given window.
Procedures to select menu items and checkbox menu items in native windows applications.
Select an item from a menu.
Mark and copy the whole text of a given document via Ctrl+A and Ctrl+C.
Packageawt
Procedures for advanced manipulation of awt components.
Procedures to select menu items.
Select an item from a menu.
Select an item from a menu.
Select a checkbox item from a menu.
Select a checkbox item from a menu in a sub-menu.
Contains procedures to check components.
Check the state of a given component.
Check image of a component against a file.
Check if given component is selected.
Check the text of a given component.
Check whether a value is in a given range.
Compare two values for their equality.
Compare two date strings.
Compare two values for their equality.
Compare two values for their equality.
The procedures in this package are useful for generic cleanup after an exception is thrown.
Close all dialogs.
Close all menus unconditionally.
Close all modal dialogs.
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.
Procedures for interacting with (SUT) clients.
Rename an SUT client.
Write a string to the stdin stream of a process started by QF-Test.
Helper method for turning on internal logging.
Helper method for turning off internal logging.
Procedures to work with a QF-Test daemon.
Starts remote instrumentation procedure for an Eclipse/RCP based or standalone SWT application via a given daemon.
Locate all running daemons and writes them into the run-log and prints a list of running daemons to the terminal.
Start a client application on a remote host via the QF-Test daemon.
Procedures to work with databases.
Build up connection to a given database and executes a specified select-sql-statement.
Build up connection to a given database and execute a specified SQL-statement.
Procedures to bind data for data-driven testing.
Create and register a databinder that binds a list of values to a variable.
Create and register a databinder that binds a list of value-sets to a set of variables.
Procedures for showing dialogs during the test-run.
Show a configurable dialog equivalent to JOptionPane.
Show an information dialog with an OK option.
Show an information dialog with a YES, NO and CANCEL option.
Show an information dialog with a YES and NO option.
Packagefx
Procedures for advanced manipulation of fx components.
Procedures to get and set the state of checkboxes.
Deselect a checkbox.
Deselect a checkbox.
Return the value of a checkbox.
Select a checkbox.
Select a checkbox.
Procedureset
Set checkbox to the given state.
Set checkbox to the given state.
The procedures in this package are useful for generic cleanup after an exception is thrown.
Close all menus unconditionally.
Close all modal dialogs.
Close a menu by replaying an [Escape] keystroke on a Window.
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.
Procedures to handle comboboxes.
Return the current index of a given item.
Return the number of items of a given combobox.
Return the text of a given combobox.
Return the text of a given item.
Select specified value of a given combobox.
Set a value in the combobox.
Select specified value of a given combobox using a SUT script.
Procedures which work for any fx component.
Click on a given component, but only if the according parameter is set to true.
Click on a given component, but only if the according parameter is set to true.
Delete the current association of PriorityFxNode.
Click on a given component.
Click on a given component.
Send a selection event to a given component.
Set the location of a given component.
Set a given component to the PriorityFxNode.
Set the width and the height of a given component.
Wait for a given component.
Wait till a given component disappears.
Procedures for accessing lists.
Procedures for checking a list.
Check the number of items of a given list according to a specified comparison mode.
Select a given item by a mouse-click on it.
Return the current index of a given item.
Return the number of items of a given list.
Return the text of a given item.
Procedures to (de-)select certain items of a list.
Deselect all items.
Deselect a given item, specified by its index.
Deselect a range of items, specified by their index.
Select all items.
Select a given item, specified by its index.
Select a range of items, specified by their index.
Select a given item by a mouse-click on it.
Procedures to select menu items and checkbox menu items.
Select a checkbox menu item from a menu.
Select a checkbox menu item from a menu.
Select an item from a menu.
Select an item from a menu.
Select an item from a menu.
Select an item from a menu.
Select an item within a submenu.
Select an item within a submenu.
Select a checkbox menu item.
Select a checkbox menu item.
Select a checkbox menu item within within a submenu.
Select a checkbox menu item within within a submenu.
Procedures to select items and checkbox menu items from popup menus.
Select an item in a popup menu.
Select an item in a popup menu.
Select an item within a submenu of a popup menu.
Select an item within a submenu of a popup menu.
Select a checkbox menu item in a popup menu.
Select a checkbox menu item in a popup menu.
Select a checkbox menu item within a submenu of a popup menu.
Select a checkbox menu item within a submenu of a popup menu.
Procedures to set and get the state of radio buttons.
Return the value of a radio button.
Select a radio button.
Select a radio button.
Procedures to access sliders.
Procedure for checking slider values.
Check the value of a slider component.
Return the value of a slider component.
Set the value of a slider component.
Procedures to work with TabbedPanes.
Close a tab via a selection event.
Return the index of a given tab in a TabPane.
Return the text of a given tab in a TabPane.
Select a tab in a given TabPane.
Procedures to access tables.
Procedures to set the state of checkboxes in a table-cell.
Deselect a checkbox in a table-cell.
Deselect a checkbox in a table-cell.
Select a checkbox in a table-cell.
Select a checkbox in a table-cell.
Procedureset
Set checkbox in a table-cell to the given state.
Set checkbox in a table-cell to the given state.
Procedures for checking a table.
Check the number of rows of a given table according to a specified comparison mode.
Select a given cell.
Return the number of columns of a given table.
Return the current index of a given column.
Return the header text of a given column.
Return the number of rows of a given table.
Return the row number of a given cell.
Return the text of a given cell.
Resize width of a table column.
Select a given cell.
Procedures to (de-)select certain rows of a table.
Deselect all rows.
Deselect a given row, specified by its index.
Deselect a range of rows, specified by their index.
Select all rows.
Select a given row, specified by its index.
Select a range of rows, specified by their index.
Procedures to access text fields and text areas.
Clear a multi-line text area.
Clear a simple text field.
Return the text of a given textfield.
Set a given text to a given text-field or text-area.
Read the content of a given file and set its content to a given text-field.
Procedures to access trees.
Procedures for checking a tree.
Check the number of child nodes of a given tree node according to a specified comparison mode.
Check the number of visible nodes under a given tree or tree node according to a specified comparison mode.
Select a given node.
Collapse a tree node.
Collapse a tree node.
Collapse a tree node recursively.
Collapse a tree node.
Collapse a tree node.
Expand a tree node.
Expand a tree node.
Expand a tree node recursively.
Expand a tree node.
Expand a tree node.
Return the number of child nodes.
Return the current index of a given node.
Return the number of visible nodes under a given tree or tree-node.
Return the text of a given node.
Select a given node.
Packagepdf
Procedures for PDF testing.
Procedures in order to highlight components.
Hide borders around each recognized component.
Show borders around each recognized component.
Toggle borders around each recognized component.
Procedures to navigate inside a PDF document.
Iterate over all pages in a PDF document.
Open the first page of the PDF document.
Open the last page of the PDF document.
Open/Goto the next page of the PDF document.
Open a specific page of the PDF document.
Open/Goto the previous page of the PDF document.
Open a random page of the PDF document.
Procedures to get/interact with the current page / all pages.
Return the name of the currently selected page in the PDF document.
Return the index/number of the currently selected page in the PDF document.
Return the number of pages in a PDF document.
Refresh the currently opened page.
Procedures for writing log-entries.
Write an error into the run-log.
Write a message into the run-log.
Write a warning into the run-log.
Procedures to write screenshots into the run-log.
Return the total number of monitors.
Write an image of a component into the run-log.
Write a screenshot of the whole screen into the run-log.
Write a screenshots of a given monitor into the run-log.
Packageweb
Procedures to write web specifics into run-log.
Write a document's source code into the run-log.
Utility procedures for shell commands.
Copy a given file or directory to a given target.
Delete a file.
Check whether a given file or directory exists.
Return the basename of the given file or directory.
Return the parent directory of the given file or directory.
Create a given directory.
Move a given file or directory to a given target.
Remove a given directory.
Create a given file or update the last modified date of an existing file.
Procedures for advanced manipulation of swing components.
Procedures to set the state of checkboxes.
Deselect a checkbox.
Deselect a checkbox.
Return the value of a checkbox.
Select a checkbox.
Select a checkbox.
Procedureset
Set checkbox to the given state.
Set checkbox to the given state.
The procedures in this package are useful for generic cleanup after an exception is thrown.
Close all dialogs.
Close all menus unconditionally.
Close all modal dialogs.
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.
Procedures to handle comboboxes.
Return the current index of a given item.
Return the number of items of a given combobox.
Return the text of a given combobox.
Return the text of a given item.
Select specified value of a given combobox.
Set a value in the combobox.
Select specified value of a given combobox using a SUT script.
Procedures to handle Dialogs.
Wait for the client to connect and check whether a Java security dialog blocks the JRE start which need to be confirmed.
Procedures for accessing file chooser dialogs.
Uninstall the JFileChooser name resolver.
Install the JFileChooser name resolver.
Select a file in a JFileChooser dialog.
Select several files in a JFileChooser dialog.
Procedures which work for any Swing component.
Click on a given component, but only if the according parameter is set to true.
Click on a given component, but only if the according parameter is set to true.
Delete the current association of PriorityAwtSwingComponent.
Click on a given component.
Click on a given component.
Send a selection event to a given component.
Set the location of a given component.
Set a given component to the PriorityAwtSwingComponent.
Set the width and the height of a given component.
Wait for a given component.
Wait till a given component disappears.
Procedures for accessing lists.
Procedures for checking a list.
Check the number of items of a given list according to a specified comparison mode.
Select a given item by a mouse-click on it.
Return the current index of a given item.
Return the number of items of a given list.
Return the text of a given item.
Procedures to (de-)select certain items of a list.
Deselect all items.
Deselect a given item, specified by its index.
Deselect a range of items, specified by their index.
Select all items.
Select a given item, specified by its index.
Select a range of items, specified by their index.
Select a given item by a mouse-click on it.
Procedures to select menu items and checkbox menu items.
Select a checkbox menu item from a menu.
Select a checkbox menu item from a menu.
Select an item from a menu.
Select an item from a menu.
Select an item from a menu.
Select an item from a menu.
Select an item within a submenu.
Select an item within a submenu.
Select a checkbox menu item.
Select a checkbox menu item.
Select a checkbox menu item within within a submenu.
Select a checkbox menu item within within a submenu.
Procedures for accessing standard error/message dialogs.
Check the message of the current javax.swing.JOptionPane dialog.
Check the title of the current javax.swing.JOptionPane dialog.
Click on the Cancel Button of the current javax.swing.JOptionPane dialog.
Click on the No Button of the current javax.swing.JOptionPane dialog.
Click on the OK Button of the current javax.swing.JOptionPane dialog.
Click on the Yes Button of the current javax.swing.JOptionPane dialog.
Uninstall the JOptionPane name resolver.
Install the JOptionPane name resolver.
Get the message of the current javax.swing.JOptionPane dialog.
Return the message Type of the current javax.swing.JOptionPane dialog.
Get the title of the current javax.swing.JOptionPane dialog.
Check if the current javax.swing.JOptionPane dialog has an Cancel Button.
Check if the current javax.swing.JOptionPane dialog has an NO Button.
Check if the current javax.swing.JOptionPane dialog has an OK Button.
Check if the current javax.swing.JOptionPane dialog has an YES Button.
Check, if current window is a javax.swing.JOptionPane ErrorDialog.
Check, if current window is a javax.swing.JOptionPane InfoDialog.
Check, if current window is a javax.swing.JOptionPane dialog.
Check, if current window is a javax.swing.JOptionPane PlainDialog.
Check, if current window is a javax.swing.JOptionPane QuestionDialog.
Check, if current window is a javax.swing.JOptionPane WarningDialog.
Procedures to select items and checkbox menu items from popup menus.
Select an item in a popup menu.
Select an item in a popup menu.
Select an item within a submenu of a popup menu.
Select an item within a submenu of a popup menu.
Select a checkbox menu item in a popup menu.
Select a checkbox menu item in a popup menu.
Select a checkbox menu item within a submenu of a popup menu.
Select a checkbox menu item within a submenu of a popup menu.
Procedures to get and set the state of radio buttons.
Return the value of a radio button.
Select a radio button.
Select a radio button.
Procedures to access sliders.
Procedure for checking slider values.
Check the value of a slider component
Return the value of a slider component.
Set the value of a slider component.
Procedures for startup of swing applications.
Set delays for the QF-Test SUT initialization process.
Define properties for recognizing WebStart and applet security dialogs that should be closed automatically.
Start an applet as SUT in a browser.
Start a Webstart SUT.
Procedures to work with TabbedPanes.
Close a tab via clicking on the "X "button.
Return the index of a given tab in a JTabbedPane.
Return the text of a given tab in a JTabbedPane.
Select a tab in a given TabbedPane.
Procedures to access tables.
Procedures to set the state of checkboxes in a table-cell.
Deselect a checkbox in a table-cell.
Deselect a checkbox in a table-cell.
Select a checkbox in a table-cell.
Select a checkbox in a table-cell.
Procedureset
Set checkbox in a table-cell to the given state.
Set checkbox in a table-cell to the given state.
Procedures for checking a table.
Check the number of rows of a given table according to a specified comparison mode.
Select a given cell.
Return the number of columns of a given table.
Return the current index of a given column.
Return the header text of a given column.
Return the number of rows of a given table.
Return the row number of a given cell.
Return the text of a given cell.
Resize width of a table column.
Select a given cell.
Procedures to (de-)select certain rows of a table.
Deselect all rows.
Deselect a given row, specified by its index.
Deselect a range of rows, specified by their index.
Select all rows.
Select a given row, specified by its index.
Select a range of rows, specified by their index.
Procedures to access text fields and text areas.
Clear a multi-line text area.
Clear a simple text field.
Return the text of a given textfield.
Set a given text to a given text-field or text-area.
Read the content of a given file and set its content to a given text-field.
Procedures to access trees.
Example for a callback procedure used by expandNodes.
Procedures for checking a tree.
Check the number of child nodes of a given tree node according to a specified comparison mode.
Check the number of visible nodes under a given tree or tree node according to a specified comparison mode.
Select a given node.
Collapse a tree node.
Collapse a tree node.
Collapse a tree node recursively.
Collapse a tree node.
Collapse a tree node.
Expand a tree node.
Expand a tree node.
Expand a tree node recursively.
Expand a tree node recursively.
Expand a tree node.
Expand a tree node.
Return the number of child nodes.
Return the current index of a given node.
Return the number of visible nodes under a given tree or tree-node.
Return the text of a given node.
Select a given node.
Packageswt
Procedures for advanced manipulation of SWT components.
Procedures to set the state of checkboxes.
Deselect a checkbox.
Deselect a checkbox.
Return the value of a checkbox.
Select a checkbox.
Select a checkbox.
Procedureset
Set checkbox to the given state.
Set checkbox to the given state.
The procedures in this package are useful for generic cleanup after an exception is thrown.
Close all modal dialogs.
Close all menus unconditionally.
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.
Procedures to handle Colordialogs.
Select a specified color of a ColorDialog.
Procedures to handle comboboxes.
Return the current index of a given item.
Return the number of items of a given combobox.
Return the text of a given combo.
Return the text of a given item.
Select specified value of a given combobox using a selection event.
Select specified value of a given combobox using a SUT script.
Procedures for SWT CTabFolder widgets.
This procedure raises an error, if a given tab is not dirty.
Close a tab in a generic CTabFolder that is identified only by the fact that it contains the desired tab.
Open the View Menu for a generic CTabFolder that is identified only by the fact that it contains the desired tab.
Select a tab in a generic CTabFolder that is identified only by the fact that it contains the desired tab.
Procedures for accessing directory dialogs.
Select a directory in a DirectoryDialog dialog.
Procedures for accessing file dialogs.
Select a file in a FileDialog dialog.
Procedures which work for any SWT component.
Click on a given component, but only if the according parameter is set to true.
Click on a given component, but only if the according parameter is set to true.
Delete the current association of PrioritySwtComponent.
Click on a given component.
Click on a given component.
Send a selection event to a given component.
Set the location of a given component.
Set a given component to the PrioritySwtWidget.
Set the width and the height of a given component.
Wait for a given component.
Wait till a given component disappears.
Procedures for SWT instrumentation.
Instrument an Eclipse/RCP based or standalone SWT application for use with QF-Test.
Procedures for accessing lists.
Procedures for checking a list.
Check the number of items of a given list according to a specified comparison mode.
Select a given item by a mouse-click on it.
Return the current index of a given item.
Return the number of items of a given list.
Return the text of a given item.
Procedures to (de-)select certain items of a list.
Deselect all items.
Deselect a given item, specified by its index.
Deselect a range of items, specified by their index.
Select all items.
Select a given item, specified by its index.
Select a range of items, specified by their index.
Select a given item by a mouse-click on it.
Procedures to select menu items and checkbox menu items.
Select a checkbox menu item from a menu.
Select an item from a menu.
Select an item from a menu.
Select an item within a submenu.
Select a checkbox menu item.
Select a checkbox menu item within within a submenu.
Procedures to select items and checkbox menu items from popup menus.
Select an item in a popup menu.
Select an item within a submenu of a popup menu.
Select a checkbox menu item in a popup menu.
Select a checkbox menu item within a submenu of a popup menu.
Procedures to set the state of buttons with the style SWT.RADIO.
Return the value of a radio button.
Select a radio button.
Select a radio button.
Procedures to work with sash components.
Move a sash by a given distance.
Move a sash to a given position.
Procedures to work with scrollbar components.
Scroll a component one page downwards by simulating a hard mouse click below the scrollbar's thumb.
Scroll a component one page to the left by simulating a hard mouse click to the left of the scrollbar's thumb.
Scroll a component one page to the right by simulating a hard mouse click to the right of the scrollbar's thumb.
Scroll a component one page upwards by simulating a hard mouse click above the scrollbar's thumb.
Scroll a component downwards by simulating a hard mouse click on the down arrow button of its vertical scrollbar.
Scroll a component to the left by simulating a hard mouse click on the left arrow button of its horizontal scrollbar.
Scroll a component to the right by simulating a hard mouse click on the right arrow button of its horizontal scrollbar.
Scroll a component upwards by simulating a hard mouse click on the up arrow button of its vertical scrollbar.
Procedures for SWT TabFolder widgets.
Close a tab via sending a "close" selection event.
Return the index of a given tab.
Return the text of a given tab.
Select a tab in a given Tabfolder.
Procedures to access tables.
Procedures to set the checked state of tableitems.
Unset the checked state of a tableitem in a table.
Set the checked state of a tableitem in a table.
Procedureset
Set checked state of a tableitem to the given state.
Procedures for checking a table.
Check the number of rows of a given table according to a specified comparison mode.
Select a given cell.
Return the number of columns of a given table.
Return the current index of a given column.
Return the header text of a given column.
Return the number of rows of a given table.
Return the row number of a given cell.
Return the text of a given cell.
Select a given cell.
Procedures to (de-)select certain rows of a table.
Deselect all rows.
Deselect a given row, specified by its index.
Deselect a range of rows, specified by their index.
Select all rows.
Select a given row, specified by its index.
Select a range of rows, specified by their index.
Procedures to access text fields and text areas.
Clear a multi-line text area.
Clear a simple text field.
Return the text of a given textfield.
Set a given text to a given text-field or text-area.
Read the content of a given file and set its content to a given text-field.
Procedures to access trees.
Example for a callback procedure used by expandNodes.
Procedures for checking a tree.
Check the number of child nodes of a given tree node according to a specified comparison mode.
Check the number of visible nodes under a given tree or tree node according to a specified comparison mode.
Select a given node.
Collapse a tree node.
Collapse a tree node.
Collapse a tree node.
Collapse a tree node.
Expand a tree node.
Expand a tree node.
Expand a tree node recursively.
Expand a tree node recursively.
Expand a tree node.
Expand a tree node.
Return the number of child nodes.
Return the hierarchical index of a given node.
Return the number of visible nodes under a given tree or tree-node.
Return the text of a given node.
Special procedures for multi-column trees.
Return the index of the first row containing a given cell text in a given column of an SWT multi-column tree.
Select a given node.
Miscellaneous utility procedures.
Accessing the clipboard from procedures.
Return the current text on the system clipboard.
Set a text on the system clipboard.
Trigger a full thread dump in the SUT if possible.
Drag the source component or item onto the target and drop it.
Dump an entire component hierarchy into the run-log.
Dump the heap of the Java VM.
Procedures for sending E-Mails.
Procedures for interacting with a POP3 server.
Delete all messages from a pop3 account.
Fetch a message from a pop3 account.
This procedure uses the smtplib module from Jython, to send emails via SMTP server.
Send an e-mail.
Contain procedures to work with files.
Check, whether a given file contain a specific value.
Check, whether a given file contain a specific value in a line.
Compare the given files and returns true if equal, otherwise false.
Read a worksheet of an Excel file.
Get the screen location and the size of a component or sub-item.
Return a date, default is the current date in current locale.
Return the time in the current format.
Return a timestamp, which represents the current time in milliseconds.
Kill all running clients.
Kill a client.
Log all available methods of a given component.
Log current memory use.
Log current memory usage of the native process(es) of a client.
Print a given message to STDOUT.
Print the content of a variable.
Procedures for generating random string.
Return a random string created of parts of a specified area.
Return a random number.
Return a random number between two given numbers.
Return a random string containing small letters.
Read the content of a given file.
Sleep a given time.
Packagessh
Procedures for executing commands on a remote server via ssh.
Connect to a remote server by ssh and execute a command.
 
Close an established ssh connection.
Connect to a remote server by ssh and keep the session open for further use.
Send a command via an established ssh connection and wait for resulting output.
Procedures for handling the test execution.
Procedures for skipping test-steps.
Skip the execution of the current test-case.
Skip the execution of the current test-set.
Procedures for stopping test-steps.
Stop the execution of the current test-case
Stop the complete test-run.
Stop the execution of the current test-set.
Procedures for working with variables.
Delete all global QF-Test variables.
Delete all global QF-Test variables.
Delete a given global QF-Test variable.
Delete a given variable of a property group.
Delete a given global property group.
Print a list of all members of a given property group to the terminal.
Wait until one of N components is available.
Write a given message into a given file.
Packagexml
Procedures for working with XML files.
Compare two XML files for full identity.
Load properties from an XML file.
Packageweb
Web utility procedures.
AJAX procedures.
Dump properties of an installed CustomWebResolver.
Install a generic CustomWebResolver for an Ajax framework.
Install a special resolver for given AJAX toolkit to improve recorded component types and hierarchy and therefore achieves improved component recognition.
Uninstall a previously installed generic CustomWebResolver.
Uninstall a special resolver for given AJAX toolkit.
Updates properties of an installed generic CustomWebResolver.
Browser procedures.
Procedures for handling Error-Dialogs opened within the Browser.
Uses the Java AWT Robot/Autowin Methods to automatically close an open Certificate Warning Dialog.
Uses the Java AWT Robot Methods to automatically close an open Javascript Warning Dialog.
Handle the native Windows Upload dialog (especially for Internet Explorer 8).
Packagedom
Procedures for handling DOM access.
Check or uncheck all (enabled) Checkboxes which are situated in the DOM-Tree beneath the given Parent.
Procedures to handle downloads in QF-Test.
Set the QF-Test download property.
General browser procedures.
Check for the browser and if is not running than start it.
Checks if running Browser-Engine has embedded Internet Explorer 6.
Opens a new browser window which emulates a mobile browser.
Open a new window in an already running browser.
Show a different URL in an open browser window.
Ensures the given browser executable is started as a new process.
Mozilla utility procedures.
Performs several cleanup actions on the given mozProfile directory.
The procedures in this package are useful for customizing browser settings.
Delete cookies.
Disable cookies in the browser.
Do startup settings for the browser.
Empty the browser cache.
Sets the compatibilitymode in Internet Explorer.
Enable cookies in the browser.
Enable/Disable MutationListeners in the QF-Test browser engine for a specific document or globally for all documents.
Set preferred language for in the displaying web pages in the browser.
Set a proxy server for the browser.
Procedures to set the state of checkboxes.
Deselect a checkbox.
Deselect a checkbox If the checkbox is already de-selected, no action is performed.
Return the value of a checkbox.
Select a checkbox.
Select a checkbox.
Procedureset
Set checkbox to the given state.
Set all (enabled) checkboxes inside a given parent.
Set checkbox to the given state.
Procedures for handling different web checks.
Checks an attribute of a component.
Negates a normal Elementcheck in select elements to allow NegationChecks.
Checks if the given element (option-element-text) is in the select-element (combobox).
Negates a normal WaitForComponentCheck to allow VisibilityChecks.
Negates a normal Textcheck to allow NegationChecks.
Checks the title of the BrowserWindow.
Procedures for handling different element style checks.
Checks a specific style attribute for the given component.
Procedures for handling different element style checks concerning color attributes.
Checks the value that indicates the color behind the content of the component.
Checks the value that indicates the color of the text of the component.
Procedures for handling different element style checks concerning font attributes.
Checks the name of the font used for text in the component.
Checks the value that indicates the font size used for text in the component
Checks the value that indicates the font style used for text in the component (italic, normal or oblique)
Returns the value of a specific style attribute of the given component.
Procedures which work for any Web component.
Click on a given component, but only if the according parameter is set to true.
Click on a given component, but only if the according parameter is set to true.
Clicks the given component with increasingly hard mouse clicks and waits for the given action to be performed.
Delete the current association of PriorityWebComponent.
Click on a given component.
Click on a given component.
Simulate a drag&drop operation.
Return document's source code.
Integrates Firebug Lite from http://getfirebug.com into an open browser window for an easier analysis of the DOM.
Set a given component to the PriorityWebComponent.
Wait for a given component.
Wait till a given component disappears.
Procedures to access INPUT elements.
Set the value of the INPUT:FILE node by whatever means that are applicable for the browser.
Procedures to set the state of buttons.
Return the value of a radio button.
Select a radio button.
Select a radio button.
Procedures to access select nodes.
Return the current index of a given item.
Return the number of items of a given select.
Return the current value of a given select node.
Return the current text of a given item.
Select a given value in a Select node.
Procedures to access web tables.
Procedures for checking a table.
Check the number of columns of a given table according to a specified comparison mode.
Check the number of rows of a given table according to a specified comparison mode.
Select a given cell.
Return the number of columns of a given web table.
Return the current index of a given column.
Return the header text of a given column.
Return the number of rows of a given table.
Return the row number of a given cell.
Return the text of a given cell.
Procedures influencing recording of web tables.
Activate recording of item based access for a given web table.
Deactivate recording of item based access for a given web table.
Select a given cell.
Procedures to access text fields and text areas.
Clear a multi-line text area.
Clear a simple text field.
Return the text of a given textfield.
Set a given text to a given text-field or text-area.
Read the content of a given file and set its content to a given text-field.
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: 'autoscreen'

Procedures for testing based on images.

Author:
QFS,mh
Since:
3.5M1
Package: 'fx'

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

Author:
QFS,mh
Since:
4.1.0
Procedure/DependencyDescription
ProcedureclickAtImage
Click at an image anywhere on a JavaFX application.
ProceduregetComponentAtImage
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.
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/DependencyDescription
ProcedureclickAtImage
Click at an image anywhere on the screen.
ProceduregetPositionOfImage
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.
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/DependencyDescription
ProcedureclickAtImage
Click at an image anywhere on a JFrame of a swing application.
ProceduregetComponentAtImage
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.
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/DependencyDescription
ProcedureclickAtImage
Click at an image anywhere on a Shell of a SWT application.
ProceduregetComponentAtImage
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.
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/DependencyDescription
ProcedureclickAtImage
Click at an image anywhere on a web application.
ProceduregetComponentAtImage
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.
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/DependencyDescription
ProcedurecheckForExistence
Check, whether a native window on the operating system Windows is opened.
ProcedurecheckForExistenceAndClose
Check, whether a native window on the operating system Windows is opened and close it.
Procedureclose
Close a window.
ProceduregetURLFromIE
Read the URL from an InternetExplorer window.
ProcedurelogChildWindows
Write all children of a window to the run-log.
ProceduremarkAllAndCopy
Perform Ctrl+A and then Ctrl+C to a given window.
ProceduresaveTextToFileViaClipboard
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.

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.

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.

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'

Read the URL from an InternetExplorer window.

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.

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

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'

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'

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

Author:
QFS,tm
Since:
3.4.0
Procedure/DependencyDescription
ProceduresaveAsText
Save the current open PDF in Adobe Acrobat Reader as a text file with the given filename.
ProceduresavePDF
Save the current open PDF in Adobe Acrobat Reader as a PDF file with the given filename.
Procedure: 'saveAsText'

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.
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.
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'

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/DependencyDescription
ProcedurecheckValue
Check the value of the given component.
Proceduredeselect
Deselect a checkbox.
ProceduregetValue
Return the value of a checkbox.
Procedureselect
Select a checkbox.
Procedureset
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.

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'

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'

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'

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'

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/DependencyDescription
ProcedurecheckGeometry
Check the position, width and height of the component on the screen.
ProcedurecheckImage
Check the image of a given component.
ProcedurecheckName
Compare the given name to the name of a component according to the compareMode.
ProcedurecheckText
Wrapper procedure to either check the value of a component or, if no value exists, the name.
ProcedurecheckValue
Compare the given value to the value of a component according to the compareMode.
Procedureclick
Click a given component.
ProceduregetControl
Set the global variable __uiauto_control to the GUI element matching the given parameters in the given window.
ProceduregetGeometry
Fetch the screen coordinates for the left border, top, width and height for the component.
ProceduregetName
Return the name of the given control.
ProceduregetText
Return the value or, if it does not exist, the name of the given control.
ProceduregetValue
Return the value of the given control.
ProceduresetText
Set a given text to a component if the method setText() is implemented by the IUIAutomationElement Interface of the component.
ProceduresetValue
Set a given value to a component.
ProcedurewaitForComponent
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.
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'

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.
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'

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'

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'

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'

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'

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'

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 a comma-separaed list: left,top,width,height.
Author:
QFS,ue
Since:
4.2.3
Procedure: 'getName'

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'

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.
Author:
QFS,ue
Since:
4.2.3
Procedure: 'getValue'

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'

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'

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'

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:
ComponentNotException - 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/DependencyDescription
DependencySUT_started
Start a native windows application as the SUT (system under test) using the dependency funtionality.
Dependency: 'SUT_started'

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 the 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/DependencyDescription
ProcedurecheckIfWindows
Check if the operation system is Microsoft Windows.
ProceduredumpComponent
Print information provided by the IUIAutomationElement Interface of the given GUI control to the QF-Test terminal: name, value, clickable point, class name, bounding rectangle, control type, automation id and methods.
ProceduredumpComponents
Print name, class name, control type and automation id of controls in the given windows to the QF-Test terminal.
ProceduredumpComponentsToFile
Write name, class name, control type and automation id of controls in the given windows to a file.
ProceduredumpDesktopWindows
Print the titles of all windows on the desktop of Microsoft Windows to the QF-Test terminal.
ProceduresetWindowToForeground
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.

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 of 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: name, value, clickable point, class name, bounding rectangle, control type, automation id and methods.

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.

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.

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.

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/DependencyDescription
ProcedurepressCtrlA
Perform Ctrl+a to the given window to mark all text of the compontent which has the focus.
ProcedurepressCtrlV
Perform Ctrl+v to the given window to paste the content of the clipboard to the component with the focus.
ProcedurepressCtrlX
Perform Ctrl+x to the given window to cut the selected content of the component with the focus.
ProcedurepressDelete
Replay DELETE to the given window.
ProcedurepressEnter
Replay ENTER to the given window.
ProcedurepressTab
Replay TAB to the given window.
ProceduresendKey
Send the given key along with the qualifier to the window with the given title.
Procedure: 'pressCtrlA'

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'

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'

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'

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'

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'

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/DependencyDescription
ProcedureselectItem
Select an item from a menu.
Procedure: 'selectItem'

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/DependencyDescription
ProcedureselectItem
Select an item from a menu.
ProcedureselectItemWithSubMenu
Select an item from a menu.
ProceduresetCheckItem
Select a checkbox item from a menu.
ProceduresetSubCheckItem
Select a checkbox item from a menu in a sub-menu.
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 sub-menu, 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 sub-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 sub-menu, 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'

Contains procedures to check components.

Author:
QFS,mm
Since:
2.1.0
Procedure/DependencyDescription
ProcedurecheckEnabledStatus
Check the state of a given component.
ProcedurecheckImageAgainstFile
Check image of a component against a file.
ProcedurecheckSelectedStatus
Check if given component is selected.
ProcedurecheckText
Check the text of a given component.
ProcedurecheckValueInRange
Check whether a value is in a given range.
ProcedurecheckValueToBeEqual
Compare two values for their equality.
ProcedurecompareDates
Compare two date strings.
ProcedurecompareTwoNumbers
Compare two values for their equality.
ProcedurecompareTwoStringValues
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: '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 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/DependencyDescription
ProcedurecloseAllDialogs
Close all dialogs.
ProcedurecloseAllMenus
Close all menus unconditionally.
ProcedurecloseAllModalDialogs
Close all modal dialogs.
ProcedureimplicitExceptionHandler
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.

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.

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/DependencyDescription
ProcedurerenameClient
Rename an SUT client.
ProceduresendInput
Write a string to the stdin stream of a process started by QF-Test.
ProcedurestartLogging
Helper method for turning on internal logging.
ProcedurestopLogging
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:
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/DependencyDescription
ProcedureinstrumentRemoteSwt
Starts remote instrumentation procedure for an Eclipse/RCP based or standalone SWT application via a given daemon.
ProcedurelocateDaemons
Locate all running daemons and writes them into the run-log and prints a list of running daemons to the terminal.
ProcedurestartRemoteSUT
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.

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.
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/DependencyDescription
ProcedureexecuteSelectStatement
Build up connection to a given database and executes a specified select-sql-statement.
ProcedureexecuteStatement
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.
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/DependencyDescription
ProcedurebindList
Create and register a databinder that binds a list of values to a variable.
ProcedurebindSets
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/DependencyDescription
ProcedureshowConfigurabableDialog
Show a configurable dialog equivalent to JOptionPane.
ProcedureshowInformationMessageDialog
Show an information dialog with an OK option.
ProcedureshowYes_No_Cancel_Dialog
Show an information dialog with a YES, NO and CANCEL option.
ProcedureshowYes_No_Dialog
Show an information dialog with a YES and NO option.
Procedure: 'showConfigurabableDialog'

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.
Returns:
The code for the clicked button. 0 for YES/OK, 1 for NO, 2 for CANCEL, 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: '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/DependencyDescription
Proceduredeselect
Deselect a checkbox.
ProceduredeselectWithCoordinates
Deselect a checkbox.
ProceduregetValue
Return the value of a checkbox.
Procedureselect
Select a checkbox.
ProcedureselectWithCoordinates
Select a checkbox.
Procedureset
Set checkbox to the given state.
ProceduresetWithCoordinates
Set checkbox to the given state.
Procedure: 'deselect'

Deselect a checkbox. If the checkbox is already de-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: 'deselectWithCoordinates'

Deselect a checkbox. If the checkbox is already de-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: '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'

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,gs
Since:
4.0
Procedure/DependencyDescription
ProcedurecloseAllMenus
Close all menus unconditionally.
ProcedurecloseAllModalDialogs
Close all modal dialogs.
ProcedurecloseMenu
Close a menu by replaying an [Escape] keystroke on a Window.
ProcedureimplicitExceptionHandler
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'

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.

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/DependencyDescription
ProceduregetIndexOfItem
Return the current index of a given item.
ProceduregetItemCount
Return the number of items of a given combobox.
ProceduregetValue
Return the text of a given combobox.
ProceduregetValueOfItem
Return the text of a given item.
ProceduresetValue
Select specified value of a given combobox.
ProceduresetValueViaIndex
Set a value in the combobox.
ProceduresetValueViaSUTScript
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/DependencyDescription
ProcedureclickAtComponent
Click on a given component, but only if the according parameter is set to true.
ProcedureclickAtComponentWithDetails
Click on a given component, but only if the according parameter is set to true.
ProceduredeleteOverrideComponent
Delete the current association of PriorityFxNode.
ProceduredoClick
Click on a given component.
ProceduredoClickWithDetails
Click on a given component.
ProceduredoSelect
Send a selection event to a given component.
ProceduresetLocation
Set the location of a given component.
ProceduresetOverrideComponent
Set a given component to the PriorityFxNode.
ProceduresetSize
Set the width and the height of a given component.
ProcedurewaitForComponent
Wait for a given component.
ProcedurewaitForComponentForAbsence
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. 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,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. 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,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/DependencyDescription
ProcedureclickItemWithDetails
Select a given item by a mouse-click on it.
ProceduregetIndexOfItem
Return the current index of a given item.
ProceduregetItemCount
Return the number of items of a given list.
ProceduregetValueOfItem
Return the text of a given item.
ProcedureselectItem
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,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/DependencyDescription
ProcedurecheckNumberOfItems
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/DependencyDescription
ProceduredeselectAllItems
Deselect all items.
ProceduredeselectItem
Deselect a given item, specified by its index.
ProceduredeselectItemRange
Deselect a range of items, specified by their index.
ProcedureselectAllItems
Select all items.
ProcedureselectItem
Select a given item, specified by its index.
ProcedureselectItemRange
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/DependencyDescription
ProcedureselectCheckMenuItemInHierarchy
Select a checkbox menu item from a menu.
ProcedureselectCheckMenuItemInHierarchyWithCoordinates
Select a checkbox menu item from a menu.
ProcedureselectItem
Select an item from a menu.
ProcedureselectItemWithCoordinates
Select an item from a menu.
ProcedureselectMenuItemInHierarchy
Select an item from a menu.
ProcedureselectMenuItemInHierarchyWithCoordinates
Select an item from a menu.
ProcedureselectSubItem
Select an item within a submenu.
ProcedureselectSubItemWithCoordinates
Select an item within a submenu.
ProceduresetCheckItem
Select a checkbox menu item.
ProceduresetCheckItemWithCoordinates
Select a checkbox menu item.
ProceduresetSubCheckItem
Select a checkbox menu item within within a submenu.
ProceduresetSubCheckItemWithCoordinates
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'

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.
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 sub-item 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 sub-item 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.

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.
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 sub-menus. (fx components javafx.scene.control.RadioMenuItem and javafx.scene.control.CheckMenuItem from javafx.scene.control.MenuItem)

Author:
QFS
Since:
4.0
Procedure/DependencyDescription
ProcedureclickItemWithDetails
Select an item in a popup menu.
ProcedureselectItem
Select an item in a popup menu.
ProcedureselectSubItem
Select an item within a submenu of a popup menu.
ProcedureselectSubItemWithCoordinates
Select an item within a submenu of a popup menu.
ProceduresetCheckItem
Select a checkbox menu item in a popup menu.
ProceduresetCheckItemWithCoordinates
Select a checkbox menu item in a popup menu.
ProceduresetSubCheckItem
Select a checkbox menu item within a submenu of a popup menu.
ProceduresetSubCheckItemWithCoordinates
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. 16 for right mouse. 4 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/DependencyDescription
ProceduregetValue
Return the value of a radio button.
Procedureselect
Select a radio button.
ProcedureselectWithCoordinates
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/DependencyDescription
ProceduregetValue
Return the value of a slider component.
ProceduresetValue
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/DependencyDescription
ProcedurecheckValue
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/DependencyDescription
ProcedurecloseTab
Close a tab via a selection event.
ProceduregetIndexOfTab
Return the index of a given tab in a TabPane.
ProceduregetValueOfTab
Return the text of a given tab in a TabPane.
ProcedureselectTab
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: '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/DependencyDescription
ProcedureclickCellWithDetails
Select a given cell.
ProceduregetColumnCount
Return the number of columns of a given table.
ProceduregetIndexOfColumn
Return the current index of a given column.
ProceduregetNameOfColumn
Return the header text of a given column.
ProceduregetRowCount
Return the number of rows of a given table.
ProceduregetRowIndexOfCell
Return the row number of a given cell.
ProceduregetValueOfCell
Return the text of a given cell.
ProcedureresizeColumn
Resize width of a table column.
ProcedureselectCell
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. 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,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/DependencyDescription
Proceduredeselect
Deselect a checkbox in a table-cell.
ProceduredeselectWithCoordinates
Deselect a checkbox in a table-cell.
Procedureselect
Select a checkbox in a table-cell.
ProcedureselectWithCoordinates
Select a checkbox in a table-cell.
Procedureset
Set checkbox in a table-cell to the given state.
ProceduresetWithCoordinates
Set checkbox in a table-cell to the given state.
Procedure: 'deselect'

Deselect a checkbox in a table-cell. If the checkbox is already de-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: 'deselectWithCoordinates'

Deselect a checkbox in a table-cell. If the checkbox is already de-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: '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/DependencyDescription
ProcedurecheckNumberOfRows
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/DependencyDescription
ProceduredeselectAllRows
Deselect all rows.
ProceduredeselectRow
Deselect a given row, specified by its index.
ProceduredeselectRowRange
Deselect a range of rows, specified by their index.
ProcedureselectAllRows
Select all rows.
ProcedureselectRow
Select a given row, specified by its index.
ProcedureselectRowRange
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/DependencyDescription
ProcedureclearArea
Clear a multi-line text area.
ProcedureclearField
Clear a simple text field.
ProceduregetText
Return the text of a given textfield.
ProceduresetText
Set a given text to a given text-field or text-area.
ProceduresetTextFromFile
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.
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/DependencyDescription
ProcedureclickNodeWithDetails
Select a given node.
Procedurecollapse
Collapse a tree node.
ProcedurecollapseNode
Collapse a tree node.
ProcedurecollapseNodes
Collapse a tree node recursively.
ProcedurecollapseNodeWithCoordinates
Collapse a tree node.
ProcedurecollapseWithCoordinates
Collapse a tree node.
Procedureexpand
Expand a tree node.
ProcedureexpandNode
Expand a tree node.
ProcedureexpandNodes
Expand a tree node recursively.
ProcedureexpandNodeWithCoordinates
Expand a tree node.
ProcedureexpandWithCoordinates
Expand a tree node.
ProceduregetChildNodeCount
Return the number of child nodes.
ProceduregetIndexOfNode
Return the current index of a given node.
ProceduregetRowCount
Return the number of visible nodes under a given tree or tree-node.
ProceduregetValueOfNode
Return the text of a given node.
ProcedureselectNode
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. 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,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'

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.
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'

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. 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. 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, 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. You can specify the coordinates for clicking.

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'

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.
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/DependencyDescription
ProcedurecheckNumberOfChildNodes
Check the number of child nodes of a given tree node according to a specified comparison mode.
ProcedurecheckNumberOfRows
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: 'pdf'

Procedures for PDF testing.

Author:
QFS
Since:
4.2
Package: 'highlight'

Procedures in order to highlight components.

Author:
QFS,ys
Since:
4.2
Procedure/DependencyDescription
ProcedurehideBordersAroundComponents
Hide borders around each recognized component.
ProcedureshowBordersAroundComponents
Show borders around each recognized component.
ProceduretoggleBordersAroundComponents
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/DependencyDescription
Procedureiterate
Iterate over all pages in a PDF document.
ProcedureopenFirstPage
Open the first page of the PDF document.
ProcedureopenLastPage
Open the last page of the PDF document.
ProcedureopenNextPage
Open/Goto the next page of the PDF document.
ProcedureopenPage
Open a specific page of the PDF document.
ProcedureopenPrevPage
Open/Goto the previous page of the PDF document.
ProcedureopenRandomPage
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 (comma-separated) page numbers which got 'true' returned by the called 'procedureToCall' parameter.
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/DependencyDescription
ProceduregetCurrentPageName
Return the name of the currently selected page in the PDF document.
ProceduregetCurrentPageNumber
Return the index/number of the currently selected page in the PDF document.
ProceduregetPageCount
Return the number of pages in a PDF document.
ProcedurerefreshCurrentPage
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/DependencyDescription
ProcedurelogError
Write an error into the run-log.
ProcedurelogMessage
Write a message into the run-log.
ProcedurelogWarning
Write a warning into the run-log.
Procedure: 'logError'

Write an error into the run-log.

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. Screenshots of the whole screen are taken in any case.
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/DependencyDescription
ProceduregetMonitorCount
Return the total number of monitors.
ProcedurelogImageOfComponent
Write an image of a component into the run-log.
ProcedurelogScreenshot
Write a screenshot of the whole screen into the run-log.
ProcedurelogScreenshotOfMonitor
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/DependencyDescription
ProcedurelogSourcecode
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/DependencyDescription
Procedurecopy
Copy a given file or directory to a given target.
ProceduredeleteFile
Delete a file.
Procedureexists
Check whether a given file or directory exists.
ProceduregetBasename
Return the basename of the given file or directory.
ProceduregetParentdirectory
Return the parent directory of the given file or directory.
Proceduremkdir
Create a given directory.
Proceduremove
Move a given file or directory to a given target.
ProcedureremoveDirectory
Remove a given directory.
Proceduretouch
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: '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, copy source into that directory. If target's parent directory does not exist, create it. If an error happens during copying, 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/DependencyDescription
Proceduredeselect
Deselect a checkbox.
ProceduredeselectWithCoordinates
Deselect a checkbox.
ProceduregetValue
Return the value of a checkbox.
Procedureselect
Select a checkbox.
ProcedureselectWithCoordinates
Select a checkbox.
Procedureset
Set checkbox to the given state.
ProceduresetWithCoordinates
Set checkbox to the given state.
Procedure: 'deselect'

Deselect a checkbox. If the checkbox is already de-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: 'deselectWithCoordinates'

Deselect a checkbox. If the checkbox is already de-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: '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'

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,mm
Since:
2.1.0
Procedure/DependencyDescription
ProcedurecloseAllDialogs
Close all dialogs.
ProcedurecloseAllMenus
Close all menus unconditionally.
ProcedurecloseAllModalDialogs
Close all modal dialogs.
ProcedureimplicitExceptionHandler
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'

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.

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/DependencyDescription
ProceduregetIndexOfItem
Return the current index of a given item.
ProceduregetItemCount
Return the number of items of a given combobox.
ProceduregetValue
Return the text of a given combobox.
ProceduregetValueOfItem
Return the text of a given item.
ProceduresetValue
Select specified value of a given combobox.
ProceduresetValueViaIndex
Set a value in the combobox.
ProceduresetValueViaSUTScript
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/DependencyDescription
ProcedurehandleSecurityWarning
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/DependencyDescription
ProceduredisableNameResolver
Uninstall the JFileChooser name resolver.
ProcedureenableNameResolver
Install the JFileChooser name resolver.
ProcedureselectFile
Select a file in a JFileChooser dialog.
ProcedureselectFiles
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/DependencyDescription
ProcedureclickAtComponent
Click on a given component, but only if the according parameter is set to true.
ProcedureclickAtComponentWithDetails
Click on a given component, but only if the according parameter is set to true.
ProceduredeleteOverrideComponent
Delete the current association of PriorityAwtSwingComponent.
ProceduredoClick
Click on a given component.
ProceduredoClickWithDetails
Click on a given component.
ProceduredoSelect
Send a selection event to a given component.
ProceduresetLocation
Set the location of a given component.
ProceduresetOverrideComponent
Set a given component to the PriorityAwtSwingComponent.
ProceduresetSize
Set the width and the height of a given component.
ProcedurewaitForComponent
Wait for a given component.
ProcedurewaitForComponentForAbsence
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. 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,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. 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,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/DependencyDescription
ProcedureclickItemWithDetails
Select a given item by a mouse-click on it.
ProceduregetIndexOfItem
Return the current index of a given item.
ProceduregetItemCount
Return the number of items of a given list.
ProceduregetValueOfItem
Return the text of a given item.
ProcedureselectItem
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,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/DependencyDescription
ProcedurecheckNumberOfItems
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/DependencyDescription
ProceduredeselectAllItems
Deselect all items.
ProceduredeselectItem
Deselect a given item, specified by its index.
ProceduredeselectItemRange
Deselect a range of items, specified by their index.
ProcedureselectAllItems
Select all items.
ProcedureselectItem
Select a given item, specified by its index.
ProcedureselectItemRange
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/DependencyDescription
ProcedureselectCheckMenuItemInHierarchy
Select a checkbox menu item from a menu.
ProcedureselectCheckMenuItemInHierarchyWithCoordinates
Select a checkbox menu item from a menu.
ProcedureselectItem
Select an item from a menu.
ProcedureselectItemWithCoordinates
Select an item from a menu.
ProcedureselectMenuItemInHierarchy
Select an item from a menu.
ProcedureselectMenuItemInHierarchyWithCoordinates
Select an item from a menu.
ProcedureselectSubItem
Select an item within a submenu.
ProcedureselectSubItemWithCoordinates
Select an item within a submenu.
ProceduresetCheckItem
Select a checkbox menu item.
ProceduresetCheckItemWithCoordinates
Select a checkbox menu item.
ProceduresetSubCheckItem
Select a checkbox menu item within within a submenu.
ProceduresetSubCheckItemWithCoordinates
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:
3.5
Procedure: 'selectCheckMenuItemInHierarchyWithCoordinates'

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.
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'

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:
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.

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 sub-item 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 sub-item 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