Share this page
com.hp.lft.sdk.web
Interface ListBox
- All Superinterfaces:
- Clickable, EnabledProvider, LocationInfoProvider, SupportDragAndDrop, SupportsNativeObject, TestObject, TestObjectDescriber, VisibleProvider, WaitUntilVisibleProvider, WebElement, WebTestObject, WebTestObjectDescriber, WaitUntilEnabledProvider
public interface ListBox extends WebElement
A Web drop-down box or multiple selection list.
HTML example:
<select name="select">
<option value="value1"> Value 1</option>
<option value="value2" selected> Value 2</option>
<option value="value3> Value 3</option>
</select>
Method Summary
Modifier and Type Method and Description voiddeselect(int... itemIndices)Deselects items in the list based on the item indices.voiddeselect(ListItem... items)Deselects a list of items in the list box.voiddeselect(java.lang.String... items)Deselects items in the list based on the item names.voidextendSelect(int... itemIndices)Selects additional items from the multi-selection list, by index.voidextendSelect(ListItem... items)Selects additional items from the multi-selection list, by ListItem item.voidextendSelect(java.lang.String... items)Selects additional items from the multi-selection list, by name.java.lang.StringgetDefaultValue()Returns the initial text value, which is set when the object is reset.ListItemgetItem(java.lang.String text)Returns an item with the given text.java.util.List<ListItem>getItems()Returns all of the items in the list.java.util.List<ListItem>getSelectedItems()Returns a collection of all selected items.java.lang.StringgetType()Returns the attribute "type" of the HTML element.java.lang.StringgetValue()Returns this object's text value.intgetVisibleItemsCount()Returns the number of items that are displayed in the list box.booleanisMultiple()Indicates whether the user can select multiple items.voidselect(int... itemIndices)Selects items in the list based on the item indices.voidselect(ListItem... items)Selects a list of items in the list box.voidselect(java.lang.String... items)Selects items in the list based on the item names.Methods inherited from interface com.hp.lft.sdk.web.WebElement
doubleClick, doubleClick, fireEvent, getAccessibilityName, getCSSSelector, getRole, getXPath, hoverTap, hoverTap, longPress, longPress, pan, pan, pinch, pinch, swipe, swipe
Methods inherited from interface com.hp.lft.sdk.TestObject
exists, exists, findChildren, getDescription, getDisplayName, getParent, getSnapshot, getTextLocations, getTextLocations, getVisibleText, getVisibleText, highlight, highlightMatches, setDescription, setDisplayName, verifyImageExists, verifyImageExists, verifyImageMatch, verifyImageMatch, verifyImageMatch, verifyImageMatch, verifyImageMatch, verifyImageMatch, waitUntilExists, waitUntilExists
Methods inherited from interface com.hp.lft.sdk.web.WebTestObject
getAttribute, getAttributes, getClassName, getComputedStyle, getComputedStyles, getId, getInnerHTML, getInnerText, getName, getOuterHTML, getOuterText, getTagName, getTitle, isVisible
Methods inherited from interface com.hp.lft.sdk.LocationInfoProvider
getAbsoluteLocation, getLocation, getSize
Methods inherited from interface com.hp.lft.sdk.web.WebTestObjectDescriber
describe, describe
Methods inherited from interface com.hp.lft.sdk.TestObjectDescriber
describe
Methods inherited from interface com.hp.lft.sdk.SupportsNativeObject
getNativeObject
Methods inherited from interface com.hp.lft.sdk.SupportDragAndDrop
dragAndDropOn, dragAndDropOn
Methods inherited from interface com.hp.lft.sdk.WaitUntilEnabledProvider
waitUntilEnabled, waitUntilEnabled
Methods inherited from interface com.hp.lft.sdk.EnabledProvider
isEnabled
Method Detail
getValue
java.lang.String getValue() throws GeneralLeanFtExceptionReturns this object's text value.- Returns:
- this object's text value.
- Throws:
GeneralLeanFtException- if an error occurs during execution.
getDefaultValue
java.lang.String getDefaultValue() throws GeneralLeanFtExceptionReturns the initial text value, which is set when the object is reset.- Returns:
- the initial text value, which is set when the object is reset.
- Throws:
GeneralLeanFtException- if an error occurs during execution.
isMultiple
boolean isMultiple() throws GeneralLeanFtExceptionIndicates whether the user can select multiple items.- Returns:
- true, if the user can select multiple items.
- Throws:
GeneralLeanFtException- if an error occurs during execution.
getVisibleItemsCount
int getVisibleItemsCount() throws GeneralLeanFtExceptionReturns the number of items that are displayed in the list box.- Returns:
- the number of items that are displayed in the list box.
- Throws:
GeneralLeanFtException- if an error occurs during execution.
getItems
java.util.List<ListItem> getItems() throws GeneralLeanFtException
Returns all of the items in the list.- Returns:
- all of the items in the list.
- Throws:
GeneralLeanFtException- if an error occurs during execution.
getSelectedItems
java.util.List<ListItem> getSelectedItems() throws GeneralLeanFtException
Returns a collection of all selected items.- Returns:
- a collection of all selected items.
- Throws:
GeneralLeanFtException- if an error occurs during execution.
select
void select(ListItem... items) throws GeneralLeanFtException
Selects a list of items in the list box.- Parameters:
items- the items to select.- Throws:
GeneralLeanFtException- if an error occurs during execution.
select
void select(java.lang.String... items) throws GeneralLeanFtExceptionSelects items in the list based on the item names.- Parameters:
items- the names of the items to select.- Throws:
GeneralLeanFtException- if an error occurs during execution.
select
void select(int... itemIndices) throws GeneralLeanFtExceptionSelects items in the list based on the item indices.- Parameters:
itemIndices- the item indices to select.- Throws:
GeneralLeanFtException- if an error occurs during execution.
deselect
void deselect(ListItem... items) throws GeneralLeanFtException
Deselects a list of items in the list box.- Parameters:
items- the items to deselect.- Throws:
GeneralLeanFtException- if an error occurs during execution.
deselect
void deselect(java.lang.String... items) throws GeneralLeanFtExceptionDeselects items in the list based on the item names.- Parameters:
items- the names of the items to deselect.- Throws:
GeneralLeanFtException- if an error occurs during execution.
deselect
void deselect(int... itemIndices) throws GeneralLeanFtExceptionDeselects items in the list based on the item indices.- Parameters:
itemIndices- the indices of the items to deselect.- Throws:
GeneralLeanFtException- if an error occurs during execution.
extendSelect
void extendSelect(int... items) throws GeneralLeanFtException
Selects additional items from the multi-selection list, by index.- Parameters:
itemIndices- the indices of the items to add to the selection.- Throws:
GeneralLeanFtException- if an error occurs during execution.
extendSelect
void extendSelect(ListItem... items) throws GeneralLeanFtException
Selects additional items from the multi-selection list, by ListItem item.- Parameters:
items- the ListItem items to add to the selection.- Throws:
GeneralLeanFtException- if an error occurs during execution.
extendSelect
void extendSelect(java.lang.String... items) throws GeneralLeanFtException
Selects additional items from the multi-selection list, by name.- Parameters:
items- the names of the items to add to the selection.- Throws:
GeneralLeanFtException- if an error occurs during execution.
getItem
ListItem getItem(java.lang.String text)
Returns an item with the given text.- Parameters:
text- the text of this item.- Returns:
- an item with the given text.
getType
java.lang.String getType() throws GeneralLeanFtExceptionReturns the attribute "type" of the HTML element.- Returns:
- the attribute "type" of the HTML element.
- Throws:
GeneralLeanFtException- if an error occurs during execution.
