HtmlToPdfObject (htmltopdf 1.0.4 API)

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

public class HtmlToPdfObject
extends java.lang.Object

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`HtmlToPdfObject`	`authPassword(java.lang.String password)` The auth password to use when requesting the webpage.
`HtmlToPdfObject`	`authUsername(java.lang.String username)` The auth username to use when requesting the webpage.
`HtmlToPdfObject`	`blockLocalFileAccess(boolean block)` Whether or not to block the webpage from accessing local file access.
`HtmlToPdfObject`	`convertInternalLinksToPdfReferences(boolean convert)` Whether or not to convert links within the webpage to PDF references.
`HtmlToPdfObject`	`debugJavascriptWarningsAndErrors(boolean debug)` Whether or not to debug javascript warnings and errors.
`HtmlToPdfObject`	`defaultEncoding(java.lang.String encoding)` The character encoding to use when not specified by the webpage (e.g.
`HtmlToPdfObject`	`enableIntelligentShrinking(boolean enable)` Whether or not to enable Intelligent Shrinking.
`HtmlToPdfObject`	`enableJavascript(boolean enable)` Whether or not to enable javascript.
`static HtmlToPdfObject`	`forHtml(java.lang.String html)` Creates a new `HtmlToPdfObject` using the specified HTML as content.
`static HtmlToPdfObject`	`forUrl(java.lang.String url)` Creates a new `HtmlToPdfObject` for the specified URL.
`HtmlToPdfObject`	`handleErrors(ObjectErrorHandling errorHandling)` Specifies the way in which errors are handled for this object.
`HtmlToPdfObject`	`headerCenter(java.lang.String text)` Text to write in the center part of the header.
`HtmlToPdfObject`	`headerFontName(java.lang.String fontName)` The font name of the custom header to add.
`HtmlToPdfObject`	`headerFontSize(int size)` The font size of the custom header to add.
`HtmlToPdfObject`	`headerHtmlUrl(java.lang.String url)` URL for an HTML document to use for the header.
`HtmlToPdfObject`	`headerLeft(java.lang.String text)` Text to write in the left part of the header.
`HtmlToPdfObject`	`headerLine(boolean line)` Whether or not to add a line beneath the custom header.
`HtmlToPdfObject`	`headerRight(java.lang.String text)` Text to write in the right part of the header.
`HtmlToPdfObject`	`headerSpacing(int spacing)` The amount of spacing between the header and the content.
`HtmlToPdfObject`	`javascriptDelay(int delayMs)` Delay, in milliseconds, to allow between the time when the page has been loaded and the time of conversion to PDF.
`HtmlToPdfObject`	`loadImages(boolean load)` Whether or not to load images.
`HtmlToPdfObject`	`minimumFontSize(int size)` The minimum font size allowed.
`HtmlToPdfObject`	`pageCount(boolean pageCount)` Whether or not to include page count in the header, footer, and table of contents.
`HtmlToPdfObject`	`produceForms(boolean produce)` Whether or not to turn HTML forms into PDF forms.
`HtmlToPdfObject`	`showBackground(boolean background)` Whether or not to show the page's background.
`HtmlToPdfObject`	`stopSlowScript(boolean stop)` Whether or not to stop slow running javascript.
`HtmlToPdfObject`	`tableOfContentsBackLinks(boolean backLinks)` Whether or not content should link back to the table of contents.
`HtmlToPdfObject`	`tableOfContentsCaptionText(java.lang.String captionText)` The caption text to use for the table of contents.
`HtmlToPdfObject`	`tableOfContentsDottedLines(boolean dottedLines)` Whether or not to use dotted lines for the table of contents.
`HtmlToPdfObject`	`tableOfContentsForwardLinks(boolean forward)` Whether or not the table of contents should link to the content in the PDF document.
`HtmlToPdfObject`	`tableOfContentsIncludeSections(boolean include)` Whether or not sections from the document should be included in the outline of the table of contents.
`HtmlToPdfObject`	`tableOfContentsIndentation(java.lang.String indentation)` The indentation to use for the table of contents.
`HtmlToPdfObject`	`tableOfContentsIndentationFontScaleDown(float scale)` The scale-down per indentation of the table of contents.
`HtmlToPdfObject`	`useExternalLinks(boolean use)` Whether or not to keep external links.
`HtmlToPdfObject`	`usePrintMediaType(boolean use)` Whether or not to use "print" media type (instead of "screen" media type) for CSS styles.
`HtmlToPdfObject`	`userStylesheet(java.lang.String urlOrPath)` A stylesheet to apply for the conversion.
`HtmlToPdfObject`	`zoomFactor(float factor)` Amount of zoom to use when converting.

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

- Method Detail
  - forHtml
```
public static HtmlToPdfObject forHtml(java.lang.String html)
```
    Creates a new HtmlToPdfObject using the specified HTML as content.
    
    Parameters:
    
    html - The HTML code to convert to PDF.
    
    Returns:
    
    The created HtmlToPdfObject instance.
  - forUrl
```
public static HtmlToPdfObject forUrl(java.lang.String url)
```
    Creates a new HtmlToPdfObject for the specified URL. The content will be obtained from the specified URL during the conversion process.
    
    Parameters:
    
    url - The URL to obtain HTML content from.
    
    Returns:
    
    The created HtmlToPdfObject instance.
  - showBackground
```
public HtmlToPdfObject showBackground(boolean background)
```
    Whether or not to show the page's background.
  - loadImages
```
public HtmlToPdfObject loadImages(boolean load)
```
    Whether or not to load images.
  - enableJavascript
```
public HtmlToPdfObject enableJavascript(boolean enable)
```
    Whether or not to enable javascript.
  - enableIntelligentShrinking
```
public HtmlToPdfObject enableIntelligentShrinking(boolean enable)
```
    Whether or not to enable Intelligent Shrinking. Intelligent Shrinking will attempt to fit more content into pages if enabled.
  - minimumFontSize
```
public HtmlToPdfObject minimumFontSize(int size)
```
    The minimum font size allowed.
  - usePrintMediaType
```
public HtmlToPdfObject usePrintMediaType(boolean use)
```
    Whether or not to use "print" media type (instead of "screen" media type) for CSS styles.
  - defaultEncoding
```
public HtmlToPdfObject defaultEncoding(java.lang.String encoding)
```
    The character encoding to use when not specified by the webpage (e.g. "utf-8")
  - userStylesheet
```
public HtmlToPdfObject userStylesheet(java.lang.String urlOrPath)
```
    A stylesheet to apply for the conversion.
    
    Parameters:
    
    urlOrPath - The URL or path to the stylesheet to apply.
  - authUsername
```
public HtmlToPdfObject authUsername(java.lang.String username)
```
    The auth username to use when requesting the webpage.
  - authPassword
```
public HtmlToPdfObject authPassword(java.lang.String password)
```
    The auth password to use when requesting the webpage.
  - javascriptDelay
```
public HtmlToPdfObject javascriptDelay(int delayMs)
```
    Delay, in milliseconds, to allow between the time when the page has been loaded and the time of conversion to PDF. This might be needed to allow javascript to load and display content.
  - zoomFactor
```
public HtmlToPdfObject zoomFactor(float factor)
```
    Amount of zoom to use when converting.
  - blockLocalFileAccess
```
public HtmlToPdfObject blockLocalFileAccess(boolean block)
```
    Whether or not to block the webpage from accessing local file access.
  - stopSlowScript
```
public HtmlToPdfObject stopSlowScript(boolean stop)
```
    Whether or not to stop slow running javascript.
  - debugJavascriptWarningsAndErrors
```
public HtmlToPdfObject debugJavascriptWarningsAndErrors(boolean debug)
```
    Whether or not to debug javascript warnings and errors. If enabled, warnings and errors from javascript will be added to HtmlToPdf warning callback.
    
    See Also:
    
    HtmlToPdf.warning(Consumer)
  - handleErrors
```
public HtmlToPdfObject handleErrors(ObjectErrorHandling errorHandling)
```
    Specifies the way in which errors are handled for this object.
  - headerFontSize
```
public HtmlToPdfObject headerFontSize(int size)
```
    The font size of the custom header to add.
  - headerFontName
```
public HtmlToPdfObject headerFontName(java.lang.String fontName)
```
    The font name of the custom header to add.
  - headerLine
```
public HtmlToPdfObject headerLine(boolean line)
```
    Whether or not to add a line beneath the custom header.
  - headerSpacing
```
public HtmlToPdfObject headerSpacing(int spacing)
```
    The amount of spacing between the header and the content.
  - headerHtmlUrl
```
public HtmlToPdfObject headerHtmlUrl(java.lang.String url)
```
    URL for an HTML document to use for the header.
  - headerLeft
```
public HtmlToPdfObject headerLeft(java.lang.String text)
```
    Text to write in the left part of the header.
  - headerCenter
```
public HtmlToPdfObject headerCenter(java.lang.String text)
```
    Text to write in the center part of the header.
  - headerRight
```
public HtmlToPdfObject headerRight(java.lang.String text)
```
    Text to write in the right part of the header.
  - tableOfContentsDottedLines
```
public HtmlToPdfObject tableOfContentsDottedLines(boolean dottedLines)
```
    Whether or not to use dotted lines for the table of contents.
  - tableOfContentsCaptionText
```
public HtmlToPdfObject tableOfContentsCaptionText(java.lang.String captionText)
```
    The caption text to use for the table of contents.
  - tableOfContentsForwardLinks
```
public HtmlToPdfObject tableOfContentsForwardLinks(boolean forward)
```
    Whether or not the table of contents should link to the content in the PDF document.
  - tableOfContentsBackLinks
```
public HtmlToPdfObject tableOfContentsBackLinks(boolean backLinks)
```
    Whether or not content should link back to the table of contents.
  - tableOfContentsIndentation
```
public HtmlToPdfObject tableOfContentsIndentation(java.lang.String indentation)
```
    The indentation to use for the table of contents. This string is a size such as used in CSS ("5px", "2em" etc.)
  - tableOfContentsIndentationFontScaleDown
```
public HtmlToPdfObject tableOfContentsIndentationFontScaleDown(float scale)
```
    The scale-down per indentation of the table of contents. For instance, a value of 0.8 will scale the font down by 20% for every level in the table of contents.
  - tableOfContentsIncludeSections
```
public HtmlToPdfObject tableOfContentsIncludeSections(boolean include)
```
    Whether or not sections from the document should be included in the outline of the table of contents.
  - useExternalLinks
```
public HtmlToPdfObject useExternalLinks(boolean use)
```
    Whether or not to keep external links.
  - convertInternalLinksToPdfReferences
```
public HtmlToPdfObject convertInternalLinksToPdfReferences(boolean convert)
```
    Whether or not to convert links within the webpage to PDF references.
  - produceForms
```
public HtmlToPdfObject produceForms(boolean produce)
```
    Whether or not to turn HTML forms into PDF forms.
  - pageCount
```
public HtmlToPdfObject pageCount(boolean pageCount)
```
    Whether or not to include page count in the header, footer, and table of contents.

Class HtmlToPdfObject

Method Summary

Methods inherited from class java.lang.Object

Method Detail

forHtml

forUrl

showBackground

loadImages

enableJavascript

enableIntelligentShrinking

minimumFontSize

usePrintMediaType

defaultEncoding

userStylesheet

authUsername

authPassword

javascriptDelay

zoomFactor

blockLocalFileAccess

stopSlowScript

debugJavascriptWarningsAndErrors

handleErrors

headerFontSize

headerFontName

headerLine

headerSpacing

headerHtmlUrl

headerLeft

headerCenter

headerRight

tableOfContentsDottedLines

tableOfContentsCaptionText

tableOfContentsForwardLinks

tableOfContentsBackLinks

tableOfContentsIndentation

tableOfContentsIndentationFontScaleDown

tableOfContentsIncludeSections

useExternalLinks

convertInternalLinksToPdfReferences

produceForms

pageCount