Skip navigation links

oracle.xdo.template.pdf.js
Class JavascriptEditor

java.lang.Object
oracle.xdo.template.pdf.js.JavascriptEditor

public class JavascriptEditor

extends java.lang.Object

JavascriptEditor reads a pdf file and embeds Javascript into the output. Javascript can be embedded at two levels: at the global document level and at the form field widget level. Any javascript embedded at the document level will be executed once the document is open. Javascript embedded at the form field level can be executed whenever certain form field events occur (such as mouse and keystroke ui events).

Use JavascriptEditor.getDocumentLevelJavascripts() to get a hashtable mapping of global document level script names to the actual script content.

Use JavascriptEditor.putDocumentJavascript(scriptName, script) to replace or add scripts at the document level.

Use JavascriptEditor.putJavascript(fieldName, eventType, script) to replace or add scripts for a particular form field and event.

Important: Make sure you escape your javascript code with PDFString.escape().

Please see PDFReference manual for more info on embedding javascript inside PDF files.

Author:

Mark Lin

Field Summary

static java.lang.String	DOCUMENT_AFTER_PRINT
static java.lang.String	DOCUMENT_AFTER_SAVE
static java.lang.String	DOCUMENT_BEFORE_CLOSE
static java.lang.String	DOCUMENT_BEFORE_SAVE
static java.lang.String	DOCUMENT_WILL_PRINT
static java.lang.String	EVENT_BLUR
static java.lang.String	EVENT_CALCULATE
static java.lang.String	EVENT_FOCUS
static java.lang.String	EVENT_FORMAT
static java.lang.String	EVENT_KEY_PRESSED
static java.lang.String	EVENT_MOUSE_DOWN
static java.lang.String	EVENT_MOUSE_ENTER For a more detailed summary of these events, please see PDF Reference manual: page 594 (version 1.5) or page 611 (version 1.6)
static java.lang.String	EVENT_MOUSE_EXIT
static java.lang.String	EVENT_MOUSE_UP
static java.lang.String	EVENT_PAGE_CLOSE
static java.lang.String	EVENT_PAGE_INVISIBLE
static java.lang.String	EVENT_PAGE_OPEN
static java.lang.String	EVENT_PAGE_VISIBLE
static java.lang.String	EVENT_VALIDATE
static java.lang.String	RCS_ID

Constructor Summary

JavascriptEditor(PDFParser pdfParser)
The constructor for this class

Method Summary

boolean	generatePDF(java.io.OutputStream outputStream) Generates the output PDF file
boolean	generatePDF(java.lang.String newPdfPath) Generates the output PDF File
java.lang.String	getDocumentLevelJavascript(java.lang.String jsName) Gets document level javascript for a praticular script name
java.util.Hashtable	getDocumentLevelJavascripts() Returns a hashtable mapping of script names to actual script
static void	main(java.lang.String[] args)
void	putDocumentActionJavascript(java.lang.String action, java.lang.String javascript)
void	putDocumentJavascript(java.lang.String jsName, java.lang.String javascript) Adds or replaces a script name with some script content at the document level
void	putJavascript(java.lang.String fieldName, java.lang.String action, java.lang.String javascript) Adds or replaces a script which gets run for a form field when a particular event happens

Methods inherited from class java.lang.Object

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

Field Detail

RCS_ID

public static final java.lang.String RCS_ID

See Also:

Constant Field Values

EVENT_MOUSE_ENTER

public static final java.lang.String EVENT_MOUSE_ENTER

For a more detailed summary of these events, please see PDF Reference manual: page 594 (version 1.5) or page 611 (version 1.6)

See Also:

Constant Field Values

EVENT_MOUSE_EXIT

public static final java.lang.String EVENT_MOUSE_EXIT

See Also:

Constant Field Values

EVENT_MOUSE_DOWN

public static final java.lang.String EVENT_MOUSE_DOWN

See Also:

Constant Field Values

EVENT_MOUSE_UP

public static final java.lang.String EVENT_MOUSE_UP

See Also:

Constant Field Values

EVENT_FOCUS

public static final java.lang.String EVENT_FOCUS

See Also:

Constant Field Values

EVENT_BLUR

public static final java.lang.String EVENT_BLUR

See Also:

Constant Field Values

EVENT_PAGE_OPEN

public static final java.lang.String EVENT_PAGE_OPEN

See Also:

Constant Field Values

EVENT_PAGE_CLOSE

public static final java.lang.String EVENT_PAGE_CLOSE

See Also:

Constant Field Values

EVENT_PAGE_VISIBLE

public static final java.lang.String EVENT_PAGE_VISIBLE

See Also:

Constant Field Values

EVENT_PAGE_INVISIBLE

public static final java.lang.String EVENT_PAGE_INVISIBLE

See Also:

Constant Field Values

EVENT_KEY_PRESSED

public static final java.lang.String EVENT_KEY_PRESSED

See Also:

Constant Field Values

EVENT_FORMAT

public static final java.lang.String EVENT_FORMAT

See Also:

Constant Field Values

EVENT_VALIDATE

public static final java.lang.String EVENT_VALIDATE

See Also:

Constant Field Values

EVENT_CALCULATE

public static final java.lang.String EVENT_CALCULATE

See Also:

Constant Field Values

DOCUMENT_BEFORE_CLOSE

public static final java.lang.String DOCUMENT_BEFORE_CLOSE

See Also:

Constant Field Values

DOCUMENT_BEFORE_SAVE

public static final java.lang.String DOCUMENT_BEFORE_SAVE

See Also:

Constant Field Values

DOCUMENT_AFTER_SAVE

public static final java.lang.String DOCUMENT_AFTER_SAVE

See Also:

Constant Field Values

DOCUMENT_WILL_PRINT

public static final java.lang.String DOCUMENT_WILL_PRINT

See Also:

Constant Field Values

DOCUMENT_AFTER_PRINT

public static final java.lang.String DOCUMENT_AFTER_PRINT

See Also:

Constant Field Values

Constructor Detail

JavascriptEditor

public JavascriptEditor(PDFParser pdfParser)

The constructor for this class

Parameters:

pdfParser - A PDFParser instance should be passed in as input

Method Detail

putDocumentActionJavascript

public void putDocumentActionJavascript(java.lang.String action,
                                        java.lang.String javascript)
                                 throws java.lang.Exception

Throws:

java.lang.Exception

putJavascript

public void putJavascript(java.lang.String fieldName,
                          java.lang.String action,
                          java.lang.String javascript)
                   throws java.lang.Exception

Adds or replaces a script which gets run for a form field when a particular event happens

Parameters:

fieldName - The name of the form field

action - The event trigger

javascript - The script content itself

Throws:

java.lang.Exception - A FatalException is thrown if the fieldName is not found or if the PDF file structure is invalid

putDocumentJavascript

public void putDocumentJavascript(java.lang.String jsName,
                                  java.lang.String javascript)

Adds or replaces a script name with some script content at the document level

Parameters:

jsName - The name of the script

javascript - The script content

getDocumentLevelJavascripts

public java.util.Hashtable getDocumentLevelJavascripts()

Returns a hashtable mapping of script names to actual script

Returns:

The hashtable mapping of document level javascripts

getDocumentLevelJavascript

public java.lang.String getDocumentLevelJavascript(java.lang.String jsName)

Gets document level javascript for a praticular script name

Parameters:

jsName - The name of the script

Returns:

generatePDF

public boolean generatePDF(java.io.OutputStream outputStream)

Generates the output PDF file

Parameters:

outputStream - The output stream to stream the pdf to

Returns:

generatePDF

public boolean generatePDF(java.lang.String newPdfPath)

Generates the output PDF File

Parameters:

newPdfPath - The file path to generate the new pdf file to

Returns:

main

public static void main(java.lang.String[] args)

Skip navigation links