Java Doc for PDVariableText.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
      org.pdfbox.pdmodel.interactive.form.PDVariableText

All known Subclasses:   org.pdfbox.pdmodel.interactive.form.PDTextbox,  org.pdfbox.pdmodel.interactive.form.PDChoiceField,
PDVariableText
abstract public class PDVariableText extends PDField (Code)
A class for handling PDF fields that display text.
author:
   Ben Litchfield
version:
   $Revision: 1.7 $


Field Summary
final public static  intFLAG_COMB
     A Ff flag.
final public static  intFLAG_DO_NOT_SCROLL
     A Ff flag.
final public static  intFLAG_DO_NOT_SPELL_CHECK
     A Ff flag.
final public static  intFLAG_FILE_SELECT
     A Ff flag.
final public static  intFLAG_MULTILINE
     A Ff flag.
final public static  intFLAG_PASSWORD
     A Ff flag.
final public static  intFLAG_RICH_TEXT
     A Ff flag.
final public static  intQUADDING_CENTERED
     A Q value.
final public static  intQUADDING_LEFT
     A Q value.
final public static  intQUADDING_RIGHT
     A Q value.

Constructor Summary
public  PDVariableText(PDAcroForm theAcroForm)
    
public  PDVariableText(PDAcroForm theAcroForm, COSDictionary field)
    

Method Summary
public  booleandoNotScroll()
    
public  booleandoNotSpellCheck()
    
protected  COSStringgetDefaultAppearance()
    
public  intgetQ()
     This will get the 'quadding' or justification of the text to be displayed.
public  StringgetValue()
     getValue gets the fields value to as a string.
public  booleanisFileSelect()
    
public  booleanisMultiline()
    
public  booleanisPassword()
    
public  booleanisRichText()
    
public  voidsetComb(boolean comb)
     Set the comb bit.
public  voidsetDoNotScroll(boolean doNotScroll)
     Set the doNotScroll bit.
public  voidsetDoNotSpellCheck(boolean doNotSpellCheck)
     Set the doNotSpellCheck bit.
public  voidsetFileSelect(boolean fileSelect)
     Set the file select bit.
public  voidsetMultiline(boolean multiline)
     Set the multiline bit.
public  voidsetPassword(boolean password)
     Set the password bit.
public  voidsetQ(int q)
     This will set the quadding/justification of the text.
public  voidsetRichText(boolean richText)
     Set the richText bit.
public  voidsetValue(String value)
    
public  booleanshouldComb()
    

Field Detail
FLAG_COMB
final public static int FLAG_COMB(Code)
A Ff flag.



FLAG_DO_NOT_SCROLL
final public static int FLAG_DO_NOT_SCROLL(Code)
A Ff flag.



FLAG_DO_NOT_SPELL_CHECK
final public static int FLAG_DO_NOT_SPELL_CHECK(Code)
A Ff flag.



FLAG_FILE_SELECT
final public static int FLAG_FILE_SELECT(Code)
A Ff flag.



FLAG_MULTILINE
final public static int FLAG_MULTILINE(Code)
A Ff flag.



FLAG_PASSWORD
final public static int FLAG_PASSWORD(Code)
A Ff flag.



FLAG_RICH_TEXT
final public static int FLAG_RICH_TEXT(Code)
A Ff flag.



QUADDING_CENTERED
final public static int QUADDING_CENTERED(Code)
A Q value.



QUADDING_LEFT
final public static int QUADDING_LEFT(Code)
A Q value.



QUADDING_RIGHT
final public static int QUADDING_RIGHT(Code)
A Q value.




Constructor Detail
PDVariableText
public PDVariableText(PDAcroForm theAcroForm)(Code)

See Also:   PDField.PDField(PDAcroFormCOSDictionary)
Parameters:
  theAcroForm - The acroform.



PDVariableText
public PDVariableText(PDAcroForm theAcroForm, COSDictionary field)(Code)

See Also:   org.pdfbox.pdmodel.interactive.form.PDField.PDField(PDAcroFormCOSDictionary)
Parameters:
  theAcroForm - The acroForm for this field.
Parameters:
  field - The field's dictionary.




Method Detail
doNotScroll
public boolean doNotScroll()(Code)
true if the field is not suppose to scroll.



doNotSpellCheck
public boolean doNotSpellCheck()(Code)
true if the field is not suppose to spell check.



getDefaultAppearance
protected COSString getDefaultAppearance()(Code)
the DA element of the dictionary object



getQ
public int getQ()(Code)
This will get the 'quadding' or justification of the text to be displayed. 0 - Left(default)
1 - Centered
2 - Right
Please see the QUADDING_CONSTANTS. The justification of the text strings.



getValue
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.



isFileSelect
public boolean isFileSelect()(Code)
true if the field is a file select field.



isMultiline
public boolean isMultiline()(Code)
true if the field is multiline



isPassword
public boolean isPassword()(Code)
true if the field is a password field.



isRichText
public boolean isRichText()(Code)
true if the field is a rich text field.



setComb
public void setComb(boolean comb)(Code)
Set the comb bit.
Parameters:
  comb - The value for the comb.



setDoNotScroll
public void setDoNotScroll(boolean doNotScroll)(Code)
Set the doNotScroll bit.
Parameters:
  doNotScroll - The value for the doNotScroll.



setDoNotSpellCheck
public void setDoNotSpellCheck(boolean doNotSpellCheck)(Code)
Set the doNotSpellCheck bit.
Parameters:
  doNotSpellCheck - The value for the doNotSpellCheck.



setFileSelect
public void setFileSelect(boolean fileSelect)(Code)
Set the file select bit.
Parameters:
  fileSelect - The value for the fileSelect.



setMultiline
public void setMultiline(boolean multiline)(Code)
Set the multiline bit.
Parameters:
  multiline - The value for the multiline.



setPassword
public void setPassword(boolean password)(Code)
Set the password bit.
Parameters:
  password - The value for the password.



setQ
public void setQ(int q)(Code)
This will set the quadding/justification of the text. See QUADDING constants.
Parameters:
  q - The new text justification.



setRichText
public void setRichText(boolean richText)(Code)
Set the richText bit.
Parameters:
  richText - The value for the richText.



setValue
public void setValue(String value) throws IOException(Code)

See Also:   org.pdfbox.pdmodel.interactive.form.PDField.setValue(java.lang.String)
Parameters:
  value - The new value for this text field.
throws:
  IOException - If there is an error calculating the appearance stream.



shouldComb
public boolean shouldComb()(Code)
true if the field is not suppose to comb the text display.



Fields inherited from org.pdfbox.pdmodel.interactive.form.PDField
final public static int FLAG_NO_EXPORT(Code)(Java Doc)
final public static int FLAG_READ_ONLY(Code)(Java Doc)
final public static int FLAG_REQUIRED(Code)(Java Doc)

Methods inherited from org.pdfbox.pdmodel.interactive.form.PDField
public String findFieldType()(Code)(Java Doc)
public PDField findKid(String[] name, int nameIndex) throws IOException(Code)(Java Doc)
public PDAcroForm getAcroForm()(Code)(Java Doc)
public PDFormFieldAdditionalActions getActions()(Code)(Java Doc)
public COSBase getCOSObject()(Code)(Java Doc)
public COSDictionary getDictionary()(Code)(Java Doc)
public int getFieldFlags()(Code)(Java Doc)
public String getFieldType()(Code)(Java Doc)
public String getFullyQualifiedName() throws IOException(Code)(Java Doc)
public List getKids() throws IOException(Code)(Java Doc)
public PDField getParent() throws IOException(Code)(Java Doc)
public String getPartialName()(Code)(Java Doc)
abstract public String getValue() throws IOException(Code)(Java Doc)
public PDAnnotationWidget getWidget() throws IOException(Code)(Java Doc)
public void importFDF(FDFField fdfField) throws IOException(Code)(Java Doc)
public boolean isNoExport()(Code)(Java Doc)
public boolean isReadonly()(Code)(Java Doc)
public boolean isRequired()(Code)(Java Doc)
public void setAcroForm(PDAcroForm value)(Code)(Java Doc)
public void setActions(PDFormFieldAdditionalActions actions)(Code)(Java Doc)
public void setFieldFlags(int flags)(Code)(Java Doc)
public void setKids(List kids)(Code)(Java Doc)
public void setNoExport(boolean noExport)(Code)(Java Doc)
public void setParent(PDField parent)(Code)(Java Doc)
public void setPartialName(String name)(Code)(Java Doc)
public void setReadonly(boolean readonly)(Code)(Java Doc)
public void setRequired(boolean required)(Code)(Java Doc)
abstract public void setValue(String value) throws IOException(Code)(Java Doc)
public String toString()(Code)(Java Doc)

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.