Java2DRendererBuilder (Openhtmltopdf Image Rendering (Java2D) 0.0.1-RC12 API)

java.lang.Object
- com.openhtmltopdf.java2d.api.Java2DRendererBuilder

```
public class Java2DRendererBuilder
extends Object
```
Build a Java2D renderer for a given HTML. The renderer allows to get a BufferedImage of the HTML and to render it in components (using Graphics2D).

Nested Class Summary

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

Constructor Summary

Constructors
Constructor and Description

Java2DRendererBuilder()

Constructors
Constructor and Description
`Java2DRendererBuilder()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Java2DRenderer`	`buildJava2DRenderer()`
`Java2DRendererBuilder`	`defaultTextDirection(Java2DRendererBuilder.TextDirection textDirection)` The default text direction of the document.
`void`	`runFirstPage()` `useLayoutGraphics` and `toPageProcessor` MUST have been called.
`void`	`runPaged()` `useLayoutGraphics` and `toPageProcessor` MUST have been called.
`Java2DRendererBuilder`	`testMode(boolean mode)` Whether to use test mode which will output box boundaries on the result.
`Java2DRendererBuilder`	`toPageProcessor(FSPageProcessor pageProcessor)` Output the document in paged format.
`Java2DRendererBuilder`	`toSinglePage(FSPageProcessor pageProcessor)` Render everything to a single page.
`Java2DRendererBuilder`	`useCache(FSCache cache)` Provides an external cache which can choose to cache items between runs, such as fonts or logo images.
`Java2DRendererBuilder`	`useDefaultPageSize(float pageWidth, float pageHeight, Java2DRendererBuilder.PageSizeUnits units)` Specifies the default page size to use if none is specified in CSS.
`Java2DRendererBuilder`	`useFont(FSSupplier<InputStream> supplier, String fontFamily)` Simpler overload for `useFont(FSSupplier, String, Integer, FontStyle)`
`Java2DRendererBuilder`	`useFont(FSSupplier<InputStream> supplier, String fontFamily, Integer fontWeight, Java2DRendererBuilder.FontStyle fontStyle)` Add a font programmatically.
`Java2DRendererBuilder`	`useHttpStreamImplementation(HttpStreamFactory factory)` Provides an HttpStreamFactory implementation if the user desires to use an external HTTP/HTTPS implementation.
`Java2DRendererBuilder`	`useInitialPageNumber(int pageNumberInitial)` Used to set an initial page number for use with page counters, etc.
`Java2DRendererBuilder`	`useLayoutGraphics(Graphics2D g2d)` Compulsory method.
`Java2DRendererBuilder`	`useObjectDrawerFactory(FSObjectDrawerFactory objectDrawerFactory)` Set a factory for <object> drawers
`Java2DRendererBuilder`	`useReplacementText(String replacement)` The replacement text to use if a character is cannot be renderered by any of the specified fonts.
`Java2DRendererBuilder`	`useSVGDrawer(SVGDrawer svgImpl)` Uses the specified SVG drawer implementation.
`Java2DRendererBuilder`	`useUnicodeBidiReorderer(BidiReorderer reorderer)` Provides a reorderer to properly reverse RTL text.
`Java2DRendererBuilder`	`useUnicodeBidiSplitter(BidiSplitterFactory splitter)` Provides a text splitter to split text into directional runs.
`Java2DRendererBuilder`	`useUnicodeCharacterBreaker(FSTextBreaker breaker)` Specify the character breaker.
`Java2DRendererBuilder`	`useUnicodeLineBreaker(FSTextBreaker breaker)` Specify the line breaker.
`Java2DRendererBuilder`	`useUnicodeToLowerTransformer(FSTextTransformer tr)` Specify a transformer to use to lower case strings.
`Java2DRendererBuilder`	`useUnicodeToTitleTransformer(FSTextTransformer tr)` Specify a transformer to title case strings.
`Java2DRendererBuilder`	`useUnicodeToUpperTransformer(FSTextTransformer tr)` Specify a transformer to use to upper case strings.
`Java2DRendererBuilder`	`useUriResolver(FSUriResolver resolver)` Provides a uri resolver to resolve relative uris or private uri schemes.
`Java2DRendererBuilder`	`withFile(File file)` Provides a file to convert to PDF.
`Java2DRendererBuilder`	`withHtmlContent(String html, String baseUri)` Provides a string containing XHTML/XML to convert to image.
`Java2DRendererBuilder`	`withUri(String uri)` Provides a URI to convert to image.
`Java2DRendererBuilder`	`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

- Constructor Detail
  - Java2DRendererBuilder
```
public Java2DRendererBuilder()
```
- Method Detail
  - useHttpStreamImplementation
```
public Java2DRendererBuilder 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 Java2DRendererBuilder useUriResolver(FSUriResolver resolver)
```
    Provides a uri resolver to resolve relative uris or private uri schemes.
    
    Parameters:
    
    resolver -
    
    Returns:
  - useCache
```
public Java2DRendererBuilder useCache(FSCache cache)
```
    Provides an external cache which can choose to cache items between runs, such as fonts or logo images.
    
    Parameters:
    
    cache -
    
    Returns:
  - withHtmlContent
```
public Java2DRendererBuilder withHtmlContent(String html,
                                             String baseUri)
```
    Provides a string containing XHTML/XML to convert to image.
    
    Parameters:
    
    html -
    
    baseUri -
    
    Returns:
  - withW3cDocument
```
public Java2DRendererBuilder withW3cDocument(Document doc,
                                             String baseUri)
```
    Provides a w3c DOM Document acquired from an external source.
    
    Parameters:
    
    doc -
    
    baseUri -
    
    Returns:
  - withUri
```
public Java2DRendererBuilder withUri(String uri)
```
    Provides a URI to convert to image. The URI MUST point to a strict XHTML/XML document.
    
    Parameters:
    
    uri -
    
    Returns:
  - useSVGDrawer
```
public Java2DRendererBuilder useSVGDrawer(SVGDrawer svgImpl)
```
    Uses the specified SVG drawer implementation.
    
    Parameters:
    
    svgImpl -
    
    Returns:
  - useLayoutGraphics
```
public Java2DRendererBuilder useLayoutGraphics(Graphics2D g2d)
```
    Compulsory method. The layout graphics are used to measure text and should be from an image or device with the same characteristics as the output graphicsw provided by the page processor.
    
    Parameters:
    
    g2d -
    
    Returns:
  - defaultTextDirection
```
public Java2DRendererBuilder defaultTextDirection(Java2DRendererBuilder.TextDirection textDirection)
```
    The default text direction of the document. LTR by default.
    
    Parameters:
    
    textDirection -
    
    Returns:
  - testMode
```
public Java2DRendererBuilder testMode(boolean mode)
```
    Whether to use test mode which will output box boundaries on the result. Turned off by default.
    
    Parameters:
    
    mode -
    
    Returns:
  - useUnicodeBidiSplitter
```
public Java2DRendererBuilder useUnicodeBidiSplitter(BidiSplitterFactory splitter)
```
    Provides a text splitter to split text into directional runs. Does nothing by default.
    
    Parameters:
    
    splitter -
    
    Returns:
  - useUnicodeBidiReorderer
```
public Java2DRendererBuilder useUnicodeBidiReorderer(BidiReorderer reorderer)
```
    Provides a reorderer to properly reverse RTL text. No-op by default.
    
    Parameters:
    
    reorderer -
    
    Returns:
  - withFile
```
public Java2DRendererBuilder withFile(File file)
```
    Provides a file to convert to PDF. The file MUST contain XHTML/XML in UTF-8 encoding.
    
    Parameters:
    
    file -
    
    Returns:
  - useReplacementText
```
public Java2DRendererBuilder 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 Java2DRendererBuilder 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 Java2DRendererBuilder 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 Java2DRendererBuilder 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 Java2DRendererBuilder 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 Java2DRendererBuilder 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 Java2DRendererBuilder useFont(FSSupplier<InputStream> supplier,
                                     String fontFamily,
                                     Integer fontWeight,
                                     Java2DRendererBuilder.FontStyle fontStyle)
```
    Add a font programmatically. The font will only be downloaded if needed. The InputStream returned by the supplier will be closed by the caller. 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 -
    
    Returns:
  - useFont
```
public Java2DRendererBuilder useFont(FSSupplier<InputStream> supplier,
                                     String fontFamily)
```
    Simpler overload for useFont(FSSupplier, String, Integer, FontStyle)
    
    Parameters:
    
    supplier -
    
    fontFamily -
    
    Returns:
  - useDefaultPageSize
```
public Java2DRendererBuilder useDefaultPageSize(float pageWidth,
                                                float pageHeight,
                                                Java2DRendererBuilder.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}
  - useInitialPageNumber
```
public Java2DRendererBuilder useInitialPageNumber(int pageNumberInitial)
```
    Used to set an initial page number for use with page counters, etc.
    
    Parameters:
    
    pageNumberInitial -
    
    Returns:
  - toSinglePage
```
public Java2DRendererBuilder toSinglePage(FSPageProcessor pageProcessor)
```
    Render everything to a single page. I.e. only one big page is genereated, no pagebreak will be done. The page is only as height as needed.
  - toPageProcessor
```
public Java2DRendererBuilder toPageProcessor(FSPageProcessor pageProcessor)
```
    Output the document in paged format. The user can use the DefaultPageProcessor or use its source as a reference to code their own page processor for advanced usage.
    
    Parameters:
    
    pageProcessor -
    
    Returns:
  - runPaged
```
public void runPaged()
              throws Exception
```
    useLayoutGraphics and toPageProcessor MUST have been called. Also a document MUST have been set with one of the with* methods. This will build the renderer and output each page of the document to the specified page processor.
    
    Throws:
    
    Exception
  - runFirstPage
```
public void runFirstPage()
                  throws Exception
```
    useLayoutGraphics and toPageProcessor MUST have been called. Also a document MUST have been set with one of the with* methods. This will build the renderer and output the first page of the document to the specified page processor.
    
    Throws:
    
    Exception
  - buildJava2DRenderer
```
public Java2DRenderer buildJava2DRenderer()
```
  - useObjectDrawerFactory
```
public Java2DRendererBuilder useObjectDrawerFactory(FSObjectDrawerFactory objectDrawerFactory)
```
    Set a factory for <object> drawers
    
    Parameters:
    
    objectDrawerFactory - Object Drawer Factory
    
    Returns:
    
    this for method chaining

Class Java2DRendererBuilder

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Java2DRendererBuilder

Method Detail

useHttpStreamImplementation

useUriResolver

useCache

withHtmlContent

withW3cDocument

withUri

useSVGDrawer

useLayoutGraphics

defaultTextDirection

testMode

useUnicodeBidiSplitter

useUnicodeBidiReorderer

withFile

useReplacementText

useUnicodeLineBreaker

useUnicodeCharacterBreaker

useUnicodeToUpperTransformer

useUnicodeToLowerTransformer

useUnicodeToTitleTransformer

useFont

useFont

useDefaultPageSize

useInitialPageNumber

toSinglePage

toPageProcessor

runPaged

runFirstPage

buildJava2DRenderer

useObjectDrawerFactory