org.concordion.ext

Class ScreenshotExtension

java.lang.Object

org.concordion.ext.ScreenshotExtension

All Implemented Interfaces:

org.concordion.api.extension.ConcordionExtension

public class ScreenshotExtension
extends java.lang.Object
implements org.concordion.api.extension.ConcordionExtension

Adds screenshots to the Concordion output, typically when failures or exceptions occur. The screenshot is displayed when you hover over the relevant element. Clicking on the element will open the image in the current browser window.

It can also be used as a command, to explicitly include screenshots in the output.

By default, the screenshot will be of the full visible screen. This can be overridden using a custom ScreenshotTaker.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COMMAND_NAME
static java.lang.String	EXTENSION_NAMESPACE

Constructor Summary

Constructors

Constructor and Description
ScreenshotExtension()

Method Summary

Modifier and Type	Method and Description
void	addTo(org.concordion.api.extension.ConcordionExtender concordionExtender)
ScreenshotExtension	setMaxWidth(int maxWidth) Sets the maximum width that will be used for display of the images in the output.
ScreenshotExtension	setScreenshotOnAssertionFailure(boolean takeShot) Sets whether screenshots will be embedded in the output when assertions fail.
ScreenshotExtension	setScreenshotOnAssertionSuccess(boolean takeShot) Sets whether screenshots will be embedded in the output when assertions pass.
ScreenshotExtension	setScreenshotOnThrowable(boolean takeShot) Sets whether screenshots will be embedded in the output when uncaught Throwables occur in the test.
ScreenshotExtension	setScreenshotTaker(ScreenshotTaker screenshotTaker) Set a custom screenshot taker.

Methods inherited from class java.lang.Object

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

Field Detail

COMMAND_NAME

public static final java.lang.String COMMAND_NAME

See Also:

Constant Field Values

EXTENSION_NAMESPACE

public static final java.lang.String EXTENSION_NAMESPACE

See Also:

Constant Field Values

Constructor Detail

ScreenshotExtension

public ScreenshotExtension()

Method Detail

addTo

public void addTo(org.concordion.api.extension.ConcordionExtender concordionExtender)

Specified by:

addTo in interface org.concordion.api.extension.ConcordionExtension

setScreenshotTaker

public ScreenshotExtension setScreenshotTaker(ScreenshotTaker screenshotTaker)

Set a custom screenshot taker. If not set, the extension will default to using Robot which will take a shot of the full visible screen.

Parameters:

screenshotTaker -

setMaxWidth

public ScreenshotExtension setMaxWidth(int maxWidth)

Sets the maximum width that will be used for display of the images in the output.

setScreenshotOnAssertionFailure

public ScreenshotExtension setScreenshotOnAssertionFailure(boolean takeShot)

Sets whether screenshots will be embedded in the output when assertions fail. Defaults to true.

Parameters:

takeShot - true to take screenshots on assertion failures, false to not take screenshots.

setScreenshotOnAssertionSuccess

public ScreenshotExtension setScreenshotOnAssertionSuccess(boolean takeShot)

Sets whether screenshots will be embedded in the output when assertions pass. Defaults to false.

Parameters:

takeShot - true to take screenshots on assertion success, false to not take screenshots.

setScreenshotOnThrowable

public ScreenshotExtension setScreenshotOnThrowable(boolean takeShot)

Sets whether screenshots will be embedded in the output when uncaught Throwables occur in the test. Defaults to true.

Parameters:

takeShot - true to take screenshots on uncaught Throwables, false to not take screenshots.