PdfDecoderFX (org.jpedal:OpenViewerFX 7.12.28 API)

java.lang.Object
- javafx.scene.Node
- - javafx.scene.Parent
  - - javafx.scene.layout.Region
    - - javafx.scene.layout.Pane
      - org.jpedal.PdfDecoderFX

All Implemented Interfaces:

Pageable, Printable, javafx.css.Styleable, javafx.event.EventTarget, PdfDecoderInt
```
public class PdfDecoderFX
extends javafx.scene.layout.Pane
implements Printable, Pageable, PdfDecoderInt
```
Provides an object to decode pdf files and provide a rasterizer if required - Normal usage is to create instance of PdfDecoder and access via public methods. Examples showing usage in org.jpedal.examples
We recommend you access JPedal using only public methods listed in API

Property Summary
- Properties inherited from class javafx.scene.layout.Region
  backgroundProperty, borderProperty, cacheShapeProperty, centerShapeProperty, heightProperty, insetsProperty, maxHeightProperty, maxWidthProperty, minHeightProperty, minWidthProperty, opaqueInsetsProperty, paddingProperty, prefHeightProperty, prefWidthProperty, scaleShapeProperty, shapeProperty, snapToPixelProperty, widthProperty
- Properties inherited from class javafx.scene.Parent
  impl_traversalEngineProperty, needsLayoutProperty
- Properties inherited from class javafx.scene.Node
  accessibleHelpProperty, accessibleRoleDescriptionProperty, accessibleRoleProperty, accessibleTextProperty, blendModeProperty, boundsInLocalProperty, boundsInParentProperty, cacheHintProperty, cacheProperty, clipProperty, cursorProperty, depthTestProperty, disabledProperty, disableProperty, effectiveNodeOrientationProperty, effectProperty, eventDispatcherProperty, focusedProperty, focusTraversableProperty, hoverProperty, idProperty, impl_showMnemonicsProperty, impl_treeVisibleProperty, inputMethodRequestsProperty, layoutBoundsProperty, layoutXProperty, layoutYProperty, localToParentTransformProperty, localToSceneTransformProperty, managedProperty, mouseTransparentProperty, nodeOrientationProperty, onContextMenuRequestedProperty, onDragDetectedProperty, onDragDoneProperty, onDragDroppedProperty, onDragEnteredProperty, onDragExitedProperty, onDragOverProperty, onInputMethodTextChangedProperty, onKeyPressedProperty, onKeyReleasedProperty, onKeyTypedProperty, onMouseClickedProperty, onMouseDragEnteredProperty, onMouseDragExitedProperty, onMouseDraggedProperty, onMouseDragOverProperty, onMouseDragReleasedProperty, onMouseEnteredProperty, onMouseExitedProperty, onMouseMovedProperty, onMousePressedProperty, onMouseReleasedProperty, onRotateProperty, onRotationFinishedProperty, onRotationStartedProperty, onScrollFinishedProperty, onScrollProperty, onScrollStartedProperty, onSwipeDownProperty, onSwipeLeftProperty, onSwipeRightProperty, onSwipeUpProperty, onTouchMovedProperty, onTouchPressedProperty, onTouchReleasedProperty, onTouchStationaryProperty, onZoomFinishedProperty, onZoomProperty, onZoomStartedProperty, opacityProperty, parentProperty, pickOnBoundsProperty, pressedProperty, rotateProperty, rotationAxisProperty, scaleXProperty, scaleYProperty, scaleZProperty, sceneProperty, styleProperty, translateXProperty, translateYProperty, translateZProperty, visibleProperty

Field Summary

Fields
Modifier and Type	Field and Description
`javafx.scene.layout.Pane`	`highlightsPane`
`protected Border`	`myBorder` border for component
`Display`	`pages`
`protected int`	`specialMode`
`boolean`	`useNewGraphicsMode`

Fields inherited from class javafx.scene.layout.Region
USE_COMPUTED_SIZE, USE_PREF_SIZE

Fields inherited from class javafx.scene.Node
BASELINE_OFFSET_SAME_AS_HEIGHT

Fields inherited from interface java.awt.print.Printable
NO_SUCH_PAGE, PAGE_EXISTS

Fields inherited from interface java.awt.print.Pageable
UNKNOWN_NUMBER_OF_PAGES

Constructor Summary

Constructors
Constructor and Description
`PdfDecoderFX()` Recommend way to create a PdfDecoder for renderer only viewer (not recommended for server extraction only processes)
`PdfDecoderFX(boolean newRender)` Recommend way to create a PdfDecoder if no rendering of page may be required Otherwise use PdfDecoder()

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addExternalHandler(Object newHandler, int type)` not part of API used internally
`void`	`clearScreen()` remove all displayed objects for JPanel display (wipes current page)
`void`	`closePdfFile()` convenience method to close the current PDF file and release all resources/delete any temporary files
`void`	`decodePage(int rawPage)` decode a page, - page must be between 1 and PdfDecoder.getPageCount() - Will kill off if already running
`void`	`decodePageInBackground(int i)` decode a page as a background thread (use other background methods to access data)
`void`	`dispose()` 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()
`static void`	`disposeAllStatic()` remove all static elements - only do once completely finished with JPedal as will not be reinitialised
`void`	`drawAdditionalObjectsOverPage(int page, int[] type, Color[] colors, Object[] obj)` 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
`void`	`flushAdditionalObjectsOnPage(int page)` allow user to remove all additional graphical content from the page (only for display) ONLY works in SINGLE VIEW displaymode
`void`	`flushObjectValues(boolean reinit)` provide method for outside class to clear store of objects once written out to reclaim memory
`PdfGroupingAlgorithms`	`getBackgroundGroupingObject()` returns object containing grouped text from background grouping - Please see org.jpedal.examples.text for example code
`static int`	`getCurrentPrintPage()` return page currently being printed or -1 if finished
`DecoderOptions`	`getDecoderOptions()` Return decoder options as object for cases where value is needed externally and can't be static
`DisplayOffsets`	`getDisplayOffsets()`
`int`	`getDisplayRotation()` current page rotation (in addition to rotation in file) in degrees So if user turns page by 90 degrees, value will be 90
`int`	`getDisplayView()` returns view mode used - ie SINGLE_PAGE,CONTINUOUS,FACING,CONTINUOUS_FACING (no effect in OS versions)
`DPIFactory`	`getDPIFactory()` return handle on PDFFactory which adjusts display size so matches size in Acrobat
`DynamicVectorRenderer`	`getDynamicRenderer()` Not part of API - used internally
`DynamicVectorRenderer`	`getDynamicRenderer(boolean reset)` Not part of API - used internally
`ExternalHandlers`	`getExternalHandler()`
`Object`	`getExternalHandler(int type)` not part of API used internally
`PdfFileInformation`	`getFileInformationData()` method to return null or object giving access info fields and metadata.
`String`	`getFileName()` currently open PDF file name
`AcroRenderer`	`getFormRenderer()` Allow user to access Forms renderer object if needed
`PdfGroupingAlgorithms`	`getGroupingObject()` 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.
`float`	`getHiResUpscaleFactor()` return scaleup factor applied to last Hires image of page generated negative values mean no upscaling applied and should be ignored
`String`	`getInfo(int type)` Returns list of the fonts used on the current page decoded or null type can be PdfDictionary.Font or PdfDictionary.Image
`int`	`getInsetH()` Return amount to inset the page rectangle height by
`int`	`getInsetW()` Return amount to inset the page rectangle width by
`PdfObjectReader`	`getIO()` allow access to PDF file
`Javascript`	`getJavaScript()` Allow user to access javascript object if needed
`Object`	`getJPedalObject(int id)` Not part of API - used internally
`int`	`getlastPageDecoded()` return page number for last page decoded (only use in SingleDisplay mode)
`Document`	`getMarkedContent()` return markedContent object as XML Document
`int[]`	`getMaximumSize()` 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)
`int[]`	`getMaxSizeWH()`
`int`	`getNumberOfPages()` part of pageable interface - used only in printing Use getPageCount() for number of pages
`ObjectStore`	`getObjectStore()` return object which provides access to file images and name
`Document`	`getOutlineAsXML()` return a DOM document containing the PDF Outline object as a DOM Document - may return null
`OutlineData`	`getOutlineData()` provide direct access to outlineData object
`int`	`getPageAlignment()` return type of alignment for pages if smaller than panel - see options in Display class.
`BufferedImage`	`getPageAsHiRes(int pageIndex)`
`BufferedImage`	`getPageAsHiRes(int pageIndex, boolean isTransparent)`
`BufferedImage`	`getPageAsHiRes(int pageIndex, Map params)`
`BufferedImage`	`getPageAsHiRes(int pageIndex, Map params, boolean isTransparent)`
`BufferedImage`	`getPageAsImage(int pageIndex)` generate BufferedImage of a page in current file
`BufferedImage`	`getPageAsImage(int pageIndex, float scaling)` generate BufferedImage of a page in current file with the given scaling
`BufferedImage`	`getPageAsTransparentImage(int pageIndex)` generate BufferedImage of a page in current file
`int`	`getPageCount()` get page count of current PDF file
`String`	`getPageDecodeReport()` return any errors or other messages while calling decodePage() - zero length is no problems
`boolean`	`getPageDecodeStatus(int status)` returns booleans based on flags in class org.jpedal.parser.DecoderStatus
`String`	`getPageDecodeStatusReport(int status)` get page statuses (flags in class org.jpedal.parser.DecoderStatus)
`static String`	`getPageFailureMessage()` Return String with all error messages from last printed (useful for debugging)
`PageFormat`	`getPageFormat(int p)` part of pageable interface
`int`	`getPageFromObjectRef(String ref)` given a ref, what is the page
`Iterator`	`getPageInfo(int type)` return details on page for type (defined in org.jpedal.constants.PageInfo) or null if no values Unrecognised key will throw a RunTime exception
`int`	`getPageNumber()` current logical page number
`Display`	`getPages()`
`int[]`	`getPaneBounds()`
`PdfData`	`getPdfBackgroundData()` NOT PART OF API
`PdfImageData`	`getPdfBackgroundImageData()` provide method for outside class to get data object containing images.
`PdfData`	`getPdfData()` Access should not generally be required to this class but used in examples.
`int`	`getPDFHeight()` get sizes of panel - This is the PDF pagesize
`PdfImageData`	`getPdfImageData()` provide method for outside class to get data object containing images
`PdfPageData`	`getPdfPageData()` Provides method for outside class to get data object containing information on the page for calculating grouping Please note: Structure of PdfPageData is not guaranteed to remain constant.
`String`	`getPDFVersion()` get PDF version in file
`int`	`getPDFWidth()` 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
`Printable`	`getPrintable(int page)` part of pageable interface
`protected PdfResources`	`getRes()`
`float`	`getScaling()` returns current scaling value used internally
`int`	`getScrollInterval()` return amount to scroll window by when scrolling (default is 10)
`BufferedImage`	`getSelectedRectangleOnscreen(float t_x1, float t_y1, float t_x2, float t_y2, float scaling)` If running in GUI mode, will extract a section of rendered page as BufferedImage -coordinates are PDF co-ordinates.
`int`	`getSpecialMode()`
`TextLines`	`getTextLines()` access textlines object
`int`	`getTextPrint()`
`Point`	`getUserOffsets(int mode)` not part of API used internally
`Rectangle`	`getVisibleRect()`
`boolean`	`hasAllImages()` flag to show if we suspect problem with some images
`boolean`	`hasEmbeddedFonts()` shows if embedded fonts present on page just decoded
`boolean`	`hasOutline()` flag to show if PDF document contains an outline
`static void`	`init(boolean newEmbedWidthData)` This will be needed for text extraction and set to true as paramter makes sure widths included in text stream
`boolean`	`isBorderPresent()`
`boolean`	`isEncrypted()` return true if the current pdf file is encrypted check isFileViewable(), if file is encrypted and not viewable - a user specified password is needed.
`boolean`	`isExtractionAllowed()` show if content can be extracted
`boolean`	`isFileViewable()` show if encrypted file can be viewed, if false a password needs entering
`boolean`	`isForm()` return true if currently open PDF file is a PDF form
`boolean`	`isLoadingLinearizedPDF()` track if file still loaded in background
`boolean`	`isOpen()` see if the file is open - may not be if the user interrupted open or encountered a problem
`boolean`	`isPageAvailable(int rawPage)` see if page available if in Linearized mode or return true
`static boolean`	`isPageSuccessful()` shows if page reported any errors while printing.
`boolean`	`isPasswordSupplied()` show if encryption password has been supplied or set a certificate
`boolean`	`isXMLExtraction()` shows if text extraction is XML or pure text
`static void`	`modifyJPedalParameters(Map values)` allow user to alter certain values in software such as Colour,
`void`	`modifyNonstaticJPedalParameters(Map values)` allow user to alter certain values in software such as Colour,
`void`	`openPdfArray(byte[] data)` routine to open a byte stream containing the PDF file and extract key info from pdf file so we can decode any pages.
`void`	`openPdfArray(byte[] data, String password)` routine to open a byte stream containing the PDF file and extract key info from pdf file so we can decode any pages.
`void`	`openPdfFile(String filename)` routine to open PDF file and extract key info from pdf file so we can decode any pages.
`void`	`openPdfFile(String filename, Certificate certificate, PrivateKey key)` allow user to open file using Certificate and key
`void`	`openPdfFile(String filename, String password)` routine to open PDF file and extract key info from pdf file so we can decode any pages which also sets password.
`boolean`	`openPdfFileFromInputStream(InputStream is, boolean supportLinearized)` routine to open PDF file via InputStream and extract key info from pdf file so we can decode any pages - Does not actually decode the pages themselves - You must explicitly close any open files with closePdfFile() to Java will not release all the memory
`boolean`	`openPdfFileFromInputStream(InputStream is, boolean supportLinearized, String password)` routine to open PDF file via InputStream and extract key info from pdf file so we can decode any pages - Does not actually decode the pages themselves - You must explicitly close any open files with closePdfFile() to Java will not release all the memory
`void`	`openPdfFileFromStream(Object filename, String password)` routine to open PDF file and extract key info from pdf file so we can decode any pages which also sets password.
`boolean`	`openPdfFileFromURL(String pdfUrl, boolean supportLinearized)` routine to open PDF file via URL and extract key info from pdf file so we can decode any pages - Does not actually decode the pages themselves - Also reads the form data - Based on an idea by Peter Jacobsen You must explicitly close any open files with closePdfFile() so Java will release all the memory
`boolean`	`openPdfFileFromURL(String pdfUrl, boolean supportLinearized, String password)` routine to open PDF file via URL and extract key info from pdf file so we can decode any pages - Does not actually decode the pages themselves - Also reads the form data - Based on an idea by Peter Jacobsen You must explicitly close any open files with closePdfFile() so Java will release all the memory
`int`	`print(Graphics graphics, PageFormat pageFormat, int page)` Implements the standard Java printing functionality.
`void`	`repaint()`
`void`	`repaintPane(int page)`
`void`	`resetCurrentPrintPage()`
`void`	`resetForNonPDFPage(int pageCount)` used for non-PDF files to reset page
`void`	`resetViewableArea()` NOT PART OF API turns off the viewable area, scaling the page back to original scaling
`void`	`scrollRectToVisible(Rectangle rectangle)`
`void`	`setBorderPresent(boolean borderPresent)`
`void`	`setDefaultCursor(javafx.scene.Cursor c)` When changing the mouse mode we call this method to set the mouse mode default cursor
`void`	`setDisplayRotation(int newRotation)`
`void`	`setEncryptionPassword(String password)` set a password for encryption - software will resolve if user or owner password- calls verifyAccess() from 2.74 so no separate call needed
`void`	`setExtractionMode(int mode)` set extraction mode telling JPedal what to extract - (TEXT,RAWIMAGES,FINALIMAGES - add together to combine) - See org.jpedal.examples for specific extraction examples
`void`	`setExtractionMode(int mode, float scaling)` Please do not use for general usage.
`void`	`setHardwareAccelerationforScreen(boolean useAcceleration)` Enables/Disables hardware acceleration of screen rendering (default is on)
`void`	`setInset(int width, int height)` set an inset display so that display will not touch edge of panel
`void`	`setObjectStore(ObjectStore newStore)` return object which provides access to file images and name (use not recommended)
`void`	`setPageDisplayMode(int pageDisplayMode)` NOT PART OF API
`void`	`setPageMode(int mode)` Not part of API - used internally
`void`	`setPageNumber(int newPage)`
`void`	`setPageParameters(float scaling, int pageNumber)` initialise panel and set size to fit PDF page intializes display with rotation set to the default, specified in the PDF document scaling value of -1 means keep existing setting
`void`	`setPageParameters(float scaling, int pageNumber, int newRotation)` calls setPageParameters(scaling,pageNumber) after setting rotation to draw page
`void`	`setPDFBorder(Border newBorder)` set border for screen and print which will be displayed Setting a new value will enable screen and border painting - disable with disableBorderForPrinting()
`void`	`setPreviewThumbnail(BufferedImage previewImage, String previewText)` internal method used by Viewer to provide preview of PDF in Viewer
`void`	`setRenderMode(int mode)` set render mode to state what is displayed onscreen (ie RENDERTEXT,RENDERIMAGES) - only generally required if you do not wish to show all objects on screen (default is all).
`void`	`setScaling(float x)`
`void`	`setScrollInterval(int scrollInterval)` set amount to scroll window by when scrolling
`void`	`setStatusBarObject(StatusBar statusBar)` Not part of API - used internally
`void`	`setStreamCacheSize(int size)` allows user to cache large objects to disk to avoid memory issues, setting minimum size in bytes (of uncompressed stream) above which object will be stored on disk if possible (default is -1 bytes which is all objects stored in memory) - Must be set before file opened.
`void`	`setUserOffsets(int x, int y, int mode)` not part of API used internally allow user to 'move' display of PDF mode is a Constant in org.jpedal.external.OffsetOptions (ie OffsetOptions.SWING_DISPLAY,OffsetOptions.PRINTING)
`void`	`updateCursorBoxOnScreen(int[] rectParams, int outlineColor)` update rectangle we draw to highlight an area - See Viewer example for example code showing current usage.
`boolean`	`useNewGraphicsMode()`
`void`	`useNewGraphicsMode(boolean b)`
`void`	`useTextExtraction()` XML extraction is the default - pure text extraction is much faster
`void`	`useXMLExtraction()` XML extraction is the default - pure text extraction is much faster
`void`	`waitForDecodingToFinish()` wait for decoding to finish

Methods inherited from class javafx.scene.layout.Pane
getChildren

Methods inherited from class javafx.scene.layout.Region
backgroundProperty, borderProperty, cacheShapeProperty, centerShapeProperty, computeMaxHeight, computeMaxWidth, computeMinHeight, computeMinWidth, computePrefHeight, computePrefWidth, getBackground, getBorder, getClassCssMetaData, getCssMetaData, getHeight, getInsets, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getOpaqueInsets, getPadding, getPrefHeight, getPrefWidth, getShape, getUserAgentStylesheet, getWidth, heightProperty, impl_computeContains, impl_computeGeomBounds, impl_computeLayoutBounds, impl_createPeer, impl_notifyLayoutBoundsChanged, impl_pickNodeLocal, impl_updatePeer, insetsProperty, isCacheShape, isCenterShape, isResizable, isScaleShape, isSnapToPixel, layoutInArea, layoutInArea, layoutInArea, layoutInArea, maxHeight, maxHeightProperty, maxWidth, maxWidthProperty, minHeight, minHeightProperty, minWidth, minWidthProperty, opaqueInsetsProperty, paddingProperty, positionInArea, positionInArea, prefHeight, prefHeightProperty, prefWidth, prefWidthProperty, resize, scaleShapeProperty, setBackground, setBorder, setCacheShape, setCenterShape, setHeight, setMaxHeight, setMaxSize, setMaxWidth, setMinHeight, setMinSize, setMinWidth, setOpaqueInsets, setPadding, setPrefHeight, setPrefSize, setPrefWidth, setScaleShape, setShape, setSnapToPixel, setWidth, shapeProperty, snappedBottomInset, snappedLeftInset, snappedRightInset, snappedTopInset, snapPosition, snapSize, snapSpace, snapToPixelProperty, widthProperty

Methods inherited from class javafx.scene.Parent
getBaselineOffset, getChildrenUnmodifiable, getImpl_traversalEngine, getManagedChildren, getStylesheets, impl_getAllParentStylesheets, impl_processCSS, impl_processMXNode, impl_traversalEngineProperty, isNeedsLayout, layout, layoutChildren, lookup, needsLayoutProperty, queryAccessibleAttribute, requestLayout, requestParentLayout, setImpl_traversalEngine, setNeedsLayout, updateBounds

Methods inherited from class javafx.scene.Node
accessibleHelpProperty, accessibleRoleDescriptionProperty, accessibleRoleProperty, accessibleTextProperty, addEventFilter, addEventHandler, applyCss, autosize, blendModeProperty, boundsInLocalProperty, boundsInParentProperty, buildEventDispatchChain, cacheHintProperty, cacheProperty, clipProperty, computeAreaInScreen, contains, contains, containsBounds, cursorProperty, depthTestProperty, disabledProperty, disableProperty, effectiveNodeOrientationProperty, effectProperty, eventDispatcherProperty, executeAccessibleAction, fireEvent, focusedProperty, focusTraversableProperty, getAccessibleHelp, getAccessibleRole, getAccessibleRoleDescription, getAccessibleText, getBlendMode, getBoundsInLocal, getBoundsInParent, getCacheHint, getClip, getContentBias, getCursor, getDepthTest, getEffect, getEffectiveNodeOrientation, getEventDispatcher, getId, getInputMethodRequests, getLayoutBounds, getLayoutX, getLayoutY, getLocalToParentTransform, getLocalToSceneTransform, getNodeOrientation, getOnContextMenuRequested, getOnDragDetected, getOnDragDone, getOnDragDropped, getOnDragEntered, getOnDragExited, getOnDragOver, getOnInputMethodTextChanged, getOnKeyPressed, getOnKeyReleased, getOnKeyTyped, getOnMouseClicked, getOnMouseDragEntered, getOnMouseDragExited, getOnMouseDragged, getOnMouseDragOver, getOnMouseDragReleased, getOnMouseEntered, getOnMouseExited, getOnMouseMoved, getOnMousePressed, getOnMouseReleased, getOnRotate, getOnRotationFinished, getOnRotationStarted, getOnScroll, getOnScrollFinished, getOnScrollStarted, getOnSwipeDown, getOnSwipeLeft, getOnSwipeRight, getOnSwipeUp, getOnTouchMoved, getOnTouchPressed, getOnTouchReleased, getOnTouchStationary, getOnZoom, getOnZoomFinished, getOnZoomStarted, getOpacity, getParent, getProperties, getPseudoClassStates, getRotate, getRotationAxis, getScaleX, getScaleY, getScaleZ, getScene, getStyle, getStyleableParent, getStyleClass, getTransforms, getTranslateX, getTranslateY, getTranslateZ, getTypeSelector, getUserData, hasProperties, hoverProperty, idProperty, impl_clearDirty, impl_computeIntersects, impl_cssGetCursorInitialValue, impl_cssGetFocusTraversableInitialValue, impl_findStyles, impl_geomChanged, impl_getLeafTransform, impl_getMatchingStyles, impl_getPeer, impl_getPivotX, impl_getPivotY, impl_getPivotZ, impl_getStyleMap, impl_hasTransforms, impl_intersects, impl_intersectsBounds, impl_isDirty, impl_isDirtyEmpty, impl_isShowMnemonics, impl_isTreeVisible, impl_layoutBoundsChanged, impl_markDirty, impl_pickNode, impl_processCSS, impl_reapplyCSS, impl_setShowMnemonics, impl_setStyleMap, impl_showMnemonicsProperty, impl_syncPeer, impl_transformsChanged, impl_traverse, impl_treeVisibleProperty, inputMethodRequestsProperty, intersects, intersects, isCache, isDisable, isDisabled, isFocused, isFocusTraversable, isHover, isManaged, isMouseTransparent, isPickOnBounds, isPressed, isVisible, layoutBoundsProperty, layoutXProperty, layoutYProperty, localToParent, localToParent, localToParent, localToParent, localToParent, localToParentTransformProperty, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToSceneTransformProperty, localToScreen, localToScreen, localToScreen, localToScreen, localToScreen, lookupAll, managedProperty, mouseTransparentProperty, nodeOrientationProperty, notifyAccessibleAttributeChanged, onContextMenuRequestedProperty, onDragDetectedProperty, onDragDoneProperty, onDragDroppedProperty, onDragEnteredProperty, onDragExitedProperty, onDragOverProperty, onInputMethodTextChangedProperty, onKeyPressedProperty, onKeyReleasedProperty, onKeyTypedProperty, onMouseClickedProperty, onMouseDragEnteredProperty, onMouseDragExitedProperty, onMouseDraggedProperty, onMouseDragOverProperty, onMouseDragReleasedProperty, onMouseEnteredProperty, onMouseExitedProperty, onMouseMovedProperty, onMousePressedProperty, onMouseReleasedProperty, onRotateProperty, onRotationFinishedProperty, onRotationStartedProperty, onScrollFinishedProperty, onScrollProperty, onScrollStartedProperty, onSwipeDownProperty, onSwipeLeftProperty, onSwipeRightProperty, onSwipeUpProperty, onTouchMovedProperty, onTouchPressedProperty, onTouchReleasedProperty, onTouchStationaryProperty, onZoomFinishedProperty, onZoomProperty, onZoomStartedProperty, opacityProperty, parentProperty, parentToLocal, parentToLocal, parentToLocal, parentToLocal, parentToLocal, pickOnBoundsProperty, pressedProperty, pseudoClassStateChanged, relocate, removeEventFilter, removeEventHandler, requestFocus, resizeRelocate, rotateProperty, rotationAxisProperty, scaleXProperty, scaleYProperty, scaleZProperty, sceneProperty, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, screenToLocal, screenToLocal, screenToLocal, setAccessibleHelp, setAccessibleRole, setAccessibleRoleDescription, setAccessibleText, setBlendMode, setCache, setCacheHint, setClip, setCursor, setDepthTest, setDisable, setDisabled, setEffect, setEventDispatcher, setEventHandler, setFocused, setFocusTraversable, setHover, setId, setInputMethodRequests, setLayoutX, setLayoutY, setManaged, setMouseTransparent, setNodeOrientation, setOnContextMenuRequested, setOnDragDetected, setOnDragDone, setOnDragDropped, setOnDragEntered, setOnDragExited, setOnDragOver, setOnInputMethodTextChanged, setOnKeyPressed, setOnKeyReleased, setOnKeyTyped, setOnMouseClicked, setOnMouseDragEntered, setOnMouseDragExited, setOnMouseDragged, setOnMouseDragOver, setOnMouseDragReleased, setOnMouseEntered, setOnMouseExited, setOnMouseMoved, setOnMousePressed, setOnMouseReleased, setOnRotate, setOnRotationFinished, setOnRotationStarted, setOnScroll, setOnScrollFinished, setOnScrollStarted, setOnSwipeDown, setOnSwipeLeft, setOnSwipeRight, setOnSwipeUp, setOnTouchMoved, setOnTouchPressed, setOnTouchReleased, setOnTouchStationary, setOnZoom, setOnZoomFinished, setOnZoomStarted, setOpacity, setPickOnBounds, setPressed, setRotate, setRotationAxis, setScaleX, setScaleY, setScaleZ, setStyle, setTranslateX, setTranslateY, setTranslateZ, setUserData, setVisible, snapshot, snapshot, startDragAndDrop, startFullDrag, styleProperty, toBack, toFront, toString, translateXProperty, translateYProperty, translateZProperty, usesMirroring, visibleProperty

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.jpedal.PdfDecoderInt
requestFocus

- Field Detail
  - useNewGraphicsMode
```
public boolean useNewGraphicsMode
```
  - pages
```
public Display pages
```
  - myBorder
```
protected Border myBorder
```
    border for component
  - specialMode
```
protected int specialMode
```
  - highlightsPane
```
public final javafx.scene.layout.Pane highlightsPane
```
- Constructor Detail
  - PdfDecoderFX
```
public PdfDecoderFX(boolean newRender)
```
    Recommend way to create a PdfDecoder if no rendering of page may be required
    Otherwise use PdfDecoder()
    
    Parameters:
    
    newRender - flag to show if pages are being rendered (true) or only extraction taking place (flase).
  - PdfDecoderFX
```
public PdfDecoderFX()
```
    Recommend way to create a PdfDecoder for renderer only viewer (not recommended for server extraction only processes)
- Method Detail
  - isOpen
```
public boolean isOpen()
```
    see if the file is open - may not be if the user interrupted open or encountered a problem
    
    Specified by:
    
    isOpen in interface PdfDecoderInt
  - getMarkedContent
```
public Document getMarkedContent()
```
    return markedContent object as XML Document
    
    Specified by:
    
    getMarkedContent in interface PdfDecoderInt
    
    Returns:
    
    Document containing XML structure with data Not implemented in PdfDecoderFx - use PDFDecoderServer
  - getExternalHandler
```
public ExternalHandlers getExternalHandler()
```
    Specified by:
    
    getExternalHandler in interface PdfDecoderInt
  - getRes
```
protected PdfResources getRes()
```
  - getDisplayRotation
```
public int getDisplayRotation()
```
    current page rotation (in addition to rotation in file) in degrees So if user turns page by 90 degrees, value will be 90
    
    Specified by:
    
    getDisplayRotation in interface PdfDecoderInt
    
    Returns:
  - getPageNumber
```
public int getPageNumber()
```
    current logical page number
    
    Specified by:
    
    getPageNumber in interface PdfDecoderInt
    
    Returns:
  - setPageNumber
```
public void setPageNumber(int newPage)
```
  - setDisplayRotation
```
public void setDisplayRotation(int newRotation)
```
    Specified by:
    
    setDisplayRotation in interface PdfDecoderInt
  - getPages
```
public Display getPages()
```
    Specified by:
    
    getPages in interface PdfDecoderInt
  - getlastPageDecoded
```
public int getlastPageDecoded()
```
    return page number for last page decoded (only use in SingleDisplay mode)
    
    Specified by:
    
    getlastPageDecoded in interface PdfDecoderInt
  - getPageInfo
```
public Iterator getPageInfo(int type)
```
    return details on page for type (defined in org.jpedal.constants.PageInfo) or null if no values Unrecognised key will throw a RunTime exception
    null returned if JPedal not clear on result
    
    Specified by:
    
    getPageInfo in interface PdfDecoderInt
  - getOutlineData
```
public OutlineData getOutlineData()
```
    provide direct access to outlineData object
    
    Specified by:
    
    getOutlineData in interface PdfDecoderInt
    
    Returns:
    
    OutlineData
  - isLoadingLinearizedPDF
```
public boolean isLoadingLinearizedPDF()
```
    track if file still loaded in background
    
    Specified by:
    
    isLoadingLinearizedPDF in interface PdfDecoderInt
    
    Returns:
  - useNewGraphicsMode
```
public boolean useNewGraphicsMode()
```
    Specified by:
    
    useNewGraphicsMode in interface PdfDecoderInt
  - useNewGraphicsMode
```
public void useNewGraphicsMode(boolean b)
```
    Specified by:
    
    useNewGraphicsMode in interface PdfDecoderInt
  - getSpecialMode
```
public int getSpecialMode()
```
    Specified by:
    
    getSpecialMode in interface PdfDecoderInt
  - scrollRectToVisible
```
public void scrollRectToVisible(Rectangle rectangle)
```
  - resetViewableArea
```
public void resetViewableArea()
```
    NOT PART OF API turns off the viewable area, scaling the page back to original scaling
    
    Specified by:
    
    resetViewableArea in interface PdfDecoderInt
  - getPageAlignment
```
public int getPageAlignment()
```
    return type of alignment for pages if smaller than panel - see options in Display class.
    
    Specified by:
    
    getPageAlignment in interface PdfDecoderInt
  - init
```
public static void init(boolean newEmbedWidthData)
```
    This will be needed for text extraction and set to true as paramter makes sure widths included in text stream
    
    Parameters:
    
    newEmbedWidthData - - flag to embed width data in text fragments for use by grouping algorithms
  - setPageDisplayMode
```
public void setPageDisplayMode(int pageDisplayMode)
```
    NOT PART OF API
    Recommend you use Viewer class if you want this functionality
    
    Parameters:
    
    pageDisplayMode -
  - disposeAllStatic
```
public static void disposeAllStatic()
```
    remove all static elements - only do once completely finished with JPedal as will not be reinitialised
  - dispose
```
public final void dispose()
```
    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()
    
    Specified by:
    
    dispose in interface PdfDecoderInt
  - closePdfFile
```
public final void closePdfFile()
```
    convenience method to close the current PDF file and release all resources/delete any temporary files
    
    Specified by:
    
    closePdfFile in interface PdfDecoderInt
  - getPdfBackgroundData
```
public final PdfData getPdfBackgroundData()
```
    NOT PART OF API
    Access should not generally be required to this class. Please look at getBackgroundGroupingObject() - provide method for outside class to get data object containing text and metrics of text. - Viewer can only access data for finding on page
    
    Returns:
    
    PdfData object containing text content from PDF
  - getPdfData
```
public final PdfData getPdfData()
                         throws PdfException
```
    Access should not generally be required to this class but used in examples. Returns the PdfData object containing raw content from page
    
    Specified by:
    
    getPdfData in interface PdfDecoderInt
    
    Returns:
    
    PdfData object containing text content from PDF
    
    Throws:
    
    PdfException
  - hasOutline
```
public final boolean hasOutline()
```
    flag to show if PDF document contains an outline
    
    Specified by:
    
    hasOutline in interface PdfDecoderInt
  - getOutlineAsXML
```
public final Document getOutlineAsXML()
```
    return a DOM document containing the PDF Outline object as a DOM Document - may return null
    
    Specified by:
    
    getOutlineAsXML in interface PdfDecoderInt
  - getPdfPageData
```
public final PdfPageData getPdfPageData()
```
    Provides method for outside class to get data object containing information on the page for calculating grouping
    Please note: Structure of PdfPageData is not guaranteed to remain constant. Please contact IDRsolutions for advice.
    
    Specified by:
    
    getPdfPageData in interface PdfDecoderInt
    
    Returns:
    
    PdfPageData object
  - print
```
public int print(Graphics graphics,
                 PageFormat pageFormat,
                 int page)
          throws PrinterException
```
    Implements the standard Java printing functionality.
    
    Specified by:
    
    print in interface Printable
    
    Parameters:
    
    graphics - the context into which the page is drawn
    
    pageFormat - the size and orientation of the page being drawn
    
    page - the zero based index of the page to be drawn
    
    Returns:
    
    int Printable.PAGE_EXISTS or Printable.NO_SUCH_PAGE
    
    Throws:
    
    PrinterException
  - getPageAsHiRes
```
public BufferedImage getPageAsHiRes(int pageIndex)
                             throws PdfException
```
    Specified by:
    
    getPageAsHiRes in interface PdfDecoderInt
    
    Parameters:
    
    pageIndex - number of the page we want to extract
    
    Returns:
    
    image of the extracted page
    
    Throws:
    
    PdfException - Page size is defined by CropBox see http://files.idrsolutions.com/samplecode/org/jpedal/examples/images/ConvertPagesToHiResImages.java.html for full details
  - getPageAsHiRes
```
public BufferedImage getPageAsHiRes(int pageIndex,
                                    Map params)
                             throws PdfException
```
    Specified by:
    
    getPageAsHiRes in interface PdfDecoderInt
    
    Parameters:
    
    pageIndex - number of the page we want to extract
    
    params - list of values to override static settings in modifyJPedalParameters for this instance only
    
    Returns:
    
    image of the extracted page
    
    Throws:
    
    PdfException - Page size is defined by CropBox see http://files.idrsolutions.com/samplecode/org/jpedal/examples/images/ConvertPagesToHiResImages.java.html for full details
  - getPageAsHiRes
```
public BufferedImage getPageAsHiRes(int pageIndex,
                                    Map params,
                                    boolean isTransparent)
                             throws PdfException
```
    Specified by:
    
    getPageAsHiRes in interface PdfDecoderInt
    
    Parameters:
    
    pageIndex - number of the page we want to extract
    
    params - list of values to override static settings in modifyJPedalParameters for this instance only
    
    isTransparent - - set if transparent or has background
    
    Returns:
    
    image of the extracted page
    
    Throws:
    
    PdfException - Page size is defined by CropBox see http://files.idrsolutions.com/samplecode/org/jpedal/examples/images/ConvertPagesToHiResImages.java.html for full details
  - getPageAsHiRes
```
public BufferedImage getPageAsHiRes(int pageIndex,
                                    boolean isTransparent)
                             throws PdfException
```
    Specified by:
    
    getPageAsHiRes in interface PdfDecoderInt
    
    Parameters:
    
    pageIndex - number of the page we want to extract
    
    Returns:
    
    image of the extracted page
    
    Throws:
    
    PdfException - Page size is defined by CropBox see http://files.idrsolutions.com/samplecode/org/jpedal/examples/images/ConvertPagesToHiResImages.java.html for full details
  - getPageAsImage
```
public BufferedImage getPageAsImage(int pageIndex)
                             throws PdfException
```
    generate BufferedImage of a page in current file
    Page size is defined by CropBox see http://files.idrsolutions.com/samplecode/org/jpedal/examples/images/ConvertPagesToImages.java.html for full details
    
    Specified by:
    
    getPageAsImage in interface PdfDecoderInt
    
    Throws:
    
    PdfException
  - getPageAsImage
```
public BufferedImage getPageAsImage(int pageIndex,
                                    float scaling)
                             throws PdfException
```
    generate BufferedImage of a page in current file with the given scaling
    Page size is defined by CropBox
    
    Specified by:
    
    getPageAsImage in interface PdfDecoderInt
    
    Throws:
    
    PdfException
  - getPageAsTransparentImage
```
public BufferedImage getPageAsTransparentImage(int pageIndex)
                                        throws PdfException
```
    generate BufferedImage of a page in current file
    Page size is defined by CropBox see http://files.idrsolutions.com/samplecode/org/jpedal/examples/images/ConvertPagesToImages.java.html for full details
    
    Specified by:
    
    getPageAsTransparentImage in interface PdfDecoderInt
    
    Throws:
    
    PdfException
  - getHiResUpscaleFactor
```
public float getHiResUpscaleFactor()
```
    return scaleup factor applied to last Hires image of page generated negative values mean no upscaling applied and should be ignored
    
    Specified by:
    
    getHiResUpscaleFactor in interface PdfDecoderInt
  - flushObjectValues
```
public final void flushObjectValues(boolean reinit)
```
    provide method for outside class to clear store of objects once written out to reclaim memory
    
    Specified by:
    
    flushObjectValues in interface PdfDecoderInt
    
    Parameters:
    
    reinit - lag to show if image data flushed as well
  - getPdfImageData
```
public final PdfImageData getPdfImageData()
```
    provide method for outside class to get data object containing images
    Please look at examples for usage
    
    Specified by:
    
    getPdfImageData in interface PdfDecoderInt
    
    Returns:
    
    PdfImageData containing image metadata
  - getPdfBackgroundImageData
```
public final PdfImageData getPdfBackgroundImageData()
```
    provide method for outside class to get data object containing images.
    Please look at examples for usage
    
    Returns:
    
    PdfImageData containing image metadata
  - setRenderMode
```
public final void setRenderMode(int mode)
```
    set render mode to state what is displayed onscreen (ie RENDERTEXT,RENDERIMAGES) - only generally required if you do not wish to show all objects on screen (default is all). Add values together to combine settings.
    
    Specified by:
    
    setRenderMode in interface PdfDecoderInt
  - setExtractionMode
```
public final void setExtractionMode(int mode)
```
    set extraction mode telling JPedal what to extract - (TEXT,RAWIMAGES,FINALIMAGES - add together to combine) - See org.jpedal.examples for specific extraction examples
    
    Specified by:
    
    setExtractionMode in interface PdfDecoderInt
  - modifyNonstaticJPedalParameters
```
public void modifyNonstaticJPedalParameters(Map values)
                                     throws PdfException
```
    allow user to alter certain values in software such as Colour,
    Please note all Color and text highlighting values are static and common across the JVM
    
    Specified by:
    
    modifyNonstaticJPedalParameters in interface PdfDecoderInt
    
    Throws:
    
    PdfException
  - modifyJPedalParameters
```
public static void modifyJPedalParameters(Map values)
                                   throws PdfException
```
    allow user to alter certain values in software such as Colour,
    If you are using decoder.getPageAsHiRes() after passing additional parameters into JPedal using the static method PdfDecoder.modifyJPedalParameters(), then getPageAsHiRes() wont necessarily be thread safe. If you want to use getPageAsHiRes() and pass in additional parameters, in a thread safe mannor, please use the method getPageAsHiRes(int pageIndex, Map params) or getPageAsHiRes(int pageIndex, Map params, boolean isTransparent) and pass the additional parameters in directly to the getPageAsHiRes() method without calling PdfDecoder.modifyJPedalParameters() first.
    Please see http://files.idrsolutions.com/samplecode/org/jpedal/examples/images/ConvertPagesToHiResImages.java.html for example of usage
    Please note all Color and text highlighting values except page colour are static and common across the JVM
    
    Throws:
    
    PdfException
  - getFileInformationData
```
public final PdfFileInformation getFileInformationData()
```
    method to return null or object giving access info fields and metadata.
    
    Specified by:
    
    getFileInformationData in interface PdfDecoderInt
  - setExtractionMode
```
public final void setExtractionMode(int mode,
                                    float scaling)
```
    Please do not use for general usage. Use setPageParameters(scalingValue, pageNumber) to set page scaling
    
    Specified by:
    
    setExtractionMode in interface PdfDecoderInt
  - getDPIFactory
```
public DPIFactory getDPIFactory()
```
    return handle on PDFFactory which adjusts display size so matches size in Acrobat
    
    Specified by:
    
    getDPIFactory in interface PdfDecoderInt
    
    Returns:
  - setPageParameters
```
public void setPageParameters(float scaling,
                              int pageNumber)
```
    initialise panel and set size to fit PDF page
    intializes display with rotation set to the default, specified in the PDF document scaling value of -1 means keep existing setting
    
    Specified by:
    
    setPageParameters in interface PdfDecoderInt
  - setPageParameters
```
public void setPageParameters(float scaling,
                              int pageNumber,
                              int newRotation)
```
    calls setPageParameters(scaling,pageNumber) after setting rotation to draw page
    
    Specified by:
    
    setPageParameters in interface PdfDecoderInt
  - setStatusBarObject
```
public void setStatusBarObject(StatusBar statusBar)
```
    Not part of API - used internally
    set status bar to use when decoding a page - StatusBar provides a GUI object to display progress and messages.
    
    Specified by:
    
    setStatusBarObject in interface PdfDecoderInt
  - waitForDecodingToFinish
```
public void waitForDecodingToFinish()
```
    wait for decoding to finish
    
    Specified by:
    
    waitForDecodingToFinish in interface PdfDecoderInt
  - getDynamicRenderer
```
public DynamicVectorRenderer getDynamicRenderer()
```
    Not part of API - used internally
    gets DynamicVector Object
    
    Specified by:
    
    getDynamicRenderer in interface PdfDecoderInt
  - getDynamicRenderer
```
public DynamicVectorRenderer getDynamicRenderer(boolean reset)
```
    Not part of API - used internally
    gets DynamicVector Object - NOT PART OF API and subject to change (DO NOT USE)
    
    Specified by:
    
    getDynamicRenderer in interface PdfDecoderInt
  - setDefaultCursor
```
public void setDefaultCursor(javafx.scene.Cursor c)
```
    When changing the mouse mode we call this method to set the mouse mode default cursor
    
    Parameters:
    
    c - :: The cursor to set as the default
  - decodePage
```
public final void decodePage(int rawPage)
```
    decode a page, - page must be between 1 and PdfDecoder.getPageCount() - Will kill off if already running
    returns minus page if trying to open linearized page not yet available
    
    Specified by:
    
    decodePage in interface PdfDecoderInt
  - isPageAvailable
```
public boolean isPageAvailable(int rawPage)
```
    see if page available if in Linearized mode or return true
    
    Specified by:
    
    isPageAvailable in interface PdfDecoderInt
    
    Parameters:
    
    rawPage -
    
    Returns:
  - drawAdditionalObjectsOverPage
```
public void drawAdditionalObjectsOverPage(int page,
                                          int[] type,
                                          Color[] colors,
                                          Object[] obj)
                                   throws PdfException
```
    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
    
    Specified by:
    
    drawAdditionalObjectsOverPage in interface PdfDecoderInt
    
    Throws:
    
    PdfException
  - flushAdditionalObjectsOnPage
```
public void flushAdditionalObjectsOnPage(int page)
                                  throws PdfException
```
    allow user to remove all additional graphical content from the page (only for display) ONLY works in SINGLE VIEW displaymode
    
    Specified by:
    
    flushAdditionalObjectsOnPage in interface PdfDecoderInt
    
    Throws:
    
    PdfException
  - decodePageInBackground
```
public final void decodePageInBackground(int i)
                                  throws Exception
```
    decode a page as a background thread (use other background methods to access data)
    we now recommend you use decodePage as this has been heavily optimised for speed
    
    Specified by:
    
    decodePageInBackground in interface PdfDecoderInt
    
    Throws:
    
    Exception
  - getPageCount
```
public final int getPageCount()
```
    get page count of current PDF file
    
    Specified by:
    
    getPageCount in interface PdfDecoderInt
  - isEncrypted
```
public final boolean isEncrypted()
```
    return true if the current pdf file is encrypted
    check isFileViewable(),
    
    if file is encrypted and not viewable - a user specified password is needed.
    
    Specified by:
    
    isEncrypted in interface PdfDecoderInt
  - isPasswordSupplied
```
public final boolean isPasswordSupplied()
```
    show if encryption password has been supplied or set a certificate
    
    Specified by:
    
    isPasswordSupplied in interface PdfDecoderInt
  - isFileViewable
```
public boolean isFileViewable()
```
    show if encrypted file can be viewed,
    if false a password needs entering
    
    Specified by:
    
    isFileViewable in interface PdfDecoderInt
  - isExtractionAllowed
```
public boolean isExtractionAllowed()
```
    show if content can be extracted
    
    Specified by:
    
    isExtractionAllowed in interface PdfDecoderInt
  - setEncryptionPassword
```
public final void setEncryptionPassword(String password)
                                 throws PdfException
```
    set a password for encryption - software will resolve if user or owner password- calls verifyAccess() from 2.74 so no separate call needed
    
    Specified by:
    
    setEncryptionPassword in interface PdfDecoderInt
    
    Throws:
    
    PdfException
  - openPdfArray
```
public final void openPdfArray(byte[] data,
                               String password)
                        throws PdfException
```
    routine to open a byte stream containing the PDF file and extract key info from pdf file so we can decode any pages. Does not actually decode the pages themselves - By default files over 16384 bytes are cached to disk but this can be altered by setting PdfFileReader.alwaysCacheInMemory to a maximimum size or -1 (always keep in memory)
    
    Specified by:
    
    openPdfArray in interface PdfDecoderInt
    
    Throws:
    
    PdfException
  - openPdfArray
```
public final void openPdfArray(byte[] data)
                        throws PdfException
```
    routine to open a byte stream containing the PDF file and extract key info from pdf file so we can decode any pages. Does not actually decode the pages themselves - By default files over 16384 bytes are cached to disk but this can be altered by setting PdfFileReader.alwaysCacheInMemory to a maximimum size or -1 (always keep in memory)
    
    Specified by:
    
    openPdfArray in interface PdfDecoderInt
    
    Throws:
    
    PdfException
  - openPdfFile
```
public void openPdfFile(String filename,
                        Certificate certificate,
                        PrivateKey key)
                 throws PdfException
```
    allow user to open file using Certificate and key
    
    Specified by:
    
    openPdfFile in interface PdfDecoderInt
    
    Parameters:
    
    filename -
    
    certificate -
    
    key -
    
    Throws:
    
    PdfException
  - openPdfFileFromStream
```
public final void openPdfFileFromStream(Object filename,
                                        String password)
                                 throws PdfException
```
    routine to open PDF file and extract key info from pdf file so we can decode any pages which also sets password. Does not actually decode the pages themselves. Also reads the form data. You must explicitly close your stream!!
    
    Specified by:
    
    openPdfFileFromStream in interface PdfDecoderInt
    
    Throws:
    
    PdfException
  - openPdfFile
```
public final void openPdfFile(String filename)
                       throws PdfException
```
    routine to open PDF file and extract key info from pdf file so we can decode any pages. Does not actually decode the pages themselves. Also reads the form data. You must explicitly close any open files with closePdfFile() to Java will not release all the memory
    
    Specified by:
    
    openPdfFile in interface PdfDecoderInt
    
    Throws:
    
    PdfException
  - openPdfFile
```
public final void openPdfFile(String filename,
                              String password)
                       throws PdfException
```
    routine to open PDF file and extract key info from pdf file so we can decode any pages which also sets password. Does not actually decode the pages themselves. Also reads the form data. You must explicitly close any open files with closePdfFile() or Java will not release all the memory
    
    Specified by:
    
    openPdfFile in interface PdfDecoderInt
    
    Throws:
    
    PdfException
  - openPdfFileFromURL
```
public final boolean openPdfFileFromURL(String pdfUrl,
                                        boolean supportLinearized)
                                 throws PdfException
```
    routine to open PDF file via URL and extract key info from pdf file so we can decode any pages - Does not actually decode the pages themselves - Also reads the form data - Based on an idea by Peter Jacobsen
    You must explicitly close any open files with closePdfFile() so Java will release all the memory
    
    If boolean supportLinearized is true, method will return with true value once Linearized part read
    
    Specified by:
    
    openPdfFileFromURL in interface PdfDecoderInt
    
    Throws:
    
    PdfException
  - openPdfFileFromURL
```
public final boolean openPdfFileFromURL(String pdfUrl,
                                        boolean supportLinearized,
                                        String password)
                                 throws PdfException
```
    routine to open PDF file via URL and extract key info from pdf file so we can decode any pages - Does not actually decode the pages themselves - Also reads the form data - Based on an idea by Peter Jacobsen
    You must explicitly close any open files with closePdfFile() so Java will release all the memory
    
    If boolean supportLinearized is true, method will return with true value once Linearized part read
    
    Specified by:
    
    openPdfFileFromURL in interface PdfDecoderInt
    
    Throws:
    
    PdfException
  - openPdfFileFromInputStream
```
public final boolean openPdfFileFromInputStream(InputStream is,
                                                boolean supportLinearized)
                                         throws PdfException
```
    routine to open PDF file via InputStream and extract key info from pdf file so we can decode any pages - Does not actually decode the pages themselves -
    You must explicitly close any open files with closePdfFile() to Java will not release all the memory
    IMPORTANT NOTE: If the stream does not contain enough bytes, test for Linearization may fail If boolean supportLinearized is true, method will return with true value once Linearized part read (we recommend use you false unless you know exactly what you are doing)
    
    Specified by:
    
    openPdfFileFromInputStream in interface PdfDecoderInt
    
    Throws:
    
    PdfException
  - openPdfFileFromInputStream
```
public final boolean openPdfFileFromInputStream(InputStream is,
                                                boolean supportLinearized,
                                                String password)
                                         throws PdfException
```
    routine to open PDF file via InputStream and extract key info from pdf file so we can decode any pages - Does not actually decode the pages themselves -
    You must explicitly close any open files with closePdfFile() to Java will not release all the memory
    IMPORTANT NOTE: If the stream does not contain enough bytes, test for Linearization may fail If boolean supportLinearized is true, method will return with true value once Linearized part read (we recommend use you false unless you know exactly what you are doing)
    
    Specified by:
    
    openPdfFileFromInputStream in interface PdfDecoderInt
    
    Throws:
    
    PdfException
  - getJPedalObject
```
public Object getJPedalObject(int id)
```
    Not part of API - used internally
    will return some dictionary values - if not a set value, will return null
    
    Specified by:
    
    getJPedalObject in interface PdfDecoderInt
    
    Returns:
  - setPageMode
```
public void setPageMode(int mode)
```
    Not part of API - used internally
    
    Specified by:
    
    setPageMode in interface PdfDecoderInt
    
    Parameters:
    
    mode -
  - isXMLExtraction
```
public boolean isXMLExtraction()
```
    shows if text extraction is XML or pure text
    
    Specified by:
    
    isXMLExtraction in interface PdfDecoderInt
  - useTextExtraction
```
public void useTextExtraction()
```
    XML extraction is the default - pure text extraction is much faster
    
    Specified by:
    
    useTextExtraction in interface PdfDecoderInt
  - useXMLExtraction
```
public void useXMLExtraction()
```
    XML extraction is the default - pure text extraction is much faster
    
    Specified by:
    
    useXMLExtraction in interface PdfDecoderInt
  - clearScreen
```
public void clearScreen()
```
    remove all displayed objects for JPanel display (wipes current page)
  - setStreamCacheSize
```
public void setStreamCacheSize(int size)
```
    allows user to cache large objects to disk to avoid memory issues, setting minimum size in bytes (of uncompressed stream) above which object will be stored on disk if possible (default is -1 bytes which is all objects stored in memory) - Must be set before file opened.
    
    Specified by:
    
    setStreamCacheSize in interface PdfDecoderInt
  - hasEmbeddedFonts
```
public boolean hasEmbeddedFonts()
```
    shows if embedded fonts present on page just decoded
    
    Specified by:
    
    hasEmbeddedFonts in interface PdfDecoderInt
  - getPageFromObjectRef
```
public int getPageFromObjectRef(String ref)
```
    given a ref, what is the page
    
    Specified by:
    
    getPageFromObjectRef in interface PdfDecoderInt
    
    Parameters:
    
    ref - - PDF object reference
    
    Returns:
    
    - page number with being first page
  - getInfo
```
public String getInfo(int type)
```
    Returns list of the fonts used on the current page decoded or null type can be PdfDictionary.Font or PdfDictionary.Image
    
    Specified by:
    
    getInfo in interface PdfDecoderInt
  - getFormRenderer
```
public AcroRenderer getFormRenderer()
```
    Allow user to access Forms renderer object if needed
    
    Specified by:
    
    getFormRenderer in interface PdfDecoderInt
  - getJavaScript
```
public Javascript getJavaScript()
```
    Allow user to access javascript object if needed
    
    Specified by:
    
    getJavaScript in interface PdfDecoderInt
  - isPageSuccessful
```
public static boolean isPageSuccessful()
```
    shows if page reported any errors while printing. Log can be found with getPageFailureMessage()
    
    Returns:
    
    Returns the printingSuccessful.
  - getPageDecodeReport
```
public String getPageDecodeReport()
```
    return any errors or other messages while calling decodePage() - zero length is no problems
    
    Specified by:
    
    getPageDecodeReport in interface PdfDecoderInt
  - getPageFailureMessage
```
public static String getPageFailureMessage()
```
    Return String with all error messages from last printed (useful for debugging)
  - getSelectedRectangleOnscreen
```
public BufferedImage getSelectedRectangleOnscreen(float t_x1,
                                                  float t_y1,
                                                  float t_x2,
                                                  float t_y2,
                                                  float scaling)
```
    If running in GUI mode, will extract a section of rendered page as BufferedImage -coordinates are PDF co-ordinates. If you wish to use hires image, you will need to enable hires image display with decode_pdf.useHiResScreenDisplay(true);
    
    Specified by:
    
    getSelectedRectangleOnscreen in interface PdfDecoderInt
    
    Parameters:
    
    t_x1 -
    
    t_y1 -
    
    t_x2 -
    
    t_y2 -
    
    scaling -
    
    Returns:
    
    pageErrorMessages - Any printer errors
  - getObjectStore
```
public ObjectStore getObjectStore()
```
    return object which provides access to file images and name
    
    Specified by:
    
    getObjectStore in interface PdfDecoderInt
  - setObjectStore
```
public void setObjectStore(ObjectStore newStore)
```
    return object which provides access to file images and name (use not recommended)
    
    Specified by:
    
    setObjectStore in interface PdfDecoderInt
  - getDecoderOptions
```
public DecoderOptions getDecoderOptions()
```
    Return decoder options as object for cases where value is needed externally and can't be static
    
    Specified by:
    
    getDecoderOptions in interface PdfDecoderInt
    
    Returns:
    
    DecoderOptions object containing settings for this PdfDecoder object
  - getGroupingObject
```
public PdfGroupingAlgorithms getGroupingObject()
                                        throws PdfException
```
    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.
    
    Specified by:
    
    getGroupingObject in interface PdfDecoderInt
    
    Throws:
    
    PdfException
  - getBackgroundGroupingObject
```
public PdfGroupingAlgorithms getBackgroundGroupingObject()
```
    returns object containing grouped text from background grouping - Please see org.jpedal.examples.text for example code
    
    Specified by:
    
    getBackgroundGroupingObject in interface PdfDecoderInt
  - getPDFVersion
```
public final String getPDFVersion()
```
    get PDF version in file
    
    Specified by:
    
    getPDFVersion in interface PdfDecoderInt
  - resetForNonPDFPage
```
public void resetForNonPDFPage(int pageCount)
```
    used for non-PDF files to reset page
    
    Specified by:
    
    resetForNonPDFPage in interface PdfDecoderInt
  - hasAllImages
```
public boolean hasAllImages()
```
    flag to show if we suspect problem with some images
  - getPageDecodeStatus
```
public boolean getPageDecodeStatus(int status)
```
    returns booleans based on flags in class org.jpedal.parser.DecoderStatus
    
    Specified by:
    
    getPageDecodeStatus in interface PdfDecoderInt
    
    Parameters:
    
    status -
    
    Returns:
  - getDisplayOffsets
```
public DisplayOffsets getDisplayOffsets()
```
    Specified by:
    
    getDisplayOffsets in interface PdfDecoderInt
  - getPageDecodeStatusReport
```
public String getPageDecodeStatusReport(int status)
```
    get page statuses (flags in class org.jpedal.parser.DecoderStatus)
    
    Specified by:
    
    getPageDecodeStatusReport in interface PdfDecoderInt
  - addExternalHandler
```
public void addExternalHandler(Object newHandler,
                               int type)
```
    not part of API used internally
    allows external helper classes to be added to JPedal to alter default functionality -
    
    Specified by:
    
    addExternalHandler in interface PdfDecoderInt
    
    Parameters:
    
    newHandler -
    
    type -
  - getExternalHandler
```
public Object getExternalHandler(int type)
```
    not part of API used internally
    allows external helper classes to be accessed if needed - also allows user to access SwingGUI if running full Viewer package - not all Options available to get - please contact IDRsolutions if you are looking to use
    
    Specified by:
    
    getExternalHandler in interface PdfDecoderInt
    
    Parameters:
    
    type -
  - getIO
```
public PdfObjectReader getIO()
```
    allow access to PDF file
    
    Specified by:
    
    getIO in interface PdfDecoderInt
    
    Returns:
  - getFileName
```
public String getFileName()
```
    currently open PDF file name
    
    Specified by:
    
    getFileName in interface PdfDecoderInt
    
    Returns:
  - isForm
```
public boolean isForm()
```
    return true if currently open PDF file is a PDF form
    
    Specified by:
    
    isForm in interface PdfDecoderInt
    
    Returns:
  - getPrintable
```
public Printable getPrintable(int page)
                       throws IndexOutOfBoundsException
```
    part of pageable interface
    
    Specified by:
    
    getPrintable in interface Pageable
    
    Throws:
    
    IndexOutOfBoundsException
  - getTextLines
```
public TextLines getTextLines()
```
    access textlines object
    
    Specified by:
    
    getTextLines in interface PdfDecoderInt
  - setInset
```
public final void setInset(int width,
                           int height)
```
    set an inset display so that display will not touch edge of panel
    
    Specified by:
    
    setInset in interface PdfDecoderInt
  - setUserOffsets
```
public void setUserOffsets(int x,
                           int y,
                           int mode)
```
    not part of API used internally allow user to 'move' display of PDF mode is a Constant in org.jpedal.external.OffsetOptions (ie OffsetOptions.SWING_DISPLAY,OffsetOptions.PRINTING)
    
    Specified by:
    
    setUserOffsets in interface PdfDecoderInt
  - getUserOffsets
```
public Point getUserOffsets(int mode)
```
    not part of API used internally
    
    Parameters:
    
    mode -
    
    Returns:
  - getMaximumSize
```
public final int[] getMaximumSize()
```
    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)
  - updateCursorBoxOnScreen
```
public final void updateCursorBoxOnScreen(int[] rectParams,
                                          int outlineColor)
```
    update rectangle we draw to highlight an area - See Viewer example for example code showing current usage. This method takes an int array containing the x,y,w,h params of the rectangle we wish to update. It also takes an int outLineColor which is the rgb value of a Color object.
    
    Specified by:
    
    updateCursorBoxOnScreen in interface PdfDecoderInt
  - getPDFWidth
```
public final int getPDFWidth()
```
    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
    
    Specified by:
    
    getPDFWidth in interface PdfDecoderInt
  - getPDFHeight
```
public final int getPDFHeight()
```
    get sizes of panel - This is the PDF pagesize
    
    Specified by:
    
    getPDFHeight in interface PdfDecoderInt
  - setPDFBorder
```
public final void setPDFBorder(Border newBorder)
```
    set border for screen and print which will be displayed
    Setting a new value will enable screen and border painting - disable with disableBorderForPrinting()
    
    Specified by:
    
    setPDFBorder in interface PdfDecoderInt
  - setHardwareAccelerationforScreen
```
public void setHardwareAccelerationforScreen(boolean useAcceleration)
```
    Enables/Disables hardware acceleration of screen rendering (default is on)
    
    Specified by:
    
    setHardwareAccelerationforScreen in interface PdfDecoderInt
  - getScrollInterval
```
public int getScrollInterval()
```
    return amount to scroll window by when scrolling (default is 10)
    
    Specified by:
    
    getScrollInterval in interface PdfDecoderInt
    
    Returns:
    
    int
  - setScrollInterval
```
public void setScrollInterval(int scrollInterval)
```
    set amount to scroll window by when scrolling
    
    Specified by:
    
    setScrollInterval in interface PdfDecoderInt
  - getDisplayView
```
public int getDisplayView()
```
    returns view mode used - ie SINGLE_PAGE,CONTINUOUS,FACING,CONTINUOUS_FACING (no effect in OS versions)
    
    Specified by:
    
    getDisplayView in interface PdfDecoderInt
  - getScaling
```
public float getScaling()
```
    returns current scaling value used internally
    
    Specified by:
    
    getScaling in interface PdfDecoderInt
    
    Returns:
  - getInsetH
```
public int getInsetH()
```
    Description copied from interface: PdfDecoderInt
    
    Return amount to inset the page rectangle height by
    
    Specified by:
    
    getInsetH in interface PdfDecoderInt
    
    Returns:
    
    int
  - getInsetW
```
public int getInsetW()
```
    Description copied from interface: PdfDecoderInt
    
    Return amount to inset the page rectangle width by
    
    Specified by:
    
    getInsetW in interface PdfDecoderInt
    
    Returns:
    
    int
  - getNumberOfPages
```
public int getNumberOfPages()
```
    part of pageable interface - used only in printing Use getPageCount() for number of pages
    
    Specified by:
    
    getNumberOfPages in interface Pageable
  - getPageFormat
```
public PageFormat getPageFormat(int p)
                         throws IndexOutOfBoundsException
```
    part of pageable interface
    
    Specified by:
    
    getPageFormat in interface Pageable
    
    Throws:
    
    IndexOutOfBoundsException
  - getCurrentPrintPage
```
public static int getCurrentPrintPage()
```
    return page currently being printed or -1 if finished
  - resetCurrentPrintPage
```
public void resetCurrentPrintPage()
```
  - setScaling
```
public void setScaling(float x)
```
    Specified by:
    
    setScaling in interface PdfDecoderInt
  - getMaxSizeWH
```
public int[] getMaxSizeWH()
```
    Specified by:
    
    getMaxSizeWH in interface PdfDecoderInt
  - getPaneBounds
```
public int[] getPaneBounds()
```
    Specified by:
    
    getPaneBounds in interface PdfDecoderInt
  - repaintPane
```
public void repaintPane(int page)
```
    Specified by:
    
    repaintPane in interface PdfDecoderInt
  - setBorderPresent
```
public void setBorderPresent(boolean borderPresent)
```
    Specified by:
    
    setBorderPresent in interface PdfDecoderInt
  - isBorderPresent
```
public boolean isBorderPresent()
```
    Specified by:
    
    isBorderPresent in interface PdfDecoderInt
  - setPreviewThumbnail
```
public void setPreviewThumbnail(BufferedImage previewImage,
                                String previewText)
```
    internal method used by Viewer to provide preview of PDF in Viewer
    
    Specified by:
    
    setPreviewThumbnail in interface PdfDecoderInt
  - getTextPrint
```
public int getTextPrint()
```
    Specified by:
    
    getTextPrint in interface PdfDecoderInt
  - repaint
```
public void repaint()
```
    Specified by:
    
    repaint in interface PdfDecoderInt
  - getVisibleRect
```
public Rectangle getVisibleRect()
```
    Specified by:
    
    getVisibleRect in interface PdfDecoderInt

Class PdfDecoderFX

Property Summary

Properties inherited from class javafx.scene.layout.Region

Properties inherited from class javafx.scene.Parent

Properties inherited from class javafx.scene.Node

Field Summary

Fields inherited from class javafx.scene.layout.Region

Fields inherited from class javafx.scene.Node

Fields inherited from interface java.awt.print.Printable

Fields inherited from interface java.awt.print.Pageable

Fields inherited from interface org.jpedal.PdfDecoderInt

Constructor Summary

Method Summary

Methods inherited from class javafx.scene.layout.Pane

Methods inherited from class javafx.scene.layout.Region

Methods inherited from class javafx.scene.Parent

Methods inherited from class javafx.scene.Node

Methods inherited from class java.lang.Object

Methods inherited from interface org.jpedal.PdfDecoderInt

Field Detail

useNewGraphicsMode

pages

myBorder

specialMode

highlightsPane

Constructor Detail

PdfDecoderFX

PdfDecoderFX

Method Detail

isOpen

getMarkedContent

getExternalHandler

getRes

getDisplayRotation

getPageNumber

setPageNumber

setDisplayRotation

getPages

getlastPageDecoded

getPageInfo

getOutlineData

isLoadingLinearizedPDF

useNewGraphicsMode

useNewGraphicsMode

getSpecialMode

scrollRectToVisible

resetViewableArea

getPageAlignment

init

setPageDisplayMode

disposeAllStatic

dispose

closePdfFile

getPdfBackgroundData

getPdfData

hasOutline

getOutlineAsXML

getPdfPageData

print

getPageAsHiRes

getPageAsHiRes

getPageAsHiRes

getPageAsHiRes

getPageAsImage

getPageAsImage

getPageAsTransparentImage

getHiResUpscaleFactor

flushObjectValues

getPdfImageData

getPdfBackgroundImageData

setRenderMode

setExtractionMode

modifyNonstaticJPedalParameters

modifyJPedalParameters

getFileInformationData

setExtractionMode

getDPIFactory

setPageParameters

setPageParameters

setStatusBarObject