org.safs.model.commands

Class JavaTreeFunctions

java.lang.Object

org.safs.model.commands.JavaTreeFunctions

public class JavaTreeFunctions
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CAPTURETREEDATATOFILE_KEYWORD "CaptureTreeDataToFile"
static java.lang.String	CLICKTEXTNODE_KEYWORD "ClickTextNode"
static java.lang.String	CLICKUNVERIFIEDTEXTNODE_KEYWORD "ClickUnverifiedTextNode"
static java.lang.String	COLLAPSE_KEYWORD "Collapse"
static java.lang.String	COLLAPSEPARTIALTEXTNODE_KEYWORD "CollapsePartialTextNode"
static java.lang.String	COLLAPSETEXTNODE_KEYWORD "CollapseTextNode"
static java.lang.String	COLLAPSEUNVERIFIEDTEXTNODE_KEYWORD "CollapseUnverifiedTextNode"
static java.lang.String	CTRLCLICKUNVERIFIEDTEXTNODE_KEYWORD "CtrlClickUnverifiedTextNode"
static java.lang.String	DOUBLECLICKTEXTNODE_KEYWORD "DoubleClickTextNode"
static java.lang.String	DOUBLECLICKUNVERIFIEDTEXTNODE_KEYWORD "DoubleClickUnverifiedTextNode"
static java.lang.String	EXPAND_KEYWORD "Expand"
static java.lang.String	EXPANDPARTIALTEXTNODE_KEYWORD "ExpandPartialTextNode"
static java.lang.String	EXPANDTEXTNODE_KEYWORD "ExpandTextNode"
static java.lang.String	EXPANDUNVERIFIEDTEXTNODE_KEYWORD "ExpandUnverifiedTextNode"
static java.lang.String	MAKESELECTION_KEYWORD "MakeSelection"
static java.lang.String	PARTIALMATCHTREEDATATOFILE_KEYWORD "PartialMatchTreeDataToFile"
static java.lang.String	RIGHTCLICKTEXTNODE_KEYWORD "RightClickTextNode"
static java.lang.String	RIGHTCLICKUNVERIFIEDTEXTNODE_KEYWORD "RightClickUnverifiedTextNode"
static java.lang.String	SELECTANOTHERPARTIALTEXTNODE_KEYWORD "SelectAnotherPartialTextNode"
static java.lang.String	SELECTANOTHERTEXTNODE_KEYWORD "SelectAnotherTextNode"
static java.lang.String	SELECTANOTHERUNVERIFIEDTEXTNODE_KEYWORD "SelectAnotherUnverifiedTextNode"
static java.lang.String	SELECTPARTIALTEXTNODE_KEYWORD "SelectPartialTextNode"
static java.lang.String	SELECTTEXTNODE_KEYWORD "SelectTextNode"
static java.lang.String	SELECTUNVERIFIEDTEXTNODE_KEYWORD "SelectUnverifiedTextNode"
static java.lang.String	SETTREECONTAINSNODE_KEYWORD "SetTreeContainsNode"
static java.lang.String	SETTREECONTAINSPARTIALMATCH_KEYWORD "SetTreeContainsPartialMatch"
static java.lang.String	SHIFTCLICKUNVERIFIEDTEXTNODE_KEYWORD "ShiftClickUnverifiedTextNode"
static java.lang.String	VERIFYTREECONTAINSNODE_KEYWORD "VerifyTreeContainsNode"
static java.lang.String	VERIFYTREECONTAINSPARTIALMATCH_KEYWORD "VerifyTreeContainsPartialMatch"

Method Summary

Modifier and Type	Method and Description
static ComponentFunction	captureTreeDataToFile(java.lang.String winname, java.lang.String compname, java.lang.String[] parameters) Copy the current contents of a tree[branch] to a file.
static ComponentFunction	captureTreeDataToFile(java.lang.String winname, java.lang.String compname, java.lang.String file, java.lang.String branch, java.lang.String indentMark, java.lang.String fileEncoding, java.lang.String filterMode, java.lang.String filterOptions) Copy the current contents of a tree[branch] to a file.
static ComponentFunction	clickTextNode(java.lang.String winname, java.lang.String compname, java.lang.String textValue) Action to click a node according to its text value.
static ComponentFunction	clickUnverifiedTextNode(java.lang.String winname, java.lang.String compname, java.lang.String textValue) Action to blindly click a node according to its text value.
static ComponentFunction	collapse(java.lang.String winname, java.lang.String compname, java.lang.String textValue) Use CollapseTextNode instead.
static ComponentFunction	collapsePartialTextNode(java.lang.String winname, java.lang.String compname, java.lang.String textValue) Action to collapse a node according to a partial match of its text value.
static ComponentFunction	collapseTextNode(java.lang.String winname, java.lang.String compname, java.lang.String textValue) Action to collapse a node according to its text value.
static ComponentFunction	collapseUnverifiedTextNode(java.lang.String winname, java.lang.String compname, java.lang.String textValue) Action to blindly collapse a node according to its text value.
static ComponentFunction	ctrlClickUnverifiedTextNode(java.lang.String winname, java.lang.String compname, java.lang.String textValue) Action to blindly CTRL-click a node according to its text value.
static ComponentFunction	doubleClickTextNode(java.lang.String winname, java.lang.String compname, java.lang.String textValue) Action to double-click a node according to its text value.
static ComponentFunction	doubleClickUnverifiedTextNode(java.lang.String winname, java.lang.String compname, java.lang.String textValue) Action to blindly double-click a node according to its text value.
static ComponentFunction	expand(java.lang.String winname, java.lang.String compname, java.lang.String textValue) Use ExpandTextNode instead.
static ComponentFunction	expandPartialTextNode(java.lang.String winname, java.lang.String compname, java.lang.String textValue) Action to expand a node according to a partial match of text value.
static ComponentFunction	expandTextNode(java.lang.String winname, java.lang.String compname, java.lang.String textValue) Action to expand a node according to its text value.
static ComponentFunction	expandUnverifiedTextNode(java.lang.String winname, java.lang.String compname, java.lang.String textValue) Action to blindly expand a node according to its text value.
static JavaTreeFunctions	getInstance() public Singleton to access class static methods via instance
static ComponentFunction	makeSelection(java.lang.String winname, java.lang.String compname, java.lang.String textValue) Use SelectTextNode instead.
static ComponentFunction	partialMatchTreeDataToFile(java.lang.String winname, java.lang.String compname, java.lang.String[] parameters) Copy the current contents of a tree[branch] to a file according to a partial match of its text value.
static ComponentFunction	partialMatchTreeDataToFile(java.lang.String winname, java.lang.String compname, java.lang.String file, java.lang.String branch, java.lang.String indentMark, java.lang.String filterMode, java.lang.String filterOptions) Copy the current contents of a tree[branch] to a file according to a partial match of its text value.
static ComponentFunction	rightClickTextNode(java.lang.String winname, java.lang.String compname, java.lang.String textValue) Action to right-click a node according to its text value.
static ComponentFunction	rightClickUnverifiedTextNode(java.lang.String winname, java.lang.String compname, java.lang.String textValue) Action to blindly right-click a node according to its text value.
static ComponentFunction	selectAnotherPartialTextNode(java.lang.String winname, java.lang.String compname, java.lang.String textValue) Action to select a node according to a partial match of its text value, in addition to any nodes already selected.
static ComponentFunction	selectAnotherTextNode(java.lang.String winname, java.lang.String compname, java.lang.String textValue) Action to select a node according to its text value, in addition to any nodes already selected.
static ComponentFunction	selectAnotherUnverifiedTextNode(java.lang.String winname, java.lang.String compname, java.lang.String textValue) Action to blindly select a node according to its text value, in addition to any nodes already selected.
static ComponentFunction	selectPartialTextNode(java.lang.String winname, java.lang.String compname, java.lang.String textValue) Action to select a node according to a partial match of its text value.
static ComponentFunction	selectTextNode(java.lang.String winname, java.lang.String compname, java.lang.String textValue) Action to select a node according to its text value.
static ComponentFunction	selectUnverifiedTextNode(java.lang.String winname, java.lang.String compname, java.lang.String textValue) Action to blindly select a node according to its text value.
static ComponentFunction	setTreeContainsNode(java.lang.String winname, java.lang.String compname, java.lang.String[] parameters) Sets a user-defined variable with the result of whether a tree contains the provided node.
static ComponentFunction	setTreeContainsNode(java.lang.String winname, java.lang.String compname, java.lang.String node, java.lang.String resultVar) Sets a user-defined variable with the result of whether a tree contains the provided node.
static ComponentFunction	setTreeContainsPartialMatch(java.lang.String winname, java.lang.String compname, java.lang.String[] parameters) Sets a user-defined variable with the result of whether a tree contains the provided node according to a partial match of the node's text value.
static ComponentFunction	setTreeContainsPartialMatch(java.lang.String winname, java.lang.String compname, java.lang.String node, java.lang.String resultVar) Sets a user-defined variable with the result of whether a tree contains the provided node according to a partial match of the node's text value.
static ComponentFunction	shiftClickUnverifiedTextNode(java.lang.String winname, java.lang.String compname, java.lang.String textValue) Action to blindly SHIFT-click a node according to its text value.
static ComponentFunction	verifyTreeContainsNode(java.lang.String winname, java.lang.String compname, java.lang.String node) Verify that a tree contains the provided node.
static ComponentFunction	verifyTreeContainsPartialMatch(java.lang.String winname, java.lang.String compname, java.lang.String node) Verify that a tree contains the provided node according to a partial match of the node's text value.

Methods inherited from class java.lang.Object

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

Field Detail

CAPTURETREEDATATOFILE_KEYWORD

public static final java.lang.String CAPTURETREEDATATOFILE_KEYWORD

"CaptureTreeDataToFile"

See Also:

Constant Field Values

CLICKTEXTNODE_KEYWORD

public static final java.lang.String CLICKTEXTNODE_KEYWORD

"ClickTextNode"

See Also:

Constant Field Values

CLICKUNVERIFIEDTEXTNODE_KEYWORD

public static final java.lang.String CLICKUNVERIFIEDTEXTNODE_KEYWORD

"ClickUnverifiedTextNode"

See Also:

Constant Field Values

COLLAPSE_KEYWORD

public static final java.lang.String COLLAPSE_KEYWORD

"Collapse"

See Also:

Constant Field Values

COLLAPSEPARTIALTEXTNODE_KEYWORD

public static final java.lang.String COLLAPSEPARTIALTEXTNODE_KEYWORD

"CollapsePartialTextNode"

See Also:

Constant Field Values

COLLAPSETEXTNODE_KEYWORD

public static final java.lang.String COLLAPSETEXTNODE_KEYWORD

"CollapseTextNode"

See Also:

Constant Field Values

COLLAPSEUNVERIFIEDTEXTNODE_KEYWORD

public static final java.lang.String COLLAPSEUNVERIFIEDTEXTNODE_KEYWORD

"CollapseUnverifiedTextNode"

See Also:

Constant Field Values

CTRLCLICKUNVERIFIEDTEXTNODE_KEYWORD

public static final java.lang.String CTRLCLICKUNVERIFIEDTEXTNODE_KEYWORD

"CtrlClickUnverifiedTextNode"

See Also:

Constant Field Values

DOUBLECLICKTEXTNODE_KEYWORD

public static final java.lang.String DOUBLECLICKTEXTNODE_KEYWORD

"DoubleClickTextNode"

See Also:

Constant Field Values

DOUBLECLICKUNVERIFIEDTEXTNODE_KEYWORD

public static final java.lang.String DOUBLECLICKUNVERIFIEDTEXTNODE_KEYWORD

"DoubleClickUnverifiedTextNode"

See Also:

Constant Field Values

EXPAND_KEYWORD

public static final java.lang.String EXPAND_KEYWORD

"Expand"

See Also:

Constant Field Values

EXPANDPARTIALTEXTNODE_KEYWORD

public static final java.lang.String EXPANDPARTIALTEXTNODE_KEYWORD

"ExpandPartialTextNode"

See Also:

Constant Field Values

EXPANDTEXTNODE_KEYWORD

public static final java.lang.String EXPANDTEXTNODE_KEYWORD

"ExpandTextNode"

See Also:

Constant Field Values

EXPANDUNVERIFIEDTEXTNODE_KEYWORD

public static final java.lang.String EXPANDUNVERIFIEDTEXTNODE_KEYWORD

"ExpandUnverifiedTextNode"

See Also:

Constant Field Values

MAKESELECTION_KEYWORD

public static final java.lang.String MAKESELECTION_KEYWORD

"MakeSelection"

See Also:

Constant Field Values

PARTIALMATCHTREEDATATOFILE_KEYWORD

public static final java.lang.String PARTIALMATCHTREEDATATOFILE_KEYWORD

"PartialMatchTreeDataToFile"

See Also:

Constant Field Values

RIGHTCLICKTEXTNODE_KEYWORD

public static final java.lang.String RIGHTCLICKTEXTNODE_KEYWORD

"RightClickTextNode"

See Also:

Constant Field Values

RIGHTCLICKUNVERIFIEDTEXTNODE_KEYWORD

public static final java.lang.String RIGHTCLICKUNVERIFIEDTEXTNODE_KEYWORD

"RightClickUnverifiedTextNode"

See Also:

Constant Field Values

SELECTANOTHERPARTIALTEXTNODE_KEYWORD

public static final java.lang.String SELECTANOTHERPARTIALTEXTNODE_KEYWORD

"SelectAnotherPartialTextNode"

See Also:

Constant Field Values

SELECTANOTHERTEXTNODE_KEYWORD

public static final java.lang.String SELECTANOTHERTEXTNODE_KEYWORD

"SelectAnotherTextNode"

See Also:

Constant Field Values

SELECTANOTHERUNVERIFIEDTEXTNODE_KEYWORD

public static final java.lang.String SELECTANOTHERUNVERIFIEDTEXTNODE_KEYWORD

"SelectAnotherUnverifiedTextNode"

See Also:

Constant Field Values

SELECTPARTIALTEXTNODE_KEYWORD

public static final java.lang.String SELECTPARTIALTEXTNODE_KEYWORD

"SelectPartialTextNode"

See Also:

Constant Field Values

SELECTTEXTNODE_KEYWORD

public static final java.lang.String SELECTTEXTNODE_KEYWORD

"SelectTextNode"

See Also:

Constant Field Values

SELECTUNVERIFIEDTEXTNODE_KEYWORD

public static final java.lang.String SELECTUNVERIFIEDTEXTNODE_KEYWORD

"SelectUnverifiedTextNode"

See Also:

Constant Field Values

SETTREECONTAINSNODE_KEYWORD

public static final java.lang.String SETTREECONTAINSNODE_KEYWORD

"SetTreeContainsNode"

See Also:

Constant Field Values

SETTREECONTAINSPARTIALMATCH_KEYWORD

public static final java.lang.String SETTREECONTAINSPARTIALMATCH_KEYWORD

"SetTreeContainsPartialMatch"

See Also:

Constant Field Values

SHIFTCLICKUNVERIFIEDTEXTNODE_KEYWORD

public static final java.lang.String SHIFTCLICKUNVERIFIEDTEXTNODE_KEYWORD

"ShiftClickUnverifiedTextNode"

See Also:

Constant Field Values

VERIFYTREECONTAINSNODE_KEYWORD

public static final java.lang.String VERIFYTREECONTAINSNODE_KEYWORD

"VerifyTreeContainsNode"

See Also:

Constant Field Values

VERIFYTREECONTAINSPARTIALMATCH_KEYWORD

public static final java.lang.String VERIFYTREECONTAINSPARTIALMATCH_KEYWORD

"VerifyTreeContainsPartialMatch"

See Also:

Constant Field Values

Method Detail

getInstance

public static JavaTreeFunctions getInstance()

public Singleton to access class static methods via instance

captureTreeDataToFile

public static ComponentFunction captureTreeDataToFile(java.lang.String winname,
                                                      java.lang.String compname,
                                                      java.lang.String file,
                                                      java.lang.String branch,
                                                      java.lang.String indentMark,
                                                      java.lang.String fileEncoding,
                                                      java.lang.String filterMode,
                                                      java.lang.String filterOptions)

             Copy the current contents of a tree[branch] to a file.
             
             The search of the path to the node is expected to be a case-sensitive 
             exact match of each node.  Use 'PartialMatchTreeDataToFile' if you 
             wish to specify case-insensitive substring matches for tree nodes.             
             
             By default, the files will be
             stored in the active "Test" directory.  If you specify a
             relative path, the path will be relative to the project
             directory.  The directory for a full or relative path 
             must already exist.
                  

Supporting Engines:

• Rational Robot
• Rational RobotJ

Parameters:

winname - Optional:NO The name of the window to act upon.

compname - Optional:NO The name of the component to act upon.

file - Optional:NO The name of the file used to store the tree data.

branch - Optional:YES The full name of the tree branch to capture.

indentMark - Optional:YES The character(s) to use in the output file to indent the tree nodes from the parent tree branches.

fileEncoding - Optional:YES DefaultVal: Specify a character encoding to be used when saving data to a file. If it is not specified, the system default file encoding will be used. The encoding should be a valid string supported by Java; if it is not valid, the system default file encoding will be used instead.

filterMode - Optional:YES DefaultVal: (Future) Specify a file filter to use to process the text before comparison.

filterOptions - Optional:YES DefaultVal: (Future) Specify filter options to use with the file filter.

captureTreeDataToFile

public static ComponentFunction captureTreeDataToFile(java.lang.String winname,
                                                      java.lang.String compname,
                                                      java.lang.String[] parameters)

             Copy the current contents of a tree[branch] to a file.
             
             The search of the path to the node is expected to be a case-sensitive 
             exact match of each node.  Use 'PartialMatchTreeDataToFile' if you 
             wish to specify case-insensitive substring matches for tree nodes.             
             
             By default, the files will be
             stored in the active "Test" directory.  If you specify a
             relative path, the path will be relative to the project
             directory.  The directory for a full or relative path 
             must already exist.
                  

Supporting Engines:

• Rational Robot
• Rational RobotJ

Parameters:

winname - Optional:NO The name of the window to act upon.

compname - Optional:NO The name of the component to act upon.

parameters - Optional:NO An array containing the following parameters:

file -- Optional:NO The name of the file used to store the tree data.
branch -- Optional:YES The full name of the tree branch to capture.
indentMark -- Optional:YES The character(s) to use in the output file to indent the tree nodes from the parent tree branches.
fileEncoding -- Optional:YES DefaultVal: Specify a character encoding to be used when saving data to a file. If it is not specified, the system default file encoding will be used. The encoding should be a valid string supported by Java; if it is not valid, the system default file encoding will be used instead.
filterMode -- Optional:YES DefaultVal: (Future) Specify a file filter to use to process the text before comparison.
filterOptions -- Optional:YES DefaultVal: (Future) Specify filter options to use with the file filter.

clickTextNode

public static ComponentFunction clickTextNode(java.lang.String winname,
                                              java.lang.String compname,
                                              java.lang.String textValue)

 
                 Action to click a node according to its text value.  Currently, this component function 
                 is for JavaTrees and works differently than documented in TreeViewFunctions (though that 
                 functionality may be added in the near future).
                  

Supporting Engines:

• Rational Robot
• Rational RobotJ

Parameters:

winname - Optional:NO The name of the window to act upon.

compname - Optional:NO The name of the component to act upon.

textValue - Optional:NO Case-sensitive text of node to click.

clickUnverifiedTextNode

public static ComponentFunction clickUnverifiedTextNode(java.lang.String winname,
                                                        java.lang.String compname,
                                                        java.lang.String textValue)

 
                 Action to blindly click a node according to its text value.  Currently, this component function 
                 is for JavaTrees and may work differently than documented in TreeViewFunctions.
                  

Supporting Engines:

• Rational Robot
• Rational RobotJ

Parameters:

winname - Optional:NO The name of the window to act upon.

compname - Optional:NO The name of the component to act upon.

textValue - Optional:NO Case-sensitive full path text of node to click.

collapse

public static ComponentFunction collapse(java.lang.String winname,
                                         java.lang.String compname,
                                         java.lang.String textValue)

 
                 Use CollapseTextNode instead.
                  

Supporting Engines:

• Rational Robot
• Rational RobotJ

Parameters:

winname - Optional:NO The name of the window to act upon.

compname - Optional:NO The name of the component to act upon.

textValue - Optional:NO Case-sensitive text of node to collapse

collapsePartialTextNode

public static ComponentFunction collapsePartialTextNode(java.lang.String winname,
                                                        java.lang.String compname,
                                                        java.lang.String textValue)

 
                 Action to collapse a node according to a partial match of its text value.
                  

Supporting Engines:

• Rational Robot
• Rational RobotJ

Parameters:

winname - Optional:NO The name of the window to act upon.

compname - Optional:NO The name of the component to act upon.

textValue - Optional:NO Case-Insensitive text of node to collapse

collapseTextNode

public static ComponentFunction collapseTextNode(java.lang.String winname,
                                                 java.lang.String compname,
                                                 java.lang.String textValue)

 
                 Action to collapse a node according to its text value.
                  

Supporting Engines:

• Rational Robot
• Rational RobotJ

Parameters:

winname - Optional:NO The name of the window to act upon.

compname - Optional:NO The name of the component to act upon.

textValue - Optional:NO Case-sensitive text of node to collapse

collapseUnverifiedTextNode

public static ComponentFunction collapseUnverifiedTextNode(java.lang.String winname,
                                                           java.lang.String compname,
                                                           java.lang.String textValue)

 
                 Action to blindly collapse a node according to its text value.
              
                 Generally, no pre- or post- node checks are done. If the tree contains 
                 hidden root nodes the user must provide these.
                  

Supporting Engines:

• Rational Robot
• Rational RobotJ

Parameters:

winname - Optional:NO The name of the window to act upon.

compname - Optional:NO The name of the component to act upon.

textValue - Optional:NO Case-sensitive full path text of node to collapse

ctrlClickUnverifiedTextNode

public static ComponentFunction ctrlClickUnverifiedTextNode(java.lang.String winname,
                                                            java.lang.String compname,
                                                            java.lang.String textValue)

 
                 Action to blindly CTRL-click a node according to its text value.  Currently, this component function is for JavaTrees only.
                  

Supporting Engines:

• Rational RobotJ

Parameters:

winname - Optional:NO The name of the window to act upon.

compname - Optional:NO The name of the component to act upon.

textValue - Optional:NO Case-sensitive text of node to CTRL-click.

doubleClickTextNode

public static ComponentFunction doubleClickTextNode(java.lang.String winname,
                                                    java.lang.String compname,
                                                    java.lang.String textValue)

 
                 Action to double-click a node according to its text value.  Currently, this component function 
                 is for JavaTrees and works differently than documented in TreeViewFunctions (though that 
                 functionality may be added in the near future).
                  

Supporting Engines:

• Rational Robot
• Rational RobotJ

Parameters:

winname - Optional:NO The name of the window to act upon.

compname - Optional:NO The name of the component to act upon.

textValue - Optional:NO Case-sensitive text of node to double-click.

doubleClickUnverifiedTextNode

public static ComponentFunction doubleClickUnverifiedTextNode(java.lang.String winname,
                                                              java.lang.String compname,
                                                              java.lang.String textValue)

 
                 Action to blindly double-click a node according to its text value.  Currently, this component function 
                 is for JavaTrees and may work differently than documented in TreeViewFunctions.
                  

Supporting Engines:

• Rational Robot
• Rational RobotJ

Parameters:

winname - Optional:NO The name of the window to act upon.

compname - Optional:NO The name of the component to act upon.

textValue - Optional:NO Case-sensitive full path text of node to double-click.

expand

public static ComponentFunction expand(java.lang.String winname,
                                       java.lang.String compname,
                                       java.lang.String textValue)

 
                 Use ExpandTextNode instead.
                  

Supporting Engines:

• Rational Robot
• Rational RobotJ

Parameters:

winname - Optional:NO The name of the window to act upon.

compname - Optional:NO The name of the component to act upon.

textValue - Optional:NO Case-sensitive text of node to expand

expandPartialTextNode

public static ComponentFunction expandPartialTextNode(java.lang.String winname,
                                                      java.lang.String compname,
                                                      java.lang.String textValue)

 
                 Action to expand a node according to a partial match of text value.
                  

Supporting Engines:

• Rational Robot
• Rational RobotJ

Parameters:

winname - Optional:NO The name of the window to act upon.

compname - Optional:NO The name of the component to act upon.

textValue - Optional:NO Case-Insensitive text of node to match.

expandTextNode

public static ComponentFunction expandTextNode(java.lang.String winname,
                                               java.lang.String compname,
                                               java.lang.String textValue)

 
                 Action to expand a node according to its text value.
                  

Supporting Engines:

• Rational Robot
• Rational RobotJ

Parameters:

winname - Optional:NO The name of the window to act upon.

compname - Optional:NO The name of the component to act upon.

textValue - Optional:NO Case-sensitive text of node to expand

expandUnverifiedTextNode

public static ComponentFunction expandUnverifiedTextNode(java.lang.String winname,
                                                         java.lang.String compname,
                                                         java.lang.String textValue)

 
                 Action to blindly expand a node according to its text value.
              
                 Generally, no pre- or post- node checks are done. If the tree contains 
                 hidden root nodes the user must provide these.
                  

Supporting Engines:

• Rational Robot
• Rational RobotJ

Parameters:

winname - Optional:NO The name of the window to act upon.

compname - Optional:NO The name of the component to act upon.

textValue - Optional:NO Case-sensitive full path text of node to expand

makeSelection

public static ComponentFunction makeSelection(java.lang.String winname,
                                              java.lang.String compname,
                                              java.lang.String textValue)

 
                 Use SelectTextNode instead.
                  

Supporting Engines:

• Rational Robot
• Rational RobotJ

Parameters:

winname - Optional:NO The name of the window to act upon.

compname - Optional:NO The name of the component to act upon.

textValue - Optional:NO Case-sensitive text of node to select

partialMatchTreeDataToFile

public static ComponentFunction partialMatchTreeDataToFile(java.lang.String winname,
                                                           java.lang.String compname,
                                                           java.lang.String file,
                                                           java.lang.String branch,
                                                           java.lang.String indentMark,
                                                           java.lang.String filterMode,
                                                           java.lang.String filterOptions)

             Copy the current contents of a tree[branch] to a file according to a partial match of its text value.
             
             The search of the path to the node is a case-insensitive 
             substring match of each node.  Use 'CaptureTreeDataToFile' if you 
             wish to specify case-sensitive exact matches for tree nodes.             
             
             By default, the files will be
             stored in the active "Test" directory.  If you specify a
             relative path, the path will be relative to the project
             directory.  The directory for a full or relative path 
             must already exist.
                  

Supporting Engines:

• Rational Robot
• Rational RobotJ

Parameters:

winname - Optional:NO The name of the window to act upon.

compname - Optional:NO The name of the component to act upon.

file - Optional:NO The name of the file used to store the tree data.

branch - Optional:YES The full name of the tree branch to capture.

indentMark - Optional:YES The character(s) to use in the output file to indent the tree nodes from the parent tree branches.

filterMode - Optional:YES DefaultVal: (Future) Specify a file filter to use to process the text before comparison.

filterOptions - Optional:YES DefaultVal: (Future) Specify filter options to use with the file filter.

partialMatchTreeDataToFile

public static ComponentFunction partialMatchTreeDataToFile(java.lang.String winname,
                                                           java.lang.String compname,
                                                           java.lang.String[] parameters)

             Copy the current contents of a tree[branch] to a file according to a partial match of its text value.
             
             The search of the path to the node is a case-insensitive 
             substring match of each node.  Use 'CaptureTreeDataToFile' if you 
             wish to specify case-sensitive exact matches for tree nodes.             
             
             By default, the files will be
             stored in the active "Test" directory.  If you specify a
             relative path, the path will be relative to the project
             directory.  The directory for a full or relative path 
             must already exist.
                  

Supporting Engines:

• Rational Robot
• Rational RobotJ

Parameters:

winname - Optional:NO The name of the window to act upon.

compname - Optional:NO The name of the component to act upon.

parameters - Optional:NO An array containing the following parameters:

file -- Optional:NO The name of the file used to store the tree data.
branch -- Optional:YES The full name of the tree branch to capture.
indentMark -- Optional:YES The character(s) to use in the output file to indent the tree nodes from the parent tree branches.
filterMode -- Optional:YES DefaultVal: (Future) Specify a file filter to use to process the text before comparison.
filterOptions -- Optional:YES DefaultVal: (Future) Specify filter options to use with the file filter.

rightClickTextNode

public static ComponentFunction rightClickTextNode(java.lang.String winname,
                                                   java.lang.String compname,
                                                   java.lang.String textValue)

 
                 Action to right-click a node according to its text value.  Currently, this component function 
                 is for JavaTrees and works differently than documented in TreeViewFunctions (though that 
                 functionality may be added in the near future).
                  

Supporting Engines:

• Rational Robot
• Rational RobotJ

Parameters:

winname - Optional:NO The name of the window to act upon.

compname - Optional:NO The name of the component to act upon.

textValue - Optional:NO Case-sensitive text of node to right-click.

rightClickUnverifiedTextNode

public static ComponentFunction rightClickUnverifiedTextNode(java.lang.String winname,
                                                             java.lang.String compname,
                                                             java.lang.String textValue)

 
                 Action to blindly right-click a node according to its text value.  Currently, this component function 
                 is for JavaTrees and may work differently than documented in TreeViewFunctions.
                  

Supporting Engines:

• Rational Robot
• Rational RobotJ

Parameters:

winname - Optional:NO The name of the window to act upon.

compname - Optional:NO The name of the component to act upon.

textValue - Optional:NO Case-sensitive full path text of node to right-click.

selectAnotherPartialTextNode

public static ComponentFunction selectAnotherPartialTextNode(java.lang.String winname,
                                                             java.lang.String compname,
                                                             java.lang.String textValue)

 
                 Action to select a node according to a partial match of its text value, in addition to any nodes already selected.
                 Performs selection as if CTRL key were held down during selection.
                  

Supporting Engines:

• Rational Robot
• Rational RobotJ

Parameters:

winname - Optional:NO The name of the window to act upon.

compname - Optional:NO The name of the component to act upon.

textValue - Optional:NO Case-Insensitive text of node to select.

selectAnotherTextNode

public static ComponentFunction selectAnotherTextNode(java.lang.String winname,
                                                      java.lang.String compname,
                                                      java.lang.String textValue)

 
                 Action to select a node according to its text value, in addition to any nodes already selected.
                  

Supporting Engines:

• Rational Robot
• Rational RobotJ

Parameters:

winname - Optional:NO The name of the window to act upon.

compname - Optional:NO The name of the component to act upon.

textValue - Optional:NO Case-sensitive text of node to select.

selectAnotherUnverifiedTextNode

public static ComponentFunction selectAnotherUnverifiedTextNode(java.lang.String winname,
                                                                java.lang.String compname,
                                                                java.lang.String textValue)

 
                 Action to blindly select a node according to its text value, in addition to any nodes already selected.
              
                 Generally, no pre- or post- node checks are done. If the tree contains 
                 hidden root nodes the user must provide these.
                  

Supporting Engines:

• Rational Robot
• Rational RobotJ

Parameters:

winname - Optional:NO The name of the window to act upon.

compname - Optional:NO The name of the component to act upon.

textValue - Optional:NO Case-sensitive full path text of node to select.

selectPartialTextNode

public static ComponentFunction selectPartialTextNode(java.lang.String winname,
                                                      java.lang.String compname,
                                                      java.lang.String textValue)

 
                 Action to select a node according to a partial match of its text value.
                 Performs selection as if CTRL key were held down during selection.
                  

Supporting Engines:

• Rational Robot
• Rational RobotJ

Parameters:

winname - Optional:NO The name of the window to act upon.

compname - Optional:NO The name of the component to act upon.

textValue - Optional:NO Case-Insensitive text of node to select.

selectTextNode

public static ComponentFunction selectTextNode(java.lang.String winname,
                                               java.lang.String compname,
                                               java.lang.String textValue)

 
                 Action to select a node according to its text value.
                  

Supporting Engines:

• Rational Robot
• Rational RobotJ

Parameters:

winname - Optional:NO The name of the window to act upon.

compname - Optional:NO The name of the component to act upon.

textValue - Optional:NO Case-sensitive text of node to select.

selectUnverifiedTextNode

public static ComponentFunction selectUnverifiedTextNode(java.lang.String winname,
                                                         java.lang.String compname,
                                                         java.lang.String textValue)

 
                 Action to blindly select a node according to its text value.
              
                 Generally, no pre- or post- node checks are done. If the tree contains 
                 hidden root nodes the user must provide these.
                  

Supporting Engines:

• Rational Robot
• Rational RobotJ

Parameters:

winname - Optional:NO The name of the window to act upon.

compname - Optional:NO The name of the component to act upon.

textValue - Optional:NO Case-sensitive full path text of node to select.

setTreeContainsNode

public static ComponentFunction setTreeContainsNode(java.lang.String winname,
                                                    java.lang.String compname,
                                                    java.lang.String node,
                                                    java.lang.String resultVar)

                        Sets a user-defined variable with the result of whether a tree contains the provided node.
                
                        The search of the path to the node is expected to be a case-sensitive 
                        exact match of each node.  Use 'SetTreeContainsPartialMatch' if you 
                        wish to specify case-insensitive substring matches for tree nodes.
                    

Supporting Engines:

• Rational Robot
• Rational RobotJ

Parameters:

winname - Optional:NO The name of the window to act upon.

compname - Optional:NO The name of the component to act upon.

node - Optional:NO The name of the node to verify.

resultVar - Optional:NO The name of the variable which gets assigned the result.

setTreeContainsNode

public static ComponentFunction setTreeContainsNode(java.lang.String winname,
                                                    java.lang.String compname,
                                                    java.lang.String[] parameters)

                        Sets a user-defined variable with the result of whether a tree contains the provided node.
                
                        The search of the path to the node is expected to be a case-sensitive 
                        exact match of each node.  Use 'SetTreeContainsPartialMatch' if you 
                        wish to specify case-insensitive substring matches for tree nodes.
                    

Supporting Engines:

• Rational Robot
• Rational RobotJ

Parameters:

winname - Optional:NO The name of the window to act upon.

compname - Optional:NO The name of the component to act upon.

parameters - Optional:NO An array containing the following parameters:

node -- Optional:NO The name of the node to verify.
resultVar -- Optional:NO The name of the variable which gets assigned the result.

setTreeContainsPartialMatch

public static ComponentFunction setTreeContainsPartialMatch(java.lang.String winname,
                                                            java.lang.String compname,
                                                            java.lang.String node,
                                                            java.lang.String resultVar)

                        Sets a user-defined variable with the result of whether a tree contains the provided node
                        according to a partial match of the node's text value.
                
                        The search of the path to the node is expected to be a case-insensitive 
                        substring match of each node.  Use 'SetTreeContainsNode' if you 
                        wish to specify case-sensitive substring matches for tree nodes.
                    

Supporting Engines:

• Rational Robot
• Rational RobotJ

Parameters:

winname - Optional:NO The name of the window to act upon.

compname - Optional:NO The name of the component to act upon.

node - Optional:NO The name of the node to verify.

resultVar - Optional:NO The name of the variable which gets assigned the result.

setTreeContainsPartialMatch

public static ComponentFunction setTreeContainsPartialMatch(java.lang.String winname,
                                                            java.lang.String compname,
                                                            java.lang.String[] parameters)

                        Sets a user-defined variable with the result of whether a tree contains the provided node
                        according to a partial match of the node's text value.
                
                        The search of the path to the node is expected to be a case-insensitive 
                        substring match of each node.  Use 'SetTreeContainsNode' if you 
                        wish to specify case-sensitive substring matches for tree nodes.
                    

Supporting Engines:

• Rational Robot
• Rational RobotJ

Parameters:

winname - Optional:NO The name of the window to act upon.

compname - Optional:NO The name of the component to act upon.

parameters - Optional:NO An array containing the following parameters:

node -- Optional:NO The name of the node to verify.
resultVar -- Optional:NO The name of the variable which gets assigned the result.

shiftClickUnverifiedTextNode

public static ComponentFunction shiftClickUnverifiedTextNode(java.lang.String winname,
                                                             java.lang.String compname,
                                                             java.lang.String textValue)

 
                 Action to blindly SHIFT-click a node according to its text value. Currently, this component function is for JavaTrees only.
                  

Supporting Engines:

• Rational RobotJ

Parameters:

winname - Optional:NO The name of the window to act upon.

compname - Optional:NO The name of the component to act upon.

textValue - Optional:NO Case-sensitive text of node to SHIFT-click.

verifyTreeContainsNode

public static ComponentFunction verifyTreeContainsNode(java.lang.String winname,
                                                       java.lang.String compname,
                                                       java.lang.String node)

                        Verify that a tree contains the provided node.
                
                        The search of the path to the node is expected to be a case-sensitive 
                        exact match of each node.  Use 'VerifyTreeContainsPartialMatch' if you 
                        wish to specify case-insensitive substring matches for tree nodes.
                    

Supporting Engines:

• Rational Robot
• Rational RobotJ

Parameters:

winname - Optional:NO The name of the window to act upon.

compname - Optional:NO The name of the component to act upon.

node - Optional:NO The name of the node to verify.

verifyTreeContainsPartialMatch

public static ComponentFunction verifyTreeContainsPartialMatch(java.lang.String winname,
                                                               java.lang.String compname,
                                                               java.lang.String node)

                Verify that a tree contains the provided node according to a partial match of the node's text value.
                
                        The search of the path to the node is expected to be a case-insensitive 
                        substring match of each node.  Use 'VerifyTreeContainsNode' if you 
                        wish to specify case-sensitive substring matches for tree nodes.
                    

Supporting Engines:

• Rational Robot
• Rational RobotJ

Parameters:

winname - Optional:NO The name of the window to act upon.

compname - Optional:NO The name of the component to act upon.

node - Optional:NO The name of the node to verify.