TOC PREV NEXT INDEX

System Properties


Many system properties are available for configuring ICEpdf. They can be set programmatically or on the command line. Programmatically, the syntax is as follows:

System.getProperties().put("org.icepdf.core.minMemory", "3M");
 

On the command line, the syntax is as follows:

java -Dorg.icepdf.core.minMemory=3M ...
 

The Dynamic column indicates whether changing the value of the property at runtime has any effect. The possible values are:


Property
Type
Description
Dynamic
General
org.icepdf.core.security.

jceProvider
 
string
Specifies the classname of the security provider to use for encrypted documents. The provider must be Sun Java JCE 1.2.1 compliant.
Default value is org.bouncycastle.jce.provider.BouncyCastleProvider.
No
Memory Management
org.icepdf.core.minMemory
 
string
Sets the amount of Java heap memory to reserve as a safety buffer to prevent OutOfMemory Exceptions from occurring. If the amount of used Java heap memory is greater than (Max Memory - org.icepdf.core.minMemory), the memory manager will flush pages in the page cache until the required amount of Java heap memory is available.
The default is 5MB.
No
org.icepdf.core.maxSize
 
integer
Specifies the maximum number of pages that should be cached at one time. The default is 0, which results in as many pages as will fit in the available memory being cached. A value of 1 effectively disables the page cache.
No
org.icepdf.core.purgeSize
 
integer
Sets the number of pages that are purged from the page cache each time the memory manager attempts to free memory.
Default value is 5 pages.
No
Caching
org.icepdf.core.imagecache.enabled
 
boolean
If true, images are cached to the hard drive. The default value is true.
No
Rendering Quality
Note: For the following group of properties, target can be set for both print and screen. For dynamic changes to these System Properties to take effect, you must call org.icepdf.core.util.GraphicsRenderingHints.reset().
org.icepdf.core.awtFontLoading
 
boolean
When enabled the java.awt.Font will be used to try and load embedded font files. Default value is false. Has no effect on ICEpdf Pro.
No
org.icepdf.core.scaleImages
 
boolean
Scales images with a pixel width greater than 1000 to improve memory usage and image clarity. Default value is true.
No
org.icepdf.core.target.

alphaInterpolation
 
string
Sets the JVM's alpha interpolation rendering hint.
The default value for print is VALUE_INTERPOLATION_QUALITY. The default value for screen is VALUE_INTERPOLATION_QUALITY.
The other supported value is VALUE_ALPHA_INTERPOLATION_
DEFAULT
Yes
org.icepdf.core.target.

antiAliasing
 
string
Sets the JVM's antialiasing of all images and text.
The default value for print and screen is VALUE_ANTIALIAS_ON.
Other supported values are VALUE_ANTIALIAS_DEFAULT and VALUE_ANTIALIAS_OFF.
Yes
org.icepdf.core.target.background
 
string
Sets whether a Page will draw a background fill color before drawing the Page contents. According to the PDF standard, a white background should be drawn. When printing on white paper, for some printers with poor drivers, it is best to not draw a background at all. The default value is VALUE_DRAW_WHITE_BACKGROUND. The other supported value is VALUE_DRAW_NO_BACKGROUND.
Yes
org.icepdf.core.target.colorRender
 
string
Sets the JVM's color render rendering hint.
The default value for print and screen is VALUE_COLOR_RENDER_QUALITY.
The other supported values are VALUE_COLOR_RENDER_DEFAULT.
Yes
org.icepdf.core.target.dither
 
string
Sets the JVM's dither rendering hint.
The default value for print and screen is VALUE_DITHER_ENABLE.
Other supported values are VALUE_DITHER_DEFAULT and VALUE_DITHER_DISABLE.
Yes
org.icepdf.core.target.

fractionalmetrics
 
string
Sets the JVM's fractional metrics rendering hint.
The default value for print and screen is VALUE_FRACTIONALMETRICS_ON.
Other supported values are VALUE_FRACTIONALMETRICS_DEFAULT and VALUE_FRACTIONALMETRICS_OFF.
Yes
org.icepdf.core.target.

interpolation
 
string
Sets the JVM's interpolation rendering hint.
The default value for print and screen is VALUE_INTERPOLATION_BICUBIC.
The other supported values are VALUE_INTERPOLATION_BILINEAR and VALUE_INTERPOLATION_NEAREST_
NEIGHBOR
.
Yes
org.icepdf.core.target.render
 
string
Sets the JVM's render rendering hint.
The default value for print and screen is VALUE_RENDER_QUALITY.
The other supported values are VALUE_RENDER_DEFAULT and VALUE_RENDER_SPEED
Yes
org.icepdf.core.target.stroke
 
string
Sets the JVM's stroke rendering hint.
The default value for print and screen is VALUE_STROKE_NORMALIZE.
The other supported values are VALUE_STROKE_PURE and VALUE_STROKE_DEFAULT.
Yes
org.icepdf.core.target.

textAntiAliasing
 
string
Sets the Font rendering engine's antialiasing rendering hint.
The default value is true. The other supported value is false.
Yes
org.icepdf.core.scaleImages
 
boolean
If true, large images are scaled dynamically to a reduced resolution appropriate for online display or printing. The dynamic scaling does its best to preserve image quality and minimize memory requirements. The default value is true.
No
Page Views
org.icepdf.core.views.buffersize.

vertical
 
string
Sets the vertical ratio that the current viewport height will be multiplied by to create a screen buffer. The default value is 1.0. Using a larger ratio will increase the amount of memory needed by the page view.
No
org.icepdf.core.views.buffersize.

horizontal
 
string
Sets the horizontal ratio that the current viewport width will be multiplied by to create a screen buffer. The default value is 1.0. Using a larger ratio will increase the amount of memory needed by the page view.
No
org.icepdf.core.views.

refreshfrequency
 
integer
Specifies the interval between refreshes of the view buffer when content is being rendered. The default value is 250 milliseconds.
No
org.icepdf.core.annotations.

interactive.enabled
 
boolean
If true, link annotation actions can be activated using the system mouse. Default value is true.
No
org.icepdf.core.views.page.paper.

color
 
String
Default page paper color before PDF content is painted. Default color value is #FFFFFF.
No
org.icepdf.core.views.page.border.

color
 
String
Default page border color. Default color value is #000000.
No
org.icepdf.core.views.page.shadow.

color
 
String
Default page shadow color. Default color value is #333333.
No
org.icepdf.core.views.background.

color
 
String
Default color value is #808080.
No





Copyright 2005-2009. ICEsoft Technologies, Inc.
TOC PREV NEXT INDEX