Package org.jpedal.render.output

Class ConversionOptions

java.lang.Object
org.jpedal.render.output.ConversionOptions
Direct Known Subclasses:
HTMLConversionOptions
public abstract class ConversionOptions extends Object
The parent abstract class for HTMLConversionOptions and SVGConversionOptions.

  • Constructor Details

    • ConversionOptions

      public ConversionOptions()

  • Method Details

    • notSet

      @Deprecated(since="2015") public boolean notSet(String key)
      Deprecated.
      - kept for backwards code support (do not use)
      Parameters:
      key - is of type String.
      Returns:
      boolean used internally to show if valid.

    • setRealPageRange

      public ConversionOptions 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=

      Parameters:
      value - is of Object type PageRanges.
      Returns:
      the ConversionOptions Object.

    • setLogicalPageRange

      public ConversionOptions 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=

      Parameters:
      value - is of Object type PageRanges.
      Returns:
      the ConversionOptions Object.

    • setOmitNameDir

      public ConversionOptions 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=

      Parameters:
      b - Boolean true/false.
      Returns:
      the ConversionOptions Object.

    • setCompressSVG

      public ConversionOptions 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=

      Parameters:
      b - Boolean true/false.
      Returns:
      the ConversionOptions Object.

    • setScaling

      public ConversionOptions 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=

      Parameters:
      value - is of type float.
      Returns:
      the ConversionOptions Object.

    • setScalingFitWidth

      public ConversionOptions setScalingFitWidth(int value)

    • setScalingFitHeight

      public ConversionOptions setScalingFitHeight(int value)

    • setScalingFitWidthHeight

      public ConversionOptions setScalingFitWidthHeight(int width, int height)

    • setMaxPageWidth

      public ConversionOptions 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=

      Parameters:
      width - the maximum page width.
      Returns:
      the ConversionOptions Object.
      Since:
      2023.05

    • setMaxPageHeight

      public ConversionOptions 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=

      Parameters:
      height - the maximum page height.
      Returns:
      the ConversionOptions Object.
      Since:
      2023.05

    • setEmbedImagesAsBase64Stream

      public ConversionOptions 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=

      Parameters:
      value - is of type boolean.
      Returns:
      the ConversionOptions Object.

    • setConvertSpacesToNbsp

      public ConversionOptions setConvertSpacesToNbsp(boolean value)
      Convert spaces into Non-breaking Spaces ( ) in the output.

      Possible values:

      • true/false

      Default: false

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

      Parameters:
      value - is of type boolean.
      Returns:
      the ConversionOptions Object.

    • setConvertPDFExternalFileToOutputType

      public ConversionOptions 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=

      Parameters:
      value - is of type boolean.
      Returns:
      the ConversionOptions Object.

    • setFormTag

      public ConversionOptions 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=

      Parameters:
      value - is of type String.
      Returns:
      the ConversionOptions Object.

    • setIncludedFonts

      public ConversionOptions 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=

      Parameters:
      includedFonts - is an array of Object type Font.
      Returns:
      the ConversionOptions Object.

    • setKeepGlyfsSeparate

      public ConversionOptions 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=

      Parameters:
      value - is of type boolean.
      Returns:
      the ConversionOptions Object.

    • setSeparateToWords

      public ConversionOptions 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=

      Parameters:
      value - is of type boolean.
      Returns:
      the ConversionOptions Object.

    • setFontsToRasterizeInTextMode

      public ConversionOptions 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=

      Parameters:
      value - is of type String.
      Returns:
      the ConversionOptions Object.

    • setPreserveExtractionValues

      @Deprecated(since="2015") public ConversionOptions setPreserveExtractionValues(boolean value)
      Deprecated.
      Not recommended for general usage - added for specific customer use case scenario
      If enabled, text will be remapped (ie ligatures) and not kept as single glyf value in real text modes but it can potentially cause display issues so we recommend not using it

      Possible value:

      • true/false

      Default: false

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

      Parameters:
      value - is of type boolean.
      Returns:
      the ConversionOptions Object.

    • setUseLegacyImageFileType

      public ConversionOptions 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=

      Parameters:
      value - is of type boolean.
      Returns:
      the ConversionOptions Object.

    • setCompressImages

      public ConversionOptions 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=

      Parameters:
      value - is of type boolean
      Returns:
      the ConversionOptions Object.

    • setImageScale

      public ConversionOptions 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=

      Parameters:
      imageScale - is of type float
      Returns:
      the ConversionOptions Object.
      Since:
      2019.12

    • setPageFlatteningImageThreshold

      public ConversionOptions 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=

      Parameters:
      threshold - the threshold at which the page will be flattened
      Returns:
      the ConversionOptions Object.
      Since:
      2023.05

    • setClipOffsetAmount

      public ConversionOptions 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=

      Parameters:
      offsetAmount - the distance in pixels to expand the clip edges by
      Returns:
      the ConversionOptions Object.
      Since:
      2024.05

    • setOriginalFileName

      public ConversionOptions 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=

      Parameters:
      originalFileName - the filename to be used
      Returns:
      the ConversionOptions Object.
      Since:
      2023.06

    • setPixelsPerInch

      public ConversionOptions 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=

      Parameters:
      pixelsPerInch - the pixels per inch to be used
      Returns:
      the ConversionOptions Object.
      Since:
      2024.08

    • setTinyTextRemovalThreshold

      public ConversionOptions 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=

      Parameters:
      fontSize - the font size threshold below which text is removed
      Returns:
      the ConversionOptions Object.
      Since:
      2024.08

    • setDisableExternalHyperlinks

      public ConversionOptions 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=

      Parameters:
      value - is of type boolean
      Returns:
      the ConversionOptions Object.
      Since:
      2024.12

    • setDisableHyperlinkDetection

      public ConversionOptions 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=

      Parameters:
      value - is of type boolean
      Returns:
      the ConversionOptions Object.
      Since:
      2024.12

    • getRealPageRange

      public PageRanges getRealPageRange()

    • getLogicalPageRange

      public PageRanges getLogicalPageRange()

    • getOmitNameDir

      public boolean getOmitNameDir()

    • getConvertPDFExternalFileToOutputType

      public boolean getConvertPDFExternalFileToOutputType()

    • getFormTag

      public String getFormTag()

    • getPassword

      public String getPassword()

    • getUseLegacyImageFileType

      public boolean getUseLegacyImageFileType()

    • getOriginalFileName

      public String getOriginalFileName()

    • getApplyBranding

      public String getApplyBranding()

    • getErrors

      public String getErrors()