Skip to content

Customizing the Viewer

Patrick Corless edited this page Jan 18, 2020 · 1 revision

The viewer Reference Implementation can be configured using properties defined at runtime. These properties allow for easy manipulation of the Viewer RI functionality without having to modify and compile the viewer source code.

When the Viewer RI is run for the first time settings are persisted using the Java Preferences API. The location of backing file is platform dependent.

General Properties

Property Type Description
application.viewerpreferences.hidemenubar boolean Hides the menubar. Default value false.
application.viewerpreferences.hidetoolbar boolean Hides the top toolbar. Default value false.
application.viewerpreferences.fitwindow boolean When enabled shows the document with fit to width if the document does not already specify a default view. Default value, true.
application.menuitem.show.keyboard.shortcuts boolean Enables/disables menubar key events, default is true.
application.alwaysShowImageSplashWindow string Enables/disables the splash window, default is no
application.chromeOnStartup string Start with with chrome look and feel, default value is yes.
application.showLocalStorageDialogs string Yes is default value. Show dialog to use before writing properties to disk.
application.datadir string Directory to write properties file to in users home, default .icesoft/icepdf-viewer.

Toolbar Properties

Property Type Description
application.toolbar.show.pagenav boolean Show page navigation controls; first, previous, next and last. Default is true.
application.toolbar.show.fit boolean Shows page fit controls; normal, hight and width. Default is true.
application.toolbar.show.zoom boolean Shows page zoom controls. Default is true.
application.toolbar.show.rotate boolean Shows page rotation controls. Default is true.
application.toolbar.show.pagenav boolean Shows page navigation controls, next, previous, etc. Default is true.
application.toolbar.show.tool boolean Hide all toolbars. Default is false.
application.toolbar.show.annotation boolean Shows annotation creation controls. Default is true.
application.toolbar.show.utility boolean Shows utility pane control to show/hide utility pane. Default is true.

Zoom Toolbar Properties

Property Type Description
application.zoom.factor.default number Float value of default page zoom. Default if 1.0
application.zoom.range.default string Comma separate list of float values of zoom combo box. Default value is 0.05,0.1,0.25,0.5,0.75,1.0,1.5,2.0,3.0,4.0,8.0,16.0,24.0,32.0,64.0

Utility Toolbar Properties

Property Type Description
application.toolbar.show.utility boolean show utility toolbar and children. Default is true.
application.toolbar.show.utility.save boolean Show the save control, default is true.
application.toolbar.show.utility.open boolean Show the open control, default is true.
application.toolbar.show.utility.search boolean Show the search control, default is true.
application.toolbar.show.utility.pane boolean Show the utility pane control, default is true.
application.toolbar.show.utility.print boolean Show the print control, default is true.

Tools Toolbar Properties

Property Type Description
pplication.toolbar.show.tool boolean Show the tools toolbar and children. Default is true.
application.toolbar.show.annotation boolean Show the annotation toolbar and children. Default is true.

Utility Pane Properties

Property Type Description
pplication.utilitypane.show.bookmarks boolean Show the document outline panel tab, default is true.
application.utilitypane.show.search boolean Show the search panel tab, default is true.
application.utilitypane.show.annotation boolean Show the annotation properties pane, default is true.
application.utilitypane.show.thumbs boolean Show the thumbnail view pane, default is true.
application.utilitypane.show.layers boolean Show the layers view pane, default is true.

Utility Pane Properties

Property Type Description
application.statusbar boolean Show the status bar and child component, default is true.
application.statusbar.show.statuslabel boolean Show the status label, default is true.
application.statusbar.show.viewmode boolean Show the view mode controls, default is true.