- java.lang.Object
-
- org.icepdf.ri.common.SwingViewBuilder
-
- All Implemented Interfaces:
ViewBuilder
public class SwingViewBuilder extends Object implements ViewBuilder
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.
- Building a standalone Viewer JFrame that will behave much as a full-featured PDF viewing application.
- Building an embeddable PDF Viewer JPanel, which can easily be added into any existing client application, augmenting its capabilities to include the capacity for viewing PDF Documents.
- 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 buildSaveFileMenuItem()
- 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 JMenu buildFileMenu()
- public void buildContents(Container cp, boolean embeddableComponent)
- public JToolBar buildCompleteToolBar(boolean embeddableComponent)
- public JToolBar buildUtilityToolBar(boolean embeddableComponent)
- public JButton buildOpenFileButton()
- public JButton buildSaveFileButton()
- 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 JToolBar buildUtilityToolBar(boolean embeddableComponent)
- public JSplitPane buildUtilityAndDocumentSplitPane(boolean embeddableComponent)
- public JTabbedPane buildUtilityTabbedPane()
- public JComponent buildOutlineComponents()
- public SearchPanel buildSearchPanel()
- public JScrollPane buildDocumentComponents(boolean embeddableComponent)
- public JTabbedPane buildUtilityTabbedPane()
- public JLabel buildStatusPanel()
- public JToolBar buildCompleteToolBar(boolean embeddableComponent)
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 buildSaveFileButton()
- 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 JToolBar buildUtilityToolBar(boolean embeddableComponent)
- public JSplitPane buildUtilityAndDocumentSplitPane(boolean embeddableComponent)
- public JTabbedPane buildUtilityTabbedPane()
- public JComponent buildOutlineComponents()
- public SearchPanel buildSearchPanel()
- public JScrollPane buildDocumentComponents(boolean embeddableComponent)
- public JTabbedPane buildUtilityTabbedPane()
- public JLabel buildStatusPanel()
- public JToolBar buildCompleteToolBar(boolean embeddableComponent)
- Since:
- 2.0
- Author:
- Mark Collette
-
-
Field Summary
Fields Modifier and Type Field Description protected FontbuttonFontprotected static float[]DEFAULT_ZOOM_LEVELSprotected intdocumentPageFitModeprotected intdocumentViewTypeprotected booleanhaveMadeAToolBarprotected Images.IconSizeiconSizeprotected static booleanisMacOsprotected ResourceBundlemessageBundleprotected static ViewerPropertiesManagerpropertiesManagerprotected booleanshowButtonTextstatic intTOOL_BAR_STYLE_FIXEDprotected inttoolbarStyleprotected SwingControllerviewerControllerprotected float[]zoomLevels
-
Constructor Summary
Constructors Constructor Description SwingViewBuilder(SwingController c)Construct a SwingVewBuilder with all of the default settingsSwingViewBuilder(SwingController c, int documentViewType, int documentPageFitMode)Construct a SwingVewBuilder with all of the default settingsSwingViewBuilder(SwingController c, int documentViewType, int documentPageFitMode, float rotation)Construct a SwingVewBuilder with all of the default settingsSwingViewBuilder(SwingController c, Font bf, boolean bt, int ts, float[] zl, int documentViewType, int documentPageFitMode)Construct a SwingVewBuilder with whichever settings you desireSwingViewBuilder(SwingController c, ViewerPropertiesManager properties)Constructor that accepts a different PropertiesManager and otherwise defaults the remaining settingsSwingViewBuilder(SwingController c, ViewerPropertiesManager properties, Font bf, boolean bt, int ts, float[] zl, int documentViewType, int documentPageFitMode, float rotation)Construct a SwingVewBuilder with whichever settings you desire
-
Method Summary
-
-
-
Field Detail
-
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 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
-
iconSize
protected Images.IconSize iconSize
-
messageBundle
protected ResourceBundle messageBundle
-
propertiesManager
protected static ViewerPropertiesManager propertiesManager
-
isMacOs
protected static final boolean isMacOs
-
-
Constructor Detail
-
SwingViewBuilder
public SwingViewBuilder(SwingController c)
Construct a SwingVewBuilder with all of the default settings- Parameters:
c- Controller that will interact with the GUI
-
SwingViewBuilder
public SwingViewBuilder(SwingController c, ViewerPropertiesManager properties)
Constructor that accepts a different PropertiesManager and otherwise defaults the remaining settings- Parameters:
c- Controller that will interact with the GUIproperties- 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- Controller that will interact with the GUIdocumentViewType- view type to build , single page, single column etc.documentPageFitMode- fit mode to initially load document with.
-
SwingViewBuilder
public SwingViewBuilder(SwingController c, int documentViewType, int documentPageFitMode, float rotation)
Construct a SwingVewBuilder with all of the default settings- Parameters:
c- Controller that will interact with the GUIdocumentViewType- view type to build , single page, single column etc.documentPageFitMode- fit mode to initially load document with.rotation- default page rotation.
-
SwingViewBuilder
public SwingViewBuilder(SwingController c, Font bf, boolean bt, int ts, float[] zl, int documentViewType, int documentPageFitMode)
Construct a SwingVewBuilder with whichever settings you desire- Parameters:
c- Controller that will interact with the GUIbf- button font.bt- show button text.ts- text sizezl- zoom levelsdocumentViewType- default document view.documentPageFitMode- page fit mode
-
SwingViewBuilder
public SwingViewBuilder(SwingController c, ViewerPropertiesManager properties, Font bf, boolean bt, int ts, float[] zl, int documentViewType, int documentPageFitMode, float rotation)
Construct a SwingVewBuilder with whichever settings you desire- Parameters:
c- Controller that will interact with the GUIproperties- properties managerbf- button font.bt- show button text.ts- text sizezl- zoom levelsdocumentViewType- default document view.documentPageFitMode- page fit moderotation- rotation factor
-
-
Method Detail
-
buildViewerFrame
public JFrame buildViewerFrame()
This is a standard method for creating a standalone JFrame, that would behave as a fully functional PDF Viewer application.- Specified by:
buildViewerFramein interfaceViewBuilder- 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 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(Container cp, boolean embeddableComponent)
The Container will contain the PDF document's current page visualization and document outline if available.- Specified by:
buildContentsin interfaceViewBuilder- Parameters:
embeddableComponent- true if the component is to be used as an embedded component.cp- Container in which to put components for viewing PDF documents
-
buildCompleteMenuBar
public JMenuBar buildCompleteMenuBar()
- Specified by:
buildCompleteMenuBarin interfaceViewBuilder- Returns:
- The built menu bar
-
buildKeyStroke
protected static KeyStroke buildKeyStroke(int keyCode, int modifiers)
-
buildKeyStroke
protected static 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 buildmodifiers- to buildonRelease- 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 JMenu buildFileMenu()
-
buildRecentFileMenuItem
public JMenu buildRecentFileMenuItem()
-
buildOpenFileMenuItem
public JMenuItem buildOpenFileMenuItem()
-
buildSendByMailMenuItem
public JMenuItem buildSendByMailMenuItem()
-
buildOpenURLMenuItem
public JMenuItem buildOpenURLMenuItem()
-
buildCloseMenuItem
public JMenuItem buildCloseMenuItem()
-
buildSaveFileMenuItem
public JMenuItem buildSaveFileMenuItem()
-
buildSaveAsFileMenuItem
public JMenuItem buildSaveAsFileMenuItem()
-
buildExportDocumentFileMenuItem
public JMenuItem buildExportDocumentFileMenuItem()
-
buildExportTextMenuItem
public JMenuItem buildExportTextMenuItem()
-
buildPropertiesMenuItem
public JMenuItem buildPropertiesMenuItem()
-
buildPermissionsMenuItem
public JMenuItem buildPermissionsMenuItem()
-
buildInformationMenuItem
public JMenuItem buildInformationMenuItem()
-
buildFontInformationMenuItem
public JMenuItem buildFontInformationMenuItem()
-
buildPrintSetupMenuItem
public JMenuItem buildPrintSetupMenuItem()
-
buildPrintMenuItem
public JMenuItem buildPrintMenuItem()
-
buildExitMenuItem
public JMenuItem buildExitMenuItem()
-
buildEditMenu
public JMenu buildEditMenu()
-
buildUndoMenuItem
public JMenuItem buildUndoMenuItem()
-
buildRedoMenuItem
public JMenuItem buildRedoMenuItem()
-
buildCopyMenuItem
public JMenuItem buildCopyMenuItem()
-
buildDeleteMenuItem
public JMenuItem buildDeleteMenuItem()
-
buildSelectAllMenuItem
public JMenuItem buildSelectAllMenuItem()
-
buildDeselectAllMenuItem
public JMenuItem buildDeselectAllMenuItem()
-
buildPreferencesMenuItem
public JMenuItem buildPreferencesMenuItem()
-
buildViewMenu
public JMenu buildViewMenu()
-
buildInsertMenu
public JMenu buildInsertMenu()
-
buildFitActualSizeMenuItem
public JMenuItem buildFitActualSizeMenuItem()
-
buildInsertOutlineMenuItem
public JMenuItem buildInsertOutlineMenuItem()
-
buildFitPageMenuItem
public JMenuItem buildFitPageMenuItem()
-
buildFitWidthMenuItem
public JMenuItem buildFitWidthMenuItem()
-
buildFullScreenMenuItem
public JMenuItem buildFullScreenMenuItem()
-
buildZoomInMenuItem
public JMenuItem buildZoomInMenuItem()
-
buildZoomOutMenuItem
public JMenuItem buildZoomOutMenuItem()
-
buildRotateLeftMenuItem
public JMenuItem buildRotateLeftMenuItem()
-
buildRotateRightMenuItem
public JMenuItem buildRotateRightMenuItem()
-
buildShowHideToolBarMenuItem
public JMenuItem buildShowHideToolBarMenuItem()
-
buildShowHideUtilityPaneMenuItem
public JMenuItem buildShowHideUtilityPaneMenuItem()
-
buildDocumentMenu
public JMenu buildDocumentMenu()
-
buildFirstPageMenuItem
public JMenuItem buildFirstPageMenuItem()
-
buildPreviousPageMenuItem
public JMenuItem buildPreviousPageMenuItem()
-
buildNextPageMenuItem
public JMenuItem buildNextPageMenuItem()
-
buildLastPageMenuItem
public JMenuItem buildLastPageMenuItem()
-
buildSearchMenuItem
public JMenuItem buildSearchMenuItem()
-
buildAdvancedSearchMenuItem
public JMenuItem buildAdvancedSearchMenuItem()
-
buildSearchNextMenuItem
public JMenuItem buildSearchNextMenuItem()
-
buildSearchPreviousMenuItem
public JMenuItem buildSearchPreviousMenuItem()
-
buildGoToPageMenuItem
public JMenuItem buildGoToPageMenuItem()
-
buildWindowMenu
public JMenu buildWindowMenu()
-
buildMinimiseAllMenuItem
public JMenuItem buildMinimiseAllMenuItem()
-
buildBringAllToFrontMenuItem
public JMenuItem buildBringAllToFrontMenuItem()
-
buildShowAnnotationPreviewMenuItem
public JMenuItem buildShowAnnotationPreviewMenuItem()
-
buildWindowListMenuItems
public void buildWindowListMenuItems(JMenu menu)
-
buildHelpMenu
public JMenu buildHelpMenu()
-
buildAboutMenuItem
public JMenuItem buildAboutMenuItem()
-
buildCompleteToolBar
public JToolBar buildCompleteToolBar(boolean embeddableComponent)
Description copied from interface:ViewBuilderBuilds and return the complete tool bar- Specified by:
buildCompleteToolBarin interfaceViewBuilder- Parameters:
embeddableComponent- Whether the component will be embedded or not- Returns:
- the tool bar
-
buildUtilityToolBar
public JToolBar buildUtilityToolBar(boolean embeddableComponent)
-
buildUtilityToolBar
public JToolBar buildUtilityToolBar(boolean embeddableComponent, ViewerPropertiesManager propertiesManager)
-
buildOpenFileButton
public JButton buildOpenFileButton()
-
buildSaveFileButton
public JButton buildSaveFileButton()
-
buildPrintButton
public JButton buildPrintButton()
-
buildSearchButton
public JButton buildSearchButton()
-
buildAnnotationPreviewButton
public JButton buildAnnotationPreviewButton(Images.IconSize imageSize)
-
buildShowAnnotationUtilityButton
public JButton buildShowAnnotationUtilityButton(Images.IconSize imageSize)
-
buildShowBookmarkUtilityButton
public JButton buildShowBookmarkUtilityButton(Images.IconSize imageSize)
-
buildShowHideUtilityPaneButton
public JToggleButton buildShowHideUtilityPaneButton()
-
buildPageNavigationToolBar
public JToolBar buildPageNavigationToolBar()
-
buildFirstPageButton
public JButton buildFirstPageButton()
-
buildPreviousPageButton
public JButton buildPreviousPageButton()
-
buildNextPageButton
public JButton buildNextPageButton()
-
buildLastPageButton
public JButton buildLastPageButton()
-
buildCurrentPageNumberTextField
public JTextField buildCurrentPageNumberTextField()
-
buildNumberOfPagesLabel
public JLabel buildNumberOfPagesLabel()
-
buildZoomToolBar
public JToolBar buildZoomToolBar()
-
buildZoomOutButton
public JButton buildZoomOutButton()
-
buildZoomInButton
public JButton buildZoomInButton()
-
buildFitToolBar
public JToolBar buildFitToolBar()
-
buildFullScreenToolBar
public JToolBar buildFullScreenToolBar()
-
buildFitActualSizeButton
public JToggleButton buildFitActualSizeButton()
-
buildFitPageButton
public JToggleButton buildFitPageButton()
-
buildFitWidthButton
public JToggleButton buildFitWidthButton()
-
buildFullScreenButton
public JButton buildFullScreenButton()
-
buildRotateToolBar
public JToolBar buildRotateToolBar()
-
buildRotateLeftButton
public JButton buildRotateLeftButton()
-
buildRotateRightButton
public JButton buildRotateRightButton()
-
buildToolToolBar
public JToolBar buildToolToolBar()
-
buildAnnotationToolBar
public JToolBar buildAnnotationToolBar()
-
buildFormsToolBar
public JToolBar buildFormsToolBar()
-
buildQuickSearchToolBar
public JToolBar buildQuickSearchToolBar()
-
buildAnnotationPropertiesToolBar
public JToolBar buildAnnotationPropertiesToolBar()
-
buildPanToolButton
public JToggleButton buildPanToolButton()
-
buildTextSelectToolButton
public JToggleButton buildTextSelectToolButton()
-
buildSelectToolButton
public JToggleButton buildSelectToolButton(Images.IconSize imageSize)
-
buildDeleteAllAnnotationsButton
public JButton buildDeleteAllAnnotationsButton(Images.IconSize imageSize)
-
buildHighlightAnnotationToolButton
public AbstractButton buildHighlightAnnotationToolButton(Images.IconSize imageSize)
-
buildRedactionAnnotationToolButton
public JToggleButton buildRedactionAnnotationToolButton(Images.IconSize imageSize)
-
buildSignatureAnnotationToolButton
public JToggleButton buildSignatureAnnotationToolButton(Images.IconSize imageSize)
-
buildStrikeOutAnnotationToolButton
public AbstractButton buildStrikeOutAnnotationToolButton(Images.IconSize imageSize)
-
buildUnderlineAnnotationToolButton
public AbstractButton buildUnderlineAnnotationToolButton(Images.IconSize imageSize)
-
buildLineAnnotationToolButton
public AbstractButton buildLineAnnotationToolButton(Images.IconSize imageSize)
-
buildLinkAnnotationToolButton
public JToggleButton buildLinkAnnotationToolButton(Images.IconSize imageSize)
-
buildLineArrowAnnotationToolButton
public AbstractButton buildLineArrowAnnotationToolButton(Images.IconSize imageSize)
-
buildSquareAnnotationToolButton
public AbstractButton buildSquareAnnotationToolButton(Images.IconSize imageSize)
-
buildCircleAnnotationToolButton
public AbstractButton buildCircleAnnotationToolButton(Images.IconSize imageSize)
-
buildInkAnnotationToolButton
public AbstractButton buildInkAnnotationToolButton(Images.IconSize imageSize)
-
buildFreeTextAnnotationToolButton
public JToggleButton buildFreeTextAnnotationToolButton(Images.IconSize imageSize)
-
buildTextAnnotationToolButton
public AbstractButton buildTextAnnotationToolButton(Images.IconSize imageSize)
-
buildFormHighlightButton
public JToggleButton buildFormHighlightButton(Images.IconSize imageSize)
-
buildLinkAnnotationPropertiesToolButton
public JToggleButton buildLinkAnnotationPropertiesToolButton(Images.IconSize imageSize)
-
buildAnnotationEditingModeToolButton
public JToggleButton buildAnnotationEditingModeToolButton(Images.IconSize imageSize)
-
buildHighlightAnnotationPropertiesToolButton
public JToggleButton buildHighlightAnnotationPropertiesToolButton(Images.IconSize imageSize)
-
buildStrikeOutAnnotationPropertiesToolButton
public JToggleButton buildStrikeOutAnnotationPropertiesToolButton(Images.IconSize imageSize)
-
buildUnderlineAnnotationPropertiesToolButton
public JToggleButton buildUnderlineAnnotationPropertiesToolButton(Images.IconSize imageSize)
-
buildLineAnnotationPropertiesToolButton
public JToggleButton buildLineAnnotationPropertiesToolButton(Images.IconSize imageSize)
-
buildLineArrowAnnotationPropertiesToolButton
public JToggleButton buildLineArrowAnnotationPropertiesToolButton(Images.IconSize imageSize)
-
buildSquareAnnotationPropertiesToolButton
public JToggleButton buildSquareAnnotationPropertiesToolButton(Images.IconSize imageSize)
-
buildCircleAnnotationPropertiesToolButton
public JToggleButton buildCircleAnnotationPropertiesToolButton(Images.IconSize imageSize)
-
buildInkAnnotationPropertiesToolButton
public JToggleButton buildInkAnnotationPropertiesToolButton(Images.IconSize imageSize)
-
buildFreeTextAnnotationPropertiesToolButton
public JToggleButton buildFreeTextAnnotationPropertiesToolButton(Images.IconSize imageSize)
-
buildTextAnnotationPropertiesToolButton
public JToggleButton buildTextAnnotationPropertiesToolButton(Images.IconSize imageSize)
-
buildZoomInToolButton
public JToggleButton buildZoomInToolButton()
-
buildZoomOutToolButton
public JToggleButton buildZoomOutToolButton()
-
buildUtilityAndDocumentSplitPane
public JSplitPane buildUtilityAndDocumentSplitPane(boolean embeddableComponent)
-
buildUtilityTabbedPane
public JTabbedPane buildUtilityTabbedPane()
-
buildOutlineComponents
public JComponent buildOutlineComponents()
-
buildThumbsPanel
public ThumbnailsPanel buildThumbsPanel()
-
buildLayersComponents
public LayersPanel buildLayersComponents()
-
buildSignatureComponents
public JComponent buildSignatureComponents()
-
buildSearchPanel
public SearchPanel buildSearchPanel()
-
buildAttachmentPanel
public AttachmentPanel buildAttachmentPanel()
-
buildAnnotationPanel
public AnnotationPanel buildAnnotationPanel()
-
buildMarkupAnnotationPanel
public MarkupAnnotationPanel buildMarkupAnnotationPanel()
-
buildDestinationsPanel
public DestinationsPanel buildDestinationsPanel()
-
buildStatusPanel
public 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 JToggleButton buildPageViewSinglePageConToggleButton()
-
buildPageViewFacingPageConToggleButton
public JToggleButton buildPageViewFacingPageConToggleButton()
-
buildPageViewSinglePageNonConToggleButton
public JToggleButton buildPageViewSinglePageNonConToggleButton()
-
buildPageViewFacingPageNonConToggleButton
public JToggleButton buildPageViewFacingPageNonConToggleButton()
-
makeToolbarButton
protected JButton makeToolbarButton(String title, String toolTip, String imageName, Images.IconSize iconSize, Font font)
Utility method for creating a toolbar button.- Parameters:
title- display text for the menu itemtoolTip- tool tip textimageName- display image nameiconSize- image size file extention constantfont- display font- Returns:
- a button with the specified characteristics.
-
makeAnnotationToggleButton
protected AnnotationColorToggleButton makeAnnotationToggleButton(String title, String toolTip, String colorPreferenceKey, String imageName, Images.IconSize imageSize, Font font, float alpha)
-
makeToolbarToggleButton
protected JToggleButton makeToolbarToggleButton(String title, String toolTip, String imageName, Images.IconSize imageSize, Font font)
Utility method for creating toggle buttons.- Parameters:
title- display text for the menu itemtoolTip- tool tip textimageName- display image namefont- display fontimageSize- imageSize image size constant- Returns:
- a toggle button with the specified characteristics.
-
makeToolbarToggleButtonSmall
protected JToggleButton makeToolbarToggleButtonSmall(String title, String toolTip, String imageName, Images.IconSize imageSize, Font font)
Utility method for creating small toggle buttons (24x24) that also have a selected icon state. .- Parameters:
title- display text for the menu itemtoolTip- tool tip textimageName- display image namefont- display fontimageSize- imageSize image size constant- Returns:
- a toggle button with the specified characteristics.
-
makeMenuItem
protected static JMenuItem makeMenuItem(String text, KeyStroke accel)
Utility method for creating a menu item.- Parameters:
text- display text for the menu itemaccel- accelerator key- Returns:
- menu item complete with text and action listener
-
makeMenuItem
protected JMenuItem makeMenuItem(String text, String imageName, Images.IconSize imageSize, KeyStroke accel)
Utility method for creating a menu item with an image.- Parameters:
text- display text for the menu itemimageName- display image for the menu itemimageSize- size of the image.accel- accelerator key- Returns:
- menu item complete with text, image and action listener
-
commonToolBarSetup
protected void commonToolBarSetup(JToolBar toolbar, boolean isMainToolBar)
-
doubleCheckPropertiesManager
protected static 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(ViewerPropertiesManager propertiesManager)
Method to attempt to override the system properties with various values form the preferences class.- Parameters:
propertiesManager- current properties manager.
-
buildButtonFont
public static Font buildButtonFont()
-
addToToolBar
protected void addToToolBar(JToolBar toolbar, JComponent comp)
-
-