ru.yandex.qatools.htmlelements.loader

Class HtmlElementLoader

java.lang.Object

ru.yandex.qatools.htmlelements.loader.HtmlElementLoader

public class HtmlElementLoader
extends Object

Contains methods for blocks of elements initialization and page objects initialization.

Author:

Alexander Tolmachev starlight@yandex-team.ru Date: 13.08.12

Constructor Summary

Constructors

Constructor and Description
HtmlElementLoader()

Method Summary

Modifier and Type	Method and Description
static <T> T	create(Class<T> clazz, org.openqa.selenium.WebDriver driver) Creates and initializes a block of elements if the given class is HtmlElement or its successor and initializes page object otherwise.
static <T extends HtmlElement> T	createHtmlElement(Class<T> clazz, org.openqa.selenium.SearchContext searchContext) Creates an instance of the given class representing a block of elements and initializes its fields with lazy proxies.
static <T extends HtmlElement> T	createHtmlElement(Class<T> elementClass, org.openqa.selenium.WebElement elementToWrap, String name)
static <T> T	createPageObject(Class<T> clazz, org.openqa.selenium.WebDriver driver) Creates an instance of the given page object class and initializes its fields with lazy proxies.
static <T extends TypifiedElement> T	createTypifiedElement(Class<T> clazz, org.openqa.selenium.SearchContext searchContext)
static <T extends TypifiedElement> T	createTypifiedElement(Class<T> elementClass, org.openqa.selenium.WebElement elementToWrap, String name)
static <T> void	populate(T instance, org.openqa.selenium.WebDriver driver) Initializes instance as a block of elements it is instance of HtmlElement or its successor and as a page object otherwise.
static void	populateHtmlElement(HtmlElement htmlElement, CustomElementLocatorFactory locatorFactory) Initializes fields of the given block of elements using specified locator factory.
static void	populateHtmlElement(HtmlElement htmlElement, org.openqa.selenium.SearchContext searchContext) Initializes fields of the given block of elements with lazy proxies.
static void	populatePageObject(Object page, CustomElementLocatorFactory locatorFactory) Initializes fields of the given page object using specified locator factory.
static void	populatePageObject(Object page, org.openqa.selenium.SearchContext searchContext) Initializes fields of the given page object with lazy proxies.

Methods inherited from class java.lang.Object

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

Constructor Detail

HtmlElementLoader

public HtmlElementLoader()

Method Detail

create

public static <T> T create(Class<T> clazz,
                           org.openqa.selenium.WebDriver driver)

Creates and initializes a block of elements if the given class is HtmlElement or its successor and initializes page object otherwise.

Parameters:

clazz - A class to be instantiated and initialized.

driver - The WebDriver instance that will be used to look up the elements.

Returns:

Initialized instance of the specified class.

See Also:

createHtmlElement(Class, SearchContext), createPageObject(Class, WebDriver)

populate

public static <T> void populate(T instance,
                                org.openqa.selenium.WebDriver driver)

Initializes instance as a block of elements it is instance of HtmlElement or its successor and as a page object otherwise.

Parameters:

instance - Object to be initialized.

driver - The WebDriver instance that will be used to look up the elements.

See Also:

populateHtmlElement(HtmlElement, SearchContext), createPageObject(Class, WebDriver)

createHtmlElement

public static <T extends HtmlElement> T createHtmlElement(Class<T> clazz,
                                                          org.openqa.selenium.SearchContext searchContext)

Creates an instance of the given class representing a block of elements and initializes its fields with lazy proxies. Processes annotation of the given class to set the way of locating the block itself and FindBy, FindBys and FindAll annotations of its fields for setting the way of locating elements of the block. Fields to be proxied:

• WebElement
• List of WebElements
• Block of elements (HtmlElement and its successors)
• List of blocks
• Typified element (TypifiedElement successors)
• List of typified elements

Parameters:

clazz - A class to be instantiated and initialized.

searchContext - SearchContext that will be used to look up the elements.

Returns:

Initialized instance of the specified class.

createHtmlElement

public static <T extends HtmlElement> T createHtmlElement(Class<T> elementClass,
                                                          org.openqa.selenium.WebElement elementToWrap,
                                                          String name)

createTypifiedElement

public static <T extends TypifiedElement> T createTypifiedElement(Class<T> clazz,
                                                                  org.openqa.selenium.SearchContext searchContext)

createTypifiedElement

public static <T extends TypifiedElement> T createTypifiedElement(Class<T> elementClass,
                                                                  org.openqa.selenium.WebElement elementToWrap,
                                                                  String name)

createPageObject

public static <T> T createPageObject(Class<T> clazz,
                                     org.openqa.selenium.WebDriver driver)

Creates an instance of the given page object class and initializes its fields with lazy proxies. Processes FindBy, FindBys and FindAll annotations of the fields for setting the way of locating them. Fields to be proxied:

• WebElement
• List of WebElements
• Block of elements (HtmlElement and its successors)
• List of blocks
• Typified element (TypifiedElement successors)
• List of typified elements

Parameters:

clazz - A class to be instantiated and initialized.

driver - The WebDriver instance that will be used to look up the elements.

Returns:

Initialized instance of the specified class.

populateHtmlElement

public static void populateHtmlElement(HtmlElement htmlElement,
                                       org.openqa.selenium.SearchContext searchContext)

Initializes fields of the given block of elements with lazy proxies. Processes annotation of the class of the given block to set the way of locating the block itself and FindBy, FindBys and FindAll annotations of its fields for setting the way of locating elements of the block. Fields to be proxied:

• WebElement
• List of WebElements
• Block of elements (HtmlElement and its successors)
• List of blocks
• Typified element (TypifiedElement successors)
• List of typified elements

Parameters:

htmlElement - Block of elements to be initialized.

searchContext - SearchContext that will be used to look up the elements.

populateHtmlElement

public static void populateHtmlElement(HtmlElement htmlElement,
                                       CustomElementLocatorFactory locatorFactory)

Initializes fields of the given block of elements using specified locator factory.

Parameters:

htmlElement - Block of elements to be initialized.

locatorFactory - Locator factory that will be used to locate block elements.

populatePageObject

public static void populatePageObject(Object page,
                                      org.openqa.selenium.SearchContext searchContext)

Initializes fields of the given page object with lazy proxies. Processes FindBy, FindBys and FindAll annotations of the fields for setting the way of locating them. Fields to be proxied:

• WebElement
• List of WebElements
• Block of elements (HtmlElement and its successors)
• List of blocks
• Typified element (TypifiedElement successors)
• List of typified elements

Parameters:

page - Page object to be initialized.

searchContext - The WebDriver instance that will be used to look up the elements.

populatePageObject

public static void populatePageObject(Object page,
                                      CustomElementLocatorFactory locatorFactory)

Initializes fields of the given page object using specified locator factory.

Parameters:

page - Page object to be initialized.

locatorFactory - Locator factory that will be used to locate elements.