Browser (SeleniumBrowser 0.3.11 API)

java.lang.Object
- cz.etnetera.seleniumbrowser.browser.Browser

All Implemented Interfaces:

BrowserContext, DataSource, PropertySource, org.openqa.selenium.internal.WrapsDriver, org.openqa.selenium.SearchContext
```
public class Browser
extends Object
implements BrowserContext
```
Wrapper class for WebDriver. It is configured using BrowserConfiguration. Controls automatic reporting using listeners provided by configuration.

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`baseUrl`
`protected String`	`baseUrlRegex`
`protected BrowserConfiguration`	`configuration`
`protected Map<String,Object>`	`dataHolder`
`static String`	`DEFAULT_CONFIGURATION_KEY`
`protected org.openqa.selenium.WebDriver`	`driver`
`protected BrowserElementLoader`	`elementLoader`
`static DateTimeFormatter`	`FILE_DATE_FORMATTER`
`protected com.thoughtworks.selenium.webdriven.JavascriptLibrary`	`javascriptLibrary`
`protected String`	`label`
`static String`	`LABEL_DELIMITER`
`protected List<BrowserListener>`	`listeners`
`protected Page`	`page`
`static String`	`PROPERTIES_CONFIGURATION_KEY`
`protected File`	`reportDir`
`protected boolean`	`reported`
`protected boolean`	`urlVerification`
`protected BrowserUtils`	`utils`
`protected double`	`waitRetryInterval`
`protected double`	`waitTimeout`

Constructor Summary

Constructors
Constructor and Description
`Browser()` Constructs a new instance with default configuration.
`Browser(BrowserConfiguration configuration)` Constructs a new instance and configures it.
`Browser(Class<T> configCls)` Constructs a new instance with configuration constructed from given class.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addListener(BrowserListener listener)` Adds listener.
`protected void`	`applyConfiguration(BrowserConfiguration configuration)`
`void`	`assertAt(Class<?> page)` Asserts that actual page is a given class.
`void`	`checkIfPresent(org.openqa.selenium.WebElement element)` Checks if element exists on actual page.
`<T extends BrowserElement> T`	`constructBrowserElement(Class<T> element, BrowserContext context, org.openqa.selenium.WebElement webElement, boolean optional)`
`<T extends BrowserEvent> T`	`constructEvent(Class<T> eventCls, BrowserContext context)` Constructs a new instance of `BrowserEvent` subclass with given context and local time.
`<T extends Logic> T`	`constructLogic(Class<T> logic, BrowserContext context)`
`<T extends Page> T`	`constructPage(Class<T> page)` Construct page defined by class.
`protected org.openqa.selenium.WebDriver`	`createDriver()`
`org.openqa.selenium.support.pagefactory.ElementLocator`	`createElementLocator(org.openqa.selenium.SearchContext searchContext, org.openqa.selenium.By by)`
`org.openqa.selenium.support.pagefactory.ElementLocator`	`createElementLocator(org.openqa.selenium.SearchContext searchContext, org.openqa.selenium.By by, boolean lookupCached)`
`org.openqa.selenium.support.pagefactory.ElementLocator`	`createElementLocator(org.openqa.selenium.SearchContext searchContext, Field field)`
`protected String`	`escapeFileName(String name)`
`<T extends BrowserElement> List<T>`	`find(BrowserContext context, org.openqa.selenium.By by, Class<T> elementCls)` Find all elements within the given context using the given mechanism as instances of the given `BrowserElement` or its subclass.
`org.openqa.selenium.WebElement`	`findElement(org.openqa.selenium.By by)`
`List<org.openqa.selenium.WebElement>`	`findElements(org.openqa.selenium.By by)`
`<T extends BrowserElement> T`	`findOne(BrowserContext context, org.openqa.selenium.By by, Class<T> elementCls, boolean optional)` Find the first element within the given context using the given mechanism as instance of the given `BrowserElement` or its subclass.
`String`	`getBaseUrl()` Base URL for pages.
`String`	`getBaseUrlRegex()` Base URL regex for pages.
`Browser`	`getBrowser()` Returns `Browser` instance.
`BrowserConfiguration`	`getConfiguration()` Returns `BrowserConfiguration` instance.
`<T> T`	`getConfiguration(Class<T> configuration)` Returns `BrowserConfiguration` instance casted to specific type.
`BrowserContext`	`getContext()` Returns parent `BrowserContext` instance.
`Map<String,Object>`	`getDataHolder()` Returns map which holds data.
`org.openqa.selenium.WebDriver`	`getDriver()` Returns wrapped `WebDriver` instance.
`<T> T`	`getDriver(Class<T> driver)` Returns wrapped `WebDriver` instance casted to specific type.
`BrowserElementLoader`	`getElementLoader()`
`protected Path`	`getFilePath(String name, String extension)`
`com.thoughtworks.selenium.webdriven.JavascriptLibrary`	`getJavascriptLibrary()`
`String`	`getLabel()` Browser label which is mainly used for reporting.
`Page`	`getPage()` Returns actual page or null if browser has no page initiated.
`<T> T`	`getPage(Class<T> page)` Returns actual page casted to given type or null if browser has no page initiated.
`String`	`getProperty(String key)` Returns property as `String`.
`File`	`getReportDir()` Returns reporting directory, which is used as root directory for files stored using `BrowserContext.saveFile(File, String, String)` and similar methods.
`protected Path`	`getUniqueFilePath(String name, String extension)`
`BrowserUtils`	`getUtils()` Returns utils instance.
`double`	`getWaitRetryInterval()` Returns default wait retry interval.
`double`	`getWaitTimeout()` Returns default wait timeout.
`<T extends Page> T`	`goTo(Class<T> page)` Go to page defined by class.
`<T extends Page> T`	`goTo(T page)` Go to already constructed page.
`<T extends Page> T`	`goToSafely(Class<T> page)` Safely go to page defined by class.
`<T extends Page> T`	`goToSafely(T page)` Safely go to already constructed page.
`void`	`goToUrl(String url)` Go to specific URL.
`protected void`	`init(BrowserConfiguration configuration)`
`protected <T extends BrowserConfiguration> void`	`init(Class<T> configCls)`
`<T extends BrowserElement> T`	`initBrowserElement(Class<T> element, BrowserContext context, org.openqa.selenium.WebElement webElement, boolean optional)`
`<T extends BrowserElement> T`	`initBrowserElement(T element)` Initialize already constructed element.
`protected void`	`initDefault()`
`void`	`initElements(BrowserContext context)`
`protected void`	`initListeners()`
`<T extends Logic> T`	`initLogic(Class<T> logic, BrowserContext context)`
`<T extends Logic> T`	`initLogic(T logic)` Initialize logic defined by class.
`Page`	`initOnePage(Object... pages)` Initialize first of matching page.
`Page`	`initOnePageSafely(Object... pages)` Safely initialize first of matching page.
`<T extends Page> T`	`initPage(Class<T> page)` Initialize page defined by class.
`<T extends Page> T`	`initPage(T page)` Initialize already constructed page.
`<T extends Page> T`	`initPageSafely(Class<T> page)` Safely initialize page defined by class.
`<T extends Page> T`	`initPageSafely(T page)` Safely initialize already constructed page.
`boolean`	`isAt(Class<?> page)` Check if actual page is a given class.
`boolean`	`isNotPresent(org.openqa.selenium.WebElement element)` Returns true if element does not exists on actual page.
`boolean`	`isPresent(org.openqa.selenium.WebElement element)` Returns true if element exists on actual page.
`boolean`	`isReported()` Is storing files using browser enabled.
`boolean`	`isUrlVerification()` Is URL on pages verified?
`void`	`quit()` Quits browser and wrapped `WebDriver`.
`void`	`report(BrowserContext context, String label)` Triggers `OnReportEvent` with given context and label.
`void`	`saveFile(byte[] bytes, String name, String extension)` Saves bytes into named file with extension.
`void`	`saveFile(File file, String name, String extension)` Saves file into named file with extension.
`void`	`saveFile(String content, String name, String extension)` Saves string into named file with extension.
`void`	`setBaseUrl(String baseUrl)` Updates base URL
`void`	`setBaseUrlRegex(String baseUrlRegex)` Updates base URL regex
`void`	`setLabel(String... labels)` Modify browser label joining given labels.
`void`	`setLabel(String label)` Modify browser label
`void`	`setPage(Page page)` Sets actual browser page.
`void`	`setReported(boolean reported)` Toggles storing files using browser.
`void`	`setUrlVerification(boolean urlVerification)` Toggles pages URL verification.
`void`	`setWaitRetryInterval(double waitRetryInterval)` Sets default wait retry interval.
`void`	`setWaitTimeout(double waitTimeout)` Sets default wait timeout.
`void`	`triggerEvent(BrowserEvent event)` Triggers `BrowserEvent`.
`void`	`useEnclosingMethodLabel()` Sets label using enclosing method class name and method name.

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

Methods inherited from interface cz.etnetera.seleniumbrowser.browser.BrowserContext
constructBrowserElement, constructEvent, constructLogic, createElementLocator, createElementLocator, createElementLocator, find, find, find, findOne, findOne, findOne, findOne, findOneOptional, findOneOptional, findOneOptional, findOneOptional, getBrowser, getContext, getWrappedDriver, initBrowserElement, initElements, initLogic, report, waiting, waiting, waiting, waiting

Methods inherited from interface cz.etnetera.seleniumbrowser.source.PropertySource
castString, getProperty, getProperty, getProperty

Methods inherited from interface cz.etnetera.seleniumbrowser.source.DataSource
addData, getData, removeData

- Field Detail
  - PROPERTIES_CONFIGURATION_KEY
```
public static final String PROPERTIES_CONFIGURATION_KEY
```
    See Also:
    
    Constant Field Values
  - DEFAULT_CONFIGURATION_KEY
```
public static final String DEFAULT_CONFIGURATION_KEY
```
    See Also:
    
    Constant Field Values
  - LABEL_DELIMITER
```
public static final String LABEL_DELIMITER
```
    See Also:
    
    Constant Field Values
  - FILE_DATE_FORMATTER
```
public static final DateTimeFormatter FILE_DATE_FORMATTER
```
  - configuration
```
protected BrowserConfiguration configuration
```
  - driver
```
protected org.openqa.selenium.WebDriver driver
```
  - baseUrl
```
protected String baseUrl
```
  - baseUrlRegex
```
protected String baseUrlRegex
```
  - urlVerification
```
protected boolean urlVerification
```
  - waitTimeout
```
protected double waitTimeout
```
  - waitRetryInterval
```
protected double waitRetryInterval
```
  - page
```
protected Page page
```
  - label
```
protected String label
```
  - reported
```
protected boolean reported
```
  - reportDir
```
protected File reportDir
```
  - listeners
```
protected List<BrowserListener> listeners
```
  - dataHolder
```
protected Map<String,Object> dataHolder
```
  - utils
```
protected BrowserUtils utils
```
  - elementLoader
```
protected BrowserElementLoader elementLoader
```
  - javascriptLibrary
```
protected com.thoughtworks.selenium.webdriven.JavascriptLibrary javascriptLibrary
```
- Constructor Detail
  - Browser
```
public Browser()
```
    Constructs a new instance with default configuration. It constructs BrowserConfiguration with system properties using System.getProperties() and properties from resource named seleniumbrowser.properties.
  - Browser
```
public Browser(Class<T> configCls)
```
    Constructs a new instance with configuration constructed from given class. Configuration class needs to have constructor with no parameters.
  - Browser
```
public Browser(BrowserConfiguration configuration)
```
    Constructs a new instance and configures it.
    
    Parameters:
    
    configuration - The configuration
- Method Detail
  - initDefault
```
protected void initDefault()
```
  - init
```
protected <T extends BrowserConfiguration> void init(Class<T> configCls)
```
  - init
```
protected void init(BrowserConfiguration configuration)
```
  - applyConfiguration
```
protected void applyConfiguration(BrowserConfiguration configuration)
```
  - initListeners
```
protected void initListeners()
```
  - createDriver
```
protected org.openqa.selenium.WebDriver createDriver()
```
  - addListener
```
public void addListener(BrowserListener listener)
```
    Adds listener. It is automatically initiated.
    
    Parameters:
    
    listener - The added listener
  - getLabel
```
public String getLabel()
```
    Browser label which is mainly used for reporting.
    
    Returns:
    
    Browser label
  - setLabel
```
public void setLabel(String label)
```
    Modify browser label
    
    Parameters:
    
    label - Browser label
  - setLabel
```
public void setLabel(String... labels)
```
    Modify browser label joining given labels.
    
    Parameters:
    
    labels - Browser labels
  - getBaseUrl
```
public String getBaseUrl()
```
    Base URL for pages.
    
    Returns:
    
    The base URL
  - setBaseUrl
```
public void setBaseUrl(String baseUrl)
```
    Updates base URL
    
    Parameters:
    
    baseUrl - New base URL
  - getBaseUrlRegex
```
public String getBaseUrlRegex()
```
    Base URL regex for pages.
    
    Returns:
    
    The base URL regex
  - setBaseUrlRegex
```
public void setBaseUrlRegex(String baseUrlRegex)
```
    Updates base URL regex
    
    Parameters:
    
    baseUrlRegex - New base URL regex
  - isUrlVerification
```
public boolean isUrlVerification()
```
    Is URL on pages verified?
    
    Returns:
    
    Verification status
  - setUrlVerification
```
public void setUrlVerification(boolean urlVerification)
```
    Toggles pages URL verification.
    
    Parameters:
    
    urlVerification - The new status
  - getWaitTimeout
```
public double getWaitTimeout()
```
    Description copied from interface: BrowserContext
    
    Returns default wait timeout.
    
    Specified by:
    
    getWaitTimeout in interface BrowserContext
    
    Returns:
    
    The default wait timeout.
  - setWaitTimeout
```
public void setWaitTimeout(double waitTimeout)
```
    Sets default wait timeout.
    
    Parameters:
    
    waitTimeout - The default wait timeout.
  - getWaitRetryInterval
```
public double getWaitRetryInterval()
```
    Description copied from interface: BrowserContext
    
    Returns default wait retry interval.
    
    Specified by:
    
    getWaitRetryInterval in interface BrowserContext
    
    Returns:
    
    The default wait retry interval.
  - setWaitRetryInterval
```
public void setWaitRetryInterval(double waitRetryInterval)
```
    Sets default wait retry interval.
    
    Parameters:
    
    waitRetryInterval - The default wait retry interval.
  - isReported
```
public boolean isReported()
```
    Is storing files using browser enabled.
    
    Returns:
    
    Reporting status.
  - setReported
```
public void setReported(boolean reported)
```
    Toggles storing files using browser.
    
    Parameters:
    
    reported - The reported status.
  - getReportDir
```
public File getReportDir()
```
    Returns reporting directory, which is used as root directory for files stored using BrowserContext.saveFile(File, String, String) and similar methods.
    
    Returns:
    
    The reporting directory
  - getUtils
```
public BrowserUtils getUtils()
```
    Returns utils instance.
    
    Specified by:
    
    getUtils in interface BrowserContext
    
    Returns:
    
    The utils instance
  - getElementLoader
```
public BrowserElementLoader getElementLoader()
```
  - getJavascriptLibrary
```
public com.thoughtworks.selenium.webdriven.JavascriptLibrary getJavascriptLibrary()
```
  - createElementLocator
```
public org.openqa.selenium.support.pagefactory.ElementLocator createElementLocator(org.openqa.selenium.SearchContext searchContext,
                                                                                   Field field)
```
  - createElementLocator
```
public org.openqa.selenium.support.pagefactory.ElementLocator createElementLocator(org.openqa.selenium.SearchContext searchContext,
                                                                                   org.openqa.selenium.By by)
```
  - createElementLocator
```
public org.openqa.selenium.support.pagefactory.ElementLocator createElementLocator(org.openqa.selenium.SearchContext searchContext,
                                                                                   org.openqa.selenium.By by,
                                                                                   boolean lookupCached)
```
  - quit
```
public void quit()
```
    Quits browser and wrapped WebDriver.
  - useEnclosingMethodLabel
```
public void useEnclosingMethodLabel()
```
    Sets label using enclosing method class name and method name.
  - report
```
public void report(BrowserContext context,
                   String label)
```
    Triggers OnReportEvent with given context and label.
    
    Parameters:
    
    context - The report context
    
    label - The report label
  - constructEvent
```
public <T extends BrowserEvent> T constructEvent(Class<T> eventCls,
                                                 BrowserContext context)
```
    Constructs a new instance of BrowserEvent subclass with given context and local time.
    
    Parameters:
    
    eventCls - The event class to construct
    
    context - The context to use
    
    Returns:
    
    The event instance
  - getContext
```
public BrowserContext getContext()
```
    Description copied from interface: BrowserContext
    
    Returns parent BrowserContext instance.
    
    Specified by:
    
    getContext in interface BrowserContext
    
    Returns:
    
    The parent browser context.
  - getBrowser
```
public Browser getBrowser()
```
    Description copied from interface: BrowserContext
    
    Returns Browser instance.
    
    Specified by:
    
    getBrowser in interface BrowserContext
    
    Returns:
    
    The browser
  - getConfiguration
```
public BrowserConfiguration getConfiguration()
```
    Description copied from interface: BrowserContext
    
    Returns BrowserConfiguration instance.
    
    Specified by:
    
    getConfiguration in interface BrowserContext
    
    Returns:
    
    The browser configuration
  - getConfiguration
```
public <T> T getConfiguration(Class<T> configuration)
```
    Description copied from interface: BrowserContext
    
    Returns BrowserConfiguration instance casted to specific type.
    
    Specified by:
    
    getConfiguration in interface BrowserContext
    
    Returns:
    
    The browser configuration
  - getDriver
```
public org.openqa.selenium.WebDriver getDriver()
```
    Description copied from interface: BrowserContext
    
    Returns wrapped WebDriver instance.
    
    Specified by:
    
    getDriver in interface BrowserContext
    
    Returns:
    
    The driver
  - getDriver
```
public <T> T getDriver(Class<T> driver)
```
    Description copied from interface: BrowserContext
    
    Returns wrapped WebDriver instance casted to specific type.
    
    Specified by:
    
    getDriver in interface BrowserContext
    
    Returns:
    
    The driver
  - getPage
```
public Page getPage()
```
    Description copied from interface: BrowserContext
    
    Returns actual page or null if browser has no page initiated.
    
    Specified by:
    
    getPage in interface BrowserContext
    
    Returns:
    
    The actual page or null
  - getPage
```
public <T> T getPage(Class<T> page)
```
    Description copied from interface: BrowserContext
    
    Returns actual page casted to given type or null if browser has no page initiated.
    
    Specified by:
    
    getPage in interface BrowserContext
    
    Parameters:
    
    page - The class to cast the page to
    
    Returns:
    
    The actual page or null
  - setPage
```
public void setPage(Page page)
```
    Description copied from interface: BrowserContext
    
    Sets actual browser page.
    
    Specified by:
    
    setPage in interface BrowserContext
    
    Parameters:
    
    page - The page to set
  - isAt
```
public boolean isAt(Class<?> page)
```
    Description copied from interface: BrowserContext
    
    Check if actual page is a given class. It performs no other redirection or verification.
    
    Specified by:
    
    isAt in interface BrowserContext
    
    Parameters:
    
    page - The class to check the page against
    
    Returns:
    
    true if actual page is instance of given class
  - assertAt
```
public void assertAt(Class<?> page)
```
    Description copied from interface: BrowserContext
    
    Asserts that actual page is a given class. It performs no other redirection or verification. Throws AssertionError if condition did not pass.
    
    Specified by:
    
    assertAt in interface BrowserContext
    
    Parameters:
    
    page - The class to check the page against
  - goToSafely
```
public <T extends Page> T goToSafely(Class<T> page)
```
    Description copied from interface: BrowserContext
    
    Safely go to page defined by class. Page is automatically verified against its conditions. If verification fails null is returned.
    
    Specified by:
    
    goToSafely in interface BrowserContext
    
    Parameters:
    
    page - The page class to go to
    
    Returns:
    
    The page instance or null if page is not verified
  - goToSafely
```
public <T extends Page> T goToSafely(T page)
```
    Description copied from interface: BrowserContext
    
    Safely go to already constructed page. Page is automatically verified against its conditions. If verification fails null is returned.
    
    Specified by:
    
    goToSafely in interface BrowserContext
    
    Parameters:
    
    page - The page instance to go to
    
    Returns:
    
    The same page instance or null if page is not verified
  - initPageSafely
```
public <T extends Page> T initPageSafely(Class<T> page)
```
    Description copied from interface: BrowserContext
    
    Safely initialize page defined by class. It stays on same URL and tries to initialize the page. Page is automatically verified against its conditions. If verification fails null is returned.
    
    Specified by:
    
    initPageSafely in interface BrowserContext
    
    Parameters:
    
    page - The page class to initialize
    
    Returns:
    
    The page instance or null if page is not verified
  - initPageSafely
```
public <T extends Page> T initPageSafely(T page)
```
    Description copied from interface: BrowserContext
    
    Safely initialize already constructed page. It stays on same URL and tries to initialize the page. Page is automatically verified against its conditions. If verification fails null is returned.
    
    Specified by:
    
    initPageSafely in interface BrowserContext
    
    Parameters:
    
    page - The page instance to initialize
    
    Returns:
    
    The same page instance or null if page is not verified
  - initOnePageSafely
```
public Page initOnePageSafely(Object... pages)
```
    Description copied from interface: BrowserContext
    
    Safely initialize first of matching page. Pages can be defined as class or as Page instances. It iterates over all pages and tries to initialize and verify them. First verified page is returned. If none of the pages is verified null is returned.
    
    Specified by:
    
    initOnePageSafely in interface BrowserContext
    
    Parameters:
    
    pages - The page classes or pages to initialize
    
    Returns:
    
    The same page instance or null if none of pages is verified
  - goTo
```
public <T extends Page> T goTo(Class<T> page)
```
    Description copied from interface: BrowserContext
    
    Go to page defined by class. Page is automatically verified against its conditions.
    
    Specified by:
    
    goTo in interface BrowserContext
    
    Parameters:
    
    page - The page class to go to
    
    Returns:
    
    The page instance
  - goTo
```
public <T extends Page> T goTo(T page)
```
    Description copied from interface: BrowserContext
    
    Go to already constructed page. Page is automatically verified against its conditions.
    
    Specified by:
    
    goTo in interface BrowserContext
    
    Parameters:
    
    page - The page instance to go to
    
    Returns:
    
    The same page instance
  - initPage
```
public <T extends Page> T initPage(Class<T> page)
```
    Description copied from interface: BrowserContext
    
    Initialize page defined by class. It stays on same URL and tries to initialize the page. Page is automatically verified against its conditions.
    
    Specified by:
    
    initPage in interface BrowserContext
    
    Parameters:
    
    page - The page class to initialize
    
    Returns:
    
    The page instance
  - initPage
```
public <T extends Page> T initPage(T page)
```
    Description copied from interface: BrowserContext
    
    Initialize already constructed page. It stays on same URL and tries to initialize the page. Page is automatically verified against its conditions.
    
    Specified by:
    
    initPage in interface BrowserContext
    
    Parameters:
    
    page - The page instance to initialize
    
    Returns:
    
    The same page instance
  - initOnePage
```
public Page initOnePage(Object... pages)
```
    Description copied from interface: BrowserContext
    
    Initialize first of matching page. Pages can be defined as class or as Page instances. It iterates over all pages and tries to initialize and verify them. First verified page is returned. If none of the pages is verified VerificationException is thrown.
    
    Specified by:
    
    initOnePage in interface BrowserContext
    
    Parameters:
    
    pages - The page classes or pages to initialize
    
    Returns:
    
    The same page instance
  - constructPage
```
public <T extends Page> T constructPage(Class<T> page)
```
    Description copied from interface: BrowserContext
    
    Construct page defined by class.
    
    Specified by:
    
    constructPage in interface BrowserContext
    
    Parameters:
    
    page - The page class to construct
    
    Returns:
    
    The page instance
  - initBrowserElement
```
public <T extends BrowserElement> T initBrowserElement(T element)
```
    Description copied from interface: BrowserContext
    
    Initialize already constructed element.
    
    Specified by:
    
    initBrowserElement in interface BrowserContext
    
    Parameters:
    
    element - The element instance to initialize
    
    Returns:
    
    The same element instance
  - initBrowserElement
```
public <T extends BrowserElement> T initBrowserElement(Class<T> element,
                                                       BrowserContext context,
                                                       org.openqa.selenium.WebElement webElement,
                                                       boolean optional)
```
  - constructBrowserElement
```
public <T extends BrowserElement> T constructBrowserElement(Class<T> element,
                                                            BrowserContext context,
                                                            org.openqa.selenium.WebElement webElement,
                                                            boolean optional)
```
  - initLogic
```
public <T extends Logic> T initLogic(T logic)
```
    Description copied from interface: BrowserContext
    
    Initialize logic defined by class.
    
    Specified by:
    
    initLogic in interface BrowserContext
    
    Parameters:
    
    logic - The logic instance to initialize
    
    Returns:
    
    The same logic instance
  - initLogic
```
public <T extends Logic> T initLogic(Class<T> logic,
                                     BrowserContext context)
```
  - constructLogic
```
public <T extends Logic> T constructLogic(Class<T> logic,
                                          BrowserContext context)
```
  - initElements
```
public void initElements(BrowserContext context)
```
  - checkIfPresent
```
public void checkIfPresent(org.openqa.selenium.WebElement element)
                    throws org.openqa.selenium.NoSuchElementException
```
    Description copied from interface: BrowserContext
    
    Checks if element exists on actual page. If is present it does nothing. Otherwise throws NoSuchElementException.
    
    Specified by:
    
    checkIfPresent in interface BrowserContext
    
    Parameters:
    
    element - The element to test
    
    Throws:
    
    org.openqa.selenium.NoSuchElementException - if element is not present
  - isPresent
```
public boolean isPresent(org.openqa.selenium.WebElement element)
```
    Description copied from interface: BrowserContext
    
    Returns true if element exists on actual page. It is opposite to BrowserContext.isNotPresent(WebElement).
    
    Specified by:
    
    isPresent in interface BrowserContext
    
    Parameters:
    
    element - The element to test
    
    Returns:
    
    true if element is present
  - isNotPresent
```
public boolean isNotPresent(org.openqa.selenium.WebElement element)
```
    Description copied from interface: BrowserContext
    
    Returns true if element does not exists on actual page. It is opposite to BrowserContext.isPresent(WebElement).
    
    Specified by:
    
    isNotPresent in interface BrowserContext
    
    Parameters:
    
    element - The element to test
    
    Returns:
    
    true if element is not present
  - findElements
```
public List<org.openqa.selenium.WebElement> findElements(org.openqa.selenium.By by)
```
    Specified by:
    
    findElements in interface org.openqa.selenium.SearchContext
  - findElement
```
public org.openqa.selenium.WebElement findElement(org.openqa.selenium.By by)
```
    Specified by:
    
    findElement in interface org.openqa.selenium.SearchContext
  - find
```
public <T extends BrowserElement> List<T> find(BrowserContext context,
                                               org.openqa.selenium.By by,
                                               Class<T> elementCls)
```
    Description copied from interface: BrowserContext
    
    Find all elements within the given context using the given mechanism as instances of the given BrowserElement or its subclass.
    
    Specified by:
    
    find in interface BrowserContext
    
    Parameters:
    
    context - The browser context to search in
    
    by - The locating mechanism to use
    
    elementCls - The element class
    
    Returns:
    
    A list of all BrowserElements as instances of the given BrowserElement or its subclass, or an empty list if nothing matches
  - findOne
```
public <T extends BrowserElement> T findOne(BrowserContext context,
                                            org.openqa.selenium.By by,
                                            Class<T> elementCls,
                                            boolean optional)
```
    Description copied from interface: BrowserContext
    
    Find the first element within the given context using the given mechanism as instance of the given BrowserElement or its subclass. If optional is true and no matching elements are found null is returned instead of throwing NoSuchElementException.
    
    Specified by:
    
    findOne in interface BrowserContext
    
    Parameters:
    
    context - The browser context to search in
    
    by - The locating mechanism
    
    elementCls - The element class
    
    optional - true for returning null instead of throwing NoSuchElementException if no matching elements are found
    
    Returns:
    
    The first matching element on the given context as instance of the given BrowserElement or its subclass
  - goToUrl
```
public void goToUrl(String url)
```
    Description copied from interface: BrowserContext
    
    Go to specific URL.
    
    Specified by:
    
    goToUrl in interface BrowserContext
    
    Parameters:
    
    url - The URL to go to
  - triggerEvent
```
public void triggerEvent(BrowserEvent event)
```
    Description copied from interface: BrowserContext
    
    Triggers BrowserEvent.
    
    Specified by:
    
    triggerEvent in interface BrowserContext
    
    Parameters:
    
    event - The triggered event
  - getDataHolder
```
public Map<String,Object> getDataHolder()
```
    Description copied from interface: DataSource
    
    Returns map which holds data.
    
    Specified by:
    
    getDataHolder in interface BrowserContext
    
    Specified by:
    
    getDataHolder in interface DataSource
    
    Returns:
    
    The data holder map
  - getProperty
```
public String getProperty(String key)
```
    Description copied from interface: PropertySource
    
    Returns property as String.
    
    Specified by:
    
    getProperty in interface BrowserContext
    
    Specified by:
    
    getProperty in interface PropertySource
    
    Parameters:
    
    key - The property key.
    
    Returns:
    
    The property value or null.
  - saveFile
```
public void saveFile(String content,
                     String name,
                     String extension)
```
    Description copied from interface: BrowserContext
    
    Saves string into named file with extension. It uses getFilePath(String, String). If isReported() is false no file is saved.
    
    Specified by:
    
    saveFile in interface BrowserContext
    
    Parameters:
    
    content - The string content to save.
    
    name - The file name without extension.
    
    extension - The file extension.
  - saveFile
```
public void saveFile(byte[] bytes,
                     String name,
                     String extension)
```
    Description copied from interface: BrowserContext
    
    Saves bytes into named file with extension. It uses getFilePath(String, String). If isReported() is false no file is saved.
    
    Specified by:
    
    saveFile in interface BrowserContext
    
    Parameters:
    
    bytes - The bytes to save.
    
    name - The file name without extension.
    
    extension - The file extension.
  - saveFile
```
public void saveFile(File file,
                     String name,
                     String extension)
```
    Description copied from interface: BrowserContext
    
    Saves file into named file with extension. It uses getFilePath(String, String). If isReported() is false no file is saved.
    
    Specified by:
    
    saveFile in interface BrowserContext
    
    Parameters:
    
    file - The file to save.
    
    name - The file name without extension.
    
    extension - The file extension.
  - getFilePath
```
protected Path getFilePath(String name,
                           String extension)
```
  - getUniqueFilePath
```
protected Path getUniqueFilePath(String name,
                                 String extension)
```
  - escapeFileName
```
protected String escapeFileName(String name)
```

Class Browser

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface cz.etnetera.seleniumbrowser.browser.BrowserContext

Methods inherited from interface cz.etnetera.seleniumbrowser.source.PropertySource

Methods inherited from interface cz.etnetera.seleniumbrowser.source.DataSource

Field Detail

PROPERTIES_CONFIGURATION_KEY

DEFAULT_CONFIGURATION_KEY

LABEL_DELIMITER

FILE_DATE_FORMATTER

configuration

driver

baseUrl

baseUrlRegex

urlVerification

waitTimeout

waitRetryInterval

page

label

reported

reportDir

listeners

dataHolder

utils

elementLoader

javascriptLibrary

Constructor Detail

Browser

Browser

Browser

Method Detail

initDefault

init

init

applyConfiguration

initListeners

createDriver

addListener

getLabel

setLabel

setLabel

getBaseUrl

setBaseUrl

getBaseUrlRegex

setBaseUrlRegex

isUrlVerification

setUrlVerification

getWaitTimeout

setWaitTimeout

getWaitRetryInterval

setWaitRetryInterval

isReported

setReported

getReportDir

getUtils

getElementLoader

getJavascriptLibrary

createElementLocator

createElementLocator

createElementLocator

quit

useEnclosingMethodLabel

report

constructEvent

getContext

getBrowser

getConfiguration

getConfiguration

getDriver

getDriver

getPage

getPage

setPage

isAt

assertAt

goToSafely

goToSafely