A B C D E F G H I J L M N O P R S T U V W
All Classes All Packages
All Classes All Packages
All Classes All Packages
A
- A0 - Static variable in class com.pd4ml.PageSize
-
ISO A0: 2384 x 3370 points (841 x 1189 mm).
- A1 - Static variable in class com.pd4ml.PageSize
-
ISO A1: 1684 x 2384 points (594 x 841 mm).
- A10 - Static variable in class com.pd4ml.PageSize
-
ISO A10: 74 x 105 points (26 x 37 mm).
- A2 - Static variable in class com.pd4ml.PageSize
-
ISO A2: 1190 x 1684 points (420 x 594 mm).
- A3 - Static variable in class com.pd4ml.PageSize
-
ISO A3: 842 x 1190 points (297 x 420 mm).
- A4 - Static variable in class com.pd4ml.PageSize
-
ISO A4: 595 x 842 points (210 x 297 mm).
- A5 - Static variable in class com.pd4ml.PageSize
-
ISO A5: 421 x 595 points (148 x 210 mm).
- A6 - Static variable in class com.pd4ml.PageSize
-
ISO A6: 297 x 421 points (105 x 148 mm).
- A7 - Static variable in class com.pd4ml.PageSize
-
ISO A7: 210 x 297 points (74 x 105 mm).
- A8 - Static variable in class com.pd4ml.PageSize
-
ISO A8: 148 x 210 points (52 x 74 mm).
- A9 - Static variable in class com.pd4ml.PageSize
-
ISO A9: 105 x 148 points (37 x 52 mm).
- addCustomResourceProvider(String) - Method in class com.pd4ml.PD4ML
-
Adds a custom resource loader, for example to load resources over a proprietary protocol or from a database.
- addCustomTagHandler(String, CustomTag) - Method in class com.pd4ml.PD4ML
-
Registers a handler that renders a custom HTML tag, for example
<chart>...</chart>. - addDocumentActionHandler(String, String) - Method in class com.pd4ml.PD4ML
-
Adds JavaScript that the PDF viewer runs on a document event.
- addMetadata(String, String, boolean) - Method in class com.pd4ml.PD4ML
-
Adds a custom property to the XMP metadata of the resulting PDF, for example a document ID for a document management system.
- addStyle(String, boolean) - Method in class com.pd4ml.PD4ML
-
Applies additional CSS rules to the document.
- addStyle(URL, boolean) - Method in class com.pd4ml.PD4ML
-
Applies an additional CSS stylesheet, loaded from a URL, to the document.
- addUniqueMessage(Vector<StatusMessage>, StatusMessage) - Static method in class com.pd4ml.StatusMessage
- adjustHtmlWidth(boolean) - Method in class com.pd4ml.PD4ML
-
Fits the HTML width to the actual width of the content.
- AllowAnnotate - Static variable in class com.pd4ml.Constants
-
Permission (bit 6, value 32): add or modify annotations and fill in form fields; together with
Constants.AllowModify, also create or modify form fields. - AllowAssembly - Static variable in class com.pd4ml.Constants
-
Permission (bit 11, value 1024): assemble the document (insert, rotate or delete pages, create bookmarks or thumbnails), even if
Constants.AllowModifyis not set. - AllowContentExtraction - Static variable in class com.pd4ml.Constants
-
Permission (bit 10, value 512): extract text and graphics for accessibility, for example for screen readers.
- AllowCopy - Static variable in class com.pd4ml.Constants
-
Permission (bit 5, value 16): copy or otherwise extract text and graphics from the document.
- AllowDegradedPrint - Static variable in class com.pd4ml.Constants
-
Permission (bit 3, value 4): print the document, possibly at a degraded quality unless
Constants.AllowPrintis also set. - AllowFillingForms - Static variable in class com.pd4ml.Constants
-
Permission (bit 9, value 256): fill in existing form fields, including signature fields, even if
Constants.AllowAnnotateis not set. - AllowModify - Static variable in class com.pd4ml.Constants
-
Permission (bit 4, value 8): modify the document content by operations other than those controlled by
Constants.AllowAnnotate,Constants.AllowFillingFormsandConstants.AllowAssembly. - AllowPrint - Static variable in class com.pd4ml.Constants
-
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.
- append(PdfDocumentBase) - Method in class com.pd4ml.pdf.PdfDocumentBase
-
Appends the pages of another document after the pages of this one.
- applyKerning(boolean) - Method in class com.pd4ml.PD4ML
-
Applies the kerning information of TrueType/OpenType fonts, which adjusts the spacing of specific character pairs (such as "AV") for more even-looking text.
- applyLicense(String) - Method in class com.pd4ml.PD4ML
-
Applies a license to this instance, replacing the one applied before.
- ArchA - Static variable in class com.pd4ml.PageSize
-
Architectural A: 648 x 864 points (9 x 12 in).
- ArchB - Static variable in class com.pd4ml.PageSize
-
Architectural B: 864 x 1296 points (12 x 18 in).
- ArchC - Static variable in class com.pd4ml.PageSize
-
Architectural C: 1296 x 1728 points (18 x 24 in).
- ArchD - Static variable in class com.pd4ml.PageSize
-
Architectural D: 1728 x 2592 points (24 x 36 in).
- ArchE - Static variable in class com.pd4ml.PageSize
-
Architectural E: 2592 x 3456 points (36 x 48 in).
- ArchE1 - Static variable in class com.pd4ml.PageSize
-
Architectural E1: 2160 x 3024 points (30 x 42 in).
- asyncResourceLoader(int) - Method in class com.pd4ml.PD4ML
-
Loads external resources (images, attachments and so on) in parallel, which can speed up documents that reference many remote resources.
B
- B4 - Static variable in class com.pd4ml.PageSize
-
ISO B4: 250 x 353 mm.
- B5 - Static variable in class com.pd4ml.PageSize
-
ISO B5: 176 x 250 mm.
- BatikSvgCustomTag - Class in com.pd4ml.plugins
- BatikSvgCustomTag() - Constructor for class com.pd4ml.plugins.BatikSvgCustomTag
- BatikSvgCustomTag(String, FontCache, CustomTag) - Constructor for class com.pd4ml.plugins.BatikSvgCustomTag
- bottom - Variable in class com.pd4ml.PageMargins
-
The bottom margin in points.
C
- canLoad(String, FileCache) - Method in class com.pd4ml.ResourceProvider
-
Tells whether this loader handles the given resource address, typically by checking its protocol or prefix.
- CENTER_ALIGN - Static variable in class com.pd4ml.Constants
-
Center alignment.
- clone() - Method in class com.pd4ml.StatusMessage
- closeResourceStream() - Method in class com.pd4ml.ResourceProvider
-
Releases the resources of the last
ResourceProvider.getResourceAsStream(String, FileCache)call, for example closes a connection. - com.pd4ml - package com.pd4ml
- com.pd4ml.pdf - package com.pd4ml.pdf
- com.pd4ml.plugins - package com.pd4ml.plugins
- com.pd4ml.tools - package com.pd4ml.tools
- computeScope(String, int) - Static method in class com.pd4ml.pdf.PdfDocumentBase
-
Evaluates a page scope: tells for each page of a document whether the scope selects it.
- ConflictingParametersException - Exception in com.pd4ml
-
Signals that conversion parameters were set that cannot be used together.
- ConflictingParametersException(String) - Constructor for exception com.pd4ml.ConflictingParametersException
-
Creates the exception.
- Constants - Class in com.pd4ml
-
Constants of the PD4ML API: PDF permission flags,
PD4ML.setParam(String, String)parameter keys,PD4ML.getLastRenderInfo(String)keys, output formats, encryption methods and error policies. - Constants() - Constructor for class com.pd4ml.Constants
- CONVERSION_BEGIN - Static variable in interface com.pd4ml.ProgressListener
-
The conversion has started.
- CONVERSION_END - Static variable in interface com.pd4ml.ProgressListener
-
The conversion is complete.
- createSvgParser() - Static method in class com.pd4ml.plugins.PD4MLSvgCustomTag
- CustomTag - Class in com.pd4ml
-
Base class for handlers of custom HTML tags, which render content PD4ML does not support natively, for example charts or barcodes.
- CustomTag() - Constructor for class com.pd4ml.CustomTag
-
Creates the handler object to register with
PD4ML.addCustomTagHandler(String, CustomTag). - CustomTag(String, FontCache, CustomTag) - Constructor for class com.pd4ml.CustomTag
-
Creates the handler instance for one occurrence of the tag; used by
CustomTag.getInstance(String, FontCache).
D
- decode(byte[], int, int) - Static method in class com.pd4ml.tools.Pd4Cmd.Base64
-
Very low-level access to decoding ASCII characters in the form of a byte array.
- decode(String) - Static method in class com.pd4ml.tools.Pd4Cmd.Base64
-
Decodes data from Base64 notation, automatically detecting gzip-compressed data and decompressing it.
- DECODE - Static variable in class com.pd4ml.tools.Pd4Cmd.Base64
-
Specify decoding.
- DEFAULT_PAGE_MARGINS - Static variable in class com.pd4ml.PageMargins
-
The default margins for PDF, RTF and DOCX output: 10 mm on each side.
- DEFAULT_SIZE - Static variable in class com.pd4ml.plugins.ORCodeCustomTag
- DefaultPermissions - Static variable in class com.pd4ml.Constants
-
All permissions: allows every operation on the document.
- deletePage(int) - Method in class com.pd4ml.pdf.PdfDocumentBase
-
Deletes a page.
- Dimensions - Interface in com.pd4ml
-
Unit conversion factors and measurement units used by
PageSizeandPageMargins. - Dimensions.Units - Enum in com.pd4ml
-
Measurement units for
PageSizeandPageMarginsvalues. - disable - Static variable in class com.pd4ml.plugins.BatikSvgCustomTag
- disable - Static variable in class com.pd4ml.plugins.MathMLCustomTag
- disable - Static variable in class com.pd4ml.plugins.ORCodeCustomTag
- disableBatik - Static variable in class com.pd4ml.PD4ML
-
Global switch,
falseby default. - disableMathML - Static variable in class com.pd4ml.PD4ML
-
Global switch,
falseby default. - doc - Variable in class com.pd4ml.plugins.BatikSvgCustomTag
- DOC_RENDER_IN_PROGRESS - Static variable in interface com.pd4ml.ProgressListener
-
Pages are being rendered; sent once per page, with the page number as the message.
- DOC_WRITE_BEGIN - Static variable in interface com.pd4ml.ProgressListener
-
Writing the output has started.
- DOCX - Static variable in class com.pd4ml.Constants
-
Output format "docx": a Microsoft Word document.
- DOCX_PRE_RENDER_DONE - Static variable in interface com.pd4ml.ProgressListener
-
The preparation of DOCX output is complete.
- DONT_BREAK_LINES - Static variable in class com.pd4ml.tools.Pd4Cmd.Base64
-
Don't break lines when encoding (violates strict Base64 specification)
- dontCache() - Method in class com.pd4ml.ResourceProvider
-
Tells whether loaded resources must not be kept in the resource cache, for example because they change between requests.
- dump(int) - Method in class com.pd4ml.PD4ML
-
Returns a text dump of internal structures, for diagnostics and support requests.
- dumpOutlines() - Method in class com.pd4ml.pdf.PdfDocumentBase
-
Returns a text dump of the bookmark (outline) tree, for diagnostics.
E
- embedTTFs(boolean, boolean) - Method in class com.pd4ml.PD4ML
-
Controls how TrueType/OpenType fonts are stored in the resulting PDF.
- enableHyperlinks(boolean) - Method in class com.pd4ml.PD4ML
-
Controls whether HTML links become clickable links in the resulting PDF.
- enableLigatures(boolean) - Method in class com.pd4ml.PD4ML
-
Enables OpenType text shaping with TrueType/OpenType fonts: glyph substitution (GSUB tables) for ligatures such as "fi" and "fl", and the compound glyphs that complex scripts such as Devanagari need for correct rendering.
- ENCODE - Static variable in class com.pd4ml.tools.Pd4Cmd.Base64
-
Specify encoding.
- ERROR - Static variable in class com.pd4ml.StatusMessage
-
Message type: a problem that makes the output non-conforming or restricted.
- extractAttachments(String, short) - Static method in class com.pd4ml.tools.Pd4Cmd
F
- fitPageVertically(int) - Method in class com.pd4ml.PD4ML
-
Scales the whole document down so that it fits on a single page vertically, including the page header and footer.
- flipHorizontal() - Method in class com.pd4ml.PageMargins
-
Returns a copy with the left and right margins swapped, for example for the facing pages of a book.
- flipVertical() - Method in class com.pd4ml.PageMargins
-
Returns a copy with the top and bottom margins swapped.
- ForcedTerminationException - Exception in com.pd4ml
-
Thrown on the conversion thread when the conversion has been cancelled with
PD4ML.terminate(). - ForcedTerminationException() - Constructor for exception com.pd4ml.ForcedTerminationException
G
- generateBookmarksFromAnchors(boolean) - Method in class com.pd4ml.PD4ML
-
Generates the PDF bookmarks (outline) from named anchors, that is from
<a name="destination">Label</a>tags. - generateBookmarksFromHeadings(boolean) - Method in class com.pd4ml.PD4ML
-
Generates the PDF bookmarks (outline) from the document headings: each
<h1>to<h6>becomes a bookmark, nested by heading level. - generateForms(boolean, String) - Method in class com.pd4ml.PD4ML
-
Converts HTML form controls (
<input>,<textarea>,<select>) to interactive PDF form fields (AcroForm) instead of static images of them. - generateForms(boolean, String, String) - Method in class com.pd4ml.PD4ML
-
Converts HTML form controls to interactive PDF form fields, like
PD4ML.generateForms(boolean, String), and embeds the glyphs for the characters users may type into the fields. - generateMulticolumn(int, int, boolean) - Method in class com.pd4ml.PD4ML
-
Intended to lay out the document in several columns per page.
- getAuthor() - Method in class com.pd4ml.pdf.PdfDocumentBase
-
Returns the author from the document properties.
- getCache() - Method in class com.pd4ml.PD4ML
-
Returns the font and resource cache of this instance, so later conversions can reuse it with
PD4ML.setCache(Object)instead of loading the same fonts and resources again. - getCreationDate() - Method in class com.pd4ml.pdf.PdfDocumentBase
-
Returns the creation date from the document properties.
- getCreator() - Method in class com.pd4ml.pdf.PdfDocumentBase
-
Returns the creator from the document properties: the application the original document was created with.
- getDetails() - Method in class com.pd4ml.StatusMessage
-
Returns additional details about the problem, for example the requested output format.
- getDocumentTitle() - Method in class com.pd4ml.PD4ML
-
Returns the document title: the one set with
PD4ML.setDocumentTitle(String), or else the<title>of the HTML document. - getEncoding() - Method in class com.pd4ml.ResourceProvider
-
Returns the character encoding of the loaded resource, as set by the implementation in
ResourceProvider.encoding. - getFitPageVertically() - Method in class com.pd4ml.PD4ML
-
Returns the alignment set by
PD4ML.fitPageVertically(int). - getHeight(int) - Method in class com.pd4ml.CustomTag
-
Returns the natural height of the element.
- getHeight(int) - Method in class com.pd4ml.PD4ML
-
Calculates the height of the whole document laid out at the given width, ignoring page breaks.
- getHeight(int) - Method in class com.pd4ml.plugins.BatikSvgCustomTag
- getHeight(int) - Method in class com.pd4ml.plugins.MathMLCustomTag
- getHeight(int) - Method in class com.pd4ml.plugins.ORCodeCustomTag
- getHeight(int) - Method in class com.pd4ml.plugins.PD4MLSvgCustomTag
- getInnerCode() - Method in class com.pd4ml.CustomTag
-
Returns the source code of the tag occurrence: the complete element as it appears in the document, including the opening tag with its attributes, the content and the closing tag, for example
<chart type="pie">...</chart>. - getInnerCode() - Method in class com.pd4ml.plugins.BatikSvgCustomTag
- getInstance(String) - Static method in class com.pd4ml.PageSize
-
Returns a page size by name or by dimensions.
- getInstance(String, FontCache) - Method in class com.pd4ml.CustomTag
-
Creates the handler instance for one occurrence of the tag.
- getInstance(String, FontCache) - Method in class com.pd4ml.plugins.BatikSvgCustomTag
- getInstance(String, FontCache) - Method in class com.pd4ml.plugins.MathMLCustomTag
- getInstance(String, FontCache) - Method in class com.pd4ml.plugins.ORCodeCustomTag
- getInstance(String, FontCache) - Method in class com.pd4ml.plugins.PD4MLSvgCustomTag
- getKeywords() - Method in class com.pd4ml.pdf.PdfDocumentBase
-
Returns the keywords from the document properties.
- getLang() - Method in class com.pd4ml.plugins.MathMLCustomTag
- getLastRenderInfo(String) - Method in class com.pd4ml.PD4ML
-
Returns information about the last conversion, after a
write...orrenderAsImages(...)call. - getMessage() - Method in class com.pd4ml.StatusMessage
-
Returns the message text.
- getMessage(int, String) - Static method in class com.pd4ml.StatusMessage
-
Creates a copy of a predefined message.
- getMetadata() - Method in class com.pd4ml.pdf.PdfDocumentBase
-
Returns the XMP metadata of the document, for example to check its PDF/A conformance declaration.
- getMime() - Method in class com.pd4ml.ResourceProvider
-
Returns the MIME type of the loaded resource, as set by the implementation in
ResourceProvider.mime. - getModDate() - Method in class com.pd4ml.pdf.PdfDocumentBase
-
Returns the modification date from the document properties.
- getNumberOfPages() - Method in class com.pd4ml.pdf.PdfDocumentBase
-
Returns the number of pages, including the pages of an appended document.
- getPageBox(int, String) - Method in class com.pd4ml.pdf.PdfDocumentBase
-
Returns a page boundary box.
- getPageContent(int) - Method in class com.pd4ml.pdf.PdfDocumentBase
-
Returns the decoded content stream of a page: the PDF drawing operators, for diagnostics or simple text checks.
- getPageMargins(int, boolean) - Method in class com.pd4ml.PD4ML
-
Returns the margins of a page, as determined by the defaults,
setPageMargins(...)calls and, afterreadHTML(...), CSS@pagerules of the document. - getPageSize(int) - Method in class com.pd4ml.PD4ML
-
Returns the size of a page, as determined by the default page size,
setPageSize(...)calls and, afterreadHTML(...), CSS@pagerules of the document. - getPageSize(int) - Method in class com.pd4ml.pdf.PdfDocumentBase
-
Returns the size of a page: the size of its crop box (the area viewers show), or of its media box if it has no crop box.
- getPdfFormatVersion() - Method in class com.pd4ml.pdf.PdfDocumentBase
-
Returns the PDF version of the document, from its file header.
- getPermissions() - Method in class com.pd4ml.pdf.PdfDocumentBase
-
Returns the access permissions of the document, as a combination of the
Constants.Allow*flags. - getProducer() - Method in class com.pd4ml.pdf.PdfDocumentBase
-
Returns the producer from the document properties: the software that wrote the PDF.
- getResourceAsBytes(String, FileCache) - Method in class com.pd4ml.ResourceProvider
-
Loads the resource completely.
- getResourceAsStream(String, FileCache) - Method in class com.pd4ml.ResourceProvider
-
Opens the resource for reading.
- getSubject() - Method in class com.pd4ml.pdf.PdfDocumentBase
-
Returns the subject from the document properties.
- getTitle() - Method in class com.pd4ml.pdf.PdfDocumentBase
-
Returns the title from the document properties.
- getTitle(Context) - Method in class com.pd4ml.plugins.MathMLCustomTag
- getVersion() - Static method in class com.pd4ml.PD4ML
-
Returns the version of the PD4ML library.
- getVersionBuildDate() - Static method in class com.pd4ml.PD4ML
-
Returns the build date of the PD4ML library.
- getWidth(int) - Method in class com.pd4ml.CustomTag
-
Returns the natural width of the element.
- getWidth(int) - Method in class com.pd4ml.plugins.BatikSvgCustomTag
- getWidth(int) - Method in class com.pd4ml.plugins.MathMLCustomTag
- getWidth(int) - Method in class com.pd4ml.plugins.ORCodeCustomTag
- getWidth(int) - Method in class com.pd4ml.plugins.PD4MLSvgCustomTag
- GZIP - Static variable in class com.pd4ml.tools.Pd4Cmd.Base64
-
Specify that data should be gzip-compressed.
H
- HALFLETTER - Static variable in class com.pd4ml.PageSize
-
Half Letter (Statement): 396 x 612 points (5.5 x 8.5 in).
- height - Variable in class com.pd4ml.PageSize
-
The page height in points.
- HTML_LAYOUT_DONE - Static variable in interface com.pd4ml.ProgressListener
-
The layout is complete.
- HTML_LAYOUT_IN_PROGRESS - Static variable in interface com.pd4ml.ProgressListener
-
The layout is in progress; sent repeatedly.
- HTML_PARSED - Static variable in interface com.pd4ml.ProgressListener
-
The source document has been parsed.
I
- injectHtml(String, boolean) - Method in class com.pd4ml.PD4ML
-
Inserts HTML code into the document body without changing the document source.
- InvalidPasswordException - Exception in com.pd4ml
-
Thrown when an encrypted PDF document cannot be opened because the password given to the
PdfDocumentconstructor is missing or wrong. - InvalidPasswordException(String) - Constructor for exception com.pd4ml.InvalidPasswordException
-
Creates the exception.
- InvokeException - Exception in com.pd4ml
-
Thrown when the PD4ML API is used incorrectly: an invalid argument, or a method called at the wrong time (for example a configuration method after
readHTML(...), or awrite...method before it). - InvokeException(String) - Constructor for exception com.pd4ml.InvokeException
-
Creates the exception.
- InvokeException(Throwable) - Constructor for exception com.pd4ml.InvokeException
-
Creates the exception for an underlying cause.
- isDemoMode() - Method in class com.pd4ml.PD4ML
-
Tells whether the converter runs in demo mode, that is, without a valid license.
- isDirectory() - Method in class com.pd4ml.ResourceProvider
-
Tells whether the requested address is a directory rather than a resource, as set by the implementation in
ResourceProvider.dir. - isEmptyTag() - Method in class com.pd4ml.CustomTag
-
Tells the parser whether the tag is an empty element without content or closing tag, like
<br>. - isEmptyTag() - Method in class com.pd4ml.plugins.BatikSvgCustomTag
- isEmptyTag() - Method in class com.pd4ml.plugins.MathMLCustomTag
- isEmptyTag() - Method in class com.pd4ml.plugins.ORCodeCustomTag
- isEmptyTag() - Method in class com.pd4ml.plugins.PD4MLSvgCustomTag
- isError() - Method in class com.pd4ml.StatusMessage
-
Tells whether this is an error: for PDF/A output, the result does not conform to the requested standard; otherwise, the output is restricted, for example by the license.
- ISO8859_1 - Static variable in class com.pd4ml.Constants
-
The ISO-8859-1 (Latin-1) encoding name.
- ISOB0 - Static variable in class com.pd4ml.PageSize
-
ISO B0: 2836 x 4008 points (1000 x 1414 mm).
- ISOB1 - Static variable in class com.pd4ml.PageSize
-
ISO B1: 2004 x 2836 points (707 x 1000 mm).
- ISOB2 - Static variable in class com.pd4ml.PageSize
-
ISO B2: 1418 x 2004 points (500 x 707 mm).
- ISOB3 - Static variable in class com.pd4ml.PageSize
-
ISO B3: 1002 x 1418 points (353 x 500 mm).
- ISOB4 - Static variable in class com.pd4ml.PageSize
-
ISO B4: 709 x 1002 points (250 x 353 mm).
- ISOB5 - Static variable in class com.pd4ml.PageSize
-
ISO B5: 501 x 709 points (176 x 250 mm).
- isPro() - Method in class com.pd4ml.PD4ML
-
Tells whether the applied license enables Pro features, such as TTF font embedding (
PD4ML.useTTF(String)), PDF forms,PD4ML.addStyle(String, boolean)andPD4ML.merge(PdfDocument, int, int, boolean). - isTaggedOutput(Context) - Method in class com.pd4ml.plugins.MathMLCustomTag
- isWarning() - Method in class com.pd4ml.StatusMessage
-
Tells whether this is a warning: PD4ML worked around a problem, for example by ignoring a setting the requested standard does not allow.
J
- JIS_B4 - Static variable in class com.pd4ml.PageSize
-
JIS B4 (Japanese standard): 257 x 364 mm.
- JIS_B5 - Static variable in class com.pd4ml.PageSize
-
JIS B5 (Japanese standard): 182 x 257 mm.
L
- LEDGER - Static variable in class com.pd4ml.PageSize
-
Ledger: 1224 x 792 points (17 x 11 in), the landscape form of
PageSize.TABLOID. - left - Variable in class com.pd4ml.PageMargins
-
The left margin in points.
- LEFT_ALIGN - Static variable in class com.pd4ml.Constants
-
Left alignment.
- LEGAL - Static variable in class com.pd4ml.PageSize
-
US Legal: 612 x 1008 points (8.5 x 14 in).
- LETTER - Static variable in class com.pd4ml.PageSize
-
US Letter: 612 x 792 points (8.5 x 11 in).
- localFile() - Method in class com.pd4ml.ResourceProvider
-
Returns the local file that holds the resource, if any, so PD4ML can access it directly.
M
- main(String[]) - Static method in class com.pd4ml.tools.Pd4Cmd
- MAIN_DOC_READ - Static variable in interface com.pd4ml.ProgressListener
-
The source document has been loaded.
- MathMLCustomTag - Class in com.pd4ml.plugins
- MathMLCustomTag() - Constructor for class com.pd4ml.plugins.MathMLCustomTag
- MathMLCustomTag(String, FontCache, CustomTag) - Constructor for class com.pd4ml.plugins.MathMLCustomTag
- merge(PdfDocument, int, int, boolean) - Method in class com.pd4ml.PD4ML
-
Combines the PDF produced by the next
PD4ML.writePDF(OutputStream)call with pages of an existing PDF document. - mergePDFs(InputStream, InputStream, OutputStream) - Static method in class com.pd4ml.PdfDocument
-
Concatenates two PDF documents: writes all pages of
pdf1followed by all pages ofpdf2toresult. - mime - Variable in class com.pd4ml.ResourceProvider
-
The MIME type of the loaded resource, for example "image/png", or
nullif unknown. - MM - com.pd4ml.Dimensions.Units
-
Millimeters.
- MM_PER_INCH - Static variable in interface com.pd4ml.Dimensions
-
Millimeters per inch: 25.4.
- mmHeight() - Method in class com.pd4ml.PageSize
-
Intended to return the height in millimeters.
- mmWidth() - Method in class com.pd4ml.PageSize
-
Intended to return the width in millimeters.
- monitorProgressWith(ProgressListener) - Method in class com.pd4ml.PD4ML
-
Registers a listener that is notified about the progress of the conversion, for example to show a progress bar.
- MULTIPAGE_TIFF - Static variable in class com.pd4ml.Constants
-
Image format "mpagetiff": a single uncompressed TIFF image with all pages.
- MULTIPAGE_TIFF_COMPRESSED - Static variable in class com.pd4ml.Constants
-
Image format "mpagetiffcomp": a single compressed (PackBits) TIFF image with all pages.
N
- NO_OPTIONS - Static variable in class com.pd4ml.tools.Pd4Cmd.Base64
-
No options specified.
- NOTE - Static variable in class com.pd4ml.PageSize
-
Note: 540 x 720 points (7.5 x 10 in).
O
- ORCodeCustomTag - Class in com.pd4ml.plugins
- ORCodeCustomTag() - Constructor for class com.pd4ml.plugins.ORCodeCustomTag
- ORCodeCustomTag(String, FontCache, CustomTag) - Constructor for class com.pd4ml.plugins.ORCodeCustomTag
- outputRange(String) - Method in class com.pd4ml.PD4ML
-
Limits the output to the selected pages.
- overlay(PdfDocumentBase, int) - Method in class com.pd4ml.pdf.PdfDocumentBase
-
Draws the pages of another document over the pages of this one, for example to stamp a watermark or a "COPY" label.
- overlay(PdfDocumentBase, String, String, int) - Method in class com.pd4ml.pdf.PdfDocumentBase
-
Draws selected pages of another document over selected pages of this one.
- overrideDocumentEncoding(String) - Method in class com.pd4ml.PD4ML
-
Forces the encoding of the HTML document, overriding the encoding reported by the server, the byte order mark and
<meta>charset declarations.
P
- PAGEBREAKS_ALIGNED - Static variable in interface com.pd4ml.ProgressListener
-
The content has been distributed across pages.
- PageMargins - Class in com.pd4ml
-
Page margins: the distances between the page edges and the page content area, in points (1/72 inch).
- PageMargins(float, float, float, float) - Constructor for class com.pd4ml.PageMargins
-
Creates page margins in points (1/72 inch).
- PageMargins(float, float, float, float, Dimensions.Units) - Constructor for class com.pd4ml.PageMargins
-
Creates page margins in the given units.
- PageSize - Class in com.pd4ml
-
A page size in points (1/72 inch), with constants for the common ISO, JIS, North American and architectural paper formats.
- PageSize(float, float) - Constructor for class com.pd4ml.PageSize
-
Creates a page size in points (1/72 inch).
- PageSize(float, float, Dimensions.Units) - Constructor for class com.pd4ml.PageSize
-
Creates a page size in the given units.
- paint(float, float, float, float, float, float, Graphics2D) - Method in class com.pd4ml.CustomTag
-
Draws the element.
- paint(float, float, float, float, float, float, Graphics2D) - Method in class com.pd4ml.plugins.BatikSvgCustomTag
- paint(float, float, float, float, float, float, Graphics2D) - Method in class com.pd4ml.plugins.MathMLCustomTag
- paint(float, float, float, float, float, float, Graphics2D) - Method in class com.pd4ml.plugins.PD4MLSvgCustomTag
- paint(float, float, Graphics2D) - Method in class com.pd4ml.CustomTag
-
Draws the element at the given position, at its natural size.
- paint(float, float, Graphics2D) - Method in class com.pd4ml.plugins.ORCodeCustomTag
- parse(String, String) - Method in class com.pd4ml.plugins.BatikSvgCustomTag
- Pd4Cmd - Class in com.pd4ml.tools
- Pd4Cmd() - Constructor for class com.pd4ml.tools.Pd4Cmd
- Pd4Cmd.Base64 - Class in com.pd4ml.tools
-
Encodes and decodes to and from Base64 notation.
- Pd4CmdException - Exception in com.pd4ml.tools
- Pd4CmdException() - Constructor for exception com.pd4ml.tools.Pd4CmdException
- Pd4CmdException(String) - Constructor for exception com.pd4ml.tools.Pd4CmdException
- PD4ML - Class in com.pd4ml
-
The main entry point of PD4ML: converts HTML/CSS documents to PDF, PDF/A, PDF/UA, RTF, DOCX or page images.
- PD4ML() - Constructor for class com.pd4ml.PD4ML
-
Creates a converter instance with logging disabled.
- PD4ML(int) - Constructor for class com.pd4ml.PD4ML
-
Creates a converter instance with the given log level.
- PD4ML(String) - Constructor for class com.pd4ml.PD4ML
-
Creates a converter instance with the given license and logging disabled.
- PD4ML(String, int) - Constructor for class com.pd4ml.PD4ML
-
Creates a converter instance with the given license and log level.
- PD4ML_ALLOWED_RESOURCE_LOCATION - Static variable in class com.pd4ml.Constants
-
"pd4ml.allowed.resource.location": a URL prefix that restricts where external resources (stylesheets, images, attachments) may be loaded from.
- PD4ML_BACKGROUND_AS_PATTERNS - Static variable in class com.pd4ml.Constants
-
"pd4ml.background.as.patterns": "false" switches back to the background image rendering used before v3.8.5fx3.
- PD4ML_CACHE_ENABLE - Static variable in class com.pd4ml.Constants
-
"pd4ml.cache.enable": "false" disables the resource cache, so every resource is loaded anew.
- PD4ML_CACHE_IMAGES_IN_TMP_DIR - Static variable in class com.pd4ml.Constants
-
"pd4ml.cache.images.in.tmp.dir": "true" makes PD4ML keep loaded images in temporary files instead of memory.
- PD4ML_CONFIG_FILE - Static variable in class com.pd4ml.Constants
-
"pd4ml.config.file": a JVM system property with the location of a configuration file in
.propertiesformat. - PD4ML_CONFIG_HANDLER_CLASS - Static variable in class com.pd4ml.Constants
-
"pd4ml.config.handler.class": a JVM system property with the name of a class that reads the configuration file instead of the default
PD4ConfigHandler. - PD4ML_CSS_IMPORT_DIRECTIVE - Static variable in class com.pd4ml.Constants
-
"pd4ml.css.import.directive": "disable" makes PD4ML ignore
@importrules in stylesheets. - PD4ML_DISABLE_EXTERNAL_ATTACHMENTS - Static variable in class com.pd4ml.Constants
-
"pd4ml.disable.external.attachments": "true" stops PD4ML from loading
<pd4ml:attachment>files from the local file system or from URLs. - PD4ML_DISABLE_WOFF - Static variable in class com.pd4ml.Constants
-
"pd4ml.disable.woff": "true" disables WOFF web fonts in
@font-facerules, so the fallback fonts are used. - PD4ML_DISABLE_WOFF2 - Static variable in class com.pd4ml.Constants
-
"pd4ml.disable.woff2": "true" disables WOFF2 web fonts in
@font-facerules, so the fallback fonts are used. - PD4ML_DOCUMENT_DATE - Static variable in class com.pd4ml.Constants
-
"pd4ml.document.date": overrides the creation date in the PDF document properties, for example to produce byte-identical output for comparisons.
- PD4ML_DOCUMENT_HEIGHT_PX - Static variable in class com.pd4ml.Constants
-
Key for
PD4ML.getLastRenderInfo(String): returns the height of the laid-out document in pixels, ignoring page breaks, as aLong. - PD4ML_DOCUMENT_VIEW_MODE - Static variable in class com.pd4ml.Constants
-
"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).
- PD4ML_DOCUMENT_XMP_DATE - Static variable in class com.pd4ml.Constants
-
"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.
- PD4ML_DUMP_DEFAULT_STYLE - Static variable in class com.pd4ml.Constants
-
"pd4ml.dump.no.default.style": for debugging only.
- PD4ML_ENABLE_HTTP_ERRORS - Static variable in class com.pd4ml.Constants
-
"pd4ml.enable.http.errors": intended to report HTTP errors when loading the main document as exceptions instead of producing an empty document.
- PD4ML_EXTRA_RESOURCE_LOADERS - Static variable in class com.pd4ml.Constants
-
"pd4ml.extra.resource.loaders".
- PD4ML_FAKE_BROWSER - Static variable in class com.pd4ml.Constants
-
"pd4ml.fake.browser": "true" makes PD4ML identify itself as a regular web browser in HTTP requests, for servers that reject unknown clients.
- PD4ML_FIX20130116 - Static variable in class com.pd4ml.Constants
-
"pd4ml.fix.20130116": a workaround for table rows repeated after a page break in old versions.
- PD4ML_FORCE_RTL - Static variable in class com.pd4ml.Constants
-
"pd4ml.force.rtl": "true" applies right-to-left word order to all text, including text in left-to-right languages.
- PD4ML_GENERATE_TOOLTIPS - Static variable in class com.pd4ml.Constants
-
"pd4ml.generate.tooltips": "true" turns the
titleattributes of HTML elements into PDF annotations, which viewers show as tooltips. - PD4ML_HEADER_HEIGHT_LIMIT - Static variable in class com.pd4ml.Constants
-
"pd4ml.header.height.limit": "false" removed the limit of page header and footer height to one third of the page height in old versions.
- PD4ML_HTML_IN_DYNAMIC_DATA - Static variable in class com.pd4ml.Constants
-
"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. - PD4ML_HTTP_REQUEST_DISPATCHER - Static variable in class com.pd4ml.Constants
-
"pd4ml.http.request.dispatcher".
- PD4ML_IDS_AS_DESTINATIONS - Static variable in class com.pd4ml.Constants
-
"pd4ml.ids.as.destinations": "true" (the default) lets links address any element by its
idattribute (<a href="#chapter2">), in addition to<a name="...">anchors; "false" restricts link destinations to named anchors. - PD4ML_IMAGE_REPOSITORY - Static variable in class com.pd4ml.Constants
-
"pd4ml.image.repository".
- PD4ML_INFO_AUTHOR - Static variable in class com.pd4ml.Constants
-
Intended as a
PD4ML.getLastRenderInfo(String)key for the document author; not supported by this version of PD4ML (nullis returned). - PD4ML_INFO_TITLE - Static variable in class com.pd4ml.Constants
-
Intended as a
PD4ML.getLastRenderInfo(String)key for the document title; not supported by this version of PD4ML (nullis returned). - PD4ML_INITIAL_PAGE_NUMBER - Static variable in class com.pd4ml.Constants
-
"pd4ml.initial.page.number": the number of the first page, as an integer string.
- PD4ML_KEEP_TRAILING_BLANK_PAGES - Static variable in class com.pd4ml.Constants
-
"pd4ml.keep.trailing.blank.pages": "true" keeps blank pages at the end of the document.
- PD4ML_MAX_CACHE_ENTRIES - Static variable in class com.pd4ml.Constants
-
"pd4ml.max.cache.entries".
- PD4ML_MAX_CACHE_SIZE - Static variable in class com.pd4ml.Constants
-
"pd4ml.max.cache.size": the maximum number of resources (images, stylesheets and so on) kept in the resource cache; 1024 by default.
- PD4ML_MAX_CACHE_VOLUME - Static variable in class com.pd4ml.Constants
-
"pd4ml.max.cache.volume": the maximum total size of the resource cache in bytes; unlimited by default.
- PD4ML_MEDIA_TYPE_PRINT - Static variable in class com.pd4ml.Constants
-
"pd4ml.media.type.print": controls which CSS media types apply.
- PD4ML_OMIT_DEFAULT_STYLE - Static variable in class com.pd4ml.Constants
-
"pd4ml.omit.default.style": for debugging only.
- PD4ML_PDFA_STATUS - Static variable in class com.pd4ml.Constants
-
Key for
PD4ML.getLastRenderInfo(String): returns the warnings and errors recorded during the last conversion, as aStatusMessage[]. - PD4ML_PRINT_DIALOG_POPUP - Static variable in class com.pd4ml.Constants
-
"pd4ml.print.dialog.popup".
- PD4ML_RIGHT_EDGE_PX - Static variable in class com.pd4ml.Constants
-
Key for
PD4ML.getLastRenderInfo(String): returns the right edge of the content of the last conversion in pixels, as aLong. - PD4ML_SESSIONID_APPEND - Static variable in class com.pd4ml.Constants
-
"pd4ml.sessionid.append": "false" stops PD4ML from appending the session ID set with
PD4ML.setSessionID(String)to resource URLs. - PD4ML_SESSIONID_VARNAME - Static variable in class com.pd4ml.Constants
-
"pd4ml.sessionid.varname": the name of the URL parameter that carries the session ID set with
PD4ML.setSessionID(String); "jsessionid" by default. - PD4ML_SOCKET_TIMEOUT - Static variable in class com.pd4ml.Constants
-
"pd4ml.socket.timeout": the connect and read timeout for HTTP(S) resource requests, in milliseconds.
- PD4ML_STYLESHEETS_TO_OMIT - Static variable in class com.pd4ml.Constants
-
"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.
- PD4ML_TOTAL_PAGES - Static variable in class com.pd4ml.Constants
-
Key for
PD4ML.getLastRenderInfo(String): returns the number of pages of the last conversion, as aLong. - PD4MLSvgCustomTag - Class in com.pd4ml.plugins
- PD4MLSvgCustomTag() - Constructor for class com.pd4ml.plugins.PD4MLSvgCustomTag
- PD4MLSvgCustomTag(String, FontCache, CustomTag) - Constructor for class com.pd4ml.plugins.PD4MLSvgCustomTag
- pdf - Variable in class com.pd4ml.pdf.PdfDocumentBase
-
The parsed document,
nulluntil it has been read. - PDF - Static variable in class com.pd4ml.Constants
-
Output format "pdf": a regular PDF document (PDF 1.5).
- PDFA - Static variable in class com.pd4ml.Constants
-
Output format "pdfa": a PDF/A-1b document for long-term archiving.
- PdfDocument - Class in com.pd4ml
-
An existing PDF document, for post-processing: reading and changing document properties, appending another document, putting the pages of another document over or under its pages, deleting pages, and saving it, optionally encrypted.
- PdfDocument(byte[], String) - Constructor for class com.pd4ml.PdfDocument
-
Creates a document from PDF bytes.
- PdfDocument(PdfDoc) - Constructor for class com.pd4ml.PdfDocument
-
Creates a document from a document built with PD4ML's internal PDF writer.
- PdfDocument(InputStream, String) - Constructor for class com.pd4ml.PdfDocument
-
Creates a document from a stream.
- PdfDocument(URL, String) - Constructor for class com.pd4ml.PdfDocument
-
Creates a document from a URL (
file:,http:,https:orjava:for classpath resources). - PdfDocumentBase - Class in com.pd4ml.pdf
-
The base class of
PdfDocument: an existing PDF document that can be inspected, changed and saved. - PdfDocumentBase(byte[], String) - Constructor for class com.pd4ml.pdf.PdfDocumentBase
-
Creates a document from PDF bytes.
- PdfDocumentBase(InputStream, String) - Constructor for class com.pd4ml.pdf.PdfDocumentBase
-
Creates a document from a stream.
- PdfDocumentBase(URL, String) - Constructor for class com.pd4ml.pdf.PdfDocumentBase
-
Creates a document from a URL.
- PDFUA - Static variable in class com.pd4ml.Constants
-
Output format "pdfua": an accessible, tagged PDF that conforms to both PDF/UA-1 and PDF/A-2a.
- PIXELS_PER_POINT - Static variable in interface com.pd4ml.Dimensions
-
HTML pixels per point when no HTML width is set: 1.35.
- PNG24 - Static variable in class com.pd4ml.Constants
-
Image format "png24": PNG images with 24-bit color and an alpha channel (transparency).
- PNG8 - Static variable in class com.pd4ml.Constants
-
Image format "png8": PNG images with 24-bit color and no transparency.
- POINTS_PER_INCH - Static variable in interface com.pd4ml.Dimensions
-
Points per inch: 72.
- POINTS_PER_MM - Static variable in interface com.pd4ml.Dimensions
-
Points per millimeter: 2.835 (72 / 25.4, rounded).
- predictPageHeight(PageMargins, PageSize, int) - Static method in class com.pd4ml.PD4ML
-
Calculates how many HTML pixels of content fit on one page for the given settings: the printable page height (page height minus top and bottom margins) divided by the scale factor from
PD4ML.predictScale(PageMargins, PageSize, int). - predictScale(PageMargins, PageSize, int) - Static method in class com.pd4ml.PD4ML
-
Calculates the scale factor from HTML pixels to PDF points for the given settings: the printable page width (page width minus left and right margins) divided by the HTML width.
- ProgressListener - Interface in com.pd4ml
-
Receives progress notifications during a conversion, for example to update a progress bar or to log timing information.
- progressUpdate(int, int, String, long) - Method in interface com.pd4ml.ProgressListener
-
Called at each stage of the conversion.
- protectPhysicalUnitDimensions(boolean) - Method in class com.pd4ml.PD4ML
-
Keeps sizes given in physical units (
in,cm,mm,pt,pc) at their exact physical size in the PDF, regardless of the HTML width. - PT - com.pd4ml.Dimensions.Units
-
Points (1/72 inch).
- PX - com.pd4ml.Dimensions.Units
-
Pixels, converted at
Dimensions.PIXELS_PER_POINTpixels per point.
R
- read() - Method in class com.pd4ml.pdf.PdfDocumentBase
-
Loads and parses the document.
- readHTML(InputStream) - Method in class com.pd4ml.PD4ML
-
Reads and parses an HTML document from a stream.
- readHTML(InputStream, URL) - Method in class com.pd4ml.PD4ML
-
Reads and parses an HTML document from a stream, decoding it with the platform default encoding (the
file.encodingsystem property). - readHTML(InputStream, URL, String) - Method in class com.pd4ml.PD4ML
-
Reads and parses an HTML document from a stream, with an explicit encoding.
- readHTML(URL) - Method in class com.pd4ml.PD4ML
-
Loads and parses an HTML document from a URL (
file:,http:,https:,java:for classpath resources, or a protocol handled by a custom resource provider). - readHTML(URL, String) - Method in class com.pd4ml.PD4ML
-
Loads and parses an HTML document from a URL, with an explicit encoding.
- redirected - Variable in class com.pd4ml.ResourceProvider
-
The final address of the resource if the request was redirected, otherwise
null. - renderAsImages() - Method in class com.pd4ml.PD4ML
-
Lays out the document and draws each page as an image in memory, for example to display or post-process the pages.
- renderAsImages(File, String, String) - Method in class com.pd4ml.PD4ML
-
Lays out the document and writes each page as a PNG image file.
- renderAsImages(String) - Method in class com.pd4ml.PD4ML
-
Lays out the document and encodes each page as an image in memory.
- RENDERER_TREE_BUILT - Static variable in interface com.pd4ml.ProgressListener
-
The layout structure has been built from the parsed document.
- ResourceProvider - Class in com.pd4ml
-
Base class for custom resource loaders, which let PD4ML load documents, images, stylesheets and other resources from sources it does not support natively: a proprietary protocol, a database, an encrypted store and so on.
- ResourceProvider() - Constructor for class com.pd4ml.ResourceProvider
- right - Variable in class com.pd4ml.PageMargins
-
The right margin in points.
- RIGHT_ALIGN - Static variable in class com.pd4ml.Constants
-
Right alignment.
- rotate() - Method in class com.pd4ml.PageMargins
-
Returns a copy rotated by 90 degrees, matching a page rotated with
PageSize.rotate(): the new left margin is the old top margin, the new top is the old right, and so on. - rotate() - Method in class com.pd4ml.PageSize
-
Returns the size rotated by 90 degrees, with width and height swapped, for example to turn a portrait format into landscape.
- rotated - Variable in class com.pd4ml.PageSize
-
trueif the size was created byPageSize.rotate(). - RTF - Static variable in class com.pd4ml.Constants
-
Output format "rtf": an RTF document with images embedded in their original format, which Microsoft Word and most other editors support.
- RTF_PRE_RENDER_DONE - Static variable in interface com.pd4ml.ProgressListener
-
The preparation of RTF output is complete.
- RTF_WMF - Static variable in class com.pd4ml.Constants
-
Output format "rtfwmf": an RTF document with images converted to WMF, for viewers such as WordPad that support no other image format.
S
- setAuthor(String) - Method in class com.pd4ml.pdf.PdfDocumentBase
-
Sets the author in the document properties.
- setAuthorName(String) - Method in class com.pd4ml.PD4ML
-
Sets the author stored in the document properties (metadata) of the output.
- setCache(Object) - Method in class com.pd4ml.PD4ML
-
Makes this instance reuse the font and resource cache of an earlier conversion.
- setCookie(String, String) - Method in class com.pd4ml.PD4ML
-
Adds a cookie to every HTTP request PD4ML makes to load the document and its resources, for example to pass an authentication or session cookie.
- setCreator(String) - Method in class com.pd4ml.pdf.PdfDocumentBase
-
Sets the creator in the document properties.
- setDetails(String) - Method in class com.pd4ml.StatusMessage
-
Sets additional details about the problem.
- setDocumentTitle(String) - Method in class com.pd4ml.PD4ML
-
Sets the title stored in the document properties (metadata) of the output, overriding the
<title>of the HTML document. - setDynamicData(Map<String, String>) - Method in class com.pd4ml.PD4ML
-
Sets values for
$[key]placeholders in the document, so the HTML can be used as a template. - setElement(Element) - Method in class com.pd4ml.CustomTag
-
Called by PD4ML to pass the document element of this tag occurrence, for example to read its computed style.
- setHeight(int) - Method in class com.pd4ml.CustomTag
-
Sets the height the default
CustomTag.getHeight(int)reports. - setHtmlWidth(int) - Method in class com.pd4ml.PD4ML
-
Sets the width, in pixels, of the virtual browser window the document is laid out in.
- setHttpOptions(String, String) - Method in class com.pd4ml.PD4ML
-
Sets the proxy and the credentials for HTTP requests PD4ML makes to load the document and its resources.
- setInitialPageNumber(int) - Method in class com.pd4ml.PD4ML
-
Sets the number of the first page, for example when the output is going to be appended to another document.
- setInnerCode(String) - Method in class com.pd4ml.CustomTag
-
Replaces the source code of the tag occurrence.
- setKeywords(String) - Method in class com.pd4ml.pdf.PdfDocumentBase
-
Sets the keywords in the document properties.
- setLogLevel(int) - Method in class com.pd4ml.PD4ML
-
Sets which log and diagnostic messages are written to the console.
- setModDate() - Method in class com.pd4ml.pdf.PdfDocumentBase
-
Sets the modification date in the document properties to the current time.
- setPageBackground(String) - Method in class com.pd4ml.PD4ML
-
Sets HTML content to draw under the page content of every page, for example a letterhead or a page frame.
- setPageBackground(String, String) - Method in class com.pd4ml.PD4ML
-
Sets HTML content to draw under the page content of the selected pages.
- setPageFooter(String, int) - Method in class com.pd4ml.PD4ML
-
Sets an HTML page footer for all pages.
- setPageFooter(String, int, String) - Method in class com.pd4ml.PD4ML
-
Sets an HTML page footer for the selected pages.
- setPageHeader(String, int) - Method in class com.pd4ml.PD4ML
-
Sets an HTML page header for all pages.
- setPageHeader(String, int, String) - Method in class com.pd4ml.PD4ML
-
Sets an HTML page header for the selected pages.
- setPageMargins(PageMargins) - Method in class com.pd4ml.PD4ML
-
Sets the page margins for all pages.
- setPageMargins(PageMargins, String) - Method in class com.pd4ml.PD4ML
-
Sets the page margins for the selected pages.
- setPageSize(PageSize) - Method in class com.pd4ml.PD4ML
-
Sets the page size for all pages.
- setPageSize(PageSize, String) - Method in class com.pd4ml.PD4ML
-
Sets the page size for the selected pages.
- setParam(String, String) - Method in class com.pd4ml.PD4ML
-
Sets an advanced conversion parameter.
- setPermissions(String, int) - Method in class com.pd4ml.PD4ML
-
Encrypts the resulting PDF (128-bit RC4) and restricts what users may do with it.
- setRenderingHints(Map) - Method in class com.pd4ml.PD4ML
-
Sets the Java2D rendering hints used to draw pages in image output (
renderAsImages(...)), for example to enable antialiasing or to trade quality for speed. - setSessionID(String) - Method in class com.pd4ml.PD4ML
-
Sets the web application session ID to send with resource requests, so resources that require the user's session (stylesheets, images and so on) can be loaded.
- setSubject(String) - Method in class com.pd4ml.pdf.PdfDocumentBase
-
Sets the subject in the document properties.
- setTitle(String) - Method in class com.pd4ml.pdf.PdfDocumentBase
-
Sets the title in the document properties.
- setWatermark(String, float, float, float, float, float, boolean, boolean, String) - Method in class com.pd4ml.PD4ML
-
Adds a watermark: HTML content drawn over the page content of the selected pages.
- setWidth(int) - Method in class com.pd4ml.CustomTag
-
Sets the width the default
CustomTag.getWidth(int)reports. - StatusMessage - Class in com.pd4ml
-
A warning or error recorded during a conversion, for example that a font could not be embedded in PDF/A output, or that the license does not cover the requested output format.
- StatusMessage(int, int, String) - Constructor for class com.pd4ml.StatusMessage
-
Creates a message.
T
- TABLOID - Static variable in class com.pd4ml.PageSize
-
Tabloid: 792 x 1224 points (11 x 17 in).
- terminate() - Method in class com.pd4ml.PD4ML
-
Requests termination of a running conversion and clears the font cache.
- testTermination() - Method in class com.pd4ml.PD4ML
-
Checks whether
PD4ML.terminate()has been called, and aborts the conversion if so. - TIFF - Static variable in class com.pd4ml.Constants
-
Image format "tiff": one uncompressed TIFF image per page.
- TIFF_COMPRESSED - Static variable in class com.pd4ml.Constants
-
Image format "tiffcomp": one compressed (PackBits) TIFF image per page.
- TOC_GENERATED - Static variable in interface com.pd4ml.ProgressListener
-
The table of contents has been generated.
- top - Variable in class com.pd4ml.PageMargins
-
The top margin in points.
- toString() - Method in class com.pd4ml.PageMargins
- toString() - Method in class com.pd4ml.PageSize
- transformXML(String) - Method in class com.pd4ml.tools.Pd4Cmd
- TRANSLATE_FACTOR - Static variable in class com.pd4ml.Constants
-
The number of PDF points per millimeter: 2.835.
- translateToPt(float) - Static method in class com.pd4ml.PD4ML
-
Converts millimeters to points (1/72 inch) at
Constants.TRANSLATE_FACTORpoints per millimeter.
U
- underlay(PdfDocumentBase, int) - Method in class com.pd4ml.pdf.PdfDocumentBase
-
Draws the pages of another document under the pages of this one, for example a letterhead or a page background.
- underlay(PdfDocumentBase, String, String, int) - Method in class com.pd4ml.pdf.PdfDocumentBase
-
Draws selected pages of another document under selected pages of this one.
- useHttpRequest(Object, Object) - Method in class com.pd4ml.PD4ML
-
Passes the current servlet request and response to PD4ML, for conversions running inside a web application.
- useTTF(String) - Method in class com.pd4ml.PD4ML
-
Registers a directory of TrueType/OpenType fonts to use in the output.
- useTTF(String, boolean) - Method in class com.pd4ml.PD4ML
-
Registers a font directory like
PD4ML.useTTF(String), and optionally creates its pd4fonts.properties mapping file. - useTTF(String, String) - Method in class com.pd4ml.PD4ML
-
Registers only the fonts of a directory whose names match a filter.
- UTF8 - Static variable in class com.pd4ml.Constants
-
The UTF-8 encoding name.
V
- valueOf(String) - Static method in enum com.pd4ml.Dimensions.Units
-
Returns the enum constant of this type with the specified name.
- values() - Static method in enum com.pd4ml.Dimensions.Units
-
Returns an array containing the constants of this enum type, in the order they are declared.
W
- WARNING - Static variable in class com.pd4ml.StatusMessage
-
Message type: a problem PD4ML worked around, for example by ignoring a setting.
- width - Variable in class com.pd4ml.PageSize
-
The page width in points.
- WINDOWS_1252 - Static variable in class com.pd4ml.Constants
-
The Windows-1252 encoding name.
- write(OutputStream) - Method in class com.pd4ml.pdf.PdfDocumentBase
-
Writes the document with all changes, unencrypted, and closes the stream.
- write(OutputStream, String, int) - Method in class com.pd4ml.pdf.PdfDocumentBase
-
Writes the document with all changes and closes the stream, optionally encrypted (128-bit RC4).
- writeDOCX(OutputStream) - Method in class com.pd4ml.PD4ML
-
Lays out the document read by
readHTML(...)and writes it as a Microsoft Word (DOCX) document. - writePDF(OutputStream) - Method in class com.pd4ml.PD4ML
-
Lays out the document read by
readHTML(...)and writes it as a PDF 1.5 document. - writePDF(OutputStream, String) - Method in class com.pd4ml.PD4ML
-
Lays out the document and writes it as a regular PDF, a PDF/A or a PDF/UA document.
- writeRTF(OutputStream, boolean) - Method in class com.pd4ml.PD4ML
-
Lays out the document read by
readHTML(...)and writes it as an RTF document.
All Classes All Packages