com.codeborne.selenide.impl

Class ScreenShotLaboratory

java.lang.Object

com.codeborne.selenide.impl.ScreenShotLaboratory

public class ScreenShotLaboratory
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List<java.io.File>	allScreenshots
protected java.lang.ThreadLocal<java.lang.String>	currentContext
protected java.lang.ThreadLocal<java.util.List<java.io.File>>	currentContextScreenshots
protected java.util.concurrent.atomic.AtomicLong	screenshotCounter
protected java.lang.ThreadLocal<java.util.List<java.io.File>>	threadScreenshots

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ScreenShotLaboratory()
protected	ScreenShotLaboratory(Photographer photographer, PageSourceExtractor extractor, com.codeborne.selenide.impl.Clock clock)

Method Summary

Modifier and Type	Method and Description
protected java.io.File	addToHistory(java.io.File screenshot)
java.util.List<java.io.File>	finishContext()
java.lang.String	formatScreenShotPath(Driver driver) Deprecated. Use method takeScreenshot(Driver) which returns Screenshot instead of String
protected java.lang.String	generateScreenshotFileName()
java.util.List<java.io.File>	getContextScreenshots()
static ScreenShotLaboratory	getInstance()
java.util.Optional<java.io.File>	getLastContextScreenshot()
java.io.File	getLastScreenshot()
java.util.Optional<java.io.File>	getLastThreadScreenshot()
protected java.lang.String	getScreenshotFileName(java.lang.String className, java.lang.String methodName)
java.util.List<java.io.File>	getScreenshots()
java.util.List<java.io.File>	getThreadScreenshots()
protected java.io.File	savePageImageToFile(Config config, java.lang.String fileName, Driver driver)
protected java.io.File	savePageSourceToFile(Config config, java.lang.String fileName, Driver driver)
void	startContext(java.lang.String context)
void	startContext(java.lang.String className, java.lang.String methodName)
Screenshot	takeScreenshot(Driver driver)
java.lang.String	takeScreenShot(Driver driver) Deprecated. use takeScreenshot(Driver) which returns Screenshot instead of String
<T> T	takeScreenShot(Driver driver, <any> outputType)
Screenshot	takeScreenshot(Driver driver, java.lang.String fileName) Takes screenshot of current browser window.
java.lang.String	takeScreenShot(Driver driver, java.lang.String fileName) Deprecated. use takeScreenshot(Driver, String) which returns Screenshot instead of String
Screenshot	takeScreenShot(Driver driver, java.lang.String className, java.lang.String methodName)
java.io.File	takeScreenshot(Driver driver, WebElement element)
java.io.File	takeScreenshot(Driver driver, WebElement iframe, WebElement element)
java.io.File	takeScreenShotAsFile(Driver driver)
java.awt.image.BufferedImage	takeScreenshotAsImage(Driver driver, WebElement element)
java.awt.image.BufferedImage	takeScreenshotAsImage(Driver driver, WebElement iframe, WebElement element)

Methods inherited from class java.lang.Object

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

Field Detail

allScreenshots

protected final java.util.List<java.io.File> allScreenshots

screenshotCounter

protected java.util.concurrent.atomic.AtomicLong screenshotCounter

currentContext

protected java.lang.ThreadLocal<java.lang.String> currentContext

currentContextScreenshots

protected java.lang.ThreadLocal<java.util.List<java.io.File>> currentContextScreenshots

threadScreenshots

protected java.lang.ThreadLocal<java.util.List<java.io.File>> threadScreenshots

Constructor Detail

ScreenShotLaboratory

protected ScreenShotLaboratory()

ScreenShotLaboratory

protected ScreenShotLaboratory(Photographer photographer,
                               PageSourceExtractor extractor,
                               com.codeborne.selenide.impl.Clock clock)

Method Detail

getInstance

public static ScreenShotLaboratory getInstance()

takeScreenShot

public Screenshot takeScreenShot(Driver driver,
                                 java.lang.String className,
                                 java.lang.String methodName)

getScreenshotFileName

protected java.lang.String getScreenshotFileName(java.lang.String className,
                                                 java.lang.String methodName)

takeScreenShot

@Deprecated
public java.lang.String takeScreenShot(Driver driver)

Deprecated. use takeScreenshot(Driver) which returns Screenshot instead of String

takeScreenShot

@Deprecated
public java.lang.String takeScreenShot(Driver driver,
                                                   java.lang.String fileName)

Deprecated. use takeScreenshot(Driver, String) which returns Screenshot instead of String

Takes screenshot of current browser window. Stores 2 files: html of page (if "savePageSource" option is enabled), and (if possible) image in PNG format.

Parameters:

fileName - name of file (without extension) to store screenshot to.

Returns:

the name of last saved screenshot or null if failed to create screenshot

takeScreenshot

public Screenshot takeScreenshot(Driver driver,
                                 java.lang.String fileName)

Takes screenshot of current browser window. Stores 2 files: html of page (if "savePageSource" option is enabled), and (if possible) image in PNG format.

Parameters:

fileName - name of file (without extension) to store screenshot to.

Returns:

instance of Screenshot containing both files

takeScreenShot

public <T> T takeScreenShot(Driver driver,
                            <any> outputType)

takeScreenshot

public java.io.File takeScreenshot(Driver driver,
                                   WebElement element)

takeScreenshotAsImage

public java.awt.image.BufferedImage takeScreenshotAsImage(Driver driver,
                                                          WebElement element)

generateScreenshotFileName

protected java.lang.String generateScreenshotFileName()

takeScreenshot

public java.io.File takeScreenshot(Driver driver,
                                   WebElement iframe,
                                   WebElement element)

takeScreenshotAsImage

public java.awt.image.BufferedImage takeScreenshotAsImage(Driver driver,
                                                          WebElement iframe,
                                                          WebElement element)

takeScreenShotAsFile

public java.io.File takeScreenShotAsFile(Driver driver)

addToHistory

protected java.io.File addToHistory(java.io.File screenshot)

savePageImageToFile

protected java.io.File savePageImageToFile(Config config,
                                           java.lang.String fileName,
                                           Driver driver)

savePageSourceToFile

protected java.io.File savePageSourceToFile(Config config,
                                            java.lang.String fileName,
                                            Driver driver)

startContext

public void startContext(java.lang.String className,
                         java.lang.String methodName)

startContext

public void startContext(java.lang.String context)

finishContext

public java.util.List<java.io.File> finishContext()

getScreenshots

public java.util.List<java.io.File> getScreenshots()

getThreadScreenshots

public java.util.List<java.io.File> getThreadScreenshots()

getContextScreenshots

public java.util.List<java.io.File> getContextScreenshots()

getLastScreenshot

public java.io.File getLastScreenshot()

getLastThreadScreenshot

public java.util.Optional<java.io.File> getLastThreadScreenshot()

getLastContextScreenshot

public java.util.Optional<java.io.File> getLastContextScreenshot()

formatScreenShotPath

@Deprecated
public java.lang.String formatScreenShotPath(Driver driver)

Deprecated. Use method takeScreenshot(Driver) which returns Screenshot instead of String

takeScreenshot

public Screenshot takeScreenshot(Driver driver)