se.claremont.taf.websupport

Class DomElement

java.lang.Object

se.claremont.taf.websupport.DomElement

All Implemented Interfaces:

Serializable, GuiElement

public class DomElement
extends Object
implements GuiElement, Serializable

Object declaration mechanisms for web elements

Created by jordam on 2016-08-17.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DomElement.IdentificationType Identification mechanisms

Field Summary

Fields

Modifier and Type	Field and Description
By	by
DomElement.IdentificationType	identificationType
String	name
Integer	ordinalNumber
List<String>	recognitionStrings

Constructor Summary

Constructors

Constructor and Description
DomElement(By by) Declares a DOM element on a web page, for use in automation.
DomElement(org.openqa.selenium.By seleniumBy) Please, use the more powerful se.claremont.autotest.websupport.elementidentification.By instead.
DomElement(By by, String name) Declares a DOM element on a web page, for use in automation.
DomElement(PositionBasedWebElement positionBasedWebElement) Defines a DOM element on a web page, based on its relative position with other elements on the page.
DomElement(String json)
DomElement(String[] alternativeRecognitionStrings, DomElement.IdentificationType identificationType) Constructor for use for example with several languages.
DomElement(String[] alternativeRecognitionStrings, DomElement.IdentificationType identificationType, Integer ordinalNumber) Constructor for use for example with several languages.
DomElement(String[] alternativeRecognitionStrings, DomElement.IdentificationType identificationType, Integer ordinalNumber, String name) Constructor for use for example with several languages.
DomElement(String[] alternativeRecognitionStrings, DomElement.IdentificationType identificationType, String name) Constructor for use for example with several languages.
DomElement(String recognitionString, DomElement.IdentificationType identificationType) Declares a DOM element to be used in test execution.
DomElement(String recognitionString, DomElement.IdentificationType identificationType, Integer ordinalNumber) Declares a DOM element to be used in test execution.
DomElement(String recognitionString, DomElement.IdentificationType identificationType, Integer ordinalNumber, String name) Declares a DOM element to be used in test execution.
DomElement(String recognitionString, DomElement.IdentificationType identificationType, String name) Declares a DOM element to be used in test execution.
DomElement(org.openqa.selenium.WebElement webElement) Defines a DOM element based on the given Selenium WebElement.
DomElement(org.openqa.selenium.WebElement webElement, String elementName, String elementPageName) Defines a DOM element based on the given Selenium WebElement.

Method Summary

Modifier and Type	Method and Description
PositionBasedWebElement	asPositionBasedWebElement(WebInteractionMethods web) Converts a DomElement to a PositionBasedWebElement.
DomElement	getDomElementFromDescendants(DomElement domElement, WebInteractionMethods web) Searches the descendants for the given DOM element, using the WebInteractionMethods given.
String	getElementXPath(org.openqa.selenium.WebElement element) Retrieves the xpath of the current element, in the current browser, and with the current web page structure.
String	LogIdentification() Enables unified logging formats for element references in the testCaseLog.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

name

public String name

by

public By by

recognitionStrings

public List<String> recognitionStrings

identificationType

public DomElement.IdentificationType identificationType

ordinalNumber

public Integer ordinalNumber

Constructor Detail

DomElement

public DomElement(By by)

Declares a DOM element on a web page, for use in automation.

Parameters:

by - Describes how to identify the DOM element.

DomElement

public DomElement(String json)

DomElement

public DomElement(org.openqa.selenium.By seleniumBy)

Please, use the more powerful se.claremont.autotest.websupport.elementidentification.By instead. This constructor converts the Selenium By to the TAF By class. With this you get the logging of TAF, but not the flexibility and versatility of the TAF By class.

Parameters:

seleniumBy - Regular Selenium By statement.

DomElement

public DomElement(By by,
                  String name)

Declares a DOM element on a web page, for use in automation.

Parameters:

by - Describes how to identify the DOM element.

name - The element name, to be used in logs.

DomElement

public DomElement(org.openqa.selenium.WebElement webElement)

Defines a DOM element based on the given Selenium WebElement.

Parameters:

webElement - The Selenium WebElement to use as base for this DomElement.

DomElement

public DomElement(org.openqa.selenium.WebElement webElement,
                  String elementName,
                  String elementPageName)

Defines a DOM element based on the given Selenium WebElement.

Parameters:

webElement - Selenium WebElement object.

elementName - The name for the element, for use in logs.

elementPageName - The name of the page of the element, for use in logs.

DomElement

public DomElement(String recognitionString,
                  DomElement.IdentificationType identificationType,
                  String name)

Declares a DOM element to be used in test execution.

Parameters:

recognitionString - the recognition string that identifies the object.

identificationType - what mechanism to use for identification.

name - Element name, for logging.

DomElement

public DomElement(String recognitionString,
                  DomElement.IdentificationType identificationType)

Declares a DOM element to be used in test execution.

Parameters:

recognitionString - the recognition string that identifies the object.

identificationType - what mechanism to use for identification.

DomElement

public DomElement(String[] alternativeRecognitionStrings,
                  DomElement.IdentificationType identificationType,
                  String name)

Constructor for use for example with several languages.

Parameters:

alternativeRecognitionStrings - An array of recognition strings for this element.

identificationType - The method of identification.

name - Element name, for logging.

DomElement

public DomElement(String[] alternativeRecognitionStrings,
                  DomElement.IdentificationType identificationType)

Constructor for use for example with several languages.

Parameters:

alternativeRecognitionStrings - An array of recognition strings for this element.

identificationType - The method of identification.

DomElement

public DomElement(String recognitionString,
                  DomElement.IdentificationType identificationType,
                  Integer ordinalNumber,
                  String name)

Declares a DOM element to be used in test execution.

Parameters:

recognitionString - the recognition string that identifies the object.

identificationType - what mechanism to use for identification.

ordinalNumber - The ordinal number of the occurrence on the web page, if multiple matches for search criteria.

name - Element name, for logging.

DomElement

public DomElement(String recognitionString,
                  DomElement.IdentificationType identificationType,
                  Integer ordinalNumber)

Declares a DOM element to be used in test execution.

Parameters:

recognitionString - the recognition string that identifies the object.

identificationType - what mechanism to use for identification.

ordinalNumber - The ordinal number of the occurrence on the web page, if multiple matches for search criteria.

DomElement

public DomElement(String[] alternativeRecognitionStrings,
                  DomElement.IdentificationType identificationType,
                  Integer ordinalNumber,
                  String name)

Constructor for use for example with several languages.

Parameters:

alternativeRecognitionStrings - An array of recognition strings for this element.

identificationType - The method of identification.

ordinalNumber - The ordinal number of the occurrence on the web page, if multiple matches for search criteria.

name - Element name, for logging.

DomElement

public DomElement(String[] alternativeRecognitionStrings,
                  DomElement.IdentificationType identificationType,
                  Integer ordinalNumber)

Constructor for use for example with several languages.

Parameters:

alternativeRecognitionStrings - An array of recognition strings for this element.

identificationType - The method of identification.

ordinalNumber - The ordinal number of the occurrence on the web page, if multiple matches for search criteria.

DomElement

public DomElement(PositionBasedWebElement positionBasedWebElement)

Defines a DOM element on a web page, based on its relative position with other elements on the page.

Parameters:

positionBasedWebElement - A DOM element prepared for position based identification.

Method Detail

getDomElementFromDescendants

public DomElement getDomElementFromDescendants(DomElement domElement,
                                               WebInteractionMethods web)

Searches the descendants for the given DOM element, using the WebInteractionMethods given.

Parameters:

domElement - The DOM element that should exist among the descendants of this element.

web - WebInteractionMethods to use.

Returns:

Returns the DomElement, for later use.

asPositionBasedWebElement

public PositionBasedWebElement asPositionBasedWebElement(WebInteractionMethods web)

Converts a DomElement to a PositionBasedWebElement.

Parameters:

web - WebInteractionMethods to use.

Returns:

Returns this element as a PositionBasedWebElement.

getElementXPath

public String getElementXPath(org.openqa.selenium.WebElement element)

Retrieves the xpath of the current element, in the current browser, and with the current web page structure. Remember that different web browsers parses the DOM differently, giving different xpaths. Hence this method should only be used for runtime xpath context, not permanent declarations.

Parameters:

element - The Selenium WebElement object to find the xpath for.

Returns:

Returns the xpath as a String object.

LogIdentification

public String LogIdentification()

Enables unified logging formats for element references in the testCaseLog.

Returns:

a string to use in testCaseLog posts.

toString

public String toString()

Overrides:

toString in class Object