Index (BuildVu 2025.06 API Documentation)

A B C D E F G H I J N O P S T V W
All Classes and Interfaces|All Packages|Serialized Form|System Properties

A

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

B

BACKGROUND - Enum constant in enum class 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
Clean - Enum constant in enum class org.jpedal.render.output.IDRViewerOptions.ViewerUI
Complete - Enum constant in enum class org.jpedal.render.output.IDRViewerOptions.ViewerUI
completeDocument() - Method in interface org.jpedal.render.output.io.CustomIO
ContentOptions - Class in org.jpedal.render.output: The class to use for setting output options when using content mode.
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: The parent abstract class for HTMLConversionOptions and SVGConversionOptions.
ConversionOptions() - Constructor for class org.jpedal.render.output.ConversionOptions
ConversionOptions.Font - Enum Class in org.jpedal.render.output: Enum for setting which font types to use (WOFF, OTF, WOFF_BASE64, OTF_BASE64).
ConversionOptions.ScalingMode - Enum Class in org.jpedal.render.output: Enum for setting the scaling mode (SCALE, FITWIDTH, FITHEIGHT, FITWIDTHHEIGHT).
ConversionOptions.TextMode - Enum Class in org.jpedal.render.output: Enum for setting the text mode (SVG_REALTEXT, IMAGE_REALTEXT, etc).
Conversion With Forms Viewer (FormVu Only) - Search tag in class org.jpedal.examples.html.PDFtoHTML5Converter: Section
Conversion with IDRViewer - Search tag in class org.jpedal.examples.svg.PDFtoSVGConverter: Section
Conversion with IDRViewer (BuildVu Only) - Search tag in class org.jpedal.examples.html.PDFtoHTML5Converter: Section
Conversion With No Viewer - Search tag in class org.jpedal.examples.svg.PDFtoSVGConverter: Section
Conversion With No Viewer (BuildVu Only) - Search tag in class org.jpedal.examples.html.PDFtoHTML5Converter: Section
convert() - Method in class org.jpedal.examples.html.PDFtoHTML5Converter: Start converting the PDF file.
convert() - Method in class org.jpedal.examples.svg.PDFtoSVGConverter: Start converting the PDF file.
convert(File, String) - Static method in class org.jpedal.examples.DocumentToPDFConverter: Uses LibreOffice to convert an office document to PDF using the provided LibreOffice executable path.
convert(File, String, boolean) - Static method in class org.jpedal.examples.DocumentToPDFConverter: Uses LibreOffice to convert an office document to PDF using the provided LibreOffice executable path.
createBase64ImageStream(BufferedImage, ImageFileType) - Method in interface org.jpedal.render.output.io.CustomIO
Custom - Enum constant in enum class org.jpedal.render.output.IDRViewerOptions.ViewerUI
CustomIO - Interface in org.jpedal.render.output.io: Interface used in PDFtoHTML5Converter and PDF2SVGConverter for controlling the file output to disk.

D

DocumentToPDFConverter - Class in org.jpedal.examples: Helper class for converting Office documents to PDF using LibreOffice.

E

ErrorTracker - Interface in org.jpedal.external: The ErrorTracker interface allows monitoring of page decode progress and can be used to end a page decode early.
Examples - Search tag in class org.jpedal.examples.html.PDFtoHTML5Converter: Section
Examples - Search tag in class org.jpedal.examples.html.PDFtoHTML5Converter: Section
Examples - Search tag in class org.jpedal.examples.svg.PDFtoSVGConverter: Section

F

finishedPageDecoding(int) - Method in interface org.jpedal.external.ErrorTracker
FITHEIGHT - Enum constant in enum class org.jpedal.render.output.ConversionOptions.ScalingMode
FITWIDTH - Enum constant in enum class org.jpedal.render.output.ConversionOptions.ScalingMode
FITWIDTHHEIGHT - Enum constant in enum class org.jpedal.render.output.ConversionOptions.ScalingMode
FORM - Enum constant in enum class org.jpedal.render.output.io.ImageType: Used for rasterising PDF forms (non XFA).

G

getAddJavaScript() - Method in class org.jpedal.render.output.html.HTMLConversionOptions
getApplyBranding() - Method in class org.jpedal.render.output.ConversionOptions
getBaseType() - Method in enum class org.jpedal.render.output.ConversionOptions.Font
getBooleanValue(String, boolean) - Method in class org.jpedal.render.output.OutputModeOptions
getConvertPDFExternalFileToOutputType() - Method in class org.jpedal.render.output.ConversionOptions
getErrors() - Method in class org.jpedal.render.output.ConversionOptions
getErrors() - Method in class org.jpedal.render.output.OutputModeOptions
getFileExtension() - Method in enum class org.jpedal.render.output.io.ImageFileType
getFormTag() - Method in class org.jpedal.render.output.ConversionOptions
getImageTypeUsed(ImageType) - Method in interface org.jpedal.render.output.io.CustomIO
getLogicalPageRange() - Method in class org.jpedal.render.output.ConversionOptions
getMessage() - Method in exception class org.jpedal.exception.PdfException: display the error message
getMimeType() - Method in enum class org.jpedal.render.output.io.ImageFileType
getOmitNameDir() - Method in class org.jpedal.render.output.ConversionOptions
getOriginalFileName() - 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

hasConvertibleFileType(File) - Static method in class org.jpedal.examples.DocumentToPDFConverter: Returns whether the provided file has a convertible file type
HTMLConversionOptions - Class in org.jpedal.render.output.html: The class to use for setting conversion options when converting to 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

IDRViewerOptions - Class in org.jpedal.render.output: The class to use for setting output options when using the IDRViewer.
IDRViewerOptions() - Constructor for class org.jpedal.render.output.IDRViewerOptions
IDRViewerOptions(String) - Constructor for class org.jpedal.render.output.IDRViewerOptions
IDRViewerOptions(Map<String, String>) - Constructor for class org.jpedal.render.output.IDRViewerOptions
IDRViewerOptions.ViewerUI - Enum Class in org.jpedal.render.output: Enum for setting which viewer user interface to use (Complete, Clean, Simple, SlideShow, Custom).
IMAGE_REALTEXT - Enum constant in enum class org.jpedal.render.output.ConversionOptions.TextMode
IMAGE_SHAPETEXT_NONSELECTABLE - Enum constant in enum class org.jpedal.render.output.ConversionOptions.TextMode
IMAGE_SHAPETEXT_SELECTABLE - Enum constant in enum class org.jpedal.render.output.ConversionOptions.TextMode
ImageFileType - Enum Class in org.jpedal.render.output.io: Enum used within the CustomIO API for overriding the file type of image content.
ImageType - Enum Class in org.jpedal.render.output.io: Enum used within the CustomIO API for overriding the file type of image content.
isBase64() - Method in enum class org.jpedal.render.output.ConversionOptions.Font
ispageSuccessful() - Method in interface org.jpedal.external.ErrorTracker

J

JPG - Enum constant in enum class org.jpedal.render.output.io.ImageFileType

N

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

O

org.jpedal.examples - package org.jpedal.examples
org.jpedal.examples.html - package org.jpedal.examples.html
org.jpedal.examples.svg - package org.jpedal.examples.svg
org.jpedal.exception - package org.jpedal.exception
org.jpedal.external - package org.jpedal.external
org.jpedal.pdf2html.addBorder - Search tag in org.jpedal.render.output.svg.SVGConversionOptions.setAddBorder(boolean): System Property
org.jpedal.pdf2html.addJavaScript - Search tag in org.jpedal.render.output.html.HTMLConversionOptions.setAddJavaScript(boolean): System Property
org.jpedal.pdf2html.clipOffsetAmount - Search tag in org.jpedal.render.output.ConversionOptions.setClipOffsetAmount(float): System Property
org.jpedal.pdf2html.clipOffsetAmount - Search tag in org.jpedal.render.output.ConversionOptions.setClipOffsetAmount(float): System Property
org.jpedal.pdf2html.clipOffsetAmount - Search tag in org.jpedal.render.output.ConversionOptions.setClipOffsetAmount(float): System Property
org.jpedal.pdf2html.completeDocument - Search tag in org.jpedal.render.output.ContentOptions.setCompleteDocument(boolean): System Property
org.jpedal.pdf2html.compressImages - Search tag in org.jpedal.render.output.ConversionOptions.setCompressImages(boolean): System Property
org.jpedal.pdf2html.compressImages - Search tag in org.jpedal.render.output.ConversionOptions.setCompressImages(boolean): System Property
org.jpedal.pdf2html.compressImages - Search tag in org.jpedal.render.output.ConversionOptions.setCompressImages(boolean): System Property
org.jpedal.pdf2html.compressSVG - Search tag in org.jpedal.render.output.ConversionOptions.setCompressSVG(boolean): System Property
org.jpedal.pdf2html.compressSVG - Search tag in org.jpedal.render.output.ConversionOptions.setCompressSVG(boolean): System Property
org.jpedal.pdf2html.compressSVG - Search tag in org.jpedal.render.output.ConversionOptions.setCompressSVG(boolean): System Property
org.jpedal.pdf2html.containerId - Search tag in org.jpedal.render.output.ContentOptions.setContainerId(String): System Property
org.jpedal.pdf2html.convertPDFExternalFileToOutputType - Search tag in org.jpedal.render.output.ConversionOptions.setConvertPDFExternalFileToOutputType(boolean): System Property
org.jpedal.pdf2html.convertPDFExternalFileToOutputType - Search tag in org.jpedal.render.output.ConversionOptions.setConvertPDFExternalFileToOutputType(boolean): System Property
org.jpedal.pdf2html.convertPDFExternalFileToOutputType - Search tag in org.jpedal.render.output.ConversionOptions.setConvertPDFExternalFileToOutputType(boolean): System Property
org.jpedal.pdf2html.convertSpacesToNbsp - Search tag in org.jpedal.render.output.ConversionOptions.setConvertSpacesToNbsp(boolean): System Property
org.jpedal.pdf2html.convertSpacesToNbsp - Search tag in org.jpedal.render.output.ConversionOptions.setConvertSpacesToNbsp(boolean): System Property
org.jpedal.pdf2html.convertSpacesToNbsp - Search tag in org.jpedal.render.output.ConversionOptions.setConvertSpacesToNbsp(boolean): System Property
org.jpedal.pdf2html.cssSuffix - Search tag in org.jpedal.render.output.ContentOptions.setCssSuffix(String): System Property
org.jpedal.pdf2html.disableComments - Search tag in org.jpedal.render.output.html.HTMLConversionOptions.setDisableComments(boolean): System Property
org.jpedal.pdf2html.disableExternalHyperlinks - Search tag in org.jpedal.render.output.ConversionOptions.setDisableExternalHyperlinks(boolean): System Property
org.jpedal.pdf2html.disableExternalHyperlinks - Search tag in org.jpedal.render.output.ConversionOptions.setDisableExternalHyperlinks(boolean): System Property
org.jpedal.pdf2html.disableExternalHyperlinks - Search tag in org.jpedal.render.output.ConversionOptions.setDisableExternalHyperlinks(boolean): System Property
org.jpedal.pdf2html.disableHyperlinkDetection - Search tag in org.jpedal.render.output.ConversionOptions.setDisableHyperlinkDetection(boolean): System Property
org.jpedal.pdf2html.disableHyperlinkDetection - Search tag in org.jpedal.render.output.ConversionOptions.setDisableHyperlinkDetection(boolean): System Property
org.jpedal.pdf2html.disableHyperlinkDetection - Search tag in org.jpedal.render.output.ConversionOptions.setDisableHyperlinkDetection(boolean): System Property
org.jpedal.pdf2html.embedImagesAsBase64Stream - Search tag in org.jpedal.render.output.ConversionOptions.setEmbedImagesAsBase64Stream(boolean): System Property
org.jpedal.pdf2html.embedImagesAsBase64Stream - Search tag in org.jpedal.render.output.ConversionOptions.setEmbedImagesAsBase64Stream(boolean): System Property
org.jpedal.pdf2html.embedImagesAsBase64Stream - Search tag in org.jpedal.render.output.ConversionOptions.setEmbedImagesAsBase64Stream(boolean): System Property
org.jpedal.pdf2html.embedSvgAsBase64Image - Search tag in org.jpedal.render.output.html.HTMLConversionOptions.setEmbedSvgAsBase64Image(boolean): System Property
org.jpedal.pdf2html.enableLaunchActions - Search tag in org.jpedal.render.output.IDRViewerOptions.setEnableLaunchActions(boolean): System Property
org.jpedal.pdf2html.firstPageName - Search tag in org.jpedal.render.output.ContentOptions.setFirstPageName(String): System Property
org.jpedal.pdf2html.fontsToRasterizeInTextMode - Search tag in org.jpedal.render.output.ConversionOptions.setFontsToRasterizeInTextMode(String): System Property
org.jpedal.pdf2html.fontsToRasterizeInTextMode - Search tag in org.jpedal.render.output.ConversionOptions.setFontsToRasterizeInTextMode(String): System Property
org.jpedal.pdf2html.fontsToRasterizeInTextMode - Search tag in org.jpedal.render.output.ConversionOptions.setFontsToRasterizeInTextMode(String): System Property
org.jpedal.pdf2html.formTag - Search tag in org.jpedal.render.output.ConversionOptions.setFormTag(String): System Property
org.jpedal.pdf2html.formTag - Search tag in org.jpedal.render.output.ConversionOptions.setFormTag(String): System Property
org.jpedal.pdf2html.formTag - Search tag in org.jpedal.render.output.ConversionOptions.setFormTag(String): System Property
org.jpedal.pdf2html.generateSearchFile - Search tag in org.jpedal.render.output.OutputModeOptions.setGenerateSearchFile(boolean): System Property
org.jpedal.pdf2html.generateSearchFile - Search tag in org.jpedal.render.output.OutputModeOptions.setGenerateSearchFile(boolean): System Property
org.jpedal.pdf2html.generateSearchFile - Search tag in org.jpedal.render.output.OutputModeOptions.setGenerateSearchFile(boolean): System Property
org.jpedal.pdf2html.imageScale - Search tag in org.jpedal.render.output.ConversionOptions.setImageScale(float): System Property
org.jpedal.pdf2html.imageScale - Search tag in org.jpedal.render.output.ConversionOptions.setImageScale(float): System Property
org.jpedal.pdf2html.imageScale - Search tag in org.jpedal.render.output.ConversionOptions.setImageScale(float): System Property
org.jpedal.pdf2html.includedFonts - Search tag in org.jpedal.render.output.ConversionOptions.setIncludedFonts(ConversionOptions.Font[]): System Property
org.jpedal.pdf2html.includedFonts - Search tag in org.jpedal.render.output.ConversionOptions.setIncludedFonts(ConversionOptions.Font[]): System Property
org.jpedal.pdf2html.includedFonts - Search tag in org.jpedal.render.output.ConversionOptions.setIncludedFonts(ConversionOptions.Font[]): System Property
org.jpedal.pdf2html.inlineSVG - Search tag in org.jpedal.render.output.html.HTMLConversionOptions.setInlineSVG(boolean): System Property
org.jpedal.pdf2html.keepGlyfsSeparate - Search tag in org.jpedal.render.output.ConversionOptions.setKeepGlyfsSeparate(boolean): System Property
org.jpedal.pdf2html.keepGlyfsSeparate - Search tag in org.jpedal.render.output.ConversionOptions.setKeepGlyfsSeparate(boolean): System Property
org.jpedal.pdf2html.keepGlyfsSeparate - Search tag in org.jpedal.render.output.ConversionOptions.setKeepGlyfsSeparate(boolean): System Property
org.jpedal.pdf2html.logicalPageRange - Search tag in org.jpedal.render.output.ConversionOptions.setLogicalPageRange(PageRanges): System Property
org.jpedal.pdf2html.logicalPageRange - Search tag in org.jpedal.render.output.ConversionOptions.setLogicalPageRange(PageRanges): System Property
org.jpedal.pdf2html.logicalPageRange - Search tag in org.jpedal.render.output.ConversionOptions.setLogicalPageRange(PageRanges): System Property
org.jpedal.pdf2html.maxPageHeight - Search tag in org.jpedal.render.output.ConversionOptions.setMaxPageHeight(int): System Property
org.jpedal.pdf2html.maxPageHeight - Search tag in org.jpedal.render.output.ConversionOptions.setMaxPageHeight(int): System Property
org.jpedal.pdf2html.maxPageHeight - Search tag in org.jpedal.render.output.ConversionOptions.setMaxPageHeight(int): System Property
org.jpedal.pdf2html.maxPageWidth - Search tag in org.jpedal.render.output.ConversionOptions.setMaxPageWidth(int): System Property
org.jpedal.pdf2html.maxPageWidth - Search tag in org.jpedal.render.output.ConversionOptions.setMaxPageWidth(int): System Property
org.jpedal.pdf2html.maxPageWidth - Search tag in org.jpedal.render.output.ConversionOptions.setMaxPageWidth(int): System Property
org.jpedal.pdf2html.minFontSize - Search tag in org.jpedal.render.output.html.HTMLConversionOptions.setMinFontSize(int): System Property
org.jpedal.pdf2html.omitNameDir - Search tag in org.jpedal.render.output.ConversionOptions.setOmitNameDir(boolean): System Property
org.jpedal.pdf2html.omitNameDir - Search tag in org.jpedal.render.output.ConversionOptions.setOmitNameDir(boolean): System Property
org.jpedal.pdf2html.omitNameDir - Search tag in org.jpedal.render.output.ConversionOptions.setOmitNameDir(boolean): System Property
org.jpedal.pdf2html.originalFileName - Search tag in org.jpedal.render.output.ConversionOptions.setOriginalFileName(String): System Property
org.jpedal.pdf2html.originalFileName - Search tag in org.jpedal.render.output.ConversionOptions.setOriginalFileName(String): System Property
org.jpedal.pdf2html.originalFileName - Search tag in org.jpedal.render.output.ConversionOptions.setOriginalFileName(String): System Property
org.jpedal.pdf2html.outputThumbnails - Search tag in org.jpedal.render.output.OutputModeOptions.setOutputThumbnails(boolean): System Property
org.jpedal.pdf2html.outputThumbnails - Search tag in org.jpedal.render.output.OutputModeOptions.setOutputThumbnails(boolean): System Property
org.jpedal.pdf2html.outputThumbnails - Search tag in org.jpedal.render.output.OutputModeOptions.setOutputThumbnails(boolean): System Property
org.jpedal.pdf2html.overlay - Search tag in org.jpedal.render.output.html.HTMLConversionOptions.setOverlay(boolean): System Property
org.jpedal.pdf2html.pageFlatteningImageThreshold - Search tag in org.jpedal.render.output.ConversionOptions.setPageFlatteningImageThreshold(int): System Property
org.jpedal.pdf2html.pageFlatteningImageThreshold - Search tag in org.jpedal.render.output.ConversionOptions.setPageFlatteningImageThreshold(int): System Property
org.jpedal.pdf2html.pageFlatteningImageThreshold - Search tag in org.jpedal.render.output.ConversionOptions.setPageFlatteningImageThreshold(int): System Property
org.jpedal.pdf2html.pixelsPerInch - Search tag in org.jpedal.render.output.ConversionOptions.setPixelsPerInch(int): System Property
org.jpedal.pdf2html.pixelsPerInch - Search tag in org.jpedal.render.output.ConversionOptions.setPixelsPerInch(int): System Property
org.jpedal.pdf2html.pixelsPerInch - Search tag in org.jpedal.render.output.ConversionOptions.setPixelsPerInch(int): System Property
org.jpedal.pdf2html.preserveExtractionValues - Search tag in org.jpedal.render.output.ConversionOptions.setPreserveExtractionValues(boolean): System Property
org.jpedal.pdf2html.realPageRange - Search tag in org.jpedal.render.output.ConversionOptions.setRealPageRange(PageRanges): System Property
org.jpedal.pdf2html.realPageRange - Search tag in org.jpedal.render.output.ConversionOptions.setRealPageRange(PageRanges): System Property
org.jpedal.pdf2html.realPageRange - Search tag in org.jpedal.render.output.ConversionOptions.setRealPageRange(PageRanges): System Property
org.jpedal.pdf2html.scaling - Search tag in org.jpedal.render.output.ConversionOptions.setScaling(float): System Property
org.jpedal.pdf2html.scaling - Search tag in org.jpedal.render.output.ConversionOptions.setScaling(float): System Property
org.jpedal.pdf2html.scaling - Search tag in org.jpedal.render.output.ConversionOptions.setScaling(float): System Property
org.jpedal.pdf2html.separateTextToWords - Search tag in org.jpedal.render.output.ConversionOptions.setSeparateToWords(boolean): System Property
org.jpedal.pdf2html.separateTextToWords - Search tag in org.jpedal.render.output.ConversionOptions.setSeparateToWords(boolean): System Property
org.jpedal.pdf2html.separateTextToWords - Search tag in org.jpedal.render.output.ConversionOptions.setSeparateToWords(boolean): System Property
org.jpedal.pdf2html.textMode - Search tag in org.jpedal.render.output.html.HTMLConversionOptions.setTextMode(ConversionOptions.TextMode): System Property
org.jpedal.pdf2html.textMode - Search tag in org.jpedal.render.output.svg.SVGConversionOptions.setTextMode(ConversionOptions.TextMode): System Property
org.jpedal.pdf2html.thumbnailMaxHeight - Search tag in org.jpedal.render.output.OutputModeOptions.setThumbnailMaxHeight(int): System Property
org.jpedal.pdf2html.thumbnailMaxHeight - Search tag in org.jpedal.render.output.OutputModeOptions.setThumbnailMaxHeight(int): System Property
org.jpedal.pdf2html.thumbnailMaxHeight - Search tag in org.jpedal.render.output.OutputModeOptions.setThumbnailMaxHeight(int): System Property
org.jpedal.pdf2html.thumbnailMaxWidth - Search tag in org.jpedal.render.output.OutputModeOptions.setThumbnailMaxWidth(int): System Property
org.jpedal.pdf2html.thumbnailMaxWidth - Search tag in org.jpedal.render.output.OutputModeOptions.setThumbnailMaxWidth(int): System Property
org.jpedal.pdf2html.thumbnailMaxWidth - Search tag in org.jpedal.render.output.OutputModeOptions.setThumbnailMaxWidth(int): System Property
org.jpedal.pdf2html.tinyTextRemovalThreshold - Search tag in org.jpedal.render.output.ConversionOptions.setTinyTextRemovalThreshold(float): System Property
org.jpedal.pdf2html.tinyTextRemovalThreshold - Search tag in org.jpedal.render.output.ConversionOptions.setTinyTextRemovalThreshold(float): System Property
org.jpedal.pdf2html.tinyTextRemovalThreshold - Search tag in org.jpedal.render.output.ConversionOptions.setTinyTextRemovalThreshold(float): System Property
org.jpedal.pdf2html.useLegacyImageFileType - Search tag in org.jpedal.render.output.ConversionOptions.setUseLegacyImageFileType(boolean): System Property
org.jpedal.pdf2html.useLegacyImageFileType - Search tag in org.jpedal.render.output.ConversionOptions.setUseLegacyImageFileType(boolean): System Property
org.jpedal.pdf2html.useLegacyImageFileType - Search tag in org.jpedal.render.output.ConversionOptions.setUseLegacyImageFileType(boolean): System Property
org.jpedal.pdf2html.viewerUI - Search tag in org.jpedal.render.output.IDRViewerOptions.setViewerUI(IDRViewerOptions.ViewerUI): System Property
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
org.jpedal.render.output.svg - package org.jpedal.render.output.svg
OTF - Enum constant in enum class org.jpedal.render.output.ConversionOptions.Font
OTF_BASE64 - Enum constant in enum class org.jpedal.render.output.ConversionOptions.Font
OutputModeOptions - Class in org.jpedal.render.output: The parent abstract class for IDRViewerOptions and ContentOptions.
OutputModeOptions() - Constructor for class org.jpedal.render.output.OutputModeOptions

P

PdfException - Exception Class in org.jpedal.exception: A generic PDF exception type which will be thrown if there is an error.
PdfException() - Constructor for exception class org.jpedal.exception.PdfException
PdfException(String) - Constructor for exception class org.jpedal.exception.PdfException: set message at exception
PdfException(String, Throwable) - Constructor for exception class org.jpedal.exception.PdfException
PDFtoHTML5Converter - Class in org.jpedal.examples.html: The main entry point 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.
PDFtoHTML5Converter(InputStream, File, HTMLConversionOptions, OutputModeOptions) - Constructor for class org.jpedal.examples.html.PDFtoHTML5Converter: Constructs a new PDFtoHTML5Converter.
PDFtoSVGConverter - Class in org.jpedal.examples.svg: The main entry point for converting PDF files to SVG.
PDFtoSVGConverter(byte[], File, SVGConversionOptions, OutputModeOptions) - Constructor for class org.jpedal.examples.svg.PDFtoSVGConverter: Constructs a new PDFtoSVGConverter.
PDFtoSVGConverter(File, File, SVGConversionOptions, OutputModeOptions) - Constructor for class org.jpedal.examples.svg.PDFtoSVGConverter: Constructs a new PDFtoSVGConverter.
PDFtoSVGConverter(InputStream, File, SVGConversionOptions, OutputModeOptions) - Constructor for class org.jpedal.examples.svg.PDFtoSVGConverter: Constructs a new PDFtoSVGConverter.
PNG - Enum constant in enum class org.jpedal.render.output.io.ImageFileType

S

SCALE - Enum constant in enum class org.jpedal.render.output.ConversionOptions.ScalingMode
setAddBorder(boolean) - Method in class org.jpedal.render.output.svg.SVGConversionOptions: Add a border around the page
setAddJavaScript(boolean) - Method in class org.jpedal.render.output.html.HTMLConversionOptions: Include all the JavaScript that is within the PDF file.
setClipOffsetAmount(float) - Method in class org.jpedal.render.output.ConversionOptions: Set the distance in pixels that polygons are expanded by in order to reduce fractional white lines
setClipOffsetAmount(float) - Method in class org.jpedal.render.output.html.HTMLConversionOptions: Set the distance in pixels that polygons are expanded by in order to reduce fractional white lines
setClipOffsetAmount(float) - Method in class org.jpedal.render.output.svg.SVGConversionOptions: Set the distance in pixels that polygons are expanded by in order to reduce fractional white lines
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
setCompressImages(boolean) - Method in class org.jpedal.render.output.svg.SVGConversionOptions: When enabled, generated PNG images will be compressed to reduce file size.
setCompressSVG(boolean) - Method in class org.jpedal.render.output.ConversionOptions: Generates compressed .svgz files rather than .svg.
setCompressSVG(boolean) - Method in class org.jpedal.render.output.html.HTMLConversionOptions: Generates compressed .svgz files rather than .svg.
setCompressSVG(boolean) - Method in class org.jpedal.render.output.svg.SVGConversionOptions: Generates compressed .svgz files rather than .svg.
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.
setConvertPDFExternalFileToOutputType(boolean) - Method in class org.jpedal.render.output.svg.SVGConversionOptions: 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 ( ) in the output.
setConvertSpacesToNbsp(boolean) - Method in class org.jpedal.render.output.html.HTMLConversionOptions: Convert spaces into Non-breaking Spaces ( ) in the output.
setConvertSpacesToNbsp(boolean) - Method in class org.jpedal.render.output.svg.SVGConversionOptions: Convert spaces into Non-breaking Spaces ( ) in the output.
setCssSuffix(String) - Method in class org.jpedal.render.output.ContentOptions: Appends the provided cssSuffix value to any classes and IDs within the document.
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.
setCustomErrorTracker(ErrorTracker) - Method in class org.jpedal.examples.svg.PDFtoSVGConverter: 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.
setCustomIO(CustomIO) - Method in class org.jpedal.examples.svg.PDFtoSVGConverter: 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.
setDisableExternalHyperlinks(boolean) - Method in class org.jpedal.render.output.ConversionOptions: Prevents outbound hyperlinks being included in the output.
setDisableExternalHyperlinks(boolean) - Method in class org.jpedal.render.output.html.HTMLConversionOptions: Prevents outbound hyperlinks being included in the output.
setDisableExternalHyperlinks(boolean) - Method in class org.jpedal.render.output.svg.SVGConversionOptions: Prevents outbound hyperlinks being included in the output.
setDisableHyperlinkDetection(boolean) - Method in class org.jpedal.render.output.ConversionOptions: Disables the functionality that detects hyperlinks within PDF text.
setDisableHyperlinkDetection(boolean) - Method in class org.jpedal.render.output.html.HTMLConversionOptions: Disables the functionality that detects hyperlinks within PDF text.
setDisableHyperlinkDetection(boolean) - Method in class org.jpedal.render.output.svg.SVGConversionOptions: Disables the functionality that detects hyperlinks within PDF text.
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.
setEmbedImagesAsBase64Stream(boolean) - Method in class org.jpedal.render.output.svg.SVGConversionOptions: Embed images as Base64 stream.
setEmbedSvgAsBase64Image(boolean) - Method in class org.jpedal.render.output.html.HTMLConversionOptions: Embeds the SVG background directly into the HTML file as a base64 image.
setEnableLaunchActions(boolean) - Method in class org.jpedal.render.output.IDRViewerOptions: Enables Link annotations that use Launch actions in the IDRViewer.
setEncryptTempFiles() - Method in class org.jpedal.examples.html.PDFtoHTML5Converter: Enables encryption of all temporary files that may be created during the conversion process.
setEncryptTempFiles() - Method in class org.jpedal.examples.svg.PDFtoSVGConverter: 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,
setFontsToRasterizeInTextMode(String) - Method in class org.jpedal.render.output.svg.SVGConversionOptions: 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.
setFormTag(String) - Method in class org.jpedal.render.output.svg.SVGConversionOptions: Replacing <form> with your version.
setGenerateSearchFile(boolean) - Method in class org.jpedal.render.output.ContentOptions: Generates search.json.
setGenerateSearchFile(boolean) - Method in class org.jpedal.render.output.IDRViewerOptions: Generates search.json.
setGenerateSearchFile(boolean) - Method in class org.jpedal.render.output.OutputModeOptions: 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.
setImageScale(float) - Method in class org.jpedal.render.output.svg.SVGConversionOptions: Write out larger images to allow higher quality zooming.
setIncludedFonts(ConversionOptions.Font[]) - Method in class org.jpedal.render.output.ConversionOptions: Specify the font types to generate.
setIncludedFonts(ConversionOptions.Font[]) - Method in class org.jpedal.render.output.html.HTMLConversionOptions: Specify the font types to generate.
setIncludedFonts(ConversionOptions.Font[]) - Method in class org.jpedal.render.output.svg.SVGConversionOptions: Specify the font types to generate.
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.
setKeepGlyfsSeparate(boolean) - Method in class org.jpedal.render.output.svg.SVGConversionOptions: 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.
setLogicalPageRange(PageRanges) - Method in class org.jpedal.render.output.svg.SVGConversionOptions: Set a page range using logical page numbering.
setMaxPageHeight(int) - Method in class org.jpedal.render.output.ConversionOptions: Sets the maximum height of the converted document.
setMaxPageHeight(int) - Method in class org.jpedal.render.output.html.HTMLConversionOptions: Sets the maximum height of the converted document.
setMaxPageHeight(int) - Method in class org.jpedal.render.output.svg.SVGConversionOptions: Sets the maximum height of the converted document.
setMaxPageWidth(int) - Method in class org.jpedal.render.output.ConversionOptions: Sets the maximum width of the converted document.
setMaxPageWidth(int) - Method in class org.jpedal.render.output.html.HTMLConversionOptions: Sets the maximum width of the converted document.
setMaxPageWidth(int) - Method in class org.jpedal.render.output.svg.SVGConversionOptions: Sets the maximum width of the converted document.
setMinFontSize(int) - Method in class org.jpedal.render.output.html.HTMLConversionOptions: Sets the minimum font size to be used.
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.
setOmitNameDir(boolean) - Method in class org.jpedal.render.output.svg.SVGConversionOptions: Controls the folder structure of the output.
setOriginalFileName(String) - Method in class org.jpedal.render.output.ConversionOptions: Spoof the filename of the document being converted.
setOriginalFileName(String) - Method in class org.jpedal.render.output.html.HTMLConversionOptions: Spoof the filename of the document being converted.
setOriginalFileName(String) - Method in class org.jpedal.render.output.svg.SVGConversionOptions: Spoof the filename of the document being converted.
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.IDRViewerOptions: 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.
setPageFlatteningImageThreshold(int) - Method in class org.jpedal.render.output.ConversionOptions: Set the threshold for the number of images which, once reached, will cause the page will be flattened into a single image to improve performance in the browser.
setPageFlatteningImageThreshold(int) - Method in class org.jpedal.render.output.html.HTMLConversionOptions: Set the threshold for the number of images which, once reached, will cause the page will be flattened into a single image to improve performance in the browser.
setPageFlatteningImageThreshold(int) - Method in class org.jpedal.render.output.svg.SVGConversionOptions: Set the threshold for the number of images which, once reached, will cause the page will be flattened into a single image to improve performance in the browser.
setPassword(String) - Method in class org.jpedal.examples.html.PDFtoHTML5Converter: Set the password to be used to open the PDF file (if set).
setPassword(String) - Method in class org.jpedal.examples.svg.PDFtoSVGConverter: Set the password to be used to open the PDF file (if set).
setPixelsPerInch(int) - Method in class org.jpedal.render.output.ConversionOptions: Set the internal resolution which determines the page size at 100% zoom/scaling.
setPixelsPerInch(int) - Method in class org.jpedal.render.output.html.HTMLConversionOptions: Set the internal resolution which determines the page size at 100% zoom/scaling.
setPixelsPerInch(int) - Method in class org.jpedal.render.output.svg.SVGConversionOptions: Set the internal resolution which determines the page size at 100% zoom/scaling.
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.
setRealPageRange(PageRanges) - Method in class org.jpedal.render.output.svg.SVGConversionOptions: 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.
setScaling(float) - Method in class org.jpedal.render.output.svg.SVGConversionOptions: 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
setScalingFitHeight(int) - Method in class org.jpedal.render.output.svg.SVGConversionOptions
setScalingFitWidth(int) - Method in class org.jpedal.render.output.ConversionOptions
setScalingFitWidth(int) - Method in class org.jpedal.render.output.html.HTMLConversionOptions
setScalingFitWidth(int) - Method in class org.jpedal.render.output.svg.SVGConversionOptions
setScalingFitWidthHeight(int, int) - Method in class org.jpedal.render.output.ConversionOptions
setScalingFitWidthHeight(int, int) - Method in class org.jpedal.render.output.html.HTMLConversionOptions
setScalingFitWidthHeight(int, int) - Method in class org.jpedal.render.output.svg.SVGConversionOptions
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.
setSeparateToWords(boolean) - Method in class org.jpedal.render.output.svg.SVGConversionOptions: 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.
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.
setTextMode(ConversionOptions.TextMode) - Method in class org.jpedal.render.output.svg.SVGConversionOptions: Set Text Mode.
setThumbnailMaxHeight(int) - Method in class org.jpedal.render.output.ContentOptions: Sets the maximum height of the thumbnails.
setThumbnailMaxHeight(int) - Method in class org.jpedal.render.output.IDRViewerOptions: Sets the maximum height of the thumbnails.
setThumbnailMaxHeight(int) - Method in class org.jpedal.render.output.OutputModeOptions: Sets the maximum height of the thumbnails.
setThumbnailMaxWidth(int) - Method in class org.jpedal.render.output.ContentOptions: Sets the maximum width of the thumbnails.
setThumbnailMaxWidth(int) - Method in class org.jpedal.render.output.IDRViewerOptions: Sets the maximum width of the thumbnails.
setThumbnailMaxWidth(int) - Method in class org.jpedal.render.output.OutputModeOptions: Sets the maximum width of the thumbnails.
setTinyTextRemovalThreshold(float) - Method in class org.jpedal.render.output.ConversionOptions: Removes text below the given font size in the generated output.
setTinyTextRemovalThreshold(float) - Method in class org.jpedal.render.output.html.HTMLConversionOptions: Removes text below the given font size in the generated output.
setTinyTextRemovalThreshold(float) - Method in class org.jpedal.render.output.svg.SVGConversionOptions: Removes text below the given font size in the generated output.
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.
setUseLegacyImageFileType(boolean) - Method in class org.jpedal.render.output.svg.SVGConversionOptions: If enabled, all images output will use the PNG file type.
setViewerUI(IDRViewerOptions.ViewerUI) - Method in class org.jpedal.render.output.IDRViewerOptions: Sets the user interface to use for the viewer.
SHADE - Enum constant in enum class org.jpedal.render.output.io.ImageType: Used in svg_* text modes.
Simple - Enum constant in enum class org.jpedal.render.output.IDRViewerOptions.ViewerUI
SlideShow - Enum constant in enum class org.jpedal.render.output.IDRViewerOptions.ViewerUI
startedPageDecoding(int) - Method in interface org.jpedal.external.ErrorTracker
SVG_ALPHA_NOT_REQUIRED - Enum constant in enum class org.jpedal.render.output.io.ImageType: Used in svg_* text modes.
SVG_ALPHA_REQUIRED - Enum constant in enum class org.jpedal.render.output.io.ImageType: Used in svg_* text modes.
SVG_REALTEXT - Enum constant in enum class org.jpedal.render.output.ConversionOptions.TextMode
SVG_SHAPETEXT_NONSELECTABLE - Enum constant in enum class org.jpedal.render.output.ConversionOptions.TextMode
SVG_SHAPETEXT_SELECTABLE - Enum constant in enum class org.jpedal.render.output.ConversionOptions.TextMode
SVGConversionOptions - Class in org.jpedal.render.output.svg: The class to use for setting conversion options when converting to SVG.
SVGConversionOptions() - Constructor for class org.jpedal.render.output.svg.SVGConversionOptions
SVGConversionOptions(String) - Constructor for class org.jpedal.render.output.svg.SVGConversionOptions
SVGConversionOptions(Map<String, String>) - Constructor for class org.jpedal.render.output.svg.SVGConversionOptions

T

THUMBNAIL - Enum constant in enum class 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 class org.jpedal.render.output.ConversionOptions.Font: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.jpedal.render.output.ConversionOptions.ScalingMode: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.jpedal.render.output.ConversionOptions.TextMode: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.jpedal.render.output.IDRViewerOptions.ViewerUI: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.jpedal.render.output.io.ImageFileType: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.jpedal.render.output.io.ImageType: Returns the enum constant of this class with the specified name.
values() - Static method in enum class org.jpedal.render.output.ConversionOptions.Font: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.jpedal.render.output.ConversionOptions.ScalingMode: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.jpedal.render.output.ConversionOptions.TextMode: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.jpedal.render.output.IDRViewerOptions.ViewerUI: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.jpedal.render.output.io.ImageFileType: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.jpedal.render.output.io.ImageType: Returns an array containing the constants of this enum class, in the order they are declared.

W

WOFF - Enum constant in enum class org.jpedal.render.output.ConversionOptions.Font
WOFF_BASE64 - Enum constant in enum class 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 S T V W
All Classes and Interfaces|All Packages|Serialized Form|System Properties