com.atlassian.confluence.selenium.client

Class Editor

java.lang.Object

com.atlassian.confluence.selenium.client.Editor

public class Editor
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static int	EDITOR_TIMEOUT_MILLIS

Constructor Summary

Constructors

Constructor and Description
Editor(ConfluenceSeleniumClient client, Suite suite)

Method Summary

Modifier and Type	Method and Description
void	addComment(Page page)
PageView	cancel()
void	createBlogPost(Space space)
void	createPage(Space space)
TinyMce	edit(ContentEntity contentEntity)
long	getAttachmentSourceContentId()
String	getContent()
long	getContentId()
String	getHtmlSourceContent()
Location	getLocation()
MacroBrowser	getMacroBrowser() For use when opening the macro browser manually, e.g.
Map<String,String>	getMacroParameters(String name) Retrieve a macro's parameters from the editor.
TinyMce	getTinyMce()
String	getTitle() Gets the value in the editor Title field.
long	getToolbarPositionTop()
InsertImageDialog	insertImage() Opens the image dialog if in RTE mode.
void	insertImage(Attachment attachment)
TinyMce	logInAndAddComment(User user, BlogPost blogpost)
TinyMce	logInAndAddComment(User user, Page page)
TinyMce	logInAndCreateBlogPost(User user, Space space)
TinyMce	logInAndCreatePage(User user, Space space)
TinyMce	logInAndEdit(User user, ContentEntity contentEntity)
TinyMce	logInAndEditInRTE(User user, ContentEntity contentEntity) Logs the given user in, edits the given content and switches to the RTE.
void	merge() Click the link to merge an existing draft with the current editor content.
LinkBrowser	openLinkBrowser()
MacroBrowser	openMacroBrowser()
PagePermissionsEditor	openPermissionsEditor()
PageView	save()
PageView	saveWithKeyboardShortcut()
MovePageDialog	saveWithLocation() Note that this is only available as a dark feature now.
void	selectFirstParagraph()
void	setContent(String content) Note: Be careful with \n characters as they behave differently in IE and FF at the moment.
void	setHtmlContent(String htmlContent)
void	setTitle(String title)
EditorPreview	switchToPreview()
void	triggerDraftAndCheckUserDrafts()
void	triggerDraftAndCheckUserDrafts(Page page) Triggers a draft to be saved and then checks that the draft screen contains a draft with the title of the given page.
void	triggerDraftAndEdit(Page page) Triggers a draft to be saved.
void	triggerDraftAutoSave() Triggers a draft by switching to preview mode.
void	waitForDraftAutoSavedMessage()
void	waitForEditorPageLoad() Waits for the page to load with the configured editor page load timeout.
void	waitForPreviewToLoad() Wait until the preview is loaded
void	waitUntilEditorIsVisible() Wait until the RTE is visible after switching back from the preview

Methods inherited from class java.lang.Object

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

Field Detail

EDITOR_TIMEOUT_MILLIS

public static final int EDITOR_TIMEOUT_MILLIS

Constructor Detail

Editor

public Editor(ConfluenceSeleniumClient client,
              Suite suite)

Method Detail

waitForEditorPageLoad

public void waitForEditorPageLoad()

Waits for the page to load with the configured editor page load timeout. Loading editor pages is quite slow, so it should be higher than the other configured timeouts.

logInAndCreatePage

public TinyMce logInAndCreatePage(User user,
                                  Space space)

logInAndCreateBlogPost

public TinyMce logInAndCreateBlogPost(User user,
                                      Space space)

logInAndEdit

public TinyMce logInAndEdit(User user,
                            ContentEntity contentEntity)

logInAndAddComment

public TinyMce logInAndAddComment(User user,
                                  Page page)

logInAndAddComment

public TinyMce logInAndAddComment(User user,
                                  BlogPost blogpost)

logInAndEditInRTE

public TinyMce logInAndEditInRTE(User user,
                                 ContentEntity contentEntity)

Logs the given user in, edits the given content and switches to the RTE.

Returns:

the TinyMce reference

edit

public TinyMce edit(ContentEntity contentEntity)

addComment

public void addComment(Page page)

createPage

public void createPage(Space space)

createBlogPost

public void createBlogPost(Space space)

getHtmlSourceContent

public String getHtmlSourceContent()

getTitle

public String getTitle()

Gets the value in the editor Title field. If the field is showing the default greyed-text title an empty string will be returned.

setHtmlContent

public void setHtmlContent(String htmlContent)

setContent

public void setContent(String content)

Note: Be careful with \n characters as they behave differently in IE and FF at the moment. (IE->p, FF->br)

getContent

public String getContent()

selectFirstParagraph

public void selectFirstParagraph()

switchToPreview

public EditorPreview switchToPreview()

triggerDraftAutoSave

public void triggerDraftAutoSave()

Triggers a draft by switching to preview mode.

waitForDraftAutoSavedMessage

public void waitForDraftAutoSavedMessage()

triggerDraftAndCheckUserDrafts

public void triggerDraftAndCheckUserDrafts(Page page)

Triggers a draft to be saved and then checks that the draft screen contains a draft with the title of the given page.

triggerDraftAndCheckUserDrafts

public void triggerDraftAndCheckUserDrafts()

triggerDraftAndEdit

public void triggerDraftAndEdit(Page page)

Triggers a draft to be saved. It checks that the draft screen contains a draft with the title of the given page and then returns to the edit page screen.

save

public PageView save()

saveWithKeyboardShortcut

public PageView saveWithKeyboardShortcut()

cancel

public PageView cancel()

openPermissionsEditor

public PagePermissionsEditor openPermissionsEditor()

setTitle

public void setTitle(String title)

merge

public void merge()

Click the link to merge an existing draft with the current editor content.

getTinyMce

public TinyMce getTinyMce()

saveWithLocation

public MovePageDialog saveWithLocation()

Note that this is only available as a dark feature now.

openMacroBrowser

public MacroBrowser openMacroBrowser()

openLinkBrowser

public LinkBrowser openLinkBrowser()

getMacroBrowser

public MacroBrowser getMacroBrowser()

For use when opening the macro browser manually, e.g. via a context menu selection

Returns:

the macro browser.

waitForPreviewToLoad

public void waitForPreviewToLoad()

Wait until the preview is loaded

waitUntilEditorIsVisible

public void waitUntilEditorIsVisible()

Wait until the RTE is visible after switching back from the preview

insertImage

public InsertImageDialog insertImage()

Opens the image dialog if in RTE mode.

insertImage

public void insertImage(Attachment attachment)

getContentId

public long getContentId()

getAttachmentSourceContentId

public long getAttachmentSourceContentId()

getLocation

public Location getLocation()

getToolbarPositionTop

public long getToolbarPositionTop()

getMacroParameters

public Map<String,String> getMacroParameters(String name)

Retrieve a macro's parameters from the editor.

Parameters:

name - the name of the macro to be checked for

Returns:

the hashmap of the params of the macro, or an empty hashmap if the macro doesn't exist.

Throws:

com.thoughtworks.selenium.SeleniumException - if the macro doesn't exist.