GUI (org.jpedal:OpenViewerFX 7.12.28 API)

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

All Implemented Interfaces:

GUIFactory

Direct Known Subclasses:

JavaFxGUI
```
public abstract class GUI
extends Object
implements GUIFactory
```
any shared GUI code - generic and AWT

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class GUI.PageCounter

static class GUI.ScrollPolicy
Generic ENUMS for setting similar JavaFX and Swing values.

Nested Classes
Modifier and Type	Class and Description
`static class`	`GUI.PageCounter`
`static class`	`GUI.ScrollPolicy` Generic ENUMS for setting similar JavaFX and Swing values.

Field Summary

Fields
Modifier and Type	Field and Description
`protected boolean`	`allowScrolling` stops autoscrolling at screen edge
`static boolean`	`alwaysShowMouse`
`protected String`	`annotationTitle`
`protected String`	`attachmentsTitle`
`protected boolean`	`bookmarksGenerated`
`protected String`	`bookmarksTitle`
`protected static int`	`collapsedSize`
`protected Values`	`commonValues`
`protected boolean`	`confirmClose` confirms exit when closing the window
`protected CommandListener`	`currentCommandListener` listener on buttons, menus, combboxes to execute options (one instance on all objects)
`protected Commands`	`currentCommands`
`static int`	`CURSOR`
`protected CustomMessageHandler`	`customMessageHandler`
`static boolean`	`debugFX`
`protected PdfDecoderInt`	`decode_pdf` handle for internal use
`static int`	`DEFAULT_CURSOR`
`protected static int`	`defaultSelection` default scaling on the combobox scalingValues
`static boolean`	`deletePropertiesOnExit`
`protected static int`	`expandedSize`
`protected boolean`	`finishedDecoding`
`protected Color`	`glowInnerColor`
`protected Color`	`glowOuterColor`
`protected static int`	`glowThickness` Constants for glowing border
`static int`	`GRAB_CURSOR` grabbing cursor
`static int`	`GRABBING_CURSOR`
`protected Font`	`headFont`
`protected static int`	`inset` padding so that the pdf is not right at the edge
`protected PdfLayerList`	`layersObject`
`protected String`	`layersTitle`
`protected GUIMenuItems`	`menuItems`
`protected static int`	`minimumScreenWidth` minimum screen width to ensure menu buttons are visible
`protected Map<FormObject,String>`	`objs`
`protected String`	`pageTitle`
`static int`	`PAN_CURSOR`
`static int`	`PAN_CURSORB`
`static int`	`PAN_CURSORBL`
`static int`	`PAN_CURSORBR`
`static int`	`PAN_CURSORL`
`static int`	`PAN_CURSORR`
`static int`	`PAN_CURSORT`
`static int`	`PAN_CURSORTL`
`static int`	`PAN_CURSORTR`
`protected boolean`	`previewOnSingleScroll`
`protected PropertiesFile`	`properties`
`protected RecentDocumentsFactory`	`recent`
`protected int`	`rotation` store page rotation
`protected GUICombo`	`rotationBox` scaling factors on the page
`protected float`	`scaling` page scaling to use 1=100%
`protected GUICombo`	`scalingBox` scaling factors on the page
`protected float[]`	`scalingFloatValues` scaling values as floats to save conversion
`protected GUISearchWindow`	`searchFrame`
`static boolean`	`showMessages` control if messages appear
`protected String`	`signaturesTitle`
`protected Font`	`textFont`
`protected GUIThumbnailPanel`	`thumbnails`
`protected GUIOutline`	`tree` XML structure of bookmarks
`static String`	`windowTitle`

Fields inherited from interface org.jpedal.gui.GUIFactory
BUTTONBAR, MULTIPAGE, NAVBAR, PAGES

Constructor Summary

Constructors
Constructor and Description

GUI(PdfDecoderInt decode_pdf, Values commonValues, GUIThumbnailPanel thumbnails, PropertiesFile properties)

Constructors
Constructor and Description
`GUI(PdfDecoderInt decode_pdf, Values commonValues, GUIThumbnailPanel thumbnails, PropertiesFile properties)`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`addCombo(String tooltip, int ID)`
`protected void`	`addComboListenerAndLabel(GUICombo combo)` Adds listener for the ComboBoxes and Title.
`protected void`	`addGUIComboBoxes(GUICombo combo)` Adds the ComboBoxes to theViewer.
`boolean`	`allowScrolling()` show if user has set auto-scrolling on or off - if on moves at edge of panel to show more
`boolean`	`confirmClose()` show is user has set the option to have exit confirmed with a dialog
`protected void`	`createMainViewerWindow(int width, int height)` Creates the Main Display Window for all of the JavaFX Content.
`protected void`	`createOtherToolBars()`
`protected void`	`createTopMenuBar()` Creates the top two menu bars, the file loading & viewer properties one and the PDF toolbar, the one which controls printing, searching etc.
`void`	`createUniqueAnnotationIcons()` example code which sets up an individual icon for each annotation to display - only use if you require each annotation to have its own icon
`void`	`decodeGUIPage(GUIFactory currentGUI)` called by nav functions to decode next page (in GUI code as needs to manipulate large part of GUI)
`void`	`dispose()` Dispose of the elements that require disposal
`protected static void`	`getFlattenedTreeNodes(TreeNode theNode, List<TreeNode> items)`
`Color`	`getGlowInnerColor()` Get the inner colour of the glow border
`Color`	`getGlowOuterColor()` Get the outer colour of the glow border
`int`	`getGlowThickness()` Get the thickness of the glow border
`Map`	`getHotspots()` get Map containing Form Objects setup for Unique Annotations
`String`	`getPageLabel(int pageNumber)` Get the label of the given page.
`static int`	`getPDFDisplayInset()`
`int`	`getRotation()` get current rotation
`float`	`getScaling()` get current scaling
`int`	`getSelectedComboIndex(int ID)` Get selected index for the specified combo-box
`Object`	`getSelectedComboItem(int ID)` Get selected item for the specified combo-box
`protected String`	`getTitle()`
`Values`	`getValues()` Get the values used by the GUI
`void`	`init(Commands currentCommands)` main method to initialise Swing specific code and create GUI display
`boolean`	`isCommandInThread()` Get if command is in a thread
`boolean`	`isExecutingCommand()` Get if their is currently a command executing
`boolean`	`pageLabelDiffers(int pageNumber)` Get if the page label for a given page differs from the default page numbers
`void`	`setAutoScrolling(boolean allowScrolling)`
`void`	`setCommandInThread(boolean b)` Used to flag if command is in a thread
`void`	`setDpi(int dpi)` Set the dpi value used to adjust scaling
`void`	`setExecutingCommand(boolean b)` Used to flag if command is executing
`void`	`setPdfDecoder(PdfDecoderInt decode_pdf)` Not part of API - used internally
`void`	`setPreferences(int dpi, int search, int border, boolean scroll, int pageMode, boolean updateDefaultValue, int maxNoOfMultiViewers)` Method to allow setting of common properties values
`protected void`	`setRotation()`
`void`	`setScaling(float s)` Set the scaling for the user interface and update the scaling combo box
`void`	`setSearchFrame(GUISearchWindow searchFrame)` Set the search frame to be used as part of the user interface
`void`	`setSelectedComboIndex(int ID, int index)` Set selected index for the specified combo-box
`void`	`setSelectedComboItem(int ID, String index)` Set selected item for the specified combo-box
`protected abstract void`	`setTitle(String title)` Sets the title for the Viewer.
`protected void`	`setupBorderPanes()` Sets up the panes to the left and right of the central display.
`protected void`	`setupBottomToolBarItems()` Sets up the position & visual style of the items on the bottom toolbar (page navigation buttons etc).
`protected void`	`setupCenterPanelBackground()` Sets the background for the main center display panel which holds the PDF content pane.
`protected void`	`setupComboBoxes()` Performs initial setup of the ComboBoxes.
`protected void`	`setupKeyboardControl()` Adds key listeners for keyboard navigation of the Viewer.
`protected void`	`setupPDFBorder()` Creates a glowing border around the PDFDisplayPane.
`protected void`	`setupPDFDisplayPane()` Sets up the central display pane to display the pdf content.
`protected void`	`setupSidebarTitles()`
`protected void`	`setViewerIcon()` Sets the icon for the Viewer.
`void`	`setViewerTitle(String title)` set title or over-ride with message
`void`	`toogleAutoScrolling()` toggle state of autoscrolling on/off

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

Methods inherited from interface org.jpedal.gui.GUIFactory
alterProperty, decodePage, enableCursor, enableDownloadBar, enableMemoryBar, enableNavigationBar, enablePageCounter, enableSearchItems, enableStatusBar, getAnnotationPanel, getBookmark, getButtons, getCombo, getCommand, getDisplayPane, getDividerLocation, getDropShadowDepth, getFrame, getGlassPane, getGUICursor, getMenuItems, getMultiViewerFrames, getOutlinePanel, getPageContainer, getPageCounter, getPageTurnScalingAppropriate, getPaperSizes, getPdfDecoder, getProperties, getPropertiesFileLocation, getRecentDocument, getSidebarTabCount, getSidebarTabTitleAt, getSideTabBar, getSplitDividerLocation, getStartSize, getStatusBar, getThumbnailPanel, getThumbnailScrollBar, getTitles, getType, getVerticalScrollBar, isSingle, open, openFile, openNewMultiplePage, printDialog, reinitialiseTabs, reinitThumbnails, removePageListener, removeSearchWindow, removeSidebarTabAt, rescanPdfLayers, resetComboBoxes, resetNavBar, resetPageNav, resetRotationBox, resetStatusMessage, rotate, scaleAndRotate, scaleToVisible, scrollToPage, searchInTab, setBookmarks, setCoordText, setDisplayMode, setDisplayView, setDownloadProgress, setMultibox, setNoPagesDecoded, setPage, setPageCounterText, setPageNumber, setPannable, setPropertiesFileLocation, setRecentDocument, setResults, setRootContainer, setRotationFromExternal, setScalingFromExternal, setScrollBarPolicy, setSearchText, setStartSize, setStatusProgress, setTabsNotInitialised, setThumbnailScrollBarValue, setThumbnailScrollBarVisibility, setupSplitPaneDivider, setupThumbnailPanel, showConfirmDialog, showConfirmDialog, showFirstTimePopup, showInputDialog, showInputDialog, showMessageDialog, showMessageDialog, showMessageDialog, showMessageDialog, showOverwriteDialog, snapScalingToDefaults, stopThumbnails, triggerPageTurnAnimation, updateStatusMessage, updateTextBoxSize

- Field Detail
  - deletePropertiesOnExit
```
public static boolean deletePropertiesOnExit
```
  - alwaysShowMouse
```
public static boolean alwaysShowMouse
```
  - expandedSize
```
protected static int expandedSize
```
  - collapsedSize
```
protected static int collapsedSize
```
  - windowTitle
```
public static String windowTitle
```
  - recent
```
protected RecentDocumentsFactory recent
```
  - currentCommandListener
```
protected CommandListener currentCommandListener
```
    listener on buttons, menus, combboxes to execute options (one instance on all objects)
  - currentCommands
```
protected Commands currentCommands
```
  - customMessageHandler
```
protected CustomMessageHandler customMessageHandler
```
  - showMessages
```
public static boolean showMessages
```
    control if messages appear
  - menuItems
```
protected GUIMenuItems menuItems
```
  - layersObject
```
protected PdfLayerList layersObject
```
  - finishedDecoding
```
protected boolean finishedDecoding
```
  - CURSOR
```
public static final int CURSOR
```
    See Also:
    
    Constant Field Values
  - GRAB_CURSOR
```
public static final int GRAB_CURSOR
```
    grabbing cursor
    
    See Also:
    
    Constant Field Values
  - GRABBING_CURSOR
```
public static final int GRABBING_CURSOR
```
    See Also:
    
    Constant Field Values
  - DEFAULT_CURSOR
```
public static final int DEFAULT_CURSOR
```
    See Also:
    
    Constant Field Values
  - PAN_CURSOR
```
public static final int PAN_CURSOR
```
    See Also:
    
    Constant Field Values
  - PAN_CURSORL
```
public static final int PAN_CURSORL
```
    See Also:
    
    Constant Field Values
  - PAN_CURSORTL
```
public static final int PAN_CURSORTL
```
    See Also:
    
    Constant Field Values
  - PAN_CURSORT
```
public static final int PAN_CURSORT
```
    See Also:
    
    Constant Field Values
  - PAN_CURSORTR
```
public static final int PAN_CURSORTR
```
    See Also:
    
    Constant Field Values
  - PAN_CURSORR
```
public static final int PAN_CURSORR
```
    See Also:
    
    Constant Field Values
  - PAN_CURSORBR
```
public static final int PAN_CURSORBR
```
    See Also:
    
    Constant Field Values
  - PAN_CURSORB
```
public static final int PAN_CURSORB
```
    See Also:
    
    Constant Field Values
  - PAN_CURSORBL
```
public static final int PAN_CURSORBL
```
    See Also:
    
    Constant Field Values
  - textFont
```
protected Font textFont
```
  - headFont
```
protected Font headFont
```
  - previewOnSingleScroll
```
protected boolean previewOnSingleScroll
```
  - glowThickness
```
protected static final int glowThickness
```
    Constants for glowing border
    
    See Also:
    
    Constant Field Values
  - glowOuterColor
```
protected final Color glowOuterColor
```
  - glowInnerColor
```
protected final Color glowInnerColor
```
  - objs
```
protected Map<FormObject,String> objs
```
  - bookmarksGenerated
```
protected boolean bookmarksGenerated
```
  - searchFrame
```
protected GUISearchWindow searchFrame
```
  - pageTitle
```
protected String pageTitle
```
  - bookmarksTitle
```
protected String bookmarksTitle
```
  - signaturesTitle
```
protected String signaturesTitle
```
  - layersTitle
```
protected String layersTitle
```
  - annotationTitle
```
protected String annotationTitle
```
  - attachmentsTitle
```
protected String attachmentsTitle
```
  - decode_pdf
```
protected PdfDecoderInt decode_pdf
```
    handle for internal use
  - minimumScreenWidth
```
protected static final int minimumScreenWidth
```
    minimum screen width to ensure menu buttons are visible
    
    See Also:
    
    Constant Field Values
  - tree
```
protected GUIOutline tree
```
    XML structure of bookmarks
  - allowScrolling
```
protected boolean allowScrolling
```
    stops autoscrolling at screen edge
  - confirmClose
```
protected boolean confirmClose
```
    confirms exit when closing the window
  - scalingFloatValues
```
protected float[] scalingFloatValues
```
    scaling values as floats to save conversion
  - scaling
```
protected float scaling
```
    page scaling to use 1=100%
  - inset
```
protected static int inset
```
    padding so that the pdf is not right at the edge
  - rotation
```
protected int rotation
```
    store page rotation
  - rotationBox
```
protected GUICombo rotationBox
```
    scaling factors on the page
  - scalingBox
```
protected GUICombo scalingBox
```
    scaling factors on the page
  - defaultSelection
```
protected static int defaultSelection
```
    default scaling on the combobox scalingValues
  - commonValues
```
protected final Values commonValues
```
  - thumbnails
```
protected final GUIThumbnailPanel thumbnails
```
  - properties
```
protected final PropertiesFile properties
```
  - debugFX
```
public static final boolean debugFX
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - GUI
```
public GUI(PdfDecoderInt decode_pdf,
           Values commonValues,
           GUIThumbnailPanel thumbnails,
           PropertiesFile properties)
```
- Method Detail
  - setPreferences
```
public void setPreferences(int dpi,
                           int search,
                           int border,
                           boolean scroll,
                           int pageMode,
                           boolean updateDefaultValue,
                           int maxNoOfMultiViewers)
```
    Method to allow setting of common properties values
    
    Parameters:
    
    dpi - int value to set the dpi property
    
    search - int value to set the search style property
    
    border - int value to set the border property
    
    scroll - true to enable autoscrolling, false to disable
    
    pageMode - int value to set the starting display view mode
    
    updateDefaultValue - true to enable automaticupdate property, false to disable
    
    maxNoOfMultiViewers - int value to set the maximum amount of files openable by the Multiviewer
  - allowScrolling
```
public boolean allowScrolling()
```
    Description copied from interface: GUIFactory
    
    show if user has set auto-scrolling on or off - if on moves at edge of panel to show more
    
    Specified by:
    
    allowScrolling in interface GUIFactory
  - confirmClose
```
public boolean confirmClose()
```
    Description copied from interface: GUIFactory
    
    show is user has set the option to have exit confirmed with a dialog
    
    Specified by:
    
    confirmClose in interface GUIFactory
  - setAutoScrolling
```
public void setAutoScrolling(boolean allowScrolling)
```
    Specified by:
    
    setAutoScrolling in interface GUIFactory
  - toogleAutoScrolling
```
public void toogleAutoScrolling()
```
    Description copied from interface: GUIFactory
    
    toggle state of autoscrolling on/off
    
    Specified by:
    
    toogleAutoScrolling in interface GUIFactory
  - getRotation
```
public int getRotation()
```
    Description copied from interface: GUIFactory
    
    get current rotation
    
    Specified by:
    
    getRotation in interface GUIFactory
  - getScaling
```
public float getScaling()
```
    Description copied from interface: GUIFactory
    
    get current scaling
    
    Specified by:
    
    getScaling in interface GUIFactory
  - getValues
```
public Values getValues()
```
    Get the values used by the GUI
    
    Specified by:
    
    getValues in interface GUIFactory
    
    Returns:
    
    Values object to hold various details for the viewer
  - addCombo
```
protected void addCombo(String tooltip,
                        int ID)
```
  - getHotspots
```
public Map getHotspots()
```
    get Map containing Form Objects setup for Unique Annotations
    
    Specified by:
    
    getHotspots in interface GUIFactory
    
    Returns:
    
    Map
  - setScaling
```
public void setScaling(float s)
```
    Set the scaling for the user interface and update the scaling combo box
    
    Parameters:
    
    s - float value representing the scaling where 1 is 100%
  - getPDFDisplayInset
```
public static int getPDFDisplayInset()
```
  - createUniqueAnnotationIcons
```
public void createUniqueAnnotationIcons()
```
    example code which sets up an individual icon for each annotation to display - only use if you require each annotation to have its own icon
    To use this you ideally need to parse the annotations first -there is a method allowing you to extract just the annotations from the data.
  - setDpi
```
public void setDpi(int dpi)
```
    Set the dpi value used to adjust scaling
    
    Parameters:
    
    dpi - int value to represent the dpi
  - dispose
```
public void dispose()
```
    Dispose of the elements that require disposal
    
    Specified by:
    
    dispose in interface GUIFactory
  - init
```
public void init(Commands currentCommands)
```
    main method to initialise Swing specific code and create GUI display
    
    Specified by:
    
    init in interface GUIFactory
    
    Parameters:
    
    currentCommands - Commands object to be used by the user interface
  - getTitle
```
protected String getTitle()
```
  - isCommandInThread
```
public boolean isCommandInThread()
```
    Get if command is in a thread
    
    Specified by:
    
    isCommandInThread in interface GUIFactory
    
    Returns:
    
    true if command is in thread, false otherwise.
  - setCommandInThread
```
public void setCommandInThread(boolean b)
```
    Used to flag if command is in a thread
    
    Specified by:
    
    setCommandInThread in interface GUIFactory
    
    Parameters:
    
    b - true to flag command is in thread, false otherwise.
  - isExecutingCommand
```
public boolean isExecutingCommand()
```
    Get if their is currently a command executing
    
    Specified by:
    
    isExecutingCommand in interface GUIFactory
    
    Returns:
    
    true if command is executing, false otherwise
  - setExecutingCommand
```
public void setExecutingCommand(boolean b)
```
    Used to flag if command is executing
    
    Specified by:
    
    setExecutingCommand in interface GUIFactory
    
    Parameters:
    
    b - true to flag command is executing, false otherwise.
  - getFlattenedTreeNodes
```
protected static void getFlattenedTreeNodes(TreeNode theNode,
                                            List<TreeNode> items)
```
  - getGlowThickness
```
public int getGlowThickness()
```
    Get the thickness of the glow border
    
    Returns:
    
    int value of the glow border thickness
  - getGlowOuterColor
```
public Color getGlowOuterColor()
```
    Get the outer colour of the glow border
    
    Returns:
    
    Color used for the outer section of the glow border
  - getGlowInnerColor
```
public Color getGlowInnerColor()
```
    Get the inner colour of the glow border
    
    Returns:
    
    Color used for the inner section of the glow border
  - setSearchFrame
```
public void setSearchFrame(GUISearchWindow searchFrame)
```
    Set the search frame to be used as part of the user interface
    
    Specified by:
    
    setSearchFrame in interface GUIFactory
    
    Parameters:
    
    searchFrame - GUISearchWindow object to be used as the search window
  - setRotation
```
protected void setRotation()
```
  - getSelectedComboIndex
```
public int getSelectedComboIndex(int ID)
```
    Get selected index for the specified combo-box
    
    Parameters:
    
    ID - int value specifying a combo-box
    
    Returns:
    
    int value of the selected index in the given combo-box or -1 if ID is not valid
  - setSelectedComboIndex
```
public void setSelectedComboIndex(int ID,
                                  int index)
```
    Set selected index for the specified combo-box
    
    Parameters:
    
    ID - int value specifying a combo-box
    
    index - int value of the index to select
  - getSelectedComboItem
```
public Object getSelectedComboItem(int ID)
```
    Get selected item for the specified combo-box
    
    Parameters:
    
    ID - int value specifying a combo-box
    
    Returns:
    
    Object representing the selected item or null if ID is not recognised
  - setSelectedComboItem
```
public void setSelectedComboItem(int ID,
                                 String index)
```
    Set selected item for the specified combo-box
    
    Parameters:
    
    ID - int value specifying a combo-box
    
    index - String value of the item to select
  - setPdfDecoder
```
public void setPdfDecoder(PdfDecoderInt decode_pdf)
```
    Not part of API - used internally
    Set the PdfDecoderInt object used by the user interface
    
    Parameters:
    
    decode_pdf - PdfDecoderInt used for the PDF opened in the viewer
  - decodeGUIPage
```
public void decodeGUIPage(GUIFactory currentGUI)
```
    called by nav functions to decode next page (in GUI code as needs to manipulate large part of GUI)
  - setViewerTitle
```
public void setViewerTitle(String title)
```
    Description copied from interface: GUIFactory
    
    set title or over-ride with message
    
    Specified by:
    
    setViewerTitle in interface GUIFactory
  - setTitle
```
protected abstract void setTitle(String title)
```
    Sets the title for the Viewer.
  - setViewerIcon
```
protected void setViewerIcon()
```
    Sets the icon for the Viewer.
  - addComboListenerAndLabel
```
protected void addComboListenerAndLabel(GUICombo combo)
```
    Adds listener for the ComboBoxes and Title.
  - addGUIComboBoxes
```
protected void addGUIComboBoxes(GUICombo combo)
```
    Adds the ComboBoxes to theViewer. Resize box & rotation box.
  - setupCenterPanelBackground
```
protected void setupCenterPanelBackground()
```
    Sets the background for the main center display panel which holds the PDF content pane.
  - setupComboBoxes
```
protected void setupComboBoxes()
```
    Performs initial setup of the ComboBoxes. Resize box & rotation box.
  - setupKeyboardControl
```
protected void setupKeyboardControl()
```
    Adds key listeners for keyboard navigation of the Viewer.
  - setupPDFDisplayPane
```
protected void setupPDFDisplayPane()
```
    Sets up the central display pane to display the pdf content.
  - setupBorderPanes
```
protected void setupBorderPanes()
```
    Sets up the panes to the left and right of the central display. Bookmarks & Thumbnails Pages etc.
  - createOtherToolBars
```
protected void createOtherToolBars()
```
  - setupBottomToolBarItems
```
protected void setupBottomToolBarItems()
```
    Sets up the position & visual style of the items on the bottom toolbar (page navigation buttons etc).
  - setupPDFBorder
```
protected void setupPDFBorder()
```
    Creates a glowing border around the PDFDisplayPane.
  - createTopMenuBar
```
protected void createTopMenuBar()
```
    Creates the top two menu bars, the file loading & viewer properties one and the PDF toolbar, the one which controls printing, searching etc.
  - createMainViewerWindow
```
protected void createMainViewerWindow(int width,
                                      int height)
```
    Creates the Main Display Window for all of the JavaFX Content.
    
    Parameters:
    
    width - is of type int
    
    height - is of type int
  - setupSidebarTitles
```
protected void setupSidebarTitles()
```
  - getPageLabel
```
public String getPageLabel(int pageNumber)
```
    Get the label of the given page. PDFs can specify a label for a page (such as using Roman numerals), the method will return the page label if one exists, otherwise it will return the default of the page number.
    
    Specified by:
    
    getPageLabel in interface GUIFactory
    
    Parameters:
    
    pageNumber - int value to present the page number
    
    Returns:
    
    String value representing the page label for the page.
  - pageLabelDiffers
```
public boolean pageLabelDiffers(int pageNumber)
```
    Get if the page label for a given page differs from the default page numbers
    
    Parameters:
    
    pageNumber - int value representing the page number
    
    Returns:
    
    true if the page label differs, false otherwise

Class GUI

Nested Class Summary

Field Summary

Fields inherited from interface org.jpedal.gui.GUIFactory

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.jpedal.gui.GUIFactory

Field Detail

deletePropertiesOnExit

alwaysShowMouse

expandedSize

collapsedSize

windowTitle

recent

currentCommandListener

currentCommands

customMessageHandler

showMessages

menuItems

layersObject

finishedDecoding

CURSOR

GRAB_CURSOR

GRABBING_CURSOR

DEFAULT_CURSOR

PAN_CURSOR

PAN_CURSORL

PAN_CURSORTL

PAN_CURSORT

PAN_CURSORTR

PAN_CURSORR

PAN_CURSORBR

PAN_CURSORB

PAN_CURSORBL

textFont

headFont

previewOnSingleScroll

glowThickness

glowOuterColor

glowInnerColor

objs

bookmarksGenerated

searchFrame

pageTitle

bookmarksTitle

signaturesTitle

layersTitle

annotationTitle

attachmentsTitle

decode_pdf

minimumScreenWidth

tree

allowScrolling

confirmClose

scalingFloatValues

scaling

inset

rotation

rotationBox

scalingBox

defaultSelection

commonValues

thumbnails

properties

debugFX

Constructor Detail

GUI

Method Detail

setPreferences

allowScrolling

confirmClose

setAutoScrolling

toogleAutoScrolling

getRotation

getScaling

getValues

addCombo

getHotspots

setScaling