com.aventstack.extentreports.reporter.configuration

Class ExtentHtmlReporterConfiguration

java.lang.Object

com.aventstack.extentreports.reporter.configuration.BasicFileConfiguration

com.aventstack.extentreports.reporter.configuration.ExtentHtmlReporterConfiguration

All Implemented Interfaces:

IReporterConfiguration

public class ExtentHtmlReporterConfiguration
extends BasicFileConfiguration
implements IReporterConfiguration

Defines configuration settings for the HTML reporter

Constructor Summary

Constructors

Constructor and Description
ExtentHtmlReporterConfiguration()

Method Summary

Modifier and Type	Method and Description
boolean	getAutoCreateRelativePathMedia()
boolean	getChartVisibilityOnOpen()
java.util.Map<java.lang.String,java.lang.String>	getConfigMap()
boolean	getCreateOfflineReport()
java.util.List<Status>	getLevel()
Protocol	getProtocol()
java.lang.String	getReportName()
ChartLocation	getTestViewChartLocation()
void	setAutoCreateRelativePathMedia(boolean v) Setting to automatically store screen shots relative to the path.
void	setChartVisibilityOnOpen(boolean chartVisibilityOnOpen) For ExtentHtmlReporter, sets the configuration to allow viewing or hiding charts on report open
void	setCreateOfflineReport(boolean v) Creates the HTML report, saving all resources (css, js, fonts) in the same location, so the report can be viewed without an internet connection
void	setLevel(Status... level)
void	setProtocol(Protocol protocol) Sets the protocol of accessing CSS/JS resources from CDN
void	setReportName(java.lang.String reportName)
void	setTestViewChartLocation(ChartLocation chartLocation) For ExtentHtmlReporter, sets the location of charts

Methods inherited from class com.aventstack.extentreports.reporter.configuration.BasicFileConfiguration

getCSS, getDocumentTitle, getEncoding, getExtentXUrl, getFilePath, getJS, getTheme, setCSS, setDocumentTitle, setEncoding, setExtentXUrl, setFilePath, setFilePath, setJS, setTheme

Methods inherited from class java.lang.Object

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

Constructor Detail

ExtentHtmlReporterConfiguration

public ExtentHtmlReporterConfiguration()

Method Detail

setProtocol

public void setProtocol(Protocol protocol)

Sets the protocol of accessing CSS/JS resources from CDN

Default protocol value: HTTPS

Parameters:

protocol - Protocol, HTTPS or HTTP

getProtocol

public Protocol getProtocol()

setTestViewChartLocation

public void setTestViewChartLocation(ChartLocation chartLocation)

For ExtentHtmlReporter, sets the location of charts

Parameters:

chartLocation - Location

getTestViewChartLocation

public ChartLocation getTestViewChartLocation()

setChartVisibilityOnOpen

public void setChartVisibilityOnOpen(boolean chartVisibilityOnOpen)

For ExtentHtmlReporter, sets the configuration to allow viewing or hiding charts on report open

Parameters:

chartVisibilityOnOpen - true to view charts on report open, false to hide

getChartVisibilityOnOpen

public boolean getChartVisibilityOnOpen()

setAutoCreateRelativePathMedia

public void setAutoCreateRelativePathMedia(boolean v)

Setting to automatically store screen shots relative to the path. This method also sets the new relative path as a link from the report. Example:

 /
   Report.html
   Report.0
     - 1.png
     - 2.png
   Report.1
     - 1.png
     - 2.png
 

Report.0 directory will contain media from the 1st run. Report.1 directory will contain media from the 2nd run.

Parameters:

v - Setting to enable this feature

getAutoCreateRelativePathMedia

public boolean getAutoCreateRelativePathMedia()

setCreateOfflineReport

public void setCreateOfflineReport(boolean v)
                            throws InvalidFileException

Creates the HTML report, saving all resources (css, js, fonts) in the same location, so the report can be viewed without an internet connection

Parameters:

v - Setting to enable an offline accessible report

Throws:

InvalidFileException - Exception thrown if the HTML file or path was not specified

getCreateOfflineReport

public boolean getCreateOfflineReport()

getConfigMap

public java.util.Map<java.lang.String,java.lang.String> getConfigMap()

setLevel

public void setLevel(Status... level)

getLevel

public java.util.List<Status> getLevel()

setReportName

public void setReportName(java.lang.String reportName)

getReportName

public java.lang.String getReportName()