Modifier and Type	Class and Description
public static class	PdfVisualTester.PdfCompareResult
public static enum	PdfVisualTester.ProblemType
public static class	PdfVisualTester.TestImage

Modifier and Type	Field and Description
private static final int	LEFT_MARGIN_PX
private static final int	LINE_HEIGHT_PX
private static final BufferedImage	ONE_PX_IMAGE

Access	Constructor and Description
public	PdfVisualTester()

Method Summary

Modifier and Type	Method and Description
private static int	calcCombinedIntensity(final int element) Calculate the combined intensity of a pixel and normalizes it to a value of at most 255.
private static int	color(final int r, final int g, final int b)
public static List<PdfVisualTester.PdfCompareResult>	Returns: A list of `PdfCompareResult` instances describing differences. comparePdfDocuments(byte[] expected, byte[] actual, String testName, boolean Whether to return the images in the case they are good (ie. the same). keepSameImages) Compares two PDF documents by rendering each page to an image and comparing pixel by pixel.
public static BufferedImage	createDiffImage(BufferedImage img1, BufferedImage img2)
private static int	fade(final int i)
private static int	fadeElement(final int i)
private static int	getActualPixel(BufferedImage img, int x, int y)
private static int	getElement(final int expectedElement, final int actualElement)
private static int	getExpectedPixel(BufferedImage img, int x, int y)
private static boolean	Returns: whether imgExpected is different image compared to imgActual isImageDifferent(BufferedImage imgExpected, BufferedImage imgActual) Gets the data buffer of each image and compares.
private static int	Returns: A value that is at least 50 and at most maxIntensity levelIntensity(final int color component to level darkness, final int highest possible intensity cut off maxIntensity) Levels the color intensity to at least 50 and at most maxIntensity.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

LEFT_MARGIN_PX	back to summary
private static final int LEFT_MARGIN_PX

LINE_HEIGHT_PX	back to summary
private static final int LINE_HEIGHT_PX

ONE_PX_IMAGE	back to summary
private static final BufferedImage ONE_PX_IMAGE

Constructor Detail

PdfVisualTester	back to summary
public PdfVisualTester()

Method Detail

calcCombinedIntensity	back to summary
private static int calcCombinedIntensity(final int element) Calculate the combined intensity of a pixel and normalizes it to a value of at most 255.

color	back to summary
private static int color(final int r, final int g, final int b)

comparePdfDocuments back to summary

comparePdfDocuments	back to summary
public static List<PdfVisualTester.PdfCompareResult> comparePdfDocuments(byte[] expected, byte[] actual, String testName, boolean keepSameImages) throws IOException Compares two PDF documents by rendering each page to an image and comparing pixel by pixel. Parameters keepSameImages:boolean Whether to return the images in the case they are good (ie. the same). Returns:List<PdfVisualTester.PdfCompareResult> A list of `PdfCompareResult` instances describing differences.

public static List<PdfVisualTester.PdfCompareResult> comparePdfDocuments(byte[] expected, byte[] actual, String testName, boolean keepSameImages) throws IOException

Compares two PDF documents by rendering each page to an image and comparing pixel by pixel.

Parameters

keepSameImages:boolean: Whether to return the images in the case they are good (ie. the same).

Returns:List<PdfVisualTester.PdfCompareResult>

A list of PdfCompareResult instances describing differences.

createDiffImage	back to summary
public static BufferedImage createDiffImage(BufferedImage img1, BufferedImage img2)

fade	back to summary
private static int fade(final int i)

fadeElement	back to summary
private static int fadeElement(final int i)

getActualPixel	back to summary
private static int getActualPixel(BufferedImage img, int x, int y)

getElement	back to summary
private static int getElement(final int expectedElement, final int actualElement)

getExpectedPixel	back to summary
private static int getExpectedPixel(BufferedImage img, int x, int y)

isImageDifferent	back to summary
private static boolean isImageDifferent(BufferedImage imgExpected, BufferedImage imgActual) Gets the data buffer of each image and compares. Note May be an expensive (memory and CPU) operation for large images. Returns:boolean whether imgExpected is different image compared to imgActual

isImageDifferent

back to summary

private static boolean isImageDifferent(BufferedImage imgExpected, BufferedImage imgActual)

Gets the data buffer of each image and compares.

Note

May be an expensive (memory and CPU) operation for large images.

Returns:boolean: whether imgExpected is different image compared to imgActual

levelIntensity	back to summary
private static int levelIntensity(final int darkness, final int maxIntensity) Levels the color intensity to at least 50 and at most maxIntensity. Parameters darkness:int color component to level maxIntensity:int highest possible intensity cut off Returns:int A value that is at least 50 and at most maxIntensity

levelIntensity

back to summary

private static int levelIntensity(final int darkness, final int maxIntensity)

Levels the color intensity to at least 50 and at most maxIntensity.

Parameters

darkness:int: color component to level
maxIntensity:int: highest possible intensity cut off

Returns:int

A value that is at least 50 and at most maxIntensity

com.openhtmltopdf.pdfboxout.visualtester back to summary

public Class PdfVisualTester.PdfCompareResult

Class Inheritance

extends Object

java.lang.Object
com.openhtmltopdf.pdfboxout.visualtester.PdfVisualTester.PdfCompareResult

Field Summary

Modifier and Type	Field and Description
public static final int	INALID_PAGE_NO
public final String	logMessage
public final int	pageNumber
public final PdfVisualTester.TestImage	testImages
public final PdfVisualTester.ProblemType	type

Constructor Summary

Access	Constructor and Description
private	PdfCompareResult(PdfVisualTester.ProblemType type, String logMessage, int pageNumber, PdfVisualTester.TestImage testImage)

Method Summary

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

INALID_PAGE_NO	back to summary
public static final int INALID_PAGE_NO

logMessage	back to summary
public final String logMessage

pageNumber	back to summary
public final int pageNumber

testImages	back to summary
public final PdfVisualTester.TestImage testImages

type	back to summary
public final PdfVisualTester.ProblemType type

Constructor Detail

PdfCompareResult	back to summary
private PdfCompareResult(PdfVisualTester.ProblemType type, String logMessage, int pageNumber, PdfVisualTester.TestImage testImage)

com.openhtmltopdf.pdfboxout.visualtester back to summary

public final Enum PdfVisualTester.ProblemType

Class Inheritance

extends Enum<PdfVisualTester.ProblemType>

java.lang.Object
java.lang.Enum
com.openhtmltopdf.pdfboxout.visualtester.PdfVisualTester.ProblemType

Field Summary

Modifier and Type	Field and Description
public static final PdfVisualTester.ProblemType	EXTRA_EXPECTED_PAGE
public static final PdfVisualTester.ProblemType	NO_ACTUAL_DOCUMENT_PROVIDED
public static final PdfVisualTester.ProblemType	NO_EXPECTED_DOCUMENT_PROVIDED
public static final PdfVisualTester.ProblemType	PAGE_COUNT_DIFFERENT
public static final PdfVisualTester.ProblemType	PAGE_GOOD
public static final PdfVisualTester.ProblemType	PAGE_SIZE_DIFFERENT
public static final PdfVisualTester.ProblemType	PAGE_VISUALLY_DIFFERENT

Constructor Summary

Access	Constructor and Description
private	ProblemType()

Method Summary

Modifier and Type	Method and Description
public static PdfVisualTester.ProblemType	valueOf(String name)
public static PdfVisualTester.ProblemType[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

EXTRA_EXPECTED_PAGE	back to summary
public static final PdfVisualTester.ProblemType EXTRA_EXPECTED_PAGE

NO_ACTUAL_DOCUMENT_PROVIDED	back to summary
public static final PdfVisualTester.ProblemType NO_ACTUAL_DOCUMENT_PROVIDED

NO_EXPECTED_DOCUMENT_PROVIDED	back to summary
public static final PdfVisualTester.ProblemType NO_EXPECTED_DOCUMENT_PROVIDED

PAGE_COUNT_DIFFERENT	back to summary
public static final PdfVisualTester.ProblemType PAGE_COUNT_DIFFERENT

PAGE_GOOD	back to summary
public static final PdfVisualTester.ProblemType PAGE_GOOD

PAGE_SIZE_DIFFERENT	back to summary
public static final PdfVisualTester.ProblemType PAGE_SIZE_DIFFERENT

PAGE_VISUALLY_DIFFERENT	back to summary
public static final PdfVisualTester.ProblemType PAGE_VISUALLY_DIFFERENT

Constructor Detail

ProblemType	back to summary
private ProblemType()

Method Detail

valueOf	back to summary
public static PdfVisualTester.ProblemType valueOf(String name)

values	back to summary
public static PdfVisualTester.ProblemType[] values()

com.openhtmltopdf.pdfboxout.visualtester back to summary

public Class PdfVisualTester.TestImage

Class Inheritance

extends Object

java.lang.Object
com.openhtmltopdf.pdfboxout.visualtester.PdfVisualTester.TestImage

Field Summary

Modifier and Type	Field and Description
private final BufferedImage	actual
private final boolean	differences
private final BufferedImage	expected
private final int	pageNumber
private final String	testName

Constructor Summary

Access	Constructor and Description
private	TestImage(String test, int pageNo, BufferedImage exp, BufferedImage act, boolean hasDifferences)

Method Summary

Modifier and Type	Method and Description
public BufferedImage	Returns: the diff image. createDiff() Creates a diff image to quickly spot differences between expected and actual.
public BufferedImage	Returns: the actual image, may be null if expected has more pages than actual getActual() Get the actual rendered image.
public BufferedImage	Returns: the expected image, should never be null. getExpected() Get the expected rendered image.
public int	Returns: the page number. getPageNumber()
public String	Returns: the test name passed into `PdfVisualTester#comparePdfDocuments(byte[], byte[], String, boolean)` getTestName()
public boolean	Returns: true if the images are different. Precaulculated. hasDifferences() Should usually be called before `createDiff()`.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

actual	back to summary
private final BufferedImage actual

differences	back to summary
private final boolean differences

expected	back to summary
private final BufferedImage expected

pageNumber	back to summary
private final int pageNumber

testName	back to summary
private final String testName

Constructor Detail

TestImage	back to summary
private TestImage(String test, int pageNo, BufferedImage exp, BufferedImage act, boolean hasDifferences)

Method Detail

createDiff back to summary

createDiff	back to summary
public BufferedImage createDiff() Creates a diff image to quickly spot differences between expected and actual. Note May be expensive for large images. Returns:BufferedImage the diff image. See Also `hasDifferences`

public BufferedImage createDiff()

Creates a diff image to quickly spot differences between expected and actual.

Note

May be expensive for large images.

Returns:BufferedImage: the diff image.
See Also: hasDifferences

getActual

back to summary

public BufferedImage getActual()

Get the actual rendered image.

Returns:BufferedImage: the actual image, may be null if expected has more pages than actual

getExpected

back to summary

public BufferedImage getExpected()

Get the expected rendered image.

Returns:BufferedImage: the expected image, should never be null.

getPageNumber	back to summary
public int getPageNumber() Returns:int the page number.

getTestName	back to summary
public String getTestName() Returns:String the test name passed into `PdfVisualTester#comparePdfDocuments(byte[], byte[], String, boolean)`

hasDifferences back to summary

public boolean hasDifferences()

Should usually be called before createDiff().

Returns:boolean: true if the images are different. Precaulculated.

public Class PdfVisualTester

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class PdfVisualTester.PdfCompareResult

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

public final Enum PdfVisualTester.ProblemType

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class PdfVisualTester.TestImage

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail