org.jpedal.objects.acroforms

Class AcroRenderer

java.lang.Object

org.jpedal.objects.acroforms.AcroRenderer

public class AcroRenderer
extends Object

Provides top level to forms handling, assisted by separate classes to decode widgets (FormDecoder - default implements Swing set) create Form widgets (implementation of FormFactory), store and render widgets (GUIData), handle Javascript and Actions (Javascript and ActionHandler) and support for Signature object

Field Summary

Fields

Modifier and Type	Field and Description
GUIData	compData holder for all data (implementations to support Swing and ULC)
FormFactory	formFactory creates all GUI components from raw data in PDF and stores in GUIData instance
static boolean	FROM_JPDF2FORMS

Constructor Summary

Constructors

Constructor and Description
AcroRenderer() used to create version without XFA support in XFA version.

Method Summary

Modifier and Type	Method and Description
boolean	alwaysuseXFA()
void	alwaysuseXFA(boolean alwaysUseXFA)
void	createDisplayComponentsForPage(int page, PdfStreamDecoder current) build forms display using standard swing components
BufferedImage	decode(PdfObject pdfObject, PdfObjectReader currentPdfFile, PdfObject XObject, int subtype, int width, int height, int offsetImage, float pageScaling)
void	displayComponentsOnscreen(int startPage, int endPage) display widgets on screen for range (inclusive)
void	dispose()
boolean	formsRasterizedForDisplay()
ActionHandler	getActionHandler()
PdfArrayIterator	getAnnotsOnPage(int page) Deprecated. - getFormComponents(String objectName, ReturnValues value,int pageNumber) recommended as much more flexible
GUIData	getCompData() get GUIData object with all widgets
Object[]	getFormComponents(String objectName, ReturnValues value, int pageNumber) If possible we recommend you work with the Form Objects rather than resolve GUI components
FormFactory	getFormFactory()
FormFlattener	getFormFlattener()
FormObject	getFormObject(String ref) get FormObject
Object[]	getFormResources()
HashMap	getPageMapXFA()
Enum<FormTypes>	getPDFformType() Allow user to get ENUM to show type of form FormTypes (XFA_LEGACY, XFA_DYNAMIC, NON_XFA)
Iterator<FormObject>	getSignatureObjects() return Signature as iterator with one or more objects or null
PdfStreamDecoder	getStreamDecoder(PdfObjectReader currentPdfFile, PdfLayerList layer, boolean isFirst)
PrintStreamDecoder	getStreamDecoderForPrinting(PdfObjectReader currentPdfFile, PdfLayerList pdfLayerList)
byte[]	getXMLContentAsBytes(int dataType)
boolean	hasFormsOnPage(int page)
boolean	ignoreForms()
void	init(SwingFormCreator formCreator)
static boolean	isAnnotation(FormObject formObject) Utility method to ensure formObject is actually an annotation before we continue
boolean	isXFA() returns false if not XFA (or XFA in Legacy mode) and true if XFA using XFA data
int	openFile(int pageCount, int insetW, int insetH, PdfPageData pageData, PdfObjectReader currentPdfFile, PdfObject acroObj) initialise holders and variables, data structures and get a handle on data object
void	outputJavascriptXFA(String path, String name)
void	removeDisplayComponentsFromScreen() make all components invisible on all pages by removing from Display
void	resetAnnotData(int insetW, int insetH, PdfPageData pageData, int page, PdfObjectReader currentPdfFile, byte[][] currentAnnotList) initialise holders and variables and get a handle on data object Complicated as Annotations stored on a PAGE basis whereas FORMS stored on a file basis
protected void	resetContainers(boolean resetToEmpty) flush or resize data containers
void	resetHandler(ActionHandler formsActionHandler, float dpi, Javascript javascript) reset handler (must be called Before page opened) - null Object resets to default
void	setFormFactory(FormFactory newFormFactory) setup object which creates all GUI objects
void	setIgnoreForms(boolean ignoreForms)
void	setInsets(int width, int height)
boolean	showFormWarningMessage(int page)
boolean	useXFA()
void	useXFAIfAvailable(boolean useXFA)

Methods inherited from class java.lang.Object

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

Field Detail

FROM_JPDF2FORMS

public static boolean FROM_JPDF2FORMS

formFactory

public FormFactory formFactory

creates all GUI components from raw data in PDF and stores in GUIData instance

compData

public GUIData compData

holder for all data (implementations to support Swing and ULC)

Constructor Detail

AcroRenderer

public AcroRenderer()

used to create version without XFA support in XFA version. Should not be used otherwise.

Method Detail

useXFAIfAvailable

public void useXFAIfAvailable(boolean useXFA)

resetHandler

public void resetHandler(ActionHandler formsActionHandler,
                         float dpi,
                         Javascript javascript)

reset handler (must be called Before page opened) - null Object resets to default

removeDisplayComponentsFromScreen

public void removeDisplayComponentsFromScreen()

make all components invisible on all pages by removing from Display

openFile

public int openFile(int pageCount,
                    int insetW,
                    int insetH,
                    PdfPageData pageData,
                    PdfObjectReader currentPdfFile,
                    PdfObject acroObj)

initialise holders and variables, data structures and get a handle on data object

resetAnnotData

public void resetAnnotData(int insetW,
                           int insetH,
                           PdfPageData pageData,
                           int page,
                           PdfObjectReader currentPdfFile,
                           byte[][] currentAnnotList)

initialise holders and variables and get a handle on data object
Complicated as Annotations stored on a PAGE basis whereas FORMS stored on a file basis

resetContainers

protected void resetContainers(boolean resetToEmpty)

flush or resize data containers

createDisplayComponentsForPage

public void createDisplayComponentsForPage(int page,
                                           PdfStreamDecoder current)

build forms display using standard swing components

isAnnotation

public static boolean isAnnotation(FormObject formObject)

Utility method to ensure formObject is actually an annotation before we continue

Returns:

True if annotation

displayComponentsOnscreen

public void displayComponentsOnscreen(int startPage,
                                      int endPage)

display widgets on screen for range (inclusive)

getFormComponents

public Object[] getFormComponents(String objectName,
                                  ReturnValues value,
                                  int pageNumber)

If possible we recommend you work with the Form Objects rather than resolve GUI components

null key will return all values

if pageNumber is -1 it will process whole document, otherwise just that page

For a full example of usage please see http://files.idrsolutions.com/samplecode/org/jpedal/examples/acroform/ExtractFormDataAsObject.java.html

Object[] will vary depending on what ReturnValues enum is passed in and could contain String (Names), FormObject or Component

setFormFactory

public void setFormFactory(FormFactory newFormFactory)

setup object which creates all GUI objects

getCompData

public GUIData getCompData()

get GUIData object with all widgets

getSignatureObjects

public Iterator<FormObject> getSignatureObjects()

return Signature as iterator with one or more objects or null

getActionHandler

public ActionHandler getActionHandler()

getFormFactory

public FormFactory getFormFactory()

setIgnoreForms

public void setIgnoreForms(boolean ignoreForms)

ignoreForms

public boolean ignoreForms()

dispose

public void dispose()

getAnnotsOnPage

@Deprecated
public PdfArrayIterator getAnnotsOnPage(int page)

Deprecated. - getFormComponents(String objectName, ReturnValues value,int pageNumber) recommended as much more flexible

get Iterator with list of all Annots on page or return null if no Annots - no longer needs call to decodePage beforehand as checks itself

isXFA

public boolean isXFA()

returns false if not XFA (or XFA in Legacy mode) and true if XFA using XFA data

Returns:

useXFA

public boolean useXFA()

hasFormsOnPage

public boolean hasFormsOnPage(int page)

getFormResources

public Object[] getFormResources()

formsRasterizedForDisplay

public boolean formsRasterizedForDisplay()

getFormObject

public FormObject getFormObject(String ref)

get FormObject

Parameters:

ref -

Returns:

In all modes except HTML,SVG,JavaFX will decode other forms on pages if not found

setInsets

public void setInsets(int width,
                      int height)

getPDFformType

public Enum<FormTypes> getPDFformType()

Allow user to get ENUM to show type of form FormTypes (XFA_LEGACY, XFA_DYNAMIC, NON_XFA)

Returns:

alwaysuseXFA

public void alwaysuseXFA(boolean alwaysUseXFA)

alwaysuseXFA

public boolean alwaysuseXFA()

init

public void init(SwingFormCreator formCreator)

getStreamDecoder

public PdfStreamDecoder getStreamDecoder(PdfObjectReader currentPdfFile,
                                         PdfLayerList layer,
                                         boolean isFirst)

showFormWarningMessage

public boolean showFormWarningMessage(int page)

getPageMapXFA

public HashMap getPageMapXFA()

getXMLContentAsBytes

public byte[] getXMLContentAsBytes(int dataType)

outputJavascriptXFA

public void outputJavascriptXFA(String path,
                                String name)

getStreamDecoderForPrinting

public PrintStreamDecoder getStreamDecoderForPrinting(PdfObjectReader currentPdfFile,
                                                      PdfLayerList pdfLayerList)

decode

public BufferedImage decode(PdfObject pdfObject,
                            PdfObjectReader currentPdfFile,
                            PdfObject XObject,
                            int subtype,
                            int width,
                            int height,
                            int offsetImage,
                            float pageScaling)

getFormFlattener

public FormFlattener getFormFlattener()