SwingViewBuilder (ICEpdf Viewer RI)

java.lang.Object
- org.icepdf.ri.common.SwingViewBuilder

```
public class SwingViewBuilder
extends java.lang.Object
```
The purpose of this class is to facilitate in the building of user interface components that are used to view and interact with PDF Documents.

As such, there are three main scenarios that are covered.
1. Building a standalone Viewer JFrame that will behave much as a full-featured PDF viewing application.
2. Building an embeddable PDF Viewer JPanel, which can easily be added into any existing client application, augmenting its cababilities to include the capacity for viewing PDF Documents.
3. Building a subset of the above, using the various building block methods in this class to construct GUI components that provide certain aspects of the overall functionality, and adding those into your application as desired.
Building a standalone window

This is the main entry point for building a JFrame containing all of the graphical user interface elements necessary for viewing PDF files.

The hierarchy of the methods that are invoked to construct the complete GUI is provided below for your reference. You may choose to use any of the individual methods to construct a sub-set of the complete GUI that meets your specific requirements. This also provides you flexibility in the containers that you add the components into and the overall layout of the application, etc.

public JFrame buildViewerFrame()
- public JMenuBar buildCompleteMenuBar()
  - public JMenu buildFileMenu()
    - public JMenuItem buildOpenFileMenuItem()
    - public JMenuItem buildOpenURLMenuItem()
    - public JMenuItem buildCloseMenuItem()
    - public JMenuItem buildSaveAsFileMenuItem()
    - public JMenuItem buildExportTextMenuItem()
    - public JMenuItem buildExportSVGMenuItem()
    - public JMenuItem buildPermissionsMenuItem()
    - public JMenuItem buildInformationMenuItem()
    - public JMenuItem buildPrintSetupMenuItem()
    - public JMenuItem buildPrintMenuItem()
    - public JMenuItem buildExitMenuItem()
  - public JMenu buildViewMenu()
    - public JMenuItem buildFitActualSizeMenuItem()
    - public JMenuItem buildFitPageMenuItem()
    - public JMenuItem buildFitWidthMenuItem()
    - public JMenuItem buildZoomInMenuItem()
    - public JMenuItem buildZoomOutMenuItem()
    - public JMenuItem buildRotateLeftMenuItem()
    - public JMenuItem buildRotateRightMenuItem()
    - public JMenuItem buildShowHideToolBarMenuItem()
    - public JMenuItem buildShowHideUtilityPaneMenuItem()
  - public JMenu buildDocumentMenu()
    - public JMenuItem buildFirstPageMenuItem()
    - public JMenuItem buildPreviousPageMenuItem()
    - public JMenuItem buildNextPageMenuItem()
    - public JMenuItem buildLastPageMenuItem()
    - public JMenuItem buildSearchMenuItem()
    - public JMenuItem buildGoToPageMenuItem()
  - public JMenu buildWindowMenu()
    - public JMenuItem buildMinimiseAllMenuItem()
    - public JMenuItem buildBringAllToFrontMenuItem()
    - public void buildWindowListMenuItems(JMenu menu)
  - public JMenu buildHelpMenu()
    - public JMenuItem buildAboutMenuItem()
- public void buildContents(Container cp, boolean embeddableComponent)
  - public JToolBar buildCompleteToolBar(boolean embeddableComponent)
    - public JToolBar buildUtilityToolBar(boolean embeddableComponent)
      
      public JButton buildOpenFileButton()
      
      public JButton buildSaveAsFileButton()
      
      public JButton buildPrintButton()
      
      public JButton buildSearchButton()
      
      public JButton buildShowHideUtilityPaneButton()
    - public JToolBar buildPageNavigationToolBar()
      
      public JButton buildFirstPageButton()
      
      public JButton buildPreviousPageButton()
      
      public JButton buildNextPageButton()
      
      public JButton buildLastPageButton()
      
      public JTextField buildCurrentPageNumberTextField()
      
      public JLabel buildNumberOfPagesLabel()
    - public JToolBar buildZoomToolBar()
      
      public JButton buildZoomOutButton()
      
      public JComboBox buildZoomCombBox()
      
      public JButton buildZoomInButton()
    - public JToolBar buildFitToolBar()
      
      public JToggleButton buildFitActualSizeButton()
      
      public JToggleButton buildFitPageButton()
      
      public JToggleButton buildFitWidthButton()
    - public JToolBar buildRotateToolBar()
      
      public JButton buildRotateLeftButton()
      
      public JButton buildRotateRightButton()
    - public JToolBar buildToolToolBar()
      
      public JToggleButton buildPanToolButton()
      
      public JToggleButton buildZoomInToolButton()
      
      public JToggleButton buildZoomOutToolButton()
  - public JSplitPane buildUtilityAndDocumentSplitPane(boolean embeddableComponent)
    - public JTabbedPane buildUtilityTabbedPane()
      
      public JComponent buildOutlineComponents()
      
      public SearchPanel buildSearchPanel()
    - public JScrollPane buildDocumentComponents(boolean embeddableComponent)
  - public JLabel buildStatusPanel()
Building an embeddable component

This is the main entry point for building a JPanel containing all of the GUI elements necessary for viewing PDF files. The main differences between this and buildViewerFrame() are:
- The buildViewerPanel method returns a JPanel which you may then embed anywhere into your GUI
- The JPanel will not contain a menu bar.
- The JPanel uses the sub-set of the GUI components available in buildViewerFrame that are suited to an embedded component scenario.
The following hierarchy of methods that are invoked to construct the complete Component GUI is provided for your reference. You may choose to use any of the individual methods below to construct a sub-set of the complete GUI that meets your specific requirements. This also provides you flexibility in the containers that you add the components into and the overall layout of the application, etc.

public JPanel buildViewerPanel()
- public void buildContents(Container cp, boolean embeddableComponent)
  - public JToolBar buildCompleteToolBar(boolean embeddableComponent)
    - public JToolBar buildUtilityToolBar(boolean embeddableComponent)
      
      public JButton buildSaveAsFileButton()
      
      public JButton buildPrintButton()
      
      public JButton buildSearchButton()
      
      public JButton buildShowHideUtilityPaneButton()
    - public JToolBar buildPageNavigationToolBar()
      
      public JButton buildFirstPageButton()
      
      public JButton buildPreviousPageButton()
      
      public JButton buildNextPageButton()
      
      public JButton buildLastPageButton()
      
      public JTextField buildCurrentPageNumberTextField()
      
      public JLabel buildNumberOfPagesLabel()
    - public JToolBar buildZoomToolBar()
      
      public JButton buildZoomOutButton()
      
      public JComboBox buildZoomCombBox()
      
      public JButton buildZoomInButton()
    - public JToolBar buildFitToolBar()
      
      public JToggleButton buildFitActualSizeButton()
      
      public JToggleButton buildFitPageButton()
      
      public JToggleButton buildFitWidthButton()
    - public JToolBar buildRotateToolBar()
      
      public JButton buildRotateLeftButton()
      
      public JButton buildRotateRightButton()
    - public JToolBar buildToolToolBar()
      
      public JToggleButton buildPanToolButton()
      
      public JToggleButton buildZoomInToolButton()
      
      public JToggleButton buildZoomOutToolButton()
  - public JSplitPane buildUtilityAndDocumentSplitPane(boolean embeddableComponent)
    - public JTabbedPane buildUtilityTabbedPane()
      
      public JComponent buildOutlineComponents()
      
      public SearchPanel buildSearchPanel()
    - public JScrollPane buildDocumentComponents(boolean embeddableComponent)
  - public JLabel buildStatusPanel()
Since:

2.0

Author:

Mark Collette

Field Summary

Fields
Modifier and Type	Field and Description
`protected java.awt.Font`	`buttonFont`
`protected static float[]`	`DEFAULT_ZOOM_LEVELS`
`protected int`	`documentPageFitMode`
`protected int`	`documentViewType`
`protected boolean`	`haveMadeAToolBar`
`static boolean`	`isMacOs`
`protected java.util.ResourceBundle`	`messageBundle`
`protected PropertiesManager`	`propertiesManager`
`protected boolean`	`showButtonText`
`static int`	`TOOL_BAR_STYLE_FIXED`
`static int`	`TOOL_BAR_STYLE_FLOATING`
`protected int`	`toolbarStyle`
`protected SwingController`	`viewerController`
`protected float[]`	`zoomLevels`

Constructor Summary

Constructors
Constructor and Description
`SwingViewBuilder(SwingController c)` Construct a SwingVewBuilder with all of the default settings
`SwingViewBuilder(SwingController c, java.awt.Font bf, boolean bt, int ts, float[] zl, int documentViewType, int documentPageFitMode)` Construct a SwingVewBuilder with whichever settings you desire
`SwingViewBuilder(SwingController c, int documentViewType, int documentPageFitMode)` Construct a SwingVewBuilder with all of the default settings
`SwingViewBuilder(SwingController c, PropertiesManager properties)` Constructor that accepts a different PropertiesManager and otherwise defaults the remaining settings
`SwingViewBuilder(SwingController c, PropertiesManager properties, java.awt.Font bf, boolean bt, int ts, float[] zl, int documentViewType, int documentPageFitMode)` Construct a SwingVewBuilder with whichever settings you desire

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`addToMenu(javax.swing.JMenu menu, javax.swing.JMenuItem mi)`
`protected void`	`addToMenuBar(javax.swing.JMenuBar menuBar, javax.swing.JMenu menu)`
`protected void`	`addToToolBar(javax.swing.JToolBar toolbar, javax.swing.JComponent comp)`
`javax.swing.JMenuItem`	`buildAboutMenuItem()`
`javax.swing.JToolBar`	`buildAnnotationlToolBar()`
`AnnotationPanel`	`buildAnnotationPanel()`
`javax.swing.JToolBar`	`buildAnnotationUtilityToolBar()`
`javax.swing.JMenuItem`	`buildBringAllToFrontMenuItem()`
`protected java.awt.Font`	`buildButtonFont()`
`javax.swing.JToggleButton`	`buildCircleAnnotationToolButton()`
`javax.swing.JMenuItem`	`buildCloseMenuItem()`
`javax.swing.JMenuBar`	`buildCompleteMenuBar()`
`javax.swing.JToolBar`	`buildCompleteToolBar(boolean embeddableComponent)`
`void`	`buildContents(java.awt.Container cp, boolean embeddableComponent)` The Container will contain the PDF document's current page visualization and document outline if available.
`javax.swing.JMenuItem`	`buildCopyMenuItem()`
`javax.swing.JTextField`	`buildCurrentPageNumberTextField()`
`javax.swing.JMenuItem`	`buildDeleteMenuItem()`
`javax.swing.JToolBar`	`buildDemoToolBar()`
`javax.swing.JMenuItem`	`buildDeselectAllMenuItem()`
`javax.swing.JMenu`	`buildDocumentMenu()`
`javax.swing.JMenu`	`buildEditMenu()`
`javax.swing.JMenuItem`	`buildExitMenuItem()`
`javax.swing.JMenuItem`	`buildExportSVGMenuItem()`
`javax.swing.JMenuItem`	`buildExportTextMenuItem()`
`javax.swing.JMenu`	`buildFileMenu()`
`javax.swing.JButton`	`buildFirstPageButton()`
`javax.swing.JMenuItem`	`buildFirstPageMenuItem()`
`javax.swing.JToggleButton`	`buildFitActualSizeButton()`
`javax.swing.JMenuItem`	`buildFitActualSizeMenuItem()`
`javax.swing.JToggleButton`	`buildFitPageButton()`
`javax.swing.JMenuItem`	`buildFitPageMenuItem()`
`javax.swing.JToolBar`	`buildFitToolBar()`
`javax.swing.JToggleButton`	`buildFitWidthButton()`
`javax.swing.JMenuItem`	`buildFitWidthMenuItem()`
`javax.swing.JToggleButton`	`buildFontEngineButton()`
`javax.swing.JToggleButton`	`buildFormHighlightButton(java.lang.String imageSize)`
`javax.swing.JToolBar`	`buildFormsToolBar()`
`javax.swing.JToggleButton`	`buildFreeTextAnnotationToolButton()`
`javax.swing.JMenuItem`	`buildGoToPageMenuItem()`
`javax.swing.JMenu`	`buildHelpMenu()`
`javax.swing.JToggleButton`	`buildHighlightAnnotationToolButton(java.lang.String imageSize)`
`javax.swing.JToggleButton`	`buildHighlightAnnotationUtilityToolButton(java.lang.String imageSize)`
`javax.swing.JMenuItem`	`buildInformationMenuItem()`
`javax.swing.JToggleButton`	`buildInkAnnotationToolButton()`
`protected javax.swing.KeyStroke`	`buildKeyStroke(int keyCode, int modifiers)`
`protected javax.swing.KeyStroke`	`buildKeyStroke(int keyCode, int modifiers, boolean onRelease)` Create and return a KeyStroke with the specified code and modifier Note this will automatically return null if the PROPERTY_SHOW_KEYBOARD_SHORTCUTS property is 'false'
`javax.swing.JButton`	`buildLastPageButton()`
`javax.swing.JMenuItem`	`buildLastPageMenuItem()`
`LayersPanel`	`buildLayersComponents()`
`javax.swing.JToggleButton`	`buildLineAnnotationToolButton()`
`javax.swing.JToggleButton`	`buildLineArrowAnnotationToolButton()`
`javax.swing.JToggleButton`	`buildLinkAnnotationToolButton()`
`javax.swing.JMenuItem`	`buildMinimiseAllMenuItem()`
`protected int`	`buildMnemonic(char mnemonic)` Return a valid mnemonic for the passed character, unless the PropertiesManager.PROPERTY_SHOW_KEYBOARD_SHORTCUTS property is 'false', in which case we'll return -1
`javax.swing.JButton`	`buildNextPageButton()`
`javax.swing.JMenuItem`	`buildNextPageMenuItem()`
`javax.swing.JLabel`	`buildNumberOfPagesLabel()`
`javax.swing.JButton`	`buildOpenFileButton()`
`javax.swing.JMenuItem`	`buildOpenFileMenuItem()`
`javax.swing.JMenuItem`	`buildOpenURLMenuItem()`
`javax.swing.JComponent`	`buildOutlineComponents()`
`javax.swing.JToolBar`	`buildPageNavigationToolBar()`
`javax.swing.JToggleButton`	`buildPageViewFacingPageConToggleButton()`
`javax.swing.JToggleButton`	`buildPageViewFacingPageNonConToggleButton()`
`javax.swing.JToggleButton`	`buildPageViewSinglePageConToggleButton()`
`javax.swing.JToggleButton`	`buildPageViewSinglePageNonConToggleButton()`
`javax.swing.JToggleButton`	`buildPanToolButton()`
`javax.swing.JMenuItem`	`buildPermissionsMenuItem()`
`javax.swing.JButton`	`buildPreviousPageButton()`
`javax.swing.JMenuItem`	`buildPreviousPageMenuItem()`
`javax.swing.JButton`	`buildPrintButton()`
`javax.swing.JMenuItem`	`buildPrintMenuItem()`
`javax.swing.JMenuItem`	`buildPrintSetupMenuItem()`
`javax.swing.JMenuItem`	`buildRedoMenuItem()`
`javax.swing.JButton`	`buildRotateLeftButton()`
`javax.swing.JMenuItem`	`buildRotateLeftMenuItem()`
`javax.swing.JButton`	`buildRotateRightButton()`
`javax.swing.JMenuItem`	`buildRotateRightMenuItem()`
`javax.swing.JToolBar`	`buildRotateToolBar()`
`javax.swing.JButton`	`buildSaveAsFileButton()`
`javax.swing.JMenuItem`	`buildSaveAsFileMenuItem()`
`javax.swing.JButton`	`buildSearchButton()`
`javax.swing.JMenuItem`	`buildSearchMenuItem()`
`SearchPanel`	`buildSearchPanel()`
`javax.swing.JMenuItem`	`buildSelectAllMenuItem()`
`javax.swing.JToggleButton`	`buildSelectToolButton(java.lang.String imageSize)`
`javax.swing.JMenuItem`	`buildShowHideToolBarMenuItem()`
`javax.swing.JToggleButton`	`buildShowHideUtilityPaneButton()`
`javax.swing.JMenuItem`	`buildShowHideUtilityPaneMenuItem()`
`javax.swing.JToggleButton`	`buildSquareAnnotationToolButton()`
`javax.swing.JPanel`	`buildStatusPanel()` Builds the status bar panel containing a status label on the left and view mode controls on the right.
`javax.swing.JToggleButton`	`buildStrikeOutAnnotationToolButton()`
`javax.swing.JToggleButton`	`buildTextAnnotationToolButton(java.lang.String imageSize)`
`javax.swing.JToggleButton`	`buildTextAnnotationUtilityToolButton(java.lang.String imageSize)`
`javax.swing.JToggleButton`	`buildTextSelectToolButton()`
`ThumbnailsPanel`	`buildThumbsPanel()`
`javax.swing.JToolBar`	`buildToolToolBar()`
`javax.swing.JToggleButton`	`buildUnderlineAnnotationToolButton()`
`javax.swing.JMenuItem`	`buildUndoMenuItem()`
`javax.swing.JSplitPane`	`buildUtilityAndDocumentSplitPane(boolean embeddableComponent)`
`javax.swing.JTabbedPane`	`buildUtilityTabbedPane()`
`javax.swing.JToolBar`	`buildUtilityToolBar(boolean embeddableComponent)`
`javax.swing.JToolBar`	`buildUtilityToolBar(boolean embeddableComponent, PropertiesManager propertiesManager)`
`javax.swing.JFrame`	`buildViewerFrame()` This is a standard method for creating a standalone JFrame, that would behave as a fully functional PDF Viewer application.
`javax.swing.JPanel`	`buildViewerPanel()` Used by the Applet and Pilot RI code to create an embeddable panel for viewing PDF files, as opposed to buildViewerFrame(), which makes a standalone JFrame
`javax.swing.JMenu`	`buildViewMenu()`
`void`	`buildWindowListMenuItems(javax.swing.JMenu menu)`
`javax.swing.JMenu`	`buildWindowMenu()`
`javax.swing.JComboBox`	`buildZoomCombBox()`
`javax.swing.JButton`	`buildZoomInButton()`
`javax.swing.JMenuItem`	`buildZoomInMenuItem()`
`javax.swing.JToggleButton`	`buildZoomInToolButton()`
`javax.swing.JButton`	`buildZoomOutButton()`
`javax.swing.JMenuItem`	`buildZoomOutMenuItem()`
`javax.swing.JToggleButton`	`buildZoomOutToolButton()`
`javax.swing.JToolBar`	`buildZoomToolBar()`
`protected void`	`commonToolBarSetup(javax.swing.JToolBar toolbar, boolean isMainToolBar)`
`protected void`	`doubleCheckPropertiesManager()` Method to try to get the properties manager from the window management callback, if we don't already have a propertiesManager object
`protected javax.swing.JMenuItem`	`makeMenuItem(java.lang.String text, javax.swing.KeyStroke accel)` Utility method for creating a menu item.
`protected javax.swing.JMenuItem`	`makeMenuItem(java.lang.String text, java.lang.String imageName, java.lang.String imageSize, javax.swing.KeyStroke accel)` Utility method for creating a menu item with an image.
`protected javax.swing.JButton`	`makeToolbarButton(java.lang.String title, java.lang.String toolTip, java.lang.String imageName, java.lang.String imageSize, java.awt.Font font)` Utility method for creating a toolbar button.
`protected javax.swing.JToggleButton`	`makeToolbarToggleButton(java.lang.String title, java.lang.String toolTip, java.awt.Font font)`
`protected javax.swing.JToggleButton`	`makeToolbarToggleButton(java.lang.String title, java.lang.String toolTip, java.lang.String imageName, int imageWidth, int imageHeight, java.awt.Font font)`
`protected javax.swing.JToggleButton`	`makeToolbarToggleButton(java.lang.String title, java.lang.String toolTip, java.lang.String imageName, java.lang.String imageSize, java.awt.Font font)` Utility method for creating toggle buttons.
`protected javax.swing.JToggleButton`	`makeToolbarToggleButtonSmall(java.lang.String title, java.lang.String toolTip, java.lang.String imageName, java.lang.String imageSize, java.awt.Font font)` Utility method for creating small toggle buttons (24x24) that also have a selected icon state.
`protected void`	`overrideHighlightColor()` Method to attempt to override the system property highlight color If the current color is blank, we'll try to pull the same property from our local propertiesManager and, if found, apply it to the system properties This affects the search highlight coloring
`protected void`	`shortenDocumentOrigins(java.util.List<java.lang.Object> windowDocOriginList)`

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

Field Detail

TOOL_BAR_STYLE_FLOATING
```
public static final int TOOL_BAR_STYLE_FLOATING
```
See Also:

Constant Field Values

TOOL_BAR_STYLE_FIXED
```
public static final int TOOL_BAR_STYLE_FIXED
```
See Also:

Constant Field Values

DEFAULT_ZOOM_LEVELS

protected static final float[] DEFAULT_ZOOM_LEVELS

viewerController

protected SwingController viewerController

buttonFont
```
protected java.awt.Font buttonFont
```

showButtonText
```
protected boolean showButtonText
```

toolbarStyle
```
protected int toolbarStyle
```

zoomLevels
```
protected float[] zoomLevels
```

haveMadeAToolBar
```
protected boolean haveMadeAToolBar
```

documentViewType
```
protected int documentViewType
```

documentPageFitMode
```
protected int documentPageFitMode
```

messageBundle

protected java.util.ResourceBundle messageBundle

propertiesManager

protected PropertiesManager propertiesManager

isMacOs
```
public static boolean isMacOs
```

Constructor Detail

SwingViewBuilder
```
public SwingViewBuilder(SwingController c)
```
Construct a SwingVewBuilder with all of the default settings

Parameters:

c - SwingController that will interact with the GUI

SwingViewBuilder
```
public SwingViewBuilder(SwingController c,
                        PropertiesManager properties)
```
Constructor that accepts a different PropertiesManager and otherwise defaults the remaining settings

Parameters:

c - SwingController that will interact with the GUI

properties - PropertiesManager that can customize the UI

SwingViewBuilder
```
public SwingViewBuilder(SwingController c,
                        int documentViewType,
                        int documentPageFitMode)
```
Construct a SwingVewBuilder with all of the default settings

Parameters:

c - SwingController that will interact with the GUI

documentViewType - view type to build , single page, single column etc.

documentPageFitMode - fit mode to initially load document with.

SwingViewBuilder

public SwingViewBuilder(SwingController c,
                        java.awt.Font bf,
                        boolean bt,
                        int ts,
                        float[] zl,
                        int documentViewType,
                        int documentPageFitMode)

Construct a SwingVewBuilder with whichever settings you desire

Parameters:: c - SwingController that will interact with the GUI

SwingViewBuilder

public SwingViewBuilder(SwingController c,
                        PropertiesManager properties,
                        java.awt.Font bf,
                        boolean bt,
                        int ts,
                        float[] zl,
                        int documentViewType,
                        int documentPageFitMode)

Construct a SwingVewBuilder with whichever settings you desire

Parameters:: c - SwingController that will interact with the GUI

Method Detail

buildViewerFrame
```
public javax.swing.JFrame buildViewerFrame()
```
This is a standard method for creating a standalone JFrame, that would behave as a fully functional PDF Viewer application.

Returns:

a JFrame containing the PDF document's current page visualization, menu bar, accelerator buttons, and document outline if available.

See Also:

buildViewerPanel()

buildViewerPanel
```
public javax.swing.JPanel buildViewerPanel()
```
Used by the Applet and Pilot RI code to create an embeddable panel for viewing PDF files, as opposed to buildViewerFrame(), which makes a standalone JFrame

Returns:

JPanel containing the PDF document's current page visualization, menu bar, accelerator buttons, and document outline if available.

See Also:

buildViewerFrame()

buildContents
```
public void buildContents(java.awt.Container cp,
                          boolean embeddableComponent)
```
The Container will contain the PDF document's current page visualization and document outline if available.

Parameters:

cp - Container in which to put components for viewing PDF documents

buildCompleteMenuBar

public javax.swing.JMenuBar buildCompleteMenuBar()

buildKeyStroke

protected javax.swing.KeyStroke buildKeyStroke(int keyCode,
                                               int modifiers)

buildKeyStroke
```
protected javax.swing.KeyStroke buildKeyStroke(int keyCode,
                                               int modifiers,
                                               boolean onRelease)
```
Create and return a KeyStroke with the specified code and modifier Note this will automatically return null if the PROPERTY_SHOW_KEYBOARD_SHORTCUTS property is 'false'

Parameters:

keyCode - to build

modifiers - to build

onRelease - to build

Returns:

built KeyStroke

buildMnemonic
```
protected int buildMnemonic(char mnemonic)
```
Return a valid mnemonic for the passed character, unless the PropertiesManager.PROPERTY_SHOW_KEYBOARD_SHORTCUTS property is 'false', in which case we'll return -1

Parameters:

mnemonic - to build

Returns:

built mnemonic

buildFileMenu

public javax.swing.JMenu buildFileMenu()

buildOpenFileMenuItem

public javax.swing.JMenuItem buildOpenFileMenuItem()

buildOpenURLMenuItem

public javax.swing.JMenuItem buildOpenURLMenuItem()

buildCloseMenuItem

public javax.swing.JMenuItem buildCloseMenuItem()

buildSaveAsFileMenuItem

public javax.swing.JMenuItem buildSaveAsFileMenuItem()

buildExportTextMenuItem

public javax.swing.JMenuItem buildExportTextMenuItem()

buildExportSVGMenuItem

public javax.swing.JMenuItem buildExportSVGMenuItem()

buildPermissionsMenuItem

public javax.swing.JMenuItem buildPermissionsMenuItem()

buildInformationMenuItem

public javax.swing.JMenuItem buildInformationMenuItem()

buildPrintSetupMenuItem

public javax.swing.JMenuItem buildPrintSetupMenuItem()

buildPrintMenuItem

public javax.swing.JMenuItem buildPrintMenuItem()

buildExitMenuItem

public javax.swing.JMenuItem buildExitMenuItem()

buildEditMenu

public javax.swing.JMenu buildEditMenu()

buildUndoMenuItem

public javax.swing.JMenuItem buildUndoMenuItem()

buildRedoMenuItem

public javax.swing.JMenuItem buildRedoMenuItem()

buildCopyMenuItem

public javax.swing.JMenuItem buildCopyMenuItem()

buildDeleteMenuItem

public javax.swing.JMenuItem buildDeleteMenuItem()

buildSelectAllMenuItem

public javax.swing.JMenuItem buildSelectAllMenuItem()

buildDeselectAllMenuItem

public javax.swing.JMenuItem buildDeselectAllMenuItem()

buildViewMenu

public javax.swing.JMenu buildViewMenu()

buildFitActualSizeMenuItem

public javax.swing.JMenuItem buildFitActualSizeMenuItem()

buildFitPageMenuItem

public javax.swing.JMenuItem buildFitPageMenuItem()

buildFitWidthMenuItem

public javax.swing.JMenuItem buildFitWidthMenuItem()

buildZoomInMenuItem

public javax.swing.JMenuItem buildZoomInMenuItem()

buildZoomOutMenuItem

public javax.swing.JMenuItem buildZoomOutMenuItem()

buildRotateLeftMenuItem

public javax.swing.JMenuItem buildRotateLeftMenuItem()

buildRotateRightMenuItem

public javax.swing.JMenuItem buildRotateRightMenuItem()

buildShowHideToolBarMenuItem

public javax.swing.JMenuItem buildShowHideToolBarMenuItem()

buildShowHideUtilityPaneMenuItem

public javax.swing.JMenuItem buildShowHideUtilityPaneMenuItem()

buildDocumentMenu

public javax.swing.JMenu buildDocumentMenu()

buildFirstPageMenuItem

public javax.swing.JMenuItem buildFirstPageMenuItem()

buildPreviousPageMenuItem

public javax.swing.JMenuItem buildPreviousPageMenuItem()

buildNextPageMenuItem

public javax.swing.JMenuItem buildNextPageMenuItem()

buildLastPageMenuItem

public javax.swing.JMenuItem buildLastPageMenuItem()

buildSearchMenuItem

public javax.swing.JMenuItem buildSearchMenuItem()

buildGoToPageMenuItem

public javax.swing.JMenuItem buildGoToPageMenuItem()

buildWindowMenu

public javax.swing.JMenu buildWindowMenu()

buildMinimiseAllMenuItem

public javax.swing.JMenuItem buildMinimiseAllMenuItem()

buildBringAllToFrontMenuItem

public javax.swing.JMenuItem buildBringAllToFrontMenuItem()

buildWindowListMenuItems

public void buildWindowListMenuItems(javax.swing.JMenu menu)

shortenDocumentOrigins

protected void shortenDocumentOrigins(java.util.List<java.lang.Object> windowDocOriginList)

buildHelpMenu

public javax.swing.JMenu buildHelpMenu()

buildAboutMenuItem

public javax.swing.JMenuItem buildAboutMenuItem()

buildCompleteToolBar

public javax.swing.JToolBar buildCompleteToolBar(boolean embeddableComponent)

buildUtilityToolBar

public javax.swing.JToolBar buildUtilityToolBar(boolean embeddableComponent)

buildUtilityToolBar

public javax.swing.JToolBar buildUtilityToolBar(boolean embeddableComponent,
                                                PropertiesManager propertiesManager)

buildOpenFileButton

public javax.swing.JButton buildOpenFileButton()

buildSaveAsFileButton

public javax.swing.JButton buildSaveAsFileButton()

buildPrintButton

public javax.swing.JButton buildPrintButton()

buildSearchButton

public javax.swing.JButton buildSearchButton()

buildShowHideUtilityPaneButton

public javax.swing.JToggleButton buildShowHideUtilityPaneButton()

buildPageNavigationToolBar

public javax.swing.JToolBar buildPageNavigationToolBar()

buildFirstPageButton

public javax.swing.JButton buildFirstPageButton()

buildPreviousPageButton

public javax.swing.JButton buildPreviousPageButton()

buildNextPageButton

public javax.swing.JButton buildNextPageButton()

buildLastPageButton

public javax.swing.JButton buildLastPageButton()

buildCurrentPageNumberTextField

public javax.swing.JTextField buildCurrentPageNumberTextField()

buildNumberOfPagesLabel

public javax.swing.JLabel buildNumberOfPagesLabel()

buildZoomToolBar

public javax.swing.JToolBar buildZoomToolBar()

buildZoomOutButton

public javax.swing.JButton buildZoomOutButton()

buildZoomCombBox

public javax.swing.JComboBox buildZoomCombBox()

buildZoomInButton

public javax.swing.JButton buildZoomInButton()

buildFitToolBar

public javax.swing.JToolBar buildFitToolBar()

buildFitActualSizeButton

public javax.swing.JToggleButton buildFitActualSizeButton()

buildFitPageButton

public javax.swing.JToggleButton buildFitPageButton()

buildFontEngineButton

public javax.swing.JToggleButton buildFontEngineButton()

buildFitWidthButton

public javax.swing.JToggleButton buildFitWidthButton()

buildRotateToolBar

public javax.swing.JToolBar buildRotateToolBar()

buildRotateLeftButton

public javax.swing.JButton buildRotateLeftButton()

buildRotateRightButton

public javax.swing.JButton buildRotateRightButton()

buildToolToolBar

public javax.swing.JToolBar buildToolToolBar()

buildAnnotationlToolBar

public javax.swing.JToolBar buildAnnotationlToolBar()

buildFormsToolBar

public javax.swing.JToolBar buildFormsToolBar()

buildAnnotationUtilityToolBar

public javax.swing.JToolBar buildAnnotationUtilityToolBar()

buildDemoToolBar

public javax.swing.JToolBar buildDemoToolBar()

buildPanToolButton

public javax.swing.JToggleButton buildPanToolButton()

buildTextSelectToolButton

public javax.swing.JToggleButton buildTextSelectToolButton()

buildSelectToolButton

public javax.swing.JToggleButton buildSelectToolButton(java.lang.String imageSize)

buildLinkAnnotationToolButton

public javax.swing.JToggleButton buildLinkAnnotationToolButton()

buildHighlightAnnotationToolButton

public javax.swing.JToggleButton buildHighlightAnnotationToolButton(java.lang.String imageSize)

buildHighlightAnnotationUtilityToolButton

public javax.swing.JToggleButton buildHighlightAnnotationUtilityToolButton(java.lang.String imageSize)

buildStrikeOutAnnotationToolButton

public javax.swing.JToggleButton buildStrikeOutAnnotationToolButton()

buildUnderlineAnnotationToolButton

public javax.swing.JToggleButton buildUnderlineAnnotationToolButton()

buildLineAnnotationToolButton

public javax.swing.JToggleButton buildLineAnnotationToolButton()

buildLineArrowAnnotationToolButton

public javax.swing.JToggleButton buildLineArrowAnnotationToolButton()

buildSquareAnnotationToolButton

public javax.swing.JToggleButton buildSquareAnnotationToolButton()

buildCircleAnnotationToolButton

public javax.swing.JToggleButton buildCircleAnnotationToolButton()

buildInkAnnotationToolButton

public javax.swing.JToggleButton buildInkAnnotationToolButton()

buildFreeTextAnnotationToolButton

public javax.swing.JToggleButton buildFreeTextAnnotationToolButton()

buildTextAnnotationToolButton

public javax.swing.JToggleButton buildTextAnnotationToolButton(java.lang.String imageSize)

buildFormHighlightButton

public javax.swing.JToggleButton buildFormHighlightButton(java.lang.String imageSize)

buildTextAnnotationUtilityToolButton

public javax.swing.JToggleButton buildTextAnnotationUtilityToolButton(java.lang.String imageSize)

buildZoomInToolButton

public javax.swing.JToggleButton buildZoomInToolButton()

buildZoomOutToolButton

public javax.swing.JToggleButton buildZoomOutToolButton()

buildUtilityAndDocumentSplitPane

public javax.swing.JSplitPane buildUtilityAndDocumentSplitPane(boolean embeddableComponent)

buildUtilityTabbedPane

public javax.swing.JTabbedPane buildUtilityTabbedPane()

buildOutlineComponents

public javax.swing.JComponent buildOutlineComponents()

buildThumbsPanel

public ThumbnailsPanel buildThumbsPanel()

buildLayersComponents

public LayersPanel buildLayersComponents()

buildSearchPanel
```
public SearchPanel buildSearchPanel()
```

buildAnnotationPanel

public AnnotationPanel buildAnnotationPanel()

buildStatusPanel
```
public javax.swing.JPanel buildStatusPanel()
```
Builds the status bar panel containing a status label on the left and view mode controls on the right. The status bar can be shown or hidden completely using the view property 'application.statusbar=true|false' and the two child frame elements can be controlled using 'application.statusbar.show.statuslabel=true|false' and 'application.statusbar.show.viewmode=true|false'. The default value for all properties is 'true'.

Returns:

status panel JPanel if visible, null if the proeprty 'application.statusbar=false' is set.

buildPageViewSinglePageConToggleButton

public javax.swing.JToggleButton buildPageViewSinglePageConToggleButton()

buildPageViewFacingPageConToggleButton

public javax.swing.JToggleButton buildPageViewFacingPageConToggleButton()

buildPageViewSinglePageNonConToggleButton

public javax.swing.JToggleButton buildPageViewSinglePageNonConToggleButton()

buildPageViewFacingPageNonConToggleButton

public javax.swing.JToggleButton buildPageViewFacingPageNonConToggleButton()

makeToolbarButton

protected javax.swing.JButton makeToolbarButton(java.lang.String title,
                                                java.lang.String toolTip,
                                                java.lang.String imageName,
                                                java.lang.String imageSize,
                                                java.awt.Font font)

Utility method for creating a toolbar button.

Parameters:: title - display text for the menu item; toolTip - tool tip text; imageName - display image name; imageSize - image size file extention constant; font - display font
Returns:: a button with the specified characteristics.

makeToolbarToggleButton

protected javax.swing.JToggleButton makeToolbarToggleButton(java.lang.String title,
                                                            java.lang.String toolTip,
                                                            java.lang.String imageName,
                                                            java.lang.String imageSize,
                                                            java.awt.Font font)

Utility method for creating toggle buttons.

Parameters:: title - display text for the menu item; toolTip - tool tip text; imageName - display image name; font - display font; imageSize - imageSize image size constant
Returns:: a toggle button with the specified characteristics.

makeToolbarToggleButtonSmall

protected javax.swing.JToggleButton makeToolbarToggleButtonSmall(java.lang.String title,
                                                                 java.lang.String toolTip,
                                                                 java.lang.String imageName,
                                                                 java.lang.String imageSize,
                                                                 java.awt.Font font)

Utility method for creating small toggle buttons (24x24) that also have a selected icon state. .

Parameters:: title - display text for the menu item; toolTip - tool tip text; imageName - display image name; font - display font; imageSize - imageSize image size constant
Returns:: a toggle button with the specified characteristics.

makeToolbarToggleButton

protected javax.swing.JToggleButton makeToolbarToggleButton(java.lang.String title,
                                                            java.lang.String toolTip,
                                                            java.awt.Font font)

makeToolbarToggleButton

protected javax.swing.JToggleButton makeToolbarToggleButton(java.lang.String title,
                                                            java.lang.String toolTip,
                                                            java.lang.String imageName,
                                                            int imageWidth,
                                                            int imageHeight,
                                                            java.awt.Font font)

makeMenuItem
```
protected javax.swing.JMenuItem makeMenuItem(java.lang.String text,
                                             javax.swing.KeyStroke accel)
```
Utility method for creating a menu item.

Parameters:

text - display text for the menu item

Returns:

menu item complete with text and action listener

makeMenuItem

protected javax.swing.JMenuItem makeMenuItem(java.lang.String text,
                                             java.lang.String imageName,
                                             java.lang.String imageSize,
                                             javax.swing.KeyStroke accel)

Utility method for creating a menu item with an image.

Parameters:: text - display text for the menu item; imageName - display image for the menu item; imageSize - size of the image.
Returns:: memu item complete with text, image and action listener

commonToolBarSetup

protected void commonToolBarSetup(javax.swing.JToolBar toolbar,
                                  boolean isMainToolBar)

doubleCheckPropertiesManager
```
protected void doubleCheckPropertiesManager()
```
Method to try to get the properties manager from the window management callback, if we don't already have a propertiesManager object

overrideHighlightColor
```
protected void overrideHighlightColor()
```
Method to attempt to override the system property highlight color If the current color is blank, we'll try to pull the same property from our local propertiesManager and, if found, apply it to the system properties This affects the search highlight coloring

buildButtonFont

protected java.awt.Font buildButtonFont()

addToToolBar

protected void addToToolBar(javax.swing.JToolBar toolbar,
                            javax.swing.JComponent comp)

addToMenu

protected void addToMenu(javax.swing.JMenu menu,
                         javax.swing.JMenuItem mi)

addToMenuBar

protected void addToMenuBar(javax.swing.JMenuBar menuBar,
                            javax.swing.JMenu menu)

Class SwingViewBuilder

Building a standalone window

Building an embeddable component

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

TOOL_BAR_STYLE_FLOATING

TOOL_BAR_STYLE_FIXED

DEFAULT_ZOOM_LEVELS

viewerController

buttonFont

showButtonText

toolbarStyle

zoomLevels

haveMadeAToolBar

documentViewType

documentPageFitMode

messageBundle

propertiesManager

isMacOs

Constructor Detail

SwingViewBuilder

SwingViewBuilder

SwingViewBuilder

SwingViewBuilder

SwingViewBuilder

Method Detail

buildViewerFrame

buildViewerPanel

buildContents

buildCompleteMenuBar

buildKeyStroke

buildKeyStroke

buildMnemonic

buildFileMenu

buildOpenFileMenuItem

buildOpenURLMenuItem

buildCloseMenuItem

buildSaveAsFileMenuItem

buildExportTextMenuItem

buildExportSVGMenuItem

buildPermissionsMenuItem

buildInformationMenuItem

buildPrintSetupMenuItem

buildPrintMenuItem

buildExitMenuItem

buildEditMenu

buildUndoMenuItem

buildRedoMenuItem

buildCopyMenuItem

buildDeleteMenuItem

buildSelectAllMenuItem

buildDeselectAllMenuItem

buildViewMenu

buildFitActualSizeMenuItem

buildFitPageMenuItem

buildFitWidthMenuItem

buildZoomInMenuItem

buildZoomOutMenuItem

buildRotateLeftMenuItem

buildRotateRightMenuItem

buildShowHideToolBarMenuItem

buildShowHideUtilityPaneMenuItem

buildDocumentMenu

buildFirstPageMenuItem

buildPreviousPageMenuItem

buildNextPageMenuItem

buildLastPageMenuItem

buildSearchMenuItem

buildGoToPageMenuItem

buildWindowMenu

buildMinimiseAllMenuItem

buildBringAllToFrontMenuItem

buildWindowListMenuItems

shortenDocumentOrigins

buildHelpMenu

buildAboutMenuItem

buildCompleteToolBar