com.adobe.platform.operation.pdfops.options.createpdf

Class CreatePDFFromHTMLOptions

java.lang.Object

com.adobe.platform.operation.pdfops.options.createpdf.CreatePDFOptions

com.adobe.platform.operation.pdfops.options.createpdf.CreatePDFFromHTMLOptions

public class CreatePDFFromHTMLOptions
extends CreatePDFOptions

Parameters for converting HTML to PDF using CreatePDFOperation.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CreatePDFFromHTMLOptions.Builder Builds a CreatePDFFromHTMLOptions instance.

Method Summary

Modifier and Type	Method and 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.
boolean	includesHeaderFooter() Returns true if default header and footer will be included in the resulting PDF file.

Methods inherited from class com.adobe.platform.operation.pdfops.options.createpdf.CreatePDFOptions

htmlOptionsBuilder

Methods inherited from class java.lang.Object

clone, equals, finalize, 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.