Element (Robot Framework :: Selenium2Library 1.4.0.3 API)

java.lang.Object
- com.github.markusbernhardt.selenium2library.RunOnFailureKeywordsAdapter
- - com.github.markusbernhardt.selenium2library.keywords.Element

All Implemented Interfaces:: RunOnFailureKeywords

public class Element
extends RunOnFailureKeywordsAdapter

Field Summary

Fields
Modifier and Type	Field and Description
`protected BrowserManagement`	`browserManagement` Instantiated BrowserManagement keyword bean
`protected FormElement`	`formElement` Instantiated FormElement keyword bean
`protected Logging`	`logging` Instantiated Logging keyword bean

Constructor Summary

Constructors
Constructor and Description

Element()

Constructors
Constructor and Description
`Element()`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`assignIdToElement(String locator, String id)` Assigns a temporary identifier to the element identified by locator This is mainly useful, when the locator is a complicated and slow XPath expression.
`void`	`clearElementText(String locator)` Clears the text from element identified by locator.
`void`	`clickElement(String locator)` Click on the element identified by locator.
`void`	`clickElementAtCoordinates(String locator, String xOffset, String yOffset)` Click on the element identified by locator at the coordinates xOffset and yOffset.
`void`	`clickImage(String locator)` Click on the image identified by locator.
`void`	`clickLink(String locator)` Click on the link identified by locator.
`void`	`currentFrameContains(String text)`
`void`	`currentFrameContains(String text, String logLevel)` Verify the current frame contains text.
`void`	`currentFrameShouldNotContain(String text)`
`void`	`currentFrameShouldNotContain(String text, String logLevel)` Verify the current frame does not contain text.
`void`	`doubleClickElement(String locator)` Double-Click on the element identified by locator.
`void`	`dragAndDrop(String source, String target)` Drag the element identified by the locator source and move it on top of the element identified by the locator target.
`void`	`dragAndDropByOffset(String source, int xOffset, int yOffset)` Drag the element identified by the locator source and move it by xOffset and yOffset.
`protected List<org.openqa.selenium.WebElement>`	`elementFind(String locator, boolean firstOnly, boolean required)`
`protected List<org.openqa.selenium.WebElement>`	`elementFind(String locator, boolean firstOnly, boolean required, String tag)`
`void`	`elementShouldBeClickable(String locator)`
`void`	`elementShouldBeClickable(String locator, String message)` Verify the element identified by locator is clickable.
`void`	`elementShouldBeDisabled(String locator)` Verify the element identified by locator is disabled.
`void`	`elementShouldBeEnabled(String locator)` Verify the element identified by locator is enabled.
`void`	`elementShouldBeSelected(String locator)`
`void`	`elementShouldBeSelected(String locator, String message)` Verify the element identified by locator is selected.
`void`	`elementShouldBeVisible(String locator)`
`void`	`elementShouldBeVisible(String locator, String message)` Verify the element identified by locator is visible.
`void`	`elementShouldContain(String locator, String text)`
`void`	`elementShouldContain(String locator, String text, String message)` Verify the element identified by locator contains text.
`void`	`elementShouldNotBeClickable(String locator)`
`void`	`elementShouldNotBeClickable(String locator, String message)` Verify the element identified by locator is not clickable.
`void`	`elementShouldNotBeSelected(String locator)`
`void`	`elementShouldNotBeSelected(String locator, String message)` Verify the element identified by locator is not selected.
`void`	`elementShouldNotBeVisible(String locator)`
`void`	`elementShouldNotBeVisible(String locator, String message)` Verify the element identified by locator is not visible.
`void`	`elementShouldNotContain(String locator, String text)`
`void`	`elementShouldNotContain(String locator, String text, String message)` Verify the element identified by locator does not contain text.
`void`	`elementTextShouldBe(String locator, String expected)`
`void`	`elementTextShouldBe(String locator, String text, String message)` Verify the text of the element identified by locator is exactly text.
`void`	`elementTextShouldNotBe(String locator, String expected)`
`void`	`elementTextShouldNotBe(String locator, String text, String message)` Verify the text of the element identified by locator is not exactly text.
`static String`	`escapeXpathValue(String value)`
`void`	`focus(String locator)` Set the focus to the element identified by locator.
`protected boolean`	`frameContains(String locator, String text)`
`void`	`frameShouldContain(String locator, String text)`
`void`	`frameShouldContain(String locator, String text, String logLevel)` Verify the frame identified by locator contains text.
`void`	`frameShouldNotContain(String locator, String text, String logLevel)` Verify the frame identified by locator does not contain text.
`ArrayList<String>`	`getAllLinks()` Returns a list containing ids of all links found in current page.
`String`	`getElementAttribute(String attributeLocator)` Returns the value of an element attribute.
`int`	`getHorizontalPosition(String locator)` Returns horizontal position of element identified by locator.
`int`	`getMatchingXpathCount(String xpath)` Returns the number of elements located the given xpath.
`String`	`getText(String locator)` Returns the text of the element identified by locator.
`String`	`getValue(String locator)` Returns the value attribute of the element identified by locator.
`protected String`	`getValue(String locator, String tag)`
`int`	`getVerticalPosition(String locator)` Returns vertical position of element identified by locator.
`protected boolean`	`isClickable(String locator)`
`protected boolean`	`isElementPresent(String locator)`
`protected boolean`	`isElementPresent(String locator, String tag)`
`protected boolean`	`isEnabled(String locator)`
`protected boolean`	`isSelected(String locator)`
`protected boolean`	`isTextPresent(String text)`
`protected boolean`	`isVisible(String locator)`
`protected CharSequence`	`mapAsciiKeyCodeToKey(int keyCode)`
`void`	`mouseDown(String locator)` Simulates pressing the left mouse button on the element identified by locator.
`void`	`mouseDownOnImage(String locator)` Simulates pressing the left mouse button on the image identified by locator.
`void`	`mouseDownOnLink(String locator)` Simulates pressing the left mouse button on the link identified by locator.
`void`	`mouseOut(String locator)` Simulates moving the mouse away from the element identified by locator.
`void`	`mouseOver(String locator)` Simulates moving the mouse over the element identified by locator.
`void`	`mouseUp(String locator)` Simulates releasing the left mouse button on the element identified by locator.
`void`	`openContextMenu(String locator)` Opens the context menu on the element identified by locator.
`protected boolean`	`pageContains(String text)`
`void`	`pageShouldContain(String text)`
`void`	`pageShouldContain(String text, String logLevel)` Verify the current page contains text.
`void`	`pageShouldContainElement(String locator)`
`void`	`pageShouldContainElement(String locator, String message)`
`void`	`pageShouldContainElement(String locator, String message, String logLevel)` Verify the element identified by locator is found on the current page.
`protected void`	`pageShouldContainElement(String locator, String tag, String message, String logLevel)`
`void`	`pageShouldContainImage(String locator)`
`void`	`pageShouldContainImage(String locator, String message)`
`void`	`pageShouldContainImage(String locator, String message, String logLevel)` Verify the image identified by locator is found on the current page.
`void`	`pageShouldContainLink(String locator)`
`void`	`pageShouldContainLink(String locator, String message)`
`void`	`pageShouldContainLink(String locator, String message, String logLevel)` Verify the link identified by locator is found on the current page.
`void`	`pageShouldNotContain(String text)`
`void`	`pageShouldNotContain(String text, String logLevel)` Verify the current page does not contain text.
`void`	`pageShouldNotContainElement(String locator)`
`void`	`pageShouldNotContainElement(String locator, String message)`
`void`	`pageShouldNotContainElement(String locator, String message, String logLevel)` Verify the element identified by locator is not found on the current page.
`protected void`	`pageShouldNotContainElement(String locator, String tag, String message, String logLevel)`
`void`	`pageShouldNotContainImage(String locator)`
`void`	`pageShouldNotContainImage(String locator, String message)`
`void`	`pageShouldNotContainImage(String locator, String message, String logLevel)` Verify the image identified by locator is not found on the current page.
`void`	`pageShouldNotContainLink(String locator)`
`void`	`pageShouldNotContainLink(String locator, String message)`
`void`	`pageShouldNotContainLink(String locator, String message, String logLevel)` Verify the link identified by locator is not found on the current page.
`protected String[]`	`parseAttributeLocator(String attributeLocator)`
`void`	`pressKey(String locator, String key)` Simulates pressing key on the element identified by locator.
`void`	`simulate(String locator, String event)` Simulates the given event on the element identified by locator.
`void`	`xpathShouldMatchXTimes(String xpath, int expectedXpathCount)`
`void`	`xpathShouldMatchXTimes(String xpath, int expectedXpathCount, String message)`
`void`	`xpathShouldMatchXTimes(String xpath, int expectedXpathCount, String message, String logLevel)` Verify that the page contains the expectedXpathCount of elements located by the given xpath.

Methods inherited from class com.github.markusbernhardt.selenium2library.RunOnFailureKeywordsAdapter
runOnFailureByAspectJ

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

- Field Detail
  - browserManagement
```
protected BrowserManagement browserManagement
```
    Instantiated BrowserManagement keyword bean
  - formElement
```
protected FormElement formElement
```
    Instantiated FormElement keyword bean
  - logging
```
protected Logging logging
```
    Instantiated Logging keyword bean
- Constructor Detail
  - Element
```
public Element()
```
- Method Detail
  - currentFrameContains
```
public void currentFrameContains(String text)
```
  - currentFrameContains
```
public void currentFrameContains(String text,
                        String logLevel)
```
    Verify the current frame contains text.
    
    See `Introduction` for details about log levels.
    
    Parameters:
    text - The text to verify.
    logLevel - Default=INFO. Optional log level.
  - currentFrameShouldNotContain
```
public void currentFrameShouldNotContain(String text)
```
  - currentFrameShouldNotContain
```
public void currentFrameShouldNotContain(String text,
                                String logLevel)
```
    Verify the current frame does not contain text.
    
    See `Introduction` for details about log levels.
    
    Parameters:
    text - The text to verify.
    logLevel - Default=INFO. Optional log level.
  - elementShouldContain
```
public void elementShouldContain(String locator,
                        String text)
```
  - elementShouldContain
```
public void elementShouldContain(String locator,
                        String text,
                        String message)
```
    Verify the element identified by locator contains text.
    
    See `Introduction` for details about locators.
    
    Parameters:
    locator - The locator to locate the element.
    text - The text to verify.
    message - Default=NONE. Optional custom error message.
  - elementShouldNotContain
```
public void elementShouldNotContain(String locator,
                           String text)
```
  - elementShouldNotContain
```
public void elementShouldNotContain(String locator,
                           String text,
                           String message)
```
    Verify the element identified by locator does not contain text.
    
    See `Introduction` for details about locators.
    
    Parameters:
    locator - The locator to locate the element.
    text - The text to verify.
    message - Default=NONE. Optional custom error message.
  - frameShouldContain
```
public void frameShouldContain(String locator,
                      String text)
```
  - frameShouldContain
```
public void frameShouldContain(String locator,
                      String text,
                      String logLevel)
```
    Verify the frame identified by locator contains text.
    
    See `Introduction` for details about locators.
    
    Parameters:
    locator - The locator to locate the frame.
    text - The text to verify.
    logLevel - Default=INFO. Optional log level.
  - frameShouldNotContain
```
public void frameShouldNotContain(String locator,
                         String text,
                         String logLevel)
```
    Verify the frame identified by locator does not contain text.
    
    See `Introduction` for details about locators.
    
    Parameters:
    locator - The locator to locate the frame.
    text - The text to verify.
    logLevel - Default=INFO. Optional log level.
  - pageShouldContain
```
public void pageShouldContain(String text)
```
  - pageShouldContain
```
public void pageShouldContain(String text,
                     String logLevel)
```
    Verify the current page contains text.
    
    See `Introduction` for details about log levels.
    
    Parameters:
    text - The text to verify.
    logLevel - Default=INFO. Optional log level.
  - pageShouldNotContain
```
public void pageShouldNotContain(String text)
```
  - pageShouldNotContain
```
public void pageShouldNotContain(String text,
                        String logLevel)
```
    Verify the current page does not contain text.
    
    See `Introduction` for details about log levels.
    
    Parameters:
    text - The text to verify.
    logLevel - Default=INFO. Optional log level.
  - pageShouldContainElement
```
public void pageShouldContainElement(String locator)
```
  - pageShouldContainElement
```
public void pageShouldContainElement(String locator,
                            String message)
```
  - pageShouldContainElement
```
public void pageShouldContainElement(String locator,
                            String message,
                            String logLevel)
```
    Verify the element identified by locator is found on the current page.
    
    Key attributes for arbitrary elements are id and name. See `Introduction` for details about log levels and locators.
    
    Parameters:
    locator - The locator to locate the element.
    message - Default=NONE. Optional custom error message.
    logLevel - Default=INFO. Optional log level.
  - pageShouldContainElement
```
protected void pageShouldContainElement(String locator,
                            String tag,
                            String message,
                            String logLevel)
```
  - pageShouldNotContainElement
```
public void pageShouldNotContainElement(String locator)
```
  - pageShouldNotContainElement
```
public void pageShouldNotContainElement(String locator,
                               String message)
```
  - pageShouldNotContainElement
```
public void pageShouldNotContainElement(String locator,
                               String message,
                               String logLevel)
```
    Verify the element identified by locator is not found on the current page.
    
    Key attributes for arbitrary elements are id and name. See `Introduction` for details about log levels and locators.
    
    Parameters:
    locator - The locator to locate the element.
    message - Default=NONE. Optional custom error message.
    logLevel - Default=INFO. Optional log level.
  - pageShouldNotContainElement
```
protected void pageShouldNotContainElement(String locator,
                               String tag,
                               String message,
                               String logLevel)
```
  - assignIdToElement
```
public void assignIdToElement(String locator,
                     String id)
```
    Assigns a temporary identifier to the element identified by locator
    
    This is mainly useful, when the locator is a complicated and slow XPath expression. The identifier expires when the page is reloaded.
    
    Example:
    
    Assign ID to Element xpath=//div[@id=\"first_div\"] my id
    
    Page Should Contain Element my id
    
    Parameters:
    locator - The locator to locate the element.
    id - The id to assign.
  - elementShouldBeEnabled
```
public void elementShouldBeEnabled(String locator)
```
    Verify the element identified by locator is enabled.
    
    Key attributes for arbitrary elements are id and name. See `Introduction` for details about locators.
    
    Parameters:
    locator - The locator to locate the element.
  - elementShouldBeDisabled
```
public void elementShouldBeDisabled(String locator)
```
    Verify the element identified by locator is disabled.
    
    Key attributes for arbitrary elements are id and name. See `Introduction` for details about locators.
    
    Parameters:
    locator - The locator to locate the element.
  - elementShouldBeSelected
```
public void elementShouldBeSelected(String locator)
```
  - elementShouldBeSelected
```
public void elementShouldBeSelected(String locator,
                           String message)
```
    Verify the element identified by locator is selected.
    
    Key attributes for arbitrary elements are id and name. See `Introduction` for details about locators.
    
    Parameters:
    locator - The locator to locate the element.
    message - Default=NONE. Optional custom error message.
  - elementShouldNotBeSelected
```
public void elementShouldNotBeSelected(String locator)
```
  - elementShouldNotBeSelected
```
public void elementShouldNotBeSelected(String locator,
                              String message)
```
    Verify the element identified by locator is not selected.
    
    Key attributes for arbitrary elements are id and name. See `Introduction` for details about locators.
    
    Parameters:
    locator - The locator to locate the element.
    message - Default=NONE. Optional custom error message.
  - elementShouldBeVisible
```
public void elementShouldBeVisible(String locator)
```
  - elementShouldBeVisible
```
public void elementShouldBeVisible(String locator,
                          String message)
```
    Verify the element identified by locator is visible.
    
    Herein, visible means that the element is logically visible, not optically visible in the current browser viewport. For example, an element that carries display:none is not logically visible, so using this keyword on that element would fail.
    
    Key attributes for arbitrary elements are id and name. See `Introduction` for details about locators.
    
    Parameters:
    locator - The locator to locate the element.
    message - Default=NONE. Optional custom error message.
  - elementShouldNotBeVisible
```
public void elementShouldNotBeVisible(String locator)
```
  - elementShouldNotBeVisible
```
public void elementShouldNotBeVisible(String locator,
                             String message)
```
    Verify the element identified by locator is not visible.
    
    Herein, visible means that the element is logically visible, not optically visible in the current browser viewport. For example, an element that carries display:none is not logically visible, so using this keyword on that element would fail.
    
    Key attributes for arbitrary elements are id and name. See `Introduction` for details about locators.
    
    Parameters:
    locator - The locator to locate the element.
    message - Default=NONE. Optional custom error message.
  - elementShouldBeClickable
```
public void elementShouldBeClickable(String locator)
```
  - elementShouldBeClickable
```
public void elementShouldBeClickable(String locator,
                            String message)
```
    Verify the element identified by locator is clickable.
    
    Key attributes for arbitrary elements are id and name. See `Introduction` for details about locators.
    
    Parameters:
    locator - The locator to locate the element.
    message - Default=NONE. Optional custom error message.
  - elementShouldNotBeClickable
```
public void elementShouldNotBeClickable(String locator)
```
  - elementShouldNotBeClickable
```
public void elementShouldNotBeClickable(String locator,
                               String message)
```
    Verify the element identified by locator is not clickable.
    
    Key attributes for arbitrary elements are id and name. See `Introduction` for details about locators.
    
    Parameters:
    locator - The locator to locate the element.
    message - Default=NONE. Optional custom error message.
  - elementTextShouldBe
```
public void elementTextShouldBe(String locator,
                       String expected)
```
  - elementTextShouldBe
```
public void elementTextShouldBe(String locator,
                       String text,
                       String message)
```
    Verify the text of the element identified by locator is exactly text.
    
    In contrast to `Element Should Contain`, this keyword does not try a substring match but an exact match on the element identified by locator.
    
    Key attributes for arbitrary elements are id and name. See `Introduction` for details about locators.
    
    Parameters:
    locator - The locator to locate the element.
    text - The text to verify.
    message - Default=NONE. Optional custom error message.
  - elementTextShouldNotBe
```
public void elementTextShouldNotBe(String locator,
                          String expected)
```
  - elementTextShouldNotBe
```
public void elementTextShouldNotBe(String locator,
                          String text,
                          String message)
```
    Verify the text of the element identified by locator is not exactly text.
    
    In contrast to `Element Should Not Contain`, this keyword does not try a substring match but an exact match on the element identified by locator.
    
    Key attributes for arbitrary elements are id and name. See `Introduction` for details about locators.
    
    Parameters:
    locator - The locator to locate the element.
    text - The text to verify.
    message - Default=NONE. Optional custom error message.
  - getElementAttribute
```
public String getElementAttribute(String attributeLocator)
```
    Returns the value of an element attribute.
    
    The attribute_locator consists of element locator followed by an @ sign and attribute name. Example: element_id@class
    
    Key attributes for arbitrary elements are id and name. See `Introduction` for details about locators.
    
    Parameters:
    attributeLocator - The attribute locator.
    
    Returns:
    The attribute value.
  - clearElementText
```
public void clearElementText(String locator)
```
    Clears the text from element identified by locator.
    
    This keyword does not execute any checks on whether or not the clear method has succeeded, so if any subsequent checks are needed, they should be executed using method `Element Text Should Be`.
    
    Also, this method will use WebDriver's internal _element.clear()_ method, i.e. it will not send any keypresses, and it will not have any effect whatsoever on elements other than input textfields or input textareas. Clients relying on keypresses should implement their own methods.
    
    Key attributes for arbitrary elements are id and name. See `Introduction` for details about locators.
    
    Parameters:
    locator - The locator to locate the element.
  - getHorizontalPosition
```
public int getHorizontalPosition(String locator)
```
    Returns horizontal position of element identified by locator.
    
    The position is returned in pixels off the left side of the page, as an integer. Fails if the matching element is not found.
    
    Key attributes for arbitrary elements are id and name. See `Introduction` for details about locators.
    
    Parameters:
    locator - The locator to locate the element.
    
    Returns:
    The horizontal position
  - getValue
```
public String getValue(String locator)
```
    Returns the value attribute of the element identified by locator.
    
    Key attributes for arbitrary elements are id and name. See `Introduction` for details about locators.
    
    Parameters:
    locator - The locator to locate the element.
    
    Returns:
    The value attribute of the element.
  - getValue
```
protected String getValue(String locator,
              String tag)
```
  - getText
```
public String getText(String locator)
```
    Returns the text of the element identified by locator.
    
    Key attributes for arbitrary elements are id and name. See `Introduction` for details about locators.
    
    Parameters:
    locator - The locator to locate the element.
    
    Returns:
    The text of the element.
  - getVerticalPosition
```
public int getVerticalPosition(String locator)
```
    Returns vertical position of element identified by locator.
    
    The position is returned in pixels off the top of the page, as an integer. Fails if the matching element is not found.
    
    Key attributes for arbitrary elements are id and name. See `Introduction` for details about locators.
    
    Parameters:
    locator - The locator to locate the element.
    
    Returns:
    The vertical position
  - clickElement
```
public void clickElement(String locator)
```
    Click on the element identified by locator.
    
    Key attributes for arbitrary elements are id and name. See `Introduction` for details about locators.
    
    Parameters:
    locator - The locator to locate the element.
  - clickElementAtCoordinates
```
public void clickElementAtCoordinates(String locator,
                             String xOffset,
                             String yOffset)
```
    Click on the element identified by locator at the coordinates xOffset and yOffset.
    
    The cursor is moved at the center of the element and the to the given x/y offset from that point. Both offsets are specified as negative (left/up) or positive (right/down) number.
    
    Key attributes for arbitrary elements are id and name. See `Introduction` for details about locators.
    
    Parameters:
    locator - The locator to locate the element.
    xOffset - The horizontal offset in pixel. Negative means left, positive right.
    yOffset - The vertical offset in pixel. Negative means up, positive down.
  - doubleClickElement
```
public void doubleClickElement(String locator)
```
    Double-Click on the element identified by locator.
    
    Key attributes for arbitrary elements are id and name. See `Introduction` for details about locators.
    
    Parameters:
    locator - The locator to locate the element.
  - focus
```
public void focus(String locator)
```
    Set the focus to the element identified by locator.
    
    Key attributes for arbitrary elements are id and name. See `Introduction` for details about locators.
    
    Parameters:
    locator - The locator to locate the element.
  - dragAndDrop
```
public void dragAndDrop(String source,
               String target)
```
    Drag the element identified by the locator source and move it on top of the element identified by the locator target.
    
    Key attributes for arbitrary elements are id and name. See `Introduction` for details about locators.
    
    Example:
    
    Drag And Drop elem1 elem2 # Move elem1 over elem2
    
    Parameters:
    source - The locator to locate the element to drag.
    target - The locator to locate the element where to drop the dragged element.
  - dragAndDropByOffset
```
public void dragAndDropByOffset(String source,
                       int xOffset,
                       int yOffset)
```
    Drag the element identified by the locator source and move it by xOffset and yOffset.
    
    Both offsets are specified as negative (left/up) or positive (right/down) number.
    
    Key attributes for arbitrary elements are id and name. See `Introduction` for details about locators.
    
    Example:
    
    Drag And Drop By Offset elem1 50 35 # Move elem1 50px right and 35px down.
    
    Parameters:
    source - The locator to locate the element to drag.
    xOffset - The horizontal offset in pixel. Negative means left, positive right.
    yOffset - The vertical offset in pixel. Negative means up, positive down.
  - mouseDown
```
public void mouseDown(String locator)
```
    Simulates pressing the left mouse button on the element identified by locator.
    
    The element is pressed without releasing the mouse button.
    
    Key attributes for arbitrary elements are id and name. See `Introduction` for details about locators.
    
    Parameters:
    locator - The locator to locate the element.
    See Also:
    mouseDownOnImage(java.lang.String), mouseDownOnLink(java.lang.String)
  - mouseOut
```
public void mouseOut(String locator)
```
    Simulates moving the mouse away from the element identified by locator.
    
    Key attributes for arbitrary elements are id and name. See `Introduction` for details about locators.
    
    Parameters:
    locator - The locator to locate the element.
  - mouseOver
```
public void mouseOver(String locator)
```
    Simulates moving the mouse over the element identified by locator.
    
    Key attributes for arbitrary elements are id and name. See `Introduction` for details about locators.
    
    Parameters:
    locator - The locator to locate the element.
  - mouseUp
```
public void mouseUp(String locator)
```
    Simulates releasing the left mouse button on the element identified by locator.
    
    Key attributes for arbitrary elements are id and name. See `Introduction` for details about locators.
    
    Parameters:
    locator - The locator to locate the element.
  - openContextMenu
```
public void openContextMenu(String locator)
```
    Opens the context menu on the element identified by locator.
    
    Key attributes for arbitrary elements are id and name. See `Introduction` for details about locators.
    
    Parameters:
    locator - The locator to locate the element.
  - simulate
```
public void simulate(String locator,
            String event)
```
    Simulates the given event on the element identified by locator.
    
    This keyword is especially useful, when the element has an OnEvent handler that needs to be explicitly invoked.
    
    Key attributes for arbitrary elements are id and name. See `Introduction` for details about locators.
    
    Parameters:
    locator - The locator to locate the element.
    event - The event to invoke.
  - pressKey
```
public void pressKey(String locator,
            String key)
```
    Simulates pressing key on the element identified by locator.
    
    Key is either a single character, or a numerical ASCII code of the key lead by '\\'.
    
    Key attributes for arbitrary elements are id and name. See `Introduction` for details about locators.
    
    Example:
    
    Press Key text_field q # Press 'q'
    
    Press Key login_button \\13 # ASCII code for enter key
    
    Parameters:
    locator - The locator to locate the element.
    key - The key to press.
  - clickLink
```
public void clickLink(String locator)
```
    Click on the link identified by locator.
    
    Key attributes for links are id, name, href and link text. See `Introduction` for details about locators.
    
    Parameters:
    locator - The locator to locate the link.
  - getAllLinks
```
public ArrayList<String> getAllLinks()
```
    Returns a list containing ids of all links found in current page.
    
    If a link has no id, an empty string will be in the list instead.
    
    Returns:
    The list of link ids.
  - mouseDownOnLink
```
public void mouseDownOnLink(String locator)
```
    Simulates pressing the left mouse button on the link identified by locator.
    
    The element is pressed without releasing the mouse button.
    
    Key attributes for links are id, name, href and link text. See `Introduction` for details about locators.
    
    Parameters:
    locator - The locator to locate the element.
    See Also:
    mouseDown(java.lang.String), mouseDownOnImage(java.lang.String)
  - pageShouldContainLink
```
public void pageShouldContainLink(String locator)
```
  - pageShouldContainLink
```
public void pageShouldContainLink(String locator,
                         String message)
```
  - pageShouldContainLink
```
public void pageShouldContainLink(String locator,
                         String message,
                         String logLevel)
```
    Verify the link identified by locator is found on the current page.
    
    Key attributes for links are id, name, href and link text. See `Introduction` for details about log levels and locators.
    
    Parameters:
    locator - The locator to locate the link.
    message - Default=NONE. Optional custom error message.
    logLevel - Default=INFO. Optional log level.
  - pageShouldNotContainLink
```
public void pageShouldNotContainLink(String locator)
```
  - pageShouldNotContainLink
```
public void pageShouldNotContainLink(String locator,
                            String message)
```
  - pageShouldNotContainLink
```
public void pageShouldNotContainLink(String locator,
                            String message,
                            String logLevel)
```
    Verify the link identified by locator is not found on the current page.
    
    Key attributes for links are id, name, href and link text. See `Introduction` for details about log levels and locators.
    
    Parameters:
    locator - The locator to locate the link.
    message - Default=NONE. Optional custom error message.
    logLevel - Default=INFO. Optional log level.
  - clickImage
```
public void clickImage(String locator)
```
    Click on the image identified by locator.
    
    Key attributes for images are id, src and alt. See `Introduction` for details about locators.
    
    Parameters:
    locator - The locator to locate the element.
  - mouseDownOnImage
```
public void mouseDownOnImage(String locator)
```
    Simulates pressing the left mouse button on the image identified by locator.
    
    The element is pressed without releasing the mouse button.
    
    Key attributes for images are id, src and alt. See `Introduction` for details about locators.
    
    Parameters:
    locator - The locator to locate the element.
    See Also:
    mouseDown(java.lang.String), mouseDownOnLink(java.lang.String)
  - pageShouldContainImage
```
public void pageShouldContainImage(String locator)
```
  - pageShouldContainImage
```
public void pageShouldContainImage(String locator,
                          String message)
```
  - pageShouldContainImage
```
public void pageShouldContainImage(String locator,
                          String message,
                          String logLevel)
```
    Verify the image identified by locator is found on the current page.
    
    Key attributes for images are id, src and alt. See `Introduction` for details about log levels and locators.
    
    Parameters:
    locator - The locator to locate the link.
    message - Default=NONE. Optional custom error message.
    logLevel - Default=INFO. Optional log level.
  - pageShouldNotContainImage
```
public void pageShouldNotContainImage(String locator)
```
  - pageShouldNotContainImage
```
public void pageShouldNotContainImage(String locator,
                             String message)
```
  - pageShouldNotContainImage
```
public void pageShouldNotContainImage(String locator,
                             String message,
                             String logLevel)
```
    Verify the image identified by locator is not found on the current page.
    
    Key attributes for images are id, src and alt. See `Introduction` for details about log levels and locators.
    
    Parameters:
    locator - The locator to locate the link.
    message - Default=NONE. Optional custom error message.
    logLevel - Default=INFO. Optional log level.
  - getMatchingXpathCount
```
public int getMatchingXpathCount(String xpath)
```
    Returns the number of elements located the given xpath.
    
    If you wish to assert the number of located elements, use `Xpath Should Match X Times`.
    
    Parameters:
    xpath - The XPath to match page elements
    
    Returns:
    The number of located elements
  - xpathShouldMatchXTimes
```
public void xpathShouldMatchXTimes(String xpath,
                          int expectedXpathCount)
```
  - xpathShouldMatchXTimes
```
public void xpathShouldMatchXTimes(String xpath,
                          int expectedXpathCount,
                          String message)
```
  - xpathShouldMatchXTimes
```
public void xpathShouldMatchXTimes(String xpath,
                          int expectedXpathCount,
                          String message,
                          String logLevel)
```
    Verify that the page contains the expectedXpathCount of elements located by the given xpath.
    
    Parameters:
    xpath - The XPath to match page elements
    expectedXpathCount - The expected number of located elements
    message - Default=NONE. Optional custom error message.
    logLevel - Default=INFO. Optional log level.
  - elementFind
```
protected List<org.openqa.selenium.WebElement> elementFind(String locator,
                                               boolean firstOnly,
                                               boolean required)
```
  - elementFind
```
protected List<org.openqa.selenium.WebElement> elementFind(String locator,
                                               boolean firstOnly,
                                               boolean required,
                                               String tag)
```
  - frameContains
```
protected boolean frameContains(String locator,
                    String text)
```
  - isTextPresent
```
protected boolean isTextPresent(String text)
```
  - isEnabled
```
protected boolean isEnabled(String locator)
```
  - isVisible
```
protected boolean isVisible(String locator)
```
  - isClickable
```
protected boolean isClickable(String locator)
```
  - isSelected
```
protected boolean isSelected(String locator)
```
  - parseAttributeLocator
```
protected String[] parseAttributeLocator(String attributeLocator)
```
  - isElementPresent
```
protected boolean isElementPresent(String locator)
```
  - isElementPresent
```
protected boolean isElementPresent(String locator,
                       String tag)
```
  - pageContains
```
protected boolean pageContains(String text)
```
  - mapAsciiKeyCodeToKey
```
protected CharSequence mapAsciiKeyCodeToKey(int keyCode)
```
  - escapeXpathValue
```
public static String escapeXpathValue(String value)
```

Assign ID to Element	xpath=//div[@id=\"first_div\"]	my id
Page Should Contain Element	my id

Press Key	text_field	q	# Press 'q'
Press Key	login_button	\\13	# ASCII code for enter key

Class Element

Field Summary

Constructor Summary

Method Summary

Methods inherited from class com.github.markusbernhardt.selenium2library.RunOnFailureKeywordsAdapter

Methods inherited from class java.lang.Object

Field Detail

browserManagement

formElement

logging

Constructor Detail

Element

Method Detail

currentFrameContains

currentFrameContains

currentFrameShouldNotContain

currentFrameShouldNotContain

elementShouldContain

elementShouldContain

elementShouldNotContain

elementShouldNotContain

frameShouldContain

frameShouldContain

frameShouldNotContain

pageShouldContain

pageShouldContain

pageShouldNotContain

pageShouldNotContain

pageShouldContainElement

pageShouldContainElement

pageShouldContainElement

pageShouldContainElement

pageShouldNotContainElement

pageShouldNotContainElement

pageShouldNotContainElement

pageShouldNotContainElement

assignIdToElement

elementShouldBeEnabled

elementShouldBeDisabled

elementShouldBeSelected

elementShouldBeSelected

elementShouldNotBeSelected

elementShouldNotBeSelected

elementShouldBeVisible

elementShouldBeVisible

elementShouldNotBeVisible

elementShouldNotBeVisible

elementShouldBeClickable

elementShouldBeClickable

elementShouldNotBeClickable

elementShouldNotBeClickable

elementTextShouldBe

elementTextShouldBe

elementTextShouldNotBe

elementTextShouldNotBe

getElementAttribute

clearElementText

getHorizontalPosition

getValue

getValue

getText

getVerticalPosition

clickElement

clickElementAtCoordinates

doubleClickElement

focus

dragAndDrop

dragAndDropByOffset

mouseDown

mouseOut

mouseOver

mouseUp

openContextMenu

simulate

pressKey

clickLink

getAllLinks

mouseDownOnLink

pageShouldContainLink

pageShouldContainLink