com.atlassian.confluence.selenium.client

Class MacroBrowser

java.lang.Object

com.atlassian.confluence.selenium.client.Dialog

com.atlassian.confluence.selenium.client.MacroBrowser

public class MacroBrowser
extends Dialog

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MacroBrowser.Category

Field Summary

Fields inherited from class com.atlassian.confluence.selenium.client.Dialog

client, id

Constructor Summary

Constructors

Constructor and Description
MacroBrowser(ConfluenceSeleniumClient client)

Method Summary

Modifier and Type	Method and Description
void	clickCheckboxParam(String paramName, boolean check)
void	clickClose()
void	clickDropDownOption(String displayText) Click the specified option in the visible macro browser drop down
void	clickInsert()
void	clickPreview(boolean waitForPreview)
static String	getBrowseCategoryMacroId(MacroBrowser.Category category, String macroName)
String	getDropDownOptionTooltip(String displayText) Returns the tooltip (title) text for the dropdown option with the supplied display text.
String	getEditMacroTitle(String macroTitle)
String	getInsertMacroTitle(String macroTitle)
String	getMacroDescription(String macroName)
String	getParameterDescription(String parameterName) Returns the description text under the given parameter for the currently-displayed macro.
String	getParamId(String paramName)
String	getParamValue(String paramName)
MacroBrowser.Category	getSelectedCategory()
Marketplace	goToMarketplace()
boolean	hasCategory(MacroBrowser.Category category)
boolean	isDropDownOptionVisible(String displayText) Returns true if display text appears in the currently-visible 'smart field' drop down.
boolean	isDropDownVisibleForParameter(String paramName) Is a 'smart field' drop down visible for the named macro parameter.
void	selectCategory(MacroBrowser.Category category)
void	selectMacro(String macroKey)
void	selectMacro(String macroKey, boolean waitForPreview)
void	selectMainFrame() Selects the main/top frame for Confluence.
void	typeStringParam(String paramName, String paramValue)
void	waitForDropDownForParameter(String paramName) Is a 'smart field' drop down visible for the named macro parameter.
void	waitForDropDownToCloseForParameter(String paramName) Waits until no dropdown is displayed for the named macro parameter.
void	waitForPreviewButtonToEnable() Wait for the preview button to be enabled
void	waitForPreviewToLoad()

Methods inherited from class com.atlassian.confluence.selenium.client.Dialog

clickButton, clickCancel, clickLink, clickPageMenu, getTitle, hasPageMenu, isVisible, pressEscape, pressEscapeOnly, waitForRemoval, waitUntilClosed, waitUntilVisible

Methods inherited from class java.lang.Object

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

Constructor Detail

MacroBrowser

public MacroBrowser(ConfluenceSeleniumClient client)

Method Detail

getMacroDescription

public String getMacroDescription(String macroName)

getInsertMacroTitle

public String getInsertMacroTitle(String macroTitle)

getEditMacroTitle

public String getEditMacroTitle(String macroTitle)

selectCategory

public void selectCategory(MacroBrowser.Category category)

hasCategory

public boolean hasCategory(MacroBrowser.Category category)

getSelectedCategory

public MacroBrowser.Category getSelectedCategory()

selectMacro

public void selectMacro(String macroKey)

selectMacro

public void selectMacro(String macroKey,
                        boolean waitForPreview)

waitForPreviewToLoad

public void waitForPreviewToLoad()

selectMainFrame

public void selectMainFrame()

Selects the main/top frame for Confluence.

clickCheckboxParam

public void clickCheckboxParam(String paramName,
                               boolean check)

typeStringParam

public void typeStringParam(String paramName,
                            String paramValue)

getParamValue

public String getParamValue(String paramName)

waitForDropDownForParameter

public void waitForDropDownForParameter(String paramName)

Is a 'smart field' drop down visible for the named macro parameter.

waitForDropDownToCloseForParameter

public void waitForDropDownToCloseForParameter(String paramName)

Waits until no dropdown is displayed for the named macro parameter.

isDropDownVisibleForParameter

public boolean isDropDownVisibleForParameter(String paramName)

Is a 'smart field' drop down visible for the named macro parameter.

isDropDownOptionVisible

public boolean isDropDownOptionVisible(String displayText)

Returns true if display text appears in the currently-visible 'smart field' drop down.

getDropDownOptionTooltip

public String getDropDownOptionTooltip(String displayText)

Returns the tooltip (title) text for the dropdown option with the supplied display text.

clickDropDownOption

public void clickDropDownOption(String displayText)

Click the specified option in the visible macro browser drop down

Parameters:

displayText - the display text of the option to be selected

clickPreview

public void clickPreview(boolean waitForPreview)

waitForPreviewButtonToEnable

public void waitForPreviewButtonToEnable()

Wait for the preview button to be enabled

clickClose

public void clickClose()

clickInsert

public void clickInsert()

getParamId

public String getParamId(String paramName)

Returns:

the unique id for the named parameter on the macro browser

goToMarketplace

public Marketplace goToMarketplace()

getParameterDescription

public String getParameterDescription(String parameterName)

Returns the description text under the given parameter for the currently-displayed macro.

getBrowseCategoryMacroId

public static String getBrowseCategoryMacroId(MacroBrowser.Category category,
                                              String macroName)