org.xwiki.test.ui.po

Class DocumentPicker

java.lang.Object

org.xwiki.test.ui.po.BaseElement

org.xwiki.test.ui.po.DocumentPicker

public class DocumentPicker
extends BaseElement

Represents the Document Picker.

Since:

7.2M3

Version:

$Id: 346751b0778654d52a7b236f0fcff3305d210d5f $

Field Summary

Fields

Modifier and Type	Field and Description
protected org.openqa.selenium.WebElement	container

Constructor Summary

Constructors

Constructor and Description
DocumentPicker() Use this constructor only if there is only one document picker on the page.
DocumentPicker(org.openqa.selenium.WebElement container)

Method Summary

Modifier and Type	Method and Description
void	browseDocuments() Clicks the "pick document" button that triggers a modal pop-up to be displayed.
BreadcrumbElement	getLocation()
String	getName()
org.openqa.selenium.WebElement	getNameInput()
String	getParent()
org.openqa.selenium.WebElement	getParentInput()
String	getTitle()
org.openqa.selenium.WebElement	getTitleInput()
DocumentPicker	setName(String name)
DocumentPicker	setParent(String parent)
DocumentPicker	setTitle(String title)
DocumentPicker	setWiki(String wikiName)
DocumentPicker	toggleLocationAdvancedEdit()
void	waitForLocation(List<String> expectedPath) Wait for the Breadcrumb to display the passed path and throw an exception if the timeout is reached.
void	waitForLocation(String expectedPathString) Wait for the Breadcrumb to display the passed path string and throw an exception if the timeout is reached.
DocumentPicker	waitForName(String name) Wait until the name field has been changed.

Methods inherited from class org.xwiki.test.ui.po.BaseElement

getDriver, getUtil, isElementVisible, setContext, waitForNotificationErrorMessage, waitForNotificationInProgressMessage, waitForNotificationSuccessMessage, waitForNotificationWarningMessage, waitUntilPageJSIsLoaded

Methods inherited from class java.lang.Object

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

Field Detail

container

protected org.openqa.selenium.WebElement container

Constructor Detail

DocumentPicker

public DocumentPicker()

Use this constructor only if there is only one document picker on the page.

DocumentPicker

public DocumentPicker(org.openqa.selenium.WebElement container)

Method Detail

getTitle

public String getTitle()

setTitle

public DocumentPicker setTitle(String title)

waitForName

public DocumentPicker waitForName(String name)

Wait until the name field has been changed.

Parameters:

name - the new name

Returns:

this.

getTitleInput

public org.openqa.selenium.WebElement getTitleInput()

getLocation

public BreadcrumbElement getLocation()

toggleLocationAdvancedEdit

public DocumentPicker toggleLocationAdvancedEdit()

getParent

public String getParent()

setParent

public DocumentPicker setParent(String parent)

getParentInput

public org.openqa.selenium.WebElement getParentInput()

getName

public String getName()

setName

public DocumentPicker setName(String name)

getNameInput

public org.openqa.selenium.WebElement getNameInput()

setWiki

public DocumentPicker setWiki(String wikiName)

browseDocuments

public void browseDocuments()

Clicks the "pick document" button that triggers a modal pop-up to be displayed.

The caller is responsible for handling the modal (or instantiating the right page object element), such we limit the extra coupling that would be required from the test framework if it were to instantiate and return the page object for the modal pop-up.

waitForLocation

public void waitForLocation(String expectedPathString)

Wait for the Breadcrumb to display the passed path string and throw an exception if the timeout is reached. Note that we need to wait since the Breadcrumb is updated live and asserting its content without waiting would lead to false positives.

Note: This method can not be implemented inside BreadcrumbElement because a change of parent replaces completely the BreadcrumbElement's container and thus it becomes stale. To avoid that, at each wait iteration, we lookup the current breadcrumb element and not a cached one.

Parameters:

expectedPathString - the path string to wait for

Since:

7.2RC1

waitForLocation

public void waitForLocation(List<String> expectedPath)

Wait for the Breadcrumb to display the passed path and throw an exception if the timeout is reached. Note that we need to wait since the Breadcrumb is updated live and asserting its content without waiting would lead to false positives.

Note: This method can not be implemented inside BreadcrumbElement because a change of parent replaces completely the BreadcrumbElement's container and thus it becomes stale. To avoid that, at each wait iteration, we lookup the current breadcrumb element and not a cached one.

Parameters:

expectedPath - the path to wait for

Since:

7.2RC1