Java Doc for FDFDictionary.java in  » PDF » PDFBox-0.7.3 » org » pdfbox » pdmodel » fdf » 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.fdf 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   org.pdfbox.pdmodel.fdf.FDFDictionary

FDFDictionary
public class FDFDictionary implements COSObjectable(Code)
This represents an FDF dictionary that is part of the FDF document.
author:
   Ben Litchfield
version:
   $Revision: 1.8 $



Constructor Summary
public  FDFDictionary()
     Default constructor.
public  FDFDictionary(COSDictionary fdfDictionary)
     Constructor.
public  FDFDictionary(Element fdfXML)
     This will create an FDF dictionary from an XFDF XML document.

Method Summary
public  ListgetAnnotations()
     This will get the list of FDF Annotations.
public  COSDictionarygetCOSDictionary()
     Convert this standard java object to a COS object.
public  COSBasegetCOSObject()
     Convert this standard java object to a COS object.
public  COSStreamgetDifferences()
     This will get the incremental updates since the PDF was last opened.
public  ListgetEmbeddedFDFs()
     This will get the list of embedded FDF entries, or null if the entry is null.
public  StringgetEncoding()
     The encoding to be used for a FDF field.
public  ListgetFields()
     This will get the list of FDF Fields.
public  PDFileSpecificationgetFile()
     The source file or target file: the PDF document file that this FDF file was exported from or is intended to be imported into.
public  COSArraygetID()
     This is the FDF id.
public  FDFJavaScriptgetJavaScript()
     This will get the java script entry.
public  ListgetPages()
     This will get the list of FDF Pages.
public  StringgetStatus()
     This will get the status string to be displayed as the result of an action.
public  StringgetTarget()
     This will get the target frame in the browser to open this document.
public  voidsetAnnotations(List annots)
     This will set the list of annotations.
public  voidsetDifferences(COSStream diff)
     This will set the differences stream.
public  voidsetEmbeddedFDFs(List embedded)
     This will set the list of embedded FDFs.
public  voidsetEncoding(String encoding)
     This will set the encoding.
public  voidsetFields(List fields)
     This will set the list of fields.
public  voidsetFile(PDFileSpecification fs)
     This will set the file specification.
public  voidsetID(COSArray id)
     This will set the FDF id.
public  voidsetJavaScript(FDFJavaScript js)
     This will set the JavaScript entry.
public  voidsetPages(List pages)
     This will set the list of pages.
public  voidsetStatus(String status)
     This will set the status string.
public  voidsetTarget(String target)
     This will set the target frame in the browser to open this document.
public  voidwriteXML(Writer output)
     This will write this element as an XML document.


Constructor Detail
FDFDictionary
public FDFDictionary()(Code)
Default constructor.



FDFDictionary
public FDFDictionary(COSDictionary fdfDictionary)(Code)
Constructor.
Parameters:
  fdfDictionary - The FDF documents catalog.



FDFDictionary
public FDFDictionary(Element fdfXML) throws IOException(Code)
This will create an FDF dictionary from an XFDF XML document.
Parameters:
  fdfXML - The XML document that contains the XFDF data.
throws:
  IOException - If there is an error reading from the dom.




Method Detail
getAnnotations
public List getAnnotations()(Code)
This will get the list of FDF Annotations. This will return a list of FDFAnnotation objects or null if the entry is not set. A list of FDF annotations.



getCOSDictionary
public COSDictionary getCOSDictionary()(Code)
Convert this standard java object to a COS object. The cos object that matches this Java object.



getCOSObject
public COSBase getCOSObject()(Code)
Convert this standard java object to a COS object. The cos object that matches this Java object.



getDifferences
public COSStream getDifferences()(Code)
This will get the incremental updates since the PDF was last opened. The differences entry of the FDF dictionary.



getEmbeddedFDFs
public List getEmbeddedFDFs() throws IOException(Code)
This will get the list of embedded FDF entries, or null if the entry is null. This will return a list of PDFileSpecification objects. A list of embedded FDF files.
throws:
  IOException - If there is an error creating the file spec.



getEncoding
public String getEncoding()(Code)
The encoding to be used for a FDF field. The default is PDFDocEncoding and this method will never return null. The encoding value.



getFields
public List getFields()(Code)
This will get the list of FDF Fields. This will return a list of FDFField objects. A list of FDF fields.



getFile
public PDFileSpecification getFile() throws IOException(Code)
The source file or target file: the PDF document file that this FDF file was exported from or is intended to be imported into. The F entry of the FDF dictionary.
throws:
  IOException - If there is an error creating the file spec.



getID
public COSArray getID()(Code)
This is the FDF id. The FDF ID.



getJavaScript
public FDFJavaScript getJavaScript()(Code)
This will get the java script entry. The java script entry describing javascript commands.



getPages
public List getPages()(Code)
This will get the list of FDF Pages. This will return a list of FDFPage objects. A list of FDF pages.



getStatus
public String getStatus()(Code)
This will get the status string to be displayed as the result of an action. The status.



getTarget
public String getTarget()(Code)
This will get the target frame in the browser to open this document. The target frame.



setAnnotations
public void setAnnotations(List annots)(Code)
This will set the list of annotations. This should be a list of FDFAnnotation objects.
Parameters:
  annots - The list of annotations.



setDifferences
public void setDifferences(COSStream diff)(Code)
This will set the differences stream.
Parameters:
  diff - The new differences stream.



setEmbeddedFDFs
public void setEmbeddedFDFs(List embedded)(Code)
This will set the list of embedded FDFs. This should be a list of PDFileSpecification objects.
Parameters:
  embedded - The list of embedded FDFs.



setEncoding
public void setEncoding(String encoding)(Code)
This will set the encoding.
Parameters:
  encoding - The new encoding.



setFields
public void setFields(List fields)(Code)
This will set the list of fields. This should be a list of FDFField objects.
Parameters:
  fields - The list of fields.



setFile
public void setFile(PDFileSpecification fs)(Code)
This will set the file specification.
Parameters:
  fs - The file specification.



setID
public void setID(COSArray id)(Code)
This will set the FDF id.
Parameters:
  id - The new id for the FDF.



setJavaScript
public void setJavaScript(FDFJavaScript js)(Code)
This will set the JavaScript entry.
Parameters:
  js - The javascript entries.



setPages
public void setPages(List pages)(Code)
This will set the list of pages. This should be a list of FDFPage objects.
Parameters:
  pages - The list of pages.



setStatus
public void setStatus(String status)(Code)
This will set the status string.
Parameters:
  status - The new status string.



setTarget
public void setTarget(String target)(Code)
This will set the target frame in the browser to open this document.
Parameters:
  target - The new target frame.



writeXML
public void writeXML(Writer output) throws IOException(Code)
This will write this element as an XML document.
Parameters:
  output - The stream to write the xml to.
throws:
  IOException - If there is an error writing the XML.



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.