public class Java2DRendererBuilder extends Object
| Modifier and Type | Class and Description |
|---|---|
static class |
Java2DRendererBuilder.FontStyle |
static class |
Java2DRendererBuilder.Graphics2DPaintingReplacedElement |
static class |
Java2DRendererBuilder.PageSizeUnits |
static class |
Java2DRendererBuilder.TextDirection |
| Constructor and Description |
|---|
Java2DRendererBuilder() |
| 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.
|
public Java2DRendererBuilder useHttpStreamImplementation(HttpStreamFactory factory)
factory - public Java2DRendererBuilder useUriResolver(FSUriResolver resolver)
resolver - public Java2DRendererBuilder useCache(FSCache cache)
cache - public Java2DRendererBuilder withHtmlContent(String html, String baseUri)
html - baseUri - public Java2DRendererBuilder withW3cDocument(Document doc, String baseUri)
doc - baseUri - public Java2DRendererBuilder withUri(String uri)
uri - public Java2DRendererBuilder useSVGDrawer(SVGDrawer svgImpl)
svgImpl - public Java2DRendererBuilder useLayoutGraphics(Graphics2D g2d)
g2d - public Java2DRendererBuilder defaultTextDirection(Java2DRendererBuilder.TextDirection textDirection)
textDirection - public Java2DRendererBuilder testMode(boolean mode)
mode - public Java2DRendererBuilder useUnicodeBidiSplitter(BidiSplitterFactory splitter)
splitter - public Java2DRendererBuilder useUnicodeBidiReorderer(BidiReorderer reorderer)
reorderer - public Java2DRendererBuilder withFile(File file)
file - public Java2DRendererBuilder useReplacementText(String replacement)
replacement - public Java2DRendererBuilder useUnicodeLineBreaker(FSTextBreaker breaker)
breaker - public Java2DRendererBuilder useUnicodeCharacterBreaker(FSTextBreaker breaker)
word-wrap: break-word is in
effect.breaker - public Java2DRendererBuilder useUnicodeToUpperTransformer(FSTextTransformer tr)
String::toUpperCase(Locale.US) is used.tr - public Java2DRendererBuilder useUnicodeToLowerTransformer(FSTextTransformer tr)
String::toLowerCase(Locale.US) is used.tr - public Java2DRendererBuilder useUnicodeToTitleTransformer(FSTextTransformer tr)
tr - public Java2DRendererBuilder useFont(FSSupplier<InputStream> supplier, String fontFamily, Integer fontWeight, Java2DRendererBuilder.FontStyle fontStyle)
supplier - fontFamily - fontWeight - fontStyle - public Java2DRendererBuilder useFont(FSSupplier<InputStream> supplier, String fontFamily)
useFont(FSSupplier, String, Integer, FontStyle)supplier - fontFamily - public Java2DRendererBuilder useDefaultPageSize(float pageWidth, float pageHeight, Java2DRendererBuilder.PageSizeUnits units)
pageWidth - pageHeight - units - either mm or inches.#PAGE_SIZE_LETTER_WIDTH}, {@link #PAGE_SIZE_LETTER_HEIGHT} and {@link #PAGE_SIZE_LETTER_UNITS}public Java2DRendererBuilder useInitialPageNumber(int pageNumberInitial)
pageNumberInitial - public Java2DRendererBuilder toSinglePage(FSPageProcessor pageProcessor)
public Java2DRendererBuilder toPageProcessor(FSPageProcessor pageProcessor)
pageProcessor - 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.Exceptionpublic 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.Exceptionpublic Java2DRenderer buildJava2DRenderer()
public Java2DRendererBuilder useObjectDrawerFactory(FSObjectDrawerFactory objectDrawerFactory)
objectDrawerFactory - Object Drawer FactoryCopyright © 2017. All rights reserved.