GUIFactory (org.jpedal:OpenViewerFX 7.12.28 API)

All Known Implementing Classes:

GUI, JavaFxGUI
```
public interface GUIFactory
```

Field Summary

Fields
Modifier and Type	Field and Description
`static boolean`	`alwaysShowMouse`
`static int`	`BUTTONBAR`
`static boolean`	`deletePropertiesOnExit`
`static Integer`	`MULTIPAGE` flag used to show opening of multiple PDFs
`static int`	`NAVBAR`
`static int`	`PAGES`

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`boolean`	`allowScrolling()` show if user has set auto-scrolling on or off - if on moves at edge of panel to show more
`void`	`alterProperty(String value, boolean show)`
`boolean`	`confirmClose()` show is user has set the option to have exit confirmed with a dialog
`void`	`decodePage()`
`void`	`dispose()`
`void`	`enableCursor(boolean enabled, boolean visible)`
`void`	`enableDownloadBar(boolean enabled, boolean visible)`
`void`	`enableMemoryBar(boolean enabled, boolean visible)`
`void`	`enableNavigationBar(boolean enabled, boolean visible)`
`void`	`enablePageCounter(GUI.PageCounter value, boolean enabled, boolean visibility)`
`void`	`enableSearchItems(boolean enabled)` Method to enable / disable search options on the toolbar.
`void`	`enableStatusBar(boolean enabled, boolean visible)`
`GUIAnnotationPanel`	`getAnnotationPanel()`
`String`	`getBookmark(String bookmark)`
`GUIButtons`	`getButtons()`
`GUICombo`	`getCombo(int ID)` return comboBox or nul if not (QUALITY, SCALING or ROTATION
`Commands`	`getCommand()` access to command object
`Object`	`getDisplayPane()`
`double`	`getDividerLocation()`
`int`	`getDropShadowDepth()`
`Object`	`getFrame()` allow access to root frame if required
`Object`	`getGlassPane()`
`SwingCursor`	`getGUICursor()`
`Map`	`getHotspots()`
`GUIMenuItems`	`getMenuItems()`
`Object`	`getMultiViewerFrames()`
`Object`	`getOutlinePanel()`
`Object`	`getPageContainer()`
`Object`	`getPageCounter(GUI.PageCounter value)`
`String`	`getPageLabel(int pageNumber)`
`boolean`	`getPageTurnScalingAppropriate()`
`PaperSizes`	`getPaperSizes()`
`PdfDecoderInt`	`getPdfDecoder()`
`PropertiesFile`	`getProperties()` This method returns the object that stores and handles the various preferences for the viewer.
`String`	`getPropertiesFileLocation()`
`RecentDocumentsFactory`	`getRecentDocument()`
`int`	`getRotation()` get current rotation
`float`	`getScaling()` get current scaling
`int`	`getSidebarTabCount()`
`String`	`getSidebarTabTitleAt(int pos)`
`Object`	`getSideTabBar()`
`int`	`getSplitDividerLocation()`
`double`	`getStartSize()`
`Object`	`getStatusBar()`
`Object`	`getThumbnailPanel()`
`Object`	`getThumbnailScrollBar()`
`String`	`getTitles(String title)`
`Enum`	`getType()`
`Values`	`getValues()`
`Object`	`getVerticalScrollBar()`
`void`	`init(Commands currentCommands)` main method to initialise Swing specific code and create GUI display
`boolean`	`isCommandInThread()`
`boolean`	`isExecutingCommand()`
`boolean`	`isSingle()`
`void`	`open(String fileName)`
`void`	`openFile(String fileToOpen)`
`PdfDecoderInt`	`openNewMultiplePage(String selectedFile, Values commonValues)`
`Object`	`printDialog(String[] printersList, String defaultPrinter)`
`void`	`reinitialiseTabs(boolean showVisible)`
`void`	`reinitThumbnails()`
`void`	`removePageListener()`
`void`	`removeSearchWindow(boolean justHide)`
`void`	`removeSidebarTabAt(int pos)`
`void`	`rescanPdfLayers()`
`void`	`resetComboBoxes(boolean value)` set all 3 combo boxes to isEnabled(value)
`void`	`resetNavBar()`
`void`	`resetPageNav()`
`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()` zoom into page
`float`	`scaleToVisible(float left, float right, float top, float bottom)`
`void`	`scrollToPage(int page)`
`void`	`searchInTab(GUISearchWindow searchFrame)`
`void`	`setAutoScrolling(boolean autoScroll)`
`void`	`setBookmarks(boolean alwaysGenerate)`
`void`	`setCommandInThread(boolean b)`
`void`	`setCoordText(String string)` set text displayed in cursor co-ordinates box
`void`	`setDisplayMode(Integer mode)`
`void`	`setDisplayView(int SINGLE_PAGE, int DISPLAY_CENTERED)`
`void`	`setDownloadProgress(String message, int percentage)`
`void`	`setExecutingCommand(boolean b)`
`void`	`setMultibox(int[] flags)`
`void`	`setNoPagesDecoded()` flush list of pages decoded
`void`	`setPage(int newPage)`
`void`	`setPageCounterText(GUI.PageCounter value, String text)`
`void`	`setPageNumber()` set page number at bottom of screen
`void`	`setPannable(boolean pan)`
`void`	`setPropertiesFileLocation(String file)`
`void`	`setRecentDocument()`
`void`	`setResults(GUISearchList results)`
`void`	`setRootContainer(Object rawValue)`
`void`	`setRotationFromExternal(int rotation)`
`void`	`setScalingFromExternal(String scale)`
`void`	`setScrollBarPolicy(GUI.ScrollPolicy pol)`
`void`	`setSearchFrame(GUISearchWindow searchFrame)`
`void`	`setSearchText(Object searchText)`
`void`	`setStartSize(int size)`
`void`	`setStatusProgress(int size)` set current status value 0 -100
`void`	`setTabsNotInitialised(boolean b)`
`void`	`setThumbnailScrollBarValue(int pageNum)`
`void`	`setThumbnailScrollBarVisibility(boolean v)`
`void`	`setupSplitPaneDivider(int size, boolean visibility)`
`void`	`setupThumbnailPanel()`
`void`	`setViewerTitle(String title)` set title or over-ride with message
`int`	`showConfirmDialog(Object message, String title, int optionType, int messageType)`
`int`	`showConfirmDialog(String message, String message2, int option)`
`void`	`showFirstTimePopup()`
`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 message1)`
`int`	`showOverwriteDialog(String file, boolean yesToAllPresent)`
`void`	`snapScalingToDefaults(float newScaling)`
`void`	`stopThumbnails()`
`void`	`toogleAutoScrolling()` toggle state of autoscrolling on/off
`void`	`triggerPageTurnAnimation(PdfDecoderInt decode_pdf, Values commonValues, int updatedTotal, boolean rightTurn)`
`void`	`updateStatusMessage(String message)` message to show in status object
`void`	`updateTextBoxSize()`

Field Detail
- BUTTONBAR
```
static final int BUTTONBAR
```
  See Also:
  
  Constant Field Values
- NAVBAR
```
static final int NAVBAR
```
  See Also:
  
  Constant Field Values
- PAGES
```
static final int PAGES
```
  See Also:
  
  Constant Field Values
- deletePropertiesOnExit
```
static final boolean deletePropertiesOnExit
```
  See Also:
  
  Constant Field Values
- alwaysShowMouse
```
static final boolean alwaysShowMouse
```
  See Also:
  
  Constant Field Values
- MULTIPAGE
```
static final Integer MULTIPAGE
```
  flag used to show opening of multiple PDFs

Method Detail

getCommand
```
Commands getCommand()
```
access to command object

resetRotationBox
```
void resetRotationBox()
```
align rotation combo box to default for page

init
```
void init(Commands currentCommands)
```
main method to initialise Swing specific code and create GUI display

setViewerTitle
```
void setViewerTitle(String title)
```
set title or over-ride with message

resetComboBoxes
```
void resetComboBoxes(boolean value)
```
set all 3 combo boxes to isEnabled(value)

scaleAndRotate
```
void scaleAndRotate()
```
zoom into page

getRotation
```
int getRotation()
```
get current rotation

getScaling
```
float getScaling()
```
get current scaling

rotate
```
void rotate()
```
read value from rotation box and apply - called by combo listener

toogleAutoScrolling
```
void toogleAutoScrolling()
```
toggle state of autoscrolling on/off

setupThumbnailPanel
```
void setupThumbnailPanel()
```

setAutoScrolling

void setAutoScrolling(boolean autoScroll)

setNoPagesDecoded
```
void setNoPagesDecoded()
```
flush list of pages decoded

setCoordText
```
void setCoordText(String string)
```
set text displayed in cursor co-ordinates box

setPageNumber
```
void setPageNumber()
```
set page number at bottom of screen

getFrame
```
Object getFrame()
```
allow access to root frame if required

resetNavBar
```
void resetNavBar()
```

showMessageDialog

void showMessageDialog(String message1)

showMessageDialog

int showMessageDialog(Object message1,
                      Object[] options,
                      int selectedChoice)

showMessageDialog

void showMessageDialog(Object message,
                       String title,
                       int type)

showInputDialog

String showInputDialog(Object message,
                       String title,
                       int type)

showInputDialog

String showInputDialog(String message)

showMessageDialog
```
void showMessageDialog(Object info)
```

showConfirmDialog

int showConfirmDialog(String message,
                      String message2,
                      int option)

showOverwriteDialog

int showOverwriteDialog(String file,
                        boolean yesToAllPresent)

showFirstTimePopup
```
void showFirstTimePopup()
```

showConfirmDialog

int showConfirmDialog(Object message,
                      String title,
                      int optionType,
                      int messageType)

allowScrolling
```
boolean allowScrolling()
```
show if user has set auto-scrolling on or off - if on moves at edge of panel to show more

confirmClose
```
boolean confirmClose()
```
show is user has set the option to have exit confirmed with a dialog

updateStatusMessage
```
void updateStatusMessage(String message)
```
message to show in status object

resetStatusMessage

void resetStatusMessage(String message)

setStatusProgress
```
void setStatusProgress(int size)
```
set current status value 0 -100

printDialog

Object printDialog(String[] printersList,
                   String defaultPrinter)

setPage
```
void setPage(int newPage)
```

getType
```
Enum getType()
```

getMultiViewerFrames
```
Object getMultiViewerFrames()
```

setBookmarks

void setBookmarks(boolean alwaysGenerate)

getBookmark
```
String getBookmark(String bookmark)
```

alterProperty

void alterProperty(String value,
                   boolean show)

getGUICursor
```
SwingCursor getGUICursor()
```

setRotationFromExternal

void setRotationFromExternal(int rotation)

setResults

void setResults(GUISearchList results)

setMultibox
```
void setMultibox(int[] flags)
```

getProperties
```
PropertiesFile getProperties()
```
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.

snapScalingToDefaults

void snapScalingToDefaults(float newScaling)

getVerticalScrollBar
```
Object getVerticalScrollBar()
```

getPropertiesFileLocation
```
String getPropertiesFileLocation()
```

isSingle
```
boolean isSingle()
```

getPageContainer
```
Object getPageContainer()
```

getPaperSizes
```
PaperSizes getPaperSizes()
```

setPropertiesFileLocation

void setPropertiesFileLocation(String file)

getCombo
```
GUICombo getCombo(int ID)
```
return comboBox or nul if not (QUALITY, SCALING or ROTATION

Parameters:

ID -

Returns:

enableSearchItems
```
void enableSearchItems(boolean enabled)
```
Method to enable / disable search options on the toolbar.

getDisplayPane
```
Object getDisplayPane()
```

reinitialiseTabs

void reinitialiseTabs(boolean showVisible)

scrollToPage
```
void scrollToPage(int page)
```

getStatusBar
```
Object getStatusBar()
```

setTabsNotInitialised
```
void setTabsNotInitialised(boolean b)
```

setScalingFromExternal

void setScalingFromExternal(String scale)

getPageTurnScalingAppropriate

boolean getPageTurnScalingAppropriate()

resetPageNav
```
void resetPageNav()
```

removeSearchWindow

void removeSearchWindow(boolean justHide)

getHotspots
```
Map getHotspots()
```

setSearchText
```
void setSearchText(Object searchText)
```

stopThumbnails
```
void stopThumbnails()
```

getThumbnailPanel
```
Object getThumbnailPanel()
```

getOutlinePanel
```
Object getOutlinePanel()
```

setDownloadProgress

void setDownloadProgress(String message,
                         int percentage)

reinitThumbnails
```
void reinitThumbnails()
```

getThumbnailScrollBar
```
Object getThumbnailScrollBar()
```

setThumbnailScrollBarVisibility

void setThumbnailScrollBarVisibility(boolean v)

setThumbnailScrollBarValue

void setThumbnailScrollBarValue(int pageNum)

getSideTabBar
```
Object getSideTabBar()
```

getSplitDividerLocation
```
int getSplitDividerLocation()
```

dispose
```
void dispose()
```

rescanPdfLayers
```
void rescanPdfLayers()
```

setRootContainer

void setRootContainer(Object rawValue)

setSearchFrame

void setSearchFrame(GUISearchWindow searchFrame)

searchInTab

void searchInTab(GUISearchWindow searchFrame)

setDisplayMode
```
void setDisplayMode(Integer mode)
```

isCommandInThread
```
boolean isCommandInThread()
```
Returns:

a boolean commandInThread

setCommandInThread
```
void setCommandInThread(boolean b)
```
Parameters:

b - assigns commandInThread to b

isExecutingCommand
```
boolean isExecutingCommand()
```
Returns:

a boolean executingCommand

setExecutingCommand
```
void setExecutingCommand(boolean b)
```
Parameters:

b - assigns executingCommand to b

getPdfDecoder
```
PdfDecoderInt getPdfDecoder()
```

getButtons
```
GUIButtons getButtons()
```

getValues
```
Values getValues()
```

setScrollBarPolicy

void setScrollBarPolicy(GUI.ScrollPolicy pol)

getMenuItems
```
GUIMenuItems getMenuItems()
```

decodePage
```
void decodePage()
```

getRecentDocument

RecentDocumentsFactory getRecentDocument()

setRecentDocument
```
void setRecentDocument()
```

openFile
```
void openFile(String fileToOpen)
```

open
```
void open(String fileName)
```

enablePageCounter

void enablePageCounter(GUI.PageCounter value,
                       boolean enabled,
                       boolean visibility)

setPageCounterText

void setPageCounterText(GUI.PageCounter value,
                        String text)

getPageCounter

Object getPageCounter(GUI.PageCounter value)

updateTextBoxSize
```
void updateTextBoxSize()
```

getTitles
```
String getTitles(String title)
```

enableStatusBar

void enableStatusBar(boolean enabled,
                     boolean visible)

enableCursor

void enableCursor(boolean enabled,
                  boolean visible)

enableMemoryBar

void enableMemoryBar(boolean enabled,
                     boolean visible)

enableNavigationBar

void enableNavigationBar(boolean enabled,
                         boolean visible)

enableDownloadBar

void enableDownloadBar(boolean enabled,
                       boolean visible)

getSidebarTabCount
```
int getSidebarTabCount()
```

getSidebarTabTitleAt
```
String getSidebarTabTitleAt(int pos)
```

removeSidebarTabAt
```
void removeSidebarTabAt(int pos)
```

getDividerLocation
```
double getDividerLocation()
```

scaleToVisible

float scaleToVisible(float left,
                     float right,
                     float top,
                     float bottom)

getDropShadowDepth
```
int getDropShadowDepth()
```

setPannable
```
void setPannable(boolean pan)
```

setupSplitPaneDivider

void setupSplitPaneDivider(int size,
                           boolean visibility)

getStartSize
```
double getStartSize()
```

setStartSize
```
void setStartSize(int size)
```

setDisplayView

void setDisplayView(int SINGLE_PAGE,
                    int DISPLAY_CENTERED)

removePageListener
```
void removePageListener()
```

openNewMultiplePage

PdfDecoderInt openNewMultiplePage(String selectedFile,
                                  Values commonValues)

triggerPageTurnAnimation

void triggerPageTurnAnimation(PdfDecoderInt decode_pdf,
                              Values commonValues,
                              int updatedTotal,
                              boolean rightTurn)

getPageLabel
```
String getPageLabel(int pageNumber)
```

getAnnotationPanel

GUIAnnotationPanel getAnnotationPanel()

getGlassPane
```
Object getGlassPane()
```

Interface GUIFactory

Field Summary

Method Summary

Field Detail

BUTTONBAR

NAVBAR

PAGES

deletePropertiesOnExit

alwaysShowMouse

MULTIPAGE

Method Detail

getCommand

resetRotationBox

init

setViewerTitle

resetComboBoxes

scaleAndRotate

getRotation

getScaling

rotate

toogleAutoScrolling

setupThumbnailPanel

setAutoScrolling

setNoPagesDecoded

setCoordText

setPageNumber

getFrame

resetNavBar

showMessageDialog

showMessageDialog

showMessageDialog

showInputDialog

showInputDialog

showMessageDialog

showConfirmDialog

showOverwriteDialog

showFirstTimePopup

showConfirmDialog

allowScrolling

confirmClose

updateStatusMessage

resetStatusMessage

setStatusProgress

printDialog

setPage

getType

getMultiViewerFrames

setBookmarks

getBookmark

alterProperty

getGUICursor

setRotationFromExternal

setResults

setMultibox

getProperties

snapScalingToDefaults

getVerticalScrollBar

getPropertiesFileLocation

isSingle

getPageContainer

getPaperSizes

setPropertiesFileLocation

getCombo

enableSearchItems

getDisplayPane

reinitialiseTabs

scrollToPage

getStatusBar

setTabsNotInitialised

setScalingFromExternal

getPageTurnScalingAppropriate

resetPageNav

removeSearchWindow

getHotspots

setSearchText

stopThumbnails

getThumbnailPanel

getOutlinePanel

setDownloadProgress

reinitThumbnails