Package org.jpedal.render.output.html

Class HTMLConversionOptions

java.lang.Object
org.jpedal.render.output.ConversionOptions
org.jpedal.render.output.html.HTMLConversionOptions
public class HTMLConversionOptions extends ConversionOptions
The class to use for setting conversion options when converting to HTML.

  • Constructor Details

    • HTMLConversionOptions

      public HTMLConversionOptions(Map<String,String> jvmOptions)

    • HTMLConversionOptions

      public HTMLConversionOptions()

    • HTMLConversionOptions

      public HTMLConversionOptions(String optionsAsString)

  • Method Details

    • setTextMode

      public HTMLConversionOptions setTextMode(ConversionOptions.TextMode value)
      The text mode controls how text is rendered in the html output, for example your text can be made selectable or as an image and made non selectable.

      For an explanation of text modes, please click here.

      Important : shapetext modes extract the font metrics from the embedded fonts and includes them as shapes. If there are no embedded fonts then the converter will use Arial to ensure that text is actually displayed, although this may not be an ideal match (and we recommend using embedded fonts).

      In the case where there are no embedded fonts, it's best to use a realtext mode.

      Possible values:

      • svg_realtext
      • svg_shapetext_selectable
      • svg_shapetext_nonselectable
      • image_realtext
      • image_shapetext_selectable
      • image_shapetext_nonselectable

      Default: svg_realtext

      Also set in the JVM options with -Dorg.jpedal.pdf2html.textMode=

      Parameters:
      value - The TextMode to use for conversion.
      Returns:
      the HTMLConversionOptions Object.

    • setDisableComments

      public HTMLConversionOptions setDisableComments(boolean value)
      Disable comments inserted into the HTML output for clarity.

      Sections within the generated output are marked up with <!-- HTML comment tags --> to aid understanding of generated output and help parsing if necessary. Enabling this setting will remove those comments.

      Possible values:

      • true/false

      Default: true

      Also set with -Dorg.jpedal.pdf2html.disableComments=

      Parameters:
      value - Boolean true/false.
      Returns:
      the HTMLConversionOptions Object.

    • setAddJavaScript

      public HTMLConversionOptions setAddJavaScript(boolean value)
      Include all the JavaScript that is within the PDF file. This setting is for FormVu only and has no effect in BuildVu.

      Possible values:

      • true/false

      Default: false

      Also set with -Dorg.jpedal.pdf2html.addJavaScript=

      Parameters:
      value - Boolean true/false.
      Returns:
      the HTMLConversionOptions Object.

    • setInlineSVG

      public HTMLConversionOptions setInlineSVG(boolean value)
      Inline SVG within HTML (pure svg text modes only).

      This inlines the SVG within HTML so that there is no separate .svg file.

      Possible values:

      • true/false

      Default: false

      Also set with -Dorg.jpedal.pdf2html.inlineSVG=

      Parameters:
      value - Boolean true/false.
      Returns:
      the HTMLConversionOptions Object.

    • setOverlay

      @Deprecated(since="2014") public HTMLConversionOptions setOverlay(boolean value)
      Deprecated.
      we do not recommend that this option be used.
      Allow user to disable overlay we insert to fix selection issues in IE/FireFox if you only use IPad and want to add your own selection events (should generally not be used)

      Possible values:

      • true/false

      Default: true

      Also set with -Dorg.jpedal.pdf2html.overlay=

      Parameters:
      value - Boolean true/false.
      Returns:
      the HTMLConversionOptions Object.

    • setMinFontSize

      public HTMLConversionOptions setMinFontSize(int value)
      Sets the minimum font size to be used. This setting is designed for content aimed at Chinese, Japanese, Korean, Thai, and other markets where the locale-specific version of Chrome has a default minimum font size of 12px (Chinese) or 10px (Japanese).

      When this setting is used, any text below the provided font size will be rendered at that size and scaled down to the correct size using a CSS scale transform. Without this setting, Chrome may display text larger than intended.

      More information: https://bugs.chromium.org/p/chromium/issues/detail?id=36429

      Possible values:

      • 12 (for the Chinese market)
      • 10 (for the Japanese market)
      • Any integer value
      Default: 0

      Also set with -Dorg.jpedal.pdf2html.minFontSize=

      Parameters:
      value - int minimum font size to be used.
      Returns:
      the HTMLConversionOptions Object.
      Since:
      2021.08

    • setEmbedSvgAsBase64Image

      public HTMLConversionOptions setEmbedSvgAsBase64Image(boolean value)
      Embeds the SVG background directly into the HTML file as a base64 image. This also has the effect of base64 embedding the images inside the SVG.

      Where possible, we recommend using the inlineSVG setting instead as it is more efficient. This is because base64 uses 4 ascii characters to encode 24-bits (3 bytes) of data. With this setting, images are base64 encoded within the SVG, and then the SVG is itself also base64 encoded within the HTML. Therefore, images use 1.78x bytes compared with externally referencing them. In addition, inline SVG is highly compressible when gzip compression is enabled by the web server, whereas base64 content is not.

      Note: This setting is not compatible with the experimental text mode setting.

      Possible values:

      • true/false

      Default: true

      Also set with -Dorg.jpedal.pdf2html.embedSvgAsBase64Image=

      Parameters:
      value - boolean true/false.
      Returns:
      the HTMLConversionOptions Object.
      Since:
      2022.08

    • setOmitNameDir

      public HTMLConversionOptions setOmitNameDir(boolean b)
      Controls the folder structure of the output.

      By default, pages are output within a directory with the same name as the PDF file within the output directory specified.

      Setting omitNameDir to true will cause pages to be output directly within the output directory specified. Possible values:

      • true/false

      Default: false

      Also set with -Dorg.jpedal.pdf2html.omitNameDir=

      Overrides:
      setOmitNameDir in class ConversionOptions
      Parameters:
      b - Boolean true/false.
      Returns:
      the ConversionOptions Object.

    • setCompressSVG

      public HTMLConversionOptions setCompressSVG(boolean b)
      Generates compressed .svgz files rather than .svg. This can reduce SVG file sizes by as much as 80-90%, but you will need to configure your web server to correctly serve .svgz files.

      SVGZ files are simply SVG files which have been gzip compressed. Gzip compressed SVG files are supported by all modern browsers (IE9 onwards, Firefox, Chrome, etc) as long as the web server is configured correctly.

      More modern compression formats with higher compression ratios (such as brotli) are now supported by web servers. If configured appropriately, web servers can automatically generate and serve compressed content without needing to use this BuildVu setting.

      Important: When using this BuildVu setting you must ensure that SVGZ files are served with the Content-Encoding: gzip header in order for web browsers to understand them. For further instructions, see Enabling GZIP Compression

      Possible values:

      • true/false

      Default: false

      Also set with -Dorg.jpedal.pdf2html.compressSVG=

      Overrides:
      setCompressSVG in class ConversionOptions
      Parameters:
      b - Boolean true/false.
      Returns:
      the ConversionOptions Object.

    • setScaling

      public HTMLConversionOptions setScaling(float value)
      Sets the Scaling value of the converted content.

      Possible values:

      • 1 (float multiplier)
      • 1000x1000 (best fit width/height)
      • fitWidth1000 (best fit width)
      • fitHeight1000 (best fit height)

      Default: 1

      Also set with -Dorg.jpedal.pdf2html.scaling=

      Overrides:
      setScaling in class ConversionOptions
      Parameters:
      value - is of type float.
      Returns:
      the ConversionOptions Object.

    • setLogicalPageRange

      public HTMLConversionOptions setLogicalPageRange(PageRanges value)
      Set a page range using logical page numbering. This setting treats the document as if it only contains the pages defined in the page range.

      For example, a 7-page document with the page range "2,4,6" will generate 1.html, 2.html and 3.html, and other assets will behave as if only these pages exist.

      Important: Some assets such as config.js/properties.json/annotations.json may not be compatible with this setting.

      Possible values:

      • comma separated values including ranges. E.g. "1,3,5-8,10"

      Default: null

      Also set with -Dorg.jpedal.pdf2html.logicalPageRange=

      Overrides:
      setLogicalPageRange in class ConversionOptions
      Parameters:
      value - is of Object type PageRanges.
      Returns:
      the ConversionOptions Object.

    • setRealPageRange

      public HTMLConversionOptions setRealPageRange(PageRanges value)
      Set a page range using real page numbering. This setting treats the document as if it contains every page, however only the pages defined in the range will be converted.

      For example, a 7-page document with the page range "2,4,6" will generate 2.html, 4.html and 6.html, and other assets will behave as if pages 1, 3, 5 also 7 exist.

      Important: Some assets such as config.js/properties.json/annotations.json/search.json/index.html may not be compatible with this setting.

      Possible values:

      • Comma separated values including ranges. E.g. "1,3,5-8,10"

      Default value: all pages, e.g. "1-39"

      Also set with -Dorg.jpedal.pdf2html.realPageRange=

      Overrides:
      setRealPageRange in class ConversionOptions
      Parameters:
      value - is of Object type PageRanges.
      Returns:
      the ConversionOptions Object.

    • setScalingFitWidth

      public HTMLConversionOptions setScalingFitWidth(int value)
      Overrides:
      setScalingFitWidth in class ConversionOptions

    • setScalingFitWidthHeight

      public HTMLConversionOptions setScalingFitWidthHeight(int width, int height)
      Overrides:
      setScalingFitWidthHeight in class ConversionOptions

    • setScalingFitHeight

      public HTMLConversionOptions setScalingFitHeight(int value)
      Overrides:
      setScalingFitHeight in class ConversionOptions

    • setMaxPageWidth

      public HTMLConversionOptions setMaxPageWidth(int width)
      Sets the maximum width of the converted document. This can be used in conjunction with setMaxPageHeight to limit page dimensions to a given size.

      Pages larger than the given dimensions will be scaled down to fit within those dimensions. Pages smaller than the given dimensions will be unaffected.

      This setting may be useful to prevent rogue documents with unusually large pages from causing OutOfMemoryErrors (which may otherwise bring down the JVM).

      Possible values:

      • Any positive integer value

      Default: 5000

      Also set with -Dorg.jpedal.pdf2html.maxPageWidth=

      Overrides:
      setMaxPageWidth in class ConversionOptions
      Parameters:
      width - the maximum page width.
      Returns:
      the ConversionOptions Object.

    • setMaxPageHeight

      public HTMLConversionOptions setMaxPageHeight(int height)
      Sets the maximum height of the converted document. This can be used in conjunction with setMaxPageWidth to limit page dimensions to a given size.

      Pages larger than the given dimensions will be scaled down to fit within those dimensions. Pages smaller than the given dimensions will be unaffected.

      This setting may be useful to prevent rogue documents with unusually large pages from causing OutOfMemoryErrors (which may otherwise bring down the JVM).

      Possible values:

      • Any positive integer value

      Default: 5000

      Also set with -Dorg.jpedal.pdf2html.maxPageHeight=

      Overrides:
      setMaxPageHeight in class ConversionOptions
      Parameters:
      height - the maximum page height.
      Returns:
      the ConversionOptions Object.

    • setEmbedImagesAsBase64Stream

      public HTMLConversionOptions setEmbedImagesAsBase64Stream(boolean value)
      Embed images as Base64 stream.

      Inserts the images directly into the file as a base64 stream instead of referencing an external file.

      Possible values:

      • true/false

      Default: false

      Also set with -Dorg.jpedal.pdf2html.embedImagesAsBase64Stream=

      Overrides:
      setEmbedImagesAsBase64Stream in class ConversionOptions
      Parameters:
      value - is of type boolean.
      Returns:
      the ConversionOptions Object.

    • setConvertSpacesToNbsp

      public HTMLConversionOptions setConvertSpacesToNbsp(boolean value)
      Convert spaces into Non-breaking Spaces (&nbsp;) in the output.

      Possible values:

      • true/false

      Default: false

      Also set with -Dorg.jpedal.pdf2html.convertSpacesToNbsp=

      Overrides:
      setConvertSpacesToNbsp in class ConversionOptions
      Parameters:
      value - is of type boolean.
      Returns:
      the ConversionOptions Object.

    • setConvertPDFExternalFileToOutputType

      public HTMLConversionOptions setConvertPDFExternalFileToOutputType(boolean value)
      Set whether to convert links pointing to file.pdf into file.html inside GoToR and Launch link annotations. This setting is for FormVu only and has no effect in BuildVu.

      Possible values:

      • true/false

      Default: true

      Also set with -Dorg.jpedal.pdf2html.convertPDFExternalFileToOutputType=

      Overrides:
      setConvertPDFExternalFileToOutputType in class ConversionOptions
      Parameters:
      value - is of type boolean.
      Returns:
      the ConversionOptions Object.

    • setFormTag

      public HTMLConversionOptions setFormTag(String value)
      Replacing <form> with your version. This setting is for FormVu only and has no effect in BuildVu.

      Possible values:

      • <form **your code here**>

      Default: <form>

      Also set with -Dorg.jpedal.pdf2html.formTag=

      Overrides:
      setFormTag in class ConversionOptions
      Parameters:
      value - is of type String.
      Returns:
      the ConversionOptions Object.

    • setIncludedFonts

      public HTMLConversionOptions setIncludedFonts(ConversionOptions.Font[] includedFonts)
      Specify the font types to generate. We recommend using WOFF due to its smaller file size and excellent browser compatibility, unless you have a specific need for OTF. Generated fonts are shared by all pages in the document.

      Additionally, you can use Base64 variants of the fonts (e.g., woff_base64 or otf_base64) to embed the font directly within the HTML/SVG without relying on external files.

      Note: Base64 variants embed a copy of the font directly into each page that uses it, which can significantly increase the output file size. Furthermore, generated Base64 fonts include only the necessary mappings for the current page which means there will be a larger number of unique fonts generated for the document compared to non-base64 variants.

      Possible values:

      Any comma separated list containing:

      • woff
      • otf
      • woff_base64,
      • otf_base64
      Default: woff

      Also set with -Dorg.jpedal.pdf2html.includedFonts=

      Overrides:
      setIncludedFonts in class ConversionOptions
      Parameters:
      includedFonts - is an array of Object type Font.
      Returns:
      the ConversionOptions Object.

    • setKeepGlyfsSeparate

      public HTMLConversionOptions setKeepGlyfsSeparate(boolean value)
      Position each glyph individually for more accurate positioning.

      Produces a larger file but may suit some use cases

      Possible values:

      • true/false
      Default: false

      Also set with -Dorg.jpedal.pdf2html.keepGlyfsSeparate=

      Overrides:
      setKeepGlyfsSeparate in class ConversionOptions
      Parameters:
      value - is of type boolean.
      Returns:
      the ConversionOptions Object.

    • setSeparateToWords

      public HTMLConversionOptions setSeparateToWords(boolean value)
      Divide text chunks into words based on spaces This improves accuracy but not as much as keepGlyfsSeparate, It produces a larger file but may suit some use cases.

      Possible values:

      • true/false

      Default: false

      Also set with -Dorg.jpedal.pdf2html.separateTextToWords=

      Overrides:
      setSeparateToWords in class ConversionOptions
      Parameters:
      value - is of type boolean.
      Returns:
      the ConversionOptions Object.

    • setFontsToRasterizeInTextMode

      public HTMLConversionOptions setFontsToRasterizeInTextMode(String value)
      In Text Modes, you can override real text on a font by font basis,

      In svg_realtext text will appear as part of SVG as Vectors This setting has no effect in other modes,

      Needs to start EXCLUDE= or INCLUDE= followed by a list of comma separated fonts Comparison is case-insensitive so Arial, ARIAL and arial are the same.

      Possible values:

      • INCLUDE=font1,font2,font3 ... (rasterized JUST these fonts)
      • EXCLUDE=font1,font2,font3 ... (rasterized all fonts EXCEPT these fonts)

      For example:

      • options.setFontsToRasterizeInTextMode("EXCLUDE=PTSerif-Regular,Arial");
      • options.setFontsToRasterizeInTextMode("INCLUDE=PTSerif-Regular,Arial");

      Default: no effect

      Also set with -Dorg.jpedal.pdf2html.fontsToRasterizeInTextMode=

      Overrides:
      setFontsToRasterizeInTextMode in class ConversionOptions
      Parameters:
      value - is of type String.
      Returns:
      the ConversionOptions Object.

    • setCompressImages

      public HTMLConversionOptions setCompressImages(boolean value)
      When enabled, generated PNG images will be compressed to reduce file size.

      This setting has an effect only when svg text modes are used, or when setUseLegacyImageFileType is set to true.

      Rather than producing 24 bit RGB or 32 bit RGBA truecolor PNG images, instead the converter will produce 8 bit palette images that have undergone quantization and dithering. This is a lossy compression, but visual quality remains very high.

      Enabling compression will make conversion slower. On average, expect conversion time to at least double. File size saving can be significant. On files with large images, it is not unusual to see savings of 70-80% on the image file size.

      Possible value:

      • true/false

      Default: true

      Also set with -Dorg.jpedal.pdf2html.compressImages=

      Overrides:
      setCompressImages in class ConversionOptions
      Parameters:
      value - is of type boolean
      Returns:
      the ConversionOptions Object.

    • setUseLegacyImageFileType

      public HTMLConversionOptions setUseLegacyImageFileType(boolean value)
      If enabled, all images output will use the PNG file type.

      Possible value:

      • true/false

      Default: false

      Also set with -Dorg.jpedal.pdf2html.useLegacyImageFileType=

      Overrides:
      setUseLegacyImageFileType in class ConversionOptions
      Parameters:
      value - is of type boolean.
      Returns:
      the ConversionOptions Object.

    • setImageScale

      public HTMLConversionOptions setImageScale(float imageScale)
      Write out larger images to allow higher quality zooming.

      Default value is 1, which produces images at the same size they are displayed when the zoom is 100%. A value of 1.5 will generate images at 1.5x the standard size. The maximum size of an image is capped at the size of the source image stored in the PDF file. For example if the source image is 150x150, then increasing the imageScale value will not generate an image larger than 150x150.

      It is important to remember that file size grows exponentially with the scaling factor. For example, scaling an image by 2 actually multiplies the number of pixels by 4. We therefore recommend a value such as 1.5 or 2.

      Possible values:

      • Float value greater than 1 e.g. 1.5, 2

      Default: 1

      Also set with -Dorg.jpedal.pdf2html.imageScale=

      Overrides:
      setImageScale in class ConversionOptions
      Parameters:
      imageScale - is of type float
      Returns:
      the ConversionOptions Object.

    • setPageFlatteningImageThreshold

      public HTMLConversionOptions setPageFlatteningImageThreshold(int threshold)
      Set the threshold for the number of images which, once reached, will cause the page will be flattened into a single image to improve performance in the browser.

      Possible values:

      • Any positive integer value

      Default: 200

      Also set with -Dorg.jpedal.pdf2html.pageFlatteningImageThreshold=

      Overrides:
      setPageFlatteningImageThreshold in class ConversionOptions
      Parameters:
      threshold - the threshold at which the page will be flattened
      Returns:
      the ConversionOptions Object.

    • setClipOffsetAmount

      public HTMLConversionOptions setClipOffsetAmount(float offsetAmount)
      Set the distance in pixels that polygons are expanded by in order to reduce fractional white lines

      Possible values:

      • Any floating point value

      Default: 0.3

      Also set with -Dorg.jpedal.pdf2html.clipOffsetAmount=

      Overrides:
      setClipOffsetAmount in class ConversionOptions
      Parameters:
      offsetAmount - the distance in pixels to expand the clip edges by
      Returns:
      the ConversionOptions Object.

    • setOriginalFileName

      public HTMLConversionOptions setOriginalFileName(String originalFileName)
      Spoof the filename of the document being converted. This setting is useful when the filename is not specified such as when converting from InputStream or byte array, or when the filename has been sanitized.

      This value controls the following:

      • The name of the output directory (sanitized)
      • The title used by the IDRViewer (when a title is not defined within the PDF file)
      • In FormVu, the filename used when resaving the form as PDF

      Possible values:

      • Non-null alphanumeric string

      Default: unset

      Also set with -Dorg.jpedal.pdf2html.originalFileName=

      Overrides:
      setOriginalFileName in class ConversionOptions
      Parameters:
      originalFileName - the filename to be used
      Returns:
      the ConversionOptions Object.

    • setPixelsPerInch

      public HTMLConversionOptions setPixelsPerInch(int pixelsPerInch)
      Set the internal resolution which determines the page size at 100% zoom/scaling.

      The default size of a unit in the PDF coordinate system is 1/72 inch (72 units per inch). However, the majority of PDF readers display PDF files at either 96 or 110 PPI (pixels per inch). This means that at 100% zoom/scaling, most PDF Readers actually apply an internal scaling of ~1.33 (110/96) or ~1.528 (110/72).

      BuildVu and FormVu use the same technique by using a default resolution of 110 PPI, which is why the pixel values in the output produced are approximately 1.5x the units defined within the PDF file.

      This configuration option can be used to modify the resolution, for example using a value of 72 would mean the pixel values align with the units defined within the PDF file.

      Note: Other settings (such as scaling, maxPageWidth and maxPageHeight) also affect the size of the converted document.

      Note: This setting should not be thought of as affecting pixel density. Instead, it determines the page size at default zoom/scaling.

      Possible values:

      • Any positive integer value, although in practice a value such as 72, 96 or 110 would be typical.

      Default: 110

      Also set with -Dorg.jpedal.pdf2html.pixelsPerInch=

      Overrides:
      setPixelsPerInch in class ConversionOptions
      Parameters:
      pixelsPerInch - the pixels per inch to be used
      Returns:
      the ConversionOptions Object.

    • setTinyTextRemovalThreshold

      public HTMLConversionOptions setTinyTextRemovalThreshold(float fontSize)
      Removes text below the given font size in the generated output.

      This prevents files containing a large amount of tiny text from creating bloated output which is slow to load and render in the web browser.

      Note: This value is based on the PDF coordinate system, meaning it acts independently of the values used for the scaling and pixelsPerInch settings.

      Possible values:

      • Any positive float value, or 0 to disable this functionality

      Default: 0.5

      Also set with -Dorg.jpedal.pdf2html.tinyTextRemovalThreshold=

      Overrides:
      setTinyTextRemovalThreshold in class ConversionOptions
      Parameters:
      fontSize - the font size threshold below which text is removed
      Returns:
      the ConversionOptions Object.

    • setDisableExternalHyperlinks

      public HTMLConversionOptions setDisableExternalHyperlinks(boolean value)
      Prevents outbound hyperlinks being included in the output.

      This includes links defined within annotations as well as auto-detected hyperlinks within the PDF text.

      Possible values:

      • true/false

      Default: false

      Also set with -Dorg.jpedal.pdf2html.disableExternalHyperlinks=

      Overrides:
      setDisableExternalHyperlinks in class ConversionOptions
      Parameters:
      value - is of type boolean
      Returns:
      the ConversionOptions Object.

    • setDisableHyperlinkDetection

      public HTMLConversionOptions setDisableHyperlinkDetection(boolean value)
      Disables the functionality that detects hyperlinks within PDF text.

      In PDF, the only way to insert a hyperlink is using an annotation. However, most PDF readers will also try to detect hyperlinks within the text and make them clickable, too. In BuildVu/FormVu, such auto-detected hyperlinks are spoofed as annotations with the type `TextLink`.

      This setting disables the link detection functionality, preventing the spoofed `TextLink` annotations. Links that are defined as annotations within the PDF file will still be included in the output. Please see the `disableExternalHyperlinks` setting to disable all hyperlinks.

      Possible values:

      • true/false

      Default: false

      Also set with -Dorg.jpedal.pdf2html.disableHyperlinkDetection=

      Overrides:
      setDisableHyperlinkDetection in class ConversionOptions
      Parameters:
      value - is of type boolean
      Returns:
      the ConversionOptions Object.

    • getAddJavaScript

      public boolean getAddJavaScript()