getAction
public PDAction getAction()
This will get the action that is associated with this field.
- The A entry in the field dictionary.
getAdditionalActions
public PDAdditionalActions getAdditionalActions()
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()
This will get the appearance dictionary that specifies the appearance of
a pushbutton field.
- The AP entry of this dictionary.
getAppearanceStreamReference
public FDFNamedPageReference getAppearanceStreamReference()
This will get named page references..
- The named page references.
getCOSDictionary
public COSDictionary getCOSDictionary()
Convert this standard java object to a COS object.
- The cos object that matches this Java object.
getCOSObject
public COSBase getCOSObject()
Convert this standard java object to a COS object.
- getCOSObject in interface COSObjectable
- The cos object that matches this Java object.
getClearFieldFlags
public Integer getClearFieldFlags()
This will get the ClrFf entry of the cos dictionary. If it it not present then
this method will return null.
getClearWidgetFieldFlags
public Integer getClearWidgetFieldFlags()
This will get the ClrF entry of the cos dictionary. If it it not present then
this method will return null.
getFieldFlags
public Integer getFieldFlags()
This will get the Ff entry of the cos dictionary. If it it not present then
this method will return null.
getIconFit
public FDFIconFit getIconFit()
This will get the icon fit that is associated with this field.
getKids
public List getKids()
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.
getOptions
public List getOptions()
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.
getPartialFieldName
public String getPartialFieldName()
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
getRichText
public PDTextStream getRichText()
This will set the rich text that is associated with this field.
- The rich text XHTML stream.
getSetFieldFlags
public Integer getSetFieldFlags()
This will get the SetFf entry of the cos dictionary. If it it not present then
this method will return null.
getSetWidgetFieldFlags
public Integer getSetWidgetFieldFlags()
This will get the SetF entry of the cos dictionary. If it it not present then
this method will return null.
getValue
public Object getValue()
throws IOException
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
getWidgetFieldFlags
public Integer getWidgetFieldFlags()
This will get the F entry of the cos dictionary. If it it not present then
this method will return null.
setAction
public void setAction(PDAction a)
This will set the action that is associated with this field.
setAdditionalActions
public void setAdditionalActions(PDAdditionalActions aa)
This will set the additional actions that are associated with this field.
aa
- The additional actions.
setAppearanceDictionary
public void setAppearanceDictionary(PDAppearanceDictionary ap)
This will set the appearance dictionary.
ap
- The apperance dictionary.
setAppearanceStreamReference
public void setAppearanceStreamReference(FDFNamedPageReference ref)
This will set the named page references.
ref
- The named page references.
setClearFieldFlags
public void setClearFieldFlags(Integer ff)
This will get the field flags that are associated with this field. The ClrFf entry
in the FDF field dictionary.
ff
- The new value for the "clear field flags".
setClearFieldFlags
public void setClearFieldFlags(int ff)
This will get the field flags that are associated with this field. The ClrFf entry
in the FDF field dictionary.
ff
- The new value for the "clear field flags".
setClearWidgetFieldFlags
public void setClearWidgetFieldFlags(Integer ff)
This will get the field flags that are associated with this field. The ClrF entry
in the FDF field dictionary.
ff
- The new value for the "clear widget field flags".
setClearWidgetFieldFlags
public void setClearWidgetFieldFlags(int ff)
This will get the field flags that are associated with this field. The ClrF entry
in the FDF field dictionary.
ff
- The new value for the "clear field flags".
setFieldFlags
public void setFieldFlags(Integer ff)
This will get the field flags that are associated with this field. The Ff entry
in the FDF field dictionary.
ff
- The new value for the field flags.
setFieldFlags
public void setFieldFlags(int ff)
This will get the field flags that are associated with this field. The Ff entry
in the FDF field dictionary.
ff
- The new value for the field flags.
setIconFit
public void setIconFit(FDFIconFit fit)
This will set the icon fit entry.
fit
- The icon fit object.
setKids
public void setKids(List kids)
This will set the list of kids.
kids
- A list of FDFField objects.
setOptions
public void setOptions(List options)
This will set the options for the choice field. The objects in the list
should either be java.lang.String or FDFOptionElement.
options
- The options to set.
setPartialFieldName
public void setPartialFieldName(String partial)
This will set the partial field name.
partial
- The partial field name.
setRichText
public void setRichText(PDTextStream rv)
This will set the rich text value.
rv
- The rich text value for the stream.
setSetFieldFlags
public void setSetFieldFlags(Integer ff)
This will get the field flags that are associated with this field. The SetFf entry
in the FDF field dictionary.
ff
- The new value for the "set field flags".
setSetFieldFlags
public void setSetFieldFlags(int ff)
This will get the field flags that are associated with this field. The SetFf entry
in the FDF field dictionary.
ff
- The new value for the "set field flags".
setSetWidgetFieldFlags
public void setSetWidgetFieldFlags(Integer ff)
This will get the widget field flags that are associated with this field. The SetF entry
in the FDF field dictionary.
ff
- The new value for the "set widget field flags".
setSetWidgetFieldFlags
public void setSetWidgetFieldFlags(int ff)
This will get the widget field flags that are associated with this field. The SetF entry
in the FDF field dictionary.
ff
- The new value for the "set widget field flags".
setValue
public void setValue(Object value)
throws IOException
You should pass in a string, or a java.util.List of strings to set the
value.
value
- The value that should populate when imported.
setWidgetFieldFlags
public void setWidgetFieldFlags(Integer f)
This will get the widget field flags that are associated with this field. The F entry
in the FDF field dictionary.
f
- The new value for the field flags.
setWidgetFieldFlags
public void setWidgetFieldFlags(int f)
This will get the field flags that are associated with this field. The F entry
in the FDF field dictionary.
f
- The new value for the field flags.
writeXML
public void writeXML(Writer output)
throws IOException
This will write this element as an XML document.
output
- The stream to write the xml to.