PdfRendererBuilder (Openhtmltopdf PDF Rendering (Apache PDF-BOX 2) 0.0.1-RC9 API)

java.lang.Object
- com.openhtmltopdf.pdfboxout.PdfRendererBuilder

public class PdfRendererBuilder
extends Object

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`PdfRendererBuilder.FontStyle`
`static class`	`PdfRendererBuilder.PageSizeUnits`
`static class`	`PdfRendererBuilder.TextDirection`

Field Summary

Fields
Modifier and Type Field and Description

static float PAGE_SIZE_LETTER_HEIGHT

static PdfRendererBuilder.PageSizeUnits PAGE_SIZE_LETTER_UNITS

static float PAGE_SIZE_LETTER_WIDTH

Fields
Modifier and Type	Field and Description
`static float`	`PAGE_SIZE_LETTER_HEIGHT`
`static PdfRendererBuilder.PageSizeUnits`	`PAGE_SIZE_LETTER_UNITS`
`static float`	`PAGE_SIZE_LETTER_WIDTH`

Constructor Summary

Constructors
Constructor and Description

PdfRendererBuilder()

Constructors
Constructor and Description
`PdfRendererBuilder()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`PdfBoxRenderer`	`buildPdfRenderer()` Build a PdfBoxRenderer for further customization.
`PdfRendererBuilder`	`defaultTextDirection(PdfRendererBuilder.TextDirection textDirection)` The default text direction of the document.
`void`	`run()` Run the XHTML/XML to PDF conversion and output to an output stream set by toStream.
`PdfRendererBuilder`	`testMode(boolean mode)` Whether to use test mode and output the PDF uncompressed.
`PdfRendererBuilder`	`toStream(OutputStream out)` An output stream to output the resulting PDF.
`PdfRendererBuilder`	`useCache(FSCache cache)` Provides an external cache which can choose to cache items between runs, such as fonts or logo images.
`PdfRendererBuilder`	`useDefaultPageSize(float pageWidth, float pageHeight, PdfRendererBuilder.PageSizeUnits units)` Specifies the default page size to use if none is specified in CSS.
`PdfRendererBuilder`	`useFont(FSSupplier<InputStream> supplier, String fontFamily)` Simpler overload for `useFont(FSSupplier, String, Integer, FontStyle, boolean)`
`PdfRendererBuilder`	`useFont(FSSupplier<InputStream> supplier, String fontFamily, Integer fontWeight, PdfRendererBuilder.FontStyle fontStyle, boolean subset)` Add a font programmatically.
`PdfRendererBuilder`	`useHttpStreamImplementation(HttpStreamFactory factory)` Provides an HttpStreamFactory implementation if the user desires to use an external HTTP/HTTPS implementation.
`PdfRendererBuilder`	`usePdfVersion(float version)` Set the PDF version, typically we use 1.7.
`PdfRendererBuilder`	`useReplacementText(String replacement)` The replacement text to use if a character is cannot be renderered by any of the specified fonts.
`PdfRendererBuilder`	`useSVGDrawer(SVGDrawer svgImpl)` Uses the specified SVG drawer implementation.
`PdfRendererBuilder`	`useUnicodeBidiReorderer(BidiReorderer reorderer)` Provides a reorderer to properly reverse RTL text.
`PdfRendererBuilder`	`useUnicodeBidiSplitter(BidiSplitterFactory splitter)` Provides a text splitter to split text into directional runs.
`PdfRendererBuilder`	`useUnicodeCharacterBreaker(FSTextBreaker breaker)` Specify the character breaker.
`PdfRendererBuilder`	`useUnicodeLineBreaker(FSTextBreaker breaker)` Specify the line breaker.
`PdfRendererBuilder`	`useUnicodeToLowerTransformer(FSTextTransformer tr)` Specify a transformer to use to lower case strings.
`PdfRendererBuilder`	`useUnicodeToTitleTransformer(FSTextTransformer tr)` Specify a transformer to title case strings.
`PdfRendererBuilder`	`useUnicodeToUpperTransformer(FSTextTransformer tr)` Specify a transformer to use to upper case strings.
`PdfRendererBuilder`	`useUriResolver(FSUriResolver resolver)` Provides a uri resolver to resolve relative uris or private uri schemes.
`PdfRendererBuilder`	`withFile(File file)` Provides a file to convert to PDF.
`PdfRendererBuilder`	`withHtmlContent(String html, String baseUri)` Provides a string containing XHTML/XML to convert to PDF.
`PdfRendererBuilder`	`withUri(String uri)` Provides a URI to convert to PDF.
`PdfRendererBuilder`	`withW3cDocument(Document doc, String baseUri)` Provides a w3c DOM Document acquired from an external source.

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

- Field Detail
  - PAGE_SIZE_LETTER_WIDTH
```
public static final float PAGE_SIZE_LETTER_WIDTH
```
    See Also:
    
    Constant Field Values
  - PAGE_SIZE_LETTER_HEIGHT
```
public static final float PAGE_SIZE_LETTER_HEIGHT
```
    See Also:
    
    Constant Field Values
  - PAGE_SIZE_LETTER_UNITS
```
public static final PdfRendererBuilder.PageSizeUnits PAGE_SIZE_LETTER_UNITS
```
- Constructor Detail
  - PdfRendererBuilder
```
public PdfRendererBuilder()
```
- Method Detail
  - run
```
public void run()
         throws Exception
```
    Run the XHTML/XML to PDF conversion and output to an output stream set by toStream.
    
    Throws:
    
    Exception
  - buildPdfRenderer
```
public PdfBoxRenderer buildPdfRenderer()
```
    Build a PdfBoxRenderer for further customization. Remember to call PdfBoxRenderer.cleanup() after use.
    
    Returns:
  - defaultTextDirection
```
public PdfRendererBuilder defaultTextDirection(PdfRendererBuilder.TextDirection textDirection)
```
    The default text direction of the document. LTR by default.
    
    Parameters:
    
    textDirection -
    
    Returns:
  - testMode
```
public PdfRendererBuilder testMode(boolean mode)
```
    Whether to use test mode and output the PDF uncompressed. Turned off by default.
    
    Parameters:
    
    mode -
    
    Returns:
  - useHttpStreamImplementation
```
public PdfRendererBuilder useHttpStreamImplementation(HttpStreamFactory factory)
```
    Provides an HttpStreamFactory implementation if the user desires to use an external HTTP/HTTPS implementation. Uses URL::openStream by default.
    
    Parameters:
    
    factory -
    
    Returns:
  - useUriResolver
```
public PdfRendererBuilder useUriResolver(FSUriResolver resolver)
```
    Provides a uri resolver to resolve relative uris or private uri schemes.
    
    Parameters:
    
    resolver -
    
    Returns:
  - useCache
```
public PdfRendererBuilder useCache(FSCache cache)
```
    Provides an external cache which can choose to cache items between runs, such as fonts or logo images.
    
    Parameters:
    
    cache -
    
    Returns:
  - useUnicodeBidiSplitter
```
public PdfRendererBuilder useUnicodeBidiSplitter(BidiSplitterFactory splitter)
```
    Provides a text splitter to split text into directional runs. Does nothing by default.
    
    Parameters:
    
    splitter -
    
    Returns:
  - useUnicodeBidiReorderer
```
public PdfRendererBuilder useUnicodeBidiReorderer(BidiReorderer reorderer)
```
    Provides a reorderer to properly reverse RTL text. No-op by default.
    
    Parameters:
    
    reorderer -
    
    Returns:
  - withHtmlContent
```
public PdfRendererBuilder withHtmlContent(String html,
                                          String baseUri)
```
    Provides a string containing XHTML/XML to convert to PDF.
    
    Parameters:
    
    html -
    
    baseUri -
    
    Returns:
  - withW3cDocument
```
public PdfRendererBuilder withW3cDocument(Document doc,
                                          String baseUri)
```
    Provides a w3c DOM Document acquired from an external source.
    
    Parameters:
    
    doc -
    
    baseUri -
    
    Returns:
  - withUri
```
public PdfRendererBuilder withUri(String uri)
```
    Provides a URI to convert to PDF. The URI MUST point to a strict XHTML/XML document.
    
    Parameters:
    
    uri -
    
    Returns:
  - withFile
```
public PdfRendererBuilder withFile(File file)
```
    Provides a file to convert to PDF. The file MUST contain XHTML/XML in UTF-8 encoding.
    
    Parameters:
    
    file -
    
    Returns:
  - toStream
```
public PdfRendererBuilder toStream(OutputStream out)
```
    An output stream to output the resulting PDF. The caller is required to close the output stream after calling run.
    
    Parameters:
    
    out -
    
    Returns:
  - useSVGDrawer
```
public PdfRendererBuilder useSVGDrawer(SVGDrawer svgImpl)
```
    Uses the specified SVG drawer implementation.
    
    Parameters:
    
    svgImpl -
    
    Returns:
  - useDefaultPageSize
```
public PdfRendererBuilder useDefaultPageSize(float pageWidth,
                                             float pageHeight,
                                             PdfRendererBuilder.PageSizeUnits units)
```
    Specifies the default page size to use if none is specified in CSS.
    
    Parameters:
    
    pageWidth -
    
    pageHeight -
    
    units - either mm or inches.
    
    Returns:
    
    See Also:
    
    #PAGE_SIZE_LETTER_WIDTH}, {@link #PAGE_SIZE_LETTER_HEIGHT} and {@link #PAGE_SIZE_LETTER_UNITS}
  - usePdfVersion
```
public PdfRendererBuilder usePdfVersion(float version)
```
    Set the PDF version, typically we use 1.7. If you set a lower version, it is your responsibility to make sure no more recent PDF features are used.
    
    Parameters:
    
    version -
    
    Returns:
  - useReplacementText
```
public PdfRendererBuilder useReplacementText(String replacement)
```
    The replacement text to use if a character is cannot be renderered by any of the specified fonts. This is not broken across lines so should be one or zero characters for best results. Also, make sure it can be rendered by at least one of your specified fonts! The default is the # character.
    
    Parameters:
    
    replacement -
    
    Returns:
  - useUnicodeLineBreaker
```
public PdfRendererBuilder useUnicodeLineBreaker(FSTextBreaker breaker)
```
    Specify the line breaker. By default a Java default BreakIterator line instance is used with US locale. Additionally, this is wrapped with UrlAwareLineBreakIterator to also break before the forward slash (/) character so that long URIs can be broken on to multiple lines. You may want to use a BreakIterator with a different locale (wrapped by UrlAwareLineBreakIterator or not) or a more advanced BreakIterator from icu4j (see the rtl-support module for an example).
    
    Parameters:
    
    breaker -
    
    Returns:
  - useUnicodeCharacterBreaker
```
public PdfRendererBuilder useUnicodeCharacterBreaker(FSTextBreaker breaker)
```
    Specify the character breaker. By default a break iterator character instance is used with US locale. Currently this is used when word-wrap: break-word is in effect.
    
    Parameters:
    
    breaker -
    
    Returns:
  - useUnicodeToUpperTransformer
```
public PdfRendererBuilder useUnicodeToUpperTransformer(FSTextTransformer tr)
```
    Specify a transformer to use to upper case strings. By default String::toUpperCase(Locale.US) is used.
    
    Parameters:
    
    tr -
    
    Returns:
  - useUnicodeToLowerTransformer
```
public PdfRendererBuilder useUnicodeToLowerTransformer(FSTextTransformer tr)
```
    Specify a transformer to use to lower case strings. By default String::toLowerCase(Locale.US) is used.
    
    Parameters:
    
    tr -
    
    Returns:
  - useUnicodeToTitleTransformer
```
public PdfRendererBuilder useUnicodeToTitleTransformer(FSTextTransformer tr)
```
    Specify a transformer to title case strings. By default a best effort implementation (non locale aware) is used.
    
    Parameters:
    
    tr -
    
    Returns:
  - useFont
```
public PdfRendererBuilder useFont(FSSupplier<InputStream> supplier,
                                  String fontFamily,
                                  Integer fontWeight,
                                  PdfRendererBuilder.FontStyle fontStyle,
                                  boolean subset)
```
    Add a font programmatically. If the font is NOT subset, it will be downloaded when the renderer is run, otherwise the font will only be donwnloaded if needed. Therefore, the user could add many fonts, confidant that only those that are used will be downloaded and processed. The InputStream returned by the supplier will be closed by the caller. Fonts should generally be subset, except when used in form controls. FSSupplier is a lambda compatible interface. Fonts can also be added using a font-face at-rule in the CSS.
    
    Parameters:
    
    supplier -
    
    fontFamily -
    
    fontWeight -
    
    fontStyle -
    
    subset -
    
    Returns:
  - useFont
```
public PdfRendererBuilder useFont(FSSupplier<InputStream> supplier,
                                  String fontFamily)
```
    Simpler overload for useFont(FSSupplier, String, Integer, FontStyle, boolean)
    
    Parameters:
    
    supplier -
    
    fontFamily -
    
    Returns:

Class PdfRendererBuilder

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PAGE_SIZE_LETTER_WIDTH

PAGE_SIZE_LETTER_HEIGHT

PAGE_SIZE_LETTER_UNITS

Constructor Detail

PdfRendererBuilder

Method Detail

run

buildPdfRenderer

defaultTextDirection

testMode

useHttpStreamImplementation

useUriResolver

useCache

useUnicodeBidiSplitter

useUnicodeBidiReorderer

withHtmlContent

withW3cDocument

withUri

withFile

toStream

useSVGDrawer

useDefaultPageSize

usePdfVersion

useReplacementText

useUnicodeLineBreaker

useUnicodeCharacterBreaker

useUnicodeToUpperTransformer

useUnicodeToLowerTransformer

useUnicodeToTitleTransformer

useFont

useFont