Top Description Fields Constructors Methods
org.apache.pdfbox.pdmodel.fdf

public Class FDFJavaScript

extends Object
implements COSObjectable
Class Inheritance
All Implemented Interfaces
org.apache.pdfbox.pdmodel.common.COSObjectable
Imports
java.util.LinkedHashMap, .Map, org.apache.pdfbox.cos.COSArray, .COSBase, .COSDictionary, .COSName, .COSStream, .COSString, org.apache.pdfbox.pdmodel.common.COSObjectable, org.apache.pdfbox.pdmodel.interactive.action.PDAction, .PDActionFactory, .PDActionJavaScript
This represents an FDF JavaScript dictionary that is part of the FDF document.
Author
Ben Litchfield

Field Summary

Modifier and TypeField and Description
private final COSDictionary
dictionary

Constructor Summary

AccessConstructor and Description
public
FDFJavaScript()

Default constructor.

public
FDFJavaScript(COSDictionary
The FDF java script.
javaScript)

Constructor.

Method Summary

Modifier and TypeMethod and Description
public String

Returns:

Some javascript code.
getAfter()

This will get the javascript that is executed after the import.

public String

Returns:

Some javascript code.
getBefore()

This will get the javascript that is executed before the import.

public COSDictionary

Returns:

The cos object that matches this Java object.
getCOSObject()

Implements org.apache.pdfbox.pdmodel.common.COSObjectable.getCOSObject.

Convert this standard java object to a COS object.

public Map<String, PDActionJavaScript>

Returns:

Map of named "JavaScript" dictionaries.
getDoc()

Returns the dictionary's "Doc" entry, that is, a map of key value pairs to be added to the document's JavaScript name tree.

public void
setAfter(String
A reference to some javascript code.
after)

This will set the javascript code the will get execute after the import.

public void
setBefore(String
A reference to some javascript code.
before)

This will set the javascript code the will get execute before the import.

public void
setDoc(Map<String, PDActionJavaScript>
Map of named "JavaScript" dictionaries.
map)

Sets the dictionary's "Doc" entry.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

dictionaryback to summary
private final COSDictionary dictionary

Constructor Detail

FDFJavaScriptback to summary
public FDFJavaScript()

Default constructor.

FDFJavaScriptback to summary
public FDFJavaScript(COSDictionary javaScript)

Constructor.

Parameters
javaScript:COSDictionary

The FDF java script.

Method Detail

getAfterback to summary
public String getAfter()

This will get the javascript that is executed after the import.

Returns:String

Some javascript code.

getBeforeback to summary
public String getBefore()

This will get the javascript that is executed before the import.

Returns:String

Some javascript code.

getCOSObjectback to summary
public COSDictionary getCOSObject()

Implements org.apache.pdfbox.pdmodel.common.COSObjectable.getCOSObject.

Convert this standard java object to a COS object.

Returns:COSDictionary

The cos object that matches this Java object.

Annotations
@Override
getDocback to summary
public Map<String, PDActionJavaScript> getDoc()

Returns the dictionary's "Doc" entry, that is, a map of key value pairs to be added to the document's JavaScript name tree.

Returns:Map<String, PDActionJavaScript>

Map of named "JavaScript" dictionaries.

setAfterback to summary
public void setAfter(String after)

This will set the javascript code the will get execute after the import.

Parameters
after:String

A reference to some javascript code.

setBeforeback to summary
public void setBefore(String before)

This will set the javascript code the will get execute before the import.

Parameters
before:String

A reference to some javascript code.

setDocback to summary
public void setDoc(Map<String, PDActionJavaScript> map)

Sets the dictionary's "Doc" entry.

Parameters
map:Map<String, PDActionJavaScript>

Map of named "JavaScript" dictionaries.