DocumentPickerModal (XWiki Platform - Index - Tree - Tests - Page Objects 14.8-rc-1 API)

java.lang.Object
- org.xwiki.test.ui.po.BaseElement
- - org.xwiki.index.tree.test.po.DocumentPickerModal

```
public class DocumentPickerModal
extends BaseElement
```
Represents the modal opened when the user changes the location with the DocumentPicker.

Since:

7.2M3

Version:

$Id: ca9ece4c0bb79b6855df2b9486107b4e32961d5a $

Constructor Summary

Constructors
Constructor Description

DocumentPickerModal()

DocumentPickerModal(org.openqa.selenium.By selector)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`cancel()`
`DocumentTreeElement`	`getTree()`
`void`	`select()`
`void`	`selectDocument(String... path)`
`DocumentPickerModal`	`waitForDocumentSelected(String... path)`	Helper method to wait for the specified document to be selected.
`DocumentPickerModal`	`waitForIt()`
`DocumentPickerModal`	`waitToClose()`	The modal may have a fade out effect on close which means it may not disappear instantly.

Methods inherited from class org.xwiki.test.ui.po.BaseElement
getDriver, getUtil, isElementVisible, setContext, waitForNotificationErrorMessage, waitForNotificationInProgressMessage, waitForNotificationSuccessMessage, waitForNotificationWarningMessage, waitUntilPageIsReady

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

- Constructor Detail
  - DocumentPickerModal
```
public DocumentPickerModal()
```
  - DocumentPickerModal
```
public DocumentPickerModal(org.openqa.selenium.By selector)
```
- Method Detail
  - getTree
```
public DocumentTreeElement getTree()
```
  - cancel
```
public void cancel()
```
  - select
```
public void select()
```
  - selectDocument
```
public void selectDocument(String... path)
```
  - waitForIt
```
public DocumentPickerModal waitForIt()
```
  - waitToClose
```
public DocumentPickerModal waitToClose()
```
    The modal may have a fade out effect on close which means it may not disappear instantly. It's safer to wait for the modal to disappear when closed, before proceeding with next actions.
    
    Returns:
    
    this model
  - waitForDocumentSelected
```
public DocumentPickerModal waitForDocumentSelected(String... path)
```
    Helper method to wait for the specified document to be selected. This is useful when you open the modal and the tree is expanded to the current selection.
    
    Parameters:
    
    path - the path used to locate the element to wait for
    
    Returns:
    
    this modal
    
    Since:
    
    7.2