Java Doc for FDFField.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.FDFField FDFField public class FDFField implements COSObjectable(Code) This represents an FDF field that is part of the FDF document. author:    Ben Litchfield version:    $Revision: 1.5 $ Constructor Summary public   FDFField()      Default constructor. public   FDFField(COSDictionary f)      Constructor. public   FDFField(Element fieldXML)      This will create an FDF field from an XFDF XML document. Method Summary public  PDAction getAction()      This will get the action that is associated with this field. public  PDAdditionalActions getAdditionalActions()      This will get a list of additional actions that will get executed based on events. public  PDAppearanceDictionary getAppearanceDictionary()      This will get the appearance dictionary that specifies the appearance of a pushbutton field. public  FDFNamedPageReference getAppearanceStreamReference()      This will get named page references.. public  COSDictionary getCOSDictionary()      Convert this standard java object to a COS object. public  COSBase getCOSObject()      Convert this standard java object to a COS object. public  Integer getClearFieldFlags()      This will get the ClrFf entry of the cos dictionary. public  Integer getClearWidgetFieldFlags()      This will get the ClrF entry of the cos dictionary. public  Integer getFieldFlags()      This will get the Ff entry of the cos dictionary. public  FDFIconFit getIconFit()      This will get the icon fit that is associated with this field. public  List getKids()      This will get the list of kids. public  List getOptions()      This will return a list of options for a choice field. public  String getPartialFieldName()      This will get the "T" entry in the field dictionary. public  PDTextStream getRichText()      This will set the rich text that is associated with this field. public  Integer getSetFieldFlags()      This will get the SetFf entry of the cos dictionary. public  Integer getSetWidgetFieldFlags()      This will get the SetF entry of the cos dictionary. public  Object getValue()      This will set the value for the field. public  Integer getWidgetFieldFlags()      This will get the F entry of the cos dictionary. public  void setAction(PDAction a)      This will set the action that is associated with this field. public  void setAdditionalActions(PDAdditionalActions aa)      This will set the additional actions that are associated with this field. public  void setAppearanceDictionary(PDAppearanceDictionary ap)      This will set the appearance dictionary. public  void setAppearanceStreamReference(FDFNamedPageReference ref)      This will set the named page references. public  void setClearFieldFlags(Integer ff)      This will get the field flags that are associated with this field. public  void setClearFieldFlags(int ff)      This will get the field flags that are associated with this field. public  void setClearWidgetFieldFlags(Integer ff)      This will get the field flags that are associated with this field. public  void setClearWidgetFieldFlags(int ff)      This will get the field flags that are associated with this field. public  void setFieldFlags(Integer ff)      This will get the field flags that are associated with this field. public  void setFieldFlags(int ff)      This will get the field flags that are associated with this field. public  void setIconFit(FDFIconFit fit)      This will set the icon fit entry. public  void setKids(List kids)      This will set the list of kids. public  void setOptions(List options)      This will set the options for the choice field. public  void setPartialFieldName(String partial)      This will set the partial field name. public  void setRichText(PDTextStream rv)      This will set the rich text value. public  void setSetFieldFlags(Integer ff)      This will get the field flags that are associated with this field. public  void setSetFieldFlags(int ff)      This will get the field flags that are associated with this field. public  void setSetWidgetFieldFlags(Integer ff)      This will get the widget field flags that are associated with this field. public  void setSetWidgetFieldFlags(int ff)      This will get the widget field flags that are associated with this field. public  void setValue(Object value)      You should pass in a string, or a java.util.List of strings to set the value. public  void setWidgetFieldFlags(Integer f)      This will get the widget field flags that are associated with this field. public  void setWidgetFieldFlags(int f)      This will get the field flags that are associated with this field. public  void writeXML(Writer output)      This will write this element as an XML document. Constructor Detail FDFField public FDFField()(Code) Default constructor. FDFField public FDFField(COSDictionary f)(Code) Constructor. Parameters:   f - The FDF field. FDFField public FDFField(Element fieldXML) throws IOException(Code) This will create an FDF field from an XFDF XML document. Parameters:   fieldXML - The XML document that contains the XFDF data. throws:   IOException - If there is an error reading from the dom. Method Detail getAction public PDAction getAction()(Code) This will get the action that is associated with this field. The A entry in the field dictionary. getAdditionalActions public PDAdditionalActions getAdditionalActions()(Code) This will get a list of additional actions that will get executed based on events. The AA entry in this field dictionary. getAppearanceDictionary public PDAppearanceDictionary getAppearanceDictionary()(Code) This will get the appearance dictionary that specifies the appearance of a pushbutton field. The AP entry of this dictionary. getAppearanceStreamReference public FDFNamedPageReference getAppearanceStreamReference()(Code) This will get named page references.. The named page references. 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. getClearFieldFlags public Integer getClearFieldFlags()(Code) This will get the ClrFf entry of the cos dictionary. If it it not present then this method will return null. The field flags. getClearWidgetFieldFlags public Integer getClearWidgetFieldFlags()(Code) This will get the ClrF entry of the cos dictionary. If it it not present then this method will return null. The widget field flags. getFieldFlags public Integer getFieldFlags()(Code) This will get the Ff entry of the cos dictionary. If it it not present then this method will return null. The field flags. getIconFit public FDFIconFit getIconFit()(Code) This will get the icon fit that is associated with this field. The IF entry. getKids public List getKids()(Code) This will get the list of kids. This will return a list of FDFField objects. This will return null if the underlying list is null. The list of kids. getOptions public List getOptions()(Code) This will return a list of options for a choice field. The value in the list will be 1 of 2 types. java.lang.String or FDFOptionElement. A list of all options. getPartialFieldName public String getPartialFieldName()(Code) This will get the "T" entry in the field dictionary. A partial field name. Where the fully qualified field name is a concatenation of the parent's fully qualified field name and "." as a separator. For example Address.State Address.City The partial field name. getRichText public PDTextStream getRichText()(Code) This will set the rich text that is associated with this field. The rich text XHTML stream. getSetFieldFlags public Integer getSetFieldFlags()(Code) This will get the SetFf entry of the cos dictionary. If it it not present then this method will return null. The field flags. getSetWidgetFieldFlags public Integer getSetWidgetFieldFlags()(Code) This will get the SetF entry of the cos dictionary. If it it not present then this method will return null. The field flags. getValue public Object getValue() throws IOException(Code) This will set the value for the field. This will return type will either be String : Checkboxes, Radio Button java.util.List of strings: Choice Field PDTextStream: Textfields The value of the field. throws:   IOException - If there is an error getting the value. getWidgetFieldFlags public Integer getWidgetFieldFlags()(Code) This will get the F entry of the cos dictionary. If it it not present then this method will return null. The widget field flags. setAction public void setAction(PDAction a)(Code) This will set the action that is associated with this field. Parameters:   a - The new action. setAdditionalActions public void setAdditionalActions(PDAdditionalActions aa)(Code) This will set the additional actions that are associated with this field. Parameters:   aa - The additional actions. setAppearanceDictionary public void setAppearanceDictionary(PDAppearanceDictionary ap)(Code) This will set the appearance dictionary. Parameters:   ap - The apperance dictionary. setAppearanceStreamReference public void setAppearanceStreamReference(FDFNamedPageReference ref)(Code) This will set the named page references. Parameters:   ref - The named page references. setClearFieldFlags public void setClearFieldFlags(Integer ff)(Code) This will get the field flags that are associated with this field. The ClrFf entry in the FDF field dictionary. Parameters:   ff - The new value for the "clear field flags". setClearFieldFlags public void setClearFieldFlags(int ff)(Code) This will get the field flags that are associated with this field. The ClrFf entry in the FDF field dictionary. Parameters:   ff - The new value for the "clear field flags". setClearWidgetFieldFlags public void setClearWidgetFieldFlags(Integer ff)(Code) This will get the field flags that are associated with this field. The ClrF entry in the FDF field dictionary. Parameters:   ff - The new value for the "clear widget field flags". setClearWidgetFieldFlags public void setClearWidgetFieldFlags(int ff)(Code) This will get the field flags that are associated with this field. The ClrF entry in the FDF field dictionary. Parameters:   ff - The new value for the "clear field flags". setFieldFlags public void setFieldFlags(Integer ff)(Code) This will get the field flags that are associated with this field. The Ff entry in the FDF field dictionary. Parameters:   ff - The new value for the field flags. setFieldFlags public void setFieldFlags(int ff)(Code) This will get the field flags that are associated with this field. The Ff entry in the FDF field dictionary. Parameters:   ff - The new value for the field flags. setIconFit public void setIconFit(FDFIconFit fit)(Code) This will set the icon fit entry. Parameters:   fit - The icon fit object. setKids public void setKids(List kids)(Code) This will set the list of kids. Parameters:   kids - A list of FDFField objects. setOptions public void setOptions(List options)(Code) This will set the options for the choice field. The objects in the list should either be java.lang.String or FDFOptionElement. Parameters:   options - The options to set. setPartialFieldName public void setPartialFieldName(String partial)(Code) This will set the partial field name. Parameters:   partial - The partial field name. setRichText public void setRichText(PDTextStream rv)(Code) This will set the rich text value. Parameters:   rv - The rich text value for the stream. setSetFieldFlags public void setSetFieldFlags(Integer ff)(Code) This will get the field flags that are associated with this field. The SetFf entry in the FDF field dictionary. Parameters:   ff - The new value for the "set field flags". setSetFieldFlags public void setSetFieldFlags(int ff)(Code) This will get the field flags that are associated with this field. The SetFf entry in the FDF field dictionary. Parameters:   ff - The new value for the "set field flags". setSetWidgetFieldFlags public void setSetWidgetFieldFlags(Integer ff)(Code) This will get the widget field flags that are associated with this field. The SetF entry in the FDF field dictionary. Parameters:   ff - The new value for the "set widget field flags". setSetWidgetFieldFlags public void setSetWidgetFieldFlags(int ff)(Code) This will get the widget field flags that are associated with this field. The SetF entry in the FDF field dictionary. Parameters:   ff - The new value for the "set widget field flags". setValue public void setValue(Object value) throws IOException(Code) You should pass in a string, or a java.util.List of strings to set the value. Parameters:   value - The value that should populate when imported. throws:   IOException - If there is an error setting the value. setWidgetFieldFlags public void setWidgetFieldFlags(Integer f)(Code) This will get the widget field flags that are associated with this field. The F entry in the FDF field dictionary. Parameters:   f - The new value for the field flags. setWidgetFieldFlags public void setWidgetFieldFlags(int f)(Code) This will get the field flags that are associated with this field. The F entry in the FDF field dictionary. Parameters:   f - The new value for the field flags. 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)