com.gnostice.documents.controls.swing.viewer

Interface IViewer

All Known Implementing Classes:

DocumentViewer

public interface IViewer

This interface defines API for document viewer components.

Method Summary

Modifier and Type	Method and Description
void	addViewerListener(DocumentViewerListener viewerListener) 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	dispose()
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 zoomIn() and zoomOut() change to.
ViewerPreferences	getPreferences() Returns viewer settings.
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 pageNum) 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.
int	previousPage() Navigates to the previous page.
void	refresh() Refreshes the display.
void	removeViewerListener(DocumentViewerListener viewerListener) 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 angle) 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.
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.

Method Detail

getCurrentPageNumber

int getCurrentPageNumber()

Returns current page number.

Returns:

current page number

goToPageNumber

void goToPageNumber(int pageNum)
             throws XDocException

Navigates to specified page.

Parameters:

pageNum - number of the page.

Throws:

XDocException - if a viewer error occurs

getPageCount

int getPageCount()

Returns number of pages in the document.

Returns:

number of pages in the document

isDocumentLoaded

boolean isDocumentLoaded()

Returns whether a document has been loaded in the viewer.

Returns:

true if a document has been loaded; false if otherwise

getBorderWidth

int getBorderWidth()

Returns width of the border of the viewer.

Returns:

width of the border

setBorderWidth

void setBorderWidth(int borderWidth)

Sets specified border width for the viewer.

Parameters:

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

getZoom

Zoom getZoom()

Returns current page magnification.

Returns:

percentage of the page magnification

zoomTo

void zoomTo(Zoom zoom)

Changes the page magnification to specified value.

Parameters:

zoom - page magnification that needs to be applied

getPreferences

ViewerPreferences getPreferences()

Returns viewer settings.

Returns:

viewer settings

getActiveDocument

IDocument getActiveDocument()

Returns the active document.

Returns:

active document

loadDocument

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

Loads specified document with specified password.

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

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

Loads a document from specified stream with specified stream.

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

void closeDocument()
            throws IOException

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

Throws:

IOException - if an I/O error occurs

nextPage

int nextPage()
      throws XDocException

Navigates to the next page.

Returns:

number of the page

Throws:

XDocException - if a viewer error occurs

previousPage

int previousPage()
          throws XDocException

Navigates to the previous page.

Returns:

number of the page

Throws:

XDocException - if a viewer error occurs

firstPage

void firstPage()
        throws XDocException

Navigates to the first page.

Throws:

XDocException - if a viewer error occurs

lastPage

void lastPage()
       throws XDocException

Navigates to the last page.

Throws:

XDocException - if a viewer error occurs

refresh

void refresh()

Refreshes the display.

rotateAllPagesClockwise

void rotateAllPagesClockwise()

Rotates displayed contents of all pages in the clockwise direction.

rotateAllPagesAntiClockwise

void rotateAllPagesAntiClockwise()

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

rotateAllPagesTo

void rotateAllPagesTo(RotationAngle angle)

Rotate displayed contents of all pages by specified angle.

Parameters:

angle - angle by which the contents need to be rotated

rotatePageTo

void rotatePageTo(RotationAngle angle,
                  String pageRange)

Rotate contents of specified pages by specified angle.

Parameters:

angle - angle by which the contents need to be rotated

pageRange - pages whose contents need to be rotated

rotatePageTo

void rotatePageTo(RotationAngle angle,
                  int pageNum)

Rotates contents of specified page by specified angle.

Parameters:

angle - angle by which the contents need to be rotated

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

resetAllPageRotation

void resetAllPageRotation()

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

getRotationAngle

RotationAngle getRotationAngle()

Returns current angle of rotation.

Returns:

current angle of rotation

zoomIn

boolean zoomIn()

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

Returns:

whether the operation was successful

zoomOut

boolean zoomOut()

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

Returns:

whether the operation was successful

getPageLayout

PageLayout getPageLayout()

Returns current page layout setting.

Returns:

current page layout

setPageLayout

void setPageLayout(PageLayout pageLayout)
            throws XDocException

Displays pages in specified layout.

Parameters:

pageLayout - layout in which pages need to be displayed

Throws:

XDocException

addViewerListener

void addViewerListener(DocumentViewerListener viewerListener)

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

Parameters:

viewerListener - user-class instance that needs to be added

getViewerListeners

DocumentViewerListener[] getViewerListeners()

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

Returns:

list of listeners

removeViewerListener

void removeViewerListener(DocumentViewerListener viewerListener)

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

Parameters:

viewerListener - listener that needs to be removed

getSupportedFormats

List<String> getSupportedFormats()

Returns the list of supported formats.

Returns:

list of supported formats

getMinZoomVal

double getMinZoomVal()

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

Returns:

minimum page magnification that is supported by the viewer

getMaxZoomVal

double getMaxZoomVal()

Returns page magnification that can be used to display documents.

Returns:

maximum page magnification that is supported by the viewer

getPredefinedZoomValues

double[] getPredefinedZoomValues()

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

Returns:

array of pre-defined page magnification settings.

setBackgroundColor

void setBackgroundColor(Color backgroundColor)

Sets specified background color for the viewer.

Parameters:

backgroundColor - background color for the viewer

dispose

void dispose()
      throws IOException

Throws:

IOException

getVisiblePageNumbers

int[] getVisiblePageNumbers()

Returns numbers of pages that are current displayed.

Returns:

array of the page numbers

getComponent

Component getComponent()

Returns the container component.

Returns: