Package com.itextpdf.forms

Class FormDefaultAccessibilityProperties

java.lang.Object

com.itextpdf.kernel.pdf.tagutils.AccessibilityProperties

com.itextpdf.kernel.pdf.tagutils.DefaultAccessibilityProperties

com.itextpdf.forms.FormDefaultAccessibilityProperties

       public class FormDefaultAccessibilityProperties extends DefaultAccessibilityProperties
      

The FormDefaultAccessibilityProperties class is used to create a specific forms related instance of the DefaultAccessibilityProperties class.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	FORM_FIELD_CHECK	Represents the role: Checkbox.
static final String	FORM_FIELD_LIST_BOX	Represents the role: ListBox.
static final String	FORM_FIELD_PUSH_BUTTON	Represents the role: PushButton.
static final String	FORM_FIELD_RADIO	Represents the role: radio.
static final String	FORM_FIELD_TEXT	Represents the role: Text.

Fields inherited from class com.itextpdf.kernel.pdf.tagutils.DefaultAccessibilityProperties

actualText, alternateDescription, attributesList, expansion, language, namespace, phoneme, phoneticAlphabet, refs, role

Constructor Summary

Constructors

Constructor	Description
FormDefaultAccessibilityProperties(String formFieldType)	Instantiates a new FormDefaultAccessibilityProperties instance based on structure element role.

Method Summary

Modifier and Type	Method	Description
void	updateCheckedValue(IPropertyContainer element)	Updates the checked value of the form field based on the FormProperty.FORM_FIELD_CHECKED property.

Methods inherited from class com.itextpdf.kernel.pdf.tagutils.DefaultAccessibilityProperties

addAttributes, addAttributes, addRef, clearAttributes, clearRefs, getActualText, getAlternateDescription, getAttributesList, getExpansion, getLanguage, getNamespace, getPhoneme, getPhoneticAlphabet, getRefsList, getRole, getStructureElementId, setActualText, setAlternateDescription, setExpansion, setLanguage, setNamespace, setPhoneme, setPhoneticAlphabet, setRole, setStructureElementId

Methods inherited from class com.itextpdf.kernel.pdf.tagutils.AccessibilityProperties

setStructureElementIdString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

FORM_FIELD_RADIO

             public static final String FORM_FIELD_RADIO
            

Represents the role: radio.

See Also:

• Constant Field Values

FORM_FIELD_CHECK

             public static final String FORM_FIELD_CHECK
            

Represents the role: Checkbox.

See Also:

• Constant Field Values

FORM_FIELD_PUSH_BUTTON

             public static final String FORM_FIELD_PUSH_BUTTON
            

Represents the role: PushButton.

See Also:

• Constant Field Values

FORM_FIELD_LIST_BOX

             public static final String FORM_FIELD_LIST_BOX
            

Represents the role: ListBox.

See Also:

• Constant Field Values

FORM_FIELD_TEXT

             public static final String FORM_FIELD_TEXT
            

Represents the role: Text. This can be passwords, text areas, etc.

See Also:

• Constant Field Values

Constructor Details

FormDefaultAccessibilityProperties

             public FormDefaultAccessibilityProperties
             (String formFieldType)
            

Instantiates a new FormDefaultAccessibilityProperties instance based on structure element role.

Parameters:

formFieldType - the type of the formField

Method Details

updateCheckedValue

             public void updateCheckedValue
             (IPropertyContainer element)
            

Updates the checked value of the form field based on the FormProperty.FORM_FIELD_CHECKED property. If no such property is found, the checked value is set to "off".

Parameters:

element - The element which contains a FormProperty.FORM_FIELD_CHECKED property.