SeleniumPage (JBehave Web Selenium 4.0-beta-1 API)

java.lang.Object
- org.jbehave.web.selenium.SeleniumPage

```
public class SeleniumPage
extends Object
```
Abstract base class for pages that use the Selenium API. It contains common page methods, with a view to implement the Page Objects pattern.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class SeleniumPage.NonBlank

Nested Classes
Modifier and Type	Class and Description
`static class`	`SeleniumPage.NonBlank`

Field Summary

Fields
Modifier and Type Field and Description

protected ConditionRunner conditionRunner

protected Selenium selenium

Fields
Modifier and Type	Field and Description
`protected ConditionRunner`	`conditionRunner`
`protected Selenium`	`selenium`

Constructor Summary

Constructors
Constructor and Description

SeleniumPage(Selenium selenium, ConditionRunner conditionRunner)

Constructors
Constructor and Description
`SeleniumPage(Selenium selenium, ConditionRunner conditionRunner)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addCustomRequestHeader(String key, String value)`
`void`	`addLocationStrategy(String strategyName, String functionDefinition)`
`void`	`addScript(String scriptContent, String scriptTagId)`
`void`	`addSelection(String locator, String optionLocator)`
`void`	`allowNativeXpath(String allow)`
`void`	`altKeyDown()`
`void`	`altKeyUp()`
`void`	`answerOnNextPrompt(String answer)`
`void`	`assignId(String locator, String identifier)`
`void`	`attachFile(String fieldLocator, String fileLocator)`
`void`	`captureEntirePageScreenshot(String filename, String kwargs)`
`String`	`captureEntirePageScreenshotToString(String kwargs)`
`String`	`captureNetworkTraffic(String type)`
`void`	`captureScreenshot(String filename)`
`String`	`captureScreenshotToString()`
`void`	`check(String locator)`
`void`	`chooseCancelOnNextConfirmation()`
`void`	`chooseOkOnNextConfirmation()`
`void`	`click(String locator)`
`void`	`clickAt(String locator, String coordString)`
`void`	`clickButton(String name)`
`void`	`clickLink(String name)`
`void`	`close()`
`void`	`contextMenu(String locator)`
`void`	`contextMenuAt(String locator, String coordString)`
`void`	`controlKeyDown()`
`void`	`controlKeyUp()`
`void`	`createCookie(String nameValuePair, String optionsString)`
`void`	`deleteAllVisibleCookies()`
`void`	`deleteCookie(String name, String optionsString)`
`void`	`deselectPopUp()`
`void`	`doubleClick(String locator)`
`void`	`doubleClickAt(String locator, String coordString)`
`void`	`dragAndDrop(String locator, String movementsString)`
`void`	`dragAndDropToObject(String locatorOfObjectToBeDragged, String locatorOfDragDestinationObject)`
`void`	`dragdrop(String locator, String movementsString)`
`void`	`fireEvent(String locator, String eventName)`
`void`	`focus(String locator)`
`String`	`getAlert()`
`String[]`	`getAllButtons()`
`String[]`	`getAllFields()`
`String[]`	`getAllLinks()`
`String[]`	`getAllWindowIds()`
`String[]`	`getAllWindowNames()`
`String[]`	`getAllWindowTitles()`
`String`	`getAttribute(String attributeLocator)`
`String[]`	`getAttributeFromAllWindows(String attributeName)`
`String`	`getBodyText()`
`String`	`getConfirmation()`
`String`	`getCookie()`
`String`	`getCookieByName(String name)`
`Number`	`getCssCount(String css)`
`Number`	`getCursorPosition(String locator)`
`Number`	`getElementHeight(String locator)`
`Number`	`getElementIndex(String locator)`
`Number`	`getElementPositionLeft(String locator)`
`Number`	`getElementPositionTop(String locator)`
`Number`	`getElementWidth(String locator)`
`String`	`getEval(String script)`
`String`	`getExpression(String expression)`
`String`	`getHtmlSource()`
`String`	`getLocation()`
`String`	`getLog()`
`Number`	`getMouseSpeed()`
`String`	`getPrompt()`
`String`	`getSelectedId(String selectLocator)`
`String[]`	`getSelectedIds(String selectLocator)`
`String`	`getSelectedIndex(String selectLocator)`
`String[]`	`getSelectedIndexes(String selectLocator)`
`String`	`getSelectedLabel(String selectLocator)`
`String[]`	`getSelectedLabels(String selectLocator)`
`String`	`getSelectedValue(String selectLocator)`
`String[]`	`getSelectedValues(String selectLocator)`
`String[]`	`getSelectOptions(String selectLocator)`
`String`	`getSpeed()`
`String`	`getTable(String tableCellAddress)`
`String`	`getText(String locator)`
`String`	`getTitle()`
`String`	`getValue(String locator)`
`boolean`	`getWhetherThisFrameMatchFrameExpression(String currentFrameString, String target)`
`boolean`	`getWhetherThisWindowMatchWindowExpression(String currentWindowString, String target)`
`Number`	`getXpathCount(String xpath)`
`void`	`goBack()`
`void`	`highlight(String locator)`
`void`	`ignoreAttributesWithoutValue(String ignore)`
`boolean`	`isAlertPresent()`
`boolean`	`isChecked(String locator)`
`boolean`	`isConfirmationPresent()`
`boolean`	`isCookiePresent(String name)`
`boolean`	`isEditable(String locator)`
`boolean`	`isElementPresent(String locator)`
`boolean`	`isOrdered(String locator1, String locator2)`
`boolean`	`isPromptPresent()`
`boolean`	`isSomethingSelected(String selectLocator)`
`boolean`	`isTextPresent(String pattern)`
`boolean`	`isVisible(String locator)`
`void`	`keyDown(String locator, String keySequence)`
`void`	`keyDownNative(String keycode)`
`void`	`keyPress(String locator, String keySequence)`
`void`	`keyPressNative(String keycode)`
`void`	`keyUp(String locator, String keySequence)`
`void`	`keyUpNative(String keycode)`
`void`	`metaKeyDown()`
`void`	`metaKeyUp()`
`void`	`mouseDown(String locator)`
`void`	`mouseDownAt(String locator, String coordString)`
`void`	`mouseDownRight(String locator)`
`void`	`mouseDownRightAt(String locator, String coordString)`
`void`	`mouseMove(String locator)`
`void`	`mouseMoveAt(String locator, String coordString)`
`void`	`mouseOut(String locator)`
`void`	`mouseOver(String locator)`
`void`	`mouseUp(String locator)`
`void`	`mouseUpAt(String locator, String coordString)`
`void`	`mouseUpRight(String locator)`
`void`	`mouseUpRightAt(String locator, String coordString)`
`void`	`open(String url)`
`void`	`open(String url, String ignoreResponseCode)`
`void`	`openWindow(String url, String windowID)`
`void`	`refresh()`
`void`	`removeAllSelections(String locator)`
`void`	`removeScript(String scriptTagId)`
`void`	`removeSelection(String locator, String optionLocator)`
`String`	`retrieveLastRemoteControlLogs()`
`void`	`rollup(String rollupName, String kwargs)`
`void`	`runScript(String script)`
`void`	`select(String locator, String option)`
`void`	`selectByLabel(String locator, String label)`
`void`	`selectByValue(String locator, String value)`
`void`	`selectFrame(String locator)`
`void`	`selectPopUp(String windowID)`
`void`	`selectWindow(String windowID)`
`void`	`setBrowserLogLevel(String logLevel)`
`void`	`setContext(String context)`
`void`	`setCursorPosition(String locator, String position)`
`void`	`setExtensionJs(String extensionJs)`
`void`	`setMouseSpeed(String pixels)`
`void`	`setSpeed(String value)`
`void`	`setTimeout(String timeout)`
`void`	`shiftKeyDown()`
`void`	`shiftKeyUp()`
`void`	`showContextualBanner()`
`void`	`showContextualBanner(String className, String methodName)`
`void`	`shutDownSeleniumServer()`
`void`	`start()`
`void`	`start(Object optionsObject)`
`void`	`start(String optionsString)`
`void`	`stop()`
`void`	`submit(String formLocator)`
`String`	`text(String locator)`
`void`	`textIsNotVisible(String text)`
`void`	`textIsNotVisible(String text, String locator)`
`void`	`textIsVisible(String text)`
`void`	`textIsVisible(String text, String locator)`
`void`	`type(String locator, String value)`
`void`	`typeKeys(String locator, String value)`
`void`	`uncheck(String locator)`
`void`	`useXpathLibrary(String libraryName)`
`String`	`value(String locator)`
`void`	`waitFor(Condition condition)`
`void`	`waitForCondition(String script, String timeout)`
`void`	`waitForFrameToLoad(String frameAddress, String timeout)`
`void`	`waitForPageToLoad()`
`void`	`waitForPageToLoad(int seconds)`
`void`	`waitForPageToLoad(String timeout)`
`void`	`waitForPopUp(String windowID, String timeout)`
`void`	`windowFocus()`
`void`	`windowMaximize()`

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

Field Detail

selenium
```
protected final Selenium selenium
```

conditionRunner

protected final ConditionRunner conditionRunner

Constructor Detail

SeleniumPage

public SeleniumPage(Selenium selenium,
                    ConditionRunner conditionRunner)

Method Detail

open
```
public void open(String url)
```

openWindow

public void openWindow(String url,
                       String windowID)

selectWindow

public void selectWindow(String windowID)

selectPopUp

public void selectPopUp(String windowID)

deselectPopUp
```
public void deselectPopUp()
```

selectFrame

public void selectFrame(String locator)

getWhetherThisFrameMatchFrameExpression

public boolean getWhetherThisFrameMatchFrameExpression(String currentFrameString,
                                                       String target)

getWhetherThisWindowMatchWindowExpression

public boolean getWhetherThisWindowMatchWindowExpression(String currentWindowString,
                                                         String target)

waitForPopUp

public void waitForPopUp(String windowID,
                         String timeout)

chooseCancelOnNextConfirmation

public void chooseCancelOnNextConfirmation()

chooseOkOnNextConfirmation

public void chooseOkOnNextConfirmation()

answerOnNextPrompt

public void answerOnNextPrompt(String answer)

goBack
```
public void goBack()
```

refresh
```
public void refresh()
```

close
```
public void close()
```

isAlertPresent
```
public boolean isAlertPresent()
```

isPromptPresent
```
public boolean isPromptPresent()
```

isConfirmationPresent

public boolean isConfirmationPresent()

getAlert
```
public String getAlert()
```

getConfirmation
```
public String getConfirmation()
```

getPrompt
```
public String getPrompt()
```

getLocation
```
public String getLocation()
```

getTitle
```
public String getTitle()
```

getBodyText
```
public String getBodyText()
```

getValue

public String getValue(String locator)

getText

public String getText(String locator)

highlight

public void highlight(String locator)

getEval
```
public String getEval(String script)
```

isChecked

public boolean isChecked(String locator)

getTable

public String getTable(String tableCellAddress)

getSelectedLabels

public String[] getSelectedLabels(String selectLocator)

getSelectedLabel

public String getSelectedLabel(String selectLocator)

getSelectedValues

public String[] getSelectedValues(String selectLocator)

getSelectedValue

public String getSelectedValue(String selectLocator)

getSelectedIndexes

public String[] getSelectedIndexes(String selectLocator)

getSelectedIndex

public String getSelectedIndex(String selectLocator)

getSelectedIds

public String[] getSelectedIds(String selectLocator)

getSelectedId

public String getSelectedId(String selectLocator)

isSomethingSelected

public boolean isSomethingSelected(String selectLocator)

getSelectOptions

public String[] getSelectOptions(String selectLocator)

getAttribute

public String getAttribute(String attributeLocator)

isTextPresent

public boolean isTextPresent(String pattern)

isElementPresent

public boolean isElementPresent(String locator)

isVisible

public boolean isVisible(String locator)

isEditable

public boolean isEditable(String locator)

getAllButtons
```
public String[] getAllButtons()
```

getAllLinks
```
public String[] getAllLinks()
```

getAllFields
```
public String[] getAllFields()
```

getAttributeFromAllWindows

public String[] getAttributeFromAllWindows(String attributeName)

dragdrop

public void dragdrop(String locator,
                     String movementsString)

setMouseSpeed

public void setMouseSpeed(String pixels)

getMouseSpeed
```
public Number getMouseSpeed()
```

dragAndDrop

public void dragAndDrop(String locator,
                        String movementsString)

dragAndDropToObject

public void dragAndDropToObject(String locatorOfObjectToBeDragged,
                                String locatorOfDragDestinationObject)

windowFocus
```
public void windowFocus()
```

windowMaximize
```
public void windowMaximize()
```

getAllWindowIds
```
public String[] getAllWindowIds()
```

getAllWindowNames
```
public String[] getAllWindowNames()
```

getAllWindowTitles
```
public String[] getAllWindowTitles()
```

getHtmlSource
```
public String getHtmlSource()
```

setCursorPosition

public void setCursorPosition(String locator,
                              String position)

getElementIndex

public Number getElementIndex(String locator)

isOrdered

public boolean isOrdered(String locator1,
                         String locator2)

getElementPositionLeft

public Number getElementPositionLeft(String locator)

getElementPositionTop

public Number getElementPositionTop(String locator)

getElementWidth

public Number getElementWidth(String locator)

getElementHeight

public Number getElementHeight(String locator)

getCursorPosition

public Number getCursorPosition(String locator)

getExpression

public String getExpression(String expression)

getXpathCount

public Number getXpathCount(String xpath)

getCssCount

public Number getCssCount(String css)

assignId

public void assignId(String locator,
                     String identifier)

allowNativeXpath

public void allowNativeXpath(String allow)

ignoreAttributesWithoutValue

public void ignoreAttributesWithoutValue(String ignore)

waitForCondition

public void waitForCondition(String script,
                             String timeout)

setTimeout

public void setTimeout(String timeout)

waitForPageToLoad

public void waitForPageToLoad(String timeout)

waitForFrameToLoad

public void waitForFrameToLoad(String frameAddress,
                               String timeout)

getCookie
```
public String getCookie()
```

getCookieByName

public String getCookieByName(String name)

isCookiePresent

public boolean isCookiePresent(String name)

createCookie

public void createCookie(String nameValuePair,
                         String optionsString)

deleteCookie

public void deleteCookie(String name,
                         String optionsString)

deleteAllVisibleCookies
```
public void deleteAllVisibleCookies()
```

setBrowserLogLevel

public void setBrowserLogLevel(String logLevel)

runScript
```
public void runScript(String script)
```

addLocationStrategy

public void addLocationStrategy(String strategyName,
                                String functionDefinition)

captureEntirePageScreenshot

public void captureEntirePageScreenshot(String filename,
                                        String kwargs)

rollup

public void rollup(String rollupName,
                   String kwargs)

addScript

public void addScript(String scriptContent,
                      String scriptTagId)

removeScript

public void removeScript(String scriptTagId)

useXpathLibrary

public void useXpathLibrary(String libraryName)

setContext

public void setContext(String context)

attachFile

public void attachFile(String fieldLocator,
                       String fileLocator)

captureScreenshot

public void captureScreenshot(String filename)

captureScreenshotToString

public String captureScreenshotToString()

captureNetworkTraffic

public String captureNetworkTraffic(String type)

addCustomRequestHeader

public void addCustomRequestHeader(String key,
                                   String value)

captureEntirePageScreenshotToString

public String captureEntirePageScreenshotToString(String kwargs)

shutDownSeleniumServer
```
public void shutDownSeleniumServer()
```

retrieveLastRemoteControlLogs

public String retrieveLastRemoteControlLogs()

keyDownNative

public void keyDownNative(String keycode)

keyUpNative

public void keyUpNative(String keycode)

keyPressNative

public void keyPressNative(String keycode)

click
```
public void click(String locator)
```

doubleClick

public void doubleClick(String locator)

contextMenu

public void contextMenu(String locator)

clickAt

public void clickAt(String locator,
                    String coordString)

doubleClickAt

public void doubleClickAt(String locator,
                          String coordString)

contextMenuAt

public void contextMenuAt(String locator,
                          String coordString)

fireEvent

public void fireEvent(String locator,
                      String eventName)

focus
```
public void focus(String locator)
```

keyPress

public void keyPress(String locator,
                     String keySequence)

shiftKeyDown
```
public void shiftKeyDown()
```

shiftKeyUp
```
public void shiftKeyUp()
```

metaKeyDown
```
public void metaKeyDown()
```

metaKeyUp
```
public void metaKeyUp()
```

altKeyDown
```
public void altKeyDown()
```

altKeyUp
```
public void altKeyUp()
```

controlKeyDown
```
public void controlKeyDown()
```

controlKeyUp
```
public void controlKeyUp()
```

keyDown

public void keyDown(String locator,
                    String keySequence)

keyUp

public void keyUp(String locator,
                  String keySequence)

mouseOver

public void mouseOver(String locator)

mouseOut
```
public void mouseOut(String locator)
```

mouseDown

public void mouseDown(String locator)

mouseDownRight

public void mouseDownRight(String locator)

mouseDownAt

public void mouseDownAt(String locator,
                        String coordString)

mouseDownRightAt

public void mouseDownRightAt(String locator,
                             String coordString)

mouseUp
```
public void mouseUp(String locator)
```

mouseUpRight

public void mouseUpRight(String locator)

mouseUpAt

public void mouseUpAt(String locator,
                      String coordString)

mouseUpRightAt

public void mouseUpRightAt(String locator,
                           String coordString)

mouseMove

public void mouseMove(String locator)

mouseMoveAt

public void mouseMoveAt(String locator,
                        String coordString)

clickButton
```
public void clickButton(String name)
```

clickLink
```
public void clickLink(String name)
```

select

public void select(String locator,
                   String option)

addSelection

public void addSelection(String locator,
                         String optionLocator)

removeSelection

public void removeSelection(String locator,
                            String optionLocator)

removeAllSelections

public void removeAllSelections(String locator)

submit

public void submit(String formLocator)

open

public void open(String url,
                 String ignoreResponseCode)

selectByLabel

public void selectByLabel(String locator,
                          String label)

selectByValue

public void selectByValue(String locator,
                          String value)

type

public void type(String locator,
                 String value)

typeKeys

public void typeKeys(String locator,
                     String value)

setSpeed
```
public void setSpeed(String value)
```

getSpeed
```
public String getSpeed()
```

getLog
```
public String getLog()
```

check
```
public void check(String locator)
```

uncheck
```
public void uncheck(String locator)
```

text
```
public String text(String locator)
```

value
```
public String value(String locator)
```

textIsVisible

public void textIsVisible(String text)

textIsVisible

public void textIsVisible(String text,
                          String locator)

textIsNotVisible

public void textIsNotVisible(String text)

textIsNotVisible

public void textIsNotVisible(String text,
                             String locator)

waitFor

public void waitFor(Condition condition)

waitForPageToLoad
```
public void waitForPageToLoad()
```

waitForPageToLoad

public void waitForPageToLoad(int seconds)

setExtensionJs

public void setExtensionJs(String extensionJs)

start
```
public void start()
```

start

public void start(String optionsString)

start

public void start(Object optionsObject)

stop
```
public void stop()
```

showContextualBanner
```
public void showContextualBanner()
```

showContextualBanner

public void showContextualBanner(String className,
                                 String methodName)

Class SeleniumPage

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

selenium

conditionRunner

Constructor Detail

SeleniumPage

Method Detail

open

openWindow

selectWindow

selectPopUp

deselectPopUp

selectFrame

getWhetherThisFrameMatchFrameExpression

getWhetherThisWindowMatchWindowExpression

waitForPopUp

chooseCancelOnNextConfirmation

chooseOkOnNextConfirmation

answerOnNextPrompt

goBack

refresh

close

isAlertPresent

isPromptPresent

isConfirmationPresent

getAlert

getConfirmation

getPrompt

getLocation

getTitle

getBodyText

getValue

getText

highlight

getEval

isChecked

getTable

getSelectedLabels

getSelectedLabel

getSelectedValues

getSelectedValue

getSelectedIndexes

getSelectedIndex

getSelectedIds

getSelectedId

isSomethingSelected

getSelectOptions

getAttribute

isTextPresent

isElementPresent

isVisible

isEditable

getAllButtons

getAllLinks

getAllFields

getAttributeFromAllWindows

dragdrop

setMouseSpeed

getMouseSpeed

dragAndDrop

dragAndDropToObject

windowFocus

windowMaximize

getAllWindowIds

getAllWindowNames

getAllWindowTitles

getHtmlSource

setCursorPosition

getElementIndex

isOrdered

getElementPositionLeft

getElementPositionTop

getElementWidth

getElementHeight

getCursorPosition