com.applitools.eyes.selenium.wrappers

Class EyesTargetLocator

java.lang.Object

com.applitools.eyes.selenium.wrappers.EyesTargetLocator

All Implemented Interfaces:

org.openqa.selenium.WebDriver.TargetLocator

public class EyesTargetLocator
extends Object
implements org.openqa.selenium.WebDriver.TargetLocator

Wraps a target locator so we can keep track of which frames have been switched to.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	EyesTargetLocator.TargetType An enum for the different types of frames we can switch into.

Constructor Summary

Constructors

Constructor and Description
EyesTargetLocator(Logger logger, EyesWebDriver driver, org.openqa.selenium.WebDriver.TargetLocator targetLocator) Initialized a new EyesTargetLocator object.

Method Summary

Modifier and Type	Method and Description
org.openqa.selenium.WebElement	activeElement()
org.openqa.selenium.Alert	alert()
org.openqa.selenium.WebDriver	defaultContent()
org.openqa.selenium.WebDriver	frame(int index)
org.openqa.selenium.WebDriver	frame(String nameOrId)
org.openqa.selenium.WebDriver	frame(org.openqa.selenium.WebElement frameElement)
org.openqa.selenium.WebDriver	frames(FrameChain frameChain) Switches into every frame in the frame chain.
org.openqa.selenium.WebDriver	frames(String[] framesPath) Switches into every frame in the list.
org.openqa.selenium.WebDriver	parentFrame()
void	willSwitchToFrame(EyesTargetLocator.TargetType targetType, org.openqa.selenium.WebElement targetFrame) Will be called before switching into a frame.
void	willSwitchToWindow(String nameOrHandle) Will be called before switching into a window.
org.openqa.selenium.WebDriver	window(String nameOrHandle)

Methods inherited from class java.lang.Object

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

Constructor Detail

EyesTargetLocator

public EyesTargetLocator(Logger logger,
                         EyesWebDriver driver,
                         org.openqa.selenium.WebDriver.TargetLocator targetLocator)

Initialized a new EyesTargetLocator object.

Parameters:

driver - The WebDriver from which the targetLocator was received.

targetLocator - The actual TargetLocator object.

Method Detail

willSwitchToFrame

public void willSwitchToFrame(EyesTargetLocator.TargetType targetType,
                              org.openqa.selenium.WebElement targetFrame)

Will be called before switching into a frame.

Parameters:

targetType - The type of frame we're about to switch into.

targetFrame - The element about to be switched to, if available. Otherwise, null.

willSwitchToWindow

public void willSwitchToWindow(String nameOrHandle)

Will be called before switching into a window.

Parameters:

nameOrHandle - The name/handle of the window to be switched to.

frame

public org.openqa.selenium.WebDriver frame(int index)

Specified by:

frame in interface org.openqa.selenium.WebDriver.TargetLocator

frame

public org.openqa.selenium.WebDriver frame(String nameOrId)

Specified by:

frame in interface org.openqa.selenium.WebDriver.TargetLocator

frame

public org.openqa.selenium.WebDriver frame(org.openqa.selenium.WebElement frameElement)

Specified by:

frame in interface org.openqa.selenium.WebDriver.TargetLocator

parentFrame

public org.openqa.selenium.WebDriver parentFrame()

Specified by:

parentFrame in interface org.openqa.selenium.WebDriver.TargetLocator

frames

public org.openqa.selenium.WebDriver frames(FrameChain frameChain)

Switches into every frame in the frame chain. This is used as way to switch into nested frames (while considering scroll) in a single call.

Parameters:

frameChain - The path to the frame to switch to.

Returns:

The WebDriver with the switched context.

frames

public org.openqa.selenium.WebDriver frames(String[] framesPath)

Switches into every frame in the list. This is used as way to switch into nested frames in a single call.

Parameters:

framesPath - The path to the frame to check. This is a list of frame names/IDs (where each frame is nested in the previous frame).

Returns:

The WebDriver with the switched context.

window

public org.openqa.selenium.WebDriver window(String nameOrHandle)

Specified by:

window in interface org.openqa.selenium.WebDriver.TargetLocator

defaultContent

public org.openqa.selenium.WebDriver defaultContent()

Specified by:

defaultContent in interface org.openqa.selenium.WebDriver.TargetLocator

activeElement

public org.openqa.selenium.WebElement activeElement()

Specified by:

activeElement in interface org.openqa.selenium.WebDriver.TargetLocator

alert

public org.openqa.selenium.Alert alert()

Specified by:

alert in interface org.openqa.selenium.WebDriver.TargetLocator