public class HtmlToPdf
extends java.lang.Object
| Modifier and Type | Method and Description |
|---|---|
HtmlToPdf |
collate(boolean collate)
Whether or not to collate copies.
|
HtmlToPdf |
colorMode(PdfColorMode colorMode)
The color mode of the output document.
|
HtmlToPdf |
compression(boolean compression)
Whether or not loss-less compression should be used.
|
java.io.InputStream |
convert()
Performs the conversion, returning an
InputStream with the
bytes of the resulting PDF. |
boolean |
convert(java.lang.String path)
Performs the conversion, saving the result PDF to the specified path.
|
HtmlToPdf |
cookieJar(java.lang.String cookieJar)
The cookie jar to use when loading and storing cookies.
|
static HtmlToPdf |
create()
Creates a new
HtmlToPdf instance. |
HtmlToPdf |
documentTitle(java.lang.String title)
The title of the PDF document.
|
HtmlToPdf |
dpi(int dpi)
The DPI of the output document.
|
HtmlToPdf |
error(java.util.function.Consumer<java.lang.String> errorConsumer)
Adds a consumer for error messages produced during the conversion process.
|
HtmlToPdf |
failure(java.lang.Runnable failureRunnable)
Adds a runnable to run if the conversion failed.
|
HtmlToPdf |
finished(java.util.function.Consumer<java.lang.Boolean> finishConsumer)
Adds a consumer for the conversion's finish state.
|
HtmlToPdf |
imageDpi(int imageDpi)
The maximum DPI to use for images.
|
HtmlToPdf |
imageQuality(int quality)
JPEG compression factor (1-100)
|
HtmlToPdf |
marginBottom(java.lang.String marginBottom)
The size of the bottom margin (CSS value, e.g.
|
HtmlToPdf |
marginLeft(java.lang.String marginLeft)
The size of the left margin (CSS value, e.g.
|
HtmlToPdf |
marginRight(java.lang.String marginRight)
The size of the right margin (CSS value, e.g.
|
HtmlToPdf |
marginTop(java.lang.String marginTop)
The size of the top margin (CSS value, e.g.
|
HtmlToPdf |
object(HtmlToPdfObject object)
Adds an object to be converted.
|
HtmlToPdf |
orientation(PdfOrientation orientation)
The orientation of the output document.
|
HtmlToPdf |
outline(boolean outline)
Whether or not a table of contents should be generated.
|
HtmlToPdf |
outlineDepth(int outlineDepth)
The maximum depth of the outline.
|
HtmlToPdf |
pageSize(PdfPageSize pageSize)
The paper size of the output document.
|
HtmlToPdf |
progress(java.util.function.Consumer<HtmlToPdfProgress> progressChangeConsumer)
Adds a consumer for conversion progress updates.
|
HtmlToPdf |
success(java.lang.Runnable successRunnable)
Adds a runnable to run if the conversion was successful.
|
HtmlToPdf |
warning(java.util.function.Consumer<java.lang.String> warningConsumer)
Adds a consumer for warning messages produced during the conversion process.
|
public static HtmlToPdf create()
HtmlToPdf instance.public HtmlToPdf pageSize(PdfPageSize pageSize)
public HtmlToPdf orientation(PdfOrientation orientation)
public HtmlToPdf colorMode(PdfColorMode colorMode)
public HtmlToPdf dpi(int dpi)
public HtmlToPdf collate(boolean collate)
public HtmlToPdf outline(boolean outline)
public HtmlToPdf outlineDepth(int outlineDepth)
public HtmlToPdf documentTitle(java.lang.String title)
public HtmlToPdf compression(boolean compression)
public HtmlToPdf marginTop(java.lang.String marginTop)
public HtmlToPdf marginBottom(java.lang.String marginBottom)
public HtmlToPdf marginLeft(java.lang.String marginLeft)
public HtmlToPdf marginRight(java.lang.String marginRight)
public HtmlToPdf imageDpi(int imageDpi)
public HtmlToPdf imageQuality(int quality)
public HtmlToPdf cookieJar(java.lang.String cookieJar)
public HtmlToPdf warning(java.util.function.Consumer<java.lang.String> warningConsumer)
public HtmlToPdf error(java.util.function.Consumer<java.lang.String> errorConsumer)
public HtmlToPdf progress(java.util.function.Consumer<HtmlToPdfProgress> progressChangeConsumer)
public HtmlToPdf finished(java.util.function.Consumer<java.lang.Boolean> finishConsumer)
Boolean value denoting whether the
conversion was successful (true) or a failure (false).public HtmlToPdf success(java.lang.Runnable successRunnable)
public HtmlToPdf failure(java.lang.Runnable failureRunnable)
public HtmlToPdf object(HtmlToPdfObject object)
public boolean convert(java.lang.String path)
true if the conversion process completed successfully,
or false otherwise.public java.io.InputStream convert()
InputStream with the
bytes of the resulting PDF.HtmlToPdfException - if conversion failed