Java Doc for PDField.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.PDField All known Subclasses:   org.pdfbox.pdmodel.interactive.form.PDSignature,  org.pdfbox.pdmodel.interactive.form.PDVariableText,  org.pdfbox.pdmodel.interactive.form.PDUnknownField,  org.pdfbox.pdmodel.interactive.form.PDChoiceButton,  org.pdfbox.pdmodel.interactive.form.PDPushButton, PDField abstract public class PDField implements COSObjectable(Code) This is the superclass for a Field element in a PDF. Based on the COS object model from PDFBox. author:    sug version:    $Revision: 1.23 $ Field Summary final public static  int FLAG_NO_EXPORT      A Ff flag. final public static  int FLAG_READ_ONLY      A Ff flag. final public static  int FLAG_REQUIRED      A Ff flag. Constructor Summary public   PDField(PDAcroForm theAcroForm)      Constructor. public   PDField(PDAcroForm theAcroForm, COSDictionary field)      Creates a COSField from a COSDictionary, expected to be a correct object definition for a field in PDF. Method Summary public  String findFieldType()      Find the field type and optionally do a recursive upward search. public  PDField findKid(String[] name, int nameIndex)      This will find one of the child elements. public  PDAcroForm getAcroForm()      This will get the acroform that this field is part of. public  PDFormFieldAdditionalActions getActions()      Get the additional actions for this field. public  COSBase getCOSObject()      Convert this standard java object to a COS object. public  COSDictionary getDictionary()      This will get the dictionary associated with this field. public  int getFieldFlags()      This will get the flags for this field. public  String getFieldType()      Get the FT entry of the field. public  String getFullyQualifiedName()      Returns the fully qualified name of the field, which is a concatenation of the names of all the parents fields. public  List getKids()      This will get all the kids of this field. public  PDField getParent()      Get the parent field to this field, or null if none exists. public  String getPartialName()      Returns the partial name of the field. abstract public  String getValue()      getValue gets the fields value to as a string. public  PDAnnotationWidget getWidget()      This will get the single associated widget that is part of this field. public  void importFDF(FDFField fdfField)      This will import a fdf field from a fdf document. public  boolean isNoExport()      public  boolean isReadonly()      public  boolean isRequired()      public  void setAcroForm(PDAcroForm value)      This will set the form this field is on. public  void setActions(PDFormFieldAdditionalActions actions)      Set the actions of the field. public  void setFieldFlags(int flags)      This will set the flags for this field. public  void setKids(List kids)      This will set the list of kids. public  void setNoExport(boolean noExport)      sets the field to be not exported.. public  void setParent(PDField parent)      Set the parent of this field. public  void setPartialName(String name)      This will set the partial name of the field. public  void setReadonly(boolean readonly)      sets the field to be read-only. public  void setRequired(boolean required)      sets the field to be required. abstract public  void setValue(String value)      setValue sets the fields value to a given string. public  String toString()      This will return a string representation of this field. Field Detail FLAG_NO_EXPORT final public static int FLAG_NO_EXPORT(Code) A Ff flag. FLAG_READ_ONLY final public static int FLAG_READ_ONLY(Code) A Ff flag. FLAG_REQUIRED final public static int FLAG_REQUIRED(Code) A Ff flag. Constructor Detail PDField public PDField(PDAcroForm theAcroForm)(Code) Constructor. Parameters:   theAcroForm - The form that this field is part of. PDField public PDField(PDAcroForm theAcroForm, COSDictionary field)(Code) Creates a COSField from a COSDictionary, expected to be a correct object definition for a field in PDF. Parameters:   theAcroForm - The form that this field is part of. Parameters:   field - the PDF objet to represent as a field. Method Detail findFieldType public String findFieldType()(Code) Find the field type and optionally do a recursive upward search. Sometimes the fieldtype will be specified on the parent instead of the direct object. This will look at this object for the field type, if none is specified then it will look to the parent if there is a parent. If there is no parent and no field type has been found then this will return null. The field type or null if none was found. findKid public PDField findKid(String[] name, int nameIndex) throws IOException(Code) This will find one of the child elements. The name array are the components of the name to search down the tree of names. The nameIndex is where to start in that array. This method is called recursively until it finds the end point based on the name array. Parameters:   name - An array that picks the path to the field. Parameters:   nameIndex - The index into the array. The field at the endpoint or null if none is found. throws:   IOException - If there is an error creating the field. getAcroForm public PDAcroForm getAcroForm()(Code) This will get the acroform that this field is part of. The form this field is on. getActions public PDFormFieldAdditionalActions getActions()(Code) Get the additional actions for this field. This will return null if there are no additional actions for this field. The actions of the field. getCOSObject public COSBase getCOSObject()(Code) Convert this standard java object to a COS object. The cos object that matches this Java object. getDictionary public COSDictionary getDictionary()(Code) This will get the dictionary associated with this field. The dictionary that this class wraps. getFieldFlags public int getFieldFlags()(Code) This will get the flags for this field. flags The set of flags. getFieldType public String getFieldType()(Code) Get the FT entry of the field. This is a read only field and is set depending on the actual type. The field type is an inheritable attribute. This method will return only the direct value on this object. Use the findFieldType for an upward recursive search. The Field type. See Also:   PDField.findFieldType getFullyQualifiedName public String getFullyQualifiedName() throws IOException(Code) Returns the fully qualified name of the field, which is a concatenation of the names of all the parents fields. the name of the field throws:   IOException - If there is an error generating the fully qualified name. getKids public List getKids() throws IOException(Code) This will get all the kids of this field. The values in the list will either be PDWidget or PDField. Normally they will be PDWidget objects unless this is a non-terminal field and they will be child PDField objects. A list of either PDWidget or PDField objects. throws:   IOException - If there is an error retrieving the kids. getParent public PDField getParent() throws IOException(Code) Get the parent field to this field, or null if none exists. The parent field. throws:   IOException - If there is an error creating the parent field. getPartialName public String getPartialName()(Code) Returns the partial name of the field. the name of the field getValue abstract public String getValue() throws IOException(Code) getValue gets the fields value to as a string. The string value of this field. throws:   IOException - If there is an error getting the value. getWidget public PDAnnotationWidget getWidget() throws IOException(Code) This will get the single associated widget that is part of this field. This occurs when the Widget is embedded in the fields dictionary. Sometimes there are multiple sub widgets associated with this field, in which case you want to use getKids(). If the kids entry is specified, then the first entry in that list will be returned. The widget that is associated with this field. throws:   IOException - If there is an error getting the widget object. importFDF public void importFDF(FDFField fdfField) throws IOException(Code) This will import a fdf field from a fdf document. Parameters:   fdfField - The fdf field to import. throws:   IOException - If there is an error importing the data for this field. isNoExport public boolean isNoExport()(Code) true if the field is not to be exported. isReadonly public boolean isReadonly()(Code) true if the field is readonly isRequired public boolean isRequired()(Code) true if the field is required setAcroForm public void setAcroForm(PDAcroForm value)(Code) This will set the form this field is on. Parameters:   value - The new form to use. setActions public void setActions(PDFormFieldAdditionalActions actions)(Code) Set the actions of the field. Parameters:   actions - The field actions. setFieldFlags public void setFieldFlags(int flags)(Code) This will set the flags for this field. Parameters:   flags - The new flags. setKids public void setKids(List kids)(Code) This will set the list of kids. Parameters:   kids - The list of child widgets. setNoExport public void setNoExport(boolean noExport)(Code) sets the field to be not exported.. Parameters:   noExport - The new flag for noExport. setParent public void setParent(PDField parent)(Code) Set the parent of this field. Parameters:   parent - The parent to this field. setPartialName public void setPartialName(String name)(Code) This will set the partial name of the field. Parameters:   name - The new name for the field. setReadonly public void setReadonly(boolean readonly)(Code) sets the field to be read-only. Parameters:   readonly - The new flag for readonly. setRequired public void setRequired(boolean required)(Code) sets the field to be required. Parameters:   required - The new flag for required. setValue abstract public void setValue(String value) throws IOException(Code) setValue sets the fields value to a given string. Parameters:   value - the string value throws:   IOException - If there is an error creating the appearance stream. toString public String toString()(Code) This will return a string representation of this field. A string representation of this field. 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)