Package com.itextpdf.forms.form.element

Class FormFieldIFormField>

java.lang.Object
com.itextpdf.commons.actions.sequence.AbstractIdentifiableElement
com.itextpdf.layout.ElementPropertyContainer
com.itextpdf.layout.element.AbstractElement
com.itextpdf.forms.form.element.FormField
Type Parameters:
T - the generic type of the form field (e.g. input field, button, text area)
All Implemented Interfaces:
IFormField, IAbstractElement, IBlockElement, IElement, IPropertyContainer, IAccessibleElement
Direct Known Subclasses:
AbstractSelectField, Button, CheckBox, InputField, Radio, SignatureFieldAppearance, TextArea
public abstract class FormFieldIFormField> extends AbstractElement implements IFormField, IAccessibleElement
Implementation of the AbstractElement class for form fields.

  • Field Details

  • Method Details

    • setSize

      public T setSize (float size)
      Sets the form field's width and height.
      Parameters:
      size - form field's width and height.
      Returns:
      this same FormField element.

    • setWidth

      public IFormField setWidth (float width)
      Set the form field's width.
      Specified by:
      setWidth in interface IFormField
      Parameters:
      width - form field's width
      Returns:
      this FormField element

    • setHeight

      public IFormField setHeight (float height)
      Set the form field's height.
      Specified by:
      setHeight in interface IFormField
      Parameters:
      height - form field's height
      Returns:
      this FormField element

    • setValue

      public IFormField setValue (String value)
      Sets the FormProperty.FORM_FIELD_VALUE property.
      Specified by:
      setValue in interface IFormField
      Parameters:
      value - string value of the property to be set
      Returns:
      this same IFormField instance

    • getId

      public String getId()
      Gets the id.
      Specified by:
      getId in interface IFormField
      Returns:
      the id

    • getDefaultProperty

      public  T1 getDefaultProperty (int property)
      Gets the default property from this entity.
      Specified by:
      getDefaultProperty in interface IPropertyContainer
      Overrides:
      getDefaultProperty in class ElementPropertyContainer<T extends IFormField>
      Type Parameters:
      T1 - the return type associated with the property
      Parameters:
      property - the property to be retrieved
      Returns:
      the default property value. If the default property is not defined, null will be returned

    • setInteractive

      public IFormField setInteractive (boolean interactive)
      Set the form field to be interactive and added into Acroform instead of drawing it on a page.
      Specified by:
      setInteractive in interface IFormField
      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

    • setAlternativeDescription

      public IFormField setAlternativeDescription (String alternativeDescription)
      Sets the form field's alternative description.
      Parameters:
      alternativeDescription - form field's alternative description.
      Returns:
      this same FormField element.