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

client

Procedures for interacting with (SUT) clients.

renameClient

Rename an SUT client.

sendInput

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

startLogging

Helper method for turning on internal logging.

stopLogging

Helper method for turning off internal logging.

daemon

Procedures to work with a QF-Test daemon.

instrumentRemoteSwt

Starts remote instrumentation procedure for an Eclipse/RCP based or standalone SWT application via a given daemon.

locateDaemons

Locate all running daemons and writes them into the run-log and prints a list of running daemons to the terminal.

startRemoteSUT

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

database

Procedures to work with databases.

executeSelectStatement

Build up connection to a given database and executes a specified select-sql-statement.

executeStatement

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

databinder

Procedures to bind data for data-driven testing.

bindList

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

bindSets

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

dialogs

Procedures for showing dialogs during the test-run.

showConfigurabableDialog

Show a configurable dialog equivalent to JOptionPane.

showInformationMessageDialog

Show an information dialog with an OK option.

showYes_No_Cancel_Dialog

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

showYes_No_Dialog

Show an information dialog with a YES and NO option.

Procedures for advanced manipulation of fx components.

checkbox

Procedures to get and set the state of checkboxes.

deselect

Deselect a checkbox.

deselectWithCoordinates

Deselect a checkbox.

getValue

Return the value of a checkbox.

select

Select a checkbox.

selectWithCoordinates

Select a checkbox.

set

Set checkbox to the given state.

setWithCoordinates

Set checkbox to the given state.

cleanup

The procedures in this package are useful for generic cleanup after an exception is thrown.

closeAllMenus

Close all menus unconditionally.

closeAllModalDialogs

Close all modal dialogs.

closeMenu

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

implicitExceptionHandler

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

combobox

Procedures to handle comboboxes.

getIndexOfItem

Return the current index of a given item.

getItemCount

Return the number of items of a given combobox.

getValue

Return the text of a given combobox.

getValueOfItem

Return the text of a given item.

setValue

Select specified value of a given combobox.

setValueViaIndex

Set a value in the combobox.

setValueViaSUTScript

Select specified value of a given combobox using a SUT script.

general

Procedures which work for any fx component.

clickAtComponent

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

clickAtComponentWithDetails

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

deleteOverrideComponent

Delete the current association of PriorityFxNode.

doClick

Click on a given component.

doClickWithDetails

Click on a given component.

doSelect

Send a selection event to a given component.

setLocation

Set the location of a given component.

setOverrideComponent

Set a given component to the PriorityFxNode.

setSize

Set the width and the height of a given component.

waitForComponent

Wait for a given component.

waitForComponentForAbsence

Wait till a given component disappears.

list

Procedures for accessing lists.

checks

Procedures for checking a list.

checkNumberOfItems

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

clickItemWithDetails

Select a given item by a mouse-click on it.

getIndexOfItem

Return the current index of a given item.

getItemCount

Return the number of items of a given list.

getValueOfItem

Return the text of a given item.

selection

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

deselectAllItems

Deselect all items.

deselectItem

Deselect a given item, specified by its index.

deselectItemRange

Deselect a range of items, specified by their index.

selectAllItems

Select all items.

selectItem

Select a given item, specified by its index.

selectItemRange

Select a range of items, specified by their index.

selectItem

Select a given item by a mouse-click on it.

Procedures to select menu items and checkbox menu items.

selectCheckMenuItemInHierarchy

Select a checkbox menu item from a menu.

selectCheckMenuItemInHierarchyWithCoordinates

Select a checkbox menu item from a menu.

selectItem

Select an item from a menu.

selectItemWithCoordinates

Select an item from a menu.

selectMenuItemInHierarchy

Select an item from a menu.

selectMenuItemInHierarchyWithCoordinates

Select an item from a menu.

selectSubItem

Select an item within a submenu.

selectSubItemWithCoordinates

Select an item within a submenu.

setCheckItem

Select a checkbox menu item.

setCheckItemWithCoordinates

Select a checkbox menu item.

setSubCheckItem

Select a checkbox menu item within within a submenu.

setSubCheckItemWithCoordinates

Select a checkbox menu item within within a submenu.

popupmenu

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

clickItemWithDetails

Select an item in a popup menu.

selectItem

Select an item in a popup menu.

selectSubItem

Select an item within a submenu of a popup menu.

selectSubItemWithCoordinates

Select an item within a submenu of a popup menu.

setCheckItem

Select a checkbox menu item in a popup menu.

setCheckItemWithCoordinates

Select a checkbox menu item in a popup menu.

setSubCheckItem

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

setSubCheckItemWithCoordinates

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

radiobutton

Procedures to set and get the state of radio buttons.

getValue

Return the value of a radio button.

select

Select a radio button.

selectWithCoordinates

Select a radio button.

slider

Procedures to access sliders.

checks

Procedure for checking slider values.

checkValue

Check the value of a slider component.

getValue

Return the value of a slider component.

setValue

Set the value of a slider component.

tabbedpane

Procedures to work with TabbedPanes.

closeTab

Close a tab via a selection event.

getIndexOfTab

Return the index of a given tab in a TabPane.

getValueOfTab

Return the text of a given tab in a TabPane.

selectTab

Select a tab in a given TabPane.

table

Procedures to access tables.

checkbox

Procedures to set the state of checkboxes in a table-cell.

deselect

Deselect a checkbox in a table-cell.

deselectWithCoordinates

Deselect a checkbox in a table-cell.

select

Select a checkbox in a table-cell.

selectWithCoordinates

Select a checkbox in a table-cell.

set

Set checkbox in a table-cell to the given state.

setWithCoordinates

Set checkbox in a table-cell to the given state.

checks

Procedures for checking a table.

checkNumberOfRows

Check the number of rows of a given table according to a specified comparison mode.

clickCellWithDetails

Select a given cell.

getColumnCount

Return the number of columns of a given table.

getIndexOfColumn

Return the current index of a given column.

getNameOfColumn

Return the header text of a given column.

getRowCount

Return the number of rows of a given table.

getRowIndexOfCell

Return the row number of a given cell.

getValueOfCell

Return the text of a given cell.

resizeColumn

Resize width of a table column.

selectCell

Select a given cell.

selection

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

deselectAllRows

Deselect all rows.

deselectRow

Deselect a given row, specified by its index.

deselectRowRange

Deselect a range of rows, specified by their index.

selectAllRows

Select all rows.

selectRow

Select a given row, specified by its index.

selectRowRange

Select a range of rows, specified by their index.

text

Procedures to access text fields and text areas.

clearArea

Clear a multi-line text area.

clearField

Clear a simple text field.

getText

Return the text of a given textfield.

setText

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

setTextFromFile

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

tree

Procedures to access trees.

checks

Procedures for checking a tree.

checkNumberOfChildNodes

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

checkNumberOfRows

Check the number of visible nodes under a given tree or tree node according to a specified comparison mode.

clickNodeWithDetails

Select a given node.

collapse

Collapse a tree node.

collapseNode

Collapse a tree node.

collapseNodes

Collapse a tree node recursively.

collapseNodeWithCoordinates

Collapse a tree node.

collapseWithCoordinates

Collapse a tree node.

expand

Expand a tree node.

expandNode

Expand a tree node.

expandNodes

Expand a tree node recursively.

expandNodeWithCoordinates

Expand a tree node.

expandWithCoordinates

Expand a tree node.

getChildNodeCount

Return the number of child nodes.

getIndexOfNode

Return the current index of a given node.

getRowCount

Return the number of visible nodes under a given tree or tree-node.

getValueOfNode

Return the text of a given node.

selectNode

Select a given node.

pdf

Procedures for PDF testing.

highlight

Procedures in order to highlight components.

hideBordersAroundComponents

Hide borders around each recognized component.

showBordersAroundComponents

Show borders around each recognized component.

toggleBordersAroundComponents

Toggle borders around each recognized component.

navigation

Procedures to navigate inside a PDF document.

iterate

Iterate over all pages in a PDF document.

openFirstPage

Open the first page of the PDF document.

openLastPage

Open the last page of the PDF document.

openNextPage

Open/Goto the next page of the PDF document.

openPage

Open a specific page of the PDF document.

openPrevPage

Open/Goto the previous page of the PDF document.

openRandomPage

Open a random page of the PDF document.

page

Procedures to get/interact with the current page / all pages.

getCurrentPageName

Return the name of the currently selected page in the PDF document.

getCurrentPageNumber

Return the index/number of the currently selected page in the PDF document.

getPageCount

Return the number of pages in a PDF document.

refreshCurrentPage

Refresh the currently opened page.

run-log

Procedures for writing log-entries.

logError

Write an error into the run-log.

logMessage

Write a message into the run-log.

logWarning

Write a warning into the run-log.

screenshots

Procedures to write screenshots into the run-log.

getMonitorCount

Return the total number of monitors.

logImageOfComponent

Write an image of a component into the run-log.

logScreenshot

Write a screenshot of the whole screen into the run-log.

logScreenshotOfMonitor

Write a screenshots of a given monitor into the run-log.

web

Procedures to write web specifics into run-log.

logSourcecode

Write a document's source code into the run-log.

shellutils

Utility procedures for shell commands.

copy

Copy a given file or directory to a given target.

deleteFile

Delete a file.

exists

Check whether a given file or directory exists.

getBasename

Return the basename of the given file or directory.

getParentdirectory

Return the parent directory of the given file or directory.

mkdir

Create a given directory.

move

Move a given file or directory to a given target.

removeDirectory

Remove a given directory.

touch

Create a given file or update the last modified date of an existing file.

swing

Procedures for advanced manipulation of swing components.

checkbox

Procedures to set the state of checkboxes.

deselect

Deselect a checkbox.

deselectWithCoordinates

Deselect a checkbox.

getValue

Return the value of a checkbox.

select

Select a checkbox.

selectWithCoordinates

Select a checkbox.

set

Set checkbox to the given state.

setWithCoordinates

Set checkbox to the given state.

cleanup

The procedures in this package are useful for generic cleanup after an exception is thrown.

closeAllDialogs

Close all dialogs.

closeAllMenus

Close all menus unconditionally.

closeAllModalDialogs

Close all modal dialogs.

implicitExceptionHandler

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

combobox

Procedures to handle comboboxes.

getIndexOfItem

Return the current index of a given item.

getItemCount

Return the number of items of a given combobox.

getValue

Return the text of a given combobox.

getValueOfItem

Return the text of a given item.

setValue

Select specified value of a given combobox.

setValueViaIndex

Set a value in the combobox.

setValueViaSUTScript

Select specified value of a given combobox using a SUT script.

dialogs

Procedures to handle Dialogs.

handleSecurityWarning

Wait for the client to connect and check whether a Java security dialog blocks the JRE start which need to be confirmed.

filechooser

Procedures for accessing file chooser dialogs.

disableNameResolver

Uninstall the JFileChooser name resolver.

enableNameResolver

Install the JFileChooser name resolver.

selectFile

Select a file in a JFileChooser dialog.

selectFiles

Select several files in a JFileChooser dialog.

general

Procedures which work for any Swing component.

clickAtComponent

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

clickAtComponentWithDetails

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

deleteOverrideComponent

Delete the current association of PriorityAwtSwingComponent.

doClick

Click on a given component.

doClickWithDetails

Click on a given component.

doSelect

Send a selection event to a given component.

setLocation

Set the location of a given component.

setOverrideComponent

Set a given component to the PriorityAwtSwingComponent.

setSize

Set the width and the height of a given component.

waitForComponent

Wait for a given component.

waitForComponentForAbsence

Wait till a given component disappears.

list

Procedures for accessing lists.

checks

Procedures for checking a list.

checkNumberOfItems

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

clickItemWithDetails

Select a given item by a mouse-click on it.

getIndexOfItem

Return the current index of a given item.

getItemCount

Return the number of items of a given list.

getValueOfItem

Return the text of a given item.

selection

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

deselectAllItems

Deselect all items.

deselectItem

Deselect a given item, specified by its index.

deselectItemRange

Deselect a range of items, specified by their index.

selectAllItems

Select all items.

selectItem

Select a given item, specified by its index.

selectItemRange

Select a range of items, specified by their index.

selectItem

Select a given item by a mouse-click on it.

Procedures to select menu items and checkbox menu items.

selectCheckMenuItemInHierarchy

Select a checkbox menu item from a menu.

selectCheckMenuItemInHierarchyWithCoordinates

Select a checkbox menu item from a menu.

selectItem

Select an item from a menu.

selectItemWithCoordinates

Select an item from a menu.

selectMenuItemInHierarchy

Select an item from a menu.

selectMenuItemInHierarchyWithCoordinates

Select an item from a menu.

selectSubItem

Select an item within a submenu.

selectSubItemWithCoordinates

Select an item within a submenu.

setCheckItem

Select a checkbox menu item.

setCheckItemWithCoordinates

Select a checkbox menu item.

setSubCheckItem

Select a checkbox menu item within within a submenu.

setSubCheckItemWithCoordinates

Select a checkbox menu item within within a submenu.

optionpane

Procedures for accessing standard error/message dialogs.

checkMessage

Check the message of the current javax.swing.JOptionPane dialog.

checkTitle

Check the title of the current javax.swing.JOptionPane dialog.

clickCancelButton

Click on the Cancel Button of the current javax.swing.JOptionPane dialog.

clickNoButton

Click on the No Button of the current javax.swing.JOptionPane dialog.

clickOkButton

Click on the OK Button of the current javax.swing.JOptionPane dialog.

clickYesButton

Click on the Yes Button of the current javax.swing.JOptionPane dialog.

disableNameResolver

Uninstall the JOptionPane name resolver.

enableNameResolver

Install the JOptionPane name resolver.

getMessage

Get the message of the current javax.swing.JOptionPane dialog.

getOptionPaneMessageType

Return the message Type of the current javax.swing.JOptionPane dialog.

getTitle

Get the title of the current javax.swing.JOptionPane dialog.

hasCancelButton

Check if the current javax.swing.JOptionPane dialog has an Cancel Button.

hasNoButton

Check if the current javax.swing.JOptionPane dialog has an NO Button.

hasOkButton

Check if the current javax.swing.JOptionPane dialog has an OK Button.

hasYesButton

Check if the current javax.swing.JOptionPane dialog has an YES Button.

isErrorDialog

Check, if current window is a javax.swing.JOptionPane ErrorDialog.

isInfoDialog

Check, if current window is a javax.swing.JOptionPane InfoDialog.

isOptionPane

Check, if current window is a javax.swing.JOptionPane dialog.

isPlainDialog

Check, if current window is a javax.swing.JOptionPane PlainDialog.

isQuestionDialog

Check, if current window is a javax.swing.JOptionPane QuestionDialog.

isWarningDialog

Check, if current window is a javax.swing.JOptionPane WarningDialog.

popupmenu

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

clickItemWithDetails

Select an item in a popup menu.

selectItem

Select an item in a popup menu.

selectSubItem

Select an item within a submenu of a popup menu.

selectSubItemWithCoordinates

Select an item within a submenu of a popup menu.

setCheckItem

Select a checkbox menu item in a popup menu.

setCheckItemWithCoordinates

Select a checkbox menu item in a popup menu.

setSubCheckItem

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

setSubCheckItemWithCoordinates

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

radiobutton

Procedures to get and set the state of radio buttons.

getValue

Return the value of a radio button.

select

Select a radio button.

selectWithCoordinates

Select a radio button.

slider

Procedures to access sliders.

checks

Procedure for checking slider values.

checkValue

Check the value of a slider component

getValue

Return the value of a slider component.

setValue

Set the value of a slider component.

startup

Procedures for startup of swing applications.

setDelays

Set delays for the QF-Test SUT initialization process.

setSecurityDialogSpec

Define properties for recognizing WebStart and applet security dialogs that should be closed automatically.

startAppletSUT

Start an applet as SUT in a browser.

startWebstartSUT

Start a Webstart SUT.

tabbedpane

Procedures to work with TabbedPanes.

closeTab

Close a tab via clicking on the "X "button.

getIndexOfTab

Return the index of a given tab in a JTabbedPane.

getValueOfTab

Return the text of a given tab in a JTabbedPane.

selectTab

Select a tab in a given TabbedPane.

table

Procedures to access tables.

checkbox

Procedures to set the state of checkboxes in a table-cell.

deselect

Deselect a checkbox in a table-cell.

deselectWithCoordinates

Deselect a checkbox in a table-cell.

select

Select a checkbox in a table-cell.

selectWithCoordinates

Select a checkbox in a table-cell.

set

Set checkbox in a table-cell to the given state.

setWithCoordinates

Set checkbox in a table-cell to the given state.

checks

Procedures for checking a table.

checkNumberOfRows

Check the number of rows of a given table according to a specified comparison mode.

clickCellWithDetails

Select a given cell.

getColumnCount

Return the number of columns of a given table.

getIndexOfColumn

Return the current index of a given column.

getNameOfColumn

Return the header text of a given column.

getRowCount

Return the number of rows of a given table.

getRowIndexOfCell

Return the row number of a given cell.

getValueOfCell

Return the text of a given cell.

resizeColumn

Resize width of a table column.

selectCell

Select a given cell.

selection

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

deselectAllRows

Deselect all rows.

deselectRow

Deselect a given row, specified by its index.

deselectRowRange

Deselect a range of rows, specified by their index.

selectAllRows

Select all rows.

selectRow

Select a given row, specified by its index.

selectRowRange

Select a range of rows, specified by their index.

text

Procedures to access text fields and text areas.

clearArea

Clear a multi-line text area.

clearField

Clear a simple text field.

getText

Return the text of a given textfield.

setText

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

setTextFromFile

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

tree

Procedures to access trees.

callbackPrintNodeText

Example for a callback procedure used by expandNodes.

checks

Procedures for checking a tree.

checkNumberOfChildNodes

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

checkNumberOfRows

Check the number of visible nodes under a given tree or tree node according to a specified comparison mode.

clickNodeWithDetails

Select a given node.

collapse

Collapse a tree node.

collapseNode

Collapse a tree node.

collapseNodes

Collapse a tree node recursively.

collapseNodeWithCoordinates

Collapse a tree node.

collapseWithCoordinates

Collapse a tree node.

expand

Expand a tree node.

expandNode

Expand a tree node.

expandNodes

Expand a tree node recursively.

expandNodesWithCoordinates

Expand a tree node recursively.

expandNodeWithCoordinates

Expand a tree node.

expandWithCoordinates

Expand a tree node.

getChildNodeCount

Return the number of child nodes.

getIndexOfNode

Return the current index of a given node.

getRowCount

Return the number of visible nodes under a given tree or tree-node.

getValueOfNode

Return the text of a given node.

selectNode

Select a given node.

swt

Procedures for advanced manipulation of SWT components.

checkbox

Procedures to set the state of checkboxes.

deselect

Deselect a checkbox.

deselectWithCoordinates

Deselect a checkbox.

getValue

Return the value of a checkbox.

select

Select a checkbox.

selectWithCoordinates

Select a checkbox.

set

Set checkbox to the given state.

setWithCoordinates

Set checkbox to the given state.

cleanup

The procedures in this package are useful for generic cleanup after an exception is thrown.

closeAllDialogsAndModalShells

Close all modal dialogs.

closeAllMenus

Close all menus unconditionally.

implicitExceptionHandler

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

colordialog

Procedures to handle Colordialogs.

selectColor

Select a specified color of a ColorDialog.

combo

Procedures to handle comboboxes.

getIndexOfItem

Return the current index of a given item.

getItemCount

Return the number of items of a given combobox.

getValue

Return the text of a given combo.

getValueOfItem

Return the text of a given item.

setValue

Select specified value of a given combobox using a selection event.

setValueViaSUTScript

Select specified value of a given combobox using a SUT script.

ctabfolder

Procedures for SWT CTabFolder widgets.

checkTabIsDirty

This procedure raises an error, if a given tab is not dirty.

closeTab

Close a tab in a generic CTabFolder that is identified only by the fact that it contains the desired tab.

openViewMenu

Open the View Menu for a generic CTabFolder that is identified only by the fact that it contains the desired tab.

selectTab

Select a tab in a generic CTabFolder that is identified only by the fact that it contains the desired tab.

directorydialog

Procedures for accessing directory dialogs.

selectDirectory

Select a directory in a DirectoryDialog dialog.

filedialog

Procedures for accessing file dialogs.

selectFile

Select a file in a FileDialog dialog.

general

Procedures which work for any SWT component.

clickAtComponent

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

clickAtComponentWithDetails

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

deleteOverrideComponent

Delete the current association of PrioritySwtComponent.

doClick

Click on a given component.

doClickWithDetails

Click on a given component.

doSelect

Send a selection event to a given component.

setLocation

Set the location of a given component.

setOverrideComponent

Set a given component to the PrioritySwtWidget.

setSize

Set the width and the height of a given component.

waitForComponent

Wait for a given component.

waitForComponentForAbsence

Wait till a given component disappears.

instrument

Procedures for SWT instrumentation.

setup

Instrument an Eclipse/RCP based or standalone SWT application for use with QF-Test.

list

Procedures for accessing lists.

checks

Procedures for checking a list.

checkNumberOfItems

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

clickItemWithDetails

Select a given item by a mouse-click on it.

getIndexOfItem

Return the current index of a given item.

getItemCount

Return the number of items of a given list.

getValueOfItem

Return the text of a given item.

selection

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

deselectAllItems

Deselect all items.

deselectItem

Deselect a given item, specified by its index.

deselectItemRange

Deselect a range of items, specified by their index.

selectAllItems

Select all items.

selectItem

Select a given item, specified by its index.

selectItemRange

Select a range of items, specified by their index.

selectItem

Select a given item by a mouse-click on it.

Procedures to select menu items and checkbox menu items.

selectCheckMenuItemInHierarchy

Select a checkbox menu item from a menu.

selectItem

Select an item from a menu.

selectMenuItemInHierarchy

Select an item from a menu.

selectSubItem

Select an item within a submenu.

setCheckItem

Select a checkbox menu item.

setSubCheckItem

Select a checkbox menu item within within a submenu.

popupmenu

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

selectItem

Select an item in a popup menu.

selectSubItem

Select an item within a submenu of a popup menu.

setCheckItem

Select a checkbox menu item in a popup menu.

setSubCheckItem

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

radiobutton

Procedures to set the state of buttons with the style SWT.RADIO.

getValue

Return the value of a radio button.

select

Select a radio button.

selectWithCoordinates

Select a radio button.

sash

Procedures to work with sash components.

moveSash

Move a sash by a given distance.

moveSashTo

Move a sash to a given position.

scrollbar

Procedures to work with scrollbar components.

pageDown

Scroll a component one page downwards by simulating a hard mouse click below the scrollbar's thumb.

pageLeft

Scroll a component one page to the left by simulating a hard mouse click to the left of the scrollbar's thumb.

pageRight

Scroll a component one page to the right by simulating a hard mouse click to the right of the scrollbar's thumb.

pageUp

Scroll a component one page upwards by simulating a hard mouse click above the scrollbar's thumb.

scrollDown

Scroll a component downwards by simulating a hard mouse click on the down arrow button of its vertical scrollbar.

scrollLeft

Scroll a component to the left by simulating a hard mouse click on the left arrow button of its horizontal scrollbar.

scrollRight

Scroll a component to the right by simulating a hard mouse click on the right arrow button of its horizontal scrollbar.

scrollUp

Scroll a component upwards by simulating a hard mouse click on the up arrow button of its vertical scrollbar.

tabfolder

Procedures for SWT TabFolder widgets.

closeTab

Close a tab via sending a "close" selection event.

getIndexOfTab

Return the index of a given tab.

getValueOfTab

Return the text of a given tab.

selectTab

Select a tab in a given Tabfolder.

table

Procedures to access tables.

checkbox

Procedures to set the checked state of tableitems.

deselect

Unset the checked state of a tableitem in a table.

select

Set the checked state of a tableitem in a table.

set

Set checked state of a tableitem to the given state.

checks

Procedures for checking a table.

checkNumberOfRows

Check the number of rows of a given table according to a specified comparison mode.

clickCellWithDetails

Select a given cell.

getColumnCount

Return the number of columns of a given table.

getIndexOfColumn

Return the current index of a given column.

getNameOfColumn

Return the header text of a given column.

getRowCount

Return the number of rows of a given table.

getRowIndexOfCell

Return the row number of a given cell.

getValueOfCell

Return the text of a given cell.

selectCell

Select a given cell.

selection

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

deselectAllRows

Deselect all rows.

deselectRow

Deselect a given row, specified by its index.

deselectRowRange

Deselect a range of rows, specified by their index.

selectAllRows

Select all rows.

selectRow

Select a given row, specified by its index.

selectRowRange

Select a range of rows, specified by their index.

text

Procedures to access text fields and text areas.

clearArea

Clear a multi-line text area.

clearField

Clear a simple text field.

getText

Return the text of a given textfield.

setText

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

setTextFromFile

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

tree

Procedures to access trees.

callbackPrintNodeText

Example for a callback procedure used by expandNodes.

checks

Procedures for checking a tree.

checkNumberOfChildNodes

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

checkNumberOfRows

Check the number of visible nodes under a given tree or tree node according to a specified comparison mode.

clickNodeWithDetails

Select a given node.

collapse

Collapse a tree node.

collapseNode

Collapse a tree node.

collapseNodeWithCoordinates

Collapse a tree node.

collapseWithCoordinates

Collapse a tree node.

expand

Expand a tree node.

expandNode

Expand a tree node.

expandNodes

Expand a tree node recursively.

expandNodesWithCoordinates

Expand a tree node recursively.

expandNodeWithCoordinates

Expand a tree node.

expandWithCoordinates

Expand a tree node.

getChildNodeCount

Return the number of child nodes.

getIndexOfNode

Return the hierarchical index of a given node.

getRowCount

Return the number of visible nodes under a given tree or tree-node.

getValueOfNode

Return the text of a given node.

multicolumn

Special procedures for multi-column trees.

getRowIndexByCellText

Return the index of the first row containing a given cell text in a given column of an SWT multi-column tree.

selectNode

Select a given node.

utils

Miscellaneous utility procedures.

clipboard

Accessing the clipboard from procedures.

getTextFromClipboard

Return the current text on the system clipboard.

setTextAtClipboard

Set a text on the system clipboard.

createThreadDump

Trigger a full thread dump in the SUT if possible.

dragAndDrop

Drag the source component or item onto the target and drop it.

dumpComponents

Dump an entire component hierarchy into the run-log.

dumpHeap

Dump the heap of the Java VM.

Procedures for sending E-Mails.

pop3

Procedures for interacting with a POP3 server.

deleteMessages

Delete all messages from a pop3 account.

fetchMessage

Fetch a message from a pop3 account.

sendEmail

This procedure uses the smtplib module from Jython, to send emails via SMTP server.

sendEmail_SMTPHost

Send an e-mail.

files

Contain procedures to work with files.

checkFileForContent

Check, whether a given file contain a specific value.

checkFileForExistingLine

Check, whether a given file contain a specific value in a line.

compareFiles

Compare the given files and returns true if equal, otherwise false.

readExcelFile

Read a worksheet of an Excel file.

getBoundsOnScreen

Get the screen location and the size of a component or sub-item.

getDate

Return a date, default is the current date in current locale.

getTime

Return the time in the current format.

getTimestamp

Return a timestamp, which represents the current time in milliseconds.

killAllClients

Kill all running clients.

killClient

Kill a client.

logAllMethodsOfAGivenComponent

Log all available methods of a given component.

logMemory

Log current memory use.

logNativeMemory

Log current memory usage of the native process(es) of a client.

printMessage

Print a given message to STDOUT.

printVariable

Print the content of a variable.

random

Procedures for generating random string.

getEntriesOfArea

Return a random string created of parts of a specified area.

getNumber

Return a random number.

getNumberFromRange

Return a random number between two given numbers.

getString

Return a random string containing small letters.

readTextFromFile

Read the content of a given file.

sendEmail

sleep

Sleep a given time.

ssh

Procedures for executing commands on a remote server via ssh.

executeCommand

Connect to a remote server by ssh and execute a command.

session

Close an established ssh connection.

open

Connect to a remote server by ssh and keep the session open for further use.

send

Send a command via an established ssh connection and wait for resulting output.

testrun

Procedures for handling the test execution.

skip

Procedures for skipping test-steps.

skipTestCase

Skip the execution of the current test-case.

skipTestSet

Skip the execution of the current test-set.

stop

Procedures for stopping test-steps.

stopTestCase

Stop the execution of the current test-case

stopTestRun

Stop the complete test-run.

stopTestSet

Stop the execution of the current test-set.

variables

Procedures for working with variables.

deleteAllGlobalVariables

Delete all global QF-Test variables.

deleteGlobalVariablesExcept

Delete all global QF-Test variables.

deleteOneGlobalVariable

Delete a given global QF-Test variable.

deleteOnePropertyVariable

Delete a given variable of a property group.

deletePropertyGroup

Delete a given global property group.

listAllMembersOfPropertyGroup

Print a list of all members of a given property group to the terminal.

waitForOneOfNComponents

Wait until one of N components is available.

writeMessageIntoFile

Write a given message into a given file.

xml

Procedures for working with XML files.

compareXMLFiles

Compare two XML files for full identity.

loadPropertiesFromXML

Load properties from an XML file.

web

Web utility procedures.

ajax

AJAX procedures.

dumpCustomWebResolverProperties

Dump properties of an installed CustomWebResolver.

installCustomWebResolver

Install a generic CustomWebResolver for an Ajax framework.

installToolkitResolver

Install a special resolver for given AJAX toolkit to improve recorded component types and hierarchy and therefore achieves improved component recognition.

uninstallCustomWebResolver

Uninstall a previously installed generic CustomWebResolver.

uninstallToolkitResolver

Uninstall a special resolver for given AJAX toolkit.

updateCustomWebResolverProperties

Updates properties of an installed generic CustomWebResolver.

browser

Browser procedures.

dialogs

Procedures for handling Error-Dialogs opened within the Browser.

closeCertificateWarning

Uses the Java AWT Robot/Autowin Methods to automatically close an open Certificate Warning Dialog.

closeJavascriptWarning

Uses the Java AWT Robot Methods to automatically close an open Javascript Warning Dialog.

upload

Handle the native Windows Upload dialog (especially for Internet Explorer 8).

dom

Procedures for handling DOM access.

selectAllCheckboxes

Check or uncheck all (enabled) Checkboxes which are situated in the DOM-Tree beneath the given Parent.

download

Procedures to handle downloads in QF-Test.

setDownloadProperty

Set the QF-Test download property.

general

General browser procedures.

checkForRunningBrowserEngine

Check for the browser and if is not running than start it.

isIE6

Checks if running Browser-Engine has embedded Internet Explorer 6.

openMobileEmulation

Opens a new browser window which emulates a mobile browser.

openNewWindow

Open a new window in an already running browser.

showUrl

Show a different URL in an open browser window.

startAsNewProcess

Ensures the given browser executable is started as a new process.

mozilla

Mozilla utility procedures.

cleanupProfileDir

Performs several cleanup actions on the given mozProfile directory.

settings

The procedures in this package are useful for customizing browser settings.

deleteCookies

Delete cookies.

disableCookies

Disable cookies in the browser.

doStartupSettings

Do startup settings for the browser.

emptyCache

Empty the browser cache.

enableCompatibilityMode

Sets the compatibilitymode in Internet Explorer.

enableCookies

Enable cookies in the browser.

enableMutationListeners

Enable/Disable MutationListeners in the QF-Test browser engine for a specific document or globally for all documents.

setLocale

Set preferred language for in the displaying web pages in the browser.

setProxy

Set a proxy server for the browser.

checkbox

Procedures to set the state of checkboxes.

deselect

Deselect a checkbox.

deselectWithCoordinates

Deselect a checkbox If the checkbox is already de-selected, no action is performed.

getValue

Return the value of a checkbox.

select

Select a checkbox.

selectWithCoordinates

Select a checkbox.

set

Set checkbox to the given state.

setAll

Set all (enabled) checkboxes inside a given parent.

setWithCoordinates

Set checkbox to the given state.

checks

Procedures for handling different web checks.

checkAttribute

Checks an attribute of a component.

checkElements(negative)

Negates a normal Elementcheck in select elements to allow NegationChecks.

checkForElement

Checks if the given element (option-element-text) is in the select-element (combobox).

checkInvisibility

Negates a normal WaitForComponentCheck to allow VisibilityChecks.

checkText(negative)

Negates a normal Textcheck to allow NegationChecks.

checkTitle

Checks the title of the BrowserWindow.

style

Procedures for handling different element style checks.

checkStyleAttribute

Checks a specific style attribute for the given component.

color

Procedures for handling different element style checks concerning color attributes.

checkBackgroundColor

Checks the value that indicates the color behind the content of the component.

checkColor

Checks the value that indicates the color of the text of the component.

font

Procedures for handling different element style checks concerning font attributes.

checkFontName

Checks the name of the font used for text in the component.

checkFontSize

Checks the value that indicates the font size used for text in the component

checkFontStyle

Checks the value that indicates the font style used for text in the component (italic, normal or oblique)

getStyleAttributeThroughJS

Returns the value of a specific style attribute of the given component.

general

Procedures which work for any Web component.

clickAtComponent

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

clickAtComponentWithDetails

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

clickIncreasinglyHard

Clicks the given component with increasingly hard mouse clicks and waits for the given action to be performed.

deleteOverrideComponent

Delete the current association of PriorityWebComponent.

doClick

Click on a given component.

doClickWithDetails

Click on a given component.

dragFromTo

Simulate a drag&drop operation.

getSourcecode

Return document's source code.

integrateFirebug

Integrates Firebug Lite from http://getfirebug.com into an open browser window for an easier analysis of the DOM.

setOverrideComponent

Set a given component to the PriorityWebComponent.

waitForComponent

Wait for a given component.

waitForComponentForAbsence

Wait till a given component disappears.

input

Procedures to access INPUT elements.

fileUpload

Set the value of the INPUT:FILE node by whatever means that are applicable for the browser.

radiobutton

Procedures to set the state of buttons.

getValue

Return the value of a radio button.

select

Select a radio button.

selectWithCoordinates

Select a radio button.

select

Procedures to access select nodes.

getIndexOfItem

Return the current index of a given item.

getItemCount

Return the number of items of a given select.

getValue

Return the current value of a given select node.

getValueOfItem

Return the current text of a given item.

selectValue

Select a given value in a Select node.

table

Procedures to access web tables.

checks

Procedures for checking a table.

checkNumberOfColums

Check the number of columns of a given table according to a specified comparison mode.

checkNumberOfRows

Check the number of rows of a given table according to a specified comparison mode.

clickCellWithDetails

Select a given cell.

getColumnCount

Return the number of columns of a given web table.

getIndexOfColumn

Return the current index of a given column.

getNameOfColumn

Return the header text of a given column.

getRowCount

Return the number of rows of a given table.

getRowIndexOfCell

Return the row number of a given cell.

getValueOfCell

Return the text of a given cell.

recording

Procedures influencing recording of web tables.

activateItemRecording

Activate recording of item based access for a given web table.

deactivateItemRecording

Deactivate recording of item based access for a given web table.

selectCell

Select a given cell.

text

Procedures to access text fields and text areas.

clearArea

Clear a multi-line text area.

clearField

Clear a simple text field.

getText

Return the text of a given textfield.

setText

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

setTextFromFile

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

[Summary] [qfs.qft]

Details

[Summary] [qfs.qft]

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

[Summary] [qfs.qft] [qfs]

Package: 'autoscreen'

Procedures for testing based on images.

Author:: QFS,mh
Since:: 3.5M1

[Summary] [qfs.qft] [qfs] [autoscreen]

Package: 'fx'

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

Author:: QFS,mh
Since:: 4.1.0

Procedure/Dependency

Description

clickAtImage

Click at an image anywhere on a JavaFX application.

getComponentAtImage

Find an image anywhere on a JavaFX application and return the component ID.

[Summary] [qfs.qft] [qfs] [autoscreen] [fx]

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

[Summary] [qfs.qft] [qfs] [autoscreen] [fx]

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

[Summary] [qfs.qft] [qfs] [autoscreen]

Package: 'screen'

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

Author:: QFS,mh
Since:: 3.5M1

Procedure/Dependency

Description

clickAtImage

Click at an image anywhere on the screen.

getPositionOfImage

Find an image anywhere on the screen and return its position.

[Summary] [qfs.qft] [qfs] [autoscreen] [screen]

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

[Summary] [qfs.qft] [qfs] [autoscreen] [screen]

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

[Summary] [qfs.qft] [qfs] [autoscreen]

Package: 'swing'

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

Author:: QFS,mh
Since:: 3.5M1

Procedure/Dependency

Description

clickAtImage

Click at an image anywhere on a JFrame of a swing application.

getComponentAtImage

Find an image anywhere on a JFrame of a Swing application and return the component ID.

[Summary] [qfs.qft] [qfs] [autoscreen] [swing]

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

[Summary] [qfs.qft] [qfs] [autoscreen] [swing]

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

[Summary] [qfs.qft] [qfs] [autoscreen]

Package: 'swt'

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

Author:: QFS,mh
Since:: 3.5M1

Procedure/Dependency

Description

clickAtImage

Click at an image anywhere on a Shell of a SWT application.

getComponentAtImage

Find an image anywhere on a Shell of a SWT application and return the component ID.

[Summary] [qfs.qft] [qfs] [autoscreen] [swt]

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

[Summary] [qfs.qft] [qfs] [autoscreen] [swt]

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

[Summary] [qfs.qft] [qfs] [autoscreen]

Package: 'web'

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

Author:: QFS,mh
Since:: 3.5M1

Procedure/Dependency

Description

clickAtImage

Click at an image anywhere on a web application.

getComponentAtImage

Find an image anywhere on a web application and return the component ID.

[Summary] [qfs.qft] [qfs] [autoscreen] [web]

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

[Summary] [qfs.qft] [qfs] [autoscreen] [web]

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

[Summary] [qfs.qft] [qfs]

Package: 'autowin'

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

All procedures use the Jython library autowin.py, located in the jython/Lib folder of the current installation. There are even more methods for your needs, e.g. click a button or setting a text.

Author:: QFS,mm
Since:: 3.1.4

Procedure/Dependency

Description

checkForExistence

Check, whether a native window on the operating system Windows is opened.

checkForExistenceAndClose

Check, whether a native window on the operating system Windows is opened and close it.

Close a window.

getURLFromIE

Read the URL from an InternetExplorer window.

logChildWindows

Write all children of a window to the run-log.

markAllAndCopy

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

saveTextToFileViaClipboard

Mark and copy the whole text of a given document via Ctrl+A and Ctrl+C.

[Summary] [qfs.qft] [qfs] [autowin]

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

[Summary] [qfs.qft] [qfs] [autowin]

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

[Summary] [qfs.qft] [qfs] [autowin]

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

[Summary] [qfs.qft] [qfs] [autowin]

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

[Summary] [qfs.qft] [qfs] [autowin]

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

[Summary] [qfs.qft] [qfs] [autowin]

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

[Summary] [qfs.qft] [qfs] [autowin]

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

[Summary] [qfs.qft] [qfs] [autowin]

Package: 'acrobat'

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

Author:: QFS,tm
Since:: 3.4.0

Procedure/Dependency

Description

saveAsText

Save the current open PDF in Adobe Acrobat Reader as a text file with the given filename.

savePDF

Save the current open PDF in Adobe Acrobat Reader as a PDF file with the given filename.

[Summary] [qfs.qft] [qfs] [autowin] [acrobat]

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

[Summary] [qfs.qft] [qfs] [autowin] [acrobat]

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

[Summary] [qfs.qft] [qfs]

Package: 'awt'

Procedures for advanced manipulation of awt components.

Author:: QFS
Since:: 2.1.0

[Summary] [qfs.qft] [qfs] [awt]

Package: 'menu'

Procedures to select menu items.

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

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

Author:: QFS
Since:: 2.1.0

Procedure/Dependency

Description

selectItem

Select an item from a menu.

selectItemWithSubMenu

Select an item from a menu.

setCheckItem

Select a checkbox item from a menu.

setSubCheckItem

Select a checkbox item from a menu in a sub-menu.

[Summary] [qfs.qft] [qfs] [awt] [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

[Summary] [qfs.qft] [qfs] [awt] [menu]

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

[Summary] [qfs.qft] [qfs] [awt] [menu]

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

[Summary] [qfs.qft] [qfs] [awt] [menu]

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

[Summary] [qfs.qft] [qfs]

Package: 'check'

Contains procedures to check components.

Author:: QFS,mm
Since:: 2.1.0

Procedure/Dependency

Description

checkEnabledStatus

Check the state of a given component.

checkImageAgainstFile

Check image of a component against a file.

checkSelectedStatus

Check if given component is selected.

checkText

Check the text of a given component.

checkValueInRange

Check whether a value is in a given range.

checkValueToBeEqual

Compare two values for their equality.

compareDates

Compare two date strings.

compareTwoNumbers

Compare two values for their equality.

compareTwoStringValues

Compare two values for their equality.

[Summary] [qfs.qft] [qfs] [check]

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

[Summary] [qfs.qft] [qfs] [check]

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

[Summary] [qfs.qft] [qfs] [check]

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

[Summary] [qfs.qft] [qfs] [check]

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

[Summary] [qfs.qft] [qfs] [check]

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

[Summary] [qfs.qft] [qfs] [check]

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

[Summary] [qfs.qft] [qfs] [check]

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

[Summary] [qfs.qft] [qfs] [check]

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

[Summary] [qfs.qft] [qfs] [check]

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

[Summary] [qfs.qft] [qfs]

Package: 'cleanup'

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

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

Author:: QFS
Since:: 1.05.0

Procedure/Dependency

Description

closeAllDialogs

Close all dialogs.

closeAllMenus

Close all menus unconditionally.

closeAllModalDialogs

Close all modal dialogs.

implicitExceptionHandler

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

[Summary] [qfs.qft] [qfs] [cleanup]

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

[Summary] [qfs.qft] [qfs] [cleanup]

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

[Summary] [qfs.qft] [qfs] [cleanup]

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

[Summary] [qfs.qft] [qfs] [cleanup]

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

[Summary] [qfs.qft] [qfs]

Package: 'client'

Procedures for interacting with (SUT) clients.

Author:: QFS
Since:: 3.4

Procedure/Dependency

Description

renameClient

Rename an SUT client.

sendInput

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

startLogging

Helper method for turning on internal logging.

stopLogging

Helper method for turning off internal logging.

[Summary] [qfs.qft] [qfs] [client]

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

[Summary] [qfs.qft] [qfs] [client]

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

[Summary] [qfs.qft] [qfs] [client]

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

[Summary] [qfs.qft] [qfs] [client]

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

[Summary] [qfs.qft] [qfs]

Package: 'daemon'

Procedures to work with a QF-Test daemon.

Author:: QFS
Since:: 2.9.9

Procedure/Dependency

Description

instrumentRemoteSwt

Starts remote instrumentation procedure for an Eclipse/RCP based or standalone SWT application via a given daemon.

locateDaemons

Locate all running daemons and writes them into the run-log and prints a list of running daemons to the terminal.

startRemoteSUT

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

[Summary] [qfs.qft] [qfs] [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

[Summary] [qfs.qft] [qfs] [daemon]

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

[Summary] [qfs.qft] [qfs] [daemon]

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

[Summary] [qfs.qft] [qfs]

Package: 'database'

Procedures to work with databases.

Author:: QFS,mm
Since:: 2.1.0

Procedure/Dependency

Description

executeSelectStatement

Build up connection to a given database and executes a specified select-sql-statement.

executeStatement

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

[Summary] [qfs.qft] [qfs] [database]

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

[Summary] [qfs.qft] [qfs] [database]

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

[Summary] [qfs.qft] [qfs]

Package: 'databinder'

Procedures to bind data for data-driven testing.

Author:: QFS
Since:: 2.2.0

Procedure/Dependency

Description

bindList

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

bindSets

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

[Summary] [qfs.qft] [qfs] [databinder]

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

[Summary] [qfs.qft] [qfs] [databinder]

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

[Summary] [qfs.qft] [qfs]

Package: 'dialogs'

Procedures for showing dialogs during the test-run.

Author:: QFS
Since:: 3.0

Procedure/Dependency

Description

showConfigurabableDialog

Show a configurable dialog equivalent to JOptionPane.

showInformationMessageDialog

Show an information dialog with an OK option.

showYes_No_Cancel_Dialog

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

showYes_No_Dialog

Show an information dialog with a YES and NO option.

[Summary] [qfs.qft] [qfs] [dialogs]

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

[Summary] [qfs.qft] [qfs] [dialogs]

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

[Summary] [qfs.qft] [qfs] [dialogs]

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

[Summary] [qfs.qft] [qfs] [dialogs]

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

[Summary] [qfs.qft] [qfs]

Package: 'fx'

Procedures for advanced manipulation of fx components.

Author:: QFS
Since:: 4.0

[Summary] [qfs.qft] [qfs] [fx]

Package: 'checkbox'

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

Author:: QFS,mm
Since:: 4.0

Procedure/Dependency

Description

deselect

Deselect a checkbox.

deselectWithCoordinates

Deselect a checkbox.

getValue

Return the value of a checkbox.

select

Select a checkbox.

selectWithCoordinates

Select a checkbox.

set

Set checkbox to the given state.

setWithCoordinates

Set checkbox to the given state.

[Summary] [qfs.qft] [qfs] [fx] [checkbox]

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

[Summary] [qfs.qft] [qfs] [fx] [checkbox]

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

[Summary] [qfs.qft] [qfs] [fx] [checkbox]

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

[Summary] [qfs.qft] [qfs] [fx] [checkbox]

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

[Summary] [qfs.qft] [qfs] [fx] [checkbox]

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

[Summary] [qfs.qft] [qfs] [fx] [checkbox]

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

[Summary] [qfs.qft] [qfs] [fx] [checkbox]

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

[Summary] [qfs.qft] [qfs] [fx]

Package: 'cleanup'

Author:: QFS,gs
Since:: 4.0

Procedure/Dependency

Description

closeAllMenus

Close all menus unconditionally.

closeAllModalDialogs

Close all modal dialogs.

closeMenu

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

implicitExceptionHandler

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

[Summary] [qfs.qft] [qfs] [fx] [cleanup]

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

[Summary] [qfs.qft] [qfs] [fx] [cleanup]

Procedure: 'closeAllModalDialogs'

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

[Summary] [qfs.qft] [qfs] [fx] [cleanup]

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

[Summary] [qfs.qft] [qfs] [fx] [cleanup]

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

[Summary] [qfs.qft] [qfs] [fx]

Package: 'combobox'

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

Author:: QFS,mm
Since:: 4.0

Procedure/Dependency

Description

getIndexOfItem

Return the current index of a given item.

getItemCount

Return the number of items of a given combobox.

getValue

Return the text of a given combobox.

getValueOfItem

Return the text of a given item.

setValue

Select specified value of a given combobox.

setValueViaIndex

Set a value in the combobox.

setValueViaSUTScript

Select specified value of a given combobox using a SUT script.

[Summary] [qfs.qft] [qfs] [fx] [combobox]

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

[Summary] [qfs.qft] [qfs] [fx] [combobox]

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

[Summary] [qfs.qft] [qfs] [fx] [combobox]

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

[Summary] [qfs.qft] [qfs] [fx] [combobox]

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

[Summary] [qfs.qft] [qfs] [fx] [combobox]

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

[Summary] [qfs.qft] [qfs] [fx] [combobox]

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

[Summary] [qfs.qft] [qfs] [fx] [combobox]

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

[Summary] [qfs.qft] [qfs] [fx]

Package: 'general'

Procedures which work for any fx component.

Author:: QFS,mm
Since:: 4.0

Procedure/Dependency

Description

clickAtComponent

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

clickAtComponentWithDetails

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

deleteOverrideComponent

Delete the current association of PriorityFxNode.

doClick

Click on a given component.

doClickWithDetails

Click on a given component.

doSelect

Send a selection event to a given component.

setLocation

Set the location of a given component.

setOverrideComponent

Set a given component to the PriorityFxNode.

setSize

Set the width and the height of a given component.

waitForComponent

Wait for a given component.

waitForComponentForAbsence

Wait till a given component disappears.

[Summary] [qfs.qft] [qfs] [fx] [general]

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

[Summary] [qfs.qft] [qfs] [fx] [general]

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

[Summary] [qfs.qft] [qfs] [fx] [general]

Procedure: 'deleteOverrideComponent'

Delete the current association of PriorityFxNode.

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

[Summary] [qfs.qft] [qfs] [fx] [general]

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

[Summary] [qfs.qft] [qfs] [fx] [general]

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

[Summary] [qfs.qft] [qfs] [fx] [general]

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

[Summary] [qfs.qft] [qfs] [fx] [general]

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

[Summary] [qfs.qft] [qfs] [fx] [general]

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

[Summary] [qfs.qft] [qfs] [fx] [general]

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

[Summary] [qfs.qft] [qfs] [fx] [general]

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

[Summary] [qfs.qft] [qfs] [fx] [general]

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

[Summary] [qfs.qft] [qfs] [fx]

Package: 'list'

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

Author:: QFS,mm
Since:: 4.0

Procedure/Dependency

Description

clickItemWithDetails

Select a given item by a mouse-click on it.

getIndexOfItem

Return the current index of a given item.

getItemCount

Return the number of items of a given list.

getValueOfItem

Return the text of a given item.

selectItem

Select a given item by a mouse-click on it.

[Summary] [qfs.qft] [qfs] [fx] [list]

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

[Summary] [qfs.qft] [qfs] [fx] [list]

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

[Summary] [qfs.qft] [qfs] [fx] [list]

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

[Summary] [qfs.qft] [qfs] [fx] [list]

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

[Summary] [qfs.qft] [qfs] [fx] [list]

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

[Summary] [qfs.qft] [qfs] [fx] [list]

Package: 'checks'

Procedures for checking a list.

Author:: QFS,mm
Since:: 4.0

Procedure/Dependency

Description

checkNumberOfItems

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

[Summary] [qfs.qft] [qfs] [fx] [list] [checks]

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

[Summary] [qfs.qft] [qfs] [fx] [list]

Package: 'selection'

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

Author:: QFS,mm
Since:: 4.0

Procedure/Dependency

Description

deselectAllItems

Deselect all items.

deselectItem

Deselect a given item, specified by its index.

deselectItemRange

Deselect a range of items, specified by their index.

selectAllItems

Select all items.

selectItem

Select a given item, specified by its index.

selectItemRange

Select a range of items, specified by their index.

[Summary] [qfs.qft] [qfs] [fx] [list] [selection]

Procedure: 'deselectAllItems'

Deselect all items. It uses clearSelection.

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

[Summary] [qfs.qft] [qfs] [fx] [list] [selection]

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

[Summary] [qfs.qft] [qfs] [fx] [list] [selection]

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

[Summary] [qfs.qft] [qfs] [fx] [list] [selection]

Procedure: 'selectAllItems'

Select all items. It uses selectAll().

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

[Summary] [qfs.qft] [qfs] [fx] [list] [selection]

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

[Summary] [qfs.qft] [qfs] [fx] [list] [selection]

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

[Summary] [qfs.qft] [qfs] [fx]

Package: 'menu'

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

Author:: QFS
Since:: 4.0

Procedure/Dependency

Description

selectCheckMenuItemInHierarchy

Select a checkbox menu item from a menu.

selectCheckMenuItemInHierarchyWithCoordinates

Select a checkbox menu item from a menu.

selectItem

Select an item from a menu.

selectItemWithCoordinates

Select an item from a menu.

selectMenuItemInHierarchy

Select an item from a menu.

selectMenuItemInHierarchyWithCoordinates

Select an item from a menu.

selectSubItem

Select an item within a submenu.

selectSubItemWithCoordinates

Select an item within a submenu.

setCheckItem

Select a checkbox menu item.

setCheckItemWithCoordinates

Select a checkbox menu item.

setSubCheckItem

Select a checkbox menu item within within a submenu.

setSubCheckItemWithCoordinates

Select a checkbox menu item within within a submenu.

[Summary] [qfs.qft] [qfs] [fx] [menu]

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

[Summary] [qfs.qft] [qfs] [fx] [menu]

Procedure: 'selectCheckMenuItemInHierarchyWithCoordinates'

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

[Summary] [qfs.qft] [qfs] [fx] [menu]

Procedure: 'selectItem'

Select an item from a menu.

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

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

[Summary] [qfs.qft] [qfs] [fx] [menu]

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

[Summary] [qfs.qft] [qfs] [fx] [menu]

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

[Summary] [qfs.qft] [qfs] [fx] [menu]

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

[Summary] [qfs.qft] [qfs] [fx] [menu]

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

[Summary] [qfs.qft] [qfs] [fx] [menu]

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

[Summary] [qfs.qft] [qfs] [fx] [menu]

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

[Summary] [qfs.qft] [qfs] [fx] [menu]

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

[Summary] [qfs.qft] [qfs] [fx] [menu]

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

[Summary] [qfs.qft] [qfs] [fx] [menu]

Procedure: 'setSubCheckItemWithCoordinates'

Select a checkbox menu item within within a submenu.

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

[Summary] [qfs.qft] [qfs] [fx]

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/Dependency

Description

clickItemWithDetails

Select an item in a popup menu.

selectItem

Select an item in a popup menu.

selectSubItem

Select an item within a submenu of a popup menu.

selectSubItemWithCoordinates

Select an item within a submenu of a popup menu.

setCheckItem

Select a checkbox menu item in a popup menu.

setCheckItemWithCoordinates

Select a checkbox menu item in a popup menu.

setSubCheckItem

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

setSubCheckItemWithCoordinates

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

[Summary] [qfs.qft] [qfs] [fx] [popupmenu]

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

[Summary] [qfs.qft] [qfs] [fx] [popupmenu]

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

[Summary] [qfs.qft] [qfs] [fx] [popupmenu]

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

[Summary] [qfs.qft] [qfs] [fx] [popupmenu]

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

[Summary] [qfs.qft] [qfs] [fx] [popupmenu]

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

[Summary] [qfs.qft] [qfs] [fx] [popupmenu]

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

[Summary] [qfs.qft] [qfs] [fx] [popupmenu]

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

[Summary] [qfs.qft] [qfs] [fx] [popupmenu]

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

[Summary] [qfs.qft] [qfs] [fx]

Package: 'radiobutton'

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

Author:: QFS,mm
Since:: 4.0

Procedure/Dependency

Description

getValue

Return the value of a radio button.

select

Select a radio button.

selectWithCoordinates

Select a radio button.

[Summary] [qfs.qft] [qfs] [fx] [radiobutton]

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

[Summary] [qfs.qft] [qfs] [fx] [radiobutton]

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

[Summary] [qfs.qft] [qfs] [fx] [radiobutton]

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

[Summary] [qfs.qft] [qfs] [fx]

Package: 'slider'

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

Author:: QFS, mm
Since:: 4.0

Procedure/Dependency

Description

getValue

Return the value of a slider component.

setValue

Set the value of a slider component.

[Summary] [qfs.qft] [qfs] [fx] [slider]

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

[Summary] [qfs.qft] [qfs] [fx] [slider]

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

[Summary] [qfs.qft] [qfs] [fx] [slider]

Package: 'checks'

Procedure for checking slider values.

Author:: QFS, mm
Since:: 4.0

Procedure/Dependency

Description

checkValue

Check the value of a slider component.

[Summary] [qfs.qft] [qfs] [fx] [slider] [checks]

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

[Summary] [qfs.qft] [qfs] [fx]

Package: 'tabbedpane'

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

Author:: QFS,mm
Since:: 4.0

Procedure/Dependency

Description

closeTab

Close a tab via a selection event.

getIndexOfTab

Return the index of a given tab in a TabPane.

getValueOfTab

Return the text of a given tab in a TabPane.

selectTab

Select a tab in a given TabPane.

[Summary] [qfs.qft] [qfs] [fx] [tabbedpane]

Procedure: 'closeTab'

Close a tab via a selection event.

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

[Summary] [qfs.qft] [qfs] [fx] [tabbedpane]

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

[Summary] [qfs.qft] [qfs] [fx] [tabbedpane]

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

[Summary] [qfs.qft] [qfs] [fx] [tabbedpane]

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

[Summary] [qfs.qft] [qfs] [fx]

Package: 'table'

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

Author:: QFS,mm
Since:: 4.0

Procedure/Dependency

Description

clickCellWithDetails

Select a given cell.

getColumnCount

Return the number of columns of a given table.

getIndexOfColumn

Return the current index of a given column.

getNameOfColumn

Return the header text of a given column.

getRowCount

Return the number of rows of a given table.

getRowIndexOfCell

Return the row number of a given cell.

getValueOfCell

Return the text of a given cell.

resizeColumn

Resize width of a table column.

selectCell

Select a given cell.

[Summary] [qfs.qft] [qfs] [fx] [table]

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

[Summary] [qfs.qft] [qfs] [fx] [table]

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

[Summary] [qfs.qft] [qfs] [fx] [table]

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

[Summary] [qfs.qft] [qfs] [fx] [table]

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

[Summary] [qfs.qft] [qfs] [fx] [table]

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

[Summary] [qfs.qft] [qfs] [fx] [table]

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

[Summary] [qfs.qft] [qfs] [fx] [table]

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

[Summary] [qfs.qft] [qfs] [fx] [table]

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

[Summary] [qfs.qft] [qfs] [fx] [table]

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

[Summary] [qfs.qft] [qfs] [fx] [table]

Package: 'checkbox'

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

Author:: QFS,mm
Since:: 4.0

Procedure/Dependency

Description

deselect

Deselect a checkbox in a table-cell.

deselectWithCoordinates

Deselect a checkbox in a table-cell.

select

Select a checkbox in a table-cell.

selectWithCoordinates

Select a checkbox in a table-cell.

set

Set checkbox in a table-cell to the given state.

setWithCoordinates

Set checkbox in a table-cell to the given state.

[Summary] [qfs.qft] [qfs] [fx] [table] [checkbox]

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

[Summary] [qfs.qft] [qfs] [fx] [table] [checkbox]

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

[Summary] [qfs.qft] [qfs] [fx] [table] [checkbox]

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

[Summary] [qfs.qft] [qfs] [fx] [table] [checkbox]

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

[Summary] [qfs.qft] [qfs] [fx] [table] [checkbox]

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

[Summary] [qfs.qft] [qfs] [fx] [table] [checkbox]

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

[Summary] [qfs.qft] [qfs] [fx] [table]

Package: 'checks'

Procedures for checking a table.

Author:: QFS,mm
Since:: 4.0

Procedure/Dependency

Description

checkNumberOfRows

Check the number of rows of a given table according to a specified comparison mode.

[Summary] [qfs.qft] [qfs] [fx] [table] [checks]

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

[Summary] [qfs.qft] [qfs] [fx] [table]

Package: 'selection'

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

Author:: QFS,mm
Since:: 4.0

Procedure/Dependency

Description

deselectAllRows

Deselect all rows.

deselectRow

Deselect a given row, specified by its index.

deselectRowRange

Deselect a range of rows, specified by their index.

selectAllRows

Select all rows.

selectRow

Select a given row, specified by its index.

selectRowRange

Select a range of rows, specified by their index.

[Summary] [qfs.qft] [qfs] [fx] [table] [selection]

Procedure: 'deselectAllRows'

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

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

[Summary] [qfs.qft] [qfs] [fx] [table] [selection]

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

[Summary] [qfs.qft] [qfs] [fx] [table] [selection]

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

[Summary] [qfs.qft] [qfs] [fx] [table] [selection]

Procedure: 'selectAllRows'

Select all rows. It uses selectAll()

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

[Summary] [qfs.qft] [qfs] [fx] [table] [selection]

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

[Summary] [qfs.qft] [qfs] [fx] [table] [selection]

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

[Summary] [qfs.qft] [qfs] [fx]

Package: 'text'

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

Author:: QFS,mm
Since:: 4.0

Procedure/Dependency

Description

clearArea

Clear a multi-line text area.

clearField

Clear a simple text field.

getText

Return the text of a given textfield.

setText

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

setTextFromFile

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

[Summary] [qfs.qft] [qfs] [fx] [text]

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

[Summary] [qfs.qft] [qfs] [fx] [text]

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

[Summary] [qfs.qft] [qfs] [fx] [text]

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

[Summary] [qfs.qft] [qfs] [fx] [text]

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

[Summary] [qfs.qft] [qfs] [fx] [text]

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

[Summary] [qfs.qft] [qfs] [fx]

Package: 'tree'

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

Author:: QFS,mm
Since:: 4.0

Procedure/Dependency

Description

clickNodeWithDetails

Select a given node.

collapse

Collapse a tree node.

collapseNode

Collapse a tree node.

collapseNodes

Collapse a tree node recursively.

collapseNodeWithCoordinates

Collapse a tree node.

collapseWithCoordinates

Collapse a tree node.

expand

Expand a tree node.

expandNode

Expand a tree node.

expandNodes

Expand a tree node recursively.

expandNodeWithCoordinates

Expand a tree node.

expandWithCoordinates

Expand a tree node.

getChildNodeCount

Return the number of child nodes.

getIndexOfNode

Return the current index of a given node.

getRowCount

Return the number of visible nodes under a given tree or tree-node.

getValueOfNode

Return the text of a given node.

selectNode

Select a given node.

[Summary] [qfs.qft] [qfs] [fx] [tree]

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

[Summary] [qfs.qft] [qfs] [fx] [tree]

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

[Summary] [qfs.qft] [qfs] [fx] [tree]

Procedure: 'collapseNode'

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

[Summary] [qfs.qft] [qfs] [fx] [tree]

Procedure: 'collapseNodes'

Collapse a tree node recursively.

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

[Summary] [qfs.qft] [qfs] [fx] [tree]

Procedure: 'collapseNodeWithCoordinates'

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

[Summary] [qfs.qft] [qfs] [fx] [tree]

Procedure: 'collapseWithCoordinates'

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

[Summary] [qfs.qft] [qfs] [fx] [tree]

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

[Summary] [qfs.qft] [qfs] [fx] [tree]

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

[Summary] [qfs.qft] [qfs] [fx] [tree]

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

[Summary] [qfs.qft] [qfs] [fx] [tree]

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

[Summary] [qfs.qft] [qfs] [fx] [tree]

Procedure: 'expandWithCoordinates'

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

[Summary] [qfs.qft] [qfs] [fx] [tree]

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

[Summary] [qfs.qft] [qfs] [fx] [tree]

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

[Summary] [qfs.qft] [qfs] [fx] [tree]

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

[Summary] [qfs.qft] [qfs] [fx] [tree]

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

[Summary] [qfs.qft] [qfs] [fx] [tree]

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

[Summary] [qfs.qft] [qfs] [fx] [tree]

Package: 'checks'

Procedures for checking a tree.

Author:: QFS,mm
Since:: 3.1.1

Procedure/Dependency

Description

checkNumberOfChildNodes

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

checkNumberOfRows

Check the number of visible nodes under a given tree or tree node according to a specified comparison mode.

[Summary] [qfs.qft] [qfs] [fx] [tree] [checks]

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

[Summary] [qfs.qft] [qfs] [fx] [tree] [checks]

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

[Summary] [qfs.qft] [qfs]

Package: 'pdf'

Procedures for PDF testing.

Author:: QFS
Since:: 4.2

[Summary] [qfs.qft] [qfs] [pdf]

Package: 'highlight'

Procedures in order to highlight components.

Author:: QFS,ys
Since:: 4.2

Procedure/Dependency

Description

hideBordersAroundComponents

Hide borders around each recognized component.

showBordersAroundComponents

Show borders around each recognized component.

toggleBordersAroundComponents

Toggle borders around each recognized component.

[Summary] [qfs.qft] [qfs] [pdf] [highlight]

Procedure: 'hideBordersAroundComponents'

Hide borders around each recognized component.

Author:: QFS,ys
Since:: 4.2

[Summary] [qfs.qft] [qfs] [pdf] [highlight]

Procedure: 'showBordersAroundComponents'

Show borders around each recognized component.

Author:: QFS,ys
Since:: 4.2

[Summary] [qfs.qft] [qfs] [pdf] [highlight]

Procedure: 'toggleBordersAroundComponents'

Toggle borders around each recognized component.

Author:: QFS,ys
Since:: 4.2

[Summary] [qfs.qft] [qfs] [pdf]

Package: 'navigation'

Procedures to navigate inside a PDF document.

Author:: QFS,ys
Since:: 4.2

Procedure/Dependency

Description

iterate

Iterate over all pages in a PDF document.

openFirstPage

Open the first page of the PDF document.

openLastPage

Open the last page of the PDF document.

openNextPage

Open/Goto the next page of the PDF document.

openPage

Open a specific page of the PDF document.

openPrevPage

Open/Goto the previous page of the PDF document.

openRandomPage

Open a random page of the PDF document.

[Summary] [qfs.qft] [qfs] [pdf] [navigation]

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

[Summary] [qfs.qft] [qfs] [pdf] [navigation]

Procedure: 'openFirstPage'

Open the first page of the PDF document.

Author:: QFS,ys
Since:: 4.2

[Summary] [qfs.qft] [qfs] [pdf] [navigation]

Procedure: 'openLastPage'

Open the last page of the PDF document.

Author:: QFS,ys
Since:: 4.2

[Summary] [qfs.qft] [qfs] [pdf] [navigation]

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

[Summary] [qfs.qft] [qfs] [pdf] [navigation]

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

[Summary] [qfs.qft] [qfs] [pdf] [navigation]

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

[Summary] [qfs.qft] [qfs] [pdf] [navigation]

Procedure: 'openRandomPage'

Open a random page of the PDF document.

Author:: QFS,ys
Since:: 4.2

[Summary] [qfs.qft] [qfs] [pdf]

Package: 'page'

Procedures to get/interact with the current page / all pages.

Author:: QFS,ys
Since:: 4.2

Procedure/Dependency

Description

getCurrentPageName

Return the name of the currently selected page in the PDF document.

getCurrentPageNumber

Return the index/number of the currently selected page in the PDF document.

getPageCount

Return the number of pages in a PDF document.

refreshCurrentPage

Refresh the currently opened page.

[Summary] [qfs.qft] [qfs] [pdf] [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

[Summary] [qfs.qft] [qfs] [pdf] [page]

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

[Summary] [qfs.qft] [qfs] [pdf] [page]

Procedure: 'getPageCount'

Return the number of pages in a PDF document.

Author:: QFS,ys
Since:: 4.2

[Summary] [qfs.qft] [qfs] [pdf] [page]

Procedure: 'refreshCurrentPage'

Refresh the currently opened page.

Author:: QFS,ys
Since:: 4.2

[Summary] [qfs.qft] [qfs]

Package: 'run-log'

Procedures for writing log-entries.

Author:: QFS,mm
Since:: 2.1.0

Procedure/Dependency

Description

logError

Write an error into the run-log.

logMessage

Write a message into the run-log.

logWarning

Write a warning into the run-log.

[Summary] [qfs.qft] [qfs] [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

[Summary] [qfs.qft] [qfs] [run-log]

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

[Summary] [qfs.qft] [qfs] [run-log]

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

[Summary] [qfs.qft] [qfs] [run-log]

Package: 'screenshots'

Procedures to write screenshots into the run-log.

Author:: QFS,mm
Since:: 3.0

Procedure/Dependency

Description

getMonitorCount

Return the total number of monitors.

logImageOfComponent

Write an image of a component into the run-log.

logScreenshot

Write a screenshot of the whole screen into the run-log.

logScreenshotOfMonitor

Write a screenshots of a given monitor into the run-log.

[Summary] [qfs.qft] [qfs] [run-log] [screenshots]

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

[Summary] [qfs.qft] [qfs] [run-log] [screenshots]

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

[Summary] [qfs.qft] [qfs] [run-log] [screenshots]

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

[Summary] [qfs.qft] [qfs] [run-log] [screenshots]

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

[Summary] [qfs.qft] [qfs] [run-log]

Package: 'web'

Procedures to write web specifics into run-log.

Author:: QFS,mm
Since:: 3.4.9

Procedure/Dependency

Description

logSourcecode

Write a document's source code into the run-log.

[Summary] [qfs.qft] [qfs] [run-log] [web]

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

[Summary] [qfs.qft] [qfs]

Package: 'shellutils'

Utility procedures for shell commands.

Author:: QFS,mm
Since:: 2.2

Procedure/Dependency

Description

copy

Copy a given file or directory to a given target.

deleteFile

Delete a file.

exists

Check whether a given file or directory exists.

getBasename

Return the basename of the given file or directory.

getParentdirectory

Return the parent directory of the given file or directory.

mkdir

Create a given directory.

move

Move a given file or directory to a given target.

removeDirectory

Remove a given directory.

touch

Create a given file or update the last modified date of an existing file.

[Summary] [qfs.qft] [qfs] [shellutils]

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

[Summary] [qfs.qft] [qfs] [shellutils]

Procedure: 'deleteFile'

Delete a file.

Parameters:: file - The file to remove.
Author:: QFS,mm
Since:: 2.2

[Summary] [qfs.qft] [qfs] [shellutils]

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

[Summary] [qfs.qft] [qfs] [shellutils]

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

[Summary] [qfs.qft] [qfs] [shellutils]

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

[Summary] [qfs.qft] [qfs] [shellutils]

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

[Summary] [qfs.qft] [qfs] [shellutils]

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

[Summary] [qfs.qft] [qfs] [shellutils]

Procedure: 'removeDirectory'

Remove a given directory.

Parameters:: directory - The directory to remove.
Author:: QFS,mm
Since:: 2.2

[Summary] [qfs.qft] [qfs] [shellutils]

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

[Summary] [qfs.qft] [qfs]

Package: 'swing'

Procedures for advanced manipulation of swing components.

Author:: QFS
Since:: 1.05.0

[Summary] [qfs.qft] [qfs] [swing]

Package: 'checkbox'

Procedures to set the state of checkboxes. (Swing component javax.swing.JCheckBox)

Author:: QFS,mm
Since:: 1.05.0

Procedure/Dependency

Description

deselect

Deselect a checkbox.

deselectWithCoordinates

Deselect a checkbox.

getValue

Return the value of a checkbox.

select

Select a checkbox.

selectWithCoordinates

Select a checkbox.

set

Set checkbox to the given state.

setWithCoordinates

Set checkbox to the given state.

[Summary] [qfs.qft] [qfs] [swing] [checkbox]

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

[Summary] [qfs.qft] [qfs] [swing] [checkbox]

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

[Summary] [qfs.qft] [qfs] [swing] [checkbox]

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

[Summary] [qfs.qft] [qfs] [swing] [checkbox]

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

[Summary] [qfs.qft] [qfs] [swing] [checkbox]

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

[Summary] [qfs.qft] [qfs] [swing] [checkbox]

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

[Summary] [qfs.qft] [qfs] [swing] [checkbox]

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

[Summary] [qfs.qft] [qfs] [swing]

Package: 'cleanup'

Author:: QFS,mm
Since:: 2.1.0

Procedure/Dependency

Description

closeAllDialogs

Close all dialogs.

closeAllMenus

Close all menus unconditionally.

closeAllModalDialogs

Close all modal dialogs.

implicitExceptionHandler

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

[Summary] [qfs.qft] [qfs] [swing] [cleanup]

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

[Summary] [qfs.qft] [qfs] [swing] [cleanup]

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

[Summary] [qfs.qft] [qfs] [swing] [cleanup]

Procedure: 'closeAllModalDialogs'

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

[Summary] [qfs.qft] [qfs] [swing] [cleanup]

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

[Summary] [qfs.qft] [qfs] [swing]

Package: 'combobox'

Procedures to handle comboboxes. (Swing component javax.swing.JComboBox)

Author:: QFS,mm
Since:: 2.1.0

Procedure/Dependency

Description

getIndexOfItem

Return the current index of a given item.

getItemCount

Return the number of items of a given combobox.

getValue

Return the text of a given combobox.

getValueOfItem

Return the text of a given item.

setValue

Select specified value of a given combobox.

setValueViaIndex

Set a value in the combobox.

setValueViaSUTScript

Select specified value of a given combobox using a SUT script.

[Summary] [qfs.qft] [qfs] [swing] [combobox]

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

[Summary] [qfs.qft] [qfs] [swing] [combobox]

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

[Summary] [qfs.qft] [qfs] [swing] [combobox]

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

[Summary] [qfs.qft] [qfs] [swing] [combobox]

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

[Summary] [qfs.qft] [qfs] [swing] [combobox]

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

[Summary] [qfs.qft] [qfs] [swing] [combobox]

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

[Summary] [qfs.qft] [qfs] [swing] [combobox]

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

[Summary] [qfs.qft] [qfs] [swing]

Package: 'dialogs'

Procedures to handle Dialogs. (Swing component javax.swing.JDialog)

Author:: QFS,kk
Since:: 3.4.14

Procedure/Dependency

Description

handleSecurityWarning

Wait for the client to connect and check whether a Java security dialog blocks the JRE start which need to be confirmed.

[Summary] [qfs.qft] [qfs] [swing] [dialogs]

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

[Summary] [qfs.qft] [qfs] [swing]

Package: 'filechooser'

Procedures for accessing file chooser dialogs. (Swing component javax.swing.JFileChooser)

Author:: QFS
Since:: 1.05.0

Procedure/Dependency Description

disableNameResolver

Uninstall the JFileChooser name resolver.

enableNameResolver

Install the JFileChooser name resolver.

selectFile

Select a file in a JFileChooser dialog.

selectFiles

Select several files in a JFileChooser dialog.

[Summary] [qfs.qft] [qfs] [swing] [filechooser]

Procedure: 'disableNameResolver'

Uninstall the JFileChooser name resolver.

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

[Summary] [qfs.qft] [qfs] [swing] [filechooser]

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

[Summary] [qfs.qft] [qfs] [swing] [filechooser]

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

[Summary] [qfs.qft] [qfs] [swing] [filechooser]

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

[Summary] [qfs.qft] [qfs] [swing]

Package: 'general'

Procedures which work for any Swing component.

Author:: QFS,mm
Since:: 2.1.0

Procedure/Dependency

Description

clickAtComponent

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

clickAtComponentWithDetails

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

deleteOverrideComponent

Delete the current association of PriorityAwtSwingComponent.

doClick

Click on a given component.

doClickWithDetails

Click on a given component.

doSelect

Send a selection event to a given component.

setLocation

Set the location of a given component.

setOverrideComponent

Set a given component to the PriorityAwtSwingComponent.

setSize

Set the width and the height of a given component.

waitForComponent

Wait for a given component.

waitForComponentForAbsence

Wait till a given component disappears.

[Summary] [qfs.qft] [qfs] [swing] [general]

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

[Summary] [qfs.qft] [qfs] [swing] [general]

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

[Summary] [qfs.qft] [qfs] [swing] [general]

Procedure: 'deleteOverrideComponent'

Delete the current association of PriorityAwtSwingComponent.

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

[Summary] [qfs.qft] [qfs] [swing] [general]

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

[Summary] [qfs.qft] [qfs] [swing] [general]

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

[Summary] [qfs.qft] [qfs] [swing] [general]

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

[Summary] [qfs.qft] [qfs] [swing] [general]

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

[Summary] [qfs.qft] [qfs] [swing] [general]

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

[Summary] [qfs.qft] [qfs] [swing] [general]

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

[Summary] [qfs.qft] [qfs] [swing] [general]

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

[Summary] [qfs.qft] [qfs] [swing] [general]

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

[Summary] [qfs.qft] [qfs] [swing]

Package: 'list'

Procedures for accessing lists. (Swing component javax.swing.JList)

Author:: QFS,mm
Since:: 3.0

Procedure/Dependency

Description

clickItemWithDetails

Select a given item by a mouse-click on it.

getIndexOfItem

Return the current index of a given item.

getItemCount

Return the number of items of a given list.

getValueOfItem

Return the text of a given item.

selectItem

Select a given item by a mouse-click on it.

[Summary] [qfs.qft] [qfs] [swing] [list]

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

[Summary] [qfs.qft] [qfs] [swing] [list]

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

[Summary] [qfs.qft] [qfs] [swing] [list]

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

[Summary] [qfs.qft] [qfs] [swing] [list]

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

[Summary] [qfs.qft] [qfs] [swing] [list]

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

[Summary] [qfs.qft] [qfs] [swing] [list]

Package: 'checks'

Procedures for checking a list.

Author:: QFS,mm
Since:: 3.1.1

Procedure/Dependency

Description

checkNumberOfItems

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

[Summary] [qfs.qft] [qfs] [swing] [list] [checks]

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

[Summary] [qfs.qft] [qfs] [swing] [list]

Package: 'selection'

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

Author:: QFS,mm
Since:: 3.1.1

Procedure/Dependency

Description

deselectAllItems

Deselect all items.

deselectItem

Deselect a given item, specified by its index.

deselectItemRange

Deselect a range of items, specified by their index.

selectAllItems

Select all items.

selectItem

Select a given item, specified by its index.

selectItemRange

Select a range of items, specified by their index.

[Summary] [qfs.qft] [qfs] [swing] [list] [selection]

Procedure: 'deselectAllItems'

Deselect all items. It uses removeSelectionInterval.

Parameters:: id - ID of the list.
Author:: QFS,mm
Since:: 3.1.1

[Summary] [qfs.qft] [qfs] [swing] [list] [selection]

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

[Summary] [qfs.qft] [qfs] [swing] [list] [selection]

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

[Summary] [qfs.qft] [qfs] [swing] [list] [selection]

Procedure: 'selectAllItems'

Select all items. It uses setSelectionInterval.

Parameters:: id - ID of the list.
Author:: QFS,mm
Since:: 3.1.1

[Summary] [qfs.qft] [qfs] [swing] [list] [selection]

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

[Summary] [qfs.qft] [qfs] [swing] [list] [selection]

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

[Summary] [qfs.qft] [qfs] [swing]

Package: 'menu'

Procedures to select menu items and checkbox menu items. (Swing components javax.swing.JMenuItem and javax.swing.JCheckBoxMenuItem from javax.swing.JMenu)

Author:: QFS
Since:: 1.05.0

Procedure/Dependency

Description

selectCheckMenuItemInHierarchy

Select a checkbox menu item from a menu.

selectCheckMenuItemInHierarchyWithCoordinates

Select a checkbox menu item from a menu.

selectItem

Select an item from a menu.

selectItemWithCoordinates

Select an item from a menu.

selectMenuItemInHierarchy

Select an item from a menu.

selectMenuItemInHierarchyWithCoordinates

Select an item from a menu.

selectSubItem

Select an item within a submenu.

selectSubItemWithCoordinates

Select an item within a submenu.

setCheckItem

Select a checkbox menu item.

setCheckItemWithCoordinates

Select a checkbox menu item.

setSubCheckItem

Select a checkbox menu item within within a submenu.

setSubCheckItemWithCoordinates

Select a checkbox menu item within within a submenu.

[Summary] [qfs.qft] [qfs] [swing] [menu]

Procedure: 'selectCheckMenuItemInHierarchy'

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

[Summary] [qfs.qft] [qfs] [swing] [menu]

Procedure: 'selectCheckMenuItemInHierarchyWithCoordinates'

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

[Summary] [qfs.qft] [qfs] [swing] [menu]

Procedure: 'selectItem'

Select an item from a menu.

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

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

[Summary] [qfs.qft] [qfs] [swing] [menu]

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

[Summary] [qfs.qft] [qfs] [swing] [menu]

Procedure: 'selectMenuItemInHierarchy'

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

[Summary] [qfs.qft] [qfs] [swing] [menu]

Procedure: 'selectMenuItemInHierarchyWithCoordinates'

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

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

[Summary] [qfs.qft] [qfs] [swing] [menu]

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

[Summary] [qfs.qft] [qfs] [swing] [menu]

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

[Summary] [qfs.qft] [qfs] [swing] [menu]

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

[Summary] [qfs.qft] [qfs] [swing] [menu]

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

[Summary] [qfs.qft] [qfs] [swing] [menu]

Procedure: 'setSubCheckItem'

Select a checkbox menu item within within a submenu.

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

[Summary] [qfs.qft] [qfs] [swing] [menu]

Procedure: 'setSubCheckItemWithCoordinates'

Select a checkbox menu item within within a submenu.

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

[Summary] [qfs.qft] [qfs] [swing]

Package: 'optionpane'

Procedures for accessing standard error/message dialogs. (Swing component javax.swing.JOptionPane)

Author:: QFS
Since:: 1.07.0

Procedure/Dependency Description

checkMessage

Check the message of the current javax.swing.JOptionPane dialog.

checkTitle

Check the title of the current javax.swing.JOptionPane dialog.

clickCancelButton

Click on the Cancel Button of the current javax.swing.JOptionPane dialog.

clickNoButton

Click on the No Button of the current javax.swing.JOptionPane dialog.

clickOkButton

Click on the OK Button of the current javax.swing.JOptionPane dialog.

clickYesButton

Click on the Yes Button of the current javax.swing.JOptionPane dialog.

disableNameResolver

Uninstall the JOptionPane name resolver.

enableNameResolver

Install the JOptionPane name resolver.

getMessage

Get the message of the current javax.swing.JOptionPane dialog.

getOptionPaneMessageType

Return the message Type of the current javax.swing.JOptionPane dialog.

getTitle

Get the title of the current javax.swing.JOptionPane dialog.

hasCancelButton

Check if the current javax.swing.JOptionPane dialog has an Cancel Button.

hasNoButton

Check if the current javax.swing.JOptionPane dialog has an NO Button.

hasOkButton

Check if the current javax.swing.JOptionPane dialog has an OK Button.

hasYesButton

Check if the current javax.swing.JOptionPane dialog has an YES Button.

isErrorDialog

Check, if current window is a javax.swing.JOptionPane ErrorDialog.

isInfoDialog

Check, if current window is a javax.swing.JOptionPane InfoDialog.

isOptionPane

Check, if current window is a javax.swing.JOptionPane dialog.

isPlainDialog

Check, if current window is a javax.swing.JOptionPane PlainDialog.

isQuestionDialog

Check, if current window is a javax.swing.JOptionPane QuestionDialog.

isWarningDialog

Check, if current window is a javax.swing.JOptionPane WarningDialog.

[Summary] [qfs.qft] [qfs] [swing] [optionpane]

Procedure: 'checkMessage'

Check the message of the current javax.swing.JOptionPane dialog.

Parameters:: client - The name of the SUT client.; newline - The newline character used in the JOptionPane dialog.; expectedMsg - The string representing the expected message.; checkMessage - The message, which should be written into the run-log for that check.; compareMode - The comparison mode. = or ==, asserts got == expected <, asserts got < expected >, asserts got > expected <=, asserts got <= expected >=, asserts got >= expected !=, asserts got != expected regexp, the expected value should be treated as a regular expression, that matches the received value. regexpNegate, the expected value should be treated as a regular expression, that doesn't match the received value.; errorLevel - The kind of error, which should be logged. Either EXCEPTION, ERROR, WARNING or MESSAGE.; appearInReport - Flag, whether to show check in report, if a message or warning are set as errorLevel. If this is set to 1, the check will be shown in the report.
Exceptions:: UserException - If wrong comparison mode has been set this exception will be thrown.; ClientNotConnectedException - If SUT wasn't started this exception will be thrown.; ComponentNotFoundException - If no optionpane dialog was found, this exception will be thrown.
Author:: QFS,ys
Since:: 3.5.3

[Summary] [qfs.qft] [qfs] [swing] [optionpane]

Procedure: 'checkTitle'

Check the title of the current javax.swing.JOptionPane dialog.

Parameters:: client - The name of the SUT client.; expectedTitle - The string representing the expected title.; checkMessage - The message, which should be written into the run-log for that check.; compareMode - The comparison mode. = or ==, asserts got == expected <, asserts got < expected >, asserts got > expected <=, asserts got <= expected >=, asserts got >= expected !=, asserts got != expected regexp, the expected value should be treated as regular expression, that matches the received value. regexpNegate, the expected value should be treated as regular expression, that doesn't match the received value.; errorLevel - The kind of error, which should be logged. Either EXCEPTION, ERROR, WARNING or MESSAGE.; appearInReport - Flag, whether to show check in report, if a message or warning are set as errorLevel. If this is set to 1, the check will be shown in the report.
Exceptions:: UserException - If wrong comparison mode has been set this exception will be thrown.; ClientNotConnectedException - If SUT wasn't started this exception will be thrown.; ComponentNotFoundException - If no optionpane dialog was found, this exception will be thrown.
Author:: QFS,ys
Since:: 3.5.3

[Summary] [qfs.qft] [qfs] [swing] [optionpane]

Procedure: 'clickCancelButton'

Click on the Cancel Button of the current javax.swing.JOptionPane dialog.

Parameters:: client - The name of the SUT client.
Exceptions:: ClientNotConnectedException - If SUT wasn't started this exception will be thrown.; ComponentNotFoundException - If no optionpane dialog was found, this exception will be thrown.
Author:: QFS,ys
Since:: 3.5.3

[Summary] [qfs.qft] [qfs] [swing] [optionpane]

Procedure: 'clickNoButton'

Click on the No Button of the current javax.swing.JOptionPane dialog.

Parameters:: client - The name of the SUT client.
Exceptions:: ClientNotConnectedException - If SUT wasn't started this exception will be thrown.; ComponentNotFoundException - If no optionpane dialog was found, this exception will be thrown.
Author:: QFS,ys
Since:: 3.5.3

[Summary] [qfs.qft] [qfs] [swing] [optionpane]

Procedure: 'clickOkButton'

Click on the OK Button of the current javax.swing.JOptionPane dialog.

Parameters:: client - The name of the SUT client.
Exceptions:: ClientNotConnectedException - If SUT wasn't started this exception will be thrown.; ComponentNotFoundException - If no optionpane dialog was found, this exception will be thrown.
Author:: QFS,ys
Since:: 3.5.3

[Summary] [qfs.qft] [qfs] [swing] [optionpane]

Procedure: 'clickYesButton'

Click on the Yes Button of the current javax.swing.JOptionPane dialog.

Parameters:: client - The name of the SUT client.
Exceptions:: ClientNotConnectedException - If SUT wasn't started this exception will be thrown.; ComponentNotFoundException - If no optionpane dialog was found, this exception will be thrown.
Author:: QFS,ys
Since:: 3.5.3

[Summary] [qfs.qft] [qfs] [swing] [optionpane]

Procedure: 'disableNameResolver'

Uninstall the JOptionPane name resolver.

The name resolver is automatically enabled and disabled by the other procedures of this packages. Therefore you typically don't need to do this explicitely.

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

[Summary] [qfs.qft] [qfs] [swing] [optionpane]

Procedure: 'enableNameResolver'

Install the JOptionPane name resolver. The effect is similar to assigning names to the most important components in JOptionPane dialogs with setName().

The name resolver is automatically enabled and disabled by the other procedures of this packages. Therefore you typically don't need to do this explicitely.

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

[Summary] [qfs.qft] [qfs] [swing] [optionpane]

Procedure: 'getMessage'

Get the message of the current javax.swing.JOptionPane dialog.

Parameters:: client - The name of the SUT client.; newline - The newline character used in the JOptionPane dialog.
Returns:: The message of the optionpane dialog.
Exceptions:: ClientNotConnectedException - If SUT wasn't started this exception will be thrown.; ComponentNotFoundException - If no optionpane dialog was found, this exception will be thrown.
Author:: QFS,ys
Since:: 3.5.3

[Summary] [qfs.qft] [qfs] [swing] [optionpane]

Procedure: 'getOptionPaneMessageType'

Return the message Type of the current javax.swing.JOptionPane dialog.

Parameters:: client - The name of the SUT client.
Returns:: This function returns one of the following Strings: ErrorDialog, if an error dialog was detected; InfoDialog, if an info dialog was detected; WarningDialog, if a warning dialog was detected; PlainDialog, if a plain dialog was detected; QuestionDialog, if a question dialog was detected.
Exceptions:: ClientNotConnectedException - If SUT wasn't started this exception will be thrown.; ComponentNotFoundException - If no JOptionPane dialog was found, this exception will be thrown!; UserException - with the message "Unknown dialog!" if non of these dialogs could be detected.
Author:: QFS,ys
Since:: 3.5.3

[Summary] [qfs.qft] [qfs] [swing] [optionpane]

Procedure: 'getTitle'

Get the title of the current javax.swing.JOptionPane dialog.

Parameters:: client - The name of the SUT client.
Returns:: Returns the title of the current optionpane dialog.
Exceptions:: ClientNotConnectedException - If SUT wasn't started this exception will be thrown.
Author:: QFS,ys
Since:: 3.5.3

[Summary] [qfs.qft] [qfs] [swing] [optionpane]

Procedure: 'hasCancelButton'

Check if the current javax.swing.JOptionPane dialog has an Cancel Button.

Parameters:: client - The name of the SUT client.; throwExc - Whether to throw a ComponentNotFoundException, if the optionpane dialog has no Cancel button.
Returns:: The result of the check ('true' if Cancel Button was found otherwise 'false').
Exceptions:: ClientNotConnectedException - If SUT wasn't started this exception will be thrown.; ComponentNotFoundException - If no optionpane dialog or no Cancel Button was found, this exception will be thrown.
Author:: QFS,ys
Since:: 3.5.3

[Summary] [qfs.qft] [qfs] [swing] [optionpane]

Procedure: 'hasNoButton'

Check if the current javax.swing.JOptionPane dialog has an NO Button.

Parameters:: client - The name of the SUT client.; throwExc - Whether to throw a ComponentNotFoundException, if the optionpane dialog has no NO button.
Returns:: The result of the check ('true' if NO Button was found otherwise 'false').
Exceptions:: ClientNotConnectedException - If SUT wasn't started this exception will be thrown.; ComponentNotFoundException - If no optionpane dialog or no No Button was found, this exception will be thrown.
Author:: QFS,ys
Since:: 3.5.3

[Summary] [qfs.qft] [qfs] [swing] [optionpane]

Procedure: 'hasOkButton'

Check if the current javax.swing.JOptionPane dialog has an OK Button.

Parameters:: client - The name of the SUT client.; throwExc - Whether to throw a ComponentNotFoundException, if the optionpane dialog has no OK button.
Returns:: The result of the check ('true' if OK Button was found otherwise 'false').
Exceptions:: ClientNotConnectedException - If SUT wasn't started this exception will be thrown.; ComponentNotFoundException - If no optionpane dialog or no Ok Button was found, this exception will be thrown.
Author:: QFS,ys
Since:: 3.5.3

[Summary] [qfs.qft] [qfs] [swing] [optionpane]

Procedure: 'hasYesButton'

Check if the current javax.swing.JOptionPane dialog has an YES Button.

Parameters:: client - The name of the SUT client.; throwExc - Whether to throw a ComponentNotFoundException, if the optionpane dialog has no YES button.
Returns:: The result of the check ('true' if YES Button was found otherwise 'false').
Exceptions:: ClientNotConnectedException - If SUT wasn't started this exception will be thrown.; ComponentNotFoundException - If no optionpane dialog or no Yes Button was found, this exception will be thrown.
Author:: QFS,ys
Since:: 3.5.3

[Summary] [qfs.qft] [qfs] [swing] [optionpane]

Procedure: 'isErrorDialog'

Check, if current window is a javax.swing.JOptionPane ErrorDialog.

Parameters:: client - The name of the SUT client.; throwExc - Whether to throw an exception, if the JOptionPane ErrorDialog wasn't found.
Returns:: This function returns true if current window is a JOptionPane error dialog, otherwise false.
Exceptions:: ClientNotConnectedException - If SUT wasn't started this exception will be thrown.
Author:: QFS,ys
Since:: 3.5.3

[Summary] [qfs.qft] [qfs] [swing] [optionpane]

Procedure: 'isInfoDialog'

Check, if current window is a javax.swing.JOptionPane InfoDialog.

Parameters:: client - The name of the SUT client.; throwExc - Whether to throw an exception, if the JOptionPane InfoDialog wasn't found.
Returns:: This function returns true if current window is a JOptionPane info dialog, otherwise false.
Exceptions:: ClientNotConnectedException - If SUT wasn't started this exception will be thrown.
Author:: QFS,ys
Since:: 3.5.3

[Summary] [qfs.qft] [qfs] [swing] [optionpane]

Procedure: 'isOptionPane'

Check, if current window is a javax.swing.JOptionPane dialog.

Parameters:: client - The name of the SUT client.; throwExc - Whether to throw an exception, if the JOptionPane dialog wasn't found.
Returns:: This function returns true if current window is a JOptionPane dialog, otherwise false.
Exceptions:: ClientNotConnectedException - If SUT wasn't started this exception will be thrown.
Author:: QFS,ys
Since:: 3.5.3

[Summary] [qfs.qft] [qfs] [swing] [optionpane]

Procedure: 'isPlainDialog'

Check, if current window is a javax.swing.JOptionPane PlainDialog.

Parameters:: client - The name of the SUT client.; throwExc - Whether to throw an exception, if the JOptionPane dialog wasn't found.
Returns:: This function returns true if current window is a JOptionPane plain dialog, otherwise false.
Exceptions:: ClientNotConnectedException - If SUT wasn't started this exception will be thrown.
Author:: QFS,ys
Since:: 3.5.3

[Summary] [qfs.qft] [qfs] [swing] [optionpane]

Procedure: 'isQuestionDialog'

Check, if current window is a javax.swing.JOptionPane QuestionDialog.

Parameters:: client - The name of the SUT client.; throwExc - Whether to throw an exception, if the JOptionPane QuestionDialog wasn't found.
Returns:: This function returns true if current window is a JOptionPane question dialog, otherwise false.
Exceptions:: ClientNotConnectedException - If SUT wasn't started this exception will be thrown.
Author:: QFS,ys
Since:: 3.5.3

[Summary] [qfs.qft] [qfs] [swing] [optionpane]

Procedure: 'isWarningDialog'

Check, if current window is a javax.swing.JOptionPane WarningDialog.

Parameters:: client - The name of the SUT client.; throwExc - Whether to throw an exception, if the JOptionPane WarningDialog wasn't found.
Returns:: This function returns true if current window is a JOptionPane warning dialog, otherwise false.
Exceptions:: ClientNotConnectedException - If SUT wasn't started this exception will be thrown.
Author:: QFS,ys
Since:: 3.5.3

[Summary] [qfs.qft] [qfs] [swing]

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. (Swing components javax.swing.JMenuItem and javax.swing.JCheckBoxMenuItem from javax.swing.JPopupMenu)

Author:: QFS
Since:: 1.05.0

Procedure/Dependency

Description

clickItemWithDetails

Select an item in a popup menu.

selectItem

Select an item in a popup menu.

selectSubItem

Select an item within a submenu of a popup menu.

selectSubItemWithCoordinates

Select an item within a submenu of a popup menu.

setCheckItem

Select a checkbox menu item in a popup menu.

setCheckItemWithCoordinates

Select a checkbox menu item in a popup menu.

setSubCheckItem

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

setSubCheckItemWithCoordinates

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

[Summary] [qfs.qft] [qfs] [swing] [popupmenu]

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

[Summary] [qfs.qft] [qfs] [swing] [popupmenu]

Procedure: 'selectItem'

Select an item in a popup menu.

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

[Summary] [qfs.qft] [qfs] [swing] [popupmenu]

Procedure: 'selectSubItem'

Select an item within a submenu of a popup menu.

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

[Summary] [qfs.qft] [qfs] [swing] [popupmenu]

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

[Summary] [qfs.qft] [qfs] [swing] [popupmenu]

Procedure: 'setCheckItem'

Select a checkbox menu item in a popup menu.

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

[Summary] [qfs.qft] [qfs] [swing] [popupmenu]

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

[Summary] [qfs.qft] [qfs] [swing] [popupmenu]

Procedure: 'setSubCheckItem'

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

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

[Summary] [qfs.qft] [qfs] [swing] [popupmenu]

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

[Summary] [qfs.qft] [qfs] [swing]

Package: 'radiobutton'

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

Author:: QFS,mm
Since:: 3.5.0

Procedure/Dependency

Description

getValue

Return the value of a radio button.

select

Select a radio button.

selectWithCoordinates

Select a radio button.

[Summary] [qfs.qft] [qfs] [swing] [radiobutton]

Procedure: 'getValue'

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

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

[Summary] [qfs.qft] [qfs] [swing] [radiobutton]

Procedure: 'select'

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

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

[Summary] [qfs.qft] [qfs] [swing] [radiobutton]

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

[Summary] [qfs.qft] [qfs] [swing]

Package: 'slider'

Procedures to access sliders. (Swing component javax.swing.JSlider)

Author:: QFS, mm
Since:: 3.4.1

Procedure/Dependency

Description

getValue

Return the value of a slider component.

setValue

Set the value of a slider component.

[Summary] [qfs.qft] [qfs] [swing] [slider]

Procedure: 'getValue'

Return the value of a slider component.

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

[Summary] [qfs.qft] [qfs] [swing] [slider]

Procedure: 'setValue'

Set the value of a slider component.

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

[Summary] [qfs.qft] [qfs] [swing] [slider]

Package: 'checks'

Procedure for checking slider values.

Author:: QFS, mm
Since:: 3.4.1

Procedure/Dependency

Description

checkValue

Check the value of a slider component

[Summary] [qfs.qft] [qfs] [swing] [slider] [checks]

Procedure: 'checkValue'

Check the value of a slider component

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

[Summary] [qfs.qft] [qfs] [swing]

Package: 'startup'

Procedures for startup of swing applications.

Author:: QFS, gs
Since:: 3.4.14

Procedure/Dependency

Description

setDelays

Set delays for the QF-Test SUT initialization process.

setSecurityDialogSpec

Define properties for recognizing WebStart and applet security dialogs that should be closed automatically.

startAppletSUT

Start an applet as SUT in a browser.

startWebstartSUT

Start a Webstart SUT.

[Summary] [qfs.qft] [qfs] [swing] [startup]

Procedure: 'setDelays'

Set delays for the QF-Test SUT initialization process.

Note: Values that are documented to have a default will pick up that default when you set them to 0. Use 1 to disable the default.

The Java WebStart launcher has several race conditions where initialization of QF-Test SUT client wrapper can lead to problems, even to crashes. Newer versions of the Java applet plugin exhibit similar problems. QF-Test therefore delays certain steps in the SUT connection process to allow the SUT to get past the critical points.

By calling this procedure before SUT startup with one or more of the following parameters it is possible to fine-tune these delays. Unfortunately there is no single optimal setting. In case you experience problems with SUT startup you will need to experiment with these values. Start with few parameters and values between 5000 and 10000.

Parameters:: delay-1 - Earliest place, called once. Default is 3000 for WebStart and applets. Good choice up to 30000.; delay0 - Before checking ThreadGroups. Called often, use small values.; delay10 - After checking ThreadGroups. Called often, use small values.; delay1 - Before checking ThreadGroups for security engine. Called often, use small values.; delay11 - After checking ThreadGroups for security engine. Called often, use small values.; delay2 - Applet plugin only, good choice for that.; delay3 - Before initializing RMI, normal engine. Good choice. Default 3000.; delay13 - Before initializing RMI, security engine. Good choice. Default 2000.; delay4 - Before creating security engine. Rarely useful.; delay5 - Before installing EventQueue. Rarely useful.; delay6 - After installing EventQueue. Rarely useful.; delay7 - Before connecting with QF-Test. Rarely useful.; delay8 - WebStart only. Before initializing the engine on the system ThreadGroup which should be avoided if possible. Default 30000.; delay20 - WebStart and applet only. Before automatically closing security dialogs. Can be set to enable manual interaction. Default 300.
Author:: QFS,gs
Since:: 3.4.14

[Summary] [qfs.qft] [qfs] [swing] [startup]

Procedure: 'setSecurityDialogSpec'

Define properties for recognizing WebStart and applet security dialogs that should be closed automatically. Default values, which handle English and German security dialogs in current versions of Java 6, 7 and 8 apply in case of empty parameters.

Do disable automatic handling of security dialogs, set the title parameter to '-'.

Parameters:: title - A regular expression matching the dialog title. Set to '-' to disable automatic handling of security dialogs. Default: .*(Security|Sicherheit).*; button - A regular expression matching the text of the button to click. Default: (OK|Yes|Run|Continue|Ja|Ausf.hren|Fortfahren|Weiter); permanent - Whether to accept the certificate permanently. Default is false.; checkbox - A regular expression matching the text of the checkbox to select in order to accept the certificate permanently. Default: .*(not show this again|lways trust|nicht mehr anzeigen|immer vertrauen).*
Author:: QFS,gs
Since:: 3.5.2

[Summary] [qfs.qft] [qfs] [swing] [startup]

Procedure: 'startAppletSUT'

Start an applet as SUT in a browser.

It is ensured a new browser default is used, otherwise the applet is not properly recognized by QF-Test.

This procedure just delegates to qfs.web.browser.general.startAsNewProcess. Therefore parameter description can be found at http://www.qfs.de/include/qfs_pkgdoc/qfs_pkgdoc.html#qfs.web.browser.general.startAsNewProcess

Author:: QFS,kk
Since:: 3.5

[Summary] [qfs.qft] [qfs] [swing] [startup]

Procedure: 'startWebstartSUT'

Start a Webstart SUT.

Parameters:: client - The client.; exec - The Java webstart executable. Default is javaws.; jnlp - The jnlp Descriptor file either given local or as URL.; waitForClientTimeout - Time in ms to wait for the client to connect. Default is 120000.
Author:: QFS,kk
Since:: 3.5

[Summary] [qfs.qft] [qfs] [swing]

Package: 'tabbedpane'

Procedures to work with TabbedPanes. (Swing component javax.swing.JTabbedPane or any other TabFolder implementations)

Author:: QFS,mm
Since:: 2.1.0

Procedure/Dependency

Description

closeTab

Close a tab via clicking on the "X "button.

getIndexOfTab

Return the index of a given tab in a JTabbedPane.

getValueOfTab

Return the text of a given tab in a JTabbedPane.

selectTab

Select a tab in a given TabbedPane.

[Summary] [qfs.qft] [qfs] [swing] [tabbedpane]

Procedure: 'closeTab'

Close a tab via clicking on the "X "button. The procedure assumes that the "X" button is located 10 pixel away from the right corner. If this doesn't work for you, you can configure this via the parameter "wdiff".

Parameters:: id - ID of tab, which should be closed.; wdiff - X position of the "x" button seen from the right side.; y - The y coordinate for the click, default is empty to click in the middle.
Author:: QFS,mm
Since:: 2.1.0

[Summary] [qfs.qft] [qfs] [swing] [tabbedpane]

Procedure: 'getIndexOfTab'

Return the index of a given tab in a JTabbedPane.

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

[Summary] [qfs.qft] [qfs] [swing] [tabbedpane]

Procedure: 'getValueOfTab'

Return the text of a given tab in a JTabbedPane.

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

[Summary] [qfs.qft] [qfs] [swing] [tabbedpane]

Procedure: 'selectTab'

Select a tab in a given TabbedPane.

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

[Summary] [qfs.qft] [qfs] [swing]

Package: 'table'

Procedures to access tables. (Swing component javax.swing.JTable)

Author:: QFS,mm
Since:: 1.08.4

Procedure/Dependency

Description

clickCellWithDetails

Select a given cell.

getColumnCount

Return the number of columns of a given table.

getIndexOfColumn

Return the current index of a given column.

getNameOfColumn

Return the header text of a given column.

getRowCount

Return the number of rows of a given table.

getRowIndexOfCell

Return the row number of a given cell.

getValueOfCell

Return the text of a given cell.

resizeColumn

Resize width of a table column.

selectCell

Select a given cell.

[Summary] [qfs.qft] [qfs] [swing] [table]

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

[Summary] [qfs.qft] [qfs] [swing] [table]

Procedure: 'getColumnCount'

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

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

[Summary] [qfs.qft] [qfs] [swing] [table]

Procedure: 'getIndexOfColumn'

Return the current index of a given column.

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

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

[Summary] [qfs.qft] [qfs] [swing] [table]

Procedure: 'getNameOfColumn'

Return the header text of a given column.

Sample usage: Determine the title of the second column.

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

[Summary] [qfs.qft] [qfs] [swing] [table]

Procedure: 'getRowCount'

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

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

[Summary] [qfs.qft] [qfs] [swing] [table]

Procedure: 'getRowIndexOfCell'

Return the row number of a given cell.

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

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

[Summary] [qfs.qft] [qfs] [swing] [table]

Procedure: 'getValueOfCell'

Return the text of a given cell.

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

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

[Summary] [qfs.qft] [qfs] [swing] [table]

Procedure: 'resizeColumn'

Resize width of a table column.

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

[Summary] [qfs.qft] [qfs] [swing] [table]

Procedure: 'selectCell'

Select a given cell.

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

[Summary] [qfs.qft] [qfs] [swing] [table]

Package: 'checkbox'

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

Author:: QFS,mm
Since:: 3.0

Procedure/Dependency

Description

deselect

Deselect a checkbox in a table-cell.

deselectWithCoordinates

Deselect a checkbox in a table-cell.