ComponentFunctions (SAFS API DOCUMENT)

java.lang.Object
- org.safs.model.commands.ComponentFunctions

public class ComponentFunctions
extends java.lang.Object

Field Summary

Fields
Modifier and Type	Field and Description
`static CheckBoxFunctions`	`_CheckBoxFunctions` static reference to CheckBoxFunctions.class Actions for Checkbox objects
`static ComboBoxFunctions`	`_ComboBoxFunctions` static reference to ComboBoxFunctions.class Actions for working with ComboBox objects
`static ComboEditBoxFunctions`	`_ComboEditBoxFunctions` static reference to ComboEditBoxFunctions.class Actions for working with ComboEditBox objects
`static ComboListBoxFunctions`	`_ComboListBoxFunctions` static reference to ComboListBoxFunctions.class Actions for ComboListBox objects
`static DatabaseFunctions`	`_DatabaseFunctions` static reference to DatabaseFunctions.class Actions for working with Database tables.
`static DatePickerFunctions`	`_DatePickerFunctions` static reference to DatePickerFunctions.class Actions for working with Date Picker object
`static DotNetMenuFunctions`	`_DotNetMenuFunctions` static reference to DotNetMenuFunctions.class Actions for working with .NET Menu objects
`static DotNetTableFunctions`	`_DotNetTableFunctions` static reference to DotNetTableFunctions.class Actions for working with DotNetTable objects
`static DotNetTreeFunctions`	`_DotNetTreeFunctions` static reference to DotNetTreeFunctions.class Actions for working with .NET Tree objects
`static EditBoxFunctions`	`_EditBoxFunctions` static reference to EditBoxFunctions.class Actions for working with EditBox objects
`static FlexColorFunctions`	`_FlexColorFunctions` static reference to FlexColorFunctions.class Actions for working with Flex ColorPicker objects
`static FlexDateFunctions`	`_FlexDateFunctions` static reference to FlexDateFunctions.class Actions for working with Flex DateChooser or DateField objects
`static FlexNumericStepperFunctions`	`_FlexNumericStepperFunctions` static reference to FlexNumericStepperFunctions.class Actions for working with Flex NumericStepper objects
`static FlexSliderFunctions`	`_FlexSliderFunctions` static reference to FlexSliderFunctions.class Actions for working with Flex Slider objects
`static FPSpreadFunctions`	`_FPSpreadFunctions` static reference to FPSpreadFunctions.class Functions and Actions for FarPoint Spread objects.
`static GenericMasterFunctions`	`_GenericMasterFunctions` static reference to GenericMasterFunctions.class Generic actions available for ALL types of Windows and Components.
`static GenericObjectFunctions`	`_GenericObjectFunctions` static reference to GenericObjectFunctions.class Actions for working with GENERIC objects
`static GraphicControlFunctions`	`_GraphicControlFunctions` static reference to GraphicControlFunctions.class Actions for working with GraphicControl objects
`static HTMLDocumentFunctions`	`_HTMLDocumentFunctions` static reference to HTMLDocumentFunctions.class Actions for working with HTMLDocument objects
`static HTMLFunctions`	`_HTMLFunctions` static reference to HTMLFunctions.class Actions for working with HTML objects
`static HTMLImageFunctions`	`_HTMLImageFunctions` static reference to HTMLImageFunctions.class Actions for working with HTMLImage objects
`static HTMLLinkFunctions`	`_HTMLLinkFunctions` static reference to HTMLLinkFunctions.class Actions for working with HTMLLink objects
`static HTMLTableFunctions`	`_HTMLTableFunctions` static reference to HTMLTableFunctions.class Actions for working with HTMLTable objects NOTE: The RobotJ version has enabled ALL of the keywords available to the JavaTableFunctions.
`static JavaMenuFunctions`	`_JavaMenuFunctions` static reference to JavaMenuFunctions.class Actions for working with Java Swing JMenu objects
`static JavaTableFunctions`	`_JavaTableFunctions` static reference to JavaTableFunctions.class Actions for working with JavaTable objects
`static JavaTreeFunctions`	`_JavaTreeFunctions` static reference to JavaTreeFunctions.class Actions for working with Java Swing JTree objects
`static LabelFunctions`	`_LabelFunctions` static reference to LabelFunctions.class Actions for Label objects
`static ListBoxFunctions`	`_ListBoxFunctions` static reference to ListBoxFunctions.class Actions for working with ListBox objects
`static ListViewFunctions`	`_ListViewFunctions` static reference to ListViewFunctions.class Actions for working with ListView objects
`static PopupMenuFunctions`	`_PopupMenuFunctions` static reference to PopupMenuFunctions.class Actions for ACTIVE Popup Menus Actions for ACTIVE Popup Menus.
`static ProgressBarFunctions`	`_ProgressBarFunctions` static reference to ProgressBarFunctions.class Actions for working with Progress Bar object.
`static PushButtonFunctions`	`_PushButtonFunctions` static reference to PushButtonFunctions.class Actions for working with PushButton objects
`static RadioButtonFunctions`	`_RadioButtonFunctions` static reference to RadioButtonFunctions.class Actions for working with RadioButton objects
`static ScrollBarFunctions`	`_ScrollBarFunctions` static reference to ScrollBarFunctions.class Actions for working with ScrollBar objects
`static SSTreeFunctions`	`_SSTreeFunctions` static reference to SSTreeFunctions.class Actions for working with Sheridan Class=SSTree objects
`static TabControlFunctions`	`_TabControlFunctions` static reference to TabControlFunctions.class Actions for working with TabControl objects
`static TableViewFunctions`	`_TableViewFunctions` static reference to TableViewFunctions.class Actions for working with TableView objects
`static TIDRestFunctions`	`_TIDRestFunctions` static reference to TIDRestFunctions.class Actions for REST request such as GET, PUT, POST, DELETE etc.
`static TimePickerFunctions`	`_TimePickerFunctions` static reference to TimePickerFunctions.class Actions for working with Time Picker object
`static ToolBarFunctions`	`_ToolBarFunctions` static reference to ToolBarFunctions.class Actions for working with ToolBar objects.
`static TreeViewFunctions`	`_TreeViewFunctions` static reference to TreeViewFunctions.class Actions for working with TreeView objects RJ Implementation: For each command, the 5th parameter "TextValue" must be given as full path with separator "->".
`static VSFlexGridFunctions`	`_VSFlexGridFunctions` static reference to VSFlexGridFunctions.class Functions and Actions for VSFlexGrid objects.
`static WindowFunctions`	`_WindowFunctions` static reference to WindowFunctions.class Actions for working with Window objects

Method Summary
- Methods inherited from class java.lang.Object
  clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - _CheckBoxFunctions
```
public static CheckBoxFunctions _CheckBoxFunctions
```
    static reference to CheckBoxFunctions.class Actions for Checkbox objects
  - _ComboBoxFunctions
```
public static ComboBoxFunctions _ComboBoxFunctions
```
    static reference to ComboBoxFunctions.class Actions for working with ComboBox objects
  - _ComboEditBoxFunctions
```
public static ComboEditBoxFunctions _ComboEditBoxFunctions
```
    static reference to ComboEditBoxFunctions.class Actions for working with ComboEditBox objects
  - _ComboListBoxFunctions
```
public static ComboListBoxFunctions _ComboListBoxFunctions
```
    static reference to ComboListBoxFunctions.class Actions for ComboListBox objects
  - _DatabaseFunctions
```
public static DatabaseFunctions _DatabaseFunctions
```
    static reference to DatabaseFunctions.class Actions for working with Database tables.
  - _DatePickerFunctions
```
public static DatePickerFunctions _DatePickerFunctions
```
    static reference to DatePickerFunctions.class Actions for working with Date Picker object
  - _EditBoxFunctions
```
public static EditBoxFunctions _EditBoxFunctions
```
    static reference to EditBoxFunctions.class Actions for working with EditBox objects
  - _FPSpreadFunctions
```
public static FPSpreadFunctions _FPSpreadFunctions
```
    static reference to FPSpreadFunctions.class Functions and Actions for FarPoint Spread objects. This is not supported by Rational Robot out-of-the-box. You need a proxy from one of IBM's 3rd party partners for this to work. This proxy requires at least version 2003.06.15 of Robot.
  - _FlexColorFunctions
```
public static FlexColorFunctions _FlexColorFunctions
```
    static reference to FlexColorFunctions.class Actions for working with Flex ColorPicker objects
  - _FlexDateFunctions
```
public static FlexDateFunctions _FlexDateFunctions
```
    static reference to FlexDateFunctions.class Actions for working with Flex DateChooser or DateField objects
  - _FlexNumericStepperFunctions
```
public static FlexNumericStepperFunctions _FlexNumericStepperFunctions
```
    static reference to FlexNumericStepperFunctions.class Actions for working with Flex NumericStepper objects
  - _FlexSliderFunctions
```
public static FlexSliderFunctions _FlexSliderFunctions
```
    static reference to FlexSliderFunctions.class Actions for working with Flex Slider objects
  - _GenericMasterFunctions
```
public static GenericMasterFunctions _GenericMasterFunctions
```
    static reference to GenericMasterFunctions.class Generic actions available for ALL types of Windows and Components.
  - _GenericObjectFunctions
```
public static GenericObjectFunctions _GenericObjectFunctions
```
    static reference to GenericObjectFunctions.class Actions for working with GENERIC objects
  - _GraphicControlFunctions
```
public static GraphicControlFunctions _GraphicControlFunctions
```
    static reference to GraphicControlFunctions.class Actions for working with GraphicControl objects
  - _HTMLFunctions
```
public static HTMLFunctions _HTMLFunctions
```
    static reference to HTMLFunctions.class Actions for working with HTML objects
  - _HTMLDocumentFunctions
```
public static HTMLDocumentFunctions _HTMLDocumentFunctions
```
    static reference to HTMLDocumentFunctions.class Actions for working with HTMLDocument objects
  - _HTMLImageFunctions
```
public static HTMLImageFunctions _HTMLImageFunctions
```
    static reference to HTMLImageFunctions.class Actions for working with HTMLImage objects
  - _HTMLLinkFunctions
```
public static HTMLLinkFunctions _HTMLLinkFunctions
```
    static reference to HTMLLinkFunctions.class Actions for working with HTMLLink objects
  - _HTMLTableFunctions
```
public static HTMLTableFunctions _HTMLTableFunctions
```
    static reference to HTMLTableFunctions.class Actions for working with HTMLTable objects NOTE: The RobotJ version has enabled *ALL* of the keywords available to the JavaTableFunctions. See that documentation for a description of those keywords. The only differences are thus: The columns cannot be named, but must evaluate to a numerical value.
  - _JavaMenuFunctions
```
public static JavaMenuFunctions _JavaMenuFunctions
```
    static reference to JavaMenuFunctions.class Actions for working with Java Swing JMenu objects
  - _JavaTableFunctions
```
public static JavaTableFunctions _JavaTableFunctions
```
    static reference to JavaTableFunctions.class Actions for working with JavaTable objects
  - _JavaTreeFunctions
```
public static JavaTreeFunctions _JavaTreeFunctions
```
    static reference to JavaTreeFunctions.class Actions for working with Java Swing JTree objects
  - _DotNetTableFunctions
```
public static DotNetTableFunctions _DotNetTableFunctions
```
    static reference to DotNetTableFunctions.class Actions for working with DotNetTable objects
  - _DotNetMenuFunctions
```
public static DotNetMenuFunctions _DotNetMenuFunctions
```
    static reference to DotNetMenuFunctions.class Actions for working with .NET Menu objects
  - _DotNetTreeFunctions
```
public static DotNetTreeFunctions _DotNetTreeFunctions
```
    static reference to DotNetTreeFunctions.class Actions for working with .NET Tree objects
  - _LabelFunctions
```
public static LabelFunctions _LabelFunctions
```
    static reference to LabelFunctions.class Actions for Label objects
  - _ListBoxFunctions
```
public static ListBoxFunctions _ListBoxFunctions
```
    static reference to ListBoxFunctions.class Actions for working with ListBox objects
  - _ListViewFunctions
```
public static ListViewFunctions _ListViewFunctions
```
    static reference to ListViewFunctions.class Actions for working with ListView objects
  - _PopupMenuFunctions
```
public static PopupMenuFunctions _PopupMenuFunctions
```
    static reference to PopupMenuFunctions.class Actions for ACTIVE Popup Menus Actions for ACTIVE Popup Menus. The popup menu must usually already be up and active for each of these Actions. It is important to recognize certain issues with Popup menus, especially as we need to differentiate between Java popups and Win32 popups. Win32 popup menus are generally found as the topmost active popup window. Because of this, we generally can just look for the topmost active popup window and we don't need any type of recognition information to locate it. Java popup menus are generally NOT implemented as normal Win32 popup menus and we generally DO need to have window and component recognition information for Java popup menus. For RC and Win32 popups: Unless otherwise indicated, the Window and Component references are not used and can be anything. They just cannot be blank. For Java popups: Unless otherwise indicated, valid recognition information for the Java window and "child" popup menu must be provided. Also refer to JavaMenuFunctions for support specific to Java menus and popup menus.
  - _ProgressBarFunctions
```
public static ProgressBarFunctions _ProgressBarFunctions
```
    static reference to ProgressBarFunctions.class Actions for working with Progress Bar object. For Android progress bar, there are two modes indeterminate and determinate. In indeterminate mode, the progress is ignored and the progress bar shows an infinite animation instead. In this case, the keyword SetProgress will not work and GetProgress will return 0. These 2 keywords only work for progress bar in determinate mode. Note:Keyword SetRating and GetRating will ONLY work for RatingBar object. RatingBar is a subclass of ProgressBar, so SetProgress and GetProgress can work for it.
  - _PushButtonFunctions
```
public static PushButtonFunctions _PushButtonFunctions
```
    static reference to PushButtonFunctions.class Actions for working with PushButton objects
  - _RadioButtonFunctions
```
public static RadioButtonFunctions _RadioButtonFunctions
```
    static reference to RadioButtonFunctions.class Actions for working with RadioButton objects
  - _ScrollBarFunctions
```
public static ScrollBarFunctions _ScrollBarFunctions
```
    static reference to ScrollBarFunctions.class Actions for working with ScrollBar objects
  - _SSTreeFunctions
```
public static SSTreeFunctions _SSTreeFunctions
```
    static reference to SSTreeFunctions.class Actions for working with Sheridan Class=SSTree objects
  - _TabControlFunctions
```
public static TabControlFunctions _TabControlFunctions
```
    static reference to TabControlFunctions.class Actions for working with TabControl objects
  - _TableViewFunctions
```
public static TableViewFunctions _TableViewFunctions
```
    static reference to TableViewFunctions.class Actions for working with TableView objects
  - _ToolBarFunctions
```
public static ToolBarFunctions _ToolBarFunctions
```
    static reference to ToolBarFunctions.class Actions for working with ToolBar objects. Toolbars come in many different flavors. The toolbar support defined here is not going to work for all toolbars in all different environments. The tester will have to experiment using these commands against their specific toolbar.
  - _TIDRestFunctions
```
public static TIDRestFunctions _TIDRestFunctions
```
    static reference to TIDRestFunctions.class Actions for REST request such as GET, PUT, POST, DELETE etc. This keyword library provides REST Actions that can be used by all three DDE Drivers--CycleDriver, SuiteDriver, and StepDriver. That means they can be used in any keyword driven test tables regardless of the test tables level--Cycle, Suite, or Step. Each different action has different parameters as described in its documentation. For reference, the first fields of ALL REST Action test records are defined below: First Fields Description Field #1 The "T" = Component Action record type specifier. Field #2 The "SAFSREST" = Flag for REST action. It can be a literal string "SAFSREST" a map item of any name given by user, but the value MUST be "SAFSREST", such as --------- Map file example ------- [RestServiceTest] RestServiceTest=SAFSREST ----------------------------------- Field #3 The "SessionIDItem" = The map item storing the Session ID. How to define SessionIDItem The variable "SessionIDItem" can be defined in the map file under section [ApplicationConstant] or section specified by Field #2, examples as below: --------- Map file example ------- #T, SAFSREST, SessionIDItem, RestAction #For above test record, SessionIDItem can be defined under section "SAFSREST" [SAFSREST] SessionIDItem=UserAssignedSessionID #Or SessionIDItem can be defined under section "ApplicationConstant" [ApplicationConstant] SessionIDItem=UserAssignedSessionID #T, RestServiceTest, SessionIDItem, RestAction #For above test record, SessionIDItem is defined under section "RestServiceTest" [RestServiceTest] RestServiceTest=SAFSREST SessionIDItem=UserAssignedSessionID #Or SessionIDItem can be defined under section "ApplicationConstant" [ApplicationConstant] SessionIDItem=UserAssignedSessionID ----------------------------------- Notes of SessionIDItem This ID is assigned by user, who needs to guarantee it is unique. If the SessionIDItem is provided, the keyword RestStartServiceSession SHOULD be executed before executing each other action keyword, which will be handled within a session, within which: 1. The base URL is stored, and it will be prepended to a relative URI to form a full REST service URL. 2. The authentication information is also stored for later rest action execution. Otherwise (no SessionIDItem is provided), it will be considered as a one-shot connection, and NO RestStartServiceSession needs to be called and user may need to provide authentication information. The parameter relativeURI should be provided with a full-path URL Field #4 The REST Action keyword. Authentication/Authorization settings Some REST service needs Authentication/Authorization before requesting. It can be globally set via .ini configuration file or VM parameter as below: .ini configuration file #The auth-config file should be assigned to key AUTH under section SAFS_REST [SAFS_REST] AUTH=config\auth2.xml VM parameter #The auth-config file should be assigned to parameter safs.rest.auth java -Dsafs.rest.auth=config\auth2.xml aTest It can also be set via keyword parameter as below: T, SAFSREST, sessionIDItem, RestGetXML, relativeURI, responseIDVar [, body] [, headers] , config\auth2.xml Auth setting via keyword parameter will only take effect during this keyword execution, and it will override the global auth setting. Examples: T, SAFSREST, sessionIDItem, RestStartServiceSession, baseURL [, authentication] T, SAFSREST, sessionIDItem, RestGetXML, relativeURI, responseIDVar [, body] [, headers] [, authentication] T, SAFSREST, sessionIDItem, RestEndServiceSession Note: REST Action parameters must be placed in the test record in the field position specified in the documentation. Some parameters are optional. However, the field associated with that parameter must be honored. If you wish to skip an optional parameter you must still provide an empty field for that parameter.
  - _TimePickerFunctions
```
public static TimePickerFunctions _TimePickerFunctions
```
    static reference to TimePickerFunctions.class Actions for working with Time Picker object
  - _TreeViewFunctions
```
public static TreeViewFunctions _TreeViewFunctions
```
    static reference to TreeViewFunctions.class Actions for working with TreeView objects RJ Implementation: For each command, the 5th parameter "TextValue" must be given as full path with separator "->". Example: "Parent->Child"
  - _VSFlexGridFunctions
```
public static VSFlexGridFunctions _VSFlexGridFunctions
```
    static reference to VSFlexGridFunctions.class Functions and Actions for VSFlexGrid objects. This serves as an example of a new core library servicing a custom component.
  - _WindowFunctions
```
public static WindowFunctions _WindowFunctions
```
    static reference to WindowFunctions.class Actions for working with Window objects

Class ComponentFunctions

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

_CheckBoxFunctions

_ComboBoxFunctions

_ComboEditBoxFunctions

_ComboListBoxFunctions

_DatabaseFunctions

_DatePickerFunctions

_EditBoxFunctions

_FPSpreadFunctions

_FlexColorFunctions

_FlexDateFunctions

_FlexNumericStepperFunctions

_FlexSliderFunctions

_GenericMasterFunctions

_GenericObjectFunctions

_GraphicControlFunctions

_HTMLFunctions

_HTMLDocumentFunctions

_HTMLImageFunctions

_HTMLLinkFunctions

_HTMLTableFunctions

_JavaMenuFunctions

_JavaTableFunctions

_JavaTreeFunctions

_DotNetTableFunctions

_DotNetMenuFunctions

_DotNetTreeFunctions

_LabelFunctions

_ListBoxFunctions

_ListViewFunctions

_PopupMenuFunctions

_ProgressBarFunctions

_PushButtonFunctions

_RadioButtonFunctions

_ScrollBarFunctions

_SSTreeFunctions

_TabControlFunctions

_TableViewFunctions

_ToolBarFunctions

_TIDRestFunctions

_TimePickerFunctions

_TreeViewFunctions

_VSFlexGridFunctions

_WindowFunctions