Index (JPedal 2024.11 API Documentation)

A B C D E F G H I J K L M N O P R S T U V W X Z
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

A(Object, FormObject, int) - Method in interface org.jpedal.objects.acroforms.actions.ActionHandler: A action when pressed in active area ?
ABOUT - Enum constant in enum class org.jpedal.examples.viewer.ViewerCommands
ABOUT - Static variable in class org.jpedal.examples.viewer.Commands
ACCELERATIONOFF - Enum constant in enum class org.jpedal.examples.viewer.ViewerCommands
ACCELERATIONOFF - Static variable in class org.jpedal.examples.viewer.Commands
ACCELERATIONON - Enum constant in enum class org.jpedal.examples.viewer.ViewerCommands
ACCELERATIONON - Static variable in class org.jpedal.examples.viewer.Commands
ActionHandler - Interface in org.jpedal.objects.acroforms.actions
actionPerformed(SwingGUI, Commands) - Method in interface org.jpedal.external.JPedalActionHandler
addCode(String) - Method in interface org.jpedal.objects.javascript.ExpressionEngine: adding code for the javascript to call as needed
addExternalHandler(Object, int) - Method in class org.jpedal.PdfDecoder: not part of API used internally
addExternalHandler(Object, int) - Method in interface org.jpedal.PdfDecoderInt: not part of API used internally
addExternalHandler(Object, int) - Method in class org.jpedal.PdfDecoderServer: not part of API used internally
addExternalHandler(Map<Integer, Object>, int) - Method in class org.jpedal.examples.viewer.Viewer: Allows external helper classes to be added to JPedal to alter default functionality.
addFallBackFont(FallbackFont) - Static method in class org.jpedal.fonts.FontMappings
addHighlights(int[][], boolean, int) - Method in class org.jpedal.text.TextLines: Method to highlight text on page.
AdditionalHandler - Static variable in class org.jpedal.external.Options
addPageFailureMessage(String) - Method in interface org.jpedal.external.ErrorTracker
addPageScript(int, int, String) - Method in interface org.jpedal.objects.acroforms.creation.FormFactory
addShape(int, int, Shape, PdfPaint, PdfPaint) - Method in interface org.jpedal.external.ShapeTracker: pass user the low-level details
addToLineAreas(int[], int, int) - Method in class org.jpedal.text.TextLines
addUrlArea(int, int[], String) - Method in class org.jpedal.text.TextLines
ADDVIEW - Enum constant in enum class org.jpedal.examples.viewer.ViewerCommands
ADDVIEW - Static variable in class org.jpedal.examples.viewer.Commands
ALLOW_PAGES_SMALLER_THAN_PAGE_SIZE - Static variable in class org.jpedal.constants.JPedalSettings: For use with converting to Image, this key will allow JPedal to generate pages smaller than the PDFs page size when using HiRes image conversion.
ALLPAGES - Static variable in interface org.jpedal.external.JPedalCustomDrawObject
ALWAYSSHOWMOUSE - Enum constant in enum class org.jpedal.examples.viewer.ViewerCommands
ALWAYSSHOWMOUSE - Static variable in class org.jpedal.examples.viewer.Commands
annotation - Static variable in interface org.jpedal.objects.acroforms.creation.FormFactory
ANNOTATION - Static variable in interface org.jpedal.objects.acroforms.creation.FormFactory
annotationButton(FormObject) - Method in interface org.jpedal.objects.acroforms.creation.FormFactory: setup annotations display with pop-ups, etc
AnnotationWriter - Class in org.jpedal.io.annotation: Class writes annotations to PDF file Example:
append(BufferedImage, byte[]) - Method in class com.idrsolutions.image.tiff.TiffEncoder: Appends image to byte array
append(BufferedImage, String) - Method in class com.idrsolutions.image.tiff.TiffEncoder: Appends image to specified tiff file
appendAnnotOrder(Map<String, String>) - Method in interface org.jpedal.objects.acroforms.creation.FormFactory: Append a map of tab orders onto the form factories existing annotation order store
AUTOSCROLL - Enum constant in enum class org.jpedal.examples.viewer.ViewerCommands
AUTOSCROLL - Static variable in class org.jpedal.examples.viewer.Commands

B

BACK - Enum constant in enum class org.jpedal.examples.viewer.ViewerCommands
BACK - Static variable in class org.jpedal.examples.viewer.Commands
BACKPAGE - Enum constant in enum class org.jpedal.examples.viewer.ViewerCommands
BACKPAGE - Static variable in class org.jpedal.examples.viewer.Commands
BITMAP - Enum constant in enum class org.jpedal.examples.viewer.ViewerCommands
BITMAP - Static variable in class org.jpedal.examples.viewer.Commands
Bl(Object, FormObject) - Method in interface org.jpedal.objects.acroforms.actions.ActionHandler: Bl action when input focus lost
BmpDecoder - Class in com.idrsolutions.image.bmp: Class reads BMP image as BufferedImage
BmpDecoder() - Constructor for class com.idrsolutions.image.bmp.BmpDecoder
BmpEncoder - Class in com.idrsolutions.image.bmp: Class writes BufferedImages as BMP
BmpEncoder() - Constructor for class com.idrsolutions.image.bmp.BmpEncoder
BmpEncoder(EncoderOptions) - Constructor for class com.idrsolutions.image.bmp.BmpEncoder: Sets up the options so they can be used when encoding
BmpEncoderOptions - Class in com.idrsolutions.image.bmp.options: Class handles the options available for writing BMP
BmpEncoderOptions() - Constructor for class com.idrsolutions.image.bmp.options.BmpEncoderOptions
BOOKMARK - Enum constant in enum class org.jpedal.examples.viewer.ViewerCommands
BOOKMARK - Static variable in class org.jpedal.examples.viewer.Commands
BUY - Enum constant in enum class org.jpedal.examples.viewer.ViewerCommands
BUY - Static variable in class org.jpedal.examples.viewer.Commands

C

C(FormObject) - Method in interface org.jpedal.objects.acroforms.actions.ActionHandler: C action when another field changes (recalculate this field) [javascript] should not be called other than from internal methods to action changes on other fields.
CACHE_LARGE_FONTS - Static variable in class org.jpedal.constants.JPedalSettings: For use with all JPedal functionality, this key will allow JPedal to cache large fonts to avoid big memory hit.
CARET - Enum constant in enum class org.jpedal.io.annotation.WritableAnnotation.AnnotationType
CASE_SENSITIVE - Static variable in class org.jpedal.grouping.SearchType: Used to describe a search that is case-sensitive
Centimetres - Enum constant in enum class org.jpedal.examples.PdfUtilities.PageUnits
CHANGE_LINEART - Static variable in class org.jpedal.constants.JPedalSettings: For use with Viewer, Print, and converting to Image, this key will allow JPedal to replace the color of the shapes on the page in the same way the text color is changed.
CHANGELINEART - Enum constant in enum class org.jpedal.examples.viewer.ViewerCommands
CHANGELINEART - Static variable in class org.jpedal.examples.viewer.Commands
changeTo(String, int, Object, Integer, boolean) - Method in interface org.jpedal.objects.acroforms.actions.ActionHandler
changeTo(String, int, Object, Integer, boolean) - Method in class org.jpedal.objects.acroforms.actions.DefaultActionHandler: this calls the PdfDecoder to open a new page and change to the correct page and location on page, is any value is null, it means leave as is.
checkBoxBut(FormObject) - Method in interface org.jpedal.objects.acroforms.creation.FormFactory: setup and return a single checkBox button component, from the specified formObject
checkboxbutton - Static variable in interface org.jpedal.objects.acroforms.creation.FormFactory
CHECKBOXBUTTON - Static variable in interface org.jpedal.objects.acroforms.creation.FormFactory
checkForExitRequest(int, int) - Method in interface org.jpedal.external.ErrorTracker
checkLinks(Map<FormObject, String>, boolean, PdfObjectReader, int, int, SwingGUI, Values) - Method in class org.jpedal.examples.handlers.ExampleAnnotationHandler
choiceIndicesToOptions(int[]) - Method in class org.jpedal.objects.raw.FormObject: Convert a list of indices into a list of the options they represent
choiceOptionsToIndices(String[], boolean) - Method in class org.jpedal.objects.raw.FormObject: Convert a list of options into a list of indices
choiceOptionToIndex(String, boolean) - Method in class org.jpedal.objects.raw.FormObject: Get the index of the given option
CIRCLE - Enum constant in enum class org.jpedal.io.annotation.WritableAnnotation.AnnotationType
CircleAnnotation - Class in org.jpedal.io.annotation: Class generates Circle Annotation
CircleAnnotation(int, float, float, float, float) - Constructor for class org.jpedal.io.annotation.CircleAnnotation: Constructor for creating Circle Annotation
CircleAnnotation(int, float, float, float, float, FormObject) - Constructor for class org.jpedal.io.annotation.CircleAnnotation: Constructor for creating Circle Annotation
clearHighlights() - Method in class org.jpedal.text.TextLines: Clear all highlights that are being displayed
clearScreen() - Method in class org.jpedal.PdfDecoder: remove all displayed objects for JPanel display (wipes current page)
clearScreen() - Method in class org.jpedal.PdfDecoderServer: remove all displayed objects for JPanel display (wipes current page)
Clipped Image Extraction from PDF files - Search tag in class org.jpedal.examples.images.ExtractClippedImages: Section
CLIPPEDIMAGES - Static variable in interface org.jpedal.PdfDecoderInt: flag to show extraction of clipped images at highest res
closeCalled - Static variable in class org.jpedal.examples.viewer.Viewer
closeFile() - Method in interface org.jpedal.objects.javascript.ExpressionEngine: called on close to do any cleanup
closePDF() - Method in class org.jpedal.tools.PdfOptimizer: Closes the PDF file that is current loaded
closePdfFile() - Method in class org.jpedal.PdfDecoder: convenience method to close the current PDF file and release all resources/delete any temporary files
closePdfFile() - Method in interface org.jpedal.PdfDecoderInt
closePdfFile() - Method in class org.jpedal.PdfDecoderServer: convenience method to close the current PDF file and release all resources/delete any temporary files
closePDFfile() - Method in class org.jpedal.examples.acroform.ExtractEmbeddedFiles: ensure PDF file is closed once no longer needed and all resources released
closePDFfile() - Method in class org.jpedal.examples.acroform.PdfFormUtilities: ensure PDF file is closed once no longer needed and all resources released
closePDFfile() - Method in class org.jpedal.examples.images.ConvertPagesToHiResImages: ensure PDF file is closed once no longer needed and all resources released
closePDFfile() - Method in class org.jpedal.examples.images.ConvertPagesToImages: ensure PDF file is closed once no longer needed and all resources released
closePDFfile() - Method in class org.jpedal.examples.images.ExtractClippedImages: ensure PDF file is closed once no longer needed and all resources released
closePDFfile() - Method in class org.jpedal.examples.images.ExtractImages: ensure PDF file is closed once no longer needed and all resources released
closePDFfile() - Method in class org.jpedal.examples.PdfUtilities: ensure PDF file is closed once no longer needed and all resources released
closePDFfile() - Method in class org.jpedal.examples.text.ExtractOutline: ensure PDF file is closed once no longer needed and all resources released
closePDFfile() - Method in class org.jpedal.examples.text.ExtractStructuredText: ensure PDF file is closed once no longer needed and all resources released
closePDFfile() - Method in class org.jpedal.examples.text.ExtractTextAsWordlist: ensure PDF file is closed once no longer needed and all resources released
closePDFfile() - Method in class org.jpedal.examples.text.ExtractTextInRectangle: ensure PDF file is closed once no longer needed and all resources released
closePDFfile() - Method in class org.jpedal.examples.text.FindTextInRectangle: ensure PDF file is closed once no longer needed and all resources released
closePDFfile(boolean) - Method in class org.jpedal.examples.printing.PrintPdfPages: Ensure PDF file is closed once no longer needed and all resources released.
ColorHandler - Static variable in class org.jpedal.external.Options: allow user to make bw
com.idrsolutions.image - package com.idrsolutions.image
com.idrsolutions.image.bmp - package com.idrsolutions.image.bmp
com.idrsolutions.image.bmp.options - package com.idrsolutions.image.bmp.options
com.idrsolutions.image.gif - package com.idrsolutions.image.gif
com.idrsolutions.image.gif.options - package com.idrsolutions.image.gif.options
com.idrsolutions.image.heic - package com.idrsolutions.image.heic
com.idrsolutions.image.heic.options - package com.idrsolutions.image.heic.options
com.idrsolutions.image.jpeg - package com.idrsolutions.image.jpeg
com.idrsolutions.image.jpeg.options - package com.idrsolutions.image.jpeg.options
com.idrsolutions.image.jpeg2000 - package com.idrsolutions.image.jpeg2000
com.idrsolutions.image.jpeg2000.options - package com.idrsolutions.image.jpeg2000.options
com.idrsolutions.image.png - package com.idrsolutions.image.png
com.idrsolutions.image.png.options - package com.idrsolutions.image.png.options
com.idrsolutions.image.tiff - package com.idrsolutions.image.tiff
com.idrsolutions.image.tiff.options - package com.idrsolutions.image.tiff.options
com.idrsolutions.image.webp - package com.idrsolutions.image.webp
com.idrsolutions.image.webp.options - package com.idrsolutions.image.webp.options
COMBO_ID - Static variable in class org.jpedal.objects.raw.FormObject: If set, the field is a combo box; if clear, the field is a list box.
combobox - Static variable in interface org.jpedal.objects.acroforms.creation.FormFactory
comboBox(FormObject) - Method in interface org.jpedal.objects.acroforms.creation.FormFactory: setup and return a ComboBox component, from the specified formObject
COMBOBOX - Static variable in interface org.jpedal.objects.acroforms.creation.FormFactory
Commands - Search tag in class org.jpedal.examples.viewer.Commands: Section
Commands - Class in org.jpedal.examples.viewer: Commands
Commands(Values, SwingGUI, PdfDecoderInt, SwingThumbnailPanel, PropertiesFile, SwingSearchWindow) - Constructor for class org.jpedal.examples.viewer.Commands
containsEmbeddedFiles() - Method in class org.jpedal.examples.acroform.ExtractEmbeddedFiles: Method to flag if the current file contains embedded files.
containsFilesAttachments() - Method in class org.jpedal.examples.acroform.ExtractEmbeddedFiles: Method to flag if the current file contains file attachments
CONTENTMENU - Enum constant in enum class org.jpedal.examples.viewer.ViewerCommands
CONTENTMENU - Static variable in class org.jpedal.examples.viewer.Commands
CONTINUOUS - Enum constant in enum class org.jpedal.examples.viewer.ViewerCommands
CONTINUOUS - Static variable in class org.jpedal.examples.viewer.Commands
CONTINUOUS_FACING - Enum constant in enum class org.jpedal.examples.viewer.ViewerCommands
CONTINUOUS_FACING - Static variable in class org.jpedal.examples.viewer.Commands
convert(byte[], EncoderOptions) - Static method in class com.idrsolutions.image.JDeli: Convert between any supported image file formats and process image
convert(byte[], String) - Static method in class com.idrsolutions.image.JDeli: Convert between any supported image file formats and process image
convert(byte[], String, ImageProcessingOps) - Static method in class com.idrsolutions.image.JDeli: Convert between any supported image file formats and process image
convert(File, EncoderOptions, File) - Static method in class com.idrsolutions.image.JDeli: Convert between any supported image file formats
convert(File, File) - Static method in class com.idrsolutions.image.JDeli: Convert between any supported image file formats
convert(File, File, ImageProcessingOps) - Static method in class com.idrsolutions.image.JDeli: Convert between any supported image file formats and process image
convert(InputStream, EncoderOptions, OutputStream, String) - Static method in class com.idrsolutions.image.JDeli: Convert between any supported image file formats
convert(InputStream, OutputStream, String) - Static method in class com.idrsolutions.image.JDeli: Convert between any supported image file formats and process image
convert(InputStream, OutputStream, String, ImageProcessingOps) - Static method in class com.idrsolutions.image.JDeli: Convert between any supported image file formats and process image
ConvertPagesToHiResImages - Class in org.jpedal.examples.images: Image Extraction from PDF files
ConvertPagesToHiResImages(byte[]) - Constructor for class org.jpedal.examples.images.ConvertPagesToHiResImages: Sets up an ConvertPagesToHiResImages instance to open a PDF file contained as a BLOB within a byte[] stream
ConvertPagesToHiResImages(String) - Constructor for class org.jpedal.examples.images.ConvertPagesToHiResImages: Sets up an ConvertPagesToHiResImages instance to open a PDF File
ConvertPagesToImages - Class in org.jpedal.examples.images: Image Extraction from PDF files
ConvertPagesToImages(byte[]) - Constructor for class org.jpedal.examples.images.ConvertPagesToImages: Sets up an ConvertPagesToImages instance to open a PDF file contained as a BLOB within a byte[] stream (do not pad with additional empty bytes)
ConvertPagesToImages(String) - Constructor for class org.jpedal.examples.images.ConvertPagesToImages: Sets up an ConvertPagesToImages instance to open a PDF File
COPY - Enum constant in enum class org.jpedal.examples.viewer.ViewerCommands
COPY - Static variable in class org.jpedal.examples.viewer.Commands
copyInheritedValuesFromParent(FormObject) - Method in class org.jpedal.objects.raw.FormObject: overwrites all the values on this form with any values from the parent
createFromID(int) - Static method in enum class org.jpedal.examples.viewer.ViewerCommands
CropBox - Enum constant in enum class org.jpedal.examples.PdfUtilities.PageSizeType
CURRENTMENU - Enum constant in enum class org.jpedal.examples.viewer.ViewerCommands
CURRENTMENU - Static variable in class org.jpedal.examples.viewer.Commands
CurrentOffset - Static variable in class org.jpedal.external.Options: Internal use only - do not use
CURRENTPAGE - Enum constant in enum class org.jpedal.examples.viewer.ViewerValues
CURRENTPAGE - Static variable in class org.jpedal.examples.viewer.Commands
CustomFormPrint - Interface in org.jpedal.external
CustomFormPrint - Static variable in class org.jpedal.external.Options: allow user to print own forms
CustomMessageHandler - Interface in org.jpedal.external: allow user to handle output messages
CustomMessageOutput - Static variable in class org.jpedal.external.Options: allow user to replace info messages with own code -also disables error and other info messages
CustomMouseHandler - Static variable in class org.jpedal.external.Options
CustomOutput - Static variable in class org.jpedal.external.Options: allow user to make own output from parser
CustomPrintHintingHandler - Static variable in class org.jpedal.external.Options: Internal use only - do not use

D

D(Object, FormObject) - Method in interface org.jpedal.objects.acroforms.actions.ActionHandler: D action when cursor button pressed inside active area
D(Object, FormObject) - Method in class org.jpedal.objects.acroforms.actions.DefaultActionHandler: D action when cursor button pressed inside active area
debug(String[]) - Static method in class org.jpedal.examples.viewer.Viewer: run the viewer in debug mode
decodePage(int) - Method in class org.jpedal.PdfDecoder: decode a page, - page must be between 1 and PdfDecoder.getPageCount() - Will kill off if already running
decodePage(int) - Method in interface org.jpedal.PdfDecoderInt
decodePage(int) - Method in class org.jpedal.PdfDecoderServer: decode a page, - page must be between 1 and PdfDecoder.getPageCount() - Will kill off if already running
decodePageInBackground(int) - Method in class org.jpedal.PdfDecoder: decode a page as a background thread (use other background methods to access data)
decodePageInBackground(int) - Method in interface org.jpedal.PdfDecoderInt
decodePageInBackground(int) - Method in class org.jpedal.PdfDecoderServer: decode a page as a background thread (use other background methods to access data)
decodeSamplesWithOutputBytes(Info, byte[]) - Static method in class com.idrsolutions.image.jpeg.JpegDecoder
DecodeStatus - Class in org.jpedal.parser
decompressStreamWhenRead() - Method in class org.jpedal.objects.raw.FormObject
DEFAULT - Static variable in class org.jpedal.grouping.SearchType: The default parameter, this describes a search that will not be limited to finding whole words only, is not case-sensitive, and will find all occurrences.
DEFAULT_SIGNATURE_SIZE - Static variable in class org.jpedal.tools.PdfSigner: The default signature size if none is specified.
DefaultActionHandler - Class in org.jpedal.objects.acroforms.actions
DefaultActionHandler(SwingGUI) - Constructor for class org.jpedal.objects.acroforms.actions.DefaultActionHandler
defaultFont - Static variable in class org.jpedal.fonts.FontMappings: font to use in preference to SansSerif
defaultFontDirs - Static variable in class org.jpedal.fonts.FontMappings: put fonts in variable so can be altered if needed by Client
deletePageRange(File, File, int, int) - Static method in class org.jpedal.tools.PdfPageDeletion: Delete the specified page from the provided PDF file into a new File
deletePageRange(File, File, int, int, String) - Static method in class org.jpedal.tools.PdfPageDeletion: Delete the specified page from the provided PDF file into a new File
deletePageRange(File, File, PageRanges) - Static method in class org.jpedal.tools.PdfPageDeletion: Delete the specified page from the provided PDF file into a new File
deletePageRange(File, File, PageRanges, String) - Static method in class org.jpedal.tools.PdfPageDeletion: Delete the specified page from the provided PDF file into a new File
DELETEPROPERTIESONEXIT - Enum constant in enum class org.jpedal.examples.viewer.ViewerCommands
DELETEPROPERTIESONEXIT - Static variable in class org.jpedal.examples.viewer.Commands
deleteSinglePage(File, File, int) - Static method in class org.jpedal.tools.PdfPageDeletion: Delete the specified page from the provided PDF file
deleteSinglePage(File, File, int, String) - Static method in class org.jpedal.tools.PdfPageDeletion: Delete the specified page from the provided PDF file
DESELECTALL - Enum constant in enum class org.jpedal.examples.viewer.ViewerCommands
DESELECTALL - Static variable in class org.jpedal.examples.viewer.Commands
Display - Static variable in class org.jpedal.external.Options: Internal use only - do not use
DISPLAY_BACKGROUND - Static variable in class org.jpedal.constants.JPedalSettings: For use with Viewer, this key will allow JPedal to change the display areas background color to the specified value.
DISPLAY_INVISIBLE_TEXT - Static variable in class org.jpedal.constants.JPedalSettings: For use with Viewer, Print, and converting to Image, this key will allow JPedal to display invisible text in current fill colour.
DisplayOffsets - Static variable in class org.jpedal.external.Options
dispose() - Method in class org.jpedal.examples.viewer.Viewer: run with caution and only at end of usage if you really need
dispose() - Static method in class org.jpedal.fonts.FontMappings
dispose() - Method in interface org.jpedal.objects.javascript.ExpressionEngine
dispose() - Method in class org.jpedal.PdfDecoder: convenience method to remove all items from memory If you wish to clear all static objects as well, you will also need to call disposeAllStatic()
dispose() - Method in interface org.jpedal.PdfDecoderInt
dispose() - Method in class org.jpedal.PdfDecoderServer: convenience method to remove all items from memory If you wish to clear all static objects as well, you will also need to call disposeAllStatic()
disposeAllStatic() - Static method in class org.jpedal.PdfDecoder: remove all static elements - only do once completely finished with JPedal as will not be reinitialised
disposeAllStatic() - Static method in class org.jpedal.PdfDecoderServer: remove all static elements - only do once completely finished with JPedal as will not be reinitialised
DOCINFO - Enum constant in enum class org.jpedal.examples.viewer.ViewerCommands
DOCINFO - Static variable in class org.jpedal.examples.viewer.Commands
DONOTSCROLL_ID - Static variable in class org.jpedal.objects.raw.FormObject: If set, the field shall not scroll (horizontally for single-line fields, vertically for multiple-line fields) to accommodate more text than fits within its annotation rectangle.
DONOTSPELLCHECK_ID - Static variable in class org.jpedal.objects.raw.FormObject: If set, text entered in the field shall not be spell-checked.
downsampleLevel - Static variable in class org.jpedal.images.SamplingFactory: current setting - do not set directly
DrawAdditionalObjects - Class in org.jpedal.examples.samples.swing
drawAdditionalObjectsOverPage(int, int[], Color[], Object[]) - Method in class org.jpedal.PdfDecoder: allow user to add grapical content on top of page - for display ONLY Additional calls will overwrite current settings on page ONLY works in SINGLE VIEW displaymode
drawAdditionalObjectsOverPage(int, int[], Color[], Object[]) - Method in interface org.jpedal.PdfDecoderInt
drawAdditionalObjectsOverPage(int, int[], Color[], Object[]) - Method in class org.jpedal.PdfDecoderServer: allow user to add grapical content on top of page - for display ONLY Additional calls will overwrite current settings on page ONLY works in SINGLE VIEW displaymode
duplicate() - Method in class org.jpedal.objects.raw.FormObject

E

E(Object, FormObject) - Method in interface org.jpedal.objects.acroforms.actions.ActionHandler: E action when cursor enters active area
EDIT_ID - Static variable in class org.jpedal.objects.raw.FormObject: If set, the combo box shall include an editable text box as well as a drop-down list; if clear, it shall include only a drop-down list.
EDITMENU - Enum constant in enum class org.jpedal.examples.viewer.ViewerCommands
EDITMENU - Static variable in class org.jpedal.examples.viewer.Commands
ENHANCE_FRACTIONAL_LINES - Static variable in class org.jpedal.constants.JPedalSettings: For use with Viewer, Print, and converting to Image, this key will allow JPedal to make adjustments to lines positioned at fractional pixel positions to improve appearance.
ensurePointIsVisible(Point) - Method in class org.jpedal.PdfDecoder: make screen scroll to ensure point is visible
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.
ErrorTracker - Static variable in class org.jpedal.external.Options
Example 1 (Using raw byte data): - Search tag in class com.idrsolutions.image.gif.GifDecoder: Section
Example 1 - access API methods - Search tag in class org.jpedal.examples.acroform.ExtractEmbeddedFiles: Section
Example 1 - Print all pages from a PDF - Search tag in class org.jpedal.examples.printing.PrintPdfPages: Section
Example 2 (Using File): - Search tag in class com.idrsolutions.image.gif.GifDecoder: Section
Example 2 - convenience static method - Search tag in class org.jpedal.examples.acroform.ExtractEmbeddedFiles: Section
Example 2 - Print a single page from a PDF - Search tag in class org.jpedal.examples.printing.PrintPdfPages: Section
Example 3 - Access directly from the Jar - Search tag in class org.jpedal.examples.acroform.ExtractEmbeddedFiles: Section
Example 3 - Access directly from the Jar - Search tag in class org.jpedal.examples.printing.PrintPdfPages: Section
ExampleActionHandler - Class in org.jpedal.examples.handlers
ExampleActionHandler() - Constructor for class org.jpedal.examples.handlers.ExampleActionHandler
ExampleAnnotationHandler - Class in org.jpedal.examples.handlers
ExampleAnnotationHandler() - Constructor for class org.jpedal.examples.handlers.ExampleAnnotationHandler
ExampleColorHandler - Class in org.jpedal.examples.handlers
ExampleColorHandler() - Constructor for class org.jpedal.examples.handlers.ExampleColorHandler
ExampleCustomMessageHandler - Class in org.jpedal.examples.handlers
ExampleCustomMessageHandler() - Constructor for class org.jpedal.examples.handlers.ExampleCustomMessageHandler
ExampleErrorTracker - Class in org.jpedal.examples.handlers
ExampleErrorTracker() - Constructor for class org.jpedal.examples.handlers.ExampleErrorTracker
Example to read an image, where: - Search tag in class com.idrsolutions.image.JDeli: Section
Example to write an image, where: - Search tag in class com.idrsolutions.image.JDeli: Section
execute(FormObject, int, String, int, char) - Method in interface org.jpedal.objects.javascript.ExpressionEngine
executeCommand(int, Object[]) - Method in class org.jpedal.examples.viewer.Commands: Deprecated.
use Commands.executeCommand(ViewerCommands, Object[]) instead.
executeCommand(int, Object[]) - Method in class org.jpedal.examples.viewer.Viewer: Deprecated.
use Viewer.executeCommand(ViewerCommands, Object[]) instead.
executeCommand(ViewerCommands, Object[]) - Method in class org.jpedal.examples.viewer.Commands
executeCommand(ViewerCommands, Object...) - Method in class org.jpedal.examples.viewer.Viewer: Execute Jpedal functionality from outside the library using this method.
executeFunctions(String, FormObject) - Method in interface org.jpedal.objects.javascript.ExpressionEngine
EXIT - Enum constant in enum class org.jpedal.examples.viewer.ViewerCommands
EXIT - Static variable in class org.jpedal.examples.viewer.Commands
exitOnClose - Static variable in class org.jpedal.examples.viewer.Viewer
EXPORTMENU - Enum constant in enum class org.jpedal.examples.viewer.ViewerCommands
EXPORTMENU - Static variable in class org.jpedal.examples.viewer.Commands
ExpressionEngine - Interface in org.jpedal.objects.javascript: allow user to handle expressions with own implementation
ExpressionEngine - Static variable in class org.jpedal.external.Options: allows user to link in their own code for Javascript validation - needs to implement ExpressionEngine
EXTRACT_AT_BEST_QUALITY_MAXSCALING - Static variable in class org.jpedal.constants.JPedalSettings: For use with converting to Image, this key will allow JPedal to limit the amount of scaling on Best quality to a given maximum.
EXTRACT_AT_PAGE_SIZE - Static variable in class org.jpedal.constants.JPedalSettings: For use with converting to Image, this key will allow JPedal to limit the amount of scaling on Best quality.
extractAllFilesFromPdf(String, String) - Static method in class org.jpedal.examples.acroform.ExtractEmbeddedFiles: static method to write out all pages in a PDF files or directory of PDF files as images
EXTRACTASIMAGE - Enum constant in enum class org.jpedal.examples.viewer.ViewerCommands
EXTRACTASIMAGE - Static variable in class org.jpedal.examples.viewer.Commands
ExtractClippedImages - Class in org.jpedal.examples.images: Clipped Image Extraction from PDF files
ExtractClippedImages(byte[]) - Constructor for class org.jpedal.examples.images.ExtractClippedImages: Sets up an ExtractClippedImages instance to open a PDF file contained as a BLOB within a byte[] stream
ExtractClippedImages(String) - Constructor for class org.jpedal.examples.images.ExtractClippedImages: Sets up an ExtractClippedImages instance to open a PDF File
extractEmbeddedFiles(String) - Method in class org.jpedal.examples.acroform.ExtractEmbeddedFiles: Extract embedded files and place them in the output directory specified.
ExtractEmbeddedFiles - Class in org.jpedal.examples.acroform: File Extraction from PDF files
ExtractEmbeddedFiles(byte[]) - Constructor for class org.jpedal.examples.acroform.ExtractEmbeddedFiles
ExtractEmbeddedFiles(String) - Constructor for class org.jpedal.examples.acroform.ExtractEmbeddedFiles
extractFileAttachments(String) - Method in class org.jpedal.examples.acroform.ExtractEmbeddedFiles: Extract files from file attachment annotations in the open file and place them in the output directory specified.
ExtractImages - Class in org.jpedal.examples.images: Image Extraction from PDF files
ExtractImages(byte[]) - Constructor for class org.jpedal.examples.images.ExtractImages: Sets up an ExtractImages instance to open a PDF file contained as a BLOB within a byte[] stream
ExtractImages(String) - Constructor for class org.jpedal.examples.images.ExtractImages: Sets up an ExtractImages instance to open a PDF File
extractingAsImage - Variable in class org.jpedal.examples.viewer.Commands
ExtractOutline - Class in org.jpedal.examples.text: Outline Object Data Extraction from PDF files
ExtractOutline(byte[]) - Constructor for class org.jpedal.examples.text.ExtractOutline: Sets up an ExtractOutline instance to open a PDF file contained as a BLOB within a byte[] stream
ExtractOutline(String) - Constructor for class org.jpedal.examples.text.ExtractOutline: Sets up an ExtractOutline instance to open a PDF File
extractPageRange(File, File, int, int) - Static method in class org.jpedal.tools.PdfPageExtraction: Extract the specified page from the provided PDF file into a new File
extractPageRange(File, File, int, int, String) - Static method in class org.jpedal.tools.PdfPageExtraction: Extract the specified page from the provided PDF file into a new File
extractPageRange(File, File, PageRanges) - Static method in class org.jpedal.tools.PdfPageExtraction: Extract the specified pages from the provided PDF file into a new File
extractPageRange(File, File, PageRanges, String) - Static method in class org.jpedal.tools.PdfPageExtraction: Extract the specified pages from the provided PDF file into a new File
extractPagesAsImages(String, String, String, boolean) - Method in class org.jpedal.examples.images.ConvertPagesToImages
extractSinglePage(File, File, int) - Static method in class org.jpedal.tools.PdfPageExtraction: Extract the specified page from the provided PDF file
extractSinglePage(File, File, int, String) - Static method in class org.jpedal.tools.PdfPageExtraction: Extract the specified page from the provided PDF file
Extract Structured Content (if present) from PDF files - Search tag in class org.jpedal.examples.text.ExtractStructuredText: Section
ExtractStructuredText - Class in org.jpedal.examples.text: Extract Structured Content (if present) from PDF files
ExtractStructuredText(byte[]) - Constructor for class org.jpedal.examples.text.ExtractStructuredText: Sets up an ExtractStructuredText instance to open a PDF file contained as a BLOB within a byte[] stream
ExtractStructuredText(byte[], ExtractStructuredTextProperties) - Constructor for class org.jpedal.examples.text.ExtractStructuredText: Sets up an ExtractStructuredText instance to open a PDF file contained as a BLOB within a byte[] stream
ExtractStructuredText(String) - Constructor for class org.jpedal.examples.text.ExtractStructuredText: Sets up an ExtractStructuredText instance to open a PDF File
ExtractStructuredText(String, ExtractStructuredTextProperties) - Constructor for class org.jpedal.examples.text.ExtractStructuredText: Sets up an ExtractStructuredText instance to open a PDF File
EXTRACTTEXT - Enum constant in enum class org.jpedal.examples.viewer.ViewerCommands
EXTRACTTEXT - Static variable in class org.jpedal.examples.viewer.Commands
ExtractTextAsWordlist - Class in org.jpedal.examples.text: Extract words and locations from PDF files
ExtractTextAsWordlist(byte[]) - Constructor for class org.jpedal.examples.text.ExtractTextAsWordlist: Sets up an ExtractTextAsWordlist instance to open a PDF file contained as a BLOB within a byte[] stream
ExtractTextAsWordlist(String) - Constructor for class org.jpedal.examples.text.ExtractTextAsWordlist: Sets up an ExtractTextAsWordlist instance to open a PDF File
Extract text from PDF files - Search tag in class org.jpedal.examples.text.ExtractTextInRectangle: Section
ExtractTextInRectangle - Class in org.jpedal.examples.text: Extract text from PDF files
ExtractTextInRectangle(byte[]) - Constructor for class org.jpedal.examples.text.ExtractTextInRectangle: Sets up an ExtractTextInRectangle instance to open a PDF file contained as a BLOB within a byte[] stream
ExtractTextInRectangle(String) - Constructor for class org.jpedal.examples.text.ExtractTextInRectangle: Sets up an ExtractTextInRectangle instance to open a PDF File
ExtractTextInRectangle(String, boolean) - Constructor for class org.jpedal.examples.text.ExtractTextInRectangle: Sets up an ExtractTextInRectangle instance to open a PDF File
ExtractTextInRectangle.OUTPUT_FORMAT - Enum Class in org.jpedal.examples.text: The available formats that text can be output as
Extract words and locations from PDF files - Search tag in class org.jpedal.examples.text.ExtractTextAsWordlist: Section

F

F(FormObject) - Method in interface org.jpedal.objects.acroforms.actions.ActionHandler: F the display formatting of the field (e.g 2 decimal places) [javascript]
FACING - Enum constant in enum class org.jpedal.examples.viewer.ViewerCommands
FACING - Static variable in class org.jpedal.examples.viewer.Commands
FBACKPAGE - Enum constant in enum class org.jpedal.examples.viewer.ViewerCommands
FBACKPAGE - Static variable in class org.jpedal.examples.viewer.Commands
FFORWARDPAGE - Enum constant in enum class org.jpedal.examples.viewer.ViewerCommands
FFORWARDPAGE - Static variable in class org.jpedal.examples.viewer.Commands
FieldsHightlightColor - Static variable in class org.jpedal.objects.raw.FormObject
FileAccess - Static variable in class org.jpedal.external.Options
FILEATTACHMENT - Enum constant in enum class org.jpedal.io.annotation.WritableAnnotation.AnnotationType
File Extraction from PDF files - Search tag in class org.jpedal.examples.acroform.ExtractEmbeddedFiles: Section
FILEMENU - Enum constant in enum class org.jpedal.examples.viewer.ViewerCommands
FILEMENU - Static variable in class org.jpedal.examples.viewer.Commands
filter(byte[], FilterOptions) - Static method in class com.idrsolutions.image.JDeli: This method filters the data using the chosen algorithm
filter(InputStream, FilterOptions, OutputStream) - Static method in class com.idrsolutions.image.JDeli: This method filters the data using the chosen algorithm
FINALIMAGES - Static variable in interface org.jpedal.PdfDecoderInt: flag to show extraction mode is to include final scale/clip
FIND - Enum constant in enum class org.jpedal.examples.viewer.ViewerCommands
FIND - Static variable in class org.jpedal.examples.viewer.Commands
FIND_FIRST_OCCURANCE_ONLY - Static variable in class org.jpedal.grouping.SearchType: Used to describe a search that will find first occurrences only
Find text in PDF files - Search tag in class org.jpedal.examples.text.FindTextInRectangle: Section
FindTextInRectangle - Class in org.jpedal.examples.text: Find text in PDF files
FindTextInRectangle(byte[]) - Constructor for class org.jpedal.examples.text.FindTextInRectangle: Sets up an FindTextInRectangle instance to open a PDF file contained as a BLOB within a byte[] stream
FindTextInRectangle(String) - Constructor for class org.jpedal.examples.text.FindTextInRectangle: Sets up an FindTextInRectangle instance to open a PDF File
findTextOnAllPages(String, String) - Static method in class org.jpedal.examples.text.FindTextInRectangle: Convenience method to find text in a PDF file
findTextOnPage(int, int, int, int, int, String, int) - Method in class org.jpedal.examples.text.FindTextInRectangle: Return the coords for the page specified.The origin of the coords is the bottom left hand corner (on unrotated page)
findTextOnPage(int, String, int) - Method in class org.jpedal.examples.text.FindTextInRectangle: Return the coords for the page specified.The origin of the coords is the bottom left hand corner (on unrotated page)
finishedPageDecoding(int) - Method in interface org.jpedal.external.ErrorTracker
FIRST_DOCUMENT_SEARCH_RESULT_NOW_SHOWN - Static variable in class org.jpedal.examples.viewer.Commands
FIRSTPAGE - Enum constant in enum class org.jpedal.examples.viewer.ViewerCommands
FIRSTPAGE - Static variable in class org.jpedal.examples.viewer.Commands
flattenForm(FormObject) - Method in interface org.jpedal.objects.acroforms.creation.FormFactory
flipChoiceOption(String[], boolean) - Method in class org.jpedal.objects.raw.FormObject: Flip the choice option
flipChoiceOption(String, boolean) - Method in class org.jpedal.objects.raw.FormObject: Flip a choice option
flushAdditionalObjectsOnPage(int) - Method in class org.jpedal.PdfDecoder: allow user to remove all additional grapical content from the page (only for display) ONLY works in SINGLE VIEW displaymode
flushAdditionalObjectsOnPage(int) - Method in interface org.jpedal.PdfDecoderInt: allow user to remove all additional grapical content from the page (only for display) ONLY works in SINGLE VIEW displaymode
flushAdditionalObjectsOnPage(int) - Method in class org.jpedal.PdfDecoderServer: allow user to remove all additional grapical content from the page (only for display) ONLY works in SINGLE VIEW displaymode
flushObjectValues(boolean) - Method in class org.jpedal.PdfDecoder: provide method for outside class to clear store of objects once written out to reclaim memory
flushObjectValues(boolean) - Method in interface org.jpedal.PdfDecoderInt
flushObjectValues(boolean) - Method in class org.jpedal.PdfDecoderServer: provide method for outside class to clear store of objects once written out to reclaim memory
Fo(Object, FormObject) - Method in interface org.jpedal.objects.acroforms.actions.ActionHandler: Fo action on input focus
FOCUS_EVENT - Static variable in interface org.jpedal.objects.acroforms.actions.ActionHandler
FontMappings - Class in org.jpedal.fonts: Holds Maps which are used to map font names onto actual fonts and files
fontPropertiesTable - Static variable in class org.jpedal.fonts.FontMappings: hold details of all fonts
fontPropertiesTablePath - Static variable in class org.jpedal.fonts.FontMappings
fontPropertiesTableType - Static variable in class org.jpedal.fonts.FontMappings
fontsInitialised - Static variable in class org.jpedal.fonts.FontMappings: ensure fonts setup only once
fontSubstitutionAliasTable - Static variable in class org.jpedal.fonts.FontMappings: used to remap fonts onto truetype fonts (set internally)
fontSubstitutionFontID - Static variable in class org.jpedal.fonts.FontMappings: used to store number for subfonts in TTC
fontSubstitutionLocation - Static variable in class org.jpedal.fonts.FontMappings: used to remap fonts onto truetype fonts (set internally)
fontSubstitutionTable - Static variable in class org.jpedal.fonts.FontMappings: used to remap fonts onto truetype fonts (set internally)
FormFactory - Interface in org.jpedal.objects.acroforms.creation
FormFactory - Static variable in class org.jpedal.external.Options: allows user to over-ride form creation code with own - needs to implement FormFactory
FormObject - Class in org.jpedal.objects.raw
FormObject() - Constructor for class org.jpedal.objects.raw.FormObject
FormObject(int) - Constructor for class org.jpedal.objects.raw.FormObject
FormObject(int, int) - Constructor for class org.jpedal.objects.raw.FormObject
FormObject(String) - Constructor for class org.jpedal.objects.raw.FormObject
FormObject(String, boolean) - Constructor for class org.jpedal.objects.raw.FormObject
FormObject(String, int) - Constructor for class org.jpedal.objects.raw.FormObject
FormsActionHandler - Static variable in class org.jpedal.external.Options: allows user to replace whole forms action Handling code - needs to implement ActionHandler It is recommended you look at Options.ExpressionEngine and Options.LinkHandler for most purposes
FormWriter - Class in org.jpedal.io.annotation: Utility class with static methods to all the writing of forms to a PDF
FORWARD - Enum constant in enum class org.jpedal.examples.viewer.ViewerCommands
FORWARD - Static variable in class org.jpedal.examples.viewer.Commands
FORWARDPAGE - Enum constant in enum class org.jpedal.examples.viewer.ViewerCommands
FORWARDPAGE - Static variable in class org.jpedal.examples.viewer.Commands
FREETEXT - Enum constant in enum class org.jpedal.io.annotation.WritableAnnotation.AnnotationType
FreeTextAnnotation - Class in org.jpedal.io.annotation: Class generates Free Text Annotation
FreeTextAnnotation(int, float, float, float, float, String) - Constructor for class org.jpedal.io.annotation.FreeTextAnnotation: Constructor for creating Freetext Annotation
FreeTextAnnotation(int, float, float, float, float, FormObject) - Constructor for class org.jpedal.io.annotation.FreeTextAnnotation: Constructor for creating Freetext Annotation
FULL_OFF_SCREEN_RENDERING - Static variable in class org.jpedal.constants.JPedalSettings: For use with Viewer, this key will allow JPedal to render the full page off-screen to improve performance of off-screen rendering but increases memory consumption.
FULLSCREEN - Enum constant in enum class org.jpedal.examples.viewer.ViewerCommands
FULLSCREEN - Static variable in class org.jpedal.examples.viewer.Commands

G

generate() - Method in class org.jpedal.io.outline.OutlineWriter

generateBorderfromForm(FormObject, float) - Method in interface org.jpedal.objects.acroforms.creation.FormFactory

generateColor(float[]) - Static method in class org.jpedal.objects.raw.FormObject

takes a value and turns it into the color it represents, e.g. (0.5) represents gray (127,127,127) grey = array length 1, with one value rgb = array length 3, in the order of red,green,blue cmyk = array length 4, in the reverse order, (ie. k, y, m, c)

getActionFlag() - Method in class org.jpedal.objects.raw.FormObject

get status found during decode

getAlignment() - Method in class org.jpedal.objects.raw.FormObject

getAllFontDataForDocument() - Method in class org.jpedal.examples.PdfUtilities

getAllHighlights() - Method in class org.jpedal.text.TextLines

Get all the highlights currently stored.

getAPString(int) - Method in class org.jpedal.io.annotation.CircleAnnotation

getAPString(int) - Method in class org.jpedal.io.annotation.FreeTextAnnotation

getAPString(int) - Method in class org.jpedal.io.annotation.HighlightAnnotation

getAPString(int) - Method in class org.jpedal.io.annotation.ImageAnnotation

getAPString(int) - Method in class org.jpedal.io.annotation.InkAnnotation

getAPString(int) - Method in class org.jpedal.io.annotation.LineAnnotation

getAPString(int) - Method in class org.jpedal.io.annotation.PolygonAnnotation

getAPString(int) - Method in class org.jpedal.io.annotation.PolyLineAnnotation

getAPString(int) - Method in class org.jpedal.io.annotation.SquareAnnotation

getAPString(int) - Method in class org.jpedal.io.annotation.TextAnnotation

getAPString(int) - Method in class org.jpedal.io.annotation.WritableAnnotation

getBackgroundGroupingObject() - Method in class org.jpedal.PdfDecoder

returns object containing grouped text from background grouping - Please see org.jpedal.examples.text for example code

getBackgroundGroupingObject() - Method in interface org.jpedal.PdfDecoderInt

returns object containing grouped text from background grouping - Please see org.jpedal.examples.text for example code

getBackgroundGroupingObject() - Method in class org.jpedal.PdfDecoderServer

returns object containing grouped text from background grouping - Please see org.jpedal.examples.text for example code

getBoolean(int) - Method in class org.jpedal.objects.raw.FormObject

getBounding2DRectangleForTabbing() - Method in class org.jpedal.objects.raw.FormObject

This method should be called only in tabbing functionality

getBoundingRectangle() - Method in class org.jpedal.objects.raw.FormObject

return the bounding rectangle for this object

getCharacteristics() - Method in class org.jpedal.objects.raw.FormObject

getChoiceOptions() - Method in class org.jpedal.objects.raw.FormObject

Get the available choice options for this choice field

getClippedImage(int, int) - Method in class org.jpedal.examples.images.ExtractClippedImages

extract any image from any page - recommended you process images on each page in turn as quicker

getCommandCountForPageStream(int) - Method in class org.jpedal.examples.PdfUtilities


     PdfUtilities pdfUtils=new PdfUtilities("C:/pdfs/mypdf.pdf");
     // pdfUtils.setPassword("password");
     if (pdfUtils.openPDFFile()) {
         int commandsOnPage=pdfUtils.getCommandCountForPageStream();
     }
     pdfUtils.closePDFfile();

getCompressionFormat() - Method in class com.idrsolutions.image.png.options.PngEncoderOptions

getCompressionFormat() - Method in class com.idrsolutions.image.tiff.options.TiffEncoderOptions

getCompressionFormat() - Method in class com.idrsolutions.image.webp.options.WebpEncoderOptions

getCurrentPrintPage() - Method in class org.jpedal.PdfDecoder

return page currently being printed or -1 if finished

getCurrentScaling() - Method in class org.jpedal.objects.raw.FormObject

getCustomCompData() - Method in interface org.jpedal.objects.acroforms.creation.FormFactory

return new instance of GUIData implementation to support component set

getDecoderOptions() - Method in class org.jpedal.PdfDecoder

Return decoder options as object for cases where value is needed externally and can't be static

getDecoderOptions() - Method in interface org.jpedal.PdfDecoderInt

getDecoderOptions() - Method in class org.jpedal.PdfDecoderServer

Return decoder options as object for cases where value is needed externally and can't be static

getDefaultFieldValue() - Method in class org.jpedal.objects.raw.FormObject

Get the first element of the default fieldValues
for when the field only expects a single value

getDefaultFieldValues() - Method in class org.jpedal.objects.raw.FormObject

Get the default Field Values
For when the field can have multiple values

getDictionary(int) - Method in class org.jpedal.objects.raw.FormObject

getDictString() - Method in class org.jpedal.io.annotation.CircleAnnotation

getDictString() - Method in class org.jpedal.io.annotation.FreeTextAnnotation

getDictString() - Method in class org.jpedal.io.annotation.HighlightAnnotation

getDictString() - Method in class org.jpedal.io.annotation.ImageAnnotation

getDictString() - Method in class org.jpedal.io.annotation.InkAnnotation

getDictString() - Method in class org.jpedal.io.annotation.LineAnnotation

getDictString() - Method in class org.jpedal.io.annotation.LinkAnnotation

getDictString() - Method in class org.jpedal.io.annotation.PolygonAnnotation

getDictString() - Method in class org.jpedal.io.annotation.PolyLineAnnotation

getDictString() - Method in class org.jpedal.io.annotation.SquareAnnotation

getDictString() - Method in class org.jpedal.io.annotation.TextAnnotation

getDictString() - Method in class org.jpedal.io.annotation.WritableAnnotation

getDisplayOffsets() - Method in class org.jpedal.PdfDecoder

getDisplayOffsets() - Method in interface org.jpedal.PdfDecoderInt

getDisplayOffsets() - Method in class org.jpedal.PdfDecoderServer

getDisplayRotation() - Method in class org.jpedal.PdfDecoder

current page rotation (in addition to rotation in file) in degrees So if user turns page by 90 degrees, value will be 90

getDisplayRotation() - Method in interface org.jpedal.PdfDecoderInt

getDisplayRotation() - Method in class org.jpedal.PdfDecoderServer

current page rotation (in addition to rotation in file) in degrees So if user turns page by 90 degrees, value will be 90

getDisplayView() - Method in class org.jpedal.PdfDecoder

returns view mode used - ie SINGLE_PAGE,CONTINUOUS,FACING,CONTINUOUS_FACING (no effect in OS versions)

getDisplayView() - Method in interface org.jpedal.PdfDecoderInt

getDisplayView() - Method in class org.jpedal.PdfDecoderServer

returns view mode used - ie SINGLE_PAGE,CONTINUOUS,FACING,CONTINUOUS_FACING (no effect in OS versions)

getDocumentPropertyFieldsInXML() - Method in class org.jpedal.examples.PdfUtilities

access the XML Document properties String (if present) from the open PDF file

getDocumentPropertyStringValuesAsMap() - Method in class org.jpedal.examples.PdfUtilities

return a Map containing the pair value properties (if present) from the open PDF file -

getDPIFactory() - Method in class org.jpedal.PdfDecoder

return handle on PDFFactory which adjusts display size so matches size in Acrobat

getDPIFactory() - Method in interface org.jpedal.PdfDecoderInt

getDPIFactory() - Method in class org.jpedal.PdfDecoderServer

return handle on PDFFactory which adjusts display size so matches size in Acrobat

getDynamicRenderer() - Method in class org.jpedal.PdfDecoder

Not part of API - used internally

getDynamicRenderer() - Method in interface org.jpedal.PdfDecoderInt

getDynamicRenderer() - Method in class org.jpedal.PdfDecoderServer

Not part of API - used internally

getDynamicRenderer(boolean) - Method in class org.jpedal.PdfDecoder

Not part of API - used internally

getDynamicRenderer(boolean) - Method in interface org.jpedal.PdfDecoderInt

getDynamicRenderer(boolean) - Method in class org.jpedal.PdfDecoderServer

Not part of API - used internally

getEncoderOptions() - Method in class com.idrsolutions.image.bmp.BmpEncoder

getEncoderOptions() - Method in class com.idrsolutions.image.gif.GifEncoder

getEncoderOptions() - Method in class com.idrsolutions.image.heic.HeicEncoder

getEncoderOptions() - Method in class com.idrsolutions.image.jpeg.JpegEncoder

getEncoderOptions() - Method in class com.idrsolutions.image.jpeg2000.Jpeg2000Encoder

getEncoderOptions() - Method in class com.idrsolutions.image.png.PngEncoder

getEncoderOptions() - Method in class com.idrsolutions.image.tiff.TiffEncoder

getEncoderOptions() - Method in class com.idrsolutions.image.webp.WebpEncoder

getExportList() - Method in class org.jpedal.objects.raw.FormObject

Get the export values of the choice field

getExternalHandler() - Method in class org.jpedal.PdfDecoder

getExternalHandler() - Method in interface org.jpedal.PdfDecoderInt

getExternalHandler() - Method in class org.jpedal.PdfDecoderServer

getExternalHandler(int) - Method in class org.jpedal.PdfDecoder

not part of API used internally

getExternalHandler(int) - Method in interface org.jpedal.PdfDecoderInt

getExternalHandler(int) - Method in class org.jpedal.PdfDecoderServer

not part of API used internally

getFieldFlags() - Method in class org.jpedal.objects.raw.FormObject

returns the flags array (Ff in PDF) (indexs are the number listed)
* all
1=readonly - if set there is no interaction
2=required - if set the field must have a value when submit-form-action occures
3=noexport - if set the field must not be exported by a submit-form-action

Choice fields
18=combo - set its a combobox, else a list box
19=edit - defines a comboBox to be editable
20=sort - defines list to be sorted alphabetically
22=multiselect - if set more than one items can be selected, else only one
23=donotspellcheck - (only used on editable combobox) don't spell check
27=commitOnselchange - if set commit the action when selection changed, else commit when user exits field

text fields
13=multiline - uses multipul lines else uses a single line
14=password - a password is intended
21=fileselect -text in field represents a file pathname to be submitted
23=donotspellcheck - don't spell check
24=donotscroll - once the field is full don't enter anymore text.

getFieldValue() - Method in class org.jpedal.objects.raw.FormObject

Get the first element of the fieldValues
For when the field only expects a single value

getFieldValues() - Method in class org.jpedal.objects.raw.FormObject

Get the fieldValues
For when the field can have multiple values

getFileInformationData() - Method in class org.jpedal.PdfDecoder

method to return null or object giving access info fields and metadata.

getFileInformationData() - Method in interface org.jpedal.PdfDecoderInt

getFileInformationData() - Method in class org.jpedal.PdfDecoderServer

method to return null or object giving access info fields and metadata.

getFileName() - Method in class org.jpedal.PdfDecoder

currently open PDF file name

getFileName() - Method in interface org.jpedal.PdfDecoderInt

getFileName() - Method in class org.jpedal.PdfDecoderServer

currently open PDF file name

getFloat2DArray(int) - Method in class org.jpedal.objects.raw.FormObject

getFloatArray(int) - Method in class org.jpedal.objects.raw.FormObject

getFloatNumber(int) - Method in class org.jpedal.objects.raw.FormObject

getFontDataForPage(int) - Method in class org.jpedal.examples.PdfUtilities

return a String detailing the fonts from page

getFontName() - Method in class org.jpedal.objects.raw.FormObject

getFontSize() - Method in class org.jpedal.objects.raw.FormObject

Method to get the font size to be used in the form component This is currently only implemented for text pop-up forms

getFontSubstitutionMode() - Static method in class org.jpedal.fonts.FontMappings

set mode to use when substituting fonts (default is to use Filename (ie arial.ttf) Options are SUBSTITUTE_* values from PdfDecoder

getFormComponentsFromDocument(String, ReturnValues) - Method in class org.jpedal.examples.acroform.PdfFormUtilities

access the PDF FormObjects (if present) from the open PDF file and return Object values according to ReturnValues.

getFormComponentsFromPage(String, ReturnValues, int) - Method in class org.jpedal.examples.acroform.PdfFormUtilities

access the PDF FormObjects (if present) from the page of the open PDF file and return Object values according to ReturnValues.

getFormObject() - Method in class org.jpedal.io.annotation.WritableAnnotation

Returns the form object used to create this object or null is none were used.

getFormRenderer() - Method in class org.jpedal.PdfDecoder

Allow user to access Forms renderer object if needed

getFormRenderer() - Method in interface org.jpedal.PdfDecoderInt

getFormRenderer() - Method in class org.jpedal.PdfDecoderServer

Allow user to access Forms renderer object if needed

getFormType() - Method in class org.jpedal.objects.raw.FormObject

look at FormFactory.LIST etc for full list of types

getFormValue() - Method in class org.jpedal.objects.raw.FormObject

Get the current value of the form field

getGroupingObject() - Method in class org.jpedal.PdfDecoder

returns object containing grouped text of last decoded page - if no page decoded, a Runtime exception is thrown to warn user Please see org.jpedal.examples.text for example code.

getGroupingObject() - Method in interface org.jpedal.PdfDecoderInt

returns object containing grouped text of last decoded page - if no page decoded, a Runtime exception is thrown to warn user Please see org.jpedal.examples.text for example code.

getGroupingObject() - Method in class org.jpedal.PdfDecoderServer

returns object containing grouped text of last decoded page - if no page decoded, a Runtime exception is thrown to warn user Please see org.jpedal.examples.text for example code.

getGUIComponent() - Method in class org.jpedal.objects.raw.FormObject

getHighlightableInArea(int[], boolean, int) - Method in class org.jpedal.text.TextLines

getHighlightedAreasAs2DArray(int) - Method in class org.jpedal.text.TextLines

Creates a two-dimensional int array containing x,y,width and height values for each rectangle that is stored in the localAreas map, which allows us to create a swing/fx rectangle on these values.

getHiResUpscaleFactor() - Method in class org.jpedal.PdfDecoder

return scaleup factor applied to last Hires image of page generated

getHiResUpscaleFactor() - Method in interface org.jpedal.PdfDecoderInt

getHiResUpscaleFactor() - Method in class org.jpedal.PdfDecoderServer

return scaleup factor applied to last Hires image of page generated

getHTMLElementId() - Method in class org.jpedal.objects.raw.FormObject

getIFD(DataReader, int) - Static method in class com.idrsolutions.image.tiff.TiffDecoder

getImage(int, int, boolean) - Method in class org.jpedal.examples.images.ExtractImages

extract any image from any page - recommended you process images on each page in turn as quicker

getImageCount(byte[]) - Method in class com.idrsolutions.image.tiff.TiffDecoder

Returns the number of images in the Tiff data.

getImageCount(int) - Method in class org.jpedal.examples.images.ExtractClippedImages

returns an image count for the selected page

getImageCount(int) - Method in class org.jpedal.examples.images.ExtractImages

returns an image count for the selected page

getImageCount(File) - Method in class com.idrsolutions.image.tiff.TiffDecoder

Returns the number of images in the Tiff data.

getImageData(int) - Method in class org.jpedal.examples.images.ExtractImages

getImageInfo(byte[]) - Static method in class com.idrsolutions.image.JDeli

Returns Metadata object describing Image

getImageInfo(File) - Static method in class com.idrsolutions.image.JDeli

Returns Metadata object describing Image

getImageInfo(InputStream) - Static method in class com.idrsolutions.image.JDeli

Returns Metadata object describing Image

getInfo() - Method in class com.idrsolutions.image.jpeg2000.Jpeg2000Decoder

getInfo(int) - Method in class org.jpedal.PdfDecoder

Returns list of the fonts used on the current page decoded or null type can be PdfDictionary.Font or PdfDictionary.Image

getInfo(int) - Method in interface org.jpedal.PdfDecoderInt

getInfo(int) - Method in class org.jpedal.PdfDecoderServer

Returns list of the fonts used on the current page decoded or null type can be PdfDictionary.Font or PdfDictionary.Image

getInsetH() - Method in class org.jpedal.PdfDecoder

getInsetH() - Method in interface org.jpedal.PdfDecoderInt

Return amount to inset the page rectangle height by

getInsetH() - Method in class org.jpedal.PdfDecoderServer

getInsetW() - Method in class org.jpedal.PdfDecoder

getInsetW() - Method in interface org.jpedal.PdfDecoderInt

Return amount to inset the page rectangle width by

getInsetW() - Method in class org.jpedal.PdfDecoderServer

getInt(int) - Method in class org.jpedal.objects.raw.FormObject

getIntArray(int) - Method in class org.jpedal.objects.raw.FormObject

getIO() - Method in class org.jpedal.PdfDecoder

allow access to PDF file

getIO() - Method in interface org.jpedal.PdfDecoderInt

allow access to PDF file

getIO() - Method in class org.jpedal.PdfDecoderServer

allow access to PDF file

getItemsList() - Method in class org.jpedal.objects.raw.FormObject

Get the display values of the choice field

getJavaScript() - Method in class org.jpedal.PdfDecoder

Allow user to access javascript object if needed

getJavaScript() - Method in interface org.jpedal.PdfDecoderInt

getJavaScript() - Method in class org.jpedal.PdfDecoderServer

Allow user to access javascript object if needed

getJPedalObject(int) - Method in class org.jpedal.PdfDecoder

Not part of API - used internally

getJPedalObject(int) - Method in interface org.jpedal.PdfDecoderInt

getJPedalObject(int) - Method in class org.jpedal.PdfDecoderServer

Not part of API - used internally

getKeyArray(int) - Method in class org.jpedal.objects.raw.FormObject

getlastPageDecoded() - Method in class org.jpedal.PdfDecoder

return page number for last page decoded (only use in SingleDisplay mode)

getlastPageDecoded() - Method in interface org.jpedal.PdfDecoderInt

getlastPageDecoded() - Method in class org.jpedal.PdfDecoderServer

return page number for last page decoded (only use in SingleDisplay mode)

getLastValidValue() - Method in class org.jpedal.objects.raw.FormObject

used by JS to reset

getLayerHandler() - Method in interface org.jpedal.objects.acroforms.actions.ActionHandler

getLayerName() - Method in class org.jpedal.objects.raw.FormObject

getLineAreasAs2DArray(int) - Method in class org.jpedal.text.TextLines

Creates a two-dimensional int array containing x,y,width and height values for each rectangle that is stored in the localLineAreas map, which allows us to create a swing/fx rectangle on these values.

getLinkAtPageLocation(int, int, int) - Method in class org.jpedal.text.TextLines

getMarkedContent() - Method in class org.jpedal.PdfDecoder

return markedContent object as XML Document

getMarkedContent() - Method in interface org.jpedal.PdfDecoderInt

getMarkedContent() - Method in class org.jpedal.PdfDecoderServer

return markedContent object as XML Document

getMatteBorderDetails() - Method in class org.jpedal.objects.raw.FormObject

Method returns matte border details of Form (not all surrounding element)

getMaximumSize() - Method in class org.jpedal.PdfDecoder

get sizes of panel
This is the PDF pagesize (as set in the PDF from pagesize) - It now includes any scaling factor you have set (ie a PDF size 800 * 600 with a scaling factor of 2 will return 1600 *1200)

getMaxSizeWH() - Method in class org.jpedal.PdfDecoder

getMaxSizeWH() - Method in interface org.jpedal.PdfDecoderInt

getMaxSizeWH() - Method in class org.jpedal.PdfDecoderServer

getMessage() - Method in exception class org.jpedal.exception.PdfException

display the error message

getMinimumSize() - Method in class org.jpedal.PdfDecoder

get width of panel

getMixedArray(int) - Method in class org.jpedal.objects.raw.FormObject

getMouseMode() - Method in class org.jpedal.examples.viewer.Commands

getName(int) - Method in class org.jpedal.objects.raw.FormObject

getNameAsConstant(int) - Method in class org.jpedal.objects.raw.FormObject

getNonStrokeColor() - Method in class org.jpedal.io.annotation.WritableAnnotation

getNormalOnState() - Method in class org.jpedal.objects.raw.FormObject

getNumberOfPages() - Method in class org.jpedal.PdfDecoder

part of pageable interface - used only in printing Use getPageCount() for number of pages

getObjectArray(int) - Method in class org.jpedal.objects.raw.FormObject

getObjectStore() - Method in class org.jpedal.PdfDecoder

return object which provides access to file images and name

getObjectStore() - Method in interface org.jpedal.PdfDecoderInt

getObjectStore() - Method in class org.jpedal.PdfDecoderServer

return object which provides access to file images and name

getOpaqueImage() - Static method in class org.jpedal.objects.raw.FormObject

getoptimizedFileAsBytes() - Method in class org.jpedal.tools.PdfOptimizer

Create a new PDF from the result of the original final after any optimizations have been performed.

getOutlineAsXML() - Method in class org.jpedal.PdfDecoder

return a DOM document containing the PDF Outline object as a DOM Document - may return null

getOutlineAsXML() - Method in interface org.jpedal.PdfDecoderInt

getOutlineAsXML() - Method in class org.jpedal.PdfDecoderServer

return a DOM document containing the PDF Outline object as a DOM Document - may return null

getOutlineData() - Method in class org.jpedal.PdfDecoder

provide direct access to outlineData object

getOutlineData() - Method in interface org.jpedal.PdfDecoderInt

getOutlineData() - Method in class org.jpedal.PdfDecoderServer

provide direct access to outlineData object

getOutlinePanel() - Method in class org.jpedal.examples.viewer.Viewer

Get the outline panel.

GETOUTLINEPANEL - Static variable in class org.jpedal.examples.viewer.Commands

getOutputFormat() - Method in class com.idrsolutions.image.bmp.options.BmpEncoderOptions

getOutputFormat() - Method in class com.idrsolutions.image.gif.options.GifEncoderOptions

getOutputFormat() - Method in class com.idrsolutions.image.heic.options.HeicEncoderOptions

getOutputFormat() - Method in class com.idrsolutions.image.jpeg.options.JpegEncoderOptions

getOutputFormat() - Method in class com.idrsolutions.image.jpeg2000.options.Jpeg2000EncoderOptions

getOutputFormat() - Method in class com.idrsolutions.image.png.options.PngEncoderOptions

getOutputFormat() - Method in class com.idrsolutions.image.tiff.options.TiffEncoderOptions

getOutputFormat() - Method in class com.idrsolutions.image.webp.options.WebpEncoderOptions

getOutputSubtype() - Method in class com.idrsolutions.image.jpeg2000.options.Jpeg2000EncoderOptions

getPage() - Method in class org.jpedal.io.annotation.WritableAnnotation

getPageAlignment() - Method in class org.jpedal.PdfDecoder

return type of alignment for pages if smaller than panel - see options in Display class.

getPageAlignment() - Method in interface org.jpedal.PdfDecoderInt

getPageAlignment() - Method in class org.jpedal.PdfDecoderServer

return type of alignment for pages if smaller than panel - see options in Display class.

getPageAsHiRes(int) - Method in class org.jpedal.PdfDecoder

getPageAsHiRes(int) - Method in interface org.jpedal.PdfDecoderInt

getPageAsHiRes(int) - Method in class org.jpedal.PdfDecoderServer

getPageAsHiRes(int, boolean) - Method in class org.jpedal.PdfDecoder

getPageAsHiRes(int, boolean) - Method in interface org.jpedal.PdfDecoderInt

getPageAsHiRes(int, boolean) - Method in class org.jpedal.PdfDecoderServer

getPageAsHiRes(int, Map<Integer, Object>) - Method in class org.jpedal.PdfDecoder

getPageAsHiRes(int, Map<Integer, Object>) - Method in interface org.jpedal.PdfDecoderInt

getPageAsHiRes(int, Map<Integer, Object>) - Method in class org.jpedal.PdfDecoderServer

getPageAsHiRes(int, Map<Integer, Object>, boolean) - Method in class org.jpedal.PdfDecoder

getPageAsHiRes(int, Map<Integer, Object>, boolean) - Method in interface org.jpedal.PdfDecoderInt

getPageAsHiRes(int, Map<Integer, Object>, boolean) - Method in class org.jpedal.PdfDecoderServer

getPageAsHiResImage(int, boolean, Map<Integer, Object>) - Method in class org.jpedal.examples.images.ConvertPagesToHiResImages

getPageAsImage(int) - Method in class org.jpedal.examples.images.ConvertPagesToImages

getPageAsImage(int) - Method in class org.jpedal.PdfDecoder

generate BufferedImage of a page in current file

getPageAsImage(int) - Method in interface org.jpedal.PdfDecoderInt

getPageAsImage(int) - Method in class org.jpedal.PdfDecoderServer

generate BufferedImage of a page in current file

getPageAsImage(int, boolean) - Method in class org.jpedal.examples.images.ConvertPagesToImages

getPageAsImage(int, float) - Method in class org.jpedal.PdfDecoder

generate BufferedImage of a page in current file

getPageAsImage(int, float) - Method in interface org.jpedal.PdfDecoderInt

getPageAsImage(int, float) - Method in class org.jpedal.PdfDecoderServer

generate BufferedImage of a page in current file with the given scaling

getPageAsTransparentImage(int) - Method in class org.jpedal.PdfDecoder

generate BufferedImage of a page in current file

getPageAsTransparentImage(int) - Method in interface org.jpedal.PdfDecoderInt

getPageAsTransparentImage(int) - Method in class org.jpedal.PdfDecoderServer

generate BufferedImage of a page in current file

getPageCount() - Method in class com.idrsolutions.image.tiff.TiffDecoder

Returns the number of pages the tiff file contains.

getPageCount() - Method in class org.jpedal.examples.acroform.PdfFormUtilities