## Uses of Class
org.faceless.pdf2.viewer2.DocumentPanel

- Packages that use DocumentPanel
  Package | Description
  --- | ---
  org.faceless.pdf2.viewer2 | The "viewer" package contains the classes required to create a Swing application to display PDFs.
  org.faceless.pdf2.viewer2.feature | Contains a list of all the features that are available to the PDFViewer.

- - ### Uses of DocumentPanel in org.faceless.pdf2.viewer2

    Methods in org.faceless.pdf2.viewer2 that return DocumentPanel
    Modifier and Type | Method and Description
    --- | ---
    `DocumentPanel` | PDFViewer.`getActiveDocumentPanel()` Return the active `DocumentPanel`
    `DocumentPanel` | DocumentPanelEvent.`getDocumentPanel()` Get the DocumentPanel this event was raised on
    `DocumentPanel` | DocumentViewport.`getDocumentPanel()` Return the `DocumentPanel` containing this DocumentViewport.
    `DocumentPanel` | PagePanel.`getDocumentPanel()` Get the `DocumentPanel` this PagePanel is contained inside, or `null` if this PagePanel was not created as part of a `DocumentPanel`.
    `DocumentPanel` | ViewerEvent.`getDocumentPanel()` Return the active `DocumentPanel` of the PDFViewer, or `null` if no DocumentPanel is active.
    `DocumentPanel` | JSManager.`getDocumentPanel(PDF pdf)` Return the DocumentPanel that contains the specified PDF
    `DocumentPanel[]` | PDFViewer.`getDocumentPanels()` Return all the `DocumentPanel`s in the viewer

    Methods in org.faceless.pdf2.viewer2 with parameters of type DocumentPanel
    Modifier and Type | Method and Description
    --- | ---
    `void` | PDFViewer.`closeDocumentPanel(DocumentPanel panel)` Close the specified `DocumentPanel`
    `static DocumentPanelEvent` | DocumentPanelEvent.`createActivated(DocumentPanel panel)` Create an "activated" DocumentPanelEvent
    `static DocumentPanelEvent` | DocumentPanelEvent.`createClosing(DocumentPanel panel)` Create a "closing" DocumentPanelEvent
    `static DocumentPanelEvent` | DocumentPanelEvent.`createCreated(DocumentPanel panel)` Create a "created" DocumentPanelEvent
    `static DocumentPanelEvent` | DocumentPanelEvent.`createDeactivated(DocumentPanel panel)` Create a "deactivated" DocumentPanelEvent
    `static DocumentPanelEvent` | DocumentPanelEvent.`createLoaded(DocumentPanel panel)` Create a "loaded" DocumentPanelEvent
    `static DocumentPanelEvent` | DocumentPanelEvent.`createPageChanged(DocumentPanel panel)` Create a "pageChanged" DocumentPanelEvent
    `static DocumentPanelEvent` | DocumentPanelEvent.`createPagePositionChanged(DocumentPanel panel)` Create a "pagePositionChanged" DocumentPanelEvent
    `static DocumentPanelEvent` | DocumentPanelEvent.`createPermissionChanged(DocumentPanel panel, String permission)` Create a "permissionChanged" DocumentPanelEvent
    `static DocumentPanelEvent` | DocumentPanelEvent.`createRedrawn(DocumentPanel panel)` Create a "redrawn" DocumentPanelEvent
    `static DocumentPanelEvent` | DocumentPanelEvent.`createStateChanged(DocumentPanel panel, Object state)` Create a "stateChanged" DocumentPanelEvent
    `static DocumentPanelEvent` | DocumentPanelEvent.`createViewportChanged(DocumentPanel panel)` Create a "viewportChanged" DocumentPanelEvent
    `JComponent` | Exporter.`getComponent(DocumentPanel panel, File file)` Return a JComponent which prompts the user for additional information after the initial save dialog.
    `abstract Exporter.ExporterTask` | Exporter.`getExporter(DocumentPanel panel, PDF pdf, JComponent component, OutputStream out)` Return a new `Exporter.ExporterTask` that would save a PDF
    `static ImageIcon` | SignatureProvider.`getIcon(DocumentPanel docpanel, FormSignature field)` Get an Icon that can be used to describe the specified signature.
    `static SignatureProvider.SignatureState` | SignatureProvider.`getSignatureState(DocumentPanel docpanel, FormSignature field)` Get a previously determined `SignatureProvider.SignatureState` for the specified signature field, as set by `setSignatureState()`.
    `boolean` | Exporter.`isEnabled(DocumentPanel docpanel)` Return true if this Exporter should be available for this DocumentPanel.
    `boolean` | AnnotationComponentFactory.`isFactoryReadOnly(DocumentPanel panel)` Indicates whether annotations may be created, removed, or edited.
    `abstract boolean` | ActionHandler.`matches(DocumentPanel panel, PDFAction action)` Return true if this ActionFactory can handle the specified `PDFAction`
    `abstract void` | ActionHandler.`run(DocumentPanel panel, PDFAction action)` Run the specified action
    `JSEvent` | JSManager.`runEventBatchExec(DocumentPanel panel, PDF pdf, String javascript)` Raise the `Batch/Exec` JavaScript method
    `JSEvent` | JSManager.`runEventBookmarkMouseUp(DocumentPanel panel, PDFBookmark bookmark)` Raise the `Bookmark/MouseUp` JavaScript method
    `JSEvent` | JSManager.`runEventConsoleExec(DocumentPanel panel, String javascript)` Raise the `Console/Exec` JavaScript method
    `JSEvent` | JSManager.`runEventDocDidPrint(DocumentPanel panel)` Raise the `Doc/DidPrint` JavaScript method
    `JSEvent` | JSManager.`runEventDocDidSave(DocumentPanel panel)` Raise the `Doc/DidSave` JavaScript method
    `JSEvent` | JSManager.`runEventDocOpen(DocumentPanel panel, String targetName)` Raise the `Doc/Open` JavaScript method
    `JSEvent` | JSManager.`runEventDocWillClose(DocumentPanel panel)` Raise the `Doc/WillClose` JavaScript method
    `JSEvent` | JSManager.`runEventDocWillPrint(DocumentPanel panel)` Raise the `Doc/WillPrint` JavaScript method
    `JSEvent` | JSManager.`runEventDocWillSave(DocumentPanel panel)` Raise the `Doc/WillSave` JavaScript method
    `JSEvent` | JSManager.`runEventExternalExec(DocumentPanel panel, String javascript)` Raise the `External/Exec` JavaScript method
    `JSEvent` | JSManager.`runEventFieldBlur(DocumentPanel panel, WidgetAnnotation annot, boolean shift, boolean modifier)` Raise the `Field/Blur` JavaScript method
    `JSEvent` | JSManager.`runEventFieldCalculate(DocumentPanel panel, WidgetAnnotation target, WidgetAnnotation source)` Raise the `Field/Calculate` JavaScript method
    `JSEvent` | JSManager.`runEventFieldFocus(DocumentPanel panel, WidgetAnnotation annot, boolean shift, boolean modifier)` Raise the `Field/Focus` JavaScript method
    `JSEvent` | JSManager.`runEventFieldFormat(DocumentPanel panel, WidgetAnnotation annot, int commitKey, boolean willCommit)` Raise the `Field/Format` JavaScript method
    `JSEvent` | JSManager.`runEventFieldKeystroke(DocumentPanel panel, WidgetAnnotation annot, int commitKey, String change, String changeEx, boolean fieldFull, boolean keyDown, boolean modifier, int selStart, int selEnd, boolean shift, String value, boolean willCommit)` Raise the `Field/Keystroke` JavaScript method
    `JSEvent` | JSManager.`runEventFieldMouseDown(DocumentPanel panel, WidgetAnnotation annot, MouseEvent mevent)` Raise the `Field/Mouse Down` JavaScript method
    `JSEvent` | JSManager.`runEventFieldMouseEnter(DocumentPanel panel, WidgetAnnotation annot, MouseEvent mevent)` Raise the `Field/Mouse Enter` JavaScript method
    `JSEvent` | JSManager.`runEventFieldMouseExit(DocumentPanel panel, WidgetAnnotation annot, MouseEvent mevent)` Raise the `Field/Mouse Exit` JavaScript method
    `JSEvent` | JSManager.`runEventFieldMouseUp(DocumentPanel panel, WidgetAnnotation annot, MouseEvent mevent)` Raise the `Field/Mouse Up` JavaScript method
    `JSEvent` | JSManager.`runEventFieldValidate(DocumentPanel panel, WidgetAnnotation annot, String value, boolean shift, boolean modifier, String change, String changeEx, boolean keyDown)` Raise the `Field/Validate` JavaScript method
    `JSEvent` | JSManager.`runEventLinkMouseUp(DocumentPanel panel, AnnotationLink annot)` Raise the `Link/Mouse Up` JavaScript method
    `JSEvent` | JSManager.`runEventPageClose(DocumentPanel panel, PDFPage page)` Raise the `Page/Close` JavaScript method
    `JSEvent` | JSManager.`runEventPageOpen(DocumentPanel panel, PDFPage page)` Raise the `Page/Open` JavaScript method
    `static void` | SignatureProvider.`selectSignProvider(DocumentPanel docpanel, FormSignature field, JComponent comp, Point point, ActionListener listener)` Select a SignatureProvider that can be used to sign the specified signature field.
    `static void` | SignatureProvider.`selectVerifyProvider(DocumentPanel docpanel, FormSignature field, JComponent comp, Point point, ActionListener listener)` Select a SignatureProvider that can be used to verify the specified signature field.
    `void` | DocumentViewport.`setDocumentPanel(DocumentPanel panel)` Set the DocumentPanel that contains this DocumentViewport.
    `void` | DualPageDocumentViewport.`setDocumentPanel(DocumentPanel panel)`
    `void` | MultiPageDocumentViewport.`setDocumentPanel(DocumentPanel panel)`
    `void` | SidePanel.`setDocumentPanel(DocumentPanel panel)` Set the `DocumentPanel` this SidePanel is a member of.
    `void` | SinglePageDocumentViewport.`setDocumentPanel(DocumentPanel panel)`
    `static void` | SignatureProvider.`setSignatureState(DocumentPanel docpanel, FormSignature field, SignatureProvider.SignatureState state)` Set the `SignatureProvider.SignatureState` of this field - should be called by the `showVerifyDialog()` method after the field has been verified, to save the details of the verification.
    `static URL` | Util.`toURL(DocumentPanel docpanel, String path)` Attempt to convert a relative URL to an absolute one.

    Constructors in org.faceless.pdf2.viewer2 with parameters of type DocumentPanel
    Constructor and Description
    `ViewerEvent(PDFViewer viewer, DocumentPanel panel)` Create a new ViewerEvent manually

  - ### Uses of DocumentPanel in org.faceless.pdf2.viewer2.feature

    Methods in org.faceless.pdf2.viewer2.feature that return DocumentPanel
    Modifier and Type | Method and Description
    --- | ---
    `DocumentPanel` | ThumbnailPanel.View.`getDocumentPanel()` Get the DocumentPanel this View relates to

    Methods in org.faceless.pdf2.viewer2.feature with parameters of type DocumentPanel
    Modifier and Type | Method and Description
    --- | ---
    `void` | BackgroundTextExtractor.`extract(DocumentPanel docpanel)` This method is run by this feature when a new DocumentPanel is loaded.
    `JComponent` | TIFFExporter.`getComponent(DocumentPanel panel, File file)`
    `Exporter.ExporterTask` | PDFExporter.`getExporter(DocumentPanel docpanel, PDF pdf, JComponent c, OutputStream out)`
    `Exporter.ExporterTask` | TIFFExporter.`getExporter(DocumentPanel panel, PDF pdf, JComponent c, OutputStream out)`
    `Exporter.ExporterTask` | TextExporter.`getExporter(DocumentPanel panel, PDF pdf, JComponent c, OutputStream out)`
    `boolean` | PDFExporter.`isEnabled(DocumentPanel docpanel)`
    `boolean` | TextExporter.`isEnabled(DocumentPanel docpanel)`
    `boolean` | FormImportDataActionHandler.`matches(DocumentPanel panel, PDFAction action)`
    `boolean` | FormResetActionHandler.`matches(DocumentPanel panel, PDFAction action)`
    `boolean` | FormSubmitActionHandler.`matches(DocumentPanel panel, PDFAction action)`
    `boolean` | GenericNamedActionHandler.`matches(DocumentPanel panel, PDFAction action)`
    `boolean` | GoToActionHandler.`matches(DocumentPanel panel, PDFAction action)`
    `boolean` | ShowHideActionHandler.`matches(DocumentPanel panel, PDFAction action)`
    `boolean` | SoundActionHandler.`matches(DocumentPanel panel, PDFAction action)`
    `boolean` | URLActionHandler.`matches(DocumentPanel panel, PDFAction action)`
    `void` | FormImportDataActionHandler.`run(DocumentPanel docpanel, PDFAction action)`
    `void` | FormResetActionHandler.`run(DocumentPanel docpanel, PDFAction action)`
    `void` | FormSubmitActionHandler.`run(DocumentPanel docpanel, PDFAction action)`
    `void` | GenericNamedActionHandler.`run(DocumentPanel docpanel, PDFAction action)`
    `void` | GoToActionHandler.`run(DocumentPanel docpanel, PDFAction action)`
    `void` | ShowHideActionHandler.`run(DocumentPanel docpanel, PDFAction action)`
    `void` | SoundActionHandler.`run(DocumentPanel docpanel, PDFAction action)`
    `void` | URLActionHandler.`run(DocumentPanel panel, PDFAction action)`
    `static void` | GenericNamedActionHandler.`run(DocumentPanel docpanel, String action)` Run the specified "named" action.
    `void` | MarkupSelectionAction.`selectAction(DocumentPanel docpanel, TextSelection.RangeList list)`
    `void` | RedactSelectionAction.`selectAction(DocumentPanel docpanel, TextSelection.RangeList list)`
    `void` | TextCopyAction.`selectAction(DocumentPanel docpanel, TextSelection.RangeList range)`
    `void` | TextSelectionAction.`selectAction(DocumentPanel docpanel, TextSelection.RangeList ranges)` Run the action.
    `void` | NetworkSave.`setAdditionalHeaders(URLConnection con, DocumentPanel panel)` Set any additional headers on the connection, or modify the PDF if necessary before saving.
    `void` | SearchPanel.Results.`setDocumentPanel(DocumentPanel docpanel)`
    `void` | ThumbnailPanel.ThumbnailSidePanel.`setDocumentPanel(DocumentPanel docpanel)`
    `void` | FormBlankSignatureWidgetFactory.`sign(FormSignature field, DocumentPanel docpanel, SignatureProvider provider)` Sign the field, by calling the `showSignDialog()` method on the specified SignatureServiceProvider.
    `void` | InvisiblySignDocument.`sign(FormSignature field, DocumentPanel docpanel, SignatureProvider provider)` Sign the Signature field.
    `void` | BackgroundTextExtractor.`startExtraction(DocumentPanel docpanel)` Start a background thread to run the `BackgroundTextExtractor.extract(org.faceless.pdf2.viewer2.DocumentPanel)` method
    `void` | BackgroundSignatureVerifier.`startVerification(DocumentPanel docpanel, Collection<? extends FormElement> fields)` Start a background thread that runs the `verify()` method
    `void` | FormSubmitActionHandler.`submit(DocumentPanel docpanel, String url, String method, String[] fields, int annotations, int flags)` Submit the document form.
    `void` | BackgroundSignatureVerifier.`verify(DocumentPanel docpanel, Collection<? extends FormElement> fields)` Verify the specified collection of fields.
    `void` | FormSignedSignatureWidgetFactory.`verify(FormSignature field, DocumentPanel docpanel, SignatureProvider provider)` Verify the signature field, by calling the `showVerifyDialog()` method on the specified SignatureProvider

Copyright © 2001-2015 Big Faceless Organization