JVM Flags
JPedal includes a number of flags which can be added to the Java command line to alter the way it operates. These are listed in the tables below. The values are all lower case. For example, the command: java -Dorg.jpedal.flattenForm=true -jar jpedal.jar $InputFile $OutputDirectory Flattens out all the Forms, putting them on the page display, but No interactivity. You can also set the values using System.setProperties() in Java but you must do this before accessing JPedal.
List of JVM flags in JPedal
- General JVM Flags
- Extra Flags For Specific Features
- org.jpedal.compress_tiff
- org.jpedal.multipage_tiff
- org.jpedal.opi
- org.jpedal.startWindowSize
- org.jpedal.page
- org.jpedal.bookmark
- org.jpedal.thumbnail
- org.jpedal.password
- org.jpedal.Viewer.Prefs
- org.jpedal.defaultViewerScaling
- org.jpedal.suppressViewerPopups
- org.jpedal.userControlledLAF
- org.jpedal.pageSize
- org.jpedal.pageMaxScaling
- org.jpedal.pageSizeOverridesImage
- org.jpedal.defaultPrinter
- org.jpedal.printPaperSize
- org.jpedal.separation
- org.jpedal.imageType
- org.jpedal.targetRelativeLinkDir
General JVM Flags
org.jpedal.fontdirs
Tells JPedal to register additional fonts from a list of directories and use these fonts for unembedded fonts in PDF. These directories do not need to exist so it is useful for cross-platform settings.
Accepted Values
Comma separated list of directories.
org.jpedal.useTTFontHinting
Tells JPedal to use TrueType font hinting. Default is false as some fonts contain instructions on which Apple has a patent.
Accepted Values
- true
- false
org.jpedal.securityprovider
Instructs JPedal to use an alternative Security library for encryption. This should be the full class name delimited with ‘.’ between package and class names.
Accepted Values
String class name for the providers class.
org.jpedal.RGBprofile
Instructs JPedal to use a different ICC profile from default for sRGB .
Accepted Values
The absolute filename for a .icm file.
org.jpedal.downsample
Downsampling class org.jpedal.images.SamplingFactory offers several options to improve memory usage and speed on PDFs with large images. This value can also be set programmatically.
Accepted Values
- high
- medium
- none
- print_disable
- print_enable
Default
high
org.jpedal.noURLaccess
Stop any URL from opening in browser. It also disables any tooltips on links.
Accepted Values
- true
- false
- Any message you wish to display (appears in a dialog box).
Default
false
org.jpedal.flattenForm
Flattens out all the Forms, putting them on the page display, but with no interactivity.
Accepted Values
- true
- false
Default
false
org.jpedal.inclusiveLogFilters
Only shows log messages which contain the values given by the flag. The values are given as comma-seperated values.
Accepted Values
Comma separated list of values to check for in log messages.
org.jpedal.updateFileOnClose
Saves any changes to a file automatically when the viewer is closed.
Accepted Values
- true
- false
Default
false
Extra Flags For Specific Features
org.jpedal.compress_tiff
Write out Tiff files compressed.
Features using this flag
- ExtractClippedImages
- ExtractImages
- ConvertPagesToImages
Accepted Values
- true
- false
Default
false
org.jpedal.multipage_tiff
Write out all images to one Tiff file.
Features using this flag
- ConvertPagesToImages
Accepted Values
- true
- false
Default
false
org.jpedal.opi
Include OPI metadata in XML information with images.
Features using this flag
- ExtractImages
Accepted Values
- true
- false
Default
false
org.jpedal.startWindowSize
Set the initial size of the Viewer.
Features using this flag
- Viewer
Accepted Values
A string containing width and height following the pattern WIDTHxHEIGHT. e.g 400x300
org.jpedal.page
Page number to open document, if page exists.
Features using this flag
- Viewer
Accepted Values
Any page number.
Default
1
org.jpedal.bookmark
Location to open document (either a bookmark or named destination), if valid.
Features using this flag
- Viewer
Accepted Values
The name of a destination or bookmark in the file being opened.
org.jpedal.thumbnail
Flag to disable thumbnails appearing in the Viewer.
Features using this flag
- Viewer
Accepted Values
- true
- false
Default
true
org.jpedal.password
Set a password to be used to open password protected files. If this password does not match you will asked to enter a password.
Features using this flag
- Viewer
Accepted Values
Any string
Default
No password provided, you will be asked to enter one.
org.jpedal.Viewer.Prefs
Flag to allow you to load a specific preferences file that controls which menus items are present among other things. See this tutorial for more details.
Features using this flag
- Viewer
Accepted Values
The filename of the preferences file you wish to use.
org.jpedal.defaultViewerScaling
Flag to enable user to startup with a specific scaling value from the scaling options in the Viewers scaling combo box.
Features using this flag
- Viewer
Accepted Values
- Fit Page
- Fit Height
- Fit Width
- 25
- 50
- 75
- 100
- 125
- 150
- 200
- 250
- 500
- 750
- 1000
Default
Fit Page
org.jpedal.suppressViewerPopups
Flag to enable user to suppress all popups when viewer first starts.
Features using this flag
- Viewer
Accepted Values
- true
- false
Default
false
org.jpedal.userControlledLAF
This flag grants the user control over the look and feel used by the JPedal Viewer. This flag can have 3 different input values. This should be the full class name delimited with ‘.’ between package and class names.
Features using this flag
- Viewer
Accepted Values
- true
Viewer will not set a look and feel, instead using the currently set Look and Feel. - false
Viewer will set up a look and feel based on the current preferences values (System look and feel by default). - class name of a java look and feel
Viewer will set up the specified look and feel.
Default
false
org.jpedal.pageSize
Set pagesize to scale the PDF page up to (preserving aspect ratio).
Features using this flag
- ConvertPagesToHiResImages
Accepted Values
A string containing width and height following the pattern WIDTHxHEIGHT. e.g 400x300
org.jpedal.pageMaxScaling
Set maximum scaling allowed. This can help to prevent any images becoming too large.
Features using this flag
- ConvertPagesToHiResImages
Accepted Values
Any float value (where 1 = 100% scaling).
Default
No max scaling specified.
org.jpedal.pageSizeOverridesImage
Set whether pageSize or max page scaling takes priority.
Features using this flag
- ConvertPagesToHiResImages
Accepted Values
- true
- false
Default
false
org.jpedal.defaultPrinter
Set default printer to be used by JPedal.
Features using this flag
- PrintPanel
Accepted Values
The name of an available printer.
Default
The systems default printer.
org.jpedal.printPaperSize
Set default paper size to print on.
Features using this flag
- PrintPanel
Accepted Values
The name of a paper size supported by the printer.
Default
The printers default paper size.
org.jpedal.separation
Create multiple images with separate image, text and Vector content on each. Find out more details.
Features using this flag
- ConvertPagesToHiResImages
- ConvertPagesToImages
Accepted Values
all
org.jpedal.imageType
Set colour type and colour depth of the image to be saved out using a TYPE variable from an awt BufferedImage.
Features using this flag
- ConvertPagesToHiResImages
- ConvertPagesToImages
Accepted Values
Any value from 1 to 13 based on BufferedImage type.
org.jpedal.targetRelativeLinkDir
The directory to use as the relative directory for link annotations.
Accepted Values
Absolute path of the desired directory.
Default
The directory the pdf currently open is located in.