com.qoppa.pdfEditor

Class PDFEditorBean

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

com.qoppa.pdfViewer.PDFViewerBean

com.qoppa.pdfNotes.PDFNotesBean

com.qoppa.pdfEditor.PDFEditorBean

All Implemented Interfaces:

IPDFActionHandler, IDocumentListener, IPassword, IPDFSaver, IPDFOpener, ActionListener, KeyListener, ImageObserver, MenuContainer, Serializable, EventListener, Accessible

public class PDFEditorBean
extends PDFNotesBean

PDFEditorBean is a component that can be used to display, annotate and edit PDF documents within a Java application or an applet. The bean can open PDF documents from files, URLs, InputStream and will display the document, allowing the user to navigate and annotate, edit or redact the document.

Documents can be saved to files, output stream and even to a web server, when running in a browser. The component provides extensive functionality "as is" and can be easily extended to provide a full PDF editor to your end users.

Author:

Qoppa Software

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PDFEditorBean.KeyInfoEditor This is the Main-Class for the jPDFEditor.jar that can generate server key requests, validate a key, and display server information.

Nested classes/interfaces inherited from class com.qoppa.pdfNotes.PDFNotesBean

PDFNotesBean.KeyInfoNotes

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

Modifier and Type	Field and Description
static int	MODE_COMPARE_OVERLAY Overlay comparison mode.
static int	MODE_COMPARE_SIDEBYSIDE Side by side comparison mode.

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
PDFEditorBean() Create a new PDFEditorBean component.

Method Summary

Modifier and Type	Method and Description
void	actionPerformed(ActionEvent ae) Handle actions registered with this component.
boolean	addCompareListener(CompareListener listener) Adds a CompareListener to be notified when comparison modes are started or stopped.
boolean	addOutputPreviewListener(OutputPreviewListener listener) Adds an OutputPreviewListener to be notified when output preview mode is started or stopped.
void	applyRedactionAnnotation(Redaction redaction) Apply the redaction annotation to the document.
void	applyRedactionAnnotations() Apply redaction annotations to the document.
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) Handle content change events.
BookmarkPanelEditor	getBookmarkPanelEditor() Returns an interface to allow access to the bookmarks panel.
PDFDocument	getCompareDocument() Gets the PDFDocument that is overlayed or in side by side comparison with the current document.
PDFDocument	getDocument() Returns the PDF document currently displayed.
CompareOverlayOptions	getOverlayOptions() Get the current overlay options.
PageViewPanelEditor	getPageViewPanelEditor() Returns an interface to allow access to the page view panel.
static String	getVersion() Returns version string for jPDFNotes.
boolean	isCompareOverlay() Returns true if overlay comparison mode is active.
boolean	isCompareSidebySide() Returns true if side by side comparison is active.
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	paste() Override parent's paste method to handle pasting of content.
boolean	removeCompareListener(CompareListener listener) Removes the CompareListener.
boolean	removeOutputPreviewListener(OutputPreviewListener listener) Removes the OutputPreviewListener.
boolean	save() This method saves the current document, it is called when the Save button is pressed in the toolbar.
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.
static boolean	setAppletKey(String key, Applet applet) Sets the product key when running from an applet.
void	setGridSettings(GridSettings gridSettings) Sets the grid settings.
static boolean	setKey(String key) Sets product key.
boolean	setOutputPreview(ColorSpace outputCS, boolean simOverprint, Color background) This method will set the output color space that jPDFEditor should render to.
void	setRulerSettings(RulerSettings rulerSettings) Sets the ruler settings.
static boolean	setWebstartKey(String key) Sets the product key when running from Web Start.
void	startCompare(PDFDocument comparePDF, int mode, CompareOverlayOptions overlayOptions) Starts a comparison between the current document and a second document in the specified mode (one of PDFEditorBean.MODE_COMPARE_OVERLAY or PDFEditorBean.MODE_COMPARE_SIDEBYSIDE).
void	startOutputPreview(List<NamedColorSpace> namedColorSpaces, OutputPreviewOptions options) Starts Output Preview mode which allows the simulation of overprint, color spaces, and background colors.
void	stopCompareOverlay() Stops overlay comparison mode.
boolean	stopCompareSideBySide() Stops side by side comparison mode.
void	stopOutputPreview() Stops Output Preview mode which allows the simulation of overprint, color spaces, and background colors.

Methods inherited from class com.qoppa.pdfNotes.PDFNotesBean

activateOCR, addAnnotation, addAnnotation, addNotify, addPDFListener, addSignatureField, addSignatureField, canPaste, enableSpellChecking, getAnnotAlignmentToolBar, getAnnotationManager, getAnnotPropertiesToolBar, getAnnotToolbar, getAttachmentPanel, getCommentPanel, getEditToolbar, getGridSettings, getMutableDocument, getPageViewPanel, getRulerSettings, getSelectToolbar, getSignaturePanel, getTextAnnotPropertiesToolBar, getThumbnailPanel, getUndoManager, handleAction, isModified, isOpenPDFOnly, keyPressed, loadDocument, loadDocument, loadFDF, loadPDF, loadPDF, loadPDF, loadPDF, loadTextDocument, loadXFDF, openFile, print, reloadDocument, removeAnnotation, removeNotify, removePDFListener, revert, save, saveDocument, saveDocument, setCommentComponentsVisible, setDocument, setModified, setOpenPDFOnly, setPageMode, setPDFSaver, showSignWarning, signDocument, signDocument, signDocument, startEdit, startMeasurementCalibration

Methods inherited from class com.qoppa.pdfViewer.PDFViewerBean

addAnnotationToSelection, addHistoryListener, clearDocument, closeAdvancedSearch, closeSearch, deselectAnnotation, getAcroForm, getBookmarkPanel, getContentTreePanel, getCurrentLocation, getDestinationPanel, 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

Field Detail

MODE_COMPARE_OVERLAY

public static final int MODE_COMPARE_OVERLAY

Overlay comparison mode.

See Also:

Constant Field Values

MODE_COMPARE_SIDEBYSIDE

public static final int MODE_COMPARE_SIDEBYSIDE

Side by side comparison mode.

See Also:

Constant Field Values

Constructor Detail

PDFEditorBean

public PDFEditorBean()

Create a new PDFEditorBean component.

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

getDocument

public PDFDocument getDocument()

Returns the PDF document currently displayed.

Overrides:

getDocument in class PDFViewerBean

Returns:

The current document.

actionPerformed

public void actionPerformed(ActionEvent ae)

Handle actions registered with this component. This fulfills the ActionListener interface to handle actions from buttons related to content editing and redaction.

Specified by:

actionPerformed in interface ActionListener

Overrides:

actionPerformed in class PDFNotesBean

Parameters:

ae - The action event.

getPageViewPanelEditor

public PageViewPanelEditor getPageViewPanelEditor()

Returns an interface to allow access to the page view panel. The interface provides methods to access the PopupMenus which appear on the page.

Returns:

Interface to the page view panel

paste

public void paste()

Override parent's paste method to handle pasting of content.

Overrides:

paste in class PDFNotesBean

documentChanged

public void documentChanged(DocumentEvent de)

Handle content change events.

Specified by:

documentChanged in interface IDocumentListener

Overrides:

documentChanged in class PDFNotesBean

applyRedactionAnnotations

public void applyRedactionAnnotations()
                               throws PDFException

Apply redaction annotations to the document.

Throws:

PDFException

applyRedactionAnnotation

public void applyRedactionAnnotation(Redaction redaction)
                              throws PDFException

Apply the redaction annotation to the document.

Throws:

PDFException

save

public boolean save()

Description copied from class: PDFNotesBean

This method saves the current document, it is called when the Save button is pressed in the toolbar.

Overrides:

save in class PDFNotesBean

Returns:

true if the document was saved properly, false if there were any errors.

saveAs

public boolean saveAs()

Description copied from class: PDFNotesBean

This method implements the standard 'Save As...' function by prompting for a new file name and calling the save method with this file name.

Overrides:

saveAs in class PDFNotesBean

Returns:

true if the document was saved properly, false if there were any errors or if user canceled.

See Also:

PDFNotesBean.save(), PDFNotesBean.save(PDFNotesBean, String, File)

getBookmarkPanelEditor

public BookmarkPanelEditor getBookmarkPanelEditor()

Returns an interface to allow access to the bookmarks panel. The interface provides methods to access the panel's toolbar as well as the bookmark tree.

Returns:

Interface to the bookmark panel

setOutputPreview

public boolean setOutputPreview(ColorSpace outputCS,
                                boolean simOverprint,
                                Color background)

This method will set the output color space that jPDFEditor should render to. By default, content is rendered to sRGB color space to display on the screen. With this method, the host application can override the output color space that we render to preview what the output would look when rendered to other devices, such as CMYK printers.

Parameters:

outputCS - The output color space to render the content to.

simOverprint - Flag indicating whether the renderer should simulate overprinting.

Returns:

true if the profile was successfully applied.

startOutputPreview

public void startOutputPreview(List<NamedColorSpace> namedColorSpaces,
                               OutputPreviewOptions options)

Starts Output Preview mode which allows the simulation of overprint, color spaces, and background colors.

Parameters:

namedColorSpaces - A List of NamedColorSpace objects.

options - The initial Output Preview settings.

stopOutputPreview

public void stopOutputPreview()

Stops Output Preview mode which allows the simulation of overprint, color spaces, and background colors.

commitEdits

public void commitEdits()

This method will commit any edits that are currently in progress.

Overrides:

commitEdits in class PDFNotesBean

stopCompareOverlay

public void stopCompareOverlay()

Stops overlay comparison mode.

isCompareOverlay

public boolean isCompareOverlay()

Returns true if overlay comparison mode is active.

Returns:

true if overlay comparison mode is active.

getCompareDocument

public PDFDocument getCompareDocument()

Gets the PDFDocument that is overlayed or in side by side comparison with the current document.

Returns:

the PDFDocument that is overlayed or in side by side comparison with the current document.

stopCompareSideBySide

public boolean stopCompareSideBySide()

Stops side by side comparison mode. If the comparison document has been changed, it will prompt the user to save at which point they will have the option to cancel closing.

Returns:

true if the document was successfully closed.

isCompareSidebySide

public boolean isCompareSidebySide()

Returns true if side by side comparison is active.

Returns:

true if side by side comparison is active.

close

public boolean close(boolean checkSave)

Description copied from class: PDFNotesBean

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.

Overrides:

close in class PDFNotesBean

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

startCompare

public void startCompare(PDFDocument comparePDF,
                         int mode,
                         CompareOverlayOptions overlayOptions)

Starts a comparison between the current document and a second document in the specified mode (one of PDFEditorBean.MODE_COMPARE_OVERLAY or PDFEditorBean.MODE_COMPARE_SIDEBYSIDE). Settings for overlay comparison may also be specified, if left null default settings will be used.

Parameters:

comparePDF - The document to overlay or compare side by side.

mode - The comparison mode. One of PDFEditorBean.MODE_COMPARE_OVERLAY or PDFEditorBean.MODE_COMPARE_SIDEBYSIDE.

overlayOptions - Optionally specify the settings for overlay mode. If left null, default settings will be used.

getOverlayOptions

public CompareOverlayOptions getOverlayOptions()

Get the current overlay options.

Returns:

The current overlay options. May return null.

addCompareListener

public boolean addCompareListener(CompareListener listener)

Adds a CompareListener to be notified when comparison modes are started or stopped.

Parameters:

listener - The CompareListener.

Returns:

true if the CompareListener was successfully added.

removeCompareListener

public boolean removeCompareListener(CompareListener listener)

Removes the CompareListener.

Parameters:

listener - The CompareListener.

Returns:

true if the CompareListener was successfully removed.

addOutputPreviewListener

public boolean addOutputPreviewListener(OutputPreviewListener listener)

Adds an OutputPreviewListener to be notified when output preview mode is started or stopped.

Parameters:

listener - The OutputPreviewListener.

Returns:

true if the OutputPreviewListener was successfully added.

removeOutputPreviewListener

public boolean removeOutputPreviewListener(OutputPreviewListener listener)

Removes the OutputPreviewListener.

Parameters:

listener - The OutputPreviewListener.

Returns:

true if the OutputPreviewListener was successfully removed.

setGridSettings

public void setGridSettings(GridSettings gridSettings)

Sets the grid settings. Set to null to hide the grid.

Overrides:

setGridSettings in class PDFNotesBean

Parameters:

gridSettings - The new GridSettings or null to hide the grid.

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.

Overrides:

setRulerSettings in class PDFNotesBean

Parameters:

rulerSettings - The new settings for the rulers, or null to hide the rulers.