org.jpedal.examples.viewer

Class OpenViewerFX

java.lang.Object

org.jpedal.examples.viewer.SharedViewer

org.jpedal.examples.viewer.OpenViewerFX

All Implemented Interfaces:

ViewerInt

public class OpenViewerFX
extends SharedViewer

PDF Viewer

If you are compiling, you will need to download all the examples source files from : How to View PDF File in Java.

Run directly from jar with java -cp jpedal.jar org.jpedal.examples.viewer.FXStartup (needs Java8)

There are plenty of tutorials on how to configure the Viewer on our website Support Section.

See Here for Settings to Customise the PDF Viewer

We also have our Swing Viewer documented at :

Swing Viewer Documentation.

If you want to implement your own there is a very simple example at : BaseOpenViewerFX Demo

We recommend you look at the full viewer as it is totally configurable and does everything for you.

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	isOpenFX

Fields inherited from class org.jpedal.examples.viewer.SharedViewer

closeCalled, commonValues, currentCommands, currentGUI, exitOnClose, PREFERENCES_BEAN, PREFERENCES_DEFAULT, PREFERENCES_NO_GUI, PREFERENCES_NO_SIDE_BAR, PREFERENCES_OPEN_AND_NAV_ONLY

Constructor Summary

Constructors

Constructor and Description
OpenViewerFX(javafx.scene.Parent parentPane, String preferencesPath) Constructor to use when embedding the JavaFX Viewer in your own JavaFX application, pass in your parentPane and the Viewer will become a child of the parentPane.
OpenViewerFX(javafx.stage.Stage stage, String[] args) Base Constructor to use when starting Viewer as a stand alone Stage.

Method Summary

Modifier and Type	Method and Description
protected static void	checkUserJavaVersion()
void	close() Releases all resources used by the viewer - Please note this calls System.exit(0); This method has to be called when you explicitly want to close the viewer.
javafx.scene.layout.BorderPane	getRoot() Not part of the API.
void	handleArguments(String[] args) Allows the viewer to handle any JVM/Program arguments.
void	setupViewer() Sets up the Viewer and Displays it.

Methods inherited from class org.jpedal.examples.viewer.SharedViewer

addExternalHandler, dispose, executeCommand, getPdfDecoder, getSwingGUI, init, isFX, isProcessing, loadProperties, loadProperties, openDefaultFile, openDefaultFileAtPage, setRootContainer

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

isOpenFX

public static boolean isOpenFX

Constructor Detail

OpenViewerFX

public OpenViewerFX(javafx.stage.Stage stage,
                    String[] args)

Base Constructor to use when starting Viewer as a stand alone Stage. Please ensure you call setupViewer after calling this constructor.

Parameters:

stage - Is of type Stage

args - Program arguments passed into the Viewer

OpenViewerFX

public OpenViewerFX(javafx.scene.Parent parentPane,
                    String preferencesPath)

Constructor to use when embedding the JavaFX Viewer in your own JavaFX application, pass in your parentPane and the Viewer will become a child of the parentPane.

Please ensure you call setupViewer after calling this constructor.

To add the JavaFX Viewer to a Tab, please pass a Pane or ScrollPane and add the passed Pane to the Tab.

Parameters:

parentPane - Is a constructor of your own JavaFX application in which JavaFx Viewer will be embedded

preferencesPath - The path of the preferences file

Method Detail

setupViewer

public void setupViewer()

Sets up the Viewer and Displays it.

Please make sure you call this method after calling any constructor to initialise key components.

Specified by:

setupViewer in interface ViewerInt

Overrides:

setupViewer in class SharedViewer

handleArguments

public void handleArguments(String[] args)

Allows the viewer to handle any JVM/Program arguments.

Specified by:

handleArguments in interface ViewerInt

Overrides:

handleArguments in class SharedViewer

Parameters:

args - :: Program arguments passed into the Viewer.

close

public void close()

Releases all resources used by the viewer - Please note this calls System.exit(0); This method has to be called when you explicitly want to close the viewer.

getRoot

public javafx.scene.layout.BorderPane getRoot()

Not part of the API.

To add Viewer to your own parent node, please use: OpenViewerFX(Parent parentPane, String preferencesPath).

Returns:

The root of your JavaFX application

checkUserJavaVersion

protected static void checkUserJavaVersion()