com.lowagie.text.pdf

Class PdfFormField

public class PdfFormField extends PdfAnnotation

Implements form fields.

Author: Paulo Soares (psoares@consiste.pt)

Field Summary
static intFF_COMB
static intFF_COMBO
static intFF_DONOTSCROLL
static intFF_DONOTSPELLCHECK
static intFF_EDIT
static intFF_FILESELECT
static intFF_MULTILINE
static intFF_MULTISELECT
static intFF_NO_EXPORT
static intFF_NO_TOGGLE_TO_OFF
static intFF_PASSWORD
static intFF_PUSHBUTTON
static intFF_RADIO
static intFF_RADIOSINUNISON
static intFF_READ_ONLY
static intFF_REQUIRED
static PdfNameIF_SCALE_ALWAYS
static PdfNameIF_SCALE_ANAMORPHIC
static PdfNameIF_SCALE_BIGGER
static PdfNameIF_SCALE_NEVER
static PdfNameIF_SCALE_PROPORTIONAL
static PdfNameIF_SCALE_SMALLER
protected ArrayListkids
static PdfName[]mergeTarget
static intMK_CAPTION_ABOVE
static intMK_CAPTION_BELOW
static intMK_CAPTION_LEFT
static intMK_CAPTION_OVERLAID
static intMK_CAPTION_RIGHT
static intMK_NO_CAPTION
static intMK_NO_ICON
static booleanMULTILINE
protected PdfFormFieldparent
Holds value of property parent.
static booleanPASSWORD
static booleanPLAINTEXT
static intQ_CENTER
static intQ_LEFT
static intQ_RIGHT
static booleanSINGLELINE
Constructor Summary
PdfFormField(PdfWriter writer, float llx, float lly, float urx, float ury, PdfAction action)
Constructs a new PdfAnnotation of subtype link (Action).
protected PdfFormField(PdfWriter writer)
Creates new PdfFormField
Method Summary
voidaddKid(PdfFormField field)
protected static PdfFormFieldcreateButton(PdfWriter writer, int flags)
static PdfFormFieldcreateCheckBox(PdfWriter writer)
protected static PdfFormFieldcreateChoice(PdfWriter writer, int flags, PdfArray options, int topIndex)
static PdfFormFieldcreateCombo(PdfWriter writer, boolean edit, String[] options, int topIndex)
static PdfFormFieldcreateCombo(PdfWriter writer, boolean edit, String[][] options, int topIndex)
static PdfFormFieldcreateEmpty(PdfWriter writer)
static PdfFormFieldcreateList(PdfWriter writer, String[] options, int topIndex)
static PdfFormFieldcreateList(PdfWriter writer, String[][] options, int topIndex)
static PdfFormFieldcreatePushButton(PdfWriter writer)
static PdfFormFieldcreateRadioButton(PdfWriter writer, boolean noToggleToOff)
static PdfFormFieldcreateSignature(PdfWriter writer)
static PdfFormFieldcreateTextField(PdfWriter writer, boolean multiline, boolean password, int maxLen)
ArrayListgetKids()
PdfFormFieldgetParent()
Getter for property parent.
static voidmergeResources(PdfDictionary result, PdfDictionary source, PdfStamperImp writer)
static voidmergeResources(PdfDictionary result, PdfDictionary source)
protected static PdfArrayprocessOptions(String[] options)
protected static PdfArrayprocessOptions(String[][] options)
voidsetButton(int flags)
voidsetDefaultValueAsName(String s)
voidsetDefaultValueAsString(String s)
intsetFieldFlags(int flags)
voidsetFieldName(String s)
voidsetMappingName(String s)
voidsetQuadding(int v)
voidsetUsed()
voidsetUserName(String s)
voidsetValue(PdfSignature sig)
voidsetValueAsName(String s)
voidsetValueAsString(String s)
voidsetWidget(Rectangle rect, PdfName highlight)
static PdfAnnotationshallowDuplicate(PdfAnnotation annot)

Field Detail

FF_COMB

public static final int FF_COMB

FF_COMBO

public static final int FF_COMBO

FF_DONOTSCROLL

public static final int FF_DONOTSCROLL

FF_DONOTSPELLCHECK

public static final int FF_DONOTSPELLCHECK

FF_EDIT

public static final int FF_EDIT

FF_FILESELECT

public static final int FF_FILESELECT

FF_MULTILINE

public static final int FF_MULTILINE

FF_MULTISELECT

public static final int FF_MULTISELECT

FF_NO_EXPORT

public static final int FF_NO_EXPORT

FF_NO_TOGGLE_TO_OFF

public static final int FF_NO_TOGGLE_TO_OFF

FF_PASSWORD

public static final int FF_PASSWORD

FF_PUSHBUTTON

public static final int FF_PUSHBUTTON

FF_RADIO

public static final int FF_RADIO

FF_RADIOSINUNISON

public static final int FF_RADIOSINUNISON

FF_READ_ONLY

public static final int FF_READ_ONLY

FF_REQUIRED

public static final int FF_REQUIRED

IF_SCALE_ALWAYS

public static final PdfName IF_SCALE_ALWAYS

IF_SCALE_ANAMORPHIC

public static final PdfName IF_SCALE_ANAMORPHIC

IF_SCALE_BIGGER

public static final PdfName IF_SCALE_BIGGER

IF_SCALE_NEVER

public static final PdfName IF_SCALE_NEVER

IF_SCALE_PROPORTIONAL

public static final PdfName IF_SCALE_PROPORTIONAL

IF_SCALE_SMALLER

public static final PdfName IF_SCALE_SMALLER

kids

protected ArrayList kids

mergeTarget

static PdfName[] mergeTarget

MK_CAPTION_ABOVE

public static final int MK_CAPTION_ABOVE

MK_CAPTION_BELOW

public static final int MK_CAPTION_BELOW

MK_CAPTION_LEFT

public static final int MK_CAPTION_LEFT

MK_CAPTION_OVERLAID

public static final int MK_CAPTION_OVERLAID

MK_CAPTION_RIGHT

public static final int MK_CAPTION_RIGHT

MK_NO_CAPTION

public static final int MK_NO_CAPTION

MK_NO_ICON

public static final int MK_NO_ICON

MULTILINE

public static final boolean MULTILINE

parent

protected PdfFormField parent
Holds value of property parent.

PASSWORD

public static final boolean PASSWORD

PLAINTEXT

public static final boolean PLAINTEXT

Q_CENTER

public static final int Q_CENTER

Q_LEFT

public static final int Q_LEFT

Q_RIGHT

public static final int Q_RIGHT

SINGLELINE

public static final boolean SINGLELINE

Constructor Detail

PdfFormField

public PdfFormField(PdfWriter writer, float llx, float lly, float urx, float ury, PdfAction action)
Constructs a new PdfAnnotation of subtype link (Action).

PdfFormField

protected PdfFormField(PdfWriter writer)
Creates new PdfFormField

Method Detail

addKid

public void addKid(PdfFormField field)

createButton

protected static PdfFormField createButton(PdfWriter writer, int flags)

createCheckBox

public static PdfFormField createCheckBox(PdfWriter writer)

createChoice

protected static PdfFormField createChoice(PdfWriter writer, int flags, PdfArray options, int topIndex)

createCombo

public static PdfFormField createCombo(PdfWriter writer, boolean edit, String[] options, int topIndex)

createCombo

public static PdfFormField createCombo(PdfWriter writer, boolean edit, String[][] options, int topIndex)

createEmpty

public static PdfFormField createEmpty(PdfWriter writer)

createList

public static PdfFormField createList(PdfWriter writer, String[] options, int topIndex)

createList

public static PdfFormField createList(PdfWriter writer, String[][] options, int topIndex)

createPushButton

public static PdfFormField createPushButton(PdfWriter writer)

createRadioButton

public static PdfFormField createRadioButton(PdfWriter writer, boolean noToggleToOff)

createSignature

public static PdfFormField createSignature(PdfWriter writer)

createTextField

public static PdfFormField createTextField(PdfWriter writer, boolean multiline, boolean password, int maxLen)

getKids

public ArrayList getKids()

getParent

public PdfFormField getParent()
Getter for property parent.

Returns: Value of property parent.

mergeResources

static void mergeResources(PdfDictionary result, PdfDictionary source, PdfStamperImp writer)

mergeResources

static void mergeResources(PdfDictionary result, PdfDictionary source)

processOptions

protected static PdfArray processOptions(String[] options)

processOptions

protected static PdfArray processOptions(String[][] options)

setButton

public void setButton(int flags)

setDefaultValueAsName

public void setDefaultValueAsName(String s)

setDefaultValueAsString

public void setDefaultValueAsString(String s)

setFieldFlags

public int setFieldFlags(int flags)

setFieldName

public void setFieldName(String s)

setMappingName

public void setMappingName(String s)

setQuadding

public void setQuadding(int v)

setUsed

public void setUsed()

setUserName

public void setUserName(String s)

setValue

public void setValue(PdfSignature sig)

setValueAsName

public void setValueAsName(String s)

setValueAsString

public void setValueAsString(String s)

setWidget

public void setWidget(Rectangle rect, PdfName highlight)

shallowDuplicate

public static PdfAnnotation shallowDuplicate(PdfAnnotation annot)