Package org.primefaces.selenium.component

Class PickList

java.lang.Object

org.primefaces.selenium.AbstractPrimePageFragment

org.primefaces.selenium.component.base.AbstractComponent

org.primefaces.selenium.component.PickList

All Implemented Interfaces:

org.openqa.selenium.SearchContext, org.openqa.selenium.TakesScreenshot, org.openqa.selenium.WebElement, org.openqa.selenium.WrapsElement

public abstract class PickList
extends AbstractComponent

Component wrapper for the PrimeFaces p:pickList.

Constructor Summary

Constructors

Constructor	Description
PickList()

Method Summary

Modifier and Type	Method	Description
void	clearSourceListFilter()	Clears the source list filter
void	clearTargetListFilter()	Clears the target list filter
void	filterSourceList(String filterValue)	Filters the source list with the provided filter value
void	filterTargetList(String filterValue)	Filters the target list with the provided filter value
List<org.openqa.selenium.WebElement>	getSourceListElements()	Gets a list of the items in the source list
List<String>	getSourceListLabels()	Gets a list of the labels in the source list
List<String>	getSourceListValues()	Gets a list of the values in the source list
List<org.openqa.selenium.WebElement>	getTargetListElements()	Gets the list of items in the target list
List<String>	getTargetListLabels()	Gets a list of the labels in the target list
List<String>	getTargetListValues()	Gets a list of the values in the target list
boolean	isCheckboxSelectionEnabled()	Determines if the pick list has checkbox selection enabled
void	moveSourceItemsDown(String... items)	Selects the given items in the source list and moves them down.
void	moveSourceItemsToBottom(String... items)	Selects the given items in the source list and moves them to the bottom of the list.
void	moveSourceItemsToTop(String... items)	Selects the given items in the source list and moves them to the top of the list.
void	moveSourceItemsUp(String... items)	Selects the given items in the source list and moves them up.
void	moveTargetItemsDown(String... items)	Selects the given items in the target list and moves them down.
void	moveTargetItemsToBottom(String... items)	Selects the given items in the target list and moves them to the bottom
void	moveTargetItemsToTop(String... items)	Selects the given items in the target list and moves them to the top
void	moveTargetItemsUp(String... items)	Selects the given items in the target list and moves them up.
void	pick(String... items)	Picks the given items from the source list.
void	pickAll()	Picks all the items in the source list.
void	remove(String... items)	Picks the given items from the target list.
void	removeAll()	Removes all the items in the target list.
void	setFilterValue(org.openqa.selenium.WebElement filterElement, String filterValue)	Filter using the Widget configuration "filterDelay" and "filterEvent" values.
void	setFilterValue(org.openqa.selenium.WebElement filterElement, String filterValue, String filterEvent, int filterDelay)	Filter the column using these values.

Methods inherited from class org.primefaces.selenium.component.base.AbstractComponent

destroy, getWidgetByIdScript, getWidgetConfiguration, getWidgetConfigurationAsString, isAjaxified, isAjaxified

Methods inherited from class org.primefaces.selenium.AbstractPrimePageFragment

getElementLocator, getId, getRoot, getWebDriver, getWrappedElement, setElementLocator, setWebDriver

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.openqa.selenium.TakesScreenshot

getScreenshotAs

Methods inherited from interface org.openqa.selenium.WebElement

clear, click, findElement, findElements, getAccessibleName, getAriaRole, getAttribute, getCssValue, getDomAttribute, getDomProperty, getLocation, getRect, getShadowRoot, getSize, getTagName, getText, isDisplayed, isEnabled, isSelected, sendKeys, submit

Constructor Details

PickList

public PickList()

Method Details

pick

public void pick(String... items)

Picks the given items from the source list.

Parameters:

items - the items to pick. These can either be the labels displayed in the list or the underlying values.

pickAll

public void pickAll()

Picks all the items in the source list.

remove

public void remove(String... items)

Picks the given items from the target list.

Parameters:

items - the items to remove. These can either be the labels displayed in the list or the underlying values.

removeAll

public void removeAll()

Removes all the items in the target list.

moveSourceItemsUp

public void moveSourceItemsUp(String... items)

Selects the given items in the source list and moves them up.

Parameters:

items - the items to move up. These can either be the labels displayed in the list or the underlying values.

moveSourceItemsDown

public void moveSourceItemsDown(String... items)

Selects the given items in the source list and moves them down.

Parameters:

items - the items to move down. These can either be the labels displayed in the list or the underlying values.

moveSourceItemsToTop

public void moveSourceItemsToTop(String... items)

Selects the given items in the source list and moves them to the top of the list.

Parameters:

items - the items to move to the top. These can either be the labels displayed in the list or the underlying values.

moveSourceItemsToBottom

public void moveSourceItemsToBottom(String... items)

Selects the given items in the source list and moves them to the bottom of the list.

Parameters:

items - the items to move to the bottom. These can either be the labels displayed in the list or the underlying values.

moveTargetItemsUp

public void moveTargetItemsUp(String... items)

Selects the given items in the target list and moves them up.

Parameters:

items - the items to move up. These can either be the labels displayed in the list or the underlying values.

moveTargetItemsDown

public void moveTargetItemsDown(String... items)

Selects the given items in the target list and moves them down.

Parameters:

items - the items to move down. These can either be the labels displayed in the list or the underlying values.

moveTargetItemsToTop

public void moveTargetItemsToTop(String... items)

Selects the given items in the target list and moves them to the top

Parameters:

items - the items to move to the top. These can either be the labels displayed in the list or the underlying values.

moveTargetItemsToBottom

public void moveTargetItemsToBottom(String... items)

Selects the given items in the target list and moves them to the bottom

Parameters:

items - the items to move to the bottom. These can either be the labels displayed in the list or the underlying values.

filterSourceList

public void filterSourceList(String filterValue)

Filters the source list with the provided filter value

Parameters:

filterValue - the value to use for filtering the list

filterTargetList

public void filterTargetList(String filterValue)

Filters the target list with the provided filter value

Parameters:

filterValue - the value to use for filtering the list

clearSourceListFilter

public void clearSourceListFilter()

Clears the source list filter

clearTargetListFilter

public void clearTargetListFilter()

Clears the target list filter

setFilterValue

public void setFilterValue(org.openqa.selenium.WebElement filterElement,
 String filterValue)

Filter using the Widget configuration "filterDelay" and "filterEvent" values.

Parameters:

filterElement - the source or target filter

filterValue - the value to set the filter

setFilterValue

public void setFilterValue(org.openqa.selenium.WebElement filterElement,
 String filterValue,
 String filterEvent,
 int filterDelay)

Filter the column using these values.

Parameters:

filterElement - the source or target filter

filterValue - the value to filter for

filterEvent - the event causing the filter to trigger such as "keyup" or "enter"

filterDelay - the delay in milliseconds if a "keyup" filter

getSourceListValues

public List<String> getSourceListValues()

Gets a list of the values in the source list

Returns:

the list of values

getSourceListLabels

public List<String> getSourceListLabels()

Gets a list of the labels in the source list

Returns:

the list of labels

getSourceListElements

public List<org.openqa.selenium.WebElement> getSourceListElements()

Gets a list of the items in the source list

Returns:

the items in the source list

getTargetListValues

public List<String> getTargetListValues()

Gets a list of the values in the target list

Returns:

the list of values

getTargetListLabels

public List<String> getTargetListLabels()

Gets a list of the labels in the target list

Returns:

the list of labels

getTargetListElements

public List<org.openqa.selenium.WebElement> getTargetListElements()

Gets the list of items in the target list

Returns:

the items in the target list

isCheckboxSelectionEnabled

public boolean isCheckboxSelectionEnabled()

Determines if the pick list has checkbox selection enabled

Returns:

true if checkbox selection is enabled, false otherwise