HtmlToPdf (htmltopdf 1.0.4 API)

java.lang.Object
- io.woo.htmltopdf.HtmlToPdf

public class HtmlToPdf
extends java.lang.Object

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

Class HtmlToPdf

Method Summary

Methods inherited from class java.lang.Object

Method Detail

create

pageSize

orientation

colorMode

dpi

collate

outline

outlineDepth

documentTitle

compression

marginTop

marginBottom

marginLeft

marginRight

imageDpi

imageQuality

cookieJar

warning

error

progress

finished

success

failure

object

convert

convert