Java Doc for PDAcroForm.java in  » PDF » PDFBox-0.7.3 » org » pdfbox » pdmodel » interactive » form » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » PDF » PDFBox 0.7.3 » org.pdfbox.pdmodel.interactive.form 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   org.pdfbox.pdmodel.interactive.form.PDAcroForm

PDAcroForm
public class PDAcroForm implements COSObjectable(Code)
This class represents the acroform of a PDF document.
author:
   Ben Litchfield
version:
   $Revision: 1.14 $



Constructor Summary
public  PDAcroForm(PDDocument doc)
     Constructor.
public  PDAcroForm(PDDocument doc, COSDictionary form)
     Constructor.

Method Summary
public  FDFDocumentexportFDF()
     This will export all FDF form data.
public  COSBasegetCOSObject()
    
public  PDResourcesgetDefaultResources()
     This will get the default resources for the acro form.
public  COSDictionarygetDictionary()
     This will get the dictionary that this form wraps.
public  PDDocumentgetDocument()
     This will get the document associated with this form.
public  PDFieldgetField(String name)
     This will get a field by name, possibly using the cache if setCache is true.
Parameters:
  name - The name of the field to get.
public  ListgetFields()
     This will return all of the fields in the document.
public  PDXFAgetXFA()
     Get the XFA resource, the XFA resource is only used for PDF 1.5+ forms.
public  voidimportFDF(FDFDocument fdf)
     This method will import an entire FDF document into the PDF document that this acroform is part of.
public  booleanisCachingFields()
     This will tell if this acro form is caching the fields.
public  voidsetCacheFields(boolean cache)
     This will tell this form to cache the fields into a Map structure for fast access via the getField method.
public  voidsetDefaultResources(PDResources dr)
     This will set the default resources for the acroform.
public  voidsetFields(List fields)
     Set the fields that are part of this AcroForm.
public  voidsetXFA(PDXFA xfa)
     Set the XFA resource, this is only used for PDF 1.5+ forms.


Constructor Detail
PDAcroForm
public PDAcroForm(PDDocument doc)(Code)
Constructor.
Parameters:
  doc - The document that this form is part of.



PDAcroForm
public PDAcroForm(PDDocument doc, COSDictionary form)(Code)
Constructor.
Parameters:
  doc - The document that this form is part of.
Parameters:
  form - The existing acroForm.




Method Detail
exportFDF
public FDFDocument exportFDF() throws IOException(Code)
This will export all FDF form data. An FDF document used to export the document.
throws:
  IOException - If there is an error when exporting the document.



getCOSObject
public COSBase getCOSObject()(Code)



getDefaultResources
public PDResources getDefaultResources()(Code)
This will get the default resources for the acro form. The default resources.



getDictionary
public COSDictionary getDictionary()(Code)
This will get the dictionary that this form wraps. The dictionary for this form.



getDocument
public PDDocument getDocument()(Code)
This will get the document associated with this form. The PDF document.



getField
public PDField getField(String name) throws IOException(Code)
This will get a field by name, possibly using the cache if setCache is true.
Parameters:
  name - The name of the field to get. The field with that name of null if one was not found.
throws:
  IOException - If there is an error getting the field type.



getFields
public List getFields() throws IOException(Code)
This will return all of the fields in the document. The type will be a org.pdfbox.pdmodel.field.PDField. A list of all the fields.
throws:
  IOException - If there is an error while getting the list of fields.



getXFA
public PDXFA getXFA()(Code)
Get the XFA resource, the XFA resource is only used for PDF 1.5+ forms. The xfa resource or null if it does not exist.



importFDF
public void importFDF(FDFDocument fdf) throws IOException(Code)
This method will import an entire FDF document into the PDF document that this acroform is part of.
Parameters:
  fdf - The FDF document to import.
throws:
  IOException - If there is an error doing the import.



isCachingFields
public boolean isCachingFields()(Code)
This will tell if this acro form is caching the fields. true if the fields are being cached.



setCacheFields
public void setCacheFields(boolean cache) throws IOException(Code)
This will tell this form to cache the fields into a Map structure for fast access via the getField method. The default is false. You would want this to be false if you were changing the COSDictionary behind the scenes, otherwise setting this to true is acceptable.
Parameters:
  cache - A boolean telling if we should cache the fields.
throws:
  IOException - If there is an error while caching the fields.



setDefaultResources
public void setDefaultResources(PDResources dr)(Code)
This will set the default resources for the acroform.
Parameters:
  dr - The new default resources.



setFields
public void setFields(List fields)(Code)
Set the fields that are part of this AcroForm.
Parameters:
  fields - The fields that are part of this form.



setXFA
public void setXFA(PDXFA xfa)(Code)
Set the XFA resource, this is only used for PDF 1.5+ forms.
Parameters:
  xfa - The xfa resource.



Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.