com.relevantcodes.extentreports.markup

Class DocumentConfig

java.lang.Object

com.relevantcodes.extentreports.LogSettings

com.relevantcodes.extentreports.markup.DocumentConfig

public class DocumentConfig
extends LogSettings

DocumentConfig class for customizing the report layout

Author:

Anshoo Arora

Field Summary

Fields inherited from class com.relevantcodes.extentreports.LogSettings

displayCallerClass, logTimeFormat

Constructor Summary

Constructors

Constructor and Description
DocumentConfig(String filePath)

Method Summary

Modifier and Type	Method and Description
DocumentConfig	addCustomStyles(String styles) Use custom CSS directly for the document to change layout
DocumentConfig	addCustomStylesheet(String cssFilePath) Use a custom stylesheet file with CSS
DocumentConfig	chartTitle(Chart chart, String title) Allows changing the title of the dashboard charts
DocumentConfig	displayCallerClass(Boolean display) Setting to append the caller class to the log event.
DocumentConfig	displayTestHeaders(Boolean display) Deprecated.
DocumentConfig	documentTitle(String title) Change the title of the report file
DocumentConfig	insertJS(String script) Adds custom scripts to the report
DocumentConfig	renewSystemInfo()
DocumentConfig	reportHeadline(String headline) Add, remove or modify the report summary
DocumentConfig	reportTitle(String title) Add, remove or modify the report summary
DocumentConfig	setImageSize(String percent) Sets the size of the attached snapshots by percentage.
DocumentConfig	statusIcon(LogStatus status, String newIcon) Choose to use your own icons for log status (PASS, FAIL, WARNING etc.) by choosing one of the icons from Fontawesome website: http://fortawesome.github.io/Font-Awesome/icons/.
DocumentConfig	useExtentFooter(Boolean display) Setting to show or hide the default Extent footer By default, this is FALSE

Methods inherited from class java.lang.Object

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

Constructor Detail

DocumentConfig

public DocumentConfig(String filePath)

Parameters:

filePath - Path of the HTML file with .htm or .html extension

Method Detail

statusIcon

public DocumentConfig statusIcon(LogStatus status,
                                 String newIcon)

Choose to use your own icons for log status (PASS, FAIL, WARNING etc.) by choosing one of the icons from Fontawesome website: http://fortawesome.github.io/Font-Awesome/icons/.

Parameters:

status - LogStatus

newIcon - Icon string from font-awesome

Returns:

DocumentConfig

displayTestHeaders

@Deprecated
public DocumentConfig displayTestHeaders(Boolean display)

Deprecated.

Allows showing of TH headers for the test

Parameters:

display - Setting FALSE will remove the TH headers from the test table

Returns:

DocumentConfig

useExtentFooter

public DocumentConfig useExtentFooter(Boolean display)

Setting to show or hide the default Extent footer By default, this is FALSE

Parameters:

display - Setting FALSE will hide the default Extent footer

Returns:

DocumentConfig

insertJS

public DocumentConfig insertJS(String script)

Adds custom scripts to the report

Parameters:

script - JavaScript code to be used for the report

Returns:

DocumentConfig

reportHeadline

public DocumentConfig reportHeadline(String headline)

Add, remove or modify the report summary

Parameters:

headline - Report summary

Returns:

DocumentConfig

reportTitle

public DocumentConfig reportTitle(String title)

Add, remove or modify the report summary

Parameters:

title - Title of the report

Returns:

DocumentConfig

addCustomStylesheet

public DocumentConfig addCustomStylesheet(String cssFilePath)

Use a custom stylesheet file with CSS

Parameters:

cssFilePath - Path of the CSS stylesheet file

Returns:

DocumentConfig

addCustomStyles

public DocumentConfig addCustomStyles(String styles)

Use custom CSS directly for the document to change layout

Parameters:

styles - CSS style string

Returns:

DocumentConfig

documentTitle

public DocumentConfig documentTitle(String title)

Change the title of the report file

Parameters:

title - Document title

Returns:

DocumentConfig

renewSystemInfo

public DocumentConfig renewSystemInfo()

Returns:

DocumentConfig object

displayCallerClass

public DocumentConfig displayCallerClass(Boolean display)

Setting to append the caller class to the log event. By default, the setting is enabled to allow the caller class to be displayed

Parameters:

display - Shows the caller class in the report step

Returns:

DocumentConfig

setImageSize

public DocumentConfig setImageSize(String percent)

Sets the size of the attached snapshots by percentage. Default = 50%.

Usage: extent.setImageSize("40%");

Parameters:

percent - Size of the image in percentage

Returns:

DocumentConfig

chartTitle

public DocumentConfig chartTitle(Chart chart,
                                 String title)

Allows changing the title of the dashboard charts

Parameters:

chart - TEST_SET, TEST

title - New title of the chart

Returns:

DocumentConfig