org.xwiki.annotation.test.po

Class AnnotatableViewPage

java.lang.Object

org.xwiki.test.ui.po.BaseElement

org.xwiki.annotation.test.po.AnnotatableViewPage

public class AnnotatableViewPage
extends BaseElement

Since:

4.2M1

Version:

$Id: aefba32658c8fd7e9deaf7d572f4cdb337a1a1c9 $

Constructor Summary

Constructors

Constructor and Description
AnnotatableViewPage(ViewPage viewPage)

Method Summary

Modifier and Type	Method and Description
void	addAnnotation(String annotatedText, String annotationText)
void	addAnnotation(String annotatedText, String annotationText, boolean wait)
AnnotationsWindow	beginAddAnnotation(String annotatedText) Selects the specified text and opens the create annotation dialog.
boolean	checkIfAnnotationsAreDisabled()
boolean	checkIfClickbuttonExists()
void	clickHideAnnotations()
void	clickShowAnnotations()
void	clickShowAnnotations(boolean wait) Clicks on the checkbox to show the annotations and maybe waits for the annotations to be displayed.
void	deleteAnnotationByID(String id)
void	deleteAnnotationByText(String annotatedText)
String	getAnnotationContentByText(String searchText)
int	getAnnotationCount()
String	getAnnotationIdByText(String searchText)
int	getCommentId(String annotationId)
ViewPage	getWrappedViewPage()
void	hideAnnotationsPane()
void	selectText(String annotationWord)
AnnotationsPane	showAnnotationsPane()
AnnotationsPane	showAnnotationsPane(boolean wait) Open the annotation settings pane using the menu and maybe wait for it.
void	simulateCTRL_M()
void	toggleAnnotationDisplayUsingShortcutKey(boolean wait) Toggle the display of the annotations using the keyboard shortcut.
void	waitForAnnotationsDisplayed() Wait for at least one annotation to be displayed.
void	waitforAnnotationWarningNotification()

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

Constructor Detail

AnnotatableViewPage

public AnnotatableViewPage(ViewPage viewPage)

Method Detail

getWrappedViewPage

public ViewPage getWrappedViewPage()

addAnnotation

public void addAnnotation(String annotatedText,
                          String annotationText)

addAnnotation

public void addAnnotation(String annotatedText,
                          String annotationText,
                          boolean wait)

beginAddAnnotation

public AnnotationsWindow beginAddAnnotation(String annotatedText)

Selects the specified text and opens the create annotation dialog.

Parameters:

annotatedText - the text to select and annotate

Returns:

the annotation creation dialog

Since:

12.10.9, 13.4.1, 13.5RC1

deleteAnnotationByID

public void deleteAnnotationByID(String id)

deleteAnnotationByText

public void deleteAnnotationByText(String annotatedText)

getAnnotationContentByText

public String getAnnotationContentByText(String searchText)

getAnnotationIdByText

public String getAnnotationIdByText(String searchText)

Parameters:

searchText - the text selected by the annotation.

Returns:

the annotation id

Since:

10.6RC1, 9.11.9

showAnnotationsPane

public AnnotationsPane showAnnotationsPane()

showAnnotationsPane

public AnnotationsPane showAnnotationsPane(boolean wait)

Open the annotation settings pane using the menu and maybe wait for it.

Parameters:

wait - whether to wait for the pane to be visible or not

Returns:

the annotation settings pane

Since:

12.10.9, 13.4.1, 13.5RC1

hideAnnotationsPane

public void hideAnnotationsPane()

clickShowAnnotations

public void clickShowAnnotations()

clickShowAnnotations

public void clickShowAnnotations(boolean wait)

Clicks on the checkbox to show the annotations and maybe waits for the annotations to be displayed.

Parameters:

wait - whether to wait or not for the annotations to be displayed; pass true only if you know there are existing annotations to display

Since:

12.10.9, 13.4.1, 13.5RC1

waitForAnnotationsDisplayed

public void waitForAnnotationsDisplayed()

Wait for at least one annotation to be displayed.

Since:

12.10.9, 13.4.1, 13.5RC1

clickHideAnnotations

public void clickHideAnnotations()

getAnnotationCount

public int getAnnotationCount()

Returns:

the number of annotations displayed on the page

Since:

12.10.9, 13.4.1, 13.5RC1

toggleAnnotationDisplayUsingShortcutKey

public void toggleAnnotationDisplayUsingShortcutKey(boolean wait)

Toggle the display of the annotations using the keyboard shortcut.

Parameters:

wait - whether to wait for the annotations to be displayed or not (as they may need to be fetched from the server); pass true only if you know that there are existing annotations

Since:

12.10.9, 13.4.1, 13.5RC1

checkIfClickbuttonExists

public boolean checkIfClickbuttonExists()

simulateCTRL_M

public void simulateCTRL_M()

selectText

public void selectText(String annotationWord)

Parameters:

annotationWord - string that will be selected on the screen

checkIfAnnotationsAreDisabled

public boolean checkIfAnnotationsAreDisabled()

waitforAnnotationWarningNotification

public void waitforAnnotationWarningNotification()

getCommentId

public int getCommentId(String annotationId)

Parameters:

annotationId - the annotation id.

Returns:

the comment id. Used by CommentsTab.

Since:

10.6RC1, 9.11.9