com.realobjects.pdfreactor

Class Configuration.JavaScriptSettings

java.lang.Object

com.realobjects.pdfreactor.Configuration.JavaScriptSettings

Enclosing class:

Configuration

public static class Configuration.JavaScriptSettings
extends Object

A type containing settings related to JavaScript.

Constructor Summary

Constructors

Constructor and Description
JavaScriptSettings()

Method Summary

Modifier and Type	Method and Description
Configuration.JavaScriptSettings	setDebugIndentation(Integer debugIndentation) Specifies the amount of spaces per indentation level when using JavaScript debugging.
Configuration.JavaScriptSettings	setDebugMode(Configuration.JavaScriptDebugMode debugMode) Specifies the debug mode.
Configuration.JavaScriptSettings	setEnabled(Boolean enabled) Specifies whether to process JavaScript.
Configuration.JavaScriptSettings	setIgnoreScriptElements(Boolean ignoreScriptElements) Specifies whether to ignore <script> elements in the document, only executing user scripts.
Configuration.JavaScriptSettings	setMaxQueuedTasks(Integer maxQueuedTasks) Specifies the maximum amount of tasks to be queued before ending JavaScript processing.
Configuration.JavaScriptSettings	setMaxScriptElements(Integer maxScriptElements) Specifies the maximum amount of script elements in the document to process.
Configuration.JavaScriptSettings	setMaxTasksWithoutDomChange(Integer maxTasksWithoutDomChange) Specifies the maximum amount of tasks to be allowed to be queued, while the DOM does not change, before ending JavaScript processing.
Configuration.JavaScriptSettings	setMaxVirtualTimeOffset(Integer maxVirtualTimeOffset) Specifies the maximum amount of virtual time in seconds to let pass before ending JavaScript processing.
Configuration.JavaScriptSettings	setNoLayout(Boolean noLayout) Specifies whether to process JavaScript without causing document layouts or updates.
Configuration.JavaScriptSettings	setNoVirtualTime(Boolean noVirtualTime) Specifies whether not to use virtual time for JavaScript.
Configuration.JavaScriptSettings	setTimeLapse(Boolean timeLapse) Specifies whether to fast-forward the virtual time of JavaScript every time it is retrieved.
Configuration.JavaScriptSettings	setTimeout(Integer value) Sets a timeout in seconds for JavaScript processing If the timeout is exceeded, the conversion will be aborted.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JavaScriptSettings

public JavaScriptSettings()

Method Detail

setEnabled

public Configuration.JavaScriptSettings setEnabled(Boolean enabled)

Specifies whether to process JavaScript.

setIgnoreScriptElements

public Configuration.JavaScriptSettings setIgnoreScriptElements(Boolean ignoreScriptElements)

Specifies whether to ignore <script> elements in the document, only executing user scripts.

setNoLayout

public Configuration.JavaScriptSettings setNoLayout(Boolean noLayout)

Specifies whether to process JavaScript without causing document layouts or updates.

This can speed up conversions, but will break a significant amount of functionality and libraries.

setTimeLapse

public Configuration.JavaScriptSettings setTimeLapse(Boolean timeLapse)

Specifies whether to fast-forward the virtual time of JavaScript every time it is retrieved.

Only use if required for a specific library.

setNoVirtualTime

public Configuration.JavaScriptSettings setNoVirtualTime(Boolean noVirtualTime)

Specifies whether not to use virtual time for JavaScript.

Only use if required for a specific library.

setMaxVirtualTimeOffset

public Configuration.JavaScriptSettings setMaxVirtualTimeOffset(Integer maxVirtualTimeOffset)

Specifies the maximum amount of virtual time in seconds to let pass before ending JavaScript processing.

Values smaller than 1 default to 3600 (1h).

setMaxQueuedTasks

public Configuration.JavaScriptSettings setMaxQueuedTasks(Integer maxQueuedTasks)

Specifies the maximum amount of tasks to be queued before ending JavaScript processing.

Values smaller than 1 default to 1,000,000.

setMaxTasksWithoutDomChange

public Configuration.JavaScriptSettings setMaxTasksWithoutDomChange(Integer maxTasksWithoutDomChange)

Specifies the maximum amount of tasks to be allowed to be queued, while the DOM does not change, before ending JavaScript processing.

Values smaller than 1 default to 1,000.

setMaxScriptElements

public Configuration.JavaScriptSettings setMaxScriptElements(Integer maxScriptElements)

Specifies the maximum amount of script elements in the document to process.

Values smaller than 1 default to 1,000,000.

setDebugIndentation

public Configuration.JavaScriptSettings setDebugIndentation(Integer debugIndentation)

Specifies the amount of spaces per indentation level when using JavaScript debugging.

The default value is 0.

setDebugMode

public Configuration.JavaScriptSettings setDebugMode(Configuration.JavaScriptDebugMode debugMode)

Specifies the debug mode.

Any other value than the default Configuration.JavaScriptDebugMode.NONE impacts performance significantly and should not be used in production.

setTimeout

public Configuration.JavaScriptSettings setTimeout(Integer value)

Sets a timeout in seconds for JavaScript processing If the timeout is exceeded, the conversion will be aborted.

A timeout of 0 or negative values mean that the conversion will never time out. This is also the default behavior if no timeout is specified.