com.gnostice.documents.controls.swing.viewer

Class DocumentViewer

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

com.gnostice.documents.controls.swing.viewer.DocumentViewer

All Implemented Interfaces:

IViewer, ComponentListener, ImageObserver, MenuContainer, Serializable, EventListener, Accessible

public class DocumentViewer
extends JPanel
implements Serializable, ComponentListener, IViewer

This class represents the document viewer control. Use it as a JPanel control in a Swing application.

See Also:

Serialized Form

Example

Getting Started with XtremeDocumentStudio (for Java)'s multi-format DocumentViewer component

Nested Class Summary

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 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
DocumentViewer() Creates a new instance of the document viewer component.

Method Summary

Modifier and Type	Method and Description
void	addViewerListener(DocumentViewerListener listener) Adds specified user-class instance to the list of listeners that are notified about viewer events.
void	closeDocument() Stops the display of the documents and unloads it from memory.
void	componentHidden(ComponentEvent e)
void	componentMoved(ComponentEvent e)
void	componentResized(ComponentEvent e)
void	componentShown(ComponentEvent e)
void	dispose()
void	finalize()
void	firstPage() Navigates to the first page.
IDocument	getActiveDocument() Returns the active document.
int	getBorderWidth() Returns width of the border of the viewer.
Component	getComponent() Returns the container component.
int	getCurrentPageNumber() Returns current page number.
double	getMaxZoomVal() Returns page magnification that can be used to display documents.
double	getMinZoomVal() Returns minimum page magnification that can be used to display documents.
int	getPageCount() Returns number of pages in the document.
PageLayout	getPageLayout() Returns current page layout setting.
double[]	getPredefinedZoomValues() Returns pre-defined page magnification settings to which IViewer.zoomIn() and IViewer.zoomOut() change to.
ViewerPreferences	getPreferences() Returns viewer settings.
Dimension	getPreferredSize()
RotationAngle	getRotationAngle() Returns current angle of rotation.
List<String>	getSupportedFormats() Returns the list of supported formats.
DocumentViewerListener[]	getViewerListeners() Returns list of user-class instance that are notified of viewer events.
int[]	getVisiblePageNumbers() Returns numbers of pages that are current displayed.
Zoom	getZoom() Returns current page magnification.
void	goToPageNumber(int gotoPageNum) Navigates to specified page.
boolean	isDocumentLoaded() Returns whether a document has been loaded in the viewer.
void	lastPage() Navigates to the last page.
void	loadDocument(InputStream inputStream, String password) Loads a document from specified stream with specified stream.
void	loadDocument(String fileName, String password) Loads specified document with specified password.
int	nextPage() Navigates to the next page.
Dimension	preferredSize()
int	previousPage() Navigates to the previous page.
void	refresh() Refreshes the display.
void	removeViewerListener(DocumentViewerListener listener) Removes specified user-class instance from the list of listeners that are notified viewer events.
void	resetAllPageRotation() Resets the angle of rotation of pages whose contents have been rotated.
void	rotateAllPagesAntiClockwise() Rotates displayed contents of all pages in the counter-clockwise direction.
void	rotateAllPagesClockwise() Rotates displayed contents of all pages in the clockwise direction.
void	rotateAllPagesTo(RotationAngle rotationAngle) Rotate displayed contents of all pages by specified angle.
void	rotatePageTo(RotationAngle angle, int pageNum) Rotates contents of specified page by specified angle.
void	rotatePageTo(RotationAngle angle, String pageRange) Rotate contents of specified pages by specified angle.
void	setBackgroundColor(Color backgroundColor) Sets specified background color for the viewer.
void	setBorderWidth(int borderWidth) Sets specified border width for the viewer.
void	setPageLayout(PageLayout pageLayout) Displays pages in specified layout.
void	setViewerPreferences(ViewerPreferences viewerPreferences) Sets specified viewer settings.
boolean	zoomIn() Changes page magnification to the next higher pre-defined page magnification value.
boolean	zoomOut() Changes page magnification to the next lower pre-defined page magnification value.
void	zoomTo(Zoom zoom) Changes the page magnification to specified value.

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, 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, getRegisteredKeyStrokes, getRootPane, 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, removeNotify, 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, 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

DocumentViewer

public DocumentViewer()

Creates a new instance of the document viewer component.

Method Detail

preferredSize

public Dimension preferredSize()

Overrides:

preferredSize in class Container

getPreferredSize

public Dimension getPreferredSize()

Overrides:

getPreferredSize in class JComponent

setBackgroundColor

public void setBackgroundColor(Color backgroundColor)

Description copied from interface: IViewer

Sets specified background color for the viewer.

Specified by:

setBackgroundColor in interface IViewer

Parameters:

backgroundColor - background color for the viewer

loadDocument

public void loadDocument(String fileName,
                         String password)
                  throws IOException,
                         FormatNotSupportedException,
                         IncorrectPasswordException,
                         XDocException

Description copied from interface: IViewer

Loads specified document with specified password.

Specified by:

loadDocument in interface IViewer

Parameters:

fileName - pathname of the file

password - password to decrypt the document

Throws:

IOException - if an I/O error occurs

FormatNotSupportedException - if the document format is not supported

IncorrectPasswordException - if an incorrect password was provided

XDocException - if a viewer error occurs

loadDocument

public void loadDocument(InputStream inputStream,
                         String password)
                  throws IOException,
                         FormatNotSupportedException,
                         IncorrectPasswordException,
                         XDocException

Description copied from interface: IViewer

Loads a document from specified stream with specified stream.

Specified by:

loadDocument in interface IViewer

Parameters:

inputStream - stream from which the document needs to be loaded

password - password to decrypt the document

Throws:

IOException - if an I/O error occurs

FormatNotSupportedException - if the document format is not supported

IncorrectPasswordException - if an incorrect password was provided

XDocException - if a viewer error occurs

closeDocument

public void closeDocument()
                   throws IOException

Description copied from interface: IViewer

Stops the display of the documents and unloads it from memory.

Specified by:

closeDocument in interface IViewer

Throws:

IOException - if an I/O error occurs

finalize

public void finalize()

Overrides:

finalize in class Object

getMinZoomVal

public double getMinZoomVal()

Description copied from interface: IViewer

Returns minimum page magnification that can be used to display documents.

Specified by:

getMinZoomVal in interface IViewer

Returns:

minimum page magnification that is supported by the viewer

getMaxZoomVal

public double getMaxZoomVal()

Description copied from interface: IViewer

Returns page magnification that can be used to display documents.

Specified by:

getMaxZoomVal in interface IViewer

Returns:

maximum page magnification that is supported by the viewer

zoomIn

public boolean zoomIn()

Description copied from interface: IViewer

Changes page magnification to the next higher pre-defined page magnification value.

Specified by:

zoomIn in interface IViewer

Returns:

whether the operation was successful

zoomOut

public boolean zoomOut()

Description copied from interface: IViewer

Changes page magnification to the next lower pre-defined page magnification value.

Specified by:

zoomOut in interface IViewer

Returns:

whether the operation was successful

getPredefinedZoomValues

public double[] getPredefinedZoomValues()

Description copied from interface: IViewer

Returns pre-defined page magnification settings to which IViewer.zoomIn() and IViewer.zoomOut() change to.

Specified by:

getPredefinedZoomValues in interface IViewer

Returns:

array of pre-defined page magnification settings.

dispose

public void dispose()
             throws IOException

Specified by:

dispose in interface IViewer

Throws:

IOException

zoomTo

public void zoomTo(Zoom zoom)

Description copied from interface: IViewer

Changes the page magnification to specified value.

Specified by:

zoomTo in interface IViewer

Parameters:

zoom - page magnification that needs to be applied

getZoom

public Zoom getZoom()

Description copied from interface: IViewer

Returns current page magnification.

Specified by:

getZoom in interface IViewer

Returns:

percentage of the page magnification

getRotationAngle

public RotationAngle getRotationAngle()

Description copied from interface: IViewer

Returns current angle of rotation.

Specified by:

getRotationAngle in interface IViewer

Returns:

current angle of rotation

getCurrentPageNumber

public int getCurrentPageNumber()

Description copied from interface: IViewer

Returns current page number.

Specified by:

getCurrentPageNumber in interface IViewer

Returns:

current page number

getPageCount

public int getPageCount()

Description copied from interface: IViewer

Returns number of pages in the document.

Specified by:

getPageCount in interface IViewer

Returns:

number of pages in the document

getPageLayout

public PageLayout getPageLayout()

Description copied from interface: IViewer

Returns current page layout setting.

Specified by:

getPageLayout in interface IViewer

Returns:

current page layout

setPageLayout

public void setPageLayout(PageLayout pageLayout)
                   throws XDocException

Description copied from interface: IViewer

Displays pages in specified layout.

Specified by:

setPageLayout in interface IViewer

Parameters:

pageLayout - layout in which pages need to be displayed

Throws:

XDocException

rotateAllPagesClockwise

public void rotateAllPagesClockwise()

Description copied from interface: IViewer

Rotates displayed contents of all pages in the clockwise direction.

Specified by:

rotateAllPagesClockwise in interface IViewer

rotateAllPagesTo

public void rotateAllPagesTo(RotationAngle rotationAngle)

Description copied from interface: IViewer

Rotate displayed contents of all pages by specified angle.

Specified by:

rotateAllPagesTo in interface IViewer

Parameters:

rotationAngle - angle by which the contents need to be rotated

firstPage

public void firstPage()
               throws XDocException

Description copied from interface: IViewer

Navigates to the first page.

Specified by:

firstPage in interface IViewer

Throws:

XDocException - if a viewer error occurs

previousPage

public int previousPage()
                 throws XDocException

Description copied from interface: IViewer

Navigates to the previous page.

Specified by:

previousPage in interface IViewer

Returns:

number of the page

Throws:

XDocException - if a viewer error occurs

nextPage

public int nextPage()
             throws XDocException

Description copied from interface: IViewer

Navigates to the next page.

Specified by:

nextPage in interface IViewer

Returns:

number of the page

Throws:

XDocException - if a viewer error occurs

lastPage

public void lastPage()
              throws XDocException

Description copied from interface: IViewer

Navigates to the last page.

Specified by:

lastPage in interface IViewer

Throws:

XDocException - if a viewer error occurs

goToPageNumber

public void goToPageNumber(int gotoPageNum)
                    throws XDocException

Description copied from interface: IViewer

Navigates to specified page.

Specified by:

goToPageNumber in interface IViewer

Parameters:

gotoPageNum - number of the page.

Throws:

XDocException - if a viewer error occurs

addViewerListener

public void addViewerListener(DocumentViewerListener listener)

Description copied from interface: IViewer

Adds specified user-class instance to the list of listeners that are notified about viewer events.

Specified by:

addViewerListener in interface IViewer

Parameters:

listener - user-class instance that needs to be added

removeViewerListener

public void removeViewerListener(DocumentViewerListener listener)

Description copied from interface: IViewer

Removes specified user-class instance from the list of listeners that are notified viewer events.

Specified by:

removeViewerListener in interface IViewer

Parameters:

listener - listener that needs to be removed

getViewerListeners

public DocumentViewerListener[] getViewerListeners()

Description copied from interface: IViewer

Returns list of user-class instance that are notified of viewer events.

Specified by:

getViewerListeners in interface IViewer

Returns:

list of listeners

getActiveDocument

public IDocument getActiveDocument()

Description copied from interface: IViewer

Returns the active document.

Specified by:

getActiveDocument in interface IViewer

Returns:

active document

getBorderWidth

public int getBorderWidth()

Description copied from interface: IViewer

Returns width of the border of the viewer.

Specified by:

getBorderWidth in interface IViewer

Returns:

width of the border

getPreferences

public ViewerPreferences getPreferences()

Description copied from interface: IViewer

Returns viewer settings.

Specified by:

getPreferences in interface IViewer

Returns:

viewer settings

isDocumentLoaded

public boolean isDocumentLoaded()

Description copied from interface: IViewer

Returns whether a document has been loaded in the viewer.

Specified by:

isDocumentLoaded in interface IViewer

Returns:

true if a document has been loaded; false if otherwise

rotateAllPagesAntiClockwise

public void rotateAllPagesAntiClockwise()

Description copied from interface: IViewer

Rotates displayed contents of all pages in the counter-clockwise direction.

Specified by:

rotateAllPagesAntiClockwise in interface IViewer

setBorderWidth

public void setBorderWidth(int borderWidth)

Description copied from interface: IViewer

Sets specified border width for the viewer.

Specified by:

setBorderWidth in interface IViewer

Parameters:

borderWidth - border width that needs to be set for the viewer

getSupportedFormats

public List<String> getSupportedFormats()

Description copied from interface: IViewer

Returns the list of supported formats.

Specified by:

getSupportedFormats in interface IViewer

Returns:

list of supported formats

rotatePageTo

public void rotatePageTo(RotationAngle angle,
                         String pageRange)

Description copied from interface: IViewer

Rotate contents of specified pages by specified angle.

Specified by:

rotatePageTo in interface IViewer

Parameters:

angle - angle by which the contents need to be rotated

pageRange - pages whose contents need to be rotated

rotatePageTo

public void rotatePageTo(RotationAngle angle,
                         int pageNum)

Description copied from interface: IViewer

Rotates contents of specified page by specified angle.

Specified by:

rotatePageTo in interface IViewer

Parameters:

angle - angle by which the contents need to be rotated

pageNum - number of the page whose contents need to be rotated

resetAllPageRotation

public void resetAllPageRotation()

Description copied from interface: IViewer

Resets the angle of rotation of pages whose contents have been rotated.

Specified by:

resetAllPageRotation in interface IViewer

getVisiblePageNumbers

public int[] getVisiblePageNumbers()

Description copied from interface: IViewer

Returns numbers of pages that are current displayed.

Specified by:

getVisiblePageNumbers in interface IViewer

Returns:

array of the page numbers

getComponent

public Component getComponent()

Description copied from interface: IViewer

Returns the container component.

Specified by:

getComponent in interface IViewer

Returns:

refresh

public void refresh()

Description copied from interface: IViewer

Refreshes the display.

Specified by:

refresh in interface IViewer

componentHidden

public void componentHidden(ComponentEvent e)

Specified by:

componentHidden in interface ComponentListener

componentMoved

public void componentMoved(ComponentEvent e)

Specified by:

componentMoved in interface ComponentListener

componentResized

public void componentResized(ComponentEvent e)

Specified by:

componentResized in interface ComponentListener

componentShown

public void componentShown(ComponentEvent e)

Specified by:

componentShown in interface ComponentListener

setViewerPreferences

public void setViewerPreferences(ViewerPreferences viewerPreferences)

Sets specified viewer settings.

Parameters:

viewerPreferences - viewer settings that need to be set