COSObjectable
public class FDFField extends java.lang.Object implements COSObjectable
Constructor | Description |
---|---|
FDFField() |
Default constructor.
|
FDFField(COSDictionary f) |
Constructor.
|
FDFField(org.w3c.dom.Element fieldXML) |
This will create an FDF field from an XFDF XML document.
|
Modifier and Type | Method | Description |
---|---|---|
PDAction |
getAction() |
This will get the action that is associated with this field.
|
PDAdditionalActions |
getAdditionalActions() |
This will get a list of additional actions that will get executed based
on events.
|
PDAppearanceDictionary |
getAppearanceDictionary() |
This will get the appearance dictionary that specifies the appearance of
a pushbutton field.
|
FDFNamedPageReference |
getAppearanceStreamReference() |
This will get named page references..
|
java.lang.Integer |
getClearFieldFlags() |
This will get the ClrFf entry of the cos dictionary.
|
java.lang.Integer |
getClearWidgetFieldFlags() |
This will get the ClrF entry of the cos dictionary.
|
COSDictionary |
getCOSDictionary() |
Convert this standard java object to a COS object.
|
COSBase |
getCOSObject() |
Convert this standard java object to a COS object.
|
java.lang.Integer |
getFieldFlags() |
This will get the Ff entry of the cos dictionary.
|
FDFIconFit |
getIconFit() |
This will get the icon fit that is associated with this field.
|
java.util.List<FDFField> |
getKids() |
This will get the list of kids.
|
java.util.List |
getOptions() |
This will return a list of options for a choice field.
|
java.lang.String |
getPartialFieldName() |
This will get the "T" entry in the field dictionary.
|
PDTextStream |
getRichText() |
This will set the rich text that is associated with this field.
|
java.lang.Integer |
getSetFieldFlags() |
This will get the SetFf entry of the cos dictionary.
|
java.lang.Integer |
getSetWidgetFieldFlags() |
This will get the SetF entry of the cos dictionary.
|
java.lang.Object |
getValue() |
This will set the value for the field.
|
java.lang.Integer |
getWidgetFieldFlags() |
This will get the F entry of the cos dictionary.
|
void |
setAction(PDAction a) |
This will set the action that is associated with this field.
|
void |
setAdditionalActions(PDAdditionalActions aa) |
This will set the additional actions that are associated with this field.
|
void |
setAppearanceDictionary(PDAppearanceDictionary ap) |
This will set the appearance dictionary.
|
void |
setAppearanceStreamReference(FDFNamedPageReference ref) |
This will set the named page references.
|
void |
setClearFieldFlags(int ff) |
This will get the field flags that are associated with this field.
|
void |
setClearFieldFlags(java.lang.Integer ff) |
This will get the field flags that are associated with this field.
|
void |
setClearWidgetFieldFlags(int ff) |
This will get the field flags that are associated with this field.
|
void |
setClearWidgetFieldFlags(java.lang.Integer ff) |
This will get the field flags that are associated with this field.
|
void |
setFieldFlags(int ff) |
This will get the field flags that are associated with this field.
|
void |
setFieldFlags(java.lang.Integer ff) |
This will get the field flags that are associated with this field.
|
void |
setIconFit(FDFIconFit fit) |
This will set the icon fit entry.
|
void |
setKids(java.util.List<FDFField> kids) |
This will set the list of kids.
|
void |
setOptions(java.util.List options) |
This will set the options for the choice field.
|
void |
setPartialFieldName(java.lang.String partial) |
This will set the partial field name.
|
void |
setRichText(PDTextStream rv) |
This will set the rich text value.
|
void |
setSetFieldFlags(int ff) |
This will get the field flags that are associated with this field.
|
void |
setSetFieldFlags(java.lang.Integer ff) |
This will get the field flags that are associated with this field.
|
void |
setSetWidgetFieldFlags(int ff) |
This will get the widget field flags that are associated with this field.
|
void |
setSetWidgetFieldFlags(java.lang.Integer ff) |
This will get the widget field flags that are associated with this field.
|
void |
setValue(java.lang.Object value) |
You should pass in a string, or a java.util.List of strings to set the
value.
|
void |
setWidgetFieldFlags(int f) |
This will get the field flags that are associated with this field.
|
void |
setWidgetFieldFlags(java.lang.Integer f) |
This will get the widget field flags that are associated with this field.
|
void |
writeXML(java.io.Writer output) |
This will write this element as an XML document.
|
public FDFField()
public FDFField(COSDictionary f)
f
- The FDF field.public FDFField(org.w3c.dom.Element fieldXML) throws java.io.IOException
fieldXML
- The XML document that contains the XFDF data.java.io.IOException
- If there is an error reading from the dom.public void writeXML(java.io.Writer output) throws java.io.IOException
output
- The stream to write the xml to.java.io.IOException
- If there is an error writing the XML.public COSBase getCOSObject()
getCOSObject
in interface COSObjectable
public COSDictionary getCOSDictionary()
public java.util.List<FDFField> getKids()
public void setKids(java.util.List<FDFField> kids)
kids
- A list of FDFField objects.public java.lang.String getPartialFieldName()
public void setPartialFieldName(java.lang.String partial)
partial
- The partial field name.public java.lang.Object getValue() throws java.io.IOException
java.io.IOException
- If there is an error getting the value.public void setValue(java.lang.Object value) throws java.io.IOException
value
- The value that should populate when imported.java.io.IOException
- If there is an error setting the value.public java.lang.Integer getFieldFlags()
public void setFieldFlags(java.lang.Integer ff)
ff
- The new value for the field flags.public void setFieldFlags(int ff)
ff
- The new value for the field flags.public java.lang.Integer getSetFieldFlags()
public void setSetFieldFlags(java.lang.Integer ff)
ff
- The new value for the "set field flags".public void setSetFieldFlags(int ff)
ff
- The new value for the "set field flags".public java.lang.Integer getClearFieldFlags()
public void setClearFieldFlags(java.lang.Integer ff)
ff
- The new value for the "clear field flags".public void setClearFieldFlags(int ff)
ff
- The new value for the "clear field flags".public java.lang.Integer getWidgetFieldFlags()
public void setWidgetFieldFlags(java.lang.Integer f)
f
- The new value for the field flags.public void setWidgetFieldFlags(int f)
f
- The new value for the field flags.public java.lang.Integer getSetWidgetFieldFlags()
public void setSetWidgetFieldFlags(java.lang.Integer ff)
ff
- The new value for the "set widget field flags".public void setSetWidgetFieldFlags(int ff)
ff
- The new value for the "set widget field flags".public java.lang.Integer getClearWidgetFieldFlags()
public void setClearWidgetFieldFlags(java.lang.Integer ff)
ff
- The new value for the "clear widget field flags".public void setClearWidgetFieldFlags(int ff)
ff
- The new value for the "clear field flags".public PDAppearanceDictionary getAppearanceDictionary()
public void setAppearanceDictionary(PDAppearanceDictionary ap)
ap
- The apperance dictionary.public FDFNamedPageReference getAppearanceStreamReference()
public void setAppearanceStreamReference(FDFNamedPageReference ref)
ref
- The named page references.public FDFIconFit getIconFit()
public void setIconFit(FDFIconFit fit)
fit
- The icon fit object.public java.util.List getOptions()
public void setOptions(java.util.List options)
options
- The options to set.public PDAction getAction()
public void setAction(PDAction a)
a
- The new action.public PDAdditionalActions getAdditionalActions()
public void setAdditionalActions(PDAdditionalActions aa)
aa
- The additional actions.public PDTextStream getRichText()
public void setRichText(PDTextStream rv)
rv
- The rich text value for the stream.