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
private static java.lang.String[]	ALLOWED_VALUES
private static java.lang.String	ATTRIBUTE_CHECKED
private static java.lang.String	ATTRIBUTE_OFF
private static java.lang.String	ATTRIBUTE_ON
static java.lang.String	FORM_FIELD_CHECK	Represents the role: Checkbox.
static java.lang.String	FORM_FIELD_LIST_BOX	Represents the role: ListBox.
static java.lang.String	FORM_FIELD_PUSH_BUTTON	Represents the role: PushButton.
static java.lang.String	FORM_FIELD_RADIO	Represents the role: radio.
static java.lang.String	FORM_FIELD_TEXT	Represents the role: Text.
private static java.lang.String	OWNER_PRINT_FIELD_NAME
private static java.lang.String	ROLE_NAME

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(java.lang.String formFieldType)	Instantiates a new FormDefaultAccessibilityProperties instance based on structure element role.

Method Summary

Modifier and Type	Method	Description
private static void	checkIfFormFieldTypeIsAllowed(java.lang.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 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 Detail

FORM_FIELD_RADIO

public static final java.lang.String FORM_FIELD_RADIO

Represents the role: radio.

See Also:

Constant Field Values

FORM_FIELD_CHECK

public static final java.lang.String FORM_FIELD_CHECK

Represents the role: Checkbox.

See Also:

Constant Field Values

FORM_FIELD_PUSH_BUTTON

public static final java.lang.String FORM_FIELD_PUSH_BUTTON

Represents the role: PushButton.

See Also:

Constant Field Values

FORM_FIELD_LIST_BOX

public static final java.lang.String FORM_FIELD_LIST_BOX

Represents the role: ListBox.

See Also:

Constant Field Values

FORM_FIELD_TEXT

public static final java.lang.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 java.lang.String ROLE_NAME

See Also:

Constant Field Values

OWNER_PRINT_FIELD_NAME

private static final java.lang.String OWNER_PRINT_FIELD_NAME

See Also:

Constant Field Values

ATTRIBUTE_CHECKED

private static final java.lang.String ATTRIBUTE_CHECKED

See Also:

Constant Field Values

ATTRIBUTE_ON

private static final java.lang.String ATTRIBUTE_ON

See Also:

Constant Field Values

ATTRIBUTE_OFF

private static final java.lang.String ATTRIBUTE_OFF

See Also:

Constant Field Values

ALLOWED_VALUES

private static final java.lang.String[] ALLOWED_VALUES

Constructor Detail

FormDefaultAccessibilityProperties

public FormDefaultAccessibilityProperties(java.lang.String formFieldType)

Instantiates a new FormDefaultAccessibilityProperties instance based on structure element role.

Parameters:

formFieldType - the type of the formField

Method Detail

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(java.lang.String formFieldType)