Package org.zefer.pd4ml
Class PD4Constants
java.lang.Object
org.zefer.pd4ml.PD4Constants
- Direct Known Subclasses:
PD4ML
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final Dimension
2384 x 3370 pointsstatic final Dimension
1684 x 2384 pointsstatic final Dimension
74 x 105 pointsstatic final Dimension
1190 x 1684 pointsstatic final Dimension
842 x 1190 pointsstatic final Dimension
595 x 842 pointsstatic final Dimension
421 x 595 pointsstatic final Dimension
297 x 421 pointsstatic final Dimension
210 x 297 pointsstatic final Dimension
148 x 210 pointsstatic final Dimension
105 x 148 pointsstatic final int
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 final int
Document access permission (bit 11, value = 1024).
(only if isStrong=true) Assemble the document (insert, rotate, or delete pages and create bookmarks or thumbnail images), even if bit 4 is clear.static final int
Document access permission (bit 10, value = 512).
(only if isStrong=true) Extract text and graphics (in support of accessibility to disabled users or for other purposes).static final int
Document access permission (bit 5, value = 16).
(isStrong=false) Copy or otherwise extract text and graphics from the document, including extracting text and graphics (in support of accessibility to disabled users or for other purposes).
(isStrong=true) Copy or otherwise extract text and graphics from the document by operations other than that controlled by bit 10.static final int
Document access permission (bit 3, value = 4).
(isStrong=false) Print the document.
(isStrong=true) Print the document (possibly not at the highest quality level, depending on whether bit 12 is also set).static final int
Document access permission (bit 9).
(only if isStrong=true) Fill in existing interactive form fields (including signature fields), even if bit 6 is clear.static final int
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 final int
Document access permission (bit 12 + bit 3, value = 2052).
(only if isStrong=true) Print the document to a representation from which a faithful digital copy of the PDF content could be generated.static final Dimension
648 x 864 pointsstatic final Dimension
864 x 1296 pointsstatic final Dimension
1296 x 1728 pointsstatic final Dimension
1728 x 2592 pointsstatic final Dimension
2592 x 3456 pointsstatic final Dimension
2160 x 3024 pointsstatic final int
Document permissions.static final Dimension
396 x 612 pointsstatic final Dimension
2836 x 4008 pointsstatic final Dimension
2004 x 2836 pointsstatic final Dimension
1418 x 2004 pointsstatic final Dimension
1002 x 1418 pointsstatic final Dimension
709 x 1002 pointsstatic final Dimension
501 x 709 pointsstatic final Dimension
1224 x 792 pointsstatic final Dimension
612 x 1008 pointsstatic final Dimension
612 x 792 pointsstatic final Dimension
540 x 720 pointsstatic final String
"pd4ml.absolute.address.space" (not yet completely implemented!) if "pages" (default) - it uses all page space for absolute positioning and ignores explicit page breaks, if "document" - behaves as PD4ML versions prior to v360: breaks with flow (not absolute positioned) content.static final String
"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 final String
"pd4ml.background.as.patterns" - Allows to switch on pre-v385fx3 background image logic with "false" value.static final String
"pd4ml.basic.authentication" - expect authentication string in "login:password" form.static final String
"pd4ml.cache.enable" - allows to disable internal file cache.static final String
"pd4ml.cache.images.in.tmp.dir" if "true" - PD4ML does not cache downloaded images in RAM, but uses /tmp directory for that.static final String
"pd4ml.config.file" - environment variable specifies configuration file location.static final String
"pd4ml.config.handler.class" - environment variable specifies configuration file reader class.static final String
"pd4ml.css.import.directive".static final String
"pd4ml.disable.external.attachments" if "true", it does not load attachments (<pd4ml:attachment>) from local system and from URL.static final String
"pd4ml.document.date" - allows to override document creation date.static final String
"pd4ml.document.height.px" - allows to request document height in pixels (ignoring page breaks, if any)static final String
"pd4ml.document.view.mode" defines default view mode for generated document, one from: "SinglePage", "OneColumn", "TwoColumnLeft", "TwoColumnRight", "TwoPageLeft", "TwoPageRight";static final String
"pd4ml.document.xmp.date" - allows to override document creation date in XMP metadata.static final String
"pd4ml.enable.canvas.interpreter" - "true" forces PD4ML to lookup PD4CanvasHandler and use it as <canvas> hadler.static final String
"pd4ml.enable.http.errors" - by "true" propagates HTML loading HTTP errors to the PD4ML API level.static final String
"PD4CanvasHandler" pluggable <canvas> interpreter class name (the class must implement org.zefer.cache.DynamicImageHandler interface)static final String
"pd4ml.extra.resource.loaders"static final String
"pd4ml.fake.browser" - allows PD4ML to pretend to be a regular browser (from HTTP perspective).static final String
"pd4ml.fix.20130116" - "true" forces PD4ML to workaround problem with occasional repeating of table rows after a page breakstatic final String
"pd4ml.fix.20150816" - "true" forces PD4ML to workaround problem with using of CJK fonts to print English textsstatic final String
"pd4ml.force.rtl" - Applies Right-To-Left word order also to not-RTL languages.static final String
"pd4ml.generate.tooltips" if "true", produces tooltips (PDF annotations) from TITLE HTML attributes.static final String
Default is "true" - header/footer height max value is limited by 1/3 page height.static final String
"pd4ml.http.proxy" - allows to define HTTP proxy "server:port" for current conversion, keeping global proxy settings untouched.static final String
"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 final String
"pd4ml.ids.as.destinations"static final String
"pd4ml.image.repository" - property specifies additional image location(s).static final String
"pd4ml.info.author" - allows to request document author infostatic final String
"pd4ml.info.title" - allows to request document titlestatic final String
"pd4ml.initial.page.number"static final String
"pd4ml.legacy.rtl.mode" - "true" does not change table columns order when dir=rtl (for backward compatibility with older PD4ML versions).static final String
static final String
"pd4ml.media.type.print".static final String
"pd4ml.mobile.device.optimize" - used in internal projects; to be changed in the futurestatic final String
"pd4ml.mobile.device.width" - used in internal projects; to be changed in the futurestatic final String
"pd4ml.pdfa.status" - returns an array of PDF/A conformity warnings or errors.static final String
"pd4ml.print.dialog.popup" - if "true" forces PDF viewer to pop up a print dialog.static final String
"pd4ml.right.edge.px" - allows to request the maximal element width for the last rendered document.static final String
"pd4ml.sessionid.append" - if "false" suppresses session ID append to the image/CSS requestsstatic final String
"pd4ml.sessionid.varname"static final String
static final String
"pd4ml.stylesheets.to.omit" - semicolon-delimited list of stylesheet path patterns, to be ignored by document renderingstatic final String
"pd4ml.suppress.blank.pages" (default = "true") if "false" - PD4ML does not try to suppress occasional blank pages (i.e.static final String
"pd4ml.total.pages" - allows to request number of pages of generated PDFstatic final String
PD4ML output format "pdf"static final String
PD4ML output format "pdfa" (overrides generatePdfa(boolean))static final String
PD4ML output format "PNG" (24bit colorspace, supports alpha channel).static final String
PD4ML output format "PNG" (indexed colorspace).static final String
PD4ML output format "rtf".static final String
PD4ML output format "rtf".static final Dimension
792 x 1224 pointsstatic final String
PD4ML output format: multipage "TIFF".static final String
PD4ML output format: multipage compressed "TIFF".static final double
2.835 points per mm -
Constructor Summary
Constructors -
Method Summary
-
Field Details
-
A10
74 x 105 points -
A9
105 x 148 points -
A8
148 x 210 points -
A7
210 x 297 points -
A6
297 x 421 points -
A5
421 x 595 points -
A4
595 x 842 points -
A3
842 x 1190 points -
A2
1190 x 1684 points -
A1
1684 x 2384 points -
A0
2384 x 3370 points -
ISOB5
501 x 709 points -
ISOB4
709 x 1002 points -
ISOB3
1002 x 1418 points -
ISOB2
1418 x 2004 points -
ISOB1
2004 x 2836 points -
ISOB0
2836 x 4008 points -
HALFLETTER
396 x 612 points -
LETTER
612 x 792 points -
TABLOID
792 x 1224 points -
LEDGER
1224 x 792 points -
NOTE
540 x 720 points -
LEGAL
612 x 1008 points -
ArchA
648 x 864 points -
ArchB
864 x 1296 points -
ArchC
1296 x 1728 points -
ArchD
1728 x 2592 points -
ArchE
2592 x 3456 points -
ArchE1
2160 x 3024 points -
TRANSLATE_FACTOR
public static final double TRANSLATE_FACTOR2.835 points per mm- See Also:
-
DefaultPermissions
public static final int DefaultPermissionsDocument permissions. Enables everything by default. -
AllowDegradedPrint
public static final int AllowDegradedPrintDocument access permission (bit 3, value = 4).
(isStrong=false) Print the document.
(isStrong=true) Print the document (possibly not at the highest quality level, depending on whether bit 12 is also set). -
AllowModify
public static final int AllowModifyDocument 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 AllowCopyDocument access permission (bit 5, value = 16).
(isStrong=false) Copy or otherwise extract text and graphics from the document, including extracting text and graphics (in support of accessibility to disabled users or for other purposes).
(isStrong=true) Copy or otherwise extract text and graphics from the document by operations other than that controlled by bit 10. -
AllowAnnotate
public static final int AllowAnnotateDocument 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 AllowFillingFormsDocument access permission (bit 9).
(only if isStrong=true) Fill in existing interactive form fields (including signature fields), even if bit 6 is clear. -
AllowContentExtraction
public static final int AllowContentExtractionDocument access permission (bit 10, value = 512).
(only if isStrong=true) Extract text and graphics (in support of accessibility to disabled users or for other purposes). -
AllowAssembly
public static final int AllowAssemblyDocument access permission (bit 11, value = 1024).
(only if isStrong=true) 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 AllowPrintDocument access permission (bit 12 + bit 3, value = 2052).
(only if isStrong=true) 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 lowlevel representation of the appearance, possibly of degraded quality. -
PD4ML_IDS_AS_DESTINATIONS
"pd4ml.ids.as.destinations" -
PD4ML_MOBILE_DEVICE_WIDTH
"pd4ml.mobile.device.width" - used in internal projects; to be changed in the future -
PD4ML_MOBILE_DEVICE_OPTIMIZE
"pd4ml.mobile.device.optimize" - used in internal projects; to be changed in the future -
PD4ML_EXTRA_RESOURCE_LOADERS
"pd4ml.extra.resource.loaders" -
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_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_DOCUMENT_DATE
"pd4ml.document.date" - allows to override document creation date. useful if needed a byte-to-byte document comparison. -
PD4ML_FAKE_BROWSER
"pd4ml.fake.browser" - allows PD4ML to pretend to be a regular browser (from HTTP perspective). -
PD4ML_CACHE_ENABLE
"pd4ml.cache.enable" - allows to disable internal file cache. -
PD4ML_SESSIONID_APPEND
"pd4ml.sessionid.append" - if "false" suppresses session ID append to the image/CSS requests -
PD4ML_HTTP_PROXY
"pd4ml.http.proxy" - allows to define HTTP proxy "server:port" for current conversion, keeping global proxy settings untouched. JDK1.5+- Since:
- v371
- See Also:
-
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
"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
"pd4ml.css.import.directive". If the parameter is set to "disable", @ import directives in CSS stylesheets take no effect, -
PD4ML_BASIC_AUTHENTICATION
"pd4ml.basic.authentication" - expect authentication string in "login:password" form. It forces to send the authentication info with each request -
PD4ML_SESSIONID_VARNAME
"pd4ml.sessionid.varname" -
PD4ML_INITIAL_PAGE_NUMBER
"pd4ml.initial.page.number" -
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
"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
"pd4ml.generate.tooltips" if "true", produces tooltips (PDF annotations) from TITLE HTML attributes. -
PD4ML_ABSOLUTE_ADDRESS_SPACE
"pd4ml.absolute.address.space" (not yet completely implemented!) if "pages" (default) - it uses all page space for absolute positioning and ignores explicit page breaks, if "document" - behaves as PD4ML versions prior to v360: breaks with flow (not absolute positioned) content.- See Also:
-
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- See Also:
-
PD4ML_SUPPRESS_BLANK_PAGES
"pd4ml.suppress.blank.pages" (default = "true") if "false" - PD4ML does not try to suppress occasional blank pages (i.e. generated by a sequence of page break directive)- See Also:
-
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.- See Also:
-
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
"pd4ml.document.height.px" - allows to request document height in pixels (ignoring page breaks, if any) -
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
"pd4ml.total.pages" - allows to request number of pages of generated PDF -
PD4ML_INFO_AUTHOR
"pd4ml.info.author" - allows to request document author info -
PD4ML_INFO_TITLE
"pd4ml.info.title" - allows to request document title -
PD4ML_LEGACY_RTL_MODE
"pd4ml.legacy.rtl.mode" - "true" does not change table columns order when dir=rtl (for backward compatibility with older PD4ML versions). Default is "false" -
PD4ML_FORCE_RTL
"pd4ml.force.rtl" - Applies Right-To-Left word order also to not-RTL languages. Default is "false" -
PD4ML_BACKGROUND_AS_PATTERNS
"pd4ml.background.as.patterns" - Allows to switch on pre-v385fx3 background image logic with "false" value. Default is "true" -
PD4ML_ENABLE_CANVAS_INTERPRETER
"pd4ml.enable.canvas.interpreter" - "true" forces PD4ML to lookup PD4CanvasHandler and use it as <canvas> hadler. Default is "false" -
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:
-
PD4ML_CONFIG_HANDLER_CLASS
"pd4ml.config.handler.class" - environment variable specifies configuration file reader class. If set, it overrides the default PD4ConfigHandler.- See Also:
-
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:
-
PD4ML_FIX20130116
"pd4ml.fix.20130116" - "true" forces PD4ML to workaround problem with occasional repeating of table rows after a page break- See Also:
-
PD4ML_FIX20150816
"pd4ml.fix.20150816" - "true" forces PD4ML to workaround problem with using of CJK fonts to print English texts- See Also:
-
PD4ML_STYLESHEETS_TO_OMIT
"pd4ml.stylesheets.to.omit" - semicolon-delimited list of stylesheet path patterns, to be ignored by document rendering- See Also:
-
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:
-
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_SOCKET_TIMEOUT
- See Also:
-
PD4ML_LEGACY_TEXT_BASELINE_COMPUTATION
- See Also:
-
PDF
PD4ML output format "pdf" -
PDFA
PD4ML output format "pdfa" (overrides generatePdfa(boolean)) -
RTF
PD4ML output format "rtf". Document images are embedded in their original format (compatible with MS Word and few other editors) -
RTF_WMF
PD4ML output format "rtf". Forces PD4ML to convert images (if any) to WMF for compatibility with WordPad WMF -
PNG8
PD4ML output format "PNG" (indexed colorspace). -
PNG24
PD4ML output format "PNG" (24bit colorspace, supports alpha channel). -
TIFF
PD4ML output format: multipage "TIFF". Requires JAI library in the classpath. -
TIFF_COMPRESSED
PD4ML output format: multipage compressed "TIFF". Requires JAI library in the classpath. -
PD4ML_EXTERNAL_CANVAS_HANDLER
"PD4CanvasHandler" pluggable <canvas> interpreter class name (the class must implement org.zefer.cache.DynamicImageHandler interface)- See Also:
-
-
Constructor Details
-
PD4Constants
public PD4Constants()
-