com.crionics.jpdf.viewer
Class ViewerFrame

java.lang.Object
  java.awt.Component
      java.awt.Container
          java.awt.Window
              java.awt.Frame
                  javax.swing.JFrame
                      com.crionics.jpdf.viewer.ViewerFrame

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.beans.PropertyChangeListener, java.io.Serializable, java.util.EventListener, javax.accessibility.Accessible, javax.swing.RootPaneContainer, javax.swing.WindowConstants

public class ViewerFrame
extends javax.swing.JFrame
implements java.beans.PropertyChangeListener

Create a rich GUI window which shows a PDF ViewerPanel, a full featured menubar (with a file history and preferences) and the docking framework (toolbars, bookmarks, wizards..etc). The component is i18 compliant and is smart enough to remember its bindings (maximized, minimized, position).

See Also:

Serialized Form

Field Summary

static int

STATE_MAXIMIZED

Fields inherited from class javax.swing.JFrame

EXIT_ON_CLOSE

Fields inherited from class java.awt.Frame

CROSSHAIR_CURSOR, DEFAULT_CURSOR, E_RESIZE_CURSOR, HAND_CURSOR, ICONIFIED, MAXIMIZED_BOTH, MAXIMIZED_HORIZ, MAXIMIZED_VERT, MOVE_CURSOR, N_RESIZE_CURSOR, NE_RESIZE_CURSOR, NORMAL, NW_RESIZE_CURSOR, S_RESIZE_CURSOR, SE_RESIZE_CURSOR, SW_RESIZE_CURSOR, TEXT_CURSOR, W_RESIZE_CURSOR, WAIT_CURSOR

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface javax.swing.WindowConstants

DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, HIDE_ON_CLOSE

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

ViewerFrame()
Frame Constructor.

Method Summary

boolean	closeDocument() Closes the document currently displayed If the document has changed, the user will be presented a confirmation dialog.
ViewerPanel	getViewerPanel() This method gives access to the pdf viewer panel.
boolean	isIconized() Checks if window is iconified
boolean	isMaximized() Checks if window is maximized
static void	main(java.lang.String[] args) Application entry point.
void	propertyChange(java.beans.PropertyChangeEvent evt) Internally used to handle GUI events.
void	setDocument(java.io.File pathToPDF) Displays the given document in the rendering panel
void	setDocument(java.io.File pathToPDF, ICredentials credentials) Displays the given document in the rendering panel
void	showToolTips() Shows the tooltips window

Methods inherited from class javax.swing.JFrame

getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getJMenuBar, getLayeredPane, getRootPane, isDefaultLookAndFeelDecorated, remove, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setIconImage, setJMenuBar, setLayeredPane, setLayout, update

Methods inherited from class java.awt.Frame

addNotify, getCursorType, getExtendedState, getFrames, getIconImage, getMaximizedBounds, getMenuBar, getState, getTitle, isResizable, isUndecorated, remove, removeNotify, setCursor, setExtendedState, setMaximizedBounds, setMenuBar, setResizable, setState, setTitle, setUndecorated

Methods inherited from class java.awt.Window

addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getGraphicsConfiguration, getInputContext, getListeners, getLocale, getMostRecentFocusOwner, getOwnedWindows, getOwner, getToolkit, getWarningString, getWindowFocusListeners, getWindowListeners, getWindowStateListeners, hide, isActive, isAlwaysOnTop, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isShowing, pack, postEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, setAlwaysOnTop, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setLocationByPlatform, setLocationRelativeTo, show, toBack, toFront

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paint, paintComponents, preferredSize, print, printComponents, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, transferFocusBackward, transferFocusDownCycle, validate

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, dispatchEvent, enable, enable, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphics, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isPreferredSizeSet, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, repaint, requestFocus, requestFocusInWindow, reshape, resize, resize, setBackground, setBounds, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setMinimumSize, setName, setPreferredSize, setSize, setSize, setVisible, show, size, toString, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.awt.MenuContainer

getFont, postEvent

Field Detail

STATE_MAXIMIZED

public static final int STATE_MAXIMIZED

See Also:

Constant Field Values

Constructor Detail

ViewerFrame

public ViewerFrame()

Frame Constructor.

Method Detail

main

public static final void main(java.lang.String[] args)

Application entry point. Creates the jPDF Viewer frame and displays it.

Parameters:

args - command line arguments

closeDocument

public boolean closeDocument()

Closes the document currently displayed If the document has changed, the user will be presented a confirmation dialog.

Returns:

true if the document was actually close, false if the user pressed Cancel

getViewerPanel

public ViewerPanel getViewerPanel()

This method gives access to the pdf viewer panel. It can be used to get more control over what components should be hidden/displayed.

Returns:

the pdf viewer panel

isIconized

public boolean isIconized()

Checks if window is iconified

Returns:

true if window is iconified

isMaximized

public boolean isMaximized()

Checks if window is maximized

Returns:

true if window is maximized

propertyChange

public void propertyChange(java.beans.PropertyChangeEvent evt)

Internally used to handle GUI events.

Specified by:

propertyChange in interface java.beans.PropertyChangeListener

setDocument

public void setDocument(java.io.File pathToPDF)
                 throws java.io.IOException,
                        PdfException,
                        PdfAuthException

Displays the given document in the rendering panel

Parameters:

pathToPDF - path to the document

Throws:

java.io.IOException - issue related to io and caching

PdfException - issue related to PDF

PdfAuthException - issue with authentication

setDocument

public void setDocument(java.io.File pathToPDF,
                        ICredentials credentials)
                 throws java.io.IOException,
                        PdfException

Displays the given document in the rendering panel

Parameters:

pathToPDF - path to the document

credentials - credentials to open the document

Throws:

java.io.IOException - issue related to io and caching

PdfException - issue related to PDF

PdfAuthException - issue with authentication

showToolTips

public void showToolTips()

Shows the tooltips window