Package com.pd4ml

Class Constants

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  Constants.ErrorPolicy
      How strictly problems found during a conversion are treated.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int AES_128BIT
      AES encryption with a 128-bit key (PDF 1.6 and later).
      static int AES_256BIT
      AES encryption with a 256-bit key (PDF 1.7 extension level 3 and later).
      static int AllowAnnotate
      Permission (bit 6, value 32): add or modify annotations and fill in form fields; together with AllowModify, also create or modify form fields.
      static int AllowAssembly
      Permission (bit 11, value 1024): assemble the document (insert, rotate or delete pages, create bookmarks or thumbnails), even if AllowModify is not set.
      static int AllowContentExtraction
      Permission (bit 10, value 512): extract text and graphics for accessibility, for example for screen readers.
      static int AllowCopy
      Permission (bit 5, value 16): copy or otherwise extract text and graphics from the document.
      static int AllowDegradedPrint
      Permission (bit 3, value 4): print the document, possibly at a degraded quality unless AllowPrint is also set.
      static int AllowFillingForms
      Permission (bit 9, value 256): fill in existing form fields, including signature fields, even if AllowAnnotate is not set.
      static int AllowModify
      Permission (bit 4, value 8): modify the document content by operations other than those controlled by AllowAnnotate, AllowFillingForms and AllowAssembly.
      static int AllowPrint
      Permission (bits 3 and 12, value 2052): print the document at full quality, so that a faithful digital copy of it could be generated from the print.
      static int CENTER_ALIGN
      Center alignment.
      static int DefaultPermissions
      All permissions: allows every operation on the document.
      static java.lang.String DOCX
      Output format "docx": a Microsoft Word document.
      static java.lang.String ISO8859_1
      The ISO-8859-1 (Latin-1) encoding name.
      static int LEFT_ALIGN
      Left alignment.
      static java.lang.String MULTIPAGE_TIFF
      Image format "mpagetiff": a single uncompressed TIFF image with all pages.
      static java.lang.String MULTIPAGE_TIFF_COMPRESSED
      Image format "mpagetiffcomp": a single compressed (PackBits) TIFF image with all pages.
      static java.lang.String PD4ML_ALLOWED_RESOURCE_LOCATION
      "pd4ml.allowed.resource.location": a URL prefix that restricts where external resources (stylesheets, images, attachments) may be loaded from.
      static java.lang.String PD4ML_BACKGROUND_AS_PATTERNS
      "pd4ml.background.as.patterns": "false" switches back to the background image rendering used before v3.8.5fx3.
      static java.lang.String PD4ML_CACHE_ENABLE
      "pd4ml.cache.enable": "false" disables the resource cache, so every resource is loaded anew.
      static java.lang.String PD4ML_CACHE_IMAGES_IN_TMP_DIR
      "pd4ml.cache.images.in.tmp.dir": "true" makes PD4ML keep loaded images in temporary files instead of memory.
      static java.lang.String PD4ML_CONFIG_FILE
      "pd4ml.config.file": a JVM system property with the location of a configuration file in .properties format.
      static java.lang.String PD4ML_CONFIG_HANDLER_CLASS
      "pd4ml.config.handler.class": a JVM system property with the name of a class that reads the configuration file instead of the default PD4ConfigHandler.
      static java.lang.String PD4ML_CSS_IMPORT_DIRECTIVE
      "pd4ml.css.import.directive": "disable" makes PD4ML ignore @import rules in stylesheets.
      static java.lang.String PD4ML_DISABLE_EXTERNAL_ATTACHMENTS
      "pd4ml.disable.external.attachments": "true" stops PD4ML from loading <pd4ml:attachment> files from the local file system or from URLs.
      static java.lang.String PD4ML_DISABLE_WOFF
      "pd4ml.disable.woff": "true" disables WOFF web fonts in @font-face rules, so the fallback fonts are used.
      static java.lang.String PD4ML_DISABLE_WOFF2
      "pd4ml.disable.woff2": "true" disables WOFF2 web fonts in @font-face rules, so the fallback fonts are used.
      static java.lang.String PD4ML_DOCUMENT_DATE
      "pd4ml.document.date": overrides the creation date in the PDF document properties, for example to produce byte-identical output for comparisons.
      static java.lang.String PD4ML_DOCUMENT_HEIGHT_PX
      Key for PD4ML.getLastRenderInfo(String): returns the height of the laid-out document in pixels, ignoring page breaks, as a Long.
      static java.lang.String PD4ML_DOCUMENT_VIEW_MODE
      "pd4ml.document.view.mode": the page layout a PDF viewer initially uses to show the document: "SinglePage" (the default; one page at a time), "OneColumn" (continuous), "TwoColumnLeft", "TwoColumnRight" (two pages side by side, continuous, odd pages on the left or right), "TwoPageLeft" or "TwoPageRight" (two pages side by side, one spread at a time).
      static java.lang.String PD4ML_DOCUMENT_XMP_DATE
      "pd4ml.document.xmp.date": overrides the dates in the XMP metadata of the PDF (written for PDF/A, PDF/UA and custom metadata), for example to produce byte-identical output.
      static java.lang.String PD4ML_DUMP_DEFAULT_STYLE
      "pd4ml.dump.no.default.style": for debugging only.
      static java.lang.String PD4ML_ENABLE_HTTP_ERRORS
      "pd4ml.enable.http.errors": intended to report HTTP errors when loading the main document as exceptions instead of producing an empty document.
      static java.lang.String PD4ML_EXTRA_RESOURCE_LOADERS
      "pd4ml.extra.resource.loaders".
      static java.lang.String PD4ML_FAKE_BROWSER
      "pd4ml.fake.browser": "true" makes PD4ML identify itself as a regular web browser in HTTP requests, for servers that reject unknown clients.
      static java.lang.String PD4ML_FIX20130116
      "pd4ml.fix.20130116": a workaround for table rows repeated after a page break in old versions.
      static java.lang.String PD4ML_FORCE_RTL
      "pd4ml.force.rtl": "true" applies right-to-left word order to all text, including text in left-to-right languages.
      static java.lang.String PD4ML_GENERATE_TOOLTIPS
      "pd4ml.generate.tooltips": "true" turns the title attributes of HTML elements into PDF annotations, which viewers show as tooltips.
      static java.lang.String PD4ML_HEADER_HEIGHT_LIMIT
      "pd4ml.header.height.limit": "false" removed the limit of page header and footer height to one third of the page height in old versions.
      static java.lang.String PD4ML_HTML_IN_DYNAMIC_DATA
      "pd4ml.html.in.dynamic.data": "enable" makes PD4ML parse the values set with PD4ML.setDynamicData(java.util.Map) as HTML instead of inserting them as text.
      static java.lang.String PD4ML_HTTP_REQUEST_DISPATCHER
      "pd4ml.http.request.dispatcher".
      static java.lang.String PD4ML_IDS_AS_DESTINATIONS
      "pd4ml.ids.as.destinations": "true" (the default) lets links address any element by its id attribute (<a href="#chapter2">), in addition to <a name="..."> anchors; "false" restricts link destinations to named anchors.
      static java.lang.String PD4ML_IMAGE_REPOSITORY
      "pd4ml.image.repository".
      static java.lang.String PD4ML_INFO_AUTHOR
      Intended as a PD4ML.getLastRenderInfo(String) key for the document author; not supported by this version of PD4ML (null is returned).
      static java.lang.String PD4ML_INFO_TITLE
      Intended as a PD4ML.getLastRenderInfo(String) key for the document title; not supported by this version of PD4ML (null is returned).
      static java.lang.String PD4ML_INITIAL_PAGE_NUMBER
      "pd4ml.initial.page.number": the number of the first page, as an integer string.
      static java.lang.String PD4ML_KEEP_TRAILING_BLANK_PAGES
      "pd4ml.keep.trailing.blank.pages": "true" keeps blank pages at the end of the document.
      static java.lang.String PD4ML_MAX_CACHE_ENTRIES
      "pd4ml.max.cache.entries".
      static java.lang.String PD4ML_MAX_CACHE_SIZE
      "pd4ml.max.cache.size": the maximum number of resources (images, stylesheets and so on) kept in the resource cache; 1024 by default.
      static java.lang.String PD4ML_MAX_CACHE_VOLUME
      "pd4ml.max.cache.volume": the maximum total size of the resource cache in bytes; unlimited by default.
      static java.lang.String PD4ML_MEDIA_TYPE_PRINT
      "pd4ml.media.type.print": controls which CSS media types apply.
      static java.lang.String PD4ML_OMIT_DEFAULT_STYLE
      "pd4ml.omit.default.style": for debugging only.
      static java.lang.String PD4ML_PDFA_STATUS
      Key for PD4ML.getLastRenderInfo(String): returns the warnings and errors recorded during the last conversion, as a StatusMessage[].
      static java.lang.String PD4ML_PRINT_DIALOG_POPUP
      "pd4ml.print.dialog.popup".
      static java.lang.String PD4ML_RIGHT_EDGE_PX
      Key for PD4ML.getLastRenderInfo(String): returns the right edge of the content of the last conversion in pixels, as a Long.
      static java.lang.String PD4ML_SESSIONID_APPEND
      "pd4ml.sessionid.append": "false" stops PD4ML from appending the session ID set with PD4ML.setSessionID(String) to resource URLs.
      static java.lang.String PD4ML_SESSIONID_VARNAME
      "pd4ml.sessionid.varname": the name of the URL parameter that carries the session ID set with PD4ML.setSessionID(String); "jsessionid" by default.
      static java.lang.String PD4ML_SOCKET_TIMEOUT
      "pd4ml.socket.timeout": the connect and read timeout for HTTP(S) resource requests, in milliseconds.
      static java.lang.String PD4ML_STYLESHEETS_TO_OMIT
      "pd4ml.stylesheets.to.omit": a semicolon-separated list of strings; stylesheets whose URL contains one of them are not loaded, for example to skip screen-only frameworks.
      static java.lang.String PD4ML_TOTAL_PAGES
      Key for PD4ML.getLastRenderInfo(String): returns the number of pages of the last conversion, as a Long.
      static java.lang.String PDF
      Output format "pdf": a regular PDF document (PDF 1.7).
      static java.lang.String PDFA
      Output format "pdfa": a PDF/A-1b document for long-term archiving.
      static java.lang.String PDFUA
      Output format "pdfua": an accessible, tagged PDF that conforms to both PDF/UA-1 and PDF/A-2a.
      static java.lang.String PNG24
      Image format "png24": PNG images with 24-bit color and an alpha channel (transparency).
      static java.lang.String PNG8
      Image format "png8": PNG images with 24-bit color and no transparency.
      static int RC4_128BIT
      RC4 encryption with a 128-bit key.
      static int RC4_40BIT
      RC4 encryption with a 40-bit key.
      static int RIGHT_ALIGN
      Right alignment.
      static java.lang.String RTF
      Output format "rtf": an RTF document with images embedded in their original format, which Microsoft Word and most other editors support.
      static java.lang.String RTF_WMF
      Output format "rtfwmf": an RTF document with images converted to WMF, for viewers such as WordPad that support no other image format.
      static java.lang.String TIFF
      Image format "tiff": one uncompressed TIFF image per page.
      static java.lang.String TIFF_COMPRESSED
      Image format "tiffcomp": one compressed (PackBits) TIFF image per page.
      static double TRANSLATE_FACTOR
      The number of PDF points per millimeter: 2.835.
      static java.lang.String UTF8
      The UTF-8 encoding name.
      static java.lang.String WINDOWS_1252
      The Windows-1252 encoding name.

      • Fields inherited from class com.pd4ml.util.Base

        LOG_ALL, LOG_CACHE, LOG_CSS, LOG_DEBUG, LOG_ERROR, LOG_FATAL, LOG_FONTS, LOG_INFO, LOG_MINIMAL, LOG_PARSE, LOG_TRACE, LOG_USAGE, LOG_VERBOSE, LOG_WARN, NO_LOG, PD4ML_LOG_LEVEL

    • Constructor Summary

      Constructors 
      Constructor Description
      Constants()  

    • Method Summary

      • Methods inherited from class com.pd4ml.util.Base

        log, log2, printLog, shouldForceException

      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait