SharedViewer (org.jpedal:OpenViewerFX 7.12.28 API)

java.lang.Object
- org.jpedal.examples.viewer.SharedViewer

All Implemented Interfaces:: ViewerInt

Direct Known Subclasses:: OpenViewerFX

public abstract class SharedViewer
extends Object
implements ViewerInt

Field Summary

Fields
Modifier and Type	Field and Description
`static boolean`	`closeCalled`
`protected Values`	`commonValues`
`protected Commands`	`currentCommands`
`protected GUIFactory`	`currentGUI`
`static boolean`	`exitOnClose`
`static String`	`PREFERENCES_BEAN`
`static String`	`PREFERENCES_DEFAULT`
`static String`	`PREFERENCES_NO_GUI`
`static String`	`PREFERENCES_NO_SIDE_BAR`
`static String`	`PREFERENCES_OPEN_AND_NAV_ONLY`

Constructor Summary

Constructors
Constructor and Description

SharedViewer()

Constructors
Constructor and Description
`SharedViewer()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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.
`PdfDecoderInt`	`getPdfDecoder()`
`GUIFactory`	`getSwingGUI()` open the file passed in by user on startup (do not call directly) USED by our tests
`void`	`handleArguments(String[] args)` Have the viewer handle program arguments
`protected void`	`init(ResourceBundle bundle)` setup the viewer
`static boolean`	`isFX()`
`static boolean`	`isProcessing()`
`void`	`loadProperties(InputStream is)` Should be called before setupViewer
`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)

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - PREFERENCES_DEFAULT
```
public static final String PREFERENCES_DEFAULT
```
    See Also:
    
    Constant Field Values
  - PREFERENCES_NO_GUI
```
public static final String PREFERENCES_NO_GUI
```
    See Also:
    
    Constant Field Values
  - PREFERENCES_NO_SIDE_BAR
```
public static final String PREFERENCES_NO_SIDE_BAR
```
    See Also:
    
    Constant Field Values
  - PREFERENCES_OPEN_AND_NAV_ONLY
```
public static final String PREFERENCES_OPEN_AND_NAV_ONLY
```
    See Also:
    
    Constant Field Values
  - PREFERENCES_BEAN
```
public static final String PREFERENCES_BEAN
```
    See Also:
    
    Constant Field Values
  - commonValues
```
protected Values commonValues
```
  - currentGUI
```
protected GUIFactory currentGUI
```
  - currentCommands
```
protected Commands currentCommands
```
  - exitOnClose
```
public static boolean exitOnClose
```
  - closeCalled
```
public static boolean closeCalled
```
- Constructor Detail
  - SharedViewer
```
public SharedViewer()
```
- Method Detail
  - getSwingGUI
```
public GUIFactory getSwingGUI()
```
    open the file passed in by user on startup (do not call directly) USED by our tests
  - openDefaultFile
```
public void openDefaultFile(String defaultFile)
```
    Description copied from interface: ViewerInt
    
    Allow user to open PDF file to display
    
    Specified by:
    
    openDefaultFile in interface ViewerInt
    
    Parameters:
    
    defaultFile - Allow user to open PDF file to display
  - openDefaultFileAtPage
```
public void openDefaultFileAtPage(String defaultFile,
                                  int page)
```
    Description copied from interface: ViewerInt
    
    Allow user to open PDF file to display
    
    Specified by:
    
    openDefaultFileAtPage in interface ViewerInt
    
    Parameters:
    
    defaultFile - Allow user to open PDF file to display
    
    page - The page number on with the displayed file will be open
  - getPdfDecoder
```
public PdfDecoderInt getPdfDecoder()
```
  - setRootContainer
```
public void setRootContainer(Object rootContainer)
```
    Specified by:
    
    setRootContainer in interface ViewerInt
  - loadProperties
```
public void loadProperties(String props)
```
    Should be called before setupViewer
    
    Specified by:
    
    loadProperties in interface ViewerInt
    
    Parameters:
    
    props - the set properties
  - loadProperties
```
public void loadProperties(InputStream is)
```
    Should be called before setupViewer
    
    Parameters:
    
    is - input of loaded properties
  - setupViewer
```
public void setupViewer()
```
    initialise and run client (default as Application in own Frame)
    
    Specified by:
    
    setupViewer in interface ViewerInt
  - init
```
protected void init(ResourceBundle bundle)
```
    setup the viewer
  - handleArguments
```
public void handleArguments(String[] args)
```
    Have the viewer handle program arguments
    
    Specified by:
    
    handleArguments in interface ViewerInt
    
    Parameters:
    
    args - :: Program arguments passed into the Viewer.
  - executeCommand
```
public 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/
    
    Specified by:
    
    executeCommand in interface ViewerInt
    
    Parameters:
    
    commandID - :: static int value from Commands to spedify which command is wanted
    
    args - :: arguements for the desired command
    
    Returns:
    
    command
  - isProcessing
```
public static boolean isProcessing()
```
  - addExternalHandler
```
public 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
    
    Specified by:
    
    addExternalHandler in interface ViewerInt
    
    Parameters:
    
    newHandler - Implementation of interface provided by IDR solutions
    
    type - Defined value into org.jpedal.external.Options class
  - dispose
```
public void dispose()
```
    run with caution and only at end of usage if you really need
    
    Specified by:
    
    dispose in interface ViewerInt
  - isFX
```
public static boolean isFX()
```

Class SharedViewer

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PREFERENCES_DEFAULT

PREFERENCES_NO_GUI

PREFERENCES_NO_SIDE_BAR

PREFERENCES_OPEN_AND_NAV_ONLY

PREFERENCES_BEAN

commonValues

currentGUI

currentCommands

exitOnClose

closeCalled

Constructor Detail

SharedViewer

Method Detail

getSwingGUI

openDefaultFile

openDefaultFileAtPage

getPdfDecoder

setRootContainer

loadProperties

loadProperties

setupViewer

init

handleArguments

executeCommand

isProcessing

addExternalHandler

dispose

isFX