|
DynamicPDF by ceTe Software | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.cete.dynamicpdf.Resource com.cete.dynamicpdf.forms.FormField
public class FormField
Represents a PDF form field.
Licensing:
Reading the values or properties of a field is a
DynamicPDF Merger Standard Edition feature (for modifying field values see below).
One of the following licenses is required for non-evaluation usage:
Modiying the values of the fields (i.e. form filling) is a Professional Edition Feature. One of the following licenses is required for non-evaluation usage:
Constructor Summary | |
---|---|
FormField(java.lang.String name)
Initializes a new instance of the FormField class. |
|
FormField(java.lang.String name,
FormFieldFlags flags,
AnnotationReaderEvents actions)
Initializes a new instance of the FormField class. |
Method Summary | |
---|---|
void |
draw(DocumentWriter writer)
Draws the form field to the given DocumentWriter object. |
protected void |
drawDictionary(DocumentWriter writer)
Draws the form field's dictionary entries to the given DocumentWriter object. |
java.lang.String |
getAlternateName()
Gets the alternate name of the form field. |
protected boolean |
getAnnotation()
Gets a value indicating if the form field is an annotation. |
RgbColor |
getBackgroundColor()
Gets the BackgroundColor of a form field. |
DeviceColor |
getBorderColor()
Gets the BorderColor of a form field. |
BorderStyle |
getBorderStyle()
Gets the BorderStyle. |
FormFieldList |
getChildFields()
Gets a collection of child form fields. |
FormFieldFlags |
getFlags()
Deprecated. as of v8.0.0 Instead use relevant flag name properties present on the PdfFormField class. |
Font |
getFont()
Gets the Font of a form field. |
float |
getFontSize()
Gets the FontSize for a form field. |
Form |
getForm()
Gets the form containing this form field. |
java.lang.String |
getFullName()
Gets the full name of the form field. |
java.lang.String |
getMappingName()
Gets the mapping name of the form field. |
java.lang.String |
getName()
Gets the name of the form field. |
FormFieldOutput |
getOutput()
Gets output options for the field. |
FormField |
getParent()
Gets the parent form field. |
int |
getRequiredPdfObjects()
Gets the number of PDF objects required by the form field. |
ResourceType |
getResourceType()
Gets the resource type. |
int |
getRotate()
Gets the angle of a form field. |
DeviceColor |
getTextColor()
Gets the TextColor of a form field. |
boolean |
getUseSubstituteFont()
Gets whether to use SubstituteFont if the Font assigned is not found. |
java.lang.String |
getValue()
Gets the value of the form field. |
boolean |
hasChildFields()
Gets a value indicating if there are child form fields. |
boolean |
hasValue()
Gets a value indicating if the form field has a value. |
boolean |
inheritsName()
Gets a value indicating if the form field inherits its name. |
boolean |
inheritsValue()
Gets a value indicating if the form field inherits its value. |
boolean |
isReadOnly()
Gets a value indicating if the form field is read only. |
void |
setAlternateName(java.lang.String alternateName)
Sets the alternate name of the form field. |
protected void |
setAnnotation(boolean isAnnotation)
Sets a value indicating if the form field is an annotation. |
void |
setFont(Font font)
Sets the Font for a form field. |
void |
setFontSize(float fontSize)
Sets the FontSize for a form field. |
void |
setMappingName(java.lang.String mappingName)
Sets the mapping name of the form field. |
void |
setName(java.lang.String name)
Sets the name of the form field. |
void |
setOutput(FormFieldOutput value)
Sets output options for the field. |
void |
setReadOnly(boolean isReadOnly)
Sets a value indicating if the form field is read only. |
void |
setUseSubstituteFont(boolean value)
Sets whether to use SubstituteFont if the Font assigned is not found. |
void |
setValue(java.lang.String value)
Sets the value of the form field. |
Methods inherited from class com.cete.dynamicpdf.Resource |
---|
getUid, newUid |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public FormField(java.lang.String name)
FormField
class.
name
- Name of the form field.FormField
public FormField(java.lang.String name, FormFieldFlags flags, AnnotationReaderEvents actions)
FormField
class.
name
- Name of the form field.flags
- The flags for the form field.actions
- The AnnotationReaderEvents for the form field.FormField
Method Detail |
---|
public int getRequiredPdfObjects()
getRequiredPdfObjects
in class Resource
protected void setAnnotation(boolean isAnnotation)
isAnnotation
- A value indicating if the form field is an annotation.protected boolean getAnnotation()
public boolean hasValue()
public void setValue(java.lang.String value)
value
- The value of the form field.public java.lang.String getValue()
public boolean inheritsName()
public boolean inheritsValue()
public void setReadOnly(boolean isReadOnly)
isReadOnly
- A value indicating if the form field is read only.public boolean isReadOnly()
public FormFieldList getChildFields()
public FormFieldFlags getFlags()
public boolean hasChildFields()
public java.lang.String getFullName()
public void setName(java.lang.String name)
name
- The name of the form field.public java.lang.String getName()
public void setAlternateName(java.lang.String alternateName)
alternateName
- The alternate name of the form field.public java.lang.String getAlternateName()
public void setMappingName(java.lang.String mappingName)
mappingName
- The mapping name of the form field.public java.lang.String getMappingName()
public FormField getParent()
public Form getForm()
public BorderStyle getBorderStyle()
public DeviceColor getBorderColor()
public RgbColor getBackgroundColor()
public DeviceColor getTextColor()
public int getRotate()
public Font getFont()
public void setFont(Font font)
font
- the Font of a form field.public float getFontSize()
public void setFontSize(float fontSize)
fontSize
- the FontSize for a form field.public boolean getUseSubstituteFont()
public void setUseSubstituteFont(boolean value)
public FormFieldOutput getOutput()
public void setOutput(FormFieldOutput value)
value
- output options for the field.public ResourceType getResourceType()
getResourceType
in class Resource
ResourceType
public void draw(DocumentWriter writer)
DocumentWriter
object.
draw
in class Resource
writer
- DocumentWriter
object to receive the
form field's output.DocumentWriter
protected void drawDictionary(DocumentWriter writer)
DocumentWriter
object.
writer
- DocumentWriter
object to receive the output.DocumentWriter
|
DynamicPDF by ceTe Software | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |