FormVu 2021.11 API Documentation
A B C D E F G H I J N O P R S T V W 

A

addPageFailureMessage(String) - Method in interface org.jpedal.external.ErrorTracker
 

B

BACKGROUND - org.jpedal.render.output.io.ImageType
Used in image_* text modes.

C

cancelPage(String) - Method in interface org.jpedal.render.output.io.CustomIO
 
checkForExitRequest(int, int) - Method in interface org.jpedal.external.ErrorTracker
 
completeDocument() - Method in interface org.jpedal.render.output.io.CustomIO
 
ContentOptions - Class in org.jpedal.render.output
 
ContentOptions() - Constructor for class org.jpedal.render.output.ContentOptions
 
ContentOptions(String) - Constructor for class org.jpedal.render.output.ContentOptions
 
ContentOptions(Map<String, String>) - Constructor for class org.jpedal.render.output.ContentOptions
 
ConversionOptions - Class in org.jpedal.render.output
 
ConversionOptions() - Constructor for class org.jpedal.render.output.ConversionOptions
 
ConversionOptions.Font - Enum in org.jpedal.render.output
 
ConversionOptions.ScalingMode - Enum in org.jpedal.render.output
 
ConversionOptions.TextMode - Enum in org.jpedal.render.output
 
convert() - Method in class org.jpedal.examples.html.PDFtoHTML5Converter
 
createBase64ImageStream(BufferedImage, ImageFileType) - Method in interface org.jpedal.render.output.io.CustomIO
 
CustomIO - Interface in org.jpedal.render.output.io
abstract IO from HTML and SVG conversion

D

DEFAULT - org.jpedal.render.output.FormViewerOptions.OutputContentMode
 

E

ErrorTracker - Interface in org.jpedal.external
 

F

finishedPageDecoding(int) - Method in interface org.jpedal.external.ErrorTracker
 
FITHEIGHT - org.jpedal.render.output.ConversionOptions.ScalingMode
 
FITWIDTH - org.jpedal.render.output.ConversionOptions.ScalingMode
 
FITWIDTHHEIGHT - org.jpedal.render.output.ConversionOptions.ScalingMode
 
FORM - org.jpedal.render.output.io.ImageType
Used for rasterising PDF forms (non XFA).
FormViewerOptions - Class in org.jpedal.render.output
 
FormViewerOptions() - Constructor for class org.jpedal.render.output.FormViewerOptions
 
FormViewerOptions(Map<String, String>) - Constructor for class org.jpedal.render.output.FormViewerOptions
 
FormViewerOptions.OutputContentMode - Enum in org.jpedal.render.output
 

G

getAddJavaScript() - Method in class org.jpedal.render.output.html.HTMLConversionOptions
 
getApplyBranding() - Method in class org.jpedal.render.output.ConversionOptions
 
getBaseType() - Method in enum org.jpedal.render.output.ConversionOptions.Font
 
getBooleanValue(String, boolean) - Method in class org.jpedal.render.output.OutputModeOptions
 
getErrors() - Method in class org.jpedal.render.output.ConversionOptions
 
getErrors() - Method in class org.jpedal.render.output.OutputModeOptions
 
getFileExtension() - Method in enum org.jpedal.render.output.io.ImageFileType
 
getImageTypeUsed(ImageType) - Method in interface org.jpedal.render.output.io.CustomIO
 
getInlineJavaScriptAndCSS() - Method in class org.jpedal.render.output.FormViewerOptions
 
getLogicalPageRange() - Method in class org.jpedal.render.output.ConversionOptions
 
getMessage() - Method in exception org.jpedal.exception.PdfException
display the error message
getOmitNameDir() - Method in class org.jpedal.render.output.ConversionOptions
 
getPageFailureMessage() - Method in interface org.jpedal.external.ErrorTracker
 
getPassword() - Method in class org.jpedal.render.output.ConversionOptions
 
getRealPageRange() - Method in class org.jpedal.render.output.ConversionOptions
 
getStringValue(String) - Method in class org.jpedal.render.output.OutputModeOptions
 
getUseLegacyImageFileType() - Method in class org.jpedal.render.output.ConversionOptions
 

H

HTMLConversionOptions - Class in org.jpedal.render.output.html
 
HTMLConversionOptions() - Constructor for class org.jpedal.render.output.html.HTMLConversionOptions
 
HTMLConversionOptions(String) - Constructor for class org.jpedal.render.output.html.HTMLConversionOptions
 
HTMLConversionOptions(Map<String, String>) - Constructor for class org.jpedal.render.output.html.HTMLConversionOptions
 

I

IMAGE_REALTEXT - org.jpedal.render.output.ConversionOptions.TextMode
 
IMAGE_SHAPETEXT_NONSELECTABLE - org.jpedal.render.output.ConversionOptions.TextMode
 
IMAGE_SHAPETEXT_SELECTABLE - org.jpedal.render.output.ConversionOptions.TextMode
 
ImageFileType - Enum in org.jpedal.render.output.io
 
ImageType - Enum in org.jpedal.render.output.io
The ImageType specifies what the image is used for in conversion.
isBase64() - Method in enum org.jpedal.render.output.ConversionOptions.Font
 
ispageSuccessful() - Method in interface org.jpedal.external.ErrorTracker
 

J

JPG - org.jpedal.render.output.io.ImageFileType
 

N

NO_FDFXFADUMP - org.jpedal.render.output.FormViewerOptions.OutputContentMode
 
NO_MENU - org.jpedal.render.output.FormViewerOptions.OutputContentMode
 
notSet(String) - Method in class org.jpedal.render.output.ConversionOptions
Deprecated.
- kept for backwards code support (do not use)

O

org.jpedal.examples.html - package org.jpedal.examples.html
 
org.jpedal.exception - package org.jpedal.exception
 
org.jpedal.external - package org.jpedal.external
 
org.jpedal.render.output - package org.jpedal.render.output
 
org.jpedal.render.output.html - package org.jpedal.render.output.html
 
org.jpedal.render.output.io - package org.jpedal.render.output.io
 
OTF - org.jpedal.render.output.ConversionOptions.Font
 
OTF_BASE64 - org.jpedal.render.output.ConversionOptions.Font
 
OutputModeOptions - Class in org.jpedal.render.output
 
OutputModeOptions() - Constructor for class org.jpedal.render.output.OutputModeOptions
 

P

PdfException - Exception in org.jpedal.exception
a generic exception which code can throw if there is an error
PdfException() - Constructor for exception org.jpedal.exception.PdfException
 
PdfException(String) - Constructor for exception org.jpedal.exception.PdfException
set message at exception
PdfException(String, Throwable) - Constructor for exception org.jpedal.exception.PdfException
 
PDFtoHTML5Converter - Class in org.jpedal.examples.html
Clean API for converting PDF files to HTML5
PDFtoHTML5Converter(byte[], File, HTMLConversionOptions, OutputModeOptions) - Constructor for class org.jpedal.examples.html.PDFtoHTML5Converter
Constructs a new PDFtoHTML5Converter.
PDFtoHTML5Converter(File, File, HTMLConversionOptions, OutputModeOptions) - Constructor for class org.jpedal.examples.html.PDFtoHTML5Converter
Constructs a new PDFtoHTML5Converter.
PNG - org.jpedal.render.output.io.ImageFileType
 

R

REDUCED_CONTENT - org.jpedal.render.output.FormViewerOptions.OutputContentMode
 

S

SCALE - org.jpedal.render.output.ConversionOptions.ScalingMode
 
setAddJavaScript(boolean) - Method in class org.jpedal.render.output.html.HTMLConversionOptions
Include all the JavaScript that is within the PDF file.
setCompleteDocument(boolean) - Method in class org.jpedal.render.output.ContentOptions
Enabling this setting will output html, head and body tags.
setCompressImages(boolean) - Method in class org.jpedal.render.output.ConversionOptions
When enabled, generated PNG images will be compressed to reduce file size.
setCompressImages(boolean) - Method in class org.jpedal.render.output.html.HTMLConversionOptions
When enabled, generated PNG images will be compressed to reduce file size.
setCompressImages(boolean) - Method in interface org.jpedal.render.output.io.CustomIO
 
setCompressSVG(boolean) - Method in class org.jpedal.render.output.ConversionOptions
Generates compressed .svgz files rather than .svg (you will need to configure your web server to correctly serve these).
setCompressSVG(boolean) - Method in class org.jpedal.render.output.html.HTMLConversionOptions
Generates compressed .svgz files rather than .svg (you will need to configure your web server to correctly serve these).
setContainerId(String) - Method in class org.jpedal.render.output.ContentOptions
Set the id to use for the page container div.
setConvertPDFExternalFileToOutputType(boolean) - Method in class org.jpedal.render.output.ConversionOptions
Set whether to convert links pointing to file.pdf into file.html inside GoToR and Launch link annotations.
setConvertPDFExternalFileToOutputType(boolean) - Method in class org.jpedal.render.output.html.HTMLConversionOptions
Set whether to convert links pointing to file.pdf into file.html inside GoToR and Launch link annotations.
setConvertSpacesToNbsp(boolean) - Method in class org.jpedal.render.output.ConversionOptions
Convert spaces into Non-breaking Spaces (&nbsp;) in the output.
setConvertSpacesToNbsp(boolean) - Method in class org.jpedal.render.output.html.HTMLConversionOptions
Convert spaces into Non-breaking Spaces (&nbsp;) in the output.
setCustomErrorTracker(ErrorTracker) - Method in class org.jpedal.examples.html.PDFtoHTML5Converter
Sets a custom ErrorTracker to use during conversion allowing you to track errors and provide a timeout.
setCustomIO(CustomIO) - Method in class org.jpedal.examples.html.PDFtoHTML5Converter
Sets a CustomIO to use during conversion, allowing you to control the output.
setDisableComments(boolean) - Method in class org.jpedal.render.output.html.HTMLConversionOptions
Disable comments inserted into the HTML output for clarity.
setEmbedImagesAsBase64Stream(boolean) - Method in class org.jpedal.render.output.ConversionOptions
Embed images as Base64 stream.
setEmbedImagesAsBase64Stream(boolean) - Method in class org.jpedal.render.output.html.HTMLConversionOptions
Embed images as Base64 stream.
setEnableFDFJavaScript(boolean) - Method in class org.jpedal.render.output.FormViewerOptions
Enable JavaScript from the FDF PDF to be included in the conversion output.
setEncryptTempFiles() - Method in class org.jpedal.examples.html.PDFtoHTML5Converter
Enables encryption of all temporary files that may be created during the conversion process.
setFirstPageName(String) - Method in class org.jpedal.render.output.ContentOptions
Deprecated.
We do not recommend that this option be used.
setFontsToRasterizeInTextMode(String) - Method in class org.jpedal.render.output.ConversionOptions
In Text Modes, you can override real text on a font by font basis,
setFontsToRasterizeInTextMode(String) - Method in class org.jpedal.render.output.html.HTMLConversionOptions
In Text Modes, you can override real text on a font by font basis,
setFormTag(String) - Method in class org.jpedal.render.output.ConversionOptions
Replacing <form> with your version.
setFormTag(String) - Method in class org.jpedal.render.output.html.HTMLConversionOptions
Replacing <form> with your version.
setGenerateSearchFile(boolean) - Method in class org.jpedal.render.output.ContentOptions
Generates search.json.
setImageScale(float) - Method in class org.jpedal.render.output.ConversionOptions
Write out larger images to allow higher quality zooming.
setImageScale(float) - Method in class org.jpedal.render.output.html.HTMLConversionOptions
Write out larger images to allow higher quality zooming.
setIncludedFonts(ConversionOptions.Font[]) - Method in class org.jpedal.render.output.ConversionOptions
Set fonts to convert to and include in HTML and CSS output.
setIncludedFonts(ConversionOptions.Font[]) - Method in class org.jpedal.render.output.html.HTMLConversionOptions
Set fonts to convert to and include in HTML and CSS output.
setInlineJavaScriptAndCSS(boolean) - Method in class org.jpedal.render.output.FormViewerOptions
Inline JavaScript and CSS within HTML.
setInlineSVG(boolean) - Method in class org.jpedal.render.output.html.HTMLConversionOptions
Inline SVG within HTML (pure svg text modes only).
setKeepGlyfsSeparate(boolean) - Method in class org.jpedal.render.output.ConversionOptions
Position each glyph individually for more accurate positioning.
setKeepGlyfsSeparate(boolean) - Method in class org.jpedal.render.output.html.HTMLConversionOptions
Position each glyph individually for more accurate positioning.
setLogicalPageRange(PageRanges) - Method in class org.jpedal.render.output.ConversionOptions
Set a page range using logical page numbering.
setLogicalPageRange(PageRanges) - Method in class org.jpedal.render.output.html.HTMLConversionOptions
Set a page range using logical page numbering.
setMinFontSize(int) - Method in class org.jpedal.render.output.html.HTMLConversionOptions
Sets the minimum font size to be used.
setNoCheckboxOrRadioButtonImages(boolean) - Method in class org.jpedal.render.output.FormViewerOptions
Do not use the on/off images from the converted PDF for checkboxes/radio buttons.
setOmitNameDir(boolean) - Method in class org.jpedal.render.output.ConversionOptions
Controls the folder structure of the output.
setOmitNameDir(boolean) - Method in class org.jpedal.render.output.html.HTMLConversionOptions
Controls the folder structure of the output.
setOutputContentMode(FormViewerOptions.OutputContentMode) - Method in class org.jpedal.render.output.FormViewerOptions
The output content mode affects what content is included in the generated output.
setOutputThumbnails(boolean) - Method in class org.jpedal.render.output.ContentOptions
Output thumbnails of pages in /thumbnails/.
setOutputThumbnails(boolean) - Method in class org.jpedal.render.output.OutputModeOptions
Output thumbnails of pages in /thumbnails/.
setOverlay(boolean) - Method in class org.jpedal.render.output.html.HTMLConversionOptions
Deprecated.
we do not recommend that this option be used.
setPassword(String) - Method in class org.jpedal.examples.html.PDFtoHTML5Converter
Handle PDF if encrypted (may need password which must be passed in)
setPreserveExtractionValues(boolean) - Method in class org.jpedal.render.output.ConversionOptions
Deprecated.
Not recommended for general usage - added for specific customer use case scenario
setRealPageRange(PageRanges) - Method in class org.jpedal.render.output.ConversionOptions
Set a page range using real page numbering.
setRealPageRange(PageRanges) - Method in class org.jpedal.render.output.html.HTMLConversionOptions
Set a page range using real page numbering.
setScaling(float) - Method in class org.jpedal.render.output.ConversionOptions
Sets the Scaling value of the converted content.
setScaling(float) - Method in class org.jpedal.render.output.html.HTMLConversionOptions
Sets the Scaling value of the converted content.
setScalingFitHeight(int) - Method in class org.jpedal.render.output.ConversionOptions
 
setScalingFitHeight(int) - Method in class org.jpedal.render.output.html.HTMLConversionOptions
setScalingFitWidth(int) - Method in class org.jpedal.render.output.ConversionOptions
 
setScalingFitWidth(int) - Method in class org.jpedal.render.output.html.HTMLConversionOptions
setScalingFitWidthHeight(int, int) - Method in class org.jpedal.render.output.ConversionOptions
 
setScalingFitWidthHeight(int, int) - Method in class org.jpedal.render.output.html.HTMLConversionOptions
setSeparateToWords(boolean) - Method in class org.jpedal.render.output.ConversionOptions
Divide text chunks into words based on spaces This improves accuracy but not as much as keepGlyfsSeparate, It produces a larger file but may suit some use cases.
setSeparateToWords(boolean) - Method in class org.jpedal.render.output.html.HTMLConversionOptions
Divide text chunks into words based on spaces This improves accuracy but not as much as keepGlyfsSeparate, It produces a larger file but may suit some use cases.
setSubmitUrl(String) - Method in class org.jpedal.render.output.FormViewerOptions
Set the default pdf form submission URL
setTextMode(ConversionOptions.TextMode) - Method in class org.jpedal.render.output.html.HTMLConversionOptions
The text mode controls how text is rendered in the html output, for example your text can be made selectable or as an image and made non selectable.
setUseFormVuAPI(boolean) - Method in class org.jpedal.render.output.FormViewerOptions
Output the formvuapi.js file, which handles custom functionality such as submitting forms as JSON.
setUseLegacyImageFileType(boolean) - Method in class org.jpedal.render.output.ConversionOptions
If enabled, all images output will use the PNG file type.
setUseLegacyImageFileType(boolean) - Method in class org.jpedal.render.output.html.HTMLConversionOptions
If enabled, all images output will use the PNG file type.
SHADE - org.jpedal.render.output.io.ImageType
Used in svg_* text modes.
startedPageDecoding(int) - Method in interface org.jpedal.external.ErrorTracker
 
SVG_ALPHA_NOT_REQUIRED - org.jpedal.render.output.io.ImageType
Used in svg_* text modes.
SVG_ALPHA_REQUIRED - org.jpedal.render.output.io.ImageType
Used in svg_* text modes.
SVG_REALTEXT - org.jpedal.render.output.ConversionOptions.TextMode
 
SVG_SHAPETEXT_NONSELECTABLE - org.jpedal.render.output.ConversionOptions.TextMode
 
SVG_SHAPETEXT_SELECTABLE - org.jpedal.render.output.ConversionOptions.TextMode
 

T

THUMBNAIL - org.jpedal.render.output.io.ImageType
Used in the IDRViewer, or if thumbnails are enabled in the options.

V

valueOf(String) - Static method in enum org.jpedal.render.output.ConversionOptions.Font
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.jpedal.render.output.ConversionOptions.ScalingMode
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.jpedal.render.output.ConversionOptions.TextMode
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.jpedal.render.output.FormViewerOptions.OutputContentMode
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.jpedal.render.output.io.ImageFileType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.jpedal.render.output.io.ImageType
Returns the enum constant of this type with the specified name.
values() - Static method in enum org.jpedal.render.output.ConversionOptions.Font
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.jpedal.render.output.ConversionOptions.ScalingMode
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.jpedal.render.output.ConversionOptions.TextMode
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.jpedal.render.output.FormViewerOptions.OutputContentMode
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.jpedal.render.output.io.ImageFileType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.jpedal.render.output.io.ImageType
Returns an array containing the constants of this enum type, in the order they are declared.

W

WOFF - org.jpedal.render.output.ConversionOptions.Font
 
WOFF_BASE64 - org.jpedal.render.output.ConversionOptions.Font
 
writeFileFromStream(String, String, InputStream) - Method in interface org.jpedal.render.output.io.CustomIO
 
writeFont(String, String, byte[]) - Method in interface org.jpedal.render.output.io.CustomIO
 
writeGZIPCompressedFile(String, String, StringBuilder) - Method in interface org.jpedal.render.output.io.CustomIO
 
writeImage(String, String, BufferedImage, ImageType) - Method in interface org.jpedal.render.output.io.CustomIO
 
writePlainTextAppendedFile(String, String, StringBuilder, boolean) - Method in interface org.jpedal.render.output.io.CustomIO
 
writePlainTextFile(String, String, StringBuilder) - Method in interface org.jpedal.render.output.io.CustomIO
 
A B C D E F G H I J N O P R S T V W 
Skip navigation links
FormVu 2021.11 API Documentation

Copyright 2021 IDRsolutions ltd. All rights reserved.