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
private static final String[]	ALLOWED_VALUES
private static final String	ATTRIBUTE_CHECKED
private static final String	ATTRIBUTE_OFF
private static final String	ATTRIBUTE_ON
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.
private static final String	OWNER_PRINT_FIELD_NAME
private static final String	ROLE_NAME

Fields inherited from class 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
private static void	checkIfFormFieldTypeIsAllowed(String formFieldType)
void	updateCheckedValue(IPropertyContainer element)	Updates the checked value of the form field based on the FormProperty.FORM_FIELD_CHECKED property.

Methods inherited from class 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 AccessibilityProperties

setStructureElementIdString

Methods inherited from class 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

ROLE_NAME

private static final String ROLE_NAME

See Also:

• Constant Field Values

OWNER_PRINT_FIELD_NAME

private static final String OWNER_PRINT_FIELD_NAME

See Also:

• Constant Field Values

ATTRIBUTE_CHECKED

private static final String ATTRIBUTE_CHECKED

See Also:

• Constant Field Values

ATTRIBUTE_ON

private static final String ATTRIBUTE_ON

See Also:

• Constant Field Values

ATTRIBUTE_OFF

private static final String ATTRIBUTE_OFF

See Also:

• Constant Field Values

ALLOWED_VALUES

private static final String[] ALLOWED_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.

checkIfFormFieldTypeIsAllowed

private static void checkIfFormFieldTypeIsAllowed(String formFieldType)