IFormField

All Superinterfaces:: IAbstractElement, IBlockElement, IElement, IPropertyContainer

All Known Implementing Classes:: AbstractSelectField, Button, CheckBox, ComboBoxField, FormField, InputField, ListBoxField, Radio, SignatureFieldAppearance, TextArea

public interface IFormField extends IBlockElement

Common interface for HTML form elements.

Method Summary

Modifier and Type

Method

Description

String

getId()

Gets the id.

IFormField

setHeight(float height)

Set the form field's height.

IFormField

setInteractive(boolean interactive)

Set the form field to be interactive and added into Acroform instead of drawing it on a page.

IFormField

setValue(String value)

Sets the FormProperty.FORM_FIELD_VALUE property.

IFormField

setWidth(float width)

Set the form field's width.

Methods inherited from interface com.itextpdf.layout.element.IAbstractElement
getChildren

Methods inherited from interface com.itextpdf.layout.element.IElement
createRendererSubTree, getRenderer, setNextRenderer

Methods inherited from interface com.itextpdf.layout.IPropertyContainer
deleteOwnProperty, getDefaultProperty, getOwnProperty, getProperty, hasOwnProperty, hasProperty, setProperty

Method Details
- setValue
  
  IFormField setValue(String value)
  
  Sets the FormProperty.FORM_FIELD_VALUE property.
  
  Parameters:
  
  value - string value of the property to be set
  
  Returns:
  
  this same IFormField instance
- setInteractive
  
  IFormField setInteractive(boolean interactive)
  
  Set the form field to be interactive and added into Acroform instead of drawing it on a page.
  
  Parameters:
  
  interactive - true if the form field element shall be added into Acroform, false otherwise. By default, the form field element is not interactive and drawn on a page
  
  Returns:
  
  this same IFormField instance
- getId
  
  String getId()
  
  Gets the id.
  
  Returns:
  
  the id
- setWidth
  
  IFormField setWidth(float width)
  
  Set the form field's width.
  
  Parameters:
  
  width - form field's width
  
  Returns:
  
  this FormField element
- setHeight
  
  IFormField setHeight(float height)
  
  Set the form field's height.
  
  Parameters:
  
  height - form field's height
  
  Returns:
  
  this FormField element