Package org.xwiki.index.tree.test.po

Class DocumentTreeElement

java.lang.Object

org.xwiki.test.ui.po.BaseElement

org.xwiki.tree.test.po.TreeElement

org.xwiki.index.tree.test.po.DocumentTreeElement

public class DocumentTreeElement
extends TreeElement

Page object used to interact with the document tree.

Since:

6.3RC1

Version:

$Id: e0212c60c7be4a5eb69baa0ebfcd8b54be50b5f3 $

Constructor Summary

Constructors

Constructor	Description
DocumentTreeElement(org.openqa.selenium.WebElement element)	Creates a new instance that can be used to interact with the document tree represented by the given element.

Method Summary

Modifier and Type	Method	Description
DocumentTreeElement	clearSelection()
TreeNodeElement	getAttachmentNode(String... path)
TreeNodeElement	getAttachmentNode(AttachmentReference attachmentReference)
TreeNodeElement	getDocumentNode(String... path)
TreeNodeElement	getSpaceNode(String... path)
boolean	hasAttachment(String... path)
boolean	hasDocument(String... path)
boolean	hasSpace(String... path)
DocumentTreeElement	openTo(String nodeId)
DocumentTreeElement	openToAttachment(String... path)	Opens the tree to the specified attachment.
DocumentTreeElement	openToAttachment(AttachmentReference attachmentReference)	Open the tree to the specific attachment.
DocumentTreeElement	openToDocument(String... path)	Opens the tree to the specified document.
DocumentTreeElement	openToSpace(String... path)	Opens the tree to the specified space.
DocumentTreeElement	waitForDocumentSelected(String... path)	Waits for the specified document to be selected.
DocumentTreeElement	waitForIt()

Methods inherited from class org.xwiki.tree.test.po.TreeElement

getElement, getNode, getNodeIDs, getSelectedNodeIDs, getTopLevelNodes, hasNode, selectNodes, waitForNodeSelected

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

DocumentTreeElement

public DocumentTreeElement(org.openqa.selenium.WebElement element)

Creates a new instance that can be used to interact with the document tree represented by the given element.

Parameters:

element - the element that represents the document tree

Method Detail

openTo

public DocumentTreeElement openTo(String nodeId)

Overrides:

openTo in class TreeElement

clearSelection

public DocumentTreeElement clearSelection()

Overrides:

clearSelection in class TreeElement

openToSpace

public DocumentTreeElement openToSpace(String... path)

Opens the tree to the specified space.

Parameters:

path - the path used to locate the space

Returns:

this tree

openToDocument

public DocumentTreeElement openToDocument(String... path)

Opens the tree to the specified document.

Parameters:

path - the path used to locate the document

Returns:

this tree

openToAttachment

public DocumentTreeElement openToAttachment(String... path)

Opens the tree to the specified attachment.

Parameters:

path - the path used to locate the attachment

Returns:

this tree

See Also:

openToAttachment(AttachmentReference)

openToAttachment

public DocumentTreeElement openToAttachment(AttachmentReference attachmentReference)

Open the tree to the specific attachment.

Parameters:

attachmentReference - the attachment reference to open the tree to

Returns:

this tree

Since:

14.7RC1

See Also:

openToAttachment(String...)

waitForIt

public DocumentTreeElement waitForIt()

Overrides:

waitForIt in class TreeElement

waitForDocumentSelected

public DocumentTreeElement waitForDocumentSelected(String... path)

Waits for the specified document to be selected.

Parameters:

path - the path used to locate the document to wait for

Returns:

this tree

Since:

7.2

hasSpace

public boolean hasSpace(String... path)

Parameters:

path - the path used to locate the space

Returns:

true if the specified space appears in the tree

hasDocument

public boolean hasDocument(String... path)

Parameters:

path - the path used to locate the document

Returns:

true if the specified document appears in the tree

hasAttachment

public boolean hasAttachment(String... path)

Parameters:

path - the path used to locate the attachment

Returns:

true if the specified attachment is present in the tree

getSpaceNode

public TreeNodeElement getSpaceNode(String... path)

Parameters:

path - the path used to locate the space

Returns:

the corresponding space node

getDocumentNode

public TreeNodeElement getDocumentNode(String... path)

Parameters:

path - the path used to locate the document

Returns:

the corresponding document node

getAttachmentNode

public TreeNodeElement getAttachmentNode(String... path)

Parameters:

path - the path used to locate the attachment

Returns:

the corresponding attachment node

See Also:

getAttachmentNode(AttachmentReference)

getAttachmentNode

public TreeNodeElement getAttachmentNode(AttachmentReference attachmentReference)

Parameters:

attachmentReference - the attachment reference of the attachment node to get

Returns:

the corresponding attachment node

Since:

14.7RC1

See Also:

getAttachmentNode(String...)