org.apache.pdfbox.preflight.annotation

Class WidgetAnnotationValidator

java.lang.Object

org.apache.pdfbox.preflight.annotation.AnnotationValidator

org.apache.pdfbox.preflight.annotation.WidgetAnnotationValidator

public class WidgetAnnotationValidator
extends AnnotationValidator

Validation class for the Widget Annotation

Field Summary

Fields

Modifier and Type	Field and Description
protected PDAnnotationWidget	pdWidget PDFBox object which wraps the annotation dictionary

Fields inherited from class org.apache.pdfbox.preflight.annotation.AnnotationValidator

annotDictionary, annotFact, cosDocument, ctx, pdAnnot

Constructor Summary

Constructors

Constructor and Description
WidgetAnnotationValidator(PreflightContext ctx, COSDictionary annotDictionary)

Method Summary

Modifier and Type	Method and Description
protected boolean	checkAAField() The AA field is forbidden for the Widget annotation when the PDF is a PDF/A.
protected boolean	checkMandatoryFields() Checks if all mandatory fields of an annotation are present.
boolean	validate() In addition of the AnnotationValidator.validate() method, this method executes the the checkAAField method.

Methods inherited from class org.apache.pdfbox.preflight.annotation.AnnotationValidator

checkActions, checkAP, checkCA, checkColors, checkFlags, checkPopup, searchRGBProfile, setFactory

Methods inherited from class java.lang.Object

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

Field Detail

pdWidget

protected PDAnnotationWidget pdWidget

PDFBox object which wraps the annotation dictionary

Constructor Detail

WidgetAnnotationValidator

public WidgetAnnotationValidator(PreflightContext ctx,
                                 COSDictionary annotDictionary)

Method Detail

validate

public boolean validate()
                 throws ValidationException

In addition of the AnnotationValidator.validate() method, this method executes the the checkAAField method.

Overrides:

validate in class AnnotationValidator

Returns:

true if validation succeed, false otherwise.

Throws:

ValidationException

See Also:

org.apache.padaf.preflight.annotation.AnnotationValidator#validate(java.util.List)

checkAAField

protected boolean checkAAField()

The AA field is forbidden for the Widget annotation when the PDF is a PDF/A. This method return false and update the errors list if this key is present. returns true otherwise

Returns:

checkMandatoryFields

protected boolean checkMandatoryFields()

Description copied from class: AnnotationValidator

Checks if all mandatory fields of an annotation are present. If some fields are missing, the method returns false and the errors list is updated.

Specified by:

checkMandatoryFields in class AnnotationValidator

Returns:

true if validation succeed, false otherwise.