iText7 7.1.12  Overview   Package   Class  Text Changes  Statistics  Help 
Generated by
JDiff
PREV PACKAGE    NEXT PACKAGE          FRAMES    NO FRAMES  

com.itextpdf.forms.xfdf Documentation Differences

This file contains all the changes in documentation in the package com.itextpdf.forms.xfdf as colored differences. Deletions are shown like this , and additions are shown like this.
If no deletions or additions are shown in an entry, the HTML tags will be what has changed. The new HTML tags are shown in the differences. If no documentation existed, and then some was added in a later version, this change is noted in the appropriate class pages of differences, but the change is not shown on this page. Only changes in existing text are shown here. Similarly, documentation which was inherited from another class or interface is not shown here.
Note that an HTML error in the new documentation may cause the display of other documentation changes to be presented incorrectly. For instance, failure to close a tag will cause all subsequent paragraphs to be displayed differently.
Class ActionObject, DestObject getDestination()

Gets Dest, inner element of link, GoTo, and GoToR elements. Corresponds to Dest key in link annotation dictionary. For more details see paragraph 6.5.10 in Xfdf specification. @return DestObject destination attribute of current action element
Class ActionObject, String getFileOriginalName()

Gets the string value of OriginalName, required attribute of File inner element of GoToR or Launch element. Corresponds to F key in go-to action or launch dictionaries. For more details see paragraphs 6.5.11, 6.5.23 in Xfdf specification. @return String value of OriginalName attribute of current action object
Class ActionObject, PdfName getNameAction()

Gets the value of Name, required attribute of Named element. For more details see paragraph 6.5.24 in Xfdf specification. @return PdfName value of Name attribute of a named action element
Class ActionObject, PdfName getType()

Returns the type of inner action element. Possible values: PdfName.URI, PdfName.Launch, PdfName.GoTo, PdfName.GoToR, PdfName.Named. @return PdfName type of inner action element
Class ActionObject, PdfString getUri()

Gets the string value of URI elements. Corresponds to Name, required attribute of URI element. For more details see paragraph 6.5.30 in Xfdf specification. @return PdfString value of URI element
Class ActionObject, boolean isMap()

Gets IsMap, optional attribute of URI element. For more details see paragraph 6.5.30 in Xfdf specification. @return boolean indicating if URI element is a map
Class ActionObject, boolean isNewWindow()

Sets Gets the boolean value of NewWindow, optional attribute of Launch element. For more details see paragraph 6.5.23 in Xfdf specification. @return boolean indicating if current Launch action element should be opened in a new window
Class ActionObject, ActionObject setDestination(DestObject)

Sets Dest, inner element of link, GoTo, and GoToR elements. Corresponds to Dest key in link annotation dictionary. For more details see paragraph 6.5.10 in Xfdf specification. @param destination DestObject destination attribute of the action element @return current ActionObject
Class ActionObject, ActionObject setFileOriginalName(String)

Sets the string value of OriginalName, required attribute of File inner element of GoToR or Launch element. Corresponds to F key in go-to action or launch dictionaries. For more details see paragraphs 6.5.11, 6.5.23 in Xfdf specification. @param fileOriginalName String value of OriginalName attribute of action object @return current ActionObject
Class ActionObject, ActionObject setMap(boolean)

Sets IsMap, optional attribute of URI element. For more details see paragraph 6.5.30 in Xfdf specification. @param map boolean indicating if URI element is a map @return current ActionObject
Class ActionObject, ActionObject setNameAction(PdfName)

Sets the value of Name, required attribute of Named element. For more details see paragraph 6.5.24 in Xfdf specification. @param nameAction PdfName value to be set to Name attribute of a named action element @return current ActionObject
Class ActionObject, ActionObject setNewWindow(boolean)

Gets Sets the boolean value of NewWindow, optional attribute of Launch element. For more details see paragraph 6.5.23 in Xfdf specification. @param newWindow boolean indicating if current Launch action element should be opened in a new window @return current ActionObject
Class ActionObject, ActionObject setType(PdfName)

Sets the type of inner action element. Possible values: PdfName.URI, PdfName.Launch, PdfName.GoTo, PdfName.GoToR, PdfName.Named. @param type PdfName type of inner action object @return current ActionObject
Class ActionObject, ActionObject setUri(PdfString)

Sets the string value of URI elements element. Corresponds to Name, required attribute of URI element. For more details see paragraph 6.5.30 in Xfdf specification. @param uri PdfString value to be set to URI element @return current ActionObject
Class AnnotObject, PdfIndirectReference getRef()

Gets the reference to the source PdfAnnotation. Used for attaching popups in case of reading data from pdf file. @return an PdfIndirectReference of the source annotation object.
Class AnnotObject, AnnotObject setRef(PdfIndirectReference)

Sets the reference to the source PdfAnnotation. Used for attaching popups in case of reading data from pdf file. @param ref PdfIndirectReference of the source annotation object. @return this AnnotObject instance.
Class AnnotsObject, AnnotsObject addAnnot(AnnotObject)

Adds a new AnnotObject to the list of children annotations. @param annot AnnotObject containing info about pdf document annotation. @return this AnnotsObject instance.
Class AnnotsObject, List getAnnotsList()

Gets children annotations. @return a list List of children AnnotObject annotations each representing a child annotation of this annots tag.
Class AttributeObject

Represents the attribute of any xfdf XFDF element.
Class AttributeObject, String getName()

Returns attribute name. @return a string containing representation of attribute name, case-sensitive as per XML specification.
Class AttributeObject, String getValue()

Returns attribute value. @return a string representation of attribute value.
Class BorderStyleAltObject, String getContent()

Gets border style. @return an encoded border style as string.
Class BorderStyleAltObject, float[] getDashPattern()

Gets a array of numbers specifying the pattern of dashes and dash gaps pattern of the border. Corresponds to array index 3 in the Border key in the common annotation dictionary. @return an array of numbers specifying the pattern of dashes and gaps of the border.
Class BorderStyleAltObject, float getHCornerRadius()

Gets a float value specifying the horizontal corner radius of the rectangular border. Corresponds to array index 0 in the Border key in the common annotation dictionary. @return a float value specifying the horizontal corner radius.
Class BorderStyleAltObject, float getVCornerRadius()

Gets a float value specifying the vertical corner radius of the rectangular border. Corresponds to array index 1 in the Border key in the common annotation dictionary. @return a float value specifying the vertical corner radius.
Class BorderStyleAltObject, float getWidth()

Gets a float value specifying the width of the rectangular border. Corresponds to array index 2 in the Border key in the common annotation dictionary. @return a float value specifying the width of the border.
Class BorderStyleAltObject, BorderStyleAltObject setContent(String)

Sets border style. @param content an encoded border style as string. @return this BorderStyleAltObject instance.
Class BorderStyleAltObject, BorderStyleAltObject setDashPattern(float[])

Sets a array of numbers specifying the pattern of dashes and dash gaps pattern of the border. Corresponds to array index 3 in the Border key in the common annotation dictionary. @param dashPattern an array of numbers specifying the pattern of dashes and gaps of the border. @return this BorderStyleAltObject instance.
Class DestObject

Represents Dest element, a child of the link, GoTo, and GoToR elements. Corresponds to the Dest key in the link annotations dictionary. For more details see paragraph 6.5.10 in Xfdf XFDF document specification. Content model: ( Named | XYZ | Fit | FitH | FitV | FitR | FitB | FitBH | FitBV )
Class DestObject, FitObject getFit()

Gets the Fit element, a child of the Dest element. Corresponds to the Fit key in the destination syntax. Required attributes: Page. For more details see paragraph 6.5.13 in Xfdf XFDF document specification. @return a FitObject that represents Fit of Dest element.
Class DestObject, FitObject getFitB()

Sets the FitB element, a child of the Dest element. Corresponds to the FitB key in the destination syntax. Required attributes: Page. For more details see paragraph 6.5.14 in Xfdf XFDF document specification. @return a FitObject that represents FitB of Dest element.
Class DestObject, FitObject getFitBH()

Sets the FitBH element, a child of the Dest element. Corresponds to the FitBH key in the destination syntax. Required attributes: Page, Top. For more details see paragraph 6.5.15 in Xfdf XFDF document specification. @return a FitObject that represents FitBH of Dest element.
Class DestObject, FitObject getFitBV()

Sets the FitBV element, a child of the Dest element. Corresponds to the FitBV key in the destination syntax. Required attributes: Page, Left. For more details see paragraph 6.5.16 in Xfdf XFDF document specification. @return a FitObject that represents FitBV of Dest element.
Class DestObject, FitObject getFitH()

Gets the FitH element, a child of the Dest element. Corresponds to the FitH key in the destination syntax. Required attributes: Page, Top. For more details see paragraph 6.5.17 in Xfdf XFDF document specification. @return a FitObject that represents FitH of Dest element.
Class DestObject, FitObject getFitR()

Gets the FitR element, a child of the Dest element. Corresponds to the FitR key in the destination syntax. Required attributes: Page, Left, Bottom, Right, Top. For more details see paragraph 6.5.18 in Xfdf XFDF document specification. @return a FitObject that represents FitR of Dest element.
Class DestObject, FitObject getFitV()

Gets the FitV element, a child of the Dest element. Corresponds to the FitV key in the destination syntax. Required attributes: Page, Left. For more details see paragraph 6.5.19 in Xfdf XFDF document specification. @return a FitObject that represents FitV of Dest element.
Class DestObject, String getName()

Gets string value of the Name attribute of Named element, a child of Dest element. Allows a destination to be referred to indirectly by means of a name object or a byte string. For more details see paragraph 6.5.25 in Xfdf XFDF document specification. @return string value of the Name attribute.
Class DestObject, FitObject getXyz()

Gets the XYZ element, a child of the Dest element. Corresponds to the XYZ key in the destination syntax. Required attributes: Page, Left, Bottom, Right, Top. For more details see paragraph 6.5.32 in Xfdf XFDF document specification. @return a FitObject that represents XYZ of Dest element.
Class DestObject, DestObject setFit(FitObject)

Sets the Fit element, a child of the Dest element. Corresponds to the Fit key in the destination syntax. Required attributes: Page. @param fit a FitObject that represents Fit of Dest element. @return this DestObject instance.
Class DestObject, DestObject setFitB(FitObject)

Gets the FitB element, a child of the Dest element. Corresponds to the FitB key in the destination syntax. Required attributes: Page. For more details see paragraph 6.5.14 in XFDF document specification. @param fitB a FitObject that represents FitB of Dest element. @return this DestObject instance.
Class DestObject, DestObject setFitBH(FitObject)

Gets the FitBH element, a child of the Dest element. Corresponds to the FitBH key in the destination syntax. Required attributes: Page, Top. @param fitBH a FitObject that represents FitBH of Dest element. @return this DestObject instance.
Class DestObject, DestObject setFitBV(FitObject)

Sets the FitBV element, a child of the Dest element. Corresponds to the FitBV key in the destination syntax. Required attributes: Page, Left. @param fitBV a FitObject that represents FitBV of Dest element. @return this DestObject instance.
Class DestObject, DestObject setFitH(FitObject)

Sets the FitH element, a child of the Dest element. Corresponds to the FitH key in the destination syntax. Required attributes: Page, Top. @param fitH a FitObject that represents FitH of Dest element. @return this DestObject instance.
Class DestObject, DestObject setFitR(FitObject)

Sets the FitR element, a child of the Dest element. Corresponds to the FitR key in the destination syntax. Required attributes: Page, Left, Bottom, Right, Top. @param fitR a FitObject that represents FitR of Dest element. @return this DestObject instance.
Class DestObject, DestObject setFitV(FitObject)

Sets the FitV element, a child of the Dest element. Corresponds to the FitV key in the destination syntax. Required attributes: Page, Left. @param fitV a FitObject that represents FitV of Dest element. @return this DestObject instance.
Class DestObject, DestObject setName(String)

Sets string value of the Name attribute of Named element, a child of Dest element. Allows a destination to be referred to indirectly by means of a name object or a byte string. @param name string value of the Name attribute. @return this DestObject instance.
Class DestObject, DestObject setXyz(FitObject)

Sets the XYZ element, a child of the Dest element. Corresponds to the XYZ key in the destination syntax. Required attributes: Page, Left, Bottom, Right, Top. @param xyz a FitObject that represents XYZ of Dest element. @return this DestObject instance.
Class FieldObject

Represents the field element, a child of the fields and field elements. The field element corresponds to a form field. Content model: ( field* | value* | ( value? & value-richtext? )). Required attributes: name. For more details see paragraph 6.3.2 in Xfdf XFDF document specification.
Class FieldObject, String getName()

Gets the string value of the name attribute of the field element. Corresponds to the T key in the field dictionary. In a hierarchical form field, the name is the partial field name. For more details see paragraph 6.3.2.2 in Xfdf XFDF document specification.
Class FieldObject, String getRichTextValue()

Gets the string representation of the value-richtext element, a child of the field element and contains the the field's value formatted as a a rich text string. Corresponds to the RV key in the variable text field dictionary. Content model: text strign or rich text string. For more details see paragraph 6.3.4 in Xfdf XFDF document specification.
Class FieldObject, String getValue()

Gets the string representation of the value element, a child of the field element and contains the field's value, whose format may may vary depending on the field type. Corresponds to the V key in the FDF field dictionary. For more details see paragraph 6.3.3 in Xfdf XFDF document specification.
Class FieldObject, void setRichTextValue(String)

Sets the string representation of the value-richtext element, a child of the field element and contains the the field's value formatted as a a rich text string. Corresponds to the RV key in the variable text field dictionary. Content model: text strign or rich text string.
Class FieldObject, void setValue(String)

Sets the string representation of the value element, a child of the field element and contains the field's value, whose format may may vary depending on the field type. Corresponds to the V key in the FDF field dictionary.
Class XfdfConstants

Class containing constants to be used in xfdf XFDF processing.
Class XfdfConstants, String UNSUPPORTED_ANNOTATION_ATTRIBUTE

@deprecated Use LogMessageConstant.XFDF_UNSUPPORTED_ANNOTATION_ATTRIBUTE instead. The constant will be removed in 7.2.
Class XfdfObject

Represents xfdf element, the top level element in an xfdf document. For more details see paragraph 6.2.1 in Xfdf document specification. Content model: ( f? & ids? & fields? & annots? ) Attributes: xml:space, xmlns.
Class XfdfObject, void mergeToPdf(PdfDocument, String)

Merges info from XfdfObject to pdf document. @param pdfDocument the target document for merge. @param pdfDocumentName the name of the target document. Will be checked in the merge process to determined if it is the same as href attribute of f element of merged XfdfObject. If the names are different, a warning will be thrown.
Class XfdfObject, void writeToFile(OutputStream)

Writes info from XfdfObject to .xfdf file. @param os target output stream. @throws TransformerException if there is an error while creating xml structure. @throws ParserConfigurationException if there is an error while writing info into xml format.
Class XfdfObject, void writeToFile(String)

Writes info from XfdfObject to .xfdf file. @param filename name of the target file. @throws IOException if a problem occured during opening the target file. @throws TransformerException if there is an error while creating xml structure. @throws ParserConfigurationException if there is an error while writing info into xnl format.