Package com.pd4ml
Class Constants
- java.lang.Object
-
- com.pd4ml.util.Base
-
- com.pd4ml.Constants
-
public class Constants extends com.pd4ml.util.Base
-
-
Field Summary
Fields Modifier and Type Field Description static int
AllowAnnotate
Document access permission (bit 6).
Add or modify text annotations, fill in interactive form fields, and, if bit 4 is also set, create or modify interactive form fields.static int
AllowAssembly
Document access permission (bit 11, value = 1024).
Assemble the document (insert, rotate, or delete pages and create bookmarks or thumbnail images), even if bit 4 is clear.static int
AllowContentExtraction
Document access permission (bit 10, value = 512).
Extract text and graphics (in support of accessibility to disabled users or for other purposes).static int
AllowCopy
Document access permission (bit 5, value = 16).
Copy or otherwise extract text and graphics from the document by operations other than that controlled by bit 10.static int
AllowDegradedPrint
Document access permission (bit 3, value = 4).
Print the document (possibly not at the highest quality level, depending on whether bit 12 is also set).static int
AllowFillingForms
Document access permission (bit 9).
Fill in existing interactive form fields (including signature fields), even if bit 6 is clear.static int
AllowModify
Document access permission (bit 4, value = 8).
Modify the contents of the document by operations other than those controlled by bits 6, 9, and 11.static int
AllowPrint
Document access permission (bit 12 + bit 3, value = 2052).
Print the document to a representation from which a faithful digital copy of the PDF content could be generated.static int
CENTER_ALIGN
static int
DefaultPermissions
Document permissions.static java.lang.String
DOCX
PD4ML output format "docx".static java.lang.String
ISO8859_1
static int
LEFT_ALIGN
static java.lang.String
MULTIPAGE_TIFF
PD4ML output format: multipage "TIFF".static java.lang.String
MULTIPAGE_TIFF_COMPRESSED
PD4ML output format: multipage compressed "TIFF".static java.lang.String
PD4ML_ALLOWED_RESOURCE_LOCATION
"pd4ml.allowed.resource.location" forces PD4ML to avoid loading of external resources (CSSs, images, attachments) located outside of (not nested to) the given URI.static java.lang.String
PD4ML_BACKGROUND_AS_PATTERNS
"pd4ml.background.as.patterns" - Allows to switch on pre-v385fx3 background image logic with "false" value.static java.lang.String
PD4ML_CACHE_ENABLE
"pd4ml.cache.enable" - allows to disable internal file cache.static java.lang.String
PD4ML_CACHE_IMAGES_IN_TMP_DIR
"pd4ml.cache.images.in.tmp.dir" if "true" - PD4ML does not cache downloaded images in RAM, but uses /tmp directory for that.static java.lang.String
PD4ML_CONFIG_FILE
"pd4ml.config.file" - environment variable specifies configuration file location.static java.lang.String
PD4ML_CONFIG_HANDLER_CLASS
"pd4ml.config.handler.class" - environment variable specifies configuration file reader class.static java.lang.String
PD4ML_CSS_IMPORT_DIRECTIVE
"pd4ml.css.import.directive".static java.lang.String
PD4ML_DISABLE_EXTERNAL_ATTACHMENTS
"pd4ml.disable.external.attachments" if "true", it does not load attachments (<pd4ml:attachment>) from local system and from URL.static java.lang.String
PD4ML_DISABLE_WOFF
Default is "false".static java.lang.String
PD4ML_DISABLE_WOFF2
Default is "false".static java.lang.String
PD4ML_DOCUMENT_DATE
"pd4ml.document.date" - allows to override document creation date.static java.lang.String
PD4ML_DOCUMENT_HEIGHT_PX
"pd4ml.document.height.px" - allows to request document height in pixels (ignoring page breaks, if any)static java.lang.String
PD4ML_DOCUMENT_VIEW_MODE
"pd4ml.document.view.mode" defines default view mode for generated document, one from: "SinglePage", "OneColumn", "TwoColumnLeft", "TwoColumnRight", "TwoPageLeft", "TwoPageRight";static java.lang.String
PD4ML_DOCUMENT_XMP_DATE
"pd4ml.document.xmp.date" - allows to override document creation date in XMP metadata.static java.lang.String
PD4ML_DUMP_DEFAULT_STYLE
For debug only.static java.lang.String
PD4ML_ENABLE_HTTP_ERRORS
"pd4ml.enable.http.errors" - by "true" propagates HTML loading HTTP errors to the PD4ML API level.static java.lang.String
PD4ML_EXTRA_RESOURCE_LOADERS
"pd4ml.extra.resource.loaders"static java.lang.String
PD4ML_FAKE_BROWSER
"pd4ml.fake.browser" - allows PD4ML to pretend to be a regular browser (from HTTP perspective).static java.lang.String
PD4ML_FIX20130116
"pd4ml.fix.20130116" - "true" forces PD4ML to workaround problem with occasional repeating of table rows after a page breakstatic java.lang.String
PD4ML_FORCE_RTL
"pd4ml.force.rtl" - Applies Right-To-Left word order also to not-RTL languages.static java.lang.String
PD4ML_GENERATE_TOOLTIPS
"pd4ml.generate.tooltips" if "true", produces tooltips (PDF annotations) from TITLE HTML attributes.static java.lang.String
PD4ML_HEADER_HEIGHT_LIMIT
Default is "true" - header/footer height max value is limited by 1/3 page height.static java.lang.String
PD4ML_HTML_IN_DYNAMIC_DATA
"pd4ml.html.in.dynamic.datar=enable" enables HTML parsing of the dynamic data values.static java.lang.String
PD4ML_HTTP_REQUEST_DISPATCHER
"pd4ml.http.request.dispatcher" if "enable" (default) - it tries to use RequestDispatcher.include() to load local web application resources (relies onPD4ML.useHttpRequest(jakarta.servlet.http.HttpServletRequest, jakarta.servlet.http.HttpServletResponse)
), if "disable" - behaves as PD4ML versions prior to v360fx1.static java.lang.String
PD4ML_IDS_AS_DESTINATIONS
"pd4ml.ids.as.destinations"static java.lang.String
PD4ML_IMAGE_REPOSITORY
"pd4ml.image.repository" - property specifies additional image location(s).static java.lang.String
PD4ML_INFO_AUTHOR
"pd4ml.info.author" - allows to request document author infostatic java.lang.String
PD4ML_INFO_TITLE
"pd4ml.info.title" - allows to request document titlestatic java.lang.String
PD4ML_INITIAL_PAGE_NUMBER
"pd4ml.initial.page.number"static java.lang.String
PD4ML_KEEP_TRAILING_BLANK_PAGES
Default is "false".static java.lang.String
PD4ML_MAX_CACHE_ENTRIES
"pd4ml.max.cache.entries"static java.lang.String
PD4ML_MAX_CACHE_SIZE
"pd4ml.max.cache.size" maximal number of cached itemsstatic java.lang.String
PD4ML_MAX_CACHE_VOLUME
"pd4ml.max.cache.size" maximal cache size in bytesstatic java.lang.String
PD4ML_MEDIA_TYPE_PRINT
"pd4ml.media.type.print".static java.lang.String
PD4ML_OMIT_DEFAULT_STYLE
Dangerous.static java.lang.String
PD4ML_PDFA_STATUS
"pd4ml.pdfa.status" - returns an array of PDF/A conformity warnings or errors.static java.lang.String
PD4ML_PRINT_DIALOG_POPUP
"pd4ml.print.dialog.popup" - if "true" forces PDF viewer to pop up a print dialog.static java.lang.String
PD4ML_RIGHT_EDGE_PX
"pd4ml.right.edge.px" - allows to request the maximal element width for the last rendered document.static java.lang.String
PD4ML_SESSIONID_APPEND
"pd4ml.sessionid.append" - if "false" suppresses session ID append to the image/CSS requestsstatic java.lang.String
PD4ML_SESSIONID_VARNAME
"pd4ml.sessionid.varname"static java.lang.String
PD4ML_SOCKET_TIMEOUT
static java.lang.String
PD4ML_STYLESHEETS_TO_OMIT
"pd4ml.stylesheets.to.omit" - semicolon-delimited list of stylesheet path patterns, to be ignored by document renderingstatic java.lang.String
PD4ML_TOTAL_PAGES
"pd4ml.total.pages" - allows to request number of pages of generated PDFstatic java.lang.String
PDF
PD4ML output format "pdf"static java.lang.String
PDFA
PD4ML output format "pdfa" (PDF/A-1b)static java.lang.String
PDFUA
PD4ML output format "pdfua" (conforming both PDF/A-2a and PDF/UA-1 specs)static java.lang.String
PNG24
PD4ML output format "PNG" (24bit colorspace, supports alpha channel).static java.lang.String
PNG8
PD4ML output format "PNG" (indexed colorspace).static int
RIGHT_ALIGN
static java.lang.String
RTF
PD4ML output format "rtf".static java.lang.String
RTF_WMF
PD4ML output format "rtf".static java.lang.String
TIFF
PD4ML output format: "TIFF".static java.lang.String
TIFF_COMPRESSED
PD4ML output format: compressed "TIFF".static double
TRANSLATE_FACTOR
2.835 points per mmstatic java.lang.String
UTF8
static java.lang.String
WINDOWS_1252
-
Constructor Summary
Constructors Constructor Description Constants()
-
-
-
Field Detail
-
TRANSLATE_FACTOR
public static final double TRANSLATE_FACTOR
2.835 points per mm- See Also:
- Constant Field Values
-
DefaultPermissions
public static final int DefaultPermissions
Document permissions. Enables everything by default.
-
AllowDegradedPrint
public static final int AllowDegradedPrint
Document access permission (bit 3, value = 4).
Print the document (possibly not at the highest quality level, depending on whether bit 12 is also set).
-
AllowModify
public static final int AllowModify
Document access permission (bit 4, value = 8).
Modify the contents of the document by operations other than those controlled by bits 6, 9, and 11.
-
AllowCopy
public static final int AllowCopy
Document access permission (bit 5, value = 16).
Copy or otherwise extract text and graphics from the document by operations other than that controlled by bit 10.
-
AllowAnnotate
public static final int AllowAnnotate
Document access permission (bit 6).
Add or modify text annotations, fill in interactive form fields, and, if bit 4 is also set, create or modify interactive form fields.
-
AllowFillingForms
public static final int AllowFillingForms
Document access permission (bit 9).
Fill in existing interactive form fields (including signature fields), even if bit 6 is clear.
-
AllowContentExtraction
public static final int AllowContentExtraction
Document access permission (bit 10, value = 512).
Extract text and graphics (in support of accessibility to disabled users or for other purposes).
-
AllowAssembly
public static final int AllowAssembly
Document access permission (bit 11, value = 1024).
Assemble the document (insert, rotate, or delete pages and create bookmarks or thumbnail images), even if bit 4 is clear.
-
AllowPrint
public static final int AllowPrint
Document access permission (bit 12 + bit 3, value = 2052).
Print the document to a representation from which a faithful digital copy of the PDF content could be generated. When this bit is clear (and bit 3 is set), printing is limited to a low level representation of the appearance, possibly of degraded quality.
-
PD4ML_MAX_CACHE_ENTRIES
public static final java.lang.String PD4ML_MAX_CACHE_ENTRIES
"pd4ml.max.cache.entries"
-
PD4ML_MAX_CACHE_SIZE
public static final java.lang.String PD4ML_MAX_CACHE_SIZE
"pd4ml.max.cache.size" maximal number of cached items
-
PD4ML_MAX_CACHE_VOLUME
public static final java.lang.String PD4ML_MAX_CACHE_VOLUME
"pd4ml.max.cache.size" maximal cache size in bytes
-
PD4ML_IDS_AS_DESTINATIONS
public static final java.lang.String PD4ML_IDS_AS_DESTINATIONS
"pd4ml.ids.as.destinations"
-
PD4ML_EXTRA_RESOURCE_LOADERS
public static final java.lang.String PD4ML_EXTRA_RESOURCE_LOADERS
"pd4ml.extra.resource.loaders"
-
PD4ML_DOCUMENT_VIEW_MODE
public static final java.lang.String PD4ML_DOCUMENT_VIEW_MODE
"pd4ml.document.view.mode" defines default view mode for generated document, one from: "SinglePage", "OneColumn", "TwoColumnLeft", "TwoColumnRight", "TwoPageLeft", "TwoPageRight";
-
PD4ML_DOCUMENT_DATE
public static final java.lang.String PD4ML_DOCUMENT_DATE
"pd4ml.document.date" - allows to override document creation date. useful if needed a byte-to-byte document comparison.
-
PD4ML_DOCUMENT_XMP_DATE
public static final java.lang.String PD4ML_DOCUMENT_XMP_DATE
"pd4ml.document.xmp.date" - allows to override document creation date in XMP metadata. useful if needed a byte-to-byte document comparison.
-
PD4ML_FAKE_BROWSER
public static final java.lang.String PD4ML_FAKE_BROWSER
"pd4ml.fake.browser" - allows PD4ML to pretend to be a regular browser (from HTTP perspective).
-
PD4ML_CACHE_ENABLE
public static final java.lang.String PD4ML_CACHE_ENABLE
"pd4ml.cache.enable" - allows to disable internal file cache.
-
PD4ML_SESSIONID_APPEND
public static final java.lang.String PD4ML_SESSIONID_APPEND
"pd4ml.sessionid.append" - if "false" suppresses session ID append to the image/CSS requests
-
PD4ML_SOCKET_TIMEOUT
public static final java.lang.String PD4ML_SOCKET_TIMEOUT
- See Also:
- Constant Field Values
-
PD4ML_PRINT_DIALOG_POPUP
public static final java.lang.String PD4ML_PRINT_DIALOG_POPUP
"pd4ml.print.dialog.popup" - if "true" forces PDF viewer to pop up a print dialog. (The client PDF viewer should support JavaScript, and the support should not be disabled)
-
PD4ML_MEDIA_TYPE_PRINT
public static final java.lang.String PD4ML_MEDIA_TYPE_PRINT
"pd4ml.media.type.print". PD4ML by default interprets "screen", "all" and "pdf" CSS media types. If the parameter is set to "add", it adds to the list "print" media type. If it is set to "override", it forces PD4ML to ignore "screen", but use "print" instead.
-
PD4ML_CSS_IMPORT_DIRECTIVE
public static final java.lang.String PD4ML_CSS_IMPORT_DIRECTIVE
"pd4ml.css.import.directive". If the parameter is set to "disable", @ import directives in CSS stylesheets take no effect,
-
PD4ML_SESSIONID_VARNAME
public static final java.lang.String PD4ML_SESSIONID_VARNAME
"pd4ml.sessionid.varname"
-
PD4ML_INITIAL_PAGE_NUMBER
public static final java.lang.String PD4ML_INITIAL_PAGE_NUMBER
"pd4ml.initial.page.number"
-
PD4ML_HTML_IN_DYNAMIC_DATA
public static final java.lang.String PD4ML_HTML_IN_DYNAMIC_DATA
"pd4ml.html.in.dynamic.datar=enable" enables HTML parsing of the dynamic data values. Can be dangerous for entire HTML document layout integrity
-
PD4ML_ALLOWED_RESOURCE_LOCATION
public static final java.lang.String PD4ML_ALLOWED_RESOURCE_LOCATION
"pd4ml.allowed.resource.location" forces PD4ML to avoid loading of external resources (CSSs, images, attachments) located outside of (not nested to) the given URI. It does not impact TTF locations and JAR resources addressed via ClassLoader.
-
PD4ML_DISABLE_EXTERNAL_ATTACHMENTS
public static final java.lang.String PD4ML_DISABLE_EXTERNAL_ATTACHMENTS
"pd4ml.disable.external.attachments" if "true", it does not load attachments (<pd4ml:attachment>) from local system and from URL. It does not impact inline-defined attachments.
-
PD4ML_GENERATE_TOOLTIPS
public static final java.lang.String PD4ML_GENERATE_TOOLTIPS
"pd4ml.generate.tooltips" if "true", produces tooltips (PDF annotations) from TITLE HTML attributes.
-
PD4ML_CACHE_IMAGES_IN_TMP_DIR
public static final java.lang.String PD4ML_CACHE_IMAGES_IN_TMP_DIR
"pd4ml.cache.images.in.tmp.dir" if "true" - PD4ML does not cache downloaded images in RAM, but uses /tmp directory for that. The mode may cause performance loss, but should save memory heap size
-
PD4ML_HTTP_REQUEST_DISPATCHER
public static final java.lang.String PD4ML_HTTP_REQUEST_DISPATCHER
"pd4ml.http.request.dispatcher" if "enable" (default) - it tries to use RequestDispatcher.include() to load local web application resources (relies onPD4ML.useHttpRequest(jakarta.servlet.http.HttpServletRequest, jakarta.servlet.http.HttpServletResponse)
), if "disable" - behaves as PD4ML versions prior to v360fx1.
-
PD4ML_PDFA_STATUS
public static final java.lang.String PD4ML_PDFA_STATUS
"pd4ml.pdfa.status" - returns an array of PDF/A conformity warnings or errors. An empty array means "everything is OK". A single PD4StatusMessage marked as Error means, the resulting document is not PDF/A compliant
-
PD4ML_DOCUMENT_HEIGHT_PX
public static final java.lang.String PD4ML_DOCUMENT_HEIGHT_PX
"pd4ml.document.height.px" - allows to request document height in pixels (ignoring page breaks, if any)
-
PD4ML_RIGHT_EDGE_PX
public static final java.lang.String PD4ML_RIGHT_EDGE_PX
"pd4ml.right.edge.px" - allows to request the maximal element width for the last rendered document. If the document root has elements with width="100%", the returned value is going to be very close to htmlWidth rendering parameter value.
-
PD4ML_TOTAL_PAGES
public static final java.lang.String PD4ML_TOTAL_PAGES
"pd4ml.total.pages" - allows to request number of pages of generated PDF
-
PD4ML_INFO_AUTHOR
public static final java.lang.String PD4ML_INFO_AUTHOR
"pd4ml.info.author" - allows to request document author info
-
PD4ML_INFO_TITLE
public static final java.lang.String PD4ML_INFO_TITLE
"pd4ml.info.title" - allows to request document title
-
PD4ML_FORCE_RTL
public static final java.lang.String PD4ML_FORCE_RTL
"pd4ml.force.rtl" - Applies Right-To-Left word order also to not-RTL languages. Default is "false"
-
PD4ML_BACKGROUND_AS_PATTERNS
public static final java.lang.String PD4ML_BACKGROUND_AS_PATTERNS
"pd4ml.background.as.patterns" - Allows to switch on pre-v385fx3 background image logic with "false" value. Default is "true"
-
PD4ML_CONFIG_FILE
public static final java.lang.String PD4ML_CONFIG_FILE
"pd4ml.config.file" - environment variable specifies configuration file location. The configuration (in .properties file format) makes possible to trigger PD4ML API calls without a re-compiling of end-applications. If a configuration file is specified, it impacts all PD4ML conversions.- See Also:
PD4ConfigHandler
, Constant Field Values
-
PD4ML_CONFIG_HANDLER_CLASS
public static final java.lang.String PD4ML_CONFIG_HANDLER_CLASS
"pd4ml.config.handler.class" - environment variable specifies configuration file reader class. If set, it overrides the default PD4ConfigHandler.- See Also:
PD4ConfigHandler
, Constant Field Values
-
PD4ML_IMAGE_REPOSITORY
public static final java.lang.String PD4ML_IMAGE_REPOSITORY
"pd4ml.image.repository" - property specifies additional image location(s). Multiple directories can be delimited with a semicolon (;). The locations are used instead of absolute or relative image paths given in the source HTML. Use with care (only as the last resort by image referencing problems) The path(s) may include $[current.dir] placeholder to be substituted with System.getProperty("user.dir")- See Also:
- Constant Field Values
-
PD4ML_FIX20130116
public static final java.lang.String PD4ML_FIX20130116
"pd4ml.fix.20130116" - "true" forces PD4ML to workaround problem with occasional repeating of table rows after a page break- See Also:
- Constant Field Values
-
PD4ML_STYLESHEETS_TO_OMIT
public static final java.lang.String PD4ML_STYLESHEETS_TO_OMIT
"pd4ml.stylesheets.to.omit" - semicolon-delimited list of stylesheet path patterns, to be ignored by document rendering- See Also:
- Constant Field Values
-
PD4ML_ENABLE_HTTP_ERRORS
public static final java.lang.String PD4ML_ENABLE_HTTP_ERRORS
"pd4ml.enable.http.errors" - by "true" propagates HTML loading HTTP errors to the PD4ML API level. Default is "false" (the errors are suppressed and a blank PDF is generated)- See Also:
- Constant Field Values
-
PD4ML_OMIT_DEFAULT_STYLE
public static final java.lang.String PD4ML_OMIT_DEFAULT_STYLE
Dangerous. For debug only. Omits a loading of initial style, which defines HTML/CSS basics.- See Also:
- Constant Field Values
-
PD4ML_DUMP_DEFAULT_STYLE
public static final java.lang.String PD4ML_DUMP_DEFAULT_STYLE
For debug only. default = "yes"- See Also:
- Constant Field Values
-
PD4ML_HEADER_HEIGHT_LIMIT
public static final java.lang.String PD4ML_HEADER_HEIGHT_LIMIT
Default is "true" - header/footer height max value is limited by 1/3 page height. "false" removes the limitation. Remove the limitation only if you know what you do.- Since:
- v395fx4
- See Also:
PD4ML.setParam(String, String)
, Constant Field Values
-
PD4ML_KEEP_TRAILING_BLANK_PAGES
public static final java.lang.String PD4ML_KEEP_TRAILING_BLANK_PAGES
Default is "false". "true" protects trailing blank pages from being removed- Since:
- v407
- See Also:
PD4ML.setParam(String, String)
, Constant Field Values
-
PD4ML_DISABLE_WOFF
public static final java.lang.String PD4ML_DISABLE_WOFF
Default is "false". "true" disables woff fonts support- Since:
- v4.0.16
- See Also:
PD4ML.setParam(String, String)
, Constant Field Values
-
PD4ML_DISABLE_WOFF2
public static final java.lang.String PD4ML_DISABLE_WOFF2
Default is "false". "true" disables woff2 fonts support- Since:
- v4.0.16
- See Also:
PD4ML.setParam(String, String)
, Constant Field Values
-
PDF
public static final java.lang.String PDF
PD4ML output format "pdf"
-
PDFA
public static final java.lang.String PDFA
PD4ML output format "pdfa" (PDF/A-1b)
-
PDFUA
public static final java.lang.String PDFUA
PD4ML output format "pdfua" (conforming both PDF/A-2a and PDF/UA-1 specs)
-
DOCX
public static final java.lang.String DOCX
PD4ML output format "docx".- See Also:
- Constant Field Values
-
RTF
public static final java.lang.String RTF
PD4ML output format "rtf". Document images are embedded in their original format (compatible with MS Word and few other editors)- See Also:
- Constant Field Values
-
RTF_WMF
public static final java.lang.String RTF_WMF
PD4ML output format "rtf". Forces PD4ML to convert images (if any) to WMF for compatibility with WordPad WMF- See Also:
- Constant Field Values
-
PNG8
public static final java.lang.String PNG8
PD4ML output format "PNG" (indexed colorspace).
-
PNG24
public static final java.lang.String PNG24
PD4ML output format "PNG" (24bit colorspace, supports alpha channel).
-
TIFF
public static final java.lang.String TIFF
PD4ML output format: "TIFF". Requires JAI library in the classpath.
-
TIFF_COMPRESSED
public static final java.lang.String TIFF_COMPRESSED
PD4ML output format: compressed "TIFF". Requires JAI library in the classpath.
-
MULTIPAGE_TIFF
public static final java.lang.String MULTIPAGE_TIFF
PD4ML output format: multipage "TIFF". Requires JAI library in the classpath.
-
MULTIPAGE_TIFF_COMPRESSED
public static final java.lang.String MULTIPAGE_TIFF_COMPRESSED
PD4ML output format: multipage compressed "TIFF". Requires JAI library in the classpath.
-
LEFT_ALIGN
public static final int LEFT_ALIGN
-
CENTER_ALIGN
public static final int CENTER_ALIGN
-
RIGHT_ALIGN
public static final int RIGHT_ALIGN
-
ISO8859_1
public static final java.lang.String ISO8859_1
- See Also:
- Constant Field Values
-
WINDOWS_1252
public static final java.lang.String WINDOWS_1252
- See Also:
- Constant Field Values
-
UTF8
public static final java.lang.String UTF8
- See Also:
- Constant Field Values
-
-