PDFNotesBean (Qoppa jPDFNotes API)

java.lang.Object
- java.awt.Component
- - java.awt.Container
  - - javax.swing.JComponent
    - - javax.swing.JPanel
      - com.qoppa.pdfViewer.PDFViewerBean
        
        com.qoppa.pdfNotes.PDFNotesBean

All Implemented Interfaces:

IPDFActionHandler, IDocumentListener, IPassword, IPDFSaver, IPDFOpener, ActionListener, KeyListener, ImageObserver, MenuContainer, Serializable, EventListener, Accessible
```
public class PDFNotesBean
extends PDFViewerBean
implements IPDFSaver
```
PDFNotesBean is a component that can be used to display and annotate PDF documents within an application or an applet. The bean takes a PDF document as a file name, a URL or an InputStream, reads the document and then displays the document, allowing the user to navigate and add annotations to the document.
The bean can save the document to a file but also allows the host application to define a custom 'saver' to be able to save the document somewhere different than a file (database, server, etc). The bean can be extended and the save method overridden to get the same effect.

Author:

Qoppa Software

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`PDFNotesBean.KeyInfoNotes` This is the Main-Class for the jPDFNotes.jar that can generate server key requests, validate a key, and display server information.

Nested classes/interfaces inherited from class com.qoppa.pdfViewer.PDFViewerBean
PDFViewerBean.KeyInfoViewer

Nested classes/interfaces inherited from class javax.swing.JComponent
JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Component
Component.BaselineResizeBehavior

Field Summary
- Fields inherited from class com.qoppa.pdfViewer.PDFViewerBean
  PAGEMODE_CONTINUOUS, PAGEMODE_COVER, PAGEMODE_COVER_CONTINUOUS, PAGEMODE_FACING, PAGEMODE_FACING_CONTINUOUS, PAGEMODE_SINGLEPAGE, SPLITPOLICY_NEVER_VISIBLE, SPLITPOLICY_USEDOCUMENTPAGEMODE, SPLITPOLICY_VISIBLE, ZOOMMODE_FITPAGE, ZOOMMODE_FITWIDTH, ZOOMMODE_NORMAL
- Fields inherited from class javax.swing.JComponent
  TOOL_TIP_TEXT_KEY, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
- Fields inherited from class java.awt.Component
  BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
- Fields inherited from interface java.awt.image.ImageObserver
  ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors
Constructor and Description

PDFNotesBean()
Construct a PDFNotesBean.

Constructors
Constructor and Description
`PDFNotesBean()` Construct a PDFNotesBean.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`actionPerformed(ActionEvent ae)` This method handles actions from the toolbars in the bean.
`JButton`	`activateOCR()` Activates the OCR function for this `PDFNotesBean`.
`void`	`addAnnotation(Annotation newAnnot, int pageIndex)` Add an annotation to the document programmatically.
`void`	`addAnnotation(Annotation newAnnot, int pageIndex, boolean setRotation)` Add an annotation to the document programmatically.
`void`	`addNotify()` This is an internal method that overwrites the addNotify() method in JComponent and is used to do whatever is needed when PDFNotesBean is added to a parent container.
`void`	`addPDFListener(IPDFListener listener)` Adds a PDF Listener object to receive notifications when a new document is opened.
`void`	`addSignatureField()` This method starts the signature field creation process.
`SignatureField`	`addSignatureField(String fieldName, Rectangle2D bounds, int pageIndex)` Add a signature field to a page in the currently loaded document.
`boolean`	`canPaste()` Look at the contents of the system clipboard and determine if the object in the clipboard can be pasted into jPDFNotes.
`boolean`	`close(boolean checkSave)` This method closes the current document.
`void`	`commitEdits()` This method will commit any edits that are currently in progress.
`void`	`documentChanged(DocumentEvent de)` Internal method, do not use.
`static void`	`enableSpellChecking(boolean enable, boolean showSubMenu)` This will enable spell checking in text components using JOrtho.
`AnnotAlignmentToolbar`	`getAnnotAlignmentToolBar()` Returns the `AnnotAlignmentToolbar` used to align selected annotations
`IAnnotationManagerNotes`	`getAnnotationManager()` Returns the annotation manager for this PDFNotesBean.
`AnnotPropertiesToolbar`	`getAnnotPropertiesToolBar()` Returns the `AnnotPropertiesToolbar` used to modify common annotation properties.
`AnnotToolbar`	`getAnnotToolbar()` Returns the annotation tools toolbar.
`AttachmentPanel`	`getAttachmentPanel()` Returns an interface to allow access to the attachment panel.
`CommentPanelNotes`	`getCommentPanel()` Returns an interface to allow access to the comment panel.
`EditToolbar`	`getEditToolbar()` Returns the standard toolbar.
`GridSettings`	`getGridSettings()` Returns the current gride settings.
`MutableDocument`	`getMutableDocument()` This method returns a mutable PDF document, that is, a document that can be modified by the calling applications.
`PageViewPanelNotes`	`getPageViewPanel()` Returns an interface to allow access to the page view panel.
`RulerSettings`	`getRulerSettings()` Gets the current ruler settings.
`SelectToolbarNotes`	`getSelectToolbar()` Returns the selection toolbar.
`SignaturePanelNotes`	`getSignaturePanel()` Returns an interface to allow access to the signature panel.
`TextAnnotPropertiesToolbar`	`getTextAnnotPropertiesToolBar()` Returns the `TextAnnotPropertiesToolbar` used to modify common annotation properties.
`ThumbnailPanelNotes`	`getThumbnailPanel()` Returns a reference to the thumbnail panel, the panel that displays the page thumbnails.
`UndoManager`	`getUndoManager()` Returns the `UndoManager` for this `PDFNotesBean`.
`static String`	`getVersion()` Returns version string for jPDFNotes.
`void`	`handleAction(Action action)` This method overrides the PDFViewerBean handleAction to take care of actions that are specific to jPDFNotes, such as saving the document.
`boolean`	`isModified()` Returns whether this document has been modified or not.
`boolean`	`isOpenPDFOnly()` Returns whether the user is allowed to open PDF files only.
`void`	`keyPressed(KeyEvent e)` Handle key pressed events.
`void`	`loadDocument(InputStream inStream, String formatName)` Open a document from an input stream.
`void`	`loadDocument(String fileName)` Method to open files of PDF, JPEG, TIFF and PNG types.
`void`	`loadFDF(String fileName)` Load an FDF file.
`static void`	`loadLicense(InputStream licenseStream)` Method to load a license file from an inputstream.
`static void`	`loadLicense(String licenseFile)` Method to load a license file.
`void`	`loadPDF(InputStream inStream)` Load and display a PDF document using an InputStream.
`void`	`loadPDF(PDFSource pdfSource)` Load and display a PDF document using a PDFSource object
`void`	`loadPDF(String fileName)` Load and display a PDF document using a file name.
`void`	`loadPDF(URL url)` Load and display a PDF document using a URL.
`void`	`loadTextDocument(String fileName, TextToPDFSettings settings)` Method to open text files .
`void`	`loadXFDF(String fileName)` Load an XFDF file.
`void`	`openFile(PDFViewerBean viewerBean)` This method is called whenever the user presses the file open button.
`void`	`paste()` this method checks the clipboard and pastes any object that it can handle into the document.
`void`	`print(PrintSettings printSettings)` Prints the PDF document to a printer.
`void`	`reloadDocument()` Reloads a document into the viewer.
`void`	`removeAnnotation(Annotation annot, int pageIndex)` Remove an annotation from the document programmatically.
`void`	`removeNotify()` This is an internal method that overwrites the removeNotify() method in JComponent and is used to do whatever is needed when PDFNotesBean is removed from a parent container.
`boolean`	`removePDFListener(IPDFListener listener)` Removes a PDF Listener object.
`void`	`revert()` Reverts the loaded document to the original document.
`boolean`	`save()` This method saves the current document, it is called when the Save button is pressed in the toolbar.
`boolean`	`save(PDFNotesBean notesBean, String docName, File pdfFile)` This method saves the pdf to a file.
`boolean`	`saveAs()` This method implements the standard 'Save As...' function by prompting for a new file name and calling the save method with this file name.
`void`	`saveDocument(OutputStream outStream)` Saves a copy of this document to an output stream.
`void`	`saveDocument(String fileName)` Saves a copy of this document to a file.
`static boolean`	`setAppletKey(String key, Applet applet)` Sets the product key when running from an applet.
`void`	`setCommentComponentsVisible(boolean visible)` This method will set hiding of comments components on and off.
`void`	`setDocument(IPDFDocument pdfDoc)` Sets this bean's document.
`void`	`setGridSettings(GridSettings gridSettings)` Sets the grid settings.
`static boolean`	`setKey(String key)` Sets product key.
`void`	`setModified(boolean modified)` Flag this document as modified.
`void`	`setOpenPDFOnly(boolean openPDFOnly)` Sets a flag to determine whether the user can open PDF files only, or is allowed to open image files in JPEG, TIFF or PNG formats.
`void`	`setPageMode(int pageMode)` Sets the page viewing mode in the viewer.
`void`	`setPDFSaver(IPDFSaver saver)` This method allows the host application to override the default PDF Saver, the class that saves the document when the save toolbar button is pressed.
`void`	`setRulerSettings(RulerSettings rulerSettings)` Sets the ruler settings.
`static boolean`	`setWebstartKey(String key)` Sets the product key when running from Web Start.
`void`	`showSignWarning(boolean showSignWarning)` When modifying and saving a document that has a signed signature field, `PDFNotesBean` will show a warning that the signature may be invalidated.
`void`	`signDocument(SignatureField signField)` Starts the signing GUI for a given signature field.
`void`	`signDocument(SignatureField signField, boolean certify)` Starts the signing GUI for a given signature field.
`void`	`signDocument(SignatureField signField, SigningInformation signingInfo, File outputFile)` This method will sign and save the document.
`void`	`startEdit(Annotation annot, boolean useDefault, boolean isSticky)` This method starts an annotation editor appropriate to the type of annotation passed to it.
`void`	`startMeasurementCalibration()` This method begins the process of calibrating the scale used with the Distance, Perimeter, and Area measuring tools.

Methods inherited from class com.qoppa.pdfViewer.PDFViewerBean
addAnnotationToSelection, addHistoryListener, clearDocument, closeAdvancedSearch, closeSearch, deselectAnnotation, getAcroForm, getBookmarkPanel, getContentTreePanel, getCurrentLocation, getDestinationPanel, getDocument, getEmailHandler, getInitialViewSettings, getLayerPanel, getLocationHistory, getPageByLocation, getPageCount, getPageMode, getPageNumber, getPageView, getPasswordHandler, getPasswords, getRightSplitPolicy, getRootPane, getRotation, getScale2D, getScrollPane, getSecurityPanel, getSelectedText, getSplitPolicy, getSubmitActionEmailHandler, getTagPanel, getToolbar, getToolbarButtonGroup, getWatermark, getWindowHandler, getZoomMode, gotoNextView, gotoPreviousView, isCommentComponentsVisible, isCreateLinksFromURLs, isFieldsHighlight, isIncrementalLoading, isRightSplitOpen, isSplitOpen, isTouchEnabled, keyReleased, keyTyped, openFile, releaseTileImages, removeHistoryListener, rotateCCW, rotateCW, scrollToAnnotation, scrollToPage, scrollToPage, selectAnnotation, setCreateLinksFromURLs, setEmailHandler, setFieldsHighlight, setHorzDividerLocation, setIncrementalLoad, setInvertColorsMode, setLeftDividerLocation, setLocationHistory, setPage, setPasswordHandler, setPDFOpener, setPrintSettings, setRightDividerLocation, setRightSplitOpen, setRightSplitPolicy, setRightSplitVisible, setRotation, setScale2D, setScreenResolution, setSnapshotHandler, setSplitOpen, setSplitPolicy, setSplitVisible, setSubmitActionEmailHandler, setTextSelectionColors, setTouchEnabled, setVertDividerLocation, setWatermark, setWindowHandler, setZoomMode, showError, showMessage, startAdvancedSearch, startAdvancedSearch, startLoupeTool, startMagnifyRect, startSearch, startTextSelection, stopTextSelection, zoomToRect

Methods inherited from class javax.swing.JPanel
getAccessibleContext, getUI, getUIClassID, setUI, updateUI

Methods inherited from class javax.swing.JComponent
addAncestorListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintImmediately, paintImmediately, print, printAll, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate

Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, contains, createImage, createImage, createVolatileImage, createVolatileImage, dispatchEvent, enable, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

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

- Constructor Detail
  - PDFNotesBean
```
public PDFNotesBean()
```
    Construct a PDFNotesBean.
- Method Detail
  - getVersion
```
public static String getVersion()
```
    Returns version string for jPDFNotes. If this is the demo version, the return string will contain 'Demo Version' at the end.
  - setKey
```
public static boolean setKey(String key)
```
    Sets product key. Use this method after purchasing to remove evaluation restrictions.
    
    Parameters:
    
    key - Product key.
  - loadLicense
```
public static void loadLicense(InputStream licenseStream)
                        throws LicenseException
```
    Method to load a license file from an inputstream. This is useful when the license file is placed in the classpath of the host application and an input stream can be opened to it as a resource.
    
    Parameters:
    
    licenseStream - The input stream for the license file contents.
    
    Throws:
    
    LicenseException - If there are any problems with the license file
  - loadLicense
```
public static void loadLicense(String licenseFile)
                        throws LicenseException,
                               IOException
```
    Method to load a license file.
    
    Parameters:
    
    licenseFile - The full path to the license file.
    
    Throws:
    
    LicenseException - If there are any problems with the license file
    
    IOException
  - setAppletKey
```
public static boolean setAppletKey(String key,
                                   Applet applet)
```
    Sets the product key when running from an applet. Use this method after purchasing to remove evaluation restrictions.
    
    Parameters:
    
    key - Product key
    
    applet - The applet that we are running in.
  - setWebstartKey
```
public static boolean setWebstartKey(String key)
```
    Sets the product key when running from Web Start. Use this method after purchasing to remove evaluation restrictions.
    
    Parameters:
    
    key - Product key
  - getEditToolbar
```
public EditToolbar getEditToolbar()
```
    Returns the standard toolbar. Host applications can use this method to be able to change the behaviour of the toolbar, such as making buttons visible/invisible, adding listeners, etc. See EditToolbar for details.
    
    Returns:
    
    The edit bean's toolbar.
  - reloadDocument
```
public void reloadDocument()
```
    Reloads a document into the viewer. This method should be called when a document has been modified in some way that the viewer would not detect. When the method is called, bookmarks, page thumb views, etc are re-generated.
  - removeAnnotation
```
public void removeAnnotation(Annotation annot,
                             int pageIndex)
                      throws PDFException
```
    Remove an annotation from the document programmatically. Using this method, the host application can remove annotations from the document without user interaction.
    
    Parameters:
    
    annot - The annotation to be removed
    
    pageIndex - The page where the annotation is currently displayed, pageIndex starts at 0.
    
    Throws:
    
    PDFException
  - getAnnotToolbar
```
public AnnotToolbar getAnnotToolbar()
```
    Returns the annotation tools toolbar. This method provides access to the annotation toolbar so that the host application can modify the standard behaviour and buttons of the toolbar.
    
    Returns:
    
    Reference to the annotation toolbar.
  - getThumbnailPanel
```
public ThumbnailPanelNotes getThumbnailPanel()
```
    Returns a reference to the thumbnail panel, the panel that displays the page thumbnails.
    
    Overrides:
    
    getThumbnailPanel in class PDFViewerBean
    
    Returns:
    
    Reference to the thumbnail panel.
  - actionPerformed
```
public void actionPerformed(ActionEvent ae)
```
    This method handles actions from the toolbars in the bean. The method overrides PDFViewerBean to handle editing commands and calls PDFViewerBean.actionPerformed for the standard buttons.
    
    Specified by:
    
    actionPerformed in interface ActionListener
    
    Overrides:
    
    actionPerformed in class PDFViewerBean
    
    Parameters:
    
    ae - The action event.
  - getSelectToolbar
```
public SelectToolbarNotes getSelectToolbar()
```
    Returns the selection toolbar. This toolbar extends the SelectToolbar and adds an Object select button, which is defaulted to not visible.
    
    Overrides:
    
    getSelectToolbar in class PDFViewerBean
    
    Returns:
    
    Reference to the selection toolbar.
  - getMutableDocument
```
public MutableDocument getMutableDocument()
```
    This method returns a mutable PDF document, that is, a document that can be modified by the calling applications. Any changes to the document made through this object will be reflected on the screen: i.e. if a page is deleted, it will be removed from the view
    
    Returns:
    
    An object that allows modifications to the underlying PDF document.
  - startEdit
```
public void startEdit(Annotation annot,
                      boolean useDefault,
                      boolean isSticky)
```
    This method starts an annotation editor appropriate to the type of annotation passed to it. The method will start different editors for the following annotation types: Circle, Square, Ink, FreeText, Text, Sound and Link.
    
    Parameters:
    
    annot - An annotation object.
    
    useDefault - Flag indicating whether the annotation properties should be set to default properties, as determined by the classes in the com.qoppa.pdfNotes.settings package
    
    isSticky - Flag indicating whether this tool should be "sticky". When a tool is sticky, it will start over after the user is done adding the annotation
  - revert
```
public void revert()
```
    Reverts the loaded document to the original document. If the document has been modified, this method will prompt the user to discard any changes, and then load the document. If a document was loaded from a file, the document will be reloaded from the file.
  - close
```
public boolean close(boolean checkSave)
```
    This method closes the current document. The method first checks if the current document has been modified (optionally) and if it has, asks the user whether it should be saved.
    
    Parameters:
    
    checkSave - Tells the method whether to ask the user to save the current document if it has been modified.
    
    Returns:
    
    true if the document was closed, false if user pressed cancel
  - setDocument
```
public void setDocument(IPDFDocument pdfDoc)
```
    Sets this bean's document. When this method is called, the bean will go back to page 1 of the document and reset the page control in the toolbar. The method will also start generating a new set of thumbviews for the pages.
    
    Overrides:
    
    setDocument in class PDFViewerBean
    
    Parameters:
    
    pdfDoc - The new document.
  - setCommentComponentsVisible
```
public void setCommentComponentsVisible(boolean visible)
```
    Description copied from class: PDFViewerBean
    
    This method will set hiding of comments components on and off. When false, comment components will be dynamically hidden. Comments will still show in the comment pane, but will not be displayed in the viewer. They will also not be rendered when printing. When true, comment components will be displayed as normal.
    
    Overrides:
    
    setCommentComponentsVisible in class PDFViewerBean
    
    Parameters:
    
    visible - Comment visibility flag
  - save
```
public boolean save(PDFNotesBean notesBean,
                    String docName,
                    File pdfFile)
```
    This method saves the pdf to a file. If there is no file name available, the method will prompt the user for a file name and then save to that file. If the pdfFile argument is null, this method behaves the same as saveAs(), it will prompt the user for a file name.
    This method fulfills the IPDFSaver interface and will be called by the Save button on the toolbar unless the saver has been set by the host application.
    This method can be overridden by a class that extends PDFNotesBean to customize saving behavior. Alternatively, a host application can call setPDFSaver with an object that implements IPDFSaver to use a custom saver. After setPDFSaver is called, all save functions will use the saver supplied by the host application.
    
    Specified by:
    
    save in interface IPDFSaver
    
    Parameters:
    
    notesBean - Reference to the PDFNotesBean that holds the document.
    
    docName - The name of the PDF document, normally the file name.
    
    pdfFile - A reference to a file object if the PDF was loaded from a file, null if the PDF was opened from a URL or an InputStream.
    
    Returns:
    
    true if the document was saved properly, false if there was any errors.
    
    See Also:
    
    save(), saveAs()
  - saveDocument
```
public void saveDocument(String fileName)
                  throws PDFException,
                         IOException
```
    Saves a copy of this document to a file.
    
    Parameters:
    
    fileName - Name of the file to save the document.
    
    Throws:
    
    PDFException
    
    IOException
  - saveDocument
```
public void saveDocument(OutputStream outStream)
                  throws IOException,
                         PDFException
```
    Saves a copy of this document to an output stream. This method can be used in conjunction with a ByteArrayOutputStream to get a byte array holding the PDF document.
    
    Parameters:
    
    outStream - OutputStream where the document will be written to.
    
    Throws:
    
    IOException
    
    PDFException
  - saveAs
```
public boolean saveAs()
```
    This method implements the standard 'Save As...' function by prompting for a new file name and calling the save method with this file name.
    
    Returns:
    
    true if the document was saved properly, false if there were any errors or if user canceled.
    
    See Also:
    
    save(), save(PDFNotesBean, String, File)
  - save
```
public boolean save()
```
    This method saves the current document, it is called when the Save button is pressed in the toolbar.
    
    Returns:
    
    true if the document was saved properly, false if there were any errors.
  - loadPDF
```
public void loadPDF(PDFSource pdfSource)
             throws PDFException
```
    Load and display a PDF document using a PDFSource object
    
    Overrides:
    
    loadPDF in class PDFViewerBean
    
    Parameters:
    
    pdfSource - Object that implements the PDFSource interface.
    
    Throws:
    
    PDFException
  - loadPDF
```
public void loadPDF(InputStream inStream)
             throws PDFException
```
    Load and display a PDF document using an InputStream.
    
    Overrides:
    
    loadPDF in class PDFViewerBean
    
    Parameters:
    
    inStream - InputStream used to read the PDF document.
    
    Throws:
    
    PDFException
  - loadFDF
```
public void loadFDF(String fileName)
             throws PDFException
```
    Load an FDF file. This method will open the corresponding PDF file and import the FDF data in the document.
    
    Parameters:
    
    fileName - Name of the FDF document file.
    
    Throws:
    
    PDFException
  - loadXFDF
```
public void loadXFDF(String fileName)
              throws PDFException
```
    Load an XFDF file. This method will open the corresponding PDF file and import the XFDF data in the document.
    
    Parameters:
    
    fileName - Name of the xFDF document file.
    
    Throws:
    
    PDFException
  - loadPDF
```
public void loadPDF(String fileName)
             throws PDFException
```
    Load and display a PDF document using a file name.
    
    Overrides:
    
    loadPDF in class PDFViewerBean
    
    Parameters:
    
    fileName - Name of the PDF document file.
    
    Throws:
    
    PDFException
  - loadPDF
```
public void loadPDF(URL url)
             throws PDFException
```
    Load and display a PDF document using a URL.
    
    Overrides:
    
    loadPDF in class PDFViewerBean
    
    Parameters:
    
    url - URL pointing to the location of the PDF document.
    
    Throws:
    
    PDFException
  - print
```
public void print(PrintSettings printSettings)
           throws PDFPermissionException,
                  PrinterException
```
    Description copied from class: PDFViewerBean
    
    Prints the PDF document to a printer. This method will first prompt the user to choose a system printer and then it will print the document.
    
    If finer control of printing is necessary, the IPDFDocument object return by the getDocument() method implements both Printable and Pageable. The host application can then create its own PrinterJob and set any settings necessary, then call either setPageable or setPrintable with the IPDFDocument object and then start the print job.
    
    Overrides:
    
    print in class PDFViewerBean
    
    Parameters:
    
    printSettings - Print job settings. Use this object to tell jPDFViewer how to print the document. If null, the library will print using default settings.
    
    Throws:
    
    PDFPermissionException
    
    PrinterException
  - setPDFSaver
```
public void setPDFSaver(IPDFSaver saver)
```
    This method allows the host application to override the default PDF Saver, the class that saves the document when the save toolbar button is pressed.
    
    Parameters:
    
    saver - A reference to an object that implements the IPDFSaver interface.
  - addPDFListener
```
public void addPDFListener(IPDFListener listener)
```
    Adds a PDF Listener object to receive notifications when a new document is opened.
    
    Parameters:
    
    listener - The new listener.
  - removePDFListener
```
public boolean removePDFListener(IPDFListener listener)
```
    Removes a PDF Listener object.
    
    Parameters:
    
    listener - The new listener.
    
    Returns:
    
    true if the listener was removed, false otherwise
  - setModified
```
public void setModified(boolean modified)
```
    Flag this document as modified. If the host application modifies the document programmatically, it should call this method to flag the document as modified. Methods such as open and close check this flag to decide whether to prompt the user to save the current document or not.
    
    Parameters:
    
    modified - Flag indicating whether this document has been modified.
  - isModified
```
public boolean isModified()
```
    Returns whether this document has been modified or not.
    
    Returns:
    
    true if the document has changed, false otherwise.
  - documentChanged
```
public void documentChanged(DocumentEvent de)
```
    Internal method, do not use.
    
    Specified by:
    
    documentChanged in interface IDocumentListener
    
    Overrides:
    
    documentChanged in class PDFViewerBean
  - commitEdits
```
public void commitEdits()
```
    This method will commit any edits that are currently in progress. This method is useful to ensure that an ongoing edit to a form field is committed from the GUI to the Acroform before processing field values.
    
    Overrides:
    
    commitEdits in class PDFViewerBean
  - addAnnotation
```
public void addAnnotation(Annotation newAnnot,
                          int pageIndex)
                   throws PDFException
```
    Add an annotation to the document programmatically. Using this method, the host application can add annotations to the document without user interaction.
    
    Parameters:
    
    newAnnot - The new annotation.
    
    pageIndex - The page at which to add the annotation, pageIndex starts at 0.
    
    Throws:
    
    PDFException
  - addAnnotation
```
public void addAnnotation(Annotation newAnnot,
                          int pageIndex,
                          boolean setRotation)
                   throws PDFException
```
    Add an annotation to the document programmatically. Using this method, the host application can add annotations to the document without user interaction.
    
    Parameters:
    
    newAnnot - The new annotation.
    
    pageIndex - The page at which to add the annotation, pageIndex starts at 0.
    
    setRotation - Set false if the annotation should not be oriented according to the page's rotation
    
    Throws:
    
    PDFException
  - addSignatureField
```
public SignatureField addSignatureField(String fieldName,
                                        Rectangle2D bounds,
                                        int pageIndex)
                                 throws PDFException
```
    Add a signature field to a page in the currently loaded document. Signature fields are used to digitally sign PDF documents. When this method is called, an empty signature field is added that can be signed by a user. To sign the document programmatically, the host application can call signDocument.
    
    Parameters:
    
    fieldName - The name of the field.
    
    bounds - The bounds on the page for the field. If bounds are set to (0,0,0,0) then the signature is invisible.
    
    pageIndex - The page number.
    
    Throws:
    
    PDFException
  - addSignatureField
```
public void addSignatureField()
```
    This method starts the signature field creation process. The user is able to use the mouse to draw a signature field on the document. This method is called when the signature button is pressed on the toolbar.
  - signDocument
```
public void signDocument(SignatureField signField)
                  throws PDFException
```
    Starts the signing GUI for a given signature field. This method will display a number of dialogs to the user to to choose a PKCS#12 file and to get any additional information needed to sign the document. After the signature is applied, the method will save the document to the same file or to a new file according to what the user chose.
    
    Parameters:
    
    signField - The signature field to apply the signature to.
    
    Throws:
    
    PDFException
  - signDocument
```
public void signDocument(SignatureField signField,
                         boolean certify)
                  throws PDFException
```
    Starts the signing GUI for a given signature field. This method will display a number of dialogs to the user to to choose a PKCS#12 file and to get any additional information needed to sign the document. After the signature is applied, the method will save the document to the same file or to a new file according to what the user chose.
    
    Parameters:
    
    signField - The signature field to apply the signature to.
    
    certify - Option to select the certify signature option
    
    Throws:
    
    PDFException
  - signDocument
```
public void signDocument(SignatureField signField,
                         SigningInformation signingInfo,
                         File outputFile)
                  throws PDFException
```
    This method will sign and save the document. The signature information is passed in to the method, so the method does not prompt the user for any additional information. After signing, the document will be saved to outputFile.
    
    Parameters:
    
    signField - The signature field to apply the signature to.
    
    signingInfo - The signature information.
    
    outputFile - The output file to save the document to. If this is null, the document will be saved to the current file.
    
    Throws:
    
    PDFException
  - showSignWarning
```
public void showSignWarning(boolean showSignWarning)
```
    When modifying and saving a document that has a signed signature field, PDFNotesBean will show a warning that the signature may be invalidated. To disable this warning message, set this value to false.
    
    Parameters:
    
    showSignWarning - true to show the signed signature warning, otherwise false
  - handleAction
```
public void handleAction(Action action)
```
    This method overrides the PDFViewerBean handleAction to take care of actions that are specific to jPDFNotes, such as saving the document. This method can be further overridden to handle actions in a custom manner. The parameter passed in will be an instance of an object derived from Action and can be tested using 'instanceof' to determine the kind of action.
    
    Specified by:
    
    handleAction in interface IPDFActionHandler
    
    Overrides:
    
    handleAction in class PDFViewerBean
    
    Parameters:
    
    action - Object describing the action.
  - openFile
```
public void openFile(PDFViewerBean viewerBean)
              throws PDFException
```
    This method is called whenever the user presses the file open button. This implementation of the method overrides the PDFViewerBean implementation to allow opening JPEG, TIFF and PNG files.
    
    Specified by:
    
    openFile in interface IPDFOpener
    
    Overrides:
    
    openFile in class PDFViewerBean
    
    Parameters:
    
    viewerBean - The PDFViewerBean object that initiated the open file action.
    
    Throws:
    
    PDFException
  - loadDocument
```
public void loadDocument(InputStream inStream,
                         String formatName)
                  throws PDFException,
                         IOException
```
    Open a document from an input stream. This method will take different document types. Use the predefined constants DOCTYPE_* to tell the method what type of contents the input stream has.
    
    Parameters:
    
    inStream - The input stream to read the document from.
    
    formatName - The name of the format of the input content data. Valid format names are pdf, tiff, tif, png, jpg, jpeg and jpe and are case insensitive.
    
    Throws:
    
    PDFException
    
    IOException
  - loadDocument
```
public void loadDocument(String fileName)
                  throws PDFException,
                         IOException
```
    Method to open files of PDF, JPEG, TIFF and PNG types. The method will look at the file extension to determine how to open the file. If an image file, the file is converted to PDF and then displayed. When these files are saved, the bean can only save as PDF.
    
    Parameters:
    
    fileName - The name of the file to open.
    
    Throws:
    
    PDFException
    
    IOException
  - loadTextDocument
```
public void loadTextDocument(String fileName,
                             TextToPDFSettings settings)
                      throws PDFException,
                             IOException
```
    Method to open text files . The file is converted to PDF and then displayed. When these files are saved, the bean can only save as PDF.
    
    Parameters:
    
    fileName - The name of the file to open.
    
    settings - The settings to use when converting the text file to PDF.
    
    Throws:
    
    PDFException
    
    IOException
  - isOpenPDFOnly
```
public boolean isOpenPDFOnly()
```
    Returns whether the user is allowed to open PDF files only.
    
    Returns:
    
    Flag indicating whether the user is allowed to open PDF files only.
  - setOpenPDFOnly
```
public void setOpenPDFOnly(boolean openPDFOnly)
```
    Sets a flag to determine whether the user can open PDF files only, or is allowed to open image files in JPEG, TIFF or PNG formats. This flag is used in setting the filters for the file chooser dialog.
    
    Parameters:
    
    openPDFOnly - The new value of the flag.
  - keyPressed
```
public void keyPressed(KeyEvent e)
```
    Description copied from class: PDFViewerBean
    
    Handle key pressed events. PDFViewerBean handles page up and page down events to let the user scroll up and down the document using these keys.
    
    Specified by:
    
    keyPressed in interface KeyListener
    
    Overrides:
    
    keyPressed in class PDFViewerBean
  - canPaste
```
public boolean canPaste()
```
    Look at the contents of the system clipboard and determine if the object in the clipboard can be pasted into jPDFNotes.
    
    Returns:
    
    Flag indicating whether the object in the clipboard can be pasted into jPDFNotes.
  - paste
```
public void paste()
```
    this method checks the clipboard and pastes any object that it can handle into the document. Currently, the method can only paste annotations, which are placed on the clipboard when the user presses the Ctrl+C key.
  - startMeasurementCalibration
```
public void startMeasurementCalibration()
```
    This method begins the process of calibrating the scale used with the Distance, Perimeter, and Area measuring tools. When this method is called, the user will be prompted to select a start and end point and then be prompted for the distance that measurement should be. The scale will be calculated and will be reflected in any subsequent measurements.
    This method does nothing if a document is open since this feature requires a document.
  - getAnnotationManager
```
public IAnnotationManagerNotes getAnnotationManager()
```
    Returns the annotation manager for this PDFNotesBean.
    
    Overrides:
    
    getAnnotationManager in class PDFViewerBean
    
    Returns:
    
    The annotation manager for this PDFNotesBean
  - getPageViewPanel
```
public PageViewPanelNotes getPageViewPanel()
```
    Returns an interface to allow access to the page view panel. The interface provides methods to access the PopupMenus which appear on the page.
    
    Overrides:
    
    getPageViewPanel in class PDFViewerBean
    
    Returns:
    
    Interface to the page view panel
  - getCommentPanel
```
public CommentPanelNotes getCommentPanel()
```
    Returns an interface to allow access to the comment panel. The interface provides methods to access the panel's toolbar as well as a list of comments / annotations.
    
    Overrides:
    
    getCommentPanel in class PDFViewerBean
    
    Returns:
    
    Interface to the comment panel
  - getSignaturePanel
```
public SignaturePanelNotes getSignaturePanel()
```
    Returns an interface to allow access to the signature panel. The interface provides methods to access the panel's toolbar and control the panel's visibility.
    
    Overrides:
    
    getSignaturePanel in class PDFViewerBean
    
    Returns:
    
    Interface to the signature panel
  - activateOCR
```
public JButton activateOCR()
```
    Activates the OCR function for this PDFNotesBean. A button is added to the PDFToolbar that initiates the OCR function.
    
    Returns:
    
    the button used to initiate the OCR function
  - getAnnotPropertiesToolBar
```
public AnnotPropertiesToolbar getAnnotPropertiesToolBar()
```
    Returns the AnnotPropertiesToolbar used to modify common annotation properties.
    
    Returns:
    
    the AnnotPropertiesToolbar
  - getTextAnnotPropertiesToolBar
```
public TextAnnotPropertiesToolbar getTextAnnotPropertiesToolBar()
```
    Returns the TextAnnotPropertiesToolbar used to modify common annotation properties.
    
    Returns:
    
    the TextAnnotPropertiesToolbar
  - getAnnotAlignmentToolBar
```
public AnnotAlignmentToolbar getAnnotAlignmentToolBar()
```
    Returns the AnnotAlignmentToolbar used to align selected annotations
    
    Returns:
    
    the AnnotAlignmentToolbar
  - getUndoManager
```
public UndoManager getUndoManager()
```
    Returns the UndoManager for this PDFNotesBean.
    
    Returns:
    
    the UndoManager for this PDFNotesBean
  - getAttachmentPanel
```
public AttachmentPanel getAttachmentPanel()
```
    Description copied from class: PDFViewerBean
    
    Returns an interface to allow access to the attachment panel. The interface provides methods to access the panel's toolbar as well as the attachment list.
    
    Overrides:
    
    getAttachmentPanel in class PDFViewerBean
    
    Returns:
    
    Interface to the attachment panel
  - setRulerSettings
```
public void setRulerSettings(RulerSettings rulerSettings)
```
    Sets the ruler settings. Set to null to hide the rulers. Use the settings to choose the units to use in the ruler, inches or centimeters.
    
    Parameters:
    
    rulerSettings - The new settings for the rulers, or null to hide the rulers.
  - getRulerSettings
```
public RulerSettings getRulerSettings()
```
    Gets the current ruler settings. The return value is read-only, so changing the object will not have any effect. To change settings, call setRulerSettings().
    
    Returns:
    
    The current ruler settings.
  - setGridSettings
```
public void setGridSettings(GridSettings gridSettings)
```
    Sets the grid settings. Set to null to hide the grid.
    
    Parameters:
    
    gridSettings - The new GridSettings or null to hide the grid.
  - getGridSettings
```
public GridSettings getGridSettings()
```
    Returns the current gride settings. The GridSettings object contains information about the grid units, width/height, subdivisions, and offsets. To change settings, call setGridSettings().
    
    Returns:
    
    GridSettings The current grid settings.
  - setPageMode
```
public void setPageMode(int pageMode)
```
    Description copied from class: PDFViewerBean
    
    Sets the page viewing mode in the viewer. The mode should be set using one of the predefined values: PAGEMODE_CONTINUOUS, PAGEMODE_SINGLEPAGE, PAGEMODE_FACING, PAGEMODE_FACING_CONTINUOUS, PAGEMODE_FACING_COVER, and PAGEMODE_FACING_CONTINUOUS_COVER
    
    Overrides:
    
    setPageMode in class PDFViewerBean
    
    Parameters:
    
    pageMode - The new page mode.
  - enableSpellChecking
```
public static void enableSpellChecking(boolean enable,
                                       boolean showSubMenu)
                                throws ClassNotFoundException
```
    This will enable spell checking in text components using JOrtho. For more information on JOrtho, see http://jortho.sourceforge.net. JOrtho is published under the GNU General Public License (GPL) for inclusion in programs published under a compatible open-source license. A commercial license must be purchased for commercial use. For more information regarding JOrtho licensing, see http://jortho.sourceforge.net/#license.
    To use this feature, you must have jortho.jar in your classpath and you must also replace several .class files with .class files available for download from Qoppa Software.
    
    Parameters:
    
    enable -
    
    Throws:
    
    ClassNotFoundException
  - addNotify
```
public void addNotify()
```
    This is an internal method that overwrites the addNotify() method in JComponent and is used to do whatever is needed when PDFNotesBean is added to a parent container. Do not use.
    
    Overrides:
    
    addNotify in class PDFViewerBean
  - removeNotify
```
public void removeNotify()
```
    This is an internal method that overwrites the removeNotify() method in JComponent and is used to do whatever is needed when PDFNotesBean is removed from a parent container. Do not use.
    
    Overrides:
    
    removeNotify in class PDFViewerBean

Class PDFNotesBean

Nested Class Summary

Nested classes/interfaces inherited from class com.qoppa.pdfViewer.PDFViewerBean

Nested classes/interfaces inherited from class javax.swing.JComponent

Nested classes/interfaces inherited from class java.awt.Component

Field Summary

Fields inherited from class com.qoppa.pdfViewer.PDFViewerBean

Fields inherited from class javax.swing.JComponent

Fields inherited from class java.awt.Component

Fields inherited from interface java.awt.image.ImageObserver

Constructor Summary

Method Summary

Methods inherited from class com.qoppa.pdfViewer.PDFViewerBean

Methods inherited from class javax.swing.JPanel

Methods inherited from class javax.swing.JComponent

Methods inherited from class java.awt.Container

Methods inherited from class java.awt.Component

Methods inherited from class java.lang.Object

Constructor Detail

PDFNotesBean

Method Detail

getVersion

setKey

loadLicense

loadLicense

setAppletKey

setWebstartKey

getEditToolbar

reloadDocument

removeAnnotation

getAnnotToolbar

getThumbnailPanel

actionPerformed

getSelectToolbar

getMutableDocument

startEdit

revert

close

setDocument

setCommentComponentsVisible

save

saveDocument

saveDocument

saveAs

save

loadPDF

loadPDF

loadFDF

loadXFDF

loadPDF

loadPDF

print

setPDFSaver

addPDFListener

removePDFListener

setModified

isModified

documentChanged

commitEdits

addAnnotation

addAnnotation

addSignatureField

addSignatureField

signDocument

signDocument

signDocument

showSignWarning

handleAction

openFile

loadDocument

loadDocument

loadTextDocument

isOpenPDFOnly

setOpenPDFOnly

keyPressed

canPaste

paste

startMeasurementCalibration

getAnnotationManager

getPageViewPanel