JavaFxGUI (org.jpedal:OpenViewerFX 7.12.28 API)

java.lang.Object
- org.jpedal.examples.viewer.gui.GUI
- - org.jpedal.examples.viewer.gui.JavaFxGUI

All Implemented Interfaces:

GUIFactory
```
public class JavaFxGUI
extends GUI
```
Description: GUI functions in Viewer implemented in JavaFX

Nested Class Summary
- Nested classes/interfaces inherited from class org.jpedal.examples.viewer.gui.GUI
  GUI.PageCounter, GUI.ScrollPolicy

Field Summary

Fields
Modifier and Type Field and Description

protected JavaFXButtons fxButtons

javafx.scene.control.TextField pageCounter2
- Fields inherited from class org.jpedal.examples.viewer.gui.GUI
  allowScrolling, alwaysShowMouse, annotationTitle, attachmentsTitle, bookmarksGenerated, bookmarksTitle, collapsedSize, commonValues, confirmClose, currentCommandListener, currentCommands, CURSOR, customMessageHandler, debugFX, decode_pdf, DEFAULT_CURSOR, defaultSelection, deletePropertiesOnExit, expandedSize, finishedDecoding, glowInnerColor, glowOuterColor, glowThickness, GRAB_CURSOR, GRABBING_CURSOR, headFont, inset, layersObject, layersTitle, menuItems, minimumScreenWidth, objs, pageTitle, PAN_CURSOR, PAN_CURSORB, PAN_CURSORBL, PAN_CURSORBR, PAN_CURSORL, PAN_CURSORR, PAN_CURSORT, PAN_CURSORTL, PAN_CURSORTR, previewOnSingleScroll, properties, recent, rotation, rotationBox, scaling, scalingBox, scalingFloatValues, searchFrame, showMessages, signaturesTitle, textFont, thumbnails, tree, windowTitle
- Fields inherited from interface org.jpedal.gui.GUIFactory
  BUTTONBAR, MULTIPAGE, NAVBAR, PAGES

Fields
Modifier and Type	Field and Description
`protected JavaFXButtons`	`fxButtons`
`javafx.scene.control.TextField`	`pageCounter2`

Constructor Summary

Constructors
Constructor and Description
`JavaFxGUI(javafx.stage.Stage stage, PdfDecoderInt decode_pdf, Values commonValues, GUIThumbnailPanel thumbnails, PropertiesFile properties)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`addComboListenerAndLabel(GUICombo combo)` Overrides method from GUI.java, see GUI.java for DOCS.
`protected void`	`addGUIComboBoxes(GUICombo combo)` Overrides method from GUI.java, see GUI.java for DOCS.
`void`	`alterProperty(String value, boolean set)`
`protected void`	`createMainViewerWindow(int width, int height)` Creates the Main Display Window for all of the JavaFX Content.
`protected void`	`createOtherToolBars()` method being called from within init to create other tool bars to add to display
`protected void`	`createTopMenuBar()` Creates the top two menu bars, the file loading & viewer properties one and the PDF toolbar, the one which controls searching etc.
`void`	`decodePage()` Key method that calls decodePage from GUI.java
`void`	`dispose()` Method to dispose of objects used by the interface before closing.
`void`	`enableCursor(boolean enabled, boolean visible)` Enable and or set visibility for the cursor display for multi box
`void`	`enableDownloadBar(boolean enabled, boolean visible)` Enable and or set visibility for the download display for multi box
`void`	`enableMemoryBar(boolean enabled, boolean visible)`
`void`	`enableNavigationBar(boolean enabled, boolean visible)`
`void`	`enablePageCounter(GUI.PageCounter value, boolean enabled, boolean visibility)` Enable and make visible different parts of the page counter of all of it
`void`	`enableSearchItems(boolean enabled)` Method to enable / disable search options on the toolbar.
`void`	`enableStatusBar(boolean enabled, boolean visible)` Enable and or set visibility for the status bar for multi box
`GUIAnnotationPanel`	`getAnnotationPanel()` Annotation panel is not available in FX Viewer
`String`	`getBookmark(String bookmark)` Gets the page number of the given bookmark
`GUIButtons`	`getButtons()` Get the GUIButtons object that holds all buttons used by the user interface
`GUICombo`	`getCombo(int ID)` return comboBox or nul if not (QUALITY, SCALING or ROTATION
`Commands`	`getCommand()` Gets the Commands object used by the user interface
`javafx.scene.control.SplitPane`	`getDisplayPane()` Returns the split pane used in the display area of the viewer.
`double`	`getDividerLocation()` Get the divider location for the viewer
`int`	`getDropShadowDepth()` Get the thickness of the glow border
`javafx.stage.Stage`	`getFrame()` allow access to root frame if required
`Object`	`getGlassPane()` Glass pane is not available in FX Viewer
`SwingCursor`	`getGUICursor()` Not part of API - used internally
`GUIMenuItems`	`getMenuItems()` Get the GUIMenuItems object that holds all the menu items used by the user interface.
`Object`	`getMultiViewerFrames()` Used in Swing MultiViewer only
`Object`	`getOutlinePanel()` Gets the object used for the outline panel
`javafx.scene.control.ScrollPane`	`getPageContainer()` Get the page container for the PDF display area
`Object`	`getPageCounter(GUI.PageCounter value)` Get the page counter segments
`boolean`	`getPageTurnScalingAppropriate()` Not part of API - used internally
`PaperSizes`	`getPaperSizes()` Gets the paper sizes for use by the print dialog
`PdfDecoderFX`	`getPdfDecoder()` Get the PdfDecoderFX object used to display the PDF in the user interface
`PropertiesFile`	`getProperties()` This method returns the object that stores and handles the various preferences for the viewer.
`String`	`getPropertiesFileLocation()` Gets the file path for the properties file used in the viewer.
`RecentDocumentsFactory`	`getRecentDocument()` Returns the RecentDocumentFactory used to hand the recent document list
`javafx.scene.layout.BorderPane`	`getRoot()` Get the root pane that holds the GUI interface
`static double`	`getScalingRatio(double actualW, double actualH, double maxW, double maxH)` Get the scaling ratio required to fit one dimension to another
`int`	`getSidebarTabCount()` Get the current count of tabs on the side tab bar
`String`	`getSidebarTabTitleAt(int pos)` Get the title of the tab at the given position
`Object`	`getSideTabBar()` Get the TabPane, as an Object, used for the side tab bar
`int`	`getSplitDividerLocation()` getSplitDividerLocation not supported in OpenViewerFX
`double`	`getStartSize()` Get the start / collapsed position of the split pane divider
`Object`	`getStatusBar()` getStatusBar not supported in OpenViewerFX
`Object`	`getThumbnailPanel()` Gets the object used for the thumbnail panel.
`Object`	`getThumbnailScrollBar()` Returns the scroll bar used in single page mode that shows page thumbnails as you scroll
`protected String`	`getTitle()`
`String`	`getTitles(String title)` Checks if title matches the title of any of the side tab bar tabs
`Enum`	`getType()` Get the type of the user interface
`Object`	`getVerticalScrollBar()` Can't get the scrollbar from a scroll pane, other methods should be implemented to circumvent this when needed
`void`	`init(Commands currentCommands)` main method to initialise Swing specific code and create GUI display
`boolean`	`isSingle()` JavaFX is only in single mode
`void`	`open(String fileName)` Open a file in the Viewer
`void`	`openFile(String fileToOpen)` Open a file in the Viewer
`PdfDecoderInt`	`openNewMultiplePage(String selectedFile, Values commonValues)` Not used in FX.
`Object`	`printDialog(String[] printersList, String defaultPrinter)` Printing is not currently supported in OpenViewerFX
`void`	`reinitialiseTabs(boolean showVisible)` Set the side tab bar state and set any values required for that state.
`void`	`reinitThumbnails()` Flags the pages thumbnail tab as requiring reinitialisation
`void`	`removePageListener()` Remove the ChangeListener from the PdfDecoder and flush cached pages
`void`	`removeSearchWindow(boolean justHide)` Removes the search window from view with option to clear search results
`void`	`removeSidebarTabAt(int pos)` Remove the tab at the specified position from the side tab bar
`void`	`rescanPdfLayers()` Not part of API - used internally
`void`	`resetComboBoxes(boolean value)` set all 3 combo boxes to isEnabled(value)
`void`	`resetNavBar()` reset the navigation bar so that it appears closed
`void`	`resetPageNav()` Reset the page counter to empty them.
`void`	`resetRotationBox()` align rotation combo box to default for page
`void`	`resetStatusMessage(String message)`
`void`	`rotate()` read value from rotation box and apply - called by combo listener
`void`	`scaleAndRotate()` all scaling and rotation should go through this.
`float`	`scaleToVisible(float left, float right, float top, float bottom)` calculates the scaling required to make the given area visible
`void`	`scrollToPage(int page)` Scrolls the view to the specified page.
`void`	`searchInTab(GUISearchWindow searchFrame)` Set Search Bar to be in the Left hand Tabbed pane
`void`	`setBookmarks(boolean alwaysGenerate)` Set the bookmarks for the outline panel
`void`	`setCoordText(String string)` set text displayed in cursor co-ordinates box
`void`	`setDisplayMode(Integer mode)` setDisplayMode not supported in OpenViewerFX
`void`	`setDisplayView(int displayView, int orientation)` set view mode used in panel and redraw in new mode SINGLE_PAGE,CONTINUOUS,FACING,CONTINUOUS_FACING delay is the time in milli-seconds which scrolling can stop before background page drawing starts Multipage views not in OS releases
`void`	`setDownloadProgress(String message, int percentage)`
`void`	`setMultibox(int[] flags)` Not part of API - used internally
`void`	`setNoPagesDecoded()` flush list of pages decoded
`void`	`setPage(int page)` Set the interfaces page counter to the page number and alter any other interface options to match.
`void`	`setPageCounterText(GUI.PageCounter value, String text)` Set the text content for a section of the page counter.
`void`	`setPageNumber()` set page number at bottom of screen
`void`	`setPannable(boolean pan)` Set is the page display can be panned
`void`	`setPropertiesFileLocation(String file)` Sets the properties file to be used
`void`	`setRecentDocument()` Create the RecentDocuments for the user interface
`void`	`setResults(GUISearchList results)` Set the search list to be used to hold search results in menu bar search mode
`void`	`setRootContainer(Object rawValue)`
`void`	`setRotationFromExternal(int rot)` Method to set the viewers rotation from external sources.
`void`	`setScalingFromExternal(String scale)` Method to set the viewers scaling from external sources.
`void`	`setScrollBarPolicy(GUI.ScrollPolicy pol)` Sets the scroll bar policy for the display areas scroll pane
`void`	`setSearchText(Object searchText)` Set the search text field to be used for the menu bar search input
`void`	`setStartSize(int size)` Set the start / collapsed position of the split pane divider
`void`	`setStatusProgress(int size)` set current status value 0 -100
`void`	`setTabsNotInitialised(boolean b)` Set tabs not initialised flag to prevent use of tabs.
`void`	`setThumbnailScrollBarValue(int pageNum)` Set the position of the scroll bar based on desired page number
`void`	`setThumbnailScrollBarVisibility(boolean isVisible)` Control thumbnail scroll bars visibility
`protected void`	`setTitle(String title)` Overrides method from GUI.java, see GUI.java for DOCS.
`protected void`	`setupBorderPanes()` Overrides method from GUI.java, see GUI.java for DOCS.
`protected void`	`setupBottomToolBarItems()` Sets up the position & visual style of the items on the bottom toolbar (page navigation buttons etc).
`protected void`	`setupCenterPanelBackground()` Overrides method from GUI.java, see GUI.java for DOCS.
`protected void`	`setupComboBoxes()` Overrides method from GUI.java, see GUI.java for DOCS.
`protected void`	`setupKeyboardControl()` Uses Keyboard Arrow Keys (UP/DOWN LEFT/RIGT) to Control Page Navigation.
`protected void`	`setupPDFBorder()` Creates a glowing border around the PDFDisplayPane.
`protected void`	`setupPDFDisplayPane()` Sets up the central display pane to display the pdf content.
`void`	`setupSplitPaneDivider(int size, boolean visibility)` Set up the split pane divider for use
`void`	`setupThumbnailPanel()` Set the thumbnail panel ready for display.
`protected void`	`setViewerIcon()` Overrides method from GUI.java, see GUI.java for DOCS.
`int`	`showConfirmDialog(Object message, String title, int optionType, int messageType)`
`int`	`showConfirmDialog(String message, String message2, int option)`
`void`	`showFirstTimePopup()` Method used to show popups that are displayed the first time the Viewer is opened
`String`	`showInputDialog(Object message, String title, int type)`
`String`	`showInputDialog(String message)`
`void`	`showMessageDialog(Object info)`
`int`	`showMessageDialog(Object message1, Object[] options, int selectedChoice)`
`void`	`showMessageDialog(Object message, String title, int type)`
`void`	`showMessageDialog(String message)`
`void`	`showMessageDialog(String message, String title)` Show a message dialog with the specified message and title
`int`	`showOverwriteDialog(String file, boolean yesToAllPresent)`
`void`	`snapScalingToDefaults(float newScaling)` Set scaling to nearest of the viewer default values.
`void`	`stopThumbnails()` Stop thumbnail generation in the pages thumbnail tab
`void`	`triggerPageTurnAnimation(PdfDecoderInt decode_pdf, Values commonValues, int updatedTotal, boolean rightTurn)` triggerPageTurnAnimation is unsupported in OpenViewerFX
`void`	`updateStatusMessage(String message)` message to show in status object
`void`	`updateTextBoxSize()` Update the page counter input size to accommodate the contents
`void`	`updateTransitionType()` Set the transition type to be used when changing between pages

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

- Field Detail
  - fxButtons
```
protected final JavaFXButtons fxButtons
```
  - pageCounter2
```
public javafx.scene.control.TextField pageCounter2
```
- Constructor Detail
  - JavaFxGUI
```
public JavaFxGUI(javafx.stage.Stage stage,
                 PdfDecoderInt decode_pdf,
                 Values commonValues,
                 GUIThumbnailPanel thumbnails,
                 PropertiesFile properties)
```
- Method Detail
  - getThumbnailScrollBar
```
public Object getThumbnailScrollBar()
```
    Returns the scroll bar used in single page mode that shows page thumbnails as you scroll
    
    Returns:
    
    ScrollBar used for the thumbnail scroll in single page mode
  - setThumbnailScrollBarVisibility
```
public void setThumbnailScrollBarVisibility(boolean isVisible)
```
    Control thumbnail scroll bars visibility
    
    Parameters:
    
    isVisible - boolean value to control visibility
  - setThumbnailScrollBarValue
```
public void setThumbnailScrollBarValue(int pageNum)
```
    Set the position of the scroll bar based on desired page number
    
    Parameters:
    
    pageNum - int value for the page
  - getDisplayPane
```
public javafx.scene.control.SplitPane getDisplayPane()
```
    Returns the split pane used in the display area of the viewer.
    
    Returns:
    
    SplitPane used to hold the page display and the side tab bar
  - getMultiViewerFrames
```
public Object getMultiViewerFrames()
```
    Used in Swing MultiViewer only
  - getPropertiesFileLocation
```
public String getPropertiesFileLocation()
```
    Gets the file path for the properties file used in the viewer.
    
    Returns:
    
    String containing the properties file name
  - getBookmark
```
public String getBookmark(String bookmark)
```
    Gets the page number of the given bookmark
    
    Parameters:
    
    bookmark - String value of the bookmark
    
    Returns:
    
    String value of the page number
  - reinitialiseTabs
```
public void reinitialiseTabs(boolean showVisible)
```
    Set the side tab bar state and set any values required for that state.
    
    Parameters:
    
    showVisible - true to expand the side tab bar, false to collapse
  - stopThumbnails
```
public void stopThumbnails()
```
    Stop thumbnail generation in the pages thumbnail tab
  - reinitThumbnails
```
public void reinitThumbnails()
```
    Flags the pages thumbnail tab as requiring reinitialisation
  - resetNavBar
```
public void resetNavBar()
```
    reset the navigation bar so that it appears closed
  - setNoPagesDecoded
```
public void setNoPagesDecoded()
```
    Description copied from interface: GUIFactory
    
    flush list of pages decoded
  - setDisplayMode
```
public void setDisplayMode(Integer mode)
```
    setDisplayMode not supported in OpenViewerFX
  - isSingle
```
public boolean isSingle()
```
    JavaFX is only in single mode
    
    Returns:
    
    Always returns true
  - getThumbnailPanel
```
public Object getThumbnailPanel()
```
    Gets the object used for the thumbnail panel.
    
    Returns:
    
    an Object that extends GUIThumbnailPanel
  - getOutlinePanel
```
public Object getOutlinePanel()
```
    Gets the object used for the outline panel
    
    Returns:
    
    an Object that extends GUIOutline
  - getVerticalScrollBar
```
public Object getVerticalScrollBar()
```
    Can't get the scrollbar from a scroll pane, other methods should be implemented to circumvent this when needed
  - setRootContainer
```
public void setRootContainer(Object rawValue)
```
  - resetRotationBox
```
public void resetRotationBox()
```
    Description copied from interface: GUIFactory
    
    align rotation combo box to default for page
  - getProperties
```
public PropertiesFile getProperties()
```
    Description copied from interface: GUIFactory
    
    This method returns the object that stores and handles the various preferences for the viewer. The returned object can be used to get property values and set them.
    
    Returns:
    
    The PropertiesFile object currently in use by the viewer.
  - searchInTab
```
public void searchInTab(GUISearchWindow searchFrame)
```
    Set Search Bar to be in the Left hand Tabbed pane
  - setPropertiesFileLocation
```
public void setPropertiesFileLocation(String file)
```
    Sets the properties file to be used
    
    Parameters:
    
    file - String file name for the properties file to be used
  - getCommand
```
public Commands getCommand()
```
    Gets the Commands object used by the user interface
    
    Returns:
    
    Commands object for executing commands
  - init
```
public void init(Commands currentCommands)
```
    Description copied from class: GUI
    
    main method to initialise Swing specific code and create GUI display
    
    Specified by:
    
    init in interface GUIFactory
    
    Overrides:
    
    init in class GUI
    
    Parameters:
    
    currentCommands - Commands object to be used by the user interface
  - createOtherToolBars
```
protected void createOtherToolBars()
```
    method being called from within init to create other tool bars to add to display
    
    Overrides:
    
    createOtherToolBars in class GUI
  - setMultibox
```
public void setMultibox(int[] flags)
```
    Not part of API - used internally
    Set the state and value for the multi box at the bottom left of the user interface.
    
    Parameters:
    
    flags - an int[] used to control multi box display
  - setViewerIcon
```
protected void setViewerIcon()
```
    Overrides method from GUI.java, see GUI.java for DOCS.
    
    Overrides:
    
    setViewerIcon in class GUI
  - setDisplayView
```
public void setDisplayView(int displayView,
                           int orientation)
```
    set view mode used in panel and redraw in new mode SINGLE_PAGE,CONTINUOUS,FACING,CONTINUOUS_FACING delay is the time in milli-seconds which scrolling can stop before background page drawing starts Multipage views not in OS releases
  - setTitle
```
protected void setTitle(String title)
```
    Overrides method from GUI.java, see GUI.java for DOCS.
    
    Specified by:
    
    setTitle in class GUI
  - resetComboBoxes
```
public void resetComboBoxes(boolean value)
```
    Description copied from interface: GUIFactory
    
    set all 3 combo boxes to isEnabled(value)
  - getCombo
```
public GUICombo getCombo(int ID)
```
    Description copied from interface: GUIFactory
    
    return comboBox or nul if not (QUALITY, SCALING or ROTATION
    
    Returns:
  - scaleAndRotate
```
public void scaleAndRotate()
```
    all scaling and rotation should go through this.
  - getScalingRatio
```
public static double getScalingRatio(double actualW,
                                     double actualH,
                                     double maxW,
                                     double maxH)
```
    Get the scaling ratio required to fit one dimension to another
    
    Parameters:
    
    actualW - double value representing actual width
    
    actualH - double value representing actual height
    
    maxW - double value representing max width
    
    maxH - double value representing max height
    
    Returns:
    
    double value representing the scaling ration to convert actual values to max values
  - snapScalingToDefaults
```
public void snapScalingToDefaults(float newScaling)
```
    Set scaling to nearest of the viewer default values.
    
    Parameters:
    
    newScaling - The scaling value to snap to viewer default values
  - rotate
```
public void rotate()
```
    Description copied from interface: GUIFactory
    
    read value from rotation box and apply - called by combo listener
  - scrollToPage
```
public void scrollToPage(int page)
```
    Scrolls the view to the specified page.
    
    Parameters:
    
    page - Page to scroll to.
  - setupThumbnailPanel
```
public void setupThumbnailPanel()
```
    Set the thumbnail panel ready for display.
  - setBookmarks
```
public void setBookmarks(boolean alwaysGenerate)
```
    Set the bookmarks for the outline panel
    
    Parameters:
    
    alwaysGenerate - true we will generate the bookmarks, false we only generate bookmarks if not already generated
  - setCoordText
```
public void setCoordText(String string)
```
    Description copied from interface: GUIFactory
    
    set text displayed in cursor co-ordinates box
  - setPageNumber
```
public void setPageNumber()
```
    Description copied from interface: GUIFactory
    
    set page number at bottom of screen
  - setPage
```
public void setPage(int page)
```
    Set the interfaces page counter to the page number and alter any other interface options to match.
    
    Parameters:
    
    page - page number as an int
  - getType
```
public Enum getType()
```
    Get the type of the user interface
    
    Returns:
    
    GUIModes.JAVAFX
  - resetPageNav
```
public void resetPageNav()
```
    Reset the page counter to empty them.
  - setRotationFromExternal
```
public void setRotationFromExternal(int rot)
```
    Method to set the viewers rotation from external sources.
    
    Parameters:
    
    rot - The rotation to use in the Viewer
  - setScalingFromExternal
```
public void setScalingFromExternal(String scale)
```
    Method to set the viewers scaling from external sources.
    
    Parameters:
    
    scale - The scaling to use in the Viewer as a String
  - getFrame
```
public javafx.stage.Stage getFrame()
```
    Description copied from interface: GUIFactory
    
    allow access to root frame if required
  - showMessageDialog
```
public int showMessageDialog(Object message1,
                             Object[] options,
                             int selectedChoice)
```
  - showMessageDialog
```
public void showMessageDialog(Object message,
                              String title,
                              int type)
```
  - showInputDialog
```
public String showInputDialog(Object message,
                              String title,
                              int type)
```
  - showInputDialog
```
public String showInputDialog(String message)
```
  - showConfirmDialog
```
public int showConfirmDialog(String message,
                             String message2,
                             int option)
```
  - showOverwriteDialog
```
public int showOverwriteDialog(String file,
                               boolean yesToAllPresent)
```
  - showMessageDialog
```
public void showMessageDialog(String message)
```
  - showMessageDialog
```
public void showMessageDialog(String message,
                              String title)
```
    Show a message dialog with the specified message and title
    
    Parameters:
    
    message - String message to be used in the dialog
    
    title - String title to be used in the dialog
  - showMessageDialog
```
public void showMessageDialog(Object info)
```
  - showFirstTimePopup
```
public void showFirstTimePopup()
```
    Method used to show popups that are displayed the first time the Viewer is opened
  - showConfirmDialog
```
public int showConfirmDialog(Object message,
                             String title,
                             int optionType,
                             int messageType)
```
  - setDownloadProgress
```
public void setDownloadProgress(String message,
                                int percentage)
```
  - updateStatusMessage
```
public void updateStatusMessage(String message)
```
    Description copied from interface: GUIFactory
    
    message to show in status object
  - resetStatusMessage
```
public void resetStatusMessage(String message)
```
  - setStatusProgress
```
public void setStatusProgress(int size)
```
    Description copied from interface: GUIFactory
    
    set current status value 0 -100
  - getSplitDividerLocation
```
public int getSplitDividerLocation()
```
    getSplitDividerLocation not supported in OpenViewerFX
    
    Returns:
    
    Always returns 0
  - printDialog
```
public Object printDialog(String[] printersList,
                          String defaultPrinter)
```
    Printing is not currently supported in OpenViewerFX
    
    Parameters:
    
    printersList -
    
    defaultPrinter -
    
    Returns:
  - getPaperSizes
```
public PaperSizes getPaperSizes()
```
    Gets the paper sizes for use by the print dialog
    
    Returns:
    
    a PaperSizes object holding all paper sizes
  - setSearchText
```
public void setSearchText(Object searchText)
```
    Set the search text field to be used for the menu bar search input
    
    Parameters:
    
    searchText - A JTextField to be used for search input
  - setResults
```
public void setResults(GUISearchList results)
```
    Set the search list to be used to hold search results in menu bar search mode
    
    Parameters:
    
    results - an implementation of GUISearchList
  - getSideTabBar
```
public Object getSideTabBar()
```
    Get the TabPane, as an Object, used for the side tab bar
    
    Returns:
    
    TabPane used for the side tab bar
  - enableSearchItems
```
public void enableSearchItems(boolean enabled)
```
    Description copied from interface: GUIFactory
    
    Method to enable / disable search options on the toolbar.
  - removeSearchWindow
```
public void removeSearchWindow(boolean justHide)
```
    Removes the search window from view with option to clear search results
    
    Parameters:
    
    justHide - true to just remove the search window, false to also clear current results
  - alterProperty
```
public void alterProperty(String value,
                          boolean set)
```
  - dispose
```
public void dispose()
```
    Method to dispose of objects used by the interface before closing.
    
    Specified by:
    
    dispose in interface GUIFactory
    
    Overrides:
    
    dispose in class GUI
  - getPageTurnScalingAppropriate
```
public boolean getPageTurnScalingAppropriate()
```
    Not part of API - used internally
  - getGUICursor
```
public SwingCursor getGUICursor()
```
    Not part of API - used internally
  - rescanPdfLayers
```
public void rescanPdfLayers()
```
    Not part of API - used internally
  - getTitles
```
public String getTitles(String title)
```
    Checks if title matches the title of any of the side tab bar tabs
    
    Parameters:
    
    title - String title to check for.
    
    Returns:
    
    String title of tab found.
  - getStatusBar
```
public Object getStatusBar()
```
    getStatusBar not supported in OpenViewerFX
    
    Returns:
    
    Always returns null
  - getButtons
```
public GUIButtons getButtons()
```
    Get the GUIButtons object that holds all buttons used by the user interface
    
    Returns:
    
    GUIButtons implementation used by the user interface
  - getMenuItems
```
public GUIMenuItems getMenuItems()
```
    Get the GUIMenuItems object that holds all the menu items used by the user interface.
    
    Returns:
    
    GUIMenuItems implementation used by the user interface
  - setTabsNotInitialised
```
public void setTabsNotInitialised(boolean b)
```
    Set tabs not initialised flag to prevent use of tabs.
    
    Parameters:
    
    b - true to mark the tabs as not initialised, false to mark as initialised
  - decodePage
```
public void decodePage()
```
    Key method that calls decodePage from GUI.java
  - updateTransitionType
```
public void updateTransitionType()
```
    Set the transition type to be used when changing between pages
  - getPageContainer
```
public javafx.scene.control.ScrollPane getPageContainer()
```
    Get the page container for the PDF display area
    
    Returns:
    
    ScrollPane containing the PdfDecoderFX
  - getPdfDecoder
```
public PdfDecoderFX getPdfDecoder()
```
    Get the PdfDecoderFX object used to display the PDF in the user interface
    
    Returns:
    
    PdfDecoderFX object used for display
  - addComboListenerAndLabel
```
protected void addComboListenerAndLabel(GUICombo combo)
```
    Overrides method from GUI.java, see GUI.java for DOCS.
    
    Overrides:
    
    addComboListenerAndLabel in class GUI
  - addGUIComboBoxes
```
protected void addGUIComboBoxes(GUICombo combo)
```
    Overrides method from GUI.java, see GUI.java for DOCS.
    
    Overrides:
    
    addGUIComboBoxes in class GUI
  - setupCenterPanelBackground
```
protected void setupCenterPanelBackground()
```
    Overrides method from GUI.java, see GUI.java for DOCS.
    
    Overrides:
    
    setupCenterPanelBackground in class GUI
  - setupComboBoxes
```
protected void setupComboBoxes()
```
    Overrides method from GUI.java, see GUI.java for DOCS.
    
    Overrides:
    
    setupComboBoxes in class GUI
  - setupKeyboardControl
```
protected void setupKeyboardControl()
```
    Uses Keyboard Arrow Keys (UP/DOWN LEFT/RIGT) to Control Page Navigation. Overrides method from GUI.java, see GUI.java for DOCS.
    
    Overrides:
    
    setupKeyboardControl in class GUI
  - setupPDFDisplayPane
```
protected void setupPDFDisplayPane()
```
    Description copied from class: GUI
    
    Sets up the central display pane to display the pdf content.
    
    Overrides:
    
    setupPDFDisplayPane in class GUI
  - setupBorderPanes
```
protected void setupBorderPanes()
```
    Overrides method from GUI.java, see GUI.java for DOCS.
    
    Overrides:
    
    setupBorderPanes in class GUI
  - setupBottomToolBarItems
```
protected void setupBottomToolBarItems()
```
    Sets up the position & visual style of the items on the bottom toolbar (page navigation buttons etc).
    
    Overrides:
    
    setupBottomToolBarItems in class GUI
  - setupPDFBorder
```
protected void setupPDFBorder()
```
    Creates a glowing border around the PDFDisplayPane.
    
    Overrides:
    
    setupPDFBorder in class GUI
  - createTopMenuBar
```
protected void createTopMenuBar()
```
    Creates the top two menu bars, the file loading & viewer properties one and the PDF toolbar, the one which controls searching etc.
    
    Overrides:
    
    createTopMenuBar in class GUI
  - createMainViewerWindow
```
protected void createMainViewerWindow(int width,
                                      int height)
```
    Creates the Main Display Window for all of the JavaFX Content.
    
    Overrides:
    
    createMainViewerWindow in class GUI
    
    Parameters:
    
    width - is of type int
    
    height - is of type int
  - setScrollBarPolicy
```
public void setScrollBarPolicy(GUI.ScrollPolicy pol)
```
    Sets the scroll bar policy for the display areas scroll pane
    
    Parameters:
    
    pol - ScrollPolicy to be applied to the scroll pane
  - getRecentDocument
```
public RecentDocumentsFactory getRecentDocument()
```
    Returns the RecentDocumentFactory used to hand the recent document list
    
    Returns:
    
    RecentDocumentFactory used by the user interface
  - setRecentDocument
```
public void setRecentDocument()
```
    Create the RecentDocuments for the user interface
  - openFile
```
public void openFile(String fileToOpen)
```
    Open a file in the Viewer
    
    Parameters:
    
    fileToOpen - String filename for the file to be opened
  - open
```
public void open(String fileName)
```
    Open a file in the Viewer
    
    Parameters:
    
    fileName - String filename for the file to be opened
  - enablePageCounter
```
public void enablePageCounter(GUI.PageCounter value,
                              boolean enabled,
                              boolean visibility)
```
    Enable and make visible different parts of the page counter of all of it
    
    Parameters:
    
    value - PageCounter value for the different page counter elements
    
    enabled - true to enable the counter section, false to disable.
    
    visibility - true to make visible the counter section, false to disable.
  - removePageListener
```
public void removePageListener()
```
    Remove the ChangeListener from the PdfDecoder and flush cached pages
  - setPageCounterText
```
public void setPageCounterText(GUI.PageCounter value,
                               String text)
```
    Set the text content for a section of the page counter.
    
    Parameters:
    
    value - PageCounter value for the different page counter elements
    
    text - String value to be place in the page counter
  - getPageCounter
```
public Object getPageCounter(GUI.PageCounter value)
```
    Get the page counter segments
    
    Parameters:
    
    value - PageCounter value for the different page counter elements
    
    Returns:
    
    an Object containing the section of the page counter
  - updateTextBoxSize
```
public void updateTextBoxSize()
```
    Update the page counter input size to accommodate the contents
  - enableCursor
```
public void enableCursor(boolean enabled,
                         boolean visible)
```
    Enable and or set visibility for the cursor display for multi box
    
    Parameters:
    
    enabled - true to enable, false to disable
    
    visible - true to make visible, false to make invisible
  - enableMemoryBar
```
public void enableMemoryBar(boolean enabled,
                            boolean visible)
```
  - enableNavigationBar
```
public void enableNavigationBar(boolean enabled,
                                boolean visible)
```
  - enableDownloadBar
```
public void enableDownloadBar(boolean enabled,
                              boolean visible)
```
    Enable and or set visibility for the download display for multi box
    
    Parameters:
    
    enabled - true to enable, false to disable
    
    visible - true to make visible, false to make invisible
  - getSidebarTabCount
```
public int getSidebarTabCount()
```
    Get the current count of tabs on the side tab bar
    
    Returns:
    
    int value representing the number of tabs currently visible
  - getSidebarTabTitleAt
```
public String getSidebarTabTitleAt(int pos)
```
    Get the title of the tab at the given position
    
    Parameters:
    
    pos - The position of the tab on the tabbed pane
    
    Returns:
    
    String title of the given tab or an empty String is tab not present.
  - removeSidebarTabAt
```
public void removeSidebarTabAt(int pos)
```
    Remove the tab at the specified position from the side tab bar
    
    Parameters:
    
    pos - Tab index to removed.
  - getDividerLocation
```
public double getDividerLocation()
```
    Get the divider location for the viewer
    
    Returns:
    
    double representation of the divider location
  - getStartSize
```
public double getStartSize()
```
    Get the start / collapsed position of the split pane divider
    
    Returns:
    
    divider position as a double
  - setStartSize
```
public void setStartSize(int size)
```
    Set the start / collapsed position of the split pane divider
    
    Parameters:
    
    size - position as an int
  - scaleToVisible
```
public float scaleToVisible(float left,
                            float right,
                            float top,
                            float bottom)
```
    calculates the scaling required to make the given area visible
  - getDropShadowDepth
```
public int getDropShadowDepth()
```
    Get the thickness of the glow border
    
    Returns:
    
    thickness of glow as an int
  - getRoot
```
public javafx.scene.layout.BorderPane getRoot()
```
    Get the root pane that holds the GUI interface
    
    Returns:
    
    BorderPane object for the user interface
  - setPannable
```
public void setPannable(boolean pan)
```
    Set is the page display can be panned
    
    Parameters:
    
    pan - boolean value to control if pannable
  - setupSplitPaneDivider
```
public void setupSplitPaneDivider(int size,
                                  boolean visibility)
```
    Set up the split pane divider for use
    
    Parameters:
    
    size - unsupported in OpenViewerFX
    
    visibility - true to set left side of divider visible and enabled, false to set disabled and invisible
  - enableStatusBar
```
public void enableStatusBar(boolean enabled,
                            boolean visible)
```
    Enable and or set visibility for the status bar for multi box
    
    Parameters:
    
    enabled - true to enable, false to disable
    
    visible - true to make visible, false to make invisible
  - getAnnotationPanel
```
public GUIAnnotationPanel getAnnotationPanel()
```
    Annotation panel is not available in FX Viewer
  - getGlassPane
```
public Object getGlassPane()
```
    Glass pane is not available in FX Viewer
  - openNewMultiplePage
```
public PdfDecoderInt openNewMultiplePage(String selectedFile,
                                         Values commonValues)
```
    Not used in FX.
    
    Throws:
    
    RuntimeException - When called throws a runtime exception
  - triggerPageTurnAnimation
```
public void triggerPageTurnAnimation(PdfDecoderInt decode_pdf,
                                     Values commonValues,
                                     int updatedTotal,
                                     boolean rightTurn)
```
    triggerPageTurnAnimation is unsupported in OpenViewerFX
  - getTitle
```
protected String getTitle()
```
    Overrides:
    
    getTitle in class GUI

Class JavaFxGUI

Nested Class Summary

Nested classes/interfaces inherited from class org.jpedal.examples.viewer.gui.GUI

Field Summary

Fields inherited from class org.jpedal.examples.viewer.gui.GUI

Fields inherited from interface org.jpedal.gui.GUIFactory

Constructor Summary

Method Summary

Methods inherited from class org.jpedal.examples.viewer.gui.GUI

Methods inherited from class java.lang.Object

Field Detail

fxButtons

pageCounter2

Constructor Detail

JavaFxGUI

Method Detail

getThumbnailScrollBar

setThumbnailScrollBarVisibility

setThumbnailScrollBarValue

getDisplayPane

getMultiViewerFrames

getPropertiesFileLocation

getBookmark

reinitialiseTabs

stopThumbnails

reinitThumbnails

resetNavBar

setNoPagesDecoded

setDisplayMode

isSingle

getThumbnailPanel

getOutlinePanel

getVerticalScrollBar

setRootContainer

resetRotationBox

getProperties

searchInTab

setPropertiesFileLocation

getCommand

init

createOtherToolBars

setMultibox

setViewerIcon

setDisplayView

setTitle

resetComboBoxes

getCombo

scaleAndRotate

getScalingRatio

snapScalingToDefaults

rotate

scrollToPage

setupThumbnailPanel

setBookmarks

setCoordText

setPageNumber

setPage

getType

resetPageNav

setRotationFromExternal

setScalingFromExternal

getFrame

showMessageDialog

showMessageDialog

showInputDialog

showInputDialog

showConfirmDialog

showOverwriteDialog

showMessageDialog

showMessageDialog

showMessageDialog

showFirstTimePopup

showConfirmDialog

setDownloadProgress

updateStatusMessage

resetStatusMessage

setStatusProgress

getSplitDividerLocation

printDialog

getPaperSizes