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.imageReference", "scaled");

On the command line, the syntax is as follows:

java -Dorg.icepdf.core.imageReference=scaled ...

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

No - has no effect at runtime
Yes - always has effect at runtime
new <*class>* - a new instance of the class must be created to see the effect at runtime
N/A - not applicable

Property	Type	Description	Dynamic
Annotations
org.icepdf.core.views.page.annotation.textmarkup.highlight.color	string	Specifies the default color used to create a new highlight annotation. Default value is #ffff00.	No
org.icepdf.core.views.page.annotation.strikeOut.highlight.color	string	Specifies the default color used to create a new strike out annotation. Default value is #ff0000.	No
org.icepdf.core.views.page.annotation.strikeOut.underline.color	string	Specifies the default color used to create a new underline annotation. Default value is #00ff00.	No
org.icepdf.core.views.page.annotation.ink.line.color	string	Specifies the default color used to create a new ink annotation via the LinkAnnotationHandler. Default value is #00ff00.	No
org.icepdf.core.views.page.annotation.line.stroke.color	string	Specifies the default stroke color used to create a new line annotation via the LineAnnotationHandler and LineArrowAnnotationHandler. Default value is #ff0000.	No
org.icepdf.core.views.page.annotation.line.fill.color	string	Specifies the default fill color used to create a new square or circle annotation via the SquareAnnotationHandler and CircleArrowAnnotationHandler. Default value is #ffffff.	No
org.icepdf.core.views.page.annotation.squareCircle.fill.color	string	Specifies the default fill color used to create a new square or circle annotation via the SquareAnnotationHandler and CircleArrowAnnotationHandler. Default value is #000000.	No
org.icepdf.core.views.page.annotation.squareCircle.stroke.color	string	Specifies the default stroke color used to create a new square or circle annotation via the SquareAnnotationHandler and CircleArrowAnnotationHandler. Default value is #ff0000.	No
org.icepdf.core.views.page.annotation.text.fill.color	string	Specifies the default fill color used to create a new text annotation. Default value is #ffff00.	No
org.icepdf.core.views.page.annotation.freeText.font.color	string	Specifies the default font colour used to create a new free text annotation. Default value is #000000.	No
org.icepdf.core.views.page.annotation.freeText.fill.color	string	Specifies the default fillcolor used to create a new free text annotation. Default value is #ffffff.	No
org.icepdf.core.views.page.annotation.freeText.font.size	int	Specifies the default font size in points used to create a new free text annotation font. Default value is 24	No
org.icepdf.core.views.page.annotation.outline.color	string	Specifies the default color used to draw annotations with invisible borders. Default value is #CCCCCC.	No
org.icepdf.core.views.page.annotation.outlineResize.color	string	Specifies the default color used when drawing the resize squares on an annotation's border. Default value is #ffffff.	No
Encryption
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
Font Engine
org.icepdf.core.nfont.truetype.hinting	boolean	If true, font hinting is enabled and the font engine will execute hinting instructions for set of know font names. The default value is false.	No
org.icepdf.core.nfont.truetype.hinting.alwayson	boolean	If true, font hinting is enabled for all fonts without exclusion. The property overrides org.icepdf.core.nfont.truetype.hinting, default value is false.	No
org.icepdf.core.nfont.truetype.hintingNames	String	List of font names delimited by spaces which will be appended to the existing list of fonts to hint. No default value.	No
org.icepdf.core.nfont.truetype.hintingNames	String	List of font names delimited by spaces which will be appended to the existing list of fonts to hint. No default value.	No
org.icepdf.core.nfont.truetype.eraseHintingDefaults	String	Clears the list of know font names to hint. No default value.	No
Imaging
org.icepdf.core.imageReference	String	Sets the default image reference type. Possible values are; 'default', 'scaled' and 'mipmap'. Default value is 'default'. For more information on property values click here.	No
org.icepdf.core.ccittfax.jai	boolean	If true, JAI will be used to decode CCITTFAX images. Otherwise ICEpdf code will be used to decode CCITTFAX images. Default value is false.	No
org.icepdf.core.imageProxy	boolean	If true, image will be loaded on as separate thread when the page is initialized. If false the prox will be disabled and images will be loaded on the same thread doing the page parse. Default value is true.	No
Page View Buffer
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.views.dirtytimer.interval	integer	Specifies the interval in which a test for a dirty buffer will be executed and consequently when a repaint will occur. The default value is 5 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
Page Decorator
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
org.icepdf.core.views.page.proxy	boolean	If true the page view component will load and paint the page content using two different theads. If false the page is loaded on the AWT thread. Default value true.	No
Text extraction
org.icepdf.core.views.page.text.spaceFraction	integer	Sets the heuristic used to detect if a space should be inserted between two characters. The value is converted to 1/spaceFraction and is multiplied by the average character width. higher values will insert more space and lower values less space. Default value is 3.	No
Text selection
org.icepdf.core.views.page.text.selectionColor	string	Sets the color used for text selection painting. Default color value is #0077FF.	No
org.icepdf.core.views.page.text.highlightColor	string	Sets the color used for search highlight painting. Default color value is #FFF600.	No
Threading
org.icepdf.core.library.threadPoolSize	integer	Sets the max number of threads that ICEpdf can use for its common thread pool executor. The common thread pool is used to initial Page content in the Viewer RI. Default value is 3.	No
org.icepdf.core.library.painterThreadPoolSize	integer	Sets the max number of threads that ICEpdf can use when painting pages in the Viewer RI PageViewComponentImpl. Default value is 1.	No
org.icepdf.core.library.imageThreadPoolSize	integer	Sets the max number of threads that ICEpdf can use when proxying image loading work during page parsing. Default value is 5.	No

Note: For the Rendering Quality properties below, 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().

Property	Type	Description	Dynamic
Rendering Quality
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.paint.disableAlpha	boolean	If true, all alpha or transparency painting will be suspended. This property can be enabled when printing with in the intension of reducing the spool size.	Yes
org.icepdf.core.paint.disableClipping	boolean	If true, all clipping will be suspended. This property should only be used if content is missing from printed output. This property can be turned on for printing and turned off once the print job has finished.	Yes
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

System Properties

Labels