HTMLToPDFParams (Adobe PDF Services SDK Specification)

java.lang.Object
- com.adobe.pdfservices.operation.pdfjobs.params.htmltopdf.HTMLToPDFParams

All Implemented Interfaces:

PDFServicesJobParams
```
public class HTMLToPDFParams
extends Object
implements PDFServicesJobParams
```
Parameters for converting HTML to PDF using HTMLToPDFJob.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class HTMLToPDFParams.Builder
Builds a HTMLToPDFParams instance.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`org.json.JSONObject`	`getDataToMerge()`	Returns JSON data that will be used to manipulate HTML DOM before it is converted into PDF file.
`PageLayout`	`getPageLayout()`	Returns the intended page layout of the resulting PDF file.
`static HTMLToPDFParams.Builder`	`htmltoPDFParamsBuilder()`	Creates a new `HTMLToPDFParams.Builder`.
`boolean`	`includesHeaderFooter()`	Returns `true` if default header and footer will be included in the resulting PDF file.

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

- Method Detail
  - includesHeaderFooter
```
public boolean includesHeaderFooter()
```
    Returns true if default header and footer will be included in the resulting PDF file. The default header consists of the date and the document title. The default footer consists of the file name and page number.
    
    Returns:
    
    true if default header and footer will be included in the resulting PDF file
  - getPageLayout
```
public PageLayout getPageLayout()
```
    Returns the intended page layout of the resulting PDF file.
    
    Returns:
    
    intended page layout.
  - getDataToMerge
```
public org.json.JSONObject getDataToMerge()
```
    Returns JSON data that will be used to manipulate HTML DOM before it is converted into PDF file. This mechanism is intended to be used to supply data that might otherwise be retrieved using ajax requests.
    To make use of this mechanism, the source html file must include a script element such as:
    <script src='./json.js' type='text/javascript'></script> where json.js refers to the JSON data,
    And also Requires javascript in the source html file to make use of this JSON data to manipulate the HTML DOM.
    Returns:
    
    data inputs for manipulating HTML DOM before converting it into a PDF file.
  - htmltoPDFParamsBuilder
```
public static HTMLToPDFParams.Builder htmltoPDFParamsBuilder()
```
    Creates a new HTMLToPDFParams.Builder.
    
    Returns:
    
    a HTMLToPDFParams.Builder instance.