com.qoppa.pdf

Class JavaScriptSettings

java.lang.Object

com.qoppa.pdf.JavaScriptSettings

public final class JavaScriptSettings
extends Object

This class contains settings for running JavaScript. It has options to enable / disable JavaScript as well as to enable JavaScript popups and to enable error reporting. The settings are as follows

JSEnabler - This object is called back when a document is loaded to determine if JavaScript will be enabled. The default is to have this field null, which implies that JavaScript is disabled. There is a simple implementation class provided to enable / disable JavaScript: JavaScriptEnabler.
AllowPopups - This flag determines if JavaScript alerts will pop up in a message box or be printed to the console. Note that since some alerts require user input, an Exception will be thrown if this flag is set to false when an alert contains more than one option. Default is false.
SilenceErrors - This flag determines if formatting errors generated from predefined formats will pop up in a message box or if the system will beep. The default setting of true means the system will beep instead of popping up a message box.

Author:

Qoppa Software

Method Summary

Modifier and Type	Method and Description
static IdentityProperties	getIdentityProperties() Returns a static object that identifies the current user of the application.
static IJavaScriptEnabler	getJSEnabler() Get the JavaScriptEnabler.
static boolean	isAllowPopups() Returns true if popups are allowed.
static boolean	isMailDocWarn() Returns true if the user will have the option to proceed with emailing the document when mailDoc() is called.
static boolean	isSilenceErrors() Returns true if errors will be silenced instead of displaying an alert.
static boolean	isSubmitFormWarn() Returns true if the user will have the option to proceed with connecting to a URL and submitting the form when submitForm() is called.
static void	setAllowPopups(boolean allowPopups) Set to true to allow pop ups for alerts.
static void	setIdentityProperties(IdentityProperties identity) Sets a static object that identifies the current user of the application.
static void	setJSEnabler(IJavaScriptEnabler enabler) Set the JavaScriptEnabler.
static void	setMailDocWarn(boolean mailDocWarn) Set to true to warn/ask the user before emailing the document when mailDoc() is called.
static void	setSilenceErrors(boolean silenceErrors) Set to true to silence errors.
static void	setSubmitFormWarn(boolean submitFormWarn) Set to true to warn/ask the user before connecting to a URL and submitting the form when submitForm() is called.
static boolean	shouldEnableJS(IPDFDocument doc) Returns true if JavaScript should be enabled for the document.

Methods inherited from class java.lang.Object

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

Method Detail

shouldEnableJS

public static boolean shouldEnableJS(IPDFDocument doc)

Returns true if JavaScript should be enabled for the document. This is a convenience method, it passes the call on to the registered JavaScriptEnabler object. If there is no JavaScriptEnabler (it is null), then this method return false, disabling JavaScript.

Parameters:

doc - The PDF document that is being loaded. This is passed on to the IJavaScriptEnabler implementation.

setJSEnabler

public static void setJSEnabler(IJavaScriptEnabler enabler)

Set the JavaScriptEnabler. If this is set to null, shouldEnableJS() will always return false, thereby disabling JavaScript. A default implementation of this interface is provided in the JavaScriptEnabler class, that takes true or false in its constructor. A host application can also create a custom implementation that uses other criteria to determine whether to enable JavaScript.

Parameters:

enabler - The implementation of JavaScriptEnabler.

getJSEnabler

public static IJavaScriptEnabler getJSEnabler()

Get the JavaScriptEnabler.

isAllowPopups

public static boolean isAllowPopups()

Returns true if popups are allowed. Otherwise alerts will be printed to standard out. Note that since some alerts require user input, an Exception will be thrown if this flag is set to false when an alert contains more than one option.

Returns:

True if popups are allowed. False otherwise.

setAllowPopups

public static void setAllowPopups(boolean allowPopups)

Set to true to allow pop ups for alerts. If set to false, alerts will be printed to standard out.

Parameters:

allowPopups - Set to true to allow pop ups for alerts. Set to false to print alerts to standard out.

isSilenceErrors

public static boolean isSilenceErrors()

Returns true if errors will be silenced instead of displaying an alert.

Returns:

True if errors will be silenced, false otherwise.

setSilenceErrors

public static void setSilenceErrors(boolean silenceErrors)

Set to true to silence errors. If set to false, errors will display in an alert.

Parameters:

silenceErrors - Set to true to silence errors. Set to false to display errors in an alert.

setIdentityProperties

public static void setIdentityProperties(IdentityProperties identity)

Sets a static object that identifies the current user of the application.

getIdentityProperties

public static IdentityProperties getIdentityProperties()

Returns a static object that identifies the current user of the application.

isSubmitFormWarn

public static boolean isSubmitFormWarn()

Returns true if the user will have the option to proceed with connecting to a URL and submitting the form when submitForm() is called.

Returns:

True if the user will have the option to proceed with submitting the form.

setSubmitFormWarn

public static void setSubmitFormWarn(boolean submitFormWarn)

Set to true to warn/ask the user before connecting to a URL and submitting the form when submitForm() is called.

Parameters:

submitFormWarn - Set to true to warn/ask the user before connecting to a URL.

isMailDocWarn

public static boolean isMailDocWarn()

Returns true if the user will have the option to proceed with emailing the document when mailDoc() is called.

Returns:

True if the user will have the option to proceed with emailing the document.

setMailDocWarn

public static void setMailDocWarn(boolean mailDocWarn)

Set to true to warn/ask the user before emailing the document when mailDoc() is called.

Parameters:

mailDocWarn - Set to true to warn/ask the user before emailing the document.