org.jpedal.examples.viewer

Interface ViewerInt

All Known Implementing Classes:

OpenViewerFX, SharedViewer

public interface ViewerInt

PDF viewer

If you are compiling, you will need to download all the examples source files from http://www.idrsolutions.com/how-to-view-pdf-files-in-java/

Run directly from jar with java -cp jpedal.jar org/jpedal/examples/viewer/Viewer or java -jar jpedal.jar

Lots of tutorials on how to configure on our website

There is also a JavaFX Viewer documented at http://files.idrsolutions.com/samplecode/org/jpedal/examples/viewer/OpenViewerFX.java.html

If you want to implement your own Very simple example at http://files.idrsolutions.com/samplecode/org/jpedal/examples/jpaneldemo/JPanelDemo.java.html But we would recommend you look at the full viewer as it is totally configurable and does everything for you.

See also http://javadoc.idrsolutions.com/org/jpedal/constants/JPedalSettings.html for settings to customise

Fully featured GUI viewer and demonstration of JPedal's capabilities

This class provides the framework for the Viewer and calls other classes which provide the following functions:-

Values commonValues - repository for general settings Printer currentPrinter - All printing functions and access methods to see if printing active PdfDecoder decode_pdf - PDF library and panel ThumbnailPanel thumbnails - provides a thumbnail pane down the left side of page - thumbnails can be clicked on to goto page PropertiesFile properties - saved values stored between sessions SwingGUI currentGUI - all Swing GUI functions SearchWindow searchFrame (not GPL) - search Window to search pages and goto references on any page Commands currentCommands - parses and executes all options SwingMouseHandler mouseHandler - handles all mouse and related activity

Method Summary

Modifier and Type	Method and Description
void	addExternalHandler(Map<Integer,Object> newHandler, int type) Allows external helper classes to be added to JPedal to alter default functionality.
void	dispose() run with caution and only at end of usage if you really need
Object	executeCommand(int commandID, Object[] args) Execute Jpedal functionality from outside of the library using this method.
void	handleArguments(String[] args) Have the viewer handle program arguments
void	loadProperties(String props) Should be called before setupViewer
void	openDefaultFile(String defaultFile) Allow user to open PDF file to display
void	openDefaultFileAtPage(String defaultFile, int page) Allow user to open PDF file to display
void	setRootContainer(Object rootContainer)
void	setupViewer() initialise and run client (default as Application in own Frame)

Method Detail

openDefaultFile

void openDefaultFile(String defaultFile)

Allow user to open PDF file to display

Parameters:

defaultFile - The file that will be displayed

openDefaultFileAtPage

void openDefaultFileAtPage(String defaultFile,
                           int page)

Allow user to open PDF file to display

Parameters:

defaultFile - The file that will be displayed

page - The page number on with the displayed file will be open

setRootContainer

void setRootContainer(Object rootContainer)

loadProperties

void loadProperties(String props)

Should be called before setupViewer

Parameters:

props - the set properties

setupViewer

void setupViewer()

initialise and run client (default as Application in own Frame)

handleArguments

void handleArguments(String[] args)

Have the viewer handle program arguments

Parameters:

args - :: Program arguments passed into the Viewer.

executeCommand

Object executeCommand(int commandID,
                      Object[] args)

Execute Jpedal functionality from outside of the library using this method. EXAMPLES commandID = Commands.OPENFILE, args = {"/PDFData/Hand_Test/crbtrader.pdf}" commandID = Commands.OPENFILE, args = {byte[] = {0,1,1,0,1,1,1,0,0,1}, "/PDFData/Hand_Test/crbtrader.pdf}" commandID = Commands.ROTATION, args = {"90"} commandID = Commands.OPENURL, args = {"http://www.cs.bham.ac.uk/~axj/pub/papers/handy1.pdf"}

for full details see http://www.idrsolutions.com/access-pdf-viewer-features-from-your-code/

Parameters:

commandID - :: static int value from Commands to spedify which command is wanted

args - :: arguements for the desired command

Returns:

command

addExternalHandler

void addExternalHandler(Map<Integer,Object> newHandler,
                        int type)

Allows external helper classes to be added to JPedal to alter default functionality.

If Options.FormsActionHandler is the type then the newHandler should be of the form org.jpedal.objects.acroforms.ActionHandler

If Options.JPedalActionHandler is the type then the newHandler should be of the form Map which contains Command Integers, mapped onto their respective org.jpedal.examples.viewer.gui.swing.JPedalActionHandler implementations. For example, to create a custom help action, you would add to your map, Integer(Commands.HELP) -> JPedalActionHandler. For a tutorial on creating custom actions in the Viewer, see http://www.jpedal.org/support.php

Parameters:

newHandler - Implementation of interface provided by IDR solutions

type - Defined value into org.jpedal.external.Options class

dispose

void dispose()

run with caution and only at end of usage if you really need