relenium (version 0.3.0)

firefoxClass: Class firefoxClass. A class to represent Firefox web browser

Description

This class is designed to represent and interact with a Firefox web browser.

Methods

Navigation and web data extraction

get(url = ""):

Use this method to load a new web page in the current browser window.

getTitle():

Use this method to get the title of the current page, with leading and trailing whitespace stripped, or null if one is not already set.

getCurrentUrl():

Use this method to get a string representing the current URL that the browser is looking at.

getPageSource():

Use this method to get the source of the last loaded page.

printHtml():

Use this method to parse and print the html code of the last loaded page. It is similar to getPageSource but it returns the html code in a more readable form.

forward():

Use this method to move forward a single "item" in the browser's history. It does nothing if it is on the last page viewed.

back():

Use this method to move back a single "item" in the browser's history.

close():

Use this method to close the Firefox browser.

getCapabilities():

Use this method to get your Firefox browser capabilities, platform, version, etc.

getVersion():

Use this method to get your Firefox browser version.

Locating elements There are different methods to find a single element in a page. All the functions from the 'findElement/s' family have the same argument stringName = "". Functions of type 'finElement' return a webElementClass object. Functions of type 'finElements' return a list of webElementClass objects.

findElementByXPath:

Use this method when you know the xpath of an element. With this strategy, the first element matching the xpath will be returned.

findElementByClassName:

Use this method when you know the class attribute of an element. With this strategy, the first element with the class attribute value matching the location will be returned.

findElementByCssSelector:

Use this method to find elements via driver's underlying W3 Selector engine. If the browser does not implement the Selector API, a best effort is made to emulate the API.

findElementById:

Use this method when you know the id attribute of an element. With this strategy, the first element with the id attribute value matching the location will be returned.

findElementByName:

Use this method when you know the name attribute of an element. With this strategy, the first element with the name attribute value matching the location will be returned.

findElementByLinkText:

Use this method when you know the text of an element. With this strategy, the first element matching the exact text will be returned.

findElementByPartialLinkText:

Use this method when you know the text of an element. With this strategy, the first element matching the partial text will be returned.

findElementByTagName:

Use this method when you know the tag name of an element. With this strategy, the first element matching the tag name will be returned.

To find multiple elements use the following methods in the same way as the previous ones. Note that these methods will return a list.

• findElementsByXPath
• findElementsByClassName
• findElementsByCssSelector
• findElementsById
• findElementByPartialLinkText
• findElementsByLinkText
• findElementsByName
• findElementsByPartialLinkText
• findElementsByTagName

Details

The firefox class is implemented as a reference class (see ReferenceClasses for more details). This class is designed to represent and to interact with a Firefox web browser. You can open a new Firefox web browser with firefoxClass$new(), navigate to any web page, extract web data and find web elements by different ways like tag name, text, id, xpath and others.

All methods implemented are explained below. Documentation is based on the original Selinum's Java documentation. It is possible to access to the methods through TAB completion.

Normally Firefox's binary is assumed to be in your system's default location:

• Linux firefox (found using "which")
• Mac /Applications/Firefox.app/Contents/MacOS/firefox-bin
• Windows %PROGRAMFILES%\Mozilla Firefox\firefox.exe

A simple firefoxClass example can be found at the end of this file. You can get a more sofisticated one using demo(package = "relenium").

See Also

ReferenceClasses, relenium-package, webElementClass

Examples

  ## Not run: 
#     require(relenium)
# 
#     firefox <- firefoxClass$new()
#     firefox$get("https://github.com/LluisRamon/relenium")
#     firefox$getTitle()
#     firefox$close()
#   ## End(Not run)