|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.pdfbox.pdmodel.interactive.form.PDField
org.pdfbox.pdmodel.interactive.form.PDVariableText
A class for handling PDF fields that display text.
Field Summary | |
static int |
FLAG_COMB
A Ff flag. |
static int |
FLAG_DO_NOT_SCROLL
A Ff flag. |
static int |
FLAG_DO_NOT_SPELL_CHECK
A Ff flag. |
static int |
FLAG_FILE_SELECT
A Ff flag. |
static int |
FLAG_MULTILINE
A Ff flag. |
static int |
FLAG_PASSWORD
A Ff flag. |
static int |
FLAG_RICH_TEXT
A Ff flag. |
static int |
QUADDING_CENTERED
A Q value. |
static int |
QUADDING_LEFT
A Q value. |
static int |
QUADDING_RIGHT
A Q value. |
Fields inherited from class org.pdfbox.pdmodel.interactive.form.PDField |
FLAG_NO_EXPORT, FLAG_READ_ONLY, FLAG_REQUIRED |
Constructor Summary | |
PDVariableText(PDAcroForm theAcroForm)
|
|
PDVariableText(PDAcroForm theAcroForm,
COSDictionary field)
|
Method Summary | |
boolean |
doNotScroll()
|
boolean |
doNotSpellCheck()
|
protected COSString |
getDefaultAppearance()
|
int |
getQ()
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. |
String |
getValue()
getValue gets the fields value to as a string. |
boolean |
isFileSelect()
|
boolean |
isMultiline()
|
boolean |
isPassword()
|
boolean |
isRichText()
|
void |
setComb(boolean comb)
Set the comb bit. |
void |
setDoNotScroll(boolean doNotScroll)
Set the doNotScroll bit. |
void |
setDoNotSpellCheck(boolean doNotSpellCheck)
Set the doNotSpellCheck bit. |
void |
setFileSelect(boolean fileSelect)
Set the file select bit. |
void |
setMultiline(boolean multiline)
Set the multiline bit. |
void |
setPassword(boolean password)
Set the password bit. |
void |
setQ(int q)
This will set the quadding/justification of the text. |
void |
setRichText(boolean richText)
Set the richText bit. |
void |
setValue(String value)
setValue sets the fields value to a given string. |
boolean |
shouldComb()
|
Methods inherited from class org.pdfbox.pdmodel.interactive.form.PDField |
findFieldType, findKid, getAcroForm, getActions, getCOSObject, getDictionary, getFieldFlags, getFieldType, getFullyQualifiedName, getKids, getParent, getPartialName, getWidget, importFDF, isNoExport, isReadonly, isRequired, setAcroForm, setActions, setFieldFlags, setKids, setNoExport, setParent, setPartialName, setReadonly, setRequired, toString |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
public static final int FLAG_MULTILINE
public static final int FLAG_PASSWORD
public static final int FLAG_FILE_SELECT
public static final int FLAG_DO_NOT_SPELL_CHECK
public static final int FLAG_DO_NOT_SCROLL
public static final int FLAG_COMB
public static final int FLAG_RICH_TEXT
public static final int QUADDING_LEFT
public static final int QUADDING_CENTERED
public static final int QUADDING_RIGHT
Constructor Detail |
public PDVariableText(PDAcroForm theAcroForm)
theAcroForm
- The acroform.PDField.PDField(PDAcroForm,COSDictionary)
public PDVariableText(PDAcroForm theAcroForm, COSDictionary field)
theAcroForm
- The acroForm for this field.field
- The field's dictionary.PDField.PDField(PDAcroForm,COSDictionary)
Method Detail |
public void setValue(String value) throws IOException
PDField
setValue
in class PDField
value
- The new value for this text field.
IOException
- If there is an error calculating the appearance stream.PDField.setValue(java.lang.String)
public String getValue() throws IOException
getValue
in class PDField
IOException
- If there is an error getting the value.public boolean isMultiline()
public void setMultiline(boolean multiline)
multiline
- The value for the multiline.public boolean isPassword()
public void setPassword(boolean password)
password
- The value for the password.public boolean isFileSelect()
public void setFileSelect(boolean fileSelect)
fileSelect
- The value for the fileSelect.public boolean doNotSpellCheck()
public void setDoNotSpellCheck(boolean doNotSpellCheck)
doNotSpellCheck
- The value for the doNotSpellCheck.public boolean doNotScroll()
public void setDoNotScroll(boolean doNotScroll)
doNotScroll
- The value for the doNotScroll.public boolean shouldComb()
public void setComb(boolean comb)
comb
- The value for the comb.public boolean isRichText()
public void setRichText(boolean richText)
richText
- The value for the richText.protected COSString getDefaultAppearance()
public int getQ()
public void setQ(int q)
q
- The new text justification.
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |