com.applitools.eyes

Class FrameChain

java.lang.Object

com.applitools.eyes.FrameChain

All Implemented Interfaces:

Iterable<Frame>

public class FrameChain
extends Object
implements Iterable<Frame>

Represents a path to a frame, including their location and scroll.

Constructor Summary

Constructors

Constructor and Description
FrameChain(com.applitools.eyes.Logger logger) Creates a new frame chain.
FrameChain(com.applitools.eyes.Logger logger, FrameChain other) Creates a frame chain which is a copy of the current frame.

Method Summary

Modifier and Type	Method and Description
void	clear() Removes all current frames in the frame chain.
com.applitools.eyes.Location	getCurrentFrameOffset()
com.applitools.eyes.RectangleSize	getCurrentFrameSize()
com.applitools.eyes.Location	getDefaultContentScrollPosition()
static boolean	isSameFrameChain(FrameChain c1, FrameChain c2) Compares two frame chains.
Iterator<Frame>	iterator()
void	pop() Removes the last inserted frame element.
void	push(Frame frame) Appends a frame to the frame chain.
int	size()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

FrameChain

public FrameChain(com.applitools.eyes.Logger logger)

Creates a new frame chain.

Parameters:

logger - A Logger instance.

FrameChain

public FrameChain(com.applitools.eyes.Logger logger,
                  FrameChain other)

Creates a frame chain which is a copy of the current frame.

Parameters:

logger - A Logger instance.

other - A frame chain from which the current frame chain will be created.

Method Detail

isSameFrameChain

public static boolean isSameFrameChain(FrameChain c1,
                                       FrameChain c2)

Compares two frame chains.

Parameters:

c1 - Frame chain to be compared against c2.

c2 - Frame chain to be compared against c1.

Returns:

True if both frame chains represent the same frame, false otherwise.

size

public int size()

Returns:

The number of frames in the chain.

clear

public void clear()

Removes all current frames in the frame chain.

pop

public void pop()

Removes the last inserted frame element. Practically means we switched back to the parent of the current frame

push

public void push(Frame frame)

Appends a frame to the frame chain.

Parameters:

frame - The frame to be added.

getCurrentFrameOffset

public com.applitools.eyes.Location getCurrentFrameOffset()

Returns:

The location of the current frame in the page.

getDefaultContentScrollPosition

public com.applitools.eyes.Location getDefaultContentScrollPosition()

Returns:

The outermost frame's location, or NoFramesException.

getCurrentFrameSize

public com.applitools.eyes.RectangleSize getCurrentFrameSize()

Returns:

The size of the current frame.

iterator

public Iterator<Frame> iterator()

Specified by:

iterator in interface Iterable<Frame>

Returns:

An iterator to go over the frames in the chain.