org.safs

Class SAFSPlus.ComboBox

java.lang.Object

org.safs.SAFSPlus.Component

org.safs.SAFSPlus.ComboBox

Direct Known Subclasses:

SeleniumPlus.ComboBox

Enclosing class:

SAFSPlus

public static class SAFSPlus.ComboBox
extends SAFSPlus.Component

Wrapper class providing APIs to handle ComboBox keywords, like Select, ShowList, SetTextValue etc.

Constructor Summary

Constructors

Constructor and Description
ComboBox()

Method Summary

Modifier and Type	Method and Description
static boolean	CaptureItemsToFile(Component combobox, java.lang.String filename, java.lang.String... params) Capture all items in Combo Box to a file.
static boolean	HideList(Component combobox) Hide the combo box list.
static boolean	Select(Component combobox, java.lang.String itemtext, java.lang.String... extraParams) Select an item in Combo Box.
static boolean	SelectIndex(Component combobox, int index, java.lang.String... extraParams) Select an item in Combo Box by index.
static boolean	SelectPartialMatch(Component combobox, java.lang.String itemtext, java.lang.String... extraParams) Select a text item in Combo Box using a partial substring match.
static boolean	SelectUnverified(Component combobox, java.lang.String itemtext, java.lang.String... extraParams) Select an item in Combo Box without verification of the selected item.
static boolean	SelectUnverifiedPartialMatch(Component combobox, java.lang.String itemtext, java.lang.String... extraParams) Select an item in Combo Box using a partial substring match, no verification of the 'selected item' will be attempted.
static boolean	SetTextValue(Component combobox, java.lang.String value) Set text value in Combo box.
static boolean	ShowList(Component combobox) Show the combo box list.
static boolean	VerifySelected(Component combobox, java.lang.String item) Verify specific item in Combo Box is selected.

Methods inherited from class org.safs.SAFSPlus.Component

AltLeftDrag, AssignPropertyVariable, CaptureObjectDataToFile, CapturePropertiesToFile, CapturePropertyToFile, ClearCache, Click, CtrlAltLeftDrag, CtrlClick, CtrlLeftDrag, CtrlRightClick, CtrlShiftLeftDrag, DoubleClick, DragTo, ExecuteScript, GetComputedStyle, GetGUIImage, GetTextFromGUI, GUIDoesExist, GUIDoesNotExist, HoverMouse, HoverScreenLocation, InputCharacters, InputKeys, IsPropertyExist, IsPropertyExist, LeftDrag, LocateScreenImage, RightClick, RightDrag, SaveTextFromGUI, ShiftClick, ShiftLeftDrag, ShowOnPage, TypeChars, TypeEncryption, TypeKeys, VerifyBinaryFileToFile, VerifyComputedStyle, VerifyFileToFile, VerifyGUIImageToFile, VerifyObjectDataToFile, VerifyPropertiesSubsetToFile, VerifyPropertiesToFile, VerifyProperty, VerifyPropertyContains, VerifyPropertyContains, VerifyPropertyToFile, VerifyTextFileToFile, VerifyValueContains, VerifyValueContainsIgnoreCase, VerifyValueDoesNotContain, VerifyValues, VerifyValuesIgnoreCase, VerifyValuesNotEqual

Methods inherited from class java.lang.Object

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

Constructor Detail

ComboBox

public ComboBox()

Method Detail

Select

public static boolean Select(Component combobox,
                             java.lang.String itemtext,
                             java.lang.String... extraParams)

Select an item in Combo Box. Typically a verification that the item was selected is attempted.

See Detailed Reference

Parameters:

combobox - Component (from App Map) to Select item from.

itemtext - -- The combo box option to select.

extraParams - optional

extraParams[0] forceRefresh String, determine if force refreshing after selection. It is usually used when the 'id' of ComboBox is dynamic.
true, force refreshing
false, not force refreshing

Returns:

true if successful, false otherwise.

See Also:

SAFSPlus.prevResults, TestRecordData.getStatusCode(), TestRecordData.getStatusInfo()

Example:

 
 boolean success = ComboBox.Select(Map.Google.Combobox1, "ItemText");
 boolean success = ComboBox.Select(Map.Google.Combobox1, "ItemText", "true"); // force refreshing when dealing dynamic 'id' ComboBox
 
 

SelectUnverified

public static boolean SelectUnverified(Component combobox,
                                       java.lang.String itemtext,
                                       java.lang.String... extraParams)

Select an item in Combo Box without verification of the selected item.

See Detailed Reference

Parameters:

combobox - Component (from App Map) to Select item from.

itemtext - -- The combo box option to select.

extraParams - optional

extraParams[0] forceRefresh String, determine if force refreshing after selection. It is usually used when the 'id' of ComboBox is dynamic.
true, force refreshing
false, not force refreshing

Returns:

true if successful, false otherwise.

See Also:

SAFSPlus.prevResults, TestRecordData.getStatusCode(), TestRecordData.getStatusInfo()

Example:

 
 boolean success = ComboBox.SelectUnverified(Map.Google.Combobox1, "ItemText");
 boolean success = ComboBox.SelectUnverified(Map.Google.Combobox1, "ItemText", "true"); // force refreshing when dealing dynamic 'id' ComboBox
 
 

SelectPartialMatch

public static boolean SelectPartialMatch(Component combobox,
                                         java.lang.String itemtext,
                                         java.lang.String... extraParams)

Select a text item in Combo Box using a partial substring match.

See Detailed Reference

Parameters:

combobox - Component (from App Map) to Select item from.

itemtext - -- The combo box option to select, given as a substring of the option. Case Sensitive.

extraParams - optional

extraParams[0] forceRefresh String, determine if force refreshing after selection. It is usually used when the 'id' of ComboBox is dynamic.
true, force refreshing
false, not force refreshing

Returns:

true if successful, false otherwise.

See Also:

SAFSPlus.prevResults, TestRecordData.getStatusCode(), TestRecordData.getStatusInfo()

Example:

 
 boolean success = ComboBox.SelectPartialMatch(Map.Google.Combobox1, "substring");
 boolean success = ComboBox.SelectPartialMatch(Map.Google.Combobox1, "substring", "true"); // force refreshing when dealing dynamic 'id' ComboBox
 
 

SelectUnverifiedPartialMatch

public static boolean SelectUnverifiedPartialMatch(Component combobox,
                                                   java.lang.String itemtext,
                                                   java.lang.String... extraParams)

Select an item in Combo Box using a partial substring match, no verification of the 'selected item' will be attempted.

See Detailed Reference

Parameters:

combobox - Component (from App Map) to Select item from.

itemtext - -- The combo box option to select, given as a substring of the option. Case Sensitive.

extraParams - optional

extraParams[0] forceRefresh String, determine if force refreshing after selection. It is usually used when the 'id' of ComboBox is dynamic.
true, force refreshing
false, not force refreshing

Returns:

true if successful, false otherwise.

See Also:

SAFSPlus.prevResults, TestRecordData.getStatusCode(), TestRecordData.getStatusInfo()

Example:

 
 boolean success = ComboBox.SelectUnverifiedPartialMatch(Map.Google.Combobox1, "PartialItemText");
 boolean success = ComboBox.SelectUnverifiedPartialMatch(Map.Google.Combobox1, "PartialItemText", "true"); // force refreshing when dealing dynamic 'id' ComboBox
 
 

SelectIndex

public static boolean SelectIndex(Component combobox,
                                  int index,
                                  java.lang.String... extraParams)

Select an item in Combo Box by index.

See Detailed Reference

Parameters:

combobox - Component (from App Map) to Select item from.

index - -- the 1-based item index to select.

extraParams - optional

extraParams[0] forceRefresh String, determine if force refreshing after selection. It is usually used when the 'id' of ComboBox is dynamic.
true, force refreshing
false, not force refreshing

Returns:

true if successful, false otherwise.

See Also:

SAFSPlus.prevResults, TestRecordData.getStatusCode(), TestRecordData.getStatusInfo()

Example:

 
 boolean success = ComboBox.SelectIndex(Map.Google.Combobox1, 3);
 boolean success = ComboBox.SelectIndex(Map.Google.Combobox1, 3, "true"); // force refreshing when dealing dynamic 'id' ComboBox
 
 

VerifySelected

public static boolean VerifySelected(Component combobox,
                                     java.lang.String item)

Verify specific item in Combo Box is selected.

See Detailed Reference

Parameters:

combobox - Component (from App Map) to verify.

item - -- text item expected to be selected.

Returns:

true if successful, false otherwise.

See Also:

SAFSPlus.prevResults, TestRecordData.getStatusCode(), TestRecordData.getStatusInfo()

Example:

 
 boolean success = ComboBox.VerifySelected(Map.Google.Combobox1,"SelectItem");
 
 

HideList

public static boolean HideList(Component combobox)

Hide the combo box list.

See Detailed Reference

Parameters:

combobox - Component (from App Map).

Returns:

true if successful, false otherwise.

See Also:

SAFSPlus.prevResults, TestRecordData.getStatusCode(), TestRecordData.getStatusInfo()

Example:

 
 boolean success = ComboBox.HideList(Map.Google.Combobox1);
 
 

ShowList

public static boolean ShowList(Component combobox)

Show the combo box list.

See Detailed Reference

Parameters:

combobox - Component (from App Map).

Returns:

true if successful, false otherwise.

See Also:

SAFSPlus.prevResults, TestRecordData.getStatusCode(), TestRecordData.getStatusInfo()

Example:

 
 boolean success = ComboBox.ShowList(Map.Google.Combobox1);
 
 

CaptureItemsToFile

public static boolean CaptureItemsToFile(Component combobox,
                                         java.lang.String filename,
                                         java.lang.String... params)

Capture all items in Combo Box to a file.

See Detailed Reference

Parameters:

combobox - (from App Map) to get the content.

filename - String, The filename to save the combo box's data

params - optional

params[0] encoding String, The file encoding.

Returns:

true if successful, false otherwise.

See Also:

SAFSPlus.prevResults, TestRecordData.getStatusCode(), TestRecordData.getStatusInfo()

Example:

 
 boolean success = ComboBox.CaptureItemsToFile(Map.Google.Combobox1,"filename");
 boolean success = ComboBox.CaptureItemsToFile(Map.Google.Combobox1,"c:\\filename.txt","UTF-8");
 
 

 File will be created into Actuals project dir or user define location.
 

SetTextValue

public static boolean SetTextValue(Component combobox,
                                   java.lang.String value)

Set text value in Combo box.

See Detailed Reference

Parameters:

combobox - org.safs.model.Component, the Combo box Component get from App map file.

value - String, the value of content, which is entered into Combo box.

Returns:

true, if successful. false, otherwise.

See Also:

SAFSPlus.prevResults, TestRecordData.getStatusCode(), TestRecordData.getStatusInfo()

Example:

 
         boolean success = ComboBox.SetTextValue(Map.Google.Combobox1,"Some Text");
         boolean success = ComboBox.SetTextValue(Map.Google.Combobox1,"Some Text with special keys +(abcd)");